if_alcvar.h revision 211053
1/*-
2 * Copyright (c) 2009, Pyun YongHyeon <yongari@FreeBSD.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice unmodified, this list of conditions, and the following
10 *    disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 *
27 * $FreeBSD: head/sys/dev/alc/if_alcvar.h 211053 2010-08-08 00:43:41Z yongari $
28 */
29
30#ifndef	_IF_ALCVAR_H
31#define	_IF_ALCVAR_H
32
33#define	ALC_TX_RING_CNT		256
34#define	ALC_TX_RING_ALIGN	sizeof(struct tx_desc)
35#define	ALC_RX_RING_CNT		256
36#define	ALC_RX_RING_ALIGN	sizeof(struct rx_desc)
37#define	ALC_RX_BUF_ALIGN	4
38#define	ALC_RR_RING_CNT		ALC_RX_RING_CNT
39#define	ALC_RR_RING_ALIGN	sizeof(struct rx_rdesc)
40#define	ALC_CMB_ALIGN		8
41#define	ALC_SMB_ALIGN		8
42
43#define	ALC_TSO_MAXSEGSIZE	4096
44#define	ALC_TSO_MAXSIZE		(65535 + sizeof(struct ether_vlan_header))
45#define	ALC_MAXTXSEGS		32
46
47#define	ALC_ADDR_LO(x)		((uint64_t) (x) & 0xFFFFFFFF)
48#define	ALC_ADDR_HI(x)		((uint64_t) (x) >> 32)
49
50#define	ALC_DESC_INC(x, y)	((x) = ((x) + 1) % (y))
51
52/* Water mark to kick reclaiming Tx buffers. */
53#define	ALC_TX_DESC_HIWAT	((ALC_TX_RING_CNT * 6) / 10)
54
55#define	ALC_MSI_MESSAGES	1
56#define	ALC_MSIX_MESSAGES	1
57
58#define	ALC_TX_RING_SZ		\
59	(sizeof(struct tx_desc) * ALC_TX_RING_CNT)
60#define	ALC_RX_RING_SZ		\
61	(sizeof(struct rx_desc) * ALC_RX_RING_CNT)
62#define	ALC_RR_RING_SZ		\
63	(sizeof(struct rx_rdesc) * ALC_RR_RING_CNT)
64#define	ALC_CMB_SZ		(sizeof(struct cmb))
65#define	ALC_SMB_SZ		(sizeof(struct smb))
66
67#define	ALC_PROC_MIN		16
68#define	ALC_PROC_MAX		(ALC_RX_RING_CNT - 1)
69#define	ALC_PROC_DEFAULT	(ALC_RX_RING_CNT / 4)
70
71#define	ALC_JUMBO_FRAMELEN	(9 * 1024)
72#define	ALC_JUMBO_MTU		\
73	(ALC_JUMBO_FRAMELEN - sizeof(struct ether_vlan_header) - ETHER_CRC_LEN)
74#define	ALC_MAX_FRAMELEN	(ETHER_MAX_LEN + ETHER_VLAN_ENCAP_LEN)
75
76/*
77 * The number of bits reserved for MSS in AR8121/AR8132 controllers
78 * are 13 bits. This limits the maximum interface MTU size in TSO
79 * case(8191 + sizeof(struct ip) + sizeof(struct tcphdr)) as upper
80 * stack should not generate TCP segments with MSS greater than the
81 * limit. Also Atheros says that maximum MTU for TSO is 6KB.
82 */
83#define	ALC_TSO_MTU		(6 * 1024)
84
85struct alc_rxdesc {
86	struct mbuf		*rx_m;
87	bus_dmamap_t		rx_dmamap;
88	struct rx_desc		*rx_desc;
89};
90
91struct alc_txdesc {
92	struct mbuf		*tx_m;
93	bus_dmamap_t		tx_dmamap;
94};
95
96struct alc_ring_data {
97	struct tx_desc		*alc_tx_ring;
98	bus_addr_t		alc_tx_ring_paddr;
99	struct rx_desc		*alc_rx_ring;
100	bus_addr_t		alc_rx_ring_paddr;
101	struct rx_rdesc		*alc_rr_ring;
102	bus_addr_t		alc_rr_ring_paddr;
103	struct cmb		*alc_cmb;
104	bus_addr_t		alc_cmb_paddr;
105	struct smb		*alc_smb;
106	bus_addr_t		alc_smb_paddr;
107};
108
109struct alc_chain_data {
110	bus_dma_tag_t		alc_parent_tag;
111	bus_dma_tag_t		alc_buffer_tag;
112	bus_dma_tag_t		alc_tx_tag;
113	struct alc_txdesc	alc_txdesc[ALC_TX_RING_CNT];
114	bus_dma_tag_t		alc_rx_tag;
115	struct alc_rxdesc	alc_rxdesc[ALC_RX_RING_CNT];
116	bus_dma_tag_t		alc_tx_ring_tag;
117	bus_dmamap_t		alc_tx_ring_map;
118	bus_dma_tag_t		alc_rx_ring_tag;
119	bus_dmamap_t		alc_rx_ring_map;
120	bus_dma_tag_t		alc_rr_ring_tag;
121	bus_dmamap_t		alc_rr_ring_map;
122	bus_dmamap_t		alc_rx_sparemap;
123	bus_dma_tag_t		alc_cmb_tag;
124	bus_dmamap_t		alc_cmb_map;
125	bus_dma_tag_t		alc_smb_tag;
126	bus_dmamap_t		alc_smb_map;
127
128	int			alc_tx_prod;
129	int			alc_tx_cons;
130	int			alc_tx_cnt;
131	int			alc_rx_cons;
132	int			alc_rr_cons;
133	int			alc_rxlen;
134
135	struct mbuf		*alc_rxhead;
136	struct mbuf		*alc_rxtail;
137	struct mbuf		*alc_rxprev_tail;
138};
139
140struct alc_hw_stats {
141	/* Rx stats. */
142	uint32_t rx_frames;
143	uint32_t rx_bcast_frames;
144	uint32_t rx_mcast_frames;
145	uint32_t rx_pause_frames;
146	uint32_t rx_control_frames;
147	uint32_t rx_crcerrs;
148	uint32_t rx_lenerrs;
149	uint64_t rx_bytes;
150	uint32_t rx_runts;
151	uint32_t rx_fragments;
152	uint32_t rx_pkts_64;
153	uint32_t rx_pkts_65_127;
154	uint32_t rx_pkts_128_255;
155	uint32_t rx_pkts_256_511;
156	uint32_t rx_pkts_512_1023;
157	uint32_t rx_pkts_1024_1518;
158	uint32_t rx_pkts_1519_max;
159	uint32_t rx_pkts_truncated;
160	uint32_t rx_fifo_oflows;
161	uint32_t rx_rrs_errs;
162	uint32_t rx_alignerrs;
163	uint64_t rx_bcast_bytes;
164	uint64_t rx_mcast_bytes;
165	uint32_t rx_pkts_filtered;
166	/* Tx stats. */
167	uint32_t tx_frames;
168	uint32_t tx_bcast_frames;
169	uint32_t tx_mcast_frames;
170	uint32_t tx_pause_frames;
171	uint32_t tx_excess_defer;
172	uint32_t tx_control_frames;
173	uint32_t tx_deferred;
174	uint64_t tx_bytes;
175	uint32_t tx_pkts_64;
176	uint32_t tx_pkts_65_127;
177	uint32_t tx_pkts_128_255;
178	uint32_t tx_pkts_256_511;
179	uint32_t tx_pkts_512_1023;
180	uint32_t tx_pkts_1024_1518;
181	uint32_t tx_pkts_1519_max;
182	uint32_t tx_single_colls;
183	uint32_t tx_multi_colls;
184	uint32_t tx_late_colls;
185	uint32_t tx_excess_colls;
186	uint32_t tx_abort;
187	uint32_t tx_underrun;
188	uint32_t tx_desc_underrun;
189	uint32_t tx_lenerrs;
190	uint32_t tx_pkts_truncated;
191	uint64_t tx_bcast_bytes;
192	uint64_t tx_mcast_bytes;
193};
194
195/*
196 * Software state per device.
197 */
198struct alc_softc {
199	struct ifnet 		*alc_ifp;
200	device_t		alc_dev;
201	device_t		alc_miibus;
202	struct resource		*alc_res[1];
203	struct resource_spec	*alc_res_spec;
204	struct resource		*alc_irq[ALC_MSI_MESSAGES];
205	struct resource_spec	*alc_irq_spec;
206	void			*alc_intrhand[ALC_MSI_MESSAGES];
207	int			alc_rev;
208	int			alc_chip_rev;
209	int			alc_phyaddr;
210	uint8_t			alc_eaddr[ETHER_ADDR_LEN];
211	uint32_t		alc_dma_rd_burst;
212	uint32_t		alc_dma_wr_burst;
213	uint32_t		alc_rcb;
214	int			alc_expcap;
215	int			alc_pmcap;
216	int			alc_flags;
217#define	ALC_FLAG_PCIE		0x0001
218#define	ALC_FLAG_PCIX		0x0002
219#define	ALC_FLAG_MSI		0x0004
220#define	ALC_FLAG_MSIX		0x0008
221#define	ALC_FLAG_PM		0x0010
222#define	ALC_FLAG_FASTETHER	0x0020
223#define	ALC_FLAG_JUMBO		0x0040
224#define	ALC_FLAG_ASPM_MON	0x0080
225#define	ALC_FLAG_CMB_BUG	0x0100
226#define	ALC_FLAG_SMB_BUG	0x0200
227#define	ALC_FLAG_DETACH		0x4000
228#define	ALC_FLAG_LINK		0x8000
229
230	struct callout		alc_tick_ch;
231	struct alc_hw_stats	alc_stats;
232	struct alc_chain_data	alc_cdata;
233	struct alc_ring_data	alc_rdata;
234	int			alc_if_flags;
235	int			alc_watchdog_timer;
236	int			alc_process_limit;
237	volatile int		alc_morework;
238	int			alc_int_rx_mod;
239	int			alc_int_tx_mod;
240	int			alc_buf_size;
241
242	struct task		alc_int_task;
243	struct task		alc_tx_task;
244	struct taskqueue	*alc_tq;
245	struct mtx		alc_mtx;
246};
247
248/* Register access macros. */
249#define	CSR_WRITE_4(_sc, reg, val)	\
250	bus_write_4((_sc)->alc_res[0], (reg), (val))
251#define	CSR_WRITE_2(_sc, reg, val)	\
252	bus_write_2((_sc)->alc_res[0], (reg), (val))
253#define	CSR_WRITE_1(_sc, reg, val)	\
254	bus_write_1((_sc)->alc_res[0], (reg), (val))
255#define	CSR_READ_2(_sc, reg)		\
256	bus_read_2((_sc)->alc_res[0], (reg))
257#define	CSR_READ_4(_sc, reg)		\
258	bus_read_4((_sc)->alc_res[0], (reg))
259
260#define	ALC_RXCHAIN_RESET(_sc)						\
261do {									\
262	(_sc)->alc_cdata.alc_rxhead = NULL;				\
263	(_sc)->alc_cdata.alc_rxtail = NULL;				\
264	(_sc)->alc_cdata.alc_rxprev_tail = NULL;			\
265	(_sc)->alc_cdata.alc_rxlen = 0;					\
266} while (0)
267
268#define	ALC_LOCK(_sc)		mtx_lock(&(_sc)->alc_mtx)
269#define	ALC_UNLOCK(_sc)		mtx_unlock(&(_sc)->alc_mtx)
270#define	ALC_LOCK_ASSERT(_sc)	mtx_assert(&(_sc)->alc_mtx, MA_OWNED)
271
272#define	ALC_TX_TIMEOUT		5
273#define	ALC_RESET_TIMEOUT	100
274#define	ALC_TIMEOUT		1000
275#define	ALC_PHY_TIMEOUT		1000
276
277#endif	/* _IF_ALCVAR_H */
278