Refactor tap binary APIs, VPP-550
[vpp.git] / vpp / vpp-api / vpe.api
index 537f568..5116cbf 100644 (file)
  * If you're looking for interface APIs, please
  * see .../vnet/vnet/{interface.api,interface_api.c}
  * IP APIs: see .../vnet/vnet/ip/{ip.api, ip_api.c}
+ * TAP APIs: see .../vnet/vnet/unix/{tap.api, tap_api.c}
  */
 
-/** \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
-*/
-define tap_connect
-{
-  u32 client_index;
-  u32 context;
-  u8 use_random_mac;
-  u8 tap_name[64];
-  u8 mac_address[6];
-  u8 renumber;
-  u32 custom_dev_instance;
-  u8 tag[64];
-};
-
-/** \brief Reply for tap connect request
-    @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_connect_reply
-{
-  u32 context;
-  i32 retval;
-  u32 sw_if_index;
-};
-
-/** \brief Modify a 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 sw_if_index - interface index of existing tap interface
-    @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
-*/
-define tap_modify
-{
-  u32 client_index;
-  u32 context;
-  u32 sw_if_index;
-  u8 use_random_mac;
-  u8 tap_name[64];
-  u8 mac_address[6];
-  u8 renumber;
-  u32 custom_dev_instance;
-};
-
-/** \brief Reply for tap modify request
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-    @param sw_if_index - software index if the modified tap interface
-*/
-define tap_modify_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
-*/
-define tap_delete
-{
-  u32 client_index;
-  u32 context;
-  u32 sw_if_index;
-};
-
-/** \brief Reply for tap delete request
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define tap_delete_reply
-{
-  u32 context;
-  i32 retval;
-};
-
-/** \brief Dump tap interfaces request */
-define sw_interface_tap_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_details
-{
-  u32 context;
-  u32 sw_if_index;
-  u8 dev_name[64];
-};
-
 /** \brief Create a new subinterface with the given vlan id
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request