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_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 */
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 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
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/* SCSI Control Functions: 0x10->0x1F */
146 XPT_ABORT = 0x10,
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 */
152 XPT_TERM_IO = 0x13,
153 /* Terminate the I/O process */
154 XPT_SCAN_LUN = 0x14 | XPT_FC_QUEUED | XPT_FC_USER_CCB
155 | XPT_FC_XPT_ONLY,
156 /* Scan Logical Unit */
157 XPT_GET_TRAN_SETTINGS = 0x15,
158 /*
159 * Get default/user transfer settings
160 * for the target
161 */
162 XPT_SET_TRAN_SETTINGS = 0x16,
163 /*
164 * Set transfer rate/width
165 * negotiation settings
166 */
167 XPT_CALC_GEOMETRY = 0x17,
168 /*
169 * Calculate the geometry parameters for
170 * a device give the sector size and
171 * volume size.
172 */
173 XPT_ATA_IO = 0x18 | XPT_FC_DEV_QUEUED,
174 /* Execute the requested ATA I/O operation */
175
176 XPT_GET_SIM_KNOB = 0x18,
177 /*
178 * Get SIM specific knob values.
179 */
180
181 XPT_SET_SIM_KNOB = 0x19,
182 /*
183 * Set SIM specific knob values.
184 */
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 */
190
191/* Target mode commands: 0x30->0x3F */
192 XPT_EN_LUN = 0x30,
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 */
208
209/* Vendor Unique codes: 0x80->0x8F */
210 XPT_VUNIQUE = 0x80
211} xpt_opcode;
212
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
220
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)
225
226typedef enum {
227 PROTO_UNKNOWN,
228 PROTO_UNSPECIFIED,
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 */
233} cam_proto;
234
235typedef enum {
236 XPORT_UNKNOWN,
237 XPORT_UNSPECIFIED,
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 */
246 XPORT_ISCSI, /* iSCSI */
247} cam_xport;
248
249#define PROTO_VERSION_UNKNOWN (UINT_MAX - 1)
250#define PROTO_VERSION_UNSPECIFIED UINT_MAX
251#define XPORT_VERSION_UNKNOWN (UINT_MAX - 1)
252#define XPORT_VERSION_UNSPECIFIED UINT_MAX
253
254typedef union {
255 LIST_ENTRY(ccb_hdr) le;
256 SLIST_ENTRY(ccb_hdr) sle;
257 TAILQ_ENTRY(ccb_hdr) tqe;
258 STAILQ_ENTRY(ccb_hdr) stqe;
259} camq_entry;
260
261typedef union {
262 void *ptr;
263 u_long field;
264 u_int8_t bytes[sizeof(uintptr_t)];
265} ccb_priv_entry;
266
267typedef union {
268 ccb_priv_entry entries[CCB_PERIPH_PRIV_SIZE];
269 u_int8_t bytes[CCB_PERIPH_PRIV_SIZE * sizeof(ccb_priv_entry)];
270} ccb_ppriv_area;
271
272typedef union {
273 ccb_priv_entry entries[CCB_SIM_PRIV_SIZE];
274 u_int8_t bytes[CCB_SIM_PRIV_SIZE * sizeof(ccb_priv_entry)];
275} ccb_spriv_area;
276
277struct ccb_hdr {
278 cam_pinfo pinfo; /* Info for priority scheduling */
279 camq_entry xpt_links; /* For chaining in the XPT layer */
280 camq_entry sim_links; /* For chaining in the SIM layer */
281 camq_entry periph_links; /* For chaining in the type driver */
282 u_int32_t retry_count;
283 void (*cbfcnp)(struct cam_periph *, union ccb *);
284 /* Callback on completion function */
285 xpt_opcode func_code; /* XPT function code */
286 u_int32_t status; /* Status returned by CAM subsystem */
287 struct cam_path *path; /* Compiled path for this ccb */
288 path_id_t path_id; /* Path ID for the request */
289 target_id_t target_id; /* Target device ID */
290 lun_id_t target_lun; /* Target LUN number */
291 u_int32_t flags; /* ccb_flags */
292 ccb_ppriv_area periph_priv;
293 ccb_spriv_area sim_priv;
294 u_int32_t timeout; /* Timeout value */
295
296 /*
297 * Deprecated, only for use by non-MPSAFE SIMs. All others must
298 * allocate and initialize their own callout storage.
299 */
300 struct callout_handle timeout_ch;
301};
302
303/* Get Device Information CCB */
304struct ccb_getdev {
305 struct ccb_hdr ccb_h;
306 cam_proto protocol;
307 struct scsi_inquiry_data inq_data;
308 struct ata_params ident_data;
309 u_int8_t serial_num[252];
310 u_int8_t inq_flags;
311 u_int8_t serial_num_len;
312};
313
314/* Device Statistics CCB */
315struct ccb_getdevstats {
316 struct ccb_hdr ccb_h;
317 int dev_openings; /* Space left for more work on device*/
318 int dev_active; /* Transactions running on the device */
319 int devq_openings; /* Space left for more queued work */
320 int devq_queued; /* Transactions queued to be sent */
321 int held; /*
322 * CCBs held by peripheral drivers
323 * for this device
324 */
325 int maxtags; /*
326 * Boundary conditions for number of
327 * tagged operations
328 */
329 int mintags;
330 struct timeval last_reset; /* Time of last bus reset/loop init */
331};
332
333typedef enum {
334 CAM_GDEVLIST_LAST_DEVICE,
335 CAM_GDEVLIST_LIST_CHANGED,
336 CAM_GDEVLIST_MORE_DEVS,
337 CAM_GDEVLIST_ERROR
338} ccb_getdevlist_status_e;
339
340struct ccb_getdevlist {
341 struct ccb_hdr ccb_h;
342 char periph_name[DEV_IDLEN];
343 u_int32_t unit_number;
344 unsigned int generation;
345 u_int32_t index;
346 ccb_getdevlist_status_e status;
347};
348
349typedef enum {
350 PERIPH_MATCH_NONE = 0x000,
351 PERIPH_MATCH_PATH = 0x001,
352 PERIPH_MATCH_TARGET = 0x002,
353 PERIPH_MATCH_LUN = 0x004,
354 PERIPH_MATCH_NAME = 0x008,
355 PERIPH_MATCH_UNIT = 0x010,
356 PERIPH_MATCH_ANY = 0x01f
357} periph_pattern_flags;
358
359struct periph_match_pattern {
360 char periph_name[DEV_IDLEN];
361 u_int32_t unit_number;
362 path_id_t path_id;
363 target_id_t target_id;
364 lun_id_t target_lun;
365 periph_pattern_flags flags;
366};
367
368typedef enum {
369 DEV_MATCH_NONE = 0x000,
370 DEV_MATCH_PATH = 0x001,
371 DEV_MATCH_TARGET = 0x002,
372 DEV_MATCH_LUN = 0x004,
373 DEV_MATCH_INQUIRY = 0x008,
374 DEV_MATCH_ANY = 0x00f
375} dev_pattern_flags;
376
377struct device_match_pattern {
378 path_id_t path_id;
379 target_id_t target_id;
380 lun_id_t target_lun;
381 struct scsi_static_inquiry_pattern inq_pat;
382 dev_pattern_flags flags;
383};
384
385typedef enum {
386 BUS_MATCH_NONE = 0x000,
387 BUS_MATCH_PATH = 0x001,
388 BUS_MATCH_NAME = 0x002,
389 BUS_MATCH_UNIT = 0x004,
390 BUS_MATCH_BUS_ID = 0x008,
391 BUS_MATCH_ANY = 0x00f
392} bus_pattern_flags;
393
394struct bus_match_pattern {
395 path_id_t path_id;
396 char dev_name[DEV_IDLEN];
397 u_int32_t unit_number;
398 u_int32_t bus_id;
399 bus_pattern_flags flags;
400};
401
402union match_pattern {
403 struct periph_match_pattern periph_pattern;
404 struct device_match_pattern device_pattern;
405 struct bus_match_pattern bus_pattern;
406};
407
408typedef enum {
409 DEV_MATCH_PERIPH,
410 DEV_MATCH_DEVICE,
411 DEV_MATCH_BUS
412} dev_match_type;
413
414struct dev_match_pattern {
415 dev_match_type type;
416 union match_pattern pattern;
417};
418
419struct periph_match_result {
420 char periph_name[DEV_IDLEN];
421 u_int32_t unit_number;
422 path_id_t path_id;
423 target_id_t target_id;
424 lun_id_t target_lun;
425};
426
427typedef enum {
428 DEV_RESULT_NOFLAG = 0x00,
429 DEV_RESULT_UNCONFIGURED = 0x01
430} dev_result_flags;
431
432struct device_match_result {
433 path_id_t path_id;
434 target_id_t target_id;
435 lun_id_t target_lun;
436 cam_proto protocol;
437 struct scsi_inquiry_data inq_data;
438 struct ata_params ident_data;
439 dev_result_flags flags;
440};
441
442struct bus_match_result {
443 path_id_t path_id;
444 char dev_name[DEV_IDLEN];
445 u_int32_t unit_number;
446 u_int32_t bus_id;
447};
448
449union match_result {
450 struct periph_match_result periph_result;
451 struct device_match_result device_result;
452 struct bus_match_result bus_result;
453};
454
455struct dev_match_result {
456 dev_match_type type;
457 union match_result result;
458};
459
460typedef enum {
461 CAM_DEV_MATCH_LAST,
462 CAM_DEV_MATCH_MORE,
463 CAM_DEV_MATCH_LIST_CHANGED,
464 CAM_DEV_MATCH_SIZE_ERROR,
465 CAM_DEV_MATCH_ERROR
466} ccb_dev_match_status;
467
468typedef enum {
469 CAM_DEV_POS_NONE = 0x000,
470 CAM_DEV_POS_BUS = 0x001,
471 CAM_DEV_POS_TARGET = 0x002,
472 CAM_DEV_POS_DEVICE = 0x004,
473 CAM_DEV_POS_PERIPH = 0x008,
474 CAM_DEV_POS_PDPTR = 0x010,
475 CAM_DEV_POS_TYPEMASK = 0xf00,
476 CAM_DEV_POS_EDT = 0x100,
477 CAM_DEV_POS_PDRV = 0x200
478} dev_pos_type;
479
480struct ccb_dm_cookie {
481 void *bus;
482 void *target;
483 void *device;
484 void *periph;
485 void *pdrv;
486};
487
488struct ccb_dev_position {
489 u_int generations[4];
490#define CAM_BUS_GENERATION 0x00
491#define CAM_TARGET_GENERATION 0x01
492#define CAM_DEV_GENERATION 0x02
493#define CAM_PERIPH_GENERATION 0x03
494 dev_pos_type position_type;
495 struct ccb_dm_cookie cookie;
496};
497
498struct ccb_dev_match {
499 struct ccb_hdr ccb_h;
500 ccb_dev_match_status status;
501 u_int32_t num_patterns;
502 u_int32_t pattern_buf_len;
503 struct dev_match_pattern *patterns;
504 u_int32_t num_matches;
505 u_int32_t match_buf_len;
506 struct dev_match_result *matches;
507 struct ccb_dev_position pos;
508};
509
510/*
511 * Definitions for the path inquiry CCB fields.
512 */
513#define CAM_VERSION 0x15 /* Hex value for current version */
514
515typedef enum {
516 PI_MDP_ABLE = 0x80, /* Supports MDP message */
517 PI_WIDE_32 = 0x40, /* Supports 32 bit wide SCSI */
518 PI_WIDE_16 = 0x20, /* Supports 16 bit wide SCSI */
519 PI_SDTR_ABLE = 0x10, /* Supports SDTR message */
520 PI_LINKED_CDB = 0x08, /* Supports linked CDBs */
521 PI_SATAPM = 0x04, /* Supports SATA PM */
522 PI_TAG_ABLE = 0x02, /* Supports tag queue messages */
523 PI_SOFT_RST = 0x01 /* Supports soft reset alternative */
524} pi_inqflag;
525
526typedef enum {
527 PIT_PROCESSOR = 0x80, /* Target mode processor mode */
528 PIT_PHASE = 0x40, /* Target mode phase cog. mode */
529 PIT_DISCONNECT = 0x20, /* Disconnects supported in target mode */
530 PIT_TERM_IO = 0x10, /* Terminate I/O message supported in TM */
531 PIT_GRP_6 = 0x08, /* Group 6 commands supported */
532 PIT_GRP_7 = 0x04 /* Group 7 commands supported */
533} pi_tmflag;
534
535typedef enum {
536 PIM_SCANHILO = 0x80, /* Bus scans from high ID to low ID */
537 PIM_NOREMOVE = 0x40, /* Removeable devices not included in scan */
538 PIM_NOINITIATOR = 0x20, /* Initiator role not supported. */
539 PIM_NOBUSRESET = 0x10, /* User has disabled initial BUS RESET */
540 PIM_NO_6_BYTE = 0x08, /* Do not send 6-byte commands */
541 PIM_SEQSCAN = 0x04 /* Do bus scans sequentially, not in parallel */
542} pi_miscflag;
543
544/* Path Inquiry CCB */
545struct ccb_pathinq_settings_spi {
546 u_int8_t ppr_options;
547};
548
549struct ccb_pathinq_settings_fc {
550 u_int64_t wwnn; /* world wide node name */
551 u_int64_t wwpn; /* world wide port name */
552 u_int32_t port; /* 24 bit port id, if known */
553 u_int32_t bitrate; /* Mbps */
554};
555
556struct ccb_pathinq_settings_sas {
557 u_int32_t bitrate; /* Mbps */
558};
559#define PATHINQ_SETTINGS_SIZE 128
560
561struct ccb_pathinq {
562 struct ccb_hdr ccb_h;
563 u_int8_t version_num; /* Version number for the SIM/HBA */
564 u_int8_t hba_inquiry; /* Mimic of INQ byte 7 for the HBA */
565 u_int8_t target_sprt; /* Flags for target mode support */
566 u_int8_t hba_misc; /* Misc HBA features */
567 u_int16_t hba_eng_cnt; /* HBA engine count */
568 /* Vendor Unique capabilities */
569 u_int8_t vuhba_flags[VUHBALEN];
570 u_int32_t max_target; /* Maximum supported Target */
571 u_int32_t max_lun; /* Maximum supported Lun */
572 u_int32_t async_flags; /* Installed Async handlers */
573 path_id_t hpath_id; /* Highest Path ID in the subsystem */
574 target_id_t initiator_id; /* ID of the HBA on the SCSI bus */
575 char sim_vid[SIM_IDLEN]; /* Vendor ID of the SIM */
576 char hba_vid[HBA_IDLEN]; /* Vendor ID of the HBA */
577 char dev_name[DEV_IDLEN];/* Device name for SIM */
578 u_int32_t unit_number; /* Unit number for SIM */
579 u_int32_t bus_id; /* Bus ID for SIM */
580 u_int32_t base_transfer_speed;/* Base bus speed in KB/sec */
581 cam_proto protocol;
582 u_int protocol_version;
583 cam_xport transport;
584 u_int transport_version;
585 union {
586 struct ccb_pathinq_settings_spi spi;
587 struct ccb_pathinq_settings_fc fc;
588 struct ccb_pathinq_settings_sas sas;
589 char ccb_pathinq_settings_opaque[PATHINQ_SETTINGS_SIZE];
590 } xport_specific;
591 u_int maxio; /* Max supported I/O size, in bytes. */
592};
593
594/* Path Statistics CCB */
595struct ccb_pathstats {
596 struct ccb_hdr ccb_h;
597 struct timeval last_reset; /* Time of last bus reset/loop init */
598};
599
600typedef union {
601 u_int8_t *sense_ptr; /*
602 * Pointer to storage
603 * for sense information
604 */
605 /* Storage Area for sense information */
606 struct scsi_sense_data sense_buf;
607} sense_t;
608
609typedef union {
610 u_int8_t *cdb_ptr; /* Pointer to the CDB bytes to send */
611 /* Area for the CDB send */
612 u_int8_t cdb_bytes[IOCDBLEN];
613} cdb_t;
614
615/*
616 * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO
617 * function codes.
618 */
619struct ccb_scsiio {
620 struct ccb_hdr ccb_h;
621 union ccb *next_ccb; /* Ptr for next CCB for action */
622 u_int8_t *req_map; /* Ptr to mapping info */
623 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */
624 u_int32_t dxfer_len; /* Data transfer length */
625 /* Autosense storage */
626 struct scsi_sense_data sense_data;
627 u_int8_t sense_len; /* Number of bytes to autosense */
628 u_int8_t cdb_len; /* Number of bytes for the CDB */
629 u_int16_t sglist_cnt; /* Number of SG list entries */
630 u_int8_t scsi_status; /* Returned SCSI status */
631 u_int8_t sense_resid; /* Autosense resid length: 2's comp */
632 u_int32_t resid; /* Transfer residual length: 2's comp */
633 cdb_t cdb_io; /* Union for CDB bytes/pointer */
634 u_int8_t *msg_ptr; /* Pointer to the message buffer */
635 u_int16_t msg_len; /* Number of bytes for the Message */
636 u_int8_t tag_action; /* What to do for tag queueing */
637 /*
638 * The tag action should be either the define below (to send a
639 * non-tagged transaction) or one of the defined scsi tag messages
640 * from scsi_message.h.
641 */
642#define CAM_TAG_ACTION_NONE 0x00
643 u_int tag_id; /* tag id from initator (target mode) */
644 u_int init_id; /* initiator id of who selected */
645};
646
647/*
648 * ATA I/O Request CCB used for the XPT_ATA_IO function code.
649 */
650struct ccb_ataio {
651 struct ccb_hdr ccb_h;
652 union ccb *next_ccb; /* Ptr for next CCB for action */
653 struct ata_cmd cmd; /* ATA command register set */
654 struct ata_res res; /* ATA result register set */
655 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */
656 u_int32_t dxfer_len; /* Data transfer length */
657 u_int32_t resid; /* Transfer residual length: 2's comp */
658 u_int8_t tag_action; /* What to do for tag queueing */
659 /*
660 * The tag action should be either the define below (to send a
661 * non-tagged transaction) or one of the defined scsi tag messages
662 * from scsi_message.h.
663 */
664#define CAM_TAG_ACTION_NONE 0x00
665 u_int tag_id; /* tag id from initator (target mode) */
666 u_int init_id; /* initiator id of who selected */
667};
668
669struct ccb_accept_tio {
670 struct ccb_hdr ccb_h;
671 cdb_t cdb_io; /* Union for CDB bytes/pointer */
672 u_int8_t cdb_len; /* Number of bytes for the CDB */
673 u_int8_t tag_action; /* What to do for tag queueing */
674 u_int8_t sense_len; /* Number of bytes of Sense Data */
675 u_int tag_id; /* tag id from initator (target mode) */
676 u_int init_id; /* initiator id of who selected */
677 struct scsi_sense_data sense_data;
678};
679
680/* Release SIM Queue */
681struct ccb_relsim {
682 struct ccb_hdr ccb_h;
683 u_int32_t release_flags;
684#define RELSIM_ADJUST_OPENINGS 0x01
685#define RELSIM_RELEASE_AFTER_TIMEOUT 0x02
686#define RELSIM_RELEASE_AFTER_CMDCMPLT 0x04
687#define RELSIM_RELEASE_AFTER_QEMPTY 0x08
688 u_int32_t openings;
689 u_int32_t release_timeout;
690 u_int32_t qfrozen_cnt;
691};
692
693/*
694 * Definitions for the asynchronous callback CCB fields.
695 */
696typedef enum {
697 AC_CONTRACT = 0x1000,/* A contractual callback */
698 AC_GETDEV_CHANGED = 0x800,/* Getdev info might have changed */
699 AC_INQ_CHANGED = 0x400,/* Inquiry info might have changed */
700 AC_TRANSFER_NEG = 0x200,/* New transfer settings in effect */
701 AC_LOST_DEVICE = 0x100,/* A device went away */
702 AC_FOUND_DEVICE = 0x080,/* A new device was found */
703 AC_PATH_DEREGISTERED = 0x040,/* A path has de-registered */
704 AC_PATH_REGISTERED = 0x020,/* A new path has been registered */
705 AC_SENT_BDR = 0x010,/* A BDR message was sent to target */
706 AC_SCSI_AEN = 0x008,/* A SCSI AEN has been received */
707 AC_UNSOL_RESEL = 0x002,/* Unsolicited reselection occurred */
708 AC_BUS_RESET = 0x001 /* A SCSI bus reset occurred */
709} ac_code;
710
711typedef void ac_callback_t (void *softc, u_int32_t code,
712 struct cam_path *path, void *args);
713
714/*
715 * Generic Asynchronous callbacks.
716 *
717 * Generic arguments passed bac which are then interpreted between a per-system
718 * contract number.
719 */
720#define AC_CONTRACT_DATA_MAX (128 - sizeof (u_int64_t))
721struct ac_contract {
722 u_int64_t contract_number;
723 u_int8_t contract_data[AC_CONTRACT_DATA_MAX];
724};
725
726#define AC_CONTRACT_DEV_CHG 1
727struct ac_device_changed {
728 u_int64_t wwpn;
729 u_int32_t port;
730 target_id_t target;
731 u_int8_t arrived;
732};
733
734/* Set Asynchronous Callback CCB */
735struct ccb_setasync {
736 struct ccb_hdr ccb_h;
737 u_int32_t event_enable; /* Async Event enables */
738 ac_callback_t *callback;
739 void *callback_arg;
740};
741
742/* Set Device Type CCB */
743struct ccb_setdev {
744 struct ccb_hdr ccb_h;
745 u_int8_t dev_type; /* Value for dev type field in EDT */
746};
747
748/* SCSI Control Functions */
749
750/* Abort XPT request CCB */
751struct ccb_abort {
752 struct ccb_hdr ccb_h;
753 union ccb *abort_ccb; /* Pointer to CCB to abort */
754};
755
756/* Reset SCSI Bus CCB */
757struct ccb_resetbus {
758 struct ccb_hdr ccb_h;
759};
760
761/* Reset SCSI Device CCB */
762struct ccb_resetdev {
763 struct ccb_hdr ccb_h;
764};
765
766/* Terminate I/O Process Request CCB */
767struct ccb_termio {
768 struct ccb_hdr ccb_h;
769 union ccb *termio_ccb; /* Pointer to CCB to terminate */
770};
771
772typedef enum {
773 CTS_TYPE_CURRENT_SETTINGS,
774 CTS_TYPE_USER_SETTINGS
775} cts_type;
776
777struct ccb_trans_settings_scsi
778{
779 u_int valid; /* Which fields to honor */
780#define CTS_SCSI_VALID_TQ 0x01
781 u_int flags;
782#define CTS_SCSI_FLAGS_TAG_ENB 0x01
783};
784
785struct ccb_trans_settings_spi
786{
787 u_int valid; /* Which fields to honor */
788#define CTS_SPI_VALID_SYNC_RATE 0x01
789#define CTS_SPI_VALID_SYNC_OFFSET 0x02
790#define CTS_SPI_VALID_BUS_WIDTH 0x04
791#define CTS_SPI_VALID_DISC 0x08
792#define CTS_SPI_VALID_PPR_OPTIONS 0x10
793 u_int flags;
794#define CTS_SPI_FLAGS_DISC_ENB 0x01
795 u_int sync_period;
796 u_int sync_offset;
797 u_int bus_width;
798 u_int ppr_options;
799};
800
801struct ccb_trans_settings_fc {
802 u_int valid; /* Which fields to honor */
803#define CTS_FC_VALID_WWNN 0x8000
804#define CTS_FC_VALID_WWPN 0x4000
805#define CTS_FC_VALID_PORT 0x2000
806#define CTS_FC_VALID_SPEED 0x1000
807 u_int64_t wwnn; /* world wide node name */
808 u_int64_t wwpn; /* world wide port name */
809 u_int32_t port; /* 24 bit port id, if known */
810 u_int32_t bitrate; /* Mbps */
811};
812
813struct ccb_trans_settings_sas {
814 u_int valid; /* Which fields to honor */
815#define CTS_SAS_VALID_SPEED 0x1000
816 u_int32_t bitrate; /* Mbps */
817};
818
819struct ccb_trans_settings_ata {
820 u_int valid; /* Which fields to honor */
821#define CTS_ATA_VALID_MODE 0x01
822#define CTS_ATA_VALID_BYTECOUNT 0x02
| 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_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 */
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 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
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/* SCSI Control Functions: 0x10->0x1F */
146 XPT_ABORT = 0x10,
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 */
152 XPT_TERM_IO = 0x13,
153 /* Terminate the I/O process */
154 XPT_SCAN_LUN = 0x14 | XPT_FC_QUEUED | XPT_FC_USER_CCB
155 | XPT_FC_XPT_ONLY,
156 /* Scan Logical Unit */
157 XPT_GET_TRAN_SETTINGS = 0x15,
158 /*
159 * Get default/user transfer settings
160 * for the target
161 */
162 XPT_SET_TRAN_SETTINGS = 0x16,
163 /*
164 * Set transfer rate/width
165 * negotiation settings
166 */
167 XPT_CALC_GEOMETRY = 0x17,
168 /*
169 * Calculate the geometry parameters for
170 * a device give the sector size and
171 * volume size.
172 */
173 XPT_ATA_IO = 0x18 | XPT_FC_DEV_QUEUED,
174 /* Execute the requested ATA I/O operation */
175
176 XPT_GET_SIM_KNOB = 0x18,
177 /*
178 * Get SIM specific knob values.
179 */
180
181 XPT_SET_SIM_KNOB = 0x19,
182 /*
183 * Set SIM specific knob values.
184 */
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 */
190
191/* Target mode commands: 0x30->0x3F */
192 XPT_EN_LUN = 0x30,
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 */
208
209/* Vendor Unique codes: 0x80->0x8F */
210 XPT_VUNIQUE = 0x80
211} xpt_opcode;
212
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
220
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)
225
226typedef enum {
227 PROTO_UNKNOWN,
228 PROTO_UNSPECIFIED,
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 */
233} cam_proto;
234
235typedef enum {
236 XPORT_UNKNOWN,
237 XPORT_UNSPECIFIED,
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 */
246 XPORT_ISCSI, /* iSCSI */
247} cam_xport;
248
249#define PROTO_VERSION_UNKNOWN (UINT_MAX - 1)
250#define PROTO_VERSION_UNSPECIFIED UINT_MAX
251#define XPORT_VERSION_UNKNOWN (UINT_MAX - 1)
252#define XPORT_VERSION_UNSPECIFIED UINT_MAX
253
254typedef union {
255 LIST_ENTRY(ccb_hdr) le;
256 SLIST_ENTRY(ccb_hdr) sle;
257 TAILQ_ENTRY(ccb_hdr) tqe;
258 STAILQ_ENTRY(ccb_hdr) stqe;
259} camq_entry;
260
261typedef union {
262 void *ptr;
263 u_long field;
264 u_int8_t bytes[sizeof(uintptr_t)];
265} ccb_priv_entry;
266
267typedef union {
268 ccb_priv_entry entries[CCB_PERIPH_PRIV_SIZE];
269 u_int8_t bytes[CCB_PERIPH_PRIV_SIZE * sizeof(ccb_priv_entry)];
270} ccb_ppriv_area;
271
272typedef union {
273 ccb_priv_entry entries[CCB_SIM_PRIV_SIZE];
274 u_int8_t bytes[CCB_SIM_PRIV_SIZE * sizeof(ccb_priv_entry)];
275} ccb_spriv_area;
276
277struct ccb_hdr {
278 cam_pinfo pinfo; /* Info for priority scheduling */
279 camq_entry xpt_links; /* For chaining in the XPT layer */
280 camq_entry sim_links; /* For chaining in the SIM layer */
281 camq_entry periph_links; /* For chaining in the type driver */
282 u_int32_t retry_count;
283 void (*cbfcnp)(struct cam_periph *, union ccb *);
284 /* Callback on completion function */
285 xpt_opcode func_code; /* XPT function code */
286 u_int32_t status; /* Status returned by CAM subsystem */
287 struct cam_path *path; /* Compiled path for this ccb */
288 path_id_t path_id; /* Path ID for the request */
289 target_id_t target_id; /* Target device ID */
290 lun_id_t target_lun; /* Target LUN number */
291 u_int32_t flags; /* ccb_flags */
292 ccb_ppriv_area periph_priv;
293 ccb_spriv_area sim_priv;
294 u_int32_t timeout; /* Timeout value */
295
296 /*
297 * Deprecated, only for use by non-MPSAFE SIMs. All others must
298 * allocate and initialize their own callout storage.
299 */
300 struct callout_handle timeout_ch;
301};
302
303/* Get Device Information CCB */
304struct ccb_getdev {
305 struct ccb_hdr ccb_h;
306 cam_proto protocol;
307 struct scsi_inquiry_data inq_data;
308 struct ata_params ident_data;
309 u_int8_t serial_num[252];
310 u_int8_t inq_flags;
311 u_int8_t serial_num_len;
312};
313
314/* Device Statistics CCB */
315struct ccb_getdevstats {
316 struct ccb_hdr ccb_h;
317 int dev_openings; /* Space left for more work on device*/
318 int dev_active; /* Transactions running on the device */
319 int devq_openings; /* Space left for more queued work */
320 int devq_queued; /* Transactions queued to be sent */
321 int held; /*
322 * CCBs held by peripheral drivers
323 * for this device
324 */
325 int maxtags; /*
326 * Boundary conditions for number of
327 * tagged operations
328 */
329 int mintags;
330 struct timeval last_reset; /* Time of last bus reset/loop init */
331};
332
333typedef enum {
334 CAM_GDEVLIST_LAST_DEVICE,
335 CAM_GDEVLIST_LIST_CHANGED,
336 CAM_GDEVLIST_MORE_DEVS,
337 CAM_GDEVLIST_ERROR
338} ccb_getdevlist_status_e;
339
340struct ccb_getdevlist {
341 struct ccb_hdr ccb_h;
342 char periph_name[DEV_IDLEN];
343 u_int32_t unit_number;
344 unsigned int generation;
345 u_int32_t index;
346 ccb_getdevlist_status_e status;
347};
348
349typedef enum {
350 PERIPH_MATCH_NONE = 0x000,
351 PERIPH_MATCH_PATH = 0x001,
352 PERIPH_MATCH_TARGET = 0x002,
353 PERIPH_MATCH_LUN = 0x004,
354 PERIPH_MATCH_NAME = 0x008,
355 PERIPH_MATCH_UNIT = 0x010,
356 PERIPH_MATCH_ANY = 0x01f
357} periph_pattern_flags;
358
359struct periph_match_pattern {
360 char periph_name[DEV_IDLEN];
361 u_int32_t unit_number;
362 path_id_t path_id;
363 target_id_t target_id;
364 lun_id_t target_lun;
365 periph_pattern_flags flags;
366};
367
368typedef enum {
369 DEV_MATCH_NONE = 0x000,
370 DEV_MATCH_PATH = 0x001,
371 DEV_MATCH_TARGET = 0x002,
372 DEV_MATCH_LUN = 0x004,
373 DEV_MATCH_INQUIRY = 0x008,
374 DEV_MATCH_ANY = 0x00f
375} dev_pattern_flags;
376
377struct device_match_pattern {
378 path_id_t path_id;
379 target_id_t target_id;
380 lun_id_t target_lun;
381 struct scsi_static_inquiry_pattern inq_pat;
382 dev_pattern_flags flags;
383};
384
385typedef enum {
386 BUS_MATCH_NONE = 0x000,
387 BUS_MATCH_PATH = 0x001,
388 BUS_MATCH_NAME = 0x002,
389 BUS_MATCH_UNIT = 0x004,
390 BUS_MATCH_BUS_ID = 0x008,
391 BUS_MATCH_ANY = 0x00f
392} bus_pattern_flags;
393
394struct bus_match_pattern {
395 path_id_t path_id;
396 char dev_name[DEV_IDLEN];
397 u_int32_t unit_number;
398 u_int32_t bus_id;
399 bus_pattern_flags flags;
400};
401
402union match_pattern {
403 struct periph_match_pattern periph_pattern;
404 struct device_match_pattern device_pattern;
405 struct bus_match_pattern bus_pattern;
406};
407
408typedef enum {
409 DEV_MATCH_PERIPH,
410 DEV_MATCH_DEVICE,
411 DEV_MATCH_BUS
412} dev_match_type;
413
414struct dev_match_pattern {
415 dev_match_type type;
416 union match_pattern pattern;
417};
418
419struct periph_match_result {
420 char periph_name[DEV_IDLEN];
421 u_int32_t unit_number;
422 path_id_t path_id;
423 target_id_t target_id;
424 lun_id_t target_lun;
425};
426
427typedef enum {
428 DEV_RESULT_NOFLAG = 0x00,
429 DEV_RESULT_UNCONFIGURED = 0x01
430} dev_result_flags;
431
432struct device_match_result {
433 path_id_t path_id;
434 target_id_t target_id;
435 lun_id_t target_lun;
436 cam_proto protocol;
437 struct scsi_inquiry_data inq_data;
438 struct ata_params ident_data;
439 dev_result_flags flags;
440};
441
442struct bus_match_result {
443 path_id_t path_id;
444 char dev_name[DEV_IDLEN];
445 u_int32_t unit_number;
446 u_int32_t bus_id;
447};
448
449union match_result {
450 struct periph_match_result periph_result;
451 struct device_match_result device_result;
452 struct bus_match_result bus_result;
453};
454
455struct dev_match_result {
456 dev_match_type type;
457 union match_result result;
458};
459
460typedef enum {
461 CAM_DEV_MATCH_LAST,
462 CAM_DEV_MATCH_MORE,
463 CAM_DEV_MATCH_LIST_CHANGED,
464 CAM_DEV_MATCH_SIZE_ERROR,
465 CAM_DEV_MATCH_ERROR
466} ccb_dev_match_status;
467
468typedef enum {
469 CAM_DEV_POS_NONE = 0x000,
470 CAM_DEV_POS_BUS = 0x001,
471 CAM_DEV_POS_TARGET = 0x002,
472 CAM_DEV_POS_DEVICE = 0x004,
473 CAM_DEV_POS_PERIPH = 0x008,
474 CAM_DEV_POS_PDPTR = 0x010,
475 CAM_DEV_POS_TYPEMASK = 0xf00,
476 CAM_DEV_POS_EDT = 0x100,
477 CAM_DEV_POS_PDRV = 0x200
478} dev_pos_type;
479
480struct ccb_dm_cookie {
481 void *bus;
482 void *target;
483 void *device;
484 void *periph;
485 void *pdrv;
486};
487
488struct ccb_dev_position {
489 u_int generations[4];
490#define CAM_BUS_GENERATION 0x00
491#define CAM_TARGET_GENERATION 0x01
492#define CAM_DEV_GENERATION 0x02
493#define CAM_PERIPH_GENERATION 0x03
494 dev_pos_type position_type;
495 struct ccb_dm_cookie cookie;
496};
497
498struct ccb_dev_match {
499 struct ccb_hdr ccb_h;
500 ccb_dev_match_status status;
501 u_int32_t num_patterns;
502 u_int32_t pattern_buf_len;
503 struct dev_match_pattern *patterns;
504 u_int32_t num_matches;
505 u_int32_t match_buf_len;
506 struct dev_match_result *matches;
507 struct ccb_dev_position pos;
508};
509
510/*
511 * Definitions for the path inquiry CCB fields.
512 */
513#define CAM_VERSION 0x15 /* Hex value for current version */
514
515typedef enum {
516 PI_MDP_ABLE = 0x80, /* Supports MDP message */
517 PI_WIDE_32 = 0x40, /* Supports 32 bit wide SCSI */
518 PI_WIDE_16 = 0x20, /* Supports 16 bit wide SCSI */
519 PI_SDTR_ABLE = 0x10, /* Supports SDTR message */
520 PI_LINKED_CDB = 0x08, /* Supports linked CDBs */
521 PI_SATAPM = 0x04, /* Supports SATA PM */
522 PI_TAG_ABLE = 0x02, /* Supports tag queue messages */
523 PI_SOFT_RST = 0x01 /* Supports soft reset alternative */
524} pi_inqflag;
525
526typedef enum {
527 PIT_PROCESSOR = 0x80, /* Target mode processor mode */
528 PIT_PHASE = 0x40, /* Target mode phase cog. mode */
529 PIT_DISCONNECT = 0x20, /* Disconnects supported in target mode */
530 PIT_TERM_IO = 0x10, /* Terminate I/O message supported in TM */
531 PIT_GRP_6 = 0x08, /* Group 6 commands supported */
532 PIT_GRP_7 = 0x04 /* Group 7 commands supported */
533} pi_tmflag;
534
535typedef enum {
536 PIM_SCANHILO = 0x80, /* Bus scans from high ID to low ID */
537 PIM_NOREMOVE = 0x40, /* Removeable devices not included in scan */
538 PIM_NOINITIATOR = 0x20, /* Initiator role not supported. */
539 PIM_NOBUSRESET = 0x10, /* User has disabled initial BUS RESET */
540 PIM_NO_6_BYTE = 0x08, /* Do not send 6-byte commands */
541 PIM_SEQSCAN = 0x04 /* Do bus scans sequentially, not in parallel */
542} pi_miscflag;
543
544/* Path Inquiry CCB */
545struct ccb_pathinq_settings_spi {
546 u_int8_t ppr_options;
547};
548
549struct ccb_pathinq_settings_fc {
550 u_int64_t wwnn; /* world wide node name */
551 u_int64_t wwpn; /* world wide port name */
552 u_int32_t port; /* 24 bit port id, if known */
553 u_int32_t bitrate; /* Mbps */
554};
555
556struct ccb_pathinq_settings_sas {
557 u_int32_t bitrate; /* Mbps */
558};
559#define PATHINQ_SETTINGS_SIZE 128
560
561struct ccb_pathinq {
562 struct ccb_hdr ccb_h;
563 u_int8_t version_num; /* Version number for the SIM/HBA */
564 u_int8_t hba_inquiry; /* Mimic of INQ byte 7 for the HBA */
565 u_int8_t target_sprt; /* Flags for target mode support */
566 u_int8_t hba_misc; /* Misc HBA features */
567 u_int16_t hba_eng_cnt; /* HBA engine count */
568 /* Vendor Unique capabilities */
569 u_int8_t vuhba_flags[VUHBALEN];
570 u_int32_t max_target; /* Maximum supported Target */
571 u_int32_t max_lun; /* Maximum supported Lun */
572 u_int32_t async_flags; /* Installed Async handlers */
573 path_id_t hpath_id; /* Highest Path ID in the subsystem */
574 target_id_t initiator_id; /* ID of the HBA on the SCSI bus */
575 char sim_vid[SIM_IDLEN]; /* Vendor ID of the SIM */
576 char hba_vid[HBA_IDLEN]; /* Vendor ID of the HBA */
577 char dev_name[DEV_IDLEN];/* Device name for SIM */
578 u_int32_t unit_number; /* Unit number for SIM */
579 u_int32_t bus_id; /* Bus ID for SIM */
580 u_int32_t base_transfer_speed;/* Base bus speed in KB/sec */
581 cam_proto protocol;
582 u_int protocol_version;
583 cam_xport transport;
584 u_int transport_version;
585 union {
586 struct ccb_pathinq_settings_spi spi;
587 struct ccb_pathinq_settings_fc fc;
588 struct ccb_pathinq_settings_sas sas;
589 char ccb_pathinq_settings_opaque[PATHINQ_SETTINGS_SIZE];
590 } xport_specific;
591 u_int maxio; /* Max supported I/O size, in bytes. */
592};
593
594/* Path Statistics CCB */
595struct ccb_pathstats {
596 struct ccb_hdr ccb_h;
597 struct timeval last_reset; /* Time of last bus reset/loop init */
598};
599
600typedef union {
601 u_int8_t *sense_ptr; /*
602 * Pointer to storage
603 * for sense information
604 */
605 /* Storage Area for sense information */
606 struct scsi_sense_data sense_buf;
607} sense_t;
608
609typedef union {
610 u_int8_t *cdb_ptr; /* Pointer to the CDB bytes to send */
611 /* Area for the CDB send */
612 u_int8_t cdb_bytes[IOCDBLEN];
613} cdb_t;
614
615/*
616 * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO
617 * function codes.
618 */
619struct ccb_scsiio {
620 struct ccb_hdr ccb_h;
621 union ccb *next_ccb; /* Ptr for next CCB for action */
622 u_int8_t *req_map; /* Ptr to mapping info */
623 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */
624 u_int32_t dxfer_len; /* Data transfer length */
625 /* Autosense storage */
626 struct scsi_sense_data sense_data;
627 u_int8_t sense_len; /* Number of bytes to autosense */
628 u_int8_t cdb_len; /* Number of bytes for the CDB */
629 u_int16_t sglist_cnt; /* Number of SG list entries */
630 u_int8_t scsi_status; /* Returned SCSI status */
631 u_int8_t sense_resid; /* Autosense resid length: 2's comp */
632 u_int32_t resid; /* Transfer residual length: 2's comp */
633 cdb_t cdb_io; /* Union for CDB bytes/pointer */
634 u_int8_t *msg_ptr; /* Pointer to the message buffer */
635 u_int16_t msg_len; /* Number of bytes for the Message */
636 u_int8_t tag_action; /* What to do for tag queueing */
637 /*
638 * The tag action should be either the define below (to send a
639 * non-tagged transaction) or one of the defined scsi tag messages
640 * from scsi_message.h.
641 */
642#define CAM_TAG_ACTION_NONE 0x00
643 u_int tag_id; /* tag id from initator (target mode) */
644 u_int init_id; /* initiator id of who selected */
645};
646
647/*
648 * ATA I/O Request CCB used for the XPT_ATA_IO function code.
649 */
650struct ccb_ataio {
651 struct ccb_hdr ccb_h;
652 union ccb *next_ccb; /* Ptr for next CCB for action */
653 struct ata_cmd cmd; /* ATA command register set */
654 struct ata_res res; /* ATA result register set */
655 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */
656 u_int32_t dxfer_len; /* Data transfer length */
657 u_int32_t resid; /* Transfer residual length: 2's comp */
658 u_int8_t tag_action; /* What to do for tag queueing */
659 /*
660 * The tag action should be either the define below (to send a
661 * non-tagged transaction) or one of the defined scsi tag messages
662 * from scsi_message.h.
663 */
664#define CAM_TAG_ACTION_NONE 0x00
665 u_int tag_id; /* tag id from initator (target mode) */
666 u_int init_id; /* initiator id of who selected */
667};
668
669struct ccb_accept_tio {
670 struct ccb_hdr ccb_h;
671 cdb_t cdb_io; /* Union for CDB bytes/pointer */
672 u_int8_t cdb_len; /* Number of bytes for the CDB */
673 u_int8_t tag_action; /* What to do for tag queueing */
674 u_int8_t sense_len; /* Number of bytes of Sense Data */
675 u_int tag_id; /* tag id from initator (target mode) */
676 u_int init_id; /* initiator id of who selected */
677 struct scsi_sense_data sense_data;
678};
679
680/* Release SIM Queue */
681struct ccb_relsim {
682 struct ccb_hdr ccb_h;
683 u_int32_t release_flags;
684#define RELSIM_ADJUST_OPENINGS 0x01
685#define RELSIM_RELEASE_AFTER_TIMEOUT 0x02
686#define RELSIM_RELEASE_AFTER_CMDCMPLT 0x04
687#define RELSIM_RELEASE_AFTER_QEMPTY 0x08
688 u_int32_t openings;
689 u_int32_t release_timeout;
690 u_int32_t qfrozen_cnt;
691};
692
693/*
694 * Definitions for the asynchronous callback CCB fields.
695 */
696typedef enum {
697 AC_CONTRACT = 0x1000,/* A contractual callback */
698 AC_GETDEV_CHANGED = 0x800,/* Getdev info might have changed */
699 AC_INQ_CHANGED = 0x400,/* Inquiry info might have changed */
700 AC_TRANSFER_NEG = 0x200,/* New transfer settings in effect */
701 AC_LOST_DEVICE = 0x100,/* A device went away */
702 AC_FOUND_DEVICE = 0x080,/* A new device was found */
703 AC_PATH_DEREGISTERED = 0x040,/* A path has de-registered */
704 AC_PATH_REGISTERED = 0x020,/* A new path has been registered */
705 AC_SENT_BDR = 0x010,/* A BDR message was sent to target */
706 AC_SCSI_AEN = 0x008,/* A SCSI AEN has been received */
707 AC_UNSOL_RESEL = 0x002,/* Unsolicited reselection occurred */
708 AC_BUS_RESET = 0x001 /* A SCSI bus reset occurred */
709} ac_code;
710
711typedef void ac_callback_t (void *softc, u_int32_t code,
712 struct cam_path *path, void *args);
713
714/*
715 * Generic Asynchronous callbacks.
716 *
717 * Generic arguments passed bac which are then interpreted between a per-system
718 * contract number.
719 */
720#define AC_CONTRACT_DATA_MAX (128 - sizeof (u_int64_t))
721struct ac_contract {
722 u_int64_t contract_number;
723 u_int8_t contract_data[AC_CONTRACT_DATA_MAX];
724};
725
726#define AC_CONTRACT_DEV_CHG 1
727struct ac_device_changed {
728 u_int64_t wwpn;
729 u_int32_t port;
730 target_id_t target;
731 u_int8_t arrived;
732};
733
734/* Set Asynchronous Callback CCB */
735struct ccb_setasync {
736 struct ccb_hdr ccb_h;
737 u_int32_t event_enable; /* Async Event enables */
738 ac_callback_t *callback;
739 void *callback_arg;
740};
741
742/* Set Device Type CCB */
743struct ccb_setdev {
744 struct ccb_hdr ccb_h;
745 u_int8_t dev_type; /* Value for dev type field in EDT */
746};
747
748/* SCSI Control Functions */
749
750/* Abort XPT request CCB */
751struct ccb_abort {
752 struct ccb_hdr ccb_h;
753 union ccb *abort_ccb; /* Pointer to CCB to abort */
754};
755
756/* Reset SCSI Bus CCB */
757struct ccb_resetbus {
758 struct ccb_hdr ccb_h;
759};
760
761/* Reset SCSI Device CCB */
762struct ccb_resetdev {
763 struct ccb_hdr ccb_h;
764};
765
766/* Terminate I/O Process Request CCB */
767struct ccb_termio {
768 struct ccb_hdr ccb_h;
769 union ccb *termio_ccb; /* Pointer to CCB to terminate */
770};
771
772typedef enum {
773 CTS_TYPE_CURRENT_SETTINGS,
774 CTS_TYPE_USER_SETTINGS
775} cts_type;
776
777struct ccb_trans_settings_scsi
778{
779 u_int valid; /* Which fields to honor */
780#define CTS_SCSI_VALID_TQ 0x01
781 u_int flags;
782#define CTS_SCSI_FLAGS_TAG_ENB 0x01
783};
784
785struct ccb_trans_settings_spi
786{
787 u_int valid; /* Which fields to honor */
788#define CTS_SPI_VALID_SYNC_RATE 0x01
789#define CTS_SPI_VALID_SYNC_OFFSET 0x02
790#define CTS_SPI_VALID_BUS_WIDTH 0x04
791#define CTS_SPI_VALID_DISC 0x08
792#define CTS_SPI_VALID_PPR_OPTIONS 0x10
793 u_int flags;
794#define CTS_SPI_FLAGS_DISC_ENB 0x01
795 u_int sync_period;
796 u_int sync_offset;
797 u_int bus_width;
798 u_int ppr_options;
799};
800
801struct ccb_trans_settings_fc {
802 u_int valid; /* Which fields to honor */
803#define CTS_FC_VALID_WWNN 0x8000
804#define CTS_FC_VALID_WWPN 0x4000
805#define CTS_FC_VALID_PORT 0x2000
806#define CTS_FC_VALID_SPEED 0x1000
807 u_int64_t wwnn; /* world wide node name */
808 u_int64_t wwpn; /* world wide port name */
809 u_int32_t port; /* 24 bit port id, if known */
810 u_int32_t bitrate; /* Mbps */
811};
812
813struct ccb_trans_settings_sas {
814 u_int valid; /* Which fields to honor */
815#define CTS_SAS_VALID_SPEED 0x1000
816 u_int32_t bitrate; /* Mbps */
817};
818
819struct ccb_trans_settings_ata {
820 u_int valid; /* Which fields to honor */
821#define CTS_ATA_VALID_MODE 0x01
822#define CTS_ATA_VALID_BYTECOUNT 0x02
|
837 u_int pm_present; /* PM is present (XPT->SIM) */
838 u_int tags; /* Number of allowed tags */
839};
840
841/* Get/Set transfer rate/width/disconnection/tag queueing settings */
842struct ccb_trans_settings {
843 struct ccb_hdr ccb_h;
844 cts_type type; /* Current or User settings */
845 cam_proto protocol;
846 u_int protocol_version;
847 cam_xport transport;
848 u_int transport_version;
849 union {
850 u_int valid; /* Which fields to honor */
851 struct ccb_trans_settings_scsi scsi;
852 } proto_specific;
853 union {
854 u_int valid; /* Which fields to honor */
855 struct ccb_trans_settings_spi spi;
856 struct ccb_trans_settings_fc fc;
857 struct ccb_trans_settings_sas sas;
858 struct ccb_trans_settings_ata ata;
859 struct ccb_trans_settings_sata sata;
860 } xport_specific;
861};
862
863
864/*
865 * Calculate the geometry parameters for a device
866 * give the block size and volume size in blocks.
867 */
868struct ccb_calc_geometry {
869 struct ccb_hdr ccb_h;
870 u_int32_t block_size;
871 u_int64_t volume_size;
872 u_int32_t cylinders;
873 u_int8_t heads;
874 u_int8_t secs_per_track;
875};
876
877/*
878 * Set or get SIM (and transport) specific knobs
879 */
880
881#define KNOB_VALID_ADDRESS 0x1
882#define KNOB_VALID_ROLE 0x2
883
884
885#define KNOB_ROLE_NONE 0x0
886#define KNOB_ROLE_INITIATOR 0x1
887#define KNOB_ROLE_TARGET 0x2
888#define KNOB_ROLE_BOTH 0x3
889
890struct ccb_sim_knob_settings_spi {
891 u_int valid;
892 u_int initiator_id;
893 u_int role;
894};
895
896struct ccb_sim_knob_settings_fc {
897 u_int valid;
898 u_int64_t wwnn; /* world wide node name */
899 u_int64_t wwpn; /* world wide port name */
900 u_int role;
901};
902
903struct ccb_sim_knob_settings_sas {
904 u_int valid;
905 u_int64_t wwnn; /* world wide node name */
906 u_int role;
907};
908#define KNOB_SETTINGS_SIZE 128
909
910struct ccb_sim_knob {
911 struct ccb_hdr ccb_h;
912 union {
913 u_int valid; /* Which fields to honor */
914 struct ccb_sim_knob_settings_spi spi;
915 struct ccb_sim_knob_settings_fc fc;
916 struct ccb_sim_knob_settings_sas sas;
917 char pad[KNOB_SETTINGS_SIZE];
918 } xport_specific;
919};
920
921/*
922 * Rescan the given bus, or bus/target/lun
923 */
924struct ccb_rescan {
925 struct ccb_hdr ccb_h;
926 cam_flags flags;
927};
928
929/*
930 * Turn on debugging for the given bus, bus/target, or bus/target/lun.
931 */
932struct ccb_debug {
933 struct ccb_hdr ccb_h;
934 cam_debug_flags flags;
935};
936
937/* Target mode structures. */
938
939struct ccb_en_lun {
940 struct ccb_hdr ccb_h;
941 u_int16_t grp6_len; /* Group 6 VU CDB length */
942 u_int16_t grp7_len; /* Group 7 VU CDB length */
943 u_int8_t enable;
944};
945
946/* old, barely used immediate notify, binary compatibility */
947struct ccb_immed_notify {
948 struct ccb_hdr ccb_h;
949 struct scsi_sense_data sense_data;
950 u_int8_t sense_len; /* Number of bytes in sense buffer */
951 u_int8_t initiator_id; /* Id of initiator that selected */
952 u_int8_t message_args[7]; /* Message Arguments */
953};
954
955struct ccb_notify_ack {
956 struct ccb_hdr ccb_h;
957 u_int16_t seq_id; /* Sequence identifier */
958 u_int8_t event; /* Event flags */
959};
960
961struct ccb_immediate_notify {
962 struct ccb_hdr ccb_h;
963 u_int tag_id; /* Tag for immediate notify */
964 u_int seq_id; /* Tag for target of notify */
965 u_int initiator_id; /* Initiator Identifier */
966 u_int arg; /* Function specific */
967};
968
969struct ccb_notify_acknowledge {
970 struct ccb_hdr ccb_h;
971 u_int tag_id; /* Tag for immediate notify */
972 u_int seq_id; /* Tar for target of notify */
973 u_int initiator_id; /* Initiator Identifier */
974 u_int arg; /* Function specific */
975};
976
977/* HBA engine structures. */
978
979typedef enum {
980 EIT_BUFFER, /* Engine type: buffer memory */
981 EIT_LOSSLESS, /* Engine type: lossless compression */
982 EIT_LOSSY, /* Engine type: lossy compression */
983 EIT_ENCRYPT /* Engine type: encryption */
984} ei_type;
985
986typedef enum {
987 EAD_VUNIQUE, /* Engine algorithm ID: vendor unique */
988 EAD_LZ1V1, /* Engine algorithm ID: LZ1 var.1 */
989 EAD_LZ2V1, /* Engine algorithm ID: LZ2 var.1 */
990 EAD_LZ2V2 /* Engine algorithm ID: LZ2 var.2 */
991} ei_algo;
992
993struct ccb_eng_inq {
994 struct ccb_hdr ccb_h;
995 u_int16_t eng_num; /* The engine number for this inquiry */
996 ei_type eng_type; /* Returned engine type */
997 ei_algo eng_algo; /* Returned engine algorithm type */
998 u_int32_t eng_memeory; /* Returned engine memory size */
999};
1000
1001struct ccb_eng_exec { /* This structure must match SCSIIO size */
1002 struct ccb_hdr ccb_h;
1003 u_int8_t *pdrv_ptr; /* Ptr used by the peripheral driver */
1004 u_int8_t *req_map; /* Ptr for mapping info on the req. */
1005 u_int8_t *data_ptr; /* Pointer to the data buf/SG list */
1006 u_int32_t dxfer_len; /* Data transfer length */
1007 u_int8_t *engdata_ptr; /* Pointer to the engine buffer data */
1008 u_int16_t sglist_cnt; /* Num of scatter gather list entries */
1009 u_int32_t dmax_len; /* Destination data maximum length */
1010 u_int32_t dest_len; /* Destination data length */
1011 int32_t src_resid; /* Source residual length: 2's comp */
1012 u_int32_t timeout; /* Timeout value */
1013 u_int16_t eng_num; /* Engine number for this request */
1014 u_int16_t vu_flags; /* Vendor Unique flags */
1015};
1016
1017/*
1018 * Definitions for the timeout field in the SCSI I/O CCB.
1019 */
1020#define CAM_TIME_DEFAULT 0x00000000 /* Use SIM default value */
1021#define CAM_TIME_INFINITY 0xFFFFFFFF /* Infinite timeout */
1022
1023#define CAM_SUCCESS 0 /* For signaling general success */
1024#define CAM_FAILURE 1 /* For signaling general failure */
1025
1026#define CAM_FALSE 0
1027#define CAM_TRUE 1
1028
1029#define XPT_CCB_INVALID -1 /* for signaling a bad CCB to free */
1030
1031/*
1032 * Union of all CCB types for kernel space allocation. This union should
1033 * never be used for manipulating CCBs - its only use is for the allocation
1034 * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc
1035 * and the argument to xpt_ccb_free.
1036 */
1037union ccb {
1038 struct ccb_hdr ccb_h; /* For convenience */
1039 struct ccb_scsiio csio;
1040 struct ccb_getdev cgd;
1041 struct ccb_getdevlist cgdl;
1042 struct ccb_pathinq cpi;
1043 struct ccb_relsim crs;
1044 struct ccb_setasync csa;
1045 struct ccb_setdev csd;
1046 struct ccb_pathstats cpis;
1047 struct ccb_getdevstats cgds;
1048 struct ccb_dev_match cdm;
1049 struct ccb_trans_settings cts;
1050 struct ccb_calc_geometry ccg;
1051 struct ccb_sim_knob knob;
1052 struct ccb_abort cab;
1053 struct ccb_resetbus crb;
1054 struct ccb_resetdev crd;
1055 struct ccb_termio tio;
1056 struct ccb_accept_tio atio;
1057 struct ccb_scsiio ctio;
1058 struct ccb_en_lun cel;
1059 struct ccb_immed_notify cin;
1060 struct ccb_notify_ack cna;
1061 struct ccb_immediate_notify cin1;
1062 struct ccb_notify_acknowledge cna2;
1063 struct ccb_eng_inq cei;
1064 struct ccb_eng_exec cee;
1065 struct ccb_rescan crcn;
1066 struct ccb_debug cdbg;
1067 struct ccb_ataio ataio;
1068};
1069
1070__BEGIN_DECLS
1071static __inline void
1072cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
1073 void (*cbfcnp)(struct cam_periph *, union ccb *),
1074 u_int32_t flags, u_int8_t tag_action,
1075 u_int8_t *data_ptr, u_int32_t dxfer_len,
1076 u_int8_t sense_len, u_int8_t cdb_len,
1077 u_int32_t timeout);
1078
1079static __inline void
1080cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
1081 void (*cbfcnp)(struct cam_periph *, union ccb *),
1082 u_int32_t flags, u_int tag_action, u_int tag_id,
1083 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
1084 u_int32_t dxfer_len, u_int32_t timeout);
1085
1086static __inline void
1087cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries,
1088 void (*cbfcnp)(struct cam_periph *, union ccb *),
1089 u_int32_t flags, u_int tag_action,
1090 u_int8_t *data_ptr, u_int32_t dxfer_len,
1091 u_int32_t timeout);
1092
1093static __inline void
1094cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
1095 void (*cbfcnp)(struct cam_periph *, union ccb *),
1096 u_int32_t flags, u_int8_t tag_action,
1097 u_int8_t *data_ptr, u_int32_t dxfer_len,
1098 u_int8_t sense_len, u_int8_t cdb_len,
1099 u_int32_t timeout)
1100{
1101 csio->ccb_h.func_code = XPT_SCSI_IO;
1102 csio->ccb_h.flags = flags;
1103 csio->ccb_h.retry_count = retries;
1104 csio->ccb_h.cbfcnp = cbfcnp;
1105 csio->ccb_h.timeout = timeout;
1106 csio->data_ptr = data_ptr;
1107 csio->dxfer_len = dxfer_len;
1108 csio->sense_len = sense_len;
1109 csio->cdb_len = cdb_len;
1110 csio->tag_action = tag_action;
1111}
1112
1113static __inline void
1114cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
1115 void (*cbfcnp)(struct cam_periph *, union ccb *),
1116 u_int32_t flags, u_int tag_action, u_int tag_id,
1117 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
1118 u_int32_t dxfer_len, u_int32_t timeout)
1119{
1120 csio->ccb_h.func_code = XPT_CONT_TARGET_IO;
1121 csio->ccb_h.flags = flags;
1122 csio->ccb_h.retry_count = retries;
1123 csio->ccb_h.cbfcnp = cbfcnp;
1124 csio->ccb_h.timeout = timeout;
1125 csio->data_ptr = data_ptr;
1126 csio->dxfer_len = dxfer_len;
1127 csio->scsi_status = scsi_status;
1128 csio->tag_action = tag_action;
1129 csio->tag_id = tag_id;
1130 csio->init_id = init_id;
1131}
1132
1133static __inline void
1134cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries,
1135 void (*cbfcnp)(struct cam_periph *, union ccb *),
1136 u_int32_t flags, u_int tag_action,
1137 u_int8_t *data_ptr, u_int32_t dxfer_len,
1138 u_int32_t timeout)
1139{
1140 ataio->ccb_h.func_code = XPT_ATA_IO;
1141 ataio->ccb_h.flags = flags;
1142 ataio->ccb_h.retry_count = retries;
1143 ataio->ccb_h.cbfcnp = cbfcnp;
1144 ataio->ccb_h.timeout = timeout;
1145 ataio->data_ptr = data_ptr;
1146 ataio->dxfer_len = dxfer_len;
1147 ataio->tag_action = tag_action;
1148}
1149
1150void cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended);
1151
1152__END_DECLS
1153
1154#endif /* _CAM_CAM_CCB_H */
| 837 u_int pm_present; /* PM is present (XPT->SIM) */
838 u_int tags; /* Number of allowed tags */
839};
840
841/* Get/Set transfer rate/width/disconnection/tag queueing settings */
842struct ccb_trans_settings {
843 struct ccb_hdr ccb_h;
844 cts_type type; /* Current or User settings */
845 cam_proto protocol;
846 u_int protocol_version;
847 cam_xport transport;
848 u_int transport_version;
849 union {
850 u_int valid; /* Which fields to honor */
851 struct ccb_trans_settings_scsi scsi;
852 } proto_specific;
853 union {
854 u_int valid; /* Which fields to honor */
855 struct ccb_trans_settings_spi spi;
856 struct ccb_trans_settings_fc fc;
857 struct ccb_trans_settings_sas sas;
858 struct ccb_trans_settings_ata ata;
859 struct ccb_trans_settings_sata sata;
860 } xport_specific;
861};
862
863
864/*
865 * Calculate the geometry parameters for a device
866 * give the block size and volume size in blocks.
867 */
868struct ccb_calc_geometry {
869 struct ccb_hdr ccb_h;
870 u_int32_t block_size;
871 u_int64_t volume_size;
872 u_int32_t cylinders;
873 u_int8_t heads;
874 u_int8_t secs_per_track;
875};
876
877/*
878 * Set or get SIM (and transport) specific knobs
879 */
880
881#define KNOB_VALID_ADDRESS 0x1
882#define KNOB_VALID_ROLE 0x2
883
884
885#define KNOB_ROLE_NONE 0x0
886#define KNOB_ROLE_INITIATOR 0x1
887#define KNOB_ROLE_TARGET 0x2
888#define KNOB_ROLE_BOTH 0x3
889
890struct ccb_sim_knob_settings_spi {
891 u_int valid;
892 u_int initiator_id;
893 u_int role;
894};
895
896struct ccb_sim_knob_settings_fc {
897 u_int valid;
898 u_int64_t wwnn; /* world wide node name */
899 u_int64_t wwpn; /* world wide port name */
900 u_int role;
901};
902
903struct ccb_sim_knob_settings_sas {
904 u_int valid;
905 u_int64_t wwnn; /* world wide node name */
906 u_int role;
907};
908#define KNOB_SETTINGS_SIZE 128
909
910struct ccb_sim_knob {
911 struct ccb_hdr ccb_h;
912 union {
913 u_int valid; /* Which fields to honor */
914 struct ccb_sim_knob_settings_spi spi;
915 struct ccb_sim_knob_settings_fc fc;
916 struct ccb_sim_knob_settings_sas sas;
917 char pad[KNOB_SETTINGS_SIZE];
918 } xport_specific;
919};
920
921/*
922 * Rescan the given bus, or bus/target/lun
923 */
924struct ccb_rescan {
925 struct ccb_hdr ccb_h;
926 cam_flags flags;
927};
928
929/*
930 * Turn on debugging for the given bus, bus/target, or bus/target/lun.
931 */
932struct ccb_debug {
933 struct ccb_hdr ccb_h;
934 cam_debug_flags flags;
935};
936
937/* Target mode structures. */
938
939struct ccb_en_lun {
940 struct ccb_hdr ccb_h;
941 u_int16_t grp6_len; /* Group 6 VU CDB length */
942 u_int16_t grp7_len; /* Group 7 VU CDB length */
943 u_int8_t enable;
944};
945
946/* old, barely used immediate notify, binary compatibility */
947struct ccb_immed_notify {
948 struct ccb_hdr ccb_h;
949 struct scsi_sense_data sense_data;
950 u_int8_t sense_len; /* Number of bytes in sense buffer */
951 u_int8_t initiator_id; /* Id of initiator that selected */
952 u_int8_t message_args[7]; /* Message Arguments */
953};
954
955struct ccb_notify_ack {
956 struct ccb_hdr ccb_h;
957 u_int16_t seq_id; /* Sequence identifier */
958 u_int8_t event; /* Event flags */
959};
960
961struct ccb_immediate_notify {
962 struct ccb_hdr ccb_h;
963 u_int tag_id; /* Tag for immediate notify */
964 u_int seq_id; /* Tag for target of notify */
965 u_int initiator_id; /* Initiator Identifier */
966 u_int arg; /* Function specific */
967};
968
969struct ccb_notify_acknowledge {
970 struct ccb_hdr ccb_h;
971 u_int tag_id; /* Tag for immediate notify */
972 u_int seq_id; /* Tar for target of notify */
973 u_int initiator_id; /* Initiator Identifier */
974 u_int arg; /* Function specific */
975};
976
977/* HBA engine structures. */
978
979typedef enum {
980 EIT_BUFFER, /* Engine type: buffer memory */
981 EIT_LOSSLESS, /* Engine type: lossless compression */
982 EIT_LOSSY, /* Engine type: lossy compression */
983 EIT_ENCRYPT /* Engine type: encryption */
984} ei_type;
985
986typedef enum {
987 EAD_VUNIQUE, /* Engine algorithm ID: vendor unique */
988 EAD_LZ1V1, /* Engine algorithm ID: LZ1 var.1 */
989 EAD_LZ2V1, /* Engine algorithm ID: LZ2 var.1 */
990 EAD_LZ2V2 /* Engine algorithm ID: LZ2 var.2 */
991} ei_algo;
992
993struct ccb_eng_inq {
994 struct ccb_hdr ccb_h;
995 u_int16_t eng_num; /* The engine number for this inquiry */
996 ei_type eng_type; /* Returned engine type */
997 ei_algo eng_algo; /* Returned engine algorithm type */
998 u_int32_t eng_memeory; /* Returned engine memory size */
999};
1000
1001struct ccb_eng_exec { /* This structure must match SCSIIO size */
1002 struct ccb_hdr ccb_h;
1003 u_int8_t *pdrv_ptr; /* Ptr used by the peripheral driver */
1004 u_int8_t *req_map; /* Ptr for mapping info on the req. */
1005 u_int8_t *data_ptr; /* Pointer to the data buf/SG list */
1006 u_int32_t dxfer_len; /* Data transfer length */
1007 u_int8_t *engdata_ptr; /* Pointer to the engine buffer data */
1008 u_int16_t sglist_cnt; /* Num of scatter gather list entries */
1009 u_int32_t dmax_len; /* Destination data maximum length */
1010 u_int32_t dest_len; /* Destination data length */
1011 int32_t src_resid; /* Source residual length: 2's comp */
1012 u_int32_t timeout; /* Timeout value */
1013 u_int16_t eng_num; /* Engine number for this request */
1014 u_int16_t vu_flags; /* Vendor Unique flags */
1015};
1016
1017/*
1018 * Definitions for the timeout field in the SCSI I/O CCB.
1019 */
1020#define CAM_TIME_DEFAULT 0x00000000 /* Use SIM default value */
1021#define CAM_TIME_INFINITY 0xFFFFFFFF /* Infinite timeout */
1022
1023#define CAM_SUCCESS 0 /* For signaling general success */
1024#define CAM_FAILURE 1 /* For signaling general failure */
1025
1026#define CAM_FALSE 0
1027#define CAM_TRUE 1
1028
1029#define XPT_CCB_INVALID -1 /* for signaling a bad CCB to free */
1030
1031/*
1032 * Union of all CCB types for kernel space allocation. This union should
1033 * never be used for manipulating CCBs - its only use is for the allocation
1034 * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc
1035 * and the argument to xpt_ccb_free.
1036 */
1037union ccb {
1038 struct ccb_hdr ccb_h; /* For convenience */
1039 struct ccb_scsiio csio;
1040 struct ccb_getdev cgd;
1041 struct ccb_getdevlist cgdl;
1042 struct ccb_pathinq cpi;
1043 struct ccb_relsim crs;
1044 struct ccb_setasync csa;
1045 struct ccb_setdev csd;
1046 struct ccb_pathstats cpis;
1047 struct ccb_getdevstats cgds;
1048 struct ccb_dev_match cdm;
1049 struct ccb_trans_settings cts;
1050 struct ccb_calc_geometry ccg;
1051 struct ccb_sim_knob knob;
1052 struct ccb_abort cab;
1053 struct ccb_resetbus crb;
1054 struct ccb_resetdev crd;
1055 struct ccb_termio tio;
1056 struct ccb_accept_tio atio;
1057 struct ccb_scsiio ctio;
1058 struct ccb_en_lun cel;
1059 struct ccb_immed_notify cin;
1060 struct ccb_notify_ack cna;
1061 struct ccb_immediate_notify cin1;
1062 struct ccb_notify_acknowledge cna2;
1063 struct ccb_eng_inq cei;
1064 struct ccb_eng_exec cee;
1065 struct ccb_rescan crcn;
1066 struct ccb_debug cdbg;
1067 struct ccb_ataio ataio;
1068};
1069
1070__BEGIN_DECLS
1071static __inline void
1072cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
1073 void (*cbfcnp)(struct cam_periph *, union ccb *),
1074 u_int32_t flags, u_int8_t tag_action,
1075 u_int8_t *data_ptr, u_int32_t dxfer_len,
1076 u_int8_t sense_len, u_int8_t cdb_len,
1077 u_int32_t timeout);
1078
1079static __inline void
1080cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
1081 void (*cbfcnp)(struct cam_periph *, union ccb *),
1082 u_int32_t flags, u_int tag_action, u_int tag_id,
1083 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
1084 u_int32_t dxfer_len, u_int32_t timeout);
1085
1086static __inline void
1087cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries,
1088 void (*cbfcnp)(struct cam_periph *, union ccb *),
1089 u_int32_t flags, u_int tag_action,
1090 u_int8_t *data_ptr, u_int32_t dxfer_len,
1091 u_int32_t timeout);
1092
1093static __inline void
1094cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
1095 void (*cbfcnp)(struct cam_periph *, union ccb *),
1096 u_int32_t flags, u_int8_t tag_action,
1097 u_int8_t *data_ptr, u_int32_t dxfer_len,
1098 u_int8_t sense_len, u_int8_t cdb_len,
1099 u_int32_t timeout)
1100{
1101 csio->ccb_h.func_code = XPT_SCSI_IO;
1102 csio->ccb_h.flags = flags;
1103 csio->ccb_h.retry_count = retries;
1104 csio->ccb_h.cbfcnp = cbfcnp;
1105 csio->ccb_h.timeout = timeout;
1106 csio->data_ptr = data_ptr;
1107 csio->dxfer_len = dxfer_len;
1108 csio->sense_len = sense_len;
1109 csio->cdb_len = cdb_len;
1110 csio->tag_action = tag_action;
1111}
1112
1113static __inline void
1114cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
1115 void (*cbfcnp)(struct cam_periph *, union ccb *),
1116 u_int32_t flags, u_int tag_action, u_int tag_id,
1117 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
1118 u_int32_t dxfer_len, u_int32_t timeout)
1119{
1120 csio->ccb_h.func_code = XPT_CONT_TARGET_IO;
1121 csio->ccb_h.flags = flags;
1122 csio->ccb_h.retry_count = retries;
1123 csio->ccb_h.cbfcnp = cbfcnp;
1124 csio->ccb_h.timeout = timeout;
1125 csio->data_ptr = data_ptr;
1126 csio->dxfer_len = dxfer_len;
1127 csio->scsi_status = scsi_status;
1128 csio->tag_action = tag_action;
1129 csio->tag_id = tag_id;
1130 csio->init_id = init_id;
1131}
1132
1133static __inline void
1134cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries,
1135 void (*cbfcnp)(struct cam_periph *, union ccb *),
1136 u_int32_t flags, u_int tag_action,
1137 u_int8_t *data_ptr, u_int32_t dxfer_len,
1138 u_int32_t timeout)
1139{
1140 ataio->ccb_h.func_code = XPT_ATA_IO;
1141 ataio->ccb_h.flags = flags;
1142 ataio->ccb_h.retry_count = retries;
1143 ataio->ccb_h.cbfcnp = cbfcnp;
1144 ataio->ccb_h.timeout = timeout;
1145 ataio->data_ptr = data_ptr;
1146 ataio->dxfer_len = dxfer_len;
1147 ataio->tag_action = tag_action;
1148}
1149
1150void cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended);
1151
1152__END_DECLS
1153
1154#endif /* _CAM_CAM_CCB_H */
|