BIER disposition default route

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

diff --git a/src/vnet/bier/bier.api b/src/vnet/bier/bier.api
index 466524c..6f88732 100644 (file)
--- a/src/vnet/bier/bier.api
+++ b/src/vnet/bier/bier.api
@@ -21,9 +21,9 @@
 vl_api_version 1.0.0
 
 /** \brief BIER Table Indentifier
-    @param bt_set
-    @param bt_sub_domain
-    @param bt_bit_header_length
+    @param bt_set - The BIER set
+    @param bt_sub_domain - the sud-domain
+    @param bt_bit_header_length - the number of bits in the header length
 */
 typeonly define bier_table_id
 {
@@ -36,7 +36,9 @@ typeonly define bier_table_id
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param bt_tbl_id - The BIER table-id the route is added in
-    @param bt_mpls_label - The MPLS label for the table
+    @param bt_label - The MPLS label for the table (0 or all ones means not set)
+                      If the label is not set, then it is assumed that non-MPLS
+                     encoding is used.
     @param bt_is_add - Is this a route add or delete
 */
 autoreply define bier_table_add_del
@@ -67,10 +69,11 @@ define bier_table_details
     @param preference - The preference of the path. lowest preference is prefered
     @param is_local - local if non-zero, else remote
     @param is_drop - Drop the packet
-    @param is_unreach - Drop the packet and rate limit send ICMP unreachable
-    @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
+    @param is_udp_encap - The path describes a UDP-o-IP encapsulation.
     @param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
     @param next_hop[16] - the next hop address
+    @param next_hop_id - Used when the path resolves via an object that has a unique
+                         identifier. e.g. the UDP encap object
 
     WARNING: this type is replicated, pending cleanup completion
 */
@@ -82,10 +85,10 @@ typeonly define fib_path3
   u8 preference;
   u8 is_local;
   u8 is_drop;
-  u8 is_unreach;
-  u8 is_prohibit;
+  u8 is_udp_encap;
   u8 afi;
   u8 next_hop[16];
+  u32 next_hop_id;
   u32 rpf_id;
   u8 n_labels;
   u32 label_stack[16];
@@ -136,9 +139,8 @@ define bier_route_details
     @param context - sender context, to match reply w/ request
     @param bi_tbl_id - The BIER table-id used to forward post encap
     @param bi_src - The source Bit-position in the encap.
-    @param bi_is_add - Is this a route add or delete
     @param bi_n_bytes - The number of bytes in the following bit-string
-    @param bi_bytes - The bit-string represented as a byte array
+    @param bi_bytes - The bit-string represented as a byte array (MSB first)
 */
 define bier_imp_add
 {
@@ -146,7 +148,6 @@ define bier_imp_add
   u32 context;
   vl_api_bier_table_id_t bi_tbl_id;
   u16 bi_src;
-  u8 bi_is_add;
   u8 bi_n_bytes;
   u8 bi_bytes[bi_n_bytes];
 };
@@ -220,16 +221,14 @@ define bier_disp_table_details
 /** \brief BIER Disposition Entry Add / del
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param bde_bp - The Bit-position value for the entry
+    @param bde_bp - The Bit-position value for the entry, i.e. the sender's
+                    Use 0 for the default (match any source) entry.
     @param bde_tbl_id - The BIER dispositiontable-id the route is added in
     @param bde_next_hop_sw_if_index - the nextop interface
     @param bde_is_add - Is this a route add or delete
     @param bde_payload_proto - The payload protocol for which the next-hop
                               is added
-    @param bde_next_hop_table_id - The table ID for the next-hop
-    @param bde_next_hop_proto_is_ip4 - The next-hop is IPV4
-    @param bde_next_hop[16] - the nextop address.
-                              Set this to all 0s for dispostion.
+    @param bde_paths - The outgoing paths for the entry
 */
 autoreply define bier_disp_entry_add_del
 {