]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/scsi/lpfc/lpfc_sli.h
Merge tag 'efi-urgent' of git://git.kernel.org/pub/scm/linux/kernel/git/efi/efi into...
[mirror_ubuntu-artful-kernel.git] / drivers / scsi / lpfc / lpfc_sli.h
CommitLineData
dea3101e
JB
1/*******************************************************************
2 * This file is part of the Emulex Linux Device Driver for *
c44ce173 3 * Fibre Channel Host Bus Adapters. *
d080abe0
JS
4 * Copyright (C) 2017 Broadcom. All Rights Reserved. The term *
5 * “Broadcom” refers to Broadcom Limited and/or its subsidiaries. *
51f4ca3c 6 * Copyright (C) 2004-2016 Emulex. All rights reserved. *
c44ce173 7 * EMULEX and SLI are trademarks of Emulex. *
d080abe0 8 * www.broadcom.com *
dea3101e
JB
9 * *
10 * This program is free software; you can redistribute it and/or *
c44ce173
JSEC
11 * modify it under the terms of version 2 of the GNU General *
12 * Public License as published by the Free Software Foundation. *
13 * This program is distributed in the hope that it will be useful. *
14 * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND *
15 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, *
16 * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE *
17 * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
18 * TO BE LEGALLY INVALID. See the GNU General Public License for *
19 * more details, a copy of which can be found in the file COPYING *
20 * included with this package. *
dea3101e
JB
21 *******************************************************************/
22
dea3101e
JB
23/* forward declaration for LPFC_IOCB_t's use */
24struct lpfc_hba;
2e0fef85 25struct lpfc_vport;
dea3101e
JB
26
27/* Define the context types that SLI handles for abort and sums. */
28typedef enum _lpfc_ctx_cmd {
29 LPFC_CTX_LUN,
30 LPFC_CTX_TGT,
dea3101e
JB
31 LPFC_CTX_HOST
32} lpfc_ctx_cmd;
33
4d9ab994
JS
34struct lpfc_cq_event {
35 struct list_head list;
36 union {
37 struct lpfc_mcqe mcqe_cmpl;
38 struct lpfc_acqe_link acqe_link;
70f3c073 39 struct lpfc_acqe_fip acqe_fip;
4d9ab994 40 struct lpfc_acqe_dcbx acqe_dcbx;
b19a061a 41 struct lpfc_acqe_grp5 acqe_grp5;
70f3c073
JS
42 struct lpfc_acqe_fc_la acqe_fc;
43 struct lpfc_acqe_sli acqe_sli;
4d9ab994
JS
44 struct lpfc_rcqe rcqe_cmpl;
45 struct sli4_wcqe_xri_aborted wcqe_axri;
46 struct lpfc_wcqe_complete wcqe_cmpl;
47 } cqe;
da0436e9
JS
48};
49
dea3101e
JB
50/* This structure is used to handle IOCB requests / responses */
51struct lpfc_iocbq {
52 /* lpfc_iocbqs are used in double linked lists */
53 struct list_head list;
9c2face6 54 struct list_head clist;
2a9bf3d0 55 struct list_head dlist;
604a3e30 56 uint16_t iotag; /* pre-assigned IO tag */
6d368e53 57 uint16_t sli4_lxritag; /* logical pre-assigned XRI. */
da0436e9 58 uint16_t sli4_xritag; /* pre-assigned XRI, (OXID) tag. */
895427bd 59 uint16_t hba_wqidx; /* index to HBA work queue */
45ed1190 60 struct lpfc_cq_event cq_event;
895427bd
JS
61 struct lpfc_wcqe_complete wcqe_cmpl; /* WQE cmpl */
62 uint64_t isr_timestamp;
604a3e30 63
895427bd
JS
64 /* Be careful here */
65 union lpfc_wqe wqe; /* WQE cmd */
66 IOCB_t iocb; /* For IOCB cmd or if we want 128 byte WQE */
67
68 uint8_t rsvd2;
c92c841c 69 uint8_t priority; /* OAS priority */
dea3101e 70 uint8_t retry; /* retry counter for IOCB cmd - if needed */
1b8d11ab 71 uint32_t iocb_flag;
07951076 72#define LPFC_IO_LIBDFC 1 /* libdfc iocb */
5a0916b4
JS
73#define LPFC_IO_WAKE 2 /* Synchronous I/O completed */
74#define LPFC_IO_WAKE_TMO LPFC_IO_WAKE /* Synchronous I/O timed out */
07951076
JS
75#define LPFC_IO_FCP 4 /* FCP command -- iocbq in scsi_buf */
76#define LPFC_DRIVER_ABORTED 8 /* driver aborted this request */
92d7f7b0 77#define LPFC_IO_FABRIC 0x10 /* Iocb send using fabric scheduler */
0ff10d46 78#define LPFC_DELAY_MEM_FREE 0x20 /* Defer free'ing of FC data */
341af102
JS
79#define LPFC_EXCHANGE_BUSY 0x40 /* SLI4 hba reported XB in response */
80#define LPFC_USE_FCPWQIDX 0x80 /* Submit to specified FCPWQ index */
0f65ff68 81#define DSS_SECURITY_OP 0x100 /* security IO */
4f2e66c6 82#define LPFC_IO_ON_TXCMPLQ 0x200 /* The IO is still on the TXCMPLQ */
8012cc38
JS
83#define LPFC_IO_DIF_PASS 0x400 /* T10 DIF IO pass-thru prot */
84#define LPFC_IO_DIF_STRIP 0x800 /* T10 DIF IO strip prot */
85#define LPFC_IO_DIF_INSERT 0x1000 /* T10 DIF IO insert prot */
1b8d11ab 86#define LPFC_IO_CMD_OUTSTANDING 0x2000 /* timeout handler abort window */
341af102
JS
87
88#define LPFC_FIP_ELS_ID_MASK 0xc000 /* ELS_ID range 0-3, non-shifted mask */
89#define LPFC_FIP_ELS_ID_SHIFT 14
dea3101e 90
1ba981fd 91#define LPFC_IO_OAS 0x10000 /* OAS FCP IO */
9bd2bff5 92#define LPFC_IO_FOF 0x20000 /* FOF FCP IO */
6c7cf486 93#define LPFC_IO_LOOPBACK 0x40000 /* Loopback IO */
895427bd
JS
94#define LPFC_PRLI_NVME_REQ 0x80000 /* This is an NVME PRLI. */
95#define LPFC_PRLI_FCP_REQ 0x100000 /* This is an NVME PRLI. */
96#define LPFC_IO_NVME 0x200000 /* NVME FCP command */
97#define LPFC_IO_NVME_LS 0x400000 /* NVME LS command */
f358dd0c 98#define LPFC_IO_NVMET 0x800000 /* NVMET command */
1ba981fd 99
dea3101e 100 uint32_t drvrTimeout; /* driver timeout in seconds */
2e0fef85 101 struct lpfc_vport *vport;/* virtual port pointer */
dea3101e
JB
102 void *context1; /* caller context information */
103 void *context2; /* caller context information */
104 void *context3; /* caller context information */
105 union {
51ef4c26
JS
106 wait_queue_head_t *wait_queue;
107 struct lpfc_iocbq *rsp_iocb;
108 struct lpfcMboxq *mbox;
109 struct lpfc_nodelist *ndlp;
19ca7609 110 struct lpfc_node_rrq *rrq;
dea3101e
JB
111 } context_un;
112
2ea259ee 113 void (*fabric_iocb_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
92d7f7b0 114 struct lpfc_iocbq *);
2ea259ee 115 void (*wait_iocb_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
5a0916b4 116 struct lpfc_iocbq *);
2ea259ee 117 void (*iocb_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
dea3101e 118 struct lpfc_iocbq *);
895427bd
JS
119 void (*wqe_cmpl)(struct lpfc_hba *, struct lpfc_iocbq *,
120 struct lpfc_wcqe_complete *);
dea3101e
JB
121};
122
123#define SLI_IOCB_RET_IOCB 1 /* Return IOCB if cmd ring full */
dea3101e
JB
124
125#define IOCB_SUCCESS 0
126#define IOCB_BUSY 1
127#define IOCB_ERROR 2
128#define IOCB_TIMEDOUT 3
129
895427bd
JS
130#define SLI_WQE_RET_WQE 1 /* Return WQE if cmd ring full */
131
132#define WQE_SUCCESS 0
133#define WQE_BUSY 1
134#define WQE_ERROR 2
135#define WQE_TIMEDOUT 3
136#define WQE_ABORTED 4
137
858c9f6c
JS
138#define LPFC_MBX_WAKE 1
139#define LPFC_MBX_IMED_UNREG 2
7054a606 140
dea3101e
JB
141typedef struct lpfcMboxq {
142 /* MBOXQs are used in single linked lists */
143 struct list_head list; /* ptr to next mailbox command */
da0436e9
JS
144 union {
145 MAILBOX_t mb; /* Mailbox cmd */
146 struct lpfc_mqe mqe;
147 } u;
148 struct lpfc_vport *vport;/* virtual port pointer */
dea3101e
JB
149 void *context1; /* caller context information */
150 void *context2; /* caller context information */
151
152 void (*mbox_cmpl) (struct lpfc_hba *, struct lpfcMboxq *);
7054a606 153 uint8_t mbox_flag;
7a470277
JS
154 uint16_t in_ext_byte_len;
155 uint16_t out_ext_byte_len;
156 uint8_t mbox_offset_word;
da0436e9
JS
157 struct lpfc_mcqe mcqe;
158 struct lpfc_mbx_nembed_sge_virt *sge_array;
dea3101e
JB
159} LPFC_MBOXQ_t;
160
161#define MBX_POLL 1 /* poll mailbox till command done, then
162 return */
163#define MBX_NOWAIT 2 /* issue command then return immediately */
dea3101e 164
6669f9bb 165#define LPFC_MAX_RING_MASK 5 /* max num of rctl/type masks allowed per
dea3101e 166 ring */
2a76a283
JS
167#define LPFC_SLI3_MAX_RING 4 /* Max num of SLI3 rings used by driver.
168 For SLI4, an additional ring for each
169 FCP WQ will be allocated. */
dea3101e
JB
170
171struct lpfc_sli_ring;
172
173struct lpfc_sli_ring_mask {
174 uint8_t profile; /* profile associated with ring */
175 uint8_t rctl; /* rctl / type pair configured for ring */
176 uint8_t type; /* rctl / type pair configured for ring */
177 uint8_t rsvd;
178 /* rcv'd unsol event */
179 void (*lpfc_sli_rcv_unsol_event) (struct lpfc_hba *,
180 struct lpfc_sli_ring *,
181 struct lpfc_iocbq *);
182};
183
184
185/* Structure used to hold SLI statistical counters and info */
186struct lpfc_sli_ring_stat {
187 uint64_t iocb_event; /* IOCB event counters */
188 uint64_t iocb_cmd; /* IOCB cmd issued */
189 uint64_t iocb_rsp; /* IOCB rsp received */
190 uint64_t iocb_cmd_delay; /* IOCB cmd ring delay */
191 uint64_t iocb_cmd_full; /* IOCB cmd ring full */
192 uint64_t iocb_cmd_empty; /* IOCB cmd ring is now empty */
193 uint64_t iocb_rsp_full; /* IOCB rsp ring full */
194};
195
7e56aa25
JS
196struct lpfc_sli3_ring {
197 uint32_t local_getidx; /* last available cmd index (from cmdGetInx) */
198 uint32_t next_cmdidx; /* next_cmd index */
199 uint32_t rspidx; /* current index in response ring */
200 uint32_t cmdidx; /* current index in command ring */
201 uint16_t numCiocb; /* number of command iocb's per ring */
202 uint16_t numRiocb; /* number of rsp iocb's per ring */
203 uint16_t sizeCiocb; /* Size of command iocb's in this ring */
204 uint16_t sizeRiocb; /* Size of response iocb's in this ring */
205 uint32_t *cmdringaddr; /* virtual address for cmd rings */
206 uint32_t *rspringaddr; /* virtual address for rsp rings */
207};
208
209struct lpfc_sli4_ring {
2a76a283 210 struct lpfc_queue *wqp; /* Pointer to associated WQ */
7e56aa25
JS
211};
212
213
dea3101e
JB
214/* Structure used to hold SLI ring information */
215struct lpfc_sli_ring {
216 uint16_t flag; /* ring flags */
217#define LPFC_DEFERRED_RING_EVENT 0x001 /* Deferred processing a ring event */
218#define LPFC_CALL_RING_AVAILABLE 0x002 /* indicates cmd was full */
dea3101e 219#define LPFC_STOP_IOCB_EVENT 0x020 /* Stop processing IOCB cmds event */
dea3101e
JB
220 uint16_t abtsiotag; /* tracks next iotag to use for ABTS */
221
dea3101e
JB
222 uint8_t rsvd;
223 uint8_t ringno; /* ring number */
7e56aa25
JS
224
225 spinlock_t ring_lock; /* lock for issuing commands */
dea3101e
JB
226
227 uint32_t fast_iotag; /* max fastlookup based iotag */
228 uint32_t iotag_ctr; /* keeps track of the next iotag to use */
229 uint32_t iotag_max; /* max iotag value to use */
dea3101e
JB
230 struct list_head txq;
231 uint16_t txq_cnt; /* current length of queue */
232 uint16_t txq_max; /* max length */
233 struct list_head txcmplq;
234 uint16_t txcmplq_cnt; /* current length of queue */
235 uint16_t txcmplq_max; /* max length */
dea3101e
JB
236 uint32_t missbufcnt; /* keep track of buffers to post */
237 struct list_head postbufq;
238 uint16_t postbufq_cnt; /* current length of queue */
239 uint16_t postbufq_max; /* max length */
240 struct list_head iocb_continueq;
241 uint16_t iocb_continueq_cnt; /* current length of queue */
242 uint16_t iocb_continueq_max; /* max length */
9c2face6 243 struct list_head iocb_continue_saveq;
dea3101e
JB
244
245 struct lpfc_sli_ring_mask prt[LPFC_MAX_RING_MASK];
246 uint32_t num_mask; /* number of mask entries in prt array */
57127f15
JS
247 void (*lpfc_sli_rcv_async_status) (struct lpfc_hba *,
248 struct lpfc_sli_ring *, struct lpfc_iocbq *);
dea3101e
JB
249
250 struct lpfc_sli_ring_stat stats; /* SLI statistical info */
251
252 /* cmd ring available */
253 void (*lpfc_sli_cmd_available) (struct lpfc_hba *,
254 struct lpfc_sli_ring *);
7e56aa25
JS
255 union {
256 struct lpfc_sli3_ring sli3;
257 struct lpfc_sli4_ring sli4;
258 } sli;
dea3101e
JB
259};
260
ed957684
JS
261/* Structure used for configuring rings to a specific profile or rctl / type */
262struct lpfc_hbq_init {
263 uint32_t rn; /* Receive buffer notification */
92d7f7b0 264 uint32_t entry_count; /* max # of entries in HBQ */
ed957684
JS
265 uint32_t headerLen; /* 0 if not profile 4 or 5 */
266 uint32_t logEntry; /* Set to 1 if this HBQ used for LogEntry */
267 uint32_t profile; /* Selection profile 0=all, 7=logentry */
268 uint32_t ring_mask; /* Binds HBQ to a ring e.g. Ring0=b0001,
269 * ring2=b0100 */
270 uint32_t hbq_index; /* index of this hbq in ring .HBQs[] */
271
272 uint32_t seqlenoff;
273 uint32_t maxlen;
274 uint32_t seqlenbcnt;
275 uint32_t cmdcodeoff;
276 uint32_t cmdmatch[8];
277 uint32_t mask_count; /* number of mask entries in prt array */
278 struct hbq_mask hbqMasks[6];
92d7f7b0
JS
279
280 /* Non-config rings fields to keep track of buffer allocations */
281 uint32_t buffer_count; /* number of buffers allocated */
282 uint32_t init_count; /* number to allocate when initialized */
283 uint32_t add_count; /* number to allocate when starved */
ed957684
JS
284} ;
285
dea3101e
JB
286/* Structure used to hold SLI statistical counters and info */
287struct lpfc_sli_stat {
288 uint64_t mbox_stat_err; /* Mbox cmds completed status error */
289 uint64_t mbox_cmd; /* Mailbox commands issued */
290 uint64_t sli_intr; /* Count of Host Attention interrupts */
aa6fbb75
JS
291 uint64_t sli_prev_intr; /* Previous cnt of Host Attention interrupts */
292 uint64_t sli_ips; /* Host Attention interrupts per sec */
dea3101e
JB
293 uint32_t err_attn_event; /* Error Attn event counters */
294 uint32_t link_event; /* Link event counters */
295 uint32_t mbox_event; /* Mailbox event counters */
296 uint32_t mbox_busy; /* Mailbox cmd busy */
297};
298
64ba8818
JS
299/* Structure to store link status values when port stats are reset */
300struct lpfc_lnk_stat {
301 uint32_t link_failure_count;
302 uint32_t loss_of_sync_count;
303 uint32_t loss_of_signal_count;
304 uint32_t prim_seq_protocol_err_count;
305 uint32_t invalid_tx_word_count;
306 uint32_t invalid_crc_count;
307 uint32_t error_frames;
308 uint32_t link_events;
309};
310
dea3101e
JB
311/* Structure used to hold SLI information */
312struct lpfc_sli {
313 uint32_t num_rings;
314 uint32_t sli_flag;
315
316 /* Additional sli_flags */
317#define LPFC_SLI_MBOX_ACTIVE 0x100 /* HBA mailbox is currently active */
f4b4c68f 318#define LPFC_SLI_ACTIVE 0x200 /* SLI in firmware is active */
dea3101e 319#define LPFC_PROCESS_LA 0x400 /* Able to process link attention */
2e0fef85 320#define LPFC_BLOCK_MGMT_IO 0x800 /* Don't allow mgmt mbx or iocb cmds */
84774a4d 321#define LPFC_MENLO_MAINT 0x1000 /* need for menl fw download */
da0436e9 322#define LPFC_SLI_ASYNC_MBX_BLK 0x2000 /* Async mailbox is blocked */
f358dd0c 323#define LPFC_SLI_SUPPRESS_RSP 0x4000 /* Suppress RSP feature is supported */
dea3101e 324
895427bd 325 struct lpfc_sli_ring *sli3_ring;
dea3101e
JB
326
327 struct lpfc_sli_stat slistat; /* SLI statistical info */
328 struct list_head mboxq;
329 uint16_t mboxq_cnt; /* current length of queue */
330 uint16_t mboxq_max; /* max length */
331 LPFC_MBOXQ_t *mbox_active; /* active mboxq information */
92d7f7b0 332 struct list_head mboxq_cmpl;
dea3101e
JB
333
334 struct timer_list mbox_tmo; /* Hold clk to timeout active mbox
335 cmd */
336
604a3e30
JB
337#define LPFC_IOCBQ_LOOKUP_INCREMENT 1024
338 struct lpfc_iocbq ** iocbq_lookup; /* array to lookup IOCB by IOTAG */
339 size_t iocbq_lookup_len; /* current lengs of the array */
340 uint16_t last_iotag; /* last allocated IOTAG */
64ba8818
JS
341 unsigned long stats_start; /* in seconds */
342 struct lpfc_lnk_stat lnk_stat_offsets;
dea3101e
JB
343};
344
a183a15f
JS
345/* Timeout for normal outstanding mbox command (Seconds) */
346#define LPFC_MBOX_TMO 30
347/* Timeout for non-flash-based outstanding sli_config mbox command (Seconds) */
348#define LPFC_MBOX_SLI4_CONFIG_TMO 60
349/* Timeout for flash-based outstanding sli_config mbox command (Seconds) */
350#define LPFC_MBOX_SLI4_CONFIG_EXTENDED_TMO 300
351/* Timeout for other flash-based outstanding mbox command (Seconds) */
352#define LPFC_MBOX_TMO_FLASH_CMD 300