sys/dev/netmap/if_igb_netmap.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (C) 2011-2014 Universita` di Pisa. 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 igb, partly contributed by Ahmed Kooli
  32  * For details on netmap support please see ixgbe_netmap.h
  33  */
  34
  35
  36 #include <net/netmap.h>
  37 #include <sys/selinfo.h>
  38 #include <vm/vm.h>
  39 #include <vm/pmap.h>    /* vtophys ? */
  40 #include <dev/netmap/netmap_kern.h>
  41
  42 /*
  43  * Adaptation to different versions of the driver.
  44  */
  45
  46 #ifndef IGB_MEDIA_RESET
  47 /* at the same time as IGB_MEDIA_RESET was defined, the
  48  * tx buffer descriptor was renamed, so use this to revert
  49  * back to the old name.
  50  */
  51 #define igb_tx_buf igb_tx_buffer
  52 #endif
  53
  54
  55 /*
  56  * Register/unregister. We are already under netmap lock.
  57  */
  58 static int
  59 igb_netmap_reg(struct netmap_adapter *na, int onoff)
  60 {
  61         struct ifnet *ifp = na->ifp;
  62         struct adapter *adapter = ifp->if_softc;
  63
  64         IGB_CORE_LOCK(adapter);
  65         igb_disable_intr(adapter);
  66
  67         /* Tell the stack that the interface is no longer active */
  68         ifp->if_drv_flags &= ~(IFF_DRV_RUNNING | IFF_DRV_OACTIVE);
  69
  70         /* enable or disable flags and callbacks in na and ifp */
  71         if (onoff) {
  72                 nm_set_native_flags(na);
  73         } else {
  74                 nm_clear_native_flags(na);
  75         }
  76         igb_init_locked(adapter);       /* also enable intr */
  77         IGB_CORE_UNLOCK(adapter);
  78         return (ifp->if_drv_flags & IFF_DRV_RUNNING ? 0 : 1);
  79 }
  80
  81
  82 /*
  83  * Reconcile kernel and user view of the transmit ring.
  84  */
  85 static int
  86 igb_netmap_txsync(struct netmap_kring *kring, int flags)
  87 {
  88         struct netmap_adapter *na = kring->na;
  89         struct ifnet *ifp = na->ifp;
  90         struct netmap_ring *ring = kring->ring;
  91         u_int nm_i;     /* index into the netmap ring */
  92         u_int nic_i;    /* index into the NIC ring */
  93         u_int n;
  94         u_int const lim = kring->nkr_num_slots - 1;
  95         u_int const head = kring->rhead;
  96         /* generate an interrupt approximately every half ring */
  97         u_int report_frequency = kring->nkr_num_slots >> 1;
  98
  99         /* device-specific */
 100         struct adapter *adapter = ifp->if_softc;
 101         struct tx_ring *txr = &adapter->tx_rings[kring->ring_id];
 102         /* 82575 needs the queue index added */
 103         u32 olinfo_status =
 104             (adapter->hw.mac.type == e1000_82575) ? (txr->me << 4) : 0;
 105
 106         bus_dmamap_sync(txr->txdma.dma_tag, txr->txdma.dma_map,
 107                         BUS_DMASYNC_POSTREAD);
 108
 109         /*
 110          * First part: process new packets to send.
 111          */
 112
 113         nm_i = kring->nr_hwcur;
 114         if (nm_i != head) {     /* we have new packets to send */
 115                 nic_i = netmap_idx_k2n(kring, nm_i);
 116                 for (n = 0; nm_i != head; n++) {
 117                         struct netmap_slot *slot = &ring->slot[nm_i];
 118                         u_int len = slot->len;
 119                         uint64_t paddr;
 120                         void *addr = PNMB(na, slot, &paddr);
 121
 122                         /* device-specific */
 123                         union e1000_adv_tx_desc *curr =
 124                             (union e1000_adv_tx_desc *)&txr->tx_base[nic_i];
 125                         struct igb_tx_buf *txbuf = &txr->tx_buffers[nic_i];
 126                         int flags = (slot->flags & NS_REPORT ||
 127                                 nic_i == 0 || nic_i == report_frequency) ?
 128                                 E1000_ADVTXD_DCMD_RS : 0;
 129
 130                         NM_CHECK_ADDR_LEN(na, addr, len);
 131
 132                         if (slot->flags & NS_BUF_CHANGED) {
 133                                 /* buffer has changed, reload map */
 134                                 netmap_reload_map(na, txr->txtag, txbuf->map, addr);
 135                         }
 136                         slot->flags &= ~(NS_REPORT | NS_BUF_CHANGED);
 137
 138                         /* Fill the slot in the NIC ring. */
 139                         curr->read.buffer_addr = htole64(paddr);
 140                         // XXX check olinfo and cmd_type_len
 141                         curr->read.olinfo_status =
 142                             htole32(olinfo_status |
 143                                 (len<< E1000_ADVTXD_PAYLEN_SHIFT));
 144                         curr->read.cmd_type_len =
 145                             htole32(len | E1000_ADVTXD_DTYP_DATA |
 146                             E1000_ADVTXD_DCMD_IFCS |
 147                             E1000_ADVTXD_DCMD_DEXT |
 148                             E1000_ADVTXD_DCMD_EOP | flags);
 149
 150                         /* make sure changes to the buffer are synced */
 151                         bus_dmamap_sync(txr->txtag, txbuf->map,
 152                                 BUS_DMASYNC_PREWRITE);
 153
 154                         nm_i = nm_next(nm_i, lim);
 155                         nic_i = nm_next(nic_i, lim);
 156                 }
 157                 kring->nr_hwcur = head;
 158
 159                 /* Set the watchdog XXX ? */
 160                 txr->queue_status = IGB_QUEUE_WORKING;
 161                 txr->watchdog_time = ticks;
 162
 163                 /* synchronize the NIC ring */
 164                 bus_dmamap_sync(txr->txdma.dma_tag, txr->txdma.dma_map,
 165                         BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);
 166
 167                 /* (re)start the tx unit up to slot nic_i (excluded) */
 168                 E1000_WRITE_REG(&adapter->hw, E1000_TDT(txr->me), nic_i);
 169         }
 170
 171         /*
 172          * Second part: reclaim buffers for completed transmissions.
 173          */
 174         if (flags & NAF_FORCE_RECLAIM || nm_kr_txempty(kring)) {
 175                 /* record completed transmissions using TDH */
 176                 nic_i = E1000_READ_REG(&adapter->hw, E1000_TDH(kring->ring_id));
 177                 if (nic_i >= kring->nkr_num_slots) { /* XXX can it happen ? */
 178                         D("TDH wrap %d", nic_i);
 179                         nic_i -= kring->nkr_num_slots;
 180                 }
 181                 txr->next_to_clean = nic_i;
 182                 kring->nr_hwtail = nm_prev(netmap_idx_n2k(kring, nic_i), lim);
 183         }
 184
 185         return 0;
 186 }
 187
 188
 189 /*
 190  * Reconcile kernel and user view of the receive ring.
 191  */
 192 static int
 193 igb_netmap_rxsync(struct netmap_kring *kring, int flags)
 194 {
 195         struct netmap_adapter *na = kring->na;
 196         struct ifnet *ifp = na->ifp;
 197         struct netmap_ring *ring = kring->ring;
 198         u_int nm_i;     /* index into the netmap ring */
 199         u_int nic_i;    /* index into the NIC ring */
 200         u_int n;
 201         u_int const lim = kring->nkr_num_slots - 1;
 202         u_int const head = kring->rhead;
 203         int force_update = (flags & NAF_FORCE_READ) || kring->nr_kflags & NKR_PENDINTR;
 204
 205         /* device-specific */
 206         struct adapter *adapter = ifp->if_softc;
 207         struct rx_ring *rxr = &adapter->rx_rings[kring->ring_id];
 208
 209         if (head > lim)
 210                 return netmap_ring_reinit(kring);
 211
 212         /* XXX check sync modes */
 213         bus_dmamap_sync(rxr->rxdma.dma_tag, rxr->rxdma.dma_map,
 214                         BUS_DMASYNC_POSTREAD | BUS_DMASYNC_POSTWRITE);
 215
 216         /*
 217          * First part: import newly received packets.
 218          */
 219         if (netmap_no_pendintr || force_update) {
 220                 uint16_t slot_flags = kring->nkr_slot_flags;
 221
 222                 nic_i = rxr->next_to_check;
 223                 nm_i = netmap_idx_n2k(kring, nic_i);
 224
 225                 for (n = 0; ; n++) {
 226                         union e1000_adv_rx_desc *curr = &rxr->rx_base[nic_i];
 227                         uint32_t staterr = le32toh(curr->wb.upper.status_error);
 228
 229                         if ((staterr & E1000_RXD_STAT_DD) == 0)
 230                                 break;
 231                         ring->slot[nm_i].len = le16toh(curr->wb.upper.length);
 232                         ring->slot[nm_i].flags = slot_flags;
 233                         bus_dmamap_sync(rxr->ptag,
 234                             rxr->rx_buffers[nic_i].pmap, BUS_DMASYNC_POSTREAD);
 235                         nm_i = nm_next(nm_i, lim);
 236                         nic_i = nm_next(nic_i, lim);
 237                 }
 238                 if (n) { /* update the state variables */
 239                         rxr->next_to_check = nic_i;
 240                         kring->nr_hwtail = nm_i;
 241                 }
 242                 kring->nr_kflags &= ~NKR_PENDINTR;
 243         }
 244
 245         /*
 246          * Second part: skip past packets that userspace has released.
 247          */
 248         nm_i = kring->nr_hwcur;
 249         if (nm_i != head) {
 250                 nic_i = netmap_idx_k2n(kring, nm_i);
 251                 for (n = 0; nm_i != head; n++) {
 252                         struct netmap_slot *slot = &ring->slot[nm_i];
 253                         uint64_t paddr;
 254                         void *addr = PNMB(na, slot, &paddr);
 255
 256                         union e1000_adv_rx_desc *curr = &rxr->rx_base[nic_i];
 257                         struct igb_rx_buf *rxbuf = &rxr->rx_buffers[nic_i];
 258
 259                         if (addr == NETMAP_BUF_BASE(na)) /* bad buf */
 260                                 goto ring_reset;
 261
 262                         if (slot->flags & NS_BUF_CHANGED) {
 263                                 /* buffer has changed, reload map */
 264                                 netmap_reload_map(na, rxr->ptag, rxbuf->pmap, addr);
 265                                 slot->flags &= ~NS_BUF_CHANGED;
 266                         }
 267                         curr->wb.upper.status_error = 0;
 268                         curr->read.pkt_addr = htole64(paddr);
 269                         bus_dmamap_sync(rxr->ptag, rxbuf->pmap,
 270                             BUS_DMASYNC_PREREAD);
 271                         nm_i = nm_next(nm_i, lim);
 272                         nic_i = nm_next(nic_i, lim);
 273                 }
 274                 kring->nr_hwcur = head;
 275
 276                 bus_dmamap_sync(rxr->rxdma.dma_tag, rxr->rxdma.dma_map,
 277                     BUS_DMASYNC_PREREAD | BUS_DMASYNC_PREWRITE);
 278                 /*
 279                  * IMPORTANT: we must leave one free slot in the ring,
 280                  * so move nic_i back by one unit
 281                  */
 282                 nic_i = nm_prev(nic_i, lim);
 283                 E1000_WRITE_REG(&adapter->hw, E1000_RDT(rxr->me), nic_i);
 284         }
 285
 286         return 0;
 287
 288 ring_reset:
 289         return netmap_ring_reinit(kring);
 290 }
 291
 292
 293 static void
 294 igb_netmap_attach(struct adapter *adapter)
 295 {
 296         struct netmap_adapter na;
 297
 298         bzero(&na, sizeof(na));
 299
 300         na.ifp = adapter->ifp;
 301         na.na_flags = NAF_BDG_MAYSLEEP;
 302         na.num_tx_desc = adapter->num_tx_desc;
 303         na.num_rx_desc = adapter->num_rx_desc;
 304         na.nm_txsync = igb_netmap_txsync;
 305         na.nm_rxsync = igb_netmap_rxsync;
 306         na.nm_register = igb_netmap_reg;
 307         na.num_tx_rings = na.num_rx_rings = adapter->num_queues;
 308         netmap_attach(&na);
 309 }
 310
 311 /* end of file */