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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 option version = "2.0.0";
18 import "vnet/interface_types.api";
19 import "vnet/ethernet/ethernet_types.api";
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
28 define af_packet_create
33 vl_api_mac_address_t hw_addr;
34 bool use_random_hw_addr;
35 string host_if_name[64];
38 /** \brief Create host-interface response
39 @param context - sender context, to match reply w/ request
40 @param retval - return value for request
42 define af_packet_create_reply
46 vl_api_interface_index_t sw_if_index;
49 /** \brief Create host-interface
50 @param client_index - opaque cookie to identify the sender
51 @param context - sender context, to match reply w/ request
52 @param hw_addr - interface MAC
53 @param use_random_hw_addr - use random generated MAC
54 @param host_if_name - interface name
55 @param rx_frame_size - frame size for RX
56 @param tx_frame_size - frame size for TX
57 @param rx_frames_per_block - frames per block for RX
58 @param tx_frames_per_block - frames per block for TX
59 @param flags - flags for the af_packet interface creation
60 @param num_rx_queues - number of rx queues
62 define af_packet_create_v2
67 vl_api_mac_address_t hw_addr;
68 bool use_random_hw_addr;
69 string host_if_name[64];
72 u32 rx_frames_per_block;
73 u32 tx_frames_per_block;
75 u16 num_rx_queues [default=1];
78 /** \brief Create host-interface response
79 @param context - sender context, to match reply w/ request
80 @param retval - return value for request
82 define af_packet_create_v2_reply
86 vl_api_interface_index_t sw_if_index;
90 AF_PACKET_API_MODE_ETHERNET = 1, /* mode ethernet */
91 AF_PACKET_API_MODE_IP = 2, /* mode ip */
94 enum af_packet_flags {
95 AF_PACKET_API_FLAG_QDISC_BYPASS = 1, /* enable the qdisc bypass */
96 AF_PACKET_API_FLAG_CKSUM_GSO = 2, /* enable checksum/gso */
97 AF_PACKET_API_FLAG_VERSION_2 = 8 [backwards_compatible], /* af packet v2, default is v3 */
100 /** \brief Create host-interface
101 @param client_index - opaque cookie to identify the sender
102 @param context - sender context, to match reply w/ request
103 @param mode - 1 - Ethernet, 2 - IP
104 @param hw_addr - interface MAC
105 @param use_random_hw_addr - use random generated MAC
106 @param host_if_name - interface name
107 @param rx_frame_size - frame size for RX
108 @param tx_frame_size - frame size for TX
109 @param rx_frames_per_block - frames per block for RX
110 @param tx_frames_per_block - frames per block for TX
111 @param flags - flags for the af_packet interface creation
112 @param num_rx_queues - number of rx queues
113 @param num_tx_queues - number of tx queues
115 define af_packet_create_v3
120 vl_api_af_packet_mode_t mode;
121 vl_api_mac_address_t hw_addr;
122 bool use_random_hw_addr;
123 string host_if_name[64];
126 u32 rx_frames_per_block;
127 u32 tx_frames_per_block;
128 vl_api_af_packet_flags_t flags;
129 u16 num_rx_queues [default=1];
130 u16 num_tx_queues [default=1];
133 /** \brief Create host-interface response
134 @param context - sender context, to match reply w/ request
135 @param retval - return value for request
137 define af_packet_create_v3_reply
141 vl_api_interface_index_t sw_if_index;
144 /** \brief Delete host-interface
145 @param client_index - opaque cookie to identify the sender
146 @param context - sender context, to match reply w/ request
147 @param host_if_name - interface name
149 autoreply define af_packet_delete
154 string host_if_name[64];
157 /** \brief Set l4 offload checksum calculation
158 @param client_index - opaque cookie to identify the sender
159 @param context - sender context, to match reply w/ request
161 autoreply define af_packet_set_l4_cksum_offload
166 vl_api_interface_index_t sw_if_index;
170 /** \brief Dump af_packet interfaces request */
171 define af_packet_dump
177 /** \brief Reply for af_packet dump request
178 @param sw_if_index - software index of af_packet interface
179 @param host_if_name - interface name
181 define af_packet_details
184 vl_api_interface_index_t sw_if_index;
185 string host_if_name[64];
190 * eval: (c-set-style "gnu")