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/mps/mpi/mpi2_sas.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  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
    3  *
    4  * Copyright (c) 2007-2015 LSI Corp.
    5  * Copyright (c) 2013-2015 Avago Technologies
    6  * All rights reserved.
    7  *
    8  * Redistribution and use in source and binary forms, with or without
    9  * modification, are permitted provided that the following conditions
   10  * are met:
   11  * 1. Redistributions of source code must retain the above copyright
   12  *    notice, this list of conditions and the following disclaimer.
   13  * 2. Redistributions in binary form must reproduce the above copyright
   14  *    notice, this list of conditions and the following disclaimer in the
   15  *    documentation and/or other materials provided with the distribution.
   16  *
   17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
   18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
   21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
   22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
   23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
   24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
   25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   27  * SUCH DAMAGE.
   28  *
   29  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
   30  *
   31  * $FreeBSD$
   32  */
   33 
   34 /*
   35  *  Copyright (c) 2007-2015 LSI Corporation.
   36  *  Copyright (c) 2013-2015 Avago Technologies
   37  *
   38  *
   39  *           Name:  mpi2_sas.h
   40  *          Title:  MPI Serial Attached SCSI structures and definitions
   41  *  Creation Date:  February 9, 2007
   42  *
   43  *  mpi2_sas.h Version:  02.00.05
   44  *
   45  *  Version History
   46  *  ---------------
   47  *
   48  *  Date      Version   Description
   49  *  --------  --------  ------------------------------------------------------
   50  *  04-30-07  02.00.00  Corresponds to Fusion-MPT MPI Specification Rev A.
   51  *  06-26-07  02.00.01  Added Clear All Persistent Operation to SAS IO Unit
   52  *                      Control Request.
   53  *  10-02-08  02.00.02  Added Set IOC Parameter Operation to SAS IO Unit Control
   54  *                      Request.
   55  *  10-28-09  02.00.03  Changed the type of SGL in MPI2_SATA_PASSTHROUGH_REQUEST
   56  *                      to MPI2_SGE_IO_UNION since it supports chained SGLs.
   57  *  05-12-10  02.00.04  Modified some comments.
   58  *  08-11-10  02.00.05  Added NCQ operations to SAS IO Unit Control.
   59  *  --------------------------------------------------------------------------
   60  */
   61 
   62 #ifndef MPI2_SAS_H
   63 #define MPI2_SAS_H
   64 
   65 /*
   66  * Values for SASStatus.
   67  */
   68 #define MPI2_SASSTATUS_SUCCESS                          (0x00)
   69 #define MPI2_SASSTATUS_UNKNOWN_ERROR                    (0x01)
   70 #define MPI2_SASSTATUS_INVALID_FRAME                    (0x02)
   71 #define MPI2_SASSTATUS_UTC_BAD_DEST                     (0x03)
   72 #define MPI2_SASSTATUS_UTC_BREAK_RECEIVED               (0x04)
   73 #define MPI2_SASSTATUS_UTC_CONNECT_RATE_NOT_SUPPORTED   (0x05)
   74 #define MPI2_SASSTATUS_UTC_PORT_LAYER_REQUEST           (0x06)
   75 #define MPI2_SASSTATUS_UTC_PROTOCOL_NOT_SUPPORTED       (0x07)
   76 #define MPI2_SASSTATUS_UTC_STP_RESOURCES_BUSY           (0x08)
   77 #define MPI2_SASSTATUS_UTC_WRONG_DESTINATION            (0x09)
   78 #define MPI2_SASSTATUS_SHORT_INFORMATION_UNIT           (0x0A)
   79 #define MPI2_SASSTATUS_LONG_INFORMATION_UNIT            (0x0B)
   80 #define MPI2_SASSTATUS_XFER_RDY_INCORRECT_WRITE_DATA    (0x0C)
   81 #define MPI2_SASSTATUS_XFER_RDY_REQUEST_OFFSET_ERROR    (0x0D)
   82 #define MPI2_SASSTATUS_XFER_RDY_NOT_EXPECTED            (0x0E)
   83 #define MPI2_SASSTATUS_DATA_INCORRECT_DATA_LENGTH       (0x0F)
   84 #define MPI2_SASSTATUS_DATA_TOO_MUCH_READ_DATA          (0x10)
   85 #define MPI2_SASSTATUS_DATA_OFFSET_ERROR                (0x11)
   86 #define MPI2_SASSTATUS_SDSF_NAK_RECEIVED                (0x12)
   87 #define MPI2_SASSTATUS_SDSF_CONNECTION_FAILED           (0x13)
   88 #define MPI2_SASSTATUS_INITIATOR_RESPONSE_TIMEOUT       (0x14)
   89 
   90 /*
   91  * Values for the SAS DeviceInfo field used in SAS Device Status Change Event
   92  * data and SAS Configuration pages.
   93  */
   94 #define MPI2_SAS_DEVICE_INFO_SEP                (0x00004000)
   95 #define MPI2_SAS_DEVICE_INFO_ATAPI_DEVICE       (0x00002000)
   96 #define MPI2_SAS_DEVICE_INFO_LSI_DEVICE         (0x00001000)
   97 #define MPI2_SAS_DEVICE_INFO_DIRECT_ATTACH      (0x00000800)
   98 #define MPI2_SAS_DEVICE_INFO_SSP_TARGET         (0x00000400)
   99 #define MPI2_SAS_DEVICE_INFO_STP_TARGET         (0x00000200)
  100 #define MPI2_SAS_DEVICE_INFO_SMP_TARGET         (0x00000100)
  101 #define MPI2_SAS_DEVICE_INFO_SATA_DEVICE        (0x00000080)
  102 #define MPI2_SAS_DEVICE_INFO_SSP_INITIATOR      (0x00000040)
  103 #define MPI2_SAS_DEVICE_INFO_STP_INITIATOR      (0x00000020)
  104 #define MPI2_SAS_DEVICE_INFO_SMP_INITIATOR      (0x00000010)
  105 #define MPI2_SAS_DEVICE_INFO_SATA_HOST          (0x00000008)
  106 
  107 #define MPI2_SAS_DEVICE_INFO_MASK_DEVICE_TYPE   (0x00000007)
  108 #define MPI2_SAS_DEVICE_INFO_NO_DEVICE          (0x00000000)
  109 #define MPI2_SAS_DEVICE_INFO_END_DEVICE         (0x00000001)
  110 #define MPI2_SAS_DEVICE_INFO_EDGE_EXPANDER      (0x00000002)
  111 #define MPI2_SAS_DEVICE_INFO_FANOUT_EXPANDER    (0x00000003)
  112 
  113 /*****************************************************************************
  114 *
  115 *        SAS Messages
  116 *
  117 *****************************************************************************/
  118 
  119 /****************************************************************************
  120 *  SMP Passthrough messages
  121 ****************************************************************************/
  122 
  123 /* SMP Passthrough Request Message */
  124 typedef struct _MPI2_SMP_PASSTHROUGH_REQUEST
  125 {
  126     U8                      PassthroughFlags;   /* 0x00 */
  127     U8                      PhysicalPort;       /* 0x01 */
  128     U8                      ChainOffset;        /* 0x02 */
  129     U8                      Function;           /* 0x03 */
  130     U16                     RequestDataLength;  /* 0x04 */
  131     U8                      SGLFlags;           /* 0x06 */
  132     U8                      MsgFlags;           /* 0x07 */
  133     U8                      VP_ID;              /* 0x08 */
  134     U8                      VF_ID;              /* 0x09 */
  135     U16                     Reserved1;          /* 0x0A */
  136     U32                     Reserved2;          /* 0x0C */
  137     U64                     SASAddress;         /* 0x10 */
  138     U32                     Reserved3;          /* 0x18 */
  139     U32                     Reserved4;          /* 0x1C */
  140     MPI2_SIMPLE_SGE_UNION   SGL;                /* 0x20 */
  141 } MPI2_SMP_PASSTHROUGH_REQUEST, MPI2_POINTER PTR_MPI2_SMP_PASSTHROUGH_REQUEST,
  142   Mpi2SmpPassthroughRequest_t, MPI2_POINTER pMpi2SmpPassthroughRequest_t;
  143 
  144 /* values for PassthroughFlags field */
  145 #define MPI2_SMP_PT_REQ_PT_FLAGS_IMMEDIATE      (0x80)
  146 
  147 /* use MPI2_SGLFLAGS_ defines from mpi2.h for the SGLFlags field */
  148 
  149 /* SMP Passthrough Reply Message */
  150 typedef struct _MPI2_SMP_PASSTHROUGH_REPLY
  151 {
  152     U8                      PassthroughFlags;   /* 0x00 */
  153     U8                      PhysicalPort;       /* 0x01 */
  154     U8                      MsgLength;          /* 0x02 */
  155     U8                      Function;           /* 0x03 */
  156     U16                     ResponseDataLength; /* 0x04 */
  157     U8                      SGLFlags;           /* 0x06 */
  158     U8                      MsgFlags;           /* 0x07 */
  159     U8                      VP_ID;              /* 0x08 */
  160     U8                      VF_ID;              /* 0x09 */
  161     U16                     Reserved1;          /* 0x0A */
  162     U8                      Reserved2;          /* 0x0C */
  163     U8                      SASStatus;          /* 0x0D */
  164     U16                     IOCStatus;          /* 0x0E */
  165     U32                     IOCLogInfo;         /* 0x10 */
  166     U32                     Reserved3;          /* 0x14 */
  167     U8                      ResponseData[4];    /* 0x18 */
  168 } MPI2_SMP_PASSTHROUGH_REPLY, MPI2_POINTER PTR_MPI2_SMP_PASSTHROUGH_REPLY,
  169   Mpi2SmpPassthroughReply_t, MPI2_POINTER pMpi2SmpPassthroughReply_t;
  170 
  171 /* values for PassthroughFlags field */
  172 #define MPI2_SMP_PT_REPLY_PT_FLAGS_IMMEDIATE    (0x80)
  173 
  174 /* values for SASStatus field are at the top of this file */
  175 
  176 /****************************************************************************
  177 *  SATA Passthrough messages
  178 ****************************************************************************/
  179 
  180 /* SATA Passthrough Request Message */
  181 typedef struct _MPI2_SATA_PASSTHROUGH_REQUEST
  182 {
  183     U16                     DevHandle;          /* 0x00 */
  184     U8                      ChainOffset;        /* 0x02 */
  185     U8                      Function;           /* 0x03 */
  186     U16                     PassthroughFlags;   /* 0x04 */
  187     U8                      SGLFlags;           /* 0x06 */
  188     U8                      MsgFlags;           /* 0x07 */
  189     U8                      VP_ID;              /* 0x08 */
  190     U8                      VF_ID;              /* 0x09 */
  191     U16                     Reserved1;          /* 0x0A */
  192     U32                     Reserved2;          /* 0x0C */
  193     U32                     Reserved3;          /* 0x10 */
  194     U32                     Reserved4;          /* 0x14 */
  195     U32                     DataLength;         /* 0x18 */
  196     U8                      CommandFIS[20];     /* 0x1C */
  197     MPI2_SGE_IO_UNION       SGL;                /* 0x30 */
  198 } MPI2_SATA_PASSTHROUGH_REQUEST, MPI2_POINTER PTR_MPI2_SATA_PASSTHROUGH_REQUEST,
  199   Mpi2SataPassthroughRequest_t, MPI2_POINTER pMpi2SataPassthroughRequest_t;
  200 
  201 /* values for PassthroughFlags field */
  202 #define MPI2_SATA_PT_REQ_PT_FLAGS_EXECUTE_DIAG      (0x0100)
  203 #define MPI2_SATA_PT_REQ_PT_FLAGS_DMA               (0x0020)
  204 #define MPI2_SATA_PT_REQ_PT_FLAGS_PIO               (0x0010)
  205 #define MPI2_SATA_PT_REQ_PT_FLAGS_UNSPECIFIED_VU    (0x0004)
  206 #define MPI2_SATA_PT_REQ_PT_FLAGS_WRITE             (0x0002)
  207 #define MPI2_SATA_PT_REQ_PT_FLAGS_READ              (0x0001)
  208 
  209 /* use MPI2_SGLFLAGS_ defines from mpi2.h for the SGLFlags field */
  210 
  211 /* SATA Passthrough Reply Message */
  212 typedef struct _MPI2_SATA_PASSTHROUGH_REPLY
  213 {
  214     U16                     DevHandle;          /* 0x00 */
  215     U8                      MsgLength;          /* 0x02 */
  216     U8                      Function;           /* 0x03 */
  217     U16                     PassthroughFlags;   /* 0x04 */
  218     U8                      SGLFlags;           /* 0x06 */
  219     U8                      MsgFlags;           /* 0x07 */
  220     U8                      VP_ID;              /* 0x08 */
  221     U8                      VF_ID;              /* 0x09 */
  222     U16                     Reserved1;          /* 0x0A */
  223     U8                      Reserved2;          /* 0x0C */
  224     U8                      SASStatus;          /* 0x0D */
  225     U16                     IOCStatus;          /* 0x0E */
  226     U32                     IOCLogInfo;         /* 0x10 */
  227     U8                      StatusFIS[20];      /* 0x14 */
  228     U32                     StatusControlRegisters; /* 0x28 */
  229     U32                     TransferCount;      /* 0x2C */
  230 } MPI2_SATA_PASSTHROUGH_REPLY, MPI2_POINTER PTR_MPI2_SATA_PASSTHROUGH_REPLY,
  231   Mpi2SataPassthroughReply_t, MPI2_POINTER pMpi2SataPassthroughReply_t;
  232 
  233 /* values for SASStatus field are at the top of this file */
  234 
  235 /****************************************************************************
  236 *  SAS IO Unit Control messages
  237 ****************************************************************************/
  238 
  239 /* SAS IO Unit Control Request Message */
  240 typedef struct _MPI2_SAS_IOUNIT_CONTROL_REQUEST
  241 {
  242     U8                      Operation;          /* 0x00 */
  243     U8                      Reserved1;          /* 0x01 */
  244     U8                      ChainOffset;        /* 0x02 */
  245     U8                      Function;           /* 0x03 */
  246     U16                     DevHandle;          /* 0x04 */
  247     U8                      IOCParameter;       /* 0x06 */
  248     U8                      MsgFlags;           /* 0x07 */
  249     U8                      VP_ID;              /* 0x08 */
  250     U8                      VF_ID;              /* 0x09 */
  251     U16                     Reserved3;          /* 0x0A */
  252     U16                     Reserved4;          /* 0x0C */
  253     U8                      PhyNum;             /* 0x0E */
  254     U8                      PrimFlags;          /* 0x0F */
  255     U32                     Primitive;          /* 0x10 */
  256     U8                      LookupMethod;       /* 0x14 */
  257     U8                      Reserved5;          /* 0x15 */
  258     U16                     SlotNumber;         /* 0x16 */
  259     U64                     LookupAddress;      /* 0x18 */
  260     U32                     IOCParameterValue;  /* 0x20 */
  261     U32                     Reserved7;          /* 0x24 */
  262     U32                     Reserved8;          /* 0x28 */
  263 } MPI2_SAS_IOUNIT_CONTROL_REQUEST,
  264   MPI2_POINTER PTR_MPI2_SAS_IOUNIT_CONTROL_REQUEST,
  265   Mpi2SasIoUnitControlRequest_t, MPI2_POINTER pMpi2SasIoUnitControlRequest_t;
  266 
  267 /* values for the Operation field */
  268 #define MPI2_SAS_OP_CLEAR_ALL_PERSISTENT        (0x02)
  269 #define MPI2_SAS_OP_PHY_LINK_RESET              (0x06)
  270 #define MPI2_SAS_OP_PHY_HARD_RESET              (0x07)
  271 #define MPI2_SAS_OP_PHY_CLEAR_ERROR_LOG         (0x08)
  272 #define MPI2_SAS_OP_SEND_PRIMITIVE              (0x0A)
  273 #define MPI2_SAS_OP_FORCE_FULL_DISCOVERY        (0x0B)
  274 #define MPI2_SAS_OP_TRANSMIT_PORT_SELECT_SIGNAL (0x0C)
  275 #define MPI2_SAS_OP_REMOVE_DEVICE               (0x0D)
  276 #define MPI2_SAS_OP_LOOKUP_MAPPING              (0x0E)
  277 #define MPI2_SAS_OP_SET_IOC_PARAMETER           (0x0F)
  278 #define MPI2_SAS_OP_DEV_ENABLE_NCQ              (0x14)
  279 #define MPI2_SAS_OP_DEV_DISABLE_NCQ             (0x15)
  280 #define MPI2_SAS_OP_PRODUCT_SPECIFIC_MIN        (0x80)
  281 
  282 /* values for the PrimFlags field */
  283 #define MPI2_SAS_PRIMFLAGS_SINGLE               (0x08)
  284 #define MPI2_SAS_PRIMFLAGS_TRIPLE               (0x02)
  285 #define MPI2_SAS_PRIMFLAGS_REDUNDANT            (0x01)
  286 
  287 /* values for the LookupMethod field */
  288 #define MPI2_SAS_LOOKUP_METHOD_SAS_ADDRESS          (0x01)
  289 #define MPI2_SAS_LOOKUP_METHOD_SAS_ENCLOSURE_SLOT   (0x02)
  290 #define MPI2_SAS_LOOKUP_METHOD_SAS_DEVICE_NAME      (0x03)
  291 
  292 /* SAS IO Unit Control Reply Message */
  293 typedef struct _MPI2_SAS_IOUNIT_CONTROL_REPLY
  294 {
  295     U8                      Operation;          /* 0x00 */
  296     U8                      Reserved1;          /* 0x01 */
  297     U8                      MsgLength;          /* 0x02 */
  298     U8                      Function;           /* 0x03 */
  299     U16                     DevHandle;          /* 0x04 */
  300     U8                      IOCParameter;       /* 0x06 */
  301     U8                      MsgFlags;           /* 0x07 */
  302     U8                      VP_ID;              /* 0x08 */
  303     U8                      VF_ID;              /* 0x09 */
  304     U16                     Reserved3;          /* 0x0A */
  305     U16                     Reserved4;          /* 0x0C */
  306     U16                     IOCStatus;          /* 0x0E */
  307     U32                     IOCLogInfo;         /* 0x10 */
  308 } MPI2_SAS_IOUNIT_CONTROL_REPLY,
  309   MPI2_POINTER PTR_MPI2_SAS_IOUNIT_CONTROL_REPLY,
  310   Mpi2SasIoUnitControlReply_t, MPI2_POINTER pMpi2SasIoUnitControlReply_t;
  311 
  312 #endif

Cache object: e046bd4be464999d097e505b31ed4d1b


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