isci: uplevel register hardware data structures and unsolicited frame handling
[linux-2.6.git] / drivers / scsi / isci / scu_completion_codes.h
1 /*
2  * This file is provided under a dual BSD/GPLv2 license.  When using or
3  * redistributing this file, you may do so under either license.
4  *
5  * GPL LICENSE SUMMARY
6  *
7  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of version 2 of the GNU General Public License as
11  * published by the Free Software Foundation.
12  *
13  * This program is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21  * The full GNU General Public License is included in this distribution
22  * in the file called LICENSE.GPL.
23  *
24  * BSD LICENSE
25  *
26  * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27  * All rights reserved.
28  *
29  * Redistribution and use in source and binary forms, with or without
30  * modification, are permitted provided that the following conditions
31  * are met:
32  *
33  *   * Redistributions of source code must retain the above copyright
34  *     notice, this list of conditions and the following disclaimer.
35  *   * Redistributions in binary form must reproduce the above copyright
36  *     notice, this list of conditions and the following disclaimer in
37  *     the documentation and/or other materials provided with the
38  *     distribution.
39  *   * Neither the name of Intel Corporation nor the names of its
40  *     contributors may be used to endorse or promote products derived
41  *     from this software without specific prior written permission.
42  *
43  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54  */
55
56 #ifndef _SCU_COMPLETION_CODES_HEADER_
57 #define _SCU_COMPLETION_CODES_HEADER_
58
59 /**
60  * This file contains the constants and macros for the SCU hardware completion
61  *    codes.
62  *
63  *
64  */
65
66 #define SCU_COMPLETION_TYPE_SHIFT      28
67 #define SCU_COMPLETION_TYPE_MASK       0x70000000
68
69 /**
70  * SCU_COMPLETION_TYPE() -
71  *
72  * This macro constructs an SCU completion type
73  */
74 #define SCU_COMPLETION_TYPE(type) \
75         ((u32)(type) << SCU_COMPLETION_TYPE_SHIFT)
76
77 /**
78  * SCU_COMPLETION_TYPE() -
79  *
80  * These macros contain the SCU completion types SCU_COMPLETION_TYPE
81  */
82 #define SCU_COMPLETION_TYPE_TASK       SCU_COMPLETION_TYPE(0)
83 #define SCU_COMPLETION_TYPE_SDMA       SCU_COMPLETION_TYPE(1)
84 #define SCU_COMPLETION_TYPE_UFI        SCU_COMPLETION_TYPE(2)
85 #define SCU_COMPLETION_TYPE_EVENT      SCU_COMPLETION_TYPE(3)
86 #define SCU_COMPLETION_TYPE_NOTIFY     SCU_COMPLETION_TYPE(4)
87
88 /**
89  *
90  *
91  * These constants provide the shift and mask values for the various parts of
92  * an SCU completion code.
93  */
94 #define SCU_COMPLETION_STATUS_MASK       0x0FFC0000
95 #define SCU_COMPLETION_TL_STATUS_MASK    0x0FC00000
96 #define SCU_COMPLETION_TL_STATUS_SHIFT   22
97 #define SCU_COMPLETION_SDMA_STATUS_MASK  0x003C0000
98 #define SCU_COMPLETION_PEG_MASK          0x00010000
99 #define SCU_COMPLETION_PORT_MASK         0x00007000
100 #define SCU_COMPLETION_PE_MASK           SCU_COMPLETION_PORT_MASK
101 #define SCU_COMPLETION_PE_SHIFT          12
102 #define SCU_COMPLETION_INDEX_MASK        0x00000FFF
103
104 /**
105  * SCU_GET_COMPLETION_TYPE() -
106  *
107  * This macro returns the SCU completion type.
108  */
109 #define SCU_GET_COMPLETION_TYPE(completion_code) \
110         ((completion_code) & SCU_COMPLETION_TYPE_MASK)
111
112 /**
113  * SCU_GET_COMPLETION_STATUS() -
114  *
115  * This macro returns the SCU completion status.
116  */
117 #define SCU_GET_COMPLETION_STATUS(completion_code) \
118         ((completion_code) & SCU_COMPLETION_STATUS_MASK)
119
120 /**
121  * SCU_GET_COMPLETION_TL_STATUS() -
122  *
123  * This macro returns the transport layer completion status.
124  */
125 #define SCU_GET_COMPLETION_TL_STATUS(completion_code) \
126         ((completion_code) & SCU_COMPLETION_TL_STATUS_MASK)
127
128 /**
129  * SCU_MAKE_COMPLETION_STATUS() -
130  *
131  * This macro takes a completion code and performs the shift and mask
132  * operations to turn it into a completion code that can be compared to a
133  * SCU_GET_COMPLETION_TL_STATUS.
134  */
135 #define SCU_MAKE_COMPLETION_STATUS(completion_code) \
136         ((u32)(completion_code) << SCU_COMPLETION_TL_STATUS_SHIFT)
137
138 /**
139  * SCU_NORMALIZE_COMPLETION_STATUS() -
140  *
141  * This macro takes a SCU_GET_COMPLETION_TL_STATUS and normalizes it for a
142  * return code.
143  */
144 #define SCU_NORMALIZE_COMPLETION_STATUS(completion_code) \
145         (\
146                 ((completion_code) & SCU_COMPLETION_TL_STATUS_MASK) \
147                 >> SCU_COMPLETION_TL_STATUS_SHIFT \
148         )
149
150 /**
151  * SCU_GET_COMPLETION_SDMA_STATUS() -
152  *
153  * This macro returns the SDMA completion status.
154  */
155 #define SCU_GET_COMPLETION_SDMA_STATUS(completion_code) \
156         ((completion_code) & SCU_COMPLETION_SDMA_STATUS_MASK)
157
158 /**
159  * SCU_GET_COMPLETION_PEG() -
160  *
161  * This macro returns the Protocol Engine Group from the completion code.
162  */
163 #define SCU_GET_COMPLETION_PEG(completion_code) \
164         ((completion_code) & SCU_COMPLETION_PEG_MASK)
165
166 /**
167  * SCU_GET_COMPLETION_PORT() -
168  *
169  * This macro reuturns the logical port index from the completion code.
170  */
171 #define SCU_GET_COMPLETION_PORT(completion_code) \
172         ((completion_code) & SCU_COMPLETION_PORT_MASK)
173
174 /**
175  * SCU_GET_PROTOCOL_ENGINE_INDEX() -
176  *
177  * This macro returns the PE index from the completion code.
178  */
179 #define SCU_GET_PROTOCOL_ENGINE_INDEX(completion_code) \
180         (((completion_code) & SCU_COMPLETION_PE_MASK) >> SCU_COMPLETION_PE_SHIFT)
181
182 /**
183  * SCU_GET_COMPLETION_INDEX() -
184  *
185  * This macro returns the index of the completion which is either a TCi or an
186  * RNi depending on the completion type.
187  */
188 #define SCU_GET_COMPLETION_INDEX(completion_code) \
189         ((completion_code) & SCU_COMPLETION_INDEX_MASK)
190
191 #define SCU_UNSOLICITED_FRAME_MASK     0x0FFF0000
192 #define SCU_UNSOLICITED_FRAME_SHIFT    16
193
194 /**
195  * SCU_GET_FRAME_INDEX() -
196  *
197  * This macro returns a normalized frame index from an unsolicited frame
198  * completion.
199  */
200 #define SCU_GET_FRAME_INDEX(completion_code) \
201         (\
202                 ((completion_code) & SCU_UNSOLICITED_FRAME_MASK) \
203                 >> SCU_UNSOLICITED_FRAME_SHIFT \
204         )
205
206 #define SCU_UNSOLICITED_FRAME_ERROR_MASK  0x00008000
207
208 /**
209  * SCU_GET_FRAME_ERROR() -
210  *
211  * This macro returns a zero (0) value if there is no frame error otherwise it
212  * returns non-zero (!0).
213  */
214 #define SCU_GET_FRAME_ERROR(completion_code) \
215         ((completion_code) & SCU_UNSOLICITED_FRAME_ERROR_MASK)
216
217 /**
218  *
219  *
220  * These constants represent normalized completion codes which must be shifted
221  * 18 bits to match it with the hardware completion code. In a 16-bit compiler,
222  * immediate constants are 16-bit values (the size of an int). If we shift
223  * those by 18 bits, we completely lose the value. To ensure the value is a
224  * 32-bit value like we want, each immediate value must be cast to a u32.
225  */
226 #define SCU_TASK_DONE_GOOD                                  ((u32)0x00)
227 #define SCU_TASK_DONE_CRC_ERR                               ((u32)0x14)
228 #define SCU_TASK_DONE_CHECK_RESPONSE                        ((u32)0x14)
229 #define SCU_TASK_DONE_GEN_RESPONSE                          ((u32)0x15)
230 #define SCU_TASK_DONE_NAK_CMD_ERR                           ((u32)0x16)
231 #define SCU_TASK_DONE_CMD_LL_R_ERR                          ((u32)0x16)
232 #define SCU_TASK_DONE_LL_R_ERR                              ((u32)0x17)
233 #define SCU_TASK_DONE_ACK_NAK_TO                            ((u32)0x17)
234 #define SCU_TASK_DONE_LL_PERR                               ((u32)0x18)
235 #define SCU_TASK_DONE_LL_SY_TERM                            ((u32)0x19)
236 #define SCU_TASK_DONE_NAK_ERR                               ((u32)0x19)
237 #define SCU_TASK_DONE_LL_LF_TERM                            ((u32)0x1A)
238 #define SCU_TASK_DONE_DATA_LEN_ERR                          ((u32)0x1A)
239 #define SCU_TASK_DONE_LL_CL_TERM                            ((u32)0x1B)
240 #define SCU_TASK_DONE_LL_ABORT_ERR                          ((u32)0x1B)
241 #define SCU_TASK_DONE_SEQ_INV_TYPE                          ((u32)0x1C)
242 #define SCU_TASK_DONE_UNEXP_XR                              ((u32)0x1C)
243 #define SCU_TASK_DONE_INV_FIS_TYPE                          ((u32)0x1D)
244 #define SCU_TASK_DONE_XR_IU_LEN_ERR                         ((u32)0x1D)
245 #define SCU_TASK_DONE_INV_FIS_LEN                           ((u32)0x1E)
246 #define SCU_TASK_DONE_XR_WD_LEN                             ((u32)0x1E)
247 #define SCU_TASK_DONE_SDMA_ERR                              ((u32)0x1F)
248 #define SCU_TASK_DONE_OFFSET_ERR                            ((u32)0x20)
249 #define SCU_TASK_DONE_MAX_PLD_ERR                           ((u32)0x21)
250 #define SCU_TASK_DONE_EXCESS_DATA                           ((u32)0x22)
251 #define SCU_TASK_DONE_LF_ERR                                ((u32)0x23)
252 #define SCU_TASK_DONE_UNEXP_FIS                             ((u32)0x24)
253 #define SCU_TASK_DONE_UNEXP_RESP                            ((u32)0x24)
254 #define SCU_TASK_DONE_EARLY_RESP                            ((u32)0x25)
255 #define SCU_TASK_DONE_SMP_RESP_TO_ERR                       ((u32)0x26)
256 #define SCU_TASK_DONE_DMASETUP_DIRERR                       ((u32)0x27)
257 #define SCU_TASK_DONE_SMP_UFI_ERR                           ((u32)0x27)
258 #define SCU_TASK_DONE_XFERCNT_ERR                           ((u32)0x28)
259 #define SCU_TASK_DONE_SMP_FRM_TYPE_ERR                      ((u32)0x28)
260 #define SCU_TASK_DONE_SMP_LL_RX_ERR                         ((u32)0x29)
261 #define SCU_TASK_DONE_RESP_LEN_ERR                          ((u32)0x2A)
262 #define SCU_TASK_DONE_UNEXP_DATA                            ((u32)0x2B)
263 #define SCU_TASK_DONE_OPEN_FAIL                             ((u32)0x2C)
264 #define SCU_TASK_DONE_UNEXP_SDBFIS                          ((u32)0x2D)
265 #define SCU_TASK_DONE_REG_ERR                               ((u32)0x2E)
266 #define SCU_TASK_DONE_SDB_ERR                               ((u32)0x2F)
267 #define SCU_TASK_DONE_TASK_ABORT                            ((u32)0x30)
268 #define SCU_TASK_DONE_CMD_SDMA_ERR                          ((U32)0x32)
269 #define SCU_TASK_DONE_CMD_LL_ABORT_ERR                      ((U32)0x33)
270 #define SCU_TASK_OPEN_REJECT_WRONG_DESTINATION              ((u32)0x34)
271 #define SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_1             ((u32)0x35)
272 #define SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_2             ((u32)0x36)
273 #define SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_3             ((u32)0x37)
274 #define SCU_TASK_OPEN_REJECT_BAD_DESTINATION                ((u32)0x38)
275 #define SCU_TASK_OPEN_REJECT_ZONE_VIOLATION                 ((u32)0x39)
276 #define SCU_TASK_DONE_VIIT_ENTRY_NV                         ((u32)0x3A)
277 #define SCU_TASK_DONE_IIT_ENTRY_NV                          ((u32)0x3B)
278 #define SCU_TASK_DONE_RNCNV_OUTBOUND                        ((u32)0x3C)
279 #define SCU_TASK_OPEN_REJECT_STP_RESOURCES_BUSY             ((u32)0x3D)
280 #define SCU_TASK_OPEN_REJECT_PROTOCOL_NOT_SUPPORTED         ((u32)0x3E)
281 #define SCU_TASK_OPEN_REJECT_CONNECTION_RATE_NOT_SUPPORTED  ((u32)0x3F)
282
283 #endif /* _SCU_COMPLETION_CODES_HEADER_ */