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 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
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 XPT_FREEZE_QUEUE = 0x0d,
146 /* Freeze device queue */
147 /* SCSI Control Functions: 0x10->0x1F */
149 /* Abort the specified CCB */
150 XPT_RESET_BUS = 0x11 | XPT_FC_XPT_ONLY,
151 /* Reset the specified SCSI bus */
152 XPT_RESET_DEV = 0x12 | XPT_FC_DEV_QUEUED,
153 /* Bus Device Reset the specified SCSI device */
155 /* Terminate the I/O process */
156 XPT_SCAN_LUN = 0x14 | XPT_FC_QUEUED | XPT_FC_USER_CCB
158 /* Scan Logical Unit */
159 XPT_GET_TRAN_SETTINGS = 0x15,
161 * Get default/user transfer settings
164 XPT_SET_TRAN_SETTINGS = 0x16,
166 * Set transfer rate/width
167 * negotiation settings
169 XPT_CALC_GEOMETRY = 0x17,
171 * Calculate the geometry parameters for
172 * a device give the sector size and
175 XPT_ATA_IO = 0x18 | XPT_FC_DEV_QUEUED,
176 /* Execute the requested ATA I/O operation */
178 XPT_GET_SIM_KNOB = 0x18,
180 * Get SIM specific knob values.
183 XPT_SET_SIM_KNOB = 0x19,
185 * Set SIM specific knob values.
188 XPT_SCAN_TGT = 0x1E | XPT_FC_QUEUED | XPT_FC_USER_CCB
192 /* HBA engine commands 0x20->0x2F */
193 XPT_ENG_INQ = 0x20 | XPT_FC_XPT_ONLY,
194 /* HBA engine feature inquiry */
195 XPT_ENG_EXEC = 0x21 | XPT_FC_DEV_QUEUED,
196 /* HBA execute engine request */
198 /* Target mode commands: 0x30->0x3F */
200 /* Enable LUN as a target */
201 XPT_TARGET_IO = 0x31 | XPT_FC_DEV_QUEUED,
202 /* Execute target I/O request */
203 XPT_ACCEPT_TARGET_IO = 0x32 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
204 /* Accept Host Target Mode CDB */
205 XPT_CONT_TARGET_IO = 0x33 | XPT_FC_DEV_QUEUED,
206 /* Continue Host Target I/O Connection */
207 XPT_IMMED_NOTIFY = 0x34 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
208 /* Notify Host Target driver of event (obsolete) */
209 XPT_NOTIFY_ACK = 0x35,
210 /* Acknowledgement of event (obsolete) */
211 XPT_IMMEDIATE_NOTIFY = 0x36 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
212 /* Notify Host Target driver of event */
213 XPT_NOTIFY_ACKNOWLEDGE = 0x37 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
214 /* Acknowledgement of event */
216 /* Vendor Unique codes: 0x80->0x8F */
220 #define XPT_FC_GROUP_MASK 0xF0
221 #define XPT_FC_GROUP(op) ((op) & XPT_FC_GROUP_MASK)
222 #define XPT_FC_GROUP_COMMON 0x00
223 #define XPT_FC_GROUP_SCSI_CONTROL 0x10
224 #define XPT_FC_GROUP_HBA_ENGINE 0x20
225 #define XPT_FC_GROUP_TMODE 0x30
226 #define XPT_FC_GROUP_VENDOR_UNIQUE 0x80
228 #define XPT_FC_IS_DEV_QUEUED(ccb) \
229 (((ccb)->ccb_h.func_code & XPT_FC_DEV_QUEUED) == XPT_FC_DEV_QUEUED)
230 #define XPT_FC_IS_QUEUED(ccb) \
231 (((ccb)->ccb_h.func_code & XPT_FC_QUEUED) != 0)
236 PROTO_SCSI, /* Small Computer System Interface */
237 PROTO_ATA, /* AT Attachment */
238 PROTO_ATAPI, /* AT Attachment Packetized Interface */
239 PROTO_SATAPM, /* SATA Port Multiplier */
245 XPORT_SPI, /* SCSI Parallel Interface */
246 XPORT_FC, /* Fiber Channel */
247 XPORT_SSA, /* Serial Storage Architecture */
248 XPORT_USB, /* Universal Serial Bus */
249 XPORT_PPB, /* Parallel Port Bus */
250 XPORT_ATA, /* AT Attachment */
251 XPORT_SAS, /* Serial Attached SCSI */
252 XPORT_SATA, /* Serial AT Attachment */
253 XPORT_ISCSI, /* iSCSI */
256 #define XPORT_IS_ATA(t) ((t) == XPORT_ATA || (t) == XPORT_SATA)
257 #define XPORT_IS_SCSI(t) ((t) != XPORT_UNKNOWN && \
258 (t) != XPORT_UNSPECIFIED && \
260 #define XPORT_DEVSTAT_TYPE(t) (XPORT_IS_ATA(t) ? DEVSTAT_TYPE_IF_IDE : \
261 XPORT_IS_SCSI(t) ? DEVSTAT_TYPE_IF_SCSI : \
262 DEVSTAT_TYPE_IF_OTHER)
264 #define PROTO_VERSION_UNKNOWN (UINT_MAX - 1)
265 #define PROTO_VERSION_UNSPECIFIED UINT_MAX
266 #define XPORT_VERSION_UNKNOWN (UINT_MAX - 1)
267 #define XPORT_VERSION_UNSPECIFIED UINT_MAX
270 LIST_ENTRY(ccb_hdr) le;
271 SLIST_ENTRY(ccb_hdr) sle;
272 TAILQ_ENTRY(ccb_hdr) tqe;
273 STAILQ_ENTRY(ccb_hdr) stqe;
279 u_int8_t bytes[sizeof(uintptr_t)];
283 ccb_priv_entry entries[CCB_PERIPH_PRIV_SIZE];
284 u_int8_t bytes[CCB_PERIPH_PRIV_SIZE * sizeof(ccb_priv_entry)];
288 ccb_priv_entry entries[CCB_SIM_PRIV_SIZE];
289 u_int8_t bytes[CCB_SIM_PRIV_SIZE * sizeof(ccb_priv_entry)];
293 cam_pinfo pinfo; /* Info for priority scheduling */
294 camq_entry xpt_links; /* For chaining in the XPT layer */
295 camq_entry sim_links; /* For chaining in the SIM layer */
296 camq_entry periph_links; /* For chaining in the type driver */
297 u_int32_t retry_count;
298 void (*cbfcnp)(struct cam_periph *, union ccb *);
299 /* Callback on completion function */
300 xpt_opcode func_code; /* XPT function code */
301 u_int32_t status; /* Status returned by CAM subsystem */
302 struct cam_path *path; /* Compiled path for this ccb */
303 path_id_t path_id; /* Path ID for the request */
304 target_id_t target_id; /* Target device ID */
305 lun_id_t target_lun; /* Target LUN number */
306 u_int32_t flags; /* ccb_flags */
307 ccb_ppriv_area periph_priv;
308 ccb_spriv_area sim_priv;
309 u_int32_t timeout; /* Timeout value */
312 * Deprecated, only for use by non-MPSAFE SIMs. All others must
313 * allocate and initialize their own callout storage.
315 struct callout_handle timeout_ch;
318 /* Get Device Information CCB */
320 struct ccb_hdr ccb_h;
322 struct scsi_inquiry_data inq_data;
323 struct ata_params ident_data;
324 u_int8_t serial_num[252];
326 u_int8_t serial_num_len;
329 /* Device Statistics CCB */
330 struct ccb_getdevstats {
331 struct ccb_hdr ccb_h;
332 int dev_openings; /* Space left for more work on device*/
333 int dev_active; /* Transactions running on the device */
334 int devq_openings; /* Space left for more queued work */
335 int devq_queued; /* Transactions queued to be sent */
337 * CCBs held by peripheral drivers
341 * Boundary conditions for number of
345 struct timeval last_reset; /* Time of last bus reset/loop init */
349 CAM_GDEVLIST_LAST_DEVICE,
350 CAM_GDEVLIST_LIST_CHANGED,
351 CAM_GDEVLIST_MORE_DEVS,
353 } ccb_getdevlist_status_e;
355 struct ccb_getdevlist {
356 struct ccb_hdr ccb_h;
357 char periph_name[DEV_IDLEN];
358 u_int32_t unit_number;
359 unsigned int generation;
361 ccb_getdevlist_status_e status;
365 PERIPH_MATCH_NONE = 0x000,
366 PERIPH_MATCH_PATH = 0x001,
367 PERIPH_MATCH_TARGET = 0x002,
368 PERIPH_MATCH_LUN = 0x004,
369 PERIPH_MATCH_NAME = 0x008,
370 PERIPH_MATCH_UNIT = 0x010,
371 PERIPH_MATCH_ANY = 0x01f
372 } periph_pattern_flags;
374 struct periph_match_pattern {
375 char periph_name[DEV_IDLEN];
376 u_int32_t unit_number;
378 target_id_t target_id;
380 periph_pattern_flags flags;
384 DEV_MATCH_NONE = 0x000,
385 DEV_MATCH_PATH = 0x001,
386 DEV_MATCH_TARGET = 0x002,
387 DEV_MATCH_LUN = 0x004,
388 DEV_MATCH_INQUIRY = 0x008,
389 DEV_MATCH_ANY = 0x00f
392 struct device_match_pattern {
394 target_id_t target_id;
396 struct scsi_static_inquiry_pattern inq_pat;
397 dev_pattern_flags flags;
401 BUS_MATCH_NONE = 0x000,
402 BUS_MATCH_PATH = 0x001,
403 BUS_MATCH_NAME = 0x002,
404 BUS_MATCH_UNIT = 0x004,
405 BUS_MATCH_BUS_ID = 0x008,
406 BUS_MATCH_ANY = 0x00f
409 struct bus_match_pattern {
411 char dev_name[DEV_IDLEN];
412 u_int32_t unit_number;
414 bus_pattern_flags flags;
417 union match_pattern {
418 struct periph_match_pattern periph_pattern;
419 struct device_match_pattern device_pattern;
420 struct bus_match_pattern bus_pattern;
429 struct dev_match_pattern {
431 union match_pattern pattern;
434 struct periph_match_result {
435 char periph_name[DEV_IDLEN];
436 u_int32_t unit_number;
438 target_id_t target_id;
443 DEV_RESULT_NOFLAG = 0x00,
444 DEV_RESULT_UNCONFIGURED = 0x01
447 struct device_match_result {
449 target_id_t target_id;
452 struct scsi_inquiry_data inq_data;
453 struct ata_params ident_data;
454 dev_result_flags flags;
457 struct bus_match_result {
459 char dev_name[DEV_IDLEN];
460 u_int32_t unit_number;
465 struct periph_match_result periph_result;
466 struct device_match_result device_result;
467 struct bus_match_result bus_result;
470 struct dev_match_result {
472 union match_result result;
478 CAM_DEV_MATCH_LIST_CHANGED,
479 CAM_DEV_MATCH_SIZE_ERROR,
481 } ccb_dev_match_status;
484 CAM_DEV_POS_NONE = 0x000,
485 CAM_DEV_POS_BUS = 0x001,
486 CAM_DEV_POS_TARGET = 0x002,
487 CAM_DEV_POS_DEVICE = 0x004,
488 CAM_DEV_POS_PERIPH = 0x008,
489 CAM_DEV_POS_PDPTR = 0x010,
490 CAM_DEV_POS_TYPEMASK = 0xf00,
491 CAM_DEV_POS_EDT = 0x100,
492 CAM_DEV_POS_PDRV = 0x200
495 struct ccb_dm_cookie {
503 struct ccb_dev_position {
504 u_int generations[4];
505 #define CAM_BUS_GENERATION 0x00
506 #define CAM_TARGET_GENERATION 0x01
507 #define CAM_DEV_GENERATION 0x02
508 #define CAM_PERIPH_GENERATION 0x03
509 dev_pos_type position_type;
510 struct ccb_dm_cookie cookie;
513 struct ccb_dev_match {
514 struct ccb_hdr ccb_h;
515 ccb_dev_match_status status;
516 u_int32_t num_patterns;
517 u_int32_t pattern_buf_len;
518 struct dev_match_pattern *patterns;
519 u_int32_t num_matches;
520 u_int32_t match_buf_len;
521 struct dev_match_result *matches;
522 struct ccb_dev_position pos;
526 * Definitions for the path inquiry CCB fields.
528 #define CAM_VERSION 0x15 /* Hex value for current version */
531 PI_MDP_ABLE = 0x80, /* Supports MDP message */
532 PI_WIDE_32 = 0x40, /* Supports 32 bit wide SCSI */
533 PI_WIDE_16 = 0x20, /* Supports 16 bit wide SCSI */
534 PI_SDTR_ABLE = 0x10, /* Supports SDTR message */
535 PI_LINKED_CDB = 0x08, /* Supports linked CDBs */
536 PI_SATAPM = 0x04, /* Supports SATA PM */
537 PI_TAG_ABLE = 0x02, /* Supports tag queue messages */
538 PI_SOFT_RST = 0x01 /* Supports soft reset alternative */
542 PIT_PROCESSOR = 0x80, /* Target mode processor mode */
543 PIT_PHASE = 0x40, /* Target mode phase cog. mode */
544 PIT_DISCONNECT = 0x20, /* Disconnects supported in target mode */
545 PIT_TERM_IO = 0x10, /* Terminate I/O message supported in TM */
546 PIT_GRP_6 = 0x08, /* Group 6 commands supported */
547 PIT_GRP_7 = 0x04 /* Group 7 commands supported */
551 PIM_SCANHILO = 0x80, /* Bus scans from high ID to low ID */
552 PIM_NOREMOVE = 0x40, /* Removeable devices not included in scan */
553 PIM_NOINITIATOR = 0x20, /* Initiator role not supported. */
554 PIM_NOBUSRESET = 0x10, /* User has disabled initial BUS RESET */
555 PIM_NO_6_BYTE = 0x08, /* Do not send 6-byte commands */
556 PIM_SEQSCAN = 0x04 /* Do bus scans sequentially, not in parallel */
559 /* Path Inquiry CCB */
560 struct ccb_pathinq_settings_spi {
561 u_int8_t ppr_options;
564 struct ccb_pathinq_settings_fc {
565 u_int64_t wwnn; /* world wide node name */
566 u_int64_t wwpn; /* world wide port name */
567 u_int32_t port; /* 24 bit port id, if known */
568 u_int32_t bitrate; /* Mbps */
571 struct ccb_pathinq_settings_sas {
572 u_int32_t bitrate; /* Mbps */
574 #define PATHINQ_SETTINGS_SIZE 128
577 struct ccb_hdr ccb_h;
578 u_int8_t version_num; /* Version number for the SIM/HBA */
579 u_int8_t hba_inquiry; /* Mimic of INQ byte 7 for the HBA */
580 u_int8_t target_sprt; /* Flags for target mode support */
581 u_int8_t hba_misc; /* Misc HBA features */
582 u_int16_t hba_eng_cnt; /* HBA engine count */
583 /* Vendor Unique capabilities */
584 u_int8_t vuhba_flags[VUHBALEN];
585 u_int32_t max_target; /* Maximum supported Target */
586 u_int32_t max_lun; /* Maximum supported Lun */
587 u_int32_t async_flags; /* Installed Async handlers */
588 path_id_t hpath_id; /* Highest Path ID in the subsystem */
589 target_id_t initiator_id; /* ID of the HBA on the SCSI bus */
590 char sim_vid[SIM_IDLEN]; /* Vendor ID of the SIM */
591 char hba_vid[HBA_IDLEN]; /* Vendor ID of the HBA */
592 char dev_name[DEV_IDLEN];/* Device name for SIM */
593 u_int32_t unit_number; /* Unit number for SIM */
594 u_int32_t bus_id; /* Bus ID for SIM */
595 u_int32_t base_transfer_speed;/* Base bus speed in KB/sec */
597 u_int protocol_version;
599 u_int transport_version;
601 struct ccb_pathinq_settings_spi spi;
602 struct ccb_pathinq_settings_fc fc;
603 struct ccb_pathinq_settings_sas sas;
604 char ccb_pathinq_settings_opaque[PATHINQ_SETTINGS_SIZE];
606 u_int maxio; /* Max supported I/O size, in bytes. */
609 /* Path Statistics CCB */
610 struct ccb_pathstats {
611 struct ccb_hdr ccb_h;
612 struct timeval last_reset; /* Time of last bus reset/loop init */
616 u_int8_t *sense_ptr; /*
618 * for sense information
620 /* Storage Area for sense information */
621 struct scsi_sense_data sense_buf;
625 u_int8_t *cdb_ptr; /* Pointer to the CDB bytes to send */
626 /* Area for the CDB send */
627 u_int8_t cdb_bytes[IOCDBLEN];
631 * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO
635 struct ccb_hdr ccb_h;
636 union ccb *next_ccb; /* Ptr for next CCB for action */
637 u_int8_t *req_map; /* Ptr to mapping info */
638 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */
639 u_int32_t dxfer_len; /* Data transfer length */
640 /* Autosense storage */
641 struct scsi_sense_data sense_data;
642 u_int8_t sense_len; /* Number of bytes to autosense */
643 u_int8_t cdb_len; /* Number of bytes for the CDB */
644 u_int16_t sglist_cnt; /* Number of SG list entries */
645 u_int8_t scsi_status; /* Returned SCSI status */
646 u_int8_t sense_resid; /* Autosense resid length: 2's comp */
647 u_int32_t resid; /* Transfer residual length: 2's comp */
648 cdb_t cdb_io; /* Union for CDB bytes/pointer */
649 u_int8_t *msg_ptr; /* Pointer to the message buffer */
650 u_int16_t msg_len; /* Number of bytes for the Message */
651 u_int8_t tag_action; /* What to do for tag queueing */
653 * The tag action should be either the define below (to send a
654 * non-tagged transaction) or one of the defined scsi tag messages
655 * from scsi_message.h.
657 #define CAM_TAG_ACTION_NONE 0x00
658 u_int tag_id; /* tag id from initator (target mode) */
659 u_int init_id; /* initiator id of who selected */
663 * ATA I/O Request CCB used for the XPT_ATA_IO function code.
666 struct ccb_hdr ccb_h;
667 union ccb *next_ccb; /* Ptr for next CCB for action */
668 struct ata_cmd cmd; /* ATA command register set */
669 struct ata_res res; /* ATA result register set */
670 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */
671 u_int32_t dxfer_len; /* Data transfer length */
672 u_int32_t resid; /* Transfer residual length: 2's comp */
673 u_int8_t tag_action; /* What to do for tag queueing */
675 * The tag action should be either the define below (to send a
676 * non-tagged transaction) or one of the defined scsi tag messages
677 * from scsi_message.h.
679 #define CAM_TAG_ACTION_NONE 0x00
680 u_int tag_id; /* tag id from initator (target mode) */
681 u_int init_id; /* initiator id of who selected */
684 struct ccb_accept_tio {
685 struct ccb_hdr ccb_h;
686 cdb_t cdb_io; /* Union for CDB bytes/pointer */
687 u_int8_t cdb_len; /* Number of bytes for the CDB */
688 u_int8_t tag_action; /* What to do for tag queueing */
689 u_int8_t sense_len; /* Number of bytes of Sense Data */
690 u_int tag_id; /* tag id from initator (target mode) */
691 u_int init_id; /* initiator id of who selected */
692 struct scsi_sense_data sense_data;
695 /* Release SIM Queue */
697 struct ccb_hdr ccb_h;
698 u_int32_t release_flags;
699 #define RELSIM_ADJUST_OPENINGS 0x01
700 #define RELSIM_RELEASE_AFTER_TIMEOUT 0x02
701 #define RELSIM_RELEASE_AFTER_CMDCMPLT 0x04
702 #define RELSIM_RELEASE_AFTER_QEMPTY 0x08
703 #define RELSIM_RELEASE_RUNLEVEL 0x10
705 u_int32_t release_timeout; /* Abstract argument. */
706 u_int32_t qfrozen_cnt;
710 * Definitions for the asynchronous callback CCB fields.
713 AC_CONTRACT = 0x1000,/* A contractual callback */
714 AC_GETDEV_CHANGED = 0x800,/* Getdev info might have changed */
715 AC_INQ_CHANGED = 0x400,/* Inquiry info might have changed */
716 AC_TRANSFER_NEG = 0x200,/* New transfer settings in effect */
717 AC_LOST_DEVICE = 0x100,/* A device went away */
718 AC_FOUND_DEVICE = 0x080,/* A new device was found */
719 AC_PATH_DEREGISTERED = 0x040,/* A path has de-registered */
720 AC_PATH_REGISTERED = 0x020,/* A new path has been registered */
721 AC_SENT_BDR = 0x010,/* A BDR message was sent to target */
722 AC_SCSI_AEN = 0x008,/* A SCSI AEN has been received */
723 AC_UNSOL_RESEL = 0x002,/* Unsolicited reselection occurred */
724 AC_BUS_RESET = 0x001 /* A SCSI bus reset occurred */
727 typedef void ac_callback_t (void *softc, u_int32_t code,
728 struct cam_path *path, void *args);
731 * Generic Asynchronous callbacks.
733 * Generic arguments passed bac which are then interpreted between a per-system
736 #define AC_CONTRACT_DATA_MAX (128 - sizeof (u_int64_t))
738 u_int64_t contract_number;
739 u_int8_t contract_data[AC_CONTRACT_DATA_MAX];
742 #define AC_CONTRACT_DEV_CHG 1
743 struct ac_device_changed {
750 /* Set Asynchronous Callback CCB */
751 struct ccb_setasync {
752 struct ccb_hdr ccb_h;
753 u_int32_t event_enable; /* Async Event enables */
754 ac_callback_t *callback;
758 /* Set Device Type CCB */
760 struct ccb_hdr ccb_h;
761 u_int8_t dev_type; /* Value for dev type field in EDT */
764 /* SCSI Control Functions */
766 /* Abort XPT request CCB */
768 struct ccb_hdr ccb_h;
769 union ccb *abort_ccb; /* Pointer to CCB to abort */
772 /* Reset SCSI Bus CCB */
773 struct ccb_resetbus {
774 struct ccb_hdr ccb_h;
777 /* Reset SCSI Device CCB */
778 struct ccb_resetdev {
779 struct ccb_hdr ccb_h;
782 /* Terminate I/O Process Request CCB */
784 struct ccb_hdr ccb_h;
785 union ccb *termio_ccb; /* Pointer to CCB to terminate */
789 CTS_TYPE_CURRENT_SETTINGS,
790 CTS_TYPE_USER_SETTINGS
793 struct ccb_trans_settings_scsi
795 u_int valid; /* Which fields to honor */
796 #define CTS_SCSI_VALID_TQ 0x01
798 #define CTS_SCSI_FLAGS_TAG_ENB 0x01
801 struct ccb_trans_settings_spi
803 u_int valid; /* Which fields to honor */
804 #define CTS_SPI_VALID_SYNC_RATE 0x01
805 #define CTS_SPI_VALID_SYNC_OFFSET 0x02
806 #define CTS_SPI_VALID_BUS_WIDTH 0x04
807 #define CTS_SPI_VALID_DISC 0x08
808 #define CTS_SPI_VALID_PPR_OPTIONS 0x10
810 #define CTS_SPI_FLAGS_DISC_ENB 0x01
817 struct ccb_trans_settings_fc {
818 u_int valid; /* Which fields to honor */
819 #define CTS_FC_VALID_WWNN 0x8000
820 #define CTS_FC_VALID_WWPN 0x4000
821 #define CTS_FC_VALID_PORT 0x2000
822 #define CTS_FC_VALID_SPEED 0x1000
823 u_int64_t wwnn; /* world wide node name */
824 u_int64_t wwpn; /* world wide port name */
825 u_int32_t port; /* 24 bit port id, if known */
826 u_int32_t bitrate; /* Mbps */
829 struct ccb_trans_settings_sas {
830 u_int valid; /* Which fields to honor */
831 #define CTS_SAS_VALID_SPEED 0x1000
832 u_int32_t bitrate; /* Mbps */
835 struct ccb_trans_settings_ata {
836 u_int valid; /* Which fields to honor */
837 #define CTS_ATA_VALID_MODE 0x01
838 #define CTS_ATA_VALID_BYTECOUNT 0x02
839 #define CTS_ATA_VALID_ATAPI 0x20
841 u_int bytecount; /* Length of PIO transaction */
842 u_int atapi; /* Length of ATAPI CDB */
845 struct ccb_trans_settings_sata {
846 u_int valid; /* Which fields to honor */
847 #define CTS_SATA_VALID_MODE 0x01
848 #define CTS_SATA_VALID_BYTECOUNT 0x02
849 #define CTS_SATA_VALID_REVISION 0x04
850 #define CTS_SATA_VALID_PM 0x08
851 #define CTS_SATA_VALID_TAGS 0x10
852 #define CTS_SATA_VALID_ATAPI 0x20
853 #define CTS_SATA_VALID_CAPS 0x40
854 int mode; /* Legacy PATA mode */
855 u_int bytecount; /* Length of PIO transaction */
856 int revision; /* SATA revision */
857 u_int pm_present; /* PM is present (XPT->SIM) */
858 u_int tags; /* Number of allowed tags */
859 u_int atapi; /* Length of ATAPI CDB */
860 u_int caps; /* Device and host SATA caps. */
861 #define CTS_SATA_CAPS_H 0x0000ffff
862 #define CTS_SATA_CAPS_H_PMREQ 0x00000001
863 #define CTS_SATA_CAPS_H_APST 0x00000002
864 #define CTS_SATA_CAPS_H_DMAAA 0x00000010 /* Auto-activation */
865 #define CTS_SATA_CAPS_H_AN 0x00000020 /* Async. notification */
866 #define CTS_SATA_CAPS_D 0xffff0000
867 #define CTS_SATA_CAPS_D_PMREQ 0x00010000
868 #define CTS_SATA_CAPS_D_APST 0x00020000
871 /* Get/Set transfer rate/width/disconnection/tag queueing settings */
872 struct ccb_trans_settings {
873 struct ccb_hdr ccb_h;
874 cts_type type; /* Current or User settings */
876 u_int protocol_version;
878 u_int transport_version;
880 u_int valid; /* Which fields to honor */
881 struct ccb_trans_settings_scsi scsi;
884 u_int valid; /* Which fields to honor */
885 struct ccb_trans_settings_spi spi;
886 struct ccb_trans_settings_fc fc;
887 struct ccb_trans_settings_sas sas;
888 struct ccb_trans_settings_ata ata;
889 struct ccb_trans_settings_sata sata;
895 * Calculate the geometry parameters for a device
896 * give the block size and volume size in blocks.
898 struct ccb_calc_geometry {
899 struct ccb_hdr ccb_h;
900 u_int32_t block_size;
901 u_int64_t volume_size;
904 u_int8_t secs_per_track;
908 * Set or get SIM (and transport) specific knobs
911 #define KNOB_VALID_ADDRESS 0x1
912 #define KNOB_VALID_ROLE 0x2
915 #define KNOB_ROLE_NONE 0x0
916 #define KNOB_ROLE_INITIATOR 0x1
917 #define KNOB_ROLE_TARGET 0x2
918 #define KNOB_ROLE_BOTH 0x3
920 struct ccb_sim_knob_settings_spi {
926 struct ccb_sim_knob_settings_fc {
928 u_int64_t wwnn; /* world wide node name */
929 u_int64_t wwpn; /* world wide port name */
933 struct ccb_sim_knob_settings_sas {
935 u_int64_t wwnn; /* world wide node name */
938 #define KNOB_SETTINGS_SIZE 128
940 struct ccb_sim_knob {
941 struct ccb_hdr ccb_h;
943 u_int valid; /* Which fields to honor */
944 struct ccb_sim_knob_settings_spi spi;
945 struct ccb_sim_knob_settings_fc fc;
946 struct ccb_sim_knob_settings_sas sas;
947 char pad[KNOB_SETTINGS_SIZE];
952 * Rescan the given bus, or bus/target/lun
955 struct ccb_hdr ccb_h;
960 * Turn on debugging for the given bus, bus/target, or bus/target/lun.
963 struct ccb_hdr ccb_h;
964 cam_debug_flags flags;
967 /* Target mode structures. */
970 struct ccb_hdr ccb_h;
971 u_int16_t grp6_len; /* Group 6 VU CDB length */
972 u_int16_t grp7_len; /* Group 7 VU CDB length */
976 /* old, barely used immediate notify, binary compatibility */
977 struct ccb_immed_notify {
978 struct ccb_hdr ccb_h;
979 struct scsi_sense_data sense_data;
980 u_int8_t sense_len; /* Number of bytes in sense buffer */
981 u_int8_t initiator_id; /* Id of initiator that selected */
982 u_int8_t message_args[7]; /* Message Arguments */
985 struct ccb_notify_ack {
986 struct ccb_hdr ccb_h;
987 u_int16_t seq_id; /* Sequence identifier */
988 u_int8_t event; /* Event flags */
991 struct ccb_immediate_notify {
992 struct ccb_hdr ccb_h;
993 u_int tag_id; /* Tag for immediate notify */
994 u_int seq_id; /* Tag for target of notify */
995 u_int initiator_id; /* Initiator Identifier */
996 u_int arg; /* Function specific */
999 struct ccb_notify_acknowledge {
1000 struct ccb_hdr ccb_h;
1001 u_int tag_id; /* Tag for immediate notify */
1002 u_int seq_id; /* Tar for target of notify */
1003 u_int initiator_id; /* Initiator Identifier */
1004 u_int arg; /* Function specific */
1007 /* HBA engine structures. */
1010 EIT_BUFFER, /* Engine type: buffer memory */
1011 EIT_LOSSLESS, /* Engine type: lossless compression */
1012 EIT_LOSSY, /* Engine type: lossy compression */
1013 EIT_ENCRYPT /* Engine type: encryption */
1017 EAD_VUNIQUE, /* Engine algorithm ID: vendor unique */
1018 EAD_LZ1V1, /* Engine algorithm ID: LZ1 var.1 */
1019 EAD_LZ2V1, /* Engine algorithm ID: LZ2 var.1 */
1020 EAD_LZ2V2 /* Engine algorithm ID: LZ2 var.2 */
1023 struct ccb_eng_inq {
1024 struct ccb_hdr ccb_h;
1025 u_int16_t eng_num; /* The engine number for this inquiry */
1026 ei_type eng_type; /* Returned engine type */
1027 ei_algo eng_algo; /* Returned engine algorithm type */
1028 u_int32_t eng_memeory; /* Returned engine memory size */
1031 struct ccb_eng_exec { /* This structure must match SCSIIO size */
1032 struct ccb_hdr ccb_h;
1033 u_int8_t *pdrv_ptr; /* Ptr used by the peripheral driver */
1034 u_int8_t *req_map; /* Ptr for mapping info on the req. */
1035 u_int8_t *data_ptr; /* Pointer to the data buf/SG list */
1036 u_int32_t dxfer_len; /* Data transfer length */
1037 u_int8_t *engdata_ptr; /* Pointer to the engine buffer data */
1038 u_int16_t sglist_cnt; /* Num of scatter gather list entries */
1039 u_int32_t dmax_len; /* Destination data maximum length */
1040 u_int32_t dest_len; /* Destination data length */
1041 int32_t src_resid; /* Source residual length: 2's comp */
1042 u_int32_t timeout; /* Timeout value */
1043 u_int16_t eng_num; /* Engine number for this request */
1044 u_int16_t vu_flags; /* Vendor Unique flags */
1048 * Definitions for the timeout field in the SCSI I/O CCB.
1050 #define CAM_TIME_DEFAULT 0x00000000 /* Use SIM default value */
1051 #define CAM_TIME_INFINITY 0xFFFFFFFF /* Infinite timeout */
1053 #define CAM_SUCCESS 0 /* For signaling general success */
1054 #define CAM_FAILURE 1 /* For signaling general failure */
1059 #define XPT_CCB_INVALID -1 /* for signaling a bad CCB to free */
1062 * Union of all CCB types for kernel space allocation. This union should
1063 * never be used for manipulating CCBs - its only use is for the allocation
1064 * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc
1065 * and the argument to xpt_ccb_free.
1068 struct ccb_hdr ccb_h; /* For convenience */
1069 struct ccb_scsiio csio;
1070 struct ccb_getdev cgd;
1071 struct ccb_getdevlist cgdl;
1072 struct ccb_pathinq cpi;
1073 struct ccb_relsim crs;
1074 struct ccb_setasync csa;
1075 struct ccb_setdev csd;
1076 struct ccb_pathstats cpis;
1077 struct ccb_getdevstats cgds;
1078 struct ccb_dev_match cdm;
1079 struct ccb_trans_settings cts;
1080 struct ccb_calc_geometry ccg;
1081 struct ccb_sim_knob knob;
1082 struct ccb_abort cab;
1083 struct ccb_resetbus crb;
1084 struct ccb_resetdev crd;
1085 struct ccb_termio tio;
1086 struct ccb_accept_tio atio;
1087 struct ccb_scsiio ctio;
1088 struct ccb_en_lun cel;
1089 struct ccb_immed_notify cin;
1090 struct ccb_notify_ack cna;
1091 struct ccb_immediate_notify cin1;
1092 struct ccb_notify_acknowledge cna2;
1093 struct ccb_eng_inq cei;
1094 struct ccb_eng_exec cee;
1095 struct ccb_rescan crcn;
1096 struct ccb_debug cdbg;
1097 struct ccb_ataio ataio;
1101 static __inline void
1102 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
1103 void (*cbfcnp)(struct cam_periph *, union ccb *),
1104 u_int32_t flags, u_int8_t tag_action,
1105 u_int8_t *data_ptr, u_int32_t dxfer_len,
1106 u_int8_t sense_len, u_int8_t cdb_len,
1109 static __inline void
1110 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
1111 void (*cbfcnp)(struct cam_periph *, union ccb *),
1112 u_int32_t flags, u_int tag_action, u_int tag_id,
1113 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
1114 u_int32_t dxfer_len, u_int32_t timeout);
1116 static __inline void
1117 cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries,
1118 void (*cbfcnp)(struct cam_periph *, union ccb *),
1119 u_int32_t flags, u_int tag_action,
1120 u_int8_t *data_ptr, u_int32_t dxfer_len,
1123 static __inline void
1124 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
1125 void (*cbfcnp)(struct cam_periph *, union ccb *),
1126 u_int32_t flags, u_int8_t tag_action,
1127 u_int8_t *data_ptr, u_int32_t dxfer_len,
1128 u_int8_t sense_len, u_int8_t cdb_len,
1131 csio->ccb_h.func_code = XPT_SCSI_IO;
1132 csio->ccb_h.flags = flags;
1133 csio->ccb_h.retry_count = retries;
1134 csio->ccb_h.cbfcnp = cbfcnp;
1135 csio->ccb_h.timeout = timeout;
1136 csio->data_ptr = data_ptr;
1137 csio->dxfer_len = dxfer_len;
1138 csio->sense_len = sense_len;
1139 csio->cdb_len = cdb_len;
1140 csio->tag_action = tag_action;
1143 static __inline void
1144 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
1145 void (*cbfcnp)(struct cam_periph *, union ccb *),
1146 u_int32_t flags, u_int tag_action, u_int tag_id,
1147 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
1148 u_int32_t dxfer_len, u_int32_t timeout)
1150 csio->ccb_h.func_code = XPT_CONT_TARGET_IO;
1151 csio->ccb_h.flags = flags;
1152 csio->ccb_h.retry_count = retries;
1153 csio->ccb_h.cbfcnp = cbfcnp;
1154 csio->ccb_h.timeout = timeout;
1155 csio->data_ptr = data_ptr;
1156 csio->dxfer_len = dxfer_len;
1157 csio->scsi_status = scsi_status;
1158 csio->tag_action = tag_action;
1159 csio->tag_id = tag_id;
1160 csio->init_id = init_id;
1163 static __inline void
1164 cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries,
1165 void (*cbfcnp)(struct cam_periph *, union ccb *),
1166 u_int32_t flags, u_int tag_action,
1167 u_int8_t *data_ptr, u_int32_t dxfer_len,
1170 ataio->ccb_h.func_code = XPT_ATA_IO;
1171 ataio->ccb_h.flags = flags;
1172 ataio->ccb_h.retry_count = retries;
1173 ataio->ccb_h.cbfcnp = cbfcnp;
1174 ataio->ccb_h.timeout = timeout;
1175 ataio->data_ptr = data_ptr;
1176 ataio->dxfer_len = dxfer_len;
1177 ataio->tag_action = tag_action;
1180 void cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended);
1184 #endif /* _CAM_CAM_CCB_H */