rte_port_fd.h revision 6b3e017e
1/*-
2 *   BSD LICENSE
3 *
4 *   Copyright(c) 2016 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_FD_H__
35#define __INCLUDE_RTE_PORT_FD_H__
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41/**
42 * @file
43 * RTE Port FD Device
44 *
45 * fd_reader: input port built on top of valid non-blocking file descriptor
46 * fd_writer: output port built on top of valid non-blocking file descriptor
47 *
48 ***/
49
50#include <stdint.h>
51
52#include <rte_mempool.h>
53#include "rte_port.h"
54
55/** fd_reader port parameters */
56struct rte_port_fd_reader_params {
57	/** File descriptor */
58	int fd;
59
60	/** Maximum Transfer Unit (MTU) */
61	uint32_t mtu;
62
63	/** Pre-initialized buffer pool */
64	struct rte_mempool *mempool;
65};
66
67/** fd_reader port operations */
68extern struct rte_port_in_ops rte_port_fd_reader_ops;
69
70/** fd_writer port parameters */
71struct rte_port_fd_writer_params {
72	/** File descriptor */
73	int fd;
74
75	/**< Recommended write burst size. The actual burst size can be
76	 * bigger or smaller than this value.
77	 */
78	uint32_t tx_burst_sz;
79};
80
81/** fd_writer port operations */
82extern struct rte_port_out_ops rte_port_fd_writer_ops;
83
84/** fd_writer_nodrop port parameters */
85struct rte_port_fd_writer_nodrop_params {
86	/** File descriptor */
87	int fd;
88
89	/**< Recommended write burst size. The actual burst size can be
90	 * bigger or smaller than this value.
91	 */
92	uint32_t tx_burst_sz;
93
94	/** Maximum number of retries, 0 for no limit */
95	uint32_t n_retries;
96};
97
98/** fd_writer_nodrop port operations */
99extern struct rte_port_out_ops rte_port_fd_writer_nodrop_ops;
100
101#ifdef __cplusplus
102}
103#endif
104
105#endif
106