udp: add udp decapsulation

[vpp.git] / src / vnet / udp / udp.api

diff --git a/src/vnet/udp/udp.api b/src/vnet/udp/udp.api
index 8788fba..02176be 100644 (file)
--- a/src/vnet/udp/udp.api
+++ b/src/vnet/udp/udp.api
@@ -1,6 +1,6 @@
 /* Hey Emacs use -*- mode: C -*- */
 /*
- * Copyright (c) 2018 Cisco and/or its affiliates.
+ * Copyright (c) 2018-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:
@@ -33,16 +33,36 @@ import "vnet/ip/ip_types.api";
  * @param src_ip - Encap source address
  * @param dst_port - Encap destination port
  * @param src_port - Encap source port
- * @param id - The ID assigned to this encap object by the caller
+ * @param id - VPP assigned id; ignored in add message, set in dump
  */
 typedef udp_encap
 {
-  u32 id;
   u32 table_id;
   u16 src_port;
   u16 dst_port;
   vl_api_address_t src_ip;
   vl_api_address_t dst_ip;
+  u32 id;
+};
+
+enum udp_decap_next_proto
+{
+    UDP_API_DECAP_PROTO_IP4,
+    UDP_API_DECAP_PROTO_IP6,
+    UDP_API_DECAP_PROTO_MPLS,
+};
+
+/**
+ * @brief UDP Decap object
+ * @param is_ip4 - IPv4 if non-zero, else IPv6
+ * @param port - port to listen on for the decap
+ * @param next_proto - the protocol of the inner header
+ */
+typedef udp_decap
+{
+  u8 is_ip4;
+  u16 port;
+  vl_api_udp_decap_next_proto_t next_proto;
 };
 
 /**
@@ -51,13 +71,27 @@ typedef udp_encap
  * @param context - sender context, to match reply w/ request
  * @param udp_encap - UDP encap description
  */
-autoreply define udp_encap_add
+define udp_encap_add
 {
   u32 client_index;
   u32 context;
   vl_api_udp_encap_t udp_encap;
 };
 
+/**
+ * @brief Add UDP encap reply
+ * @param context - sender context, to match reply w/ request
+ * @param retval - success/failure return value
+ * @param id - The ID of the encap object that should be used on delete
+ *             and when reading stats from the stats segment.
+ */
+define udp_encap_add_reply
+{
+  u32 context;
+  i32 retval;
+  u32 id;
+};
+
 /**
  * @brief Del UDP encap
  * @param client_index - opaque cookie to identify the sender
@@ -89,6 +123,21 @@ define udp_encap_details
   vl_api_udp_encap_t udp_encap;
 };
 
+/**
+ * @brief Add/Del UDP decap
+ * @param client_index - opaque cookie to identify the sender
+ * @param context - sender context, to match reply w/ request
+ * @param is_add - add decap if non-zero, else delete
+ * @param udp_decap - UDP decap description
+ */
+autoreply define udp_decap_add_del
+{
+  u32 client_index;
+  u32 context;
+  bool is_add;
+  vl_api_udp_decap_t udp_decap;
+};
+
 /*
  * Local Variables:
  * eval: (c-set-style "gnu")