doc: remove release version from known issues
[dpdk.git] / app / test / virtual_pmd.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 __VIRTUAL_ETHDEV_H_
35 #define __VIRTUAL_ETHDEV_H_
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 #include <rte_ether.h>
42
43 int
44 virtual_ethdev_init(void);
45
46 int
47 virtual_ethdev_create(const char *name, struct ether_addr *mac_addr,
48                 uint8_t socket_id, uint8_t isr_support);
49
50 void
51 virtual_ethdev_set_link_status(uint8_t port_id, uint8_t link_status);
52
53 void
54 virtual_ethdev_simulate_link_status_interrupt(uint8_t port_id,
55                 uint8_t link_status);
56
57 int
58 virtual_ethdev_add_mbufs_to_rx_queue(uint8_t port_id,
59                 struct rte_mbuf **pkts_burst, int burst_length);
60
61 int
62 virtual_ethdev_get_mbufs_from_tx_queue(uint8_t port_id,
63                 struct rte_mbuf **pkt_burst, int burst_length);
64
65 /** Control methods for the dev_ops functions pointer to control the behavior
66  *  of the Virtual PMD */
67
68 void
69 virtual_ethdev_start_fn_set_success(uint8_t port_id, uint8_t success);
70
71 void
72 virtual_ethdev_stop_fn_set_success(uint8_t port_id, uint8_t success);
73
74 void
75 virtual_ethdev_configure_fn_set_success(uint8_t port_id, uint8_t success);
76
77 void
78 virtual_ethdev_rx_queue_setup_fn_set_success(uint8_t port_id, uint8_t success);
79
80 void
81 virtual_ethdev_tx_queue_setup_fn_set_success(uint8_t port_id, uint8_t success);
82
83 void
84 virtual_ethdev_link_update_fn_set_success(uint8_t port_id, uint8_t success);
85
86 void
87 virtual_ethdev_rx_burst_fn_set_success(uint8_t port_id, uint8_t success);
88
89 void
90 virtual_ethdev_tx_burst_fn_set_success(uint8_t port_id, uint8_t success);
91
92 /* if a value greater than zero is set for packet_fail_count then virtual
93  * device tx burst function will fail that many packet from burst or all
94  * packets if packet_fail_count is greater than the number of packets in the
95  * burst */
96 void
97 virtual_ethdev_tx_burst_fn_set_tx_pkt_fail_count(uint8_t port_id,
98                 uint8_t packet_fail_count);
99
100 #ifdef __cplusplus
101 }
102 #endif
103
104 #endif /* __VIRTUAL_ETHDEV_H_ */