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