xref: /netbsd-src/sys/dev/ic/dwc_gmac_var.h (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /* $NetBSD: dwc_gmac_var.h,v 1.9 2018/06/30 16:27:48 jmcneill Exp $ */
2 
3 /*-
4  * Copyright (c) 2013, 2014 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Matt Thomas of 3am Software Foundry and Martin Husemann.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 
33 /*
34  * We could use 1024 DMA descriptors to fill up an 8k page (each is 16 byte).
35  * However, on TX we probably will not need that many, and on RX we allocate
36  * a full mbuf cluster for each, so secondary memory consumption will grow
37  * rapidly.
38  * So currently we waste half a page of dma memory and consume 512k Byte of
39  * RAM for mbuf clusters.
40  * XXX Maybe fine-tune later, or reconsider unsharing of RX/TX dmamap.
41  */
42 #define		AWGE_RX_RING_COUNT	256
43 #define		AWGE_TX_RING_COUNT	256
44 #define		AWGE_TOTAL_RING_COUNT	\
45 			(AWGE_RX_RING_COUNT + AWGE_TX_RING_COUNT)
46 
47 #define		AWGE_MAX_PACKET		0x7ff
48 
49 
50 
51 struct dwc_gmac_rx_data {
52 	bus_dmamap_t	rd_map;
53 	struct mbuf	*rd_m;
54 };
55 
56 struct dwc_gmac_tx_data {
57 	bus_dmamap_t	td_map;
58 	bus_dmamap_t	td_active;
59 	struct mbuf	*td_m;
60 };
61 
62 struct dwc_gmac_tx_ring {
63 	bus_addr_t			t_physaddr; /* PA of TX ring start */
64 	struct dwc_gmac_dev_dmadesc	*t_desc;    /* VA of TX ring start */
65 	struct dwc_gmac_tx_data	t_data[AWGE_TX_RING_COUNT];
66 	int				t_cur, t_next, t_queued;
67 	kmutex_t			t_mtx;
68 };
69 
70 struct dwc_gmac_rx_ring {
71 	bus_addr_t			r_physaddr; /* PA of RX ring start */
72 	struct dwc_gmac_dev_dmadesc	*r_desc;    /* VA of RX ring start */
73 	struct dwc_gmac_rx_data	r_data[AWGE_RX_RING_COUNT];
74 	int				r_cur, r_next;
75 	kmutex_t			r_mtx;
76 };
77 
78 struct dwc_gmac_softc {
79 	device_t sc_dev;
80 	bus_space_tag_t sc_bst;
81 	bus_space_handle_t sc_bsh;
82 	bus_dma_tag_t sc_dmat;
83 	uint32_t sc_flags;
84 #define	DWC_GMAC_FORCE_THRESH_DMA_MODE	0x01	/* force DMA to use threshold mode */
85 	struct ethercom sc_ec;
86 	struct mii_data sc_mii;
87 	kmutex_t sc_mdio_lock;
88 	bus_dmamap_t sc_dma_ring_map;		/* common dma memory for RX */
89 	bus_dma_segment_t sc_dma_ring_seg;	/* and TX ring */
90 	struct dwc_gmac_rx_ring sc_rxq;
91 	struct dwc_gmac_tx_ring sc_txq;
92 	short sc_if_flags;			/* shadow of ether flags */
93 	uint16_t sc_mii_clk;
94 	bool sc_stopping;
95 
96 	kmutex_t *sc_lock;			/* lock for softc operations */
97 
98 	struct if_percpuq *sc_ipq;		/* softint-based input queues */
99 
100 	void (*sc_set_speed)(struct dwc_gmac_softc *, int);
101 };
102 
103 int dwc_gmac_attach(struct dwc_gmac_softc*, uint32_t /*mii_clk*/);
104 int dwc_gmac_intr(struct dwc_gmac_softc*);
105