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/dev/mpr/mpi/mpi2_init.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  * Copyright (c) 2012-2015 LSI Corp.
    3  * Copyright (c) 2013-2016 Avago Technologies
    4  * All rights reserved.
    5  *
    6  * Redistribution and use in source and binary forms, with or without
    7  * modification, are permitted provided that the following conditions
    8  * are met:
    9  * 1. Redistributions of source code must retain the above copyright
   10  *    notice, this list of conditions and the following disclaimer.
   11  * 2. Redistributions in binary form must reproduce the above copyright
   12  *    notice, this list of conditions and the following disclaimer in the
   13  *    documentation and/or other materials provided with the distribution.
   14  * 3. Neither the name of the author nor the names of any co-contributors
   15  *    may be used to endorse or promote products derived from this software
   16  *    without specific prior written permission.
   17  *
   18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
   19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
   22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   28  * SUCH DAMAGE.
   29  *
   30  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
   31  *
   32  * $FreeBSD$
   33  */
   34 
   35 /*
   36  *  Copyright (c) 2000-2015 LSI Corporation.
   37  *  Copyright (c) 2013-2016 Avago Technologies
   38  *  All rights reserved.
   39  *
   40  *
   41  *           Name:  mpi2_init.h
   42  *          Title:  MPI SCSI initiator mode messages and structures
   43  *  Creation Date:  June 23, 2006
   44  *
   45  *  mpi2_init.h Version:  02.00.21
   46  *
   47  *  NOTE: Names (typedefs, defines, etc.) beginning with an MPI25 or Mpi25
   48  *        prefix are for use only on MPI v2.5 products, and must not be used
   49  *        with MPI v2.0 products. Unless otherwise noted, names beginning with
   50  *        MPI2 or Mpi2 are for use with both MPI v2.0 and MPI v2.5 products.
   51  *
   52  *  Version History
   53  *  ---------------
   54  *
   55  *  Date      Version   Description
   56  *  --------  --------  ------------------------------------------------------
   57  *  04-30-07  02.00.00  Corresponds to Fusion-MPT MPI Specification Rev A.
   58  *  10-31-07  02.00.01  Fixed name for pMpi2SCSITaskManagementRequest_t.
   59  *  12-18-07  02.00.02  Modified Task Management Target Reset Method defines.
   60  *  02-29-08  02.00.03  Added Query Task Set and Query Unit Attention.
   61  *  03-03-08  02.00.04  Fixed name of struct _MPI2_SCSI_TASK_MANAGE_REPLY.
   62  *  05-21-08  02.00.05  Fixed typo in name of Mpi2SepRequest_t.
   63  *  10-02-08  02.00.06  Removed Untagged and No Disconnect values from SCSI IO
   64  *                      Control field Task Attribute flags.
   65  *                      Moved LUN field defines to mpi2.h because they are
   66  *                      common to many structures.
   67  *  05-06-09  02.00.07  Changed task management type of Query Unit Attention to
   68  *                      Query Asynchronous Event.
   69  *                      Defined two new bits in the SlotStatus field of the SCSI
   70  *                      Enclosure Processor Request and Reply.
   71  *  10-28-09  02.00.08  Added defines for decoding the ResponseInfo bytes for
   72  *                      both SCSI IO Error Reply and SCSI Task Management Reply.
   73  *                      Added ResponseInfo field to MPI2_SCSI_TASK_MANAGE_REPLY.
   74  *                      Added MPI2_SCSITASKMGMT_RSP_TM_OVERLAPPED_TAG define.
   75  *  02-10-10  02.00.09  Removed unused structure that had "#if 0" around it.
   76  *  05-12-10  02.00.10  Added optional vendor-unique region to SCSI IO Request.
   77  *  11-10-10  02.00.11  Added MPI2_SCSIIO_NUM_SGLOFFSETS define.
   78  *  11-18-11  02.00.12  Incorporating additions for MPI v2.5.
   79  *  02-06-12  02.00.13  Added alternate defines for Task Priority / Command
   80  *                      Priority to match SAM-4.
   81  *                      Added EEDPErrorOffset to MPI2_SCSI_IO_REPLY.
   82  *  07-10-12  02.00.14  Added MPI2_SCSIIO_CONTROL_SHIFT_DATADIRECTION.
   83  *  04-09-13  02.00.15  Added SCSIStatusQualifier field to MPI2_SCSI_IO_REPLY,
   84  *                      replacing the Reserved4 field.
   85  *  11-18-14  02.00.16  Updated copyright information.
   86  *  03-16-15  02.00.17  Updated for MPI v2.6.
   87  *                      Added MPI26_SCSIIO_IOFLAGS_ESCAPE_PASSTHROUGH.
   88  *                      Added MPI2_SEP_REQ_SLOTSTATUS_DEV_OFF and
   89  *                      MPI2_SEP_REPLY_SLOTSTATUS_DEV_OFF.
   90  *  08-26-15  02.00.18  Added SCSITASKMGMT_MSGFLAGS for Target Reset.
   91  *  12-18-15  02.00.19  Added EEDPObservedValue added to SCSI IO Reply message.
   92  *  01-04-16  02.00.20  Modified EEDP reported values in SCSI IO Reply message.
   93  *  01-21-16  02.00.21  Modified MPI26_SCSITASKMGMT_MSGFLAGS_PCIE* defines to
   94  *                      be unique within first 32 characters.
   95  *  --------------------------------------------------------------------------
   96  */
   97 
   98 #ifndef MPI2_INIT_H
   99 #define MPI2_INIT_H
  100 
  101 /*****************************************************************************
  102 *
  103 *               SCSI Initiator Messages
  104 *
  105 *****************************************************************************/
  106 
  107 /****************************************************************************
  108 *  SCSI IO messages and associated structures
  109 ****************************************************************************/
  110 
  111 typedef struct _MPI2_SCSI_IO_CDB_EEDP32
  112 {
  113     U8                      CDB[20];                    /* 0x00 */
  114     U32                     PrimaryReferenceTag;        /* 0x14 */
  115     U16                     PrimaryApplicationTag;      /* 0x18 */
  116     U16                     PrimaryApplicationTagMask;  /* 0x1A */
  117     U32                     TransferLength;             /* 0x1C */
  118 } MPI2_SCSI_IO_CDB_EEDP32, MPI2_POINTER PTR_MPI2_SCSI_IO_CDB_EEDP32,
  119   Mpi2ScsiIoCdbEedp32_t, MPI2_POINTER pMpi2ScsiIoCdbEedp32_t;
  120 
  121 /* MPI v2.0 CDB field */
  122 typedef union _MPI2_SCSI_IO_CDB_UNION
  123 {
  124     U8                      CDB32[32];
  125     MPI2_SCSI_IO_CDB_EEDP32 EEDP32;
  126     MPI2_SGE_SIMPLE_UNION   SGE;
  127 } MPI2_SCSI_IO_CDB_UNION, MPI2_POINTER PTR_MPI2_SCSI_IO_CDB_UNION,
  128   Mpi2ScsiIoCdb_t, MPI2_POINTER pMpi2ScsiIoCdb_t;
  129 
  130 /* MPI v2.0 SCSI IO Request Message */
  131 typedef struct _MPI2_SCSI_IO_REQUEST
  132 {
  133     U16                     DevHandle;                      /* 0x00 */
  134     U8                      ChainOffset;                    /* 0x02 */
  135     U8                      Function;                       /* 0x03 */
  136     U16                     Reserved1;                      /* 0x04 */
  137     U8                      Reserved2;                      /* 0x06 */
  138     U8                      MsgFlags;                       /* 0x07 */
  139     U8                      VP_ID;                          /* 0x08 */
  140     U8                      VF_ID;                          /* 0x09 */
  141     U16                     Reserved3;                      /* 0x0A */
  142     U32                     SenseBufferLowAddress;          /* 0x0C */
  143     U16                     SGLFlags;                       /* 0x10 */
  144     U8                      SenseBufferLength;              /* 0x12 */
  145     U8                      Reserved4;                      /* 0x13 */
  146     U8                      SGLOffset0;                     /* 0x14 */
  147     U8                      SGLOffset1;                     /* 0x15 */
  148     U8                      SGLOffset2;                     /* 0x16 */
  149     U8                      SGLOffset3;                     /* 0x17 */
  150     U32                     SkipCount;                      /* 0x18 */
  151     U32                     DataLength;                     /* 0x1C */
  152     U32                     BidirectionalDataLength;        /* 0x20 */
  153     U16                     IoFlags;                        /* 0x24 */
  154     U16                     EEDPFlags;                      /* 0x26 */
  155     U32                     EEDPBlockSize;                  /* 0x28 */
  156     U32                     SecondaryReferenceTag;          /* 0x2C */
  157     U16                     SecondaryApplicationTag;        /* 0x30 */
  158     U16                     ApplicationTagTranslationMask;  /* 0x32 */
  159     U8                      LUN[8];                         /* 0x34 */
  160     U32                     Control;                        /* 0x3C */
  161     MPI2_SCSI_IO_CDB_UNION  CDB;                            /* 0x40 */
  162 
  163 #ifdef MPI2_SCSI_IO_VENDOR_UNIQUE_REGION /* typically this is left undefined */
  164     MPI2_SCSI_IO_VENDOR_UNIQUE VendorRegion;
  165 #endif
  166 
  167     MPI2_SGE_IO_UNION       SGL;                            /* 0x60 */
  168 
  169 } MPI2_SCSI_IO_REQUEST, MPI2_POINTER PTR_MPI2_SCSI_IO_REQUEST,
  170   Mpi2SCSIIORequest_t, MPI2_POINTER pMpi2SCSIIORequest_t;
  171 
  172 /* SCSI IO MsgFlags bits */
  173 
  174 /* MsgFlags for SenseBufferAddressSpace */
  175 #define MPI2_SCSIIO_MSGFLAGS_MASK_SENSE_ADDR        (0x0C)
  176 #define MPI2_SCSIIO_MSGFLAGS_SYSTEM_SENSE_ADDR      (0x00)
  177 #define MPI2_SCSIIO_MSGFLAGS_IOCDDR_SENSE_ADDR      (0x04)
  178 #define MPI2_SCSIIO_MSGFLAGS_IOCPLB_SENSE_ADDR      (0x08) /* for MPI v2.5 and earlier only */
  179 #define MPI2_SCSIIO_MSGFLAGS_IOCPLBNTA_SENSE_ADDR   (0x0C) /* for MPI v2.5 and earlier only */
  180 #define MPI26_SCSIIO_MSGFLAGS_IOCCTL_SENSE_ADDR     (0x08) /* for MPI v2.6 only */
  181 
  182 /* SCSI IO SGLFlags bits */
  183 
  184 /* base values for Data Location Address Space */
  185 #define MPI2_SCSIIO_SGLFLAGS_ADDR_MASK              (0x0C)
  186 #define MPI2_SCSIIO_SGLFLAGS_SYSTEM_ADDR            (0x00)
  187 #define MPI2_SCSIIO_SGLFLAGS_IOCDDR_ADDR            (0x04)
  188 #define MPI2_SCSIIO_SGLFLAGS_IOCPLB_ADDR            (0x08)
  189 #define MPI2_SCSIIO_SGLFLAGS_IOCPLBNTA_ADDR         (0x0C)
  190 
  191 /* base values for Type */
  192 #define MPI2_SCSIIO_SGLFLAGS_TYPE_MASK              (0x03)
  193 #define MPI2_SCSIIO_SGLFLAGS_TYPE_MPI               (0x00)
  194 #define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE32            (0x01)
  195 #define MPI2_SCSIIO_SGLFLAGS_TYPE_IEEE64            (0x02)
  196 
  197 /* shift values for each sub-field */
  198 #define MPI2_SCSIIO_SGLFLAGS_SGL3_SHIFT             (12)
  199 #define MPI2_SCSIIO_SGLFLAGS_SGL2_SHIFT             (8)
  200 #define MPI2_SCSIIO_SGLFLAGS_SGL1_SHIFT             (4)
  201 #define MPI2_SCSIIO_SGLFLAGS_SGL0_SHIFT             (0)
  202 
  203 /* number of SGLOffset fields */
  204 #define MPI2_SCSIIO_NUM_SGLOFFSETS                  (4)
  205 
  206 /* SCSI IO IoFlags bits */
  207 
  208 /* Large CDB Address Space */
  209 #define MPI2_SCSIIO_CDB_ADDR_MASK                   (0x6000)
  210 #define MPI2_SCSIIO_CDB_ADDR_SYSTEM                 (0x0000)
  211 #define MPI2_SCSIIO_CDB_ADDR_IOCDDR                 (0x2000)
  212 #define MPI2_SCSIIO_CDB_ADDR_IOCPLB                 (0x4000)
  213 #define MPI2_SCSIIO_CDB_ADDR_IOCPLBNTA              (0x6000)
  214 
  215 #define MPI2_SCSIIO_IOFLAGS_LARGE_CDB               (0x1000)
  216 #define MPI2_SCSIIO_IOFLAGS_BIDIRECTIONAL           (0x0800)
  217 #define MPI2_SCSIIO_IOFLAGS_MULTICAST               (0x0400)
  218 #define MPI2_SCSIIO_IOFLAGS_CMD_DETERMINES_DATA_DIR (0x0200)
  219 #define MPI2_SCSIIO_IOFLAGS_CDBLENGTH_MASK          (0x01FF)
  220 
  221 /* SCSI IO EEDPFlags bits */
  222 
  223 #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_REFTAG        (0x8000)
  224 #define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_REFTAG        (0x4000)
  225 #define MPI2_SCSIIO_EEDPFLAGS_INC_PRI_APPTAG        (0x2000)
  226 #define MPI2_SCSIIO_EEDPFLAGS_INC_SEC_APPTAG        (0x1000)
  227 
  228 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REFTAG          (0x0400)
  229 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_APPTAG          (0x0200)
  230 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_GUARD           (0x0100)
  231 
  232 #define MPI2_SCSIIO_EEDPFLAGS_PASSTHRU_REFTAG       (0x0008)
  233 
  234 #define MPI2_SCSIIO_EEDPFLAGS_MASK_OP               (0x0007)
  235 #define MPI2_SCSIIO_EEDPFLAGS_NOOP_OP               (0x0000)
  236 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_OP              (0x0001)
  237 #define MPI2_SCSIIO_EEDPFLAGS_STRIP_OP              (0x0002)
  238 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REMOVE_OP       (0x0003)
  239 #define MPI2_SCSIIO_EEDPFLAGS_INSERT_OP             (0x0004)
  240 #define MPI2_SCSIIO_EEDPFLAGS_REPLACE_OP            (0x0006)
  241 #define MPI2_SCSIIO_EEDPFLAGS_CHECK_REGEN_OP        (0x0007)
  242 
  243 /* SCSI IO LUN fields: use MPI2_LUN_ from mpi2.h */
  244 
  245 /* SCSI IO Control bits */
  246 #define MPI2_SCSIIO_CONTROL_ADDCDBLEN_MASK      (0xFC000000)
  247 #define MPI2_SCSIIO_CONTROL_ADDCDBLEN_SHIFT     (26)
  248 
  249 #define MPI2_SCSIIO_CONTROL_DATADIRECTION_MASK  (0x03000000)
  250 #define MPI2_SCSIIO_CONTROL_SHIFT_DATADIRECTION (24)
  251 #define MPI2_SCSIIO_CONTROL_NODATATRANSFER      (0x00000000)
  252 #define MPI2_SCSIIO_CONTROL_WRITE               (0x01000000)
  253 #define MPI2_SCSIIO_CONTROL_READ                (0x02000000)
  254 #define MPI2_SCSIIO_CONTROL_BIDIRECTIONAL       (0x03000000)
  255 
  256 #define MPI2_SCSIIO_CONTROL_TASKPRI_MASK        (0x00007800)
  257 #define MPI2_SCSIIO_CONTROL_TASKPRI_SHIFT       (11)
  258 /* alternate name for the previous field; called Command Priority in SAM-4 */
  259 #define MPI2_SCSIIO_CONTROL_CMDPRI_MASK         (0x00007800)
  260 #define MPI2_SCSIIO_CONTROL_CMDPRI_SHIFT        (11)
  261 
  262 #define MPI2_SCSIIO_CONTROL_TASKATTRIBUTE_MASK  (0x00000700)
  263 #define MPI2_SCSIIO_CONTROL_SIMPLEQ             (0x00000000)
  264 #define MPI2_SCSIIO_CONTROL_HEADOFQ             (0x00000100)
  265 #define MPI2_SCSIIO_CONTROL_ORDEREDQ            (0x00000200)
  266 #define MPI2_SCSIIO_CONTROL_ACAQ                (0x00000400)
  267 
  268 #define MPI2_SCSIIO_CONTROL_TLR_MASK            (0x000000C0)
  269 #define MPI2_SCSIIO_CONTROL_NO_TLR              (0x00000000)
  270 #define MPI2_SCSIIO_CONTROL_TLR_ON              (0x00000040)
  271 #define MPI2_SCSIIO_CONTROL_TLR_OFF             (0x00000080)
  272 
  273 
  274 /* MPI v2.5 CDB field */
  275 typedef union _MPI25_SCSI_IO_CDB_UNION
  276 {
  277     U8                      CDB32[32];
  278     MPI2_SCSI_IO_CDB_EEDP32 EEDP32;
  279     MPI2_IEEE_SGE_SIMPLE64  SGE;
  280 } MPI25_SCSI_IO_CDB_UNION, MPI2_POINTER PTR_MPI25_SCSI_IO_CDB_UNION,
  281   Mpi25ScsiIoCdb_t, MPI2_POINTER pMpi25ScsiIoCdb_t;
  282 
  283 /* MPI v2.5/2.6 SCSI IO Request Message */
  284 typedef struct _MPI25_SCSI_IO_REQUEST
  285 {
  286     U16                     DevHandle;                      /* 0x00 */
  287     U8                      ChainOffset;                    /* 0x02 */
  288     U8                      Function;                       /* 0x03 */
  289     U16                     Reserved1;                      /* 0x04 */
  290     U8                      Reserved2;                      /* 0x06 */
  291     U8                      MsgFlags;                       /* 0x07 */
  292     U8                      VP_ID;                          /* 0x08 */
  293     U8                      VF_ID;                          /* 0x09 */
  294     U16                     Reserved3;                      /* 0x0A */
  295     U32                     SenseBufferLowAddress;          /* 0x0C */
  296     U8                      DMAFlags;                       /* 0x10 */
  297     U8                      Reserved5;                      /* 0x11 */
  298     U8                      SenseBufferLength;              /* 0x12 */
  299     U8                      Reserved4;                      /* 0x13 */
  300     U8                      SGLOffset0;                     /* 0x14 */
  301     U8                      SGLOffset1;                     /* 0x15 */
  302     U8                      SGLOffset2;                     /* 0x16 */
  303     U8                      SGLOffset3;                     /* 0x17 */
  304     U32                     SkipCount;                      /* 0x18 */
  305     U32                     DataLength;                     /* 0x1C */
  306     U32                     BidirectionalDataLength;        /* 0x20 */
  307     U16                     IoFlags;                        /* 0x24 */
  308     U16                     EEDPFlags;                      /* 0x26 */
  309     U16                     EEDPBlockSize;                  /* 0x28 */
  310     U16                     Reserved6;                      /* 0x2A */
  311     U32                     SecondaryReferenceTag;          /* 0x2C */
  312     U16                     SecondaryApplicationTag;        /* 0x30 */
  313     U16                     ApplicationTagTranslationMask;  /* 0x32 */
  314     U8                      LUN[8];                         /* 0x34 */
  315     U32                     Control;                        /* 0x3C */
  316     MPI25_SCSI_IO_CDB_UNION CDB;                            /* 0x40 */
  317 
  318 #ifdef MPI25_SCSI_IO_VENDOR_UNIQUE_REGION /* typically this is left undefined */
  319     MPI25_SCSI_IO_VENDOR_UNIQUE VendorRegion;
  320 #endif
  321 
  322     MPI25_SGE_IO_UNION      SGL;                            /* 0x60 */
  323 
  324 } MPI25_SCSI_IO_REQUEST, MPI2_POINTER PTR_MPI25_SCSI_IO_REQUEST,
  325   Mpi25SCSIIORequest_t, MPI2_POINTER pMpi25SCSIIORequest_t;
  326 
  327 /* use MPI2_SCSIIO_MSGFLAGS_ defines for the MsgFlags field */
  328 
  329 /* Defines for the DMAFlags field
  330  *  Each setting affects 4 SGLS, from SGL0 to SGL3.
  331  *      D = Data
  332  *      C = Cache DIF
  333  *      I = Interleaved
  334  *      H = Host DIF
  335  */
  336 #define MPI25_SCSIIO_DMAFLAGS_OP_MASK               (0x0F)
  337 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_D            (0x00)
  338 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_C            (0x01)
  339 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_D_I            (0x02)
  340 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_C_C            (0x03)
  341 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_C_I            (0x04)
  342 #define MPI25_SCSIIO_DMAFLAGS_OP_D_D_I_I            (0x05)
  343 #define MPI25_SCSIIO_DMAFLAGS_OP_D_C_C_C            (0x06)
  344 #define MPI25_SCSIIO_DMAFLAGS_OP_D_C_C_I            (0x07)
  345 #define MPI25_SCSIIO_DMAFLAGS_OP_D_C_I_I            (0x08)
  346 #define MPI25_SCSIIO_DMAFLAGS_OP_D_I_I_I            (0x09)
  347 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_D            (0x0A)
  348 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_C            (0x0B)
  349 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_D_I            (0x0C)
  350 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_C_C            (0x0D)
  351 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_C_I            (0x0E)
  352 #define MPI25_SCSIIO_DMAFLAGS_OP_D_H_I_I            (0x0F)
  353 
  354 /* number of SGLOffset fields */
  355 #define MPI25_SCSIIO_NUM_SGLOFFSETS                 (4)
  356 
  357 /* defines for the IoFlags field */
  358 #define MPI25_SCSIIO_IOFLAGS_IO_PATH_MASK           (0xC000)
  359 #define MPI25_SCSIIO_IOFLAGS_NORMAL_PATH            (0x0000)
  360 #define MPI25_SCSIIO_IOFLAGS_FAST_PATH              (0x4000)
  361 
  362 #define MPI26_SCSIIO_IOFLAGS_ESCAPE_PASSTHROUGH         (0x2000) /* MPI v2.6 and later */
  363 #define MPI25_SCSIIO_IOFLAGS_LARGE_CDB                  (0x1000)
  364 #define MPI25_SCSIIO_IOFLAGS_BIDIRECTIONAL              (0x0800)
  365 #define MPI26_SCSIIO_IOFLAGS_PORT_REQUEST               (0x0400) /* MPI v2.6 and later; IOC use only */
  366 #define MPI25_SCSIIO_IOFLAGS_CDBLENGTH_MASK             (0x01FF)
  367 
  368 /* MPI v2.5 defines for the EEDPFlags bits */
  369 /* use MPI2_SCSIIO_EEDPFLAGS_ defines for the other EEDPFlags bits */
  370 #define MPI25_SCSIIO_EEDPFLAGS_ESCAPE_MODE_MASK             (0x00C0)
  371 #define MPI25_SCSIIO_EEDPFLAGS_COMPATIBLE_MODE              (0x0000)
  372 #define MPI25_SCSIIO_EEDPFLAGS_DO_NOT_DISABLE_MODE          (0x0040)
  373 #define MPI25_SCSIIO_EEDPFLAGS_APPTAG_DISABLE_MODE          (0x0080)
  374 #define MPI25_SCSIIO_EEDPFLAGS_APPTAG_REFTAG_DISABLE_MODE   (0x00C0)
  375 
  376 #define MPI25_SCSIIO_EEDPFLAGS_HOST_GUARD_METHOD_MASK       (0x0030)
  377 #define MPI25_SCSIIO_EEDPFLAGS_T10_CRC_HOST_GUARD           (0x0000)
  378 #define MPI25_SCSIIO_EEDPFLAGS_IP_CHKSUM_HOST_GUARD         (0x0010)
  379 
  380 /* use MPI2_LUN_ defines from mpi2.h for the LUN field */
  381 
  382 /* use MPI2_SCSIIO_CONTROL_ defines for the Control field */
  383 
  384 
  385 /* NOTE: The SCSI IO Reply is nearly the same for MPI 2.0 and MPI 2.5, so
  386  *       MPI2_SCSI_IO_REPLY is used for both.
  387  */
  388 
  389 /* SCSI IO Error Reply Message */
  390 typedef struct _MPI2_SCSI_IO_REPLY
  391 {
  392     U16                     DevHandle;                      /* 0x00 */
  393     U8                      MsgLength;                      /* 0x02 */
  394     U8                      Function;                       /* 0x03 */
  395     U16                     Reserved1;                      /* 0x04 */
  396     U8                      Reserved2;                      /* 0x06 */
  397     U8                      MsgFlags;                       /* 0x07 */
  398     U8                      VP_ID;                          /* 0x08 */
  399     U8                      VF_ID;                          /* 0x09 */
  400     U16                     Reserved3;                      /* 0x0A */
  401     U8                      SCSIStatus;                     /* 0x0C */
  402     U8                      SCSIState;                      /* 0x0D */
  403     U16                     IOCStatus;                      /* 0x0E */
  404     U32                     IOCLogInfo;                     /* 0x10 */
  405     U32                     TransferCount;                  /* 0x14 */
  406     U32                     SenseCount;                     /* 0x18 */
  407     U32                     ResponseInfo;                   /* 0x1C */
  408     U16                     TaskTag;                        /* 0x20 */
  409     U16                     SCSIStatusQualifier;            /* 0x22 */
  410     U32                     BidirectionalTransferCount;     /* 0x24 */
  411     U32                     EEDPErrorOffset;                /* 0x28 */ /* MPI 2.5+ only; Reserved in MPI 2.0 */
  412     U16                     EEDPObservedAppTag;             /* 0x2C */ /* MPI 2.5+ only; Reserved in MPI 2.0 */
  413     U16                     EEDPObservedGuard;              /* 0x2E */ /* MPI 2.5+ only; Reserved in MPI 2.0 */
  414     U32                     EEDPObservedRefTag;             /* 0x30 */ /* MPI 2.5+ only; Reserved in MPI 2.0 */
  415 } MPI2_SCSI_IO_REPLY, MPI2_POINTER PTR_MPI2_SCSI_IO_REPLY,
  416   Mpi2SCSIIOReply_t, MPI2_POINTER pMpi2SCSIIOReply_t;
  417 
  418 /* SCSI IO Reply MsgFlags bits */
  419 #define MPI26_SCSIIO_REPLY_MSGFLAGS_REFTAG_OBSERVED_VALID     (0x01)
  420 #define MPI26_SCSIIO_REPLY_MSGFLAGS_GUARD_OBSERVED_VALID      (0x02)
  421 #define MPI26_SCSIIO_REPLY_MSGFLAGS_APPTAG_OBSERVED_VALID     (0x04)
  422 
  423 
  424 /* SCSI IO Reply SCSIStatus values (SAM-4 status codes) */
  425 
  426 #define MPI2_SCSI_STATUS_GOOD                   (0x00)
  427 #define MPI2_SCSI_STATUS_CHECK_CONDITION        (0x02)
  428 #define MPI2_SCSI_STATUS_CONDITION_MET          (0x04)
  429 #define MPI2_SCSI_STATUS_BUSY                   (0x08)
  430 #define MPI2_SCSI_STATUS_INTERMEDIATE           (0x10)
  431 #define MPI2_SCSI_STATUS_INTERMEDIATE_CONDMET   (0x14)
  432 #define MPI2_SCSI_STATUS_RESERVATION_CONFLICT   (0x18)
  433 #define MPI2_SCSI_STATUS_COMMAND_TERMINATED     (0x22) /* obsolete */
  434 #define MPI2_SCSI_STATUS_TASK_SET_FULL          (0x28)
  435 #define MPI2_SCSI_STATUS_ACA_ACTIVE             (0x30)
  436 #define MPI2_SCSI_STATUS_TASK_ABORTED           (0x40)
  437 
  438 /* SCSI IO Reply SCSIState flags */
  439 
  440 #define MPI2_SCSI_STATE_RESPONSE_INFO_VALID     (0x10)
  441 #define MPI2_SCSI_STATE_TERMINATED              (0x08)
  442 #define MPI2_SCSI_STATE_NO_SCSI_STATUS          (0x04)
  443 #define MPI2_SCSI_STATE_AUTOSENSE_FAILED        (0x02)
  444 #define MPI2_SCSI_STATE_AUTOSENSE_VALID         (0x01)
  445 
  446 /* masks and shifts for the ResponseInfo field */
  447 
  448 #define MPI2_SCSI_RI_MASK_REASONCODE            (0x000000FF)
  449 #define MPI2_SCSI_RI_SHIFT_REASONCODE           (0)
  450 
  451 #define MPI2_SCSI_TASKTAG_UNKNOWN               (0xFFFF)
  452 
  453 
  454 /****************************************************************************
  455 *  SCSI Task Management messages
  456 ****************************************************************************/
  457 
  458 /* SCSI Task Management Request Message */
  459 typedef struct _MPI2_SCSI_TASK_MANAGE_REQUEST
  460 {
  461     U16                     DevHandle;                      /* 0x00 */
  462     U8                      ChainOffset;                    /* 0x02 */
  463     U8                      Function;                       /* 0x03 */
  464     U8                      Reserved1;                      /* 0x04 */
  465     U8                      TaskType;                       /* 0x05 */
  466     U8                      Reserved2;                      /* 0x06 */
  467     U8                      MsgFlags;                       /* 0x07 */
  468     U8                      VP_ID;                          /* 0x08 */
  469     U8                      VF_ID;                          /* 0x09 */
  470     U16                     Reserved3;                      /* 0x0A */
  471     U8                      LUN[8];                         /* 0x0C */
  472     U32                     Reserved4[7];                   /* 0x14 */
  473     U16                     TaskMID;                        /* 0x30 */
  474     U16                     Reserved5;                      /* 0x32 */
  475 } MPI2_SCSI_TASK_MANAGE_REQUEST,
  476   MPI2_POINTER PTR_MPI2_SCSI_TASK_MANAGE_REQUEST,
  477   Mpi2SCSITaskManagementRequest_t,
  478   MPI2_POINTER pMpi2SCSITaskManagementRequest_t;
  479 
  480 /* TaskType values */
  481 
  482 #define MPI2_SCSITASKMGMT_TASKTYPE_ABORT_TASK           (0x01)
  483 #define MPI2_SCSITASKMGMT_TASKTYPE_ABRT_TASK_SET        (0x02)
  484 #define MPI2_SCSITASKMGMT_TASKTYPE_TARGET_RESET         (0x03)
  485 #define MPI2_SCSITASKMGMT_TASKTYPE_LOGICAL_UNIT_RESET   (0x05)
  486 #define MPI2_SCSITASKMGMT_TASKTYPE_CLEAR_TASK_SET       (0x06)
  487 #define MPI2_SCSITASKMGMT_TASKTYPE_QUERY_TASK           (0x07)
  488 #define MPI2_SCSITASKMGMT_TASKTYPE_CLR_ACA              (0x08)
  489 #define MPI2_SCSITASKMGMT_TASKTYPE_QRY_TASK_SET         (0x09)
  490 #define MPI2_SCSITASKMGMT_TASKTYPE_QRY_ASYNC_EVENT      (0x0A)
  491 
  492 /* obsolete TaskType name */
  493 #define MPI2_SCSITASKMGMT_TASKTYPE_QRY_UNIT_ATTENTION   (MPI2_SCSITASKMGMT_TASKTYPE_QRY_ASYNC_EVENT)
  494 
  495 /* MsgFlags bits */
  496 #define MPI2_SCSITASKMGMT_MSGFLAGS_MASK_TARGET_RESET      (0x18)
  497 #define MPI26_SCSITASKMGMT_MSGFLAGS_HOT_RESET_PCIE        (0x00)
  498 #define MPI2_SCSITASKMGMT_MSGFLAGS_LINK_RESET             (0x00)
  499 #define MPI2_SCSITASKMGMT_MSGFLAGS_DO_NOT_SEND_TASK_IU    (0x01)
  500 #define MPI2_SCSITASKMGMT_MSGFLAGS_NEXUS_RESET_SRST       (0x08)
  501 #define MPI2_SCSITASKMGMT_MSGFLAGS_SAS_HARD_LINK_RESET    (0x10)
  502 #define MPI26_SCSITASKMGMT_MSGFLAGS_PROTOCOL_LVL_RST_PCIE (0x18)
  503 
  504 
  505 /* SCSI Task Management Reply Message */
  506 typedef struct _MPI2_SCSI_TASK_MANAGE_REPLY
  507 {
  508     U16                     DevHandle;                      /* 0x00 */
  509     U8                      MsgLength;                      /* 0x02 */
  510     U8                      Function;                       /* 0x03 */
  511     U8                      ResponseCode;                   /* 0x04 */
  512     U8                      TaskType;                       /* 0x05 */
  513     U8                      Reserved1;                      /* 0x06 */
  514     U8                      MsgFlags;                       /* 0x07 */
  515     U8                      VP_ID;                          /* 0x08 */
  516     U8                      VF_ID;                          /* 0x09 */
  517     U16                     Reserved2;                      /* 0x0A */
  518     U16                     Reserved3;                      /* 0x0C */
  519     U16                     IOCStatus;                      /* 0x0E */
  520     U32                     IOCLogInfo;                     /* 0x10 */
  521     U32                     TerminationCount;               /* 0x14 */
  522     U32                     ResponseInfo;                   /* 0x18 */
  523 } MPI2_SCSI_TASK_MANAGE_REPLY,
  524   MPI2_POINTER PTR_MPI2_SCSI_TASK_MANAGE_REPLY,
  525   Mpi2SCSITaskManagementReply_t, MPI2_POINTER pMpi2SCSIManagementReply_t;
  526 
  527 /* ResponseCode values */
  528 
  529 #define MPI2_SCSITASKMGMT_RSP_TM_COMPLETE               (0x00)
  530 #define MPI2_SCSITASKMGMT_RSP_INVALID_FRAME             (0x02)
  531 #define MPI2_SCSITASKMGMT_RSP_TM_NOT_SUPPORTED          (0x04)
  532 #define MPI2_SCSITASKMGMT_RSP_TM_FAILED                 (0x05)
  533 #define MPI2_SCSITASKMGMT_RSP_TM_SUCCEEDED              (0x08)
  534 #define MPI2_SCSITASKMGMT_RSP_TM_INVALID_LUN            (0x09)
  535 #define MPI2_SCSITASKMGMT_RSP_TM_OVERLAPPED_TAG         (0x0A)
  536 #define MPI2_SCSITASKMGMT_RSP_IO_QUEUED_ON_IOC          (0x80)
  537 
  538 /* masks and shifts for the ResponseInfo field */
  539 
  540 #define MPI2_SCSITASKMGMT_RI_MASK_REASONCODE            (0x000000FF)
  541 #define MPI2_SCSITASKMGMT_RI_SHIFT_REASONCODE           (0)
  542 #define MPI2_SCSITASKMGMT_RI_MASK_ARI2                  (0x0000FF00)
  543 #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI2                 (8)
  544 #define MPI2_SCSITASKMGMT_RI_MASK_ARI1                  (0x00FF0000)
  545 #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI1                 (16)
  546 #define MPI2_SCSITASKMGMT_RI_MASK_ARI0                  (0xFF000000)
  547 #define MPI2_SCSITASKMGMT_RI_SHIFT_ARI0                 (24)
  548 
  549 
  550 /****************************************************************************
  551 *  SCSI Enclosure Processor messages
  552 ****************************************************************************/
  553 
  554 /* SCSI Enclosure Processor Request Message */
  555 typedef struct _MPI2_SEP_REQUEST
  556 {
  557     U16                     DevHandle;          /* 0x00 */
  558     U8                      ChainOffset;        /* 0x02 */
  559     U8                      Function;           /* 0x03 */
  560     U8                      Action;             /* 0x04 */
  561     U8                      Flags;              /* 0x05 */
  562     U8                      Reserved1;          /* 0x06 */
  563     U8                      MsgFlags;           /* 0x07 */
  564     U8                      VP_ID;              /* 0x08 */
  565     U8                      VF_ID;              /* 0x09 */
  566     U16                     Reserved2;          /* 0x0A */
  567     U32                     SlotStatus;         /* 0x0C */
  568     U32                     Reserved3;          /* 0x10 */
  569     U32                     Reserved4;          /* 0x14 */
  570     U32                     Reserved5;          /* 0x18 */
  571     U16                     Slot;               /* 0x1C */
  572     U16                     EnclosureHandle;    /* 0x1E */
  573 } MPI2_SEP_REQUEST, MPI2_POINTER PTR_MPI2_SEP_REQUEST,
  574   Mpi2SepRequest_t, MPI2_POINTER pMpi2SepRequest_t;
  575 
  576 /* Action defines */
  577 #define MPI2_SEP_REQ_ACTION_WRITE_STATUS                (0x00)
  578 #define MPI2_SEP_REQ_ACTION_READ_STATUS                 (0x01)
  579 
  580 /* Flags defines */
  581 #define MPI2_SEP_REQ_FLAGS_DEVHANDLE_ADDRESS            (0x00)
  582 #define MPI2_SEP_REQ_FLAGS_ENCLOSURE_SLOT_ADDRESS       (0x01)
  583 
  584 /* SlotStatus defines */
  585 #define MPI2_SEP_REQ_SLOTSTATUS_DEV_OFF                 (0x00080000) /* MPI v2.6 and newer */
  586 #define MPI2_SEP_REQ_SLOTSTATUS_REQUEST_REMOVE          (0x00040000)
  587 #define MPI2_SEP_REQ_SLOTSTATUS_IDENTIFY_REQUEST        (0x00020000)
  588 #define MPI2_SEP_REQ_SLOTSTATUS_REBUILD_STOPPED         (0x00000200)
  589 #define MPI2_SEP_REQ_SLOTSTATUS_HOT_SPARE               (0x00000100)
  590 #define MPI2_SEP_REQ_SLOTSTATUS_UNCONFIGURED            (0x00000080)
  591 #define MPI2_SEP_REQ_SLOTSTATUS_PREDICTED_FAULT         (0x00000040)
  592 #define MPI2_SEP_REQ_SLOTSTATUS_IN_CRITICAL_ARRAY       (0x00000010)
  593 #define MPI2_SEP_REQ_SLOTSTATUS_IN_FAILED_ARRAY         (0x00000008)
  594 #define MPI2_SEP_REQ_SLOTSTATUS_DEV_REBUILDING          (0x00000004)
  595 #define MPI2_SEP_REQ_SLOTSTATUS_DEV_FAULTY              (0x00000002)
  596 #define MPI2_SEP_REQ_SLOTSTATUS_NO_ERROR                (0x00000001)
  597 
  598 
  599 /* SCSI Enclosure Processor Reply Message */
  600 typedef struct _MPI2_SEP_REPLY
  601 {
  602     U16                     DevHandle;          /* 0x00 */
  603     U8                      MsgLength;          /* 0x02 */
  604     U8                      Function;           /* 0x03 */
  605     U8                      Action;             /* 0x04 */
  606     U8                      Flags;              /* 0x05 */
  607     U8                      Reserved1;          /* 0x06 */
  608     U8                      MsgFlags;           /* 0x07 */
  609     U8                      VP_ID;              /* 0x08 */
  610     U8                      VF_ID;              /* 0x09 */
  611     U16                     Reserved2;          /* 0x0A */
  612     U16                     Reserved3;          /* 0x0C */
  613     U16                     IOCStatus;          /* 0x0E */
  614     U32                     IOCLogInfo;         /* 0x10 */
  615     U32                     SlotStatus;         /* 0x14 */
  616     U32                     Reserved4;          /* 0x18 */
  617     U16                     Slot;               /* 0x1C */
  618     U16                     EnclosureHandle;    /* 0x1E */
  619 } MPI2_SEP_REPLY, MPI2_POINTER PTR_MPI2_SEP_REPLY,
  620   Mpi2SepReply_t, MPI2_POINTER pMpi2SepReply_t;
  621 
  622 /* SlotStatus defines */
  623 #define MPI2_SEP_REPLY_SLOTSTATUS_DEV_OFF               (0x00080000) /* MPI v2.6 and newer */
  624 #define MPI2_SEP_REPLY_SLOTSTATUS_REMOVE_READY          (0x00040000)
  625 #define MPI2_SEP_REPLY_SLOTSTATUS_IDENTIFY_REQUEST      (0x00020000)
  626 #define MPI2_SEP_REPLY_SLOTSTATUS_REBUILD_STOPPED       (0x00000200)
  627 #define MPI2_SEP_REPLY_SLOTSTATUS_HOT_SPARE             (0x00000100)
  628 #define MPI2_SEP_REPLY_SLOTSTATUS_UNCONFIGURED          (0x00000080)
  629 #define MPI2_SEP_REPLY_SLOTSTATUS_PREDICTED_FAULT       (0x00000040)
  630 #define MPI2_SEP_REPLY_SLOTSTATUS_IN_CRITICAL_ARRAY     (0x00000010)
  631 #define MPI2_SEP_REPLY_SLOTSTATUS_IN_FAILED_ARRAY       (0x00000008)
  632 #define MPI2_SEP_REPLY_SLOTSTATUS_DEV_REBUILDING        (0x00000004)
  633 #define MPI2_SEP_REPLY_SLOTSTATUS_DEV_FAULTY            (0x00000002)
  634 #define MPI2_SEP_REPLY_SLOTSTATUS_NO_ERROR              (0x00000001)
  635 
  636 
  637 #endif
  638 
  639 

Cache object: ea1ccbb957f02679fdfbbd7867caeb67


[ 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.