X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fip%2Fip.api;h=d59297b1c204b737b0736405252c7f09286c8cf7;hb=7f358b3;hp=d6c5f6bcd021259dc37986a13b4206f68f5853eb;hpb=4b9669dc116f6c9be5ef124e4aff7b201404b6ea;p=vpp.git

diff --git a/src/vnet/ip/ip.api b/src/vnet/ip/ip.api
index d6c5f6bcd02..d59297b1c20 100644
--- a/src/vnet/ip/ip.api
+++ b/src/vnet/ip/ip.api
@@ -19,7 +19,7 @@
     called through a shared memory interface. 
 */
 
-option version = "1.2.0";
+option version = "1.2.3";
 import "vnet/fib/fib_types.api";
 
 /** \brief Add / del table request
@@ -446,6 +446,7 @@ autoreply define ip_mroute_add_del
   u8 is_local;
   u8 grp_address[16];
   u8 src_address[16];
+  u8 nh_address[16];
 };
 
 /** \brief Dump IP multicast fib table
@@ -650,12 +651,55 @@ autoreply define ip_source_and_port_range_check_interface_add_del
   u32 udp_out_vrf_id;
 };
 
-/** \brief Register for ip4 arp resolution events
+/** \brief Enable/disable periodic IP neighbor scan
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param mode - 0: disable, 1: IPv4, 2: IPv6, 3: both IPv4/v6
+    @param scan_interval - neighbor scan interval in minutes, 0: default to 1
+    @param max_proc_time - max processing time per run in usec, 0: default to 20
+    @param max_update - max neighbor probe/delete per run, 0: default to 10
+    @param scan_int_delay - delay in msec to resume scan if exceed max proc
+                            time or update, 0: default to 1
+    @param stale_threshold - threshold in minutes for neighbor deletion, 
+                             0: default to 4*scan_interval
+*/
+autoreply define ip_scan_neighbor_enable_disable
+{
+  u32 client_index;
+  u32 context;
+  u8 mode;
+  u8 scan_interval;
+  u8 max_proc_time;
+  u8 max_update;
+  u8 scan_int_delay;
+  u8 stale_threshold;
+};
+
+/** \brief IP probe neighbor address on an interface by sending an
+           ARP request (for IP4) or ICMP6 Neighbor Solicitation (for IP6)
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param sw_if_index - interface index
+    @param dst_address - target IP address to send IP addr resolution request
+    @param is_ipv6 - [1|0] to indicate if address family is IPv[6|4]
+*/
+autoreply define ip_probe_neighbor
+{
+  u32 client_index;
+  u32 context;
+  u32 sw_if_index;
+  u8 dst_address[16];
+  u8 is_ipv6;
+};
+
+/** \brief Register for IP4 ARP resolution event on receing ARP reply or
+           MAC/IP info from ARP requests in L2 BDs
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param enable_disable - 1 => register for events, 0 => cancel registration
     @param pid - sender's pid
-    @param address - the exact ip4 address of interest
+    @param address - exact IP4 address of interested arp resolution event, or
+                     0 to get MAC/IP info from ARP requests in BDs
 */
 autoreply define want_ip4_arp_events
 {
@@ -666,13 +710,14 @@ autoreply define want_ip4_arp_events
   u32 address;
 };
 
-/** \brief Tell client about an ip4 arp resolution event
+/** \brief Tell client about an IP4 ARP resolution event or
+           MAC/IP info from ARP requests in L2 BDs
     @param client_index - opaque cookie to identify the sender
     @param address - the exact ip4 address of interest
     @param pid - client pid registered to receive notification
     @param sw_if_index - interface which received ARP packet
     @param new_mac - the new mac address 
-    @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
+    @param mac_ip - 0: ARP resolution event, 1: MAC/IP info from L2 BDs
 */
 define ip4_arp_event
 {
@@ -689,12 +734,14 @@ service {
     events ip4_arp_event;
 };
 
-/** \brief Register for ip6 nd resolution events
+/** \brief Register for IP6 ND resolution event on recieving NA reply
+           MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
     @param enable_disable - 1 => register for events, 0 => cancel registration
     @param pid - sender's pid
-    @param address - the exact ip6 address of interest
+    @param address - the exact IP6 address of interested ND resolution event, or
+                     0 to get MAC/IP info from ICMP6 NS in L2 BDs.
 */
 autoreply define want_ip6_nd_events
 {
@@ -705,13 +752,14 @@ autoreply define want_ip6_nd_events
   u8 address[16];
 };
 
-/** \brief Tell client about an ip6 nd resolution or mac/ip event
+/** \brief Tell client about an IP6 ND resolution or
+           MAC/IP info from ICMP6 Neighbor Solicitation in L2 BDs.
     @param client_index - opaque cookie to identify the sender
     @param pid - client pid registered to receive notification
     @param sw_if_index - interface which received ARP packet
     @param address - the exact ip6 address of interest
     @param new_mac - the new mac address 
-    @param mac_ip - 0: resolution event, 1: mac/ip binding in bd
+    @param mac_ip - 0: ND resolution event, 1: MAC/IP info from L2 BDs
 */
 define ip6_nd_event
 {
@@ -910,6 +958,22 @@ define ip_reassembly_get_reply
   u8 is_ip6;
 };
 
+/** \brief Enable/disable reassembly feature
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param sw_if_index - interface to enable/disable feature on
+    @param enable_ip4 - enable ip4 reassembly if non-zero, disable if 0
+    @param enable_ip6 - enable ip6 reassembly if non-zero, disable if 0
+*/
+autoreply define ip_reassembly_enable_disable
+{
+  u32 client_index;
+  u32 context;
+  u32 sw_if_index;
+  u8 enable_ip4;
+  u8 enable_ip6;
+};
+
 /*
  * Local Variables:
  * eval: (c-set-style "gnu")