Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]
FreeBSD/Linux Kernel Cross Reference
sys/cam/cam_ccb.h
Version:
- FREEBSD - FREEBSD-13-STABLE - FREEBSD-13-0 - FREEBSD-12-STABLE - FREEBSD-12-0 - FREEBSD-11-STABLE - FREEBSD-11-0 - FREEBSD-10-STABLE - FREEBSD-10-0 - FREEBSD-9-STABLE - FREEBSD-9-0 - FREEBSD-8-STABLE - FREEBSD-8-0 - FREEBSD-7-STABLE - FREEBSD-7-0 - FREEBSD-6-STABLE - FREEBSD-6-0 - FREEBSD-5-STABLE - FREEBSD-5-0 - FREEBSD-4-STABLE - FREEBSD-3-STABLE - FREEBSD22 - l41 - OPENBSD - linux-2.6 - MK84 - PLAN9 - xnu-8792
SearchContext: - none - 3 - 10
SearchContext: - none - 3 - 10
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_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 | XPT_FC_XPT_ONLY, 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 typedef union { 209 LIST_ENTRY(ccb_hdr) le; 210 SLIST_ENTRY(ccb_hdr) sle; 211 TAILQ_ENTRY(ccb_hdr) tqe; 212 STAILQ_ENTRY(ccb_hdr) stqe; 213 } camq_entry; 214 215 typedef union { 216 void *ptr; 217 u_long field; 218 u_int8_t bytes[sizeof(void *) > sizeof(u_long) 219 ? sizeof(void *) : sizeof(u_long)]; 220 } ccb_priv_entry; 221 222 typedef union { 223 ccb_priv_entry entries[CCB_PERIPH_PRIV_SIZE]; 224 u_int8_t bytes[CCB_PERIPH_PRIV_SIZE * sizeof(ccb_priv_entry)]; 225 } ccb_ppriv_area; 226 227 typedef union { 228 ccb_priv_entry entries[CCB_SIM_PRIV_SIZE]; 229 u_int8_t bytes[CCB_SIM_PRIV_SIZE * sizeof(ccb_priv_entry)]; 230 } ccb_spriv_area; 231 232 struct ccb_hdr { 233 cam_pinfo pinfo; /* Info for priority scheduling */ 234 camq_entry xpt_links; /* For chaining in the XPT layer */ 235 camq_entry sim_links; /* For chaining in the SIM layer */ 236 camq_entry periph_links;/* For chaining in the type driver */ 237 u_int32_t retry_count; 238 /* Callback on completion function */ 239 void (*cbfcnp)(struct cam_periph *, union ccb *); 240 xpt_opcode func_code; /* XPT function code */ 241 u_int32_t status; /* Status returned by CAM subsystem */ 242 /* Compiled path for this ccb */ 243 struct cam_path *path; 244 path_id_t path_id; /* Path ID for the request */ 245 target_id_t target_id; /* Target device ID */ 246 lun_id_t target_lun; /* Target LUN number */ 247 u_int32_t flags; 248 ccb_ppriv_area periph_priv; 249 ccb_spriv_area sim_priv; 250 u_int32_t timeout; /* Timeout value */ 251 /* Callout handle used for timeouts */ 252 struct callout_handle timeout_ch; 253 }; 254 255 /* Get Device Information CCB */ 256 struct ccb_getdev { 257 struct ccb_hdr ccb_h; 258 struct scsi_inquiry_data inq_data; 259 u_int8_t serial_num[252]; 260 u_int8_t inq_len; 261 u_int8_t serial_num_len; 262 }; 263 264 /* Device Statistics CCB */ 265 struct ccb_getdevstats { 266 struct ccb_hdr ccb_h; 267 int dev_openings; /* Space left for more work on device*/ 268 int dev_active; /* Transactions running on the device */ 269 int devq_openings; /* Space left for more queued work */ 270 int devq_queued; /* Transactions queued to be sent */ 271 int held; /* 272 * CCBs held by peripheral drivers 273 * for this device 274 */ 275 int maxtags; /* 276 * Boundary conditions for number of 277 * tagged operations 278 */ 279 int mintags; 280 struct timeval last_reset; /* Time of last bus reset/loop init */ 281 }; 282 283 typedef enum { 284 CAM_GDEVLIST_LAST_DEVICE, 285 CAM_GDEVLIST_LIST_CHANGED, 286 CAM_GDEVLIST_MORE_DEVS, 287 CAM_GDEVLIST_ERROR 288 } ccb_getdevlist_status_e; 289 290 struct ccb_getdevlist { 291 struct ccb_hdr ccb_h; 292 char periph_name[DEV_IDLEN]; 293 u_int32_t unit_number; 294 unsigned int generation; 295 u_int32_t index; 296 ccb_getdevlist_status_e status; 297 }; 298 299 typedef enum { 300 PERIPH_MATCH_NONE = 0x000, 301 PERIPH_MATCH_PATH = 0x001, 302 PERIPH_MATCH_TARGET = 0x002, 303 PERIPH_MATCH_LUN = 0x004, 304 PERIPH_MATCH_NAME = 0x008, 305 PERIPH_MATCH_UNIT = 0x010, 306 PERIPH_MATCH_ANY = 0x01f 307 } periph_pattern_flags; 308 309 struct periph_match_pattern { 310 char periph_name[DEV_IDLEN]; 311 u_int32_t unit_number; 312 path_id_t path_id; 313 target_id_t target_id; 314 lun_id_t target_lun; 315 periph_pattern_flags flags; 316 }; 317 318 typedef enum { 319 DEV_MATCH_NONE = 0x000, 320 DEV_MATCH_PATH = 0x001, 321 DEV_MATCH_TARGET = 0x002, 322 DEV_MATCH_LUN = 0x004, 323 DEV_MATCH_INQUIRY = 0x008, 324 DEV_MATCH_ANY = 0x00f 325 } dev_pattern_flags; 326 327 struct device_match_pattern { 328 path_id_t path_id; 329 target_id_t target_id; 330 lun_id_t target_lun; 331 struct scsi_static_inquiry_pattern inq_pat; 332 dev_pattern_flags flags; 333 }; 334 335 typedef enum { 336 BUS_MATCH_NONE = 0x000, 337 BUS_MATCH_PATH = 0x001, 338 BUS_MATCH_NAME = 0x002, 339 BUS_MATCH_UNIT = 0x004, 340 BUS_MATCH_BUS_ID = 0x008, 341 BUS_MATCH_ANY = 0x00f 342 } bus_pattern_flags; 343 344 struct bus_match_pattern { 345 path_id_t path_id; 346 char dev_name[DEV_IDLEN]; 347 u_int32_t unit_number; 348 u_int32_t bus_id; 349 bus_pattern_flags flags; 350 }; 351 352 union match_pattern { 353 struct periph_match_pattern periph_pattern; 354 struct device_match_pattern device_pattern; 355 struct bus_match_pattern bus_pattern; 356 }; 357 358 typedef enum { 359 DEV_MATCH_PERIPH, 360 DEV_MATCH_DEVICE, 361 DEV_MATCH_BUS 362 } dev_match_type; 363 364 struct dev_match_pattern { 365 dev_match_type type; 366 union match_pattern pattern; 367 }; 368 369 struct periph_match_result { 370 char periph_name[DEV_IDLEN]; 371 u_int32_t unit_number; 372 path_id_t path_id; 373 target_id_t target_id; 374 lun_id_t target_lun; 375 }; 376 377 typedef enum { 378 DEV_RESULT_NOFLAG = 0x00, 379 DEV_RESULT_UNCONFIGURED = 0x01 380 } dev_result_flags; 381 382 struct device_match_result { 383 path_id_t path_id; 384 target_id_t target_id; 385 lun_id_t target_lun; 386 struct scsi_inquiry_data inq_data; 387 dev_result_flags flags; 388 }; 389 390 struct bus_match_result { 391 path_id_t path_id; 392 char dev_name[DEV_IDLEN]; 393 u_int32_t unit_number; 394 u_int32_t bus_id; 395 }; 396 397 union match_result { 398 struct periph_match_result periph_result; 399 struct device_match_result device_result; 400 struct bus_match_result bus_result; 401 }; 402 403 struct dev_match_result { 404 dev_match_type type; 405 union match_result result; 406 }; 407 408 typedef enum { 409 CAM_DEV_MATCH_LAST, 410 CAM_DEV_MATCH_MORE, 411 CAM_DEV_MATCH_LIST_CHANGED, 412 CAM_DEV_MATCH_SIZE_ERROR, 413 CAM_DEV_MATCH_ERROR 414 } ccb_dev_match_status; 415 416 typedef enum { 417 CAM_DEV_POS_NONE = 0x000, 418 CAM_DEV_POS_BUS = 0x001, 419 CAM_DEV_POS_TARGET = 0x002, 420 CAM_DEV_POS_DEVICE = 0x004, 421 CAM_DEV_POS_PERIPH = 0x008, 422 CAM_DEV_POS_PDPTR = 0x010, 423 CAM_DEV_POS_TYPEMASK = 0xf00, 424 CAM_DEV_POS_EDT = 0x100, 425 CAM_DEV_POS_PDRV = 0x200 426 } dev_pos_type; 427 428 struct ccb_dm_cookie { 429 void *bus; 430 void *target; 431 void *device; 432 void *periph; 433 void *pdrv; 434 }; 435 436 struct ccb_dev_position { 437 u_int generations[4]; 438 #define CAM_BUS_GENERATION 0x00 439 #define CAM_TARGET_GENERATION 0x01 440 #define CAM_DEV_GENERATION 0x02 441 #define CAM_PERIPH_GENERATION 0x03 442 dev_pos_type position_type; 443 struct ccb_dm_cookie cookie; 444 }; 445 446 struct ccb_dev_match { 447 struct ccb_hdr ccb_h; 448 ccb_dev_match_status status; 449 u_int32_t num_patterns; 450 u_int32_t pattern_buf_len; 451 struct dev_match_pattern *patterns; 452 u_int32_t num_matches; 453 u_int32_t match_buf_len; 454 struct dev_match_result *matches; 455 struct ccb_dev_position pos; 456 }; 457 458 /* 459 * Definitions for the path inquiry CCB fields. 460 */ 461 #define CAM_VERSION 0x14 /* Hex value for current version */ 462 463 typedef enum { 464 PI_MDP_ABLE = 0x80, /* Supports MDP message */ 465 PI_WIDE_32 = 0x40, /* Supports 32 bit wide SCSI */ 466 PI_WIDE_16 = 0x20, /* Supports 16 bit wide SCSI */ 467 PI_SDTR_ABLE = 0x10, /* Supports SDTR message */ 468 PI_LINKED_CDB = 0x08, /* Supports linked CDBs */ 469 PI_TAG_ABLE = 0x02, /* Supports tag queue messages */ 470 PI_SOFT_RST = 0x01 /* Supports soft reset alternative */ 471 } pi_inqflag; 472 473 typedef enum { 474 PIT_PROCESSOR = 0x80, /* Target mode processor mode */ 475 PIT_PHASE = 0x40, /* Target mode phase cog. mode */ 476 PIT_DISCONNECT = 0x20, /* Disconnects supported in target mode */ 477 PIT_TERM_IO = 0x10, /* Terminate I/O message supported in TM */ 478 PIT_GRP_6 = 0x08, /* Group 6 commands supported */ 479 PIT_GRP_7 = 0x04 /* Group 7 commands supported */ 480 } pi_tmflag; 481 482 typedef enum { 483 PIM_SCANHILO = 0x80, /* Bus scans from high ID to low ID */ 484 PIM_NOREMOVE = 0x40, /* Removeable devices not included in scan */ 485 PIM_NOINITIATOR = 0x20, /* Initiator role not supported. */ 486 PIM_NOBUSRESET = 0x10, /* User has disabled initial BUS RESET */ 487 PIM_NO_6_BYTE = 0x08, /* Do not send 6-byte commands */ 488 PIM_SEQSCAN = 0x04 /* Do bus scans sequentially, not in parallel */ 489 } pi_miscflag; 490 491 /* Path Inquiry CCB */ 492 struct ccb_pathinq { 493 struct ccb_hdr ccb_h; 494 u_int8_t version_num; /* Version number for the SIM/HBA */ 495 u_int8_t hba_inquiry; /* Mimic of INQ byte 7 for the HBA */ 496 u_int8_t target_sprt; /* Flags for target mode support */ 497 u_int8_t hba_misc; /* Misc HBA features */ 498 u_int16_t hba_eng_cnt; /* HBA engine count */ 499 /* Vendor Unique capabilities */ 500 u_int8_t vuhba_flags[VUHBALEN]; 501 u_int32_t max_target; /* Maximum supported Target */ 502 u_int32_t max_lun; /* Maximum supported Lun */ 503 u_int32_t async_flags; /* Installed Async handlers */ 504 path_id_t hpath_id; /* Highest Path ID in the subsystem */ 505 target_id_t initiator_id; /* ID of the HBA on the SCSI bus */ 506 char sim_vid[SIM_IDLEN]; /* Vendor ID of the SIM */ 507 char hba_vid[HBA_IDLEN]; /* Vendor ID of the HBA */ 508 char dev_name[DEV_IDLEN];/* Device name for SIM */ 509 u_int32_t unit_number; /* Unit number for SIM */ 510 u_int32_t bus_id; /* Bus ID for SIM */ 511 u_int32_t base_transfer_speed;/* Base bus speed in KB/sec */ 512 }; 513 514 /* Path Statistics CCB */ 515 struct ccb_pathstats { 516 struct ccb_hdr ccb_h; 517 struct timeval last_reset; /* Time of last bus reset/loop init */ 518 }; 519 520 typedef union { 521 u_int8_t *sense_ptr; /* 522 * Pointer to storage 523 * for sense information 524 */ 525 /* Storage Area for sense information */ 526 struct scsi_sense_data sense_buf; 527 } sense_t; 528 529 typedef union { 530 u_int8_t *cdb_ptr; /* Pointer to the CDB bytes to send */ 531 /* Area for the CDB send */ 532 u_int8_t cdb_bytes[IOCDBLEN]; 533 } cdb_t; 534 535 /* 536 * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO 537 * function codes. 538 */ 539 struct ccb_scsiio { 540 struct ccb_hdr ccb_h; 541 union ccb *next_ccb; /* Ptr for next CCB for action */ 542 u_int8_t *req_map; /* Ptr to mapping info */ 543 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */ 544 u_int32_t dxfer_len; /* Data transfer length */ 545 /* Autosense storage */ 546 struct scsi_sense_data sense_data; 547 u_int8_t sense_len; /* Number of bytes to autosense */ 548 u_int8_t cdb_len; /* Number of bytes for the CDB */ 549 u_int16_t sglist_cnt; /* Number of SG list entries */ 550 u_int8_t scsi_status; /* Returned SCSI status */ 551 u_int8_t sense_resid; /* Autosense resid length: 2's comp */ 552 u_int32_t resid; /* Transfer residual length: 2's comp */ 553 cdb_t cdb_io; /* Union for CDB bytes/pointer */ 554 u_int8_t *msg_ptr; /* Pointer to the message buffer */ 555 u_int16_t msg_len; /* Number of bytes for the Message */ 556 u_int8_t tag_action; /* What to do for tag queueing */ 557 /* 558 * The tag action should be either the define below (to send a 559 * non-tagged transaction) or one of the defined scsi tag messages 560 * from scsi_message.h. 561 */ 562 #define CAM_TAG_ACTION_NONE 0x00 563 u_int tag_id; /* tag id from initator (target mode) */ 564 u_int init_id; /* initiator id of who selected */ 565 }; 566 567 struct ccb_accept_tio { 568 struct ccb_hdr ccb_h; 569 cdb_t cdb_io; /* Union for CDB bytes/pointer */ 570 u_int8_t cdb_len; /* Number of bytes for the CDB */ 571 u_int8_t tag_action; /* What to do for tag queueing */ 572 u_int8_t sense_len; /* Number of bytes of Sense Data */ 573 u_int tag_id; /* tag id from initator (target mode) */ 574 u_int init_id; /* initiator id of who selected */ 575 struct scsi_sense_data sense_data; 576 }; 577 578 /* Release SIM Queue */ 579 struct ccb_relsim { 580 struct ccb_hdr ccb_h; 581 u_int32_t release_flags; 582 #define RELSIM_ADJUST_OPENINGS 0x01 583 #define RELSIM_RELEASE_AFTER_TIMEOUT 0x02 584 #define RELSIM_RELEASE_AFTER_CMDCMPLT 0x04 585 #define RELSIM_RELEASE_AFTER_QEMPTY 0x08 586 u_int32_t openings; 587 u_int32_t release_timeout; 588 u_int32_t qfrozen_cnt; 589 }; 590 591 /* 592 * Definitions for the asynchronous callback CCB fields. 593 */ 594 typedef enum { 595 AC_GETDEV_CHANGED = 0x800,/* Getdev info might have changed */ 596 AC_INQ_CHANGED = 0x400,/* Inquiry info might have changed */ 597 AC_TRANSFER_NEG = 0x200,/* New transfer settings in effect */ 598 AC_LOST_DEVICE = 0x100,/* A device went away */ 599 AC_FOUND_DEVICE = 0x080,/* A new device was found */ 600 AC_PATH_DEREGISTERED = 0x040,/* A path has de-registered */ 601 AC_PATH_REGISTERED = 0x020,/* A new path has been registered */ 602 AC_SENT_BDR = 0x010,/* A BDR message was sent to target */ 603 AC_SCSI_AEN = 0x008,/* A SCSI AEN has been received */ 604 AC_UNSOL_RESEL = 0x002,/* Unsolicited reselection occurred */ 605 AC_BUS_RESET = 0x001 /* A SCSI bus reset occurred */ 606 } ac_code; 607 608 typedef void ac_callback_t (void *softc, u_int32_t code, 609 struct cam_path *path, void *args); 610 611 /* Set Asynchronous Callback CCB */ 612 struct ccb_setasync { 613 struct ccb_hdr ccb_h; 614 u_int32_t event_enable; /* Async Event enables */ 615 ac_callback_t *callback; 616 void *callback_arg; 617 }; 618 619 /* Set Device Type CCB */ 620 struct ccb_setdev { 621 struct ccb_hdr ccb_h; 622 u_int8_t dev_type; /* Value for dev type field in EDT */ 623 }; 624 625 /* SCSI Control Functions */ 626 627 /* Abort XPT request CCB */ 628 struct ccb_abort { 629 struct ccb_hdr ccb_h; 630 union ccb *abort_ccb; /* Pointer to CCB to abort */ 631 }; 632 633 /* Reset SCSI Bus CCB */ 634 struct ccb_resetbus { 635 struct ccb_hdr ccb_h; 636 }; 637 638 /* Reset SCSI Device CCB */ 639 struct ccb_resetdev { 640 struct ccb_hdr ccb_h; 641 }; 642 643 /* Terminate I/O Process Request CCB */ 644 struct ccb_termio { 645 struct ccb_hdr ccb_h; 646 union ccb *termio_ccb; /* Pointer to CCB to terminate */ 647 }; 648 649 /* Get/Set transfer rate/width/disconnection/tag queueing settings */ 650 struct ccb_trans_settings { 651 struct ccb_hdr ccb_h; 652 u_int valid; /* Which fields to honor */ 653 #define CCB_TRANS_SYNC_RATE_VALID 0x01 654 #define CCB_TRANS_SYNC_OFFSET_VALID 0x02 655 #define CCB_TRANS_BUS_WIDTH_VALID 0x04 656 #define CCB_TRANS_DISC_VALID 0x08 657 #define CCB_TRANS_TQ_VALID 0x10 658 u_int flags; 659 #define CCB_TRANS_CURRENT_SETTINGS 0x01 660 #define CCB_TRANS_USER_SETTINGS 0x02 661 #define CCB_TRANS_DISC_ENB 0x04 662 #define CCB_TRANS_TAG_ENB 0x08 663 u_int sync_period; 664 u_int sync_offset; 665 u_int bus_width; 666 }; 667 668 /* 669 * Calculate the geometry parameters for a device 670 * give the block size and volume size in blocks. 671 */ 672 struct ccb_calc_geometry { 673 struct ccb_hdr ccb_h; 674 u_int32_t block_size; 675 u_int32_t volume_size; 676 u_int16_t cylinders; 677 u_int8_t heads; 678 u_int8_t secs_per_track; 679 }; 680 681 /* 682 * Rescan the given bus, or bus/target/lun 683 */ 684 struct ccb_rescan { 685 struct ccb_hdr ccb_h; 686 cam_flags flags; 687 }; 688 689 /* 690 * Turn on debugging for the given bus, bus/target, or bus/target/lun. 691 */ 692 struct ccb_debug { 693 struct ccb_hdr ccb_h; 694 cam_debug_flags flags; 695 }; 696 697 /* Target mode structures. */ 698 699 struct ccb_en_lun { 700 struct ccb_hdr ccb_h; 701 u_int16_t grp6_len; /* Group 6 VU CDB length */ 702 u_int16_t grp7_len; /* Group 7 VU CDB length */ 703 u_int8_t enable; 704 }; 705 706 struct ccb_immed_notify { 707 struct ccb_hdr ccb_h; 708 struct scsi_sense_data sense_data; 709 u_int8_t sense_len; /* Number of bytes in sense buffer */ 710 u_int8_t initiator_id; /* Id of initiator that selected */ 711 u_int8_t message_args[7]; /* Message Arguments */ 712 }; 713 714 struct ccb_notify_ack { 715 struct ccb_hdr ccb_h; 716 u_int16_t seq_id; /* Sequence identifier */ 717 u_int8_t event; /* Event flags */ 718 }; 719 720 /* HBA engine structures. */ 721 722 typedef enum { 723 EIT_BUFFER, /* Engine type: buffer memory */ 724 EIT_LOSSLESS, /* Engine type: lossless compression */ 725 EIT_LOSSY, /* Engine type: lossy compression */ 726 EIT_ENCRYPT /* Engine type: encryption */ 727 } ei_type; 728 729 typedef enum { 730 EAD_VUNIQUE, /* Engine algorithm ID: vendor unique */ 731 EAD_LZ1V1, /* Engine algorithm ID: LZ1 var.1 */ 732 EAD_LZ2V1, /* Engine algorithm ID: LZ2 var.1 */ 733 EAD_LZ2V2 /* Engine algorithm ID: LZ2 var.2 */ 734 } ei_algo; 735 736 struct ccb_eng_inq { 737 struct ccb_hdr ccb_h; 738 u_int16_t eng_num; /* The engine number for this inquiry */ 739 ei_type eng_type; /* Returned engine type */ 740 ei_algo eng_algo; /* Returned engine algorithm type */ 741 u_int32_t eng_memeory; /* Returned engine memory size */ 742 }; 743 744 struct ccb_eng_exec { /* This structure must match SCSIIO size */ 745 struct ccb_hdr ccb_h; 746 u_int8_t *pdrv_ptr; /* Ptr used by the peripheral driver */ 747 u_int8_t *req_map; /* Ptr for mapping info on the req. */ 748 u_int8_t *data_ptr; /* Pointer to the data buf/SG list */ 749 u_int32_t dxfer_len; /* Data transfer length */ 750 u_int8_t *engdata_ptr; /* Pointer to the engine buffer data */ 751 u_int16_t sglist_cnt; /* Num of scatter gather list entries */ 752 u_int32_t dmax_len; /* Destination data maximum length */ 753 u_int32_t dest_len; /* Destination data length */ 754 int32_t src_resid; /* Source residual length: 2's comp */ 755 u_int32_t timeout; /* Timeout value */ 756 u_int16_t eng_num; /* Engine number for this request */ 757 u_int16_t vu_flags; /* Vendor Unique flags */ 758 }; 759 760 /* 761 * Definitions for the timeout field in the SCSI I/O CCB. 762 */ 763 #define CAM_TIME_DEFAULT 0x00000000 /* Use SIM default value */ 764 #define CAM_TIME_INFINITY 0xFFFFFFFF /* Infinite timeout */ 765 766 #define CAM_SUCCESS 0 /* For signaling general success */ 767 #define CAM_FAILURE 1 /* For signaling general failure */ 768 769 #define CAM_FALSE 0 770 #define CAM_TRUE 1 771 772 #define XPT_CCB_INVALID -1 /* for signaling a bad CCB to free */ 773 774 /* 775 * Union of all CCB types for kernel space allocation. This union should 776 * never be used for manipulating CCBs - its only use is for the allocation 777 * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc 778 * and the argument to xpt_ccb_free. 779 */ 780 union ccb { 781 struct ccb_hdr ccb_h; /* For convenience */ 782 struct ccb_scsiio csio; 783 struct ccb_getdev cgd; 784 struct ccb_getdevlist cgdl; 785 struct ccb_pathinq cpi; 786 struct ccb_relsim crs; 787 struct ccb_setasync csa; 788 struct ccb_setdev csd; 789 struct ccb_pathstats cpis; 790 struct ccb_getdevstats cgds; 791 struct ccb_dev_match cdm; 792 struct ccb_trans_settings cts; 793 struct ccb_calc_geometry ccg; 794 struct ccb_abort cab; 795 struct ccb_resetbus crb; 796 struct ccb_resetdev crd; 797 struct ccb_termio tio; 798 struct ccb_accept_tio atio; 799 struct ccb_scsiio ctio; 800 struct ccb_en_lun cel; 801 struct ccb_immed_notify cin; 802 struct ccb_notify_ack cna; 803 struct ccb_eng_inq cei; 804 struct ccb_eng_exec cee; 805 struct ccb_rescan crcn; 806 struct ccb_debug cdbg; 807 }; 808 809 __BEGIN_DECLS 810 static __inline void 811 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries, 812 void (*cbfcnp)(struct cam_periph *, union ccb *), 813 u_int32_t flags, u_int8_t tag_action, 814 u_int8_t *data_ptr, u_int32_t dxfer_len, 815 u_int8_t sense_len, u_int8_t cdb_len, 816 u_int32_t timeout); 817 818 static __inline void 819 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries, 820 void (*cbfcnp)(struct cam_periph *, union ccb *), 821 u_int32_t flags, u_int tag_action, u_int tag_id, 822 u_int init_id, u_int scsi_status, u_int8_t *data_ptr, 823 u_int32_t dxfer_len, u_int32_t timeout); 824 825 static __inline void 826 cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries, 827 void (*cbfcnp)(struct cam_periph *, union ccb *), 828 u_int32_t flags, u_int8_t tag_action, 829 u_int8_t *data_ptr, u_int32_t dxfer_len, 830 u_int8_t sense_len, u_int8_t cdb_len, 831 u_int32_t timeout) 832 { 833 csio->ccb_h.func_code = XPT_SCSI_IO; 834 csio->ccb_h.flags = flags; 835 csio->ccb_h.retry_count = retries; 836 csio->ccb_h.cbfcnp = cbfcnp; 837 csio->ccb_h.timeout = timeout; 838 csio->data_ptr = data_ptr; 839 csio->dxfer_len = dxfer_len; 840 csio->sense_len = sense_len; 841 csio->cdb_len = cdb_len; 842 csio->tag_action = tag_action; 843 } 844 845 static __inline void 846 cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries, 847 void (*cbfcnp)(struct cam_periph *, union ccb *), 848 u_int32_t flags, u_int tag_action, u_int tag_id, 849 u_int init_id, u_int scsi_status, u_int8_t *data_ptr, 850 u_int32_t dxfer_len, u_int32_t timeout) 851 { 852 csio->ccb_h.func_code = XPT_CONT_TARGET_IO; 853 csio->ccb_h.flags = flags; 854 csio->ccb_h.retry_count = retries; 855 csio->ccb_h.cbfcnp = cbfcnp; 856 csio->ccb_h.timeout = timeout; 857 csio->data_ptr = data_ptr; 858 csio->dxfer_len = dxfer_len; 859 csio->scsi_status = scsi_status; 860 csio->tag_action = tag_action; 861 csio->tag_id = tag_id; 862 csio->init_id = init_id; 863 } 864 865 __END_DECLS 866 867 #endif /* _CAM_CAM_CCB_H */
Cache object: 0d7f5112894b0f46b4c9564780af1fb9
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]