1/*	$NetBSD: if_vtevar.h,v 1.2 2011/11/19 22:51:23 tls Exp $	*/
2
3/*-
4 * Copyright (c) 2010, Pyun YongHyeon <yongari@FreeBSD.org>
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice unmodified, this list of conditions, and the following
12 *    disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * FreeBSD: src/sys/dev/vte/if_vtevar.h,v 1.1 2010/12/31 00:21:41 yongari Exp
30 */
31
32#ifndef	_IF_VTEVAR_H
33#define	_IF_VTEVAR_H
34
35#define	VTE_TX_RING_CNT		64
36#define	VTE_TX_RING_ALIGN	16
37/*
38 * The TX/RX descriptor format has no limitation for number of
39 * descriptors in TX/RX ring.  However, the maximum number of
40 * descriptors that could be set as RX descriptor ring residue
41 * counter is 255.  This effectively limits number of RX
42 * descriptors available to be less than or equal to 255.
43 */
44#define	VTE_RX_RING_CNT		128
45#define	VTE_RX_RING_ALIGN	16
46#define	VTE_RX_BUF_ALIGN	4
47
48#define	VTE_DESC_INC(x, y)	((x) = ((x) + 1) % (y))
49
50#define	VTE_TX_RING_SZ		\
51	(sizeof(struct vte_tx_desc) * VTE_TX_RING_CNT)
52#define	VTE_RX_RING_SZ		\
53	(sizeof(struct vte_rx_desc) * VTE_RX_RING_CNT)
54
55#define	VTE_RX_BUF_SIZE_MAX	(MCLBYTES - sizeof(uint32_t))
56
57#define	VTE_MIN_FRAMELEN	(ETHER_MIN_LEN - ETHER_CRC_LEN)
58
59struct vte_rxdesc {
60	struct mbuf		*rx_m;
61	bus_dma_segment_t	rx_seg;
62	bus_dmamap_t		rx_dmamap;
63	struct vte_rx_desc	*rx_desc;
64};
65
66struct vte_txdesc {
67	struct mbuf		*tx_m;
68	bus_dma_segment_t	*tx_seg;
69	bus_dmamap_t		tx_dmamap;
70	struct vte_tx_desc	*tx_desc;
71	int			tx_flags;
72#define	VTE_TXMBUF		0x0001
73};
74
75struct vte_chain_data {
76	struct vte_txdesc	vte_txdesc[VTE_TX_RING_CNT];
77	struct mbuf		*vte_txmbufs[VTE_TX_RING_CNT];
78	struct vte_rxdesc	vte_rxdesc[VTE_RX_RING_CNT];
79	bus_dmamap_t		vte_tx_ring_map;
80	bus_dma_segment_t	vte_tx_ring_seg[1];
81	bus_dmamap_t		vte_rx_ring_map;
82	bus_dma_segment_t	vte_rx_ring_seg[1];
83	bus_dmamap_t		vte_rr_ring_map;
84	bus_dma_segment_t	vte_rr_ring_seg[1];
85	bus_dmamap_t		vte_rx_sparemap;
86	bus_dmamap_t		vte_cmb_map;
87	bus_dmamap_t		vte_smb_map;
88	struct vte_tx_desc	*vte_tx_ring;
89	struct vte_rx_desc	*vte_rx_ring;
90
91	int			vte_tx_prod;
92	int			vte_tx_cons;
93	int			vte_tx_cnt;
94	int			vte_rx_cons;
95};
96
97struct vte_hw_stats {
98	/* RX stats. */
99	uint32_t rx_frames;
100	uint32_t rx_bcast_frames;
101	uint32_t rx_mcast_frames;
102	uint32_t rx_runts;
103	uint32_t rx_crcerrs;
104	uint32_t rx_long_frames;
105	uint32_t rx_fifo_full;
106	uint32_t rx_desc_unavail;
107	uint32_t rx_pause_frames;
108
109	/* TX stats. */
110	uint32_t tx_frames;
111	uint32_t tx_underruns;
112	uint32_t tx_late_colls;
113	uint32_t tx_pause_frames;
114};
115
116/*
117 * Software state per device.
118 */
119struct vte_softc {
120	device_t		vte_dev;
121	bus_space_tag_t		vte_bustag;
122	bus_space_handle_t	vte_bushandle;
123	bus_dma_tag_t		vte_dmatag;
124	void*			vte_ih;
125	struct ethercom		vte_ec;
126	mii_data_t		vte_mii;
127	device_t		vte_miibus;
128	uint8_t			vte_eaddr[ETHER_ADDR_LEN];
129	int			vte_flags;
130#define	VTE_FLAG_LINK		0x8000
131
132	struct callout		vte_tick_ch;
133	struct vte_hw_stats	vte_stats;
134	struct vte_chain_data	vte_cdata;
135	int			vte_if_flags;
136	int			vte_watchdog_timer;
137	struct sysctllog	*vte_clog;
138	int			vte_int_rx_mod;
139	int			vte_int_tx_mod;
140
141	krndsource_t	rnd_source;
142};
143
144#define vte_if	vte_ec.ec_if
145#define vte_bpf	vte_if.if_bpf
146
147/* Register access macros. */
148#define	CSR_WRITE_2(_sc, reg, val)	\
149	bus_space_write_2((_sc)->vte_bustag,  (_sc)->vte_bushandle, \
150	(reg), (val))
151#define	CSR_READ_2(_sc, reg)		\
152	bus_space_read_2((_sc)->vte_bustag,  (_sc)->vte_bushandle, (reg))
153
154#define	VTE_TX_TIMEOUT		5
155#define	VTE_RESET_TIMEOUT	100
156#define	VTE_TIMEOUT		1000
157#define	VTE_PHY_TIMEOUT		1000
158
159#endif	/* _IF_VTEVAR_H */
160