gre: Tunnel encap/decap flags
[vpp.git] / src / vnet / gre / gre.api
index 1091835..fb78b47 100644 (file)
@@ -1,5 +1,6 @@
+/* Hey Emacs use -*- mode: C -*- */
 /*
- * Copyright (c) 2015-2016 Cisco and/or its affiliates.
+ * Copyright (c) 2015-2019 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:
  * limitations under the License.
  */
 
-vl_api_version 1.0.0
+option version = "2.0.2";
 
-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,
+  GRE_API_TUNNEL_TYPE_TEB,
+  GRE_API_TUNNEL_TYPE_ERSPAN,
+};
+
+/** \brief A GRE tunnel
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+    @param tunnel_type - 0: L3, 1: TEB, 2: ERSPAN
+    @param instance - optional unique custom device instance, else ~0.
+    @param mode - P2P or P2MP
+    @param flags - to control encap/decap behaviour
+    @param src - Source IP address
+    @param dst - Destination IP address, can be multicast
+    @param outer_table_id - Encap FIB table ID
+    @param session_id - session for ERSPAN tunnel, range 0-1023
+    @param sw_if_index - ignored on create/delete, present in details.
+*/
+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;
+};
+
+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
+define gre_tunnel_add_del_reply
 {
   u32 context;
   i32 retval;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 };
 
 define gre_tunnel_dump
 {
   u32 client_index;
   u32 context;
-  u32 sw_if_index;
+  vl_api_interface_index_t sw_if_index;
 };
 
 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;
 };
 
 /*