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