X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fl2%2Fl2.api;h=8b65bc36afc5e21632d8787ee7165e2afb98b316;hb=4d5b917;hp=e508bfb529c7f3ed4a14f3f9e68b92b6ec9b57b1;hpb=8d00fff8dff4e449767601645422e03df92a83af;p=vpp.git diff --git a/src/vnet/l2/l2.api b/src/vnet/l2/l2.api index e508bfb529c..8b65bc36afc 100644 --- a/src/vnet/l2/l2.api +++ b/src/vnet/l2/l2.api @@ -14,6 +14,11 @@ * limitations under the License. */ +option version = "2.1.1"; + +import "vnet/ip/ip_types.api"; +import "vnet/ethernet/ethernet_types.api"; + /** \brief Reply to l2_xconnect_dump @param context - sender context which was passed in the request @param rx_sw_if_index - Receive interface index @@ -48,7 +53,7 @@ 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; @@ -124,7 +129,7 @@ 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; @@ -133,8 +138,7 @@ autoreply define l2fib_add_del u8 bvi_mac; }; -/** \brief Register to recive L2 MAC events for leanred and aged MAC - Will also change MAC learn limit to L2LEARN_INFORM_LIMIT +/** \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 @@ -157,20 +161,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 @@ -181,6 +187,11 @@ define l2_macs_event 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 @@ -232,7 +243,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 @@ -250,6 +261,7 @@ autoreply define bridge_domain_add_del u8 learn; u8 arp_term; u8 mac_age; + u8 bd_tag[64]; u8 is_add; }; @@ -280,11 +292,12 @@ 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 @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 */ manual_print manual_endian define bridge_domain_details @@ -297,18 +310,29 @@ manual_print manual_endian define bridge_domain_details u8 learn; u8 arp_term; u8 mac_age; + u8 bd_tag[64]; u32 bvi_sw_if_index; + u32 uu_fwd_sw_if_index; u32 n_sw_ifs; 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 bits) request +/** \brief Flags that can be changed on a bridge domain */ +enum bd_flags +{ + BRIDGE_API_FLAG_LEARN = 0x1, + BRIDGE_API_FLAG_FWD = 0x2, + BRIDGE_API_FLAG_FLOOD = 0x4, + BRIDGE_API_FLAG_UU_FLOOD = 0x8, + BRIDGE_API_FLAG_ARP_TERM = 0x10, +}; + +/** \brief Set bridge flags 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 (as above) that are non-zero to set or clear + @param flags - flags that are non-zero to set or clear */ define bridge_flags { @@ -316,7 +340,7 @@ define bridge_flags u32 context; u32 bd_id; u8 is_set; - u32 feature_bitmap; + vl_api_bd_flags_t flags; }; /** \brief Set bridge flags response @@ -376,6 +400,148 @@ autoreply define l2_interface_pbb_tag_rewrite u32 i_sid; }; +/** \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 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 +*/ +autoreply define l2_patch_add_del +{ + u32 client_index; + u32 context; + 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 An enumeration of the type of ports that can be added + * to a bridge domain + */ +enum l2_port_type +{ + /* a 'normal' interface, i.e. not BVI or UU-Flood */ + L2_API_PORT_TYPE_NORMAL = 0, + /* a BVI interface in the BD */ + L2_API_PORT_TYPE_BVI = 1, + /* The interface on which to forward unknown unicast packets + * If this is not set for a BD then UU is flooded */ + L2_API_PORT_TYPE_UU_FWD = 2, +}; + +/** \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 port_type - port_mode, see #l2_port_type + @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; + vl_api_l2_port_type_t port_type; + u8 shg; + 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; + vl_api_address_t ip; + vl_api_mac_address_t mac; +}; + +/** \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; +}; + /* * Local Variables: * eval: (c-set-style "gnu")