API: Cleaning up message naming that does not follow the conventions
[vpp.git] / src / vnet / l2 / l2.api
index 5b24f25..bb3990c 100644 (file)
@@ -36,7 +36,7 @@ define l2_xconnect_dump
   u32 context;
 };
 
-/** \brief l2 fib table entry structure
+/** \brief l2 fib table details structure
     @param bd_id - the l2 fib / bridge domain table id
     @param mac - the entry's mac address
     @param sw_if_index - index of the interface
@@ -44,7 +44,7 @@ define l2_xconnect_dump
     @param filter_mac - the entry is a mac filter entry.
     @param bvi_mac - the mac address is a bridge virtual interface
 */
-define l2_fib_table_entry
+define l2_fib_table_details
 {
   u32 context;
   u32 bd_id;
@@ -70,20 +70,44 @@ define l2_fib_table_dump
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
 */
-define l2_fib_clear_table
+autoreply define l2_fib_clear_table
 {
   u32 client_index;
   u32 context;
 };
 
-/** \brief L2 fib clear table response
+/** \brief L2 FIB flush all  entries
+    @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param retval - return code for the request
 */
-define l2_fib_clear_table_reply
+autoreply define l2fib_flush_all
 {
+  u32 client_index;
   u32 context;
-  i32 retval;
+};
+
+/** \brief L2 FIB flush bridge domain entries
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param bd_id - the entry's bridge domain id
+*/
+autoreply define l2fib_flush_bd
+{
+  u32 client_index;
+  u32 context;
+  u32 bd_id;
+};
+
+/** \brief L2 FIB flush interface entries
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param bd_id - the entry's bridge domain id
+*/
+autoreply define l2fib_flush_int
+{
+  u32 client_index;
+  u32 context;
+  u32 sw_if_index;
 };
 
 /** \brief L2 FIB add entry request
@@ -96,7 +120,7 @@ define l2_fib_clear_table_reply
     @param static_mac - 
     @param filter_mac -
 */
-define l2fib_add_del
+autoreply define l2fib_add_del
 {
   u32 client_index;
   u32 context;
@@ -109,16 +133,6 @@ define l2fib_add_del
   u8 bvi_mac;
 };
 
-/** \brief L2 FIB add entry response
-    @param context - sender context, to match reply w/ request
-    @param retval - return code for the add l2fib entry request
-*/
-define l2fib_add_del_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -146,6 +160,20 @@ define l2_flags_reply
   u32 resulting_feature_bitmap;
 };
 
+/** \brief L2 bridge domain set mac age
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param bd_id - the bridge domain to create
+    @param mac_age - mac aging time in min, 0 for disabled
+*/
+autoreply define bridge_domain_set_mac_age
+{
+  u32 client_index;
+  u32 context;
+  u32 bd_id;
+  u8 mac_age;
+};
+
 /** \brief L2 bridge domain add or delete request
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -158,7 +186,7 @@ define l2_flags_reply
     @param mac_age - mac aging time in min, 0 for disabled
     @param is_add - add or delete flag
 */
-define bridge_domain_add_del
+autoreply define bridge_domain_add_del
 {
   u32 client_index;
   u32 context;
@@ -172,16 +200,6 @@ define bridge_domain_add_del
   u8 is_add;
 };
 
-/** \brief L2 bridge domain add or delete response
-    @param context - sender context, to match reply w/ request
-    @param retval - return code for the set bridge flags request
-*/
-define bridge_domain_add_del_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief L2 bridge domain request operational state details
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -194,6 +212,18 @@ define bridge_domain_dump
   u32 bd_id;
 };
 
+/** \brief L2 bridge domain sw interface operational state response
+    @param bd_id - the bridge domain id
+    @param sw_if_index - sw_if_index in the domain
+    @param shg - split horizon group for the interface
+*/
+typeonly manual_print manual_endian define bridge_domain_sw_if
+{
+  u32 context;
+  u32 sw_if_index;
+  u8 shg;
+};
+
 /** \brief L2 bridge domain operational state response
     @param bd_id - the bridge domain id
     @param flood - bcast/mcast flooding state on all interfaces in the bd
@@ -204,7 +234,7 @@ define bridge_domain_dump
     @param mac_age - mac aging time in min, 0 for disabled
     @param n_sw_ifs - number of sw_if_index's in the domain
 */
-define bridge_domain_details
+manual_print manual_endian define bridge_domain_details
 {
   u32 context;
   u32 bd_id;
@@ -216,19 +246,7 @@ define bridge_domain_details
   u8 mac_age;
   u32 bvi_sw_if_index;
   u32 n_sw_ifs;
-};
-
-/** \brief L2 bridge domain sw interface operational state response
-    @param bd_id - the bridge domain id
-    @param sw_if_index - sw_if_index in the domain
-    @param shg - split horizon group for the interface
-*/
-define bridge_domain_sw_if_details
-{
-  u32 context;
-  u32 bd_id;
-  u32 sw_if_index;
-  u8 shg;
+  vl_api_bridge_domain_sw_if_t sw_if_details[n_sw_ifs];
 };
 
 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD, 
@@ -260,6 +278,51 @@ define bridge_flags_reply
   u32 resulting_feature_bitmap;
 };
 
+/** \brief L2 interface vlan tag rewrite configure request
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param sw_if_index - interface the operation is applied to
+    @param vtr_op - Choose from l2_vtr_op_t enum values
+    @param push_dot1q - first pushed flag dot1q id set, else dot1ad
+    @param tag1 - Needed for any push or translate vtr op
+    @param tag2 - Needed for any push 2 or translate x-2 vtr ops
+*/
+autoreply define l2_interface_vlan_tag_rewrite
+{
+  u32 client_index;
+  u32 context;
+  u32 sw_if_index;
+  u32 vtr_op;
+  u32 push_dot1q;              // ethertype of first pushed tag is dot1q/dot1ad
+  u32 tag1;                    // first pushed tag
+  u32 tag2;                    // second pushed tag
+};
+
+/** \brief L2 interface pbb tag rewrite configure request
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param sw_if_index - interface the operation is applied to
+    @param vtr_op - Choose from l2_vtr_op_t enum values
+    @param inner_tag - needed for translate_qinq vtr op only
+    @param outer_tag - needed for translate_qinq vtr op only 
+    @param b_dmac - B-tag remote mac address, needed for any push or translate_qinq vtr op
+    @param b_smac - B-tag local mac address, needed for any push or translate qinq vtr op
+    @param b_vlanid - B-tag vlanid, needed for any push or translate qinq vtr op
+    @param i_sid - I-tag service id, needed for any push or translate qinq vtr op
+*/
+autoreply define l2_interface_pbb_tag_rewrite
+{
+  u32 client_index;
+  u32 context;
+  u32 sw_if_index;
+  u32 vtr_op;
+  u16 outer_tag;
+  u8  b_dmac[6];
+  u8  b_smac[6];
+  u16 b_vlanid;
+  u32 i_sid;
+};
+
 /*
  * Local Variables:
  * eval: (c-set-style "gnu")