X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fgre%2Fgre.api;h=f4e025394b33b3012bce47fa38eee6fa47146f94;hb=073d74d0b;hp=b410ac9d49a1ece078908c8d97a83d2c073bee64;hpb=9d42087149a6870965896be74dc6260f72d2cac9;p=vpp.git

diff --git a/src/vnet/gre/gre.api b/src/vnet/gre/gre.api
index b410ac9d49a..f4e025394b3 100644
--- a/src/vnet/gre/gre.api
+++ b/src/vnet/gre/gre.api
@@ -1,5 +1,6 @@
+/* Hey Emacs use -*- mode: C -*- */
 /*
- * Copyright (c) 2015-2016 Cisco and/or its affiliates.
+ * Copyright (c) 2015-2020 Cisco and/or its affiliates.
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at:
@@ -13,43 +14,93 @@
  * limitations under the License.
  */
 
-option version = "1.0.0";
+option version = "2.1.0";
 
-define gre_add_del_tunnel
+import "vnet/interface_types.api";
+import "vnet/tunnel/tunnel_types.api";
+import "vnet/ip/ip_types.api";
+
+/** \brief A GRE tunnel type
+*/
+enum gre_tunnel_type : u8
+{
+  GRE_API_TUNNEL_TYPE_L3 = 0,
+  /* L2 Transparent Ethernet Bridge */
+  GRE_API_TUNNEL_TYPE_TEB,
+  /* Encapsulated Remote Switched Port ANalyzer */
+  GRE_API_TUNNEL_TYPE_ERSPAN,
+};
+
+/** \brief A composite type uniquely defining a GRE tunnel.
+    @param type - tunnel type (see enum definition), 0: L3, 1: TEB, 2: ERSPAN
+    @param mode - P2P or P2MP
+    @param flags - to control encap/decap behaviour
+    @param session_id - session for ERSPAN tunnel, range 0-1023
+    @param instance - optional unique custom device instance, else ~0.
+    @param outer_table_id - Encap FIB table ID
+    @param sw_if_index - ignored on create/delete, present in details.
+    @param src - Source IP address
+    @param dst - Destination IP address, can be multicast
+*/
+typedef gre_tunnel
+{
+  vl_api_gre_tunnel_type_t type;
+  vl_api_tunnel_mode_t mode;
+  vl_api_tunnel_encap_decap_flags_t flags;
+  u16 session_id;
+  u32 instance;
+  u32 outer_table_id;
+  vl_api_interface_index_t sw_if_index;
+  vl_api_address_t src;
+  vl_api_address_t dst;
+};
+
+/** \brief Add or delete a single GRE tunnel.
+    @param client_index - opaque cookie to identify the sender.
+    @param context - sender context, to match reply w/ request.
+    @param is_add - add if true, delete if false.
+    @param tunnel - tunnel definition to add or delete.
+*/
+define gre_tunnel_add_del
 {
   u32 client_index;
   u32 context;
-  u8 is_add;
-  u8 is_ipv6;
-  u8 teb;
-  u8 src_address[16];
-  u8 dst_address[16];
-  u32 outer_fib_id;
+  bool is_add;
+  vl_api_gre_tunnel_t tunnel;
 };
 
-define gre_add_del_tunnel_reply
+/** \brief Add or delete a single GRE tunnel.
+    @param context - sender context, to match reply w/ request.
+    @param retval - return code for the request.
+    @param sw_if_index - the interface corresponding to the affected tunnel.
+*/
+define gre_tunnel_add_del_reply
 {
   u32 context;
   i32 retval;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 };
 
+/** \brief Dump details of all or just a single GRE tunnel.
+    @param client_index - opaque cookie to identify the sender.
+    @param context - sender context, to match reply w/ request.
+    @param sw_if_index - filter for tunnel of this interface index, ~0 for all.
+*/
 define gre_tunnel_dump
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 };
 
+/** \brief Details response for one of the requested GRE tunnels.
+    @param context - sender context, to match reply w/ request.
+    @param tunnel - definition of the dumped tunnel.
+*/
 define gre_tunnel_details
 {
   u32 context;
-  u32 sw_if_index;
-  u8 is_ipv6;
-  u8 teb;
-  u8 src_address[16];
-  u8 dst_address[16];
-  u32 outer_fib_id;
+  vl_api_gre_tunnel_t tunnel;
 };
 
 /*