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