2 * Copyright (c) 2015-2016 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 /** \brief Initialize a new tap interface with the given paramters
23 @param client_index - opaque cookie to identify the sender
24 @param context - sender context, to match reply w/ request
25 @param use_random_mac - let the system generate a unique mac address
26 @param tap_name - name to associate with the new interface
27 @param mac_address - mac addr to assign to the interface if use_radom not set
37 u32 custom_dev_instance;
41 /** \brief Reply for tap connect request
42 @param context - returned sender context, to match reply w/ request
43 @param retval - return code
44 @param sw_if_index - software index allocated for the new tap interface
46 define tap_connect_reply
53 /** \brief Modify a tap interface with the given paramters
54 @param client_index - opaque cookie to identify the sender
55 @param context - sender context, to match reply w/ request
56 @param sw_if_index - interface index of existing tap interface
57 @param use_random_mac - let the system generate a unique mac address
58 @param tap_name - name to associate with the new interface
59 @param mac_address - mac addr to assign to the interface if use_radom not set
70 u32 custom_dev_instance;
73 /** \brief Reply for tap modify request
74 @param context - returned sender context, to match reply w/ request
75 @param retval - return code
76 @param sw_if_index - software index if the modified tap interface
78 define tap_modify_reply
85 /** \brief Delete tap interface
86 @param client_index - opaque cookie to identify the sender
87 @param context - sender context, to match reply w/ request
88 @param sw_if_index - interface index of existing tap interface
97 /** \brief Reply for tap delete request
98 @param context - returned sender context, to match reply w/ request
99 @param retval - return code
101 define tap_delete_reply
107 /** \brief Dump tap interfaces request */
108 define sw_interface_tap_dump
114 /** \brief Reply for tap dump request
115 @param sw_if_index - software index of tap interface
116 @param dev_name - Linux tap device name
118 define sw_interface_tap_details