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