xref: /freebsd/sys/dev/xilinx/if_xaevar.h (revision 974ecf68903d3887324f534a3bca21f1ae501819)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2019-2025 Ruslan Bukin <br@bsdpad.com>
5  *
6  * This software was developed by SRI International and the University of
7  * Cambridge Computer Laboratory (Department of Computer Science and
8  * Technology) under DARPA contract HR0011-18-C-0016 ("ECATS"), as part of the
9  * DARPA SSITH research programme.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  */
32 
33 #ifndef	_DEV_XILINX_IF_XAEVAR_H_
34 #define	_DEV_XILINX_IF_XAEVAR_H_
35 
36 struct xae_bufmap {
37 	struct mbuf	*mbuf;
38 	bus_dmamap_t	map;
39 };
40 
41 /*
42  * Driver data and defines.
43  */
44 #define	RX_DESC_COUNT	64
45 #define	RX_DESC_SIZE	(sizeof(struct axidma_desc) * RX_DESC_COUNT)
46 #define	TX_DESC_COUNT	64
47 #define	TX_DESC_SIZE	(sizeof(struct axidma_desc) * TX_DESC_COUNT)
48 
49 #define	AXIDMA_TX_CHAN		0
50 #define	AXIDMA_RX_CHAN		1
51 
52 struct xae_softc {
53 	struct resource		*res[2];
54 	bus_space_tag_t		bst;
55 	bus_space_handle_t	bsh;
56 	device_t		dev;
57 	uint8_t			macaddr[ETHER_ADDR_LEN];
58 	device_t		miibus;
59 	struct mii_data *	mii_softc;
60 	if_t			ifp;
61 	int			if_flags;
62 	struct mtx		mtx;
63 	void *			intr_cookie;
64 	struct callout		xae_callout;
65 	boolean_t		link_is_up;
66 	boolean_t		is_attached;
67 	boolean_t		is_detaching;
68 	int			phy_addr;
69 
70 	/* Counters */
71 	uint64_t		counters[XAE_MAX_COUNTERS];
72 
73 	/* Axistream-connected. */
74 	device_t		dma_dev;
75 	struct resource		*dma_res;
76 
77 	int			rxbuf_align;
78 	int			txbuf_align;
79 
80 	bus_dma_tag_t		rxdesc_tag;
81 	bus_dmamap_t		rxdesc_map;
82 	struct axidma_desc	*rxdesc_ring;
83 	bus_addr_t		rxdesc_ring_paddr;
84 	bus_dma_tag_t		rxbuf_tag;
85 	struct xae_bufmap	rxbuf_map[RX_DESC_COUNT];
86 	uint32_t		rx_idx;
87 
88 	bus_dma_tag_t		txdesc_tag;
89 	bus_dmamap_t		txdesc_map;
90 	struct axidma_desc	*txdesc_ring;
91 	bus_addr_t		txdesc_ring_paddr;
92 	bus_dma_tag_t		txbuf_tag;
93 	struct xae_bufmap	txbuf_map[TX_DESC_COUNT];
94 	uint32_t		tx_idx_head;
95 	uint32_t		tx_idx_tail;
96 	int			txcount;
97 };
98 
99 #endif	/* _DEV_XILINX_IF_XAEVAR_H_ */
100