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