1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/*
* Copyright (c) 2017 Cisco and/or its affiliates.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/** \file
This file defines vpe control-plane API messages for
the Linux kernel TAP device driver
*/
vl_api_version 1.0.0
/** \brief Initialize a new tap interface with the given paramters
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param id - interface id, 0xffff means auto
@param use_random_mac - let the system generate a unique mac address
@param mac_address - mac addr to assign to the interface if use_radom not set
@param tx_ring_sz - the number of entries of TX ring
@param rx_ring_sz - the number of entries of RX ring
@param host_mac_addr_set - host side interface mac address should be set
@param host_mac_addr - host side interface mac address
@param host_if_name_set - host side interface name should be set
@param host_if_name - host side interface name
@param host_namespace_set - host namespece should be set
@param host_namespace - host namespace to attach interface to
@param host_bridge_set - host bridge should be set
@param host_bridge - host bridge to attach interface to
@param host_ip4_addr_set - host IPv4 ip address should be set
@param host_ip4_addr - host IPv4 ip address
@param host_ip4_prefix_len - host IPv4 ip address prefix length
@param host_ip6_addr_set - host IPv6 ip address should be set
@param host_ip6_addr - host IPv6 ip address
@param host_ip6_prefix_len - host IPv6 ip address prefix length
*/
define tap_create_v2
{
u32 client_index;
u32 context;
u32 id;
u8 use_random_mac;
u8 mac_address[6];
u16 tx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
u16 rx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
u8 host_namespace_set;
u8 host_namespace[64];
u8 host_mac_addr_set;
u8 host_mac_addr[6];
u8 host_if_name_set;
u8 host_if_name[64];
u8 host_bridge_set;
u8 host_bridge[64];
u8 host_ip4_addr_set;
u8 host_ip4_addr[4];
u8 host_ip4_prefix_len;
u8 host_ip6_addr_set;
u8 host_ip6_addr[16];
u8 host_ip6_prefix_len;
};
/** \brief Reply for tap create reply
@param context - returned sender context, to match reply w/ request
@param retval - return code
@param sw_if_index - software index allocated for the new tap interface
*/
define tap_create_v2_reply
{
u32 context;
i32 retval;
u32 sw_if_index;
};
/** \brief Delete tap interface
@param client_index - opaque cookie to identify the sender
@param context - sender context, to match reply w/ request
@param sw_if_index - interface index of existing tap interface
*/
autoreply define tap_delete_v2
{
u32 client_index;
u32 context;
u32 sw_if_index;
};
/** \brief Dump tap interfaces request */
define sw_interface_tap_v2_dump
{
u32 client_index;
u32 context;
};
/** \brief Reply for tap dump request
@param sw_if_index - software index of tap interface
@param dev_name - Linux tap device name
*/
define sw_interface_tap_v2_details
{
u32 context;
u32 sw_if_index;
u8 dev_name[64];
};
/*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
|
