sys/cam/cam_ccb.h

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