xref: /OK3568_Linux_fs/kernel/drivers/net/ethernet/atheros/alx/alx.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright (c) 2013 Johannes Berg <johannes@sipsolutions.net>
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  *  This file is free software: you may copy, redistribute and/or modify it
5*4882a593Smuzhiyun  *  under the terms of the GNU General Public License as published by the
6*4882a593Smuzhiyun  *  Free Software Foundation, either version 2 of the License, or (at your
7*4882a593Smuzhiyun  *  option) any later version.
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  *  This file is distributed in the hope that it will be useful, but
10*4882a593Smuzhiyun  *  WITHOUT ANY WARRANTY; without even the implied warranty of
11*4882a593Smuzhiyun  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12*4882a593Smuzhiyun  *  General Public License for more details.
13*4882a593Smuzhiyun  *
14*4882a593Smuzhiyun  *  You should have received a copy of the GNU General Public License
15*4882a593Smuzhiyun  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
16*4882a593Smuzhiyun  *
17*4882a593Smuzhiyun  * This file incorporates work covered by the following copyright and
18*4882a593Smuzhiyun  * permission notice:
19*4882a593Smuzhiyun  *
20*4882a593Smuzhiyun  * Copyright (c) 2012 Qualcomm Atheros, Inc.
21*4882a593Smuzhiyun  *
22*4882a593Smuzhiyun  * Permission to use, copy, modify, and/or distribute this software for any
23*4882a593Smuzhiyun  * purpose with or without fee is hereby granted, provided that the above
24*4882a593Smuzhiyun  * copyright notice and this permission notice appear in all copies.
25*4882a593Smuzhiyun  *
26*4882a593Smuzhiyun  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
27*4882a593Smuzhiyun  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
28*4882a593Smuzhiyun  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
29*4882a593Smuzhiyun  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
30*4882a593Smuzhiyun  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
31*4882a593Smuzhiyun  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
32*4882a593Smuzhiyun  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
33*4882a593Smuzhiyun  */
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun #ifndef _ALX_H_
36*4882a593Smuzhiyun #define _ALX_H_
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun #include <linux/types.h>
39*4882a593Smuzhiyun #include <linux/etherdevice.h>
40*4882a593Smuzhiyun #include <linux/dma-mapping.h>
41*4882a593Smuzhiyun #include <linux/spinlock.h>
42*4882a593Smuzhiyun #include "hw.h"
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun #define ALX_WATCHDOG_TIME   (5 * HZ)
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun struct alx_buffer {
47*4882a593Smuzhiyun 	struct sk_buff *skb;
48*4882a593Smuzhiyun 	DEFINE_DMA_UNMAP_ADDR(dma);
49*4882a593Smuzhiyun 	DEFINE_DMA_UNMAP_LEN(size);
50*4882a593Smuzhiyun };
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun struct alx_rx_queue {
53*4882a593Smuzhiyun 	struct net_device *netdev;
54*4882a593Smuzhiyun 	struct device *dev;
55*4882a593Smuzhiyun 	struct alx_napi *np;
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun 	struct alx_rrd *rrd;
58*4882a593Smuzhiyun 	dma_addr_t rrd_dma;
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun 	struct alx_rfd *rfd;
61*4882a593Smuzhiyun 	dma_addr_t rfd_dma;
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun 	struct alx_buffer *bufs;
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	u16 count;
66*4882a593Smuzhiyun 	u16 write_idx, read_idx;
67*4882a593Smuzhiyun 	u16 rrd_read_idx;
68*4882a593Smuzhiyun 	u16 queue_idx;
69*4882a593Smuzhiyun };
70*4882a593Smuzhiyun #define ALX_RX_ALLOC_THRESH	32
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun struct alx_tx_queue {
73*4882a593Smuzhiyun 	struct net_device *netdev;
74*4882a593Smuzhiyun 	struct device *dev;
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun 	struct alx_txd *tpd;
77*4882a593Smuzhiyun 	dma_addr_t tpd_dma;
78*4882a593Smuzhiyun 
79*4882a593Smuzhiyun 	struct alx_buffer *bufs;
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 	u16 count;
82*4882a593Smuzhiyun 	u16 write_idx, read_idx;
83*4882a593Smuzhiyun 	u16 queue_idx;
84*4882a593Smuzhiyun 	u16 p_reg, c_reg;
85*4882a593Smuzhiyun };
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun #define ALX_DEFAULT_TX_WORK 128
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun enum alx_device_quirks {
90*4882a593Smuzhiyun 	ALX_DEV_QUIRK_MSI_INTX_DISABLE_BUG = BIT(0),
91*4882a593Smuzhiyun };
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun struct alx_napi {
94*4882a593Smuzhiyun 	struct napi_struct	napi;
95*4882a593Smuzhiyun 	struct alx_priv		*alx;
96*4882a593Smuzhiyun 	struct alx_rx_queue	*rxq;
97*4882a593Smuzhiyun 	struct alx_tx_queue	*txq;
98*4882a593Smuzhiyun 	int			vec_idx;
99*4882a593Smuzhiyun 	u32			vec_mask;
100*4882a593Smuzhiyun 	char			irq_lbl[IFNAMSIZ + 8];
101*4882a593Smuzhiyun };
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun #define ALX_MAX_NAPIS 8
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun struct alx_priv {
106*4882a593Smuzhiyun 	struct net_device *dev;
107*4882a593Smuzhiyun 
108*4882a593Smuzhiyun 	struct alx_hw hw;
109*4882a593Smuzhiyun 
110*4882a593Smuzhiyun 	/* msi-x vectors */
111*4882a593Smuzhiyun 	int num_vec;
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun 	/* all descriptor memory */
114*4882a593Smuzhiyun 	struct {
115*4882a593Smuzhiyun 		dma_addr_t dma;
116*4882a593Smuzhiyun 		void *virt;
117*4882a593Smuzhiyun 		unsigned int size;
118*4882a593Smuzhiyun 	} descmem;
119*4882a593Smuzhiyun 
120*4882a593Smuzhiyun 	struct alx_napi *qnapi[ALX_MAX_NAPIS];
121*4882a593Smuzhiyun 	int num_txq;
122*4882a593Smuzhiyun 	int num_rxq;
123*4882a593Smuzhiyun 	int num_napi;
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun 	/* protect int_mask updates */
126*4882a593Smuzhiyun 	spinlock_t irq_lock;
127*4882a593Smuzhiyun 	u32 int_mask;
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun 	unsigned int tx_ringsz;
130*4882a593Smuzhiyun 	unsigned int rx_ringsz;
131*4882a593Smuzhiyun 	unsigned int rxbuf_size;
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	struct work_struct link_check_wk;
134*4882a593Smuzhiyun 	struct work_struct reset_wk;
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun 	u16 msg_enable;
137*4882a593Smuzhiyun 
138*4882a593Smuzhiyun 	/* protects hw.stats */
139*4882a593Smuzhiyun 	spinlock_t stats_lock;
140*4882a593Smuzhiyun };
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun extern const struct ethtool_ops alx_ethtool_ops;
143*4882a593Smuzhiyun 
144*4882a593Smuzhiyun #endif
145