1 | /* SPDX-License-Identifier: GPL-2.0-only */ |
2 | /* |
3 | * Copyright 2008 Cisco Systems, Inc. All rights reserved. |
4 | * Copyright 2007 Nuova Systems, Inc. All rights reserved. |
5 | */ |
6 | #ifndef _FNIC_H_ |
7 | #define _FNIC_H_ |
8 | |
9 | #include <linux/interrupt.h> |
10 | #include <linux/netdevice.h> |
11 | #include <linux/workqueue.h> |
12 | #include <linux/bitops.h> |
13 | #include <scsi/libfc.h> |
14 | #include <scsi/libfcoe.h> |
15 | #include "fnic_io.h" |
16 | #include "fnic_res.h" |
17 | #include "fnic_trace.h" |
18 | #include "fnic_stats.h" |
19 | #include "vnic_dev.h" |
20 | #include "vnic_wq.h" |
21 | #include "vnic_rq.h" |
22 | #include "vnic_cq.h" |
23 | #include "vnic_wq_copy.h" |
24 | #include "vnic_intr.h" |
25 | #include "vnic_stats.h" |
26 | #include "vnic_scsi.h" |
27 | |
28 | #define DRV_NAME "fnic" |
29 | #define DRV_DESCRIPTION "Cisco FCoE HBA Driver" |
30 | #define DRV_VERSION "1.7.0.0" |
31 | #define PFX DRV_NAME ": " |
32 | #define DFX DRV_NAME "%d: " |
33 | |
34 | #define DESC_CLEAN_LOW_WATERMARK 8 |
35 | #define FNIC_UCSM_DFLT_THROTTLE_CNT_BLD 16 /* UCSM default throttle count */ |
36 | #define FNIC_MIN_IO_REQ 256 /* Min IO throttle count */ |
37 | #define FNIC_MAX_IO_REQ 1024 /* scsi_cmnd tag map entries */ |
38 | #define FNIC_DFLT_IO_REQ 256 /* Default scsi_cmnd tag map entries */ |
39 | #define FNIC_DFLT_QUEUE_DEPTH 256 |
40 | #define FNIC_STATS_RATE_LIMIT 4 /* limit rate at which stats are pulled up */ |
41 | |
42 | /* |
43 | * Tag bits used for special requests. |
44 | */ |
45 | #define FNIC_TAG_ABORT BIT(30) /* tag bit indicating abort */ |
46 | #define FNIC_TAG_DEV_RST BIT(29) /* indicates device reset */ |
47 | #define FNIC_TAG_MASK (BIT(24) - 1) /* mask for lookup */ |
48 | #define FNIC_NO_TAG -1 |
49 | |
50 | /* |
51 | * Command flags to identify the type of command and for other future |
52 | * use. |
53 | */ |
54 | #define FNIC_NO_FLAGS 0 |
55 | #define FNIC_IO_INITIALIZED BIT(0) |
56 | #define FNIC_IO_ISSUED BIT(1) |
57 | #define FNIC_IO_DONE BIT(2) |
58 | #define FNIC_IO_REQ_NULL BIT(3) |
59 | #define FNIC_IO_ABTS_PENDING BIT(4) |
60 | #define FNIC_IO_ABORTED BIT(5) |
61 | #define FNIC_IO_ABTS_ISSUED BIT(6) |
62 | #define FNIC_IO_TERM_ISSUED BIT(7) |
63 | #define FNIC_IO_INTERNAL_TERM_ISSUED BIT(8) |
64 | #define FNIC_IO_ABT_TERM_DONE BIT(9) |
65 | #define FNIC_IO_ABT_TERM_REQ_NULL BIT(10) |
66 | #define FNIC_IO_ABT_TERM_TIMED_OUT BIT(11) |
67 | #define FNIC_DEVICE_RESET BIT(12) /* Device reset request */ |
68 | #define FNIC_DEV_RST_ISSUED BIT(13) |
69 | #define FNIC_DEV_RST_TIMED_OUT BIT(14) |
70 | #define FNIC_DEV_RST_ABTS_ISSUED BIT(15) |
71 | #define FNIC_DEV_RST_TERM_ISSUED BIT(16) |
72 | #define FNIC_DEV_RST_DONE BIT(17) |
73 | #define FNIC_DEV_RST_REQ_NULL BIT(18) |
74 | #define FNIC_DEV_RST_ABTS_DONE BIT(19) |
75 | #define FNIC_DEV_RST_TERM_DONE BIT(20) |
76 | #define FNIC_DEV_RST_ABTS_PENDING BIT(21) |
77 | |
78 | /* |
79 | * fnic private data per SCSI command. |
80 | * These fields are locked by the hashed io_req_lock. |
81 | */ |
82 | struct fnic_cmd_priv { |
83 | struct fnic_io_req *io_req; |
84 | enum fnic_ioreq_state state; |
85 | u32 flags; |
86 | u16 abts_status; |
87 | u16 lr_status; |
88 | }; |
89 | |
90 | static inline struct fnic_cmd_priv *fnic_priv(struct scsi_cmnd *cmd) |
91 | { |
92 | return scsi_cmd_priv(cmd); |
93 | } |
94 | |
95 | static inline u64 fnic_flags_and_state(struct scsi_cmnd *cmd) |
96 | { |
97 | struct fnic_cmd_priv *fcmd = fnic_priv(cmd); |
98 | |
99 | return ((u64)fcmd->flags << 32) | fcmd->state; |
100 | } |
101 | |
102 | #define FCPIO_INVALID_CODE 0x100 /* hdr_status value unused by firmware */ |
103 | |
104 | #define FNIC_LUN_RESET_TIMEOUT 10000 /* mSec */ |
105 | #define FNIC_HOST_RESET_TIMEOUT 10000 /* mSec */ |
106 | #define FNIC_RMDEVICE_TIMEOUT 1000 /* mSec */ |
107 | #define FNIC_HOST_RESET_SETTLE_TIME 30 /* Sec */ |
108 | #define FNIC_ABT_TERM_DELAY_TIMEOUT 500 /* mSec */ |
109 | |
110 | #define FNIC_MAX_FCP_TARGET 256 |
111 | #define FNIC_PCI_OFFSET 2 |
112 | /** |
113 | * state_flags to identify host state along along with fnic's state |
114 | **/ |
115 | #define __FNIC_FLAGS_FWRESET BIT(0) /* fwreset in progress */ |
116 | #define __FNIC_FLAGS_BLOCK_IO BIT(1) /* IOs are blocked */ |
117 | |
118 | #define FNIC_FLAGS_NONE (0) |
119 | #define FNIC_FLAGS_FWRESET (__FNIC_FLAGS_FWRESET | \ |
120 | __FNIC_FLAGS_BLOCK_IO) |
121 | |
122 | #define FNIC_FLAGS_IO_BLOCKED (__FNIC_FLAGS_BLOCK_IO) |
123 | |
124 | #define fnic_set_state_flags(fnicp, st_flags) \ |
125 | __fnic_set_state_flags(fnicp, st_flags, 0) |
126 | |
127 | #define fnic_clear_state_flags(fnicp, st_flags) \ |
128 | __fnic_set_state_flags(fnicp, st_flags, 1) |
129 | |
130 | extern unsigned int fnic_log_level; |
131 | extern unsigned int io_completions; |
132 | |
133 | #define FNIC_MAIN_LOGGING 0x01 |
134 | #define FNIC_FCS_LOGGING 0x02 |
135 | #define FNIC_SCSI_LOGGING 0x04 |
136 | #define FNIC_ISR_LOGGING 0x08 |
137 | |
138 | #define FNIC_CHECK_LOGGING(LEVEL, CMD) \ |
139 | do { \ |
140 | if (unlikely(fnic_log_level & LEVEL)) \ |
141 | do { \ |
142 | CMD; \ |
143 | } while (0); \ |
144 | } while (0) |
145 | |
146 | #define FNIC_MAIN_DBG(kern_level, host, fnic_num, fmt, args...) \ |
147 | FNIC_CHECK_LOGGING(FNIC_MAIN_LOGGING, \ |
148 | shost_printk(kern_level, host, \ |
149 | "fnic<%d>: %s: %d: " fmt, fnic_num,\ |
150 | __func__, __LINE__, ##args);) |
151 | |
152 | #define FNIC_FCS_DBG(kern_level, host, fnic_num, fmt, args...) \ |
153 | FNIC_CHECK_LOGGING(FNIC_FCS_LOGGING, \ |
154 | shost_printk(kern_level, host, \ |
155 | "fnic<%d>: %s: %d: " fmt, fnic_num,\ |
156 | __func__, __LINE__, ##args);) |
157 | |
158 | #define FNIC_SCSI_DBG(kern_level, host, fnic_num, fmt, args...) \ |
159 | FNIC_CHECK_LOGGING(FNIC_SCSI_LOGGING, \ |
160 | shost_printk(kern_level, host, \ |
161 | "fnic<%d>: %s: %d: " fmt, fnic_num,\ |
162 | __func__, __LINE__, ##args);) |
163 | |
164 | #define FNIC_ISR_DBG(kern_level, host, fnic_num, fmt, args...) \ |
165 | FNIC_CHECK_LOGGING(FNIC_ISR_LOGGING, \ |
166 | shost_printk(kern_level, host, \ |
167 | "fnic<%d>: %s: %d: " fmt, fnic_num,\ |
168 | __func__, __LINE__, ##args);) |
169 | |
170 | #define FNIC_MAIN_NOTE(kern_level, host, fmt, args...) \ |
171 | shost_printk(kern_level, host, fmt, ##args) |
172 | |
173 | #define FNIC_WQ_COPY_MAX 64 |
174 | #define FNIC_WQ_MAX 1 |
175 | #define FNIC_RQ_MAX 1 |
176 | #define FNIC_CQ_MAX (FNIC_WQ_COPY_MAX + FNIC_WQ_MAX + FNIC_RQ_MAX) |
177 | #define FNIC_DFLT_IO_COMPLETIONS 256 |
178 | |
179 | #define FNIC_MQ_CQ_INDEX 2 |
180 | |
181 | extern const char *fnic_state_str[]; |
182 | |
183 | enum fnic_intx_intr_index { |
184 | FNIC_INTX_WQ_RQ_COPYWQ, |
185 | FNIC_INTX_DUMMY, |
186 | FNIC_INTX_NOTIFY, |
187 | FNIC_INTX_ERR, |
188 | FNIC_INTX_INTR_MAX, |
189 | }; |
190 | |
191 | enum fnic_msix_intr_index { |
192 | FNIC_MSIX_RQ, |
193 | FNIC_MSIX_WQ, |
194 | FNIC_MSIX_WQ_COPY, |
195 | FNIC_MSIX_ERR_NOTIFY = FNIC_MSIX_WQ_COPY + FNIC_WQ_COPY_MAX, |
196 | FNIC_MSIX_INTR_MAX, |
197 | }; |
198 | |
199 | struct fnic_msix_entry { |
200 | int requested; |
201 | char devname[IFNAMSIZ + 11]; |
202 | irqreturn_t (*isr)(int, void *); |
203 | void *devid; |
204 | int irq_num; |
205 | }; |
206 | |
207 | enum fnic_state { |
208 | FNIC_IN_FC_MODE = 0, |
209 | FNIC_IN_FC_TRANS_ETH_MODE, |
210 | FNIC_IN_ETH_MODE, |
211 | FNIC_IN_ETH_TRANS_FC_MODE, |
212 | }; |
213 | |
214 | struct mempool; |
215 | |
216 | enum fnic_evt { |
217 | FNIC_EVT_START_VLAN_DISC = 1, |
218 | FNIC_EVT_START_FCF_DISC = 2, |
219 | FNIC_EVT_MAX, |
220 | }; |
221 | |
222 | struct fnic_event { |
223 | struct list_head list; |
224 | struct fnic *fnic; |
225 | enum fnic_evt event; |
226 | }; |
227 | |
228 | struct fnic_cpy_wq { |
229 | unsigned long hw_lock_flags; |
230 | u16 active_ioreq_count; |
231 | u16 ioreq_table_size; |
232 | ____cacheline_aligned struct fnic_io_req **io_req_table; |
233 | }; |
234 | |
235 | /* Per-instance private data structure */ |
236 | struct fnic { |
237 | int fnic_num; |
238 | struct fc_lport *lport; |
239 | struct fcoe_ctlr ctlr; /* FIP FCoE controller structure */ |
240 | struct vnic_dev_bar bar0; |
241 | |
242 | struct fnic_msix_entry msix[FNIC_MSIX_INTR_MAX]; |
243 | |
244 | struct vnic_stats *stats; |
245 | unsigned long stats_time; /* time of stats update */ |
246 | unsigned long stats_reset_time; /* time of stats reset */ |
247 | struct vnic_nic_cfg *nic_cfg; |
248 | char name[IFNAMSIZ]; |
249 | struct timer_list notify_timer; /* used for MSI interrupts */ |
250 | |
251 | unsigned int fnic_max_tag_id; |
252 | unsigned int err_intr_offset; |
253 | unsigned int link_intr_offset; |
254 | |
255 | unsigned int wq_count; |
256 | unsigned int cq_count; |
257 | |
258 | struct mutex sgreset_mutex; |
259 | spinlock_t sgreset_lock; /* lock for sgreset */ |
260 | struct scsi_cmnd *sgreset_sc; |
261 | struct dentry *fnic_stats_debugfs_host; |
262 | struct dentry *fnic_stats_debugfs_file; |
263 | struct dentry *fnic_reset_debugfs_file; |
264 | unsigned int reset_stats; |
265 | atomic64_t io_cmpl_skip; |
266 | struct fnic_stats fnic_stats; |
267 | |
268 | u32 vlan_hw_insert:1; /* let hw insert the tag */ |
269 | u32 in_remove:1; /* fnic device in removal */ |
270 | u32 stop_rx_link_events:1; /* stop proc. rx frames, link events */ |
271 | u32 link_events:1; /* set when we get any link event*/ |
272 | |
273 | struct completion *remove_wait; /* device remove thread blocks */ |
274 | |
275 | atomic_t in_flight; /* io counter */ |
276 | bool internal_reset_inprogress; |
277 | u32 _reserved; /* fill hole */ |
278 | unsigned long state_flags; /* protected by host lock */ |
279 | enum fnic_state state; |
280 | spinlock_t fnic_lock; |
281 | |
282 | u16 vlan_id; /* VLAN tag including priority */ |
283 | u8 data_src_addr[ETH_ALEN]; |
284 | u64 fcp_input_bytes; /* internal statistic */ |
285 | u64 fcp_output_bytes; /* internal statistic */ |
286 | u32 link_down_cnt; |
287 | int link_status; |
288 | |
289 | struct list_head list; |
290 | struct pci_dev *pdev; |
291 | struct vnic_fc_config config; |
292 | struct vnic_dev *vdev; |
293 | unsigned int raw_wq_count; |
294 | unsigned int wq_copy_count; |
295 | unsigned int rq_count; |
296 | int fw_ack_index[FNIC_WQ_COPY_MAX]; |
297 | unsigned short fw_ack_recd[FNIC_WQ_COPY_MAX]; |
298 | unsigned short wq_copy_desc_low[FNIC_WQ_COPY_MAX]; |
299 | unsigned int intr_count; |
300 | u32 __iomem *legacy_pba; |
301 | struct fnic_host_tag *tags; |
302 | mempool_t *io_req_pool; |
303 | mempool_t *io_sgl_pool[FNIC_SGL_NUM_CACHES]; |
304 | |
305 | unsigned int copy_wq_base; |
306 | struct work_struct link_work; |
307 | struct work_struct frame_work; |
308 | struct work_struct flush_work; |
309 | struct sk_buff_head frame_queue; |
310 | struct sk_buff_head tx_queue; |
311 | |
312 | /*** FIP related data members -- start ***/ |
313 | void (*set_vlan)(struct fnic *, u16 vlan); |
314 | struct work_struct fip_frame_work; |
315 | struct sk_buff_head fip_frame_queue; |
316 | struct timer_list fip_timer; |
317 | struct list_head vlans; |
318 | spinlock_t vlans_lock; |
319 | |
320 | struct work_struct event_work; |
321 | struct list_head evlist; |
322 | /*** FIP related data members -- end ***/ |
323 | |
324 | /* copy work queue cache line section */ |
325 | ____cacheline_aligned struct vnic_wq_copy hw_copy_wq[FNIC_WQ_COPY_MAX]; |
326 | ____cacheline_aligned struct fnic_cpy_wq sw_copy_wq[FNIC_WQ_COPY_MAX]; |
327 | |
328 | /* completion queue cache line section */ |
329 | ____cacheline_aligned struct vnic_cq cq[FNIC_CQ_MAX]; |
330 | |
331 | spinlock_t wq_copy_lock[FNIC_WQ_COPY_MAX]; |
332 | |
333 | /* work queue cache line section */ |
334 | ____cacheline_aligned struct vnic_wq wq[FNIC_WQ_MAX]; |
335 | spinlock_t wq_lock[FNIC_WQ_MAX]; |
336 | |
337 | /* receive queue cache line section */ |
338 | ____cacheline_aligned struct vnic_rq rq[FNIC_RQ_MAX]; |
339 | |
340 | /* interrupt resource cache line section */ |
341 | ____cacheline_aligned struct vnic_intr intr[FNIC_MSIX_INTR_MAX]; |
342 | }; |
343 | |
344 | static inline struct fnic *fnic_from_ctlr(struct fcoe_ctlr *fip) |
345 | { |
346 | return container_of(fip, struct fnic, ctlr); |
347 | } |
348 | |
349 | extern struct workqueue_struct *fnic_event_queue; |
350 | extern struct workqueue_struct *fnic_fip_queue; |
351 | extern const struct attribute_group *fnic_host_groups[]; |
352 | |
353 | void fnic_clear_intr_mode(struct fnic *fnic); |
354 | int fnic_set_intr_mode(struct fnic *fnic); |
355 | int fnic_set_intr_mode_msix(struct fnic *fnic); |
356 | void fnic_free_intr(struct fnic *fnic); |
357 | int fnic_request_intr(struct fnic *fnic); |
358 | |
359 | int fnic_send(struct fc_lport *, struct fc_frame *); |
360 | void fnic_free_wq_buf(struct vnic_wq *wq, struct vnic_wq_buf *buf); |
361 | void fnic_handle_frame(struct work_struct *work); |
362 | void fnic_handle_link(struct work_struct *work); |
363 | void fnic_handle_event(struct work_struct *work); |
364 | int fnic_rq_cmpl_handler(struct fnic *fnic, int); |
365 | int fnic_alloc_rq_frame(struct vnic_rq *rq); |
366 | void fnic_free_rq_buf(struct vnic_rq *rq, struct vnic_rq_buf *buf); |
367 | void fnic_flush_tx(struct work_struct *work); |
368 | void fnic_eth_send(struct fcoe_ctlr *, struct sk_buff *skb); |
369 | void fnic_set_port_id(struct fc_lport *, u32, struct fc_frame *); |
370 | void fnic_update_mac(struct fc_lport *, u8 *new); |
371 | void fnic_update_mac_locked(struct fnic *, u8 *new); |
372 | |
373 | int fnic_queuecommand(struct Scsi_Host *, struct scsi_cmnd *); |
374 | int fnic_abort_cmd(struct scsi_cmnd *); |
375 | int fnic_device_reset(struct scsi_cmnd *); |
376 | int fnic_host_reset(struct scsi_cmnd *); |
377 | int fnic_reset(struct Scsi_Host *); |
378 | void fnic_scsi_cleanup(struct fc_lport *); |
379 | void fnic_scsi_abort_io(struct fc_lport *); |
380 | void fnic_empty_scsi_cleanup(struct fc_lport *); |
381 | void fnic_exch_mgr_reset(struct fc_lport *, u32, u32); |
382 | int fnic_wq_copy_cmpl_handler(struct fnic *fnic, int copy_work_to_do, unsigned int cq_index); |
383 | int fnic_wq_cmpl_handler(struct fnic *fnic, int); |
384 | int fnic_flogi_reg_handler(struct fnic *fnic, u32); |
385 | void fnic_wq_copy_cleanup_handler(struct vnic_wq_copy *wq, |
386 | struct fcpio_host_req *desc); |
387 | int fnic_fw_reset_handler(struct fnic *fnic); |
388 | void fnic_terminate_rport_io(struct fc_rport *); |
389 | const char *fnic_state_to_str(unsigned int state); |
390 | void fnic_mq_map_queues_cpus(struct Scsi_Host *host); |
391 | void fnic_log_q_error(struct fnic *fnic); |
392 | void fnic_handle_link_event(struct fnic *fnic); |
393 | |
394 | int fnic_is_abts_pending(struct fnic *, struct scsi_cmnd *); |
395 | |
396 | void fnic_handle_fip_frame(struct work_struct *work); |
397 | void fnic_handle_fip_event(struct fnic *fnic); |
398 | void fnic_fcoe_reset_vlans(struct fnic *fnic); |
399 | void fnic_fcoe_evlist_free(struct fnic *fnic); |
400 | extern void fnic_handle_fip_timer(struct fnic *fnic); |
401 | |
402 | static inline int |
403 | fnic_chk_state_flags_locked(struct fnic *fnic, unsigned long st_flags) |
404 | { |
405 | return ((fnic->state_flags & st_flags) == st_flags); |
406 | } |
407 | void __fnic_set_state_flags(struct fnic *, unsigned long, unsigned long); |
408 | void fnic_dump_fchost_stats(struct Scsi_Host *, struct fc_host_statistics *); |
409 | #endif /* _FNIC_H_ */ |
410 | |