Macros
#define	SCU_COMPLETION_TYPE_SHIFT 28

#define	SCU_COMPLETION_TYPE_MASK 0x70000000

#define	SCU_COMPLETION_TYPE(type) ((u32)(type) << SCU_COMPLETION_TYPE_SHIFT)

#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)

#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

#define	SCU_GET_COMPLETION_TYPE(completion_code) ((completion_code) & SCU_COMPLETION_TYPE_MASK)

#define	SCU_GET_COMPLETION_STATUS(completion_code) ((completion_code) & SCU_COMPLETION_STATUS_MASK)

#define	SCU_GET_COMPLETION_TL_STATUS(completion_code) ((completion_code) & SCU_COMPLETION_TL_STATUS_MASK)

#define	SCU_MAKE_COMPLETION_STATUS(completion_code) ((u32)(completion_code) << SCU_COMPLETION_TL_STATUS_SHIFT)

#define	SCU_NORMALIZE_COMPLETION_STATUS(completion_code)

#define	SCU_GET_COMPLETION_SDMA_STATUS(completion_code) ((completion_code) & SCU_COMPLETION_SDMA_STATUS_MASK)

#define	SCU_GET_COMPLETION_PEG(completion_code) ((completion_code) & SCU_COMPLETION_PEG_MASK)

#define	SCU_GET_COMPLETION_PORT(completion_code) ((completion_code) & SCU_COMPLETION_PORT_MASK)

#define	SCU_GET_PROTOCOL_ENGINE_INDEX(completion_code) (((completion_code) & SCU_COMPLETION_PE_MASK) >> SCU_COMPLETION_PE_SHIFT)

#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

#define	SCU_GET_FRAME_INDEX(completion_code)

#define	SCU_UNSOLICITED_FRAME_ERROR_MASK 0x00008000

#define	SCU_GET_FRAME_ERROR(completion_code) ((completion_code) & SCU_UNSOLICITED_FRAME_ERROR_MASK)

#define	SCU_TASK_DONE_GOOD ((u32)0x00)

#define	SCU_TASK_DONE_TX_RAW_CMD_ERR ((u32)0x08)

#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_BREAK_RCVD ((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)

Macro Definition Documentation

#define SCU_COMPLETION_INDEX_MASK 0x00000FFF

Definition at line 102 of file scu_completion_codes.h.

#define SCU_COMPLETION_PE_MASK SCU_COMPLETION_PORT_MASK

Definition at line 100 of file scu_completion_codes.h.

#define SCU_COMPLETION_PE_SHIFT 12

Definition at line 101 of file scu_completion_codes.h.

#define SCU_COMPLETION_PEG_MASK 0x00010000

Definition at line 98 of file scu_completion_codes.h.

#define SCU_COMPLETION_PORT_MASK 0x00007000

Definition at line 99 of file scu_completion_codes.h.

#define SCU_COMPLETION_SDMA_STATUS_MASK 0x003C0000

Definition at line 97 of file scu_completion_codes.h.

#define SCU_COMPLETION_STATUS_MASK 0x0FFC0000

These constants provide the shift and mask values for the various parts of an SCU completion code.

Definition at line 94 of file scu_completion_codes.h.

#define SCU_COMPLETION_TL_STATUS_MASK 0x0FC00000

Definition at line 95 of file scu_completion_codes.h.

#define SCU_COMPLETION_TL_STATUS_SHIFT 22

Definition at line 96 of file scu_completion_codes.h.

#define SCU_COMPLETION_TYPE ( type ) ((u32)(type) << SCU_COMPLETION_TYPE_SHIFT)

SCU_COMPLETION_TYPE() -

This macro constructs an SCU completion type

Definition at line 74 of file scu_completion_codes.h.

#define SCU_COMPLETION_TYPE_EVENT SCU_COMPLETION_TYPE(3)

Definition at line 85 of file scu_completion_codes.h.

#define SCU_COMPLETION_TYPE_MASK 0x70000000

Definition at line 67 of file scu_completion_codes.h.

#define SCU_COMPLETION_TYPE_NOTIFY SCU_COMPLETION_TYPE(4)

Definition at line 86 of file scu_completion_codes.h.

#define SCU_COMPLETION_TYPE_SDMA SCU_COMPLETION_TYPE(1)

Definition at line 83 of file scu_completion_codes.h.

#define SCU_COMPLETION_TYPE_SHIFT 28

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

Definition at line 66 of file scu_completion_codes.h.

#define SCU_COMPLETION_TYPE_TASK SCU_COMPLETION_TYPE(0)

SCU_COMPLETION_TYPE() -

These macros contain the SCU completion types SCU_COMPLETION_TYPE

Definition at line 82 of file scu_completion_codes.h.

#define SCU_COMPLETION_TYPE_UFI SCU_COMPLETION_TYPE(2)

Definition at line 84 of file scu_completion_codes.h.

#define SCU_GET_COMPLETION_INDEX ( completion_code ) ((completion_code) & SCU_COMPLETION_INDEX_MASK)

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.

Definition at line 188 of file scu_completion_codes.h.

#define SCU_GET_COMPLETION_PEG ( completion_code ) ((completion_code) & SCU_COMPLETION_PEG_MASK)

SCU_GET_COMPLETION_PEG() -

This macro returns the Protocol Engine Group from the completion code.

Definition at line 163 of file scu_completion_codes.h.

#define SCU_GET_COMPLETION_PORT ( completion_code ) ((completion_code) & SCU_COMPLETION_PORT_MASK)

SCU_GET_COMPLETION_PORT() -

This macro reuturns the logical port index from the completion code.

Definition at line 171 of file scu_completion_codes.h.

#define SCU_GET_COMPLETION_SDMA_STATUS ( completion_code ) ((completion_code) & SCU_COMPLETION_SDMA_STATUS_MASK)

SCU_GET_COMPLETION_SDMA_STATUS() -

This macro returns the SDMA completion status.

Definition at line 155 of file scu_completion_codes.h.

#define SCU_GET_COMPLETION_STATUS ( completion_code ) ((completion_code) & SCU_COMPLETION_STATUS_MASK)

SCU_GET_COMPLETION_STATUS() -

This macro returns the SCU completion status.

Definition at line 117 of file scu_completion_codes.h.

#define SCU_GET_COMPLETION_TL_STATUS ( completion_code ) ((completion_code) & SCU_COMPLETION_TL_STATUS_MASK)

SCU_GET_COMPLETION_TL_STATUS() -

This macro returns the transport layer completion status.

Definition at line 125 of file scu_completion_codes.h.

#define SCU_GET_COMPLETION_TYPE ( completion_code ) ((completion_code) & SCU_COMPLETION_TYPE_MASK)

SCU_GET_COMPLETION_TYPE() -

This macro returns the SCU completion type.

Definition at line 109 of file scu_completion_codes.h.

#define SCU_GET_FRAME_ERROR ( completion_code ) ((completion_code) & SCU_UNSOLICITED_FRAME_ERROR_MASK)

SCU_GET_FRAME_ERROR() -

This macro returns a zero (0) value if there is no frame error otherwise it returns non-zero (!0).

Definition at line 214 of file scu_completion_codes.h.

#define SCU_GET_FRAME_INDEX ( completion_code )

Value:

(\
        ((completion_code) & SCU_UNSOLICITED_FRAME_MASK) \
        >> SCU_UNSOLICITED_FRAME_SHIFT \
    )

SCU_GET_FRAME_INDEX() -

This macro returns a normalized frame index from an unsolicited frame completion.

Definition at line 200 of file scu_completion_codes.h.

#define SCU_GET_PROTOCOL_ENGINE_INDEX ( completion_code ) (((completion_code) & SCU_COMPLETION_PE_MASK) >> SCU_COMPLETION_PE_SHIFT)

SCU_GET_PROTOCOL_ENGINE_INDEX() -

This macro returns the PE index from the completion code.

Definition at line 179 of file scu_completion_codes.h.

#define SCU_MAKE_COMPLETION_STATUS ( completion_code ) ((u32)(completion_code) << SCU_COMPLETION_TL_STATUS_SHIFT)

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.

Definition at line 135 of file scu_completion_codes.h.

#define SCU_NORMALIZE_COMPLETION_STATUS ( completion_code )

Value:

(\
        ((completion_code) & SCU_COMPLETION_TL_STATUS_MASK) \
        >> 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.

Definition at line 144 of file scu_completion_codes.h.

#define SCU_TASK_DONE_ACK_NAK_TO ((u32)0x17)

Definition at line 234 of file scu_completion_codes.h.

#define SCU_TASK_DONE_BREAK_RCVD ((u32)0x1B)

Definition at line 241 of file scu_completion_codes.h.

#define SCU_TASK_DONE_CHECK_RESPONSE ((u32)0x14)

Definition at line 229 of file scu_completion_codes.h.

#define SCU_TASK_DONE_CMD_LL_ABORT_ERR ((U32)0x33)

Definition at line 271 of file scu_completion_codes.h.

#define SCU_TASK_DONE_CMD_LL_R_ERR ((u32)0x16)

Definition at line 232 of file scu_completion_codes.h.

#define SCU_TASK_DONE_CMD_SDMA_ERR ((U32)0x32)

Definition at line 270 of file scu_completion_codes.h.

#define SCU_TASK_DONE_CRC_ERR ((u32)0x14)

Definition at line 228 of file scu_completion_codes.h.

#define SCU_TASK_DONE_DATA_LEN_ERR ((u32)0x1A)

Definition at line 239 of file scu_completion_codes.h.

#define SCU_TASK_DONE_DMASETUP_DIRERR ((u32)0x27)

Definition at line 258 of file scu_completion_codes.h.

#define SCU_TASK_DONE_EARLY_RESP ((u32)0x25)

Definition at line 256 of file scu_completion_codes.h.

#define SCU_TASK_DONE_EXCESS_DATA ((u32)0x22)

Definition at line 252 of file scu_completion_codes.h.

#define SCU_TASK_DONE_GEN_RESPONSE ((u32)0x15)

Definition at line 230 of file scu_completion_codes.h.

#define SCU_TASK_DONE_GOOD ((u32)0x00)

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.

Definition at line 226 of file scu_completion_codes.h.

#define SCU_TASK_DONE_IIT_ENTRY_NV ((u32)0x3B)

Definition at line 279 of file scu_completion_codes.h.

#define SCU_TASK_DONE_INV_FIS_LEN ((u32)0x1E)

Definition at line 247 of file scu_completion_codes.h.

#define SCU_TASK_DONE_INV_FIS_TYPE ((u32)0x1D)

Definition at line 245 of file scu_completion_codes.h.

#define SCU_TASK_DONE_LF_ERR ((u32)0x23)

Definition at line 253 of file scu_completion_codes.h.

#define SCU_TASK_DONE_LL_ABORT_ERR ((u32)0x1B)

Definition at line 242 of file scu_completion_codes.h.

#define SCU_TASK_DONE_LL_CL_TERM ((u32)0x1B)

Definition at line 240 of file scu_completion_codes.h.

#define SCU_TASK_DONE_LL_LF_TERM ((u32)0x1A)

Definition at line 238 of file scu_completion_codes.h.

#define SCU_TASK_DONE_LL_PERR ((u32)0x18)

Definition at line 235 of file scu_completion_codes.h.

#define SCU_TASK_DONE_LL_R_ERR ((u32)0x17)

Definition at line 233 of file scu_completion_codes.h.

#define SCU_TASK_DONE_LL_SY_TERM ((u32)0x19)

Definition at line 236 of file scu_completion_codes.h.

#define SCU_TASK_DONE_MAX_PLD_ERR ((u32)0x21)

Definition at line 251 of file scu_completion_codes.h.

#define SCU_TASK_DONE_NAK_CMD_ERR ((u32)0x16)

Definition at line 231 of file scu_completion_codes.h.

#define SCU_TASK_DONE_NAK_ERR ((u32)0x19)

Definition at line 237 of file scu_completion_codes.h.

#define SCU_TASK_DONE_OFFSET_ERR ((u32)0x20)

Definition at line 250 of file scu_completion_codes.h.

#define SCU_TASK_DONE_OPEN_FAIL ((u32)0x2C)

Definition at line 265 of file scu_completion_codes.h.

#define SCU_TASK_DONE_REG_ERR ((u32)0x2E)

Definition at line 267 of file scu_completion_codes.h.

#define SCU_TASK_DONE_RESP_LEN_ERR ((u32)0x2A)

Definition at line 263 of file scu_completion_codes.h.

#define SCU_TASK_DONE_RNCNV_OUTBOUND ((u32)0x3C)

Definition at line 280 of file scu_completion_codes.h.

#define SCU_TASK_DONE_SDB_ERR ((u32)0x2F)

Definition at line 268 of file scu_completion_codes.h.

#define SCU_TASK_DONE_SDMA_ERR ((u32)0x1F)

Definition at line 249 of file scu_completion_codes.h.

#define SCU_TASK_DONE_SEQ_INV_TYPE ((u32)0x1C)

Definition at line 243 of file scu_completion_codes.h.

#define SCU_TASK_DONE_SMP_FRM_TYPE_ERR ((u32)0x28)

Definition at line 261 of file scu_completion_codes.h.

#define SCU_TASK_DONE_SMP_LL_RX_ERR ((u32)0x29)

Definition at line 262 of file scu_completion_codes.h.

#define SCU_TASK_DONE_SMP_RESP_TO_ERR ((u32)0x26)

Definition at line 257 of file scu_completion_codes.h.

#define SCU_TASK_DONE_SMP_UFI_ERR ((u32)0x27)

Definition at line 259 of file scu_completion_codes.h.

#define SCU_TASK_DONE_TASK_ABORT ((u32)0x30)

Definition at line 269 of file scu_completion_codes.h.

#define SCU_TASK_DONE_TX_RAW_CMD_ERR ((u32)0x08)

Definition at line 227 of file scu_completion_codes.h.

#define SCU_TASK_DONE_UNEXP_DATA ((u32)0x2B)

Definition at line 264 of file scu_completion_codes.h.

#define SCU_TASK_DONE_UNEXP_FIS ((u32)0x24)

Definition at line 254 of file scu_completion_codes.h.

#define SCU_TASK_DONE_UNEXP_RESP ((u32)0x24)

Definition at line 255 of file scu_completion_codes.h.

#define SCU_TASK_DONE_UNEXP_SDBFIS ((u32)0x2D)

Definition at line 266 of file scu_completion_codes.h.

#define SCU_TASK_DONE_UNEXP_XR ((u32)0x1C)

Definition at line 244 of file scu_completion_codes.h.

#define SCU_TASK_DONE_VIIT_ENTRY_NV ((u32)0x3A)

Definition at line 278 of file scu_completion_codes.h.

#define SCU_TASK_DONE_XFERCNT_ERR ((u32)0x28)

Definition at line 260 of file scu_completion_codes.h.

#define SCU_TASK_DONE_XR_IU_LEN_ERR ((u32)0x1D)

Definition at line 246 of file scu_completion_codes.h.

#define SCU_TASK_DONE_XR_WD_LEN ((u32)0x1E)

Definition at line 248 of file scu_completion_codes.h.

#define SCU_TASK_OPEN_REJECT_BAD_DESTINATION ((u32)0x38)

Definition at line 276 of file scu_completion_codes.h.

#define SCU_TASK_OPEN_REJECT_CONNECTION_RATE_NOT_SUPPORTED ((u32)0x3F)

Definition at line 283 of file scu_completion_codes.h.

#define SCU_TASK_OPEN_REJECT_PROTOCOL_NOT_SUPPORTED ((u32)0x3E)

Definition at line 282 of file scu_completion_codes.h.

#define SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_1 ((u32)0x35)

Definition at line 273 of file scu_completion_codes.h.

#define SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_2 ((u32)0x36)

Definition at line 274 of file scu_completion_codes.h.

#define SCU_TASK_OPEN_REJECT_RESERVED_ABANDON_3 ((u32)0x37)

Definition at line 275 of file scu_completion_codes.h.

#define SCU_TASK_OPEN_REJECT_STP_RESOURCES_BUSY ((u32)0x3D)

Definition at line 281 of file scu_completion_codes.h.

#define SCU_TASK_OPEN_REJECT_WRONG_DESTINATION ((u32)0x34)

Definition at line 272 of file scu_completion_codes.h.

#define SCU_TASK_OPEN_REJECT_ZONE_VIOLATION ((u32)0x39)

Definition at line 277 of file scu_completion_codes.h.

#define SCU_UNSOLICITED_FRAME_ERROR_MASK 0x00008000

Definition at line 206 of file scu_completion_codes.h.

#define SCU_UNSOLICITED_FRAME_MASK 0x0FFF0000

Definition at line 191 of file scu_completion_codes.h.

#define SCU_UNSOLICITED_FRAME_SHIFT 16

Definition at line 192 of file scu_completion_codes.h.

Macros

Macro Definition Documentation