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