1 /*
2  * drivers/net/ethernet/mellanox/mlxsw/spectrum_ipip.h
3  * Copyright (c) 2017-2018 Mellanox Technologies. All rights reserved.
4  * Copyright (c) 2017-2018 Petr Machata <petrm@mellanox.com>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. Neither the names of the copyright holders nor the names of its
15  *    contributors may be used to endorse or promote products derived from
16  *    this software without specific prior written permission.
17  *
18  * Alternatively, this software may be distributed under the terms of the
19  * GNU General Public License ("GPL") version 2 as published by the Free
20  * Software Foundation.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef _MLXSW_IPIP_H_
36 #define _MLXSW_IPIP_H_
37 
38 #include "spectrum_router.h"
39 #include <net/ip_fib.h>
40 #include <linux/if_tunnel.h>
41 
42 struct ip_tunnel_parm
43 mlxsw_sp_ipip_netdev_parms4(const struct net_device *ol_dev);
44 struct __ip6_tnl_parm
45 mlxsw_sp_ipip_netdev_parms6(const struct net_device *ol_dev);
46 
47 union mlxsw_sp_l3addr
48 mlxsw_sp_ipip_netdev_saddr(enum mlxsw_sp_l3proto proto,
49 			   const struct net_device *ol_dev);
50 
51 bool mlxsw_sp_l3addr_is_zero(union mlxsw_sp_l3addr addr);
52 
53 enum mlxsw_sp_ipip_type {
54 	MLXSW_SP_IPIP_TYPE_GRE4,
55 	MLXSW_SP_IPIP_TYPE_MAX,
56 };
57 
58 struct mlxsw_sp_ipip_entry {
59 	enum mlxsw_sp_ipip_type ipipt;
60 	struct net_device *ol_dev; /* Overlay. */
61 	struct mlxsw_sp_rif_ipip_lb *ol_lb;
62 	struct mlxsw_sp_fib_entry *decap_fib_entry;
63 	struct list_head ipip_list_node;
64 	union {
65 		struct ip_tunnel_parm parms4;
66 	};
67 };
68 
69 struct mlxsw_sp_ipip_ops {
70 	int dev_type;
71 	enum mlxsw_sp_l3proto ul_proto; /* Underlay. */
72 
73 	int (*nexthop_update)(struct mlxsw_sp *mlxsw_sp, u32 adj_index,
74 			      struct mlxsw_sp_ipip_entry *ipip_entry);
75 
76 	bool (*can_offload)(const struct mlxsw_sp *mlxsw_sp,
77 			    const struct net_device *ol_dev,
78 			    enum mlxsw_sp_l3proto ol_proto);
79 
80 	/* Return a configuration for creating an overlay loopback RIF. */
81 	struct mlxsw_sp_rif_ipip_lb_config
82 	(*ol_loopback_config)(struct mlxsw_sp *mlxsw_sp,
83 			      const struct net_device *ol_dev);
84 
85 	int (*fib_entry_op)(struct mlxsw_sp *mlxsw_sp,
86 			    struct mlxsw_sp_ipip_entry *ipip_entry,
87 			    enum mlxsw_reg_ralue_op op,
88 			    u32 tunnel_index);
89 
90 	int (*ol_netdev_change)(struct mlxsw_sp *mlxsw_sp,
91 				struct mlxsw_sp_ipip_entry *ipip_entry,
92 				struct netlink_ext_ack *extack);
93 };
94 
95 extern const struct mlxsw_sp_ipip_ops *mlxsw_sp_ipip_ops_arr[];
96 
97 #endif /* _MLXSW_IPIP_H_*/
98