summaryrefslogtreecommitdiffstats
path: root/drivers/scsi/isci/scu_completion_codes.h
blob: c8b329c695f9ca7487b6995947d70eb933d7dfc7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
/*
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 * The full GNU General Public License is included in this distribution
 * in the file called LICENSE.GPL.
 *
 * BSD LICENSE
 *
 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *   * Neither the name of Intel Corporation nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _SCU_COMPLETION_CODES_HEADER_
#define _SCU_COMPLETION_CODES_HEADER_

/**
 * This file contains the constants and macros for the SCU hardware completion
 *    codes.
 *
 *
 */

#define SCU_COMPLETION_TYPE_SHIFT      28
#define SCU_COMPLETION_TYPE_MASK       0x70000000

/**
 * SCU_COMPLETION_TYPE() -
 *
 * This macro constructs an SCU completion type
 */
#define SCU_COMPLETION_TYPE(type) \
	((u32)(type) << SCU_COMPLETION_TYPE_SHIFT)

/**
 * SCU_COMPLETION_TYPE() -
 *
 * These macros contain the SCU completion types SCU_COMPLETION_TYPE
 */
#define SCU_COMPLETION_TYPE_TASK       SCU_COMPLETION_TYPE(0)
#define SCU_COMPLETION_TYPE_SDMA       SCU_COMPLETION_TYPE(1)
#define SCU_COMPLETION_TYPE_UFI        SCU_COMPLETION_TYPE(2)
#define SCU_COMPLETION_TYPE_EVENT      SCU_COMPLETION_TYPE(3)
#define SCU_COMPLETION_TYPE_NOTIFY     SCU_COMPLETION_TYPE(4)

/**
 *
 *
 * These constants provide the shift and mask values for the various parts of
 * an SCU completion code.
 */
#define SCU_COMPLETION_STATUS_MASK       0x0FFC0000
#define SCU_COMPLETION_TL_STATUS_MASK    0x0FC00000
#define SCU_COMPLETION_TL_STATUS_SHIFT   22
#define SCU_COMPLETION_SDMA_STATUS_MASK  0x003C0000
#define SCU_COMPLETION_PEG_MASK          0x00010000
#define SCU_COMPLETION_PORT_MASK         0x00007000
#define SCU_COMPLETION_PE_MASK           SCU_COMPLETION_PORT_MASK
#define SCU_COMPLETION_PE_SHIFT          12
#define SCU_COMPLETION_INDEX_MASK        0x00000FFF

/**
 * SCU_GET_COMPLETION_TYPE() -
 *
 * This macro returns the SCU completion type.
 */
#define SCU_GET_COMPLETION_TYPE(completion_code) \
	((completion_code) & SCU_COMPLETION_TYPE_MASK)

/**
 * SCU_GET_COMPLETION_STATUS() -
 *
 * This macro returns the SCU completion status.
 */
#define SCU_GET_COMPLETION_STATUS(completion_code) \
	((completion_code) & SCU_COMPLETION_STATUS_MASK)

/**
 * SCU_GET_COMPLETION_TL_STATUS() -
 *
 * This macro returns the transport layer completion status.
 */
#define SCU_GET_COMPLETION_TL_STATUS(completion_code) \
	((completion_code) & SCU_COMPLETION_TL_STATUS_MASK)

/**
 * SCU_MAKE_COMPLETION_STATUS() -
 *
 * This macro takes a completion code and performs the shift and mask
 * operations to turn it into a completion code that can be compared to a
 * SCU_GET_COMPLETION_TL_STATUS.
 */
#define SCU_MAKE_COMPLETION_STATUS(completion_code) \
	((u32)(completion_code) << SCU_COMPLETION_TL_STATUS_SHIFT)

/**
 * SCU_NORMALIZE_COMPLETION_STATUS() -
 *
 * This macro takes a SCU_GET_COMPLETION_TL_STATUS and normalizes it for a
 * return code.
 */
#define SCU_NORMALIZE_COMPLETION_STATUS(completion_code) \
	(\
		((completion_code) & SCU_COMPLETION_TL_STATUS_MASK) \
		>> SCU_COMPLETION_TL_STATUS_SHIFT \
	)

/**
 * SCU_GET_COMPLETION_SDMA_STATUS() -
 *
 * This macro returns the SDMA completion status.
 */
#define SCU_GET_COMPLETION_SDMA_STATUS(completion_code)	\
	((completion_code) & SCU_COMPLETION_SDMA_STATUS_MASK)

/**
 * SCU_GET_COMPLETION_PEG() -
 *
 * This macro returns the Protocol Engine Group from the completion code.
 */
#define SCU_GET_COMPLETION_PEG(completion_code)	\
	((completion_code) & SCU_COMPLETION_PEG_MASK)

/**
 * SCU_GET_COMPLETION_PORT() -
 *
 * This macro reuturns the logical port index from the completion code.
 */
#define SCU_GET_COMPLETION_PORT(completion_code) \
	((completion_code) & SCU_COMPLETION_PORT_MASK)

/**
 * SCU_GET_PROTOCOL_ENGINE_INDEX() -
 *
 * This macro returns the PE index from the completion code.
 */
#define SCU_GET_PROTOCOL_ENGINE_INDEX(completion_code) \
	(((completion_code) & SCU_COMPLETION_PE_MASK) >> SCU_COMPLETION_PE_SHIFT)

/**
 * SCU_GET_COMPLETION_INDEX() -
 *
 * This macro returns the index of the completion which is either a TCi or an
 * RNi depending on the completion type.
 */
#define SCU_GET_COMPLETION_INDEX(completion_code) \
	((completion_code) & SCU_COMPLETION_INDEX_MASK)

#define SCU_UNSOLICITED_FRAME_MASK     0x0FFF0000
#define SCU_UNSOLICITED_FRAME_SHIFT    16

/**
 * SCU_GET_FRAME_INDEX() -
 *
 * This macro returns a normalized frame index from an unsolicited frame
 * completion.
 */
#define SCU_GET_FRAME_INDEX(completion_code) \
	(\
		((completion_code) & SCU_UNSOLICITED_FRAME_MASK) \
		>> SCU_UNSOLICITED_FRAME_SHIFT \
	)

#define SCU_UNSOLICITED_FRAME_ERROR_MASK  0x00008000

/**
 * SCU_GET_FRAME_ERROR() -
 *
 * This macro returns a zero (0) value if there is no frame error otherwise it
 * returns non-zero (!0).
 */
#define SCU_GET_FRAME_ERROR(completion_code) \
	((completion_code) & SCU_UNSOLICITED_FRAME_ERROR_MASK)

/**
 *
 *
 * These constants represent normalized completion codes which must be shifted
 * 18 bits to match it with the hardware completion code. In a 16-bit compiler,
 * immediate constants are 16-bit values (the size of an int). If we shift
 * those by 18 bits, we completely lose the value. To ensure the value is a
 * 32-bit value like we want, each immediate value must be cast to a u32.
 */
#define SCU_TASK_DONE_GOOD                                  ((u32)0x00)
#define SCU_TASK_DONE_CRC_ERR                               ((u32)0x14)
#define SCU_TASK_DONE_CHECK_RESPONSE                        ((u32)0x14)
#define SCU_TASK_DONE_GEN_RESPONSE                          ((u32)0x15)
#define SCU_TASK_DONE_NAK_CMD_ERR                           ((u32)0x16)
#define SCU_TASK_DONE_CMD_LL_R_ERR                          ((u32)0x16)
#define SCU_TASK_DONE_LL_R_ERR                              ((u32)0x17)
#define SCU_TASK_DONE_ACK_NAK_TO                            ((u32)0x17)
#define SCU_TASK_DONE_LL_PERR                               ((u32)0x18)
#define SCU_TASK_DONE_LL_SY_TERM                            ((u32)0x19)
#define SCU_TASK_DONE_NAK_ERR                               ((u32)0x19)
#define SCU_TASK_DONE_LL_LF_TERM                            ((u32)0x1A)
#define SCU_TASK_DONE_DATA_LEN_ERR                          ((u32)0x1A)
#define SCU_TASK_DONE_LL_CL_TERM                            ((u32)0x1B)
#define SCU_TASK_DONE_LL_ABORT_ERR                          ((u32)0x1B)
#define SCU_TASK_DONE_SEQ_INV_TYPE                          ((u32)0x1C)
#define SCU_TASK_DONE_UNEXP_XR                              ((u32)0x1C)
#define SCU_TASK_DONE_INV_FIS_TYPE                          ((u32)0x1D)
#define SCU_TASK_DONE_XR_IU_LEN_ERR                         ((u32)0x1D)
#define SCU_TASK_DONE_INV_FIS_LEN                           ((u32)0x1E)
#define SCU_TASK_DONE_XR_WD_LEN                             ((u32)0x1E)
#define SCU_TASK_DONE_SDMA_ERR                              ((u32)0x1F)
#define SCU_TASK_DONE_OFFSET_ERR                            ((u32)0x20)
#define SCU_TASK_DONE_MAX_PLD_ERR                           ((u32)0x21)
#define SCU_TASK_DONE_EXCESS_DATA                           ((u32)0x22)
#define SCU_TASK_DONE_LF_ERR                                ((u32)0x23)
#define SCU_TASK_DONE_UNEXP_FIS                             ((u32)0x24)
#define SCU_TASK_DONE_UNEXP_RESP                            ((u32)0x24)
#define SCU_TASK_DONE_EARLY_RESP                            ((u32)0x25)
#define SCU_TASK_DONE_SMP_RESP_TO_ERR                       ((u32)0x26)
#define SCU_TASK_DONE_DMASETUP_DIRERR                       ((u32)0x27)
#define SCU_TASK_DONE_SMP_UFI_ERR                           ((u32)0x27)
#define SCU_TASK_DONE_XFERCNT_ERR                           ((u32)0x28)
#define SCU_TASK_DONE_SMP_FRM_TYPE_ERR                      ((u32)0x28)
#define SCU_TASK_DONE_SMP_LL_RX_ERR                         ((u32)0x29)
#define SCU_TASK_DONE_RESP_LEN_ERR                          ((u32)0x2A)
#define SCU_TASK_DONE_UNEXP_DATA                            ((u32)0x2B)
#define SCU_TASK_DONE_OPEN_FAIL                             ((u32)0x2C)
#define SCU_TASK_DONE_UNEXP_SDBFIS                          ((u32)0x2D)
#define SCU_TASK_DONE_REG_ERR                               ((u32)0x2E)
#define SCU_TASK_DONE_SDB_ERR                               ((u32)0x2F)
#define SCU_TASK_DONE_TASK_ABORT                            ((u32)0x30)
#define SCU_TASK_DONE_CMD_SDMA_ERR                          ((U32)0x32)
#define SCU_TASK_DONE_CMD_LL_ABORT_ERR                      ((U32)0x33)
#define SCU_TASK_OPEN_REJECT_WRONG_DESTINATION              ((u32)0x34)
#define SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_1             ((u32)0x35)
#define SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_2             ((u32)0x36)
#define SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_3             ((u32)0x37)
#define SCU_TASK_OPEN_REJECT_BAD_DESTINATION                ((u32)0x38)
#define SCU_TASK_OPEN_REJECT_ZONE_VIOLATION                 ((u32)0x39)
#define SCU_TASK_DONE_VIIT_ENTRY_NV                         ((u32)0x3A)
#define SCU_TASK_DONE_IIT_ENTRY_NV                          ((u32)0x3B)
#define SCU_TASK_DONE_RNCNV_OUTBOUND                        ((u32)0x3C)
#define SCU_TASK_OPEN_REJECT_STP_RESOURCES_BUSY             ((u32)0x3D)
#define SCU_TASK_OPEN_REJECT_PROTOCOL_NOT_SUPPORTED         ((u32)0x3E)
#define SCU_TASK_OPEN_REJECT_CONNECTION_RATE_NOT_SUPPORTED  ((u32)0x3F)

#endif /* _SCU_COMPLETION_CODES_HEADER_ */
OpenPOWER on IntegriCloud