1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (C) 2011-2014 Luigi Rizzo. All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28/*
29 * $FreeBSD$
30 *
31 * netmap support for: re
32 *
33 * For more details on netmap support please see ixgbe_netmap.h
34 */
35
36
37#include <net/netmap.h>
38#include <sys/selinfo.h>
39#include <vm/vm.h>
40#include <vm/pmap.h>    /* vtophys ? */
41#include <dev/netmap/netmap_kern.h>
42
43
44/*
45 * Register/unregister. We are already under netmap lock.
46 */
47static int
48re_netmap_reg(struct netmap_adapter *na, int onoff)
49{
50	struct ifnet *ifp = na->ifp;
51	struct rl_softc *adapter = ifp->if_softc;
52
53	RL_LOCK(adapter);
54	re_stop(adapter); /* also clears IFF_DRV_RUNNING */
55	if (onoff) {
56		nm_set_native_flags(na);
57	} else {
58		nm_clear_native_flags(na);
59	}
60	re_init_locked(adapter);	/* also enables intr */
61	RL_UNLOCK(adapter);
62	return (ifp->if_drv_flags & IFF_DRV_RUNNING ? 0 : 1);
63}
64
65
66/*
67 * Reconcile kernel and user view of the transmit ring.
68 */
69static int
70re_netmap_txsync(struct netmap_kring *kring, int flags)
71{
72	struct netmap_adapter *na = kring->na;
73	struct ifnet *ifp = na->ifp;
74	struct netmap_ring *ring = kring->ring;
75	u_int nm_i;	/* index into the netmap ring */
76	u_int nic_i;	/* index into the NIC ring */
77	u_int n;
78	u_int const lim = kring->nkr_num_slots - 1;
79	u_int const head = kring->rhead;
80
81	/* device-specific */
82	struct rl_softc *sc = ifp->if_softc;
83	struct rl_txdesc *txd = sc->rl_ldata.rl_tx_desc;
84
85	bus_dmamap_sync(sc->rl_ldata.rl_tx_list_tag,
86	    sc->rl_ldata.rl_tx_list_map,
87	    BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE); // XXX extra postwrite ?
88
89	/*
90	 * First part: process new packets to send.
91	 */
92	nm_i = kring->nr_hwcur;
93	if (nm_i != head) {	/* we have new packets to send */
94		nic_i = sc->rl_ldata.rl_tx_prodidx;
95		// XXX or netmap_idx_k2n(kring, nm_i);
96
97		for (n = 0; nm_i != head; n++) {
98			struct netmap_slot *slot = &ring->slot[nm_i];
99			u_int len = slot->len;
100			uint64_t paddr;
101			void *addr = PNMB(na, slot, &paddr);
102
103			/* device-specific */
104			struct rl_desc *desc = &sc->rl_ldata.rl_tx_list[nic_i];
105			int cmd = slot->len | RL_TDESC_CMD_EOF |
106				RL_TDESC_CMD_OWN | RL_TDESC_CMD_SOF ;
107
108			NM_CHECK_ADDR_LEN(na, addr, len);
109
110			if (nic_i == lim)	/* mark end of ring */
111				cmd |= RL_TDESC_CMD_EOR;
112
113			if (slot->flags & NS_BUF_CHANGED) {
114				/* buffer has changed, reload map */
115				desc->rl_bufaddr_lo = htole32(RL_ADDR_LO(paddr));
116				desc->rl_bufaddr_hi = htole32(RL_ADDR_HI(paddr));
117				netmap_reload_map(na, sc->rl_ldata.rl_tx_mtag,
118					txd[nic_i].tx_dmamap, addr);
119			}
120			slot->flags &= ~(NS_REPORT | NS_BUF_CHANGED);
121
122			/* Fill the slot in the NIC ring. */
123			desc->rl_cmdstat = htole32(cmd);
124
125			/* make sure changes to the buffer are synced */
126			bus_dmamap_sync(sc->rl_ldata.rl_tx_mtag,
127				txd[nic_i].tx_dmamap,
128				BUS_DMASYNC_PREWRITE);
129
130			nm_i = nm_next(nm_i, lim);
131			nic_i = nm_next(nic_i, lim);
132		}
133		sc->rl_ldata.rl_tx_prodidx = nic_i;
134		kring->nr_hwcur = head;
135
136		/* synchronize the NIC ring */
137		bus_dmamap_sync(sc->rl_ldata.rl_tx_list_tag,
138			sc->rl_ldata.rl_tx_list_map,
139			BUS_DMASYNC_PREREAD|BUS_DMASYNC_PREWRITE);
140
141		/* start ? */
142		CSR_WRITE_1(sc, sc->rl_txstart, RL_TXSTART_START);
143	}
144
145	/*
146	 * Second part: reclaim buffers for completed transmissions.
147	 */
148	if (flags & NAF_FORCE_RECLAIM || nm_kr_txempty(kring)) {
149		nic_i = sc->rl_ldata.rl_tx_considx;
150		for (n = 0; nic_i != sc->rl_ldata.rl_tx_prodidx;
151		    n++, nic_i = RL_TX_DESC_NXT(sc, nic_i)) {
152			uint32_t cmdstat =
153				le32toh(sc->rl_ldata.rl_tx_list[nic_i].rl_cmdstat);
154			if (cmdstat & RL_TDESC_STAT_OWN)
155				break;
156		}
157		if (n > 0) {
158			sc->rl_ldata.rl_tx_considx = nic_i;
159			sc->rl_ldata.rl_tx_free += n;
160			kring->nr_hwtail = nm_prev(netmap_idx_n2k(kring, nic_i), lim);
161		}
162	}
163
164	return 0;
165}
166
167
168/*
169 * Reconcile kernel and user view of the receive ring.
170 */
171static int
172re_netmap_rxsync(struct netmap_kring *kring, int flags)
173{
174	struct netmap_adapter *na = kring->na;
175	struct ifnet *ifp = na->ifp;
176	struct netmap_ring *ring = kring->ring;
177	u_int nm_i;	/* index into the netmap ring */
178	u_int nic_i;	/* index into the NIC ring */
179	u_int n;
180	u_int const lim = kring->nkr_num_slots - 1;
181	u_int const head = kring->rhead;
182	int force_update = (flags & NAF_FORCE_READ) || kring->nr_kflags & NKR_PENDINTR;
183
184	/* device-specific */
185	struct rl_softc *sc = ifp->if_softc;
186	struct rl_rxdesc *rxd = sc->rl_ldata.rl_rx_desc;
187
188	if (head > lim)
189		return netmap_ring_reinit(kring);
190
191	bus_dmamap_sync(sc->rl_ldata.rl_rx_list_tag,
192			sc->rl_ldata.rl_rx_list_map,
193			BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);
194
195	/*
196	 * First part: import newly received packets.
197	 *
198	 * This device uses all the buffers in the ring, so we need
199	 * another termination condition in addition to RL_RDESC_STAT_OWN
200	 * cleared (all buffers could have it cleared). The easiest one
201	 * is to stop right before nm_hwcur.
202	 */
203	if (netmap_no_pendintr || force_update) {
204		uint32_t stop_i = nm_prev(kring->nr_hwcur, lim);
205
206		nic_i = sc->rl_ldata.rl_rx_prodidx; /* next pkt to check */
207		nm_i = netmap_idx_n2k(kring, nic_i);
208
209		while (nm_i != stop_i) {
210			struct rl_desc *cur_rx = &sc->rl_ldata.rl_rx_list[nic_i];
211			uint32_t rxstat = le32toh(cur_rx->rl_cmdstat);
212			uint32_t total_len;
213
214			if ((rxstat & RL_RDESC_STAT_OWN) != 0)
215				break;
216			total_len = rxstat & sc->rl_rxlenmask;
217			/* XXX subtract crc */
218			total_len = (total_len < 4) ? 0 : total_len - 4;
219			ring->slot[nm_i].len = total_len;
220			ring->slot[nm_i].flags = 0;
221			/*  sync was in re_newbuf() */
222			bus_dmamap_sync(sc->rl_ldata.rl_rx_mtag,
223			    rxd[nic_i].rx_dmamap, BUS_DMASYNC_POSTREAD);
224			// if_inc_counter(sc->rl_ifp, IFCOUNTER_IPACKETS, 1);
225			nm_i = nm_next(nm_i, lim);
226			nic_i = nm_next(nic_i, lim);
227		}
228		sc->rl_ldata.rl_rx_prodidx = nic_i;
229		kring->nr_hwtail = nm_i;
230		kring->nr_kflags &= ~NKR_PENDINTR;
231	}
232
233	/*
234	 * Second part: skip past packets that userspace has released.
235	 */
236	nm_i = kring->nr_hwcur;
237	if (nm_i != head) {
238		nic_i = netmap_idx_k2n(kring, nm_i);
239		for (n = 0; nm_i != head; n++) {
240			struct netmap_slot *slot = &ring->slot[nm_i];
241			uint64_t paddr;
242			void *addr = PNMB(na, slot, &paddr);
243
244			struct rl_desc *desc = &sc->rl_ldata.rl_rx_list[nic_i];
245			int cmd = NETMAP_BUF_SIZE(na) | RL_RDESC_CMD_OWN;
246
247			if (addr == NETMAP_BUF_BASE(na)) /* bad buf */
248				goto ring_reset;
249
250			if (nic_i == lim)	/* mark end of ring */
251				cmd |= RL_RDESC_CMD_EOR;
252
253			if (slot->flags & NS_BUF_CHANGED) {
254				/* buffer has changed, reload map */
255				desc->rl_bufaddr_lo = htole32(RL_ADDR_LO(paddr));
256				desc->rl_bufaddr_hi = htole32(RL_ADDR_HI(paddr));
257				netmap_reload_map(na, sc->rl_ldata.rl_rx_mtag,
258					rxd[nic_i].rx_dmamap, addr);
259				slot->flags &= ~NS_BUF_CHANGED;
260			}
261			desc->rl_cmdstat = htole32(cmd);
262			bus_dmamap_sync(sc->rl_ldata.rl_rx_mtag,
263			    rxd[nic_i].rx_dmamap,
264			    BUS_DMASYNC_PREREAD);
265			nm_i = nm_next(nm_i, lim);
266			nic_i = nm_next(nic_i, lim);
267		}
268		kring->nr_hwcur = head;
269
270		bus_dmamap_sync(sc->rl_ldata.rl_rx_list_tag,
271		    sc->rl_ldata.rl_rx_list_map,
272		    BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);
273	}
274
275	return 0;
276
277ring_reset:
278	return netmap_ring_reinit(kring);
279}
280
281
282/*
283 * Additional routines to init the tx and rx rings.
284 * In other drivers we do that inline in the main code.
285 */
286static void
287re_netmap_tx_init(struct rl_softc *sc)
288{
289	struct rl_txdesc *txd;
290	struct rl_desc *desc;
291	int i, n;
292	struct netmap_adapter *na = NA(sc->rl_ifp);
293	struct netmap_slot *slot;
294
295	slot = netmap_reset(na, NR_TX, 0, 0);
296	/* slot is NULL if we are not in native netmap mode */
297	if (!slot)
298		return;
299	/* in netmap mode, overwrite addresses and maps */
300	txd = sc->rl_ldata.rl_tx_desc;
301	desc = sc->rl_ldata.rl_tx_list;
302	n = sc->rl_ldata.rl_tx_desc_cnt;
303
304	/* l points in the netmap ring, i points in the NIC ring */
305	for (i = 0; i < n; i++) {
306		uint64_t paddr;
307		int l = netmap_idx_n2k(na->tx_rings[0], i);
308		void *addr = PNMB(na, slot + l, &paddr);
309
310		desc[i].rl_bufaddr_lo = htole32(RL_ADDR_LO(paddr));
311		desc[i].rl_bufaddr_hi = htole32(RL_ADDR_HI(paddr));
312		netmap_load_map(na, sc->rl_ldata.rl_tx_mtag,
313			txd[i].tx_dmamap, addr);
314	}
315}
316
317static void
318re_netmap_rx_init(struct rl_softc *sc)
319{
320	struct netmap_adapter *na = NA(sc->rl_ifp);
321	struct netmap_slot *slot = netmap_reset(na, NR_RX, 0, 0);
322	struct rl_desc *desc = sc->rl_ldata.rl_rx_list;
323	uint32_t cmdstat;
324	uint32_t nic_i, max_avail;
325	uint32_t const n = sc->rl_ldata.rl_rx_desc_cnt;
326
327	if (!slot)
328		return;
329	/*
330	 * Do not release the slots owned by userspace,
331	 * and also keep one empty.
332	 */
333	max_avail = n - 1 - nm_kr_rxspace(na->rx_rings[0]);
334	for (nic_i = 0; nic_i < n; nic_i++) {
335		void *addr;
336		uint64_t paddr;
337		uint32_t nm_i = netmap_idx_n2k(na->rx_rings[0], nic_i);
338
339		addr = PNMB(na, slot + nm_i, &paddr);
340
341		netmap_reload_map(na, sc->rl_ldata.rl_rx_mtag,
342		    sc->rl_ldata.rl_rx_desc[nic_i].rx_dmamap, addr);
343		bus_dmamap_sync(sc->rl_ldata.rl_rx_mtag,
344		    sc->rl_ldata.rl_rx_desc[nic_i].rx_dmamap, BUS_DMASYNC_PREREAD);
345		desc[nic_i].rl_bufaddr_lo = htole32(RL_ADDR_LO(paddr));
346		desc[nic_i].rl_bufaddr_hi = htole32(RL_ADDR_HI(paddr));
347		cmdstat = NETMAP_BUF_SIZE(na);
348		if (nic_i == n - 1) /* mark the end of ring */
349			cmdstat |= RL_RDESC_CMD_EOR;
350		if (nic_i < max_avail)
351			cmdstat |= RL_RDESC_CMD_OWN;
352		desc[nic_i].rl_cmdstat = htole32(cmdstat);
353	}
354}
355
356
357static void
358re_netmap_attach(struct rl_softc *sc)
359{
360	struct netmap_adapter na;
361
362	bzero(&na, sizeof(na));
363
364	na.ifp = sc->rl_ifp;
365	na.na_flags = NAF_BDG_MAYSLEEP;
366	na.num_tx_desc = sc->rl_ldata.rl_tx_desc_cnt;
367	na.num_rx_desc = sc->rl_ldata.rl_rx_desc_cnt;
368	na.nm_txsync = re_netmap_txsync;
369	na.nm_rxsync = re_netmap_rxsync;
370	na.nm_register = re_netmap_reg;
371	na.num_tx_rings = na.num_rx_rings = 1;
372	netmap_attach(&na);
373}
374
375/* end of file */
376