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