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