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