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