Linux Audio

Check our new training course

Loading...
  1/*
  2 * Copyright (C) 2005 - 2011 Emulex
  3 * All rights reserved.
  4 *
  5 * This program is free software; you can redistribute it and/or
  6 * modify it under the terms of the GNU General Public License version 2
  7 * as published by the Free Software Foundation.  The full GNU General
  8 * Public License is included in this distribution in the file called COPYING.
  9 *
 10 * Contact Information:
 11 * linux-drivers@emulex.com
 12 *
 13 * Emulex
 14 * 3333 Susan Street
 15 * Costa Mesa, CA 92626
 16 */
 17
 18#ifndef BE_H
 19#define BE_H
 20
 21#include <linux/pci.h>
 22#include <linux/etherdevice.h>
 23#include <linux/delay.h>
 24#include <net/tcp.h>
 25#include <net/ip.h>
 26#include <net/ipv6.h>
 27#include <linux/if_vlan.h>
 28#include <linux/workqueue.h>
 29#include <linux/interrupt.h>
 30#include <linux/firmware.h>
 31#include <linux/slab.h>
 32#include <linux/u64_stats_sync.h>
 33
 34#include "be_hw.h"
 35#include "be_roce.h"
 36
 37#define DRV_VER			"4.2.220u"
 38#define DRV_NAME		"be2net"
 39#define BE_NAME			"ServerEngines BladeEngine2 10Gbps NIC"
 40#define BE3_NAME		"ServerEngines BladeEngine3 10Gbps NIC"
 41#define OC_NAME			"Emulex OneConnect 10Gbps NIC"
 42#define OC_NAME_BE		OC_NAME	"(be3)"
 43#define OC_NAME_LANCER		OC_NAME "(Lancer)"
 44#define OC_NAME_SH		OC_NAME "(Skyhawk)"
 45#define DRV_DESC		"ServerEngines BladeEngine 10Gbps NIC Driver"
 46
 47#define BE_VENDOR_ID 		0x19a2
 48#define EMULEX_VENDOR_ID	0x10df
 49#define BE_DEVICE_ID1		0x211
 50#define BE_DEVICE_ID2		0x221
 51#define OC_DEVICE_ID1		0x700	/* Device Id for BE2 cards */
 52#define OC_DEVICE_ID2		0x710	/* Device Id for BE3 cards */
 53#define OC_DEVICE_ID3		0xe220	/* Device id for Lancer cards */
 54#define OC_DEVICE_ID4           0xe228   /* Device id for VF in Lancer */
 55#define OC_DEVICE_ID5		0x720	/* Device Id for Skyhawk cards */
 56#define OC_SUBSYS_DEVICE_ID1	0xE602
 57#define OC_SUBSYS_DEVICE_ID2	0xE642
 58#define OC_SUBSYS_DEVICE_ID3	0xE612
 59#define OC_SUBSYS_DEVICE_ID4	0xE652
 60
 61static inline char *nic_name(struct pci_dev *pdev)
 62{
 63	switch (pdev->device) {
 64	case OC_DEVICE_ID1:
 65		return OC_NAME;
 66	case OC_DEVICE_ID2:
 67		return OC_NAME_BE;
 68	case OC_DEVICE_ID3:
 69	case OC_DEVICE_ID4:
 70		return OC_NAME_LANCER;
 71	case BE_DEVICE_ID2:
 72		return BE3_NAME;
 73	case OC_DEVICE_ID5:
 74		return OC_NAME_SH;
 75	default:
 76		return BE_NAME;
 77	}
 78}
 79
 80/* Number of bytes of an RX frame that are copied to skb->data */
 81#define BE_HDR_LEN		((u16) 64)
 82/* allocate extra space to allow tunneling decapsulation without head reallocation */
 83#define BE_RX_SKB_ALLOC_SIZE (BE_HDR_LEN + 64)
 84
 85#define BE_MAX_JUMBO_FRAME_SIZE	9018
 86#define BE_MIN_MTU		256
 87
 88#define BE_NUM_VLANS_SUPPORTED	64
 89#define BE_MAX_EQD		96u
 90#define	BE_MAX_TX_FRAG_COUNT	30
 91
 92#define EVNT_Q_LEN		1024
 93#define TX_Q_LEN		2048
 94#define TX_CQ_LEN		1024
 95#define RX_Q_LEN		1024	/* Does not support any other value */
 96#define RX_CQ_LEN		1024
 97#define MCC_Q_LEN		128	/* total size not to exceed 8 pages */
 98#define MCC_CQ_LEN		256
 99
100#define BE3_MAX_RSS_QS		8
101#define BE2_MAX_RSS_QS		4
102#define MAX_RSS_QS		BE3_MAX_RSS_QS
103#define MAX_RX_QS		(MAX_RSS_QS + 1) /* RSS qs + 1 def Rx */
104
105#define MAX_TX_QS		8
106#define MAX_ROCE_EQS		5
107#define MAX_MSIX_VECTORS	(MAX_RSS_QS + MAX_ROCE_EQS) /* RSS qs + RoCE */
108#define BE_TX_BUDGET		256
109#define BE_NAPI_WEIGHT		64
110#define MAX_RX_POST		BE_NAPI_WEIGHT /* Frags posted at a time */
111#define RX_FRAGS_REFILL_WM	(RX_Q_LEN - MAX_RX_POST)
112
113#define FW_VER_LEN		32
114
115struct be_dma_mem {
116	void *va;
117	dma_addr_t dma;
118	u32 size;
119};
120
121struct be_queue_info {
122	struct be_dma_mem dma_mem;
123	u16 len;
124	u16 entry_size;	/* Size of an element in the queue */
125	u16 id;
126	u16 tail, head;
127	bool created;
128	atomic_t used;	/* Number of valid elements in the queue */
129};
130
131static inline u32 MODULO(u16 val, u16 limit)
132{
133	BUG_ON(limit & (limit - 1));
134	return val & (limit - 1);
135}
136
137static inline void index_adv(u16 *index, u16 val, u16 limit)
138{
139	*index = MODULO((*index + val), limit);
140}
141
142static inline void index_inc(u16 *index, u16 limit)
143{
144	*index = MODULO((*index + 1), limit);
145}
146
147static inline void *queue_head_node(struct be_queue_info *q)
148{
149	return q->dma_mem.va + q->head * q->entry_size;
150}
151
152static inline void *queue_tail_node(struct be_queue_info *q)
153{
154	return q->dma_mem.va + q->tail * q->entry_size;
155}
156
157static inline void *queue_index_node(struct be_queue_info *q, u16 index)
158{
159	return q->dma_mem.va + index * q->entry_size;
160}
161
162static inline void queue_head_inc(struct be_queue_info *q)
163{
164	index_inc(&q->head, q->len);
165}
166
167static inline void index_dec(u16 *index, u16 limit)
168{
169	*index = MODULO((*index - 1), limit);
170}
171
172static inline void queue_tail_inc(struct be_queue_info *q)
173{
174	index_inc(&q->tail, q->len);
175}
176
177struct be_eq_obj {
178	struct be_queue_info q;
179	char desc[32];
180
181	/* Adaptive interrupt coalescing (AIC) info */
182	bool enable_aic;
183	u32 min_eqd;		/* in usecs */
184	u32 max_eqd;		/* in usecs */
185	u32 eqd;		/* configured val when aic is off */
186	u32 cur_eqd;		/* in usecs */
187
188	u8 idx;			/* array index */
189	u16 tx_budget;
190	struct napi_struct napi;
191	struct be_adapter *adapter;
192} ____cacheline_aligned_in_smp;
193
194struct be_mcc_obj {
195	struct be_queue_info q;
196	struct be_queue_info cq;
197	bool rearm_cq;
198};
199
200struct be_tx_stats {
201	u64 tx_bytes;
202	u64 tx_pkts;
203	u64 tx_reqs;
204	u64 tx_wrbs;
205	u64 tx_compl;
206	ulong tx_jiffies;
207	u32 tx_stops;
208	struct u64_stats_sync sync;
209	struct u64_stats_sync sync_compl;
210};
211
212struct be_tx_obj {
213	struct be_queue_info q;
214	struct be_queue_info cq;
215	/* Remember the skbs that were transmitted */
216	struct sk_buff *sent_skb_list[TX_Q_LEN];
217	struct be_tx_stats stats;
218} ____cacheline_aligned_in_smp;
219
220/* Struct to remember the pages posted for rx frags */
221struct be_rx_page_info {
222	struct page *page;
223	DEFINE_DMA_UNMAP_ADDR(bus);
224	u16 page_offset;
225	bool last_page_user;
226};
227
228struct be_rx_stats {
229	u64 rx_bytes;
230	u64 rx_pkts;
231	u64 rx_pkts_prev;
232	ulong rx_jiffies;
233	u32 rx_drops_no_skbs;	/* skb allocation errors */
234	u32 rx_drops_no_frags;	/* HW has no fetched frags */
235	u32 rx_post_fail;	/* page post alloc failures */
236	u32 rx_compl;
237	u32 rx_mcast_pkts;
238	u32 rx_compl_err;	/* completions with err set */
239	u32 rx_pps;		/* pkts per second */
240	struct u64_stats_sync sync;
241};
242
243struct be_rx_compl_info {
244	u32 rss_hash;
245	u16 vlan_tag;
246	u16 pkt_size;
247	u16 rxq_idx;
248	u16 port;
249	u8 vlanf;
250	u8 num_rcvd;
251	u8 err;
252	u8 ipf;
253	u8 tcpf;
254	u8 udpf;
255	u8 ip_csum;
256	u8 l4_csum;
257	u8 ipv6;
258	u8 vtm;
259	u8 pkt_type;
260};
261
262struct be_rx_obj {
263	struct be_adapter *adapter;
264	struct be_queue_info q;
265	struct be_queue_info cq;
266	struct be_rx_compl_info rxcp;
267	struct be_rx_page_info page_info_tbl[RX_Q_LEN];
268	struct be_rx_stats stats;
269	u8 rss_id;
270	bool rx_post_starved;	/* Zero rx frags have been posted to BE */
271} ____cacheline_aligned_in_smp;
272
273struct be_drv_stats {
274	u32 be_on_die_temperature;
275	u32 eth_red_drops;
276	u32 rx_drops_no_pbuf;
277	u32 rx_drops_no_txpb;
278	u32 rx_drops_no_erx_descr;
279	u32 rx_drops_no_tpre_descr;
280	u32 rx_drops_too_many_frags;
281	u32 forwarded_packets;
282	u32 rx_drops_mtu;
283	u32 rx_crc_errors;
284	u32 rx_alignment_symbol_errors;
285	u32 rx_pause_frames;
286	u32 rx_priority_pause_frames;
287	u32 rx_control_frames;
288	u32 rx_in_range_errors;
289	u32 rx_out_range_errors;
290	u32 rx_frame_too_long;
291	u32 rx_address_mismatch_drops;
292	u32 rx_dropped_too_small;
293	u32 rx_dropped_too_short;
294	u32 rx_dropped_header_too_small;
295	u32 rx_dropped_tcp_length;
296	u32 rx_dropped_runt;
297	u32 rx_ip_checksum_errs;
298	u32 rx_tcp_checksum_errs;
299	u32 rx_udp_checksum_errs;
300	u32 tx_pauseframes;
301	u32 tx_priority_pauseframes;
302	u32 tx_controlframes;
303	u32 rxpp_fifo_overflow_drop;
304	u32 rx_input_fifo_overflow_drop;
305	u32 pmem_fifo_overflow_drop;
306	u32 jabber_events;
307};
308
309struct be_vf_cfg {
310	unsigned char mac_addr[ETH_ALEN];
311	int if_handle;
312	int pmac_id;
313	u16 def_vid;
314	u16 vlan_tag;
315	u32 tx_rate;
316};
317
318enum vf_state {
319	ENABLED = 0,
320	ASSIGNED = 1
321};
322
323#define BE_FLAGS_LINK_STATUS_INIT		1
324#define BE_FLAGS_WORKER_SCHEDULED		(1 << 3)
325#define BE_UC_PMAC_COUNT		30
326#define BE_VF_UC_PMAC_COUNT		2
327
328struct phy_info {
329	u8 transceiver;
330	u8 autoneg;
331	u8 fc_autoneg;
332	u8 port_type;
333	u16 phy_type;
334	u16 interface_type;
335	u32 misc_params;
336	u16 auto_speeds_supported;
337	u16 fixed_speeds_supported;
338	int link_speed;
339	int forced_port_speed;
340	u32 dac_cable_len;
341	u32 advertising;
342	u32 supported;
343};
344
345struct be_adapter {
346	struct pci_dev *pdev;
347	struct net_device *netdev;
348
349	u8 __iomem *csr;
350	u8 __iomem *db;		/* Door Bell */
351
352	struct mutex mbox_lock; /* For serializing mbox cmds to BE card */
353	struct be_dma_mem mbox_mem;
354	/* Mbox mem is adjusted to align to 16 bytes. The allocated addr
355	 * is stored for freeing purpose */
356	struct be_dma_mem mbox_mem_alloced;
357
358	struct be_mcc_obj mcc_obj;
359	spinlock_t mcc_lock;	/* For serializing mcc cmds to BE card */
360	spinlock_t mcc_cq_lock;
361
362	u32 num_msix_vec;
363	u32 num_evt_qs;
364	struct be_eq_obj eq_obj[MAX_MSIX_VECTORS];
365	struct msix_entry msix_entries[MAX_MSIX_VECTORS];
366	bool isr_registered;
367
368	/* TX Rings */
369	u32 num_tx_qs;
370	struct be_tx_obj tx_obj[MAX_TX_QS];
371
372	/* Rx rings */
373	u32 num_rx_qs;
374	struct be_rx_obj rx_obj[MAX_RX_QS];
375	u32 big_page_size;	/* Compounded page size shared by rx wrbs */
376
377	u8 eq_next_idx;
378	struct be_drv_stats drv_stats;
379
380	u16 vlans_added;
381	u16 max_vlans;	/* Number of vlans supported */
382	u8 vlan_tag[VLAN_N_VID];
383	u8 vlan_prio_bmap;	/* Available Priority BitMap */
384	u16 recommended_prio;	/* Recommended Priority */
385	struct be_dma_mem rx_filter; /* Cmd DMA mem for rx-filter */
386
387	struct be_dma_mem stats_cmd;
388	/* Work queue used to perform periodic tasks like getting statistics */
389	struct delayed_work work;
390	u16 work_counter;
391
392	u32 flags;
393	/* Ethtool knobs and info */
394	char fw_ver[FW_VER_LEN];
395	int if_handle;		/* Used to configure filtering */
396	u32 *pmac_id;		/* MAC addr handle used by BE card */
397	u32 beacon_state;	/* for set_phys_id */
398
399	bool eeh_err;
400	bool ue_detected;
401	bool fw_timeout;
402	u32 port_num;
403	bool promiscuous;
404	u32 function_mode;
405	u32 function_caps;
406	u32 rx_fc;		/* Rx flow control */
407	u32 tx_fc;		/* Tx flow control */
408	bool stats_cmd_sent;
409	u8 generation;		/* BladeEngine ASIC generation */
410	u32 if_type;
411	struct {
412		u8 __iomem *base;	/* Door Bell */
413		u32 size;
414		u32 total_size;
415		u64 io_addr;
416	} roce_db;
417	u32 num_msix_roce_vec;
418	struct ocrdma_dev *ocrdma_dev;
419	struct list_head entry;
420
421	u32 flash_status;
422	struct completion flash_compl;
423
424	u32 num_vfs;		/* Number of VFs provisioned by PF driver */
425	u32 dev_num_vfs;	/* Number of VFs supported by HW */
426	u8 virtfn;
427	struct be_vf_cfg *vf_cfg;
428	bool be3_native;
429	u32 sli_family;
430	u8 hba_port_num;
431	u16 pvid;
432	struct phy_info phy;
433	u8 wol_cap;
434	bool wol;
435	u32 max_pmac_cnt;	/* Max secondary UC MACs programmable */
436	u32 uc_macs;		/* Count of secondary UC MAC programmed */
437	u32 msg_enable;
438};
439
440#define be_physfn(adapter)		(!adapter->virtfn)
441#define	sriov_enabled(adapter)		(adapter->num_vfs > 0)
442#define	sriov_want(adapter)		(adapter->dev_num_vfs && num_vfs && \
443					 be_physfn(adapter))
444#define for_all_vfs(adapter, vf_cfg, i)					\
445	for (i = 0, vf_cfg = &adapter->vf_cfg[i]; i < adapter->num_vfs;	\
446		i++, vf_cfg++)
447
448/* BladeEngine Generation numbers */
449#define BE_GEN2 2
450#define BE_GEN3 3
451
452#define ON				1
453#define OFF				0
454#define lancer_chip(adapter)	((adapter->pdev->device == OC_DEVICE_ID3) || \
455				 (adapter->pdev->device == OC_DEVICE_ID4))
456
457#define be_roce_supported(adapter) ((adapter->if_type == SLI_INTF_TYPE_3 || \
458				adapter->sli_family == SKYHAWK_SLI_FAMILY) && \
459				(adapter->function_mode & RDMA_ENABLED))
460
461extern const struct ethtool_ops be_ethtool_ops;
462
463#define msix_enabled(adapter)		(adapter->num_msix_vec > 0)
464#define num_irqs(adapter)		(msix_enabled(adapter) ?	\
465						adapter->num_msix_vec : 1)
466#define tx_stats(txo)			(&(txo)->stats)
467#define rx_stats(rxo)			(&(rxo)->stats)
468
469/* The default RXQ is the last RXQ */
470#define default_rxo(adpt)		(&adpt->rx_obj[adpt->num_rx_qs - 1])
471
472#define for_all_rx_queues(adapter, rxo, i)				\
473	for (i = 0, rxo = &adapter->rx_obj[i]; i < adapter->num_rx_qs;	\
474		i++, rxo++)
475
476/* Skip the default non-rss queue (last one)*/
477#define for_all_rss_queues(adapter, rxo, i)				\
478	for (i = 0, rxo = &adapter->rx_obj[i]; i < (adapter->num_rx_qs - 1);\
479		i++, rxo++)
480
481#define for_all_tx_queues(adapter, txo, i)				\
482	for (i = 0, txo = &adapter->tx_obj[i]; i < adapter->num_tx_qs;	\
483		i++, txo++)
484
485#define for_all_evt_queues(adapter, eqo, i)				\
486	for (i = 0, eqo = &adapter->eq_obj[i]; i < adapter->num_evt_qs; \
487		i++, eqo++)
488
489#define is_mcc_eqo(eqo)			(eqo->idx == 0)
490#define mcc_eqo(adapter)		(&adapter->eq_obj[0])
491
492#define PAGE_SHIFT_4K		12
493#define PAGE_SIZE_4K		(1 << PAGE_SHIFT_4K)
494
495/* Returns number of pages spanned by the data starting at the given addr */
496#define PAGES_4K_SPANNED(_address, size) 				\
497		((u32)((((size_t)(_address) & (PAGE_SIZE_4K - 1)) + 	\
498			(size) + (PAGE_SIZE_4K - 1)) >> PAGE_SHIFT_4K))
499
500/* Returns bit offset within a DWORD of a bitfield */
501#define AMAP_BIT_OFFSET(_struct, field)  				\
502		(((size_t)&(((_struct *)0)->field))%32)
503
504/* Returns the bit mask of the field that is NOT shifted into location. */
505static inline u32 amap_mask(u32 bitsize)
506{
507	return (bitsize == 32 ? 0xFFFFFFFF : (1 << bitsize) - 1);
508}
509
510static inline void
511amap_set(void *ptr, u32 dw_offset, u32 mask, u32 offset, u32 value)
512{
513	u32 *dw = (u32 *) ptr + dw_offset;
514	*dw &= ~(mask << offset);
515	*dw |= (mask & value) << offset;
516}
517
518#define AMAP_SET_BITS(_struct, field, ptr, val)				\
519		amap_set(ptr,						\
520			offsetof(_struct, field)/32,			\
521			amap_mask(sizeof(((_struct *)0)->field)),	\
522			AMAP_BIT_OFFSET(_struct, field),		\
523			val)
524
525static inline u32 amap_get(void *ptr, u32 dw_offset, u32 mask, u32 offset)
526{
527	u32 *dw = (u32 *) ptr;
528	return mask & (*(dw + dw_offset) >> offset);
529}
530
531#define AMAP_GET_BITS(_struct, field, ptr)				\
532		amap_get(ptr,						\
533			offsetof(_struct, field)/32,			\
534			amap_mask(sizeof(((_struct *)0)->field)),	\
535			AMAP_BIT_OFFSET(_struct, field))
536
537#define be_dws_cpu_to_le(wrb, len)	swap_dws(wrb, len)
538#define be_dws_le_to_cpu(wrb, len)	swap_dws(wrb, len)
539static inline void swap_dws(void *wrb, int len)
540{
541#ifdef __BIG_ENDIAN
542	u32 *dw = wrb;
543	BUG_ON(len % 4);
544	do {
545		*dw = cpu_to_le32(*dw);
546		dw++;
547		len -= 4;
548	} while (len);
549#endif				/* __BIG_ENDIAN */
550}
551
552static inline u8 is_tcp_pkt(struct sk_buff *skb)
553{
554	u8 val = 0;
555
556	if (ip_hdr(skb)->version == 4)
557		val = (ip_hdr(skb)->protocol == IPPROTO_TCP);
558	else if (ip_hdr(skb)->version == 6)
559		val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_TCP);
560
561	return val;
562}
563
564static inline u8 is_udp_pkt(struct sk_buff *skb)
565{
566	u8 val = 0;
567
568	if (ip_hdr(skb)->version == 4)
569		val = (ip_hdr(skb)->protocol == IPPROTO_UDP);
570	else if (ip_hdr(skb)->version == 6)
571		val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_UDP);
572
573	return val;
574}
575
576static inline void be_vf_eth_addr_generate(struct be_adapter *adapter, u8 *mac)
577{
578	u32 addr;
579
580	addr = jhash(adapter->netdev->dev_addr, ETH_ALEN, 0);
581
582	mac[5] = (u8)(addr & 0xFF);
583	mac[4] = (u8)((addr >> 8) & 0xFF);
584	mac[3] = (u8)((addr >> 16) & 0xFF);
585	/* Use the OUI from the current MAC address */
586	memcpy(mac, adapter->netdev->dev_addr, 3);
587}
588
589static inline bool be_multi_rxq(const struct be_adapter *adapter)
590{
591	return adapter->num_rx_qs > 1;
592}
593
594static inline bool be_error(struct be_adapter *adapter)
595{
596	return adapter->eeh_err || adapter->ue_detected || adapter->fw_timeout;
597}
598
599static inline bool be_is_wol_excluded(struct be_adapter *adapter)
600{
601	struct pci_dev *pdev = adapter->pdev;
602
603	if (!be_physfn(adapter))
604		return true;
605
606	switch (pdev->subsystem_device) {
607	case OC_SUBSYS_DEVICE_ID1:
608	case OC_SUBSYS_DEVICE_ID2:
609	case OC_SUBSYS_DEVICE_ID3:
610	case OC_SUBSYS_DEVICE_ID4:
611		return true;
612	default:
613		return false;
614	}
615}
616
617static inline bool be_type_2_3(struct be_adapter *adapter)
618{
619	return (adapter->if_type == SLI_INTF_TYPE_2 ||
620		adapter->if_type == SLI_INTF_TYPE_3) ? true : false;
621}
622
623extern void be_cq_notify(struct be_adapter *adapter, u16 qid, bool arm,
624		u16 num_popped);
625extern void be_link_status_update(struct be_adapter *adapter, u8 link_status);
626extern void be_parse_stats(struct be_adapter *adapter);
627extern int be_load_fw(struct be_adapter *adapter, u8 *func);
628extern bool be_is_wol_supported(struct be_adapter *adapter);
629extern bool be_pause_supported(struct be_adapter *adapter);
630extern u32 be_get_fw_log_level(struct be_adapter *adapter);
631
632/*
633 * internal function to initialize-cleanup roce device.
634 */
635extern void be_roce_dev_add(struct be_adapter *);
636extern void be_roce_dev_remove(struct be_adapter *);
637
638/*
639 * internal function to open-close roce device during ifup-ifdown.
640 */
641extern void be_roce_dev_open(struct be_adapter *);
642extern void be_roce_dev_close(struct be_adapter *);
643
644#endif				/* BE_H */