xref: /freebsd/sys/dev/dwc/if_dwcvar.h (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*-
2  * Copyright (c) 2014 Ruslan Bukin <br@bsdpad.com>
3  * All rights reserved.
4  *
5  * This software was developed by SRI International and the University of
6  * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
7  * ("CTSRD"), as part of the DARPA CRASH research programme.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30 
31 /*
32  * Ethernet media access controller (EMAC)
33  * Chapter 17, Altera Cyclone V Device Handbook (CV-5V2 2014.07.22)
34  *
35  * EMAC is an instance of the Synopsys DesignWare 3504-0
36  * Universal 10/100/1000 Ethernet MAC (DWC_gmac).
37  */
38 
39 #ifndef	__IF_DWCVAR_H__
40 #define	__IF_DWCVAR_H__
41 
42 /*
43  * Driver data and defines.
44  */
45 #define	RX_DESC_COUNT	1024
46 #define	RX_DESC_SIZE	(sizeof(struct dwc_hwdesc) * RX_DESC_COUNT)
47 #define	TX_DESC_COUNT	1024
48 #define	TX_MAP_COUNT	TX_DESC_COUNT
49 #define	TX_DESC_SIZE	(sizeof(struct dwc_hwdesc) * TX_DESC_COUNT)
50 #define	TX_MAP_MAX_SEGS	32
51 
52 struct dwc_bufmap {
53 	bus_dmamap_t		map;
54 	struct mbuf		*mbuf;
55 	/* Only used for TX descirptors */
56 	int			last_desc_idx;
57 };
58 
59 struct dwc_softc {
60 	struct resource		*res[2];
61 	device_t		dev;
62 	int			mactype;
63 	int			mii_clk;
64 	device_t		miibus;
65 	struct mii_data *	mii_softc;
66 	if_t			ifp;
67 	int			if_flags;
68 	struct mtx		mtx;
69 	void *			intr_cookie;
70 	struct callout		dwc_callout;
71 	bool			link_is_up;
72 	bool			is_attached;
73 	bool			is_detaching;
74 	int			tx_watchdog_count;
75 	int			stats_harvest_count;
76 	int			phy_mode;
77 
78 	/* RX */
79 	bus_dma_tag_t		rxdesc_tag;
80 	bus_dmamap_t		rxdesc_map;
81 	struct dwc_hwdesc	*rxdesc_ring;
82 	bus_addr_t		rxdesc_ring_paddr;
83 	bus_dma_tag_t		rxbuf_tag;
84 	struct dwc_bufmap	rxbuf_map[RX_DESC_COUNT];
85 	uint32_t		rx_idx;
86 
87 	/* TX */
88 	bus_dma_tag_t		txdesc_tag;
89 	bus_dmamap_t		txdesc_map;
90 	struct dwc_hwdesc	*txdesc_ring;
91 	bus_addr_t		txdesc_ring_paddr;
92 	bus_dma_tag_t		txbuf_tag;
93 	struct dwc_bufmap	txbuf_map[TX_DESC_COUNT];
94 	uint32_t		tx_desc_head;
95 	uint32_t		tx_desc_tail;
96 	uint32_t		tx_map_head;
97 	uint32_t		tx_map_tail;
98 	int			tx_desccount;
99 	int			tx_mapcount;
100 };
101 
102 #endif	/* __IF_DWCVAR_H__ */
103