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.
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
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.
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.
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.
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
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
40 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54 #ifndef _SCU_COMPLETION_CODES_HEADER_
55 #define _SCU_COMPLETION_CODES_HEADER_
60 * @brief This file contains the constants and macros for the SCU hardware
68 #define SCU_COMPLETION_TYPE_SHIFT 28
69 #define SCU_COMPLETION_TYPE_MASK 0x70000000
72 * This macro constructs an SCU completion type
74 #define SCU_COMPLETION_TYPE(type) \
75 ((U32)(type) << SCU_COMPLETION_TYPE_SHIFT)
78 * These macros contain the SCU completion types
80 * @name SCU_COMPLETION_TYPE
83 #define SCU_COMPLETION_TYPE_TASK SCU_COMPLETION_TYPE(0)
84 #define SCU_COMPLETION_TYPE_SDMA SCU_COMPLETION_TYPE(1)
85 #define SCU_COMPLETION_TYPE_UFI SCU_COMPLETION_TYPE(2)
86 #define SCU_COMPLETION_TYPE_EVENT SCU_COMPLETION_TYPE(3)
87 #define SCU_COMPLETION_TYPE_NOTIFY SCU_COMPLETION_TYPE(4)
91 * These constants provide the shift and mask values for the various parts of
92 * an SCU completion code.
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
105 * This macro returns the SCU completion type.
107 #define SCU_GET_COMPLETION_TYPE(completion_code) \
108 ((completion_code) & SCU_COMPLETION_TYPE_MASK)
111 * This macro returns the SCU completion status.
113 #define SCU_GET_COMPLETION_STATUS(completion_code) \
114 ((completion_code) & SCU_COMPLETION_STATUS_MASK)
117 * This macro returns the transport layer completion status.
119 #define SCU_GET_COMPLETION_TL_STATUS(completion_code) \
120 ((completion_code) & SCU_COMPLETION_TL_STATUS_MASK)
123 * This macro takes a completion code and performs the shift and mask
124 * operations to turn it into a completion code that can be compared to a
125 * SCU_GET_COMPLETION_TL_STATUS.
127 #define SCU_MAKE_COMPLETION_STATUS(completion_code) \
128 ((U32)(completion_code) << SCU_COMPLETION_TL_STATUS_SHIFT)
131 * This macro takes a SCU_GET_COMPLETION_TL_STATUS and normalizes it for a
134 #define SCU_NORMALIZE_COMPLETION_STATUS(completion_code) \
136 ((U32)((completion_code) & SCU_COMPLETION_TL_STATUS_MASK)) \
137 >> SCU_COMPLETION_TL_STATUS_SHIFT \
141 * This macro returns the SDMA completion status.
143 #define SCU_GET_COMPLETION_SDMA_STATUS(completion_code) \
144 ((completion_code) & SCU_COMPLETION_SDMA_STATUS_MASK)
147 * This macro returns the Protocol Engine Group from the completion code.
149 #define SCU_GET_COMPLETION_PEG(completion_code) \
150 ((completion_code) & SCU_COMPLETION_PEG_MASK)
153 * This macro reuturns the logical port index from the completion code.
155 #define SCU_GET_COMPLETION_PORT(completion_code) \
156 ((completion_code) & SCU_COMPLETION_PORT_MASK)
159 * This macro returns the PE index from the completion code.
161 #define SCU_GET_PROTOCOL_ENGINE_INDEX(completion_code) \
162 (((U32)((completion_code) & SCU_COMPLETION_PE_MASK)) >> SCU_COMPLETION_PE_SHIFT)
165 * This macro returns the index of the completion which is either a TCi or an
166 * RNi depending on the completion type.
168 #define SCU_GET_COMPLETION_INDEX(completion_code) \
169 ((completion_code) & SCU_COMPLETION_INDEX_MASK)
171 #define SCU_UNSOLICITED_FRAME_MASK 0x0FFF0000
172 #define SCU_UNSOLICITED_FRAME_SHIFT 16
175 * This macro returns a normalized frame index from an unsolicited frame
178 #define SCU_GET_FRAME_INDEX(completion_code) \
180 ((U32)((completion_code) & SCU_UNSOLICITED_FRAME_MASK)) \
181 >> SCU_UNSOLICITED_FRAME_SHIFT \
184 #define SCU_UNSOLICITED_FRAME_ERROR_MASK 0x00008000
187 * This macro returns a zero (0) value if there is no frame error otherwise
188 * it returns non-zero (!0).
190 #define SCU_GET_FRAME_ERROR(completion_code) \
191 ((completion_code) & SCU_UNSOLICITED_FRAME_ERROR_MASK)
194 * These constants represent normalized completion codes which must be shifted
195 * 18 bits to match it with the hardware completion code. In a 16-bit compiler,
196 * immediate constants are 16-bit values (the size of an int). If we shift those
197 * by 18 bits, we completely lose the value. To ensure the value is a 32-bit
198 * value like we want, each immediate value must be cast to a U32.
200 #define SCU_TASK_DONE_GOOD ((U32)0x00)
201 #define SCU_TASK_DONE_CRC_ERR ((U32)0x14)
202 #define SCU_TASK_DONE_CHECK_RESPONSE ((U32)0x14)
203 #define SCU_TASK_DONE_GEN_RESPONSE ((U32)0x15)
204 #define SCU_TASK_DONE_NAK_CMD_ERR ((U32)0x16)
205 #define SCU_TASK_DONE_CMD_LL_R_ERR ((U32)0x16)
206 #define SCU_TASK_DONE_LL_R_ERR ((U32)0x17)
207 #define SCU_TASK_DONE_ACK_NAK_TO ((U32)0x17)
208 #define SCU_TASK_DONE_LL_PERR ((U32)0x18)
209 #define SCU_TASK_DONE_LL_SY_TERM ((U32)0x19)
210 #define SCU_TASK_DONE_NAK_ERR ((U32)0x19)
211 #define SCU_TASK_DONE_LL_LF_TERM ((U32)0x1A)
212 #define SCU_TASK_DONE_DATA_LEN_ERR ((U32)0x1A)
213 #define SCU_TASK_DONE_LL_CL_TERM ((U32)0x1B)
214 #define SCU_TASK_DONE_LL_ABORT_ERR ((U32)0x1B)
215 #define SCU_TASK_DONE_SEQ_INV_TYPE ((U32)0x1C)
216 #define SCU_TASK_DONE_UNEXP_XR ((U32)0x1C)
217 #define SCU_TASK_DONE_INV_FIS_TYPE ((U32)0x1D)
218 #define SCU_TASK_DONE_XR_IU_LEN_ERR ((U32)0x1D)
219 #define SCU_TASK_DONE_INV_FIS_LEN ((U32)0x1E)
220 #define SCU_TASK_DONE_XR_WD_LEN ((U32)0x1E)
221 #define SCU_TASK_DONE_SDMA_ERR ((U32)0x1F)
222 #define SCU_TASK_DONE_OFFSET_ERR ((U32)0x20)
223 #define SCU_TASK_DONE_MAX_PLD_ERR ((U32)0x21)
224 #define SCU_TASK_DONE_EXCESS_DATA ((U32)0x22)
225 #define SCU_TASK_DONE_LF_ERR ((U32)0x23)
226 #define SCU_TASK_DONE_UNEXP_FIS ((U32)0x24)
227 #define SCU_TASK_DONE_UNEXP_RESP ((U32)0x24)
228 #define SCU_TASK_DONE_EARLY_RESP ((U32)0x25)
229 #define SCU_TASK_DONE_SMP_RESP_TO_ERR ((U32)0x26)
230 #define SCU_TASK_DONE_DMASETUP_DIRERR ((U32)0x27)
231 #define SCU_TASK_DONE_SMP_UFI_ERR ((U32)0x27)
232 #define SCU_TASK_DONE_XFERCNT_ERR ((U32)0x28)
233 #define SCU_TASK_DONE_SMP_FRM_TYPE_ERR ((U32)0x28)
234 #define SCU_TASK_DONE_SMP_LL_RX_ERR ((U32)0x29)
235 #define SCU_TASK_DONE_RESP_LEN_ERR ((U32)0x2A)
236 #define SCU_TASK_DONE_UNEXP_DATA ((U32)0x2B)
237 #define SCU_TASK_DONE_OPEN_FAIL ((U32)0x2C)
238 #define SCU_TASK_DONE_UNEXP_SDBFIS ((U32)0x2D)
239 #define SCU_TASK_DONE_REG_ERR ((U32)0x2E)
240 #define SCU_TASK_DONE_SDB_ERR ((U32)0x2F)
241 #define SCU_TASK_DONE_TASK_ABORT ((U32)0x30)
242 #if defined(PBG_HBA_BETA_BUILD)
243 #define SCU_TASK_DONE_CMD_SDMA_ERR ((U32)0x32)
244 #define SCU_TASK_DONE_CMD_LL_ABORT_ERR ((U32)0x33)
246 #define SCU_TASK_OPEN_REJECT_WRONG_DESTINATION ((U32)0x34)
247 #define SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_1 ((U32)0x35)
248 #define SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_2 ((U32)0x36)
249 #define SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_3 ((U32)0x37)
250 #define SCU_TASK_OPEN_REJECT_BAD_DESTINATION ((U32)0x38)
251 #define SCU_TASK_OPEN_REJECT_ZONE_VIOLATION ((U32)0x39)
252 #define SCU_TASK_DONE_VIIT_ENTRY_NV ((U32)0x3A)
253 #define SCU_TASK_DONE_IIT_ENTRY_NV ((U32)0x3B)
254 #define SCU_TASK_DONE_RNCNV_OUTBOUND ((U32)0x3C)
255 #define SCU_TASK_OPEN_REJECT_STP_RESOURCES_BUSY ((U32)0x3D)
256 #define SCU_TASK_OPEN_REJECT_PROTOCOL_NOT_SUPPORTED ((U32)0x3E)
257 #define SCU_TASK_OPEN_REJECT_CONNECTION_RATE_NOT_SUPPORTED ((U32)0x3F)
261 #endif // __cplusplus
263 #endif // _SCU_COMPLETION_CODES_HEADER_