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