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