Trivial: Clean up some typos.

[vpp.git] / src / vnet / l2 / l2.api

diff --git a/src/vnet/l2/l2.api b/src/vnet/l2/l2.api
index 3fb6de0..fdb7db7 100644 (file)
--- a/src/vnet/l2/l2.api
+++ b/src/vnet/l2/l2.api
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-option version = "2.0.0";
+option version = "2.0.1";
 
 /** \brief Reply to l2_xconnect_dump 
     @param context - sender context which was passed in the request
@@ -135,7 +135,7 @@ autoreply define l2fib_add_del
   u8 bvi_mac;
 };
 
-/** \brief Register to recive L2 MAC events for leanred and aged MAC
+/** \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 learn_limit - MAC learn limit, 0 => default to 1000
@@ -158,20 +158,22 @@ autoreply define want_l2_macs_events
 /** \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
-    @is_del - 0 => newly learned MAC, 1 => aged out MAC
+    @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  is_del;
-  u8  spare;
+  u8  action;
+  u8  flags;
 };
 
 /** \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 enntries
+    @param n_macs - number of learned/aged MAC entries
     @param mac - array of learned/aged MAC entries
 */
 define l2_macs_event
@@ -238,7 +240,7 @@ autoreply define bridge_domain_set_mac_age
     @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
@@ -287,7 +289,7 @@ typeonly manual_print manual_endian define bridge_domain_sw_if
 /** \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
@@ -423,7 +425,7 @@ autoreply define sw_interface_set_l2_xconnect
     @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 - Shared horizon group, for 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
@@ -457,6 +459,32 @@ autoreply define bd_ip_mac_add_del
   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
@@ -468,7 +496,7 @@ autoreply define l2_interface_efp_filter
   u32 client_index;
   u32 context;
   u32 sw_if_index;
-  u32 enable_disable;
+  u8 enable_disable;
 };
 
 /** \brief Interface set vpath request