1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2016 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 /** \brief Reply to l2_xconnect_dump
18 @param context - sender context which was passed in the request
19 @param rx_sw_if_index - Receive interface index
20 @param tx_sw_if_index - Transmit interface index
22 define l2_xconnect_details
29 /** \brief Dump L2 XConnects
30 @param client_index - opaque cookie to identify the sender
31 @param context - sender context, to match reply w/ request
33 define l2_xconnect_dump
39 /** \brief l2 fib table details structure
40 @param bd_id - the l2 fib / bridge domain table id
41 @param mac - the entry's mac address
42 @param sw_if_index - index of the interface
43 @param static_mac - the entry is statically configured.
44 @param filter_mac - the entry is a mac filter entry.
45 @param bvi_mac - the mac address is a bridge virtual interface
47 define l2_fib_table_details
58 /** \brief Dump l2 fib (aka bridge domain) table
59 @param client_index - opaque cookie to identify the sender
60 @param bd_id - the l2 fib / bridge domain table identifier
62 define l2_fib_table_dump
69 /** \brief L2 fib clear table request, clear all mac entries in the l2 fib
70 @param client_index - opaque cookie to identify the sender
71 @param context - sender context, to match reply w/ request
73 autoreply define l2_fib_clear_table
79 /** \brief L2 FIB flush all entries
80 @param client_index - opaque cookie to identify the sender
81 @param context - sender context, to match reply w/ request
83 autoreply define l2fib_flush_all
89 /** \brief L2 FIB flush bridge domain entries
90 @param client_index - opaque cookie to identify the sender
91 @param context - sender context, to match reply w/ request
92 @param bd_id - the entry's bridge domain id
94 autoreply define l2fib_flush_bd
101 /** \brief L2 FIB flush interface entries
102 @param client_index - opaque cookie to identify the sender
103 @param context - sender context, to match reply w/ request
104 @param bd_id - the entry's bridge domain id
106 autoreply define l2fib_flush_int
113 /** \brief L2 FIB add entry request
114 @param client_index - opaque cookie to identify the sender
115 @param context - sender context, to match reply w/ request
116 @param mac - the entry's mac address
117 @param bd_id - the entry's bridge domain id
118 @param sw_if_index - the interface
119 @param is_add - If non zero add the entry, else delete it
123 autoreply define l2fib_add_del
136 /** \brief Register to recive L2 MAC events for leanred and aged MAC
137 @param client_index - opaque cookie to identify the sender
138 @param context - sender context, to match reply w/ request
139 @param learn_limit - MAC learn limit, 0 => default to 1000
140 @param scan_delay - event scan delay in 10 msec unit, 0 => default to 100 msec
141 @param max_macs_in_event - in units of 10 mac entries, 0 => default to 100 entries
142 @param enable_disable - 1 => register for MAC events, 0 => cancel registration
143 @param pid - sender's pid
145 autoreply define want_l2_macs_events
151 u8 max_macs_in_event;
156 /** \brief Entry for learned or aged MAC in L2 MAC Events
157 @param sw_if_index - sw_if_index in the domain
158 @param mac_addr - mac_address
159 @is_del - 0 => newly learned MAC, 1 => aged out MAC
161 typeonly define mac_entry
169 /** \brief L2 MAC event for a list of learned or aged MACs
170 @param client_index - opaque cookie to identify the sender
171 @param pid - client pid registered to receive notification
172 @param n_macs - number of learned/aged MAC enntries
173 @param mac - array of learned/aged MAC entries
180 vl_api_mac_entry_t mac[n_macs];
183 /** \brief Set interface L2 flags (such as L2_LEARN, L2_FWD,
184 L2_FLOOD, L2_UU_FLOOD, or L2_ARP_TERM bits). This can be used
185 to disable one or more of the features represented by the
186 flag bits on an interface to override what is set as default
187 for all interfaces in the bridge domain
188 @param client_index - opaque cookie to identify the sender
189 @param context - sender context, to match reply w/ request
190 @param sw_if_index - interface
191 @param is_set - if non-zero, set the bits, else clear them
192 @param feature_bitmap - non-zero bits (as above) to set or clear
203 /** \brief Set interface L2 flags response
204 @param context - sender context, to match reply w/ request
205 @param retval - return code for the set l2 bits request
206 @param resulting_feature_bitmap - the internal l2 feature bitmap after the request is implemented
208 define l2_flags_reply
212 u32 resulting_feature_bitmap;
215 /** \brief L2 bridge domain set mac age
216 @param client_index - opaque cookie to identify the sender
217 @param context - sender context, to match reply w/ request
218 @param bd_id - the bridge domain to create
219 @param mac_age - mac aging time in min, 0 for disabled
221 autoreply define bridge_domain_set_mac_age
229 /** \brief L2 bridge domain add or delete request
230 @param client_index - opaque cookie to identify the sender
231 @param context - sender context, to match reply w/ request
232 @param bd_id - the bridge domain to create
233 @param flood - enable/disable bcast/mcast flooding in the bd
234 @param uu_flood - enable/disable uknown unicast flood in the bd
235 @param forward - enable/disable forwarding on all interfaces in the bd
236 @param learn - enable/disable learning on all interfaces in the bd
237 @param arp_term - enable/disable arp termination in the bd
238 @param mac_age - mac aging time in min, 0 for disabled
239 @param is_add - add or delete flag
241 autoreply define bridge_domain_add_del
255 /** \brief L2 bridge domain request operational state details
256 @param client_index - opaque cookie to identify the sender
257 @param context - sender context, to match reply w/ request
258 @param bd_id - the bridge domain id desired or ~0 to request all bds
260 define bridge_domain_dump
267 /** \brief L2 bridge domain sw interface operational state response
268 @param bd_id - the bridge domain id
269 @param sw_if_index - sw_if_index in the domain
270 @param shg - split horizon group for the interface
272 typeonly manual_print manual_endian define bridge_domain_sw_if
279 /** \brief L2 bridge domain operational state response
280 @param bd_id - the bridge domain id
281 @param flood - bcast/mcast flooding state on all interfaces in the bd
282 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
283 @param forward - forwarding state on all interfaces in the bd
284 @param learn - learning state on all interfaces in the bd
285 @param arp_term - arp termination state on all interfaces in the bd
286 @param mac_age - mac aging time in min, 0 for disabled
287 @param n_sw_ifs - number of sw_if_index's in the domain
289 manual_print manual_endian define bridge_domain_details
301 vl_api_bridge_domain_sw_if_t sw_if_details[n_sw_ifs];
304 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
305 L2_UU_FLOOD, or L2_ARP_TERM bits) request
306 @param client_index - opaque cookie to identify the sender
307 @param context - sender context, to match reply w/ request
308 @param bd_id - the bridge domain to set the flags for
309 @param is_set - if non-zero, set the flags, else clear them
310 @param feature_bitmap - bits (as above) that are non-zero to set or clear
321 /** \brief Set bridge flags response
322 @param context - sender context, to match reply w/ request
323 @param retval - return code for the set bridge flags request
324 @param resulting_feature_bitmap - the internal L2 feature bitmap after the request is implemented
326 define bridge_flags_reply
330 u32 resulting_feature_bitmap;
333 /** \brief L2 interface vlan tag rewrite configure request
334 @param client_index - opaque cookie to identify the sender
335 @param context - sender context, to match reply w/ request
336 @param sw_if_index - interface the operation is applied to
337 @param vtr_op - Choose from l2_vtr_op_t enum values
338 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
339 @param tag1 - Needed for any push or translate vtr op
340 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
342 autoreply define l2_interface_vlan_tag_rewrite
348 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
349 u32 tag1; // first pushed tag
350 u32 tag2; // second pushed tag
353 /** \brief L2 interface pbb tag rewrite configure request
354 @param client_index - opaque cookie to identify the sender
355 @param context - sender context, to match reply w/ request
356 @param sw_if_index - interface the operation is applied to
357 @param vtr_op - Choose from l2_vtr_op_t enum values
358 @param inner_tag - needed for translate_qinq vtr op only
359 @param outer_tag - needed for translate_qinq vtr op only
360 @param b_dmac - B-tag remote mac address, needed for any push or translate_qinq vtr op
361 @param b_smac - B-tag local mac address, needed for any push or translate qinq vtr op
362 @param b_vlanid - B-tag vlanid, needed for any push or translate qinq vtr op
363 @param i_sid - I-tag service id, needed for any push or translate qinq vtr op
365 autoreply define l2_interface_pbb_tag_rewrite
380 * eval: (c-set-style "gnu")