maintainers: update for mempool
[dpdk.git] / lib / librte_port / rte_port_kni.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2016 Ethan Zhuang <zhuangwj@gmail.com>.
5  *   Copyright(c) 2016 Intel Corporation.
6  *   All rights reserved.
7  *
8  *   Redistribution and use in source and binary forms, with or without
9  *   modification, are permitted provided that the following conditions
10  *   are met:
11  *
12  *     * Redistributions of source code must retain the above copyright
13  *       notice, this list of conditions and the following disclaimer.
14  *     * Redistributions in binary form must reproduce the above copyright
15  *       notice, this list of conditions and the following disclaimer in
16  *       the documentation and/or other materials provided with the
17  *       distribution.
18  *     * Neither the name of Intel Corporation nor the names of its
19  *       contributors may be used to endorse or promote products derived
20  *       from this software without specific prior written permission.
21  *
22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34
35 #ifndef __INCLUDE_RTE_PORT_KNI_H__
36 #define __INCLUDE_RTE_PORT_KNI_H__
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 /**
43  * @file
44  * RTE Port KNI Interface
45  *
46  * kni_reader: input port built on top of pre-initialized KNI interface
47  * kni_writer: output port built on top of pre-initialized KNI interface
48  *
49  ***/
50
51 #include <stdint.h>
52
53 #include <rte_kni.h>
54
55 #include "rte_port.h"
56
57 /** kni_reader port parameters */
58 struct rte_port_kni_reader_params {
59         /** KNI interface reference */
60         struct rte_kni *kni;
61 };
62
63 /** kni_reader port operations */
64 extern struct rte_port_in_ops rte_port_kni_reader_ops;
65
66
67 /** kni_writer port parameters */
68 struct rte_port_kni_writer_params {
69         /** KNI interface reference */
70         struct rte_kni *kni;
71         /** Burst size to KNI interface. */
72         uint32_t tx_burst_sz;
73 };
74
75 /** kni_writer port operations */
76 extern struct rte_port_out_ops rte_port_kni_writer_ops;
77
78 /** kni_writer_nodrop port parameters */
79 struct rte_port_kni_writer_nodrop_params {
80         /** KNI interface reference */
81         struct rte_kni *kni;
82         /** Burst size to KNI interface. */
83         uint32_t tx_burst_sz;
84         /** Maximum number of retries, 0 for no limit */
85         uint32_t n_retries;
86 };
87
88 /** kni_writer_nodrop port operations */
89 extern struct rte_port_out_ops rte_port_kni_writer_nodrop_ops;
90
91 #ifdef __cplusplus
92 }
93 #endif
94
95 #endif