drivers/scsi/fnic/fnic.h - linux - Git at Google

 /* SPDX-License-Identifier: GPL-2.0-only */
 /*
  * Copyright 2008 Cisco Systems, Inc.  All rights reserved.
  * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
  */
 #ifndef _FNIC_H_
 #define _FNIC_H_

 #include <linux/interrupt.h>
 #include <linux/netdevice.h>
 #include <linux/workqueue.h>
 #include <linux/bitops.h>
 #include <scsi/libfc.h>
 #include <scsi/libfcoe.h>
 #include "fnic_io.h"
 #include "fnic_res.h"
 #include "fnic_trace.h"
 #include "fnic_stats.h"
 #include "vnic_dev.h"
 #include "vnic_wq.h"
 #include "vnic_rq.h"
 #include "vnic_cq.h"
 #include "vnic_wq_copy.h"
 #include "vnic_intr.h"
 #include "vnic_stats.h"
 #include "vnic_scsi.h"

 #define DRV_NAME		"fnic"
 #define DRV_DESCRIPTION		"Cisco FCoE HBA Driver"
 #define DRV_VERSION		"1.7.0.0"
 #define PFX			DRV_NAME ": "
 #define DFX                     DRV_NAME "%d: "

 #define DESC_CLEAN_LOW_WATERMARK 8
 #define FNIC_UCSM_DFLT_THROTTLE_CNT_BLD	16 /* UCSM default throttle count */
 #define FNIC_MIN_IO_REQ			256 /* Min IO throttle count */
 #define FNIC_MAX_IO_REQ		1024 /* scsi_cmnd tag map entries */
 #define FNIC_DFLT_IO_REQ        256 /* Default scsi_cmnd tag map entries */
 #define FNIC_DFLT_QUEUE_DEPTH	256
 #define	FNIC_STATS_RATE_LIMIT	4 /* limit rate at which stats are pulled up */

 /*
  * Tag bits used for special requests.
  */
 #define FNIC_TAG_ABORT		BIT(30)		/* tag bit indicating abort */
 #define FNIC_TAG_DEV_RST	BIT(29)		/* indicates device reset */
 #define FNIC_TAG_MASK		(BIT(24) - 1)	/* mask for lookup */
 #define FNIC_NO_TAG             -1

 /*
  * Command flags to identify the type of command and for other future
  * use.
  */
 #define FNIC_NO_FLAGS                   0
 #define FNIC_IO_INITIALIZED             BIT(0)
 #define FNIC_IO_ISSUED                  BIT(1)
 #define FNIC_IO_DONE                    BIT(2)
 #define FNIC_IO_REQ_NULL                BIT(3)
 #define FNIC_IO_ABTS_PENDING            BIT(4)
 #define FNIC_IO_ABORTED                 BIT(5)
 #define FNIC_IO_ABTS_ISSUED             BIT(6)
 #define FNIC_IO_TERM_ISSUED             BIT(7)
 #define FNIC_IO_INTERNAL_TERM_ISSUED    BIT(8)
 #define FNIC_IO_ABT_TERM_DONE           BIT(9)
 #define FNIC_IO_ABT_TERM_REQ_NULL       BIT(10)
 #define FNIC_IO_ABT_TERM_TIMED_OUT      BIT(11)
 #define FNIC_DEVICE_RESET               BIT(12)  /* Device reset request */
 #define FNIC_DEV_RST_ISSUED             BIT(13)
 #define FNIC_DEV_RST_TIMED_OUT          BIT(14)
 #define FNIC_DEV_RST_ABTS_ISSUED        BIT(15)
 #define FNIC_DEV_RST_TERM_ISSUED        BIT(16)
 #define FNIC_DEV_RST_DONE               BIT(17)
 #define FNIC_DEV_RST_REQ_NULL           BIT(18)
 #define FNIC_DEV_RST_ABTS_DONE          BIT(19)
 #define FNIC_DEV_RST_TERM_DONE          BIT(20)
 #define FNIC_DEV_RST_ABTS_PENDING       BIT(21)

 /*
  * fnic private data per SCSI command.
  * These fields are locked by the hashed io_req_lock.
  */
 struct fnic_cmd_priv {
 	struct fnic_io_req *io_req;
 	enum fnic_ioreq_state state;
 	u32 flags;
 	u16 abts_status;
 	u16 lr_status;
 };

 static inline struct fnic_cmd_priv *fnic_priv(struct scsi_cmnd *cmd)
 {
 	return scsi_cmd_priv(cmd);
 }

 static inline u64 fnic_flags_and_state(struct scsi_cmnd *cmd)
 {
 	struct fnic_cmd_priv *fcmd = fnic_priv(cmd);

 	return ((u64)fcmd->flags << 32) | fcmd->state;
 }

 #define FCPIO_INVALID_CODE 0x100 /* hdr_status value unused by firmware */

 #define FNIC_LUN_RESET_TIMEOUT	     10000	/* mSec */
 #define FNIC_HOST_RESET_TIMEOUT	     10000	/* mSec */
 #define FNIC_RMDEVICE_TIMEOUT        1000       /* mSec */
 #define FNIC_HOST_RESET_SETTLE_TIME  30         /* Sec */
 #define FNIC_ABT_TERM_DELAY_TIMEOUT  500        /* mSec */

 #define FNIC_MAX_FCP_TARGET     256
 #define FNIC_PCI_OFFSET		2
 /**
  * state_flags to identify host state along along with fnic's state
  **/
 #define __FNIC_FLAGS_FWRESET		BIT(0) /* fwreset in progress */
 #define __FNIC_FLAGS_BLOCK_IO		BIT(1) /* IOs are blocked */

 #define FNIC_FLAGS_NONE			(0)
 #define FNIC_FLAGS_FWRESET		(__FNIC_FLAGS_FWRESET | \
 					__FNIC_FLAGS_BLOCK_IO)

 #define FNIC_FLAGS_IO_BLOCKED		(__FNIC_FLAGS_BLOCK_IO)

 #define fnic_set_state_flags(fnicp, st_flags)	\
 	__fnic_set_state_flags(fnicp, st_flags, 0)

 #define fnic_clear_state_flags(fnicp, st_flags)  \
 	__fnic_set_state_flags(fnicp, st_flags, 1)

 extern unsigned int fnic_log_level;
 extern unsigned int io_completions;

 #define FNIC_MAIN_LOGGING 0x01
 #define FNIC_FCS_LOGGING 0x02
 #define FNIC_SCSI_LOGGING 0x04
 #define FNIC_ISR_LOGGING 0x08

 #define FNIC_CHECK_LOGGING(LEVEL, CMD)				\
 do {								\
 	if (unlikely(fnic_log_level & LEVEL))			\
 		do {						\
 			CMD;					\
 		} while (0);					\
 } while (0)

 #define FNIC_MAIN_DBG(kern_level, host, fnic_num, fmt, args...)		\
 	FNIC_CHECK_LOGGING(FNIC_MAIN_LOGGING,			\
 			 shost_printk(kern_level, host,			\
 				"fnic<%d>: %s: %d: " fmt, fnic_num,\
 				__func__, __LINE__, ##args);)

 #define FNIC_FCS_DBG(kern_level, host, fnic_num, fmt, args...)		\
 	FNIC_CHECK_LOGGING(FNIC_FCS_LOGGING,			\
 			 shost_printk(kern_level, host,			\
 				"fnic<%d>: %s: %d: " fmt, fnic_num,\
 				__func__, __LINE__, ##args);)

 #define FNIC_SCSI_DBG(kern_level, host, fnic_num, fmt, args...)		\
 	FNIC_CHECK_LOGGING(FNIC_SCSI_LOGGING,			\
 			 shost_printk(kern_level, host,			\
 				"fnic<%d>: %s: %d: " fmt, fnic_num,\
 				__func__, __LINE__, ##args);)

 #define FNIC_ISR_DBG(kern_level, host, fnic_num, fmt, args...)		\
 	FNIC_CHECK_LOGGING(FNIC_ISR_LOGGING,			\
 			 shost_printk(kern_level, host,			\
 				"fnic<%d>: %s: %d: " fmt, fnic_num,\
 				__func__, __LINE__, ##args);)

 #define FNIC_MAIN_NOTE(kern_level, host, fmt, args...)          \
 	shost_printk(kern_level, host, fmt, ##args)

 #define FNIC_WQ_COPY_MAX 64
 #define FNIC_WQ_MAX 1
 #define FNIC_RQ_MAX 1
 #define FNIC_CQ_MAX (FNIC_WQ_COPY_MAX + FNIC_WQ_MAX + FNIC_RQ_MAX)
 #define FNIC_DFLT_IO_COMPLETIONS 256

 #define FNIC_MQ_CQ_INDEX        2

 extern const char *fnic_state_str[];

 enum fnic_intx_intr_index {
 	FNIC_INTX_WQ_RQ_COPYWQ,
 	FNIC_INTX_DUMMY,
 	FNIC_INTX_NOTIFY,
 	FNIC_INTX_ERR,
 	FNIC_INTX_INTR_MAX,
 };

 enum fnic_msix_intr_index {
 	FNIC_MSIX_RQ,
 	FNIC_MSIX_WQ,
 	FNIC_MSIX_WQ_COPY,
 	FNIC_MSIX_ERR_NOTIFY = FNIC_MSIX_WQ_COPY + FNIC_WQ_COPY_MAX,
 	FNIC_MSIX_INTR_MAX,
 };

 struct fnic_msix_entry {
 	int requested;
 	char devname[IFNAMSIZ + 11];
 	irqreturn_t (*isr)(int, void *);
 	void *devid;
 	int irq_num;
 };

 enum fnic_state {
 	FNIC_IN_FC_MODE = 0,
 	FNIC_IN_FC_TRANS_ETH_MODE,
 	FNIC_IN_ETH_MODE,
 	FNIC_IN_ETH_TRANS_FC_MODE,
 };

 struct mempool;

 enum fnic_evt {
 	FNIC_EVT_START_VLAN_DISC = 1,
 	FNIC_EVT_START_FCF_DISC = 2,
 	FNIC_EVT_MAX,
 };

 struct fnic_event {
 	struct list_head list;
 	struct fnic *fnic;
 	enum fnic_evt event;
 };

 struct fnic_cpy_wq {
 	unsigned long hw_lock_flags;
 	u16 active_ioreq_count;
 	u16 ioreq_table_size;
 	____cacheline_aligned struct fnic_io_req **io_req_table;
 };

 /* Per-instance private data structure */
 struct fnic {
 	int fnic_num;
 	struct fc_lport *lport;
 	struct fcoe_ctlr ctlr;		/* FIP FCoE controller structure */
 	struct vnic_dev_bar bar0;

 	struct fnic_msix_entry msix[FNIC_MSIX_INTR_MAX];

 	struct vnic_stats *stats;
 	unsigned long stats_time;	/* time of stats update */
 	unsigned long stats_reset_time; /* time of stats reset */
 	struct vnic_nic_cfg *nic_cfg;
 	char name[IFNAMSIZ];
 	struct timer_list notify_timer; /* used for MSI interrupts */

 	unsigned int fnic_max_tag_id;
 	unsigned int err_intr_offset;
 	unsigned int link_intr_offset;

 	unsigned int wq_count;
 	unsigned int cq_count;

 	struct mutex sgreset_mutex;
 	spinlock_t sgreset_lock; /* lock for sgreset */
 	struct scsi_cmnd *sgreset_sc;
 	struct dentry *fnic_stats_debugfs_host;
 	struct dentry *fnic_stats_debugfs_file;
 	struct dentry *fnic_reset_debugfs_file;
 	unsigned int reset_stats;
 	atomic64_t io_cmpl_skip;
 	struct fnic_stats fnic_stats;

 	u32 vlan_hw_insert:1;	        /* let hw insert the tag */
 	u32 in_remove:1;                /* fnic device in removal */
 	u32 stop_rx_link_events:1;      /* stop proc. rx frames, link events */
 	u32 link_events:1;              /* set when we get any link event*/

 	struct completion *remove_wait; /* device remove thread blocks */

 	atomic_t in_flight;		/* io counter */
 	bool internal_reset_inprogress;
 	u32 _reserved;			/* fill hole */
 	unsigned long state_flags;	/* protected by host lock */
 	enum fnic_state state;
 	spinlock_t fnic_lock;

 	u16 vlan_id;	                /* VLAN tag including priority */
 	u8 data_src_addr[ETH_ALEN];
 	u64 fcp_input_bytes;		/* internal statistic */
 	u64 fcp_output_bytes;		/* internal statistic */
 	u32 link_down_cnt;
 	int link_status;

 	struct list_head list;
 	struct pci_dev *pdev;
 	struct vnic_fc_config config;
 	struct vnic_dev *vdev;
 	unsigned int raw_wq_count;
 	unsigned int wq_copy_count;
 	unsigned int rq_count;
 	int fw_ack_index[FNIC_WQ_COPY_MAX];
 	unsigned short fw_ack_recd[FNIC_WQ_COPY_MAX];
 	unsigned short wq_copy_desc_low[FNIC_WQ_COPY_MAX];
 	unsigned int intr_count;
 	u32 __iomem *legacy_pba;
 	struct fnic_host_tag *tags;
 	mempool_t *io_req_pool;
 	mempool_t *io_sgl_pool[FNIC_SGL_NUM_CACHES];

 	unsigned int copy_wq_base;
 	struct work_struct link_work;
 	struct work_struct frame_work;
 	struct sk_buff_head frame_queue;
 	struct sk_buff_head tx_queue;

 	/*** FIP related data members  -- start ***/
 	void (*set_vlan)(struct fnic *, u16 vlan);
 	struct work_struct      fip_frame_work;
 	struct sk_buff_head     fip_frame_queue;
 	struct timer_list       fip_timer;
 	struct list_head        vlans;
 	spinlock_t              vlans_lock;

 	struct work_struct      event_work;
 	struct list_head        evlist;
 	/*** FIP related data members  -- end ***/

 	/* copy work queue cache line section */
 	____cacheline_aligned struct vnic_wq_copy hw_copy_wq[FNIC_WQ_COPY_MAX];
 	____cacheline_aligned struct fnic_cpy_wq sw_copy_wq[FNIC_WQ_COPY_MAX];

 	/* completion queue cache line section */
 	____cacheline_aligned struct vnic_cq cq[FNIC_CQ_MAX];

 	spinlock_t wq_copy_lock[FNIC_WQ_COPY_MAX];

 	/* work queue cache line section */
 	____cacheline_aligned struct vnic_wq wq[FNIC_WQ_MAX];
 	spinlock_t wq_lock[FNIC_WQ_MAX];

 	/* receive queue cache line section */
 	____cacheline_aligned struct vnic_rq rq[FNIC_RQ_MAX];

 	/* interrupt resource cache line section */
 	____cacheline_aligned struct vnic_intr intr[FNIC_MSIX_INTR_MAX];
 };

 static inline struct fnic *fnic_from_ctlr(struct fcoe_ctlr *fip)
 {
 	return container_of(fip, struct fnic, ctlr);
 }

 extern struct workqueue_struct *fnic_event_queue;
 extern struct workqueue_struct *fnic_fip_queue;
 extern const struct attribute_group *fnic_host_groups[];

 void fnic_clear_intr_mode(struct fnic *fnic);
 int fnic_set_intr_mode(struct fnic *fnic);
 int fnic_set_intr_mode_msix(struct fnic *fnic);
 void fnic_free_intr(struct fnic *fnic);
 int fnic_request_intr(struct fnic *fnic);

 int fnic_send(struct fc_lport *, struct fc_frame *);
 void fnic_free_wq_buf(struct vnic_wq *wq, struct vnic_wq_buf *buf);
 void fnic_handle_frame(struct work_struct *work);
 void fnic_handle_link(struct work_struct *work);
 void fnic_handle_event(struct work_struct *work);
 int fnic_rq_cmpl_handler(struct fnic *fnic, int);
 int fnic_alloc_rq_frame(struct vnic_rq *rq);
 void fnic_free_rq_buf(struct vnic_rq *rq, struct vnic_rq_buf *buf);
 void fnic_flush_tx(struct fnic *);
 void fnic_eth_send(struct fcoe_ctlr *, struct sk_buff *skb);
 void fnic_set_port_id(struct fc_lport *, u32, struct fc_frame *);
 void fnic_update_mac(struct fc_lport *, u8 *new);
 void fnic_update_mac_locked(struct fnic *, u8 *new);

 int fnic_queuecommand(struct Scsi_Host *, struct scsi_cmnd *);
 int fnic_abort_cmd(struct scsi_cmnd *);
 int fnic_device_reset(struct scsi_cmnd *);
 int fnic_host_reset(struct scsi_cmnd *);
 int fnic_reset(struct Scsi_Host *);
 void fnic_scsi_cleanup(struct fc_lport *);
 void fnic_scsi_abort_io(struct fc_lport *);
 void fnic_empty_scsi_cleanup(struct fc_lport *);
 void fnic_exch_mgr_reset(struct fc_lport *, u32, u32);
 int fnic_wq_copy_cmpl_handler(struct fnic *fnic, int copy_work_to_do, unsigned int cq_index);
 int fnic_wq_cmpl_handler(struct fnic *fnic, int);
 int fnic_flogi_reg_handler(struct fnic *fnic, u32);
 void fnic_wq_copy_cleanup_handler(struct vnic_wq_copy *wq,
 				  struct fcpio_host_req *desc);
 int fnic_fw_reset_handler(struct fnic *fnic);
 void fnic_terminate_rport_io(struct fc_rport *);
 const char *fnic_state_to_str(unsigned int state);
 void fnic_mq_map_queues_cpus(struct Scsi_Host *host);
 void fnic_log_q_error(struct fnic *fnic);
 void fnic_handle_link_event(struct fnic *fnic);

 int fnic_is_abts_pending(struct fnic *, struct scsi_cmnd *);

 void fnic_handle_fip_frame(struct work_struct *work);
 void fnic_handle_fip_event(struct fnic *fnic);
 void fnic_fcoe_reset_vlans(struct fnic *fnic);
 void fnic_fcoe_evlist_free(struct fnic *fnic);
 extern void fnic_handle_fip_timer(struct fnic *fnic);

 static inline int
 fnic_chk_state_flags_locked(struct fnic *fnic, unsigned long st_flags)
 {
 	return ((fnic->state_flags & st_flags) == st_flags);
 }
 void __fnic_set_state_flags(struct fnic *, unsigned long, unsigned long);
 void fnic_dump_fchost_stats(struct Scsi_Host *, struct fc_host_statistics *);
 #endif /* _FNIC_H_ */
	/* SPDX-License-Identifier: GPL-2.0-only */
	/*
	* Copyright 2008 Cisco Systems, Inc. All rights reserved.
	* Copyright 2007 Nuova Systems, Inc. All rights reserved.
	*/
	#ifndef _FNIC_H_
	#define _FNIC_H_

	#include <linux/interrupt.h>
	#include <linux/netdevice.h>
	#include <linux/workqueue.h>
	#include <linux/bitops.h>
	#include <scsi/libfc.h>
	#include <scsi/libfcoe.h>
	#include "fnic_io.h"
	#include "fnic_res.h"
	#include "fnic_trace.h"
	#include "fnic_stats.h"
	#include "vnic_dev.h"
	#include "vnic_wq.h"
	#include "vnic_rq.h"
	#include "vnic_cq.h"
	#include "vnic_wq_copy.h"
	#include "vnic_intr.h"
	#include "vnic_stats.h"
	#include "vnic_scsi.h"

	#define DRV_NAME "fnic"
	#define DRV_DESCRIPTION "Cisco FCoE HBA Driver"
	#define DRV_VERSION "1.7.0.0"
	#define PFX DRV_NAME ": "
	#define DFX DRV_NAME "%d: "

	#define DESC_CLEAN_LOW_WATERMARK 8
	#define FNIC_UCSM_DFLT_THROTTLE_CNT_BLD 16 /* UCSM default throttle count */
	#define FNIC_MIN_IO_REQ 256 /* Min IO throttle count */
	#define FNIC_MAX_IO_REQ 1024 /* scsi_cmnd tag map entries */
	#define FNIC_DFLT_IO_REQ 256 /* Default scsi_cmnd tag map entries */
	#define FNIC_DFLT_QUEUE_DEPTH 256
	#define FNIC_STATS_RATE_LIMIT 4 /* limit rate at which stats are pulled up */

	/*
	* Tag bits used for special requests.
	*/
	#define FNIC_TAG_ABORT BIT(30) /* tag bit indicating abort */
	#define FNIC_TAG_DEV_RST BIT(29) /* indicates device reset */
	#define FNIC_TAG_MASK (BIT(24) - 1) /* mask for lookup */
	#define FNIC_NO_TAG -1

	/*
	* Command flags to identify the type of command and for other future
	* use.
	*/
	#define FNIC_NO_FLAGS 0
	#define FNIC_IO_INITIALIZED BIT(0)
	#define FNIC_IO_ISSUED BIT(1)
	#define FNIC_IO_DONE BIT(2)
	#define FNIC_IO_REQ_NULL BIT(3)
	#define FNIC_IO_ABTS_PENDING BIT(4)
	#define FNIC_IO_ABORTED BIT(5)
	#define FNIC_IO_ABTS_ISSUED BIT(6)
	#define FNIC_IO_TERM_ISSUED BIT(7)
	#define FNIC_IO_INTERNAL_TERM_ISSUED BIT(8)
	#define FNIC_IO_ABT_TERM_DONE BIT(9)
	#define FNIC_IO_ABT_TERM_REQ_NULL BIT(10)
	#define FNIC_IO_ABT_TERM_TIMED_OUT BIT(11)
	#define FNIC_DEVICE_RESET BIT(12) /* Device reset request */
	#define FNIC_DEV_RST_ISSUED BIT(13)
	#define FNIC_DEV_RST_TIMED_OUT BIT(14)
	#define FNIC_DEV_RST_ABTS_ISSUED BIT(15)
	#define FNIC_DEV_RST_TERM_ISSUED BIT(16)
	#define FNIC_DEV_RST_DONE BIT(17)
	#define FNIC_DEV_RST_REQ_NULL BIT(18)
	#define FNIC_DEV_RST_ABTS_DONE BIT(19)
	#define FNIC_DEV_RST_TERM_DONE BIT(20)
	#define FNIC_DEV_RST_ABTS_PENDING BIT(21)

	/*
	* fnic private data per SCSI command.
	* These fields are locked by the hashed io_req_lock.
	*/
	struct fnic_cmd_priv {
	struct fnic_io_req *io_req;
	enum fnic_ioreq_state state;
	u32 flags;
	u16 abts_status;
	u16 lr_status;
	};

	static inline struct fnic_cmd_priv fnic_priv(struct scsi_cmnd cmd)
	{
	return scsi_cmd_priv(cmd);
	}

	static inline u64 fnic_flags_and_state(struct scsi_cmnd *cmd)
	{
	struct fnic_cmd_priv *fcmd = fnic_priv(cmd);

	return ((u64)fcmd->flags << 32) \| fcmd->state;
	}

	#define FCPIO_INVALID_CODE 0x100 /* hdr_status value unused by firmware */

	#define FNIC_LUN_RESET_TIMEOUT 10000 /* mSec */
	#define FNIC_HOST_RESET_TIMEOUT 10000 /* mSec */
	#define FNIC_RMDEVICE_TIMEOUT 1000 /* mSec */
	#define FNIC_HOST_RESET_SETTLE_TIME 30 /* Sec */
	#define FNIC_ABT_TERM_DELAY_TIMEOUT 500 /* mSec */

	#define FNIC_MAX_FCP_TARGET 256
	#define FNIC_PCI_OFFSET 2
	/**
	* state_flags to identify host state along along with fnic's state
	**/
	#define __FNIC_FLAGS_FWRESET BIT(0) /* fwreset in progress */
	#define __FNIC_FLAGS_BLOCK_IO BIT(1) /* IOs are blocked */

	#define FNIC_FLAGS_NONE (0)
	#define FNIC_FLAGS_FWRESET (__FNIC_FLAGS_FWRESET \| \
	__FNIC_FLAGS_BLOCK_IO)

	#define FNIC_FLAGS_IO_BLOCKED (__FNIC_FLAGS_BLOCK_IO)

	#define fnic_set_state_flags(fnicp, st_flags) \
	__fnic_set_state_flags(fnicp, st_flags, 0)

	#define fnic_clear_state_flags(fnicp, st_flags) \
	__fnic_set_state_flags(fnicp, st_flags, 1)

	extern unsigned int fnic_log_level;
	extern unsigned int io_completions;

	#define FNIC_MAIN_LOGGING 0x01
	#define FNIC_FCS_LOGGING 0x02
	#define FNIC_SCSI_LOGGING 0x04
	#define FNIC_ISR_LOGGING 0x08

	#define FNIC_CHECK_LOGGING(LEVEL, CMD) \
	do { \
	if (unlikely(fnic_log_level & LEVEL)) \
	do { \
	CMD; \
	} while (0); \
	} while (0)

	#define FNIC_MAIN_DBG(kern_level, host, fnic_num, fmt, args...) \
	FNIC_CHECK_LOGGING(FNIC_MAIN_LOGGING, \
	shost_printk(kern_level, host, \
	"fnic<%d>: %s: %d: " fmt, fnic_num,\
	__func__, __LINE__, ##args);)

	#define FNIC_FCS_DBG(kern_level, host, fnic_num, fmt, args...) \
	FNIC_CHECK_LOGGING(FNIC_FCS_LOGGING, \
	shost_printk(kern_level, host, \
	"fnic<%d>: %s: %d: " fmt, fnic_num,\
	__func__, __LINE__, ##args);)

	#define FNIC_SCSI_DBG(kern_level, host, fnic_num, fmt, args...) \
	FNIC_CHECK_LOGGING(FNIC_SCSI_LOGGING, \
	shost_printk(kern_level, host, \
	"fnic<%d>: %s: %d: " fmt, fnic_num,\
	__func__, __LINE__, ##args);)

	#define FNIC_ISR_DBG(kern_level, host, fnic_num, fmt, args...) \
	FNIC_CHECK_LOGGING(FNIC_ISR_LOGGING, \
	shost_printk(kern_level, host, \
	"fnic<%d>: %s: %d: " fmt, fnic_num,\
	__func__, __LINE__, ##args);)

	#define FNIC_MAIN_NOTE(kern_level, host, fmt, args...) \
	shost_printk(kern_level, host, fmt, ##args)

	#define FNIC_WQ_COPY_MAX 64
	#define FNIC_WQ_MAX 1
	#define FNIC_RQ_MAX 1
	#define FNIC_CQ_MAX (FNIC_WQ_COPY_MAX + FNIC_WQ_MAX + FNIC_RQ_MAX)
	#define FNIC_DFLT_IO_COMPLETIONS 256

	#define FNIC_MQ_CQ_INDEX 2

	extern const char *fnic_state_str[];

	enum fnic_intx_intr_index {
	FNIC_INTX_WQ_RQ_COPYWQ,
	FNIC_INTX_DUMMY,
	FNIC_INTX_NOTIFY,
	FNIC_INTX_ERR,
	FNIC_INTX_INTR_MAX,
	};

	enum fnic_msix_intr_index {
	FNIC_MSIX_RQ,
	FNIC_MSIX_WQ,
	FNIC_MSIX_WQ_COPY,
	FNIC_MSIX_ERR_NOTIFY = FNIC_MSIX_WQ_COPY + FNIC_WQ_COPY_MAX,
	FNIC_MSIX_INTR_MAX,
	};

	struct fnic_msix_entry {
	int requested;
	char devname[IFNAMSIZ + 11];
	irqreturn_t (isr)(int, void );
	void *devid;
	int irq_num;
	};

	enum fnic_state {
	FNIC_IN_FC_MODE = 0,
	FNIC_IN_FC_TRANS_ETH_MODE,
	FNIC_IN_ETH_MODE,
	FNIC_IN_ETH_TRANS_FC_MODE,
	};

	struct mempool;

	enum fnic_evt {
	FNIC_EVT_START_VLAN_DISC = 1,
	FNIC_EVT_START_FCF_DISC = 2,
	FNIC_EVT_MAX,
	};

	struct fnic_event {
	struct list_head list;
	struct fnic *fnic;
	enum fnic_evt event;
	};

	struct fnic_cpy_wq {
	unsigned long hw_lock_flags;
	u16 active_ioreq_count;
	u16 ioreq_table_size;
	____cacheline_aligned struct fnic_io_req **io_req_table;
	};

	/* Per-instance private data structure */
	struct fnic {
	int fnic_num;
	struct fc_lport *lport;
	struct fcoe_ctlr ctlr; /* FIP FCoE controller structure */
	struct vnic_dev_bar bar0;

	struct fnic_msix_entry msix[FNIC_MSIX_INTR_MAX];

	struct vnic_stats *stats;
	unsigned long stats_time; /* time of stats update */
	unsigned long stats_reset_time; /* time of stats reset */
	struct vnic_nic_cfg *nic_cfg;
	char name[IFNAMSIZ];
	struct timer_list notify_timer; /* used for MSI interrupts */

	unsigned int fnic_max_tag_id;
	unsigned int err_intr_offset;
	unsigned int link_intr_offset;

	unsigned int wq_count;
	unsigned int cq_count;

	struct mutex sgreset_mutex;
	spinlock_t sgreset_lock; /* lock for sgreset */
	struct scsi_cmnd *sgreset_sc;
	struct dentry *fnic_stats_debugfs_host;
	struct dentry *fnic_stats_debugfs_file;
	struct dentry *fnic_reset_debugfs_file;
	unsigned int reset_stats;
	atomic64_t io_cmpl_skip;
	struct fnic_stats fnic_stats;

	u32 vlan_hw_insert:1; /* let hw insert the tag */
	u32 in_remove:1; /* fnic device in removal */
	u32 stop_rx_link_events:1; /* stop proc. rx frames, link events */
	u32 link_events:1; /* set when we get any link event*/

	struct completion remove_wait; / device remove thread blocks */

	atomic_t in_flight; /* io counter */
	bool internal_reset_inprogress;
	u32 _reserved; /* fill hole */
	unsigned long state_flags; /* protected by host lock */
	enum fnic_state state;
	spinlock_t fnic_lock;

	u16 vlan_id; /* VLAN tag including priority */
	u8 data_src_addr[ETH_ALEN];
	u64 fcp_input_bytes; /* internal statistic */
	u64 fcp_output_bytes; /* internal statistic */
	u32 link_down_cnt;
	int link_status;

	struct list_head list;
	struct pci_dev *pdev;
	struct vnic_fc_config config;
	struct vnic_dev *vdev;
	unsigned int raw_wq_count;
	unsigned int wq_copy_count;
	unsigned int rq_count;
	int fw_ack_index[FNIC_WQ_COPY_MAX];
	unsigned short fw_ack_recd[FNIC_WQ_COPY_MAX];
	unsigned short wq_copy_desc_low[FNIC_WQ_COPY_MAX];
	unsigned int intr_count;
	u32 __iomem *legacy_pba;
	struct fnic_host_tag *tags;
	mempool_t *io_req_pool;
	mempool_t *io_sgl_pool[FNIC_SGL_NUM_CACHES];

	unsigned int copy_wq_base;
	struct work_struct link_work;
	struct work_struct frame_work;
	struct sk_buff_head frame_queue;
	struct sk_buff_head tx_queue;

	/* FIP related data members -- start */
	void (set_vlan)(struct fnic , u16 vlan);
	struct work_struct fip_frame_work;
	struct sk_buff_head fip_frame_queue;
	struct timer_list fip_timer;
	struct list_head vlans;
	spinlock_t vlans_lock;

	struct work_struct event_work;
	struct list_head evlist;
	/* FIP related data members -- end */

	/* copy work queue cache line section */
	____cacheline_aligned struct vnic_wq_copy hw_copy_wq[FNIC_WQ_COPY_MAX];
	____cacheline_aligned struct fnic_cpy_wq sw_copy_wq[FNIC_WQ_COPY_MAX];

	/* completion queue cache line section */
	____cacheline_aligned struct vnic_cq cq[FNIC_CQ_MAX];

	spinlock_t wq_copy_lock[FNIC_WQ_COPY_MAX];

	/* work queue cache line section */
	____cacheline_aligned struct vnic_wq wq[FNIC_WQ_MAX];
	spinlock_t wq_lock[FNIC_WQ_MAX];

	/* receive queue cache line section */
	____cacheline_aligned struct vnic_rq rq[FNIC_RQ_MAX];

	/* interrupt resource cache line section */
	____cacheline_aligned struct vnic_intr intr[FNIC_MSIX_INTR_MAX];
	};

	static inline struct fnic fnic_from_ctlr(struct fcoe_ctlr fip)
	{
	return container_of(fip, struct fnic, ctlr);
	}

	extern struct workqueue_struct *fnic_event_queue;
	extern struct workqueue_struct *fnic_fip_queue;
	extern const struct attribute_group *fnic_host_groups[];

	void fnic_clear_intr_mode(struct fnic *fnic);
	int fnic_set_intr_mode(struct fnic *fnic);
	int fnic_set_intr_mode_msix(struct fnic *fnic);
	void fnic_free_intr(struct fnic *fnic);
	int fnic_request_intr(struct fnic *fnic);

	int fnic_send(struct fc_lport , struct fc_frame );
	void fnic_free_wq_buf(struct vnic_wq wq, struct vnic_wq_buf buf);
	void fnic_handle_frame(struct work_struct *work);
	void fnic_handle_link(struct work_struct *work);
	void fnic_handle_event(struct work_struct *work);
	int fnic_rq_cmpl_handler(struct fnic *fnic, int);
	int fnic_alloc_rq_frame(struct vnic_rq *rq);
	void fnic_free_rq_buf(struct vnic_rq rq, struct vnic_rq_buf buf);
	void fnic_flush_tx(struct fnic *);
	void fnic_eth_send(struct fcoe_ctlr , struct sk_buff skb);
	void fnic_set_port_id(struct fc_lport , u32, struct fc_frame );
	void fnic_update_mac(struct fc_lport , u8 new);
	void fnic_update_mac_locked(struct fnic , u8 new);

	int fnic_queuecommand(struct Scsi_Host , struct scsi_cmnd );
	int fnic_abort_cmd(struct scsi_cmnd *);
	int fnic_device_reset(struct scsi_cmnd *);
	int fnic_host_reset(struct scsi_cmnd *);
	int fnic_reset(struct Scsi_Host *);
	void fnic_scsi_cleanup(struct fc_lport *);
	void fnic_scsi_abort_io(struct fc_lport *);
	void fnic_empty_scsi_cleanup(struct fc_lport *);
	void fnic_exch_mgr_reset(struct fc_lport *, u32, u32);
	int fnic_wq_copy_cmpl_handler(struct fnic *fnic, int copy_work_to_do, unsigned int cq_index);
	int fnic_wq_cmpl_handler(struct fnic *fnic, int);
	int fnic_flogi_reg_handler(struct fnic *fnic, u32);
	void fnic_wq_copy_cleanup_handler(struct vnic_wq_copy *wq,
	struct fcpio_host_req *desc);
	int fnic_fw_reset_handler(struct fnic *fnic);
	void fnic_terminate_rport_io(struct fc_rport *);
	const char *fnic_state_to_str(unsigned int state);
	void fnic_mq_map_queues_cpus(struct Scsi_Host *host);
	void fnic_log_q_error(struct fnic *fnic);
	void fnic_handle_link_event(struct fnic *fnic);

	int fnic_is_abts_pending(struct fnic , struct scsi_cmnd );

	void fnic_handle_fip_frame(struct work_struct *work);
	void fnic_handle_fip_event(struct fnic *fnic);
	void fnic_fcoe_reset_vlans(struct fnic *fnic);
	void fnic_fcoe_evlist_free(struct fnic *fnic);
	extern void fnic_handle_fip_timer(struct fnic *fnic);

	static inline int
	fnic_chk_state_flags_locked(struct fnic *fnic, unsigned long st_flags)
	{
	return ((fnic->state_flags & st_flags) == st_flags);
	}
	void __fnic_set_state_flags(struct fnic *, unsigned long, unsigned long);
	void fnic_dump_fchost_stats(struct Scsi_Host , struct fc_host_statistics );
	#endif /* _FNIC_H_ */