blob: 0d86edff73559038f0aaf7ccfe4c6c919cb24575 [file] [log] [blame]
Damjan Marion8389fb92017-10-13 18:29:53 +02001/*
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:
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
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.
14 */
15
16/** \file
17
18 This file defines vpe control-plane API messages for
19 the Linux kernel TAP device driver
20*/
21
Damjan Marion7866c452018-01-18 13:35:11 +010022vl_api_version 1.1.0
Damjan Marion8389fb92017-10-13 18:29:53 +020023
24/** \brief Initialize a new tap interface with the given paramters
25 @param client_index - opaque cookie to identify the sender
26 @param context - sender context, to match reply w/ request
Damjan Marion2df39092017-12-04 20:03:37 +010027 @param id - interface id, 0xffff means auto
Damjan Marion8389fb92017-10-13 18:29:53 +020028 @param use_random_mac - let the system generate a unique mac address
Damjan Marion8389fb92017-10-13 18:29:53 +020029 @param mac_address - mac addr to assign to the interface if use_radom not set
Damjan Marion8389fb92017-10-13 18:29:53 +020030 @param tx_ring_sz - the number of entries of TX ring
31 @param rx_ring_sz - the number of entries of RX ring
Damjan Marion2df39092017-12-04 20:03:37 +010032 @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
Damjan Marion91c6ef72017-12-01 13:34:24 +010036 @param host_namespace_set - host namespece 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
Damjan Marion7866c452018-01-18 13:35:11 +010046 @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
Damjan Marion8389fb92017-10-13 18:29:53 +020050*/
51define tap_create_v2
52{
53 u32 client_index;
54 u32 context;
Damjan Marion2df39092017-12-04 20:03:37 +010055 u32 id;
Damjan Marion8389fb92017-10-13 18:29:53 +020056 u8 use_random_mac;
Damjan Marion8389fb92017-10-13 18:29:53 +020057 u8 mac_address[6];
Damjan Marion8389fb92017-10-13 18:29:53 +020058 u16 tx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
59 u16 rx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
Damjan Marion91c6ef72017-12-01 13:34:24 +010060 u8 host_namespace_set;
61 u8 host_namespace[64];
Damjan Marion2df39092017-12-04 20:03:37 +010062 u8 host_mac_addr_set;
63 u8 host_mac_addr[6];
64 u8 host_if_name_set;
65 u8 host_if_name[64];
Damjan Marion91c6ef72017-12-01 13:34:24 +010066 u8 host_bridge_set;
67 u8 host_bridge[64];
68 u8 host_ip4_addr_set;
69 u8 host_ip4_addr[4];
70 u8 host_ip4_prefix_len;
71 u8 host_ip6_addr_set;
72 u8 host_ip6_addr[16];
73 u8 host_ip6_prefix_len;
Damjan Marion7866c452018-01-18 13:35:11 +010074 u8 host_ip4_gw_set;
75 u8 host_ip4_gw[4];
76 u8 host_ip6_gw_set;
77 u8 host_ip6_gw[16];
Damjan Marion8389fb92017-10-13 18:29:53 +020078};
79
80/** \brief Reply for tap create reply
81 @param context - returned sender context, to match reply w/ request
82 @param retval - return code
83 @param sw_if_index - software index allocated for the new tap interface
84*/
85define tap_create_v2_reply
86{
87 u32 context;
88 i32 retval;
89 u32 sw_if_index;
90};
91
92/** \brief Delete tap interface
93 @param client_index - opaque cookie to identify the sender
94 @param context - sender context, to match reply w/ request
95 @param sw_if_index - interface index of existing tap interface
96*/
97autoreply define tap_delete_v2
98{
99 u32 client_index;
100 u32 context;
101 u32 sw_if_index;
102};
103
104/** \brief Dump tap interfaces request */
105define sw_interface_tap_v2_dump
106{
107 u32 client_index;
108 u32 context;
109};
110
111/** \brief Reply for tap dump request
112 @param sw_if_index - software index of tap interface
Milan Lenco73e7f422017-12-14 10:04:25 +0100113 @param id - interface id
Damjan Marion8389fb92017-10-13 18:29:53 +0200114 @param dev_name - Linux tap device name
Milan Lenco73e7f422017-12-14 10:04:25 +0100115 @param tx_ring_sz - the number of entries of TX ring
116 @param rx_ring_sz - the number of entries of RX ring
117 @param host_mac_addr - mac address assigned to the host side of the interface
118 @param host_if_name - host side interface name
119 @param host_namespace - host namespace the interface is attached into
120 @param host_bridge - host bridge the interface is attached into
121 @param host_ip4_addr - host IPv4 ip address
122 @param host_ip4_prefix_len - host IPv4 ip address prefix length; 0 if unset
123 @param host_ip6_addr - host IPv6 ip address
124 @param host_ip6_prefix_len - host IPv6 ip address prefix length; 0 if unset
Damjan Marion8389fb92017-10-13 18:29:53 +0200125*/
126define sw_interface_tap_v2_details
127{
128 u32 context;
129 u32 sw_if_index;
Milan Lenco73e7f422017-12-14 10:04:25 +0100130 u32 id;
Damjan Marion8389fb92017-10-13 18:29:53 +0200131 u8 dev_name[64];
Milan Lenco73e7f422017-12-14 10:04:25 +0100132 u16 tx_ring_sz;
133 u16 rx_ring_sz;
134 u8 host_mac_addr[6];
135 u8 host_if_name[64];
136 u8 host_namespace[64];
137 u8 host_bridge[64];
138 u8 host_ip4_addr[4];
139 u8 host_ip4_prefix_len;
140 u8 host_ip6_addr[16];
141 u8 host_ip6_prefix_len;
Damjan Marion8389fb92017-10-13 18:29:53 +0200142};
143
144/*
145 * Local Variables:
146 * eval: (c-set-style "gnu")
147 * End:
148 */