diff options
author | Damjan Marion <damarion@cisco.com> | 2017-12-04 15:25:58 +0100 |
---|---|---|
committer | Damjan Marion <dmarion.lists@gmail.com> | 2017-12-04 17:08:28 +0000 |
commit | c99b4cd1c3aae9ca3bda0595a5cce4ea5e6ba84f (patch) | |
tree | 7364a65a5790a43a63f2fe3f231fd0094a962e11 /src/vnet/devices/tap/tapv2.api | |
parent | ffffb15fb5d6dcd5f0afd69652aa33a4e9894152 (diff) |
tap_v2: move code to vnet/devices/tap
virtio backend stays in vnet/devices/virtio
Change-Id: Idbf04f1c645a809ed408670ba330662859fe9309
Signed-off-by: Damjan Marion <damarion@cisco.com>
Diffstat (limited to 'src/vnet/devices/tap/tapv2.api')
-rw-r--r-- | src/vnet/devices/tap/tapv2.api | 110 |
1 files changed, 110 insertions, 0 deletions
diff --git a/src/vnet/devices/tap/tapv2.api b/src/vnet/devices/tap/tapv2.api new file mode 100644 index 00000000000..03788607fe5 --- /dev/null +++ b/src/vnet/devices/tap/tapv2.api @@ -0,0 +1,110 @@ +/* + * 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 use_random_mac - let the system generate a unique mac address + @param tap_name - name to associate with the new interface + @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_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; + u8 use_random_mac; + u8 tap_name[64]; + 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_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: + */ |