examples/netmap_compat/lib/compat_netmap.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   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  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _RTE_COMPAT_NETMAP_H_
  35
  36 #include <poll.h>
  37 #include <linux/ioctl.h>
  38 #include <net/if.h>
  39
  40 #include <rte_ethdev.h>
  41 #include <rte_mempool.h>
  42
  43 #include "netmap.h"
  44 #include "netmap_user.h"
  45
  46 /**
  47  * One can overwrite Netmap macros here as needed
  48  */
  49
  50 struct rte_netmap_conf {
  51         int32_t  socket_id;
  52         uint32_t max_rings; /* number of rings(queues) per netmap_if(port) */
  53         uint32_t max_slots; /* number of slots(descriptors) per netmap ring. */
  54         uint16_t max_bufsz; /* size of each netmap buffer. */
  55 };
  56
  57 struct rte_netmap_port_conf {
  58         struct rte_eth_conf   *eth_conf;
  59         struct rte_eth_txconf *tx_conf;
  60         struct rte_eth_rxconf *rx_conf;
  61         struct rte_mempool    *pool;
  62         int32_t socket_id;
  63         uint16_t nr_tx_rings;
  64         uint16_t nr_rx_rings;
  65         uint32_t nr_tx_slots;
  66         uint32_t nr_rx_slots;
  67         uint16_t tx_burst;
  68         uint16_t rx_burst;
  69 };
  70
  71 int rte_netmap_init(const struct rte_netmap_conf *conf);
  72 int rte_netmap_init_port(uint8_t portid,
  73         const struct rte_netmap_port_conf *conf);
  74
  75 int rte_netmap_close(int fd);
  76 int rte_netmap_ioctl(int fd, int op, void *param);
  77 int rte_netmap_open(const char *pathname, int flags);
  78 int rte_netmap_poll(struct pollfd *fds, nfds_t nfds, int timeout);
  79 void *rte_netmap_mmap(void *addr, size_t length, int prot, int flags, int fd,
  80                           off_t offset);
  81
  82 #endif /* _RTE_COMPAT_NETMAP_H_ */