The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/cam/cam_ccb.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: 72210e1ce81364e85e24c9959f6e4507


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.