?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Remove unused CTS_SPI_FLAGS_TAG_ENB.
[dragonfly.git] / sys / bus / cam / cam_ccb.h
blobb4ad60efb740bce905c989d41b4e47aa162357fa
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: src/sys/cam/cam_ccb.h,v 1.15.2.3 2003/07/29 04:00:34 njl Exp $
29 * $DragonFly: src/sys/bus/cam/cam_ccb.h,v 1.16 2007/12/24 00:14:52 pavalos Exp $
30 */
31
32 #ifndef _CAM_CAM_CCB_H
33 #define _CAM_CAM_CCB_H 1
34
35 #include <sys/queue.h>
36 #include <sys/cdefs.h>
37 #include <sys/time.h>
38 #ifdef CAM_NEW_TRAN_CODE
39 #include <machine/limits.h>
40 #endif
41 #include <sys/callout.h>
42 #include "cam_debug.h"
43 #include "scsi/scsi_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 */
59 typedef 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 */
108 typedef 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
174 /* HBA engine commands 0x20->0x2F */
175 XPT_ENG_INQ = 0x20 | XPT_FC_XPT_ONLY,
176 /* HBA engine feature inquiry */
177 XPT_ENG_EXEC = 0x21 | XPT_FC_DEV_QUEUED,
178 /* HBA execute engine request */
179
180 /* Target mode commands: 0x30->0x3F */
181 XPT_EN_LUN = 0x30,
182 /* Enable LUN as a target */
183 XPT_TARGET_IO = 0x31 | XPT_FC_DEV_QUEUED,
184 /* Execute target I/O request */
185 XPT_ACCEPT_TARGET_IO = 0x32 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
186 /* Accept Host Target Mode CDB */
187 XPT_CONT_TARGET_IO = 0x33 | XPT_FC_DEV_QUEUED,
188 /* Continue Host Target I/O Connection */
189 XPT_IMMED_NOTIFY = 0x34 | XPT_FC_QUEUED | XPT_FC_USER_CCB,
190 /* Notify Host Target driver of event */
191 XPT_NOTIFY_ACK = 0x35,
192 /* Acknowledgement of event */
193
194 /* Vendor Unique codes: 0x80->0x8F */
195 XPT_VUNIQUE = 0x80
196 } xpt_opcode;
197
198 #define XPT_FC_GROUP_MASK 0xF0
199 #define XPT_FC_GROUP(op) ((op) & XPT_FC_GROUP_MASK)
200 #define XPT_FC_GROUP_COMMON 0x00
201 #define XPT_FC_GROUP_SCSI_CONTROL 0x10
202 #define XPT_FC_GROUP_HBA_ENGINE 0x20
203 #define XPT_FC_GROUP_TMODE 0x30
204 #define XPT_FC_GROUP_VENDOR_UNIQUE 0x80
205
206 #define XPT_FC_IS_DEV_QUEUED(ccb) \
207 (((ccb)->ccb_h.func_code & XPT_FC_DEV_QUEUED) == XPT_FC_DEV_QUEUED)
208 #define XPT_FC_IS_QUEUED(ccb) \
209 (((ccb)->ccb_h.func_code & XPT_FC_QUEUED) != 0)
210
211 #ifdef CAM_NEW_TRAN_CODE
212 typedef enum {
213 PROTO_UNKNOWN,
214 PROTO_UNSPECIFIED,
215 PROTO_SCSI, /* Small Computer System Interface */
216 PROTO_ATA, /* AT Attachment */
217 PROTO_ATAPI, /* AT Attachment Packetized Interface */
218 } cam_proto;
219
220 typedef enum {
221 XPORT_UNKNOWN,
222 XPORT_UNSPECIFIED,
223 XPORT_SPI, /* SCSI Parallel Interface */
224 XPORT_FC, /* Fiber Channel */
225 XPORT_SSA, /* Serial Storage Architecture */
226 XPORT_USB, /* Universal Serial Bus */
227 XPORT_PPB, /* Parallel Port Bus */
228 XPORT_ATA, /* AT Attachment */
229 XPORT_SAS, /* Serial Attached SCSI */
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 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; /* Uptime 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 struct ccb_pathinq_settings_sas {
532 u_int32_t bitrate; /* Mbps */
533 };
534 #define PATHINQ_SETTINGS_SIZE 128
535 #endif /* CAM_NEW_TRAN_CODE */
536
537 struct ccb_pathinq {
538 struct ccb_hdr ccb_h;
539 u_int8_t version_num; /* Version number for the SIM/HBA */
540 u_int8_t hba_inquiry; /* Mimic of INQ byte 7 for the HBA */
541 u_int8_t target_sprt; /* Flags for target mode support */
542 u_int8_t hba_misc; /* Misc HBA features */
543 u_int16_t hba_eng_cnt; /* HBA engine count */
544 /* Vendor Unique capabilities */
545 u_int8_t vuhba_flags[VUHBALEN];
546 u_int32_t max_target; /* Maximum supported Target */
547 u_int32_t max_lun; /* Maximum supported Lun */
548 u_int32_t async_flags; /* Installed Async handlers */
549 path_id_t hpath_id; /* Highest Path ID in the subsystem */
550 target_id_t initiator_id; /* ID of the HBA on the SCSI bus */
551 char sim_vid[SIM_IDLEN]; /* Vendor ID of the SIM */
552 char hba_vid[HBA_IDLEN]; /* Vendor ID of the HBA */
553 char dev_name[DEV_IDLEN];/* Device name for SIM */
554 u_int32_t unit_number; /* Unit number for SIM */
555 u_int32_t bus_id; /* Bus ID for SIM */
556 u_int32_t base_transfer_speed;/* Base bus speed in KB/sec */
557 #ifdef CAM_NEW_TRAN_CODE
558 cam_proto protocol;
559 u_int protocol_version;
560 cam_xport transport;
561 u_int transport_version;
562 union {
563 struct ccb_pathinq_settings_spi spi;
564 struct ccb_pathinq_settings_fc fc;
565 struct ccb_pathinq_settings_sas sas;
566 char ccb_pathinq_settings_opaque[PATHINQ_SETTINGS_SIZE];
567 } xport_specific;
568 #endif /* CAM_NEW_TRAN_CODE */
569 };
570
571 /* Path Statistics CCB */
572 struct ccb_pathstats {
573 struct ccb_hdr ccb_h;
574 struct timeval last_reset; /* Uptime of last bus reset/loop init */
575 };
576
577 typedef union {
578 u_int8_t *sense_ptr; /*
579 * Pointer to storage
580 * for sense information
581 */
582 /* Storage Area for sense information */
583 struct scsi_sense_data sense_buf;
584 } sense_t;
585
586 typedef union {
587 u_int8_t *cdb_ptr; /* Pointer to the CDB bytes to send */
588 /* Area for the CDB send */
589 u_int8_t cdb_bytes[IOCDBLEN];
590 } cdb_t;
591
592 /*
593 * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO
594 * function codes.
595 */
596 struct ccb_scsiio {
597 struct ccb_hdr ccb_h;
598 union ccb *next_ccb; /* Ptr for next CCB for action */
599 u_int8_t *req_map; /* Ptr to mapping info */
600 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */
601 u_int32_t dxfer_len; /* Data transfer length */
602 /* Autosense storage */
603 struct scsi_sense_data sense_data;
604 u_int8_t sense_len; /* Number of bytes to autosense */
605 u_int8_t cdb_len; /* Number of bytes for the CDB */
606 u_int16_t sglist_cnt; /* Number of SG list entries */
607 u_int8_t scsi_status; /* Returned SCSI status */
608 u_int8_t sense_resid; /* Autosense resid length: 2's comp */
609 u_int32_t resid; /* Transfer residual length: 2's comp */
610 cdb_t cdb_io; /* Union for CDB bytes/pointer */
611 u_int8_t *msg_ptr; /* Pointer to the message buffer */
612 u_int16_t msg_len; /* Number of bytes for the Message */
613 u_int8_t tag_action; /* What to do for tag queueing */
614 /*
615 * The tag action should be either the define below (to send a
616 * non-tagged transaction) or one of the defined scsi tag messages
617 * from scsi_message.h.
618 */
619 #define CAM_TAG_ACTION_NONE 0x00
620 u_int tag_id; /* tag id from initator (target mode) */
621 u_int init_id; /* initiator id of who selected */
622 };
623
624 struct ccb_accept_tio {
625 struct ccb_hdr ccb_h;
626 cdb_t cdb_io; /* Union for CDB bytes/pointer */
627 u_int8_t cdb_len; /* Number of bytes for the CDB */
628 u_int8_t tag_action; /* What to do for tag queueing */
629 u_int8_t sense_len; /* Number of bytes of Sense Data */
630 u_int tag_id; /* tag id from initator (target mode) */
631 u_int init_id; /* initiator id of who selected */
632 struct scsi_sense_data sense_data;
633 };
634
635 /* Release SIM Queue */
636 struct ccb_relsim {
637 struct ccb_hdr ccb_h;
638 u_int32_t release_flags;
639 #define RELSIM_ADJUST_OPENINGS 0x01
640 #define RELSIM_RELEASE_AFTER_TIMEOUT 0x02
641 #define RELSIM_RELEASE_AFTER_CMDCMPLT 0x04
642 #define RELSIM_RELEASE_AFTER_QEMPTY 0x08
643 u_int32_t openings;
644 u_int32_t release_timeout;
645 u_int32_t qfrozen_cnt;
646 };
647
648 /*
649 * Definitions for the asynchronous callback CCB fields.
650 */
651 typedef enum {
652 AC_GETDEV_CHANGED = 0x800,/* Getdev info might have changed */
653 AC_INQ_CHANGED = 0x400,/* Inquiry info might have changed */
654 AC_TRANSFER_NEG = 0x200,/* New transfer settings in effect */
655 AC_LOST_DEVICE = 0x100,/* A device went away */
656 AC_FOUND_DEVICE = 0x080,/* A new device was found */
657 AC_PATH_DEREGISTERED = 0x040,/* A path has de-registered */
658 AC_PATH_REGISTERED = 0x020,/* A new path has been registered */
659 AC_SENT_BDR = 0x010,/* A BDR message was sent to target */
660 AC_SCSI_AEN = 0x008,/* A SCSI AEN has been received */
661 AC_UNSOL_RESEL = 0x002,/* Unsolicited reselection occurred */
662 AC_BUS_RESET = 0x001 /* A SCSI bus reset occurred */
663 } ac_code;
664
665 typedef void ac_callback_t (void *softc, u_int32_t code,
666 struct cam_path *path, void *args);
667
668 /* Set Asynchronous Callback CCB */
669 struct ccb_setasync {
670 struct ccb_hdr ccb_h;
671 u_int32_t event_enable; /* Async Event enables */
672 ac_callback_t *callback;
673 void *callback_arg;
674 };
675
676 /* Set Device Type CCB */
677 struct ccb_setdev {
678 struct ccb_hdr ccb_h;
679 u_int8_t dev_type; /* Value for dev type field in EDT */
680 };
681
682 /* SCSI Control Functions */
683
684 /* Abort XPT request CCB */
685 struct ccb_abort {
686 struct ccb_hdr ccb_h;
687 union ccb *abort_ccb; /* Pointer to CCB to abort */
688 };
689
690 /* Reset SCSI Bus CCB */
691 struct ccb_resetbus {
692 struct ccb_hdr ccb_h;
693 };
694
695 /* Reset SCSI Device CCB */
696 struct ccb_resetdev {
697 struct ccb_hdr ccb_h;
698 };
699
700 /* Terminate I/O Process Request CCB */
701 struct ccb_termio {
702 struct ccb_hdr ccb_h;
703 union ccb *termio_ccb; /* Pointer to CCB to terminate */
704 };
705
706 #ifndef CAM_NEW_TRAN_CODE
707 /* Get/Set transfer rate/width/disconnection/tag queueing settings */
708 struct ccb_trans_settings {
709 struct ccb_hdr ccb_h;
710 u_int valid; /* Which fields to honor */
711 #define CCB_TRANS_SYNC_RATE_VALID 0x01
712 #define CCB_TRANS_SYNC_OFFSET_VALID 0x02
713 #define CCB_TRANS_BUS_WIDTH_VALID 0x04
714 #define CCB_TRANS_DISC_VALID 0x08
715 #define CCB_TRANS_TQ_VALID 0x10
716 u_int flags;
717 #define CCB_TRANS_CURRENT_SETTINGS 0x01
718 #define CCB_TRANS_USER_SETTINGS 0x02
719 #define CCB_TRANS_DISC_ENB 0x04
720 #define CCB_TRANS_TAG_ENB 0x08
721 u_int sync_period;
722 u_int sync_offset;
723 u_int bus_width;
724 };
725
726 #else /* CAM_NEW_TRAN_CODE */
727 typedef enum {
728 CTS_TYPE_CURRENT_SETTINGS,
729 CTS_TYPE_USER_SETTINGS
730 } cts_type;
731
732 struct ccb_trans_settings_scsi
733 {
734 u_int valid; /* Which fields to honor */
735 #define CTS_SCSI_VALID_TQ 0x01
736 u_int flags;
737 #define CTS_SCSI_FLAGS_TAG_ENB 0x01
738 };
739
740 struct ccb_trans_settings_spi
741 {
742 u_int valid; /* Which fields to honor */
743 #define CTS_SPI_VALID_SYNC_RATE 0x01
744 #define CTS_SPI_VALID_SYNC_OFFSET 0x02
745 #define CTS_SPI_VALID_BUS_WIDTH 0x04
746 #define CTS_SPI_VALID_DISC 0x08
747 #define CTS_SPI_VALID_PPR_OPTIONS 0x10
748 u_int flags;
749 #define CTS_SPI_FLAGS_DISC_ENB 0x01
750 u_int sync_period;
751 u_int sync_offset;
752 u_int bus_width;
753 u_int ppr_options;
754 };
755
756 struct ccb_trans_settings_fc {
757 u_int valid; /* Which fields to honor */
758 #define CTS_FC_VALID_WWNN 0x8000
759 #define CTS_FC_VALID_WWPN 0x4000
760 #define CTS_FC_VALID_PORT 0x2000
761 #define CTS_FC_VALID_SPEED 0x1000
762 u_int64_t wwnn; /* world wide node name */
763 u_int64_t wwpn; /* world wide port name */
764 u_int32_t port; /* 24 bit port id, if known */
765 u_int32_t bitrate; /* Mbps */
766 };
767
768 struct ccb_trans_settings_sas {
769 u_int valid; /* Which fields to honor */
770 #define CTS_SAS_VALID_SPEED 0x1000
771 u_int32_t bitrate; /* Mbps */
772 };
773
774
775 /* Get/Set transfer rate/width/disconnection/tag queueing settings */
776 struct ccb_trans_settings {
777 struct ccb_hdr ccb_h;
778 cts_type type; /* Current or User settings */
779 cam_proto protocol;
780 u_int protocol_version;
781 cam_xport transport;
782 u_int transport_version;
783 union {
784 u_int valid; /* Which fields to honor */
785 struct ccb_trans_settings_scsi scsi;
786 } proto_specific;
787 union {
788 u_int valid; /* Which fields to honor */
789 struct ccb_trans_settings_spi spi;
790 struct ccb_trans_settings_fc fc;
791 struct ccb_trans_settings_sas sas;
792 } xport_specific;
793 };
794
795 #endif /* CAM_NEW_TRAN_CODE */
796
797 /*
798 * Calculate the geometry parameters for a device
799 * give the block size and volume size in blocks.
800 */
801 struct ccb_calc_geometry {
802 struct ccb_hdr ccb_h;
803 u_int32_t block_size;
804 u_int64_t volume_size;
805 u_int32_t cylinders;
806 u_int8_t heads;
807 u_int8_t secs_per_track;
808 };
809
810 /*
811 * Rescan the given bus, or bus/target/lun
812 */
813 struct ccb_rescan {
814 struct ccb_hdr ccb_h;
815 cam_flags flags;
816 };
817
818 /*
819 * Turn on debugging for the given bus, bus/target, or bus/target/lun.
820 */
821 struct ccb_debug {
822 struct ccb_hdr ccb_h;
823 cam_debug_flags flags;
824 };
825
826 /* Target mode structures. */
827
828 struct ccb_en_lun {
829 struct ccb_hdr ccb_h;
830 u_int16_t grp6_len; /* Group 6 VU CDB length */
831 u_int16_t grp7_len; /* Group 7 VU CDB length */
832 u_int8_t enable;
833 };
834
835 struct ccb_immed_notify {
836 struct ccb_hdr ccb_h;
837 struct scsi_sense_data sense_data;
838 u_int8_t sense_len; /* Number of bytes in sense buffer */
839 u_int8_t initiator_id; /* Id of initiator that selected */
840 u_int8_t message_args[7]; /* Message Arguments */
841 };
842
843 struct ccb_notify_ack {
844 struct ccb_hdr ccb_h;
845 u_int16_t seq_id; /* Sequence identifier */
846 u_int8_t event; /* Event flags */
847 };
848
849 /* HBA engine structures. */
850
851 typedef enum {
852 EIT_BUFFER, /* Engine type: buffer memory */
853 EIT_LOSSLESS, /* Engine type: lossless compression */
854 EIT_LOSSY, /* Engine type: lossy compression */
855 EIT_ENCRYPT /* Engine type: encryption */
856 } ei_type;
857
858 typedef enum {
859 EAD_VUNIQUE, /* Engine algorithm ID: vendor unique */
860 EAD_LZ1V1, /* Engine algorithm ID: LZ1 var.1 */
861 EAD_LZ2V1, /* Engine algorithm ID: LZ2 var.1 */
862 EAD_LZ2V2 /* Engine algorithm ID: LZ2 var.2 */
863 } ei_algo;
864
865 struct ccb_eng_inq {
866 struct ccb_hdr ccb_h;
867 u_int16_t eng_num; /* The engine number for this inquiry */
868 ei_type eng_type; /* Returned engine type */
869 ei_algo eng_algo; /* Returned engine algorithm type */
870 u_int32_t eng_memeory; /* Returned engine memory size */
871 };
872
873 struct ccb_eng_exec { /* This structure must match SCSIIO size */
874 struct ccb_hdr ccb_h;
875 u_int8_t *pdrv_ptr; /* Ptr used by the peripheral driver */
876 u_int8_t *req_map; /* Ptr for mapping info on the req. */
877 u_int8_t *data_ptr; /* Pointer to the data buf/SG list */
878 u_int32_t dxfer_len; /* Data transfer length */
879 u_int8_t *engdata_ptr; /* Pointer to the engine buffer data */
880 u_int16_t sglist_cnt; /* Num of scatter gather list entries */
881 u_int32_t dmax_len; /* Destination data maximum length */
882 u_int32_t dest_len; /* Destination data length */
883 int32_t src_resid; /* Source residual length: 2's comp */
884 u_int32_t timeout; /* Timeout value */
885 u_int16_t eng_num; /* Engine number for this request */
886 u_int16_t vu_flags; /* Vendor Unique flags */
887 };
888
889 /*
890 * Definitions for the timeout field in the SCSI I/O CCB.
891 */
892 #define CAM_TIME_DEFAULT 0x00000000 /* Use SIM default value */
893 #define CAM_TIME_INFINITY 0xFFFFFFFF /* Infinite timeout */
894
895 #define CAM_SUCCESS 0 /* For signaling general success */
896 #define CAM_FAILURE 1 /* For signaling general failure */
897
898 #define CAM_FALSE 0
899 #define CAM_TRUE 1
900
901 #define XPT_CCB_INVALID -1 /* for signaling a bad CCB to free */
902
903 /*
904 * Union of all CCB types for kernel space allocation. This union should
905 * never be used for manipulating CCBs - its only use is for the allocation
906 * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc
907 * and the argument to xpt_ccb_free.
908 */
909 union ccb {
910 struct ccb_hdr ccb_h; /* For convenience */
911 struct ccb_scsiio csio;
912 struct ccb_getdev cgd;
913 struct ccb_getdevlist cgdl;
914 struct ccb_pathinq cpi;
915 struct ccb_relsim crs;
916 struct ccb_setasync csa;
917 struct ccb_setdev csd;
918 struct ccb_pathstats cpis;
919 struct ccb_getdevstats cgds;
920 struct ccb_dev_match cdm;
921 struct ccb_trans_settings cts;
922 struct ccb_calc_geometry ccg;
923 struct ccb_abort cab;
924 struct ccb_resetbus crb;
925 struct ccb_resetdev crd;
926 struct ccb_termio tio;
927 struct ccb_accept_tio atio;
928 struct ccb_scsiio ctio;
929 struct ccb_en_lun cel;
930 struct ccb_immed_notify cin;
931 struct ccb_notify_ack cna;
932 struct ccb_eng_inq cei;
933 struct ccb_eng_exec cee;
934 struct ccb_rescan crcn;
935 struct ccb_debug cdbg;
936 };
937
938 __BEGIN_DECLS
939 static __inline void
940 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
941 void (*cbfcnp)(struct cam_periph *, union ccb *),
942 u_int32_t flags, u_int8_t tag_action,
943 u_int8_t *data_ptr, u_int32_t dxfer_len,
944 u_int8_t sense_len, u_int8_t cdb_len,
945 u_int32_t timeout);
946
947 static __inline void
948 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
949 void (*cbfcnp)(struct cam_periph *, union ccb *),
950 u_int32_t flags, u_int tag_action, u_int tag_id,
951 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
952 u_int32_t dxfer_len, u_int32_t timeout);
953
954 static __inline void
955 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries,
956 void (*cbfcnp)(struct cam_periph *, union ccb *),
957 u_int32_t flags, u_int8_t tag_action,
958 u_int8_t *data_ptr, u_int32_t dxfer_len,
959 u_int8_t sense_len, u_int8_t cdb_len,
960 u_int32_t timeout)
961 {
962 csio->ccb_h.func_code = XPT_SCSI_IO;
963 csio->ccb_h.flags = flags;
964 csio->ccb_h.retry_count = retries;
965 csio->ccb_h.cbfcnp = cbfcnp;
966 csio->ccb_h.timeout = timeout;
967 csio->data_ptr = data_ptr;
968 csio->dxfer_len = dxfer_len;
969 csio->sense_len = sense_len;
970 csio->cdb_len = cdb_len;
971 csio->tag_action = tag_action;
972 }
973
974 static __inline void
975 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries,
976 void (*cbfcnp)(struct cam_periph *, union ccb *),
977 u_int32_t flags, u_int tag_action, u_int tag_id,
978 u_int init_id, u_int scsi_status, u_int8_t *data_ptr,
979 u_int32_t dxfer_len, u_int32_t timeout)
980 {
981 csio->ccb_h.func_code = XPT_CONT_TARGET_IO;
982 csio->ccb_h.flags = flags;
983 csio->ccb_h.retry_count = retries;
984 csio->ccb_h.cbfcnp = cbfcnp;
985 csio->ccb_h.timeout = timeout;
986 csio->data_ptr = data_ptr;
987 csio->dxfer_len = dxfer_len;
988 csio->scsi_status = scsi_status;
989 csio->tag_action = tag_action;
990 csio->tag_id = tag_id;
991 csio->init_id = init_id;
992 }
993
994 void cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended);
995
996 __END_DECLS
997
998 #endif /* _CAM_CAM_CCB_H */
DragonFly BSD