diff options
| author |   Neale Ranns <nranns@cisco.com> | 2017-12-12 05:32:50 -0800 |
|---|---|---|
| committer |   Florin Coras <florin.coras@gmail.com> | 2017-12-13 16:26:23 +0000 |
| commit | fa1da15ca5ea6ce308f16e1a44a604c4bec8091b (patch) | |
| tree | df17cc4dc663efc38ed2c8002951eb4db1f4ce6b /src/vnet/bier/bier.api | |
| parent | 52014c674e6e52ea48682aa2eea8db23c6b8c252 (diff) | |
BIER: API documentation fixes.
Change-Id: I497305d9a4fd556ed8b4a7ceb3654df94ff98f56
Signed-off-by: Neale Ranns <nranns@cisco.com>
Diffstat (limited to 'src/vnet/bier/bier.api')
| -rw-r--r-- | src/vnet/bier/bier.api | 15 |
1 files changed, 5 insertions, 10 deletions
diff --git a/src/vnet/bier/bier.api b/src/vnet/bier/bier.api index e4edfa1768a..f7a13e4705b 100644 --- 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]; }; @@ -229,10 +227,7 @@ define bier_disp_table_details @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 { |