examples/tep_term: add inner checksum Tx offload configuration
[dpdk.git] / examples / tep_termination / vxlan.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef _VXLAN_H_
35 #define _VXLAN_H_
36
37 #include <rte_ether.h>
38 #include <rte_ip.h>
39
40 #define PORT_MIN        49152
41 #define PORT_MAX        65535
42 #define PORT_RANGE ((PORT_MAX - PORT_MIN) + 1)
43
44 #define VXLAN_N_PORTS  2
45 #define VXLAN_HF_VNI 0x08000000
46 #define DEFAULT_VXLAN_PORT 4789
47
48 extern struct ipv4_hdr app_ip_hdr[VXLAN_N_PORTS];
49 extern struct ether_hdr app_l2_hdr[VXLAN_N_PORTS];
50 extern uint8_t tx_checksum;
51
52 struct vxlan_port {
53         uint32_t vport_id;           /**< VirtIO port id */
54         uint32_t peer_ip;            /**< remote VTEP IP address */
55         struct ether_addr peer_mac;  /**< remote VTEP MAC address */
56         struct ether_addr vport_mac; /**< VirtIO port MAC address */
57 } __rte_cache_aligned;
58
59 struct vxlan_conf {
60         uint16_t dst_port;      /**< VXLAN UDP destination port */
61         uint32_t port_ip;       /**< DPDK port IP address*/
62         uint32_t in_key;        /**< VLAN  ID */
63         uint32_t out_key;       /**< VXLAN VNI */
64         struct vxlan_port port[VXLAN_N_PORTS]; /**< VXLAN configuration */
65 } __rte_cache_aligned;
66
67 extern struct vxlan_conf vxdev;
68
69 /* structure that caches offload info for the current packet */
70 union tunnel_offload_info {
71         uint64_t data;
72         struct {
73                 uint64_t l2_len:7; /**< L2 (MAC) Header Length. */
74                 uint64_t l3_len:9; /**< L3 (IP) Header Length. */
75                 uint64_t l4_len:8; /**< L4 Header Length. */
76                 uint64_t outer_l2_len:7; /**< outer L2 Header Length */
77                 uint64_t outer_l3_len:16; /**< outer L3 Header Length */
78         };
79 } __rte_cache_aligned;
80
81 int decapsulation(struct rte_mbuf *pkt);
82 void encapsulation(struct rte_mbuf *m, uint8_t queue_id);
83
84 #endif /* _VXLAN_H_ */