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