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