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 entry 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_entry
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 define l2_fib_clear_table
79 /** \brief L2 fib clear table response
80 @param context - sender context, to match reply w/ request
81 @param retval - return code for the request
83 define l2_fib_clear_table_reply
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
101 /** \brief L2 FIB flush bridge domain entries response
102 @param context - sender context, to match reply w/ request
103 @param retval - return code for the request
105 define l2fib_flush_bd_reply
111 /** \brief L2 FIB flush interface entries
112 @param client_index - opaque cookie to identify the sender
113 @param context - sender context, to match reply w/ request
114 @param bd_id - the entry's bridge domain id
116 define l2fib_flush_int
123 /** \brief L2 FIB flush interface entries response
124 @param context - sender context, to match reply w/ request
125 @param retval - return code for the request
127 define l2fib_flush_int_reply
133 /** \brief L2 FIB add entry request
134 @param client_index - opaque cookie to identify the sender
135 @param context - sender context, to match reply w/ request
136 @param mac - the entry's mac address
137 @param bd_id - the entry's bridge domain id
138 @param sw_if_index - the interface
139 @param is_add - If non zero add the entry, else delete it
156 /** \brief L2 FIB add entry response
157 @param context - sender context, to match reply w/ request
158 @param retval - return code for the add l2fib entry request
160 define l2fib_add_del_reply
166 /** \brief Set L2 flags request !!! TODO - need more info, feature bits in l2_input.h
167 @param client_index - opaque cookie to identify the sender
168 @param context - sender context, to match reply w/ request
169 @param sw_if_index - interface
170 @param is_set - if non-zero, set the bits, else clear them
171 @param feature_bitmap - non-zero bits to set or clear
182 /** \brief Set L2 bits response
183 @param context - sender context, to match reply w/ request
184 @param retval - return code for the set l2 bits request
186 define l2_flags_reply
190 u32 resulting_feature_bitmap;
193 /** \brief L2 bridge domain set mac age
194 @param client_index - opaque cookie to identify the sender
195 @param context - sender context, to match reply w/ request
196 @param bd_id - the bridge domain to create
197 @param mac_age - mac aging time in min, 0 for disabled
199 define bridge_domain_set_mac_age
207 /** \brief Set bridge domain response
208 @param context - sender context, to match reply w/ request
209 @param retval - return code for the set l2 bits request
211 define bridge_domain_set_mac_age_reply
217 /** \brief L2 bridge domain add or delete request
218 @param client_index - opaque cookie to identify the sender
219 @param context - sender context, to match reply w/ request
220 @param bd_id - the bridge domain to create
221 @param flood - enable/disable bcast/mcast flooding in the bd
222 @param uu_flood - enable/disable uknown unicast flood in the bd
223 @param forward - enable/disable forwarding on all interfaces in the bd
224 @param learn - enable/disable learning on all interfaces in the bd
225 @param arp_term - enable/disable arp termination in the bd
226 @param mac_age - mac aging time in min, 0 for disabled
227 @param is_add - add or delete flag
229 define bridge_domain_add_del
243 /** \brief L2 bridge domain add or delete response
244 @param context - sender context, to match reply w/ request
245 @param retval - return code for the set bridge flags request
247 define bridge_domain_add_del_reply
253 /** \brief L2 bridge domain request operational state details
254 @param client_index - opaque cookie to identify the sender
255 @param context - sender context, to match reply w/ request
256 @param bd_id - the bridge domain id desired or ~0 to request all bds
258 define bridge_domain_dump
265 /** \brief L2 bridge domain operational state response
266 @param bd_id - the bridge domain id
267 @param flood - bcast/mcast flooding state on all interfaces in the bd
268 @param uu_flood - uknown unicast flooding state on all interfaces in the bd
269 @param forward - forwarding state on all interfaces in the bd
270 @param learn - learning state on all interfaces in the bd
271 @param arp_term - arp termination state on all interfaces in the bd
272 @param mac_age - mac aging time in min, 0 for disabled
273 @param n_sw_ifs - number of sw_if_index's in the domain
275 define bridge_domain_details
289 /** \brief L2 bridge domain sw interface operational state response
290 @param bd_id - the bridge domain id
291 @param sw_if_index - sw_if_index in the domain
292 @param shg - split horizon group for the interface
294 define bridge_domain_sw_if_details
302 /** \brief Set bridge flags (such as L2_LEARN, L2_FWD, L2_FLOOD,
303 L2_UU_FLOOD, or L2_ARP_TERM) request
304 @param client_index - opaque cookie to identify the sender
305 @param context - sender context, to match reply w/ request
306 @param bd_id - the bridge domain to set the flags for
307 @param is_set - if non-zero, set the flags, else clear them
308 @param feature_bitmap - bits that are non-zero to set or clear
319 /** \brief Set bridge flags response
320 @param context - sender context, to match reply w/ request
321 @param retval - return code for the set bridge flags request
322 @param resulting_feature_bitmap - the feature bitmap value after the request is implemented
324 define bridge_flags_reply
328 u32 resulting_feature_bitmap;
331 /** \brief L2 interface vlan tag rewrite configure request
332 @param client_index - opaque cookie to identify the sender
333 @param context - sender context, to match reply w/ request
334 @param sw_if_index - interface the operation is applied to
335 @param vtr_op - Choose from l2_vtr_op_t enum values
336 @param push_dot1q - first pushed flag dot1q id set, else dot1ad
337 @param tag1 - Needed for any push or translate vtr op
338 @param tag2 - Needed for any push 2 or translate x-2 vtr ops
340 define l2_interface_vlan_tag_rewrite
346 u32 push_dot1q; // ethertype of first pushed tag is dot1q/dot1ad
347 u32 tag1; // first pushed tag
348 u32 tag2; // second pushed tag
351 /** \brief L2 interface vlan tag rewrite response
352 @param context - sender context, to match reply w/ request
353 @param retval - return code for the request
355 define l2_interface_vlan_tag_rewrite_reply
361 /** \brief L2 interface pbb tag rewrite configure request
362 @param client_index - opaque cookie to identify the sender
363 @param context - sender context, to match reply w/ request
364 @param sw_if_index - interface the operation is applied to
365 @param vtr_op - Choose from l2_vtr_op_t enum values
366 @param inner_tag - needed for translate_qinq vtr op only
367 @param outer_tag - needed for translate_qinq vtr op only
368 @param b_dmac - B-tag remote mac address, needed for any push or translate_qinq vtr op
369 @param b_smac - B-tag local mac address, needed for any push or translate qinq vtr op
370 @param b_vlanid - B-tag vlanid, needed for any push or translate qinq vtr op
371 @param i_sid - I-tag service id, needed for any push or translate qinq vtr op
373 define l2_interface_pbb_tag_rewrite
386 /** \brief L2 interface pbb tag rewrite response
387 @param context - sender context, to match reply w/ request
388 @param retval - return code for the request
390 define l2_interface_pbb_tag_rewrite_reply
398 * eval: (c-set-style "gnu")