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