doc: move FAQ
[dpdk.git] / lib / librte_port / rte_port_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 __INCLUDE_RTE_PORT_RING_H__
35 #define __INCLUDE_RTE_PORT_RING_H__
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 /**
42  * @file
43  * RTE Port Ring
44  *
45  * ring_reader: input port built on top of pre-initialized single consumer ring
46  * ring_writer: output port built on top of pre-initialized single producer ring
47  *
48  ***/
49
50 #include <stdint.h>
51
52 #include <rte_ring.h>
53
54 #include "rte_port.h"
55
56 /** ring_reader port parameters */
57 struct rte_port_ring_reader_params {
58         /** Underlying single consumer ring that has to be pre-initialized */
59         struct rte_ring *ring;
60 };
61
62 /** ring_reader port operations */
63 extern struct rte_port_in_ops rte_port_ring_reader_ops;
64
65 /** ring_writer port parameters */
66 struct rte_port_ring_writer_params {
67         /** Underlying single producer ring that has to be pre-initialized */
68         struct rte_ring *ring;
69
70         /** Recommended burst size to ring. The actual burst size can be
71                 bigger or smaller than this value. */
72         uint32_t tx_burst_sz;
73 };
74
75 /** ring_writer port operations */
76 extern struct rte_port_out_ops rte_port_ring_writer_ops;
77
78 /** ring_writer_nodrop port parameters */
79 struct rte_port_ring_writer_nodrop_params {
80         /** Underlying single producer ring that has to be pre-initialized */
81         struct rte_ring *ring;
82
83         /** Recommended burst size to ring. The actual burst size can be
84                 bigger or smaller than this value. */
85         uint32_t tx_burst_sz;
86
87         /** Maximum number of retries, 0 for no limit */
88         uint32_t n_retries;
89 };
90
91 /** ring_writer_nodrop port operations */
92 extern struct rte_port_out_ops rte_port_ring_writer_nodrop_ops;
93
94 #ifdef __cplusplus
95 }
96 #endif
97
98 #endif