xref: /netbsd-src/sys/dev/ic/dwc_eqos_var.h (revision a996307834b748a0a59a5323bfffa5f25d5aa8be)
1 /* $NetBSD: dwc_eqos_var.h,v 1.11 2024/10/04 10:42:12 skrll Exp $ */
2 
3 /*-
4  * Copyright (c) 2022 Jared McNeill <jmcneill@invisible.ca>
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, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 /*
30  * DesignWare Ethernet Quality-of-Service controller
31  */
32 
33 #ifndef _DWC_EQOS_VAR_H
34 #define _DWC_EQOS_VAR_H
35 
36 #include <dev/ic/dwc_eqos_reg.h>
37 
38 #define	EQOS_DMA_DESC_COUNT	256
39 #define	EQOS_DMA_PBL_DEFAULT	8
40 
41 struct eqos_bufmap {
42 	bus_dmamap_t		map;
43 	struct mbuf		*mbuf;
44 };
45 
46 struct eqos_ring {
47 	struct eqos_softc	*sc;
48 	bus_dmamap_t		desc_map;
49 	bus_dma_segment_t	desc_dmaseg;
50 	struct eqos_dma_desc	*desc_ring;
51 	bus_addr_t		desc_ring_paddr;
52 	struct eqos_bufmap	buf_map[EQOS_DMA_DESC_COUNT];
53 	u_int			cur, next, queued;
54 };
55 
56 struct eqos_softc {
57 	device_t		sc_dev;
58 	bus_space_tag_t		sc_bst;
59 	bus_space_handle_t	sc_bsh;
60 	bus_dma_tag_t		sc_dmat;
61 	int			sc_phy_id;
62 	uint32_t		sc_csr_clock;
63 	uint32_t		sc_clock_range;
64 	uint32_t		sc_hw_feature[4];
65 	uint32_t		sc_dma_txpbl;
66 	uint32_t		sc_dma_rxpbl;
67 
68 	struct ethercom		sc_ec;
69 	struct mii_data		sc_mii;
70 	callout_t		sc_stat_ch;
71 	kmutex_t		sc_lock;
72 	kmutex_t		sc_txlock;
73 	u_short			sc_if_flags;
74 	bool			sc_txrunning;
75 
76 	struct eqos_ring	sc_tx;
77 	struct eqos_ring	sc_rx;
78 
79 	/* receiving context for jumbo frame */
80 	bool			sc_rx_discarding;
81 	struct mbuf		*sc_rx_receiving_m;
82 	struct mbuf		*sc_rx_receiving_m_last;
83 
84 	krndsource_t		sc_rndsource;
85 	struct sysctllog	*sc_sysctllog;
86 	uint32_t		sc_debug;
87 
88 	/* Indents indicate groups within evcnt. */
89 	struct evcnt		sc_ev_intr;
90 	struct evcnt		 sc_ev_rxintr;
91 	struct evcnt		 sc_ev_txintr;
92 	struct evcnt		 sc_ev_mac;
93 	struct evcnt		 sc_ev_mtl;
94 	struct evcnt		  sc_ev_mtl_debugdata;
95 	struct evcnt		  sc_ev_mtl_rxovfis;
96 	struct evcnt		  sc_ev_mtl_txovfis;
97 	struct evcnt		 sc_ev_status;
98 	struct evcnt		  sc_ev_rwt;
99 	struct evcnt		  sc_ev_excol;
100 	struct evcnt		  sc_ev_lcol;
101 	struct evcnt		  sc_ev_exdef;
102 	struct evcnt		  sc_ev_lcarr;
103 	struct evcnt		  sc_ev_ncarr;
104 	struct evcnt		  sc_ev_tjt;
105 };
106 
107 int	eqos_attach(struct eqos_softc *);
108 int	eqos_intr(void *);
109 
110 #endif /* !_DWC_EQOS_VAR_H */
111