xref: /linux/drivers/net/ethernet/mediatek/mtk_ppe.h (revision c9d23f9657cabfd2836a096bf6eddf8df2cf1434)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /* Copyright (C) 2020 Felix Fietkau <nbd@nbd.name> */
3 
4 #ifndef __MTK_PPE_H
5 #define __MTK_PPE_H
6 
7 #include <linux/kernel.h>
8 #include <linux/bitfield.h>
9 #include <linux/rhashtable.h>
10 
11 #define MTK_PPE_ENTRIES_SHIFT		3
12 #define MTK_PPE_ENTRIES			(1024 << MTK_PPE_ENTRIES_SHIFT)
13 #define MTK_PPE_HASH_MASK		(MTK_PPE_ENTRIES - 1)
14 #define MTK_PPE_WAIT_TIMEOUT_US		1000000
15 
16 #define MTK_FOE_IB1_UNBIND_TIMESTAMP	GENMASK(7, 0)
17 #define MTK_FOE_IB1_UNBIND_PACKETS	GENMASK(23, 8)
18 #define MTK_FOE_IB1_UNBIND_PREBIND	BIT(24)
19 
20 #define MTK_FOE_IB1_BIND_TIMESTAMP	GENMASK(14, 0)
21 #define MTK_FOE_IB1_BIND_KEEPALIVE	BIT(15)
22 #define MTK_FOE_IB1_BIND_VLAN_LAYER	GENMASK(18, 16)
23 #define MTK_FOE_IB1_BIND_PPPOE		BIT(19)
24 #define MTK_FOE_IB1_BIND_VLAN_TAG	BIT(20)
25 #define MTK_FOE_IB1_BIND_PKT_SAMPLE	BIT(21)
26 #define MTK_FOE_IB1_BIND_CACHE		BIT(22)
27 #define MTK_FOE_IB1_BIND_TUNNEL_DECAP	BIT(23)
28 #define MTK_FOE_IB1_BIND_TTL		BIT(24)
29 
30 #define MTK_FOE_IB1_PACKET_TYPE		GENMASK(27, 25)
31 #define MTK_FOE_IB1_STATE		GENMASK(29, 28)
32 #define MTK_FOE_IB1_UDP			BIT(30)
33 #define MTK_FOE_IB1_STATIC		BIT(31)
34 
35 /* CONFIG_MEDIATEK_NETSYS_V2 */
36 #define MTK_FOE_IB1_BIND_TIMESTAMP_V2	GENMASK(7, 0)
37 #define MTK_FOE_IB1_BIND_VLAN_LAYER_V2	GENMASK(16, 14)
38 #define MTK_FOE_IB1_BIND_PPPOE_V2	BIT(17)
39 #define MTK_FOE_IB1_BIND_VLAN_TAG_V2	BIT(18)
40 #define MTK_FOE_IB1_BIND_CACHE_V2	BIT(20)
41 #define MTK_FOE_IB1_BIND_TTL_V2		BIT(22)
42 #define MTK_FOE_IB1_PACKET_TYPE_V2	GENMASK(27, 23)
43 
44 enum {
45 	MTK_PPE_PKT_TYPE_IPV4_HNAPT = 0,
46 	MTK_PPE_PKT_TYPE_IPV4_ROUTE = 1,
47 	MTK_PPE_PKT_TYPE_BRIDGE = 2,
48 	MTK_PPE_PKT_TYPE_IPV4_DSLITE = 3,
49 	MTK_PPE_PKT_TYPE_IPV6_ROUTE_3T = 4,
50 	MTK_PPE_PKT_TYPE_IPV6_ROUTE_5T = 5,
51 	MTK_PPE_PKT_TYPE_IPV6_6RD = 7,
52 };
53 
54 #define MTK_FOE_IB2_QID			GENMASK(3, 0)
55 #define MTK_FOE_IB2_PSE_QOS		BIT(4)
56 #define MTK_FOE_IB2_DEST_PORT		GENMASK(7, 5)
57 #define MTK_FOE_IB2_MULTICAST		BIT(8)
58 
59 #define MTK_FOE_IB2_WDMA_QID2		GENMASK(13, 12)
60 #define MTK_FOE_IB2_MIB_CNT		BIT(15)
61 #define MTK_FOE_IB2_WDMA_DEVIDX		BIT(16)
62 #define MTK_FOE_IB2_WDMA_WINFO		BIT(17)
63 
64 #define MTK_FOE_IB2_PORT_MG		GENMASK(17, 12)
65 
66 #define MTK_FOE_IB2_RX_IDX		GENMASK(18, 17)
67 #define MTK_FOE_IB2_PORT_AG		GENMASK(23, 18)
68 
69 #define MTK_FOE_IB2_DSCP		GENMASK(31, 24)
70 
71 /* CONFIG_MEDIATEK_NETSYS_V2 */
72 #define MTK_FOE_IB2_QID_V2			GENMASK(6, 0)
73 #define MTK_FOE_IB2_PORT_MG_V2		BIT(7)
74 #define MTK_FOE_IB2_PSE_QOS_V2		BIT(8)
75 #define MTK_FOE_IB2_DEST_PORT_V2	GENMASK(12, 9)
76 #define MTK_FOE_IB2_MULTICAST_V2	BIT(13)
77 #define MTK_FOE_IB2_WDMA_WINFO_V2	BIT(19)
78 #define MTK_FOE_IB2_PORT_AG_V2		GENMASK(23, 20)
79 
80 #define MTK_FOE_VLAN2_WINFO_BSS		GENMASK(5, 0)
81 #define MTK_FOE_VLAN2_WINFO_WCID	GENMASK(13, 6)
82 #define MTK_FOE_VLAN2_WINFO_RING	GENMASK(15, 14)
83 
84 #define MTK_FOE_WINFO_BSS		GENMASK(5, 0)
85 #define MTK_FOE_WINFO_WCID		GENMASK(15, 6)
86 
87 enum {
88 	MTK_FOE_STATE_INVALID,
89 	MTK_FOE_STATE_UNBIND,
90 	MTK_FOE_STATE_BIND,
91 	MTK_FOE_STATE_FIN
92 };
93 
94 struct mtk_foe_mac_info {
95 	u16 vlan1;
96 	u16 etype;
97 
98 	u32 dest_mac_hi;
99 
100 	u16 vlan2;
101 	u16 dest_mac_lo;
102 
103 	u32 src_mac_hi;
104 
105 	u16 pppoe_id;
106 	u16 src_mac_lo;
107 
108 	u16 minfo;
109 	u16 winfo;
110 };
111 
112 /* software-only entry type */
113 struct mtk_foe_bridge {
114 	u8 dest_mac[ETH_ALEN];
115 	u8 src_mac[ETH_ALEN];
116 	u16 vlan;
117 
118 	struct {} key_end;
119 
120 	u32 ib2;
121 
122 	struct mtk_foe_mac_info l2;
123 };
124 
125 struct mtk_ipv4_tuple {
126 	u32 src_ip;
127 	u32 dest_ip;
128 	union {
129 		struct {
130 			u16 dest_port;
131 			u16 src_port;
132 		};
133 		struct {
134 			u8 protocol;
135 			u8 _pad[3]; /* fill with 0xa5a5a5 */
136 		};
137 		u32 ports;
138 	};
139 };
140 
141 struct mtk_foe_ipv4 {
142 	struct mtk_ipv4_tuple orig;
143 
144 	u32 ib2;
145 
146 	struct mtk_ipv4_tuple new;
147 
148 	u16 timestamp;
149 	u16 _rsv0[3];
150 
151 	u32 udf_tsid;
152 
153 	struct mtk_foe_mac_info l2;
154 };
155 
156 struct mtk_foe_ipv4_dslite {
157 	struct mtk_ipv4_tuple ip4;
158 
159 	u32 tunnel_src_ip[4];
160 	u32 tunnel_dest_ip[4];
161 
162 	u8 flow_label[3];
163 	u8 priority;
164 
165 	u32 udf_tsid;
166 
167 	u32 ib2;
168 
169 	struct mtk_foe_mac_info l2;
170 };
171 
172 struct mtk_foe_ipv6 {
173 	u32 src_ip[4];
174 	u32 dest_ip[4];
175 
176 	union {
177 		struct {
178 			u8 protocol;
179 			u8 _pad[3]; /* fill with 0xa5a5a5 */
180 		}; /* 3-tuple */
181 		struct {
182 			u16 dest_port;
183 			u16 src_port;
184 		}; /* 5-tuple */
185 		u32 ports;
186 	};
187 
188 	u32 _rsv[3];
189 
190 	u32 udf;
191 
192 	u32 ib2;
193 	struct mtk_foe_mac_info l2;
194 };
195 
196 struct mtk_foe_ipv6_6rd {
197 	u32 src_ip[4];
198 	u32 dest_ip[4];
199 	u16 dest_port;
200 	u16 src_port;
201 
202 	u32 tunnel_src_ip;
203 	u32 tunnel_dest_ip;
204 
205 	u16 hdr_csum;
206 	u8 dscp;
207 	u8 ttl;
208 
209 	u8 flag;
210 	u8 pad;
211 	u8 per_flow_6rd_id;
212 	u8 pad2;
213 
214 	u32 ib2;
215 	struct mtk_foe_mac_info l2;
216 };
217 
218 struct mtk_foe_entry {
219 	u32 ib1;
220 
221 	union {
222 		struct mtk_foe_bridge bridge;
223 		struct mtk_foe_ipv4 ipv4;
224 		struct mtk_foe_ipv4_dslite dslite;
225 		struct mtk_foe_ipv6 ipv6;
226 		struct mtk_foe_ipv6_6rd ipv6_6rd;
227 		u32 data[23];
228 	};
229 };
230 
231 enum {
232 	MTK_PPE_CPU_REASON_TTL_EXCEEDED			= 0x02,
233 	MTK_PPE_CPU_REASON_OPTION_HEADER		= 0x03,
234 	MTK_PPE_CPU_REASON_NO_FLOW			= 0x07,
235 	MTK_PPE_CPU_REASON_IPV4_FRAG			= 0x08,
236 	MTK_PPE_CPU_REASON_IPV4_DSLITE_FRAG		= 0x09,
237 	MTK_PPE_CPU_REASON_IPV4_DSLITE_NO_TCP_UDP	= 0x0a,
238 	MTK_PPE_CPU_REASON_IPV6_6RD_NO_TCP_UDP		= 0x0b,
239 	MTK_PPE_CPU_REASON_TCP_FIN_SYN_RST		= 0x0c,
240 	MTK_PPE_CPU_REASON_UN_HIT			= 0x0d,
241 	MTK_PPE_CPU_REASON_HIT_UNBIND			= 0x0e,
242 	MTK_PPE_CPU_REASON_HIT_UNBIND_RATE_REACHED	= 0x0f,
243 	MTK_PPE_CPU_REASON_HIT_BIND_TCP_FIN		= 0x10,
244 	MTK_PPE_CPU_REASON_HIT_TTL_1			= 0x11,
245 	MTK_PPE_CPU_REASON_HIT_BIND_VLAN_VIOLATION	= 0x12,
246 	MTK_PPE_CPU_REASON_KEEPALIVE_UC_OLD_HDR		= 0x13,
247 	MTK_PPE_CPU_REASON_KEEPALIVE_MC_NEW_HDR		= 0x14,
248 	MTK_PPE_CPU_REASON_KEEPALIVE_DUP_OLD_HDR	= 0x15,
249 	MTK_PPE_CPU_REASON_HIT_BIND_FORCE_CPU		= 0x16,
250 	MTK_PPE_CPU_REASON_TUNNEL_OPTION_HEADER		= 0x17,
251 	MTK_PPE_CPU_REASON_MULTICAST_TO_CPU		= 0x18,
252 	MTK_PPE_CPU_REASON_MULTICAST_TO_GMAC1_CPU	= 0x19,
253 	MTK_PPE_CPU_REASON_HIT_PRE_BIND			= 0x1a,
254 	MTK_PPE_CPU_REASON_PACKET_SAMPLING		= 0x1b,
255 	MTK_PPE_CPU_REASON_EXCEED_MTU			= 0x1c,
256 	MTK_PPE_CPU_REASON_PPE_BYPASS			= 0x1e,
257 	MTK_PPE_CPU_REASON_INVALID			= 0x1f,
258 };
259 
260 enum {
261 	MTK_FLOW_TYPE_L4,
262 	MTK_FLOW_TYPE_L2,
263 	MTK_FLOW_TYPE_L2_SUBFLOW,
264 };
265 
266 struct mtk_flow_entry {
267 	union {
268 		struct hlist_node list;
269 		struct {
270 			struct rhash_head l2_node;
271 			struct hlist_head l2_flows;
272 		};
273 	};
274 	u8 type;
275 	s8 wed_index;
276 	u8 ppe_index;
277 	u16 hash;
278 	union {
279 		struct mtk_foe_entry data;
280 		struct {
281 			struct mtk_flow_entry *base_flow;
282 			struct hlist_node list;
283 		} l2_data;
284 	};
285 	struct rhash_head node;
286 	unsigned long cookie;
287 };
288 
289 struct mtk_mib_entry {
290 	u32	byt_cnt_l;
291 	u16	byt_cnt_h;
292 	u32	pkt_cnt_l;
293 	u8	pkt_cnt_h;
294 	u8	_rsv0;
295 	u32	_rsv1;
296 } __packed;
297 
298 struct mtk_foe_accounting {
299 	u64	bytes;
300 	u64	packets;
301 };
302 
303 struct mtk_ppe {
304 	struct mtk_eth *eth;
305 	struct device *dev;
306 	void __iomem *base;
307 	int version;
308 	char dirname[5];
309 	bool accounting;
310 
311 	void *foe_table;
312 	dma_addr_t foe_phys;
313 
314 	struct mtk_mib_entry *mib_table;
315 	dma_addr_t mib_phys;
316 
317 	u16 foe_check_time[MTK_PPE_ENTRIES];
318 	struct hlist_head *foe_flow;
319 
320 	struct rhashtable l2_flows;
321 
322 	void *acct_table;
323 };
324 
325 struct mtk_ppe *mtk_ppe_init(struct mtk_eth *eth, void __iomem *base, int index);
326 
327 void mtk_ppe_deinit(struct mtk_eth *eth);
328 void mtk_ppe_start(struct mtk_ppe *ppe);
329 int mtk_ppe_stop(struct mtk_ppe *ppe);
330 int mtk_ppe_prepare_reset(struct mtk_ppe *ppe);
331 
332 void __mtk_ppe_check_skb(struct mtk_ppe *ppe, struct sk_buff *skb, u16 hash);
333 
334 static inline void
335 mtk_ppe_check_skb(struct mtk_ppe *ppe, struct sk_buff *skb, u16 hash)
336 {
337 	u16 now, diff;
338 
339 	if (!ppe)
340 		return;
341 
342 	if (hash > MTK_PPE_HASH_MASK)
343 		return;
344 
345 	now = (u16)jiffies;
346 	diff = now - ppe->foe_check_time[hash];
347 	if (diff < HZ / 10)
348 		return;
349 
350 	ppe->foe_check_time[hash] = now;
351 	__mtk_ppe_check_skb(ppe, skb, hash);
352 }
353 
354 int mtk_foe_entry_prepare(struct mtk_eth *eth, struct mtk_foe_entry *entry,
355 			  int type, int l4proto, u8 pse_port, u8 *src_mac,
356 			  u8 *dest_mac);
357 int mtk_foe_entry_set_pse_port(struct mtk_eth *eth,
358 			       struct mtk_foe_entry *entry, u8 port);
359 int mtk_foe_entry_set_ipv4_tuple(struct mtk_eth *eth,
360 				 struct mtk_foe_entry *entry, bool orig,
361 				 __be32 src_addr, __be16 src_port,
362 				 __be32 dest_addr, __be16 dest_port);
363 int mtk_foe_entry_set_ipv6_tuple(struct mtk_eth *eth,
364 				 struct mtk_foe_entry *entry,
365 				 __be32 *src_addr, __be16 src_port,
366 				 __be32 *dest_addr, __be16 dest_port);
367 int mtk_foe_entry_set_dsa(struct mtk_eth *eth, struct mtk_foe_entry *entry,
368 			  int port);
369 int mtk_foe_entry_set_vlan(struct mtk_eth *eth, struct mtk_foe_entry *entry,
370 			   int vid);
371 int mtk_foe_entry_set_pppoe(struct mtk_eth *eth, struct mtk_foe_entry *entry,
372 			    int sid);
373 int mtk_foe_entry_set_wdma(struct mtk_eth *eth, struct mtk_foe_entry *entry,
374 			   int wdma_idx, int txq, int bss, int wcid);
375 int mtk_foe_entry_set_queue(struct mtk_eth *eth, struct mtk_foe_entry *entry,
376 			    unsigned int queue);
377 int mtk_foe_entry_commit(struct mtk_ppe *ppe, struct mtk_flow_entry *entry);
378 void mtk_foe_entry_clear(struct mtk_ppe *ppe, struct mtk_flow_entry *entry);
379 int mtk_foe_entry_idle_time(struct mtk_ppe *ppe, struct mtk_flow_entry *entry);
380 int mtk_ppe_debugfs_init(struct mtk_ppe *ppe, int index);
381 struct mtk_foe_accounting *mtk_foe_entry_get_mib(struct mtk_ppe *ppe, u32 index,
382 						 struct mtk_foe_accounting *diff);
383 
384 #endif
385