1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2018-2019 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
20 * This file defines vpp UDP control-plane API messages which are generally
21 * called through a shared memory interface.
24 option version = "1.1.0";
26 import "vnet/ip/ip_types.api";
30 * @brief UDP Encap object
31 * @param table_id - table ID associated with the encap destination
32 * @param dst_ip - Encap destination address
33 * @param src_ip - Encap source address
34 * @param dst_port - Encap destination port
35 * @param src_port - Encap source port, 0 for entopy per rfc7510
36 * @param id - VPP assigned id; ignored in add message, set in dump
43 vl_api_address_t src_ip;
44 vl_api_address_t dst_ip;
48 enum udp_decap_next_proto
50 UDP_API_DECAP_PROTO_IP4,
51 UDP_API_DECAP_PROTO_IP6,
52 UDP_API_DECAP_PROTO_MPLS,
56 * @brief UDP Decap object
57 * @param is_ip4 - IPv4 if non-zero, else IPv6
58 * @param port - port to listen on for the decap
59 * @param next_proto - the protocol of the inner header
65 vl_api_udp_decap_next_proto_t next_proto;
69 * @brief Add UDP encap
70 * @param client_index - opaque cookie to identify the sender
71 * @param context - sender context, to match reply w/ request
72 * @param udp_encap - UDP encap description
78 vl_api_udp_encap_t udp_encap;
82 * @brief Add UDP encap reply
83 * @param context - sender context, to match reply w/ request
84 * @param retval - success/failure return value
85 * @param id - The ID of the encap object that should be used on delete
86 * and when reading stats from the stats segment.
88 define udp_encap_add_reply
96 * @brief Del UDP encap
97 * @param client_index - opaque cookie to identify the sender
98 * @param context - sender context, to match reply w/ request
99 * @param id - ID of the encap object the client chose during the add
101 autoreply define udp_encap_del
109 * @brief dump UDP encaps
111 define udp_encap_dump
118 * @brief UDP encap details during dump
120 define udp_encap_details
123 vl_api_udp_encap_t udp_encap;
127 * @brief Add/Del UDP decap
128 * @param client_index - opaque cookie to identify the sender
129 * @param context - sender context, to match reply w/ request
130 * @param is_add - add decap if non-zero, else delete
131 * @param udp_decap - UDP decap description
133 autoreply define udp_decap_add_del
138 vl_api_udp_decap_t udp_decap;
143 * eval: (c-set-style "gnu")