1 /*
2  *  Copyright (c) 2003 LSI Logic Corporation.
3  *
4  *
5  *           Name:  mpi_sas.h
6  *          Title:  MPI Serial Attached SCSI structures and definitions
7  *  Creation Date:  April 23, 2003
8  *
9  *    mpi_sas.h Version:  01.05.xx
10  *
11  *  Version History
12  *  ---------------
13  *
14  *  Date      Version   Description
15  *  --------  --------  ------------------------------------------------------
16  *  xx-yy-zz  01.05.01  Original release.
17  *  --------------------------------------------------------------------------
18  */
19 
20 #ifndef MPI_SAS_H
21 #define MPI_SAS_H
22 
23 /*****************************************************************************
24 *
25 *        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
26 *
27 *****************************************************************************/
28 
29 /****************************************************************************/
30 /* Serial Management Protocol Passthrough Request                           */
31 /****************************************************************************/
32 
33 typedef struct _MSG_SMP_PASSTHROUGH_REQUEST
34 {
35     U8                      PassthroughFlags;   /* 00h */
36     U8                      PhysicalPort;       /* 01h */
37     U8                      ChainOffset;        /* 02h */
38     U8                      Function;           /* 03h */
39     U16                     RequestDataLength;  /* 04h */
40     U8                      ConnectionRate;     /* 06h */
41     U8                      MsgFlags;           /* 07h */
42     U32                     MsgContext;         /* 08h */
43     U32                     Reserved1;          /* 0Ch */
44     U64                     SASAddress;         /* 10h */
45     U32                     Reserved2;          /* 18h */
46     U32                     Reserved3;          /* 1Ch */
47     SGE_SIMPLE_UNION        SGL;                /* 20h */
48 } MSG_SMP_PASSTHROUGH_REQUEST, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REQUEST,
49   SmpPassthroughRequest_t, MPI_POINTER pSmpPassthroughRequest_t;
50 
51 #define MPI_SMP_PT_REQ_PT_FLAGS_IMMEDIATE       (0x80)
52 
53 #define MPI_SMP_PT_REQ_CONNECT_RATE_NEGOTIATED  (0x00)
54 #define MPI_SMP_PT_REQ_CONNECT_RATE_1_5         (0x08)
55 #define MPI_SMP_PT_REQ_CONNECT_RATE_3_0         (0x09)
56 
57 
58 /* Serial Management Protocol Passthrough Reply */
59 typedef struct _MSG_SMP_PASSTHROUGH_REPLY
60 {
61     U8                      PassthroughFlags;   /* 00h */
62     U8                      PhysicalPort;       /* 01h */
63     U8                      MsgLength;          /* 02h */
64     U8                      Function;           /* 03h */
65     U16                     ResponseDataLength; /* 04h */
66     U8                      Reserved1;          /* 06h */
67     U8                      MsgFlags;           /* 07h */
68     U32                     MsgContext;         /* 08h */
69     U8                      Reserved2;          /* 0Ch */
70     U8                      SASStatus;          /* 0Dh */
71     U16                     IOCStatus;          /* 0Eh */
72     U32                     IOCLogInfo;         /* 10h */
73     U32                     Reserved3;          /* 14h */
74     U8                      ResponseData[4];    /* 18h */
75 } MSG_SMP_PASSTHROUGH_REPLY, MPI_POINTER PTR_MSG_SMP_PASSTHROUGH_REPLY,
76   SmpPassthroughReply_t, MPI_POINTER pSmpPassthroughReply_t;
77 
78 #define MPI_SMP_PT_REPLY_PT_FLAGS_IMMEDIATE     (0x80)
79 
80 /* values for the SASStatus field */
81 #define MPI_SASSTATUS_SUCCESS                           (0x00)
82 #define MPI_SASSTATUS_UNKNOWN_ERROR                     (0x01)
83 #define MPI_SASSTATUS_INVALID_FRAME                     (0x02)
84 #define MPI_SASSTATUS_UTC_BAD_DEST                      (0x03)
85 #define MPI_SASSTATUS_UTC_BREAK_RECEIVED                (0x04)
86 #define MPI_SASSTATUS_UTC_CONNECT_RATE_NOT_SUPPORTED    (0x05)
87 #define MPI_SASSTATUS_UTC_PORT_LAYER_REQUEST            (0x06)
88 #define MPI_SASSTATUS_UTC_PROTOCOL_NOT_SUPPORTED        (0x07)
89 #define MPI_SASSTATUS_UTC_STP_RESOURCES_BUSY            (0x08)
90 #define MPI_SASSTATUS_UTC_WRONG_DESTINATION             (0x09)
91 #define MPI_SASSTATUS_SHORT_INFORMATION_UNIT            (0x0A)
92 #define MPI_SASSTATUS_LONG_INFORMATION_UNIT             (0x0B)
93 #define MPI_SASSTATUS_XFER_RDY_INCORRECT_WRITE_DATA     (0x0C)
94 #define MPI_SASSTATUS_XFER_RDY_REQUEST_OFFSET_ERROR     (0x0D)
95 #define MPI_SASSTATUS_XFER_RDY_NOT_EXPECTED             (0x0E)
96 #define MPI_SASSTATUS_DATA_INCORRECT_DATA_LENGTH        (0x0F)
97 #define MPI_SASSTATUS_DATA_TOO_MUCH_READ_DATA           (0x10)
98 #define MPI_SASSTATUS_DATA_OFFSET_ERROR                 (0x11)
99 #define MPI_SASSTATUS_SDSF_NAK_RECEIVED                 (0x12)
100 #define MPI_SASSTATUS_SDSF_CONNECTION_FAILED            (0x13)
101 #define MPI_SASSTATUS_INITIATOR_RESPONSE_TIMEOUT        (0x14)
102 
103 
104 /*
105  * Values for the SAS DeviceInfo field used in SAS Device Status Change Event
106  * data and SAS IO Unit Configuration pages.
107  */
108 #define MPI_SAS_DEVICE_INFO_ATAPI_DEVICE        (0x00002000)
109 #define MPI_SAS_DEVICE_INFO_LSI_DEVICE          (0x00001000)
110 #define MPI_SAS_DEVICE_INFO_DIRECT_ATTACH       (0x00000800)
111 #define MPI_SAS_DEVICE_INFO_SSP_TARGET          (0x00000400)
112 #define MPI_SAS_DEVICE_INFO_STP_TARGET          (0x00000200)
113 #define MPI_SAS_DEVICE_INFO_SMP_TARGET          (0x00000100)
114 #define MPI_SAS_DEVICE_INFO_SATA_DEVICE         (0x00000080)
115 #define MPI_SAS_DEVICE_INFO_SSP_INITIATOR       (0x00000040)
116 #define MPI_SAS_DEVICE_INFO_STP_INITIATOR       (0x00000020)
117 #define MPI_SAS_DEVICE_INFO_SMP_INITIATOR       (0x00000010)
118 #define MPI_SAS_DEVICE_INFO_SATA_HOST           (0x00000008)
119 
120 #define MPI_SAS_DEVICE_INFO_MASK_DEVICE_TYPE    (0x00000007)
121 #define MPI_SAS_DEVICE_INFO_NO_DEVICE           (0x00000000)
122 #define MPI_SAS_DEVICE_INFO_END_DEVICE          (0x00000001)
123 #define MPI_SAS_DEVICE_INFO_EDGE_EXPANDER       (0x00000002)
124 #define MPI_SAS_DEVICE_INFO_FANOUT_EXPANDER     (0x00000003)
125 
126 
127 /****************************************************************************/
128 /* SAS IO Unit Control Request                                              */
129 /****************************************************************************/
130 
131 typedef struct _MSG_SAS_IOUNIT_CONTROL_REQUEST
132 {
133     U8                      Operation;          /* 00h */
134     U8                      Reserved1;          /* 01h */
135     U8                      ChainOffset;        /* 02h */
136     U8                      Function;           /* 03h */
137     U16                     Reserved2;          /* 04h */
138     U8                      Reserved3;          /* 06h */
139     U8                      MsgFlags;           /* 07h */
140     U32                     MsgContext;         /* 08h */
141     U8                      TargetID;           /* 0Ch */
142     U8                      Bus;                /* 0Dh */
143     U8                      PhyNum;             /* 0Eh */
144     U8                      Reserved4;          /* 0Fh */
145     U32                     Reserved5;          /* 10h */
146     U64                     SASAddress;         /* 14h */
147     U32                     Reserved6;          /* 1Ch */
148 } MSG_SAS_IOUNIT_CONTROL_REQUEST, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REQUEST,
149   SasIoUnitControlRequest_t, MPI_POINTER pSasIoUnitControlRequest_t;
150 
151 /* values for the ... field */
152 #define MPI_SAS_OP_CLEAR_NOT_PRESENT             (0x01)
153 #define MPI_SAS_OP_CLEAR_ALL                     (0x02)
154 #define MPI_SAS_OP_MAP                           (0x03)
155 #define MPI_SAS_OP_MOVE                          (0x04)
156 #define MPI_SAS_OP_CLEAR                         (0x05)
157 #define MPI_SAS_OP_PHY_LINK_RESET                (0x06)
158 #define MPI_SAS_OP_PHY_HARD_RESET                (0x07)
159 #define MPI_SAS_OP_PHY_CLEAR_ERROR_LOG           (0x08)
160 
161 
162 /* SAS IO Unit Control Reply */
163 typedef struct _MSG_SAS_IOUNIT_CONTROL_REPLY
164 {
165     U8                      Operation;          /* 00h */
166     U8                      Reserved1;          /* 01h */
167     U8                      MsgLength;          /* 02h */
168     U8                      Function;           /* 03h */
169     U16                     Reserved2;          /* 04h */
170     U8                      Reserved3;          /* 06h */
171     U8                      MsgFlags;           /* 07h */
172     U32                     MsgContext;         /* 08h */
173     U16                     Reserved4;          /* 0Ch */
174     U16                     IOCStatus;          /* 0Eh */
175     U32                     IOCLogInfo;         /* 10h */
176 } MSG_SAS_IOUNIT_CONTROL_REPLY, MPI_POINTER PTR_MSG_SAS_IOUNIT_CONTROL_REPLY,
177   SasIoUnitControlReply_t, MPI_POINTER pSasIoUnitControlReply_t;
178 
179 #endif
180 
181 
182