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 = "2.1.0";
24 /** \brief Initialize a new tap interface with the given parameters
25 @param client_index - opaque cookie to identify the sender
26 @param context - sender context, to match reply w/ request
27 @param id - interface id, 0xffffffff means auto
28 @param use_random_mac - let the system generate a unique mac address
29 @param mac_address - mac addr to assign to the interface if use_random not set
30 @param tx_ring_sz - the number of entries of TX ring
31 @param rx_ring_sz - the number of entries of RX ring
32 @param host_mac_addr_set - host side interface mac address should be set
33 @param host_mac_addr - host side interface mac address
34 @param host_if_name_set - host side interface name should be set
35 @param host_if_name - host side interface name
36 @param host_namespace_set - host namespace should be set
37 @param host_namespace - host namespace to attach interface to
38 @param host_bridge_set - host bridge should be set
39 @param host_bridge - host bridge to attach interface to
40 @param host_ip4_addr_set - host IPv4 ip address should be set
41 @param host_ip4_addr - host IPv4 ip address
42 @param host_ip4_prefix_len - host IPv4 ip address prefix length
43 @param host_ip6_addr_set - host IPv6 ip address should be set
44 @param host_ip6_addr - host IPv6 ip address
45 @param host_ip6_prefix_len - host IPv6 ip address prefix length
46 @param host_ip4_gw_set - host IPv4 default gateway should be set
47 @param host_ip4_gw - host IPv4 default gateway
48 @param host_ip6_gw_set - host IPv6 default gateway should be set
49 @param host_ip6_gw - host IPv6 default gateway
50 @param host_mtu_set - host MTU should be set
51 @param host_mtu_size - host MTU size
52 @param tap_flags - flags for the TAP interface creation
58 u32 id [default= 0xffffffff] ;
61 u16 tx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
62 u16 rx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
63 u8 host_namespace_set;
64 u8 host_namespace[64];
73 u8 host_ip4_prefix_len;
76 u8 host_ip6_prefix_len;
87 /** \brief Reply for tap create reply
88 @param context - returned sender context, to match reply w/ request
89 @param retval - return code
90 @param sw_if_index - software index allocated for the new tap interface
92 define tap_create_v2_reply
99 /** \brief Delete tap interface
100 @param client_index - opaque cookie to identify the sender
101 @param context - sender context, to match reply w/ request
102 @param sw_if_index - interface index of existing tap interface
104 autoreply define tap_delete_v2
111 /** \brief Dump tap interfaces request */
112 define sw_interface_tap_v2_dump
118 /** \brief Reply for tap dump request
119 @param sw_if_index - software index of tap interface
120 @param id - interface id
121 @param dev_name - Linux tap device name
122 @param tx_ring_sz - the number of entries of TX ring
123 @param rx_ring_sz - the number of entries of RX ring
124 @param host_mac_addr - mac address assigned to the host side of the interface
125 @param host_if_name - host side interface name
126 @param host_namespace - host namespace the interface is attached into
127 @param host_bridge - host bridge the interface is attached into
128 @param host_ip4_addr - host IPv4 ip address
129 @param host_ip4_prefix_len - host IPv4 ip address prefix length; 0 if unset
130 @param host_ip6_addr - host IPv6 ip address
131 @param host_ip6_prefix_len - host IPv6 ip address prefix length; 0 if unset
132 @param host_mtu_size - host mtu size
134 define sw_interface_tap_v2_details
144 u8 host_namespace[64];
147 u8 host_ip4_prefix_len;
148 u8 host_ip6_addr[16];
149 u8 host_ip6_prefix_len;
156 * eval: (c-set-style "gnu")