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";
32 /** \brief Initialize a new tap interface with the given parameters
33 @param client_index - opaque cookie to identify the sender
34 @param context - sender context, to match reply w/ request
35 @param id - interface id, 0xffffffff means auto
36 @param use_random_mac - let the system generate a unique mac address
37 @param mac_address - mac addr to assign to the interface if use_random not set
38 @param num_rx_queues - number of rx queues
39 @param tx_ring_sz - the number of entries of TX ring
40 @param rx_ring_sz - the number of entries of RX ring
41 @param host_mtu_set - host MTU should be set
42 @param host_mtu_size - host MTU size
43 @param host_mac_addr_set - host side interface mac address should be set
44 @param host_mac_addr - host side interface mac address
45 @param host_ip4_prefix_set - host IPv4 ip address should be set
46 @param host_ip4_prefix - host IPv4 ip address
47 @param host_ip6_prefix_set - host IPv6 ip address should be set
48 @param host_ip6_prefix - host IPv6 ip address
49 @param host_ip4_gw_set - host IPv4 default gateway should be set
50 @param host_ip4_gw - host IPv4 default gateway
51 @param host_ip6_gw_set - host IPv6 default gateway should be set
52 @param host_ip6_gw - host IPv6 default gateway
53 @param tap_flags - flags for the TAP interface creation
54 @param host_if_name_set - host side interface name should be set
55 @param host_if_name - host side interface name
56 @param host_namespace_set - host namespece should be set
57 @param host_namespace - host namespace to attach interface to
58 @param host_bridge_set - host bridge should be set
59 @param host_bridge - host bridge to attach interface to
66 u32 id [default=0xffffffff];
67 bool use_random_mac [default=true];
68 vl_api_mac_address_t mac_address;
69 u8 num_rx_queues [default=1];
70 u16 tx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
71 u16 rx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
74 bool host_mac_addr_set;
75 vl_api_mac_address_t host_mac_addr;
76 bool host_ip4_prefix_set;
77 vl_api_ip4_address_with_prefix_t host_ip4_prefix;
78 bool host_ip6_prefix_set;
79 vl_api_ip6_address_with_prefix_t host_ip6_prefix;
81 vl_api_ip4_address_t host_ip4_gw;
83 vl_api_ip6_address_t host_ip6_gw;
84 vl_api_tap_flags_t tap_flags;
85 bool host_namespace_set;
86 string host_namespace[64];
87 bool host_if_name_set;
88 string host_if_name[64];
90 string host_bridge[64];
94 /** \brief Reply for tap create reply
95 @param context - returned sender context, to match reply w/ request
96 @param retval - return code
97 @param sw_if_index - software index allocated for the new tap interface
99 define tap_create_v2_reply
103 vl_api_interface_index_t sw_if_index;
106 /** \brief Delete tap interface
107 @param client_index - opaque cookie to identify the sender
108 @param context - sender context, to match reply w/ request
109 @param sw_if_index - interface index of existing tap interface
111 autoreply define tap_delete_v2
115 vl_api_interface_index_t sw_if_index;
118 /** \brief Dump tap interfaces request
119 @param sw_if_index - filter by sw_if_index UNIMPLEMENTED
121 define sw_interface_tap_v2_dump
125 vl_api_interface_index_t sw_if_index [default=0xffffffff];
128 /** \brief Reply for tap dump request
129 @param sw_if_index - software index of tap interface
130 @param id - interface id
131 @param tx_ring_sz - the number of entries of TX ring
132 @param rx_ring_sz - the number of entries of RX ring
133 @param host_mtu_size - host mtu size
134 @param host_mac_addr - mac address assigned to the host side of the interface
135 @param host_ip4_prefix - host IPv4 ip address
136 @param host_ip6_prefix - host IPv6 ip address
137 @param tap_flags - flags for the TAP interface creation
138 @param dev_name - Linux tap device name
139 @param host_if_name - host side interface name
140 @param host_namespace - host namespace the interface is attached into
141 @param host_bridge - host bridge the interface is attached into
143 define sw_interface_tap_v2_details
151 vl_api_mac_address_t host_mac_addr;
152 vl_api_ip4_address_with_prefix_t host_ip4_prefix;
153 vl_api_ip6_address_with_prefix_t host_ip6_prefix;
154 vl_api_tap_flags_t tap_flags;
156 string host_if_name[64];
157 string host_namespace[64];
158 string host_bridge[64];
163 * eval: (c-set-style "gnu")