API: Cleanup APIs interface.api

Use of consistent API types for interface.api

Change-Id: Ieb54cebb4ac96b432a3f0b41596718aa2f34885b
Signed-off-by: Jakub Grajciar <jgrajcia@cisco.com>

1 files changed, 97 insertions, 124 deletions

diff --git a/src/vnet/interface.api b/src/vnet/interface.api
index 1af323e0a44..cae2b65778e 100644
--- a/src/vnet/interface.api
+++ b/src/vnet/interface.api
@@ -14,9 +14,11 @@
  * limitations under the License.
  */
 
-option version = "2.2.0";
+option version = "3.0.0";
 
 import "vnet/interface_types.api";
+import "vnet/ethernet/ethernet_types.api";
+import "vnet/ip/ip_types.api";
 
 service {
   rpc want_interface_events returns want_interface_events_reply
@@ -27,16 +29,15 @@ service {
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param sw_if_index - index of the interface to set flags on
-    @param admin_up_down - set the admin state, 1 = up, 0 = down
-    @param link_up_down - Oper state sent on change event, not used in config.
+    @param flags - interface_status flags
+        (only IF_STATUS_API_FLAG_ADMIN_UP used in config)
 */
 autoreply define sw_interface_set_flags
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
-  /* 1 = up, 0 = down */
-  u8 admin_up_down;
+  vl_api_interface_index_t sw_if_index;
+  vl_api_if_status_flags_t flags;
 };
 
 /** \brief Set interface physical MTU
@@ -49,7 +50,7 @@ autoreply define hw_interface_set_mtu
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
   u16 mtu;
 };
 
@@ -58,9 +59,8 @@ autoreply define sw_interface_set_mtu
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
-  /* $$$$ Replace with enum */
-  u32 mtu[4]; /* 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
+  vl_api_interface_index_t sw_if_index;
+  u32 mtu[4]; /* vl_api_mtu_proto_t 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
 };
 
 /** \brief Set IP4 directed broadcast
@@ -73,8 +73,8 @@ autoreply define sw_interface_set_ip_directed_broadcast
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
-  u8  enable;
+  vl_api_interface_index_t sw_if_index;
+  bool  enable;
 };
 
 
@@ -82,18 +82,16 @@ autoreply define sw_interface_set_ip_directed_broadcast
     @param client_index - opaque cookie to identify the sender
     @param pid - client pid registered to receive notification
     @param sw_if_index - index of the interface of the event
-    @param admin_up_down - The administrative state; 1 = up, 0 = down
-    @param link_up_down - The operational state; 1 = up, 0 = down
+    @param flags - interface_status flags
     @param deleted - interface was deleted
 */
 define sw_interface_event
 {
   u32 client_index;
   u32 pid;
-  u32 sw_if_index;
-  u8 admin_up_down;
-  u8 link_up_down;
-  u8 deleted;
+  vl_api_interface_index_t sw_if_index;
+  vl_api_if_status_flags_t flags;
+  bool deleted;
 };
 
 /** \brief Register for interface events
@@ -110,25 +108,19 @@ autoreply define want_interface_events
   u32 pid;
 };
 
-/** \brief Interface details structure (fix this) 
+/** \brief Interface details structure (fix this)
     @param sw_if_index - index of the interface
-    @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index  
-    @param l2_address_length - length of the interface's l2 address
-    @param pid - the interface's l2 address
-    @param interface_name - name of the interface
+    @param sup_sw_if_index - index of parent interface if any, else same as sw_if_index
+    @param l2_address - the interface's l2 address
+    @param flags - interface_status flags
     @param link_duplex - 1 if half duplex, 2 if full duplex
     @param link_speed - value in kbps
     @param link_MTU - max. transmission unit
-    @param sub_if_id - A number 0-N to uniquely identify this subif on super if
-    @param sub_dot1ad - 0 = dot1q, 1 = dot1ad
-    @param sub_dot1ah - 1 = dot1ah, 0 = otherwise
+    @param sub_id - A number 0-N to uniquely identify this subif on super if
     @param sub_number_of_tags - Number of tags (0 - 2)
     @param sub_outer_vlan_id
     @param sub_inner_vlan_id
-    @param sub_exact_match
-    @param sub_default
-    @param sub_outer_vlan_id_any
-    @param sub_inner_vlan_id_any
+    @param sub_if_flags - sub interface flags
     @param vtr_op - vlan tag rewrite operation
     @param vtr_push_dot1q
     @param vtr_tag1
@@ -138,29 +130,25 @@ autoreply define want_interface_events
     @param pbb_b_smac[6] - B-tag local mac address
     @param pbb_b_vlanid - B-tag vlanid
     @param pbb_i_sid - I-tag service id
+    @param interface_name - name of the interface
+    @param tag - an ascii tag
 */
 define sw_interface_details
 {
   u32 context;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 
   /* index of sup interface (e.g. hw interface).
      equal to sw_if_index for super hw interface. */
   u32 sup_sw_if_index;
 
   /* Layer 2 address, if applicable */
-  u32 l2_address_length;
-  u8 l2_address[8];
-
-  /* Interface name */
-  u8 interface_name[64];
+  vl_api_mac_address_t l2_address;
 
-  /* 1 = up, 0 = down */
-  u8 admin_up_down;
-  u8 link_up_down;
+  vl_api_if_status_flags_t flags;
 
   /* 1 = half duplex, 2 = full duplex */
-  u8 link_duplex;
+  vl_api_link_duplex_t link_duplex;
 
   /* link speed in kbps */
   u32 link_speed;
@@ -169,38 +157,34 @@ define sw_interface_details
   u16 link_mtu;
 
   /* Per protocol MTUs */
-  u32 mtu[4]; /* 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
+  u32 mtu[4]; /* vl_api_mtu_proto_t 0 - L3, 1 - IP4, 2 - IP6, 3 - MPLS */
 
   /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface */
   u32 sub_id;
 
-  /* 0 = dot1q, 1=dot1ad */
-  u8 sub_dot1ad;
-  /* 1 = dot1h, 1=otherwise */
-  u8 sub_dot1ah;
-
   /* Number of tags 0-2 */
   u8 sub_number_of_tags;
   u16 sub_outer_vlan_id;
   u16 sub_inner_vlan_id;
-  u8 sub_exact_match;
-  u8 sub_default;
-  u8 sub_outer_vlan_id_any;
-  u8 sub_inner_vlan_id_any;
+
+  vl_api_sub_if_flags_t sub_if_flags;
 
   /* vlan tag rewrite state */
   u32 vtr_op;
   u32 vtr_push_dot1q;		// ethertype of first pushed tag is dot1q/dot1ad
   u32 vtr_tag1;			// first pushed tag
   u32 vtr_tag2;			// second pushed tag
-  u8 tag[64];
-  
+
   /* pbb tag rewrite info */
   u16 outer_tag;
-  u8  b_dmac[6];
-  u8  b_smac[6];
+  vl_api_mac_address_t  b_dmac;
+  vl_api_mac_address_t  b_smac;
   u16 b_vlanid;
   u32 i_sid;
+
+  /* Interface name */
+  string interface_name;
+  string tag;
 };
 
 /** \brief Request all or filtered subset of sw_interface_details
@@ -214,30 +198,27 @@ define sw_interface_dump
 {
   u32 client_index;
   u32 context;
-  u8 name_filter_valid;
-  u8 name_filter[49];
+  bool name_filter_valid;
+  string name_filter;
 };
 
 /** \brief Set or delete one or all ip addresses on a specified interface
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param sw_if_index - index of the interface to add/del addresses 
+    @param sw_if_index - index of the interface to add/del addresses
     @param is_add - add address if non-zero, else delete
-    @param is_ipv6 - if non-zero the address is ipv6, else ipv4
     @param del_all - if non-zero delete all addresses on the interface
-    @param address_length - address length in bytes, 4 for ip4, 16 for ip6
-    @param address - array of address bytes
+    @param prefix - address + a prefix length for the implied connected route
 */
 autoreply define sw_interface_add_del_address
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
-  u8 is_add;
-  u8 is_ipv6;
-  u8 del_all;
-  u8 address_length;
-  u8 address[16];
+  vl_api_interface_index_t sw_if_index;
+  bool is_add;
+
+  bool del_all;
+  vl_api_prefix_t prefix;
 };
 
 /** \brief Associate the specified interface with a fib table
@@ -251,8 +232,8 @@ autoreply define sw_interface_set_table
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
-  u8 is_ipv6;
+  vl_api_interface_index_t sw_if_index;
+  bool is_ipv6;
   u32 vrf_id;
 };
 
@@ -265,8 +246,8 @@ define sw_interface_get_table
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
-  u8 is_ipv6;
+  vl_api_interface_index_t sw_if_index;
+  bool is_ipv6;
 };
 
 /** \brief Reply to get_sw_interface_vrf
@@ -291,9 +272,9 @@ autoreply define sw_interface_set_unnumbered
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;		/* use this intfc address */
-  u32 unnumbered_sw_if_index;	/* on this interface */
-  u8 is_add;
+  vl_api_interface_index_t sw_if_index;		/* use this intfc address */
+  vl_api_interface_index_t unnumbered_sw_if_index;	/* on this interface */
+  bool is_add;
 };
 
 /** \brief Clear interface statistics
@@ -305,7 +286,7 @@ autoreply define sw_interface_clear_stats
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 };
 
 /** \brief Set / clear software interface tag
@@ -315,13 +296,13 @@ autoreply define sw_interface_clear_stats
     @param add_del - 1 = add, 0 = delete
     @param tag - an ascii tag
 */
-autoreply define sw_interface_tag_add_del 
+autoreply define sw_interface_tag_add_del
 {
-    u32 client_index;
-    u32 context;
-    u8 is_add;
-    u32 sw_if_index;
-    u8 tag[64];
+  u32 client_index;
+  u32 context;
+  bool is_add;
+  vl_api_interface_index_t sw_if_index;
+  string tag;
 };
 
 /** \brief Set an interface's MAC address
@@ -332,10 +313,10 @@ autoreply define sw_interface_tag_add_del
 */
 autoreply define sw_interface_set_mac_address
 {
-    u32 client_index;
-    u32 context;
-    u32 sw_if_index;
-    u8 mac_address[6];
+  u32 client_index;
+  u32 context;
+  vl_api_interface_index_t sw_if_index;
+  vl_api_mac_address_t mac_address;
 };
 
 /** \brief Get interface's MAC address
@@ -345,9 +326,9 @@ autoreply define sw_interface_set_mac_address
 */
 define sw_interface_get_mac_address
 {
-    u32 client_index;
-    u32 context;
-    u32 sw_if_index;
+  u32 client_index;
+  u32 context;
+  vl_api_interface_index_t sw_if_index;
 };
 
 /** \brief Reply for get interface's MAC address request
@@ -357,9 +338,9 @@ define sw_interface_get_mac_address
 */
 define sw_interface_get_mac_address_reply
 {
-    u32 context;
-    i32 retval;
-    u8 mac_address[6];
+  u32 context;
+  i32 retval;
+  vl_api_mac_address_t mac_address;
 };
 
 /** \brief Set an interface's rx-mode
@@ -374,12 +355,12 @@ define sw_interface_get_mac_address_reply
 */
 autoreply define sw_interface_set_rx_mode
 {
-    u32 client_index;
-    u32 context;
-    u32 sw_if_index;
-    u8 queue_id_valid;
-    u32 queue_id;
-    u8 mode;
+  u32 client_index;
+  u32 context;
+  vl_api_interface_index_t sw_if_index;
+  bool queue_id_valid;
+  u32 queue_id;
+  vl_api_rx_mode_t mode;
 };
 
 /** \brief Set an interface's rx-placement
@@ -397,10 +378,10 @@ autoreply define sw_interface_set_rx_placement
 {
     u32 client_index;
     u32 context;
-    u32 sw_if_index;
+    vl_api_interface_index_t sw_if_index;
     u32 queue_id;
     u32 worker_id;
-    u8 is_main;
+    bool is_main;
 };
 
 /** \brief dump the rx queue placement of interface(s)
@@ -413,7 +394,7 @@ define sw_interface_rx_placement_dump
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 };
 
 /** \brief show the interface's queue - thread placement
@@ -435,10 +416,10 @@ define sw_interface_rx_placement_details
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
   u32 queue_id;
   u32 worker_id;
-  u8 mode;
+  vl_api_rx_mode_t mode;
 };
 
 /* Gross kludge, DGMS */
@@ -446,7 +427,7 @@ autoreply define interface_name_renumber
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
   u32 new_show_dev_instance;
 };
 
@@ -454,18 +435,10 @@ define create_subif
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
   u32 sub_id;
 
-  /* These fields map directly onto the subif template */
-  u8 no_tags;
-  u8 one_tag;
-  u8 two_tags;
-  u8 dot1ad;			// 0 = dot1q, 1=dot1ad
-  u8 exact_match;
-  u8 default_sub;
-  u8 outer_vlan_id_any;
-  u8 inner_vlan_id_any;
+  vl_api_sub_if_flags_t sub_if_flags;
   u16 outer_vlan_id;
   u16 inner_vlan_id;
 };
@@ -474,7 +447,7 @@ define create_subif_reply
 {
   u32 context;
   i32 retval;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 };
 
 /** \brief Create a new subinterface with the given vlan id
@@ -487,7 +460,7 @@ define create_vlan_subif
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
   u32 vlan_id;
 };
 
@@ -500,7 +473,7 @@ define create_vlan_subif_reply
 {
   u32 context;
   i32 retval;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 };
 
 /** \brief Delete sub interface request
@@ -511,7 +484,7 @@ define create_vlan_subif_reply
 autoreply define delete_subif {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 };
 
 /** \brief Create loopback interface request
@@ -523,7 +496,7 @@ define create_loopback
 {
   u32 client_index;
   u32 context;
-  u8 mac_address[6];
+  vl_api_mac_address_t mac_address;
 };
 
 /** \brief Create loopback interface response
@@ -535,7 +508,7 @@ define create_loopback_reply
 {
   u32 context;
   i32 retval;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 };
 
 /** \brief Create loopback interface instance request
@@ -549,8 +522,8 @@ define create_loopback_instance
 {
   u32 client_index;
   u32 context;
-  u8 mac_address[6];
-  u8 is_specified;
+  vl_api_mac_address_t mac_address;
+  bool is_specified;
   u32 user_instance;
 };
 
@@ -563,7 +536,7 @@ define create_loopback_instance_reply
 {
   u32 context;
   i32 retval;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 };
 
 /** \brief Delete loopback interface request
@@ -575,7 +548,7 @@ autoreply define delete_loopback
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 };
 
 /** \brief Enable or disable detailed interface stats
@@ -589,8 +562,8 @@ autoreply define collect_detailed_interface_stats
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
-  u8  enable_disable;
+  vl_api_interface_index_t sw_if_index;
+  bool  enable_disable;
 };
 
 /*