2 * Copyright (c) 2017 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.
18 This file defines vpe control-plane API messages for
19 the Linux kernel TAP device driver
22 option version = "3.0.0";
24 import "vnet/interface_types.api";
25 import "vnet/ethernet/ethernet_types.api";
26 import "vnet/ip/ip_types.api";
30 TAP_FLAG_CSUM_OFFLOAD = 2,
36 /** \brief Initialize a new tap interface with the given parameters
37 @param client_index - opaque cookie to identify the sender
38 @param context - sender context, to match reply w/ request
39 @param id - interface id, 0xffffffff means auto
40 @param use_random_mac - let the system generate a unique mac address
41 @param mac_address - mac addr to assign to the interface if use_random not set
42 @param num_rx_queues - number of rx queues
43 @param tx_ring_sz - the number of entries of TX ring
44 @param rx_ring_sz - the number of entries of RX ring
45 @param host_mtu_set - host MTU should be set
46 @param host_mtu_size - host MTU size
47 @param host_mac_addr_set - host side interface mac address should be set
48 @param host_mac_addr - host side interface mac address
49 @param host_ip4_prefix_set - host IPv4 ip address should be set
50 @param host_ip4_prefix - host IPv4 ip address
51 @param host_ip6_prefix_set - host IPv6 ip address should be set
52 @param host_ip6_prefix - host IPv6 ip address
53 @param host_ip4_gw_set - host IPv4 default gateway should be set
54 @param host_ip4_gw - host IPv4 default gateway
55 @param host_ip6_gw_set - host IPv6 default gateway should be set
56 @param host_ip6_gw - host IPv6 default gateway
57 @param tap_flags - flags for the TAP interface creation
58 @param host_if_name_set - host side interface name should be set
59 @param host_if_name - host side interface name
60 @param host_namespace_set - host namespece should be set
61 @param host_namespace - host namespace to attach interface to
62 @param host_bridge_set - host bridge should be set
63 @param host_bridge - host bridge to attach interface to
70 u32 id [default=0xffffffff];
71 bool use_random_mac [default=true];
72 vl_api_mac_address_t mac_address;
73 u8 num_rx_queues [default=1];
74 u16 tx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
75 u16 rx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
78 bool host_mac_addr_set;
79 vl_api_mac_address_t host_mac_addr;
80 bool host_ip4_prefix_set;
81 vl_api_ip4_address_with_prefix_t host_ip4_prefix;
82 bool host_ip6_prefix_set;
83 vl_api_ip6_address_with_prefix_t host_ip6_prefix;
85 vl_api_ip4_address_t host_ip4_gw;
87 vl_api_ip6_address_t host_ip6_gw;
88 vl_api_tap_flags_t tap_flags;
89 bool host_namespace_set;
90 string host_namespace[64];
91 bool host_if_name_set;
92 string host_if_name[64];
94 string host_bridge[64];
98 /** \brief Reply for tap create reply
99 @param context - returned sender context, to match reply w/ request
100 @param retval - return code
101 @param sw_if_index - software index allocated for the new tap interface
103 define tap_create_v2_reply
107 vl_api_interface_index_t sw_if_index;
110 /** \brief Delete tap interface
111 @param client_index - opaque cookie to identify the sender
112 @param context - sender context, to match reply w/ request
113 @param sw_if_index - interface index of existing tap interface
115 autoreply define tap_delete_v2
119 vl_api_interface_index_t sw_if_index;
122 /** \brief Dump tap interfaces request
123 @param sw_if_index - filter by sw_if_index UNIMPLEMENTED
125 define sw_interface_tap_v2_dump
129 vl_api_interface_index_t sw_if_index [default=0xffffffff];
132 /** \brief Reply for tap dump request
133 @param sw_if_index - software index of tap interface
134 @param id - interface id
135 @param tx_ring_sz - the number of entries of TX ring
136 @param rx_ring_sz - the number of entries of RX ring
137 @param host_mtu_size - host mtu size
138 @param host_mac_addr - mac address assigned to the host side of the interface
139 @param host_ip4_prefix - host IPv4 ip address
140 @param host_ip6_prefix - host IPv6 ip address
141 @param tap_flags - flags for the TAP interface creation
142 @param dev_name - Linux tap device name
143 @param host_if_name - host side interface name
144 @param host_namespace - host namespace the interface is attached into
145 @param host_bridge - host bridge the interface is attached into
147 define sw_interface_tap_v2_details
155 vl_api_mac_address_t host_mac_addr;
156 vl_api_ip4_address_with_prefix_t host_ip4_prefix;
157 vl_api_ip6_address_with_prefix_t host_ip6_prefix;
158 vl_api_tap_flags_t tap_flags;
160 string host_if_name[64];
161 string host_namespace[64];
162 string host_bridge[64];
167 * eval: (c-set-style "gnu")