2 * Data structures and definitions for CAM Control Blocks (CCBs).
4 * Copyright (c) 1997, 1998 Justin T. Gibbs.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
31 #ifndef _CAM_CAM_CCB_H
32 #define _CAM_CAM_CCB_H 1
34 #include <sys/queue.h>
35 #include <sys/cdefs.h>
37 #include <sys/limits.h>
39 #include <sys/callout.h>
41 #include <cam/cam_debug.h>
42 #include <cam/scsi/scsi_all.h>
43 #include <cam/ata/ata_all.h>
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 */
55 /* Struct definitions for CAM control blocks */
57 /* Common CCB header */
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
67 CAM_SCATTER_VALID = 0x00000010,/* Scatter/gather list is valid */
68 CAM_DIS_AUTOSENSE = 0x00000020,/* Disable autosense feature */
69 CAM_DIR_RESV = 0x00000000,/* Data direction (00:reserved) */
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 */
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 */
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 */
107 /* XPT Opcodes for xpt_action */
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 */
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 */
125 /* Get a list of peripheral devices */
127 /* Path routing inquiry */
129 /* Release a frozen SIM 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
136 /* (Re)Scan the SCSI Bus */
137 XPT_DEV_MATCH = 0x09 | XPT_FC_XPT_ONLY,
138 /* Get EDT entries matching the given pattern */
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 /* SCSI Control Functions: 0x10->0x1F */
147 /* Abort the specified CCB */
148 XPT_RESET_BUS = 0x11 | XPT_FC_XPT_ONLY,
149 /* Reset the specified SCSI bus */
150 XPT_RESET_DEV = 0x12 | XPT_FC_DEV_QUEUED,
151 /* Bus Device Reset the specified SCSI device */
153 /* Terminate the I/O process */
154 XPT_SCAN_LUN = 0x14 | XPT_FC_QUEUED | XPT_FC_USER_CCB
156 /* Scan Logical Unit */
157 XPT_GET_TRAN_SETTINGS = 0x15,
159 * Get default/user transfer settings
162 XPT_SET_TRAN_SETTINGS = 0x16,
164 * Set transfer rate/width
165 * negotiation settings
167 XPT_CALC_GEOMETRY = 0x17,
169 * Calculate the geometry parameters for
170 * a device give the sector size and
173 XPT_ATA_IO = 0x18 | XPT_FC_DEV_QUEUED,
174 /* Execute the requested ATA I/O operation */
176 XPT_GET_SIM_KNOB = 0x18,
178 * Get SIM specific knob values.
181 XPT_SET_SIM_KNOB = 0x19,
183 * Set SIM specific knob values.
185 /* HBA engine commands 0x20->0x2F */
186 XPT_ENG_INQ = 0x20 | XPT_FC_XPT_ONLY,
187 /* HBA engine feature inquiry */
188 XPT_ENG_EXEC = 0x21 | XPT_FC_DEV_QUEUED,
189 /* HBA execute engine request */
191 /* Target mode commands: 0x30->0x3F */
193 /* Enable LUN as a target */
194 XPT_TARGET_IO = 0x31 | XPT_FC_DEV_QUEUED,
195 /* Execute target I/O request */
196 XPT_ACCEPT_TARGET_IO = 0x32 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
197 /* Accept Host Target Mode CDB */
198 XPT_CONT_TARGET_IO = 0x33 | XPT_FC_DEV_QUEUED,
199 /* Continue Host Target I/O Connection */
200 XPT_IMMED_NOTIFY = 0x34 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
201 /* Notify Host Target driver of event (obsolete) */
202 XPT_NOTIFY_ACK = 0x35,
203 /* Acknowledgement of event (obsolete) */
204 XPT_IMMEDIATE_NOTIFY = 0x36 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
205 /* Notify Host Target driver of event */
206 XPT_NOTIFY_ACKNOWLEDGE = 0x37 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
207 /* Acknowledgement of event */
209 /* Vendor Unique codes: 0x80->0x8F */
213 #define XPT_FC_GROUP_MASK 0xF0
214 #define XPT_FC_GROUP(op) ((op) & XPT_FC_GROUP_MASK)
215 #define XPT_FC_GROUP_COMMON 0x00
216 #define XPT_FC_GROUP_SCSI_CONTROL 0x10
217 #define XPT_FC_GROUP_HBA_ENGINE 0x20
218 #define XPT_FC_GROUP_TMODE 0x30
219 #define XPT_FC_GROUP_VENDOR_UNIQUE 0x80
221 #define XPT_FC_IS_DEV_QUEUED(ccb) \
222 (((ccb)->ccb_h.func_code & XPT_FC_DEV_QUEUED) == XPT_FC_DEV_QUEUED)
223 #define XPT_FC_IS_QUEUED(ccb) \
224 (((ccb)->ccb_h.func_code & XPT_FC_QUEUED) != 0)
229 PROTO_SCSI, /* Small Computer System Interface */
230 PROTO_ATA, /* AT Attachment */
231 PROTO_ATAPI, /* AT Attachment Packetized Interface */
232 PROTO_SATAPM, /* SATA Port Multiplier */
238 XPORT_SPI, /* SCSI Parallel Interface */
239 XPORT_FC, /* Fiber Channel */
240 XPORT_SSA, /* Serial Storage Architecture */
241 XPORT_USB, /* Universal Serial Bus */
242 XPORT_PPB, /* Parallel Port Bus */
243 XPORT_ATA, /* AT Attachment */
244 XPORT_SAS, /* Serial Attached SCSI */
245 XPORT_SATA, /* Serial AT Attachment */
248 #define PROTO_VERSION_UNKNOWN (UINT_MAX - 1)
249 #define PROTO_VERSION_UNSPECIFIED UINT_MAX
250 #define XPORT_VERSION_UNKNOWN (UINT_MAX - 1)
251 #define XPORT_VERSION_UNSPECIFIED UINT_MAX
254 LIST_ENTRY(ccb_hdr) le;
255 SLIST_ENTRY(ccb_hdr) sle;
256 TAILQ_ENTRY(ccb_hdr) tqe;
257 STAILQ_ENTRY(ccb_hdr) stqe;
263 u_int8_t bytes[sizeof(uintptr_t)];
267 ccb_priv_entry entries[CCB_PERIPH_PRIV_SIZE];
268 u_int8_t bytes[CCB_PERIPH_PRIV_SIZE * sizeof(ccb_priv_entry)];
272 ccb_priv_entry entries[CCB_SIM_PRIV_SIZE];
273 u_int8_t bytes[CCB_SIM_PRIV_SIZE * sizeof(ccb_priv_entry)];
277 cam_pinfo pinfo; /* Info for priority scheduling */
278 camq_entry xpt_links; /* For chaining in the XPT layer */
279 camq_entry sim_links; /* For chaining in the SIM layer */
280 camq_entry periph_links; /* For chaining in the type driver */
281 u_int32_t retry_count;
282 void (*cbfcnp)(struct cam_periph *, union ccb *);
283 /* Callback on completion function */
284 xpt_opcode func_code; /* XPT function code */
285 u_int32_t status; /* Status returned by CAM subsystem */
286 struct cam_path *path; /* Compiled path for this ccb */
287 path_id_t path_id; /* Path ID for the request */
288 target_id_t target_id; /* Target device ID */
289 lun_id_t target_lun; /* Target LUN number */
290 u_int32_t flags; /* ccb_flags */
291 ccb_ppriv_area periph_priv;
292 ccb_spriv_area sim_priv;
293 u_int32_t timeout; /* Timeout value */
296 * Deprecated, only for use by non-MPSAFE SIMs. All others must
297 * allocate and initialize their own callout storage.
299 struct callout_handle timeout_ch;
302 /* Get Device Information CCB */
304 struct ccb_hdr ccb_h;
306 struct scsi_inquiry_data inq_data;
307 struct ata_params ident_data;
308 u_int8_t serial_num[252];
310 u_int8_t serial_num_len;
313 /* Device Statistics CCB */
314 struct ccb_getdevstats {
315 struct ccb_hdr ccb_h;
316 int dev_openings; /* Space left for more work on device*/
317 int dev_active; /* Transactions running on the device */
318 int devq_openings; /* Space left for more queued work */
319 int devq_queued; /* Transactions queued to be sent */
321 * CCBs held by peripheral drivers
325 * Boundary conditions for number of
329 struct timeval last_reset; /* Time of last bus reset/loop init */
333 CAM_GDEVLIST_LAST_DEVICE,
334 CAM_GDEVLIST_LIST_CHANGED,
335 CAM_GDEVLIST_MORE_DEVS,
337 } ccb_getdevlist_status_e;
339 struct ccb_getdevlist {
340 struct ccb_hdr ccb_h;
341 char periph_name[DEV_IDLEN];
342 u_int32_t unit_number;
343 unsigned int generation;
345 ccb_getdevlist_status_e status;
349 PERIPH_MATCH_NONE = 0x000,
350 PERIPH_MATCH_PATH = 0x001,
351 PERIPH_MATCH_TARGET = 0x002,
352 PERIPH_MATCH_LUN = 0x004,
353 PERIPH_MATCH_NAME = 0x008,
354 PERIPH_MATCH_UNIT = 0x010,
355 PERIPH_MATCH_ANY = 0x01f
356 } periph_pattern_flags;
358 struct periph_match_pattern {
359 char periph_name[DEV_IDLEN];
360 u_int32_t unit_number;
362 target_id_t target_id;
364 periph_pattern_flags flags;
368 DEV_MATCH_NONE = 0x000,
369 DEV_MATCH_PATH = 0x001,
370 DEV_MATCH_TARGET = 0x002,
371 DEV_MATCH_LUN = 0x004,
372 DEV_MATCH_INQUIRY = 0x008,
373 DEV_MATCH_ANY = 0x00f
376 struct device_match_pattern {
378 target_id_t target_id;
380 struct scsi_static_inquiry_pattern inq_pat;
381 dev_pattern_flags flags;
385 BUS_MATCH_NONE = 0x000,
386 BUS_MATCH_PATH = 0x001,
387 BUS_MATCH_NAME = 0x002,
388 BUS_MATCH_UNIT = 0x004,
389 BUS_MATCH_BUS_ID = 0x008,
390 BUS_MATCH_ANY = 0x00f
393 struct bus_match_pattern {
395 char dev_name[DEV_IDLEN];
396 u_int32_t unit_number;
398 bus_pattern_flags flags;
401 union match_pattern {
402 struct periph_match_pattern periph_pattern;
403 struct device_match_pattern device_pattern;
404 struct bus_match_pattern bus_pattern;
413 struct dev_match_pattern {
415 union match_pattern pattern;
418 struct periph_match_result {
419 char periph_name[DEV_IDLEN];
420 u_int32_t unit_number;
422 target_id_t target_id;
427 DEV_RESULT_NOFLAG = 0x00,
428 DEV_RESULT_UNCONFIGURED = 0x01
431 struct device_match_result {
433 target_id_t target_id;
436 struct scsi_inquiry_data inq_data;
437 struct ata_params ident_data;
438 dev_result_flags flags;
441 struct bus_match_result {
443 char dev_name[DEV_IDLEN];
444 u_int32_t unit_number;
449 struct periph_match_result periph_result;
450 struct device_match_result device_result;
451 struct bus_match_result bus_result;
454 struct dev_match_result {
456 union match_result result;
462 CAM_DEV_MATCH_LIST_CHANGED,
463 CAM_DEV_MATCH_SIZE_ERROR,
465 } ccb_dev_match_status;
468 CAM_DEV_POS_NONE = 0x000,
469 CAM_DEV_POS_BUS = 0x001,
470 CAM_DEV_POS_TARGET = 0x002,
471 CAM_DEV_POS_DEVICE = 0x004,
472 CAM_DEV_POS_PERIPH = 0x008,
473 CAM_DEV_POS_PDPTR = 0x010,
474 CAM_DEV_POS_TYPEMASK = 0xf00,
475 CAM_DEV_POS_EDT = 0x100,
476 CAM_DEV_POS_PDRV = 0x200
479 struct ccb_dm_cookie {
487 struct ccb_dev_position {
488 u_int generations[4];
489 #define CAM_BUS_GENERATION 0x00
490 #define CAM_TARGET_GENERATION 0x01
491 #define CAM_DEV_GENERATION 0x02
492 #define CAM_PERIPH_GENERATION 0x03
493 dev_pos_type position_type;
494 struct ccb_dm_cookie cookie;
497 struct ccb_dev_match {
498 struct ccb_hdr ccb_h;
499 ccb_dev_match_status status;
500 u_int32_t num_patterns;
501 u_int32_t pattern_buf_len;
502 struct dev_match_pattern *patterns;
503 u_int32_t num_matches;
504 u_int32_t match_buf_len;
505 struct dev_match_result *matches;
506 struct ccb_dev_position pos;
510 * Definitions for the path inquiry CCB fields.
512 #define CAM_VERSION 0x15 /* Hex value for current version */
515 PI_MDP_ABLE = 0x80, /* Supports MDP message */
516 PI_WIDE_32 = 0x40, /* Supports 32 bit wide SCSI */
517 PI_WIDE_16 = 0x20, /* Supports 16 bit wide SCSI */
518 PI_SDTR_ABLE = 0x10, /* Supports SDTR message */
519 PI_LINKED_CDB = 0x08, /* Supports linked CDBs */
520 PI_SATAPM = 0x04, /* Supports SATA PM */
521 PI_TAG_ABLE = 0x02, /* Supports tag queue messages */
522 PI_SOFT_RST = 0x01 /* Supports soft reset alternative */
526 PIT_PROCESSOR = 0x80, /* Target mode processor mode */
527 PIT_PHASE = 0x40, /* Target mode phase cog. mode */
528 PIT_DISCONNECT = 0x20, /* Disconnects supported in target mode */
529 PIT_TERM_IO = 0x10, /* Terminate I/O message supported in TM */
530 PIT_GRP_6 = 0x08, /* Group 6 commands supported */
531 PIT_GRP_7 = 0x04 /* Group 7 commands supported */
535 PIM_SCANHILO = 0x80, /* Bus scans from high ID to low ID */
536 PIM_NOREMOVE = 0x40, /* Removeable devices not included in scan */
537 PIM_NOINITIATOR = 0x20, /* Initiator role not supported. */
538 PIM_NOBUSRESET = 0x10, /* User has disabled initial BUS RESET */
539 PIM_NO_6_BYTE = 0x08, /* Do not send 6-byte commands */
540 PIM_SEQSCAN = 0x04 /* Do bus scans sequentially, not in parallel */
543 /* Path Inquiry CCB */
544 struct ccb_pathinq_settings_spi {
545 u_int8_t ppr_options;
548 struct ccb_pathinq_settings_fc {
549 u_int64_t wwnn; /* world wide node name */
550 u_int64_t wwpn; /* world wide port name */
551 u_int32_t port; /* 24 bit port id, if known */
552 u_int32_t bitrate; /* Mbps */
555 struct ccb_pathinq_settings_sas {
556 u_int32_t bitrate; /* Mbps */
558 #define PATHINQ_SETTINGS_SIZE 128
561 struct ccb_hdr ccb_h;
562 u_int8_t version_num; /* Version number for the SIM/HBA */
563 u_int8_t hba_inquiry; /* Mimic of INQ byte 7 for the HBA */
564 u_int8_t target_sprt; /* Flags for target mode support */
565 u_int8_t hba_misc; /* Misc HBA features */
566 u_int16_t hba_eng_cnt; /* HBA engine count */
567 /* Vendor Unique capabilities */
568 u_int8_t vuhba_flags[VUHBALEN];
569 u_int32_t max_target; /* Maximum supported Target */
570 u_int32_t max_lun; /* Maximum supported Lun */
571 u_int32_t async_flags; /* Installed Async handlers */
572 path_id_t hpath_id; /* Highest Path ID in the subsystem */
573 target_id_t initiator_id; /* ID of the HBA on the SCSI bus */
574 char sim_vid[SIM_IDLEN]; /* Vendor ID of the SIM */
575 char hba_vid[HBA_IDLEN]; /* Vendor ID of the HBA */
576 char dev_name[DEV_IDLEN];/* Device name for SIM */
577 u_int32_t unit_number; /* Unit number for SIM */
578 u_int32_t bus_id; /* Bus ID for SIM */
579 u_int32_t base_transfer_speed;/* Base bus speed in KB/sec */
581 u_int protocol_version;
583 u_int transport_version;
585 struct ccb_pathinq_settings_spi spi;
586 struct ccb_pathinq_settings_fc fc;
587 struct ccb_pathinq_settings_sas sas;
588 char ccb_pathinq_settings_opaque[PATHINQ_SETTINGS_SIZE];
590 u_int maxio; /* Max supported I/O size, in bytes. */
593 /* Path Statistics CCB */
594 struct ccb_pathstats {
595 struct ccb_hdr ccb_h;
596 struct timeval last_reset; /* Time of last bus reset/loop init */
600 u_int8_t *sense_ptr; /*
602 * for sense information
604 /* Storage Area for sense information */
605 struct scsi_sense_data sense_buf;
609 u_int8_t *cdb_ptr; /* Pointer to the CDB bytes to send */
610 /* Area for the CDB send */
611 u_int8_t cdb_bytes[IOCDBLEN];
615 * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO
619 struct ccb_hdr ccb_h;
620 union ccb *next_ccb; /* Ptr for next CCB for action */
621 u_int8_t *req_map; /* Ptr to mapping info */
622 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */
623 u_int32_t dxfer_len; /* Data transfer length */
624 /* Autosense storage */
625 struct scsi_sense_data sense_data;
626 u_int8_t sense_len; /* Number of bytes to autosense */
627 u_int8_t cdb_len; /* Number of bytes for the CDB */
628 u_int16_t sglist_cnt; /* Number of SG list entries */
629 u_int8_t scsi_status; /* Returned SCSI status */
630 u_int8_t sense_resid; /* Autosense resid length: 2's comp */
631 u_int32_t resid; /* Transfer residual length: 2's comp */
632 cdb_t cdb_io; /* Union for CDB bytes/pointer */
633 u_int8_t *msg_ptr; /* Pointer to the message buffer */
634 u_int16_t msg_len; /* Number of bytes for the Message */
635 u_int8_t tag_action; /* What to do for tag queueing */
637 * The tag action should be either the define below (to send a
638 * non-tagged transaction) or one of the defined scsi tag messages
639 * from scsi_message.h.
641 #define CAM_TAG_ACTION_NONE 0x00
642 u_int tag_id; /* tag id from initator (target mode) */
643 u_int init_id; /* initiator id of who selected */
647 * ATA I/O Request CCB used for the XPT_ATA_IO function code.
650 struct ccb_hdr ccb_h;
651 union ccb *next_ccb; /* Ptr for next CCB for action */
652 struct ata_cmd cmd; /* ATA command register set */
653 struct ata_res res; /* ATA result register set */
654 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */
655 u_int32_t dxfer_len; /* Data transfer length */
656 u_int32_t resid; /* Transfer residual length: 2's comp */
657 u_int8_t tag_action; /* What to do for tag queueing */
659 * The tag action should be either the define below (to send a
660 * non-tagged transaction) or one of the defined scsi tag messages
661 * from scsi_message.h.
663 #define CAM_TAG_ACTION_NONE 0x00
664 u_int tag_id; /* tag id from initator (target mode) */
665 u_int init_id; /* initiator id of who selected */
668 struct ccb_accept_tio {
669 struct ccb_hdr ccb_h;
670 cdb_t cdb_io; /* Union for CDB bytes/pointer */
671 u_int8_t cdb_len; /* Number of bytes for the CDB */
672 u_int8_t tag_action; /* What to do for tag queueing */
673 u_int8_t sense_len; /* Number of bytes of Sense Data */
674 u_int tag_id; /* tag id from initator (target mode) */
675 u_int init_id; /* initiator id of who selected */
676 struct scsi_sense_data sense_data;
679 /* Release SIM Queue */
681 struct ccb_hdr ccb_h;
682 u_int32_t release_flags;
683 #define RELSIM_ADJUST_OPENINGS 0x01
684 #define RELSIM_RELEASE_AFTER_TIMEOUT 0x02
685 #define RELSIM_RELEASE_AFTER_CMDCMPLT 0x04
686 #define RELSIM_RELEASE_AFTER_QEMPTY 0x08
688 u_int32_t release_timeout;
689 u_int32_t qfrozen_cnt;
693 * Definitions for the asynchronous callback CCB fields.
696 AC_CONTRACT = 0x1000,/* A contractual callback */
697 AC_GETDEV_CHANGED = 0x800,/* Getdev info might have changed */
698 AC_INQ_CHANGED = 0x400,/* Inquiry info might have changed */
699 AC_TRANSFER_NEG = 0x200,/* New transfer settings in effect */
700 AC_LOST_DEVICE = 0x100,/* A device went away */
701 AC_FOUND_DEVICE = 0x080,/* A new device was found */
702 AC_PATH_DEREGISTERED = 0x040,/* A path has de-registered */
703 AC_PATH_REGISTERED = 0x020,/* A new path has been registered */
704 AC_SENT_BDR = 0x010,/* A BDR message was sent to target */
705 AC_SCSI_AEN = 0x008,/* A SCSI AEN has been received */
706 AC_UNSOL_RESEL = 0x002,/* Unsolicited reselection occurred */
707 AC_BUS_RESET = 0x001 /* A SCSI bus reset occurred */
710 typedef void ac_callback_t (void *softc, u_int32_t code,
711 struct cam_path *path, void *args);
714 * Generic Asynchronous callbacks.
716 * Generic arguments passed bac which are then interpreted between a per-system
719 #define AC_CONTRACT_DATA_MAX (128 - sizeof (u_int64_t))
721 u_int64_t contract_number;
722 u_int8_t contract_data[AC_CONTRACT_DATA_MAX];
725 #define AC_CONTRACT_DEV_CHG 1
726 struct ac_device_changed {
733 /* Set Asynchronous Callback CCB */
734 struct ccb_setasync {
735 struct ccb_hdr ccb_h;
736 u_int32_t event_enable; /* Async Event enables */
737 ac_callback_t *callback;
741 /* Set Device Type CCB */
743 struct ccb_hdr ccb_h;
744 u_int8_t dev_type; /* Value for dev type field in EDT */
747 /* SCSI Control Functions */
749 /* Abort XPT request CCB */
751 struct ccb_hdr ccb_h;
752 union ccb *abort_ccb; /* Pointer to CCB to abort */
755 /* Reset SCSI Bus CCB */
756 struct ccb_resetbus {
757 struct ccb_hdr ccb_h;
760 /* Reset SCSI Device CCB */
761 struct ccb_resetdev {
762 struct ccb_hdr ccb_h;
765 /* Terminate I/O Process Request CCB */
767 struct ccb_hdr ccb_h;
768 union ccb *termio_ccb; /* Pointer to CCB to terminate */
772 CTS_TYPE_CURRENT_SETTINGS,
773 CTS_TYPE_USER_SETTINGS
776 struct ccb_trans_settings_scsi
778 u_int valid; /* Which fields to honor */
779 #define CTS_SCSI_VALID_TQ 0x01
781 #define CTS_SCSI_FLAGS_TAG_ENB 0x01
784 struct ccb_trans_settings_spi
786 u_int valid; /* Which fields to honor */
787 #define CTS_SPI_VALID_SYNC_RATE 0x01
788 #define CTS_SPI_VALID_SYNC_OFFSET 0x02
789 #define CTS_SPI_VALID_BUS_WIDTH 0x04
790 #define CTS_SPI_VALID_DISC 0x08
791 #define CTS_SPI_VALID_PPR_OPTIONS 0x10
793 #define CTS_SPI_FLAGS_DISC_ENB 0x01
800 struct ccb_trans_settings_fc {
801 u_int valid; /* Which fields to honor */
802 #define CTS_FC_VALID_WWNN 0x8000
803 #define CTS_FC_VALID_WWPN 0x4000
804 #define CTS_FC_VALID_PORT 0x2000
805 #define CTS_FC_VALID_SPEED 0x1000
806 u_int64_t wwnn; /* world wide node name */
807 u_int64_t wwpn; /* world wide port name */
808 u_int32_t port; /* 24 bit port id, if known */
809 u_int32_t bitrate; /* Mbps */
812 struct ccb_trans_settings_sas {
813 u_int valid; /* Which fields to honor */
814 #define CTS_SAS_VALID_SPEED 0x1000
815 u_int32_t bitrate; /* Mbps */
818 struct ccb_trans_settings_sata {
819 u_int valid; /* Which fields to honor */
820 #define CTS_SATA_VALID_SPEED 0x01
821 #define CTS_SATA_VALID_PM 0x02
822 u_int32_t bitrate; /* Mbps */
823 u_int pm_present; /* PM is present (XPT->SIM) */
826 /* Get/Set transfer rate/width/disconnection/tag queueing settings */
827 struct ccb_trans_settings {
828 struct ccb_hdr ccb_h;
829 cts_type type; /* Current or User settings */
831 u_int protocol_version;
833 u_int transport_version;
835 u_int valid; /* Which fields to honor */
836 struct ccb_trans_settings_scsi scsi;
839 u_int valid; /* Which fields to honor */
840 struct ccb_trans_settings_spi spi;
841 struct ccb_trans_settings_fc fc;
842 struct ccb_trans_settings_sas sas;
843 struct ccb_trans_settings_sata sata;
849 * Calculate the geometry parameters for a device
850 * give the block size and volume size in blocks.
852 struct ccb_calc_geometry {
853 struct ccb_hdr ccb_h;
854 u_int32_t block_size;
855 u_int64_t volume_size;
858 u_int8_t secs_per_track;
862 * Set or get SIM (and transport) specific knobs
865 #define KNOB_VALID_ADDRESS 0x1
866 #define KNOB_VALID_ROLE 0x2
869 #define KNOB_ROLE_NONE 0x0
870 #define KNOB_ROLE_INITIATOR 0x1
871 #define KNOB_ROLE_TARGET 0x2
872 #define KNOB_ROLE_BOTH 0x3
874 struct ccb_sim_knob_settings_spi {
880 struct ccb_sim_knob_settings_fc {
882 u_int64_t wwnn; /* world wide node name */
883 u_int64_t wwpn; /* world wide port name */
887 struct ccb_sim_knob_settings_sas {
889 u_int64_t wwnn; /* world wide node name */
892 #define KNOB_SETTINGS_SIZE 128
894 struct ccb_sim_knob {
895 struct ccb_hdr ccb_h;
897 u_int valid; /* Which fields to honor */
898 struct ccb_sim_knob_settings_spi spi;
899 struct ccb_sim_knob_settings_fc fc;
900 struct ccb_sim_knob_settings_sas sas;
901 char pad[KNOB_SETTINGS_SIZE];
906 * Rescan the given bus, or bus/target/lun
909 struct ccb_hdr ccb_h;
914 * Turn on debugging for the given bus, bus/target, or bus/target/lun.
917 struct ccb_hdr ccb_h;
918 cam_debug_flags flags;
921 /* Target mode structures. */
924 struct ccb_hdr ccb_h;
925 u_int16_t grp6_len; /* Group 6 VU CDB length */
926 u_int16_t grp7_len; /* Group 7 VU CDB length */
930 /* old, barely used immediate notify, binary compatibility */
931 struct ccb_immed_notify {
932 struct ccb_hdr ccb_h;
933 struct scsi_sense_data sense_data;
934 u_int8_t sense_len; /* Number of bytes in sense buffer */
935 u_int8_t initiator_id; /* Id of initiator that selected */
936 u_int8_t message_args[7]; /* Message Arguments */
939 struct ccb_notify_ack {
940 struct ccb_hdr ccb_h;
941 u_int16_t seq_id; /* Sequence identifier */
942 u_int8_t event; /* Event flags */
945 struct ccb_immediate_notify {
946 struct ccb_hdr ccb_h;
947 u_int tag_id; /* Tag for immediate notify */
948 u_int seq_id; /* Tag for target of notify */
949 u_int initiator_id; /* Initiator Identifier */
950 u_int arg; /* Function specific */
953 struct ccb_notify_acknowledge {
954 struct ccb_hdr ccb_h;
955 u_int tag_id; /* Tag for immediate notify */
956 u_int seq_id; /* Tar for target of notify */
957 u_int initiator_id; /* Initiator Identifier */
958 u_int arg; /* Function specific */
961 /* HBA engine structures. */
964 EIT_BUFFER, /* Engine type: buffer memory */
965 EIT_LOSSLESS, /* Engine type: lossless compression */
966 EIT_LOSSY, /* Engine type: lossy compression */
967 EIT_ENCRYPT /* Engine type: encryption */
971 EAD_VUNIQUE, /* Engine algorithm ID: vendor unique */
972 EAD_LZ1V1, /* Engine algorithm ID: LZ1 var.1 */
973 EAD_LZ2V1, /* Engine algorithm ID: LZ2 var.1 */
974 EAD_LZ2V2 /* Engine algorithm ID: LZ2 var.2 */
978 struct ccb_hdr ccb_h;
979 u_int16_t eng_num; /* The engine number for this inquiry */
980 ei_type eng_type; /* Returned engine type */
981 ei_algo eng_algo; /* Returned engine algorithm type */
982 u_int32_t eng_memeory; /* Returned engine memory size */
985 struct ccb_eng_exec { /* This structure must match SCSIIO size */
986 struct ccb_hdr ccb_h;
987 u_int8_t *pdrv_ptr; /* Ptr used by the peripheral driver */
988 u_int8_t *req_map; /* Ptr for mapping info on the req. */
989 u_int8_t *data_ptr; /* Pointer to the data buf/SG list */
990 u_int32_t dxfer_len; /* Data transfer length */
991 u_int8_t *engdata_ptr; /* Pointer to the engine buffer data */
992 u_int16_t sglist_cnt; /* Num of scatter gather list entries */
993 u_int32_t dmax_len; /* Destination data maximum length */
994 u_int32_t dest_len; /* Destination data length */
995 int32_t src_resid; /* Source residual length: 2's comp */
996 u_int32_t timeout; /* Timeout value */
997 u_int16_t eng_num; /* Engine number for this request */
998 u_int16_t vu_flags; /* Vendor Unique flags */
1002 * Definitions for the timeout field in the SCSI I/O CCB.
1004 #define CAM_TIME_DEFAULT 0x00000000 /* Use SIM default value */
1005 #define CAM_TIME_INFINITY 0xFFFFFFFF /* Infinite timeout */
1007 #define CAM_SUCCESS 0 /* For signaling general success */
1008 #define CAM_FAILURE 1 /* For signaling general failure */
1013 #define XPT_CCB_INVALID -1 /* for signaling a bad CCB to free */
1016 * Union of all CCB types for kernel space allocation. This union should
1017 * never be used for manipulating CCBs - its only use is for the allocation
1018 * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc
1019 * and the argument to xpt_ccb_free.
1022 struct ccb_hdr ccb_h; /* For convenience */
1023 struct ccb_scsiio csio;
1024 struct ccb_getdev cgd;
1025 struct ccb_getdevlist cgdl;
1026 struct ccb_pathinq cpi;
1027 struct ccb_relsim crs;
1028 struct ccb_setasync csa;
1029 struct ccb_setdev csd;
1030 struct ccb_pathstats cpis;
1031 struct ccb_getdevstats cgds;
1032 struct ccb_dev_match cdm;
1033 struct ccb_trans_settings cts;
1034 struct ccb_calc_geometry ccg;
1035 struct ccb_sim_knob knob;
1036 struct ccb_abort cab;
1037 struct ccb_resetbus crb;
1038 struct ccb_resetdev crd;
1039 struct ccb_termio tio;
1040 struct ccb_accept_tio atio;
1041 struct ccb_scsiio ctio;
1042 struct ccb_en_lun cel;
1043 struct ccb_immed_notify cin;
1044 struct ccb_notify_ack cna;
1045 struct ccb_immediate_notify cin1;
1046 struct ccb_notify_acknowledge cna2;
1047 struct ccb_eng_inq cei;
1048 struct ccb_eng_exec cee;
1049 struct ccb_rescan crcn;
1050 struct ccb_debug cdbg;
1051 struct ccb_ataio ataio;
1055 static __inline void
1056 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
1057 void (*cbfcnp)(struct cam_periph *, union ccb *),
1058 u_int32_t flags, u_int8_t tag_action,
1059 u_int8_t *data_ptr, u_int32_t dxfer_len,
1060 u_int8_t sense_len, u_int8_t cdb_len,
1063 static __inline void
1064 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
1065 void (*cbfcnp)(struct cam_periph *, union ccb *),
1066 u_int32_t flags, u_int tag_action, u_int tag_id,
1067 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
1068 u_int32_t dxfer_len, u_int32_t timeout);
1070 static __inline void
1071 cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries,
1072 void (*cbfcnp)(struct cam_periph *, union ccb *),
1073 u_int32_t flags, u_int tag_action,
1074 u_int8_t *data_ptr, u_int32_t dxfer_len,
1077 static __inline void
1078 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
1079 void (*cbfcnp)(struct cam_periph *, union ccb *),
1080 u_int32_t flags, u_int8_t tag_action,
1081 u_int8_t *data_ptr, u_int32_t dxfer_len,
1082 u_int8_t sense_len, u_int8_t cdb_len,
1085 csio->ccb_h.func_code = XPT_SCSI_IO;
1086 csio->ccb_h.flags = flags;
1087 csio->ccb_h.retry_count = retries;
1088 csio->ccb_h.cbfcnp = cbfcnp;
1089 csio->ccb_h.timeout = timeout;
1090 csio->data_ptr = data_ptr;
1091 csio->dxfer_len = dxfer_len;
1092 csio->sense_len = sense_len;
1093 csio->cdb_len = cdb_len;
1094 csio->tag_action = tag_action;
1097 static __inline void
1098 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
1099 void (*cbfcnp)(struct cam_periph *, union ccb *),
1100 u_int32_t flags, u_int tag_action, u_int tag_id,
1101 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
1102 u_int32_t dxfer_len, u_int32_t timeout)
1104 csio->ccb_h.func_code = XPT_CONT_TARGET_IO;
1105 csio->ccb_h.flags = flags;
1106 csio->ccb_h.retry_count = retries;
1107 csio->ccb_h.cbfcnp = cbfcnp;
1108 csio->ccb_h.timeout = timeout;
1109 csio->data_ptr = data_ptr;
1110 csio->dxfer_len = dxfer_len;
1111 csio->scsi_status = scsi_status;
1112 csio->tag_action = tag_action;
1113 csio->tag_id = tag_id;
1114 csio->init_id = init_id;
1117 static __inline void
1118 cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries,
1119 void (*cbfcnp)(struct cam_periph *, union ccb *),
1120 u_int32_t flags, u_int tag_action,
1121 u_int8_t *data_ptr, u_int32_t dxfer_len,
1124 ataio->ccb_h.func_code = XPT_ATA_IO;
1125 ataio->ccb_h.flags = flags;
1126 ataio->ccb_h.retry_count = retries;
1127 ataio->ccb_h.cbfcnp = cbfcnp;
1128 ataio->ccb_h.timeout = timeout;
1129 ataio->data_ptr = data_ptr;
1130 ataio->dxfer_len = dxfer_len;
1131 ataio->tag_action = tag_action;
1134 void cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended);
1138 #endif /* _CAM_CAM_CCB_H */