drivers/infiniband/hw/nes/nes.h - third_party/linux - Git at Google

 /*
  * Copyright (c) 2006 - 2011 Intel Corporation.  All rights reserved.
  * Copyright (c) 2005 Open Grid Computing, Inc. All rights reserved.
  *
  * This software is available to you under a choice of one of two
  * licenses.  You may choose to be licensed under the terms of the GNU
  * General Public License (GPL) Version 2, available from the file
  * COPYING in the main directory of this source tree, or the
  * OpenIB.org BSD license below:
  *
  *     Redistribution and use in source and binary forms, with or
  *     without modification, are permitted provided that the following
  *     conditions are met:
  *
  *      - Redistributions of source code must retain the above
  *        copyright notice, this list of conditions and the following
  *        disclaimer.
  *
  *      - Redistributions in binary form must reproduce the above
  *        copyright notice, this list of conditions and the following
  *        disclaimer in the documentation and/or other materials
  *        provided with the distribution.
  *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */

 #ifndef __NES_H
 #define __NES_H

 #include <linux/netdevice.h>
 #include <linux/inetdevice.h>
 #include <linux/interrupt.h>
 #include <linux/spinlock.h>
 #include <linux/kernel.h>
 #include <linux/delay.h>
 #include <linux/pci.h>
 #include <linux/dma-mapping.h>
 #include <linux/workqueue.h>
 #include <linux/slab.h>
 #include <asm/io.h>
 #include <linux/crc32c.h>

 #include <rdma/ib_smi.h>
 #include <rdma/ib_verbs.h>
 #include <rdma/ib_pack.h>
 #include <rdma/rdma_cm.h>
 #include <rdma/iw_cm.h>
 #include <rdma/rdma_netlink.h>
 #include <rdma/iw_portmap.h>

 #define NES_SEND_FIRST_WRITE

 #define QUEUE_DISCONNECTS

 #define DRV_NAME    "iw_nes"
 #define DRV_VERSION "1.5.0.1"
 #define PFX         DRV_NAME ": "

 /*
  * NetEffect PCI vendor id and NE010 PCI device id.
  */
 #ifndef PCI_VENDOR_ID_NETEFFECT	/* not in pci.ids yet */
 #define PCI_VENDOR_ID_NETEFFECT          0x1678
 #define PCI_DEVICE_ID_NETEFFECT_NE020    0x0100
 #define PCI_DEVICE_ID_NETEFFECT_NE020_KR 0x0110
 #endif

 #define NE020_REV   4
 #define NE020_REV1  5

 #define BAR_0       0
 #define BAR_1       2

 #define RX_BUF_SIZE             (1536 + 8)
 #define NES_REG0_SIZE           (4 * 1024)
 #define NES_TX_TIMEOUT          (6*HZ)
 #define NES_FIRST_QPN           64
 #define NES_SW_CONTEXT_ALIGN    1024

 #define NES_MAX_MTU		9000

 #define NES_NIC_MAX_NICS        16
 #define NES_MAX_ARP_TABLE_SIZE  4096

 #define NES_NIC_CEQ_SIZE        8
 /* NICs will be on a separate CQ */
 #define NES_CCEQ_SIZE ((nesadapter->max_cq / nesadapter->port_count) - 32)

 #define NES_MAX_PORT_COUNT 4

 #define MAX_DPC_ITERATIONS               128

 #define NES_DRV_OPT_ENABLE_MPA_VER_0     0x00000001
 #define NES_DRV_OPT_DISABLE_MPA_CRC      0x00000002
 #define NES_DRV_OPT_DISABLE_FIRST_WRITE  0x00000004
 #define NES_DRV_OPT_DISABLE_INTF         0x00000008
 #define NES_DRV_OPT_ENABLE_MSI           0x00000010
 #define NES_DRV_OPT_DUAL_LOGICAL_PORT    0x00000020
 #define NES_DRV_OPT_SUPRESS_OPTION_BC    0x00000040
 #define NES_DRV_OPT_NO_INLINE_DATA       0x00000080
 #define NES_DRV_OPT_DISABLE_INT_MOD      0x00000100
 #define NES_DRV_OPT_DISABLE_VIRT_WQ      0x00000200
 #define NES_DRV_OPT_ENABLE_PAU           0x00000400

 #define NES_AEQ_EVENT_TIMEOUT         2500
 #define NES_DISCONNECT_EVENT_TIMEOUT  2000

 /* debug levels */
 /* must match userspace */
 #define NES_DBG_HW          0x00000001
 #define NES_DBG_INIT        0x00000002
 #define NES_DBG_ISR         0x00000004
 #define NES_DBG_PHY         0x00000008
 #define NES_DBG_NETDEV      0x00000010
 #define NES_DBG_CM          0x00000020
 #define NES_DBG_CM1         0x00000040
 #define NES_DBG_NIC_RX      0x00000080
 #define NES_DBG_NIC_TX      0x00000100
 #define NES_DBG_CQP         0x00000200
 #define NES_DBG_MMAP        0x00000400
 #define NES_DBG_MR          0x00000800
 #define NES_DBG_PD          0x00001000
 #define NES_DBG_CQ          0x00002000
 #define NES_DBG_QP          0x00004000
 #define NES_DBG_MOD_QP      0x00008000
 #define NES_DBG_AEQ         0x00010000
 #define NES_DBG_IW_RX       0x00020000
 #define NES_DBG_IW_TX       0x00040000
 #define NES_DBG_SHUTDOWN    0x00080000
 #define NES_DBG_PAU         0x00100000
 #define NES_DBG_NLMSG       0x00200000
 #define NES_DBG_RSVD1       0x10000000
 #define NES_DBG_RSVD2       0x20000000
 #define NES_DBG_RSVD3       0x40000000
 #define NES_DBG_RSVD4       0x80000000
 #define NES_DBG_ALL         0xffffffff

 #ifdef CONFIG_INFINIBAND_NES_DEBUG
 #define nes_debug(level, fmt, args...) \
 do { \
 	if (level & nes_debug_level) \
 		printk(KERN_ERR PFX "%s[%u]: " fmt, __func__, __LINE__, ##args); \
 } while (0)

 #define assert(expr) \
 do { \
 	if (!(expr)) { \
 		printk(KERN_ERR PFX "Assertion failed! %s, %s, %s, line %d\n", \
 			   #expr, __FILE__, __func__, __LINE__); \
 	} \
 } while (0)

 #define NES_EVENT_TIMEOUT   1200000
 #else
 #define nes_debug(level, fmt, args...)
 #define assert(expr)          do {} while (0)

 #define NES_EVENT_TIMEOUT   100000
 #endif

 #include "nes_hw.h"
 #include "nes_verbs.h"
 #include "nes_context.h"
 #include <rdma/nes-abi.h>
 #include "nes_cm.h"
 #include "nes_mgt.h"

 extern int interrupt_mod_interval;
 extern int nes_if_count;
 extern int mpa_version;
 extern int disable_mpa_crc;
 extern unsigned int nes_drv_opt;
 extern unsigned int nes_debug_level;
 extern unsigned int wqm_quanta;
 extern struct list_head nes_adapter_list;

 extern atomic_t cm_connects;
 extern atomic_t cm_accepts;
 extern atomic_t cm_disconnects;
 extern atomic_t cm_closes;
 extern atomic_t cm_connecteds;
 extern atomic_t cm_connect_reqs;
 extern atomic_t cm_rejects;
 extern atomic_t mod_qp_timouts;
 extern atomic_t qps_created;
 extern atomic_t qps_destroyed;
 extern atomic_t sw_qps_destroyed;
 extern u32 mh_detected;
 extern u32 mh_pauses_sent;
 extern u32 cm_packets_sent;
 extern u32 cm_packets_bounced;
 extern u32 cm_packets_created;
 extern u32 cm_packets_received;
 extern u32 cm_packets_dropped;
 extern u32 cm_packets_retrans;
 extern atomic_t cm_listens_created;
 extern atomic_t cm_listens_destroyed;
 extern u32 cm_backlog_drops;
 extern atomic_t cm_loopbacks;
 extern atomic_t cm_nodes_created;
 extern atomic_t cm_nodes_destroyed;
 extern atomic_t cm_accel_dropped_pkts;
 extern atomic_t cm_resets_recvd;
 extern atomic_t pau_qps_created;
 extern atomic_t pau_qps_destroyed;

 extern u32 int_mod_timer_init;
 extern u32 int_mod_cq_depth_256;
 extern u32 int_mod_cq_depth_128;
 extern u32 int_mod_cq_depth_32;
 extern u32 int_mod_cq_depth_24;
 extern u32 int_mod_cq_depth_16;
 extern u32 int_mod_cq_depth_4;
 extern u32 int_mod_cq_depth_1;

 struct nes_device {
 	struct nes_adapter	   *nesadapter;
 	void __iomem           *regs;
 	void __iomem           *index_reg;
 	struct pci_dev         *pcidev;
 	struct net_device      *netdev[NES_NIC_MAX_NICS];
 	u64                    link_status_interrupts;
 	struct tasklet_struct  dpc_tasklet;
 	spinlock_t             indexed_regs_lock;
 	unsigned long          csr_start;
 	unsigned long          doorbell_region;
 	unsigned long          doorbell_start;
 	unsigned long          mac_tx_errors;
 	unsigned long          mac_pause_frames_sent;
 	unsigned long          mac_pause_frames_received;
 	unsigned long          mac_rx_errors;
 	unsigned long          mac_rx_crc_errors;
 	unsigned long          mac_rx_symbol_err_frames;
 	unsigned long          mac_rx_jabber_frames;
 	unsigned long          mac_rx_oversized_frames;
 	unsigned long          mac_rx_short_frames;
 	unsigned long          port_rx_discards;
 	unsigned long          port_tx_discards;
 	unsigned int           mac_index;
 	unsigned int           nes_stack_start;

 	/* Control Structures */
 	void                   *cqp_vbase;
 	dma_addr_t             cqp_pbase;
 	u32                    cqp_mem_size;
 	u8                     ceq_index;
 	u8                     nic_ceq_index;
 	struct nes_hw_cqp      cqp;
 	struct nes_hw_cq       ccq;
 	struct list_head       cqp_avail_reqs;
 	struct list_head       cqp_pending_reqs;
 	struct nes_cqp_request *nes_cqp_requests;

 	u32                    int_req;
 	u32                    int_stat;
 	u32                    timer_int_req;
 	u32                    timer_only_int_count;
 	u32                    intf_int_req;
 	u32                    last_mac_tx_pauses;
 	u32                    last_used_chunks_tx;
 	struct list_head       list;

 	u16                    base_doorbell_index;
 	u16                    currcq_count;
 	u16                    deepcq_count;
 	u8                     iw_status;
 	u8                     msi_enabled;
 	u8                     netdev_count;
 	u8                     napi_isr_ran;
 	u8                     disable_rx_flow_control;
 	u8                     disable_tx_flow_control;

 	struct delayed_work    work;
 	u8                     link_recheck;
 };

 /* Receive skb private area - must fit in skb->cb area */
 struct nes_rskb_cb {
 	u64                    busaddr;
 	u32                    maplen;
 	u32                    seqnum;
 	u8                     *data_start;
 	struct nes_qp          *nesqp;
 };

 static inline __le32 get_crc_value(struct nes_v4_quad *nes_quad)
 {
 	u32 crc_value;
 	crc_value = crc32c(~0, (void *)nes_quad, sizeof (struct nes_v4_quad));

 	/*
 	 * With commit ef19454b ("[LIB] crc32c: Keep intermediate crc
 	 * state in cpu order"), behavior of crc32c changes on
 	 * big-endian platforms.  Our algorithm expects the previous
 	 * behavior; otherwise we have RDMA connection establishment
 	 * issue on big-endian.
 	 */
 	return cpu_to_le32(crc_value);
 }

 static inline void
 set_wqe_64bit_value(__le32 *wqe_words, u32 index, u64 value)
 {
 	wqe_words[index]     = cpu_to_le32((u32) value);
 	wqe_words[index + 1] = cpu_to_le32(upper_32_bits(value));
 }

 static inline void
 set_wqe_32bit_value(__le32 *wqe_words, u32 index, u32 value)
 {
 	wqe_words[index] = cpu_to_le32(value);
 }

 static inline void
 nes_fill_init_cqp_wqe(struct nes_hw_cqp_wqe *cqp_wqe, struct nes_device *nesdev)
 {
 	cqp_wqe->wqe_words[NES_CQP_WQE_COMP_CTX_LOW_IDX]       = 0;
 	cqp_wqe->wqe_words[NES_CQP_WQE_COMP_CTX_HIGH_IDX]      = 0;
 	cqp_wqe->wqe_words[NES_CQP_WQE_COMP_SCRATCH_LOW_IDX]   = 0;
 	cqp_wqe->wqe_words[NES_CQP_WQE_COMP_SCRATCH_HIGH_IDX]  = 0;
 	cqp_wqe->wqe_words[NES_CQP_STAG_WQE_PBL_BLK_COUNT_IDX] = 0;
 	cqp_wqe->wqe_words[NES_CQP_STAG_WQE_PBL_LEN_IDX]       = 0;
 	cqp_wqe->wqe_words[NES_CQP_STAG_WQE_LEN_LOW_IDX]       = 0;
 	cqp_wqe->wqe_words[NES_CQP_STAG_WQE_PA_LOW_IDX]        = 0;
 	cqp_wqe->wqe_words[NES_CQP_STAG_WQE_PA_HIGH_IDX]       = 0;
 }

 static inline void
 nes_fill_init_qp_wqe(struct nes_hw_qp_wqe *wqe, struct nes_qp *nesqp, u32 head)
 {
 	u32 value;
 	value = ((u32)((unsigned long) nesqp)) | head;
 	set_wqe_32bit_value(wqe->wqe_words, NES_IWARP_SQ_WQE_COMP_CTX_HIGH_IDX,
 			(u32)(upper_32_bits((unsigned long)(nesqp))));
 	set_wqe_32bit_value(wqe->wqe_words, NES_IWARP_SQ_WQE_COMP_CTX_LOW_IDX, value);
 }

 /* Read from memory-mapped device */
 static inline u32 nes_read_indexed(struct nes_device *nesdev, u32 reg_index)
 {
 	unsigned long flags;
 	void __iomem *addr = nesdev->index_reg;
 	u32 value;

 	spin_lock_irqsave(&nesdev->indexed_regs_lock, flags);

 	writel(reg_index, addr);
 	value = readl((void __iomem *)addr + 4);

 	spin_unlock_irqrestore(&nesdev->indexed_regs_lock, flags);
 	return value;
 }

 static inline u32 nes_read32(const void __iomem *addr)
 {
 	return readl(addr);
 }

 static inline u16 nes_read16(const void __iomem *addr)
 {
 	return readw(addr);
 }

 static inline u8 nes_read8(const void __iomem *addr)
 {
 	return readb(addr);
 }

 /* Write to memory-mapped device */
 static inline void nes_write_indexed(struct nes_device *nesdev, u32 reg_index, u32 val)
 {
 	unsigned long flags;
 	void __iomem *addr = nesdev->index_reg;

 	spin_lock_irqsave(&nesdev->indexed_regs_lock, flags);

 	writel(reg_index, addr);
 	writel(val, (void __iomem *)addr + 4);

 	spin_unlock_irqrestore(&nesdev->indexed_regs_lock, flags);
 }

 static inline void nes_write32(void __iomem *addr, u32 val)
 {
 	writel(val, addr);
 }

 static inline void nes_write16(void __iomem *addr, u16 val)
 {
 	writew(val, addr);
 }

 static inline void nes_write8(void __iomem *addr, u8 val)
 {
 	writeb(val, addr);
 }

 enum nes_resource {
 	NES_RESOURCE_MW = 1,
 	NES_RESOURCE_FAST_MR,
 	NES_RESOURCE_PHYS_MR,
 	NES_RESOURCE_USER_MR,
 	NES_RESOURCE_PD,
 	NES_RESOURCE_QP,
 	NES_RESOURCE_CQ,
 	NES_RESOURCE_ARP
 };

 static inline int nes_alloc_resource(struct nes_adapter *nesadapter,
 		unsigned long *resource_array, u32 max_resources,
 		u32 *req_resource_num, u32 *next, enum nes_resource resource_type)
 {
 	unsigned long flags;
 	u32 resource_num;

 	spin_lock_irqsave(&nesadapter->resource_lock, flags);

 	resource_num = find_next_zero_bit(resource_array, max_resources, *next);
 	if (resource_num >= max_resources) {
 		resource_num = find_first_zero_bit(resource_array, max_resources);
 		if (resource_num >= max_resources) {
 			printk(KERN_ERR PFX "%s: No available resources [type=%u].\n", __func__, resource_type);
 			spin_unlock_irqrestore(&nesadapter->resource_lock, flags);
 			return -EMFILE;
 		}
 	}
 	set_bit(resource_num, resource_array);
 	*next = resource_num+1;
 	if (*next == max_resources) {
 		*next = 0;
 	}
 	spin_unlock_irqrestore(&nesadapter->resource_lock, flags);
 	*req_resource_num = resource_num;

 	return 0;
 }

 static inline int nes_is_resource_allocated(struct nes_adapter *nesadapter,
 		unsigned long *resource_array, u32 resource_num)
 {
 	unsigned long flags;
 	int bit_is_set;

 	spin_lock_irqsave(&nesadapter->resource_lock, flags);

 	bit_is_set = test_bit(resource_num, resource_array);
 	nes_debug(NES_DBG_HW, "resource_num %u is%s allocated.\n",
 			resource_num, (bit_is_set ? "": " not"));
 	spin_unlock_irqrestore(&nesadapter->resource_lock, flags);

 	return bit_is_set;
 }

 static inline void nes_free_resource(struct nes_adapter *nesadapter,
 		unsigned long *resource_array, u32 resource_num)
 {
 	unsigned long flags;

 	spin_lock_irqsave(&nesadapter->resource_lock, flags);
 	clear_bit(resource_num, resource_array);
 	spin_unlock_irqrestore(&nesadapter->resource_lock, flags);
 }

 static inline struct nes_vnic *to_nesvnic(struct ib_device *ibdev)
 {
 	return container_of(ibdev, struct nes_ib_device, ibdev)->nesvnic;
 }

 static inline struct nes_pd *to_nespd(struct ib_pd *ibpd)
 {
 	return container_of(ibpd, struct nes_pd, ibpd);
 }

 static inline struct nes_ucontext *to_nesucontext(struct ib_ucontext *ibucontext)
 {
 	return container_of(ibucontext, struct nes_ucontext, ibucontext);
 }

 static inline struct nes_mr *to_nesmr(struct ib_mr *ibmr)
 {
 	return container_of(ibmr, struct nes_mr, ibmr);
 }

 static inline struct nes_mr *to_nesmr_from_ibfmr(struct ib_fmr *ibfmr)
 {
 	return container_of(ibfmr, struct nes_mr, ibfmr);
 }

 static inline struct nes_mr *to_nesmw(struct ib_mw *ibmw)
 {
 	return container_of(ibmw, struct nes_mr, ibmw);
 }

 static inline struct nes_fmr *to_nesfmr(struct nes_mr *nesmr)
 {
 	return container_of(nesmr, struct nes_fmr, nesmr);
 }

 static inline struct nes_cq *to_nescq(struct ib_cq *ibcq)
 {
 	return container_of(ibcq, struct nes_cq, ibcq);
 }

 static inline struct nes_qp *to_nesqp(struct ib_qp *ibqp)
 {
 	return container_of(ibqp, struct nes_qp, ibqp);
 }


 /* nes.c */
 void nes_add_ref(struct ib_qp *);
 void nes_rem_ref(struct ib_qp *);
 struct ib_qp *nes_get_qp(struct ib_device *, int);


 /* nes_hw.c */
 struct nes_adapter *nes_init_adapter(struct nes_device *, u8);
 void  nes_nic_init_timer_defaults(struct nes_device *, u8);
 void nes_destroy_adapter(struct nes_adapter *);
 int nes_init_cqp(struct nes_device *);
 int nes_init_phy(struct nes_device *);
 int nes_init_nic_qp(struct nes_device *, struct net_device *);
 void nes_destroy_nic_qp(struct nes_vnic *);
 int nes_napi_isr(struct nes_device *);
 void nes_dpc(unsigned long);
 void nes_nic_ce_handler(struct nes_device *, struct nes_hw_nic_cq *);
 void nes_iwarp_ce_handler(struct nes_device *, struct nes_hw_cq *);
 int nes_destroy_cqp(struct nes_device *);
 int nes_nic_cm_xmit(struct sk_buff *, struct net_device *);
 void nes_recheck_link_status(struct work_struct *work);
 void nes_terminate_timeout(struct timer_list *t);

 /* nes_nic.c */
 struct net_device *nes_netdev_init(struct nes_device *, void __iomem *);
 void nes_netdev_destroy(struct net_device *);
 int nes_nic_cm_xmit(struct sk_buff *, struct net_device *);

 /* nes_cm.c */
 void *nes_cm_create(struct net_device *);
 int nes_cm_recv(struct sk_buff *, struct net_device *);
 void nes_update_arp(unsigned char *, u32, u32, u16, u16);
 void nes_manage_arp_cache(struct net_device *, unsigned char *, u32, u32);
 void nes_sock_release(struct nes_qp *, unsigned long *);
 void flush_wqes(struct nes_device *nesdev, struct nes_qp *, u32, u32);
 int nes_manage_apbvt(struct nes_vnic *, u32, u32, u32);
 int nes_cm_disconn(struct nes_qp *);
 void nes_cm_disconn_worker(void *);

 /* nes_verbs.c */
 int nes_hw_modify_qp(struct nes_device *, struct nes_qp *, u32, u32, u32);
 int nes_modify_qp(struct ib_qp *, struct ib_qp_attr *, int, struct ib_udata *);
 struct nes_ib_device *nes_init_ofa_device(struct net_device *);
 void  nes_port_ibevent(struct nes_vnic *nesvnic);
 void nes_destroy_ofa_device(struct nes_ib_device *);
 int nes_register_ofa_device(struct nes_ib_device *);

 /* nes_util.c */
 int nes_read_eeprom_values(struct nes_device *, struct nes_adapter *);
 void nes_write_1G_phy_reg(struct nes_device *, u8, u8, u16);
 void nes_read_1G_phy_reg(struct nes_device *, u8, u8, u16 *);
 void nes_write_10G_phy_reg(struct nes_device *, u16, u8, u16, u16);
 void nes_read_10G_phy_reg(struct nes_device *, u8, u8, u16);
 struct nes_cqp_request *nes_get_cqp_request(struct nes_device *);
 void nes_free_cqp_request(struct nes_device *nesdev,
 			  struct nes_cqp_request *cqp_request);
 void nes_put_cqp_request(struct nes_device *nesdev,
 			 struct nes_cqp_request *cqp_request);
 void nes_post_cqp_request(struct nes_device *, struct nes_cqp_request *);
 int nes_arp_table(struct nes_device *, u32, u8 *, u32);
 void nes_mh_fix(struct timer_list *t);
 void nes_clc(struct timer_list *t);
 void nes_dump_mem(unsigned int, void *, int);
 u32 nes_crc32(u32, u32, u32, u32, u8 *, u32, u32, u32);

 #endif	/* __NES_H */
	/*
	* Copyright (c) 2006 - 2011 Intel Corporation. All rights reserved.
	* Copyright (c) 2005 Open Grid Computing, Inc. All rights reserved.
	*
	* This software is available to you under a choice of one of two
	* licenses. You may choose to be licensed under the terms of the GNU
	* General Public License (GPL) Version 2, available from the file
	* COPYING in the main directory of this source tree, or the
	* OpenIB.org BSD license below:
	*
	* Redistribution and use in source and binary forms, with or
	* without modification, are permitted provided that the following
	* conditions are met:
	*
	* - Redistributions of source code must retain the above
	* copyright notice, this list of conditions and the following
	* disclaimer.
	*
	* - Redistributions in binary form must reproduce the above
	* copyright notice, this list of conditions and the following
	* disclaimer in the documentation and/or other materials
	* provided with the distribution.
	*
	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
	* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
	* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	* SOFTWARE.
	*/

	#ifndef __NES_H
	#define __NES_H

	#include <linux/netdevice.h>
	#include <linux/inetdevice.h>
	#include <linux/interrupt.h>
	#include <linux/spinlock.h>
	#include <linux/kernel.h>
	#include <linux/delay.h>
	#include <linux/pci.h>
	#include <linux/dma-mapping.h>
	#include <linux/workqueue.h>
	#include <linux/slab.h>
	#include <asm/io.h>
	#include <linux/crc32c.h>

	#include <rdma/ib_smi.h>
	#include <rdma/ib_verbs.h>
	#include <rdma/ib_pack.h>
	#include <rdma/rdma_cm.h>
	#include <rdma/iw_cm.h>
	#include <rdma/rdma_netlink.h>
	#include <rdma/iw_portmap.h>

	#define NES_SEND_FIRST_WRITE

	#define QUEUE_DISCONNECTS

	#define DRV_NAME "iw_nes"
	#define DRV_VERSION "1.5.0.1"
	#define PFX DRV_NAME ": "

	/*
	* NetEffect PCI vendor id and NE010 PCI device id.
	*/
	#ifndef PCI_VENDOR_ID_NETEFFECT /* not in pci.ids yet */
	#define PCI_VENDOR_ID_NETEFFECT 0x1678
	#define PCI_DEVICE_ID_NETEFFECT_NE020 0x0100
	#define PCI_DEVICE_ID_NETEFFECT_NE020_KR 0x0110
	#endif

	#define NE020_REV 4
	#define NE020_REV1 5

	#define BAR_0 0
	#define BAR_1 2

	#define RX_BUF_SIZE (1536 + 8)
	#define NES_REG0_SIZE (4 * 1024)
	#define NES_TX_TIMEOUT (6*HZ)
	#define NES_FIRST_QPN 64
	#define NES_SW_CONTEXT_ALIGN 1024

	#define NES_MAX_MTU 9000

	#define NES_NIC_MAX_NICS 16
	#define NES_MAX_ARP_TABLE_SIZE 4096

	#define NES_NIC_CEQ_SIZE 8
	/* NICs will be on a separate CQ */
	#define NES_CCEQ_SIZE ((nesadapter->max_cq / nesadapter->port_count) - 32)

	#define NES_MAX_PORT_COUNT 4

	#define MAX_DPC_ITERATIONS 128

	#define NES_DRV_OPT_ENABLE_MPA_VER_0 0x00000001
	#define NES_DRV_OPT_DISABLE_MPA_CRC 0x00000002
	#define NES_DRV_OPT_DISABLE_FIRST_WRITE 0x00000004
	#define NES_DRV_OPT_DISABLE_INTF 0x00000008
	#define NES_DRV_OPT_ENABLE_MSI 0x00000010
	#define NES_DRV_OPT_DUAL_LOGICAL_PORT 0x00000020
	#define NES_DRV_OPT_SUPRESS_OPTION_BC 0x00000040
	#define NES_DRV_OPT_NO_INLINE_DATA 0x00000080
	#define NES_DRV_OPT_DISABLE_INT_MOD 0x00000100
	#define NES_DRV_OPT_DISABLE_VIRT_WQ 0x00000200
	#define NES_DRV_OPT_ENABLE_PAU 0x00000400

	#define NES_AEQ_EVENT_TIMEOUT 2500
	#define NES_DISCONNECT_EVENT_TIMEOUT 2000

	/* debug levels */
	/* must match userspace */
	#define NES_DBG_HW 0x00000001
	#define NES_DBG_INIT 0x00000002
	#define NES_DBG_ISR 0x00000004
	#define NES_DBG_PHY 0x00000008
	#define NES_DBG_NETDEV 0x00000010
	#define NES_DBG_CM 0x00000020
	#define NES_DBG_CM1 0x00000040
	#define NES_DBG_NIC_RX 0x00000080
	#define NES_DBG_NIC_TX 0x00000100
	#define NES_DBG_CQP 0x00000200
	#define NES_DBG_MMAP 0x00000400
	#define NES_DBG_MR 0x00000800
	#define NES_DBG_PD 0x00001000
	#define NES_DBG_CQ 0x00002000
	#define NES_DBG_QP 0x00004000
	#define NES_DBG_MOD_QP 0x00008000
	#define NES_DBG_AEQ 0x00010000
	#define NES_DBG_IW_RX 0x00020000
	#define NES_DBG_IW_TX 0x00040000
	#define NES_DBG_SHUTDOWN 0x00080000
	#define NES_DBG_PAU 0x00100000
	#define NES_DBG_NLMSG 0x00200000
	#define NES_DBG_RSVD1 0x10000000
	#define NES_DBG_RSVD2 0x20000000
	#define NES_DBG_RSVD3 0x40000000
	#define NES_DBG_RSVD4 0x80000000
	#define NES_DBG_ALL 0xffffffff

	#ifdef CONFIG_INFINIBAND_NES_DEBUG
	#define nes_debug(level, fmt, args...) \
	do { \
	if (level & nes_debug_level) \
	printk(KERN_ERR PFX "%s[%u]: " fmt, __func__, __LINE__, ##args); \
	} while (0)

	#define assert(expr) \
	do { \
	if (!(expr)) { \
	printk(KERN_ERR PFX "Assertion failed! %s, %s, %s, line %d\n", \
	#expr, __FILE__, __func__, __LINE__); \
	} \
	} while (0)

	#define NES_EVENT_TIMEOUT 1200000
	#else
	#define nes_debug(level, fmt, args...)
	#define assert(expr) do {} while (0)

	#define NES_EVENT_TIMEOUT 100000
	#endif

	#include "nes_hw.h"
	#include "nes_verbs.h"
	#include "nes_context.h"
	#include <rdma/nes-abi.h>
	#include "nes_cm.h"
	#include "nes_mgt.h"

	extern int interrupt_mod_interval;
	extern int nes_if_count;
	extern int mpa_version;
	extern int disable_mpa_crc;
	extern unsigned int nes_drv_opt;
	extern unsigned int nes_debug_level;
	extern unsigned int wqm_quanta;
	extern struct list_head nes_adapter_list;

	extern atomic_t cm_connects;
	extern atomic_t cm_accepts;
	extern atomic_t cm_disconnects;
	extern atomic_t cm_closes;
	extern atomic_t cm_connecteds;
	extern atomic_t cm_connect_reqs;
	extern atomic_t cm_rejects;
	extern atomic_t mod_qp_timouts;
	extern atomic_t qps_created;
	extern atomic_t qps_destroyed;
	extern atomic_t sw_qps_destroyed;
	extern u32 mh_detected;
	extern u32 mh_pauses_sent;
	extern u32 cm_packets_sent;
	extern u32 cm_packets_bounced;
	extern u32 cm_packets_created;
	extern u32 cm_packets_received;
	extern u32 cm_packets_dropped;
	extern u32 cm_packets_retrans;
	extern atomic_t cm_listens_created;
	extern atomic_t cm_listens_destroyed;
	extern u32 cm_backlog_drops;
	extern atomic_t cm_loopbacks;
	extern atomic_t cm_nodes_created;
	extern atomic_t cm_nodes_destroyed;
	extern atomic_t cm_accel_dropped_pkts;
	extern atomic_t cm_resets_recvd;
	extern atomic_t pau_qps_created;
	extern atomic_t pau_qps_destroyed;

	extern u32 int_mod_timer_init;
	extern u32 int_mod_cq_depth_256;
	extern u32 int_mod_cq_depth_128;
	extern u32 int_mod_cq_depth_32;
	extern u32 int_mod_cq_depth_24;
	extern u32 int_mod_cq_depth_16;
	extern u32 int_mod_cq_depth_4;
	extern u32 int_mod_cq_depth_1;

	struct nes_device {
	struct nes_adapter *nesadapter;
	void __iomem *regs;
	void __iomem *index_reg;
	struct pci_dev *pcidev;
	struct net_device *netdev[NES_NIC_MAX_NICS];
	u64 link_status_interrupts;
	struct tasklet_struct dpc_tasklet;
	spinlock_t indexed_regs_lock;
	unsigned long csr_start;
	unsigned long doorbell_region;
	unsigned long doorbell_start;
	unsigned long mac_tx_errors;
	unsigned long mac_pause_frames_sent;
	unsigned long mac_pause_frames_received;
	unsigned long mac_rx_errors;
	unsigned long mac_rx_crc_errors;
	unsigned long mac_rx_symbol_err_frames;
	unsigned long mac_rx_jabber_frames;
	unsigned long mac_rx_oversized_frames;
	unsigned long mac_rx_short_frames;
	unsigned long port_rx_discards;
	unsigned long port_tx_discards;
	unsigned int mac_index;
	unsigned int nes_stack_start;

	/* Control Structures */
	void *cqp_vbase;
	dma_addr_t cqp_pbase;
	u32 cqp_mem_size;
	u8 ceq_index;
	u8 nic_ceq_index;
	struct nes_hw_cqp cqp;
	struct nes_hw_cq ccq;
	struct list_head cqp_avail_reqs;
	struct list_head cqp_pending_reqs;
	struct nes_cqp_request *nes_cqp_requests;

	u32 int_req;
	u32 int_stat;
	u32 timer_int_req;
	u32 timer_only_int_count;
	u32 intf_int_req;
	u32 last_mac_tx_pauses;
	u32 last_used_chunks_tx;
	struct list_head list;

	u16 base_doorbell_index;
	u16 currcq_count;
	u16 deepcq_count;
	u8 iw_status;
	u8 msi_enabled;
	u8 netdev_count;
	u8 napi_isr_ran;
	u8 disable_rx_flow_control;
	u8 disable_tx_flow_control;

	struct delayed_work work;
	u8 link_recheck;
	};

	/* Receive skb private area - must fit in skb->cb area */
	struct nes_rskb_cb {
	u64 busaddr;
	u32 maplen;
	u32 seqnum;
	u8 *data_start;
	struct nes_qp *nesqp;
	};

	static inline __le32 get_crc_value(struct nes_v4_quad *nes_quad)
	{
	u32 crc_value;
	crc_value = crc32c(~0, (void *)nes_quad, sizeof (struct nes_v4_quad));

	/*
	* With commit ef19454b ("[LIB] crc32c: Keep intermediate crc
	* state in cpu order"), behavior of crc32c changes on
	* big-endian platforms. Our algorithm expects the previous
	* behavior; otherwise we have RDMA connection establishment
	* issue on big-endian.
	*/
	return cpu_to_le32(crc_value);
	}

	static inline void
	set_wqe_64bit_value(__le32 *wqe_words, u32 index, u64 value)
	{
	wqe_words[index] = cpu_to_le32((u32) value);
	wqe_words[index + 1] = cpu_to_le32(upper_32_bits(value));
	}

	static inline void
	set_wqe_32bit_value(__le32 *wqe_words, u32 index, u32 value)
	{
	wqe_words[index] = cpu_to_le32(value);
	}

	static inline void
	nes_fill_init_cqp_wqe(struct nes_hw_cqp_wqe cqp_wqe, struct nes_device nesdev)
	{
	cqp_wqe->wqe_words[NES_CQP_WQE_COMP_CTX_LOW_IDX] = 0;
	cqp_wqe->wqe_words[NES_CQP_WQE_COMP_CTX_HIGH_IDX] = 0;
	cqp_wqe->wqe_words[NES_CQP_WQE_COMP_SCRATCH_LOW_IDX] = 0;
	cqp_wqe->wqe_words[NES_CQP_WQE_COMP_SCRATCH_HIGH_IDX] = 0;
	cqp_wqe->wqe_words[NES_CQP_STAG_WQE_PBL_BLK_COUNT_IDX] = 0;
	cqp_wqe->wqe_words[NES_CQP_STAG_WQE_PBL_LEN_IDX] = 0;
	cqp_wqe->wqe_words[NES_CQP_STAG_WQE_LEN_LOW_IDX] = 0;
	cqp_wqe->wqe_words[NES_CQP_STAG_WQE_PA_LOW_IDX] = 0;
	cqp_wqe->wqe_words[NES_CQP_STAG_WQE_PA_HIGH_IDX] = 0;
	}

	static inline void
	nes_fill_init_qp_wqe(struct nes_hw_qp_wqe wqe, struct nes_qp nesqp, u32 head)
	{
	u32 value;
	value = ((u32)((unsigned long) nesqp)) \| head;
	set_wqe_32bit_value(wqe->wqe_words, NES_IWARP_SQ_WQE_COMP_CTX_HIGH_IDX,
	(u32)(upper_32_bits((unsigned long)(nesqp))));
	set_wqe_32bit_value(wqe->wqe_words, NES_IWARP_SQ_WQE_COMP_CTX_LOW_IDX, value);
	}

	/* Read from memory-mapped device */
	static inline u32 nes_read_indexed(struct nes_device *nesdev, u32 reg_index)
	{
	unsigned long flags;
	void __iomem *addr = nesdev->index_reg;
	u32 value;

	spin_lock_irqsave(&nesdev->indexed_regs_lock, flags);

	writel(reg_index, addr);
	value = readl((void __iomem *)addr + 4);

	spin_unlock_irqrestore(&nesdev->indexed_regs_lock, flags);
	return value;
	}

	static inline u32 nes_read32(const void __iomem *addr)
	{
	return readl(addr);
	}

	static inline u16 nes_read16(const void __iomem *addr)
	{
	return readw(addr);
	}

	static inline u8 nes_read8(const void __iomem *addr)
	{
	return readb(addr);
	}

	/* Write to memory-mapped device */
	static inline void nes_write_indexed(struct nes_device *nesdev, u32 reg_index, u32 val)
	{
	unsigned long flags;
	void __iomem *addr = nesdev->index_reg;

	spin_lock_irqsave(&nesdev->indexed_regs_lock, flags);

	writel(reg_index, addr);
	writel(val, (void __iomem *)addr + 4);

	spin_unlock_irqrestore(&nesdev->indexed_regs_lock, flags);
	}

	static inline void nes_write32(void __iomem *addr, u32 val)
	{
	writel(val, addr);
	}

	static inline void nes_write16(void __iomem *addr, u16 val)
	{
	writew(val, addr);
	}

	static inline void nes_write8(void __iomem *addr, u8 val)
	{
	writeb(val, addr);
	}

	enum nes_resource {
	NES_RESOURCE_MW = 1,
	NES_RESOURCE_FAST_MR,
	NES_RESOURCE_PHYS_MR,
	NES_RESOURCE_USER_MR,
	NES_RESOURCE_PD,
	NES_RESOURCE_QP,
	NES_RESOURCE_CQ,
	NES_RESOURCE_ARP
	};

	static inline int nes_alloc_resource(struct nes_adapter *nesadapter,
	unsigned long *resource_array, u32 max_resources,
	u32 req_resource_num, u32 next, enum nes_resource resource_type)
	{
	unsigned long flags;
	u32 resource_num;

	spin_lock_irqsave(&nesadapter->resource_lock, flags);

	resource_num = find_next_zero_bit(resource_array, max_resources, *next);
	if (resource_num >= max_resources) {
	resource_num = find_first_zero_bit(resource_array, max_resources);
	if (resource_num >= max_resources) {
	printk(KERN_ERR PFX "%s: No available resources [type=%u].\n", __func__, resource_type);
	spin_unlock_irqrestore(&nesadapter->resource_lock, flags);
	return -EMFILE;
	}
	}
	set_bit(resource_num, resource_array);
	*next = resource_num+1;
	if (*next == max_resources) {
	*next = 0;
	}
	spin_unlock_irqrestore(&nesadapter->resource_lock, flags);
	*req_resource_num = resource_num;

	return 0;
	}

	static inline int nes_is_resource_allocated(struct nes_adapter *nesadapter,
	unsigned long *resource_array, u32 resource_num)
	{
	unsigned long flags;
	int bit_is_set;

	spin_lock_irqsave(&nesadapter->resource_lock, flags);

	bit_is_set = test_bit(resource_num, resource_array);
	nes_debug(NES_DBG_HW, "resource_num %u is%s allocated.\n",
	resource_num, (bit_is_set ? "": " not"));
	spin_unlock_irqrestore(&nesadapter->resource_lock, flags);

	return bit_is_set;
	}

	static inline void nes_free_resource(struct nes_adapter *nesadapter,
	unsigned long *resource_array, u32 resource_num)
	{
	unsigned long flags;

	spin_lock_irqsave(&nesadapter->resource_lock, flags);
	clear_bit(resource_num, resource_array);
	spin_unlock_irqrestore(&nesadapter->resource_lock, flags);
	}

	static inline struct nes_vnic to_nesvnic(struct ib_device ibdev)
	{
	return container_of(ibdev, struct nes_ib_device, ibdev)->nesvnic;
	}

	static inline struct nes_pd to_nespd(struct ib_pd ibpd)
	{
	return container_of(ibpd, struct nes_pd, ibpd);
	}

	static inline struct nes_ucontext to_nesucontext(struct ib_ucontext ibucontext)
	{
	return container_of(ibucontext, struct nes_ucontext, ibucontext);
	}

	static inline struct nes_mr to_nesmr(struct ib_mr ibmr)
	{
	return container_of(ibmr, struct nes_mr, ibmr);
	}

	static inline struct nes_mr to_nesmr_from_ibfmr(struct ib_fmr ibfmr)
	{
	return container_of(ibfmr, struct nes_mr, ibfmr);
	}

	static inline struct nes_mr to_nesmw(struct ib_mw ibmw)
	{
	return container_of(ibmw, struct nes_mr, ibmw);
	}

	static inline struct nes_fmr to_nesfmr(struct nes_mr nesmr)
	{
	return container_of(nesmr, struct nes_fmr, nesmr);
	}

	static inline struct nes_cq to_nescq(struct ib_cq ibcq)
	{
	return container_of(ibcq, struct nes_cq, ibcq);
	}

	static inline struct nes_qp to_nesqp(struct ib_qp ibqp)
	{
	return container_of(ibqp, struct nes_qp, ibqp);
	}



	/* nes.c */
	void nes_add_ref(struct ib_qp *);
	void nes_rem_ref(struct ib_qp *);
	struct ib_qp nes_get_qp(struct ib_device , int);


	/* nes_hw.c */
	struct nes_adapter nes_init_adapter(struct nes_device , u8);
	void nes_nic_init_timer_defaults(struct nes_device *, u8);
	void nes_destroy_adapter(struct nes_adapter *);
	int nes_init_cqp(struct nes_device *);
	int nes_init_phy(struct nes_device *);
	int nes_init_nic_qp(struct nes_device , struct net_device );
	void nes_destroy_nic_qp(struct nes_vnic *);
	int nes_napi_isr(struct nes_device *);
	void nes_dpc(unsigned long);
	void nes_nic_ce_handler(struct nes_device , struct nes_hw_nic_cq );
	void nes_iwarp_ce_handler(struct nes_device , struct nes_hw_cq );
	int nes_destroy_cqp(struct nes_device *);
	int nes_nic_cm_xmit(struct sk_buff , struct net_device );
	void nes_recheck_link_status(struct work_struct *work);
	void nes_terminate_timeout(struct timer_list *t);

	/* nes_nic.c */
	struct net_device nes_netdev_init(struct nes_device , void __iomem *);
	void nes_netdev_destroy(struct net_device *);
	int nes_nic_cm_xmit(struct sk_buff , struct net_device );

	/* nes_cm.c */
	void nes_cm_create(struct net_device );
	int nes_cm_recv(struct sk_buff , struct net_device );
	void nes_update_arp(unsigned char *, u32, u32, u16, u16);
	void nes_manage_arp_cache(struct net_device , unsigned char , u32, u32);
	void nes_sock_release(struct nes_qp , unsigned long );
	void flush_wqes(struct nes_device nesdev, struct nes_qp , u32, u32);
	int nes_manage_apbvt(struct nes_vnic *, u32, u32, u32);
	int nes_cm_disconn(struct nes_qp *);
	void nes_cm_disconn_worker(void *);

	/* nes_verbs.c */
	int nes_hw_modify_qp(struct nes_device , struct nes_qp , u32, u32, u32);
	int nes_modify_qp(struct ib_qp , struct ib_qp_attr , int, struct ib_udata *);
	struct nes_ib_device nes_init_ofa_device(struct net_device );
	void nes_port_ibevent(struct nes_vnic *nesvnic);
	void nes_destroy_ofa_device(struct nes_ib_device *);
	int nes_register_ofa_device(struct nes_ib_device *);

	/* nes_util.c */
	int nes_read_eeprom_values(struct nes_device , struct nes_adapter );
	void nes_write_1G_phy_reg(struct nes_device *, u8, u8, u16);
	void nes_read_1G_phy_reg(struct nes_device , u8, u8, u16 );
	void nes_write_10G_phy_reg(struct nes_device *, u16, u8, u16, u16);
	void nes_read_10G_phy_reg(struct nes_device *, u8, u8, u16);
	struct nes_cqp_request nes_get_cqp_request(struct nes_device );
	void nes_free_cqp_request(struct nes_device *nesdev,
	struct nes_cqp_request *cqp_request);
	void nes_put_cqp_request(struct nes_device *nesdev,
	struct nes_cqp_request *cqp_request);
	void nes_post_cqp_request(struct nes_device , struct nes_cqp_request );
	int nes_arp_table(struct nes_device , u32, u8 , u32);
	void nes_mh_fix(struct timer_list *t);
	void nes_clc(struct timer_list *t);
	void nes_dump_mem(unsigned int, void *, int);
	u32 nes_crc32(u32, u32, u32, u32, u8 *, u32, u32, u32);

	#endif /* __NES_H */