2 * Copyright 2008 Cisco Systems, Inc. All rights reserved.
3 * Copyright 2007 Nuova Systems, Inc. All rights reserved.
5 * This program is free software; you may redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; version 2 of the License.
9 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
10 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
11 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
12 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
13 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
14 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
15 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 #include <linux/interrupt.h>
22 #include <linux/netdevice.h>
23 #include <linux/workqueue.h>
24 #include <linux/bitops.h>
25 #include <scsi/libfc.h>
26 #include <scsi/libfcoe.h>
29 #include "fnic_trace.h"
34 #include "vnic_wq_copy.h"
35 #include "vnic_intr.h"
36 #include "vnic_stats.h"
37 #include "vnic_scsi.h"
39 #define DRV_NAME "fnic"
40 #define DRV_DESCRIPTION "Cisco FCoE HBA Driver"
41 #define DRV_VERSION "1.5.0.22"
42 #define PFX DRV_NAME ": "
43 #define DFX DRV_NAME "%d: "
45 #define DESC_CLEAN_LOW_WATERMARK 8
46 #define FNIC_MAX_IO_REQ 2048 /* scsi_cmnd tag map entries */
47 #define FNIC_IO_LOCKS 64 /* IO locks: power of 2 */
48 #define FNIC_DFLT_QUEUE_DEPTH 32
49 #define FNIC_STATS_RATE_LIMIT 4 /* limit rate at which stats are pulled up */
52 * Tag bits used for special requests.
54 #define FNIC_TAG_ABORT BIT(30) /* tag bit indicating abort */
55 #define FNIC_TAG_DEV_RST BIT(29) /* indicates device reset */
56 #define FNIC_TAG_MASK (BIT(24) - 1) /* mask for lookup */
57 #define FNIC_NO_TAG -1
60 * Command flags to identify the type of command and for other future
63 #define FNIC_NO_FLAGS 0
64 #define FNIC_IO_INITIALIZED BIT(0)
65 #define FNIC_IO_ISSUED BIT(1)
66 #define FNIC_IO_DONE BIT(2)
67 #define FNIC_IO_REQ_NULL BIT(3)
68 #define FNIC_IO_ABTS_PENDING BIT(4)
69 #define FNIC_IO_ABORTED BIT(5)
70 #define FNIC_IO_ABTS_ISSUED BIT(6)
71 #define FNIC_IO_TERM_ISSUED BIT(7)
72 #define FNIC_IO_INTERNAL_TERM_ISSUED BIT(8)
73 #define FNIC_IO_ABT_TERM_DONE BIT(9)
74 #define FNIC_IO_ABT_TERM_REQ_NULL BIT(10)
75 #define FNIC_IO_ABT_TERM_TIMED_OUT BIT(11)
76 #define FNIC_DEVICE_RESET BIT(12) /* Device reset request */
77 #define FNIC_DEV_RST_ISSUED BIT(13)
78 #define FNIC_DEV_RST_TIMED_OUT BIT(14)
79 #define FNIC_DEV_RST_ABTS_ISSUED BIT(15)
80 #define FNIC_DEV_RST_TERM_ISSUED BIT(16)
81 #define FNIC_DEV_RST_DONE BIT(17)
82 #define FNIC_DEV_RST_REQ_NULL BIT(18)
83 #define FNIC_DEV_RST_ABTS_DONE BIT(19)
84 #define FNIC_DEV_RST_TERM_DONE BIT(20)
85 #define FNIC_DEV_RST_ABTS_PENDING BIT(21)
88 * Usage of the scsi_cmnd scratchpad.
89 * These fields are locked by the hashed io_req_lock.
91 #define CMD_SP(Cmnd) ((Cmnd)->SCp.ptr)
92 #define CMD_STATE(Cmnd) ((Cmnd)->SCp.phase)
93 #define CMD_ABTS_STATUS(Cmnd) ((Cmnd)->SCp.Message)
94 #define CMD_LR_STATUS(Cmnd) ((Cmnd)->SCp.have_data_in)
95 #define CMD_TAG(Cmnd) ((Cmnd)->SCp.sent_command)
96 #define CMD_FLAGS(Cmnd) ((Cmnd)->SCp.Status)
98 #define FCPIO_INVALID_CODE 0x100 /* hdr_status value unused by firmware */
100 #define FNIC_LUN_RESET_TIMEOUT 10000 /* mSec */
101 #define FNIC_HOST_RESET_TIMEOUT 10000 /* mSec */
102 #define FNIC_RMDEVICE_TIMEOUT 1000 /* mSec */
103 #define FNIC_HOST_RESET_SETTLE_TIME 30 /* Sec */
104 #define FNIC_ABT_TERM_DELAY_TIMEOUT 500 /* mSec */
106 #define FNIC_MAX_FCP_TARGET 256
109 * state_flags to identify host state along along with fnic's state
111 #define __FNIC_FLAGS_FWRESET BIT(0) /* fwreset in progress */
112 #define __FNIC_FLAGS_BLOCK_IO BIT(1) /* IOs are blocked */
114 #define FNIC_FLAGS_NONE (0)
115 #define FNIC_FLAGS_FWRESET (__FNIC_FLAGS_FWRESET | \
116 __FNIC_FLAGS_BLOCK_IO)
118 #define FNIC_FLAGS_IO_BLOCKED (__FNIC_FLAGS_BLOCK_IO)
120 #define fnic_set_state_flags(fnicp, st_flags) \
121 __fnic_set_state_flags(fnicp, st_flags, 0)
123 #define fnic_clear_state_flags(fnicp, st_flags) \
124 __fnic_set_state_flags(fnicp, st_flags, 1)
126 extern unsigned int fnic_log_level
;
128 #define FNIC_MAIN_LOGGING 0x01
129 #define FNIC_FCS_LOGGING 0x02
130 #define FNIC_SCSI_LOGGING 0x04
131 #define FNIC_ISR_LOGGING 0x08
133 #define FNIC_CHECK_LOGGING(LEVEL, CMD) \
135 if (unlikely(fnic_log_level & LEVEL)) \
141 #define FNIC_MAIN_DBG(kern_level, host, fmt, args...) \
142 FNIC_CHECK_LOGGING(FNIC_MAIN_LOGGING, \
143 shost_printk(kern_level, host, fmt, ##args);)
145 #define FNIC_FCS_DBG(kern_level, host, fmt, args...) \
146 FNIC_CHECK_LOGGING(FNIC_FCS_LOGGING, \
147 shost_printk(kern_level, host, fmt, ##args);)
149 #define FNIC_SCSI_DBG(kern_level, host, fmt, args...) \
150 FNIC_CHECK_LOGGING(FNIC_SCSI_LOGGING, \
151 shost_printk(kern_level, host, fmt, ##args);)
153 #define FNIC_ISR_DBG(kern_level, host, fmt, args...) \
154 FNIC_CHECK_LOGGING(FNIC_ISR_LOGGING, \
155 shost_printk(kern_level, host, fmt, ##args);)
157 extern const char *fnic_state_str
[];
159 enum fnic_intx_intr_index
{
160 FNIC_INTX_WQ_RQ_COPYWQ
,
166 enum fnic_msix_intr_index
{
170 FNIC_MSIX_ERR_NOTIFY
,
174 struct fnic_msix_entry
{
176 char devname
[IFNAMSIZ
];
177 irqreturn_t (*isr
)(int, void *);
183 FNIC_IN_FC_TRANS_ETH_MODE
,
185 FNIC_IN_ETH_TRANS_FC_MODE
,
188 #define FNIC_WQ_COPY_MAX 1
189 #define FNIC_WQ_MAX 1
190 #define FNIC_RQ_MAX 1
191 #define FNIC_CQ_MAX (FNIC_WQ_COPY_MAX + FNIC_WQ_MAX + FNIC_RQ_MAX)
196 FNIC_EVT_START_VLAN_DISC
= 1,
197 FNIC_EVT_START_FCF_DISC
= 2,
202 struct list_head list
;
207 /* Per-instance private data structure */
209 struct fc_lport
*lport
;
210 struct fcoe_ctlr ctlr
; /* FIP FCoE controller structure */
211 struct vnic_dev_bar bar0
;
213 struct msix_entry msix_entry
[FNIC_MSIX_INTR_MAX
];
214 struct fnic_msix_entry msix
[FNIC_MSIX_INTR_MAX
];
216 struct vnic_stats
*stats
;
217 unsigned long stats_time
; /* time of stats update */
218 struct vnic_nic_cfg
*nic_cfg
;
220 struct timer_list notify_timer
; /* used for MSI interrupts */
222 unsigned int err_intr_offset
;
223 unsigned int link_intr_offset
;
225 unsigned int wq_count
;
226 unsigned int cq_count
;
228 u32 vlan_hw_insert
:1; /* let hw insert the tag */
229 u32 in_remove
:1; /* fnic device in removal */
230 u32 stop_rx_link_events
:1; /* stop proc. rx frames, link events */
232 struct completion
*remove_wait
; /* device remove thread blocks */
234 atomic_t in_flight
; /* io counter */
235 u32 _reserved
; /* fill hole */
236 unsigned long state_flags
; /* protected by host lock */
237 enum fnic_state state
;
238 spinlock_t fnic_lock
;
240 u16 vlan_id
; /* VLAN tag including priority */
241 u8 data_src_addr
[ETH_ALEN
];
242 u64 fcp_input_bytes
; /* internal statistic */
243 u64 fcp_output_bytes
; /* internal statistic */
247 struct list_head list
;
248 struct pci_dev
*pdev
;
249 struct vnic_fc_config config
;
250 struct vnic_dev
*vdev
;
251 unsigned int raw_wq_count
;
252 unsigned int wq_copy_count
;
253 unsigned int rq_count
;
254 int fw_ack_index
[FNIC_WQ_COPY_MAX
];
255 unsigned short fw_ack_recd
[FNIC_WQ_COPY_MAX
];
256 unsigned short wq_copy_desc_low
[FNIC_WQ_COPY_MAX
];
257 unsigned int intr_count
;
258 u32 __iomem
*legacy_pba
;
259 struct fnic_host_tag
*tags
;
260 mempool_t
*io_req_pool
;
261 mempool_t
*io_sgl_pool
[FNIC_SGL_NUM_CACHES
];
262 spinlock_t io_req_lock
[FNIC_IO_LOCKS
]; /* locks for scsi cmnds */
264 struct work_struct link_work
;
265 struct work_struct frame_work
;
266 struct sk_buff_head frame_queue
;
267 struct sk_buff_head tx_queue
;
269 /*** FIP related data members -- start ***/
270 void (*set_vlan
)(struct fnic
*, u16 vlan
);
271 struct work_struct fip_frame_work
;
272 struct sk_buff_head fip_frame_queue
;
273 struct timer_list fip_timer
;
274 struct list_head vlans
;
275 spinlock_t vlans_lock
;
277 struct work_struct event_work
;
278 struct list_head evlist
;
279 /*** FIP related data members -- end ***/
281 /* copy work queue cache line section */
282 ____cacheline_aligned
struct vnic_wq_copy wq_copy
[FNIC_WQ_COPY_MAX
];
283 /* completion queue cache line section */
284 ____cacheline_aligned
struct vnic_cq cq
[FNIC_CQ_MAX
];
286 spinlock_t wq_copy_lock
[FNIC_WQ_COPY_MAX
];
288 /* work queue cache line section */
289 ____cacheline_aligned
struct vnic_wq wq
[FNIC_WQ_MAX
];
290 spinlock_t wq_lock
[FNIC_WQ_MAX
];
292 /* receive queue cache line section */
293 ____cacheline_aligned
struct vnic_rq rq
[FNIC_RQ_MAX
];
295 /* interrupt resource cache line section */
296 ____cacheline_aligned
struct vnic_intr intr
[FNIC_MSIX_INTR_MAX
];
299 static inline struct fnic
*fnic_from_ctlr(struct fcoe_ctlr
*fip
)
301 return container_of(fip
, struct fnic
, ctlr
);
304 extern struct workqueue_struct
*fnic_event_queue
;
305 extern struct workqueue_struct
*fnic_fip_queue
;
306 extern struct device_attribute
*fnic_attrs
[];
308 void fnic_clear_intr_mode(struct fnic
*fnic
);
309 int fnic_set_intr_mode(struct fnic
*fnic
);
310 void fnic_free_intr(struct fnic
*fnic
);
311 int fnic_request_intr(struct fnic
*fnic
);
313 int fnic_send(struct fc_lport
*, struct fc_frame
*);
314 void fnic_free_wq_buf(struct vnic_wq
*wq
, struct vnic_wq_buf
*buf
);
315 void fnic_handle_frame(struct work_struct
*work
);
316 void fnic_handle_link(struct work_struct
*work
);
317 void fnic_handle_event(struct work_struct
*work
);
318 int fnic_rq_cmpl_handler(struct fnic
*fnic
, int);
319 int fnic_alloc_rq_frame(struct vnic_rq
*rq
);
320 void fnic_free_rq_buf(struct vnic_rq
*rq
, struct vnic_rq_buf
*buf
);
321 void fnic_flush_tx(struct fnic
*);
322 void fnic_eth_send(struct fcoe_ctlr
*, struct sk_buff
*skb
);
323 void fnic_set_port_id(struct fc_lport
*, u32
, struct fc_frame
*);
324 void fnic_update_mac(struct fc_lport
*, u8
*new);
325 void fnic_update_mac_locked(struct fnic
*, u8
*new);
327 int fnic_queuecommand(struct Scsi_Host
*, struct scsi_cmnd
*);
328 int fnic_abort_cmd(struct scsi_cmnd
*);
329 int fnic_device_reset(struct scsi_cmnd
*);
330 int fnic_host_reset(struct scsi_cmnd
*);
331 int fnic_reset(struct Scsi_Host
*);
332 void fnic_scsi_cleanup(struct fc_lport
*);
333 void fnic_scsi_abort_io(struct fc_lport
*);
334 void fnic_empty_scsi_cleanup(struct fc_lport
*);
335 void fnic_exch_mgr_reset(struct fc_lport
*, u32
, u32
);
336 int fnic_wq_copy_cmpl_handler(struct fnic
*fnic
, int);
337 int fnic_wq_cmpl_handler(struct fnic
*fnic
, int);
338 int fnic_flogi_reg_handler(struct fnic
*fnic
, u32
);
339 void fnic_wq_copy_cleanup_handler(struct vnic_wq_copy
*wq
,
340 struct fcpio_host_req
*desc
);
341 int fnic_fw_reset_handler(struct fnic
*fnic
);
342 void fnic_terminate_rport_io(struct fc_rport
*);
343 const char *fnic_state_to_str(unsigned int state
);
345 void fnic_log_q_error(struct fnic
*fnic
);
346 void fnic_handle_link_event(struct fnic
*fnic
);
348 int fnic_is_abts_pending(struct fnic
*, struct scsi_cmnd
*);
350 void fnic_handle_fip_frame(struct work_struct
*work
);
351 void fnic_handle_fip_event(struct fnic
*fnic
);
352 void fnic_fcoe_reset_vlans(struct fnic
*fnic
);
353 void fnic_fcoe_evlist_free(struct fnic
*fnic
);
354 extern void fnic_handle_fip_timer(struct fnic
*fnic
);
357 fnic_chk_state_flags_locked(struct fnic
*fnic
, unsigned long st_flags
)
359 return ((fnic
->state_flags
& st_flags
) == st_flags
);
361 void __fnic_set_state_flags(struct fnic
*, unsigned long, unsigned long);
362 #endif /* _FNIC_H_ */