sys/dev/mps/mpi/mpi2_sas.h

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