1/*-
2 * Data structures and definitions for CAM Control Blocks (CCBs).
3 *
4 * Copyright (c) 1997, 1998 Justin T. Gibbs.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification, immediately at the beginning of the file.
13 * 2. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * $FreeBSD: head/sys/cam/cam_ccb.h 220644 2011-04-14 21:25:32Z mav $
29 */
30
31#ifndef _CAM_CAM_CCB_H
32#define _CAM_CAM_CCB_H 1
33
34#include <sys/queue.h>
35#include <sys/cdefs.h>
36#include <sys/time.h>
37#include <sys/limits.h>
38#ifndef _KERNEL
39#include <sys/callout.h>
40#endif
41#include <cam/cam_debug.h>
42#include <cam/scsi/scsi_all.h>
43#include <cam/ata/ata_all.h>
44
45
46/* General allocation length definitions for CCB structures */
47#define IOCDBLEN CAM_MAX_CDBLEN /* Space for CDB bytes/pointer */
48#define VUHBALEN 14 /* Vendor Unique HBA length */
49#define SIM_IDLEN 16 /* ASCII string len for SIM ID */
50#define HBA_IDLEN 16 /* ASCII string len for HBA ID */
51#define DEV_IDLEN 16 /* ASCII string len for device names */
52#define CCB_PERIPH_PRIV_SIZE 2 /* size of peripheral private area */
53#define CCB_SIM_PRIV_SIZE 2 /* size of sim private area */
54
55/* Struct definitions for CAM control blocks */
56
57/* Common CCB header */
58/* CAM CCB flags */
59typedef enum {
60 CAM_CDB_POINTER = 0x00000001,/* The CDB field is a pointer */
61 CAM_QUEUE_ENABLE = 0x00000002,/* SIM queue actions are enabled */
62 CAM_CDB_LINKED = 0x00000004,/* CCB contains a linked CDB */
63 CAM_NEGOTIATE = 0x00000008,/*
64 * Perform transport negotiation
65 * with this command.
66 */
67 CAM_SCATTER_VALID = 0x00000010,/* Scatter/gather list is valid */
68 CAM_DIS_AUTOSENSE = 0x00000020,/* Disable autosense feature */
69 CAM_DIR_BOTH = 0x00000000,/* Data direction (00:IN/OUT) */
70 CAM_DIR_IN = 0x00000040,/* Data direction (01:DATA IN) */
71 CAM_DIR_OUT = 0x00000080,/* Data direction (10:DATA OUT) */
72 CAM_DIR_NONE = 0x000000C0,/* Data direction (11:no data) */
73 CAM_DIR_MASK = 0x000000C0,/* Data direction Mask */
74 CAM_SOFT_RST_OP = 0x00000100,/* Use Soft reset alternative */
75 CAM_ENG_SYNC = 0x00000200,/* Flush resid bytes on complete */
76 CAM_DEV_QFRZDIS = 0x00000400,/* Disable DEV Q freezing */
77 CAM_DEV_QFREEZE = 0x00000800,/* Freeze DEV Q on execution */
78 CAM_HIGH_POWER = 0x00001000,/* Command takes a lot of power */
79 CAM_SENSE_PTR = 0x00002000,/* Sense data is a pointer */
80 CAM_SENSE_PHYS = 0x00004000,/* Sense pointer is physical addr*/
81 CAM_TAG_ACTION_VALID = 0x00008000,/* Use the tag action in this ccb*/
82 CAM_PASS_ERR_RECOVER = 0x00010000,/* Pass driver does err. recovery*/
83 CAM_DIS_DISCONNECT = 0x00020000,/* Disable disconnect */
84 CAM_SG_LIST_PHYS = 0x00040000,/* SG list has physical addrs. */
85 CAM_MSG_BUF_PHYS = 0x00080000,/* Message buffer ptr is physical*/
86 CAM_SNS_BUF_PHYS = 0x00100000,/* Autosense data ptr is physical*/
87 CAM_DATA_PHYS = 0x00200000,/* SG/Buffer data ptrs are phys. */
88 CAM_CDB_PHYS = 0x00400000,/* CDB poiner is physical */
89 CAM_ENG_SGLIST = 0x00800000,/* SG list is for the HBA engine */
90
91/* Phase cognizant mode flags */
92 CAM_DIS_AUTOSRP = 0x01000000,/* Disable autosave/restore ptrs */
93 CAM_DIS_AUTODISC = 0x02000000,/* Disable auto disconnect */
94 CAM_TGT_CCB_AVAIL = 0x04000000,/* Target CCB available */
95 CAM_TGT_PHASE_MODE = 0x08000000,/* The SIM runs in phase mode */
96 CAM_MSGB_VALID = 0x10000000,/* Message buffer valid */
97 CAM_STATUS_VALID = 0x20000000,/* Status buffer valid */
98 CAM_DATAB_VALID = 0x40000000,/* Data buffer valid */
99
100/* Host target Mode flags */
101 CAM_SEND_SENSE = 0x08000000,/* Send sense data with status */
102 CAM_TERM_IO = 0x10000000,/* Terminate I/O Message sup. */
103 CAM_DISCONNECT = 0x20000000,/* Disconnects are mandatory */
104 CAM_SEND_STATUS = 0x40000000 /* Send status after data phase */
105} ccb_flags;
106
107/* XPT Opcodes for xpt_action */
108typedef enum {
109/* Function code flags are bits greater than 0xff */
110 XPT_FC_QUEUED = 0x100,
111 /* Non-immediate function code */
112 XPT_FC_USER_CCB = 0x200,
113 XPT_FC_XPT_ONLY = 0x400,
114 /* Only for the transport layer device */
115 XPT_FC_DEV_QUEUED = 0x800 | XPT_FC_QUEUED,
116 /* Passes through the device queues */
117/* Common function commands: 0x00->0x0F */
118 XPT_NOOP = 0x00,
119 /* Execute Nothing */
120 XPT_SCSI_IO = 0x01 | XPT_FC_DEV_QUEUED,
121 /* Execute the requested I/O operation */
122 XPT_GDEV_TYPE = 0x02,
123 /* Get type information for specified device */
124 XPT_GDEVLIST = 0x03,
125 /* Get a list of peripheral devices */
126 XPT_PATH_INQ = 0x04,
127 /* Path routing inquiry */
128 XPT_REL_SIMQ = 0x05,
129 /* Release a frozen device queue */
130 XPT_SASYNC_CB = 0x06,
131 /* Set Asynchronous Callback Parameters */
132 XPT_SDEV_TYPE = 0x07,
133 /* Set device type information */
134 XPT_SCAN_BUS = 0x08 | XPT_FC_QUEUED | XPT_FC_USER_CCB
135 | XPT_FC_XPT_ONLY,
136 /* (Re)Scan the SCSI Bus */
137 XPT_DEV_MATCH = 0x09 | XPT_FC_XPT_ONLY,
138 /* Get EDT entries matching the given pattern */
139 XPT_DEBUG = 0x0a,
140 /* Turn on debugging for a bus, target or lun */
141 XPT_PATH_STATS = 0x0b,
142 /* Path statistics (error counts, etc.) */
143 XPT_GDEV_STATS = 0x0c,
144 /* Device statistics (error counts, etc.) */
145 XPT_FREEZE_QUEUE = 0x0d,
146 /* Freeze device queue */
147 XPT_GDEV_ADVINFO = 0x0e,
148 /* Advanced device information */
149/* SCSI Control Functions: 0x10->0x1F */
150 XPT_ABORT = 0x10,
151 /* Abort the specified CCB */
152 XPT_RESET_BUS = 0x11 | XPT_FC_XPT_ONLY,
153 /* Reset the specified SCSI bus */
154 XPT_RESET_DEV = 0x12 | XPT_FC_DEV_QUEUED,
155 /* Bus Device Reset the specified SCSI device */
156 XPT_TERM_IO = 0x13,
157 /* Terminate the I/O process */
158 XPT_SCAN_LUN = 0x14 | XPT_FC_QUEUED | XPT_FC_USER_CCB
159 | XPT_FC_XPT_ONLY,
160 /* Scan Logical Unit */
161 XPT_GET_TRAN_SETTINGS = 0x15,
162 /*
163 * Get default/user transfer settings
164 * for the target
165 */
166 XPT_SET_TRAN_SETTINGS = 0x16,
167 /*
168 * Set transfer rate/width
169 * negotiation settings
170 */
171 XPT_CALC_GEOMETRY = 0x17,
172 /*
173 * Calculate the geometry parameters for
174 * a device give the sector size and
175 * volume size.
176 */
177 XPT_ATA_IO = 0x18 | XPT_FC_DEV_QUEUED,
178 /* Execute the requested ATA I/O operation */
179
180 XPT_GET_SIM_KNOB = 0x18,
181 /*
182 * Get SIM specific knob values.
183 */
184
185 XPT_SET_SIM_KNOB = 0x19,
186 /*
187 * Set SIM specific knob values.
188 */
189
190 XPT_SMP_IO = 0x1b | XPT_FC_DEV_QUEUED,
191 /* Serial Management Protocol */
192
193 XPT_SCAN_TGT = 0x1E | XPT_FC_QUEUED | XPT_FC_USER_CCB
194 | XPT_FC_XPT_ONLY,
195 /* Scan Target */
196
197/* HBA engine commands 0x20->0x2F */
198 XPT_ENG_INQ = 0x20 | XPT_FC_XPT_ONLY,
199 /* HBA engine feature inquiry */
200 XPT_ENG_EXEC = 0x21 | XPT_FC_DEV_QUEUED,
201 /* HBA execute engine request */
202
203/* Target mode commands: 0x30->0x3F */
204 XPT_EN_LUN = 0x30,
205 /* Enable LUN as a target */
206 XPT_TARGET_IO = 0x31 | XPT_FC_DEV_QUEUED,
207 /* Execute target I/O request */
208 XPT_ACCEPT_TARGET_IO = 0x32 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
209 /* Accept Host Target Mode CDB */
210 XPT_CONT_TARGET_IO = 0x33 | XPT_FC_DEV_QUEUED,
211 /* Continue Host Target I/O Connection */
212 XPT_IMMED_NOTIFY = 0x34 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
213 /* Notify Host Target driver of event (obsolete) */
214 XPT_NOTIFY_ACK = 0x35,
215 /* Acknowledgement of event (obsolete) */
216 XPT_IMMEDIATE_NOTIFY = 0x36 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
217 /* Notify Host Target driver of event */
218 XPT_NOTIFY_ACKNOWLEDGE = 0x37 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
219 /* Acknowledgement of event */
220
221/* Vendor Unique codes: 0x80->0x8F */
222 XPT_VUNIQUE = 0x80
223} xpt_opcode;
224
225#define XPT_FC_GROUP_MASK 0xF0
226#define XPT_FC_GROUP(op) ((op) & XPT_FC_GROUP_MASK)
227#define XPT_FC_GROUP_COMMON 0x00
228#define XPT_FC_GROUP_SCSI_CONTROL 0x10
229#define XPT_FC_GROUP_HBA_ENGINE 0x20
230#define XPT_FC_GROUP_TMODE 0x30
231#define XPT_FC_GROUP_VENDOR_UNIQUE 0x80
232
233#define XPT_FC_IS_DEV_QUEUED(ccb) \
234 (((ccb)->ccb_h.func_code & XPT_FC_DEV_QUEUED) == XPT_FC_DEV_QUEUED)
235#define XPT_FC_IS_QUEUED(ccb) \
236 (((ccb)->ccb_h.func_code & XPT_FC_QUEUED) != 0)
237
238typedef enum {
239 PROTO_UNKNOWN,
240 PROTO_UNSPECIFIED,
241 PROTO_SCSI, /* Small Computer System Interface */
242 PROTO_ATA, /* AT Attachment */
243 PROTO_ATAPI, /* AT Attachment Packetized Interface */
244 PROTO_SATAPM, /* SATA Port Multiplier */
245} cam_proto;
246
247typedef enum {
248 XPORT_UNKNOWN,
249 XPORT_UNSPECIFIED,
250 XPORT_SPI, /* SCSI Parallel Interface */
251 XPORT_FC, /* Fiber Channel */
252 XPORT_SSA, /* Serial Storage Architecture */
253 XPORT_USB, /* Universal Serial Bus */
254 XPORT_PPB, /* Parallel Port Bus */
255 XPORT_ATA, /* AT Attachment */
256 XPORT_SAS, /* Serial Attached SCSI */
257 XPORT_SATA, /* Serial AT Attachment */
258 XPORT_ISCSI, /* iSCSI */
259} cam_xport;
260
261#define XPORT_IS_ATA(t) ((t) == XPORT_ATA || (t) == XPORT_SATA)
262#define XPORT_IS_SCSI(t) ((t) != XPORT_UNKNOWN && \
263 (t) != XPORT_UNSPECIFIED && \
264 !XPORT_IS_ATA(t))
265#define XPORT_DEVSTAT_TYPE(t) (XPORT_IS_ATA(t) ? DEVSTAT_TYPE_IF_IDE : \
266 XPORT_IS_SCSI(t) ? DEVSTAT_TYPE_IF_SCSI : \
267 DEVSTAT_TYPE_IF_OTHER)
268
269#define PROTO_VERSION_UNKNOWN (UINT_MAX - 1)
270#define PROTO_VERSION_UNSPECIFIED UINT_MAX
271#define XPORT_VERSION_UNKNOWN (UINT_MAX - 1)
272#define XPORT_VERSION_UNSPECIFIED UINT_MAX
273
274typedef union {
275 LIST_ENTRY(ccb_hdr) le;
276 SLIST_ENTRY(ccb_hdr) sle;
277 TAILQ_ENTRY(ccb_hdr) tqe;
278 STAILQ_ENTRY(ccb_hdr) stqe;
279} camq_entry;
280
281typedef union {
282 void *ptr;
283 u_long field;
284 u_int8_t bytes[sizeof(uintptr_t)];
285} ccb_priv_entry;
286
287typedef union {
288 ccb_priv_entry entries[CCB_PERIPH_PRIV_SIZE];
289 u_int8_t bytes[CCB_PERIPH_PRIV_SIZE * sizeof(ccb_priv_entry)];
290} ccb_ppriv_area;
291
292typedef union {
293 ccb_priv_entry entries[CCB_SIM_PRIV_SIZE];
294 u_int8_t bytes[CCB_SIM_PRIV_SIZE * sizeof(ccb_priv_entry)];
295} ccb_spriv_area;
296
297struct ccb_hdr {
298 cam_pinfo pinfo; /* Info for priority scheduling */
299 camq_entry xpt_links; /* For chaining in the XPT layer */
300 camq_entry sim_links; /* For chaining in the SIM layer */
301 camq_entry periph_links; /* For chaining in the type driver */
302 u_int32_t retry_count;
303 void (*cbfcnp)(struct cam_periph *, union ccb *);
304 /* Callback on completion function */
305 xpt_opcode func_code; /* XPT function code */
306 u_int32_t status; /* Status returned by CAM subsystem */
307 struct cam_path *path; /* Compiled path for this ccb */
308 path_id_t path_id; /* Path ID for the request */
309 target_id_t target_id; /* Target device ID */
310 lun_id_t target_lun; /* Target LUN number */
311 u_int32_t flags; /* ccb_flags */
312 ccb_ppriv_area periph_priv;
313 ccb_spriv_area sim_priv;
314 u_int32_t timeout; /* Timeout value */
315
316 /*
317 * Deprecated, only for use by non-MPSAFE SIMs. All others must
318 * allocate and initialize their own callout storage.
319 */
320 struct callout_handle timeout_ch;
321};
322
323/* Get Device Information CCB */
324struct ccb_getdev {
325 struct ccb_hdr ccb_h;
326 cam_proto protocol;
327 struct scsi_inquiry_data inq_data;
328 struct ata_params ident_data;
329 u_int8_t serial_num[252];
330 u_int8_t inq_flags;
331 u_int8_t serial_num_len;
332};
333
334/* Device Statistics CCB */
335struct ccb_getdevstats {
336 struct ccb_hdr ccb_h;
337 int dev_openings; /* Space left for more work on device*/
338 int dev_active; /* Transactions running on the device */
339 int devq_openings; /* Space left for more queued work */
340 int devq_queued; /* Transactions queued to be sent */
341 int held; /*
342 * CCBs held by peripheral drivers
343 * for this device
344 */
345 int maxtags; /*
346 * Boundary conditions for number of
347 * tagged operations
348 */
349 int mintags;
350 struct timeval last_reset; /* Time of last bus reset/loop init */
351};
352
353typedef enum {
354 CAM_GDEVLIST_LAST_DEVICE,
355 CAM_GDEVLIST_LIST_CHANGED,
356 CAM_GDEVLIST_MORE_DEVS,
357 CAM_GDEVLIST_ERROR
358} ccb_getdevlist_status_e;
359
360struct ccb_getdevlist {
361 struct ccb_hdr ccb_h;
362 char periph_name[DEV_IDLEN];
363 u_int32_t unit_number;
364 unsigned int generation;
365 u_int32_t index;
366 ccb_getdevlist_status_e status;
367};
368
369typedef enum {
370 PERIPH_MATCH_NONE = 0x000,
371 PERIPH_MATCH_PATH = 0x001,
372 PERIPH_MATCH_TARGET = 0x002,
373 PERIPH_MATCH_LUN = 0x004,
374 PERIPH_MATCH_NAME = 0x008,
375 PERIPH_MATCH_UNIT = 0x010,
376 PERIPH_MATCH_ANY = 0x01f
377} periph_pattern_flags;
378
379struct periph_match_pattern {
380 char periph_name[DEV_IDLEN];
381 u_int32_t unit_number;
382 path_id_t path_id;
383 target_id_t target_id;
384 lun_id_t target_lun;
385 periph_pattern_flags flags;
386};
387
388typedef enum {
389 DEV_MATCH_NONE = 0x000,
390 DEV_MATCH_PATH = 0x001,
391 DEV_MATCH_TARGET = 0x002,
392 DEV_MATCH_LUN = 0x004,
393 DEV_MATCH_INQUIRY = 0x008,
394 DEV_MATCH_ANY = 0x00f
395} dev_pattern_flags;
396
397struct device_match_pattern {
398 path_id_t path_id;
399 target_id_t target_id;
400 lun_id_t target_lun;
401 struct scsi_static_inquiry_pattern inq_pat;
402 dev_pattern_flags flags;
403};
404
405typedef enum {
406 BUS_MATCH_NONE = 0x000,
407 BUS_MATCH_PATH = 0x001,
408 BUS_MATCH_NAME = 0x002,
409 BUS_MATCH_UNIT = 0x004,
410 BUS_MATCH_BUS_ID = 0x008,
411 BUS_MATCH_ANY = 0x00f
412} bus_pattern_flags;
413
414struct bus_match_pattern {
415 path_id_t path_id;
416 char dev_name[DEV_IDLEN];
417 u_int32_t unit_number;
418 u_int32_t bus_id;
419 bus_pattern_flags flags;
420};
421
422union match_pattern {
423 struct periph_match_pattern periph_pattern;
424 struct device_match_pattern device_pattern;
425 struct bus_match_pattern bus_pattern;
426};
427
428typedef enum {
429 DEV_MATCH_PERIPH,
430 DEV_MATCH_DEVICE,
431 DEV_MATCH_BUS
432} dev_match_type;
433
434struct dev_match_pattern {
435 dev_match_type type;
436 union match_pattern pattern;
437};
438
439struct periph_match_result {
440 char periph_name[DEV_IDLEN];
441 u_int32_t unit_number;
442 path_id_t path_id;
443 target_id_t target_id;
444 lun_id_t target_lun;
445};
446
447typedef enum {
448 DEV_RESULT_NOFLAG = 0x00,
449 DEV_RESULT_UNCONFIGURED = 0x01
450} dev_result_flags;
451
452struct device_match_result {
453 path_id_t path_id;
454 target_id_t target_id;
455 lun_id_t target_lun;
456 cam_proto protocol;
457 struct scsi_inquiry_data inq_data;
458 struct ata_params ident_data;
459 dev_result_flags flags;
460};
461
462struct bus_match_result {
463 path_id_t path_id;
464 char dev_name[DEV_IDLEN];
465 u_int32_t unit_number;
466 u_int32_t bus_id;
467};
468
469union match_result {
470 struct periph_match_result periph_result;
471 struct device_match_result device_result;
472 struct bus_match_result bus_result;
473};
474
475struct dev_match_result {
476 dev_match_type type;
477 union match_result result;
478};
479
480typedef enum {
481 CAM_DEV_MATCH_LAST,
482 CAM_DEV_MATCH_MORE,
483 CAM_DEV_MATCH_LIST_CHANGED,
484 CAM_DEV_MATCH_SIZE_ERROR,
485 CAM_DEV_MATCH_ERROR
486} ccb_dev_match_status;
487
488typedef enum {
489 CAM_DEV_POS_NONE = 0x000,
490 CAM_DEV_POS_BUS = 0x001,
491 CAM_DEV_POS_TARGET = 0x002,
492 CAM_DEV_POS_DEVICE = 0x004,
493 CAM_DEV_POS_PERIPH = 0x008,
494 CAM_DEV_POS_PDPTR = 0x010,
495 CAM_DEV_POS_TYPEMASK = 0xf00,
496 CAM_DEV_POS_EDT = 0x100,
497 CAM_DEV_POS_PDRV = 0x200
498} dev_pos_type;
499
500struct ccb_dm_cookie {
501 void *bus;
502 void *target;
503 void *device;
504 void *periph;
505 void *pdrv;
506};
507
508struct ccb_dev_position {
509 u_int generations[4];
510#define CAM_BUS_GENERATION 0x00
511#define CAM_TARGET_GENERATION 0x01
512#define CAM_DEV_GENERATION 0x02
513#define CAM_PERIPH_GENERATION 0x03
514 dev_pos_type position_type;
515 struct ccb_dm_cookie cookie;
516};
517
518struct ccb_dev_match {
519 struct ccb_hdr ccb_h;
520 ccb_dev_match_status status;
521 u_int32_t num_patterns;
522 u_int32_t pattern_buf_len;
523 struct dev_match_pattern *patterns;
524 u_int32_t num_matches;
525 u_int32_t match_buf_len;
526 struct dev_match_result *matches;
527 struct ccb_dev_position pos;
528};
529
530/*
531 * Definitions for the path inquiry CCB fields.
532 */
533#define CAM_VERSION 0x15 /* Hex value for current version */
534
535typedef enum {
536 PI_MDP_ABLE = 0x80, /* Supports MDP message */
537 PI_WIDE_32 = 0x40, /* Supports 32 bit wide SCSI */
538 PI_WIDE_16 = 0x20, /* Supports 16 bit wide SCSI */
539 PI_SDTR_ABLE = 0x10, /* Supports SDTR message */
540 PI_LINKED_CDB = 0x08, /* Supports linked CDBs */
541 PI_SATAPM = 0x04, /* Supports SATA PM */
542 PI_TAG_ABLE = 0x02, /* Supports tag queue messages */
543 PI_SOFT_RST = 0x01 /* Supports soft reset alternative */
544} pi_inqflag;
545
546typedef enum {
547 PIT_PROCESSOR = 0x80, /* Target mode processor mode */
548 PIT_PHASE = 0x40, /* Target mode phase cog. mode */
549 PIT_DISCONNECT = 0x20, /* Disconnects supported in target mode */
550 PIT_TERM_IO = 0x10, /* Terminate I/O message supported in TM */
551 PIT_GRP_6 = 0x08, /* Group 6 commands supported */
552 PIT_GRP_7 = 0x04 /* Group 7 commands supported */
553} pi_tmflag;
554
555typedef enum {
556 PIM_SCANHILO = 0x80, /* Bus scans from high ID to low ID */
557 PIM_NOREMOVE = 0x40, /* Removeable devices not included in scan */
558 PIM_NOINITIATOR = 0x20, /* Initiator role not supported. */
559 PIM_NOBUSRESET = 0x10, /* User has disabled initial BUS RESET */
560 PIM_NO_6_BYTE = 0x08, /* Do not send 6-byte commands */
561 PIM_SEQSCAN = 0x04 /* Do bus scans sequentially, not in parallel */
562} pi_miscflag;
563
564/* Path Inquiry CCB */
565struct ccb_pathinq_settings_spi {
566 u_int8_t ppr_options;
567};
568
569struct ccb_pathinq_settings_fc {
570 u_int64_t wwnn; /* world wide node name */
571 u_int64_t wwpn; /* world wide port name */
572 u_int32_t port; /* 24 bit port id, if known */
573 u_int32_t bitrate; /* Mbps */
574};
575
576struct ccb_pathinq_settings_sas {
577 u_int32_t bitrate; /* Mbps */
578};
579#define PATHINQ_SETTINGS_SIZE 128
580
581struct ccb_pathinq {
582 struct ccb_hdr ccb_h;
583 u_int8_t version_num; /* Version number for the SIM/HBA */
584 u_int8_t hba_inquiry; /* Mimic of INQ byte 7 for the HBA */
585 u_int8_t target_sprt; /* Flags for target mode support */
586 u_int8_t hba_misc; /* Misc HBA features */
587 u_int16_t hba_eng_cnt; /* HBA engine count */
588 /* Vendor Unique capabilities */
589 u_int8_t vuhba_flags[VUHBALEN];
590 u_int32_t max_target; /* Maximum supported Target */
591 u_int32_t max_lun; /* Maximum supported Lun */
592 u_int32_t async_flags; /* Installed Async handlers */
593 path_id_t hpath_id; /* Highest Path ID in the subsystem */
594 target_id_t initiator_id; /* ID of the HBA on the SCSI bus */
595 char sim_vid[SIM_IDLEN]; /* Vendor ID of the SIM */
596 char hba_vid[HBA_IDLEN]; /* Vendor ID of the HBA */
597 char dev_name[DEV_IDLEN];/* Device name for SIM */
598 u_int32_t unit_number; /* Unit number for SIM */
599 u_int32_t bus_id; /* Bus ID for SIM */
600 u_int32_t base_transfer_speed;/* Base bus speed in KB/sec */
601 cam_proto protocol;
602 u_int protocol_version;
603 cam_xport transport;
604 u_int transport_version;
605 union {
606 struct ccb_pathinq_settings_spi spi;
607 struct ccb_pathinq_settings_fc fc;
608 struct ccb_pathinq_settings_sas sas;
609 char ccb_pathinq_settings_opaque[PATHINQ_SETTINGS_SIZE];
610 } xport_specific;
611 u_int maxio; /* Max supported I/O size, in bytes. */
612 u_int16_t hba_vendor; /* HBA vendor ID */
613 u_int16_t hba_device; /* HBA device ID */
614 u_int16_t hba_subvendor; /* HBA subvendor ID */
615 u_int16_t hba_subdevice; /* HBA subdevice ID */
616};
617
618/* Path Statistics CCB */
619struct ccb_pathstats {
620 struct ccb_hdr ccb_h;
621 struct timeval last_reset; /* Time of last bus reset/loop init */
622};
623
624typedef enum {
625 SMP_FLAG_NONE = 0x00,
626 SMP_FLAG_REQ_SG = 0x01,
627 SMP_FLAG_RSP_SG = 0x02
628} ccb_smp_pass_flags;
629
630/*
631 * Serial Management Protocol CCB
632 * XXX Currently the semantics for this CCB are that it is executed either
633 * by the addressed device, or that device's parent (i.e. an expander for
634 * any device on an expander) if the addressed device doesn't support SMP.
635 * Later, once we have the ability to probe SMP-only devices and put them
636 * in CAM's topology, the CCB will only be executed by the addressed device
637 * if possible.
638 */
639struct ccb_smpio {
640 struct ccb_hdr ccb_h;
641 uint8_t *smp_request;
642 int smp_request_len;
643 uint16_t smp_request_sglist_cnt;
644 uint8_t *smp_response;
645 int smp_response_len;
646 uint16_t smp_response_sglist_cnt;
647 ccb_smp_pass_flags flags;
648};
649
650typedef union {
651 u_int8_t *sense_ptr; /*
652 * Pointer to storage
653 * for sense information
654 */
655 /* Storage Area for sense information */
656 struct scsi_sense_data sense_buf;
657} sense_t;
658
659typedef union {
660 u_int8_t *cdb_ptr; /* Pointer to the CDB bytes to send */
661 /* Area for the CDB send */
662 u_int8_t cdb_bytes[IOCDBLEN];
663} cdb_t;
664
665/*
666 * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO
667 * function codes.
668 */
669struct ccb_scsiio {
670 struct ccb_hdr ccb_h;
671 union ccb *next_ccb; /* Ptr for next CCB for action */
672 u_int8_t *req_map; /* Ptr to mapping info */
673 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */
674 u_int32_t dxfer_len; /* Data transfer length */
675 /* Autosense storage */
676 struct scsi_sense_data sense_data;
677 u_int8_t sense_len; /* Number of bytes to autosense */
678 u_int8_t cdb_len; /* Number of bytes for the CDB */
679 u_int16_t sglist_cnt; /* Number of SG list entries */
680 u_int8_t scsi_status; /* Returned SCSI status */
681 u_int8_t sense_resid; /* Autosense resid length: 2's comp */
682 u_int32_t resid; /* Transfer residual length: 2's comp */
683 cdb_t cdb_io; /* Union for CDB bytes/pointer */
684 u_int8_t *msg_ptr; /* Pointer to the message buffer */
685 u_int16_t msg_len; /* Number of bytes for the Message */
686 u_int8_t tag_action; /* What to do for tag queueing */
687 /*
688 * The tag action should be either the define below (to send a
689 * non-tagged transaction) or one of the defined scsi tag messages
690 * from scsi_message.h.
691 */
692#define CAM_TAG_ACTION_NONE 0x00
693 u_int tag_id; /* tag id from initator (target mode) */
694 u_int init_id; /* initiator id of who selected */
695};
696
697/*
698 * ATA I/O Request CCB used for the XPT_ATA_IO function code.
699 */
700struct ccb_ataio {
701 struct ccb_hdr ccb_h;
702 union ccb *next_ccb; /* Ptr for next CCB for action */
703 struct ata_cmd cmd; /* ATA command register set */
704 struct ata_res res; /* ATA result register set */
705 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */
706 u_int32_t dxfer_len; /* Data transfer length */
707 u_int32_t resid; /* Transfer residual length: 2's comp */
708 u_int8_t tag_action; /* What to do for tag queueing */
709 /*
710 * The tag action should be either the define below (to send a
711 * non-tagged transaction) or one of the defined scsi tag messages
712 * from scsi_message.h.
713 */
714#define CAM_TAG_ACTION_NONE 0x00
715 u_int tag_id; /* tag id from initator (target mode) */
716 u_int init_id; /* initiator id of who selected */
717};
718
719struct ccb_accept_tio {
720 struct ccb_hdr ccb_h;
721 cdb_t cdb_io; /* Union for CDB bytes/pointer */
722 u_int8_t cdb_len; /* Number of bytes for the CDB */
723 u_int8_t tag_action; /* What to do for tag queueing */
724 u_int8_t sense_len; /* Number of bytes of Sense Data */
725 u_int tag_id; /* tag id from initator (target mode) */
726 u_int init_id; /* initiator id of who selected */
727 struct scsi_sense_data sense_data;
728};
729
730/* Release SIM Queue */
731struct ccb_relsim {
732 struct ccb_hdr ccb_h;
733 u_int32_t release_flags;
734#define RELSIM_ADJUST_OPENINGS 0x01
735#define RELSIM_RELEASE_AFTER_TIMEOUT 0x02
736#define RELSIM_RELEASE_AFTER_CMDCMPLT 0x04
737#define RELSIM_RELEASE_AFTER_QEMPTY 0x08
738#define RELSIM_RELEASE_RUNLEVEL 0x10
739 u_int32_t openings;
740 u_int32_t release_timeout; /* Abstract argument. */
741 u_int32_t qfrozen_cnt;
742};
743
744/*
745 * Definitions for the asynchronous callback CCB fields.
746 */
747typedef enum {
748 AC_CONTRACT = 0x1000,/* A contractual callback */
749 AC_GETDEV_CHANGED = 0x800,/* Getdev info might have changed */
750 AC_INQ_CHANGED = 0x400,/* Inquiry info might have changed */
751 AC_TRANSFER_NEG = 0x200,/* New transfer settings in effect */
752 AC_LOST_DEVICE = 0x100,/* A device went away */
753 AC_FOUND_DEVICE = 0x080,/* A new device was found */
754 AC_PATH_DEREGISTERED = 0x040,/* A path has de-registered */
755 AC_PATH_REGISTERED = 0x020,/* A new path has been registered */
756 AC_SENT_BDR = 0x010,/* A BDR message was sent to target */
757 AC_SCSI_AEN = 0x008,/* A SCSI AEN has been received */
758 AC_UNSOL_RESEL = 0x002,/* Unsolicited reselection occurred */
759 AC_BUS_RESET = 0x001 /* A SCSI bus reset occurred */
760} ac_code;
761
762typedef void ac_callback_t (void *softc, u_int32_t code,
763 struct cam_path *path, void *args);
764
765/*
766 * Generic Asynchronous callbacks.
767 *
768 * Generic arguments passed bac which are then interpreted between a per-system
769 * contract number.
770 */
771#define AC_CONTRACT_DATA_MAX (128 - sizeof (u_int64_t))
772struct ac_contract {
773 u_int64_t contract_number;
774 u_int8_t contract_data[AC_CONTRACT_DATA_MAX];
775};
776
777#define AC_CONTRACT_DEV_CHG 1
778struct ac_device_changed {
779 u_int64_t wwpn;
780 u_int32_t port;
781 target_id_t target;
782 u_int8_t arrived;
783};
784
785/* Set Asynchronous Callback CCB */
786struct ccb_setasync {
787 struct ccb_hdr ccb_h;
788 u_int32_t event_enable; /* Async Event enables */
789 ac_callback_t *callback;
790 void *callback_arg;
791};
792
793/* Set Device Type CCB */
794struct ccb_setdev {
795 struct ccb_hdr ccb_h;
796 u_int8_t dev_type; /* Value for dev type field in EDT */
797};
798
799/* SCSI Control Functions */
800
801/* Abort XPT request CCB */
802struct ccb_abort {
803 struct ccb_hdr ccb_h;
804 union ccb *abort_ccb; /* Pointer to CCB to abort */
805};
806
807/* Reset SCSI Bus CCB */
808struct ccb_resetbus {
809 struct ccb_hdr ccb_h;
810};
811
812/* Reset SCSI Device CCB */
813struct ccb_resetdev {
814 struct ccb_hdr ccb_h;
815};
816
817/* Terminate I/O Process Request CCB */
818struct ccb_termio {
819 struct ccb_hdr ccb_h;
820 union ccb *termio_ccb; /* Pointer to CCB to terminate */
821};
822
823typedef enum {
824 CTS_TYPE_CURRENT_SETTINGS,
825 CTS_TYPE_USER_SETTINGS
826} cts_type;
827
828struct ccb_trans_settings_scsi
829{
830 u_int valid; /* Which fields to honor */
831#define CTS_SCSI_VALID_TQ 0x01
832 u_int flags;
833#define CTS_SCSI_FLAGS_TAG_ENB 0x01
834};
835
836struct ccb_trans_settings_spi
837{
838 u_int valid; /* Which fields to honor */
839#define CTS_SPI_VALID_SYNC_RATE 0x01
840#define CTS_SPI_VALID_SYNC_OFFSET 0x02
841#define CTS_SPI_VALID_BUS_WIDTH 0x04
842#define CTS_SPI_VALID_DISC 0x08
843#define CTS_SPI_VALID_PPR_OPTIONS 0x10
844 u_int flags;
845#define CTS_SPI_FLAGS_DISC_ENB 0x01
846 u_int sync_period;
847 u_int sync_offset;
848 u_int bus_width;
849 u_int ppr_options;
850};
851
852struct ccb_trans_settings_fc {
853 u_int valid; /* Which fields to honor */
854#define CTS_FC_VALID_WWNN 0x8000
855#define CTS_FC_VALID_WWPN 0x4000
856#define CTS_FC_VALID_PORT 0x2000
857#define CTS_FC_VALID_SPEED 0x1000
858 u_int64_t wwnn; /* world wide node name */
859 u_int64_t wwpn; /* world wide port name */
860 u_int32_t port; /* 24 bit port id, if known */
861 u_int32_t bitrate; /* Mbps */
862};
863
864struct ccb_trans_settings_sas {
865 u_int valid; /* Which fields to honor */
866#define CTS_SAS_VALID_SPEED 0x1000
867 u_int32_t bitrate; /* Mbps */
868};
869
870struct ccb_trans_settings_ata {
871 u_int valid; /* Which fields to honor */
872#define CTS_ATA_VALID_MODE 0x01
873#define CTS_ATA_VALID_BYTECOUNT 0x02
874#define CTS_ATA_VALID_ATAPI 0x20
875 int mode; /* Mode */
876 u_int bytecount; /* Length of PIO transaction */
877 u_int atapi; /* Length of ATAPI CDB */
878};
879
880struct ccb_trans_settings_sata {
881 u_int valid; /* Which fields to honor */
882#define CTS_SATA_VALID_MODE 0x01
883#define CTS_SATA_VALID_BYTECOUNT 0x02
884#define CTS_SATA_VALID_REVISION 0x04
885#define CTS_SATA_VALID_PM 0x08
886#define CTS_SATA_VALID_TAGS 0x10
887#define CTS_SATA_VALID_ATAPI 0x20
888#define CTS_SATA_VALID_CAPS 0x40
889 int mode; /* Legacy PATA mode */
890 u_int bytecount; /* Length of PIO transaction */
891 int revision; /* SATA revision */
892 u_int pm_present; /* PM is present (XPT->SIM) */
893 u_int tags; /* Number of allowed tags */
894 u_int atapi; /* Length of ATAPI CDB */
895 u_int caps; /* Device and host SATA caps. */
896#define CTS_SATA_CAPS_H 0x0000ffff
897#define CTS_SATA_CAPS_H_PMREQ 0x00000001
898#define CTS_SATA_CAPS_H_APST 0x00000002
899#define CTS_SATA_CAPS_H_DMAAA 0x00000010 /* Auto-activation */
900#define CTS_SATA_CAPS_H_AN 0x00000020 /* Async. notification */
901#define CTS_SATA_CAPS_D 0xffff0000
902#define CTS_SATA_CAPS_D_PMREQ 0x00010000
903#define CTS_SATA_CAPS_D_APST 0x00020000
904};
905
906/* Get/Set transfer rate/width/disconnection/tag queueing settings */
907struct ccb_trans_settings {
908 struct ccb_hdr ccb_h;
909 cts_type type; /* Current or User settings */
910 cam_proto protocol;
911 u_int protocol_version;
912 cam_xport transport;
913 u_int transport_version;
914 union {
915 u_int valid; /* Which fields to honor */
916 struct ccb_trans_settings_scsi scsi;
917 } proto_specific;
918 union {
919 u_int valid; /* Which fields to honor */
920 struct ccb_trans_settings_spi spi;
921 struct ccb_trans_settings_fc fc;
922 struct ccb_trans_settings_sas sas;
923 struct ccb_trans_settings_ata ata;
924 struct ccb_trans_settings_sata sata;
925 } xport_specific;
926};
927
928
929/*
930 * Calculate the geometry parameters for a device
931 * give the block size and volume size in blocks.
932 */
933struct ccb_calc_geometry {
934 struct ccb_hdr ccb_h;
935 u_int32_t block_size;
936 u_int64_t volume_size;
937 u_int32_t cylinders;
938 u_int8_t heads;
939 u_int8_t secs_per_track;
940};
941
942/*
943 * Set or get SIM (and transport) specific knobs
944 */
945
946#define KNOB_VALID_ADDRESS 0x1
947#define KNOB_VALID_ROLE 0x2
948
949
950#define KNOB_ROLE_NONE 0x0
951#define KNOB_ROLE_INITIATOR 0x1
952#define KNOB_ROLE_TARGET 0x2
953#define KNOB_ROLE_BOTH 0x3
954
955struct ccb_sim_knob_settings_spi {
956 u_int valid;
957 u_int initiator_id;
958 u_int role;
959};
960
961struct ccb_sim_knob_settings_fc {
962 u_int valid;
963 u_int64_t wwnn; /* world wide node name */
964 u_int64_t wwpn; /* world wide port name */
965 u_int role;
966};
967
968struct ccb_sim_knob_settings_sas {
969 u_int valid;
970 u_int64_t wwnn; /* world wide node name */
971 u_int role;
972};
973#define KNOB_SETTINGS_SIZE 128
974
975struct ccb_sim_knob {
976 struct ccb_hdr ccb_h;
977 union {
978 u_int valid; /* Which fields to honor */
979 struct ccb_sim_knob_settings_spi spi;
980 struct ccb_sim_knob_settings_fc fc;
981 struct ccb_sim_knob_settings_sas sas;
982 char pad[KNOB_SETTINGS_SIZE];
983 } xport_specific;
984};
985
986/*
987 * Rescan the given bus, or bus/target/lun
988 */
989struct ccb_rescan {
990 struct ccb_hdr ccb_h;
991 cam_flags flags;
992};
993
994/*
995 * Turn on debugging for the given bus, bus/target, or bus/target/lun.
996 */
997struct ccb_debug {
998 struct ccb_hdr ccb_h;
999 cam_debug_flags flags;
1000};
1001
1002/* Target mode structures. */
1003
1004struct ccb_en_lun {
1005 struct ccb_hdr ccb_h;
1006 u_int16_t grp6_len; /* Group 6 VU CDB length */
1007 u_int16_t grp7_len; /* Group 7 VU CDB length */
1008 u_int8_t enable;
1009};
1010
1011/* old, barely used immediate notify, binary compatibility */
1012struct ccb_immed_notify {
1013 struct ccb_hdr ccb_h;
1014 struct scsi_sense_data sense_data;
1015 u_int8_t sense_len; /* Number of bytes in sense buffer */
1016 u_int8_t initiator_id; /* Id of initiator that selected */
1017 u_int8_t message_args[7]; /* Message Arguments */
1018};
1019
1020struct ccb_notify_ack {
1021 struct ccb_hdr ccb_h;
1022 u_int16_t seq_id; /* Sequence identifier */
1023 u_int8_t event; /* Event flags */
1024};
1025
1026struct ccb_immediate_notify {
1027 struct ccb_hdr ccb_h;
1028 u_int tag_id; /* Tag for immediate notify */
1029 u_int seq_id; /* Tag for target of notify */
1030 u_int initiator_id; /* Initiator Identifier */
1031 u_int arg; /* Function specific */
1032};
1033
1034struct ccb_notify_acknowledge {
1035 struct ccb_hdr ccb_h;
1036 u_int tag_id; /* Tag for immediate notify */
1037 u_int seq_id; /* Tar for target of notify */
1038 u_int initiator_id; /* Initiator Identifier */
1039 u_int arg; /* Function specific */
1040};
1041
1042/* HBA engine structures. */
1043
1044typedef enum {
1045 EIT_BUFFER, /* Engine type: buffer memory */
1046 EIT_LOSSLESS, /* Engine type: lossless compression */
1047 EIT_LOSSY, /* Engine type: lossy compression */
1048 EIT_ENCRYPT /* Engine type: encryption */
1049} ei_type;
1050
1051typedef enum {
1052 EAD_VUNIQUE, /* Engine algorithm ID: vendor unique */
1053 EAD_LZ1V1, /* Engine algorithm ID: LZ1 var.1 */
1054 EAD_LZ2V1, /* Engine algorithm ID: LZ2 var.1 */
1055 EAD_LZ2V2 /* Engine algorithm ID: LZ2 var.2 */
1056} ei_algo;
1057
1058struct ccb_eng_inq {
1059 struct ccb_hdr ccb_h;
1060 u_int16_t eng_num; /* The engine number for this inquiry */
1061 ei_type eng_type; /* Returned engine type */
1062 ei_algo eng_algo; /* Returned engine algorithm type */
1063 u_int32_t eng_memeory; /* Returned engine memory size */
1064};
1065
1066struct ccb_eng_exec { /* This structure must match SCSIIO size */
1067 struct ccb_hdr ccb_h;
1068 u_int8_t *pdrv_ptr; /* Ptr used by the peripheral driver */
1069 u_int8_t *req_map; /* Ptr for mapping info on the req. */
1070 u_int8_t *data_ptr; /* Pointer to the data buf/SG list */
1071 u_int32_t dxfer_len; /* Data transfer length */
1072 u_int8_t *engdata_ptr; /* Pointer to the engine buffer data */
1073 u_int16_t sglist_cnt; /* Num of scatter gather list entries */
1074 u_int32_t dmax_len; /* Destination data maximum length */
1075 u_int32_t dest_len; /* Destination data length */
1076 int32_t src_resid; /* Source residual length: 2's comp */
1077 u_int32_t timeout; /* Timeout value */
1078 u_int16_t eng_num; /* Engine number for this request */
1079 u_int16_t vu_flags; /* Vendor Unique flags */
1080};
1081
1082/*
1083 * Definitions for the timeout field in the SCSI I/O CCB.
1084 */
1085#define CAM_TIME_DEFAULT 0x00000000 /* Use SIM default value */
1086#define CAM_TIME_INFINITY 0xFFFFFFFF /* Infinite timeout */
1087
1088#define CAM_SUCCESS 0 /* For signaling general success */
1089#define CAM_FAILURE 1 /* For signaling general failure */
1090
1091#define CAM_FALSE 0
1092#define CAM_TRUE 1
1093
1094#define XPT_CCB_INVALID -1 /* for signaling a bad CCB to free */
1095
1096/*
1097 * CCB for getting advanced device information. This operates in a fashion
1098 * similar to XPT_GDEV_TYPE. Specify the target in ccb_h, the buffer
1099 * type requested, and provide a buffer size/buffer to write to. If the
1100 * buffer is too small, the handler will set GDEVAI_FLAG_MORE.
1101 */
1102struct ccb_getdev_advinfo {
1103 struct ccb_hdr ccb_h;
1104 uint32_t flags;
1105#define CGDAI_FLAG_TRANSPORT 0x1
1106#define CGDAI_FLAG_PROTO 0x2
1107 uint32_t buftype; /* IN: Type of data being requested */
1108 /* NB: buftype is interpreted on a per-transport basis */
1109#define CGDAI_TYPE_SCSI_DEVID 1
1110 off_t bufsiz; /* IN: Size of external buffer */
1111#define CAM_SCSI_DEVID_MAXLEN 65536 /* length in buffer is an uint16_t */
1112 off_t provsiz; /* OUT: Size required/used */
1113 uint8_t *buf; /* IN/OUT: Buffer for requested data */
1114};
1115
1116/*
1117 * Union of all CCB types for kernel space allocation. This union should
1118 * never be used for manipulating CCBs - its only use is for the allocation
1119 * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc
1120 * and the argument to xpt_ccb_free.
1121 */
1122union ccb {
1123 struct ccb_hdr ccb_h; /* For convenience */
1124 struct ccb_scsiio csio;
1125 struct ccb_getdev cgd;
1126 struct ccb_getdevlist cgdl;
1127 struct ccb_pathinq cpi;
1128 struct ccb_relsim crs;
1129 struct ccb_setasync csa;
1130 struct ccb_setdev csd;
1131 struct ccb_pathstats cpis;
1132 struct ccb_getdevstats cgds;
1133 struct ccb_dev_match cdm;
1134 struct ccb_trans_settings cts;
1135 struct ccb_calc_geometry ccg;
1136 struct ccb_sim_knob knob;
1137 struct ccb_abort cab;
1138 struct ccb_resetbus crb;
1139 struct ccb_resetdev crd;
1140 struct ccb_termio tio;
1141 struct ccb_accept_tio atio;
1142 struct ccb_scsiio ctio;
1143 struct ccb_en_lun cel;
1144 struct ccb_immed_notify cin;
1145 struct ccb_notify_ack cna;
1146 struct ccb_immediate_notify cin1;
1147 struct ccb_notify_acknowledge cna2;
1148 struct ccb_eng_inq cei;
1149 struct ccb_eng_exec cee;
1150 struct ccb_smpio smpio;
1151 struct ccb_rescan crcn;
1152 struct ccb_debug cdbg;
1153 struct ccb_ataio ataio;
1154 struct ccb_getdev_advinfo cgdai;
1155};
1156
1157__BEGIN_DECLS
1158static __inline void
1159cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
1160 void (*cbfcnp)(struct cam_periph *, union ccb *),
1161 u_int32_t flags, u_int8_t tag_action,
1162 u_int8_t *data_ptr, u_int32_t dxfer_len,
1163 u_int8_t sense_len, u_int8_t cdb_len,
1164 u_int32_t timeout);
1165
1166static __inline void
1167cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
1168 void (*cbfcnp)(struct cam_periph *, union ccb *),
1169 u_int32_t flags, u_int tag_action, u_int tag_id,
1170 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
1171 u_int32_t dxfer_len, u_int32_t timeout);
1172
1173static __inline void
1174cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries,
1175 void (*cbfcnp)(struct cam_periph *, union ccb *),
1176 u_int32_t flags, u_int tag_action,
1177 u_int8_t *data_ptr, u_int32_t dxfer_len,
1178 u_int32_t timeout);
1179
1180static __inline void
1181cam_fill_smpio(struct ccb_smpio *smpio, uint32_t retries,
1182 void (*cbfcnp)(struct cam_periph *, union ccb *), uint32_t flags,
1183 uint8_t *smp_request, int smp_request_len,
1184 uint8_t *smp_response, int smp_response_len,
1185 uint32_t timeout);
1186
1187static __inline void
1188cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
1189 void (*cbfcnp)(struct cam_periph *, union ccb *),
1190 u_int32_t flags, u_int8_t tag_action,
1191 u_int8_t *data_ptr, u_int32_t dxfer_len,
1192 u_int8_t sense_len, u_int8_t cdb_len,
1193 u_int32_t timeout)
1194{
1195 csio->ccb_h.func_code = XPT_SCSI_IO;
1196 csio->ccb_h.flags = flags;
1197 csio->ccb_h.retry_count = retries;
1198 csio->ccb_h.cbfcnp = cbfcnp;
1199 csio->ccb_h.timeout = timeout;
1200 csio->data_ptr = data_ptr;
1201 csio->dxfer_len = dxfer_len;
1202 csio->sense_len = sense_len;
1203 csio->cdb_len = cdb_len;
1204 csio->tag_action = tag_action;
1205}
1206
1207static __inline void
1208cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
1209 void (*cbfcnp)(struct cam_periph *, union ccb *),
1210 u_int32_t flags, u_int tag_action, u_int tag_id,
1211 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
1212 u_int32_t dxfer_len, u_int32_t timeout)
1213{
1214 csio->ccb_h.func_code = XPT_CONT_TARGET_IO;
1215 csio->ccb_h.flags = flags;
1216 csio->ccb_h.retry_count = retries;
1217 csio->ccb_h.cbfcnp = cbfcnp;
1218 csio->ccb_h.timeout = timeout;
1219 csio->data_ptr = data_ptr;
1220 csio->dxfer_len = dxfer_len;
1221 csio->scsi_status = scsi_status;
1222 csio->tag_action = tag_action;
1223 csio->tag_id = tag_id;
1224 csio->init_id = init_id;
1225}
1226
1227static __inline void
1228cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries,
1229 void (*cbfcnp)(struct cam_periph *, union ccb *),
1230 u_int32_t flags, u_int tag_action,
1231 u_int8_t *data_ptr, u_int32_t dxfer_len,
1232 u_int32_t timeout)
1233{
1234 ataio->ccb_h.func_code = XPT_ATA_IO;
1235 ataio->ccb_h.flags = flags;
1236 ataio->ccb_h.retry_count = retries;
1237 ataio->ccb_h.cbfcnp = cbfcnp;
1238 ataio->ccb_h.timeout = timeout;
1239 ataio->data_ptr = data_ptr;
1240 ataio->dxfer_len = dxfer_len;
1241 ataio->tag_action = tag_action;
1242}
1243
1244static __inline void
1245cam_fill_smpio(struct ccb_smpio *smpio, uint32_t retries,
1246 void (*cbfcnp)(struct cam_periph *, union ccb *), uint32_t flags,
1247 uint8_t *smp_request, int smp_request_len,
1248 uint8_t *smp_response, int smp_response_len,
1249 uint32_t timeout)
1250{
1251#ifdef _KERNEL
1252 KASSERT((flags & CAM_DIR_MASK) == CAM_DIR_BOTH,
1253 ("direction != CAM_DIR_BOTH"));
1254 KASSERT((smp_request != NULL) && (smp_response != NULL),
1255 ("need valid request and response buffers"));
1256 KASSERT((smp_request_len != 0) && (smp_response_len != 0),
1257 ("need non-zero request and response lengths"));
1258#endif /*_KERNEL*/
1259 smpio->ccb_h.func_code = XPT_SMP_IO;
1260 smpio->ccb_h.flags = flags;
1261 smpio->ccb_h.retry_count = retries;
1262 smpio->ccb_h.cbfcnp = cbfcnp;
1263 smpio->ccb_h.timeout = timeout;
1264 smpio->smp_request = smp_request;
1265 smpio->smp_request_len = smp_request_len;
1266 smpio->smp_response = smp_response;
1267 smpio->smp_response_len = smp_response_len;
1268}
1269
1270void cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended);
1271
1272__END_DECLS
1273
1274#endif /* _CAM_CAM_CCB_H */
2 * Data structures and definitions for CAM Control Blocks (CCBs).
3 *
4 * Copyright (c) 1997, 1998 Justin T. Gibbs.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification, immediately at the beginning of the file.
13 * 2. The name of the author may not be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * $FreeBSD: head/sys/cam/cam_ccb.h 220644 2011-04-14 21:25:32Z mav $
29 */
30
31#ifndef _CAM_CAM_CCB_H
32#define _CAM_CAM_CCB_H 1
33
34#include <sys/queue.h>
35#include <sys/cdefs.h>
36#include <sys/time.h>
37#include <sys/limits.h>
38#ifndef _KERNEL
39#include <sys/callout.h>
40#endif
41#include <cam/cam_debug.h>
42#include <cam/scsi/scsi_all.h>
43#include <cam/ata/ata_all.h>
44
45
46/* General allocation length definitions for CCB structures */
47#define IOCDBLEN CAM_MAX_CDBLEN /* Space for CDB bytes/pointer */
48#define VUHBALEN 14 /* Vendor Unique HBA length */
49#define SIM_IDLEN 16 /* ASCII string len for SIM ID */
50#define HBA_IDLEN 16 /* ASCII string len for HBA ID */
51#define DEV_IDLEN 16 /* ASCII string len for device names */
52#define CCB_PERIPH_PRIV_SIZE 2 /* size of peripheral private area */
53#define CCB_SIM_PRIV_SIZE 2 /* size of sim private area */
54
55/* Struct definitions for CAM control blocks */
56
57/* Common CCB header */
58/* CAM CCB flags */
59typedef enum {
60 CAM_CDB_POINTER = 0x00000001,/* The CDB field is a pointer */
61 CAM_QUEUE_ENABLE = 0x00000002,/* SIM queue actions are enabled */
62 CAM_CDB_LINKED = 0x00000004,/* CCB contains a linked CDB */
63 CAM_NEGOTIATE = 0x00000008,/*
64 * Perform transport negotiation
65 * with this command.
66 */
67 CAM_SCATTER_VALID = 0x00000010,/* Scatter/gather list is valid */
68 CAM_DIS_AUTOSENSE = 0x00000020,/* Disable autosense feature */
69 CAM_DIR_BOTH = 0x00000000,/* Data direction (00:IN/OUT) */
70 CAM_DIR_IN = 0x00000040,/* Data direction (01:DATA IN) */
71 CAM_DIR_OUT = 0x00000080,/* Data direction (10:DATA OUT) */
72 CAM_DIR_NONE = 0x000000C0,/* Data direction (11:no data) */
73 CAM_DIR_MASK = 0x000000C0,/* Data direction Mask */
74 CAM_SOFT_RST_OP = 0x00000100,/* Use Soft reset alternative */
75 CAM_ENG_SYNC = 0x00000200,/* Flush resid bytes on complete */
76 CAM_DEV_QFRZDIS = 0x00000400,/* Disable DEV Q freezing */
77 CAM_DEV_QFREEZE = 0x00000800,/* Freeze DEV Q on execution */
78 CAM_HIGH_POWER = 0x00001000,/* Command takes a lot of power */
79 CAM_SENSE_PTR = 0x00002000,/* Sense data is a pointer */
80 CAM_SENSE_PHYS = 0x00004000,/* Sense pointer is physical addr*/
81 CAM_TAG_ACTION_VALID = 0x00008000,/* Use the tag action in this ccb*/
82 CAM_PASS_ERR_RECOVER = 0x00010000,/* Pass driver does err. recovery*/
83 CAM_DIS_DISCONNECT = 0x00020000,/* Disable disconnect */
84 CAM_SG_LIST_PHYS = 0x00040000,/* SG list has physical addrs. */
85 CAM_MSG_BUF_PHYS = 0x00080000,/* Message buffer ptr is physical*/
86 CAM_SNS_BUF_PHYS = 0x00100000,/* Autosense data ptr is physical*/
87 CAM_DATA_PHYS = 0x00200000,/* SG/Buffer data ptrs are phys. */
88 CAM_CDB_PHYS = 0x00400000,/* CDB poiner is physical */
89 CAM_ENG_SGLIST = 0x00800000,/* SG list is for the HBA engine */
90
91/* Phase cognizant mode flags */
92 CAM_DIS_AUTOSRP = 0x01000000,/* Disable autosave/restore ptrs */
93 CAM_DIS_AUTODISC = 0x02000000,/* Disable auto disconnect */
94 CAM_TGT_CCB_AVAIL = 0x04000000,/* Target CCB available */
95 CAM_TGT_PHASE_MODE = 0x08000000,/* The SIM runs in phase mode */
96 CAM_MSGB_VALID = 0x10000000,/* Message buffer valid */
97 CAM_STATUS_VALID = 0x20000000,/* Status buffer valid */
98 CAM_DATAB_VALID = 0x40000000,/* Data buffer valid */
99
100/* Host target Mode flags */
101 CAM_SEND_SENSE = 0x08000000,/* Send sense data with status */
102 CAM_TERM_IO = 0x10000000,/* Terminate I/O Message sup. */
103 CAM_DISCONNECT = 0x20000000,/* Disconnects are mandatory */
104 CAM_SEND_STATUS = 0x40000000 /* Send status after data phase */
105} ccb_flags;
106
107/* XPT Opcodes for xpt_action */
108typedef enum {
109/* Function code flags are bits greater than 0xff */
110 XPT_FC_QUEUED = 0x100,
111 /* Non-immediate function code */
112 XPT_FC_USER_CCB = 0x200,
113 XPT_FC_XPT_ONLY = 0x400,
114 /* Only for the transport layer device */
115 XPT_FC_DEV_QUEUED = 0x800 | XPT_FC_QUEUED,
116 /* Passes through the device queues */
117/* Common function commands: 0x00->0x0F */
118 XPT_NOOP = 0x00,
119 /* Execute Nothing */
120 XPT_SCSI_IO = 0x01 | XPT_FC_DEV_QUEUED,
121 /* Execute the requested I/O operation */
122 XPT_GDEV_TYPE = 0x02,
123 /* Get type information for specified device */
124 XPT_GDEVLIST = 0x03,
125 /* Get a list of peripheral devices */
126 XPT_PATH_INQ = 0x04,
127 /* Path routing inquiry */
128 XPT_REL_SIMQ = 0x05,
129 /* Release a frozen device queue */
130 XPT_SASYNC_CB = 0x06,
131 /* Set Asynchronous Callback Parameters */
132 XPT_SDEV_TYPE = 0x07,
133 /* Set device type information */
134 XPT_SCAN_BUS = 0x08 | XPT_FC_QUEUED | XPT_FC_USER_CCB
135 | XPT_FC_XPT_ONLY,
136 /* (Re)Scan the SCSI Bus */
137 XPT_DEV_MATCH = 0x09 | XPT_FC_XPT_ONLY,
138 /* Get EDT entries matching the given pattern */
139 XPT_DEBUG = 0x0a,
140 /* Turn on debugging for a bus, target or lun */
141 XPT_PATH_STATS = 0x0b,
142 /* Path statistics (error counts, etc.) */
143 XPT_GDEV_STATS = 0x0c,
144 /* Device statistics (error counts, etc.) */
145 XPT_FREEZE_QUEUE = 0x0d,
146 /* Freeze device queue */
147 XPT_GDEV_ADVINFO = 0x0e,
148 /* Advanced device information */
149/* SCSI Control Functions: 0x10->0x1F */
150 XPT_ABORT = 0x10,
151 /* Abort the specified CCB */
152 XPT_RESET_BUS = 0x11 | XPT_FC_XPT_ONLY,
153 /* Reset the specified SCSI bus */
154 XPT_RESET_DEV = 0x12 | XPT_FC_DEV_QUEUED,
155 /* Bus Device Reset the specified SCSI device */
156 XPT_TERM_IO = 0x13,
157 /* Terminate the I/O process */
158 XPT_SCAN_LUN = 0x14 | XPT_FC_QUEUED | XPT_FC_USER_CCB
159 | XPT_FC_XPT_ONLY,
160 /* Scan Logical Unit */
161 XPT_GET_TRAN_SETTINGS = 0x15,
162 /*
163 * Get default/user transfer settings
164 * for the target
165 */
166 XPT_SET_TRAN_SETTINGS = 0x16,
167 /*
168 * Set transfer rate/width
169 * negotiation settings
170 */
171 XPT_CALC_GEOMETRY = 0x17,
172 /*
173 * Calculate the geometry parameters for
174 * a device give the sector size and
175 * volume size.
176 */
177 XPT_ATA_IO = 0x18 | XPT_FC_DEV_QUEUED,
178 /* Execute the requested ATA I/O operation */
179
180 XPT_GET_SIM_KNOB = 0x18,
181 /*
182 * Get SIM specific knob values.
183 */
184
185 XPT_SET_SIM_KNOB = 0x19,
186 /*
187 * Set SIM specific knob values.
188 */
189
190 XPT_SMP_IO = 0x1b | XPT_FC_DEV_QUEUED,
191 /* Serial Management Protocol */
192
193 XPT_SCAN_TGT = 0x1E | XPT_FC_QUEUED | XPT_FC_USER_CCB
194 | XPT_FC_XPT_ONLY,
195 /* Scan Target */
196
197/* HBA engine commands 0x20->0x2F */
198 XPT_ENG_INQ = 0x20 | XPT_FC_XPT_ONLY,
199 /* HBA engine feature inquiry */
200 XPT_ENG_EXEC = 0x21 | XPT_FC_DEV_QUEUED,
201 /* HBA execute engine request */
202
203/* Target mode commands: 0x30->0x3F */
204 XPT_EN_LUN = 0x30,
205 /* Enable LUN as a target */
206 XPT_TARGET_IO = 0x31 | XPT_FC_DEV_QUEUED,
207 /* Execute target I/O request */
208 XPT_ACCEPT_TARGET_IO = 0x32 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
209 /* Accept Host Target Mode CDB */
210 XPT_CONT_TARGET_IO = 0x33 | XPT_FC_DEV_QUEUED,
211 /* Continue Host Target I/O Connection */
212 XPT_IMMED_NOTIFY = 0x34 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
213 /* Notify Host Target driver of event (obsolete) */
214 XPT_NOTIFY_ACK = 0x35,
215 /* Acknowledgement of event (obsolete) */
216 XPT_IMMEDIATE_NOTIFY = 0x36 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
217 /* Notify Host Target driver of event */
218 XPT_NOTIFY_ACKNOWLEDGE = 0x37 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
219 /* Acknowledgement of event */
220
221/* Vendor Unique codes: 0x80->0x8F */
222 XPT_VUNIQUE = 0x80
223} xpt_opcode;
224
225#define XPT_FC_GROUP_MASK 0xF0
226#define XPT_FC_GROUP(op) ((op) & XPT_FC_GROUP_MASK)
227#define XPT_FC_GROUP_COMMON 0x00
228#define XPT_FC_GROUP_SCSI_CONTROL 0x10
229#define XPT_FC_GROUP_HBA_ENGINE 0x20
230#define XPT_FC_GROUP_TMODE 0x30
231#define XPT_FC_GROUP_VENDOR_UNIQUE 0x80
232
233#define XPT_FC_IS_DEV_QUEUED(ccb) \
234 (((ccb)->ccb_h.func_code & XPT_FC_DEV_QUEUED) == XPT_FC_DEV_QUEUED)
235#define XPT_FC_IS_QUEUED(ccb) \
236 (((ccb)->ccb_h.func_code & XPT_FC_QUEUED) != 0)
237
238typedef enum {
239 PROTO_UNKNOWN,
240 PROTO_UNSPECIFIED,
241 PROTO_SCSI, /* Small Computer System Interface */
242 PROTO_ATA, /* AT Attachment */
243 PROTO_ATAPI, /* AT Attachment Packetized Interface */
244 PROTO_SATAPM, /* SATA Port Multiplier */
245} cam_proto;
246
247typedef enum {
248 XPORT_UNKNOWN,
249 XPORT_UNSPECIFIED,
250 XPORT_SPI, /* SCSI Parallel Interface */
251 XPORT_FC, /* Fiber Channel */
252 XPORT_SSA, /* Serial Storage Architecture */
253 XPORT_USB, /* Universal Serial Bus */
254 XPORT_PPB, /* Parallel Port Bus */
255 XPORT_ATA, /* AT Attachment */
256 XPORT_SAS, /* Serial Attached SCSI */
257 XPORT_SATA, /* Serial AT Attachment */
258 XPORT_ISCSI, /* iSCSI */
259} cam_xport;
260
261#define XPORT_IS_ATA(t) ((t) == XPORT_ATA || (t) == XPORT_SATA)
262#define XPORT_IS_SCSI(t) ((t) != XPORT_UNKNOWN && \
263 (t) != XPORT_UNSPECIFIED && \
264 !XPORT_IS_ATA(t))
265#define XPORT_DEVSTAT_TYPE(t) (XPORT_IS_ATA(t) ? DEVSTAT_TYPE_IF_IDE : \
266 XPORT_IS_SCSI(t) ? DEVSTAT_TYPE_IF_SCSI : \
267 DEVSTAT_TYPE_IF_OTHER)
268
269#define PROTO_VERSION_UNKNOWN (UINT_MAX - 1)
270#define PROTO_VERSION_UNSPECIFIED UINT_MAX
271#define XPORT_VERSION_UNKNOWN (UINT_MAX - 1)
272#define XPORT_VERSION_UNSPECIFIED UINT_MAX
273
274typedef union {
275 LIST_ENTRY(ccb_hdr) le;
276 SLIST_ENTRY(ccb_hdr) sle;
277 TAILQ_ENTRY(ccb_hdr) tqe;
278 STAILQ_ENTRY(ccb_hdr) stqe;
279} camq_entry;
280
281typedef union {
282 void *ptr;
283 u_long field;
284 u_int8_t bytes[sizeof(uintptr_t)];
285} ccb_priv_entry;
286
287typedef union {
288 ccb_priv_entry entries[CCB_PERIPH_PRIV_SIZE];
289 u_int8_t bytes[CCB_PERIPH_PRIV_SIZE * sizeof(ccb_priv_entry)];
290} ccb_ppriv_area;
291
292typedef union {
293 ccb_priv_entry entries[CCB_SIM_PRIV_SIZE];
294 u_int8_t bytes[CCB_SIM_PRIV_SIZE * sizeof(ccb_priv_entry)];
295} ccb_spriv_area;
296
297struct ccb_hdr {
298 cam_pinfo pinfo; /* Info for priority scheduling */
299 camq_entry xpt_links; /* For chaining in the XPT layer */
300 camq_entry sim_links; /* For chaining in the SIM layer */
301 camq_entry periph_links; /* For chaining in the type driver */
302 u_int32_t retry_count;
303 void (*cbfcnp)(struct cam_periph *, union ccb *);
304 /* Callback on completion function */
305 xpt_opcode func_code; /* XPT function code */
306 u_int32_t status; /* Status returned by CAM subsystem */
307 struct cam_path *path; /* Compiled path for this ccb */
308 path_id_t path_id; /* Path ID for the request */
309 target_id_t target_id; /* Target device ID */
310 lun_id_t target_lun; /* Target LUN number */
311 u_int32_t flags; /* ccb_flags */
312 ccb_ppriv_area periph_priv;
313 ccb_spriv_area sim_priv;
314 u_int32_t timeout; /* Timeout value */
315
316 /*
317 * Deprecated, only for use by non-MPSAFE SIMs. All others must
318 * allocate and initialize their own callout storage.
319 */
320 struct callout_handle timeout_ch;
321};
322
323/* Get Device Information CCB */
324struct ccb_getdev {
325 struct ccb_hdr ccb_h;
326 cam_proto protocol;
327 struct scsi_inquiry_data inq_data;
328 struct ata_params ident_data;
329 u_int8_t serial_num[252];
330 u_int8_t inq_flags;
331 u_int8_t serial_num_len;
332};
333
334/* Device Statistics CCB */
335struct ccb_getdevstats {
336 struct ccb_hdr ccb_h;
337 int dev_openings; /* Space left for more work on device*/
338 int dev_active; /* Transactions running on the device */
339 int devq_openings; /* Space left for more queued work */
340 int devq_queued; /* Transactions queued to be sent */
341 int held; /*
342 * CCBs held by peripheral drivers
343 * for this device
344 */
345 int maxtags; /*
346 * Boundary conditions for number of
347 * tagged operations
348 */
349 int mintags;
350 struct timeval last_reset; /* Time of last bus reset/loop init */
351};
352
353typedef enum {
354 CAM_GDEVLIST_LAST_DEVICE,
355 CAM_GDEVLIST_LIST_CHANGED,
356 CAM_GDEVLIST_MORE_DEVS,
357 CAM_GDEVLIST_ERROR
358} ccb_getdevlist_status_e;
359
360struct ccb_getdevlist {
361 struct ccb_hdr ccb_h;
362 char periph_name[DEV_IDLEN];
363 u_int32_t unit_number;
364 unsigned int generation;
365 u_int32_t index;
366 ccb_getdevlist_status_e status;
367};
368
369typedef enum {
370 PERIPH_MATCH_NONE = 0x000,
371 PERIPH_MATCH_PATH = 0x001,
372 PERIPH_MATCH_TARGET = 0x002,
373 PERIPH_MATCH_LUN = 0x004,
374 PERIPH_MATCH_NAME = 0x008,
375 PERIPH_MATCH_UNIT = 0x010,
376 PERIPH_MATCH_ANY = 0x01f
377} periph_pattern_flags;
378
379struct periph_match_pattern {
380 char periph_name[DEV_IDLEN];
381 u_int32_t unit_number;
382 path_id_t path_id;
383 target_id_t target_id;
384 lun_id_t target_lun;
385 periph_pattern_flags flags;
386};
387
388typedef enum {
389 DEV_MATCH_NONE = 0x000,
390 DEV_MATCH_PATH = 0x001,
391 DEV_MATCH_TARGET = 0x002,
392 DEV_MATCH_LUN = 0x004,
393 DEV_MATCH_INQUIRY = 0x008,
394 DEV_MATCH_ANY = 0x00f
395} dev_pattern_flags;
396
397struct device_match_pattern {
398 path_id_t path_id;
399 target_id_t target_id;
400 lun_id_t target_lun;
401 struct scsi_static_inquiry_pattern inq_pat;
402 dev_pattern_flags flags;
403};
404
405typedef enum {
406 BUS_MATCH_NONE = 0x000,
407 BUS_MATCH_PATH = 0x001,
408 BUS_MATCH_NAME = 0x002,
409 BUS_MATCH_UNIT = 0x004,
410 BUS_MATCH_BUS_ID = 0x008,
411 BUS_MATCH_ANY = 0x00f
412} bus_pattern_flags;
413
414struct bus_match_pattern {
415 path_id_t path_id;
416 char dev_name[DEV_IDLEN];
417 u_int32_t unit_number;
418 u_int32_t bus_id;
419 bus_pattern_flags flags;
420};
421
422union match_pattern {
423 struct periph_match_pattern periph_pattern;
424 struct device_match_pattern device_pattern;
425 struct bus_match_pattern bus_pattern;
426};
427
428typedef enum {
429 DEV_MATCH_PERIPH,
430 DEV_MATCH_DEVICE,
431 DEV_MATCH_BUS
432} dev_match_type;
433
434struct dev_match_pattern {
435 dev_match_type type;
436 union match_pattern pattern;
437};
438
439struct periph_match_result {
440 char periph_name[DEV_IDLEN];
441 u_int32_t unit_number;
442 path_id_t path_id;
443 target_id_t target_id;
444 lun_id_t target_lun;
445};
446
447typedef enum {
448 DEV_RESULT_NOFLAG = 0x00,
449 DEV_RESULT_UNCONFIGURED = 0x01
450} dev_result_flags;
451
452struct device_match_result {
453 path_id_t path_id;
454 target_id_t target_id;
455 lun_id_t target_lun;
456 cam_proto protocol;
457 struct scsi_inquiry_data inq_data;
458 struct ata_params ident_data;
459 dev_result_flags flags;
460};
461
462struct bus_match_result {
463 path_id_t path_id;
464 char dev_name[DEV_IDLEN];
465 u_int32_t unit_number;
466 u_int32_t bus_id;
467};
468
469union match_result {
470 struct periph_match_result periph_result;
471 struct device_match_result device_result;
472 struct bus_match_result bus_result;
473};
474
475struct dev_match_result {
476 dev_match_type type;
477 union match_result result;
478};
479
480typedef enum {
481 CAM_DEV_MATCH_LAST,
482 CAM_DEV_MATCH_MORE,
483 CAM_DEV_MATCH_LIST_CHANGED,
484 CAM_DEV_MATCH_SIZE_ERROR,
485 CAM_DEV_MATCH_ERROR
486} ccb_dev_match_status;
487
488typedef enum {
489 CAM_DEV_POS_NONE = 0x000,
490 CAM_DEV_POS_BUS = 0x001,
491 CAM_DEV_POS_TARGET = 0x002,
492 CAM_DEV_POS_DEVICE = 0x004,
493 CAM_DEV_POS_PERIPH = 0x008,
494 CAM_DEV_POS_PDPTR = 0x010,
495 CAM_DEV_POS_TYPEMASK = 0xf00,
496 CAM_DEV_POS_EDT = 0x100,
497 CAM_DEV_POS_PDRV = 0x200
498} dev_pos_type;
499
500struct ccb_dm_cookie {
501 void *bus;
502 void *target;
503 void *device;
504 void *periph;
505 void *pdrv;
506};
507
508struct ccb_dev_position {
509 u_int generations[4];
510#define CAM_BUS_GENERATION 0x00
511#define CAM_TARGET_GENERATION 0x01
512#define CAM_DEV_GENERATION 0x02
513#define CAM_PERIPH_GENERATION 0x03
514 dev_pos_type position_type;
515 struct ccb_dm_cookie cookie;
516};
517
518struct ccb_dev_match {
519 struct ccb_hdr ccb_h;
520 ccb_dev_match_status status;
521 u_int32_t num_patterns;
522 u_int32_t pattern_buf_len;
523 struct dev_match_pattern *patterns;
524 u_int32_t num_matches;
525 u_int32_t match_buf_len;
526 struct dev_match_result *matches;
527 struct ccb_dev_position pos;
528};
529
530/*
531 * Definitions for the path inquiry CCB fields.
532 */
533#define CAM_VERSION 0x15 /* Hex value for current version */
534
535typedef enum {
536 PI_MDP_ABLE = 0x80, /* Supports MDP message */
537 PI_WIDE_32 = 0x40, /* Supports 32 bit wide SCSI */
538 PI_WIDE_16 = 0x20, /* Supports 16 bit wide SCSI */
539 PI_SDTR_ABLE = 0x10, /* Supports SDTR message */
540 PI_LINKED_CDB = 0x08, /* Supports linked CDBs */
541 PI_SATAPM = 0x04, /* Supports SATA PM */
542 PI_TAG_ABLE = 0x02, /* Supports tag queue messages */
543 PI_SOFT_RST = 0x01 /* Supports soft reset alternative */
544} pi_inqflag;
545
546typedef enum {
547 PIT_PROCESSOR = 0x80, /* Target mode processor mode */
548 PIT_PHASE = 0x40, /* Target mode phase cog. mode */
549 PIT_DISCONNECT = 0x20, /* Disconnects supported in target mode */
550 PIT_TERM_IO = 0x10, /* Terminate I/O message supported in TM */
551 PIT_GRP_6 = 0x08, /* Group 6 commands supported */
552 PIT_GRP_7 = 0x04 /* Group 7 commands supported */
553} pi_tmflag;
554
555typedef enum {
556 PIM_SCANHILO = 0x80, /* Bus scans from high ID to low ID */
557 PIM_NOREMOVE = 0x40, /* Removeable devices not included in scan */
558 PIM_NOINITIATOR = 0x20, /* Initiator role not supported. */
559 PIM_NOBUSRESET = 0x10, /* User has disabled initial BUS RESET */
560 PIM_NO_6_BYTE = 0x08, /* Do not send 6-byte commands */
561 PIM_SEQSCAN = 0x04 /* Do bus scans sequentially, not in parallel */
562} pi_miscflag;
563
564/* Path Inquiry CCB */
565struct ccb_pathinq_settings_spi {
566 u_int8_t ppr_options;
567};
568
569struct ccb_pathinq_settings_fc {
570 u_int64_t wwnn; /* world wide node name */
571 u_int64_t wwpn; /* world wide port name */
572 u_int32_t port; /* 24 bit port id, if known */
573 u_int32_t bitrate; /* Mbps */
574};
575
576struct ccb_pathinq_settings_sas {
577 u_int32_t bitrate; /* Mbps */
578};
579#define PATHINQ_SETTINGS_SIZE 128
580
581struct ccb_pathinq {
582 struct ccb_hdr ccb_h;
583 u_int8_t version_num; /* Version number for the SIM/HBA */
584 u_int8_t hba_inquiry; /* Mimic of INQ byte 7 for the HBA */
585 u_int8_t target_sprt; /* Flags for target mode support */
586 u_int8_t hba_misc; /* Misc HBA features */
587 u_int16_t hba_eng_cnt; /* HBA engine count */
588 /* Vendor Unique capabilities */
589 u_int8_t vuhba_flags[VUHBALEN];
590 u_int32_t max_target; /* Maximum supported Target */
591 u_int32_t max_lun; /* Maximum supported Lun */
592 u_int32_t async_flags; /* Installed Async handlers */
593 path_id_t hpath_id; /* Highest Path ID in the subsystem */
594 target_id_t initiator_id; /* ID of the HBA on the SCSI bus */
595 char sim_vid[SIM_IDLEN]; /* Vendor ID of the SIM */
596 char hba_vid[HBA_IDLEN]; /* Vendor ID of the HBA */
597 char dev_name[DEV_IDLEN];/* Device name for SIM */
598 u_int32_t unit_number; /* Unit number for SIM */
599 u_int32_t bus_id; /* Bus ID for SIM */
600 u_int32_t base_transfer_speed;/* Base bus speed in KB/sec */
601 cam_proto protocol;
602 u_int protocol_version;
603 cam_xport transport;
604 u_int transport_version;
605 union {
606 struct ccb_pathinq_settings_spi spi;
607 struct ccb_pathinq_settings_fc fc;
608 struct ccb_pathinq_settings_sas sas;
609 char ccb_pathinq_settings_opaque[PATHINQ_SETTINGS_SIZE];
610 } xport_specific;
611 u_int maxio; /* Max supported I/O size, in bytes. */
612 u_int16_t hba_vendor; /* HBA vendor ID */
613 u_int16_t hba_device; /* HBA device ID */
614 u_int16_t hba_subvendor; /* HBA subvendor ID */
615 u_int16_t hba_subdevice; /* HBA subdevice ID */
616};
617
618/* Path Statistics CCB */
619struct ccb_pathstats {
620 struct ccb_hdr ccb_h;
621 struct timeval last_reset; /* Time of last bus reset/loop init */
622};
623
624typedef enum {
625 SMP_FLAG_NONE = 0x00,
626 SMP_FLAG_REQ_SG = 0x01,
627 SMP_FLAG_RSP_SG = 0x02
628} ccb_smp_pass_flags;
629
630/*
631 * Serial Management Protocol CCB
632 * XXX Currently the semantics for this CCB are that it is executed either
633 * by the addressed device, or that device's parent (i.e. an expander for
634 * any device on an expander) if the addressed device doesn't support SMP.
635 * Later, once we have the ability to probe SMP-only devices and put them
636 * in CAM's topology, the CCB will only be executed by the addressed device
637 * if possible.
638 */
639struct ccb_smpio {
640 struct ccb_hdr ccb_h;
641 uint8_t *smp_request;
642 int smp_request_len;
643 uint16_t smp_request_sglist_cnt;
644 uint8_t *smp_response;
645 int smp_response_len;
646 uint16_t smp_response_sglist_cnt;
647 ccb_smp_pass_flags flags;
648};
649
650typedef union {
651 u_int8_t *sense_ptr; /*
652 * Pointer to storage
653 * for sense information
654 */
655 /* Storage Area for sense information */
656 struct scsi_sense_data sense_buf;
657} sense_t;
658
659typedef union {
660 u_int8_t *cdb_ptr; /* Pointer to the CDB bytes to send */
661 /* Area for the CDB send */
662 u_int8_t cdb_bytes[IOCDBLEN];
663} cdb_t;
664
665/*
666 * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO
667 * function codes.
668 */
669struct ccb_scsiio {
670 struct ccb_hdr ccb_h;
671 union ccb *next_ccb; /* Ptr for next CCB for action */
672 u_int8_t *req_map; /* Ptr to mapping info */
673 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */
674 u_int32_t dxfer_len; /* Data transfer length */
675 /* Autosense storage */
676 struct scsi_sense_data sense_data;
677 u_int8_t sense_len; /* Number of bytes to autosense */
678 u_int8_t cdb_len; /* Number of bytes for the CDB */
679 u_int16_t sglist_cnt; /* Number of SG list entries */
680 u_int8_t scsi_status; /* Returned SCSI status */
681 u_int8_t sense_resid; /* Autosense resid length: 2's comp */
682 u_int32_t resid; /* Transfer residual length: 2's comp */
683 cdb_t cdb_io; /* Union for CDB bytes/pointer */
684 u_int8_t *msg_ptr; /* Pointer to the message buffer */
685 u_int16_t msg_len; /* Number of bytes for the Message */
686 u_int8_t tag_action; /* What to do for tag queueing */
687 /*
688 * The tag action should be either the define below (to send a
689 * non-tagged transaction) or one of the defined scsi tag messages
690 * from scsi_message.h.
691 */
692#define CAM_TAG_ACTION_NONE 0x00
693 u_int tag_id; /* tag id from initator (target mode) */
694 u_int init_id; /* initiator id of who selected */
695};
696
697/*
698 * ATA I/O Request CCB used for the XPT_ATA_IO function code.
699 */
700struct ccb_ataio {
701 struct ccb_hdr ccb_h;
702 union ccb *next_ccb; /* Ptr for next CCB for action */
703 struct ata_cmd cmd; /* ATA command register set */
704 struct ata_res res; /* ATA result register set */
705 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */
706 u_int32_t dxfer_len; /* Data transfer length */
707 u_int32_t resid; /* Transfer residual length: 2's comp */
708 u_int8_t tag_action; /* What to do for tag queueing */
709 /*
710 * The tag action should be either the define below (to send a
711 * non-tagged transaction) or one of the defined scsi tag messages
712 * from scsi_message.h.
713 */
714#define CAM_TAG_ACTION_NONE 0x00
715 u_int tag_id; /* tag id from initator (target mode) */
716 u_int init_id; /* initiator id of who selected */
717};
718
719struct ccb_accept_tio {
720 struct ccb_hdr ccb_h;
721 cdb_t cdb_io; /* Union for CDB bytes/pointer */
722 u_int8_t cdb_len; /* Number of bytes for the CDB */
723 u_int8_t tag_action; /* What to do for tag queueing */
724 u_int8_t sense_len; /* Number of bytes of Sense Data */
725 u_int tag_id; /* tag id from initator (target mode) */
726 u_int init_id; /* initiator id of who selected */
727 struct scsi_sense_data sense_data;
728};
729
730/* Release SIM Queue */
731struct ccb_relsim {
732 struct ccb_hdr ccb_h;
733 u_int32_t release_flags;
734#define RELSIM_ADJUST_OPENINGS 0x01
735#define RELSIM_RELEASE_AFTER_TIMEOUT 0x02
736#define RELSIM_RELEASE_AFTER_CMDCMPLT 0x04
737#define RELSIM_RELEASE_AFTER_QEMPTY 0x08
738#define RELSIM_RELEASE_RUNLEVEL 0x10
739 u_int32_t openings;
740 u_int32_t release_timeout; /* Abstract argument. */
741 u_int32_t qfrozen_cnt;
742};
743
744/*
745 * Definitions for the asynchronous callback CCB fields.
746 */
747typedef enum {
748 AC_CONTRACT = 0x1000,/* A contractual callback */
749 AC_GETDEV_CHANGED = 0x800,/* Getdev info might have changed */
750 AC_INQ_CHANGED = 0x400,/* Inquiry info might have changed */
751 AC_TRANSFER_NEG = 0x200,/* New transfer settings in effect */
752 AC_LOST_DEVICE = 0x100,/* A device went away */
753 AC_FOUND_DEVICE = 0x080,/* A new device was found */
754 AC_PATH_DEREGISTERED = 0x040,/* A path has de-registered */
755 AC_PATH_REGISTERED = 0x020,/* A new path has been registered */
756 AC_SENT_BDR = 0x010,/* A BDR message was sent to target */
757 AC_SCSI_AEN = 0x008,/* A SCSI AEN has been received */
758 AC_UNSOL_RESEL = 0x002,/* Unsolicited reselection occurred */
759 AC_BUS_RESET = 0x001 /* A SCSI bus reset occurred */
760} ac_code;
761
762typedef void ac_callback_t (void *softc, u_int32_t code,
763 struct cam_path *path, void *args);
764
765/*
766 * Generic Asynchronous callbacks.
767 *
768 * Generic arguments passed bac which are then interpreted between a per-system
769 * contract number.
770 */
771#define AC_CONTRACT_DATA_MAX (128 - sizeof (u_int64_t))
772struct ac_contract {
773 u_int64_t contract_number;
774 u_int8_t contract_data[AC_CONTRACT_DATA_MAX];
775};
776
777#define AC_CONTRACT_DEV_CHG 1
778struct ac_device_changed {
779 u_int64_t wwpn;
780 u_int32_t port;
781 target_id_t target;
782 u_int8_t arrived;
783};
784
785/* Set Asynchronous Callback CCB */
786struct ccb_setasync {
787 struct ccb_hdr ccb_h;
788 u_int32_t event_enable; /* Async Event enables */
789 ac_callback_t *callback;
790 void *callback_arg;
791};
792
793/* Set Device Type CCB */
794struct ccb_setdev {
795 struct ccb_hdr ccb_h;
796 u_int8_t dev_type; /* Value for dev type field in EDT */
797};
798
799/* SCSI Control Functions */
800
801/* Abort XPT request CCB */
802struct ccb_abort {
803 struct ccb_hdr ccb_h;
804 union ccb *abort_ccb; /* Pointer to CCB to abort */
805};
806
807/* Reset SCSI Bus CCB */
808struct ccb_resetbus {
809 struct ccb_hdr ccb_h;
810};
811
812/* Reset SCSI Device CCB */
813struct ccb_resetdev {
814 struct ccb_hdr ccb_h;
815};
816
817/* Terminate I/O Process Request CCB */
818struct ccb_termio {
819 struct ccb_hdr ccb_h;
820 union ccb *termio_ccb; /* Pointer to CCB to terminate */
821};
822
823typedef enum {
824 CTS_TYPE_CURRENT_SETTINGS,
825 CTS_TYPE_USER_SETTINGS
826} cts_type;
827
828struct ccb_trans_settings_scsi
829{
830 u_int valid; /* Which fields to honor */
831#define CTS_SCSI_VALID_TQ 0x01
832 u_int flags;
833#define CTS_SCSI_FLAGS_TAG_ENB 0x01
834};
835
836struct ccb_trans_settings_spi
837{
838 u_int valid; /* Which fields to honor */
839#define CTS_SPI_VALID_SYNC_RATE 0x01
840#define CTS_SPI_VALID_SYNC_OFFSET 0x02
841#define CTS_SPI_VALID_BUS_WIDTH 0x04
842#define CTS_SPI_VALID_DISC 0x08
843#define CTS_SPI_VALID_PPR_OPTIONS 0x10
844 u_int flags;
845#define CTS_SPI_FLAGS_DISC_ENB 0x01
846 u_int sync_period;
847 u_int sync_offset;
848 u_int bus_width;
849 u_int ppr_options;
850};
851
852struct ccb_trans_settings_fc {
853 u_int valid; /* Which fields to honor */
854#define CTS_FC_VALID_WWNN 0x8000
855#define CTS_FC_VALID_WWPN 0x4000
856#define CTS_FC_VALID_PORT 0x2000
857#define CTS_FC_VALID_SPEED 0x1000
858 u_int64_t wwnn; /* world wide node name */
859 u_int64_t wwpn; /* world wide port name */
860 u_int32_t port; /* 24 bit port id, if known */
861 u_int32_t bitrate; /* Mbps */
862};
863
864struct ccb_trans_settings_sas {
865 u_int valid; /* Which fields to honor */
866#define CTS_SAS_VALID_SPEED 0x1000
867 u_int32_t bitrate; /* Mbps */
868};
869
870struct ccb_trans_settings_ata {
871 u_int valid; /* Which fields to honor */
872#define CTS_ATA_VALID_MODE 0x01
873#define CTS_ATA_VALID_BYTECOUNT 0x02
874#define CTS_ATA_VALID_ATAPI 0x20
875 int mode; /* Mode */
876 u_int bytecount; /* Length of PIO transaction */
877 u_int atapi; /* Length of ATAPI CDB */
878};
879
880struct ccb_trans_settings_sata {
881 u_int valid; /* Which fields to honor */
882#define CTS_SATA_VALID_MODE 0x01
883#define CTS_SATA_VALID_BYTECOUNT 0x02
884#define CTS_SATA_VALID_REVISION 0x04
885#define CTS_SATA_VALID_PM 0x08
886#define CTS_SATA_VALID_TAGS 0x10
887#define CTS_SATA_VALID_ATAPI 0x20
888#define CTS_SATA_VALID_CAPS 0x40
889 int mode; /* Legacy PATA mode */
890 u_int bytecount; /* Length of PIO transaction */
891 int revision; /* SATA revision */
892 u_int pm_present; /* PM is present (XPT->SIM) */
893 u_int tags; /* Number of allowed tags */
894 u_int atapi; /* Length of ATAPI CDB */
895 u_int caps; /* Device and host SATA caps. */
896#define CTS_SATA_CAPS_H 0x0000ffff
897#define CTS_SATA_CAPS_H_PMREQ 0x00000001
898#define CTS_SATA_CAPS_H_APST 0x00000002
899#define CTS_SATA_CAPS_H_DMAAA 0x00000010 /* Auto-activation */
900#define CTS_SATA_CAPS_H_AN 0x00000020 /* Async. notification */
901#define CTS_SATA_CAPS_D 0xffff0000
902#define CTS_SATA_CAPS_D_PMREQ 0x00010000
903#define CTS_SATA_CAPS_D_APST 0x00020000
904};
905
906/* Get/Set transfer rate/width/disconnection/tag queueing settings */
907struct ccb_trans_settings {
908 struct ccb_hdr ccb_h;
909 cts_type type; /* Current or User settings */
910 cam_proto protocol;
911 u_int protocol_version;
912 cam_xport transport;
913 u_int transport_version;
914 union {
915 u_int valid; /* Which fields to honor */
916 struct ccb_trans_settings_scsi scsi;
917 } proto_specific;
918 union {
919 u_int valid; /* Which fields to honor */
920 struct ccb_trans_settings_spi spi;
921 struct ccb_trans_settings_fc fc;
922 struct ccb_trans_settings_sas sas;
923 struct ccb_trans_settings_ata ata;
924 struct ccb_trans_settings_sata sata;
925 } xport_specific;
926};
927
928
929/*
930 * Calculate the geometry parameters for a device
931 * give the block size and volume size in blocks.
932 */
933struct ccb_calc_geometry {
934 struct ccb_hdr ccb_h;
935 u_int32_t block_size;
936 u_int64_t volume_size;
937 u_int32_t cylinders;
938 u_int8_t heads;
939 u_int8_t secs_per_track;
940};
941
942/*
943 * Set or get SIM (and transport) specific knobs
944 */
945
946#define KNOB_VALID_ADDRESS 0x1
947#define KNOB_VALID_ROLE 0x2
948
949
950#define KNOB_ROLE_NONE 0x0
951#define KNOB_ROLE_INITIATOR 0x1
952#define KNOB_ROLE_TARGET 0x2
953#define KNOB_ROLE_BOTH 0x3
954
955struct ccb_sim_knob_settings_spi {
956 u_int valid;
957 u_int initiator_id;
958 u_int role;
959};
960
961struct ccb_sim_knob_settings_fc {
962 u_int valid;
963 u_int64_t wwnn; /* world wide node name */
964 u_int64_t wwpn; /* world wide port name */
965 u_int role;
966};
967
968struct ccb_sim_knob_settings_sas {
969 u_int valid;
970 u_int64_t wwnn; /* world wide node name */
971 u_int role;
972};
973#define KNOB_SETTINGS_SIZE 128
974
975struct ccb_sim_knob {
976 struct ccb_hdr ccb_h;
977 union {
978 u_int valid; /* Which fields to honor */
979 struct ccb_sim_knob_settings_spi spi;
980 struct ccb_sim_knob_settings_fc fc;
981 struct ccb_sim_knob_settings_sas sas;
982 char pad[KNOB_SETTINGS_SIZE];
983 } xport_specific;
984};
985
986/*
987 * Rescan the given bus, or bus/target/lun
988 */
989struct ccb_rescan {
990 struct ccb_hdr ccb_h;
991 cam_flags flags;
992};
993
994/*
995 * Turn on debugging for the given bus, bus/target, or bus/target/lun.
996 */
997struct ccb_debug {
998 struct ccb_hdr ccb_h;
999 cam_debug_flags flags;
1000};
1001
1002/* Target mode structures. */
1003
1004struct ccb_en_lun {
1005 struct ccb_hdr ccb_h;
1006 u_int16_t grp6_len; /* Group 6 VU CDB length */
1007 u_int16_t grp7_len; /* Group 7 VU CDB length */
1008 u_int8_t enable;
1009};
1010
1011/* old, barely used immediate notify, binary compatibility */
1012struct ccb_immed_notify {
1013 struct ccb_hdr ccb_h;
1014 struct scsi_sense_data sense_data;
1015 u_int8_t sense_len; /* Number of bytes in sense buffer */
1016 u_int8_t initiator_id; /* Id of initiator that selected */
1017 u_int8_t message_args[7]; /* Message Arguments */
1018};
1019
1020struct ccb_notify_ack {
1021 struct ccb_hdr ccb_h;
1022 u_int16_t seq_id; /* Sequence identifier */
1023 u_int8_t event; /* Event flags */
1024};
1025
1026struct ccb_immediate_notify {
1027 struct ccb_hdr ccb_h;
1028 u_int tag_id; /* Tag for immediate notify */
1029 u_int seq_id; /* Tag for target of notify */
1030 u_int initiator_id; /* Initiator Identifier */
1031 u_int arg; /* Function specific */
1032};
1033
1034struct ccb_notify_acknowledge {
1035 struct ccb_hdr ccb_h;
1036 u_int tag_id; /* Tag for immediate notify */
1037 u_int seq_id; /* Tar for target of notify */
1038 u_int initiator_id; /* Initiator Identifier */
1039 u_int arg; /* Function specific */
1040};
1041
1042/* HBA engine structures. */
1043
1044typedef enum {
1045 EIT_BUFFER, /* Engine type: buffer memory */
1046 EIT_LOSSLESS, /* Engine type: lossless compression */
1047 EIT_LOSSY, /* Engine type: lossy compression */
1048 EIT_ENCRYPT /* Engine type: encryption */
1049} ei_type;
1050
1051typedef enum {
1052 EAD_VUNIQUE, /* Engine algorithm ID: vendor unique */
1053 EAD_LZ1V1, /* Engine algorithm ID: LZ1 var.1 */
1054 EAD_LZ2V1, /* Engine algorithm ID: LZ2 var.1 */
1055 EAD_LZ2V2 /* Engine algorithm ID: LZ2 var.2 */
1056} ei_algo;
1057
1058struct ccb_eng_inq {
1059 struct ccb_hdr ccb_h;
1060 u_int16_t eng_num; /* The engine number for this inquiry */
1061 ei_type eng_type; /* Returned engine type */
1062 ei_algo eng_algo; /* Returned engine algorithm type */
1063 u_int32_t eng_memeory; /* Returned engine memory size */
1064};
1065
1066struct ccb_eng_exec { /* This structure must match SCSIIO size */
1067 struct ccb_hdr ccb_h;
1068 u_int8_t *pdrv_ptr; /* Ptr used by the peripheral driver */
1069 u_int8_t *req_map; /* Ptr for mapping info on the req. */
1070 u_int8_t *data_ptr; /* Pointer to the data buf/SG list */
1071 u_int32_t dxfer_len; /* Data transfer length */
1072 u_int8_t *engdata_ptr; /* Pointer to the engine buffer data */
1073 u_int16_t sglist_cnt; /* Num of scatter gather list entries */
1074 u_int32_t dmax_len; /* Destination data maximum length */
1075 u_int32_t dest_len; /* Destination data length */
1076 int32_t src_resid; /* Source residual length: 2's comp */
1077 u_int32_t timeout; /* Timeout value */
1078 u_int16_t eng_num; /* Engine number for this request */
1079 u_int16_t vu_flags; /* Vendor Unique flags */
1080};
1081
1082/*
1083 * Definitions for the timeout field in the SCSI I/O CCB.
1084 */
1085#define CAM_TIME_DEFAULT 0x00000000 /* Use SIM default value */
1086#define CAM_TIME_INFINITY 0xFFFFFFFF /* Infinite timeout */
1087
1088#define CAM_SUCCESS 0 /* For signaling general success */
1089#define CAM_FAILURE 1 /* For signaling general failure */
1090
1091#define CAM_FALSE 0
1092#define CAM_TRUE 1
1093
1094#define XPT_CCB_INVALID -1 /* for signaling a bad CCB to free */
1095
1096/*
1097 * CCB for getting advanced device information. This operates in a fashion
1098 * similar to XPT_GDEV_TYPE. Specify the target in ccb_h, the buffer
1099 * type requested, and provide a buffer size/buffer to write to. If the
1100 * buffer is too small, the handler will set GDEVAI_FLAG_MORE.
1101 */
1102struct ccb_getdev_advinfo {
1103 struct ccb_hdr ccb_h;
1104 uint32_t flags;
1105#define CGDAI_FLAG_TRANSPORT 0x1
1106#define CGDAI_FLAG_PROTO 0x2
1107 uint32_t buftype; /* IN: Type of data being requested */
1108 /* NB: buftype is interpreted on a per-transport basis */
1109#define CGDAI_TYPE_SCSI_DEVID 1
1110 off_t bufsiz; /* IN: Size of external buffer */
1111#define CAM_SCSI_DEVID_MAXLEN 65536 /* length in buffer is an uint16_t */
1112 off_t provsiz; /* OUT: Size required/used */
1113 uint8_t *buf; /* IN/OUT: Buffer for requested data */
1114};
1115
1116/*
1117 * Union of all CCB types for kernel space allocation. This union should
1118 * never be used for manipulating CCBs - its only use is for the allocation
1119 * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc
1120 * and the argument to xpt_ccb_free.
1121 */
1122union ccb {
1123 struct ccb_hdr ccb_h; /* For convenience */
1124 struct ccb_scsiio csio;
1125 struct ccb_getdev cgd;
1126 struct ccb_getdevlist cgdl;
1127 struct ccb_pathinq cpi;
1128 struct ccb_relsim crs;
1129 struct ccb_setasync csa;
1130 struct ccb_setdev csd;
1131 struct ccb_pathstats cpis;
1132 struct ccb_getdevstats cgds;
1133 struct ccb_dev_match cdm;
1134 struct ccb_trans_settings cts;
1135 struct ccb_calc_geometry ccg;
1136 struct ccb_sim_knob knob;
1137 struct ccb_abort cab;
1138 struct ccb_resetbus crb;
1139 struct ccb_resetdev crd;
1140 struct ccb_termio tio;
1141 struct ccb_accept_tio atio;
1142 struct ccb_scsiio ctio;
1143 struct ccb_en_lun cel;
1144 struct ccb_immed_notify cin;
1145 struct ccb_notify_ack cna;
1146 struct ccb_immediate_notify cin1;
1147 struct ccb_notify_acknowledge cna2;
1148 struct ccb_eng_inq cei;
1149 struct ccb_eng_exec cee;
1150 struct ccb_smpio smpio;
1151 struct ccb_rescan crcn;
1152 struct ccb_debug cdbg;
1153 struct ccb_ataio ataio;
1154 struct ccb_getdev_advinfo cgdai;
1155};
1156
1157__BEGIN_DECLS
1158static __inline void
1159cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
1160 void (*cbfcnp)(struct cam_periph *, union ccb *),
1161 u_int32_t flags, u_int8_t tag_action,
1162 u_int8_t *data_ptr, u_int32_t dxfer_len,
1163 u_int8_t sense_len, u_int8_t cdb_len,
1164 u_int32_t timeout);
1165
1166static __inline void
1167cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
1168 void (*cbfcnp)(struct cam_periph *, union ccb *),
1169 u_int32_t flags, u_int tag_action, u_int tag_id,
1170 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
1171 u_int32_t dxfer_len, u_int32_t timeout);
1172
1173static __inline void
1174cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries,
1175 void (*cbfcnp)(struct cam_periph *, union ccb *),
1176 u_int32_t flags, u_int tag_action,
1177 u_int8_t *data_ptr, u_int32_t dxfer_len,
1178 u_int32_t timeout);
1179
1180static __inline void
1181cam_fill_smpio(struct ccb_smpio *smpio, uint32_t retries,
1182 void (*cbfcnp)(struct cam_periph *, union ccb *), uint32_t flags,
1183 uint8_t *smp_request, int smp_request_len,
1184 uint8_t *smp_response, int smp_response_len,
1185 uint32_t timeout);
1186
1187static __inline void
1188cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
1189 void (*cbfcnp)(struct cam_periph *, union ccb *),
1190 u_int32_t flags, u_int8_t tag_action,
1191 u_int8_t *data_ptr, u_int32_t dxfer_len,
1192 u_int8_t sense_len, u_int8_t cdb_len,
1193 u_int32_t timeout)
1194{
1195 csio->ccb_h.func_code = XPT_SCSI_IO;
1196 csio->ccb_h.flags = flags;
1197 csio->ccb_h.retry_count = retries;
1198 csio->ccb_h.cbfcnp = cbfcnp;
1199 csio->ccb_h.timeout = timeout;
1200 csio->data_ptr = data_ptr;
1201 csio->dxfer_len = dxfer_len;
1202 csio->sense_len = sense_len;
1203 csio->cdb_len = cdb_len;
1204 csio->tag_action = tag_action;
1205}
1206
1207static __inline void
1208cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
1209 void (*cbfcnp)(struct cam_periph *, union ccb *),
1210 u_int32_t flags, u_int tag_action, u_int tag_id,
1211 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
1212 u_int32_t dxfer_len, u_int32_t timeout)
1213{
1214 csio->ccb_h.func_code = XPT_CONT_TARGET_IO;
1215 csio->ccb_h.flags = flags;
1216 csio->ccb_h.retry_count = retries;
1217 csio->ccb_h.cbfcnp = cbfcnp;
1218 csio->ccb_h.timeout = timeout;
1219 csio->data_ptr = data_ptr;
1220 csio->dxfer_len = dxfer_len;
1221 csio->scsi_status = scsi_status;
1222 csio->tag_action = tag_action;
1223 csio->tag_id = tag_id;
1224 csio->init_id = init_id;
1225}
1226
1227static __inline void
1228cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries,
1229 void (*cbfcnp)(struct cam_periph *, union ccb *),
1230 u_int32_t flags, u_int tag_action,
1231 u_int8_t *data_ptr, u_int32_t dxfer_len,
1232 u_int32_t timeout)
1233{
1234 ataio->ccb_h.func_code = XPT_ATA_IO;
1235 ataio->ccb_h.flags = flags;
1236 ataio->ccb_h.retry_count = retries;
1237 ataio->ccb_h.cbfcnp = cbfcnp;
1238 ataio->ccb_h.timeout = timeout;
1239 ataio->data_ptr = data_ptr;
1240 ataio->dxfer_len = dxfer_len;
1241 ataio->tag_action = tag_action;
1242}
1243
1244static __inline void
1245cam_fill_smpio(struct ccb_smpio *smpio, uint32_t retries,
1246 void (*cbfcnp)(struct cam_periph *, union ccb *), uint32_t flags,
1247 uint8_t *smp_request, int smp_request_len,
1248 uint8_t *smp_response, int smp_response_len,
1249 uint32_t timeout)
1250{
1251#ifdef _KERNEL
1252 KASSERT((flags & CAM_DIR_MASK) == CAM_DIR_BOTH,
1253 ("direction != CAM_DIR_BOTH"));
1254 KASSERT((smp_request != NULL) && (smp_response != NULL),
1255 ("need valid request and response buffers"));
1256 KASSERT((smp_request_len != 0) && (smp_response_len != 0),
1257 ("need non-zero request and response lengths"));
1258#endif /*_KERNEL*/
1259 smpio->ccb_h.func_code = XPT_SMP_IO;
1260 smpio->ccb_h.flags = flags;
1261 smpio->ccb_h.retry_count = retries;
1262 smpio->ccb_h.cbfcnp = cbfcnp;
1263 smpio->ccb_h.timeout = timeout;
1264 smpio->smp_request = smp_request;
1265 smpio->smp_request_len = smp_request_len;
1266 smpio->smp_response = smp_response;
1267 smpio->smp_response_len = smp_response_len;
1268}
1269
1270void cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended);
1271
1272__END_DECLS
1273
1274#endif /* _CAM_CAM_CCB_H */