X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fl2%2Fl2.api;h=fdb7db7551d2f46d62c9e8266cf95a31b1312c08;hb=bdc0e6b7204ea0211d4f7881497e4306586fb9ef;hp=c23eebeca8c519681f1ea7d3c96a35cf33ce5ae6;hpb=f24991cab4a899f9e36e7f12ca61c591fedde249;p=vpp.git

diff --git a/src/vnet/l2/l2.api b/src/vnet/l2/l2.api
index c23eebeca8c..fdb7db7551d 100644
--- a/src/vnet/l2/l2.api
+++ b/src/vnet/l2/l2.api
@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+option version = "2.0.1";
+
 /** \brief Reply to l2_xconnect_dump 
     @param context - sender context which was passed in the request
     @param rx_sw_if_index - Receive interface index
@@ -36,7 +38,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,11 +46,11 @@ 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;
-  u64 mac;
+  u8 mac[6];
   u32 sw_if_index;
   u8 static_mac;
   u8 filter_mac;
@@ -70,20 +72,20 @@ 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
@@ -91,45 +93,25 @@ define l2_fib_clear_table_reply
     @param context - sender context, to match reply w/ request
     @param bd_id - the entry's bridge domain id
 */
-define l2fib_flush_bd
+autoreply define l2fib_flush_bd
 {
   u32 client_index;
   u32 context;
   u32 bd_id;
 };
 
-/** \brief L2 FIB flush bridge domain entries response
-    @param context - sender context, to match reply w/ request
-    @param retval - return code for the request
-*/
-define l2fib_flush_bd_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \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
 */
-define l2fib_flush_int
+autoreply define l2fib_flush_int
 {
   u32 client_index;
   u32 context;
   u32 sw_if_index;
 };
 
-/** \brief L2 FIB flush interface entries response
-    @param context - sender context, to match reply w/ request
-    @param retval - return code for the request
-*/
-define l2fib_flush_int_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \brief L2 FIB add entry request
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
@@ -140,11 +122,11 @@ define l2fib_flush_int_reply
     @param static_mac - 
     @param filter_mac -
 */
-define l2fib_add_del
+autoreply define l2fib_add_del
 {
   u32 client_index;
   u32 context;
-  u64 mac;
+  u8 mac[6];
   u32 bd_id;
   u32 sw_if_index;
   u8 is_add;
@@ -153,22 +135,70 @@ define l2fib_add_del
   u8 bvi_mac;
 };
 
-/** \brief L2 FIB add entry response
+/** \brief Register to receive L2 MAC events for learned and aged MAC
+    @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param retval - return code for the add l2fib entry request
+    @param learn_limit - MAC learn limit, 0 => default to 1000
+    @param scan_delay - event scan delay in 10 msec unit, 0 => default to 100 msec
+    @param max_macs_in_event - in units of 10 mac entries, 0 => default to 100 entries
+    @param enable_disable - 1 => register for MAC events, 0 => cancel registration
+    @param pid - sender's pid
 */
-define l2fib_add_del_reply
+autoreply define want_l2_macs_events
 {
+  u32 client_index;
   u32 context;
-  i32 retval;
+  u32 learn_limit;
+  u8  scan_delay;
+  u8  max_macs_in_event;
+  u8  enable_disable;
+  u32 pid;
+};
+
+/** \brief Entry for learned or aged MAC in L2 MAC Events
+    @param sw_if_index - sw_if_index in the domain
+    @param mac_addr - mac_address
+    @param action - 0 => newly learned MAC, 1 => MAC deleted by ager
+                    3 => MAC move (sw_if_index changed)
+    @param flags - flag bits to provide other info, not yet used
+*/
+typeonly define mac_entry
+{
+  u32 sw_if_index;
+  u8  mac_addr[6];
+  u8  action;
+  u8  flags;
 };
 
-/** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
+/** \brief L2 MAC event for a list of learned or aged MACs
+    @param client_index - opaque cookie to identify the sender
+    @param pid - client pid registered to receive notification
+    @param n_macs - number of learned/aged MAC entries
+    @param mac - array of learned/aged MAC entries
+*/
+define l2_macs_event
+{
+  u32 client_index;
+  u32 pid;
+  u32 n_macs;
+  vl_api_mac_entry_t mac[n_macs];
+};
+
+service {
+  rpc want_l2_macs_events returns want_l2_macs_events_reply
+    events l2_macs_event;
+};
+
+/** \brief Set interface L2 flags (such as L2_LEARN, L2_FWD, 
+    L2_FLOOD, L2_UU_FLOOD, or L2_ARP_TERM bits). This can be used
+    to disable one or more of the features represented by the
+    flag bits on an interface to override what is set as default
+    for all interfaces in the bridge domain
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param sw_if_index - interface 
     @param is_set - if non-zero, set the bits, else clear them
-    @param feature_bitmap - non-zero bits to set or clear
+    @param feature_bitmap - non-zero bits (as above) to set or clear
 */
 define l2_flags
 {
@@ -179,9 +209,10 @@ define l2_flags
   u32 feature_bitmap;
 };
 
-/** \brief Set L2 bits response
+/** \brief Set interface L2 flags response
     @param context - sender context, to match reply w/ request
     @param retval - return code for the set l2 bits request
+    @param resulting_feature_bitmap - the internal l2 feature bitmap after the request is implemented
 */
 define l2_flags_reply
 {
@@ -196,7 +227,7 @@ define l2_flags_reply
     @param bd_id - the bridge domain to create
     @param mac_age - mac aging time in min, 0 for disabled
 */
-define bridge_domain_set_mac_age
+autoreply define bridge_domain_set_mac_age
 {
   u32 client_index;
   u32 context;
@@ -204,29 +235,19 @@ define bridge_domain_set_mac_age
   u8 mac_age;
 };
 
-/** \brief Set bridge domain response
-    @param context - sender context, to match reply w/ request
-    @param retval - return code for the set l2 bits request
-*/
-define bridge_domain_set_mac_age_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \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
     @param bd_id - the bridge domain to create
     @param flood - enable/disable bcast/mcast flooding in the bd
-    @param uu_flood - enable/disable uknown unicast flood in the bd
+    @param uu_flood - enable/disable unknown unicast flood in the bd
     @param forward - enable/disable forwarding on all interfaces in the bd
     @param learn - enable/disable learning on all interfaces in the bd
     @param arp_term - enable/disable arp termination in the bd
     @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;
@@ -237,19 +258,10 @@ define bridge_domain_add_del
   u8 learn;
   u8 arp_term;
   u8 mac_age;
+  u8 bd_tag[64];
   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
@@ -262,17 +274,30 @@ 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
-    @param uu_flood - uknown unicast flooding state on all interfaces in the bd
+    @param uu_flood - unknown unicast flooding state on all interfaces in the bd
     @param forward - forwarding state on all interfaces in the bd
     @param learn - learning state on all interfaces in the bd
     @param arp_term - arp termination state on all interfaces in the bd
     @param mac_age - mac aging time in min, 0 for disabled
+    @param bd_tag - optional textual tag for the bridge domain
     @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;
@@ -282,30 +307,19 @@ define bridge_domain_details
   u8 learn;
   u8 arp_term;
   u8 mac_age;
+  u8 bd_tag[64];
   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, 
-    L2_UU_FLOOD, or L2_ARP_TERM) request
+    L2_UU_FLOOD, or L2_ARP_TERM bits) request
     @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 set the flags for
     @param is_set - if non-zero, set the flags, else clear them
-    @param feature_bitmap - bits that are non-zero to set or clear
+    @param feature_bitmap - bits (as above) that are non-zero to set or clear
 */
 define bridge_flags
 {
@@ -319,7 +333,7 @@ define bridge_flags
 /** \brief Set bridge flags response
     @param context - sender context, to match reply w/ request
     @param retval - return code for the set bridge flags request
-    @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
+    @param resulting_feature_bitmap - the internal L2 feature bitmap after the request is implemented
 */
 define bridge_flags_reply
 {
@@ -337,7 +351,7 @@ define bridge_flags_reply
     @param tag1 - Needed for any push or translate vtr op
     @param tag2 - Needed for any push 2 or translate x-2 vtr ops
 */
-define l2_interface_vlan_tag_rewrite
+autoreply define l2_interface_vlan_tag_rewrite
 {
   u32 client_index;
   u32 context;
@@ -348,16 +362,6 @@ define l2_interface_vlan_tag_rewrite
   u32 tag2;			// second pushed tag
 };
 
-/** \brief L2 interface vlan tag rewrite response
-    @param context - sender context, to match reply w/ request
-    @param retval - return code for the request
-*/
-define l2_interface_vlan_tag_rewrite_reply
-{
-  u32 context;
-  i32 retval;
-};
-
 /** \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
@@ -370,7 +374,7 @@ define l2_interface_vlan_tag_rewrite_reply
     @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
 */
-define l2_interface_pbb_tag_rewrite
+autoreply define l2_interface_pbb_tag_rewrite
 {
   u32 client_index;
   u32 context;
@@ -383,14 +387,130 @@ define l2_interface_pbb_tag_rewrite
   u32 i_sid;
 };
 
-/** \brief L2 interface pbb tag rewrite response
+/** \brief L2 interface patch add / del request
+    @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
+    @param rx_sw_if_index - receive side interface 
+    @param tx_sw_if_index - transmit side interface
+    @param is_add - if non-zero set up the interface patch, else remove it
 */
-define l2_interface_pbb_tag_rewrite_reply
+autoreply define l2_patch_add_del
 {
+  u32 client_index;
   u32 context;
-  i32 retval;
+  u32 rx_sw_if_index;
+  u32 tx_sw_if_index;
+  u8 is_add;
+};
+
+/** \brief Set L2 XConnect between two interfaces request
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param rx_sw_if_index - Receive interface index
+    @param tx_sw_if_index - Transmit interface index
+    @param enable - enable xconnect if not 0, else set to L3 mode
+*/
+autoreply define sw_interface_set_l2_xconnect
+{
+  u32 client_index;
+  u32 context;
+  u32 rx_sw_if_index;
+  u32 tx_sw_if_index;
+  u8 enable;
+};
+
+/** \brief Interface bridge mode request
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param rx_sw_if_index - the interface
+    @param bd_id - bridge domain id
+    @param bvi - Setup interface as a bvi, bridge mode only
+    @param shg - Split horizon group, for bridge mode only
+    @param enable - Enable beige mode if not 0, else set to L3 mode
+*/
+autoreply define sw_interface_set_l2_bridge
+{
+  u32 client_index;
+  u32 context;
+  u32 rx_sw_if_index;
+  u32 bd_id;
+  u8 shg;
+  u8 bvi;
+  u8 enable;
+};
+
+/** \brief Set bridge domain ip to mac entry request
+    @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 set the flags for
+    @param is_add - if non-zero, add the entry, else clear it
+    @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
+    @param mac_address - MAC address
+    @param 
+*/
+autoreply define bd_ip_mac_add_del
+{
+  u32 client_index;
+  u32 context;
+  u32 bd_id;
+  u8 is_add;
+  u8 is_ipv6;
+  u8 ip_address[16];
+  u8 mac_address[6];
+};
+
+/** \brief bridge domain IP to MAC entry details structure
+    @param bd_id - bridge domain table id
+    @param is_ipv6 - if non-zero, ipv6 address, else ipv4 address
+    @param ip_address - ipv4 or ipv6 address
+    @param mac_address - MAC address
+*/
+define bd_ip_mac_details
+{
+  u32 context;
+  u32 bd_id;
+  u8 is_ipv6;
+  u8 ip_address[16];
+  u8 mac_address[6];
+};
+
+/** \brief Dump bridge domain IP to MAC entries
+    @param client_index - opaque cookie to identify the sender
+    @param bd_id - bridge domain identifier
+*/
+define bd_ip_mac_dump
+{
+  u32 client_index;
+  u32 context;
+  u32 bd_id;
+};
+
+/** \brief L2 interface ethernet flow point filtering enable/disable request
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param sw_if_index - interface to enable/disable filtering on
+    @param enable_disable - if non-zero enable filtering, else disable
+*/
+autoreply define l2_interface_efp_filter
+{
+  u32 client_index;
+  u32 context;
+  u32 sw_if_index;
+  u8 enable_disable;
+};
+
+/** \brief Interface set vpath request
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param sw_if_index - interface used to reach neighbor
+    @param enable - if non-zero enable, else disable
+*/
+autoreply define sw_interface_set_vpath
+{
+  u32 client_index;
+  u32 context;
+  u32 sw_if_index;
+  u8 enable;
 };
 
 /*