FreeBSD/Linux Kernel Cross Reference
sys/cam/cam_ccb.h
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: releng/6.2/sys/cam/cam_ccb.h 159407 2006-06-08 17:51:27Z mjacob $
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 #ifdef CAM_NEW_TRAN_CODE
38 #include <sys/limits.h>
39 #endif /* CAM_NEW_TRAN_CODE */
40 #ifndef _KERNEL
41 #include <sys/callout.h>
42 #endif
43 #include <cam/cam_debug.h>
44 #include <cam/scsi/scsi_all.h>
45
46
47 /* General allocation length definitions for CCB structures */
48 #define IOCDBLEN CAM_MAX_CDBLEN /* Space for CDB bytes/pointer */
49 #define VUHBALEN 14 /* Vendor Unique HBA length */
50 #define SIM_IDLEN 16 /* ASCII string len for SIM ID */
51 #define HBA_IDLEN 16 /* ASCII string len for HBA ID */
52 #define DEV_IDLEN 16 /* ASCII string len for device names */
53 #define CCB_PERIPH_PRIV_SIZE 2 /* size of peripheral private area */
54 #define CCB_SIM_PRIV_SIZE 2 /* size of sim private area */
55
56 /* Struct definitions for CAM control blocks */
57
58 /* Common CCB header */
59 /* CAM CCB flags */
60 typedef enum {
61 CAM_CDB_POINTER = 0x00000001,/* The CDB field is a pointer */
62 CAM_QUEUE_ENABLE = 0x00000002,/* SIM queue actions are enabled */
63 CAM_CDB_LINKED = 0x00000004,/* CCB contains a linked CDB */
64 CAM_NEGOTIATE = 0x00000008,/*
65 * Perform transport negotiation
66 * with this command.
67 */
68 CAM_SCATTER_VALID = 0x00000010,/* Scatter/gather list is valid */
69 CAM_DIS_AUTOSENSE = 0x00000020,/* Disable autosense feature */
70 CAM_DIR_RESV = 0x00000000,/* Data direction (00:reserved) */
71 CAM_DIR_IN = 0x00000040,/* Data direction (01:DATA IN) */
72 CAM_DIR_OUT = 0x00000080,/* Data direction (10:DATA OUT) */
73 CAM_DIR_NONE = 0x000000C0,/* Data direction (11:no data) */
74 CAM_DIR_MASK = 0x000000C0,/* Data direction Mask */
75 CAM_SOFT_RST_OP = 0x00000100,/* Use Soft reset alternative */
76 CAM_ENG_SYNC = 0x00000200,/* Flush resid bytes on complete */
77 CAM_DEV_QFRZDIS = 0x00000400,/* Disable DEV Q freezing */
78 CAM_DEV_QFREEZE = 0x00000800,/* Freeze DEV Q on execution */
79 CAM_HIGH_POWER = 0x00001000,/* Command takes a lot of power */
80 CAM_SENSE_PTR = 0x00002000,/* Sense data is a pointer */
81 CAM_SENSE_PHYS = 0x00004000,/* Sense pointer is physical addr*/
82 CAM_TAG_ACTION_VALID = 0x00008000,/* Use the tag action in this ccb*/
83 CAM_PASS_ERR_RECOVER = 0x00010000,/* Pass driver does err. recovery*/
84 CAM_DIS_DISCONNECT = 0x00020000,/* Disable disconnect */
85 CAM_SG_LIST_PHYS = 0x00040000,/* SG list has physical addrs. */
86 CAM_MSG_BUF_PHYS = 0x00080000,/* Message buffer ptr is physical*/
87 CAM_SNS_BUF_PHYS = 0x00100000,/* Autosense data ptr is physical*/
88 CAM_DATA_PHYS = 0x00200000,/* SG/Buffer data ptrs are phys. */
89 CAM_CDB_PHYS = 0x00400000,/* CDB poiner is physical */
90 CAM_ENG_SGLIST = 0x00800000,/* SG list is for the HBA engine */
91
92 /* Phase cognizant mode flags */
93 CAM_DIS_AUTOSRP = 0x01000000,/* Disable autosave/restore ptrs */
94 CAM_DIS_AUTODISC = 0x02000000,/* Disable auto disconnect */
95 CAM_TGT_CCB_AVAIL = 0x04000000,/* Target CCB available */
96 CAM_TGT_PHASE_MODE = 0x08000000,/* The SIM runs in phase mode */
97 CAM_MSGB_VALID = 0x10000000,/* Message buffer valid */
98 CAM_STATUS_VALID = 0x20000000,/* Status buffer valid */
99 CAM_DATAB_VALID = 0x40000000,/* Data buffer valid */
100
101 /* Host target Mode flags */
102 CAM_SEND_SENSE = 0x08000000,/* Send sense data with status */
103 CAM_TERM_IO = 0x10000000,/* Terminate I/O Message sup. */
104 CAM_DISCONNECT = 0x20000000,/* Disconnects are mandatory */
105 CAM_SEND_STATUS = 0x40000000 /* Send status after data phase */
106 } ccb_flags;
107
108 /* XPT Opcodes for xpt_action */
109 typedef enum {
110 /* Function code flags are bits greater than 0xff */
111 XPT_FC_QUEUED = 0x100,
112 /* Non-immediate function code */
113 XPT_FC_USER_CCB = 0x200,
114 XPT_FC_XPT_ONLY = 0x400,
115 /* Only for the transport layer device */
116 XPT_FC_DEV_QUEUED = 0x800 | XPT_FC_QUEUED,
117 /* Passes through the device queues */
118 /* Common function commands: 0x00->0x0F */
119 XPT_NOOP = 0x00,
120 /* Execute Nothing */
121 XPT_SCSI_IO = 0x01 | XPT_FC_DEV_QUEUED,
122 /* Execute the requested I/O operation */
123 XPT_GDEV_TYPE = 0x02,
124 /* Get type information for specified device */
125 XPT_GDEVLIST = 0x03,
126 /* Get a list of peripheral devices */
127 XPT_PATH_INQ = 0x04,
128 /* Path routing inquiry */
129 XPT_REL_SIMQ = 0x05,
130 /* Release a frozen SIM queue */
131 XPT_SASYNC_CB = 0x06,
132 /* Set Asynchronous Callback Parameters */
133 XPT_SDEV_TYPE = 0x07,
134 /* Set device type information */
135 XPT_SCAN_BUS = 0x08 | XPT_FC_QUEUED | XPT_FC_USER_CCB
136 | XPT_FC_XPT_ONLY,
137 /* (Re)Scan the SCSI Bus */
138 XPT_DEV_MATCH = 0x09 | XPT_FC_XPT_ONLY,
139 /* Get EDT entries matching the given pattern */
140 XPT_DEBUG = 0x0a,
141 /* Turn on debugging for a bus, target or lun */
142 XPT_PATH_STATS = 0x0b,
143 /* Path statistics (error counts, etc.) */
144 XPT_GDEV_STATS = 0x0c,
145 /* Device statistics (error counts, etc.) */
146 /* SCSI Control Functions: 0x10->0x1F */
147 XPT_ABORT = 0x10,
148 /* Abort the specified CCB */
149 XPT_RESET_BUS = 0x11 | XPT_FC_XPT_ONLY,
150 /* Reset the specified SCSI bus */
151 XPT_RESET_DEV = 0x12 | XPT_FC_DEV_QUEUED,
152 /* Bus Device Reset the specified SCSI device */
153 XPT_TERM_IO = 0x13,
154 /* Terminate the I/O process */
155 XPT_SCAN_LUN = 0x14 | XPT_FC_QUEUED | XPT_FC_USER_CCB
156 | XPT_FC_XPT_ONLY,
157 /* Scan Logical Unit */
158 XPT_GET_TRAN_SETTINGS = 0x15,
159 /*
160 * Get default/user transfer settings
161 * for the target
162 */
163 XPT_SET_TRAN_SETTINGS = 0x16,
164 /*
165 * Set transfer rate/width
166 * negotiation settings
167 */
168 XPT_CALC_GEOMETRY = 0x17,
169 /*
170 * Calculate the geometry parameters for
171 * a device give the sector size and
172 * volume size.
173 */
174
175 /* HBA engine commands 0x20->0x2F */
176 XPT_ENG_INQ = 0x20 | XPT_FC_XPT_ONLY,
177 /* HBA engine feature inquiry */
178 XPT_ENG_EXEC = 0x21 | XPT_FC_DEV_QUEUED,
179 /* HBA execute engine request */
180
181 /* Target mode commands: 0x30->0x3F */
182 XPT_EN_LUN = 0x30,
183 /* Enable LUN as a target */
184 XPT_TARGET_IO = 0x31 | XPT_FC_DEV_QUEUED,
185 /* Execute target I/O request */
186 XPT_ACCEPT_TARGET_IO = 0x32 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
187 /* Accept Host Target Mode CDB */
188 XPT_CONT_TARGET_IO = 0x33 | XPT_FC_DEV_QUEUED,
189 /* Continue Host Target I/O Connection */
190 XPT_IMMED_NOTIFY = 0x34 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
191 /* Notify Host Target driver of event */
192 XPT_NOTIFY_ACK = 0x35,
193 /* Acknowledgement of event */
194
195 /* Vendor Unique codes: 0x80->0x8F */
196 XPT_VUNIQUE = 0x80
197 } xpt_opcode;
198
199 #define XPT_FC_GROUP_MASK 0xF0
200 #define XPT_FC_GROUP(op) ((op) & XPT_FC_GROUP_MASK)
201 #define XPT_FC_GROUP_COMMON 0x00
202 #define XPT_FC_GROUP_SCSI_CONTROL 0x10
203 #define XPT_FC_GROUP_HBA_ENGINE 0x20
204 #define XPT_FC_GROUP_TMODE 0x30
205 #define XPT_FC_GROUP_VENDOR_UNIQUE 0x80
206
207 #define XPT_FC_IS_DEV_QUEUED(ccb) \
208 (((ccb)->ccb_h.func_code & XPT_FC_DEV_QUEUED) == XPT_FC_DEV_QUEUED)
209 #define XPT_FC_IS_QUEUED(ccb) \
210 (((ccb)->ccb_h.func_code & XPT_FC_QUEUED) != 0)
211
212 #ifdef CAM_NEW_TRAN_CODE
213 typedef enum {
214 PROTO_UNKNOWN,
215 PROTO_UNSPECIFIED,
216 PROTO_SCSI, /* Small Computer System Interface */
217 PROTO_ATA, /* AT Attachment */
218 PROTO_ATAPI, /* AT Attachment Packetized Interface */
219 } cam_proto;
220
221 typedef enum {
222 XPORT_UNKNOWN,
223 XPORT_UNSPECIFIED,
224 XPORT_SPI, /* SCSI Parallel Interface */
225 XPORT_FC, /* Fiber Channel */
226 XPORT_SSA, /* Serial Storage Architecture */
227 XPORT_USB, /* Universal Serial Bus */
228 XPORT_PPB, /* Parallel Port Bus */
229 XPORT_ATA /* AT Attachment */
230 } cam_xport;
231
232 #define PROTO_VERSION_UNKNOWN (UINT_MAX - 1)
233 #define PROTO_VERSION_UNSPECIFIED UINT_MAX
234 #define XPORT_VERSION_UNKNOWN (UINT_MAX - 1)
235 #define XPORT_VERSION_UNSPECIFIED UINT_MAX
236 #endif /* CAM_NEW_TRAN_CODE */
237
238 typedef union {
239 LIST_ENTRY(ccb_hdr) le;
240 SLIST_ENTRY(ccb_hdr) sle;
241 TAILQ_ENTRY(ccb_hdr) tqe;
242 STAILQ_ENTRY(ccb_hdr) stqe;
243 } camq_entry;
244
245 typedef union {
246 void *ptr;
247 u_long field;
248 u_int8_t bytes[sizeof(void *) > sizeof(u_long)
249 ? sizeof(void *) : sizeof(u_long)];
250 } ccb_priv_entry;
251
252 typedef union {
253 ccb_priv_entry entries[CCB_PERIPH_PRIV_SIZE];
254 u_int8_t bytes[CCB_PERIPH_PRIV_SIZE * sizeof(ccb_priv_entry)];
255 } ccb_ppriv_area;
256
257 typedef union {
258 ccb_priv_entry entries[CCB_SIM_PRIV_SIZE];
259 u_int8_t bytes[CCB_SIM_PRIV_SIZE * sizeof(ccb_priv_entry)];
260 } ccb_spriv_area;
261
262 struct ccb_hdr {
263 cam_pinfo pinfo; /* Info for priority scheduling */
264 camq_entry xpt_links; /* For chaining in the XPT layer */
265 camq_entry sim_links; /* For chaining in the SIM layer */
266 camq_entry periph_links; /* For chaining in the type driver */
267 u_int32_t retry_count;
268 void (*cbfcnp)(struct cam_periph *, union ccb *);
269 /* Callback on completion function */
270 xpt_opcode func_code; /* XPT function code */
271 u_int32_t status; /* Status returned by CAM subsystem */
272 struct cam_path *path; /* Compiled path for this ccb */
273 path_id_t path_id; /* Path ID for the request */
274 target_id_t target_id; /* Target device ID */
275 lun_id_t target_lun; /* Target LUN number */
276 u_int32_t flags; /* ccb_flags */
277 ccb_ppriv_area periph_priv;
278 ccb_spriv_area sim_priv;
279 u_int32_t timeout; /* Timeout value */
280 struct callout_handle timeout_ch;
281 /* Callout handle used for timeouts */
282 };
283
284 /* Get Device Information CCB */
285 struct ccb_getdev {
286 struct ccb_hdr ccb_h;
287 struct scsi_inquiry_data inq_data;
288 u_int8_t serial_num[252];
289 u_int8_t reserved;
290 u_int8_t serial_num_len;
291 };
292
293 /* Device Statistics CCB */
294 struct ccb_getdevstats {
295 struct ccb_hdr ccb_h;
296 int dev_openings; /* Space left for more work on device*/
297 int dev_active; /* Transactions running on the device */
298 int devq_openings; /* Space left for more queued work */
299 int devq_queued; /* Transactions queued to be sent */
300 int held; /*
301 * CCBs held by peripheral drivers
302 * for this device
303 */
304 int maxtags; /*
305 * Boundary conditions for number of
306 * tagged operations
307 */
308 int mintags;
309 struct timeval last_reset; /* Time of last bus reset/loop init */
310 };
311
312 typedef enum {
313 CAM_GDEVLIST_LAST_DEVICE,
314 CAM_GDEVLIST_LIST_CHANGED,
315 CAM_GDEVLIST_MORE_DEVS,
316 CAM_GDEVLIST_ERROR
317 } ccb_getdevlist_status_e;
318
319 struct ccb_getdevlist {
320 struct ccb_hdr ccb_h;
321 char periph_name[DEV_IDLEN];
322 u_int32_t unit_number;
323 unsigned int generation;
324 u_int32_t index;
325 ccb_getdevlist_status_e status;
326 };
327
328 typedef enum {
329 PERIPH_MATCH_NONE = 0x000,
330 PERIPH_MATCH_PATH = 0x001,
331 PERIPH_MATCH_TARGET = 0x002,
332 PERIPH_MATCH_LUN = 0x004,
333 PERIPH_MATCH_NAME = 0x008,
334 PERIPH_MATCH_UNIT = 0x010,
335 PERIPH_MATCH_ANY = 0x01f
336 } periph_pattern_flags;
337
338 struct periph_match_pattern {
339 char periph_name[DEV_IDLEN];
340 u_int32_t unit_number;
341 path_id_t path_id;
342 target_id_t target_id;
343 lun_id_t target_lun;
344 periph_pattern_flags flags;
345 };
346
347 typedef enum {
348 DEV_MATCH_NONE = 0x000,
349 DEV_MATCH_PATH = 0x001,
350 DEV_MATCH_TARGET = 0x002,
351 DEV_MATCH_LUN = 0x004,
352 DEV_MATCH_INQUIRY = 0x008,
353 DEV_MATCH_ANY = 0x00f
354 } dev_pattern_flags;
355
356 struct device_match_pattern {
357 path_id_t path_id;
358 target_id_t target_id;
359 lun_id_t target_lun;
360 struct scsi_static_inquiry_pattern inq_pat;
361 dev_pattern_flags flags;
362 };
363
364 typedef enum {
365 BUS_MATCH_NONE = 0x000,
366 BUS_MATCH_PATH = 0x001,
367 BUS_MATCH_NAME = 0x002,
368 BUS_MATCH_UNIT = 0x004,
369 BUS_MATCH_BUS_ID = 0x008,
370 BUS_MATCH_ANY = 0x00f
371 } bus_pattern_flags;
372
373 struct bus_match_pattern {
374 path_id_t path_id;
375 char dev_name[DEV_IDLEN];
376 u_int32_t unit_number;
377 u_int32_t bus_id;
378 bus_pattern_flags flags;
379 };
380
381 union match_pattern {
382 struct periph_match_pattern periph_pattern;
383 struct device_match_pattern device_pattern;
384 struct bus_match_pattern bus_pattern;
385 };
386
387 typedef enum {
388 DEV_MATCH_PERIPH,
389 DEV_MATCH_DEVICE,
390 DEV_MATCH_BUS
391 } dev_match_type;
392
393 struct dev_match_pattern {
394 dev_match_type type;
395 union match_pattern pattern;
396 };
397
398 struct periph_match_result {
399 char periph_name[DEV_IDLEN];
400 u_int32_t unit_number;
401 path_id_t path_id;
402 target_id_t target_id;
403 lun_id_t target_lun;
404 };
405
406 typedef enum {
407 DEV_RESULT_NOFLAG = 0x00,
408 DEV_RESULT_UNCONFIGURED = 0x01
409 } dev_result_flags;
410
411 struct device_match_result {
412 path_id_t path_id;
413 target_id_t target_id;
414 lun_id_t target_lun;
415 struct scsi_inquiry_data inq_data;
416 dev_result_flags flags;
417 };
418
419 struct bus_match_result {
420 path_id_t path_id;
421 char dev_name[DEV_IDLEN];
422 u_int32_t unit_number;
423 u_int32_t bus_id;
424 };
425
426 union match_result {
427 struct periph_match_result periph_result;
428 struct device_match_result device_result;
429 struct bus_match_result bus_result;
430 };
431
432 struct dev_match_result {
433 dev_match_type type;
434 union match_result result;
435 };
436
437 typedef enum {
438 CAM_DEV_MATCH_LAST,
439 CAM_DEV_MATCH_MORE,
440 CAM_DEV_MATCH_LIST_CHANGED,
441 CAM_DEV_MATCH_SIZE_ERROR,
442 CAM_DEV_MATCH_ERROR
443 } ccb_dev_match_status;
444
445 typedef enum {
446 CAM_DEV_POS_NONE = 0x000,
447 CAM_DEV_POS_BUS = 0x001,
448 CAM_DEV_POS_TARGET = 0x002,
449 CAM_DEV_POS_DEVICE = 0x004,
450 CAM_DEV_POS_PERIPH = 0x008,
451 CAM_DEV_POS_PDPTR = 0x010,
452 CAM_DEV_POS_TYPEMASK = 0xf00,
453 CAM_DEV_POS_EDT = 0x100,
454 CAM_DEV_POS_PDRV = 0x200
455 } dev_pos_type;
456
457 struct ccb_dm_cookie {
458 void *bus;
459 void *target;
460 void *device;
461 void *periph;
462 void *pdrv;
463 };
464
465 struct ccb_dev_position {
466 u_int generations[4];
467 #define CAM_BUS_GENERATION 0x00
468 #define CAM_TARGET_GENERATION 0x01
469 #define CAM_DEV_GENERATION 0x02
470 #define CAM_PERIPH_GENERATION 0x03
471 dev_pos_type position_type;
472 struct ccb_dm_cookie cookie;
473 };
474
475 struct ccb_dev_match {
476 struct ccb_hdr ccb_h;
477 ccb_dev_match_status status;
478 u_int32_t num_patterns;
479 u_int32_t pattern_buf_len;
480 struct dev_match_pattern *patterns;
481 u_int32_t num_matches;
482 u_int32_t match_buf_len;
483 struct dev_match_result *matches;
484 struct ccb_dev_position pos;
485 };
486
487 /*
488 * Definitions for the path inquiry CCB fields.
489 */
490 #define CAM_VERSION 0x15 /* Hex value for current version */
491
492 typedef enum {
493 PI_MDP_ABLE = 0x80, /* Supports MDP message */
494 PI_WIDE_32 = 0x40, /* Supports 32 bit wide SCSI */
495 PI_WIDE_16 = 0x20, /* Supports 16 bit wide SCSI */
496 PI_SDTR_ABLE = 0x10, /* Supports SDTR message */
497 PI_LINKED_CDB = 0x08, /* Supports linked CDBs */
498 PI_TAG_ABLE = 0x02, /* Supports tag queue messages */
499 PI_SOFT_RST = 0x01 /* Supports soft reset alternative */
500 } pi_inqflag;
501
502 typedef enum {
503 PIT_PROCESSOR = 0x80, /* Target mode processor mode */
504 PIT_PHASE = 0x40, /* Target mode phase cog. mode */
505 PIT_DISCONNECT = 0x20, /* Disconnects supported in target mode */
506 PIT_TERM_IO = 0x10, /* Terminate I/O message supported in TM */
507 PIT_GRP_6 = 0x08, /* Group 6 commands supported */
508 PIT_GRP_7 = 0x04 /* Group 7 commands supported */
509 } pi_tmflag;
510
511 typedef enum {
512 PIM_SCANHILO = 0x80, /* Bus scans from high ID to low ID */
513 PIM_NOREMOVE = 0x40, /* Removeable devices not included in scan */
514 PIM_NOINITIATOR = 0x20, /* Initiator role not supported. */
515 PIM_NOBUSRESET = 0x10, /* User has disabled initial BUS RESET */
516 PIM_NO_6_BYTE = 0x08, /* Do not send 6-byte commands */
517 PIM_SEQSCAN = 0x04 /* Do bus scans sequentially, not in parallel */
518 } pi_miscflag;
519
520 #ifdef CAM_NEW_TRAN_CODE
521 /* Path Inquiry CCB */
522 struct ccb_pathinq_settings_spi {
523 u_int8_t ppr_options;
524 };
525 struct ccb_pathinq_settings_fc {
526 u_int64_t wwnn; /* world wide node name */
527 u_int64_t wwpn; /* world wide port name */
528 u_int32_t port; /* 24 bit port id, if known */
529 u_int32_t bitrate; /* Mbps */
530 };
531 #define PATHINQ_SETTINGS_SIZE 128
532 #endif /* CAM_NEW_TRAN_CODE */
533
534 struct ccb_pathinq {
535 struct ccb_hdr ccb_h;
536 u_int8_t version_num; /* Version number for the SIM/HBA */
537 u_int8_t hba_inquiry; /* Mimic of INQ byte 7 for the HBA */
538 u_int8_t target_sprt; /* Flags for target mode support */
539 u_int8_t hba_misc; /* Misc HBA features */
540 u_int16_t hba_eng_cnt; /* HBA engine count */
541 /* Vendor Unique capabilities */
542 u_int8_t vuhba_flags[VUHBALEN];
543 u_int32_t max_target; /* Maximum supported Target */
544 u_int32_t max_lun; /* Maximum supported Lun */
545 u_int32_t async_flags; /* Installed Async handlers */
546 path_id_t hpath_id; /* Highest Path ID in the subsystem */
547 target_id_t initiator_id; /* ID of the HBA on the SCSI bus */
548 char sim_vid[SIM_IDLEN]; /* Vendor ID of the SIM */
549 char hba_vid[HBA_IDLEN]; /* Vendor ID of the HBA */
550 char dev_name[DEV_IDLEN];/* Device name for SIM */
551 u_int32_t unit_number; /* Unit number for SIM */
552 u_int32_t bus_id; /* Bus ID for SIM */
553 u_int32_t base_transfer_speed;/* Base bus speed in KB/sec */
554 #ifdef CAM_NEW_TRAN_CODE
555 cam_proto protocol;
556 u_int protocol_version;
557 cam_xport transport;
558 u_int transport_version;
559 union {
560 struct ccb_pathinq_settings_spi spi;
561 struct ccb_pathinq_settings_fc fc;
562 char ccb_pathinq_settings_opaque[PATHINQ_SETTINGS_SIZE];
563 } xport_specific;
564 #endif /* CAM_NEW_TRAN_CODE */
565 };
566
567 /* Path Statistics CCB */
568 struct ccb_pathstats {
569 struct ccb_hdr ccb_h;
570 struct timeval last_reset; /* Time of last bus reset/loop init */
571 };
572
573 typedef union {
574 u_int8_t *sense_ptr; /*
575 * Pointer to storage
576 * for sense information
577 */
578 /* Storage Area for sense information */
579 struct scsi_sense_data sense_buf;
580 } sense_t;
581
582 typedef union {
583 u_int8_t *cdb_ptr; /* Pointer to the CDB bytes to send */
584 /* Area for the CDB send */
585 u_int8_t cdb_bytes[IOCDBLEN];
586 } cdb_t;
587
588 /*
589 * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO
590 * function codes.
591 */
592 struct ccb_scsiio {
593 struct ccb_hdr ccb_h;
594 union ccb *next_ccb; /* Ptr for next CCB for action */
595 u_int8_t *req_map; /* Ptr to mapping info */
596 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */
597 u_int32_t dxfer_len; /* Data transfer length */
598 /* Autosense storage */
599 struct scsi_sense_data sense_data;
600 u_int8_t sense_len; /* Number of bytes to autosense */
601 u_int8_t cdb_len; /* Number of bytes for the CDB */
602 u_int16_t sglist_cnt; /* Number of SG list entries */
603 u_int8_t scsi_status; /* Returned SCSI status */
604 u_int8_t sense_resid; /* Autosense resid length: 2's comp */
605 u_int32_t resid; /* Transfer residual length: 2's comp */
606 cdb_t cdb_io; /* Union for CDB bytes/pointer */
607 u_int8_t *msg_ptr; /* Pointer to the message buffer */
608 u_int16_t msg_len; /* Number of bytes for the Message */
609 u_int8_t tag_action; /* What to do for tag queueing */
610 /*
611 * The tag action should be either the define below (to send a
612 * non-tagged transaction) or one of the defined scsi tag messages
613 * from scsi_message.h.
614 */
615 #define CAM_TAG_ACTION_NONE 0x00
616 u_int tag_id; /* tag id from initator (target mode) */
617 u_int init_id; /* initiator id of who selected */
618 };
619
620 struct ccb_accept_tio {
621 struct ccb_hdr ccb_h;
622 cdb_t cdb_io; /* Union for CDB bytes/pointer */
623 u_int8_t cdb_len; /* Number of bytes for the CDB */
624 u_int8_t tag_action; /* What to do for tag queueing */
625 u_int8_t sense_len; /* Number of bytes of Sense Data */
626 u_int tag_id; /* tag id from initator (target mode) */
627 u_int init_id; /* initiator id of who selected */
628 struct scsi_sense_data sense_data;
629 };
630
631 /* Release SIM Queue */
632 struct ccb_relsim {
633 struct ccb_hdr ccb_h;
634 u_int32_t release_flags;
635 #define RELSIM_ADJUST_OPENINGS 0x01
636 #define RELSIM_RELEASE_AFTER_TIMEOUT 0x02
637 #define RELSIM_RELEASE_AFTER_CMDCMPLT 0x04
638 #define RELSIM_RELEASE_AFTER_QEMPTY 0x08
639 u_int32_t openings;
640 u_int32_t release_timeout;
641 u_int32_t qfrozen_cnt;
642 };
643
644 /*
645 * Definitions for the asynchronous callback CCB fields.
646 */
647 typedef enum {
648 AC_GETDEV_CHANGED = 0x800,/* Getdev info might have changed */
649 AC_INQ_CHANGED = 0x400,/* Inquiry info might have changed */
650 AC_TRANSFER_NEG = 0x200,/* New transfer settings in effect */
651 AC_LOST_DEVICE = 0x100,/* A device went away */
652 AC_FOUND_DEVICE = 0x080,/* A new device was found */
653 AC_PATH_DEREGISTERED = 0x040,/* A path has de-registered */
654 AC_PATH_REGISTERED = 0x020,/* A new path has been registered */
655 AC_SENT_BDR = 0x010,/* A BDR message was sent to target */
656 AC_SCSI_AEN = 0x008,/* A SCSI AEN has been received */
657 AC_UNSOL_RESEL = 0x002,/* Unsolicited reselection occurred */
658 AC_BUS_RESET = 0x001 /* A SCSI bus reset occurred */
659 } ac_code;
660
661 typedef void ac_callback_t (void *softc, u_int32_t code,
662 struct cam_path *path, void *args);
663
664 /* Set Asynchronous Callback CCB */
665 struct ccb_setasync {
666 struct ccb_hdr ccb_h;
667 u_int32_t event_enable; /* Async Event enables */
668 ac_callback_t *callback;
669 void *callback_arg;
670 };
671
672 /* Set Device Type CCB */
673 struct ccb_setdev {
674 struct ccb_hdr ccb_h;
675 u_int8_t dev_type; /* Value for dev type field in EDT */
676 };
677
678 /* SCSI Control Functions */
679
680 /* Abort XPT request CCB */
681 struct ccb_abort {
682 struct ccb_hdr ccb_h;
683 union ccb *abort_ccb; /* Pointer to CCB to abort */
684 };
685
686 /* Reset SCSI Bus CCB */
687 struct ccb_resetbus {
688 struct ccb_hdr ccb_h;
689 };
690
691 /* Reset SCSI Device CCB */
692 struct ccb_resetdev {
693 struct ccb_hdr ccb_h;
694 };
695
696 /* Terminate I/O Process Request CCB */
697 struct ccb_termio {
698 struct ccb_hdr ccb_h;
699 union ccb *termio_ccb; /* Pointer to CCB to terminate */
700 };
701
702 #ifndef CAM_NEW_TRAN_CODE
703 /* Get/Set transfer rate/width/disconnection/tag queueing settings */
704 struct ccb_trans_settings {
705 struct ccb_hdr ccb_h;
706 u_int valid; /* Which fields to honor */
707 #define CCB_TRANS_SYNC_RATE_VALID 0x01
708 #define CCB_TRANS_SYNC_OFFSET_VALID 0x02
709 #define CCB_TRANS_BUS_WIDTH_VALID 0x04
710 #define CCB_TRANS_DISC_VALID 0x08
711 #define CCB_TRANS_TQ_VALID 0x10
712 u_int flags;
713 #define CCB_TRANS_CURRENT_SETTINGS 0x01
714 #define CCB_TRANS_USER_SETTINGS 0x02
715 #define CCB_TRANS_DISC_ENB 0x04
716 #define CCB_TRANS_TAG_ENB 0x08
717 u_int sync_period;
718 u_int sync_offset;
719 u_int bus_width;
720 };
721
722 #else /* CAM_NEW_TRAN_CODE */
723 typedef enum {
724 CTS_TYPE_CURRENT_SETTINGS,
725 CTS_TYPE_USER_SETTINGS
726 } cts_type;
727
728 struct ccb_trans_settings_scsi
729 {
730 u_int valid; /* Which fields to honor */
731 #define CTS_SCSI_VALID_TQ 0x01
732 u_int flags;
733 #define CTS_SCSI_FLAGS_TAG_ENB 0x01
734 };
735
736 struct ccb_trans_settings_spi
737 {
738 u_int valid; /* Which fields to honor */
739 #define CTS_SPI_VALID_SYNC_RATE 0x01
740 #define CTS_SPI_VALID_SYNC_OFFSET 0x02
741 #define CTS_SPI_VALID_BUS_WIDTH 0x04
742 #define CTS_SPI_VALID_DISC 0x08
743 #define CTS_SPI_VALID_PPR_OPTIONS 0x10
744 u_int flags;
745 #define CTS_SPI_FLAGS_DISC_ENB 0x01
746 #define CTS_SPI_FLAGS_TAG_ENB 0x02
747 u_int sync_period;
748 u_int sync_offset;
749 u_int bus_width;
750 u_int ppr_options;
751 };
752
753 struct ccb_trans_settings_fc {
754 u_int valid; /* Which fields to honor */
755 #define CTS_FC_VALID_WWNN 0x8000
756 #define CTS_FC_VALID_WWPN 0x4000
757 #define CTS_FC_VALID_PORT 0x2000
758 #define CTS_FC_VALID_SPEED 0x1000
759 u_int64_t wwnn; /* world wide node name */
760 u_int64_t wwpn; /* world wide port name */
761 u_int32_t port; /* 24 bit port id, if known */
762 u_int32_t bitrate; /* Mbps */
763 };
764
765 /* Get/Set transfer rate/width/disconnection/tag queueing settings */
766 struct ccb_trans_settings {
767 struct ccb_hdr ccb_h;
768 cts_type type; /* Current or User settings */
769 cam_proto protocol;
770 u_int protocol_version;
771 cam_xport transport;
772 u_int transport_version;
773 union {
774 u_int valid; /* Which fields to honor */
775 struct ccb_trans_settings_scsi scsi;
776 } proto_specific;
777 union {
778 u_int valid; /* Which fields to honor */
779 struct ccb_trans_settings_spi spi;
780 struct ccb_trans_settings_fc fc;
781 } xport_specific;
782 };
783
784 #endif /* CAM_NEW_TRAN_CODE */
785
786 /*
787 * Calculate the geometry parameters for a device
788 * give the block size and volume size in blocks.
789 */
790 struct ccb_calc_geometry {
791 struct ccb_hdr ccb_h;
792 u_int32_t block_size;
793 u_int64_t volume_size;
794 u_int32_t cylinders;
795 u_int8_t heads;
796 u_int8_t secs_per_track;
797 };
798
799 /*
800 * Rescan the given bus, or bus/target/lun
801 */
802 struct ccb_rescan {
803 struct ccb_hdr ccb_h;
804 cam_flags flags;
805 };
806
807 /*
808 * Turn on debugging for the given bus, bus/target, or bus/target/lun.
809 */
810 struct ccb_debug {
811 struct ccb_hdr ccb_h;
812 cam_debug_flags flags;
813 };
814
815 /* Target mode structures. */
816
817 struct ccb_en_lun {
818 struct ccb_hdr ccb_h;
819 u_int16_t grp6_len; /* Group 6 VU CDB length */
820 u_int16_t grp7_len; /* Group 7 VU CDB length */
821 u_int8_t enable;
822 };
823
824 struct ccb_immed_notify {
825 struct ccb_hdr ccb_h;
826 struct scsi_sense_data sense_data;
827 u_int8_t sense_len; /* Number of bytes in sense buffer */
828 u_int8_t initiator_id; /* Id of initiator that selected */
829 u_int8_t message_args[7]; /* Message Arguments */
830 };
831
832 struct ccb_notify_ack {
833 struct ccb_hdr ccb_h;
834 u_int16_t seq_id; /* Sequence identifier */
835 u_int8_t event; /* Event flags */
836 };
837
838 /* HBA engine structures. */
839
840 typedef enum {
841 EIT_BUFFER, /* Engine type: buffer memory */
842 EIT_LOSSLESS, /* Engine type: lossless compression */
843 EIT_LOSSY, /* Engine type: lossy compression */
844 EIT_ENCRYPT /* Engine type: encryption */
845 } ei_type;
846
847 typedef enum {
848 EAD_VUNIQUE, /* Engine algorithm ID: vendor unique */
849 EAD_LZ1V1, /* Engine algorithm ID: LZ1 var.1 */
850 EAD_LZ2V1, /* Engine algorithm ID: LZ2 var.1 */
851 EAD_LZ2V2 /* Engine algorithm ID: LZ2 var.2 */
852 } ei_algo;
853
854 struct ccb_eng_inq {
855 struct ccb_hdr ccb_h;
856 u_int16_t eng_num; /* The engine number for this inquiry */
857 ei_type eng_type; /* Returned engine type */
858 ei_algo eng_algo; /* Returned engine algorithm type */
859 u_int32_t eng_memeory; /* Returned engine memory size */
860 };
861
862 struct ccb_eng_exec { /* This structure must match SCSIIO size */
863 struct ccb_hdr ccb_h;
864 u_int8_t *pdrv_ptr; /* Ptr used by the peripheral driver */
865 u_int8_t *req_map; /* Ptr for mapping info on the req. */
866 u_int8_t *data_ptr; /* Pointer to the data buf/SG list */
867 u_int32_t dxfer_len; /* Data transfer length */
868 u_int8_t *engdata_ptr; /* Pointer to the engine buffer data */
869 u_int16_t sglist_cnt; /* Num of scatter gather list entries */
870 u_int32_t dmax_len; /* Destination data maximum length */
871 u_int32_t dest_len; /* Destination data length */
872 int32_t src_resid; /* Source residual length: 2's comp */
873 u_int32_t timeout; /* Timeout value */
874 u_int16_t eng_num; /* Engine number for this request */
875 u_int16_t vu_flags; /* Vendor Unique flags */
876 };
877
878 /*
879 * Definitions for the timeout field in the SCSI I/O CCB.
880 */
881 #define CAM_TIME_DEFAULT 0x00000000 /* Use SIM default value */
882 #define CAM_TIME_INFINITY 0xFFFFFFFF /* Infinite timeout */
883
884 #define CAM_SUCCESS 0 /* For signaling general success */
885 #define CAM_FAILURE 1 /* For signaling general failure */
886
887 #define CAM_FALSE 0
888 #define CAM_TRUE 1
889
890 #define XPT_CCB_INVALID -1 /* for signaling a bad CCB to free */
891
892 /*
893 * Union of all CCB types for kernel space allocation. This union should
894 * never be used for manipulating CCBs - its only use is for the allocation
895 * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc
896 * and the argument to xpt_ccb_free.
897 */
898 union ccb {
899 struct ccb_hdr ccb_h; /* For convenience */
900 struct ccb_scsiio csio;
901 struct ccb_getdev cgd;
902 struct ccb_getdevlist cgdl;
903 struct ccb_pathinq cpi;
904 struct ccb_relsim crs;
905 struct ccb_setasync csa;
906 struct ccb_setdev csd;
907 struct ccb_pathstats cpis;
908 struct ccb_getdevstats cgds;
909 struct ccb_dev_match cdm;
910 struct ccb_trans_settings cts;
911 struct ccb_calc_geometry ccg;
912 struct ccb_abort cab;
913 struct ccb_resetbus crb;
914 struct ccb_resetdev crd;
915 struct ccb_termio tio;
916 struct ccb_accept_tio atio;
917 struct ccb_scsiio ctio;
918 struct ccb_en_lun cel;
919 struct ccb_immed_notify cin;
920 struct ccb_notify_ack cna;
921 struct ccb_eng_inq cei;
922 struct ccb_eng_exec cee;
923 struct ccb_rescan crcn;
924 struct ccb_debug cdbg;
925 };
926
927 __BEGIN_DECLS
928 static __inline void
929 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
930 void (*cbfcnp)(struct cam_periph *, union ccb *),
931 u_int32_t flags, u_int8_t tag_action,
932 u_int8_t *data_ptr, u_int32_t dxfer_len,
933 u_int8_t sense_len, u_int8_t cdb_len,
934 u_int32_t timeout);
935
936 static __inline void
937 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
938 void (*cbfcnp)(struct cam_periph *, union ccb *),
939 u_int32_t flags, u_int tag_action, u_int tag_id,
940 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
941 u_int32_t dxfer_len, u_int32_t timeout);
942
943 static __inline void
944 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
945 void (*cbfcnp)(struct cam_periph *, union ccb *),
946 u_int32_t flags, u_int8_t tag_action,
947 u_int8_t *data_ptr, u_int32_t dxfer_len,
948 u_int8_t sense_len, u_int8_t cdb_len,
949 u_int32_t timeout)
950 {
951 csio->ccb_h.func_code = XPT_SCSI_IO;
952 csio->ccb_h.flags = flags;
953 csio->ccb_h.retry_count = retries;
954 csio->ccb_h.cbfcnp = cbfcnp;
955 csio->ccb_h.timeout = timeout;
956 csio->data_ptr = data_ptr;
957 csio->dxfer_len = dxfer_len;
958 csio->sense_len = sense_len;
959 csio->cdb_len = cdb_len;
960 csio->tag_action = tag_action;
961 }
962
963 static __inline void
964 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
965 void (*cbfcnp)(struct cam_periph *, union ccb *),
966 u_int32_t flags, u_int tag_action, u_int tag_id,
967 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
968 u_int32_t dxfer_len, u_int32_t timeout)
969 {
970 csio->ccb_h.func_code = XPT_CONT_TARGET_IO;
971 csio->ccb_h.flags = flags;
972 csio->ccb_h.retry_count = retries;
973 csio->ccb_h.cbfcnp = cbfcnp;
974 csio->ccb_h.timeout = timeout;
975 csio->data_ptr = data_ptr;
976 csio->dxfer_len = dxfer_len;
977 csio->scsi_status = scsi_status;
978 csio->tag_action = tag_action;
979 csio->tag_id = tag_id;
980 csio->init_id = init_id;
981 }
982
983 void cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended);
984
985 __END_DECLS
986
987 #endif /* _CAM_CAM_CCB_H */
Cache object: f183021a59f38e6db52026d9c52db059
|