FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
af_packet.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2015-2016 Cisco and/or its affiliates.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 option version = "2.0.0";
17 
18 import "vnet/interface_types.api";
19 import "vnet/ethernet/ethernet_types.api";
20 
21 /** \brief Create host-interface
22  @param client_index - opaque cookie to identify the sender
23  @param context - sender context, to match reply w/ request
24  @param hw_addr - interface MAC
25  @param use_random_hw_addr - use random generated MAC
26  @param host_if_name - interface name
27 */
28 define af_packet_create
29 {
32 
33  vl_api_mac_address_t hw_addr;
35  string host_if_name[64];
36 };
37 
38 /** \brief Create host-interface response
39  @param context - sender context, to match reply w/ request
40  @param retval - return value for request
41 */
42 define af_packet_create_reply
43 {
46  vl_api_interface_index_t sw_if_index;
47 };
48 
49 /** \brief Delete host-interface
50  @param client_index - opaque cookie to identify the sender
51  @param context - sender context, to match reply w/ request
52  @param host_if_name - interface name
53 */
54 autoreply define af_packet_delete
55 {
58 
59  string host_if_name[64];
60 };
61 
62 /** \brief Set l4 offload checksum calculation
63  @param client_index - opaque cookie to identify the sender
64  @param context - sender context, to match reply w/ request
65 */
67 {
70 
71  vl_api_interface_index_t sw_if_index;
72  bool set;
73 };
74 
75 /** \brief Dump af_packet interfaces request */
76 define af_packet_dump
77 {
80 };
81 
82 /** \brief Reply for af_packet dump request
83  @param sw_if_index - software index of af_packet interface
84  @param host_if_name - interface name
85 */
86 define af_packet_details
87 {
89  vl_api_interface_index_t sw_if_index;
90  string host_if_name[64];
91 };
92 
93 /*
94  * Local Variables:
95  * eval: (c-set-style "gnu")
96  * End:
97  */
vl_api_af_packet_create_reply_t::retval
i32 retval
Definition: af_packet.api:45
vl_api_af_packet_delete_t::host_if_name
string host_if_name[64]
Definition: af_packet.api:59
vl_api_af_packet_set_l4_cksum_offload_t
Set l4 offload checksum calculation.
Definition: af_packet.api:66
vl_api_af_packet_create_t::use_random_hw_addr
bool use_random_hw_addr
Definition: af_packet.api:34
vl_api_af_packet_dump_t::client_index
u32 client_index
Definition: af_packet.api:78
vl_api_af_packet_delete_t
Delete host-interface.
Definition: af_packet.api:54
i32
signed int i32
Definition: types.h:77
vl_api_af_packet_details_t
Reply for af_packet dump request.
Definition: af_packet.api:86
vl_api_af_packet_create_t::hw_addr
vl_api_mac_address_t hw_addr
Definition: af_packet.api:33
vl_api_af_packet_create_reply_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: af_packet.api:46
vl_api_af_packet_dump_t::context
u32 context
Definition: af_packet.api:79
vl_api_af_packet_details_t::host_if_name
string host_if_name[64]
Definition: af_packet.api:90
vl_api_af_packet_create_t::context
u32 context
Definition: af_packet.api:31
vl_api_af_packet_create_t::client_index
u32 client_index
Definition: af_packet.api:30
vl_api_af_packet_details_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: af_packet.api:89
vl_api_af_packet_set_l4_cksum_offload_t::client_index
u32 client_index
Definition: af_packet.api:68
vl_api_af_packet_set_l4_cksum_offload_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: af_packet.api:71
af_packet_set_l4_cksum_offload
int af_packet_set_l4_cksum_offload(vlib_main_t *vm, u32 sw_if_index, u8 set)
Definition: af_packet.c:501
vl_api_af_packet_create_t::host_if_name
string host_if_name[64]
Definition: af_packet.api:35
vl_api_af_packet_set_l4_cksum_offload_t::set
bool set
Definition: af_packet.api:72
vl_api_af_packet_details_t::context
u32 context
Definition: af_packet.api:88
version
option version
Definition: af_packet.api:16
vl_api_af_packet_create_t
Create host-interface.
Definition: af_packet.api:28
u32
unsigned int u32
Definition: types.h:88
vl_api_af_packet_set_l4_cksum_offload_t::context
u32 context
Definition: af_packet.api:69
vl_api_af_packet_dump_t
Dump af_packet interfaces request.
Definition: af_packet.api:76
vl_api_af_packet_create_reply_t
Create host-interface response.
Definition: af_packet.api:42
vl_api_af_packet_delete_t::context
u32 context
Definition: af_packet.api:57
vl_api_af_packet_create_reply_t::context
u32 context
Definition: af_packet.api:44
vl_api_af_packet_delete_t::client_index
u32 client_index
Definition: af_packet.api:56