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 option version = "1.0.0";
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
27 @param use_random_mac - let the system generate a unique mac address
28 @param tap_name - name to associate with the new interface
29 @param mac_address - mac addr to assign to the interface if use_radom not set
39 u32 custom_dev_instance;
49 /** \brief Reply for tap connect request
50 @param context - returned sender context, to match reply w/ request
51 @param retval - return code
52 @param sw_if_index - software index allocated for the new tap interface
54 define tap_connect_reply
61 /** \brief Modify a tap interface with the given paramters
62 @param client_index - opaque cookie to identify the sender
63 @param context - sender context, to match reply w/ request
64 @param sw_if_index - interface index of existing tap interface
65 @param use_random_mac - let the system generate a unique mac address
66 @param tap_name - name to associate with the new interface
67 @param mac_address - mac addr to assign to the interface if use_radom not set
78 u32 custom_dev_instance;
81 /** \brief Reply for tap modify request
82 @param context - returned sender context, to match reply w/ request
83 @param retval - return code
84 @param sw_if_index - software index if the modified tap interface
86 define tap_modify_reply
93 /** \brief Delete tap interface
94 @param client_index - opaque cookie to identify the sender
95 @param context - sender context, to match reply w/ request
96 @param sw_if_index - interface index of existing tap interface
98 autoreply define tap_delete
105 /** \brief Dump tap interfaces request */
106 define sw_interface_tap_dump
112 /** \brief Reply for tap dump request
113 @param sw_if_index - software index of tap interface
114 @param dev_name - Linux tap device name
116 define sw_interface_tap_details