drivers/net/ring/rte_eth_ring.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_ETH_RING_H_
  35 #define _RTE_ETH_RING_H_
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 #include <rte_ring.h>
  42
  43 /**
  44  * Create a new ethdev port from a set of rings
  45  *
  46  * @param name
  47  *    name to be given to the new ethdev port
  48  * @param rx_queues
  49  *    pointer to array of rte_rings to be used as RX queues
  50  * @param nb_rx_queues
  51  *    number of elements in the rx_queues array
  52  * @param tx_queues
  53  *    pointer to array of rte_rings to be used as TX queues
  54  * @param nb_tx_queues
  55  *    number of elements in the tx_queues array
  56  * @param numa_node
  57  *    the numa node on which the memory for this port is to be allocated
  58  * @return
  59  *    the port number of the newly created the ethdev or -1 on error.
  60  */
  61 int rte_eth_from_rings(const char *name,
  62                 struct rte_ring * const rx_queues[],
  63                 const unsigned nb_rx_queues,
  64                 struct rte_ring *const tx_queues[],
  65                 const unsigned nb_tx_queues,
  66                 const unsigned numa_node);
  67
  68 /**
  69  * Create a new ethdev port from a ring
  70  *
  71  * This function is a shortcut call for rte_eth_from_rings for the
  72  * case where one wants to take a single rte_ring and use it as though
  73  * it were an ethdev
  74  *
  75  * @param ring
  76  *    the ring to be used as an ethdev
  77  * @return
  78  *    the port number of the newly created ethdev, or -1 on error
  79  */
  80 int rte_eth_from_ring(struct rte_ring *r);
  81
  82 #ifdef __cplusplus
  83 }
  84 #endif
  85
  86 #endif