blob: 8ed778d4dbb9688864b20a34afaf9e724022d953 [file] [log] [blame]
Narsimhulu Musinic8806b62015-05-29 01:04:01 -07001/*
2 * Copyright 2014 Cisco Systems, Inc. All rights reserved.
3 *
4 * This program is free software; you may redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; version 2 of the License.
7 *
8 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
9 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
10 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
11 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
12 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
13 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
14 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
15 * SOFTWARE.
16 */
17
18#ifndef _SNIC_H_
19#define _SNIC_H_
20
21#include <linux/module.h>
22#include <linux/netdevice.h>
23#include <linux/workqueue.h>
24#include <linux/bitops.h>
25#include <linux/mempool.h>
26#include <scsi/scsi_cmnd.h>
27#include <scsi/scsi.h>
28#include <scsi/scsi_host.h>
29
30#include "snic_disc.h"
31#include "snic_io.h"
32#include "snic_res.h"
33#include "snic_trc.h"
34#include "snic_stats.h"
35#include "vnic_dev.h"
36#include "vnic_wq.h"
37#include "vnic_cq.h"
38#include "vnic_intr.h"
39#include "vnic_stats.h"
40#include "vnic_snic.h"
41
42#define SNIC_DRV_NAME "snic"
43#define SNIC_DRV_DESCRIPTION "Cisco SCSI NIC Driver"
44#define SNIC_DRV_VERSION "0.0.1.18"
45#define PFX SNIC_DRV_NAME ":"
46#define DFX SNIC_DRV_NAME "%d: "
47
48#define DESC_CLEAN_LOW_WATERMARK 8
49#define SNIC_UCSM_DFLT_THROTTLE_CNT_BLD 16 /* UCSM default throttle count */
50#define SNIC_MAX_IO_REQ 50 /* scsi_cmnd tag map entries */
51#define SNIC_MIN_IO_REQ 8 /* Min IO throttle count */
52#define SNIC_IO_LOCKS 64 /* IO locks: power of 2 */
53#define SNIC_DFLT_QUEUE_DEPTH 32 /* Default Queue Depth */
54#define SNIC_MAX_QUEUE_DEPTH 64 /* Max Queue Depth */
55#define SNIC_DFLT_CMD_TIMEOUT 90 /* Extended tmo for FW */
56
57/*
58 * Tag bits used for special requests.
59 */
60#define SNIC_TAG_ABORT BIT(30) /* Tag indicating abort */
61#define SNIC_TAG_DEV_RST BIT(29) /* Tag for device reset */
62#define SNIC_TAG_IOCTL_DEV_RST BIT(28) /* Tag for User Device Reset */
63#define SNIC_TAG_MASK (BIT(24) - 1) /* Mask for lookup */
64#define SNIC_NO_TAG -1
65
66/*
67 * Command flags to identify the type of command and for other future use
68 */
69#define SNIC_NO_FLAGS 0
70#define SNIC_IO_INITIALIZED BIT(0)
71#define SNIC_IO_ISSUED BIT(1)
72#define SNIC_IO_DONE BIT(2)
73#define SNIC_IO_REQ_NULL BIT(3)
74#define SNIC_IO_ABTS_PENDING BIT(4)
75#define SNIC_IO_ABORTED BIT(5)
76#define SNIC_IO_ABTS_ISSUED BIT(6)
77#define SNIC_IO_TERM_ISSUED BIT(7)
78#define SNIC_IO_ABTS_TIMEDOUT BIT(8)
79#define SNIC_IO_ABTS_TERM_DONE BIT(9)
80#define SNIC_IO_ABTS_TERM_REQ_NULL BIT(10)
81#define SNIC_IO_ABTS_TERM_TIMEDOUT BIT(11)
82#define SNIC_IO_INTERNAL_TERM_PENDING BIT(12)
83#define SNIC_IO_INTERNAL_TERM_ISSUED BIT(13)
84#define SNIC_DEVICE_RESET BIT(14)
85#define SNIC_DEV_RST_ISSUED BIT(15)
86#define SNIC_DEV_RST_TIMEDOUT BIT(16)
87#define SNIC_DEV_RST_ABTS_ISSUED BIT(17)
88#define SNIC_DEV_RST_TERM_ISSUED BIT(18)
89#define SNIC_DEV_RST_DONE BIT(19)
90#define SNIC_DEV_RST_REQ_NULL BIT(20)
91#define SNIC_DEV_RST_ABTS_DONE BIT(21)
92#define SNIC_DEV_RST_TERM_DONE BIT(22)
93#define SNIC_DEV_RST_ABTS_PENDING BIT(23)
94#define SNIC_DEV_RST_PENDING BIT(24)
95#define SNIC_DEV_RST_NOTSUP BIT(25)
96#define SNIC_SCSI_CLEANUP BIT(26)
97#define SNIC_HOST_RESET_ISSUED BIT(27)
Narsimhulu Musini0da85192016-03-17 00:51:15 -070098#define SNIC_HOST_RESET_CMD_TERM \
99 (SNIC_DEV_RST_NOTSUP | SNIC_SCSI_CLEANUP | SNIC_HOST_RESET_ISSUED)
Narsimhulu Musinic8806b62015-05-29 01:04:01 -0700100
101#define SNIC_ABTS_TIMEOUT 30000 /* msec */
102#define SNIC_LUN_RESET_TIMEOUT 30000 /* msec */
103#define SNIC_HOST_RESET_TIMEOUT 30000 /* msec */
104
105
106/*
107 * These are protected by the hashed req_lock.
108 */
109#define CMD_SP(Cmnd) \
110 (((struct snic_internal_io_state *)scsi_cmd_priv(Cmnd))->rqi)
111#define CMD_STATE(Cmnd) \
112 (((struct snic_internal_io_state *)scsi_cmd_priv(Cmnd))->state)
113#define CMD_ABTS_STATUS(Cmnd) \
114 (((struct snic_internal_io_state *)scsi_cmd_priv(Cmnd))->abts_status)
115#define CMD_LR_STATUS(Cmnd) \
116 (((struct snic_internal_io_state *)scsi_cmd_priv(Cmnd))->lr_status)
117#define CMD_FLAGS(Cmnd) \
118 (((struct snic_internal_io_state *)scsi_cmd_priv(Cmnd))->flags)
119
120#define SNIC_INVALID_CODE 0x100 /* Hdr Status val unused by firmware */
121
122#define SNIC_MAX_TARGET 256
123#define SNIC_FLAGS_NONE (0)
124
125/* snic module params */
126extern unsigned int snic_max_qdepth;
127
128/* snic debugging */
129extern unsigned int snic_log_level;
130
131#define SNIC_MAIN_LOGGING 0x1
132#define SNIC_SCSI_LOGGING 0x2
133#define SNIC_ISR_LOGGING 0x8
134#define SNIC_DESC_LOGGING 0x10
135
136#define SNIC_CHECK_LOGGING(LEVEL, CMD) \
137do { \
138 if (unlikely(snic_log_level & LEVEL)) \
139 do { \
140 CMD; \
141 } while (0); \
142} while (0)
143
144#define SNIC_MAIN_DBG(host, fmt, args...) \
145 SNIC_CHECK_LOGGING(SNIC_MAIN_LOGGING, \
146 shost_printk(KERN_INFO, host, fmt, ## args);)
147
148#define SNIC_SCSI_DBG(host, fmt, args...) \
149 SNIC_CHECK_LOGGING(SNIC_SCSI_LOGGING, \
150 shost_printk(KERN_INFO, host, fmt, ##args);)
151
152#define SNIC_DISC_DBG(host, fmt, args...) \
153 SNIC_CHECK_LOGGING(SNIC_SCSI_LOGGING, \
154 shost_printk(KERN_INFO, host, fmt, ##args);)
155
156#define SNIC_ISR_DBG(host, fmt, args...) \
157 SNIC_CHECK_LOGGING(SNIC_ISR_LOGGING, \
158 shost_printk(KERN_INFO, host, fmt, ##args);)
159
160#define SNIC_HOST_ERR(host, fmt, args...) \
161 shost_printk(KERN_ERR, host, fmt, ##args)
162
163#define SNIC_HOST_INFO(host, fmt, args...) \
164 shost_printk(KERN_INFO, host, fmt, ##args)
165
166#define SNIC_INFO(fmt, args...) \
167 pr_info(PFX fmt, ## args)
168
169#define SNIC_DBG(fmt, args...) \
170 pr_info(PFX fmt, ## args)
171
172#define SNIC_ERR(fmt, args...) \
173 pr_err(PFX fmt, ## args)
174
175#ifdef DEBUG
176#define SNIC_BUG_ON(EXPR) \
177 ({ \
178 if (EXPR) { \
179 SNIC_ERR("SNIC BUG(%s)\n", #EXPR); \
180 BUG_ON(EXPR); \
181 } \
182 })
183#else
184#define SNIC_BUG_ON(EXPR) \
185 ({ \
186 if (EXPR) { \
187 SNIC_ERR("SNIC BUG(%s) at %s : %d\n", \
188 #EXPR, __func__, __LINE__); \
189 WARN_ON_ONCE(EXPR); \
190 } \
191 })
192#endif
193
194/* Soft assert */
195#define SNIC_ASSERT_NOT_IMPL(EXPR) \
196 ({ \
197 if (EXPR) {\
198 SNIC_INFO("Functionality not impl'ed at %s:%d\n", \
199 __func__, __LINE__); \
200 WARN_ON_ONCE(EXPR); \
201 } \
202 })
203
204
205extern const char *snic_state_str[];
206
207enum snic_intx_intr_index {
208 SNIC_INTX_WQ_RQ_COPYWQ,
209 SNIC_INTX_ERR,
210 SNIC_INTX_NOTIFY,
211 SNIC_INTX_INTR_MAX,
212};
213
214enum snic_msix_intr_index {
215 SNIC_MSIX_WQ,
216 SNIC_MSIX_IO_CMPL,
217 SNIC_MSIX_ERR_NOTIFY,
218 SNIC_MSIX_INTR_MAX,
219};
220
Narsimhulu Musini0da85192016-03-17 00:51:15 -0700221#define SNIC_INTRHDLR_NAMSZ (2 * IFNAMSIZ)
Narsimhulu Musinic8806b62015-05-29 01:04:01 -0700222struct snic_msix_entry {
223 int requested;
Narsimhulu Musini0da85192016-03-17 00:51:15 -0700224 char devname[SNIC_INTRHDLR_NAMSZ];
Narsimhulu Musinic8806b62015-05-29 01:04:01 -0700225 irqreturn_t (*isr)(int, void *);
226 void *devid;
227};
228
229enum snic_state {
230 SNIC_INIT = 0,
231 SNIC_ERROR,
232 SNIC_ONLINE,
233 SNIC_OFFLINE,
234 SNIC_FWRESET,
235};
236
237#define SNIC_WQ_MAX 1
238#define SNIC_CQ_IO_CMPL_MAX 1
239#define SNIC_CQ_MAX (SNIC_WQ_MAX + SNIC_CQ_IO_CMPL_MAX)
240
241/* firmware version information */
242struct snic_fw_info {
243 u32 fw_ver;
244 u32 hid; /* u16 hid | u16 vnic id */
245 u32 max_concur_ios; /* max concurrent ios */
246 u32 max_sgs_per_cmd; /* max sgls per IO */
247 u32 max_io_sz; /* max io size supported */
248 u32 hba_cap; /* hba capabilities */
249 u32 max_tgts; /* max tgts supported */
250 u16 io_tmo; /* FW Extended timeout */
251 struct completion *wait; /* protected by snic lock*/
252};
253
254/*
255 * snic_work item : defined to process asynchronous events
256 */
257struct snic_work {
258 struct work_struct work;
259 u16 ev_id;
260 u64 *ev_data;
261};
262
263/*
264 * snic structure to represent SCSI vNIC
265 */
266struct snic {
267 /* snic specific members */
268 struct list_head list;
269 char name[IFNAMSIZ];
270 atomic_t state;
271 spinlock_t snic_lock;
272 struct completion *remove_wait;
273 bool in_remove;
274 bool stop_link_events; /* stop processing link events */
275
276 /* discovery related */
277 struct snic_disc disc;
278
279 /* Scsi Host info */
280 struct Scsi_Host *shost;
281
282 /* vnic related structures */
283 struct vnic_dev_bar bar0;
284
285 struct vnic_stats *stats;
286 unsigned long stats_time;
287 unsigned long stats_reset_time;
288
289 struct vnic_dev *vdev;
290
291 /* hw resource info */
292 unsigned int wq_count;
293 unsigned int cq_count;
294 unsigned int intr_count;
295 unsigned int err_intr_offset;
296
297 int link_status; /* retrieved from svnic_dev_link_status() */
298 u32 link_down_cnt;
299
300 /* pci related */
301 struct pci_dev *pdev;
302 struct msix_entry msix_entry[SNIC_MSIX_INTR_MAX];
303 struct snic_msix_entry msix[SNIC_MSIX_INTR_MAX];
304
305 /* io related info */
306 mempool_t *req_pool[SNIC_REQ_MAX_CACHES]; /* (??) */
307 ____cacheline_aligned spinlock_t io_req_lock[SNIC_IO_LOCKS];
308
309 /* Maintain snic specific commands, cmds with no tag in spl_cmd_list */
310 ____cacheline_aligned spinlock_t spl_cmd_lock;
311 struct list_head spl_cmd_list;
312
313 unsigned int max_tag_id;
314 atomic_t ios_inflight; /* io in flight counter */
315
316 struct vnic_snic_config config;
317
318 struct work_struct link_work;
319
320 /* firmware information */
321 struct snic_fw_info fwinfo;
322
323 /* Work for processing Target related work */
324 struct work_struct tgt_work;
325
326 /* Work for processing Discovery */
327 struct work_struct disc_work;
328
329 /* stats related */
330 unsigned int reset_stats;
331 atomic64_t io_cmpl_skip;
332 struct snic_stats s_stats; /* Per SNIC driver stats */
333
334 /* platform specific */
335#ifdef CONFIG_SCSI_SNIC_DEBUG_FS
336 struct dentry *stats_host; /* Per snic debugfs root */
337 struct dentry *stats_file; /* Per snic debugfs file */
338 struct dentry *reset_stats_file;/* Per snic reset stats file */
339#endif
340
341 /* completion queue cache line section */
342 ____cacheline_aligned struct vnic_cq cq[SNIC_CQ_MAX];
343
344 /* work queue cache line section */
345 ____cacheline_aligned struct vnic_wq wq[SNIC_WQ_MAX];
346 spinlock_t wq_lock[SNIC_WQ_MAX];
347
348 /* interrupt resource cache line section */
349 ____cacheline_aligned struct vnic_intr intr[SNIC_MSIX_INTR_MAX];
350}; /* end of snic structure */
351
352/*
353 * SNIC Driver's Global Data
354 */
355struct snic_global {
356 struct list_head snic_list;
357 spinlock_t snic_list_lock;
358
359 struct kmem_cache *req_cache[SNIC_REQ_MAX_CACHES];
360
361 struct workqueue_struct *event_q;
362
363#ifdef CONFIG_SCSI_SNIC_DEBUG_FS
364 /* debugfs related global data */
365 struct dentry *trc_root;
366 struct dentry *stats_root;
367
368 struct snic_trc trc ____cacheline_aligned;
369#endif
370};
371
372extern struct snic_global *snic_glob;
373
374int snic_glob_init(void);
375void snic_glob_cleanup(void);
376
377extern struct workqueue_struct *snic_event_queue;
378extern struct device_attribute *snic_attrs[];
379
380int snic_queuecommand(struct Scsi_Host *, struct scsi_cmnd *);
381int snic_abort_cmd(struct scsi_cmnd *);
382int snic_device_reset(struct scsi_cmnd *);
383int snic_host_reset(struct scsi_cmnd *);
384int snic_reset(struct Scsi_Host *, struct scsi_cmnd *);
385void snic_shutdown_scsi_cleanup(struct snic *);
386
387
388int snic_request_intr(struct snic *);
389void snic_free_intr(struct snic *);
390int snic_set_intr_mode(struct snic *);
391void snic_clear_intr_mode(struct snic *);
392
393int snic_fwcq_cmpl_handler(struct snic *, int);
394int snic_wq_cmpl_handler(struct snic *, int);
395void snic_free_wq_buf(struct vnic_wq *, struct vnic_wq_buf *);
396
397
398void snic_log_q_error(struct snic *);
399void snic_handle_link_event(struct snic *);
400void snic_handle_link(struct work_struct *);
401
402int snic_queue_exch_ver_req(struct snic *);
403int snic_io_exch_ver_cmpl_handler(struct snic *, struct snic_fw_req *);
404
405int snic_queue_wq_desc(struct snic *, void *os_buf, u16 len);
406
407void snic_handle_untagged_req(struct snic *, struct snic_req_info *);
408void snic_release_untagged_req(struct snic *, struct snic_req_info *);
409void snic_free_all_untagged_reqs(struct snic *);
410int snic_get_conf(struct snic *);
411void snic_set_state(struct snic *, enum snic_state);
412int snic_get_state(struct snic *);
413const char *snic_state_to_str(unsigned int);
414void snic_hex_dump(char *, char *, int);
415void snic_print_desc(const char *fn, char *os_buf, int len);
416const char *show_opcode_name(int val);
417#endif /* _SNIC_H */