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