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