mpi_sas.h revision eae225eb5947825bc4e845c33ded9aedd74407cf 
1/*
2 *  Copyright (c) 2004-2006 LSI Logic Corporation.
3 *
4 *
5 *           Name:  mpi_sas.h
6 *          Title:  MPI Serial Attached SCSI structures and definitions
7 *  Creation Date:  August 19, 2004
8 *
9 *    mpi_sas.h Version:  01.05.04
10 *
11 *  Version History
12 *  ---------------
13 *
14 *  Date      Version   Description
15 *  --------  --------  ------------------------------------------------------
16 *  08-19-04  01.05.01  Original release.
17 *  08-30-05  01.05.02  Added DeviceInfo bit for SEP.
18 *                      Added PrimFlags and Primitive field to SAS IO Unit
19 *                      Control request, and added a new operation code.
20 *  03-27-06  01.05.03  Added Force Full Discovery, Transmit Port Select Signal,
21 *                      and Remove Device operations to SAS IO Unit Control.
22 *                      Added DevHandle field to SAS IO Unit Control request and
23 *                      reply.
24 *  10-11-06  01.05.04  Fixed the name of a define for Operation field of SAS IO
25 *                      Unit Control request.
26 *  --------------------------------------------------------------------------
27 */
28
29#ifndef MPI_SAS_H
30#define MPI_SAS_H
31
32
33/*
34 * Values for SASStatus.
35 */
36#define MPI_SASSTATUS_SUCCESS                           (0x00)
37#define MPI_SASSTATUS_UNKNOWN_ERROR                     (0x01)
38#define MPI_SASSTATUS_INVALID_FRAME                     (0x02)
39#define MPI_SASSTATUS_UTC_BAD_DEST                      (0x03)
40#define MPI_SASSTATUS_UTC_BREAK_RECEIVED                (0x04)
41#define MPI_SASSTATUS_UTC_CONNECT_RATE_NOT_SUPPORTED    (0x05)
42#define MPI_SASSTATUS_UTC_PORT_LAYER_REQUEST            (0x06)
43#define MPI_SASSTATUS_UTC_PROTOCOL_NOT_SUPPORTED        (0x07)
44#define MPI_SASSTATUS_UTC_STP_RESOURCES_BUSY            (0x08)
45#define MPI_SASSTATUS_UTC_WRONG_DESTINATION             (0x09)
46#define MPI_SASSTATUS_SHORT_INFORMATION_UNIT            (0x0A)
47#define MPI_SASSTATUS_LONG_INFORMATION_UNIT             (0x0B)
48#define MPI_SASSTATUS_XFER_RDY_INCORRECT_WRITE_DATA     (0x0C)
49#define MPI_SASSTATUS_XFER_RDY_REQUEST_OFFSET_ERROR     (0x0D)
50#define MPI_SASSTATUS_XFER_RDY_NOT_EXPECTED             (0x0E)
51#define MPI_SASSTATUS_DATA_INCORRECT_DATA_LENGTH        (0x0F)
52#define MPI_SASSTATUS_DATA_TOO_MUCH_READ_DATA           (0x10)
53#define MPI_SASSTATUS_DATA_OFFSET_ERROR                 (0x11)
54#define MPI_SASSTATUS_SDSF_NAK_RECEIVED                 (0x12)
55#define MPI_SASSTATUS_SDSF_CONNECTION_FAILED            (0x13)
56#define MPI_SASSTATUS_INITIATOR_RESPONSE_TIMEOUT        (0x14)
57
58
59/*
60 * Values for the SAS DeviceInfo field used in SAS Device Status Change Event
61 * data and SAS IO Unit Configuration pages.
62 */
63#define MPI_SAS_DEVICE_INFO_SEP                 (0x00004000)
64#define MPI_SAS_DEVICE_INFO_ATAPI_DEVICE        (0x00002000)
65#define MPI_SAS_DEVICE_INFO_LSI_DEVICE          (0x00001000)
66#define MPI_SAS_DEVICE_INFO_DIRECT_ATTACH       (0x00000800)
67#define MPI_SAS_DEVICE_INFO_SSP_TARGET          (0x00000400)
68#define MPI_SAS_DEVICE_INFO_STP_TARGET          (0x00000200)
69#define MPI_SAS_DEVICE_INFO_SMP_TARGET          (0x00000100)
70#define MPI_SAS_DEVICE_INFO_SATA_DEVICE         (0x00000080)
71#define MPI_SAS_DEVICE_INFO_SSP_INITIATOR       (0x00000040)
72#define MPI_SAS_DEVICE_INFO_STP_INITIATOR       (0x00000020)
73#define MPI_SAS_DEVICE_INFO_SMP_INITIATOR       (0x00000010)
74#define MPI_SAS_DEVICE_INFO_SATA_HOST           (0x00000008)
75
76#define MPI_SAS_DEVICE_INFO_MASK_DEVICE_TYPE    (0x00000007)
77#define MPI_SAS_DEVICE_INFO_NO_DEVICE           (0x00000000)
78#define MPI_SAS_DEVICE_INFO_END_DEVICE          (0x00000001)
79#define MPI_SAS_DEVICE_INFO_EDGE_EXPANDER       (0x00000002)
80#define MPI_SAS_DEVICE_INFO_FANOUT_EXPANDER     (0x00000003)
81
82
83
84/*****************************************************************************
85*
86*        S e r i a l    A t t a c h e d    S C S I     M e s s a g e s
87*
88*****************************************************************************/
89
90/****************************************************************************/
91/* Serial Management Protocol Passthrough Request                           */
92/****************************************************************************/
93
94typedef struct _MSG_SMP_PASSTHROUGH_REQUEST
95{
96    U8                      PassthroughFlags;   /* 00h */
97    U8                      PhysicalPort;       /* 01h */
98    U8                      ChainOffset;        /* 02h */
99    U8                      Function;           /* 03h */
100    U16                     RequestDataLength;  /* 04h */
101    U8                      ConnectionRate;     /* 06h */
102    U8                      MsgFlags;           /* 07h */
103    U32                     MsgContext;         /* 08h */
104    U32                     Reserved1;          /* 0Ch */
105    U64                     SASAddress;         /* 10h */
106    U32                     Reserved2;          /* 18h */
107    U32                     Reserved3;          /* 1Ch */
108    SGE_SIMPLE_UNION        SGL;                /* 20h */
109} MSG_SMP_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REQUEST,
110  SmpPassthroughRequest_t, MPI_POINTER pSmpPassthroughRequest_t;
111
112/* values for PassthroughFlags field */
113#define MPI_SMP_PT_REQ_PT_FLAGS_IMMEDIATE       (0x80)
114
115/* values for ConnectionRate field */
116#define MPI_SMP_PT_REQ_CONNECT_RATE_NEGOTIATED  (0x00)
117#define MPI_SMP_PT_REQ_CONNECT_RATE_1_5         (0x08)
118#define MPI_SMP_PT_REQ_CONNECT_RATE_3_0         (0x09)
119
120
121/* Serial Management Protocol Passthrough Reply */
122typedef struct _MSG_SMP_PASSTHROUGH_REPLY
123{
124    U8                      PassthroughFlags;   /* 00h */
125    U8                      PhysicalPort;       /* 01h */
126    U8                      MsgLength;          /* 02h */
127    U8                      Function;           /* 03h */
128    U16                     ResponseDataLength; /* 04h */
129    U8                      Reserved1;          /* 06h */
130    U8                      MsgFlags;           /* 07h */
131    U32                     MsgContext;         /* 08h */
132    U8                      Reserved2;          /* 0Ch */
133    U8                      SASStatus;          /* 0Dh */
134    U16                     IOCStatus;          /* 0Eh */
135    U32                     IOCLogInfo;         /* 10h */
136    U32                     Reserved3;          /* 14h */
137    U8                      ResponseData[4];    /* 18h */
138} MSG_SMP_PASSTHROUGH_REPLY, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REPLY,
139  SmpPassthroughReply_t, MPI_POINTER pSmpPassthroughReply_t;
140
141#define MPI_SMP_PT_REPLY_PT_FLAGS_IMMEDIATE     (0x80)
142
143
144/****************************************************************************/
145/* SATA Passthrough Request                                                 */
146/****************************************************************************/
147
148typedef struct _MSG_SATA_PASSTHROUGH_REQUEST
149{
150    U8                      TargetID;           /* 00h */
151    U8                      Bus;                /* 01h */
152    U8                      ChainOffset;        /* 02h */
153    U8                      Function;           /* 03h */
154    U16                     PassthroughFlags;   /* 04h */
155    U8                      ConnectionRate;     /* 06h */
156    U8                      MsgFlags;           /* 07h */
157    U32                     MsgContext;         /* 08h */
158    U32                     Reserved1;          /* 0Ch */
159    U32                     Reserved2;          /* 10h */
160    U32                     Reserved3;          /* 14h */
161    U32                     DataLength;         /* 18h */
162    U8                      CommandFIS[20];     /* 1Ch */
163    SGE_SIMPLE_UNION        SGL;                /* 30h */
164} MSG_SATA_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SATA_PASSTHROUGH_REQUEST,
165  SataPassthroughRequest_t, MPI_POINTER pSataPassthroughRequest_t;
166
167/* values for PassthroughFlags field */
168#define MPI_SATA_PT_REQ_PT_FLAGS_RESET_DEVICE   (0x0200)
169#define MPI_SATA_PT_REQ_PT_FLAGS_EXECUTE_DIAG   (0x0100)
170#define MPI_SATA_PT_REQ_PT_FLAGS_DMA_QUEUED     (0x0080)
171#define MPI_SATA_PT_REQ_PT_FLAGS_PACKET_COMMAND (0x0040)
172#define MPI_SATA_PT_REQ_PT_FLAGS_DMA            (0x0020)
173#define MPI_SATA_PT_REQ_PT_FLAGS_PIO            (0x0010)
174#define MPI_SATA_PT_REQ_PT_FLAGS_UNSPECIFIED_VU (0x0004)
175#define MPI_SATA_PT_REQ_PT_FLAGS_WRITE          (0x0002)
176#define MPI_SATA_PT_REQ_PT_FLAGS_READ           (0x0001)
177
178/* values for ConnectionRate field */
179#define MPI_SATA_PT_REQ_CONNECT_RATE_NEGOTIATED (0x00)
180#define MPI_SATA_PT_REQ_CONNECT_RATE_1_5        (0x08)
181#define MPI_SATA_PT_REQ_CONNECT_RATE_3_0        (0x09)
182
183
184/* SATA Passthrough Reply */
185typedef struct _MSG_SATA_PASSTHROUGH_REPLY
186{
187    U8                      TargetID;           /* 00h */
188    U8                      Bus;                /* 01h */
189    U8                      MsgLength;          /* 02h */
190    U8                      Function;           /* 03h */
191    U16                     PassthroughFlags;   /* 04h */
192    U8                      Reserved1;          /* 06h */
193    U8                      MsgFlags;           /* 07h */
194    U32                     MsgContext;         /* 08h */
195    U8                      Reserved2;          /* 0Ch */
196    U8                      SASStatus;          /* 0Dh */
197    U16                     IOCStatus;          /* 0Eh */
198    U32                     IOCLogInfo;         /* 10h */
199    U8                      StatusFIS[20];      /* 14h */
200    U32                     StatusControlRegisters; /* 28h */
201    U32                     TransferCount;      /* 2Ch */
202} MSG_SATA_PASSTHROUGH_REPLY, MPI_POINTER PTR_MSG_SATA_PASSTHROUGH_REPLY,
203  SataPassthroughReply_t, MPI_POINTER pSataPassthroughReply_t;
204
205
206
207
208/****************************************************************************/
209/* SAS IO Unit Control Request                                              */
210/****************************************************************************/
211
212typedef struct _MSG_SAS_IOUNIT_CONTROL_REQUEST
213{
214    U8                      Operation;          /* 00h */
215    U8                      Reserved1;          /* 01h */
216    U8                      ChainOffset;        /* 02h */
217    U8                      Function;           /* 03h */
218    U16                     DevHandle;          /* 04h */
219    U8                      Reserved3;          /* 06h */
220    U8                      MsgFlags;           /* 07h */
221    U32                     MsgContext;         /* 08h */
222    U8                      TargetID;           /* 0Ch */
223    U8                      Bus;                /* 0Dh */
224    U8                      PhyNum;             /* 0Eh */
225    U8                      PrimFlags;          /* 0Fh */
226    U32                     Primitive;          /* 10h */
227    U64                     SASAddress;         /* 14h */
228    U32                     Reserved4;          /* 1Ch */
229} MSG_SAS_IOUNIT_CONTROL_REQUEST, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REQUEST,
230  SasIoUnitControlRequest_t, MPI_POINTER pSasIoUnitControlRequest_t;
231
232/* values for the Operation field */
233#define MPI_SAS_OP_CLEAR_NOT_PRESENT            (0x01)
234#define MPI_SAS_OP_CLEAR_ALL_PERSISTENT         (0x02)
235#define MPI_SAS_OP_PHY_LINK_RESET               (0x06)
236#define MPI_SAS_OP_PHY_HARD_RESET               (0x07)
237#define MPI_SAS_OP_PHY_CLEAR_ERROR_LOG          (0x08)
238#define MPI_SAS_OP_MAP_CURRENT                  (0x09)
239#define MPI_SAS_OP_SEND_PRIMITIVE               (0x0A)
240#define MPI_SAS_OP_FORCE_FULL_DISCOVERY         (0x0B)
241#define MPI_SAS_OP_TRANSMIT_PORT_SELECT_SIGNAL  (0x0C)
242#define MPI_SAS_OP_TRANSMIT_REMOVE_DEVICE       (0x0D)  /* obsolete name */
243#define MPI_SAS_OP_REMOVE_DEVICE                (0x0D)
244
245/* values for the PrimFlags field */
246#define MPI_SAS_PRIMFLAGS_SINGLE                (0x08)
247#define MPI_SAS_PRIMFLAGS_TRIPLE                (0x02)
248#define MPI_SAS_PRIMFLAGS_REDUNDANT             (0x01)
249
250
251/* SAS IO Unit Control Reply */
252typedef struct _MSG_SAS_IOUNIT_CONTROL_REPLY
253{
254    U8                      Operation;          /* 00h */
255    U8                      Reserved1;          /* 01h */
256    U8                      MsgLength;          /* 02h */
257    U8                      Function;           /* 03h */
258    U16                     DevHandle;          /* 04h */
259    U8                      Reserved3;          /* 06h */
260    U8                      MsgFlags;           /* 07h */
261    U32                     MsgContext;         /* 08h */
262    U16                     Reserved4;          /* 0Ch */
263    U16                     IOCStatus;          /* 0Eh */
264    U32                     IOCLogInfo;         /* 10h */
265} MSG_SAS_IOUNIT_CONTROL_REPLY, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REPLY,
266  SasIoUnitControlReply_t, MPI_POINTER pSasIoUnitControlReply_t;
267
268#endif
269
270
271