xref: /openbmc/linux/drivers/net/ethernet/mellanox/mlxsw/spectrum_router.h (revision ba61bb17496d1664bf7c5c2fd650d5fd78bd0a92)
1 /*
2  * drivers/net/ethernet/mellanox/mlxsw/spectrum_router.h
3  * Copyright (c) 2017 Mellanox Technologies. All rights reserved.
4  * Copyright (c) 2017 Arkadi Sharshevsky <arkadis@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_ROUTER_H_
36 #define _MLXSW_ROUTER_H_
37 
38 #include "spectrum.h"
39 #include "reg.h"
40 
41 enum mlxsw_sp_l3proto {
42 	MLXSW_SP_L3_PROTO_IPV4,
43 	MLXSW_SP_L3_PROTO_IPV6,
44 #define MLXSW_SP_L3_PROTO_MAX	(MLXSW_SP_L3_PROTO_IPV6 + 1)
45 };
46 
47 union mlxsw_sp_l3addr {
48 	__be32 addr4;
49 	struct in6_addr addr6;
50 };
51 
52 struct mlxsw_sp_rif_ipip_lb;
53 struct mlxsw_sp_rif_ipip_lb_config {
54 	enum mlxsw_reg_ritr_loopback_ipip_type lb_ipipt;
55 	u32 okey;
56 	enum mlxsw_sp_l3proto ul_protocol; /* Underlay. */
57 	union mlxsw_sp_l3addr saddr;
58 };
59 
60 enum mlxsw_sp_rif_counter_dir {
61 	MLXSW_SP_RIF_COUNTER_INGRESS,
62 	MLXSW_SP_RIF_COUNTER_EGRESS,
63 };
64 
65 struct mlxsw_sp_neigh_entry;
66 struct mlxsw_sp_nexthop;
67 struct mlxsw_sp_ipip_entry;
68 
69 struct mlxsw_sp_rif *mlxsw_sp_rif_by_index(const struct mlxsw_sp *mlxsw_sp,
70 					   u16 rif_index);
71 u16 mlxsw_sp_rif_index(const struct mlxsw_sp_rif *rif);
72 u16 mlxsw_sp_ipip_lb_rif_index(const struct mlxsw_sp_rif_ipip_lb *rif);
73 u16 mlxsw_sp_ipip_lb_ul_vr_id(const struct mlxsw_sp_rif_ipip_lb *rif);
74 u32 mlxsw_sp_ipip_dev_ul_tb_id(const struct net_device *ol_dev);
75 int mlxsw_sp_rif_dev_ifindex(const struct mlxsw_sp_rif *rif);
76 u8 mlxsw_sp_router_port(const struct mlxsw_sp *mlxsw_sp);
77 const struct net_device *mlxsw_sp_rif_dev(const struct mlxsw_sp_rif *rif);
78 int mlxsw_sp_rif_counter_value_get(struct mlxsw_sp *mlxsw_sp,
79 				   struct mlxsw_sp_rif *rif,
80 				   enum mlxsw_sp_rif_counter_dir dir,
81 				   u64 *cnt);
82 void mlxsw_sp_rif_counter_free(struct mlxsw_sp *mlxsw_sp,
83 			       struct mlxsw_sp_rif *rif,
84 			       enum mlxsw_sp_rif_counter_dir dir);
85 int mlxsw_sp_rif_counter_alloc(struct mlxsw_sp *mlxsw_sp,
86 			       struct mlxsw_sp_rif *rif,
87 			       enum mlxsw_sp_rif_counter_dir dir);
88 struct mlxsw_sp_neigh_entry *
89 mlxsw_sp_rif_neigh_next(struct mlxsw_sp_rif *rif,
90 			struct mlxsw_sp_neigh_entry *neigh_entry);
91 int mlxsw_sp_neigh_entry_type(struct mlxsw_sp_neigh_entry *neigh_entry);
92 unsigned char *
93 mlxsw_sp_neigh_entry_ha(struct mlxsw_sp_neigh_entry *neigh_entry);
94 u32 mlxsw_sp_neigh4_entry_dip(struct mlxsw_sp_neigh_entry *neigh_entry);
95 struct in6_addr *
96 mlxsw_sp_neigh6_entry_dip(struct mlxsw_sp_neigh_entry *neigh_entry);
97 
98 #define mlxsw_sp_rif_neigh_for_each(neigh_entry, rif)				\
99 	for (neigh_entry = mlxsw_sp_rif_neigh_next(rif, NULL); neigh_entry;	\
100 	     neigh_entry = mlxsw_sp_rif_neigh_next(rif, neigh_entry))
101 int mlxsw_sp_neigh_counter_get(struct mlxsw_sp *mlxsw_sp,
102 			       struct mlxsw_sp_neigh_entry *neigh_entry,
103 			       u64 *p_counter);
104 void
105 mlxsw_sp_neigh_entry_counter_update(struct mlxsw_sp *mlxsw_sp,
106 				    struct mlxsw_sp_neigh_entry *neigh_entry,
107 				    bool adding);
108 bool mlxsw_sp_neigh_ipv6_ignore(struct mlxsw_sp_neigh_entry *neigh_entry);
109 int __mlxsw_sp_ipip_entry_update_tunnel(struct mlxsw_sp *mlxsw_sp,
110 					struct mlxsw_sp_ipip_entry *ipip_entry,
111 					bool recreate_loopback,
112 					bool keep_encap,
113 					bool update_nexthops,
114 					struct netlink_ext_ack *extack);
115 void mlxsw_sp_ipip_entry_demote_tunnel(struct mlxsw_sp *mlxsw_sp,
116 				       struct mlxsw_sp_ipip_entry *ipip_entry);
117 bool
118 mlxsw_sp_ipip_demote_tunnel_by_saddr(struct mlxsw_sp *mlxsw_sp,
119 				     enum mlxsw_sp_l3proto ul_proto,
120 				     union mlxsw_sp_l3addr saddr,
121 				     u32 ul_tb_id,
122 				     const struct mlxsw_sp_ipip_entry *except);
123 struct mlxsw_sp_nexthop *mlxsw_sp_nexthop_next(struct mlxsw_sp_router *router,
124 					       struct mlxsw_sp_nexthop *nh);
125 bool mlxsw_sp_nexthop_offload(struct mlxsw_sp_nexthop *nh);
126 unsigned char *mlxsw_sp_nexthop_ha(struct mlxsw_sp_nexthop *nh);
127 int mlxsw_sp_nexthop_indexes(struct mlxsw_sp_nexthop *nh, u32 *p_adj_index,
128 			     u32 *p_adj_size, u32 *p_adj_hash_index);
129 struct mlxsw_sp_rif *mlxsw_sp_nexthop_rif(struct mlxsw_sp_nexthop *nh);
130 bool mlxsw_sp_nexthop_group_has_ipip(struct mlxsw_sp_nexthop *nh);
131 #define mlxsw_sp_nexthop_for_each(nh, router)				\
132 	for (nh = mlxsw_sp_nexthop_next(router, NULL); nh;		\
133 	     nh = mlxsw_sp_nexthop_next(router, nh))
134 int mlxsw_sp_nexthop_counter_get(struct mlxsw_sp *mlxsw_sp,
135 				 struct mlxsw_sp_nexthop *nh, u64 *p_counter);
136 int mlxsw_sp_nexthop_update(struct mlxsw_sp *mlxsw_sp, u32 adj_index,
137 			    struct mlxsw_sp_nexthop *nh);
138 void mlxsw_sp_nexthop_counter_alloc(struct mlxsw_sp *mlxsw_sp,
139 				    struct mlxsw_sp_nexthop *nh);
140 void mlxsw_sp_nexthop_counter_free(struct mlxsw_sp *mlxsw_sp,
141 				   struct mlxsw_sp_nexthop *nh);
142 
143 static inline bool mlxsw_sp_l3addr_eq(const union mlxsw_sp_l3addr *addr1,
144 				      const union mlxsw_sp_l3addr *addr2)
145 {
146 	return !memcmp(addr1, addr2, sizeof(*addr1));
147 }
148 
149 #endif /* _MLXSW_ROUTER_H_*/
150