docs: devices-- add FEATURES.yaml
[vpp.git] / src / vnet / devices / tap / tapv2.api
index 167b7a6..dee7304 100644 (file)
     the Linux kernel TAP device driver
 */
 
-option version = "2.0.0";
+option version = "2.1.0";
 
-/** \brief Initialize a new tap interface with the given paramters
+/** \brief Initialize a new tap interface with the given parameters
     @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 id - interface id, 0xffffffff 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 mac_address - mac addr to assign to the interface if use_random 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_set - host namespace 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
@@ -47,6 +47,9 @@ option version = "2.0.0";
     @param host_ip4_gw - host IPv4 default gateway
     @param host_ip6_gw_set - host IPv6 default gateway should be set
     @param host_ip6_gw - host IPv6 default gateway
+    @param host_mtu_set - host MTU should be set
+    @param host_mtu_size - host MTU size
+    @param tap_flags - flags for the TAP interface creation
 */
 define tap_create_v2
 {
@@ -75,7 +78,10 @@ define tap_create_v2
   u8 host_ip4_gw[4];
   u8 host_ip6_gw_set;
   u8 host_ip6_gw[16];
+  u8 host_mtu_set;
+  u32 host_mtu_size;
   u8 tag[64];
+  u32 tap_flags;
 };
 
 /** \brief Reply for tap create reply
@@ -123,6 +129,7 @@ define sw_interface_tap_v2_dump
     @param host_ip4_prefix_len - host IPv4 ip address prefix length; 0 if unset
     @param host_ip6_addr - host IPv6 ip address
     @param host_ip6_prefix_len - host IPv6 ip address prefix length; 0 if unset
+    @param host_mtu_size - host mtu size
 */
 define sw_interface_tap_v2_details
 {
@@ -140,6 +147,8 @@ define sw_interface_tap_v2_details
   u8 host_ip4_prefix_len;
   u8 host_ip6_addr[16];
   u8 host_ip6_prefix_len;
+  u32 host_mtu_size;
+  u32 tap_flags;
 };
 
 /*