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