1 #ifndef __57XX_ISCSI_CONSTANTS_H_
2 #define __57XX_ISCSI_CONSTANTS_H_
3 
4 /**
5  * This file defines HSI constants for the iSCSI flows
6  */
7 
8 /* current iSCSI HSI version number (8 bit) */
9 #define ISCSI_HSI_VERSION (2)
10 
11 /* iSCSI request op codes */
12 #define ISCSI_OPCODE_CLEANUP_REQUEST    (7)
13 
14 /* iSCSI response/messages op codes */
15 #define ISCSI_OPCODE_NOPOUT_LOCAL_COMPLETION    (0)
16 #define ISCSI_OPCODE_CLEANUP_RESPONSE           (0x27)
17 
18 /* iSCSI task types */
19 #define ISCSI_TASK_TYPE_READ    (0)
20 #define ISCSI_TASK_TYPE_WRITE   (1)
21 #define ISCSI_TASK_TYPE_MPATH   (2)
22 
23 /* initial CQ sequence numbers */
24 #define ISCSI_INITIAL_SN    (1)
25 
26 /*Sqn_to_notify special values */
27 #define ISCSI_SQN_TO_NOTIFY_NOT_VALID							(0xFFFF)
28 #define ISCSI_SQN_TO_NOTIFY_EVENT_COALESCING_DISABLED			(0x0)
29 
30 /* KWQ (kernel work queue) layer codes */
31 #define ISCSI_KWQE_LAYER_CODE   (6)
32 
33 /* KWQ (kernel work queue) request op codes */
34 #define ISCSI_KWQE_OPCODE_OFFLOAD_CONN1 (0)
35 #define ISCSI_KWQE_OPCODE_OFFLOAD_CONN2 (1)
36 #define ISCSI_KWQE_OPCODE_OFFLOAD_CONN3 (6)
37 #define ISCSI_KWQE_OPCODE_UPDATE_CONN   (2)
38 #define ISCSI_KWQE_OPCODE_DESTROY_CONN  (3)
39 #define ISCSI_KWQE_OPCODE_INIT1         (4)
40 #define ISCSI_KWQE_OPCODE_INIT2         (5)
41 
42 /* KCQ (kernel completion queue) response op codes */
43 #define ISCSI_KCQE_OPCODE_OFFLOAD_CONN  (0x10)
44 #define ISCSI_KCQE_OPCODE_UPDATE_CONN   (0x12)
45 #define ISCSI_KCQE_OPCODE_DESTROY_CONN  (0x13)
46 #define ISCSI_KCQE_OPCODE_INIT          (0x14)
47 #define ISCSI_KCQE_OPCODE_FW_CLEAN_TASK (0x15) // for internal FW processing
48 #define ISCSI_KCQE_OPCODE_TCP_RESET     (0x16)
49 #define ISCSI_KCQE_OPCODE_TCP_SYN       (0x17)
50 #define ISCSI_KCQE_OPCODE_TCP_FIN       (0x18)
51 #define ISCSI_KCQE_OPCODE_TCP_ERROR     (0x19)
52 #define ISCSI_KCQE_OPCODE_CQ_EVENT_NOTIFICATION (0x20)
53 #define ISCSI_KCQE_OPCODE_ISCSI_ERROR   (0x21)
54 #define ISCSI_KCQE_OPCODE_DESTROY_CTX 	(0x22)
55 
56 /* KCQ (kernel completion queue) completion status */
57 #define ISCSI_KCQE_COMPLETION_STATUS_SUCCESS                            (0x0)
58 #define ISCSI_KCQE_COMPLETION_STATUS_INVALID_OPCODE                     (0x1)
59 #define ISCSI_KCQE_COMPLETION_STATUS_CTX_ALLOC_FAILURE                  (0x2)
60 #define ISCSI_KCQE_COMPLETION_STATUS_CTX_FREE_FAILURE                   (0x3)
61 #define ISCSI_KCQE_COMPLETION_STATUS_NIC_ERROR                          (0x4)
62 
63 #define ISCSI_KCQE_COMPLETION_STATUS_HDR_DIG_ERR                        (0x5)
64 #define ISCSI_KCQE_COMPLETION_STATUS_DATA_DIG_ERR                       (0x6)
65 
66 #define ISCSI_KCQE_COMPLETION_STATUS_WRONG_HSI_VERSION                  (0x8)
67 
68 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_UNEXPECTED_OPCODE     (0xa)
69 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_OPCODE                (0xb)
70 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_AHS_LEN               (0xc)
71 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_ITT                   (0xd)
72 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_STATSN                (0xe)
73 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_EXP_DATASN            (0xf)
74 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_PEND_R2T              (0x10)
75 
76 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_O_U_0                 (0x11)
77 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_O_U_1                 (0x12)
78 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_O_U_2                 (0x13)
79 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_O_U_3                 (0x14)
80 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_O_U_4                 (0x15)
81 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_O_U_5                 (0x16)
82 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_O_U_6                 (0x17)
83 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_REMAIN_RCV_LEN        (0x18)
84 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_MAX_RCV_PDU_LEN       (0x19)
85 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_F_BIT_ZERO            (0x1a)
86 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_TTT_NOT_RSRV          (0x1b)
87 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_DATASN                (0x1c)
88 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_REMAIN_BURST_LEN      (0x1d)
89 
90 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_BUFFER_OFF            (0x1f)
91 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_LUN                   (0x20)
92 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_R2TSN                 (0x21)
93 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_DESIRED_DATA_TRNS_LEN_0 (0x22)
94 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_DESIRED_DATA_TRNS_LEN_1 (0x23)
95 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_PEND_R2T_EXCEED       (0x24)
96 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_TTT_IS_RSRV           (0x25)
97 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_MAX_BURST_LEN         (0x26)
98 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_DATA_SEG_LEN_NOT_ZERO (0x27)
99 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_REJECT_PDU_LEN        (0x28)
100 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_ASYNC_PDU_LEN         (0x29)
101 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_NOPIN_PDU_LEN         (0x2a)
102 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_PEND_R2T_IN_CLEANUP   (0x2b)
103 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_DATA_SEG_LEN_IS_ZERO  (0x2c)
104 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_DATA_SEG_LEN_TOO_BIG  (0x2d)
105 
106 /* IP/TCP processing errors: */
107 #define ISCI_KCQE_COMPLETION_STATUS_TCP_ERROR_IP_FRAGMENT               (0x40)
108 #define ISCI_KCQE_COMPLETION_STATUS_TCP_ERROR_IP_OPTIONS                (0x41)
109 #define ISCI_KCQE_COMPLETION_STATUS_TCP_ERROR_URGENT_FLAG               (0x42)
110 #define ISCI_KCQE_COMPLETION_STATUS_TCP_ERROR_MAX_RTRANS                (0x43)
111 #define ISCI_KCQE_COMPLETION_STATUS_TCP_ERROR_MAX_OPTIONS_LENGTH        (0x44)
112 
113 /* iSCSI licensing errors */
114 /* general iSCSI license not installed */
115 #define ISCSI_KCQE_COMPLETION_STATUS_ISCSI_NOT_SUPPORTED                (0x50)
116 /* additional LOM specific iSCSI license not installed */
117 #define ISCSI_KCQE_COMPLETION_STATUS_LOM_ISCSI_NOT_ENABLED              (0x51)
118 
119 //Driver uses the range beyond this value
120 #define ISCSI_KCQE_COMPLETION_STATUS_LAST_FW_ENTRY						(0x7f)
121 
122 /* SQ/RQ/CQ DB structure sizes */
123 #define ISCSI_SQ_DB_SIZE    (16)
124 #define ISCSI_RQ_DB_SIZE    (64)
125 #define ISCSI_CQ_DB_SIZE    (80)
126 
127 /* Page size codes (for flags field in connection offload request) */
128 #define ISCSI_PAGE_SIZE_256     (0)
129 #define ISCSI_PAGE_SIZE_512     (1)
130 #define ISCSI_PAGE_SIZE_1K      (2)
131 #define ISCSI_PAGE_SIZE_2K      (3)
132 #define ISCSI_PAGE_SIZE_4K      (4)
133 #define ISCSI_PAGE_SIZE_8K      (5)
134 #define ISCSI_PAGE_SIZE_16K     (6)
135 #define ISCSI_PAGE_SIZE_32K     (7)
136 #define ISCSI_PAGE_SIZE_64K     (8)
137 #define ISCSI_PAGE_SIZE_128K    (9)
138 #define ISCSI_PAGE_SIZE_256K    (10)
139 #define ISCSI_PAGE_SIZE_512K    (11)
140 #define ISCSI_PAGE_SIZE_1M      (12)
141 #define ISCSI_PAGE_SIZE_2M      (13)
142 #define ISCSI_PAGE_SIZE_4M      (14)
143 #define ISCSI_PAGE_SIZE_8M      (15)
144 
145 /* Iscsi PDU related defines */
146 #define ISCSI_HEADER_SIZE   (48)
147 #define ISCSI_DIGEST_SHIFT  (2)
148 #define ISCSI_DIGEST_SIZE   (4)
149 
150 /* Everest iSCSI connection type */
151 #define B577XX_ISCSI_CONNECTION_TYPE (3)
152 
153 #endif /*__57XX_ISCSI_CONSTANTS_H_ */
154 
155