GNU Linux-libre 4.14.303-gnu1
[releases.git] / drivers / scsi / qedi / qedi_iscsi.h
1 /*
2  * QLogic iSCSI Offload Driver
3  * Copyright (c) 2016 Cavium Inc.
4  *
5  * This software is available under the terms of the GNU General Public License
6  * (GPL) Version 2, available from the file COPYING in the main directory of
7  * this source tree.
8  */
9
10 #ifndef _QEDI_ISCSI_H_
11 #define _QEDI_ISCSI_H_
12
13 #include <linux/socket.h>
14 #include <linux/completion.h>
15 #include "qedi.h"
16
17 #define ISCSI_MAX_SESS_PER_HBA  4096
18
19 #define DEF_KA_TIMEOUT          7200000
20 #define DEF_KA_INTERVAL         10000
21 #define DEF_KA_MAX_PROBE_COUNT  10
22 #define DEF_TOS                 0
23 #define DEF_TTL                 0xfe
24 #define DEF_SND_SEQ_SCALE       0
25 #define DEF_RCV_BUF             0xffff
26 #define DEF_SND_BUF             0xffff
27 #define DEF_SEED                0
28 #define DEF_MAX_RT_TIME         8000
29 #define DEF_MAX_DA_COUNT        2
30 #define DEF_SWS_TIMER           1000
31 #define DEF_MAX_CWND            2
32 #define DEF_PATH_MTU            1500
33 #define DEF_MSS                 1460
34 #define DEF_LL2_MTU             1560
35 #define JUMBO_MTU               9000
36
37 #define MIN_MTU         576 /* rfc 793 */
38 #define IPV4_HDR_LEN    20
39 #define IPV6_HDR_LEN    40
40 #define TCP_HDR_LEN     20
41 #define TCP_OPTION_LEN  12
42 #define VLAN_LEN         4
43
44 enum {
45         EP_STATE_IDLE                   = 0x0,
46         EP_STATE_ACQRCONN_START         = 0x1,
47         EP_STATE_ACQRCONN_COMPL         = 0x2,
48         EP_STATE_OFLDCONN_START         = 0x4,
49         EP_STATE_OFLDCONN_COMPL         = 0x8,
50         EP_STATE_DISCONN_START          = 0x10,
51         EP_STATE_DISCONN_COMPL          = 0x20,
52         EP_STATE_CLEANUP_START          = 0x40,
53         EP_STATE_CLEANUP_CMPL           = 0x80,
54         EP_STATE_TCP_FIN_RCVD           = 0x100,
55         EP_STATE_TCP_RST_RCVD           = 0x200,
56         EP_STATE_LOGOUT_SENT            = 0x400,
57         EP_STATE_LOGOUT_RESP_RCVD       = 0x800,
58         EP_STATE_CLEANUP_FAILED         = 0x1000,
59         EP_STATE_OFLDCONN_FAILED        = 0x2000,
60         EP_STATE_CONNECT_FAILED         = 0x4000,
61         EP_STATE_DISCONN_TIMEDOUT       = 0x8000,
62         EP_STATE_OFLDCONN_NONE          = 0x10000,
63 };
64
65 struct qedi_conn;
66
67 struct qedi_endpoint {
68         struct qedi_ctx *qedi;
69         u32 dst_addr[4];
70         u32 src_addr[4];
71         u16 src_port;
72         u16 dst_port;
73         u16 vlan_id;
74         u16 pmtu;
75         u8 src_mac[ETH_ALEN];
76         u8 dst_mac[ETH_ALEN];
77         u8 ip_type;
78         int state;
79         wait_queue_head_t ofld_wait;
80         wait_queue_head_t tcp_ofld_wait;
81         u32 iscsi_cid;
82         /* identifier of the connection from qed */
83         u32 handle;
84         u32 fw_cid;
85         void __iomem *p_doorbell;
86
87         /* Send queue management */
88         struct iscsi_wqe *sq;
89         dma_addr_t sq_dma;
90
91         u16 sq_prod_idx;
92         u16 fw_sq_prod_idx;
93         u16 sq_con_idx;
94         u32 sq_mem_size;
95
96         void *sq_pbl;
97         dma_addr_t sq_pbl_dma;
98         u32 sq_pbl_size;
99         struct qedi_conn *conn;
100         struct work_struct offload_work;
101 };
102
103 #define QEDI_SQ_WQES_MIN        16
104
105 struct qedi_io_bdt {
106         struct scsi_sge *sge_tbl;
107         dma_addr_t sge_tbl_dma;
108         u16 sge_valid;
109 };
110
111 /**
112  * struct generic_pdu_resc - login pdu resource structure
113  *
114  * @req_buf:            driver buffer used to stage payload associated with
115  *                      the login request
116  * @req_dma_addr:       dma address for iscsi login request payload buffer
117  * @req_buf_size:       actual login request payload length
118  * @req_wr_ptr:         pointer into login request buffer when next data is
119  *                      to be written
120  * @resp_hdr:           iscsi header where iscsi login response header is to
121  *                      be recreated
122  * @resp_buf:           buffer to stage login response payload
123  * @resp_dma_addr:      login response payload buffer dma address
124  * @resp_buf_size:      login response paylod length
125  * @resp_wr_ptr:        pointer into login response buffer when next data is
126  *                      to be written
127  * @req_bd_tbl:         iscsi login request payload BD table
128  * @req_bd_dma:         login request BD table dma address
129  * @resp_bd_tbl:        iscsi login response payload BD table
130  * @resp_bd_dma:        login request BD table dma address
131  *
132  * following structure defines buffer info for generic pdus such as iSCSI Login,
133  *      Logout and NOP
134  */
135 struct generic_pdu_resc {
136         char *req_buf;
137         dma_addr_t req_dma_addr;
138         u32 req_buf_size;
139         char *req_wr_ptr;
140         struct iscsi_hdr resp_hdr;
141         char *resp_buf;
142         dma_addr_t resp_dma_addr;
143         u32 resp_buf_size;
144         char *resp_wr_ptr;
145         char *req_bd_tbl;
146         dma_addr_t req_bd_dma;
147         char *resp_bd_tbl;
148         dma_addr_t resp_bd_dma;
149 };
150
151 struct qedi_conn {
152         struct iscsi_cls_conn *cls_conn;
153         struct qedi_ctx *qedi;
154         struct qedi_endpoint *ep;
155         struct list_head active_cmd_list;
156         spinlock_t list_lock;           /* internal conn lock */
157         u32 active_cmd_count;
158         u32 cmd_cleanup_req;
159         u32 cmd_cleanup_cmpl;
160
161         u32 iscsi_conn_id;
162         int itt;
163         int abrt_conn;
164 #define QEDI_CID_RESERVED       0x5AFF
165         u32 fw_cid;
166         /*
167          * Buffer for login negotiation process
168          */
169         struct generic_pdu_resc gen_pdu;
170
171         struct list_head tmf_work_list;
172         wait_queue_head_t wait_queue;
173         spinlock_t tmf_work_lock;       /* tmf work lock */
174         unsigned long flags;
175 #define QEDI_CONN_FW_CLEANUP    1
176 };
177
178 struct qedi_cmd {
179         struct list_head io_cmd;
180         bool io_cmd_in_list;
181         struct iscsi_hdr hdr;
182         struct qedi_conn *conn;
183         struct scsi_cmnd *scsi_cmd;
184         struct scatterlist *sg;
185         struct qedi_io_bdt io_tbl;
186         struct iscsi_task_context request;
187         unsigned char *sense_buffer;
188         dma_addr_t sense_buffer_dma;
189         u16 task_id;
190
191         /* field populated for tmf work queue */
192         struct iscsi_task *task;
193         struct work_struct tmf_work;
194         int state;
195 #define CLEANUP_WAIT    1
196 #define CLEANUP_RECV    2
197 #define CLEANUP_WAIT_FAILED     3
198 #define CLEANUP_NOT_REQUIRED    4
199 #define LUN_RESET_RESPONSE_RECEIVED     5
200 #define RESPONSE_RECEIVED       6
201
202         int type;
203 #define TYPEIO          1
204 #define TYPERESET       2
205
206         struct qedi_work_map *list_tmf_work;
207         /* slowpath management */
208         bool use_slowpath;
209
210         struct iscsi_tm_rsp *tmf_resp_buf;
211         struct qedi_work cqe_work;
212 };
213
214 struct qedi_work_map {
215         struct list_head list;
216         struct qedi_cmd *qedi_cmd;
217         int rtid;
218
219         int state;
220 #define QEDI_WORK_QUEUED        1
221 #define QEDI_WORK_SCHEDULED     2
222 #define QEDI_WORK_EXIT          3
223
224         struct work_struct *ptr_tmf_work;
225 };
226
227 #define qedi_set_itt(task_id, itt) ((u32)(((task_id) & 0xffff) | ((itt) << 16)))
228 #define qedi_get_itt(cqe) (cqe.iscsi_hdr.cmd.itt >> 16)
229
230 #define QEDI_OFLD_WAIT_STATE(q) ((q)->state == EP_STATE_OFLDCONN_FAILED || \
231                                 (q)->state == EP_STATE_OFLDCONN_COMPL)
232
233 #endif /* _QEDI_ISCSI_H_ */