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 e4edfa1..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
 {
@@ -139,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
 {
@@ -149,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];
 };
@@ -223,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
 {