lisp: API cleanup
[vpp.git] / src / vnet / lisp-gpe / lisp_gpe.api
index 48baa2f..9fbd795 100644 (file)
  * limitations under the License.
  */
 
-/** \brief LISP locator structure
+option version = "2.0.0";
+
+import "vnet/interface_types.api";
+import "vnet/lisp-cp/lisp_types.api";
+
+/** \brief GPE locator structure
     @param is_ip4 - whether addr is IPv4 or v6
     @param weight - locator weight
     @param addr - IPv4/6 address
 */
-typeonly manual_print manual_endian define lisp_gpe_locator
+typedef gpe_locator
 {
-  u8 is_ip4;
   u8 weight;
-  u8 addr[16];
+  vl_api_address_t addr;
 };
 
-/** \brief add or delete lisp gpe tunnel
+/** \brief add or delete GPE tunnel
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param is_add - add address if non-zero, else delete
@@ -43,53 +47,37 @@ typeonly manual_print manual_endian define lisp_gpe_locator
     @param loc_num - number of locators
     @param locs - array of remote locators
 */
-manual_print manual_endian define lisp_gpe_add_del_fwd_entry
+manual_print manual_endian define gpe_add_del_fwd_entry
 {
   u32 client_index;
   u32 context;
-  u8 is_add;
-  u8 eid_type;
-  u8 rmt_eid[16];
-  u8 lcl_eid[16];
-  u8 rmt_len;
-  u8 lcl_len;
+  bool is_add [default=true];
+  vl_api_eid_t rmt_eid;
+  vl_api_eid_t lcl_eid;
   u32 vni;
   u32 dp_table;
   u8 action;
   u32 loc_num;
-  vl_api_lisp_gpe_locator_t locs[loc_num];
+  vl_api_gpe_locator_t locs[loc_num];
 };
 
-/** \brief Reply for gpe_fwd_entry add/del
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define lisp_gpe_add_del_fwd_entry_reply
+define gpe_add_del_fwd_entry_reply
 {
   u32 context;
   i32 retval;
+  u32 fwd_entry_index;
 };
 
-/** \brief enable or disable lisp-gpe protocol
+/** \brief enable or disable gpe protocol
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param is_en - enable protocol if non-zero, else disable
+    @param is_enable [default=true] - enable protocol if non-zero, else disable
 */
-define lisp_gpe_enable_disable
+autoreply define gpe_enable_disable
 {
   u32 client_index;
   u32 context;
-  u8 is_en;
-};
-
-/** \brief Reply for gpe enable/disable
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define lisp_gpe_enable_disable_reply
-{
-  u32 context;
-  i32 retval;
+  bool is_enable [default=true];
 };
 
 /** \brief add or delete gpe_iface
@@ -97,65 +85,155 @@ define lisp_gpe_enable_disable_reply
     @param context - sender context, to match reply w/ request
     @param is_add - add address if non-zero, else delete
 */
-define lisp_gpe_add_del_iface
+autoreply define gpe_add_del_iface
 {
   u32 client_index;
   u32 context;
-  u8 is_add;
-  u8 is_l2;
+  bool is_add [default=true];
+  bool is_l2;
   u32 dp_table;
   u32 vni;
 };
 
-/** \brief Reply for gpe_iface add/del
-    @param context - returned sender context, to match reply w/ request
-    @param retval - return code
-*/
-define lisp_gpe_add_del_iface_reply
+define gpe_fwd_entry_vnis_get
+{
+  u32 client_index;
+  u32 context;
+};
+
+manual_print manual_endian define gpe_fwd_entry_vnis_get_reply
 {
   u32 context;
   i32 retval;
+  u32 count;
+  u32 vnis[count];
 };
 
-define lisp_gpe_fwd_entries_get
+define gpe_fwd_entries_get
 {
   u32 client_index;
   u32 context;
   u32 vni;
 };
 
-typeonly manual_print manual_endian define lisp_gpe_fwd_entry
+typedef gpe_fwd_entry
 {
   u32 fwd_entry_index;
   u32 dp_table;
-  u8 eid_type;
-  u8 leid_prefix_len;
-  u8 reid_prefix_len;
-  u8 leid[16];
-  u8 reid[16];
+  vl_api_eid_t leid;
+  vl_api_eid_t reid;
+  u32 vni;
+  u8 action;
 };
 
-manual_print manual_endian define lisp_gpe_fwd_entries_get_reply
+manual_print manual_endian define gpe_fwd_entries_get_reply
 {
   u32 context;
   i32 retval;
   u32 count;
-  vl_api_lisp_gpe_fwd_entry_t entries[count];
+  vl_api_gpe_fwd_entry_t entries[count];
 };
 
-define lisp_gpe_fwd_entry_path_dump
+define gpe_fwd_entry_path_dump
 {
   u32 client_index;
   u32 context;
   u32 fwd_entry_index;
 };
 
-manual_endian manual_print define lisp_gpe_fwd_entry_path_details
+manual_endian manual_print define gpe_fwd_entry_path_details
+{
+  u32 context;
+  vl_api_gpe_locator_t lcl_loc;
+  vl_api_gpe_locator_t rmt_loc;
+};
+
+/** \brief Set GPE encapsulation mode
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param mode - LISP (value 0) or VXLAN (value 1)
+*/
+autoreply define gpe_set_encap_mode
+{
+  u32 client_index;
+  u32 context;
+  bool is_vxlan;
+};
+
+/** \brief get GPE encapsulation mode
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param mode - LISP (value 0) or VXLAN (value 1)
+*/
+define gpe_get_encap_mode
+{
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief Reply for set_encap_mode
+    @param context - returned sender context, to match reply w/ request
+    @param retval - return code
+    @param encap_mode - GPE encapsulation mode
+*/
+define gpe_get_encap_mode_reply
+{
+  u32 context;
+  i32 retval;
+  /* FIXME: gpe encap enum */
+  u8 encap_mode;
+};
+
+/** \brief Add native fwd rpath
+    @param context - returned sender context, to match reply w/ request
+    @param retval - return code
+    @param is_add - flag to indicate add or del
+    @param table_id - table id for route path
+    @param nh_sw_if_index - next-hop sw_if_index (~0 if not set)
+    @param is_ip4 - flag to indicate if nh is ip4
+    @param nh_addr - next hop ip address
+*/
+autoreply define gpe_add_del_native_fwd_rpath
+{
+  u32 client_index;
+  u32 context;
+  bool is_add [default=true];
+  u32 table_id;
+  vl_api_interface_index_t nh_sw_if_index;
+  vl_api_address_t nh_addr;
+};
+
+/** \brief get GPE native fwd rpath
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+*/
+define gpe_native_fwd_rpaths_get
 {
   u32 client_index;
   u32 context;
-  vl_api_lisp_gpe_locator_t lcl_loc;
-  vl_api_lisp_gpe_locator_t rmt_loc;
+  bool is_ip4;
+};
+
+/** \brief Reply for get native fwd rpath
+    @param context - returned sender context, to match reply w/ request
+    @param retval - return code
+    @param table_id - table id for route path
+    @param nh_sw_if_index - next-hop sw_if_index (~0 if not set)
+    @param nh_addr - next hop address
+*/
+typedef gpe_native_fwd_rpath
+{
+  u32 fib_index;
+  vl_api_interface_index_t nh_sw_if_index;
+  vl_api_address_t nh_addr;
+};
+
+manual_print manual_endian define gpe_native_fwd_rpaths_get_reply
+{
+  u32 context;
+  i32 retval;
+  u32 count;
+  vl_api_gpe_native_fwd_rpath_t entries[count];
 };
 
 /*
@@ -163,4 +241,3 @@ manual_endian manual_print define lisp_gpe_fwd_entry_path_details
  * eval: (c-set-style "gnu")
  * End:
  */