cam_ccb.h revision 292348
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: stable/10/sys/cam/cam_ccb.h 292348 2015-12-16 19:01:14Z ken $ 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#include <sys/limits.h> 38#ifndef _KERNEL 39#include <sys/callout.h> 40#endif 41#include <cam/cam_debug.h> 42#include <cam/scsi/scsi_all.h> 43#include <cam/ata/ata_all.h> 44 45/* General allocation length definitions for CCB structures */ 46#define IOCDBLEN CAM_MAX_CDBLEN /* Space for CDB bytes/pointer */ 47#define VUHBALEN 14 /* Vendor Unique HBA length */ 48#define SIM_IDLEN 16 /* ASCII string len for SIM ID */ 49#define HBA_IDLEN 16 /* ASCII string len for HBA ID */ 50#define DEV_IDLEN 16 /* ASCII string len for device names */ 51#define CCB_PERIPH_PRIV_SIZE 2 /* size of peripheral private area */ 52#define CCB_SIM_PRIV_SIZE 2 /* size of sim private area */ 53 54/* Struct definitions for CAM control blocks */ 55 56/* Common CCB header */ 57/* CAM CCB flags */ 58typedef enum { 59 CAM_CDB_POINTER = 0x00000001,/* The CDB field is a pointer */ 60 CAM_QUEUE_ENABLE = 0x00000002,/* SIM queue actions are enabled */ 61 CAM_CDB_LINKED = 0x00000004,/* CCB contains a linked CDB */ 62 CAM_NEGOTIATE = 0x00000008,/* 63 * Perform transport negotiation 64 * with this command. 65 */ 66 CAM_DATA_ISPHYS = 0x00000010,/* Data type with physical addrs */ 67 CAM_DIS_AUTOSENSE = 0x00000020,/* Disable autosense feature */ 68 CAM_DIR_BOTH = 0x00000000,/* Data direction (00:IN/OUT) */ 69 CAM_DIR_IN = 0x00000040,/* Data direction (01:DATA IN) */ 70 CAM_DIR_OUT = 0x00000080,/* Data direction (10:DATA OUT) */ 71 CAM_DIR_NONE = 0x000000C0,/* Data direction (11:no data) */ 72 CAM_DIR_MASK = 0x000000C0,/* Data direction Mask */ 73 CAM_DATA_VADDR = 0x00000000,/* Data type (000:Virtual) */ 74 CAM_DATA_PADDR = 0x00000010,/* Data type (001:Physical) */ 75 CAM_DATA_SG = 0x00040000,/* Data type (010:sglist) */ 76 CAM_DATA_SG_PADDR = 0x00040010,/* Data type (011:sglist phys) */ 77 CAM_DATA_BIO = 0x00200000,/* Data type (100:bio) */ 78 CAM_DATA_MASK = 0x00240010,/* Data type mask */ 79 CAM_SOFT_RST_OP = 0x00000100,/* Use Soft reset alternative */ 80 CAM_ENG_SYNC = 0x00000200,/* Flush resid bytes on complete */ 81 CAM_DEV_QFRZDIS = 0x00000400,/* Disable DEV Q freezing */ 82 CAM_DEV_QFREEZE = 0x00000800,/* Freeze DEV Q on execution */ 83 CAM_HIGH_POWER = 0x00001000,/* Command takes a lot of power */ 84 CAM_SENSE_PTR = 0x00002000,/* Sense data is a pointer */ 85 CAM_SENSE_PHYS = 0x00004000,/* Sense pointer is physical addr*/ 86 CAM_TAG_ACTION_VALID = 0x00008000,/* Use the tag action in this ccb*/ 87 CAM_PASS_ERR_RECOVER = 0x00010000,/* Pass driver does err. recovery*/ 88 CAM_DIS_DISCONNECT = 0x00020000,/* Disable disconnect */ 89 CAM_MSG_BUF_PHYS = 0x00080000,/* Message buffer ptr is physical*/ 90 CAM_SNS_BUF_PHYS = 0x00100000,/* Autosense data ptr is physical*/ 91 CAM_CDB_PHYS = 0x00400000,/* CDB poiner is physical */ 92 CAM_ENG_SGLIST = 0x00800000,/* SG list is for the HBA engine */ 93 94/* Phase cognizant mode flags */ 95 CAM_DIS_AUTOSRP = 0x01000000,/* Disable autosave/restore ptrs */ 96 CAM_DIS_AUTODISC = 0x02000000,/* Disable auto disconnect */ 97 CAM_TGT_CCB_AVAIL = 0x04000000,/* Target CCB available */ 98 CAM_TGT_PHASE_MODE = 0x08000000,/* The SIM runs in phase mode */ 99 CAM_MSGB_VALID = 0x10000000,/* Message buffer valid */ 100 CAM_STATUS_VALID = 0x20000000,/* Status buffer valid */ 101 CAM_DATAB_VALID = 0x40000000,/* Data buffer valid */ 102 103/* Host target Mode flags */ 104 CAM_SEND_SENSE = 0x08000000,/* Send sense data with status */ 105 CAM_TERM_IO = 0x10000000,/* Terminate I/O Message sup. */ 106 CAM_DISCONNECT = 0x20000000,/* Disconnects are mandatory */ 107 CAM_SEND_STATUS = 0x40000000,/* Send status after data phase */ 108 109 CAM_UNLOCKED = 0x80000000 /* Call callback without lock. */ 110} ccb_flags; 111 112typedef enum { 113 CAM_EXTLUN_VALID = 0x00000001,/* 64bit lun field is valid */ 114 CAM_USER_DATA_ADDR = 0x00000002,/* Userspace data pointers */ 115 CAM_SG_FORMAT_IOVEC = 0x00000004,/* iovec instead of busdma S/G*/ 116 CAM_UNMAPPED_BUF = 0x00000008 /* use unmapped I/O */ 117} ccb_xflags; 118 119/* XPT Opcodes for xpt_action */ 120typedef enum { 121/* Function code flags are bits greater than 0xff */ 122 XPT_FC_QUEUED = 0x100, 123 /* Non-immediate function code */ 124 XPT_FC_USER_CCB = 0x200, 125 XPT_FC_XPT_ONLY = 0x400, 126 /* Only for the transport layer device */ 127 XPT_FC_DEV_QUEUED = 0x800 | XPT_FC_QUEUED, 128 /* Passes through the device queues */ 129/* Common function commands: 0x00->0x0F */ 130 XPT_NOOP = 0x00, 131 /* Execute Nothing */ 132 XPT_SCSI_IO = 0x01 | XPT_FC_DEV_QUEUED, 133 /* Execute the requested I/O operation */ 134 XPT_GDEV_TYPE = 0x02, 135 /* Get type information for specified device */ 136 XPT_GDEVLIST = 0x03, 137 /* Get a list of peripheral devices */ 138 XPT_PATH_INQ = 0x04, 139 /* Path routing inquiry */ 140 XPT_REL_SIMQ = 0x05, 141 /* Release a frozen device queue */ 142 XPT_SASYNC_CB = 0x06, 143 /* Set Asynchronous Callback Parameters */ 144 XPT_SDEV_TYPE = 0x07, 145 /* Set device type information */ 146 XPT_SCAN_BUS = 0x08 | XPT_FC_QUEUED | XPT_FC_USER_CCB 147 | XPT_FC_XPT_ONLY, 148 /* (Re)Scan the SCSI Bus */ 149 XPT_DEV_MATCH = 0x09 | XPT_FC_XPT_ONLY, 150 /* Get EDT entries matching the given pattern */ 151 XPT_DEBUG = 0x0a, 152 /* Turn on debugging for a bus, target or lun */ 153 XPT_PATH_STATS = 0x0b, 154 /* Path statistics (error counts, etc.) */ 155 XPT_GDEV_STATS = 0x0c, 156 /* Device statistics (error counts, etc.) */ 157 XPT_DEV_ADVINFO = 0x0e, 158 /* Get/Set Device advanced information */ 159 XPT_ASYNC = 0x0f | XPT_FC_QUEUED | XPT_FC_USER_CCB 160 | XPT_FC_XPT_ONLY, 161 /* Asynchronous event */ 162/* SCSI Control Functions: 0x10->0x1F */ 163 XPT_ABORT = 0x10, 164 /* Abort the specified CCB */ 165 XPT_RESET_BUS = 0x11 | XPT_FC_XPT_ONLY, 166 /* Reset the specified SCSI bus */ 167 XPT_RESET_DEV = 0x12 | XPT_FC_DEV_QUEUED, 168 /* Bus Device Reset the specified SCSI device */ 169 XPT_TERM_IO = 0x13, 170 /* Terminate the I/O process */ 171 XPT_SCAN_LUN = 0x14 | XPT_FC_QUEUED | XPT_FC_USER_CCB 172 | XPT_FC_XPT_ONLY, 173 /* Scan Logical Unit */ 174 XPT_GET_TRAN_SETTINGS = 0x15, 175 /* 176 * Get default/user transfer settings 177 * for the target 178 */ 179 XPT_SET_TRAN_SETTINGS = 0x16, 180 /* 181 * Set transfer rate/width 182 * negotiation settings 183 */ 184 XPT_CALC_GEOMETRY = 0x17, 185 /* 186 * Calculate the geometry parameters for 187 * a device give the sector size and 188 * volume size. 189 */ 190 XPT_ATA_IO = 0x18 | XPT_FC_DEV_QUEUED, 191 /* Execute the requested ATA I/O operation */ 192 193 XPT_GET_SIM_KNOB = 0x18, 194 /* 195 * Get SIM specific knob values. 196 */ 197 198 XPT_SET_SIM_KNOB = 0x19, 199 /* 200 * Set SIM specific knob values. 201 */ 202 203 XPT_SMP_IO = 0x1b | XPT_FC_DEV_QUEUED, 204 /* Serial Management Protocol */ 205 206 XPT_SCAN_TGT = 0x1E | XPT_FC_QUEUED | XPT_FC_USER_CCB 207 | XPT_FC_XPT_ONLY, 208 /* Scan Target */ 209 210/* HBA engine commands 0x20->0x2F */ 211 XPT_ENG_INQ = 0x20 | XPT_FC_XPT_ONLY, 212 /* HBA engine feature inquiry */ 213 XPT_ENG_EXEC = 0x21 | XPT_FC_DEV_QUEUED, 214 /* HBA execute engine request */ 215 216/* Target mode commands: 0x30->0x3F */ 217 XPT_EN_LUN = 0x30, 218 /* Enable LUN as a target */ 219 XPT_TARGET_IO = 0x31 | XPT_FC_DEV_QUEUED, 220 /* Execute target I/O request */ 221 XPT_ACCEPT_TARGET_IO = 0x32 | XPT_FC_QUEUED | XPT_FC_USER_CCB, 222 /* Accept Host Target Mode CDB */ 223 XPT_CONT_TARGET_IO = 0x33 | XPT_FC_DEV_QUEUED, 224 /* Continue Host Target I/O Connection */ 225 XPT_IMMED_NOTIFY = 0x34 | XPT_FC_QUEUED | XPT_FC_USER_CCB, 226 /* Notify Host Target driver of event (obsolete) */ 227 XPT_NOTIFY_ACK = 0x35, 228 /* Acknowledgement of event (obsolete) */ 229 XPT_IMMEDIATE_NOTIFY = 0x36 | XPT_FC_QUEUED | XPT_FC_USER_CCB, 230 /* Notify Host Target driver of event */ 231 XPT_NOTIFY_ACKNOWLEDGE = 0x37 | XPT_FC_QUEUED | XPT_FC_USER_CCB, 232 /* Acknowledgement of event */ 233 234/* Vendor Unique codes: 0x80->0x8F */ 235 XPT_VUNIQUE = 0x80 236} xpt_opcode; 237 238#define XPT_FC_GROUP_MASK 0xF0 239#define XPT_FC_GROUP(op) ((op) & XPT_FC_GROUP_MASK) 240#define XPT_FC_GROUP_COMMON 0x00 241#define XPT_FC_GROUP_SCSI_CONTROL 0x10 242#define XPT_FC_GROUP_HBA_ENGINE 0x20 243#define XPT_FC_GROUP_TMODE 0x30 244#define XPT_FC_GROUP_VENDOR_UNIQUE 0x80 245 246#define XPT_FC_IS_DEV_QUEUED(ccb) \ 247 (((ccb)->ccb_h.func_code & XPT_FC_DEV_QUEUED) == XPT_FC_DEV_QUEUED) 248#define XPT_FC_IS_QUEUED(ccb) \ 249 (((ccb)->ccb_h.func_code & XPT_FC_QUEUED) != 0) 250 251typedef enum { 252 PROTO_UNKNOWN, 253 PROTO_UNSPECIFIED, 254 PROTO_SCSI, /* Small Computer System Interface */ 255 PROTO_ATA, /* AT Attachment */ 256 PROTO_ATAPI, /* AT Attachment Packetized Interface */ 257 PROTO_SATAPM, /* SATA Port Multiplier */ 258 PROTO_SEMB, /* SATA Enclosure Management Bridge */ 259} cam_proto; 260 261typedef enum { 262 XPORT_UNKNOWN, 263 XPORT_UNSPECIFIED, 264 XPORT_SPI, /* SCSI Parallel Interface */ 265 XPORT_FC, /* Fiber Channel */ 266 XPORT_SSA, /* Serial Storage Architecture */ 267 XPORT_USB, /* Universal Serial Bus */ 268 XPORT_PPB, /* Parallel Port Bus */ 269 XPORT_ATA, /* AT Attachment */ 270 XPORT_SAS, /* Serial Attached SCSI */ 271 XPORT_SATA, /* Serial AT Attachment */ 272 XPORT_ISCSI, /* iSCSI */ 273 XPORT_SRP, /* SCSI RDMA Protocol */ 274} cam_xport; 275 276#define XPORT_IS_ATA(t) ((t) == XPORT_ATA || (t) == XPORT_SATA) 277#define XPORT_IS_SCSI(t) ((t) != XPORT_UNKNOWN && \ 278 (t) != XPORT_UNSPECIFIED && \ 279 !XPORT_IS_ATA(t)) 280#define XPORT_DEVSTAT_TYPE(t) (XPORT_IS_ATA(t) ? DEVSTAT_TYPE_IF_IDE : \ 281 XPORT_IS_SCSI(t) ? DEVSTAT_TYPE_IF_SCSI : \ 282 DEVSTAT_TYPE_IF_OTHER) 283 284#define PROTO_VERSION_UNKNOWN (UINT_MAX - 1) 285#define PROTO_VERSION_UNSPECIFIED UINT_MAX 286#define XPORT_VERSION_UNKNOWN (UINT_MAX - 1) 287#define XPORT_VERSION_UNSPECIFIED UINT_MAX 288 289typedef union { 290 LIST_ENTRY(ccb_hdr) le; 291 SLIST_ENTRY(ccb_hdr) sle; 292 TAILQ_ENTRY(ccb_hdr) tqe; 293 STAILQ_ENTRY(ccb_hdr) stqe; 294} camq_entry; 295 296typedef union { 297 void *ptr; 298 u_long field; 299 u_int8_t bytes[sizeof(uintptr_t)]; 300} ccb_priv_entry; 301 302typedef union { 303 ccb_priv_entry entries[CCB_PERIPH_PRIV_SIZE]; 304 u_int8_t bytes[CCB_PERIPH_PRIV_SIZE * sizeof(ccb_priv_entry)]; 305} ccb_ppriv_area; 306 307typedef union { 308 ccb_priv_entry entries[CCB_SIM_PRIV_SIZE]; 309 u_int8_t bytes[CCB_SIM_PRIV_SIZE * sizeof(ccb_priv_entry)]; 310} ccb_spriv_area; 311 312typedef struct { 313 struct timeval *etime; 314 uintptr_t sim_data; 315 uintptr_t periph_data; 316} ccb_qos_area; 317 318struct ccb_hdr { 319 cam_pinfo pinfo; /* Info for priority scheduling */ 320 camq_entry xpt_links; /* For chaining in the XPT layer */ 321 camq_entry sim_links; /* For chaining in the SIM layer */ 322 camq_entry periph_links; /* For chaining in the type driver */ 323 u_int32_t retry_count; 324 void (*cbfcnp)(struct cam_periph *, union ccb *); 325 /* Callback on completion function */ 326 xpt_opcode func_code; /* XPT function code */ 327 u_int32_t status; /* Status returned by CAM subsystem */ 328 struct cam_path *path; /* Compiled path for this ccb */ 329 path_id_t path_id; /* Path ID for the request */ 330 target_id_t target_id; /* Target device ID */ 331 lun_id_t target_lun; /* Target LUN number */ 332 lun64_id_t ext_lun; /* 64bit extended/multi-level LUNs */ 333 u_int32_t flags; /* ccb_flags */ 334 u_int32_t xflags; /* Extended flags */ 335 ccb_ppriv_area periph_priv; 336 ccb_spriv_area sim_priv; 337 ccb_qos_area qos; 338 u_int32_t timeout; /* Hard timeout value in mseconds */ 339 struct timeval softtimeout; /* Soft timeout value in sec + usec */ 340}; 341 342/* Get Device Information CCB */ 343struct ccb_getdev { 344 struct ccb_hdr ccb_h; 345 cam_proto protocol; 346 struct scsi_inquiry_data inq_data; 347 struct ata_params ident_data; 348 u_int8_t serial_num[252]; 349 u_int8_t inq_flags; 350 u_int8_t serial_num_len; 351}; 352 353/* Device Statistics CCB */ 354struct ccb_getdevstats { 355 struct ccb_hdr ccb_h; 356 int dev_openings; /* Space left for more work on device*/ 357 int dev_active; /* Transactions running on the device */ 358 int allocated; /* CCBs allocated for the device */ 359 int queued; /* CCBs queued to be sent to the device */ 360 int held; /* 361 * CCBs held by peripheral drivers 362 * for this device 363 */ 364 int maxtags; /* 365 * Boundary conditions for number of 366 * tagged operations 367 */ 368 int mintags; 369 struct timeval last_reset; /* Time of last bus reset/loop init */ 370}; 371 372typedef enum { 373 CAM_GDEVLIST_LAST_DEVICE, 374 CAM_GDEVLIST_LIST_CHANGED, 375 CAM_GDEVLIST_MORE_DEVS, 376 CAM_GDEVLIST_ERROR 377} ccb_getdevlist_status_e; 378 379struct ccb_getdevlist { 380 struct ccb_hdr ccb_h; 381 char periph_name[DEV_IDLEN]; 382 u_int32_t unit_number; 383 unsigned int generation; 384 u_int32_t index; 385 ccb_getdevlist_status_e status; 386}; 387 388typedef enum { 389 PERIPH_MATCH_NONE = 0x000, 390 PERIPH_MATCH_PATH = 0x001, 391 PERIPH_MATCH_TARGET = 0x002, 392 PERIPH_MATCH_LUN = 0x004, 393 PERIPH_MATCH_NAME = 0x008, 394 PERIPH_MATCH_UNIT = 0x010, 395 PERIPH_MATCH_ANY = 0x01f 396} periph_pattern_flags; 397 398struct periph_match_pattern { 399 char periph_name[DEV_IDLEN]; 400 u_int32_t unit_number; 401 path_id_t path_id; 402 target_id_t target_id; 403 lun_id_t target_lun; 404 periph_pattern_flags flags; 405}; 406 407typedef enum { 408 DEV_MATCH_NONE = 0x000, 409 DEV_MATCH_PATH = 0x001, 410 DEV_MATCH_TARGET = 0x002, 411 DEV_MATCH_LUN = 0x004, 412 DEV_MATCH_INQUIRY = 0x008, 413 DEV_MATCH_DEVID = 0x010, 414 DEV_MATCH_ANY = 0x00f 415} dev_pattern_flags; 416 417struct device_id_match_pattern { 418 uint8_t id_len; 419 uint8_t id[256]; 420}; 421 422struct device_match_pattern { 423 path_id_t path_id; 424 target_id_t target_id; 425 lun_id_t target_lun; 426 dev_pattern_flags flags; 427 union { 428 struct scsi_static_inquiry_pattern inq_pat; 429 struct device_id_match_pattern devid_pat; 430 } data; 431}; 432 433typedef enum { 434 BUS_MATCH_NONE = 0x000, 435 BUS_MATCH_PATH = 0x001, 436 BUS_MATCH_NAME = 0x002, 437 BUS_MATCH_UNIT = 0x004, 438 BUS_MATCH_BUS_ID = 0x008, 439 BUS_MATCH_ANY = 0x00f 440} bus_pattern_flags; 441 442struct bus_match_pattern { 443 path_id_t path_id; 444 char dev_name[DEV_IDLEN]; 445 u_int32_t unit_number; 446 u_int32_t bus_id; 447 bus_pattern_flags flags; 448}; 449 450union match_pattern { 451 struct periph_match_pattern periph_pattern; 452 struct device_match_pattern device_pattern; 453 struct bus_match_pattern bus_pattern; 454}; 455 456typedef enum { 457 DEV_MATCH_PERIPH, 458 DEV_MATCH_DEVICE, 459 DEV_MATCH_BUS 460} dev_match_type; 461 462struct dev_match_pattern { 463 dev_match_type type; 464 union match_pattern pattern; 465}; 466 467struct periph_match_result { 468 char periph_name[DEV_IDLEN]; 469 u_int32_t unit_number; 470 path_id_t path_id; 471 target_id_t target_id; 472 lun_id_t target_lun; 473}; 474 475typedef enum { 476 DEV_RESULT_NOFLAG = 0x00, 477 DEV_RESULT_UNCONFIGURED = 0x01 478} dev_result_flags; 479 480struct device_match_result { 481 path_id_t path_id; 482 target_id_t target_id; 483 lun_id_t target_lun; 484 cam_proto protocol; 485 struct scsi_inquiry_data inq_data; 486 struct ata_params ident_data; 487 dev_result_flags flags; 488}; 489 490struct bus_match_result { 491 path_id_t path_id; 492 char dev_name[DEV_IDLEN]; 493 u_int32_t unit_number; 494 u_int32_t bus_id; 495}; 496 497union match_result { 498 struct periph_match_result periph_result; 499 struct device_match_result device_result; 500 struct bus_match_result bus_result; 501}; 502 503struct dev_match_result { 504 dev_match_type type; 505 union match_result result; 506}; 507 508typedef enum { 509 CAM_DEV_MATCH_LAST, 510 CAM_DEV_MATCH_MORE, 511 CAM_DEV_MATCH_LIST_CHANGED, 512 CAM_DEV_MATCH_SIZE_ERROR, 513 CAM_DEV_MATCH_ERROR 514} ccb_dev_match_status; 515 516typedef enum { 517 CAM_DEV_POS_NONE = 0x000, 518 CAM_DEV_POS_BUS = 0x001, 519 CAM_DEV_POS_TARGET = 0x002, 520 CAM_DEV_POS_DEVICE = 0x004, 521 CAM_DEV_POS_PERIPH = 0x008, 522 CAM_DEV_POS_PDPTR = 0x010, 523 CAM_DEV_POS_TYPEMASK = 0xf00, 524 CAM_DEV_POS_EDT = 0x100, 525 CAM_DEV_POS_PDRV = 0x200 526} dev_pos_type; 527 528struct ccb_dm_cookie { 529 void *bus; 530 void *target; 531 void *device; 532 void *periph; 533 void *pdrv; 534}; 535 536struct ccb_dev_position { 537 u_int generations[4]; 538#define CAM_BUS_GENERATION 0x00 539#define CAM_TARGET_GENERATION 0x01 540#define CAM_DEV_GENERATION 0x02 541#define CAM_PERIPH_GENERATION 0x03 542 dev_pos_type position_type; 543 struct ccb_dm_cookie cookie; 544}; 545 546struct ccb_dev_match { 547 struct ccb_hdr ccb_h; 548 ccb_dev_match_status status; 549 u_int32_t num_patterns; 550 u_int32_t pattern_buf_len; 551 struct dev_match_pattern *patterns; 552 u_int32_t num_matches; 553 u_int32_t match_buf_len; 554 struct dev_match_result *matches; 555 struct ccb_dev_position pos; 556}; 557 558/* 559 * Definitions for the path inquiry CCB fields. 560 */ 561#define CAM_VERSION 0x18 /* Hex value for current version */ 562 563typedef enum { 564 PI_MDP_ABLE = 0x80, /* Supports MDP message */ 565 PI_WIDE_32 = 0x40, /* Supports 32 bit wide SCSI */ 566 PI_WIDE_16 = 0x20, /* Supports 16 bit wide SCSI */ 567 PI_SDTR_ABLE = 0x10, /* Supports SDTR message */ 568 PI_LINKED_CDB = 0x08, /* Supports linked CDBs */ 569 PI_SATAPM = 0x04, /* Supports SATA PM */ 570 PI_TAG_ABLE = 0x02, /* Supports tag queue messages */ 571 PI_SOFT_RST = 0x01 /* Supports soft reset alternative */ 572} pi_inqflag; 573 574typedef enum { 575 PIT_PROCESSOR = 0x80, /* Target mode processor mode */ 576 PIT_PHASE = 0x40, /* Target mode phase cog. mode */ 577 PIT_DISCONNECT = 0x20, /* Disconnects supported in target mode */ 578 PIT_TERM_IO = 0x10, /* Terminate I/O message supported in TM */ 579 PIT_GRP_6 = 0x08, /* Group 6 commands supported */ 580 PIT_GRP_7 = 0x04 /* Group 7 commands supported */ 581} pi_tmflag; 582 583typedef enum { 584 PIM_EXTLUNS = 0x100,/* 64bit extended LUNs supported */ 585 PIM_SCANHILO = 0x80, /* Bus scans from high ID to low ID */ 586 PIM_NOREMOVE = 0x40, /* Removeable devices not included in scan */ 587 PIM_NOINITIATOR = 0x20, /* Initiator role not supported. */ 588 PIM_NOBUSRESET = 0x10, /* User has disabled initial BUS RESET */ 589 PIM_NO_6_BYTE = 0x08, /* Do not send 6-byte commands */ 590 PIM_SEQSCAN = 0x04, /* Do bus scans sequentially, not in parallel */ 591 PIM_UNMAPPED = 0x02, 592 PIM_NOSCAN = 0x01 /* SIM does its own scanning */ 593} pi_miscflag; 594 595/* Path Inquiry CCB */ 596struct ccb_pathinq_settings_spi { 597 u_int8_t ppr_options; 598}; 599 600struct ccb_pathinq_settings_fc { 601 u_int64_t wwnn; /* world wide node name */ 602 u_int64_t wwpn; /* world wide port name */ 603 u_int32_t port; /* 24 bit port id, if known */ 604 u_int32_t bitrate; /* Mbps */ 605}; 606 607struct ccb_pathinq_settings_sas { 608 u_int32_t bitrate; /* Mbps */ 609}; 610#define PATHINQ_SETTINGS_SIZE 128 611 612struct ccb_pathinq { 613 struct ccb_hdr ccb_h; 614 u_int8_t version_num; /* Version number for the SIM/HBA */ 615 u_int8_t hba_inquiry; /* Mimic of INQ byte 7 for the HBA */ 616 u_int16_t target_sprt; /* Flags for target mode support */ 617 u_int32_t hba_misc; /* Misc HBA features */ 618 u_int16_t hba_eng_cnt; /* HBA engine count */ 619 /* Vendor Unique capabilities */ 620 u_int8_t vuhba_flags[VUHBALEN]; 621 u_int32_t max_target; /* Maximum supported Target */ 622 u_int32_t max_lun; /* Maximum supported Lun */ 623 u_int32_t async_flags; /* Installed Async handlers */ 624 path_id_t hpath_id; /* Highest Path ID in the subsystem */ 625 target_id_t initiator_id; /* ID of the HBA on the SCSI bus */ 626 char sim_vid[SIM_IDLEN]; /* Vendor ID of the SIM */ 627 char hba_vid[HBA_IDLEN]; /* Vendor ID of the HBA */ 628 char dev_name[DEV_IDLEN];/* Device name for SIM */ 629 u_int32_t unit_number; /* Unit number for SIM */ 630 u_int32_t bus_id; /* Bus ID for SIM */ 631 u_int32_t base_transfer_speed;/* Base bus speed in KB/sec */ 632 cam_proto protocol; 633 u_int protocol_version; 634 cam_xport transport; 635 u_int transport_version; 636 union { 637 struct ccb_pathinq_settings_spi spi; 638 struct ccb_pathinq_settings_fc fc; 639 struct ccb_pathinq_settings_sas sas; 640 char ccb_pathinq_settings_opaque[PATHINQ_SETTINGS_SIZE]; 641 } xport_specific; 642 u_int maxio; /* Max supported I/O size, in bytes. */ 643 u_int16_t hba_vendor; /* HBA vendor ID */ 644 u_int16_t hba_device; /* HBA device ID */ 645 u_int16_t hba_subvendor; /* HBA subvendor ID */ 646 u_int16_t hba_subdevice; /* HBA subdevice ID */ 647}; 648 649/* Path Statistics CCB */ 650struct ccb_pathstats { 651 struct ccb_hdr ccb_h; 652 struct timeval last_reset; /* Time of last bus reset/loop init */ 653}; 654 655typedef enum { 656 SMP_FLAG_NONE = 0x00, 657 SMP_FLAG_REQ_SG = 0x01, 658 SMP_FLAG_RSP_SG = 0x02 659} ccb_smp_pass_flags; 660 661/* 662 * Serial Management Protocol CCB 663 * XXX Currently the semantics for this CCB are that it is executed either 664 * by the addressed device, or that device's parent (i.e. an expander for 665 * any device on an expander) if the addressed device doesn't support SMP. 666 * Later, once we have the ability to probe SMP-only devices and put them 667 * in CAM's topology, the CCB will only be executed by the addressed device 668 * if possible. 669 */ 670struct ccb_smpio { 671 struct ccb_hdr ccb_h; 672 uint8_t *smp_request; 673 int smp_request_len; 674 uint16_t smp_request_sglist_cnt; 675 uint8_t *smp_response; 676 int smp_response_len; 677 uint16_t smp_response_sglist_cnt; 678 ccb_smp_pass_flags flags; 679}; 680 681typedef union { 682 u_int8_t *sense_ptr; /* 683 * Pointer to storage 684 * for sense information 685 */ 686 /* Storage Area for sense information */ 687 struct scsi_sense_data sense_buf; 688} sense_t; 689 690typedef union { 691 u_int8_t *cdb_ptr; /* Pointer to the CDB bytes to send */ 692 /* Area for the CDB send */ 693 u_int8_t cdb_bytes[IOCDBLEN]; 694} cdb_t; 695 696/* 697 * SCSI I/O Request CCB used for the XPT_SCSI_IO and XPT_CONT_TARGET_IO 698 * function codes. 699 */ 700struct ccb_scsiio { 701 struct ccb_hdr ccb_h; 702 union ccb *next_ccb; /* Ptr for next CCB for action */ 703 u_int8_t *req_map; /* Ptr to mapping info */ 704 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */ 705 u_int32_t dxfer_len; /* Data transfer length */ 706 /* Autosense storage */ 707 struct scsi_sense_data sense_data; 708 u_int8_t sense_len; /* Number of bytes to autosense */ 709 u_int8_t cdb_len; /* Number of bytes for the CDB */ 710 u_int16_t sglist_cnt; /* Number of SG list entries */ 711 u_int8_t scsi_status; /* Returned SCSI status */ 712 u_int8_t sense_resid; /* Autosense resid length: 2's comp */ 713 u_int32_t resid; /* Transfer residual length: 2's comp */ 714 cdb_t cdb_io; /* Union for CDB bytes/pointer */ 715 u_int8_t *msg_ptr; /* Pointer to the message buffer */ 716 u_int16_t msg_len; /* Number of bytes for the Message */ 717 u_int8_t tag_action; /* What to do for tag queueing */ 718 /* 719 * The tag action should be either the define below (to send a 720 * non-tagged transaction) or one of the defined scsi tag messages 721 * from scsi_message.h. 722 */ 723#define CAM_TAG_ACTION_NONE 0x00 724 u_int tag_id; /* tag id from initator (target mode) */ 725 u_int init_id; /* initiator id of who selected */ 726}; 727 728/* 729 * ATA I/O Request CCB used for the XPT_ATA_IO function code. 730 */ 731struct ccb_ataio { 732 struct ccb_hdr ccb_h; 733 union ccb *next_ccb; /* Ptr for next CCB for action */ 734 struct ata_cmd cmd; /* ATA command register set */ 735 struct ata_res res; /* ATA result register set */ 736 u_int8_t *data_ptr; /* Ptr to the data buf/SG list */ 737 u_int32_t dxfer_len; /* Data transfer length */ 738 u_int32_t resid; /* Transfer residual length: 2's comp */ 739 u_int8_t tag_action; /* What to do for tag queueing */ 740 /* 741 * The tag action should be either the define below (to send a 742 * non-tagged transaction) or one of the defined scsi tag messages 743 * from scsi_message.h. 744 */ 745#define CAM_TAG_ACTION_NONE 0x00 746 u_int tag_id; /* tag id from initator (target mode) */ 747 u_int init_id; /* initiator id of who selected */ 748}; 749 750struct ccb_accept_tio { 751 struct ccb_hdr ccb_h; 752 cdb_t cdb_io; /* Union for CDB bytes/pointer */ 753 u_int8_t cdb_len; /* Number of bytes for the CDB */ 754 u_int8_t tag_action; /* What to do for tag queueing */ 755 u_int8_t sense_len; /* Number of bytes of Sense Data */ 756 u_int tag_id; /* tag id from initator (target mode) */ 757 u_int init_id; /* initiator id of who selected */ 758 struct scsi_sense_data sense_data; 759}; 760 761/* Release SIM Queue */ 762struct ccb_relsim { 763 struct ccb_hdr ccb_h; 764 u_int32_t release_flags; 765#define RELSIM_ADJUST_OPENINGS 0x01 766#define RELSIM_RELEASE_AFTER_TIMEOUT 0x02 767#define RELSIM_RELEASE_AFTER_CMDCMPLT 0x04 768#define RELSIM_RELEASE_AFTER_QEMPTY 0x08 769 u_int32_t openings; 770 u_int32_t release_timeout; /* Abstract argument. */ 771 u_int32_t qfrozen_cnt; 772}; 773 774/* 775 * Definitions for the asynchronous callback CCB fields. 776 */ 777typedef enum { 778 AC_UNIT_ATTENTION = 0x4000,/* Device reported UNIT ATTENTION */ 779 AC_ADVINFO_CHANGED = 0x2000,/* Advance info might have changes */ 780 AC_CONTRACT = 0x1000,/* A contractual callback */ 781 AC_GETDEV_CHANGED = 0x800,/* Getdev info might have changed */ 782 AC_INQ_CHANGED = 0x400,/* Inquiry info might have changed */ 783 AC_TRANSFER_NEG = 0x200,/* New transfer settings in effect */ 784 AC_LOST_DEVICE = 0x100,/* A device went away */ 785 AC_FOUND_DEVICE = 0x080,/* A new device was found */ 786 AC_PATH_DEREGISTERED = 0x040,/* A path has de-registered */ 787 AC_PATH_REGISTERED = 0x020,/* A new path has been registered */ 788 AC_SENT_BDR = 0x010,/* A BDR message was sent to target */ 789 AC_SCSI_AEN = 0x008,/* A SCSI AEN has been received */ 790 AC_UNSOL_RESEL = 0x002,/* Unsolicited reselection occurred */ 791 AC_BUS_RESET = 0x001 /* A SCSI bus reset occurred */ 792} ac_code; 793 794typedef void ac_callback_t (void *softc, u_int32_t code, 795 struct cam_path *path, void *args); 796 797/* 798 * Generic Asynchronous callbacks. 799 * 800 * Generic arguments passed bac which are then interpreted between a per-system 801 * contract number. 802 */ 803#define AC_CONTRACT_DATA_MAX (128 - sizeof (u_int64_t)) 804struct ac_contract { 805 u_int64_t contract_number; 806 u_int8_t contract_data[AC_CONTRACT_DATA_MAX]; 807}; 808 809#define AC_CONTRACT_DEV_CHG 1 810struct ac_device_changed { 811 u_int64_t wwpn; 812 u_int32_t port; 813 target_id_t target; 814 u_int8_t arrived; 815}; 816 817/* Set Asynchronous Callback CCB */ 818struct ccb_setasync { 819 struct ccb_hdr ccb_h; 820 u_int32_t event_enable; /* Async Event enables */ 821 ac_callback_t *callback; 822 void *callback_arg; 823}; 824 825/* Set Device Type CCB */ 826struct ccb_setdev { 827 struct ccb_hdr ccb_h; 828 u_int8_t dev_type; /* Value for dev type field in EDT */ 829}; 830 831/* SCSI Control Functions */ 832 833/* Abort XPT request CCB */ 834struct ccb_abort { 835 struct ccb_hdr ccb_h; 836 union ccb *abort_ccb; /* Pointer to CCB to abort */ 837}; 838 839/* Reset SCSI Bus CCB */ 840struct ccb_resetbus { 841 struct ccb_hdr ccb_h; 842}; 843 844/* Reset SCSI Device CCB */ 845struct ccb_resetdev { 846 struct ccb_hdr ccb_h; 847}; 848 849/* Terminate I/O Process Request CCB */ 850struct ccb_termio { 851 struct ccb_hdr ccb_h; 852 union ccb *termio_ccb; /* Pointer to CCB to terminate */ 853}; 854 855typedef enum { 856 CTS_TYPE_CURRENT_SETTINGS, 857 CTS_TYPE_USER_SETTINGS 858} cts_type; 859 860struct ccb_trans_settings_scsi 861{ 862 u_int valid; /* Which fields to honor */ 863#define CTS_SCSI_VALID_TQ 0x01 864 u_int flags; 865#define CTS_SCSI_FLAGS_TAG_ENB 0x01 866}; 867 868struct ccb_trans_settings_ata 869{ 870 u_int valid; /* Which fields to honor */ 871#define CTS_ATA_VALID_TQ 0x01 872 u_int flags; 873#define CTS_ATA_FLAGS_TAG_ENB 0x01 874}; 875 876struct ccb_trans_settings_spi 877{ 878 u_int valid; /* Which fields to honor */ 879#define CTS_SPI_VALID_SYNC_RATE 0x01 880#define CTS_SPI_VALID_SYNC_OFFSET 0x02 881#define CTS_SPI_VALID_BUS_WIDTH 0x04 882#define CTS_SPI_VALID_DISC 0x08 883#define CTS_SPI_VALID_PPR_OPTIONS 0x10 884 u_int flags; 885#define CTS_SPI_FLAGS_DISC_ENB 0x01 886 u_int sync_period; 887 u_int sync_offset; 888 u_int bus_width; 889 u_int ppr_options; 890}; 891 892struct ccb_trans_settings_fc { 893 u_int valid; /* Which fields to honor */ 894#define CTS_FC_VALID_WWNN 0x8000 895#define CTS_FC_VALID_WWPN 0x4000 896#define CTS_FC_VALID_PORT 0x2000 897#define CTS_FC_VALID_SPEED 0x1000 898 u_int64_t wwnn; /* world wide node name */ 899 u_int64_t wwpn; /* world wide port name */ 900 u_int32_t port; /* 24 bit port id, if known */ 901 u_int32_t bitrate; /* Mbps */ 902}; 903 904struct ccb_trans_settings_sas { 905 u_int valid; /* Which fields to honor */ 906#define CTS_SAS_VALID_SPEED 0x1000 907 u_int32_t bitrate; /* Mbps */ 908}; 909 910struct ccb_trans_settings_pata { 911 u_int valid; /* Which fields to honor */ 912#define CTS_ATA_VALID_MODE 0x01 913#define CTS_ATA_VALID_BYTECOUNT 0x02 914#define CTS_ATA_VALID_ATAPI 0x20 915#define CTS_ATA_VALID_CAPS 0x40 916 int mode; /* Mode */ 917 u_int bytecount; /* Length of PIO transaction */ 918 u_int atapi; /* Length of ATAPI CDB */ 919 u_int caps; /* Device and host SATA caps. */ 920#define CTS_ATA_CAPS_H 0x0000ffff 921#define CTS_ATA_CAPS_H_DMA48 0x00000001 /* 48-bit DMA */ 922#define CTS_ATA_CAPS_D 0xffff0000 923}; 924 925struct ccb_trans_settings_sata { 926 u_int valid; /* Which fields to honor */ 927#define CTS_SATA_VALID_MODE 0x01 928#define CTS_SATA_VALID_BYTECOUNT 0x02 929#define CTS_SATA_VALID_REVISION 0x04 930#define CTS_SATA_VALID_PM 0x08 931#define CTS_SATA_VALID_TAGS 0x10 932#define CTS_SATA_VALID_ATAPI 0x20 933#define CTS_SATA_VALID_CAPS 0x40 934 int mode; /* Legacy PATA mode */ 935 u_int bytecount; /* Length of PIO transaction */ 936 int revision; /* SATA revision */ 937 u_int pm_present; /* PM is present (XPT->SIM) */ 938 u_int tags; /* Number of allowed tags */ 939 u_int atapi; /* Length of ATAPI CDB */ 940 u_int caps; /* Device and host SATA caps. */ 941#define CTS_SATA_CAPS_H 0x0000ffff 942#define CTS_SATA_CAPS_H_PMREQ 0x00000001 943#define CTS_SATA_CAPS_H_APST 0x00000002 944#define CTS_SATA_CAPS_H_DMAAA 0x00000010 /* Auto-activation */ 945#define CTS_SATA_CAPS_H_AN 0x00000020 /* Async. notification */ 946#define CTS_SATA_CAPS_D 0xffff0000 947#define CTS_SATA_CAPS_D_PMREQ 0x00010000 948#define CTS_SATA_CAPS_D_APST 0x00020000 949}; 950 951/* Get/Set transfer rate/width/disconnection/tag queueing settings */ 952struct ccb_trans_settings { 953 struct ccb_hdr ccb_h; 954 cts_type type; /* Current or User settings */ 955 cam_proto protocol; 956 u_int protocol_version; 957 cam_xport transport; 958 u_int transport_version; 959 union { 960 u_int valid; /* Which fields to honor */ 961 struct ccb_trans_settings_ata ata; 962 struct ccb_trans_settings_scsi scsi; 963 } proto_specific; 964 union { 965 u_int valid; /* Which fields to honor */ 966 struct ccb_trans_settings_spi spi; 967 struct ccb_trans_settings_fc fc; 968 struct ccb_trans_settings_sas sas; 969 struct ccb_trans_settings_pata ata; 970 struct ccb_trans_settings_sata sata; 971 } xport_specific; 972}; 973 974 975/* 976 * Calculate the geometry parameters for a device 977 * give the block size and volume size in blocks. 978 */ 979struct ccb_calc_geometry { 980 struct ccb_hdr ccb_h; 981 u_int32_t block_size; 982 u_int64_t volume_size; 983 u_int32_t cylinders; 984 u_int8_t heads; 985 u_int8_t secs_per_track; 986}; 987 988/* 989 * Set or get SIM (and transport) specific knobs 990 */ 991 992#define KNOB_VALID_ADDRESS 0x1 993#define KNOB_VALID_ROLE 0x2 994 995 996#define KNOB_ROLE_NONE 0x0 997#define KNOB_ROLE_INITIATOR 0x1 998#define KNOB_ROLE_TARGET 0x2 999#define KNOB_ROLE_BOTH 0x3 1000 1001struct ccb_sim_knob_settings_spi { 1002 u_int valid; 1003 u_int initiator_id; 1004 u_int role; 1005}; 1006 1007struct ccb_sim_knob_settings_fc { 1008 u_int valid; 1009 u_int64_t wwnn; /* world wide node name */ 1010 u_int64_t wwpn; /* world wide port name */ 1011 u_int role; 1012}; 1013 1014struct ccb_sim_knob_settings_sas { 1015 u_int valid; 1016 u_int64_t wwnn; /* world wide node name */ 1017 u_int role; 1018}; 1019#define KNOB_SETTINGS_SIZE 128 1020 1021struct ccb_sim_knob { 1022 struct ccb_hdr ccb_h; 1023 union { 1024 u_int valid; /* Which fields to honor */ 1025 struct ccb_sim_knob_settings_spi spi; 1026 struct ccb_sim_knob_settings_fc fc; 1027 struct ccb_sim_knob_settings_sas sas; 1028 char pad[KNOB_SETTINGS_SIZE]; 1029 } xport_specific; 1030}; 1031 1032/* 1033 * Rescan the given bus, or bus/target/lun 1034 */ 1035struct ccb_rescan { 1036 struct ccb_hdr ccb_h; 1037 cam_flags flags; 1038}; 1039 1040/* 1041 * Turn on debugging for the given bus, bus/target, or bus/target/lun. 1042 */ 1043struct ccb_debug { 1044 struct ccb_hdr ccb_h; 1045 cam_debug_flags flags; 1046}; 1047 1048/* Target mode structures. */ 1049 1050struct ccb_en_lun { 1051 struct ccb_hdr ccb_h; 1052 u_int16_t grp6_len; /* Group 6 VU CDB length */ 1053 u_int16_t grp7_len; /* Group 7 VU CDB length */ 1054 u_int8_t enable; 1055}; 1056 1057/* old, barely used immediate notify, binary compatibility */ 1058struct ccb_immed_notify { 1059 struct ccb_hdr ccb_h; 1060 struct scsi_sense_data sense_data; 1061 u_int8_t sense_len; /* Number of bytes in sense buffer */ 1062 u_int8_t initiator_id; /* Id of initiator that selected */ 1063 u_int8_t message_args[7]; /* Message Arguments */ 1064}; 1065 1066struct ccb_notify_ack { 1067 struct ccb_hdr ccb_h; 1068 u_int16_t seq_id; /* Sequence identifier */ 1069 u_int8_t event; /* Event flags */ 1070}; 1071 1072struct ccb_immediate_notify { 1073 struct ccb_hdr ccb_h; 1074 u_int tag_id; /* Tag for immediate notify */ 1075 u_int seq_id; /* Tag for target of notify */ 1076 u_int initiator_id; /* Initiator Identifier */ 1077 u_int arg; /* Function specific */ 1078}; 1079 1080struct ccb_notify_acknowledge { 1081 struct ccb_hdr ccb_h; 1082 u_int tag_id; /* Tag for immediate notify */ 1083 u_int seq_id; /* Tar for target of notify */ 1084 u_int initiator_id; /* Initiator Identifier */ 1085 u_int arg; /* Function specific */ 1086}; 1087 1088/* HBA engine structures. */ 1089 1090typedef enum { 1091 EIT_BUFFER, /* Engine type: buffer memory */ 1092 EIT_LOSSLESS, /* Engine type: lossless compression */ 1093 EIT_LOSSY, /* Engine type: lossy compression */ 1094 EIT_ENCRYPT /* Engine type: encryption */ 1095} ei_type; 1096 1097typedef enum { 1098 EAD_VUNIQUE, /* Engine algorithm ID: vendor unique */ 1099 EAD_LZ1V1, /* Engine algorithm ID: LZ1 var.1 */ 1100 EAD_LZ2V1, /* Engine algorithm ID: LZ2 var.1 */ 1101 EAD_LZ2V2 /* Engine algorithm ID: LZ2 var.2 */ 1102} ei_algo; 1103 1104struct ccb_eng_inq { 1105 struct ccb_hdr ccb_h; 1106 u_int16_t eng_num; /* The engine number for this inquiry */ 1107 ei_type eng_type; /* Returned engine type */ 1108 ei_algo eng_algo; /* Returned engine algorithm type */ 1109 u_int32_t eng_memeory; /* Returned engine memory size */ 1110}; 1111 1112struct ccb_eng_exec { /* This structure must match SCSIIO size */ 1113 struct ccb_hdr ccb_h; 1114 u_int8_t *pdrv_ptr; /* Ptr used by the peripheral driver */ 1115 u_int8_t *req_map; /* Ptr for mapping info on the req. */ 1116 u_int8_t *data_ptr; /* Pointer to the data buf/SG list */ 1117 u_int32_t dxfer_len; /* Data transfer length */ 1118 u_int8_t *engdata_ptr; /* Pointer to the engine buffer data */ 1119 u_int16_t sglist_cnt; /* Num of scatter gather list entries */ 1120 u_int32_t dmax_len; /* Destination data maximum length */ 1121 u_int32_t dest_len; /* Destination data length */ 1122 int32_t src_resid; /* Source residual length: 2's comp */ 1123 u_int32_t timeout; /* Timeout value */ 1124 u_int16_t eng_num; /* Engine number for this request */ 1125 u_int16_t vu_flags; /* Vendor Unique flags */ 1126}; 1127 1128/* 1129 * Definitions for the timeout field in the SCSI I/O CCB. 1130 */ 1131#define CAM_TIME_DEFAULT 0x00000000 /* Use SIM default value */ 1132#define CAM_TIME_INFINITY 0xFFFFFFFF /* Infinite timeout */ 1133 1134#define CAM_SUCCESS 0 /* For signaling general success */ 1135#define CAM_FAILURE 1 /* For signaling general failure */ 1136 1137#define CAM_FALSE 0 1138#define CAM_TRUE 1 1139 1140#define XPT_CCB_INVALID -1 /* for signaling a bad CCB to free */ 1141 1142/* 1143 * CCB for working with advanced device information. This operates in a fashion 1144 * similar to XPT_GDEV_TYPE. Specify the target in ccb_h, the buffer 1145 * type requested, and provide a buffer size/buffer to write to. If the 1146 * buffer is too small, provsiz will be larger than bufsiz. 1147 */ 1148struct ccb_dev_advinfo { 1149 struct ccb_hdr ccb_h; 1150 uint32_t flags; 1151#define CDAI_FLAG_NONE 0x0 /* No flags set */ 1152#define CDAI_FLAG_STORE 0x1 /* If set, action becomes store */ 1153 uint32_t buftype; /* IN: Type of data being requested */ 1154 /* NB: buftype is interpreted on a per-transport basis */ 1155#define CDAI_TYPE_SCSI_DEVID 1 1156#define CDAI_TYPE_SERIAL_NUM 2 1157#define CDAI_TYPE_PHYS_PATH 3 1158#define CDAI_TYPE_RCAPLONG 4 1159#define CDAI_TYPE_EXT_INQ 5 1160 off_t bufsiz; /* IN: Size of external buffer */ 1161#define CAM_SCSI_DEVID_MAXLEN 65536 /* length in buffer is an uint16_t */ 1162 off_t provsiz; /* OUT: Size required/used */ 1163 uint8_t *buf; /* IN/OUT: Buffer for requested data */ 1164}; 1165 1166/* 1167 * CCB for sending async events 1168 */ 1169struct ccb_async { 1170 struct ccb_hdr ccb_h; 1171 uint32_t async_code; 1172 off_t async_arg_size; 1173 void *async_arg_ptr; 1174}; 1175 1176/* 1177 * Union of all CCB types for kernel space allocation. This union should 1178 * never be used for manipulating CCBs - its only use is for the allocation 1179 * and deallocation of raw CCB space and is the return type of xpt_ccb_alloc 1180 * and the argument to xpt_ccb_free. 1181 */ 1182union ccb { 1183 struct ccb_hdr ccb_h; /* For convenience */ 1184 struct ccb_scsiio csio; 1185 struct ccb_getdev cgd; 1186 struct ccb_getdevlist cgdl; 1187 struct ccb_pathinq cpi; 1188 struct ccb_relsim crs; 1189 struct ccb_setasync csa; 1190 struct ccb_setdev csd; 1191 struct ccb_pathstats cpis; 1192 struct ccb_getdevstats cgds; 1193 struct ccb_dev_match cdm; 1194 struct ccb_trans_settings cts; 1195 struct ccb_calc_geometry ccg; 1196 struct ccb_sim_knob knob; 1197 struct ccb_abort cab; 1198 struct ccb_resetbus crb; 1199 struct ccb_resetdev crd; 1200 struct ccb_termio tio; 1201 struct ccb_accept_tio atio; 1202 struct ccb_scsiio ctio; 1203 struct ccb_en_lun cel; 1204 struct ccb_immed_notify cin; 1205 struct ccb_notify_ack cna; 1206 struct ccb_immediate_notify cin1; 1207 struct ccb_notify_acknowledge cna2; 1208 struct ccb_eng_inq cei; 1209 struct ccb_eng_exec cee; 1210 struct ccb_smpio smpio; 1211 struct ccb_rescan crcn; 1212 struct ccb_debug cdbg; 1213 struct ccb_ataio ataio; 1214 struct ccb_dev_advinfo cdai; 1215 struct ccb_async casync; 1216}; 1217 1218__BEGIN_DECLS 1219static __inline void 1220cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries, 1221 void (*cbfcnp)(struct cam_periph *, union ccb *), 1222 u_int32_t flags, u_int8_t tag_action, 1223 u_int8_t *data_ptr, u_int32_t dxfer_len, 1224 u_int8_t sense_len, u_int8_t cdb_len, 1225 u_int32_t timeout); 1226 1227static __inline void 1228cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries, 1229 void (*cbfcnp)(struct cam_periph *, union ccb *), 1230 u_int32_t flags, u_int tag_action, u_int tag_id, 1231 u_int init_id, u_int scsi_status, u_int8_t *data_ptr, 1232 u_int32_t dxfer_len, u_int32_t timeout); 1233 1234static __inline void 1235cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries, 1236 void (*cbfcnp)(struct cam_periph *, union ccb *), 1237 u_int32_t flags, u_int tag_action, 1238 u_int8_t *data_ptr, u_int32_t dxfer_len, 1239 u_int32_t timeout); 1240 1241static __inline void 1242cam_fill_smpio(struct ccb_smpio *smpio, uint32_t retries, 1243 void (*cbfcnp)(struct cam_periph *, union ccb *), uint32_t flags, 1244 uint8_t *smp_request, int smp_request_len, 1245 uint8_t *smp_response, int smp_response_len, 1246 uint32_t timeout); 1247 1248static __inline void 1249cam_fill_csio(struct ccb_scsiio *csio, u_int32_t retries, 1250 void (*cbfcnp)(struct cam_periph *, union ccb *), 1251 u_int32_t flags, u_int8_t tag_action, 1252 u_int8_t *data_ptr, u_int32_t dxfer_len, 1253 u_int8_t sense_len, u_int8_t cdb_len, 1254 u_int32_t timeout) 1255{ 1256 csio->ccb_h.func_code = XPT_SCSI_IO; 1257 csio->ccb_h.flags = flags; 1258 csio->ccb_h.xflags = 0; 1259 csio->ccb_h.retry_count = retries; 1260 csio->ccb_h.cbfcnp = cbfcnp; 1261 csio->ccb_h.timeout = timeout; 1262 csio->data_ptr = data_ptr; 1263 csio->dxfer_len = dxfer_len; 1264 csio->sense_len = sense_len; 1265 csio->cdb_len = cdb_len; 1266 csio->tag_action = tag_action; 1267} 1268 1269static __inline void 1270cam_fill_ctio(struct ccb_scsiio *csio, u_int32_t retries, 1271 void (*cbfcnp)(struct cam_periph *, union ccb *), 1272 u_int32_t flags, u_int tag_action, u_int tag_id, 1273 u_int init_id, u_int scsi_status, u_int8_t *data_ptr, 1274 u_int32_t dxfer_len, u_int32_t timeout) 1275{ 1276 csio->ccb_h.func_code = XPT_CONT_TARGET_IO; 1277 csio->ccb_h.flags = flags; 1278 csio->ccb_h.xflags = 0; 1279 csio->ccb_h.retry_count = retries; 1280 csio->ccb_h.cbfcnp = cbfcnp; 1281 csio->ccb_h.timeout = timeout; 1282 csio->data_ptr = data_ptr; 1283 csio->dxfer_len = dxfer_len; 1284 csio->scsi_status = scsi_status; 1285 csio->tag_action = tag_action; 1286 csio->tag_id = tag_id; 1287 csio->init_id = init_id; 1288} 1289 1290static __inline void 1291cam_fill_ataio(struct ccb_ataio *ataio, u_int32_t retries, 1292 void (*cbfcnp)(struct cam_periph *, union ccb *), 1293 u_int32_t flags, u_int tag_action, 1294 u_int8_t *data_ptr, u_int32_t dxfer_len, 1295 u_int32_t timeout) 1296{ 1297 ataio->ccb_h.func_code = XPT_ATA_IO; 1298 ataio->ccb_h.flags = flags; 1299 ataio->ccb_h.retry_count = retries; 1300 ataio->ccb_h.cbfcnp = cbfcnp; 1301 ataio->ccb_h.timeout = timeout; 1302 ataio->data_ptr = data_ptr; 1303 ataio->dxfer_len = dxfer_len; 1304 ataio->tag_action = tag_action; 1305} 1306 1307static __inline void 1308cam_fill_smpio(struct ccb_smpio *smpio, uint32_t retries, 1309 void (*cbfcnp)(struct cam_periph *, union ccb *), uint32_t flags, 1310 uint8_t *smp_request, int smp_request_len, 1311 uint8_t *smp_response, int smp_response_len, 1312 uint32_t timeout) 1313{ 1314#ifdef _KERNEL 1315 KASSERT((flags & CAM_DIR_MASK) == CAM_DIR_BOTH, 1316 ("direction != CAM_DIR_BOTH")); 1317 KASSERT((smp_request != NULL) && (smp_response != NULL), 1318 ("need valid request and response buffers")); 1319 KASSERT((smp_request_len != 0) && (smp_response_len != 0), 1320 ("need non-zero request and response lengths")); 1321#endif /*_KERNEL*/ 1322 smpio->ccb_h.func_code = XPT_SMP_IO; 1323 smpio->ccb_h.flags = flags; 1324 smpio->ccb_h.retry_count = retries; 1325 smpio->ccb_h.cbfcnp = cbfcnp; 1326 smpio->ccb_h.timeout = timeout; 1327 smpio->smp_request = smp_request; 1328 smpio->smp_request_len = smp_request_len; 1329 smpio->smp_response = smp_response; 1330 smpio->smp_response_len = smp_response_len; 1331} 1332 1333static __inline void 1334cam_set_ccbstatus(union ccb *ccb, cam_status status) 1335{ 1336 ccb->ccb_h.status &= ~CAM_STATUS_MASK; 1337 ccb->ccb_h.status |= status; 1338} 1339 1340static __inline cam_status 1341cam_ccb_status(union ccb *ccb) 1342{ 1343 return ((cam_status)(ccb->ccb_h.status & CAM_STATUS_MASK)); 1344} 1345 1346void cam_calc_geometry(struct ccb_calc_geometry *ccg, int extended); 1347 1348__END_DECLS 1349 1350#endif /* _CAM_CAM_CCB_H */ 1351