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_RESV = 0x00000000,/* Data direction (00:reserved) */ 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 SIM 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 /* SCSI Control Functions: 0x10->0x1F */ 146 XPT_ABORT = 0x10, 147 /* Abort the specified CCB */ 148 XPT_RESET_BUS = 0x11 | XPT_FC_XPT_ONLY, 149 /* Reset the specified SCSI bus */ 150 XPT_RESET_DEV = 0x12 | XPT_FC_DEV_QUEUED, 151 /* Bus Device Reset the specified SCSI device */ 152 XPT_TERM_IO = 0x13, 153 /* Terminate the I/O process */ 154 XPT_SCAN_LUN = 0x14 | XPT_FC_QUEUED | XPT_FC_USER_CCB 155 | XPT_FC_XPT_ONLY, 156 /* Scan Logical Unit */ 157 XPT_GET_TRAN_SETTINGS = 0x15, 158 /* 159 * Get default/user transfer settings 160 * for the target 161 */ 162 XPT_SET_TRAN_SETTINGS = 0x16, 163 /* 164 * Set transfer rate/width 165 * negotiation settings 166 */ 167 XPT_CALC_GEOMETRY = 0x17, 168 /* 169 * Calculate the geometry parameters for 170 * a device give the sector size and 171 * volume size. 172 */ 173 XPT_ATA_IO = 0x18 | XPT_FC_DEV_QUEUED, 174 /* Execute the requested ATA I/O operation */ 175 176 /* HBA engine commands 0x20->0x2F */ 177 XPT_ENG_INQ = 0x20 | XPT_FC_XPT_ONLY, 178 /* HBA engine feature inquiry */ 179 XPT_ENG_EXEC = 0x21 | XPT_FC_DEV_QUEUED, 180 /* HBA execute engine request */ 181 182 /* Target mode commands: 0x30->0x3F */ 183 XPT_EN_LUN = 0x30, 184 /* Enable LUN as a target */ 185 XPT_TARGET_IO = 0x31 | XPT_FC_DEV_QUEUED, 186 /* Execute target I/O request */ 187 XPT_ACCEPT_TARGET_IO = 0x32 | XPT_FC_QUEUED | XPT_FC_USER_CCB, 188 /* Accept Host Target Mode CDB */ 189 XPT_CONT_TARGET_IO = 0x33 | XPT_FC_DEV_QUEUED, 190 /* Continue Host Target I/O Connection */ 191 XPT_IMMED_NOTIFY = 0x34 | XPT_FC_QUEUED | XPT_FC_USER_CCB, 192 /* Notify Host Target driver of event */ 193 XPT_NOTIFY_ACK = 0x35, 194 /* Acknowledgement of event */ 195 196 /* Vendor Unique codes: 0x80->0x8F */ 197 XPT_VUNIQUE = 0x80 198 } xpt_opcode; 199 200 #define XPT_FC_GROUP_MASK 0xF0 201 #define XPT_FC_GROUP(op) ((op) & XPT_FC_GROUP_MASK) 202 #define XPT_FC_GROUP_COMMON 0x00 203 #define XPT_FC_GROUP_SCSI_CONTROL 0x10 204 #define XPT_FC_GROUP_HBA_ENGINE 0x20 205 #define XPT_FC_GROUP_TMODE 0x30 206 #define XPT_FC_GROUP_VENDOR_UNIQUE 0x80 207 208 #define XPT_FC_IS_DEV_QUEUED(ccb) \ 209 (((ccb)->ccb_h.func_code & XPT_FC_DEV_QUEUED) == XPT_FC_DEV_QUEUED) 210 #define XPT_FC_IS_QUEUED(ccb) \ 211 (((ccb)->ccb_h.func_code & XPT_FC_QUEUED) != 0) 212 213 typedef enum { 214 PROTO_UNKNOWN, 215 PROTO_UNSPECIFIED, 216 PROTO_SCSI, /* Small Computer System Interface */ 217 PROTO_ATA, /* AT Attachment */ 218 PROTO_ATAPI, /* AT Attachment Packetized Interface */ 219 PROTO_SATAPM, /* SATA Port Multiplier */ 220 } cam_proto; 221 222 typedef enum { 223 XPORT_UNKNOWN, 224 XPORT_UNSPECIFIED, 225 XPORT_SPI, /* SCSI Parallel Interface */ 226 XPORT_FC, /* Fiber Channel */ 227 XPORT_SSA, /* Serial Storage Architecture */ 228 XPORT_USB, /* Universal Serial Bus */ 229 XPORT_PPB, /* Parallel Port Bus */ 230 XPORT_ATA, /* AT Attachment */ 231 XPORT_SAS, /* Serial Attached SCSI */ 232 XPORT_SATA, /* Serial AT Attachment */ 233 } cam_xport; 234 235 #define PROTO_VERSION_UNKNOWN (UINT_MAX - 1) 236 #define PROTO_VERSION_UNSPECIFIED UINT_MAX 237 #define XPORT_VERSION_UNKNOWN (UINT_MAX - 1) 238 #define XPORT_VERSION_UNSPECIFIED UINT_MAX 239 240 typedef union { 241 LIST_ENTRY(ccb_hdr) le; 242 SLIST_ENTRY(ccb_hdr) sle; 243 TAILQ_ENTRY(ccb_hdr) tqe; 244 STAILQ_ENTRY(ccb_hdr) stqe; 245 } camq_entry; 246 247 typedef union { 248 void *ptr; 249 u_long field; 250 u_int8_t bytes[sizeof(uintptr_t)]; 251 } ccb_priv_entry; 252 253 typedef union { 254 ccb_priv_entry entries[CCB_PERIPH_PRIV_SIZE]; 255 u_int8_t bytes[CCB_PERIPH_PRIV_SIZE * sizeof(ccb_priv_entry)]; 256 } ccb_ppriv_area; 257 258 typedef union { 259 ccb_priv_entry entries[CCB_SIM_PRIV_SIZE]; 260 u_int8_t bytes[CCB_SIM_PRIV_SIZE * sizeof(ccb_priv_entry)]; 261 } ccb_spriv_area; 262 263 struct ccb_hdr { 264 cam_pinfo pinfo; /* Info for priority scheduling */ 265 camq_entry xpt_links; /* For chaining in the XPT layer */ 266 camq_entry sim_links; /* For chaining in the SIM layer */ 267 camq_entry periph_links; /* For chaining in the type driver */ 268 u_int32_t retry_count; 269 void (*cbfcnp)(struct cam_periph *, union ccb *); 270 /* Callback on completion function */ 271 xpt_opcode func_code; /* XPT function code */ 272 u_int32_t status; /* Status returned by CAM subsystem */ 273 struct cam_path *path; /* Compiled path for this ccb */ 274 path_id_t path_id; /* Path ID for the request */ 275 target_id_t target_id; /* Target device ID */ 276 lun_id_t target_lun; /* Target LUN number */ 277 u_int32_t flags; /* ccb_flags */ 278 ccb_ppriv_area periph_priv; 279 ccb_spriv_area sim_priv; 280 u_int32_t timeout; /* Timeout value */ 281 282 /* 283 * Deprecated, only for use by non-MPSAFE SIMs. All others must 284 * allocate and initialize their own callout storage. 285 */ 286 struct callout_handle timeout_ch; 287 }; 288 289 /* Get Device Information CCB */ 290 struct ccb_getdev { 291 struct ccb_hdr ccb_h; 292 cam_proto protocol; 293 struct scsi_inquiry_data inq_data; 294 struct ata_params ident_data; 295 u_int8_t serial_num[252]; 296 u_int8_t reserved; 297 u_int8_t serial_num_len; 298 }; 299 300 /* Device Statistics CCB */ 301 struct ccb_getdevstats { 302 struct ccb_hdr ccb_h; 303 int dev_openings; /* Space left for more work on device*/ 304 int dev_active; /* Transactions running on the device */ 305 int devq_openings; /* Space left for more queued work */ 306 int devq_queued; /* Transactions queued to be sent */ 307 int held; /* 308 * CCBs held by peripheral drivers 309 * for this device 310 */ 311 int maxtags; /* 312 * Boundary conditions for number of 313 * tagged operations 314 */ 315 int mintags; 316 struct timeval last_reset; /* Time of last bus reset/loop init */ 317 }; 318 319 typedef enum { 320 CAM_GDEVLIST_LAST_DEVICE, 321 CAM_GDEVLIST_LIST_CHANGED, 322 CAM_GDEVLIST_MORE_DEVS, 323 CAM_GDEVLIST_ERROR 324 } ccb_getdevlist_status_e; 325 326 struct ccb_getdevlist { 327 struct ccb_hdr ccb_h; 328 char periph_name[DEV_IDLEN]; 329 u_int32_t unit_number; 330 unsigned int generation; 331 u_int32_t index; 332 ccb_getdevlist_status_e status; 333 }; 334 335 typedef enum { 336 PERIPH_MATCH_NONE = 0x000, 337 PERIPH_MATCH_PATH = 0x001, 338 PERIPH_MATCH_TARGET = 0x002, 339 PERIPH_MATCH_LUN = 0x004, 340 PERIPH_MATCH_NAME = 0x008, 341 PERIPH_MATCH_UNIT = 0x010, 342 PERIPH_MATCH_ANY = 0x01f 343 } periph_pattern_flags; 344 345 struct periph_match_pattern { 346 char periph_name[DEV_IDLEN]; 347 u_int32_t unit_number; 348 path_id_t path_id; 349 target_id_t target_id; 350 lun_id_t target_lun; 351 periph_pattern_flags flags; 352 }; 353 354 typedef enum { 355 DEV_MATCH_NONE = 0x000, 356 DEV_MATCH_PATH = 0x001, 357 DEV_MATCH_TARGET = 0x002, 358 DEV_MATCH_LUN = 0x004, 359 DEV_MATCH_INQUIRY = 0x008, 360 DEV_MATCH_ANY = 0x00f 361 } dev_pattern_flags; 362 363 struct device_match_pattern { 364 path_id_t path_id; 365 target_id_t target_id; 366 lun_id_t target_lun; 367 struct scsi_static_inquiry_pattern inq_pat; 368 dev_pattern_flags flags; 369 }; 370 371 typedef enum { 372 BUS_MATCH_NONE = 0x000, 373 BUS_MATCH_PATH = 0x001, 374 BUS_MATCH_NAME = 0x002, 375 BUS_MATCH_UNIT = 0x004, 376 BUS_MATCH_BUS_ID = 0x008, 377 BUS_MATCH_ANY = 0x00f 378 } bus_pattern_flags; 379 380 struct bus_match_pattern { 381 path_id_t path_id; 382 char dev_name[DEV_IDLEN]; 383 u_int32_t unit_number; 384 u_int32_t bus_id; 385 bus_pattern_flags flags; 386 }; 387 388 union match_pattern { 389 struct periph_match_pattern periph_pattern; 390 struct device_match_pattern device_pattern; 391 struct bus_match_pattern bus_pattern; 392 }; 393 394 typedef enum { 395 DEV_MATCH_PERIPH, 396 DEV_MATCH_DEVICE, 397 DEV_MATCH_BUS 398 } dev_match_type; 399 400 struct dev_match_pattern { 401 dev_match_type type; 402 union match_pattern pattern; 403 }; 404 405 struct periph_match_result { 406 char periph_name[DEV_IDLEN]; 407 u_int32_t unit_number; 408 path_id_t path_id; 409 target_id_t target_id; 410 lun_id_t target_lun; 411 }; 412 413 typedef enum { 414 DEV_RESULT_NOFLAG = 0x00, 415 DEV_RESULT_UNCONFIGURED = 0x01 416 } dev_result_flags; 417 418 struct device_match_result { 419 path_id_t path_id; 420 target_id_t target_id; 421 lun_id_t target_lun; 422 cam_proto protocol; 423 struct scsi_inquiry_data inq_data; 424 struct ata_params ident_data; 425 dev_result_flags flags; 426 }; 427 428 struct bus_match_result { 429 path_id_t path_id; 430 char dev_name[DEV_IDLEN]; 431 u_int32_t unit_number; 432 u_int32_t bus_id; 433 }; 434 435 union match_result { 436 struct periph_match_result periph_result; 437 struct device_match_result device_result; 438 struct bus_match_result bus_result; 439 }; 440 441 struct dev_match_result { 442 dev_match_type type; 443 union match_result result; 444 }; 445 446 typedef enum { 447 CAM_DEV_MATCH_LAST, 448 CAM_DEV_MATCH_MORE, 449 CAM_DEV_MATCH_LIST_CHANGED, 450 CAM_DEV_MATCH_SIZE_ERROR, 451 CAM_DEV_MATCH_ERROR 452 } ccb_dev_match_status; 453 454 typedef enum { 455 CAM_DEV_POS_NONE = 0x000, 456 CAM_DEV_POS_BUS = 0x001, 457 CAM_DEV_POS_TARGET = 0x002, 458 CAM_DEV_POS_DEVICE = 0x004, 459 CAM_DEV_POS_PERIPH = 0x008, 460 CAM_DEV_POS_PDPTR = 0x010, 461 CAM_DEV_POS_TYPEMASK = 0xf00, 462 CAM_DEV_POS_EDT = 0x100, 463 CAM_DEV_POS_PDRV = 0x200 464 } dev_pos_type; 465 466 struct ccb_dm_cookie { 467 void *bus; 468 void *target; 469 void *device; 470 void *periph; 471 void *pdrv; 472 }; 473 474 struct ccb_dev_position { 475 u_int generations[4]; 476 #define CAM_BUS_GENERATION 0x00 477 #define CAM_TARGET_GENERATION 0x01 478 #define CAM_DEV_GENERATION 0x02 479 #define CAM_PERIPH_GENERATION 0x03 480 dev_pos_type position_type; 481 struct ccb_dm_cookie cookie; 482 }; 483 484 struct ccb_dev_match { 485 struct ccb_hdr ccb_h; 486 ccb_dev_match_status status; 487 u_int32_t num_patterns; 488 u_int32_t pattern_buf_len; 489 struct dev_match_pattern *patterns; 490 u_int32_t num_matches; 491 u_int32_t match_buf_len; 492 struct dev_match_result *matches; 493 struct ccb_dev_position pos; 494 }; 495 496 /* 497 * Definitions for the path inquiry CCB fields. 498 */ 499 #define CAM_VERSION 0x15 /* Hex value for current version */ 500 501 typedef enum { 502 PI_MDP_ABLE = 0x80, /* Supports MDP message */ 503 PI_WIDE_32 = 0x40, /* Supports 32 bit wide SCSI */ 504 PI_WIDE_16 = 0x20, /* Supports 16 bit wide SCSI */ 505 PI_SDTR_ABLE = 0x10, /* Supports SDTR message */ 506 PI_LINKED_CDB = 0x08, /* Supports linked CDBs */ 507 PI_SATAPM = 0x04, /* Supports SATA PM */ 508 PI_TAG_ABLE = 0x02, /* Supports tag queue messages */ 509 PI_SOFT_RST = 0x01 /* Supports soft reset alternative */ 510 } pi_inqflag; 511 512 typedef enum { 513 PIT_PROCESSOR = 0x80, /* Target mode processor mode */ 514 PIT_PHASE = 0x40, /* Target mode phase cog. mode */ 515 PIT_DISCONNECT = 0x20, /* Disconnects supported in target mode */ 516 PIT_TERM_IO = 0x10, /* Terminate I/O message supported in TM */ 517 PIT_GRP_6 = 0x08, /* Group 6 commands supported */ 518 PIT_GRP_7 = 0x04 /* Group 7 commands supported */ 519 } pi_tmflag; 520 521 typedef enum { 522 PIM_SCANHILO = 0x80, /* Bus scans from high ID to low ID */ 523 PIM_NOREMOVE = 0x40, /* Removeable devices not included in scan */ 524 PIM_NOINITIATOR = 0x20, /* Initiator role not supported. */ 525 PIM_NOBUSRESET = 0x10, /* User has disabled initial BUS RESET */ 526 PIM_NO_6_BYTE = 0x08, /* Do not send 6-byte commands */ 527 PIM_SEQSCAN = 0x04 /* Do bus scans sequentially, not in parallel */ 528 } pi_miscflag; 529 530 /* Path Inquiry CCB */ 531 struct ccb_pathinq_settings_spi { 532 u_int8_t ppr_options; 533 }; 534 struct ccb_pathinq_settings_fc { 535 u_int64_t wwnn; /* world wide node name */ 536 u_int64_t wwpn; /* world wide port name */ 537 u_int32_t port; /* 24 bit port id, if known */ 538 u_int32_t bitrate; /* Mbps */ 539 }; 540 struct ccb_pathinq_settings_sas { 541 u_int32_t bitrate; /* Mbps */ 542 }; 543 #define PATHINQ_SETTINGS_SIZE 128 544 545 struct ccb_pathinq { 546 struct ccb_hdr ccb_h; 547 u_int8_t version_num; /* Version number for the SIM/HBA */ 548 u_int8_t hba_inquiry; /* Mimic of INQ byte 7 for the HBA */ 549 u_int8_t target_sprt; /* Flags for target mode support */ 550 u_int8_t hba_misc; /* Misc HBA features */ 551 u_int16_t hba_eng_cnt; /* HBA engine count */ 552 /* Vendor Unique capabilities */ 553 u_int8_t vuhba_flags[VUHBALEN]; 554 u_int32_t max_target; /* Maximum supported Target */ 555 u_int32_t max_lun; /* Maximum supported Lun */ 556 u_int32_t async_flags; /* Installed Async handlers */ 557 path_id_t hpath_id; /* Highest Path ID in the subsystem */ 558 target_id_t initiator_id; /* ID of the HBA on the SCSI bus */ 559 char sim_vid[SIM_IDLEN]; /* Vendor ID of the SIM */ 560 char hba_vid[HBA_IDLEN]; /* Vendor ID of the HBA */ 561 char dev_name[DEV_IDLEN];/* Device name for SIM */ 562 u_int32_t unit_number; /* Unit number for SIM */ 563 u_int32_t bus_id; /* Bus ID for SIM */ 564 u_int32_t base_transfer_speed;/* Base bus speed in KB/sec */ 565 cam_proto protocol; 566 u_int protocol_version; 567 cam_xport transport; 568 u_int transport_version; 569 union { 570 struct ccb_pathinq_settings_spi spi; 571 struct ccb_pathinq_settings_fc fc; 572 struct ccb_pathinq_settings_sas sas; 573 char ccb_pathinq_settings_opaque[PATHINQ_SETTINGS_SIZE]; 574 } xport_specific; 575 u_int maxio; /* Max supported I/O size, in bytes. */ 576 }; 577 578 /* Path Statistics CCB */ 579 struct ccb_pathstats { 580 struct ccb_hdr ccb_h; 581 struct timeval last_reset; /* Time of last bus reset/loop init */ 582 }; 583 584 typedef union { 585 u_int8_t *sense_ptr; /* 586 * Pointer to storage 587 * for sense information 588 */ 589 /* Storage Area for sense information */ 590 struct scsi_sense_data sense_buf; 591 } sense_t; 592 593 typedef union { 594 u_int8_t *cdb_ptr; /* Pointer to the CDB bytes to send */ 595 /* Area for the CDB send */ 596 u_int8_t cdb_bytes[IOCDBLEN]; 597 } cdb_t; 598 599 /* 600 * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO 601 * function codes. 602 */ 603 struct ccb_scsiio { 604 struct ccb_hdr ccb_h; 605 union ccb *next_ccb; /* Ptr for next CCB for action */ 606 u_int8_t *req_map; /* Ptr to mapping info */ 607 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */ 608 u_int32_t dxfer_len; /* Data transfer length */ 609 /* Autosense storage */ 610 struct scsi_sense_data sense_data; 611 u_int8_t sense_len; /* Number of bytes to autosense */ 612 u_int8_t cdb_len; /* Number of bytes for the CDB */ 613 u_int16_t sglist_cnt; /* Number of SG list entries */ 614 u_int8_t scsi_status; /* Returned SCSI status */ 615 u_int8_t sense_resid; /* Autosense resid length: 2's comp */ 616 u_int32_t resid; /* Transfer residual length: 2's comp */ 617 cdb_t cdb_io; /* Union for CDB bytes/pointer */ 618 u_int8_t *msg_ptr; /* Pointer to the message buffer */ 619 u_int16_t msg_len; /* Number of bytes for the Message */ 620 u_int8_t tag_action; /* What to do for tag queueing */ 621 /* 622 * The tag action should be either the define below (to send a 623 * non-tagged transaction) or one of the defined scsi tag messages 624 * from scsi_message.h. 625 */ 626 #define CAM_TAG_ACTION_NONE 0x00 627 u_int tag_id; /* tag id from initator (target mode) */ 628 u_int init_id; /* initiator id of who selected */ 629 }; 630 631 /* 632 * ATA I/O Request CCB used for the XPT_ATA_IO function code. 633 */ 634 struct ccb_ataio { 635 struct ccb_hdr ccb_h; 636 union ccb *next_ccb; /* Ptr for next CCB for action */ 637 struct ata_cmd cmd; /* ATA command register set */ 638 struct ata_res res; /* ATA result register set */ 639 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */ 640 u_int32_t dxfer_len; /* Data transfer length */ 641 u_int32_t resid; /* Transfer residual length: 2's comp */ 642 u_int8_t tag_action; /* What to do for tag queueing */ 643 /* 644 * The tag action should be either the define below (to send a 645 * non-tagged transaction) or one of the defined scsi tag messages 646 * from scsi_message.h. 647 */ 648 #define CAM_TAG_ACTION_NONE 0x00 649 u_int tag_id; /* tag id from initator (target mode) */ 650 u_int init_id; /* initiator id of who selected */ 651 }; 652 653 struct ccb_accept_tio { 654 struct ccb_hdr ccb_h; 655 cdb_t cdb_io; /* Union for CDB bytes/pointer */ 656 u_int8_t cdb_len; /* Number of bytes for the CDB */ 657 u_int8_t tag_action; /* What to do for tag queueing */ 658 u_int8_t sense_len; /* Number of bytes of Sense Data */ 659 u_int tag_id; /* tag id from initator (target mode) */ 660 u_int init_id; /* initiator id of who selected */ 661 struct scsi_sense_data sense_data; 662 }; 663 664 /* Release SIM Queue */ 665 struct ccb_relsim { 666 struct ccb_hdr ccb_h; 667 u_int32_t release_flags; 668 #define RELSIM_ADJUST_OPENINGS 0x01 669 #define RELSIM_RELEASE_AFTER_TIMEOUT 0x02 670 #define RELSIM_RELEASE_AFTER_CMDCMPLT 0x04 671 #define RELSIM_RELEASE_AFTER_QEMPTY 0x08 672 u_int32_t openings; 673 u_int32_t release_timeout; 674 u_int32_t qfrozen_cnt; 675 }; 676 677 /* 678 * Definitions for the asynchronous callback CCB fields. 679 */ 680 typedef enum { 681 AC_GETDEV_CHANGED = 0x800,/* Getdev info might have changed */ 682 AC_INQ_CHANGED = 0x400,/* Inquiry info might have changed */ 683 AC_TRANSFER_NEG = 0x200,/* New transfer settings in effect */ 684 AC_LOST_DEVICE = 0x100,/* A device went away */ 685 AC_FOUND_DEVICE = 0x080,/* A new device was found */ 686 AC_PATH_DEREGISTERED = 0x040,/* A path has de-registered */ 687 AC_PATH_REGISTERED = 0x020,/* A new path has been registered */ 688 AC_SENT_BDR = 0x010,/* A BDR message was sent to target */ 689 AC_SCSI_AEN = 0x008,/* A SCSI AEN has been received */ 690 AC_UNSOL_RESEL = 0x002,/* Unsolicited reselection occurred */ 691 AC_BUS_RESET = 0x001 /* A SCSI bus reset occurred */ 692 } ac_code; 693 694 typedef void ac_callback_t (void *softc, u_int32_t code, 695 struct cam_path *path, void *args); 696 697 /* Set Asynchronous Callback CCB */ 698 struct ccb_setasync { 699 struct ccb_hdr ccb_h; 700 u_int32_t event_enable; /* Async Event enables */ 701 ac_callback_t *callback; 702 void *callback_arg; 703 }; 704 705 /* Set Device Type CCB */ 706 struct ccb_setdev { 707 struct ccb_hdr ccb_h; 708 u_int8_t dev_type; /* Value for dev type field in EDT */ 709 }; 710 711 /* SCSI Control Functions */ 712 713 /* Abort XPT request CCB */ 714 struct ccb_abort { 715 struct ccb_hdr ccb_h; 716 union ccb *abort_ccb; /* Pointer to CCB to abort */ 717 }; 718 719 /* Reset SCSI Bus CCB */ 720 struct ccb_resetbus { 721 struct ccb_hdr ccb_h; 722 }; 723 724 /* Reset SCSI Device CCB */ 725 struct ccb_resetdev { 726 struct ccb_hdr ccb_h; 727 }; 728 729 /* Terminate I/O Process Request CCB */ 730 struct ccb_termio { 731 struct ccb_hdr ccb_h; 732 union ccb *termio_ccb; /* Pointer to CCB to terminate */ 733 }; 734 735 typedef enum { 736 CTS_TYPE_CURRENT_SETTINGS, 737 CTS_TYPE_USER_SETTINGS 738 } cts_type; 739 740 struct ccb_trans_settings_scsi 741 { 742 u_int valid; /* Which fields to honor */ 743 #define CTS_SCSI_VALID_TQ 0x01 744 u_int flags; 745 #define CTS_SCSI_FLAGS_TAG_ENB 0x01 746 }; 747 748 struct ccb_trans_settings_spi 749 { 750 u_int valid; /* Which fields to honor */ 751 #define CTS_SPI_VALID_SYNC_RATE 0x01 752 #define CTS_SPI_VALID_SYNC_OFFSET 0x02 753 #define CTS_SPI_VALID_BUS_WIDTH 0x04 754 #define CTS_SPI_VALID_DISC 0x08 755 #define CTS_SPI_VALID_PPR_OPTIONS 0x10 756 u_int flags; 757 #define CTS_SPI_FLAGS_DISC_ENB 0x01 758 u_int sync_period; 759 u_int sync_offset; 760 u_int bus_width; 761 u_int ppr_options; 762 }; 763 764 struct ccb_trans_settings_fc { 765 u_int valid; /* Which fields to honor */ 766 #define CTS_FC_VALID_WWNN 0x8000 767 #define CTS_FC_VALID_WWPN 0x4000 768 #define CTS_FC_VALID_PORT 0x2000 769 #define CTS_FC_VALID_SPEED 0x1000 770 u_int64_t wwnn; /* world wide node name */ 771 u_int64_t wwpn; /* world wide port name */ 772 u_int32_t port; /* 24 bit port id, if known */ 773 u_int32_t bitrate; /* Mbps */ 774 }; 775 776 struct ccb_trans_settings_sas { 777 u_int valid; /* Which fields to honor */ 778 #define CTS_SAS_VALID_SPEED 0x1000 779 u_int32_t bitrate; /* Mbps */ 780 }; 781 782 struct ccb_trans_settings_sata { 783 u_int valid; /* Which fields to honor */ 784 #define CTS_SATA_VALID_SPEED 0x01 785 #define CTS_SATA_VALID_PM 0x02 786 u_int32_t bitrate; /* Mbps */ 787 u_int pm_present; /* PM is present (XPT->SIM) */ 788 }; 789 790 /* Get/Set transfer rate/width/disconnection/tag queueing settings */ 791 struct ccb_trans_settings { 792 struct ccb_hdr ccb_h; 793 cts_type type; /* Current or User settings */ 794 cam_proto protocol; 795 u_int protocol_version; 796 cam_xport transport; 797 u_int transport_version; 798 union { 799 u_int valid; /* Which fields to honor */ 800 struct ccb_trans_settings_scsi scsi; 801 } proto_specific; 802 union { 803 u_int valid; /* Which fields to honor */ 804 struct ccb_trans_settings_spi spi; 805 struct ccb_trans_settings_fc fc; 806 struct ccb_trans_settings_sas sas; 807 struct ccb_trans_settings_sata sata; 808 } xport_specific; 809 }; 810 811 812 /* 813 * Calculate the geometry parameters for a device 814 * give the block size and volume size in blocks. 815 */ 816 struct ccb_calc_geometry { 817 struct ccb_hdr ccb_h; 818 u_int32_t block_size; 819 u_int64_t volume_size; 820 u_int32_t cylinders; 821 u_int8_t heads; 822 u_int8_t secs_per_track; 823 }; 824 825 /* 826 * Rescan the given bus, or bus/target/lun 827 */ 828 struct ccb_rescan { 829 struct ccb_hdr ccb_h; 830 cam_flags flags; 831 }; 832 833 /* 834 * Turn on debugging for the given bus, bus/target, or bus/target/lun. 835 */ 836 struct ccb_debug { 837 struct ccb_hdr ccb_h; 838 cam_debug_flags flags; 839 }; 840 841 /* Target mode structures. */ 842 843 struct ccb_en_lun { 844 struct ccb_hdr ccb_h; 845 u_int16_t grp6_len; /* Group 6 VU CDB length */ 846 u_int16_t grp7_len; /* Group 7 VU CDB length */ 847 u_int8_t enable; 848 }; 849 850 struct ccb_immed_notify { 851 struct ccb_hdr ccb_h; 852 struct scsi_sense_data sense_data; 853 u_int8_t sense_len; /* Number of bytes in sense buffer */ 854 u_int8_t initiator_id; /* Id of initiator that selected */ 855 u_int8_t message_args[7]; /* Message Arguments */ 856 }; 857 858 struct ccb_notify_ack { 859 struct ccb_hdr ccb_h; 860 u_int16_t seq_id; /* Sequence identifier */ 861 u_int8_t event; /* Event flags */ 862 }; 863 864 /* HBA engine structures. */ 865 866 typedef enum { 867 EIT_BUFFER, /* Engine type: buffer memory */ 868 EIT_LOSSLESS, /* Engine type: lossless compression */ 869 EIT_LOSSY, /* Engine type: lossy compression */ 870 EIT_ENCRYPT /* Engine type: encryption */ 871 } ei_type; 872 873 typedef enum { 874 EAD_VUNIQUE, /* Engine algorithm ID: vendor unique */ 875 EAD_LZ1V1, /* Engine algorithm ID: LZ1 var.1 */ 876 EAD_LZ2V1, /* Engine algorithm ID: LZ2 var.1 */ 877 EAD_LZ2V2 /* Engine algorithm ID: LZ2 var.2 */ 878 } ei_algo; 879 880 struct ccb_eng_inq { 881 struct ccb_hdr ccb_h; 882 u_int16_t eng_num; /* The engine number for this inquiry */ 883 ei_type eng_type; /* Returned engine type */ 884 ei_algo eng_algo; /* Returned engine algorithm type */ 885 u_int32_t eng_memeory; /* Returned engine memory size */ 886 }; 887 888 struct ccb_eng_exec { /* This structure must match SCSIIO size */ 889 struct ccb_hdr ccb_h; 890 u_int8_t *pdrv_ptr; /* Ptr used by the peripheral driver */ 891 u_int8_t *req_map; /* Ptr for mapping info on the req. */ 892 u_int8_t *data_ptr; /* Pointer to the data buf/SG list */ 893 u_int32_t dxfer_len; /* Data transfer length */ 894 u_int8_t *engdata_ptr; /* Pointer to the engine buffer data */ 895 u_int16_t sglist_cnt; /* Num of scatter gather list entries */ 896 u_int32_t dmax_len; /* Destination data maximum length */ 897 u_int32_t dest_len; /* Destination data length */ 898 int32_t src_resid; /* Source residual length: 2's comp */ 899 u_int32_t timeout; /* Timeout value */ 900 u_int16_t eng_num; /* Engine number for this request */ 901 u_int16_t vu_flags; /* Vendor Unique flags */ 902 }; 903 904 /* 905 * Definitions for the timeout field in the SCSI I/O CCB. 906 */ 907 #define CAM_TIME_DEFAULT 0x00000000 /* Use SIM default value */ 908 #define CAM_TIME_INFINITY 0xFFFFFFFF /* Infinite timeout */ 909 910 #define CAM_SUCCESS 0 /* For signaling general success */ 911 #define CAM_FAILURE 1 /* For signaling general failure */ 912 913 #define CAM_FALSE 0 914 #define CAM_TRUE 1 915 916 #define XPT_CCB_INVALID -1 /* for signaling a bad CCB to free */ 917 918 /* 919 * Union of all CCB types for kernel space allocation. This union should 920 * never be used for manipulating CCBs - its only use is for the allocation 921 * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc 922 * and the argument to xpt_ccb_free. 923 */ 924 union ccb { 925 struct ccb_hdr ccb_h; /* For convenience */ 926 struct ccb_scsiio csio; 927 struct ccb_getdev cgd; 928 struct ccb_getdevlist cgdl; 929 struct ccb_pathinq cpi; 930 struct ccb_relsim crs; 931 struct ccb_setasync csa; 932 struct ccb_setdev csd; 933 struct ccb_pathstats cpis; 934 struct ccb_getdevstats cgds; 935 struct ccb_dev_match cdm; 936 struct ccb_trans_settings cts; 937 struct ccb_calc_geometry ccg; 938 struct ccb_abort cab; 939 struct ccb_resetbus crb; 940 struct ccb_resetdev crd; 941 struct ccb_termio tio; 942 struct ccb_accept_tio atio; 943 struct ccb_scsiio ctio; 944 struct ccb_en_lun cel; 945 struct ccb_immed_notify cin; 946 struct ccb_notify_ack cna; 947 struct ccb_eng_inq cei; 948 struct ccb_eng_exec cee; 949 struct ccb_rescan crcn; 950 struct ccb_debug cdbg; 951 struct ccb_ataio ataio; 952 }; 953 954 __BEGIN_DECLS 955 static __inline void 956 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries, 957 void (*cbfcnp)(struct cam_periph *, union ccb *), 958 u_int32_t flags, u_int8_t tag_action, 959 u_int8_t *data_ptr, u_int32_t dxfer_len, 960 u_int8_t sense_len, u_int8_t cdb_len, 961 u_int32_t timeout); 962 963 static __inline void 964 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries, 965 void (*cbfcnp)(struct cam_periph *, union ccb *), 966 u_int32_t flags, u_int tag_action, u_int tag_id, 967 u_int init_id, u_int scsi_status, u_int8_t *data_ptr, 968 u_int32_t dxfer_len, u_int32_t timeout); 969 970 static __inline void 971 cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries, 972 void (*cbfcnp)(struct cam_periph *, union ccb *), 973 u_int32_t flags, u_int tag_action, 974 u_int8_t *data_ptr, u_int32_t dxfer_len, 975 u_int32_t timeout); 976 977 static __inline void 978 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries, 979 void (*cbfcnp)(struct cam_periph *, union ccb *), 980 u_int32_t flags, u_int8_t tag_action, 981 u_int8_t *data_ptr, u_int32_t dxfer_len, 982 u_int8_t sense_len, u_int8_t cdb_len, 983 u_int32_t timeout) 984 { 985 csio->ccb_h.func_code = XPT_SCSI_IO; 986 csio->ccb_h.flags = flags; 987 csio->ccb_h.retry_count = retries; 988 csio->ccb_h.cbfcnp = cbfcnp; 989 csio->ccb_h.timeout = timeout; 990 csio->data_ptr = data_ptr; 991 csio->dxfer_len = dxfer_len; 992 csio->sense_len = sense_len; 993 csio->cdb_len = cdb_len; 994 csio->tag_action = tag_action; 995 } 996 997 static __inline void 998 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries, 999 void (*cbfcnp)(struct cam_periph *, union ccb *), 1000 u_int32_t flags, u_int tag_action, u_int tag_id, 1001 u_int init_id, u_int scsi_status, u_int8_t *data_ptr, 1002 u_int32_t dxfer_len, u_int32_t timeout) 1003 { 1004 csio->ccb_h.func_code = XPT_CONT_TARGET_IO; 1005 csio->ccb_h.flags = flags; 1006 csio->ccb_h.retry_count = retries; 1007 csio->ccb_h.cbfcnp = cbfcnp; 1008 csio->ccb_h.timeout = timeout; 1009 csio->data_ptr = data_ptr; 1010 csio->dxfer_len = dxfer_len; 1011 csio->scsi_status = scsi_status; 1012 csio->tag_action = tag_action; 1013 csio->tag_id = tag_id; 1014 csio->init_id = init_id; 1015 } 1016 1017 static __inline void 1018 cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries, 1019 void (*cbfcnp)(struct cam_periph *, union ccb *), 1020 u_int32_t flags, u_int tag_action, 1021 u_int8_t *data_ptr, u_int32_t dxfer_len, 1022 u_int32_t timeout) 1023 { 1024 ataio->ccb_h.func_code = XPT_ATA_IO; 1025 ataio->ccb_h.flags = flags; 1026 ataio->ccb_h.retry_count = retries; 1027 ataio->ccb_h.cbfcnp = cbfcnp; 1028 ataio->ccb_h.timeout = timeout; 1029 ataio->data_ptr = data_ptr; 1030 ataio->dxfer_len = dxfer_len; 1031 ataio->tag_action = tag_action; 1032 } 1033 1034 void cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended); 1035 1036 __END_DECLS 1037 1038 #endif /* _CAM_CAM_CCB_H */ 1039