1 /* 57xx_iscsi_constants.h: Broadcom NetXtreme II iSCSI HSI
2  *
3  * Copyright (c) 2006 - 2013 Broadcom Corporation
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation.
8  *
9  * Written by: Anil Veerabhadrappa (anilgv@broadcom.com)
10  * Maintained by: Eddie Wai (eddie.wai@broadcom.com)
11  */
12 #ifndef __57XX_ISCSI_CONSTANTS_H_
13 #define __57XX_ISCSI_CONSTANTS_H_
14 
15 /**
16 * This file defines HSI constants for the iSCSI flows
17 */
18 
19 /* iSCSI request op codes */
20 #define ISCSI_OPCODE_CLEANUP_REQUEST    (7)
21 
22 /* iSCSI response/messages op codes */
23 #define ISCSI_OPCODE_CLEANUP_RESPONSE 		(0x27)
24 #define ISCSI_OPCODE_NOPOUT_LOCAL_COMPLETION    (0)
25 
26 /* iSCSI task types */
27 #define ISCSI_TASK_TYPE_READ    (0)
28 #define ISCSI_TASK_TYPE_WRITE   (1)
29 #define ISCSI_TASK_TYPE_MPATH   (2)
30 
31 /* initial CQ sequence numbers */
32 #define ISCSI_INITIAL_SN    (1)
33 
34 /* KWQ (kernel work queue) layer codes */
35 #define ISCSI_KWQE_LAYER_CODE   (6)
36 
37 /* KWQ (kernel work queue) request op codes */
38 #define ISCSI_KWQE_OPCODE_OFFLOAD_CONN1 (0)
39 #define ISCSI_KWQE_OPCODE_OFFLOAD_CONN2 (1)
40 #define ISCSI_KWQE_OPCODE_UPDATE_CONN   (2)
41 #define ISCSI_KWQE_OPCODE_DESTROY_CONN  (3)
42 #define ISCSI_KWQE_OPCODE_INIT1         (4)
43 #define ISCSI_KWQE_OPCODE_INIT2         (5)
44 
45 /* KCQ (kernel completion queue) response op codes */
46 #define ISCSI_KCQE_OPCODE_OFFLOAD_CONN  (0x10)
47 #define ISCSI_KCQE_OPCODE_UPDATE_CONN   (0x12)
48 #define ISCSI_KCQE_OPCODE_DESTROY_CONN  (0x13)
49 #define ISCSI_KCQE_OPCODE_INIT          (0x14)
50 #define ISCSI_KCQE_OPCODE_FW_CLEAN_TASK	(0x15)
51 #define ISCSI_KCQE_OPCODE_TCP_RESET     (0x16)
52 #define ISCSI_KCQE_OPCODE_TCP_SYN       (0x17)
53 #define ISCSI_KCQE_OPCODE_TCP_FIN       (0X18)
54 #define ISCSI_KCQE_OPCODE_TCP_ERROR     (0x19)
55 #define ISCSI_KCQE_OPCODE_CQ_EVENT_NOTIFICATION (0x20)
56 #define ISCSI_KCQE_OPCODE_ISCSI_ERROR   (0x21)
57 
58 /* KCQ (kernel completion queue) completion status */
59 #define ISCSI_KCQE_COMPLETION_STATUS_SUCCESS                            (0x0)
60 #define ISCSI_KCQE_COMPLETION_STATUS_INVALID_OPCODE                     (0x1)
61 #define ISCSI_KCQE_COMPLETION_STATUS_CTX_ALLOC_FAILURE                  (0x2)
62 #define ISCSI_KCQE_COMPLETION_STATUS_CTX_FREE_FAILURE                   (0x3)
63 #define ISCSI_KCQE_COMPLETION_STATUS_NIC_ERROR                          (0x4)
64 
65 #define ISCSI_KCQE_COMPLETION_STATUS_HDR_DIG_ERR                        (0x5)
66 #define ISCSI_KCQE_COMPLETION_STATUS_DATA_DIG_ERR                       (0x6)
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 
74 /* Response */
75 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_EXP_DATASN            (0xf)
76 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_PEND_R2T              (0x10)
77 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_DATA_SEG_LEN_IS_ZERO  (0x2c)
78 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_DATA_SEG_LEN_TOO_BIG  (0x2d)
79 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_O_U_0                 (0x11)
80 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_O_U_1                 (0x12)
81 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_O_U_2                 (0x13)
82 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_O_U_3                 (0x14)
83 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_O_U_4                 (0x15)
84 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_O_U_5                 (0x16)
85 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_O_U_6                 (0x17)
86 
87 /* Data-In */
88 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_REMAIN_RCV_LEN        (0x18)
89 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_MAX_RCV_PDU_LEN       (0x19)
90 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_F_BIT_ZERO            (0x1a)
91 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_TTT_NOT_RSRV          (0x1b)
92 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_DATASN                (0x1c)
93 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_REMAIN_BURST_LEN      (0x1d)
94 
95 /* R2T */
96 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_BUFFER_OFF            (0x1f)
97 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_LUN                   (0x20)
98 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_R2TSN                 (0x21)
99 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_DESIRED_DATA_TRNS_LEN_0 (0x22)
100 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_DESIRED_DATA_TRNS_LEN_1 (0x23)
101 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_PEND_R2T_EXCEED       (0x24)
102 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_TTT_IS_RSRV           (0x25)
103 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_MAX_BURST_LEN         (0x26)
104 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_DATA_SEG_LEN_NOT_ZERO (0x27)
105 
106 /* TMF */
107 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_REJECT_PDU_LEN        (0x28)
108 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_ASYNC_PDU_LEN         (0x29)
109 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_NOPIN_PDU_LEN         (0x2a)
110 #define ISCSI_KCQE_COMPLETION_STATUS_PROTOCOL_ERR_PEND_R2T_IN_CLEANUP   (0x2b)
111 
112 /* IP/TCP processing errors: */
113 #define ISCI_KCQE_COMPLETION_STATUS_TCP_ERROR_IP_FRAGMENT               (0x40)
114 #define ISCI_KCQE_COMPLETION_STATUS_TCP_ERROR_IP_OPTIONS                (0x41)
115 #define ISCI_KCQE_COMPLETION_STATUS_TCP_ERROR_URGENT_FLAG               (0x42)
116 #define ISCI_KCQE_COMPLETION_STATUS_TCP_ERROR_MAX_RTRANS                (0x43)
117 
118 /* iSCSI licensing errors */
119 /* general iSCSI license not installed */
120 #define ISCSI_KCQE_COMPLETION_STATUS_ISCSI_NOT_SUPPORTED                (0x50)
121 /* additional LOM specific iSCSI license not installed */
122 #define ISCSI_KCQE_COMPLETION_STATUS_LOM_ISCSI_NOT_ENABLED              (0x51)
123 
124 #define ISCSI_KCQE_COMPLETION_STATUS_CID_BUSY				(0x80)
125 #define ISCSI_KCQE_COMPLETION_STATUS_PARITY_ERR                         (0x81)
126 
127 /* SQ/RQ/CQ DB structure sizes */
128 #define ISCSI_SQ_DB_SIZE    (16)
129 #define ISCSI_RQ_DB_SIZE    (64)
130 #define ISCSI_CQ_DB_SIZE    (80)
131 
132 #define ISCSI_SQN_TO_NOTIFY_NOT_VALID                                   0xFFFF
133 
134 /* Page size codes (for flags field in connection offload request) */
135 #define ISCSI_PAGE_SIZE_256     (0)
136 #define ISCSI_PAGE_SIZE_512     (1)
137 #define ISCSI_PAGE_SIZE_1K      (2)
138 #define ISCSI_PAGE_SIZE_2K      (3)
139 #define ISCSI_PAGE_SIZE_4K      (4)
140 #define ISCSI_PAGE_SIZE_8K      (5)
141 #define ISCSI_PAGE_SIZE_16K     (6)
142 #define ISCSI_PAGE_SIZE_32K     (7)
143 #define ISCSI_PAGE_SIZE_64K     (8)
144 #define ISCSI_PAGE_SIZE_128K    (9)
145 #define ISCSI_PAGE_SIZE_256K    (10)
146 #define ISCSI_PAGE_SIZE_512K    (11)
147 #define ISCSI_PAGE_SIZE_1M      (12)
148 #define ISCSI_PAGE_SIZE_2M      (13)
149 #define ISCSI_PAGE_SIZE_4M      (14)
150 #define ISCSI_PAGE_SIZE_8M      (15)
151 
152 /* Iscsi PDU related defines */
153 #define ISCSI_HEADER_SIZE   (48)
154 #define ISCSI_DIGEST_SHIFT  (2)
155 #define ISCSI_DIGEST_SIZE   (4)
156 
157 #define B577XX_ISCSI_CONNECTION_TYPE    3
158 
159 #endif /*__57XX_ISCSI_CONSTANTS_H_ */
160