9c6dfcb720
The rte_eth_from_rings API allowed the creation of an ethdev port at runtime using rte_rings as the underlying storage. However, the return value from this function was either 0 or -1, and these values were never actually documented in the API documentation. Unfortunately, the programmers guide doc examples for this API implied that the return value from this function was the port id of the newly created ethdev. Since this latter behaviour is more useful - and already implied by the documentation, this patch changes the return 0 to "return data->port_id". It also adds in doxygen comments for the function so it can be correctly documented in the API reference. Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
76 lines
2.7 KiB
C
76 lines
2.7 KiB
C
/*-
|
|
* BSD LICENSE
|
|
*
|
|
* Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* * Neither the name of Intel Corporation nor the names of its
|
|
* contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef _RTE_ETH_RING_H_
|
|
#define _RTE_ETH_RING_H_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <rte_ring.h>
|
|
|
|
/**
|
|
* Create a new ethdev port from a set of rings
|
|
*
|
|
* @param name
|
|
* name to be given to the new ethdev port
|
|
* @param rx_queues
|
|
* pointer to array of rte_rings to be used as RX queues
|
|
* @param nb_rx_queues
|
|
* number of elements in the rx_queues array
|
|
* @param tx_queues
|
|
* pointer to array of rte_rings to be used as TX queues
|
|
* @param nb_tx_queues
|
|
* number of elements in the tx_queues array
|
|
* @param numa_node
|
|
* the numa node on which the memory for this port is to be allocated
|
|
* @return
|
|
* the port number of the newly created the ethdev or -1 on error.
|
|
*/
|
|
int rte_eth_from_rings(const char *name,
|
|
struct rte_ring * const rx_queues[],
|
|
const unsigned nb_rx_queues,
|
|
struct rte_ring *const tx_queues[],
|
|
const unsigned nb_tx_queues,
|
|
const unsigned numa_node);
|
|
|
|
int rte_eth_ring_pair_create(const char *name, const unsigned numa_node);
|
|
int rte_eth_ring_pair_attach(const char *name, const unsigned numa_node);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|