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_QUIET = 0x00100000,/* Quiet error reporting */ 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 /* 261 * WARNING! Fields are specifically copied in cam_periph.c's restore_ccb() 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 struct callout *timeout_ch; /* Callout handle used for timeouts */ 282 char pad[48]; /* user/kernel structure compat */ 283 }; 284 285 /* Get Device Information CCB */ 286 struct ccb_getdev { 287 struct ccb_hdr ccb_h; 288 struct scsi_inquiry_data inq_data; 289 u_int8_t serial_num[252]; 290 u_int8_t reserved; 291 u_int8_t serial_num_len; 292 }; 293 294 /* Device Statistics CCB */ 295 struct ccb_getdevstats { 296 struct ccb_hdr ccb_h; 297 int dev_openings; /* Space left for more work on device*/ 298 int dev_active; /* Transactions running on the device */ 299 int devq_openings; /* Space left for more queued work */ 300 int devq_queued; /* Transactions queued to be sent */ 301 int held; /* 302 * CCBs held by peripheral drivers 303 * for this device 304 */ 305 int maxtags; /* 306 * Boundary conditions for number of 307 * tagged operations 308 */ 309 int mintags; 310 struct timeval last_reset; /* Uptime of last bus reset/loop init */ 311 }; 312 313 typedef enum { 314 CAM_GDEVLIST_LAST_DEVICE, 315 CAM_GDEVLIST_LIST_CHANGED, 316 CAM_GDEVLIST_MORE_DEVS, 317 CAM_GDEVLIST_ERROR 318 } ccb_getdevlist_status_e; 319 320 struct ccb_getdevlist { 321 struct ccb_hdr ccb_h; 322 char periph_name[DEV_IDLEN]; 323 u_int32_t unit_number; 324 unsigned int generation; 325 u_int32_t index; 326 ccb_getdevlist_status_e status; 327 }; 328 329 typedef enum { 330 PERIPH_MATCH_NONE = 0x000, 331 PERIPH_MATCH_PATH = 0x001, 332 PERIPH_MATCH_TARGET = 0x002, 333 PERIPH_MATCH_LUN = 0x004, 334 PERIPH_MATCH_NAME = 0x008, 335 PERIPH_MATCH_UNIT = 0x010, 336 PERIPH_MATCH_ANY = 0x01f 337 } periph_pattern_flags; 338 339 struct periph_match_pattern { 340 char periph_name[DEV_IDLEN]; 341 u_int32_t unit_number; 342 path_id_t path_id; 343 target_id_t target_id; 344 lun_id_t target_lun; 345 periph_pattern_flags flags; 346 }; 347 348 typedef enum { 349 DEV_MATCH_NONE = 0x000, 350 DEV_MATCH_PATH = 0x001, 351 DEV_MATCH_TARGET = 0x002, 352 DEV_MATCH_LUN = 0x004, 353 DEV_MATCH_INQUIRY = 0x008, 354 DEV_MATCH_ANY = 0x00f 355 } dev_pattern_flags; 356 357 struct device_match_pattern { 358 path_id_t path_id; 359 target_id_t target_id; 360 lun_id_t target_lun; 361 struct scsi_static_inquiry_pattern inq_pat; 362 dev_pattern_flags flags; 363 }; 364 365 typedef enum { 366 BUS_MATCH_NONE = 0x000, 367 BUS_MATCH_PATH = 0x001, 368 BUS_MATCH_NAME = 0x002, 369 BUS_MATCH_UNIT = 0x004, 370 BUS_MATCH_BUS_ID = 0x008, 371 BUS_MATCH_ANY = 0x00f 372 } bus_pattern_flags; 373 374 struct bus_match_pattern { 375 path_id_t path_id; 376 char dev_name[DEV_IDLEN]; 377 u_int32_t unit_number; 378 u_int32_t bus_id; 379 bus_pattern_flags flags; 380 }; 381 382 union match_pattern { 383 struct periph_match_pattern periph_pattern; 384 struct device_match_pattern device_pattern; 385 struct bus_match_pattern bus_pattern; 386 }; 387 388 typedef enum { 389 DEV_MATCH_PERIPH, 390 DEV_MATCH_DEVICE, 391 DEV_MATCH_BUS 392 } dev_match_type; 393 394 struct dev_match_pattern { 395 dev_match_type type; 396 union match_pattern pattern; 397 }; 398 399 struct periph_match_result { 400 char periph_name[DEV_IDLEN]; 401 u_int32_t unit_number; 402 path_id_t path_id; 403 target_id_t target_id; 404 lun_id_t target_lun; 405 }; 406 407 typedef enum { 408 DEV_RESULT_NOFLAG = 0x00, 409 DEV_RESULT_UNCONFIGURED = 0x01 410 } dev_result_flags; 411 412 struct device_match_result { 413 path_id_t path_id; 414 target_id_t target_id; 415 lun_id_t target_lun; 416 struct scsi_inquiry_data inq_data; 417 dev_result_flags flags; 418 }; 419 420 struct bus_match_result { 421 path_id_t path_id; 422 char dev_name[DEV_IDLEN]; 423 u_int32_t unit_number; 424 u_int32_t bus_id; 425 }; 426 427 union match_result { 428 struct periph_match_result periph_result; 429 struct device_match_result device_result; 430 struct bus_match_result bus_result; 431 }; 432 433 struct dev_match_result { 434 dev_match_type type; 435 union match_result result; 436 }; 437 438 typedef enum { 439 CAM_DEV_MATCH_LAST, 440 CAM_DEV_MATCH_MORE, 441 CAM_DEV_MATCH_LIST_CHANGED, 442 CAM_DEV_MATCH_SIZE_ERROR, 443 CAM_DEV_MATCH_ERROR 444 } ccb_dev_match_status; 445 446 typedef enum { 447 CAM_DEV_POS_NONE = 0x000, 448 CAM_DEV_POS_BUS = 0x001, 449 CAM_DEV_POS_TARGET = 0x002, 450 CAM_DEV_POS_DEVICE = 0x004, 451 CAM_DEV_POS_PERIPH = 0x008, 452 CAM_DEV_POS_PDPTR = 0x010, 453 CAM_DEV_POS_TYPEMASK = 0xf00, 454 CAM_DEV_POS_EDT = 0x100, 455 CAM_DEV_POS_PDRV = 0x200 456 } dev_pos_type; 457 458 struct ccb_dm_cookie { 459 void *bus; 460 void *target; 461 void *device; 462 void *periph; 463 void *pdrv; 464 }; 465 466 struct ccb_dev_position { 467 u_int generations[4]; 468 #define CAM_BUS_GENERATION 0x00 469 #define CAM_TARGET_GENERATION 0x01 470 #define CAM_DEV_GENERATION 0x02 471 #define CAM_PERIPH_GENERATION 0x03 472 dev_pos_type position_type; 473 struct ccb_dm_cookie cookie; 474 }; 475 476 struct ccb_dev_match { 477 struct ccb_hdr ccb_h; 478 ccb_dev_match_status status; 479 u_int32_t num_patterns; 480 u_int32_t pattern_buf_len; 481 struct dev_match_pattern *patterns; 482 u_int32_t num_matches; 483 u_int32_t match_buf_len; 484 struct dev_match_result *matches; 485 struct ccb_dev_position pos; 486 }; 487 488 /* 489 * Definitions for the path inquiry CCB fields. 490 */ 491 #define CAM_VERSION 0x15 /* Hex value for current version */ 492 493 typedef enum { 494 PI_MDP_ABLE = 0x80, /* Supports MDP message */ 495 PI_WIDE_32 = 0x40, /* Supports 32 bit wide SCSI */ 496 PI_WIDE_16 = 0x20, /* Supports 16 bit wide SCSI */ 497 PI_SDTR_ABLE = 0x10, /* Supports SDTR message */ 498 PI_LINKED_CDB = 0x08, /* Supports linked CDBs */ 499 PI_TAG_ABLE = 0x02, /* Supports tag queue messages */ 500 PI_SOFT_RST = 0x01 /* Supports soft reset alternative */ 501 } pi_inqflag; 502 503 typedef enum { 504 PIT_PROCESSOR = 0x80, /* Target mode processor mode */ 505 PIT_PHASE = 0x40, /* Target mode phase cog. mode */ 506 PIT_DISCONNECT = 0x20, /* Disconnects supported in target mode */ 507 PIT_TERM_IO = 0x10, /* Terminate I/O message supported in TM */ 508 PIT_GRP_6 = 0x08, /* Group 6 commands supported */ 509 PIT_GRP_7 = 0x04 /* Group 7 commands supported */ 510 } pi_tmflag; 511 512 typedef enum { 513 PIM_SCANHILO = 0x80, /* Bus scans from high ID to low ID */ 514 PIM_NOREMOVE = 0x40, /* Removeable devices not included in scan */ 515 PIM_NOINITIATOR = 0x20, /* Initiator role not supported. */ 516 PIM_NOBUSRESET = 0x10, /* User has disabled initial BUS RESET */ 517 PIM_NO_6_BYTE = 0x08, /* Do not send 6-byte commands */ 518 PIM_SEQSCAN = 0x04 /* Do bus scans sequentially, not in parallel */ 519 } pi_miscflag; 520 521 /* Path Inquiry CCB */ 522 struct ccb_pathinq_settings_spi { 523 u_int8_t ppr_options; 524 }; 525 struct ccb_pathinq_settings_fc { 526 u_int64_t wwnn; /* world wide node name */ 527 u_int64_t wwpn; /* world wide port name */ 528 u_int32_t port; /* 24 bit port id, if known */ 529 u_int32_t bitrate; /* Mbps */ 530 }; 531 struct ccb_pathinq_settings_sas { 532 u_int32_t bitrate; /* Mbps */ 533 }; 534 #define PATHINQ_SETTINGS_SIZE 128 535 536 struct ccb_pathinq { 537 struct ccb_hdr ccb_h; 538 u_int8_t version_num; /* Version number for the SIM/HBA */ 539 u_int8_t hba_inquiry; /* Mimic of INQ byte 7 for the HBA */ 540 u_int8_t target_sprt; /* Flags for target mode support */ 541 u_int8_t hba_misc; /* Misc HBA features */ 542 u_int16_t hba_eng_cnt; /* HBA engine count */ 543 /* Vendor Unique capabilities */ 544 u_int8_t vuhba_flags[VUHBALEN]; 545 u_int32_t max_target; /* Maximum supported Target */ 546 u_int32_t max_lun; /* Maximum supported Lun */ 547 u_int32_t async_flags; /* Installed Async handlers */ 548 path_id_t hpath_id; /* Highest Path ID in the subsystem */ 549 target_id_t initiator_id; /* ID of the HBA on the SCSI bus */ 550 char sim_vid[SIM_IDLEN]; /* Vendor ID of the SIM */ 551 char hba_vid[HBA_IDLEN]; /* Vendor ID of the HBA */ 552 char dev_name[DEV_IDLEN];/* Device name for SIM */ 553 u_int32_t unit_number; /* Unit number for SIM */ 554 u_int32_t bus_id; /* Bus ID for SIM */ 555 u_int32_t base_transfer_speed;/* Base bus speed in KB/sec */ 556 cam_proto protocol; 557 u_int protocol_version; 558 cam_xport transport; 559 u_int transport_version; 560 union { 561 struct ccb_pathinq_settings_spi spi; 562 struct ccb_pathinq_settings_fc fc; 563 struct ccb_pathinq_settings_sas sas; 564 char ccb_pathinq_settings_opaque[PATHINQ_SETTINGS_SIZE]; 565 } xport_specific; 566 u_int maxio; /* Max supported I/O size, in bytes. */ 567 }; 568 569 /* Path Statistics CCB */ 570 struct ccb_pathstats { 571 struct ccb_hdr ccb_h; 572 struct timeval last_reset; /* Uptime of last bus reset/loop init */ 573 }; 574 575 typedef union { 576 u_int8_t *sense_ptr; /* 577 * Pointer to storage 578 * for sense information 579 */ 580 /* Storage Area for sense information */ 581 struct scsi_sense_data sense_buf; 582 } sense_t; 583 584 typedef union { 585 u_int8_t *cdb_ptr; /* Pointer to the CDB bytes to send */ 586 /* Area for the CDB send */ 587 u_int8_t cdb_bytes[IOCDBLEN]; 588 } cdb_t; 589 590 /* 591 * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO 592 * function codes. 593 */ 594 struct ccb_scsiio { 595 struct ccb_hdr ccb_h; 596 union ccb *next_ccb; /* Ptr for next CCB for action */ 597 u_int8_t *req_map; /* Ptr to mapping info */ 598 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */ 599 u_int32_t dxfer_len; /* Data transfer length */ 600 /* Autosense storage */ 601 struct scsi_sense_data sense_data; 602 u_int8_t sense_len; /* Number of bytes to autosense */ 603 u_int8_t cdb_len; /* Number of bytes for the CDB */ 604 u_int16_t sglist_cnt; /* Number of SG list entries */ 605 u_int8_t scsi_status; /* Returned SCSI status */ 606 u_int8_t sense_resid; /* Autosense resid length: 2's comp */ 607 u_int32_t resid; /* Transfer residual length: 2's comp */ 608 cdb_t cdb_io; /* Union for CDB bytes/pointer */ 609 u_int8_t *msg_ptr; /* Pointer to the message buffer */ 610 u_int16_t msg_len; /* Number of bytes for the Message */ 611 u_int8_t tag_action; /* What to do for tag queueing */ 612 /* 613 * The tag action should be either the define below (to send a 614 * non-tagged transaction) or one of the defined scsi tag messages 615 * from scsi_message.h. 616 */ 617 #define CAM_TAG_ACTION_NONE 0x00 618 u_int tag_id; /* tag id from initator (target mode) */ 619 u_int init_id; /* initiator id of who selected */ 620 }; 621 622 struct ccb_accept_tio { 623 struct ccb_hdr ccb_h; 624 cdb_t cdb_io; /* Union for CDB bytes/pointer */ 625 u_int8_t cdb_len; /* Number of bytes for the CDB */ 626 u_int8_t tag_action; /* What to do for tag queueing */ 627 u_int8_t sense_len; /* Number of bytes of Sense Data */ 628 u_int tag_id; /* tag id from initator (target mode) */ 629 u_int init_id; /* initiator id of who selected */ 630 struct scsi_sense_data sense_data; 631 }; 632 633 /* Release SIM Queue */ 634 struct ccb_relsim { 635 struct ccb_hdr ccb_h; 636 u_int32_t release_flags; 637 #define RELSIM_ADJUST_OPENINGS 0x01 638 #define RELSIM_RELEASE_AFTER_TIMEOUT 0x02 639 #define RELSIM_RELEASE_AFTER_CMDCMPLT 0x04 640 #define RELSIM_RELEASE_AFTER_QEMPTY 0x08 641 u_int32_t openings; 642 u_int32_t release_timeout; 643 u_int32_t qfrozen_cnt; 644 }; 645 646 /* 647 * Definitions for the asynchronous callback CCB fields. 648 */ 649 typedef enum { 650 AC_GETDEV_CHANGED = 0x800,/* Getdev info might have changed */ 651 AC_INQ_CHANGED = 0x400,/* Inquiry info might have changed */ 652 AC_TRANSFER_NEG = 0x200,/* New transfer settings in effect */ 653 AC_LOST_DEVICE = 0x100,/* A device went away */ 654 AC_FOUND_DEVICE = 0x080,/* A new device was found */ 655 AC_PATH_DEREGISTERED = 0x040,/* A path has de-registered */ 656 AC_PATH_REGISTERED = 0x020,/* A new path has been registered */ 657 AC_SENT_BDR = 0x010,/* A BDR message was sent to target */ 658 AC_SCSI_AEN = 0x008,/* A SCSI AEN has been received */ 659 AC_UNSOL_RESEL = 0x002,/* Unsolicited reselection occurred */ 660 AC_BUS_RESET = 0x001 /* A SCSI bus reset occurred */ 661 } ac_code; 662 663 typedef void ac_callback_t (void *softc, u_int32_t code, 664 struct cam_path *path, void *args); 665 666 /* Set Asynchronous Callback CCB */ 667 struct ccb_setasync { 668 struct ccb_hdr ccb_h; 669 u_int32_t event_enable; /* Async Event enables */ 670 ac_callback_t *callback; 671 void *callback_arg; 672 }; 673 674 /* Set Device Type CCB */ 675 struct ccb_setdev { 676 struct ccb_hdr ccb_h; 677 u_int8_t dev_type; /* Value for dev type field in EDT */ 678 }; 679 680 /* SCSI Control Functions */ 681 682 /* Abort XPT request CCB */ 683 struct ccb_abort { 684 struct ccb_hdr ccb_h; 685 union ccb *abort_ccb; /* Pointer to CCB to abort */ 686 }; 687 688 /* Reset SCSI Bus CCB */ 689 struct ccb_resetbus { 690 struct ccb_hdr ccb_h; 691 }; 692 693 /* Reset SCSI Device CCB */ 694 struct ccb_resetdev { 695 struct ccb_hdr ccb_h; 696 }; 697 698 /* Terminate I/O Process Request CCB */ 699 struct ccb_termio { 700 struct ccb_hdr ccb_h; 701 union ccb *termio_ccb; /* Pointer to CCB to terminate */ 702 }; 703 704 typedef enum { 705 CTS_TYPE_CURRENT_SETTINGS, 706 CTS_TYPE_USER_SETTINGS 707 } cts_type; 708 709 struct ccb_trans_settings_scsi 710 { 711 u_int valid; /* Which fields to honor */ 712 #define CTS_SCSI_VALID_TQ 0x01 713 u_int flags; 714 #define CTS_SCSI_FLAGS_TAG_ENB 0x01 715 }; 716 717 struct ccb_trans_settings_spi 718 { 719 u_int valid; /* Which fields to honor */ 720 #define CTS_SPI_VALID_SYNC_RATE 0x01 721 #define CTS_SPI_VALID_SYNC_OFFSET 0x02 722 #define CTS_SPI_VALID_BUS_WIDTH 0x04 723 #define CTS_SPI_VALID_DISC 0x08 724 #define CTS_SPI_VALID_PPR_OPTIONS 0x10 725 u_int flags; 726 #define CTS_SPI_FLAGS_DISC_ENB 0x01 727 u_int sync_period; 728 u_int sync_offset; 729 u_int bus_width; 730 u_int ppr_options; 731 }; 732 733 struct ccb_trans_settings_fc { 734 u_int valid; /* Which fields to honor */ 735 #define CTS_FC_VALID_WWNN 0x8000 736 #define CTS_FC_VALID_WWPN 0x4000 737 #define CTS_FC_VALID_PORT 0x2000 738 #define CTS_FC_VALID_SPEED 0x1000 739 u_int64_t wwnn; /* world wide node name */ 740 u_int64_t wwpn; /* world wide port name */ 741 u_int32_t port; /* 24 bit port id, if known */ 742 u_int32_t bitrate; /* Mbps */ 743 }; 744 745 struct ccb_trans_settings_sas { 746 u_int valid; /* Which fields to honor */ 747 #define CTS_SAS_VALID_SPEED 0x1000 748 u_int32_t bitrate; /* Mbps */ 749 }; 750 751 752 /* Get/Set transfer rate/width/disconnection/tag queueing settings */ 753 struct ccb_trans_settings { 754 struct ccb_hdr ccb_h; 755 cts_type type; /* Current or User settings */ 756 cam_proto protocol; 757 u_int protocol_version; 758 cam_xport transport; 759 u_int transport_version; 760 union { 761 u_int valid; /* Which fields to honor */ 762 struct ccb_trans_settings_scsi scsi; 763 } proto_specific; 764 union { 765 u_int valid; /* Which fields to honor */ 766 struct ccb_trans_settings_spi spi; 767 struct ccb_trans_settings_fc fc; 768 struct ccb_trans_settings_sas sas; 769 } xport_specific; 770 }; 771 772 /* 773 * Calculate the geometry parameters for a device 774 * give the block size and volume size in blocks. 775 */ 776 struct ccb_calc_geometry { 777 struct ccb_hdr ccb_h; 778 u_int32_t block_size; 779 u_int64_t volume_size; 780 u_int32_t cylinders; 781 u_int8_t heads; 782 u_int8_t secs_per_track; 783 }; 784 785 /* 786 * Rescan the given bus, or bus/target/lun 787 */ 788 struct ccb_rescan { 789 struct ccb_hdr ccb_h; 790 cam_flags flags; 791 }; 792 793 /* 794 * Turn on debugging for the given bus, bus/target, or bus/target/lun. 795 */ 796 struct ccb_debug { 797 struct ccb_hdr ccb_h; 798 cam_debug_flags flags; 799 }; 800 801 /* Target mode structures. */ 802 803 struct ccb_en_lun { 804 struct ccb_hdr ccb_h; 805 u_int16_t grp6_len; /* Group 6 VU CDB length */ 806 u_int16_t grp7_len; /* Group 7 VU CDB length */ 807 u_int8_t enable; 808 }; 809 810 struct ccb_immed_notify { 811 struct ccb_hdr ccb_h; 812 struct scsi_sense_data sense_data; 813 u_int8_t sense_len; /* Number of bytes in sense buffer */ 814 u_int8_t initiator_id; /* Id of initiator that selected */ 815 u_int8_t message_args[7]; /* Message Arguments */ 816 }; 817 818 struct ccb_notify_ack { 819 struct ccb_hdr ccb_h; 820 u_int16_t seq_id; /* Sequence identifier */ 821 u_int8_t event; /* Event flags */ 822 }; 823 824 /* HBA engine structures. */ 825 826 typedef enum { 827 EIT_BUFFER, /* Engine type: buffer memory */ 828 EIT_LOSSLESS, /* Engine type: lossless compression */ 829 EIT_LOSSY, /* Engine type: lossy compression */ 830 EIT_ENCRYPT /* Engine type: encryption */ 831 } ei_type; 832 833 typedef enum { 834 EAD_VUNIQUE, /* Engine algorithm ID: vendor unique */ 835 EAD_LZ1V1, /* Engine algorithm ID: LZ1 var.1 */ 836 EAD_LZ2V1, /* Engine algorithm ID: LZ2 var.1 */ 837 EAD_LZ2V2 /* Engine algorithm ID: LZ2 var.2 */ 838 } ei_algo; 839 840 struct ccb_eng_inq { 841 struct ccb_hdr ccb_h; 842 u_int16_t eng_num; /* The engine number for this inquiry */ 843 ei_type eng_type; /* Returned engine type */ 844 ei_algo eng_algo; /* Returned engine algorithm type */ 845 u_int32_t eng_memeory; /* Returned engine memory size */ 846 }; 847 848 struct ccb_eng_exec { /* This structure must match SCSIIO size */ 849 struct ccb_hdr ccb_h; 850 u_int8_t *pdrv_ptr; /* Ptr used by the peripheral driver */ 851 u_int8_t *req_map; /* Ptr for mapping info on the req. */ 852 u_int8_t *data_ptr; /* Pointer to the data buf/SG list */ 853 u_int32_t dxfer_len; /* Data transfer length */ 854 u_int8_t *engdata_ptr; /* Pointer to the engine buffer data */ 855 u_int16_t sglist_cnt; /* Num of scatter gather list entries */ 856 u_int32_t dmax_len; /* Destination data maximum length */ 857 u_int32_t dest_len; /* Destination data length */ 858 int32_t src_resid; /* Source residual length: 2's comp */ 859 u_int32_t timeout; /* Timeout value */ 860 u_int16_t eng_num; /* Engine number for this request */ 861 u_int16_t vu_flags; /* Vendor Unique flags */ 862 }; 863 864 /* 865 * Definitions for the timeout field in the SCSI I/O CCB. 866 */ 867 #define CAM_TIME_DEFAULT 0x00000000 /* Use SIM default value */ 868 #define CAM_TIME_INFINITY 0xFFFFFFFF /* Infinite timeout */ 869 870 #define CAM_SUCCESS 0 /* For signaling general success */ 871 #define CAM_FAILURE 1 /* For signaling general failure */ 872 873 #define CAM_FALSE 0 874 #define CAM_TRUE 1 875 876 #define XPT_CCB_INVALID -1 /* for signaling a bad CCB to free */ 877 878 /* 879 * Union of all CCB types for kernel space allocation. This union should 880 * never be used for manipulating CCBs - its only use is for the allocation 881 * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc 882 * and the argument to xpt_ccb_free. 883 */ 884 union ccb { 885 struct ccb_hdr ccb_h; /* For convenience */ 886 struct ccb_scsiio csio; 887 struct ccb_getdev cgd; 888 struct ccb_getdevlist cgdl; 889 struct ccb_pathinq cpi; 890 struct ccb_relsim crs; 891 struct ccb_setasync csa; 892 struct ccb_setdev csd; 893 struct ccb_pathstats cpis; 894 struct ccb_getdevstats cgds; 895 struct ccb_dev_match cdm; 896 struct ccb_trans_settings cts; 897 struct ccb_calc_geometry ccg; 898 struct ccb_abort cab; 899 struct ccb_resetbus crb; 900 struct ccb_resetdev crd; 901 struct ccb_termio tio; 902 struct ccb_accept_tio atio; 903 struct ccb_scsiio ctio; 904 struct ccb_en_lun cel; 905 struct ccb_immed_notify cin; 906 struct ccb_notify_ack cna; 907 struct ccb_eng_inq cei; 908 struct ccb_eng_exec cee; 909 struct ccb_rescan crcn; 910 struct ccb_debug cdbg; 911 }; 912 913 __BEGIN_DECLS 914 static __inline void 915 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries, 916 void (*cbfcnp)(struct cam_periph *, union ccb *), 917 u_int32_t flags, u_int8_t tag_action, 918 u_int8_t *data_ptr, u_int32_t dxfer_len, 919 u_int8_t sense_len, u_int8_t cdb_len, 920 u_int32_t timeout); 921 922 static __inline void 923 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries, 924 void (*cbfcnp)(struct cam_periph *, union ccb *), 925 u_int32_t flags, u_int tag_action, u_int tag_id, 926 u_int init_id, u_int scsi_status, u_int8_t *data_ptr, 927 u_int32_t dxfer_len, u_int32_t timeout); 928 929 static __inline void 930 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries, 931 void (*cbfcnp)(struct cam_periph *, union ccb *), 932 u_int32_t flags, u_int8_t tag_action, 933 u_int8_t *data_ptr, u_int32_t dxfer_len, 934 u_int8_t sense_len, u_int8_t cdb_len, 935 u_int32_t timeout) 936 { 937 csio->ccb_h.func_code = XPT_SCSI_IO; 938 csio->ccb_h.flags = flags; 939 csio->ccb_h.retry_count = retries; 940 csio->ccb_h.cbfcnp = cbfcnp; 941 csio->ccb_h.timeout = timeout; 942 csio->data_ptr = data_ptr; 943 csio->dxfer_len = dxfer_len; 944 csio->sense_len = sense_len; 945 csio->cdb_len = cdb_len; 946 csio->tag_action = tag_action; 947 } 948 949 static __inline void 950 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries, 951 void (*cbfcnp)(struct cam_periph *, union ccb *), 952 u_int32_t flags, u_int tag_action, u_int tag_id, 953 u_int init_id, u_int scsi_status, u_int8_t *data_ptr, 954 u_int32_t dxfer_len, u_int32_t timeout) 955 { 956 csio->ccb_h.func_code = XPT_CONT_TARGET_IO; 957 csio->ccb_h.flags = flags; 958 csio->ccb_h.retry_count = retries; 959 csio->ccb_h.cbfcnp = cbfcnp; 960 csio->ccb_h.timeout = timeout; 961 csio->data_ptr = data_ptr; 962 csio->dxfer_len = dxfer_len; 963 csio->scsi_status = scsi_status; 964 csio->tag_action = tag_action; 965 csio->tag_id = tag_id; 966 csio->init_id = init_id; 967 } 968 969 void cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended); 970 971 __END_DECLS 972 973 #endif /* !_BUS_CAM_CAM_CCB_H_ */ 974