* limitations under the License.
*/
-option version = "2.0.0";
+option version = "3.1.0";
-/** \brief Reply to l2_xconnect_dump
+import "vnet/ip/ip_types.api";
+import "vnet/ethernet/ethernet_types.api";
+import "vnet/interface_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
@param tx_sw_if_index - Transmit interface index
define l2_xconnect_details
{
u32 context;
- u32 rx_sw_if_index;
- u32 tx_sw_if_index;
+ vl_api_interface_index_t rx_sw_if_index;
+ vl_api_interface_index_t tx_sw_if_index;
};
/** \brief Dump L2 XConnects
{
u32 context;
u32 bd_id;
- u8 mac[6];
- u32 sw_if_index;
- u8 static_mac;
- u8 filter_mac;
- u8 bvi_mac;
+ vl_api_mac_address_t mac;
+ vl_api_interface_index_t sw_if_index;
+ bool static_mac;
+ bool filter_mac;
+ bool bvi_mac;
};
/** \brief Dump l2 fib (aka bridge domain) table
{
u32 client_index;
u32 context;
- u32 sw_if_index;
+ vl_api_interface_index_t sw_if_index;
};
/** \brief L2 FIB add entry request
@param bd_id - the entry's bridge domain id
@param sw_if_index - the interface
@param is_add - If non zero add the entry, else delete it
- @param static_mac -
+ @param static_mac -
@param filter_mac -
+ @param bvi_mac -
*/
autoreply define l2fib_add_del
{
u32 client_index;
u32 context;
- u8 mac[6];
+ vl_api_mac_address_t mac;
u32 bd_id;
- u32 sw_if_index;
- u8 is_add;
- u8 static_mac;
- u8 filter_mac;
- u8 bvi_mac;
+ vl_api_interface_index_t sw_if_index;
+ bool is_add [default=true];
+ bool static_mac;
+ bool filter_mac;
+ bool 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
- @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 learn_limit - MAC learn limit
+ @param scan_delay - event scan delay in 10 msec unit
+ @param max_macs_in_event - in units of 10 mac entries
@param enable_disable - 1 => register for MAC events, 0 => cancel registration
@param pid - sender's pid
*/
autoreply define want_l2_macs_events
{
+ option deprecated;
u32 client_index;
u32 context;
- u32 learn_limit;
- u8 scan_delay;
- u8 max_macs_in_event;
- u8 enable_disable;
+ u32 learn_limit [default=1000];
+ u8 scan_delay [default=10];
+ u8 max_macs_in_event [default=10];
+ bool enable_disable [default=true];
+ u32 pid;
+};
+
+/** \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 max_macs_in_event - in units of 10 mac entries
+ @param enable_disable - 1 => register for MAC events, 0 => cancel registration
+ @param pid - sender's pid
+*/
+autoreply define want_l2_macs_events2
+{
+ u32 client_index;
+ u32 context;
+ u8 max_macs_in_event [default=10];
+ bool enable_disable [default=true];
u32 pid;
};
+/** \brief set l2 table scan delay
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param scan_delay - event scan delay in 10 msec unit
+*/
+autoreply define l2fib_set_scan_delay
+{
+ u32 client_index;
+ u32 context;
+ u16 scan_delay [default=10];
+};
+
+
+enum mac_event_action
+{
+ MAC_EVENT_ACTION_API_ADD = 0,
+ MAC_EVENT_ACTION_API_DELETE = 1,
+ MAC_EVENT_ACTION_API_MOVE = 2,
+};
+
/** \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
+ 2 => MAC move (sw_if_index changed)
+ @param flags - flag bits to provide other info, not yet used
*/
-typeonly define mac_entry
+typedef mac_entry
{
- u32 sw_if_index;
- u8 mac_addr[6];
- u8 is_del;
- u8 spare;
+ vl_api_interface_index_t sw_if_index;
+ vl_api_mac_address_t mac_addr;
+ vl_api_mac_event_action_t 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
vl_api_mac_entry_t mac[n_macs];
};
-/** \brief Set interface L2 flags (such as L2_LEARN, L2_FWD,
+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 sw_if_index - interface
@param is_set - if non-zero, set the bits, else clear them
@param feature_bitmap - non-zero bits (as above) to set or clear
*/
{
u32 client_index;
u32 context;
- u32 sw_if_index;
- u8 is_set;
+ vl_api_interface_index_t sw_if_index;
+ bool is_set;
u32 feature_bitmap;
};
u8 mac_age;
};
+/** \brief L2 bridge domain set default learn limit
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param learn limit - maximum number of entries by default for bridge domains
+*/
+autoreply define bridge_domain_set_default_learn_limit
+{
+ u32 client_index;
+ u32 context;
+ u32 learn_limit;
+};
+
+
+/** \brief L2 bridge domain set learn limit
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param bd_id - the bridge domain idenntifier
+ @param learn limit - maximum number of entries for this bd
+*/
+autoreply define bridge_domain_set_learn_limit
+{
+ u32 client_index;
+ u32 context;
+ u32 bd_id;
+ u32 learn_limit;
+};
+
/** \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 arp_ufwd - enable/disable arp unicast forwarding in the bd
@param mac_age - mac aging time in min, 0 for disabled
@param is_add - add or delete flag
*/
u32 client_index;
u32 context;
u32 bd_id;
- u8 flood;
- u8 uu_flood;
- u8 forward;
- u8 learn;
- u8 arp_term;
+ bool flood;
+ bool uu_flood;
+ bool forward;
+ bool learn;
+ bool arp_term;
+ bool arp_ufwd;
u8 mac_age;
- u8 bd_tag[64];
- u8 is_add;
+ string bd_tag[64];
+ bool is_add [default=true];
};
/** \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
@param bd_id - the bridge domain id desired or ~0 to request all bds
+ @param sw_if_index - filter by sw_if_index UNIMPLEMENTED
*/
define bridge_domain_dump
{
u32 client_index;
u32 context;
- u32 bd_id;
+ u32 bd_id [default=0xffffffff];
+ vl_api_interface_index_t sw_if_index [default=0xffffffff];
};
/** \brief L2 bridge domain sw interface operational state response
@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
+typedef bridge_domain_sw_if
{
u32 context;
- u32 sw_if_index;
+ vl_api_interface_index_t sw_if_index;
+ /* FIXME: set_int_l2_mode() u32/ api u8 */
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 arp_ufwd - arp unicast forwarding 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
+define bridge_domain_details
{
u32 context;
u32 bd_id;
- u8 flood;
- u8 uu_flood;
- u8 forward;
- u8 learn;
- u8 arp_term;
+ bool flood;
+ bool uu_flood;
+ bool forward;
+ bool learn;
+ bool arp_term;
+ bool arp_ufwd;
u8 mac_age;
- u8 bd_tag[64];
- u32 bvi_sw_if_index;
+ string bd_tag[64];
+ vl_api_interface_index_t bvi_sw_if_index;
+ vl_api_interface_index_t 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_NONE = 0x0,
+ 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,
+ BRIDGE_API_FLAG_ARP_UFWD = 0x20,
+};
+
+/** \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
{
u32 client_index;
u32 context;
u32 bd_id;
- u8 is_set;
- u32 feature_bitmap;
+ bool is_set;
+ vl_api_bd_flags_t flags;
};
/** \brief Set bridge flags response
{
u32 client_index;
u32 context;
- u32 sw_if_index;
+ vl_api_interface_index_t sw_if_index;
u32 vtr_op;
u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
u32 tag1; // first pushed tag
@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 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
{
u32 client_index;
u32 context;
- u32 sw_if_index;
+ vl_api_interface_index_t sw_if_index;
u32 vtr_op;
u16 outer_tag;
- u8 b_dmac[6];
- u8 b_smac[6];
+ vl_api_mac_address_t b_dmac;
+ vl_api_mac_address_t b_smac;
u16 b_vlanid;
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 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
*/
{
u32 client_index;
u32 context;
- u32 rx_sw_if_index;
- u32 tx_sw_if_index;
- u8 is_add;
+ vl_api_interface_index_t rx_sw_if_index;
+ vl_api_interface_index_t tx_sw_if_index;
+ bool is_add [default=true];
};
/** \brief Set L2 XConnect between two interfaces request
{
u32 client_index;
u32 context;
- u32 rx_sw_if_index;
- u32 tx_sw_if_index;
- u8 enable;
+ vl_api_interface_index_t rx_sw_if_index;
+ vl_api_interface_index_t tx_sw_if_index;
+ bool enable [default=true];
+};
+
+/**
+ * @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 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 - Shared horizon group, for bridge mode only
+ @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;
+ vl_api_interface_index_t rx_sw_if_index;
u32 bd_id;
+ vl_api_l2_port_type_t port_type;
u8 shg;
- u8 bvi;
- u8 enable;
+ bool enable [default=true];
};
/** \brief Set bridge domain ip to mac entry request
@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 ip - ipv4 or ipv6 address
+ @param mac - MAC address
+*/
+
+typedef bd_ip_mac
+{
+ u32 bd_id;
+ vl_api_address_t ip;
+ vl_api_mac_address_t mac;
+};
+
+autoreply define bd_ip_mac_add_del
+{
+ u32 client_index;
+ u32 context;
+ bool is_add [default=true];
+ vl_api_bd_ip_mac_t entry;
+};
+
+/** \brief Flush bridge domain IP to MAC entries
+ @param client_index - opaque cookie to identify the sender
+ @param bd_id - bridge domain identifier
+*/
+autoreply define bd_ip_mac_flush
+{
+ u32 client_index;
+ u32 context;
+ u32 bd_id;
+};
+
+/** \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
- @param
*/
-autoreply define bd_ip_mac_add_del
+define bd_ip_mac_details
+{
+ u32 context;
+ vl_api_bd_ip_mac_t entry;
+};
+
+/** \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;
- u8 is_add;
- u8 is_ipv6;
- u8 ip_address[16];
- u8 mac_address[6];
};
/** \brief L2 interface ethernet flow point filtering enable/disable request
{
u32 client_index;
u32 context;
- u32 sw_if_index;
- u32 enable_disable;
+ vl_api_interface_index_t sw_if_index;
+ bool enable_disable [default=true];
};
/** \brief Interface set vpath request
{
u32 client_index;
u32 context;
- u32 sw_if_index;
- u8 enable;
+ vl_api_interface_index_t sw_if_index;
+ bool enable [default=0xffffffff];
+};
+
+/** \brief Create BVI interface instance request
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param mac_address - mac addr to assign to the interface if none-zero
+ @param user_instance - requested instance, ~0 => dynamically allocate
+*/
+define bvi_create
+{
+ u32 client_index;
+ u32 context;
+ vl_api_mac_address_t mac;
+ u32 user_instance [default=0xffffffff];
+};
+
+/** \brief Create BVI interface instance response
+ @param context - sender context, to match reply w/ request
+ @param sw_if_index - sw index of the interface that was created
+ @param retval - return code for the request
+*/
+define bvi_create_reply
+{
+ u32 context;
+ i32 retval;
+ vl_api_interface_index_t sw_if_index;
+};
+
+/** \brief Delete BVI interface request
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param sw_if_index - sw index of the interface that was created
+*/
+autoreply define bvi_delete
+{
+ u32 client_index;
+ u32 context;
+ vl_api_interface_index_t sw_if_index;
+};
+
+/** \brief Register for IP4 ARP resolution event on receiving ARP reply or
+ MAC/IP info from ARP requests in L2 BDs
+ @param client_index - opaque cookie to identify the sender
+ @param context - sender context, to match reply w/ request
+ @param enable - 1 => register for events, 0 => cancel registration
+ @param pid - sender's pid
+*/
+autoreply define want_l2_arp_term_events
+{
+ u32 client_index;
+ u32 context;
+ bool enable;
+ u32 pid;
+};
+
+/** \brief Tell client about an IP4 ARP resolution event or
+ MAC/IP info from ARP requests in L2 BDs
+ @param client_index - opaque cookie to identify the sender
+ @param pid - client pid registered to receive notification
+ @param ip - IP address of new ARP term entry
+ @param sw_if_index - interface of new ARP term entry
+ @param mac - MAC address of new ARP term entry
+*/
+define l2_arp_term_event
+{
+ u32 client_index;
+ u32 pid;
+ vl_api_address_t ip;
+ vl_api_interface_index_t sw_if_index;
+ vl_api_mac_address_t mac;
+};
+
+service {
+ rpc want_l2_arp_term_events returns want_l2_arp_term_events_reply
+ events l2_arp_term_event;
};
/*
Code Review / vpp.git / blobdiff