drivers/scsi/fnic/fnic.h

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