xref: /linux/drivers/net/dsa/sja1105/sja1105_main.c (revision 2c63221cd9e5c0dad0424029aeb1c40faada8330)
1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright (c) 2018, Sensor-Technik Wiedemann GmbH
3  * Copyright (c) 2018-2019, Vladimir Oltean <olteanv@gmail.com>
4  */
5 
6 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
7 
8 #include <linux/delay.h>
9 #include <linux/module.h>
10 #include <linux/printk.h>
11 #include <linux/spi/spi.h>
12 #include <linux/errno.h>
13 #include <linux/gpio/consumer.h>
14 #include <linux/phylink.h>
15 #include <linux/of.h>
16 #include <linux/of_net.h>
17 #include <linux/of_mdio.h>
18 #include <linux/of_device.h>
19 #include <linux/netdev_features.h>
20 #include <linux/netdevice.h>
21 #include <linux/if_bridge.h>
22 #include <linux/if_ether.h>
23 #include <linux/dsa/8021q.h>
24 #include "sja1105.h"
25 #include "sja1105_tas.h"
26 
27 static void sja1105_hw_reset(struct gpio_desc *gpio, unsigned int pulse_len,
28 			     unsigned int startup_delay)
29 {
30 	gpiod_set_value_cansleep(gpio, 1);
31 	/* Wait for minimum reset pulse length */
32 	msleep(pulse_len);
33 	gpiod_set_value_cansleep(gpio, 0);
34 	/* Wait until chip is ready after reset */
35 	msleep(startup_delay);
36 }
37 
38 static void
39 sja1105_port_allow_traffic(struct sja1105_l2_forwarding_entry *l2_fwd,
40 			   int from, int to, bool allow)
41 {
42 	if (allow) {
43 		l2_fwd[from].bc_domain  |= BIT(to);
44 		l2_fwd[from].reach_port |= BIT(to);
45 		l2_fwd[from].fl_domain  |= BIT(to);
46 	} else {
47 		l2_fwd[from].bc_domain  &= ~BIT(to);
48 		l2_fwd[from].reach_port &= ~BIT(to);
49 		l2_fwd[from].fl_domain  &= ~BIT(to);
50 	}
51 }
52 
53 /* Structure used to temporarily transport device tree
54  * settings into sja1105_setup
55  */
56 struct sja1105_dt_port {
57 	phy_interface_t phy_mode;
58 	sja1105_mii_role_t role;
59 };
60 
61 static int sja1105_init_mac_settings(struct sja1105_private *priv)
62 {
63 	struct sja1105_mac_config_entry default_mac = {
64 		/* Enable all 8 priority queues on egress.
65 		 * Every queue i holds top[i] - base[i] frames.
66 		 * Sum of top[i] - base[i] is 511 (max hardware limit).
67 		 */
68 		.top  = {0x3F, 0x7F, 0xBF, 0xFF, 0x13F, 0x17F, 0x1BF, 0x1FF},
69 		.base = {0x0, 0x40, 0x80, 0xC0, 0x100, 0x140, 0x180, 0x1C0},
70 		.enabled = {true, true, true, true, true, true, true, true},
71 		/* Keep standard IFG of 12 bytes on egress. */
72 		.ifg = 0,
73 		/* Always put the MAC speed in automatic mode, where it can be
74 		 * adjusted at runtime by PHYLINK.
75 		 */
76 		.speed = SJA1105_SPEED_AUTO,
77 		/* No static correction for 1-step 1588 events */
78 		.tp_delin = 0,
79 		.tp_delout = 0,
80 		/* Disable aging for critical TTEthernet traffic */
81 		.maxage = 0xFF,
82 		/* Internal VLAN (pvid) to apply to untagged ingress */
83 		.vlanprio = 0,
84 		.vlanid = 1,
85 		.ing_mirr = false,
86 		.egr_mirr = false,
87 		/* Don't drop traffic with other EtherType than ETH_P_IP */
88 		.drpnona664 = false,
89 		/* Don't drop double-tagged traffic */
90 		.drpdtag = false,
91 		/* Don't drop untagged traffic */
92 		.drpuntag = false,
93 		/* Don't retag 802.1p (VID 0) traffic with the pvid */
94 		.retag = false,
95 		/* Disable learning and I/O on user ports by default -
96 		 * STP will enable it.
97 		 */
98 		.dyn_learn = false,
99 		.egress = false,
100 		.ingress = false,
101 	};
102 	struct sja1105_mac_config_entry *mac;
103 	struct sja1105_table *table;
104 	int i;
105 
106 	table = &priv->static_config.tables[BLK_IDX_MAC_CONFIG];
107 
108 	/* Discard previous MAC Configuration Table */
109 	if (table->entry_count) {
110 		kfree(table->entries);
111 		table->entry_count = 0;
112 	}
113 
114 	table->entries = kcalloc(SJA1105_NUM_PORTS,
115 				 table->ops->unpacked_entry_size, GFP_KERNEL);
116 	if (!table->entries)
117 		return -ENOMEM;
118 
119 	table->entry_count = SJA1105_NUM_PORTS;
120 
121 	mac = table->entries;
122 
123 	for (i = 0; i < SJA1105_NUM_PORTS; i++) {
124 		mac[i] = default_mac;
125 		if (i == dsa_upstream_port(priv->ds, i)) {
126 			/* STP doesn't get called for CPU port, so we need to
127 			 * set the I/O parameters statically.
128 			 */
129 			mac[i].dyn_learn = true;
130 			mac[i].ingress = true;
131 			mac[i].egress = true;
132 		}
133 	}
134 
135 	return 0;
136 }
137 
138 static int sja1105_init_mii_settings(struct sja1105_private *priv,
139 				     struct sja1105_dt_port *ports)
140 {
141 	struct device *dev = &priv->spidev->dev;
142 	struct sja1105_xmii_params_entry *mii;
143 	struct sja1105_table *table;
144 	int i;
145 
146 	table = &priv->static_config.tables[BLK_IDX_XMII_PARAMS];
147 
148 	/* Discard previous xMII Mode Parameters Table */
149 	if (table->entry_count) {
150 		kfree(table->entries);
151 		table->entry_count = 0;
152 	}
153 
154 	table->entries = kcalloc(SJA1105_MAX_XMII_PARAMS_COUNT,
155 				 table->ops->unpacked_entry_size, GFP_KERNEL);
156 	if (!table->entries)
157 		return -ENOMEM;
158 
159 	/* Override table based on PHYLINK DT bindings */
160 	table->entry_count = SJA1105_MAX_XMII_PARAMS_COUNT;
161 
162 	mii = table->entries;
163 
164 	for (i = 0; i < SJA1105_NUM_PORTS; i++) {
165 		switch (ports[i].phy_mode) {
166 		case PHY_INTERFACE_MODE_MII:
167 			mii->xmii_mode[i] = XMII_MODE_MII;
168 			break;
169 		case PHY_INTERFACE_MODE_RMII:
170 			mii->xmii_mode[i] = XMII_MODE_RMII;
171 			break;
172 		case PHY_INTERFACE_MODE_RGMII:
173 		case PHY_INTERFACE_MODE_RGMII_ID:
174 		case PHY_INTERFACE_MODE_RGMII_RXID:
175 		case PHY_INTERFACE_MODE_RGMII_TXID:
176 			mii->xmii_mode[i] = XMII_MODE_RGMII;
177 			break;
178 		default:
179 			dev_err(dev, "Unsupported PHY mode %s!\n",
180 				phy_modes(ports[i].phy_mode));
181 		}
182 
183 		mii->phy_mac[i] = ports[i].role;
184 	}
185 	return 0;
186 }
187 
188 static int sja1105_init_static_fdb(struct sja1105_private *priv)
189 {
190 	struct sja1105_table *table;
191 
192 	table = &priv->static_config.tables[BLK_IDX_L2_LOOKUP];
193 
194 	/* We only populate the FDB table through dynamic
195 	 * L2 Address Lookup entries
196 	 */
197 	if (table->entry_count) {
198 		kfree(table->entries);
199 		table->entry_count = 0;
200 	}
201 	return 0;
202 }
203 
204 static int sja1105_init_l2_lookup_params(struct sja1105_private *priv)
205 {
206 	struct sja1105_table *table;
207 	u64 max_fdb_entries = SJA1105_MAX_L2_LOOKUP_COUNT / SJA1105_NUM_PORTS;
208 	struct sja1105_l2_lookup_params_entry default_l2_lookup_params = {
209 		/* Learned FDB entries are forgotten after 300 seconds */
210 		.maxage = SJA1105_AGEING_TIME_MS(300000),
211 		/* All entries within a FDB bin are available for learning */
212 		.dyn_tbsz = SJA1105ET_FDB_BIN_SIZE,
213 		/* And the P/Q/R/S equivalent setting: */
214 		.start_dynspc = 0,
215 		.maxaddrp = {max_fdb_entries, max_fdb_entries, max_fdb_entries,
216 			     max_fdb_entries, max_fdb_entries, },
217 		/* 2^8 + 2^5 + 2^3 + 2^2 + 2^1 + 1 in Koopman notation */
218 		.poly = 0x97,
219 		/* This selects between Independent VLAN Learning (IVL) and
220 		 * Shared VLAN Learning (SVL)
221 		 */
222 		.shared_learn = true,
223 		/* Don't discard management traffic based on ENFPORT -
224 		 * we don't perform SMAC port enforcement anyway, so
225 		 * what we are setting here doesn't matter.
226 		 */
227 		.no_enf_hostprt = false,
228 		/* Don't learn SMAC for mac_fltres1 and mac_fltres0.
229 		 * Maybe correlate with no_linklocal_learn from bridge driver?
230 		 */
231 		.no_mgmt_learn = true,
232 		/* P/Q/R/S only */
233 		.use_static = true,
234 		/* Dynamically learned FDB entries can overwrite other (older)
235 		 * dynamic FDB entries
236 		 */
237 		.owr_dyn = true,
238 		.drpnolearn = true,
239 	};
240 
241 	table = &priv->static_config.tables[BLK_IDX_L2_LOOKUP_PARAMS];
242 
243 	if (table->entry_count) {
244 		kfree(table->entries);
245 		table->entry_count = 0;
246 	}
247 
248 	table->entries = kcalloc(SJA1105_MAX_L2_LOOKUP_PARAMS_COUNT,
249 				 table->ops->unpacked_entry_size, GFP_KERNEL);
250 	if (!table->entries)
251 		return -ENOMEM;
252 
253 	table->entry_count = SJA1105_MAX_L2_LOOKUP_PARAMS_COUNT;
254 
255 	/* This table only has a single entry */
256 	((struct sja1105_l2_lookup_params_entry *)table->entries)[0] =
257 				default_l2_lookup_params;
258 
259 	return 0;
260 }
261 
262 static int sja1105_init_static_vlan(struct sja1105_private *priv)
263 {
264 	struct sja1105_table *table;
265 	struct sja1105_vlan_lookup_entry pvid = {
266 		.ving_mirr = 0,
267 		.vegr_mirr = 0,
268 		.vmemb_port = 0,
269 		.vlan_bc = 0,
270 		.tag_port = 0,
271 		.vlanid = 1,
272 	};
273 	int i;
274 
275 	table = &priv->static_config.tables[BLK_IDX_VLAN_LOOKUP];
276 
277 	/* The static VLAN table will only contain the initial pvid of 1.
278 	 * All other VLANs are to be configured through dynamic entries,
279 	 * and kept in the static configuration table as backing memory.
280 	 */
281 	if (table->entry_count) {
282 		kfree(table->entries);
283 		table->entry_count = 0;
284 	}
285 
286 	table->entries = kcalloc(1, table->ops->unpacked_entry_size,
287 				 GFP_KERNEL);
288 	if (!table->entries)
289 		return -ENOMEM;
290 
291 	table->entry_count = 1;
292 
293 	/* VLAN 1: all DT-defined ports are members; no restrictions on
294 	 * forwarding; always transmit priority-tagged frames as untagged.
295 	 */
296 	for (i = 0; i < SJA1105_NUM_PORTS; i++) {
297 		pvid.vmemb_port |= BIT(i);
298 		pvid.vlan_bc |= BIT(i);
299 		pvid.tag_port &= ~BIT(i);
300 	}
301 
302 	((struct sja1105_vlan_lookup_entry *)table->entries)[0] = pvid;
303 	return 0;
304 }
305 
306 static int sja1105_init_l2_forwarding(struct sja1105_private *priv)
307 {
308 	struct sja1105_l2_forwarding_entry *l2fwd;
309 	struct sja1105_table *table;
310 	int i, j;
311 
312 	table = &priv->static_config.tables[BLK_IDX_L2_FORWARDING];
313 
314 	if (table->entry_count) {
315 		kfree(table->entries);
316 		table->entry_count = 0;
317 	}
318 
319 	table->entries = kcalloc(SJA1105_MAX_L2_FORWARDING_COUNT,
320 				 table->ops->unpacked_entry_size, GFP_KERNEL);
321 	if (!table->entries)
322 		return -ENOMEM;
323 
324 	table->entry_count = SJA1105_MAX_L2_FORWARDING_COUNT;
325 
326 	l2fwd = table->entries;
327 
328 	/* First 5 entries define the forwarding rules */
329 	for (i = 0; i < SJA1105_NUM_PORTS; i++) {
330 		unsigned int upstream = dsa_upstream_port(priv->ds, i);
331 
332 		for (j = 0; j < SJA1105_NUM_TC; j++)
333 			l2fwd[i].vlan_pmap[j] = j;
334 
335 		if (i == upstream)
336 			continue;
337 
338 		sja1105_port_allow_traffic(l2fwd, i, upstream, true);
339 		sja1105_port_allow_traffic(l2fwd, upstream, i, true);
340 	}
341 	/* Next 8 entries define VLAN PCP mapping from ingress to egress.
342 	 * Create a one-to-one mapping.
343 	 */
344 	for (i = 0; i < SJA1105_NUM_TC; i++)
345 		for (j = 0; j < SJA1105_NUM_PORTS; j++)
346 			l2fwd[SJA1105_NUM_PORTS + i].vlan_pmap[j] = i;
347 
348 	return 0;
349 }
350 
351 static int sja1105_init_l2_forwarding_params(struct sja1105_private *priv)
352 {
353 	struct sja1105_l2_forwarding_params_entry default_l2fwd_params = {
354 		/* Disallow dynamic reconfiguration of vlan_pmap */
355 		.max_dynp = 0,
356 		/* Use a single memory partition for all ingress queues */
357 		.part_spc = { SJA1105_MAX_FRAME_MEMORY, 0, 0, 0, 0, 0, 0, 0 },
358 	};
359 	struct sja1105_table *table;
360 
361 	table = &priv->static_config.tables[BLK_IDX_L2_FORWARDING_PARAMS];
362 
363 	if (table->entry_count) {
364 		kfree(table->entries);
365 		table->entry_count = 0;
366 	}
367 
368 	table->entries = kcalloc(SJA1105_MAX_L2_FORWARDING_PARAMS_COUNT,
369 				 table->ops->unpacked_entry_size, GFP_KERNEL);
370 	if (!table->entries)
371 		return -ENOMEM;
372 
373 	table->entry_count = SJA1105_MAX_L2_FORWARDING_PARAMS_COUNT;
374 
375 	/* This table only has a single entry */
376 	((struct sja1105_l2_forwarding_params_entry *)table->entries)[0] =
377 				default_l2fwd_params;
378 
379 	return 0;
380 }
381 
382 static int sja1105_init_general_params(struct sja1105_private *priv)
383 {
384 	struct sja1105_general_params_entry default_general_params = {
385 		/* Allow dynamic changing of the mirror port */
386 		.mirr_ptacu = true,
387 		.switchid = priv->ds->index,
388 		/* Priority queue for link-local management frames
389 		 * (both ingress to and egress from CPU - PTP, STP etc)
390 		 */
391 		.hostprio = 7,
392 		.mac_fltres1 = SJA1105_LINKLOCAL_FILTER_A,
393 		.mac_flt1    = SJA1105_LINKLOCAL_FILTER_A_MASK,
394 		.incl_srcpt1 = false,
395 		.send_meta1  = false,
396 		.mac_fltres0 = SJA1105_LINKLOCAL_FILTER_B,
397 		.mac_flt0    = SJA1105_LINKLOCAL_FILTER_B_MASK,
398 		.incl_srcpt0 = false,
399 		.send_meta0  = false,
400 		/* The destination for traffic matching mac_fltres1 and
401 		 * mac_fltres0 on all ports except host_port. Such traffic
402 		 * receieved on host_port itself would be dropped, except
403 		 * by installing a temporary 'management route'
404 		 */
405 		.host_port = dsa_upstream_port(priv->ds, 0),
406 		/* Default to an invalid value */
407 		.mirr_port = SJA1105_NUM_PORTS,
408 		/* Link-local traffic received on casc_port will be forwarded
409 		 * to host_port without embedding the source port and device ID
410 		 * info in the destination MAC address (presumably because it
411 		 * is a cascaded port and a downstream SJA switch already did
412 		 * that). Default to an invalid port (to disable the feature)
413 		 * and overwrite this if we find any DSA (cascaded) ports.
414 		 */
415 		.casc_port = SJA1105_NUM_PORTS,
416 		/* No TTEthernet */
417 		.vllupformat = 0,
418 		.vlmarker = 0,
419 		.vlmask = 0,
420 		/* Only update correctionField for 1-step PTP (L2 transport) */
421 		.ignore2stf = 0,
422 		/* Forcefully disable VLAN filtering by telling
423 		 * the switch that VLAN has a different EtherType.
424 		 */
425 		.tpid = ETH_P_SJA1105,
426 		.tpid2 = ETH_P_SJA1105,
427 	};
428 	struct sja1105_table *table;
429 	int i, k = 0;
430 
431 	for (i = 0; i < SJA1105_NUM_PORTS; i++) {
432 		if (dsa_is_dsa_port(priv->ds, i))
433 			default_general_params.casc_port = i;
434 		else if (dsa_is_user_port(priv->ds, i))
435 			priv->ports[i].mgmt_slot = k++;
436 	}
437 
438 	table = &priv->static_config.tables[BLK_IDX_GENERAL_PARAMS];
439 
440 	if (table->entry_count) {
441 		kfree(table->entries);
442 		table->entry_count = 0;
443 	}
444 
445 	table->entries = kcalloc(SJA1105_MAX_GENERAL_PARAMS_COUNT,
446 				 table->ops->unpacked_entry_size, GFP_KERNEL);
447 	if (!table->entries)
448 		return -ENOMEM;
449 
450 	table->entry_count = SJA1105_MAX_GENERAL_PARAMS_COUNT;
451 
452 	/* This table only has a single entry */
453 	((struct sja1105_general_params_entry *)table->entries)[0] =
454 				default_general_params;
455 
456 	return 0;
457 }
458 
459 #define SJA1105_RATE_MBPS(speed) (((speed) * 64000) / 1000)
460 
461 static void sja1105_setup_policer(struct sja1105_l2_policing_entry *policing,
462 				  int index)
463 {
464 	policing[index].sharindx = index;
465 	policing[index].smax = 65535; /* Burst size in bytes */
466 	policing[index].rate = SJA1105_RATE_MBPS(1000);
467 	policing[index].maxlen = ETH_FRAME_LEN + VLAN_HLEN + ETH_FCS_LEN;
468 	policing[index].partition = 0;
469 }
470 
471 static int sja1105_init_l2_policing(struct sja1105_private *priv)
472 {
473 	struct sja1105_l2_policing_entry *policing;
474 	struct sja1105_table *table;
475 	int i, j, k;
476 
477 	table = &priv->static_config.tables[BLK_IDX_L2_POLICING];
478 
479 	/* Discard previous L2 Policing Table */
480 	if (table->entry_count) {
481 		kfree(table->entries);
482 		table->entry_count = 0;
483 	}
484 
485 	table->entries = kcalloc(SJA1105_MAX_L2_POLICING_COUNT,
486 				 table->ops->unpacked_entry_size, GFP_KERNEL);
487 	if (!table->entries)
488 		return -ENOMEM;
489 
490 	table->entry_count = SJA1105_MAX_L2_POLICING_COUNT;
491 
492 	policing = table->entries;
493 
494 	/* k sweeps through all unicast policers (0-39).
495 	 * bcast sweeps through policers 40-44.
496 	 */
497 	for (i = 0, k = 0; i < SJA1105_NUM_PORTS; i++) {
498 		int bcast = (SJA1105_NUM_PORTS * SJA1105_NUM_TC) + i;
499 
500 		for (j = 0; j < SJA1105_NUM_TC; j++, k++)
501 			sja1105_setup_policer(policing, k);
502 
503 		/* Set up this port's policer for broadcast traffic */
504 		sja1105_setup_policer(policing, bcast);
505 	}
506 	return 0;
507 }
508 
509 static int sja1105_static_config_load(struct sja1105_private *priv,
510 				      struct sja1105_dt_port *ports)
511 {
512 	int rc;
513 
514 	sja1105_static_config_free(&priv->static_config);
515 	rc = sja1105_static_config_init(&priv->static_config,
516 					priv->info->static_ops,
517 					priv->info->device_id);
518 	if (rc)
519 		return rc;
520 
521 	/* Build static configuration */
522 	rc = sja1105_init_mac_settings(priv);
523 	if (rc < 0)
524 		return rc;
525 	rc = sja1105_init_mii_settings(priv, ports);
526 	if (rc < 0)
527 		return rc;
528 	rc = sja1105_init_static_fdb(priv);
529 	if (rc < 0)
530 		return rc;
531 	rc = sja1105_init_static_vlan(priv);
532 	if (rc < 0)
533 		return rc;
534 	rc = sja1105_init_l2_lookup_params(priv);
535 	if (rc < 0)
536 		return rc;
537 	rc = sja1105_init_l2_forwarding(priv);
538 	if (rc < 0)
539 		return rc;
540 	rc = sja1105_init_l2_forwarding_params(priv);
541 	if (rc < 0)
542 		return rc;
543 	rc = sja1105_init_l2_policing(priv);
544 	if (rc < 0)
545 		return rc;
546 	rc = sja1105_init_general_params(priv);
547 	if (rc < 0)
548 		return rc;
549 
550 	/* Send initial configuration to hardware via SPI */
551 	return sja1105_static_config_upload(priv);
552 }
553 
554 static int sja1105_parse_rgmii_delays(struct sja1105_private *priv,
555 				      const struct sja1105_dt_port *ports)
556 {
557 	int i;
558 
559 	for (i = 0; i < SJA1105_NUM_PORTS; i++) {
560 		if (ports->role == XMII_MAC)
561 			continue;
562 
563 		if (ports->phy_mode == PHY_INTERFACE_MODE_RGMII_RXID ||
564 		    ports->phy_mode == PHY_INTERFACE_MODE_RGMII_ID)
565 			priv->rgmii_rx_delay[i] = true;
566 
567 		if (ports->phy_mode == PHY_INTERFACE_MODE_RGMII_TXID ||
568 		    ports->phy_mode == PHY_INTERFACE_MODE_RGMII_ID)
569 			priv->rgmii_tx_delay[i] = true;
570 
571 		if ((priv->rgmii_rx_delay[i] || priv->rgmii_tx_delay[i]) &&
572 		     !priv->info->setup_rgmii_delay)
573 			return -EINVAL;
574 	}
575 	return 0;
576 }
577 
578 static int sja1105_parse_ports_node(struct sja1105_private *priv,
579 				    struct sja1105_dt_port *ports,
580 				    struct device_node *ports_node)
581 {
582 	struct device *dev = &priv->spidev->dev;
583 	struct device_node *child;
584 
585 	for_each_child_of_node(ports_node, child) {
586 		struct device_node *phy_node;
587 		phy_interface_t phy_mode;
588 		u32 index;
589 		int err;
590 
591 		/* Get switch port number from DT */
592 		if (of_property_read_u32(child, "reg", &index) < 0) {
593 			dev_err(dev, "Port number not defined in device tree "
594 				"(property \"reg\")\n");
595 			of_node_put(child);
596 			return -ENODEV;
597 		}
598 
599 		/* Get PHY mode from DT */
600 		err = of_get_phy_mode(child, &phy_mode);
601 		if (err) {
602 			dev_err(dev, "Failed to read phy-mode or "
603 				"phy-interface-type property for port %d\n",
604 				index);
605 			of_node_put(child);
606 			return -ENODEV;
607 		}
608 		ports[index].phy_mode = phy_mode;
609 
610 		phy_node = of_parse_phandle(child, "phy-handle", 0);
611 		if (!phy_node) {
612 			if (!of_phy_is_fixed_link(child)) {
613 				dev_err(dev, "phy-handle or fixed-link "
614 					"properties missing!\n");
615 				of_node_put(child);
616 				return -ENODEV;
617 			}
618 			/* phy-handle is missing, but fixed-link isn't.
619 			 * So it's a fixed link. Default to PHY role.
620 			 */
621 			ports[index].role = XMII_PHY;
622 		} else {
623 			/* phy-handle present => put port in MAC role */
624 			ports[index].role = XMII_MAC;
625 			of_node_put(phy_node);
626 		}
627 
628 		/* The MAC/PHY role can be overridden with explicit bindings */
629 		if (of_property_read_bool(child, "sja1105,role-mac"))
630 			ports[index].role = XMII_MAC;
631 		else if (of_property_read_bool(child, "sja1105,role-phy"))
632 			ports[index].role = XMII_PHY;
633 	}
634 
635 	return 0;
636 }
637 
638 static int sja1105_parse_dt(struct sja1105_private *priv,
639 			    struct sja1105_dt_port *ports)
640 {
641 	struct device *dev = &priv->spidev->dev;
642 	struct device_node *switch_node = dev->of_node;
643 	struct device_node *ports_node;
644 	int rc;
645 
646 	ports_node = of_get_child_by_name(switch_node, "ports");
647 	if (!ports_node) {
648 		dev_err(dev, "Incorrect bindings: absent \"ports\" node\n");
649 		return -ENODEV;
650 	}
651 
652 	rc = sja1105_parse_ports_node(priv, ports, ports_node);
653 	of_node_put(ports_node);
654 
655 	return rc;
656 }
657 
658 /* Convert link speed from SJA1105 to ethtool encoding */
659 static int sja1105_speed[] = {
660 	[SJA1105_SPEED_AUTO]		= SPEED_UNKNOWN,
661 	[SJA1105_SPEED_10MBPS]		= SPEED_10,
662 	[SJA1105_SPEED_100MBPS]		= SPEED_100,
663 	[SJA1105_SPEED_1000MBPS]	= SPEED_1000,
664 };
665 
666 /* Set link speed in the MAC configuration for a specific port. */
667 static int sja1105_adjust_port_config(struct sja1105_private *priv, int port,
668 				      int speed_mbps)
669 {
670 	struct sja1105_xmii_params_entry *mii;
671 	struct sja1105_mac_config_entry *mac;
672 	struct device *dev = priv->ds->dev;
673 	sja1105_phy_interface_t phy_mode;
674 	sja1105_speed_t speed;
675 	int rc;
676 
677 	/* On P/Q/R/S, one can read from the device via the MAC reconfiguration
678 	 * tables. On E/T, MAC reconfig tables are not readable, only writable.
679 	 * We have to *know* what the MAC looks like.  For the sake of keeping
680 	 * the code common, we'll use the static configuration tables as a
681 	 * reasonable approximation for both E/T and P/Q/R/S.
682 	 */
683 	mac = priv->static_config.tables[BLK_IDX_MAC_CONFIG].entries;
684 	mii = priv->static_config.tables[BLK_IDX_XMII_PARAMS].entries;
685 
686 	switch (speed_mbps) {
687 	case SPEED_UNKNOWN:
688 		/* PHYLINK called sja1105_mac_config() to inform us about
689 		 * the state->interface, but AN has not completed and the
690 		 * speed is not yet valid. UM10944.pdf says that setting
691 		 * SJA1105_SPEED_AUTO at runtime disables the port, so that is
692 		 * ok for power consumption in case AN will never complete -
693 		 * otherwise PHYLINK should come back with a new update.
694 		 */
695 		speed = SJA1105_SPEED_AUTO;
696 		break;
697 	case SPEED_10:
698 		speed = SJA1105_SPEED_10MBPS;
699 		break;
700 	case SPEED_100:
701 		speed = SJA1105_SPEED_100MBPS;
702 		break;
703 	case SPEED_1000:
704 		speed = SJA1105_SPEED_1000MBPS;
705 		break;
706 	default:
707 		dev_err(dev, "Invalid speed %iMbps\n", speed_mbps);
708 		return -EINVAL;
709 	}
710 
711 	/* Overwrite SJA1105_SPEED_AUTO from the static MAC configuration
712 	 * table, since this will be used for the clocking setup, and we no
713 	 * longer need to store it in the static config (already told hardware
714 	 * we want auto during upload phase).
715 	 */
716 	mac[port].speed = speed;
717 
718 	/* Write to the dynamic reconfiguration tables */
719 	rc = sja1105_dynamic_config_write(priv, BLK_IDX_MAC_CONFIG, port,
720 					  &mac[port], true);
721 	if (rc < 0) {
722 		dev_err(dev, "Failed to write MAC config: %d\n", rc);
723 		return rc;
724 	}
725 
726 	/* Reconfigure the PLLs for the RGMII interfaces (required 125 MHz at
727 	 * gigabit, 25 MHz at 100 Mbps and 2.5 MHz at 10 Mbps). For MII and
728 	 * RMII no change of the clock setup is required. Actually, changing
729 	 * the clock setup does interrupt the clock signal for a certain time
730 	 * which causes trouble for all PHYs relying on this signal.
731 	 */
732 	phy_mode = mii->xmii_mode[port];
733 	if (phy_mode != XMII_MODE_RGMII)
734 		return 0;
735 
736 	return sja1105_clocking_setup_port(priv, port);
737 }
738 
739 /* The SJA1105 MAC programming model is through the static config (the xMII
740  * Mode table cannot be dynamically reconfigured), and we have to program
741  * that early (earlier than PHYLINK calls us, anyway).
742  * So just error out in case the connected PHY attempts to change the initial
743  * system interface MII protocol from what is defined in the DT, at least for
744  * now.
745  */
746 static bool sja1105_phy_mode_mismatch(struct sja1105_private *priv, int port,
747 				      phy_interface_t interface)
748 {
749 	struct sja1105_xmii_params_entry *mii;
750 	sja1105_phy_interface_t phy_mode;
751 
752 	mii = priv->static_config.tables[BLK_IDX_XMII_PARAMS].entries;
753 	phy_mode = mii->xmii_mode[port];
754 
755 	switch (interface) {
756 	case PHY_INTERFACE_MODE_MII:
757 		return (phy_mode != XMII_MODE_MII);
758 	case PHY_INTERFACE_MODE_RMII:
759 		return (phy_mode != XMII_MODE_RMII);
760 	case PHY_INTERFACE_MODE_RGMII:
761 	case PHY_INTERFACE_MODE_RGMII_ID:
762 	case PHY_INTERFACE_MODE_RGMII_RXID:
763 	case PHY_INTERFACE_MODE_RGMII_TXID:
764 		return (phy_mode != XMII_MODE_RGMII);
765 	default:
766 		return true;
767 	}
768 }
769 
770 static void sja1105_mac_config(struct dsa_switch *ds, int port,
771 			       unsigned int link_an_mode,
772 			       const struct phylink_link_state *state)
773 {
774 	struct sja1105_private *priv = ds->priv;
775 
776 	if (sja1105_phy_mode_mismatch(priv, port, state->interface))
777 		return;
778 
779 	if (link_an_mode == MLO_AN_INBAND) {
780 		dev_err(ds->dev, "In-band AN not supported!\n");
781 		return;
782 	}
783 
784 	sja1105_adjust_port_config(priv, port, state->speed);
785 }
786 
787 static void sja1105_mac_link_down(struct dsa_switch *ds, int port,
788 				  unsigned int mode,
789 				  phy_interface_t interface)
790 {
791 	sja1105_inhibit_tx(ds->priv, BIT(port), true);
792 }
793 
794 static void sja1105_mac_link_up(struct dsa_switch *ds, int port,
795 				unsigned int mode,
796 				phy_interface_t interface,
797 				struct phy_device *phydev)
798 {
799 	sja1105_inhibit_tx(ds->priv, BIT(port), false);
800 }
801 
802 static void sja1105_phylink_validate(struct dsa_switch *ds, int port,
803 				     unsigned long *supported,
804 				     struct phylink_link_state *state)
805 {
806 	/* Construct a new mask which exhaustively contains all link features
807 	 * supported by the MAC, and then apply that (logical AND) to what will
808 	 * be sent to the PHY for "marketing".
809 	 */
810 	__ETHTOOL_DECLARE_LINK_MODE_MASK(mask) = { 0, };
811 	struct sja1105_private *priv = ds->priv;
812 	struct sja1105_xmii_params_entry *mii;
813 
814 	mii = priv->static_config.tables[BLK_IDX_XMII_PARAMS].entries;
815 
816 	/* include/linux/phylink.h says:
817 	 *     When @state->interface is %PHY_INTERFACE_MODE_NA, phylink
818 	 *     expects the MAC driver to return all supported link modes.
819 	 */
820 	if (state->interface != PHY_INTERFACE_MODE_NA &&
821 	    sja1105_phy_mode_mismatch(priv, port, state->interface)) {
822 		bitmap_zero(supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
823 		return;
824 	}
825 
826 	/* The MAC does not support pause frames, and also doesn't
827 	 * support half-duplex traffic modes.
828 	 */
829 	phylink_set(mask, Autoneg);
830 	phylink_set(mask, MII);
831 	phylink_set(mask, 10baseT_Full);
832 	phylink_set(mask, 100baseT_Full);
833 	if (mii->xmii_mode[port] == XMII_MODE_RGMII)
834 		phylink_set(mask, 1000baseT_Full);
835 
836 	bitmap_and(supported, supported, mask, __ETHTOOL_LINK_MODE_MASK_NBITS);
837 	bitmap_and(state->advertising, state->advertising, mask,
838 		   __ETHTOOL_LINK_MODE_MASK_NBITS);
839 }
840 
841 static int
842 sja1105_find_static_fdb_entry(struct sja1105_private *priv, int port,
843 			      const struct sja1105_l2_lookup_entry *requested)
844 {
845 	struct sja1105_l2_lookup_entry *l2_lookup;
846 	struct sja1105_table *table;
847 	int i;
848 
849 	table = &priv->static_config.tables[BLK_IDX_L2_LOOKUP];
850 	l2_lookup = table->entries;
851 
852 	for (i = 0; i < table->entry_count; i++)
853 		if (l2_lookup[i].macaddr == requested->macaddr &&
854 		    l2_lookup[i].vlanid == requested->vlanid &&
855 		    l2_lookup[i].destports & BIT(port))
856 			return i;
857 
858 	return -1;
859 }
860 
861 /* We want FDB entries added statically through the bridge command to persist
862  * across switch resets, which are a common thing during normal SJA1105
863  * operation. So we have to back them up in the static configuration tables
864  * and hence apply them on next static config upload... yay!
865  */
866 static int
867 sja1105_static_fdb_change(struct sja1105_private *priv, int port,
868 			  const struct sja1105_l2_lookup_entry *requested,
869 			  bool keep)
870 {
871 	struct sja1105_l2_lookup_entry *l2_lookup;
872 	struct sja1105_table *table;
873 	int rc, match;
874 
875 	table = &priv->static_config.tables[BLK_IDX_L2_LOOKUP];
876 
877 	match = sja1105_find_static_fdb_entry(priv, port, requested);
878 	if (match < 0) {
879 		/* Can't delete a missing entry. */
880 		if (!keep)
881 			return 0;
882 
883 		/* No match => new entry */
884 		rc = sja1105_table_resize(table, table->entry_count + 1);
885 		if (rc)
886 			return rc;
887 
888 		match = table->entry_count - 1;
889 	}
890 
891 	/* Assign pointer after the resize (it may be new memory) */
892 	l2_lookup = table->entries;
893 
894 	/* We have a match.
895 	 * If the job was to add this FDB entry, it's already done (mostly
896 	 * anyway, since the port forwarding mask may have changed, case in
897 	 * which we update it).
898 	 * Otherwise we have to delete it.
899 	 */
900 	if (keep) {
901 		l2_lookup[match] = *requested;
902 		return 0;
903 	}
904 
905 	/* To remove, the strategy is to overwrite the element with
906 	 * the last one, and then reduce the array size by 1
907 	 */
908 	l2_lookup[match] = l2_lookup[table->entry_count - 1];
909 	return sja1105_table_resize(table, table->entry_count - 1);
910 }
911 
912 /* First-generation switches have a 4-way set associative TCAM that
913  * holds the FDB entries. An FDB index spans from 0 to 1023 and is comprised of
914  * a "bin" (grouping of 4 entries) and a "way" (an entry within a bin).
915  * For the placement of a newly learnt FDB entry, the switch selects the bin
916  * based on a hash function, and the way within that bin incrementally.
917  */
918 static int sja1105et_fdb_index(int bin, int way)
919 {
920 	return bin * SJA1105ET_FDB_BIN_SIZE + way;
921 }
922 
923 static int sja1105et_is_fdb_entry_in_bin(struct sja1105_private *priv, int bin,
924 					 const u8 *addr, u16 vid,
925 					 struct sja1105_l2_lookup_entry *match,
926 					 int *last_unused)
927 {
928 	int way;
929 
930 	for (way = 0; way < SJA1105ET_FDB_BIN_SIZE; way++) {
931 		struct sja1105_l2_lookup_entry l2_lookup = {0};
932 		int index = sja1105et_fdb_index(bin, way);
933 
934 		/* Skip unused entries, optionally marking them
935 		 * into the return value
936 		 */
937 		if (sja1105_dynamic_config_read(priv, BLK_IDX_L2_LOOKUP,
938 						index, &l2_lookup)) {
939 			if (last_unused)
940 				*last_unused = way;
941 			continue;
942 		}
943 
944 		if (l2_lookup.macaddr == ether_addr_to_u64(addr) &&
945 		    l2_lookup.vlanid == vid) {
946 			if (match)
947 				*match = l2_lookup;
948 			return way;
949 		}
950 	}
951 	/* Return an invalid entry index if not found */
952 	return -1;
953 }
954 
955 int sja1105et_fdb_add(struct dsa_switch *ds, int port,
956 		      const unsigned char *addr, u16 vid)
957 {
958 	struct sja1105_l2_lookup_entry l2_lookup = {0};
959 	struct sja1105_private *priv = ds->priv;
960 	struct device *dev = ds->dev;
961 	int last_unused = -1;
962 	int bin, way, rc;
963 
964 	bin = sja1105et_fdb_hash(priv, addr, vid);
965 
966 	way = sja1105et_is_fdb_entry_in_bin(priv, bin, addr, vid,
967 					    &l2_lookup, &last_unused);
968 	if (way >= 0) {
969 		/* We have an FDB entry. Is our port in the destination
970 		 * mask? If yes, we need to do nothing. If not, we need
971 		 * to rewrite the entry by adding this port to it.
972 		 */
973 		if (l2_lookup.destports & BIT(port))
974 			return 0;
975 		l2_lookup.destports |= BIT(port);
976 	} else {
977 		int index = sja1105et_fdb_index(bin, way);
978 
979 		/* We don't have an FDB entry. We construct a new one and
980 		 * try to find a place for it within the FDB table.
981 		 */
982 		l2_lookup.macaddr = ether_addr_to_u64(addr);
983 		l2_lookup.destports = BIT(port);
984 		l2_lookup.vlanid = vid;
985 
986 		if (last_unused >= 0) {
987 			way = last_unused;
988 		} else {
989 			/* Bin is full, need to evict somebody.
990 			 * Choose victim at random. If you get these messages
991 			 * often, you may need to consider changing the
992 			 * distribution function:
993 			 * static_config[BLK_IDX_L2_LOOKUP_PARAMS].entries->poly
994 			 */
995 			get_random_bytes(&way, sizeof(u8));
996 			way %= SJA1105ET_FDB_BIN_SIZE;
997 			dev_warn(dev, "Warning, FDB bin %d full while adding entry for %pM. Evicting entry %u.\n",
998 				 bin, addr, way);
999 			/* Evict entry */
1000 			sja1105_dynamic_config_write(priv, BLK_IDX_L2_LOOKUP,
1001 						     index, NULL, false);
1002 		}
1003 	}
1004 	l2_lookup.index = sja1105et_fdb_index(bin, way);
1005 
1006 	rc = sja1105_dynamic_config_write(priv, BLK_IDX_L2_LOOKUP,
1007 					  l2_lookup.index, &l2_lookup,
1008 					  true);
1009 	if (rc < 0)
1010 		return rc;
1011 
1012 	return sja1105_static_fdb_change(priv, port, &l2_lookup, true);
1013 }
1014 
1015 int sja1105et_fdb_del(struct dsa_switch *ds, int port,
1016 		      const unsigned char *addr, u16 vid)
1017 {
1018 	struct sja1105_l2_lookup_entry l2_lookup = {0};
1019 	struct sja1105_private *priv = ds->priv;
1020 	int index, bin, way, rc;
1021 	bool keep;
1022 
1023 	bin = sja1105et_fdb_hash(priv, addr, vid);
1024 	way = sja1105et_is_fdb_entry_in_bin(priv, bin, addr, vid,
1025 					    &l2_lookup, NULL);
1026 	if (way < 0)
1027 		return 0;
1028 	index = sja1105et_fdb_index(bin, way);
1029 
1030 	/* We have an FDB entry. Is our port in the destination mask? If yes,
1031 	 * we need to remove it. If the resulting port mask becomes empty, we
1032 	 * need to completely evict the FDB entry.
1033 	 * Otherwise we just write it back.
1034 	 */
1035 	l2_lookup.destports &= ~BIT(port);
1036 
1037 	if (l2_lookup.destports)
1038 		keep = true;
1039 	else
1040 		keep = false;
1041 
1042 	rc = sja1105_dynamic_config_write(priv, BLK_IDX_L2_LOOKUP,
1043 					  index, &l2_lookup, keep);
1044 	if (rc < 0)
1045 		return rc;
1046 
1047 	return sja1105_static_fdb_change(priv, port, &l2_lookup, keep);
1048 }
1049 
1050 int sja1105pqrs_fdb_add(struct dsa_switch *ds, int port,
1051 			const unsigned char *addr, u16 vid)
1052 {
1053 	struct sja1105_l2_lookup_entry l2_lookup = {0};
1054 	struct sja1105_private *priv = ds->priv;
1055 	int rc, i;
1056 
1057 	/* Search for an existing entry in the FDB table */
1058 	l2_lookup.macaddr = ether_addr_to_u64(addr);
1059 	l2_lookup.vlanid = vid;
1060 	l2_lookup.iotag = SJA1105_S_TAG;
1061 	l2_lookup.mask_macaddr = GENMASK_ULL(ETH_ALEN * 8 - 1, 0);
1062 	if (dsa_port_is_vlan_filtering(dsa_to_port(ds, port))) {
1063 		l2_lookup.mask_vlanid = VLAN_VID_MASK;
1064 		l2_lookup.mask_iotag = BIT(0);
1065 	} else {
1066 		l2_lookup.mask_vlanid = 0;
1067 		l2_lookup.mask_iotag = 0;
1068 	}
1069 	l2_lookup.destports = BIT(port);
1070 
1071 	rc = sja1105_dynamic_config_read(priv, BLK_IDX_L2_LOOKUP,
1072 					 SJA1105_SEARCH, &l2_lookup);
1073 	if (rc == 0) {
1074 		/* Found and this port is already in the entry's
1075 		 * port mask => job done
1076 		 */
1077 		if (l2_lookup.destports & BIT(port))
1078 			return 0;
1079 		/* l2_lookup.index is populated by the switch in case it
1080 		 * found something.
1081 		 */
1082 		l2_lookup.destports |= BIT(port);
1083 		goto skip_finding_an_index;
1084 	}
1085 
1086 	/* Not found, so try to find an unused spot in the FDB.
1087 	 * This is slightly inefficient because the strategy is knock-knock at
1088 	 * every possible position from 0 to 1023.
1089 	 */
1090 	for (i = 0; i < SJA1105_MAX_L2_LOOKUP_COUNT; i++) {
1091 		rc = sja1105_dynamic_config_read(priv, BLK_IDX_L2_LOOKUP,
1092 						 i, NULL);
1093 		if (rc < 0)
1094 			break;
1095 	}
1096 	if (i == SJA1105_MAX_L2_LOOKUP_COUNT) {
1097 		dev_err(ds->dev, "FDB is full, cannot add entry.\n");
1098 		return -EINVAL;
1099 	}
1100 	l2_lookup.lockeds = true;
1101 	l2_lookup.index = i;
1102 
1103 skip_finding_an_index:
1104 	rc = sja1105_dynamic_config_write(priv, BLK_IDX_L2_LOOKUP,
1105 					  l2_lookup.index, &l2_lookup,
1106 					  true);
1107 	if (rc < 0)
1108 		return rc;
1109 
1110 	return sja1105_static_fdb_change(priv, port, &l2_lookup, true);
1111 }
1112 
1113 int sja1105pqrs_fdb_del(struct dsa_switch *ds, int port,
1114 			const unsigned char *addr, u16 vid)
1115 {
1116 	struct sja1105_l2_lookup_entry l2_lookup = {0};
1117 	struct sja1105_private *priv = ds->priv;
1118 	bool keep;
1119 	int rc;
1120 
1121 	l2_lookup.macaddr = ether_addr_to_u64(addr);
1122 	l2_lookup.vlanid = vid;
1123 	l2_lookup.iotag = SJA1105_S_TAG;
1124 	l2_lookup.mask_macaddr = GENMASK_ULL(ETH_ALEN * 8 - 1, 0);
1125 	if (dsa_port_is_vlan_filtering(dsa_to_port(ds, port))) {
1126 		l2_lookup.mask_vlanid = VLAN_VID_MASK;
1127 		l2_lookup.mask_iotag = BIT(0);
1128 	} else {
1129 		l2_lookup.mask_vlanid = 0;
1130 		l2_lookup.mask_iotag = 0;
1131 	}
1132 	l2_lookup.destports = BIT(port);
1133 
1134 	rc = sja1105_dynamic_config_read(priv, BLK_IDX_L2_LOOKUP,
1135 					 SJA1105_SEARCH, &l2_lookup);
1136 	if (rc < 0)
1137 		return 0;
1138 
1139 	l2_lookup.destports &= ~BIT(port);
1140 
1141 	/* Decide whether we remove just this port from the FDB entry,
1142 	 * or if we remove it completely.
1143 	 */
1144 	if (l2_lookup.destports)
1145 		keep = true;
1146 	else
1147 		keep = false;
1148 
1149 	rc = sja1105_dynamic_config_write(priv, BLK_IDX_L2_LOOKUP,
1150 					  l2_lookup.index, &l2_lookup, keep);
1151 	if (rc < 0)
1152 		return rc;
1153 
1154 	return sja1105_static_fdb_change(priv, port, &l2_lookup, keep);
1155 }
1156 
1157 static int sja1105_fdb_add(struct dsa_switch *ds, int port,
1158 			   const unsigned char *addr, u16 vid)
1159 {
1160 	struct sja1105_private *priv = ds->priv;
1161 
1162 	/* dsa_8021q is in effect when the bridge's vlan_filtering isn't,
1163 	 * so the switch still does some VLAN processing internally.
1164 	 * But Shared VLAN Learning (SVL) is also active, and it will take
1165 	 * care of autonomous forwarding between the unique pvid's of each
1166 	 * port.  Here we just make sure that users can't add duplicate FDB
1167 	 * entries when in this mode - the actual VID doesn't matter except
1168 	 * for what gets printed in 'bridge fdb show'.  In the case of zero,
1169 	 * no VID gets printed at all.
1170 	 */
1171 	if (!dsa_port_is_vlan_filtering(dsa_to_port(ds, port)))
1172 		vid = 0;
1173 
1174 	return priv->info->fdb_add_cmd(ds, port, addr, vid);
1175 }
1176 
1177 static int sja1105_fdb_del(struct dsa_switch *ds, int port,
1178 			   const unsigned char *addr, u16 vid)
1179 {
1180 	struct sja1105_private *priv = ds->priv;
1181 
1182 	if (!dsa_port_is_vlan_filtering(dsa_to_port(ds, port)))
1183 		vid = 0;
1184 
1185 	return priv->info->fdb_del_cmd(ds, port, addr, vid);
1186 }
1187 
1188 static int sja1105_fdb_dump(struct dsa_switch *ds, int port,
1189 			    dsa_fdb_dump_cb_t *cb, void *data)
1190 {
1191 	struct sja1105_private *priv = ds->priv;
1192 	struct device *dev = ds->dev;
1193 	int i;
1194 
1195 	for (i = 0; i < SJA1105_MAX_L2_LOOKUP_COUNT; i++) {
1196 		struct sja1105_l2_lookup_entry l2_lookup = {0};
1197 		u8 macaddr[ETH_ALEN];
1198 		int rc;
1199 
1200 		rc = sja1105_dynamic_config_read(priv, BLK_IDX_L2_LOOKUP,
1201 						 i, &l2_lookup);
1202 		/* No fdb entry at i, not an issue */
1203 		if (rc == -ENOENT)
1204 			continue;
1205 		if (rc) {
1206 			dev_err(dev, "Failed to dump FDB: %d\n", rc);
1207 			return rc;
1208 		}
1209 
1210 		/* FDB dump callback is per port. This means we have to
1211 		 * disregard a valid entry if it's not for this port, even if
1212 		 * only to revisit it later. This is inefficient because the
1213 		 * 1024-sized FDB table needs to be traversed 4 times through
1214 		 * SPI during a 'bridge fdb show' command.
1215 		 */
1216 		if (!(l2_lookup.destports & BIT(port)))
1217 			continue;
1218 		u64_to_ether_addr(l2_lookup.macaddr, macaddr);
1219 
1220 		/* We need to hide the dsa_8021q VLANs from the user. */
1221 		if (!dsa_port_is_vlan_filtering(dsa_to_port(ds, port)))
1222 			l2_lookup.vlanid = 0;
1223 		cb(macaddr, l2_lookup.vlanid, l2_lookup.lockeds, data);
1224 	}
1225 	return 0;
1226 }
1227 
1228 /* This callback needs to be present */
1229 static int sja1105_mdb_prepare(struct dsa_switch *ds, int port,
1230 			       const struct switchdev_obj_port_mdb *mdb)
1231 {
1232 	return 0;
1233 }
1234 
1235 static void sja1105_mdb_add(struct dsa_switch *ds, int port,
1236 			    const struct switchdev_obj_port_mdb *mdb)
1237 {
1238 	sja1105_fdb_add(ds, port, mdb->addr, mdb->vid);
1239 }
1240 
1241 static int sja1105_mdb_del(struct dsa_switch *ds, int port,
1242 			   const struct switchdev_obj_port_mdb *mdb)
1243 {
1244 	return sja1105_fdb_del(ds, port, mdb->addr, mdb->vid);
1245 }
1246 
1247 static int sja1105_bridge_member(struct dsa_switch *ds, int port,
1248 				 struct net_device *br, bool member)
1249 {
1250 	struct sja1105_l2_forwarding_entry *l2_fwd;
1251 	struct sja1105_private *priv = ds->priv;
1252 	int i, rc;
1253 
1254 	l2_fwd = priv->static_config.tables[BLK_IDX_L2_FORWARDING].entries;
1255 
1256 	for (i = 0; i < SJA1105_NUM_PORTS; i++) {
1257 		/* Add this port to the forwarding matrix of the
1258 		 * other ports in the same bridge, and viceversa.
1259 		 */
1260 		if (!dsa_is_user_port(ds, i))
1261 			continue;
1262 		/* For the ports already under the bridge, only one thing needs
1263 		 * to be done, and that is to add this port to their
1264 		 * reachability domain. So we can perform the SPI write for
1265 		 * them immediately. However, for this port itself (the one
1266 		 * that is new to the bridge), we need to add all other ports
1267 		 * to its reachability domain. So we do that incrementally in
1268 		 * this loop, and perform the SPI write only at the end, once
1269 		 * the domain contains all other bridge ports.
1270 		 */
1271 		if (i == port)
1272 			continue;
1273 		if (dsa_to_port(ds, i)->bridge_dev != br)
1274 			continue;
1275 		sja1105_port_allow_traffic(l2_fwd, i, port, member);
1276 		sja1105_port_allow_traffic(l2_fwd, port, i, member);
1277 
1278 		rc = sja1105_dynamic_config_write(priv, BLK_IDX_L2_FORWARDING,
1279 						  i, &l2_fwd[i], true);
1280 		if (rc < 0)
1281 			return rc;
1282 	}
1283 
1284 	return sja1105_dynamic_config_write(priv, BLK_IDX_L2_FORWARDING,
1285 					    port, &l2_fwd[port], true);
1286 }
1287 
1288 static void sja1105_bridge_stp_state_set(struct dsa_switch *ds, int port,
1289 					 u8 state)
1290 {
1291 	struct sja1105_private *priv = ds->priv;
1292 	struct sja1105_mac_config_entry *mac;
1293 
1294 	mac = priv->static_config.tables[BLK_IDX_MAC_CONFIG].entries;
1295 
1296 	switch (state) {
1297 	case BR_STATE_DISABLED:
1298 	case BR_STATE_BLOCKING:
1299 		/* From UM10944 description of DRPDTAG (why put this there?):
1300 		 * "Management traffic flows to the port regardless of the state
1301 		 * of the INGRESS flag". So BPDUs are still be allowed to pass.
1302 		 * At the moment no difference between DISABLED and BLOCKING.
1303 		 */
1304 		mac[port].ingress   = false;
1305 		mac[port].egress    = false;
1306 		mac[port].dyn_learn = false;
1307 		break;
1308 	case BR_STATE_LISTENING:
1309 		mac[port].ingress   = true;
1310 		mac[port].egress    = false;
1311 		mac[port].dyn_learn = false;
1312 		break;
1313 	case BR_STATE_LEARNING:
1314 		mac[port].ingress   = true;
1315 		mac[port].egress    = false;
1316 		mac[port].dyn_learn = true;
1317 		break;
1318 	case BR_STATE_FORWARDING:
1319 		mac[port].ingress   = true;
1320 		mac[port].egress    = true;
1321 		mac[port].dyn_learn = true;
1322 		break;
1323 	default:
1324 		dev_err(ds->dev, "invalid STP state: %d\n", state);
1325 		return;
1326 	}
1327 
1328 	sja1105_dynamic_config_write(priv, BLK_IDX_MAC_CONFIG, port,
1329 				     &mac[port], true);
1330 }
1331 
1332 static int sja1105_bridge_join(struct dsa_switch *ds, int port,
1333 			       struct net_device *br)
1334 {
1335 	return sja1105_bridge_member(ds, port, br, true);
1336 }
1337 
1338 static void sja1105_bridge_leave(struct dsa_switch *ds, int port,
1339 				 struct net_device *br)
1340 {
1341 	sja1105_bridge_member(ds, port, br, false);
1342 }
1343 
1344 /* For situations where we need to change a setting at runtime that is only
1345  * available through the static configuration, resetting the switch in order
1346  * to upload the new static config is unavoidable. Back up the settings we
1347  * modify at runtime (currently only MAC) and restore them after uploading,
1348  * such that this operation is relatively seamless.
1349  */
1350 int sja1105_static_config_reload(struct sja1105_private *priv)
1351 {
1352 	struct sja1105_mac_config_entry *mac;
1353 	int speed_mbps[SJA1105_NUM_PORTS];
1354 	int rc, i;
1355 
1356 	mac = priv->static_config.tables[BLK_IDX_MAC_CONFIG].entries;
1357 
1358 	/* Back up the dynamic link speed changed by sja1105_adjust_port_config
1359 	 * in order to temporarily restore it to SJA1105_SPEED_AUTO - which the
1360 	 * switch wants to see in the static config in order to allow us to
1361 	 * change it through the dynamic interface later.
1362 	 */
1363 	for (i = 0; i < SJA1105_NUM_PORTS; i++) {
1364 		speed_mbps[i] = sja1105_speed[mac[i].speed];
1365 		mac[i].speed = SJA1105_SPEED_AUTO;
1366 	}
1367 
1368 	/* Reset switch and send updated static configuration */
1369 	rc = sja1105_static_config_upload(priv);
1370 	if (rc < 0)
1371 		goto out;
1372 
1373 	/* Configure the CGU (PLLs) for MII and RMII PHYs.
1374 	 * For these interfaces there is no dynamic configuration
1375 	 * needed, since PLLs have same settings at all speeds.
1376 	 */
1377 	rc = sja1105_clocking_setup(priv);
1378 	if (rc < 0)
1379 		goto out;
1380 
1381 	for (i = 0; i < SJA1105_NUM_PORTS; i++) {
1382 		rc = sja1105_adjust_port_config(priv, i, speed_mbps[i]);
1383 		if (rc < 0)
1384 			goto out;
1385 	}
1386 out:
1387 	return rc;
1388 }
1389 
1390 static int sja1105_pvid_apply(struct sja1105_private *priv, int port, u16 pvid)
1391 {
1392 	struct sja1105_mac_config_entry *mac;
1393 
1394 	mac = priv->static_config.tables[BLK_IDX_MAC_CONFIG].entries;
1395 
1396 	mac[port].vlanid = pvid;
1397 
1398 	return sja1105_dynamic_config_write(priv, BLK_IDX_MAC_CONFIG, port,
1399 					   &mac[port], true);
1400 }
1401 
1402 static int sja1105_is_vlan_configured(struct sja1105_private *priv, u16 vid)
1403 {
1404 	struct sja1105_vlan_lookup_entry *vlan;
1405 	int count, i;
1406 
1407 	vlan = priv->static_config.tables[BLK_IDX_VLAN_LOOKUP].entries;
1408 	count = priv->static_config.tables[BLK_IDX_VLAN_LOOKUP].entry_count;
1409 
1410 	for (i = 0; i < count; i++)
1411 		if (vlan[i].vlanid == vid)
1412 			return i;
1413 
1414 	/* Return an invalid entry index if not found */
1415 	return -1;
1416 }
1417 
1418 static int sja1105_vlan_apply(struct sja1105_private *priv, int port, u16 vid,
1419 			      bool enabled, bool untagged)
1420 {
1421 	struct sja1105_vlan_lookup_entry *vlan;
1422 	struct sja1105_table *table;
1423 	bool keep = true;
1424 	int match, rc;
1425 
1426 	table = &priv->static_config.tables[BLK_IDX_VLAN_LOOKUP];
1427 
1428 	match = sja1105_is_vlan_configured(priv, vid);
1429 	if (match < 0) {
1430 		/* Can't delete a missing entry. */
1431 		if (!enabled)
1432 			return 0;
1433 		rc = sja1105_table_resize(table, table->entry_count + 1);
1434 		if (rc)
1435 			return rc;
1436 		match = table->entry_count - 1;
1437 	}
1438 	/* Assign pointer after the resize (it's new memory) */
1439 	vlan = table->entries;
1440 	vlan[match].vlanid = vid;
1441 	if (enabled) {
1442 		vlan[match].vlan_bc |= BIT(port);
1443 		vlan[match].vmemb_port |= BIT(port);
1444 	} else {
1445 		vlan[match].vlan_bc &= ~BIT(port);
1446 		vlan[match].vmemb_port &= ~BIT(port);
1447 	}
1448 	/* Also unset tag_port if removing this VLAN was requested,
1449 	 * just so we don't have a confusing bitmap (no practical purpose).
1450 	 */
1451 	if (untagged || !enabled)
1452 		vlan[match].tag_port &= ~BIT(port);
1453 	else
1454 		vlan[match].tag_port |= BIT(port);
1455 	/* If there's no port left as member of this VLAN,
1456 	 * it's time for it to go.
1457 	 */
1458 	if (!vlan[match].vmemb_port)
1459 		keep = false;
1460 
1461 	dev_dbg(priv->ds->dev,
1462 		"%s: port %d, vid %llu, broadcast domain 0x%llx, "
1463 		"port members 0x%llx, tagged ports 0x%llx, keep %d\n",
1464 		__func__, port, vlan[match].vlanid, vlan[match].vlan_bc,
1465 		vlan[match].vmemb_port, vlan[match].tag_port, keep);
1466 
1467 	rc = sja1105_dynamic_config_write(priv, BLK_IDX_VLAN_LOOKUP, vid,
1468 					  &vlan[match], keep);
1469 	if (rc < 0)
1470 		return rc;
1471 
1472 	if (!keep)
1473 		return sja1105_table_delete_entry(table, match);
1474 
1475 	return 0;
1476 }
1477 
1478 static int sja1105_setup_8021q_tagging(struct dsa_switch *ds, bool enabled)
1479 {
1480 	int rc, i;
1481 
1482 	for (i = 0; i < SJA1105_NUM_PORTS; i++) {
1483 		rc = dsa_port_setup_8021q_tagging(ds, i, enabled);
1484 		if (rc < 0) {
1485 			dev_err(ds->dev, "Failed to setup VLAN tagging for port %d: %d\n",
1486 				i, rc);
1487 			return rc;
1488 		}
1489 	}
1490 	dev_info(ds->dev, "%s switch tagging\n",
1491 		 enabled ? "Enabled" : "Disabled");
1492 	return 0;
1493 }
1494 
1495 static enum dsa_tag_protocol
1496 sja1105_get_tag_protocol(struct dsa_switch *ds, int port)
1497 {
1498 	return DSA_TAG_PROTO_SJA1105;
1499 }
1500 
1501 /* This callback needs to be present */
1502 static int sja1105_vlan_prepare(struct dsa_switch *ds, int port,
1503 				const struct switchdev_obj_port_vlan *vlan)
1504 {
1505 	return 0;
1506 }
1507 
1508 /* The TPID setting belongs to the General Parameters table,
1509  * which can only be partially reconfigured at runtime (and not the TPID).
1510  * So a switch reset is required.
1511  */
1512 static int sja1105_vlan_filtering(struct dsa_switch *ds, int port, bool enabled)
1513 {
1514 	struct sja1105_l2_lookup_params_entry *l2_lookup_params;
1515 	struct sja1105_general_params_entry *general_params;
1516 	struct sja1105_private *priv = ds->priv;
1517 	struct sja1105_table *table;
1518 	u16 tpid, tpid2;
1519 	int rc;
1520 
1521 	if (enabled) {
1522 		/* Enable VLAN filtering. */
1523 		tpid  = ETH_P_8021AD;
1524 		tpid2 = ETH_P_8021Q;
1525 	} else {
1526 		/* Disable VLAN filtering. */
1527 		tpid  = ETH_P_SJA1105;
1528 		tpid2 = ETH_P_SJA1105;
1529 	}
1530 
1531 	table = &priv->static_config.tables[BLK_IDX_GENERAL_PARAMS];
1532 	general_params = table->entries;
1533 	/* EtherType used to identify outer tagged (S-tag) VLAN traffic */
1534 	general_params->tpid = tpid;
1535 	/* EtherType used to identify inner tagged (C-tag) VLAN traffic */
1536 	general_params->tpid2 = tpid2;
1537 	/* When VLAN filtering is on, we need to at least be able to
1538 	 * decode management traffic through the "backup plan".
1539 	 */
1540 	general_params->incl_srcpt1 = enabled;
1541 	general_params->incl_srcpt0 = enabled;
1542 
1543 	/* VLAN filtering => independent VLAN learning.
1544 	 * No VLAN filtering => shared VLAN learning.
1545 	 *
1546 	 * In shared VLAN learning mode, untagged traffic still gets
1547 	 * pvid-tagged, and the FDB table gets populated with entries
1548 	 * containing the "real" (pvid or from VLAN tag) VLAN ID.
1549 	 * However the switch performs a masked L2 lookup in the FDB,
1550 	 * effectively only looking up a frame's DMAC (and not VID) for the
1551 	 * forwarding decision.
1552 	 *
1553 	 * This is extremely convenient for us, because in modes with
1554 	 * vlan_filtering=0, dsa_8021q actually installs unique pvid's into
1555 	 * each front panel port. This is good for identification but breaks
1556 	 * learning badly - the VID of the learnt FDB entry is unique, aka
1557 	 * no frames coming from any other port are going to have it. So
1558 	 * for forwarding purposes, this is as though learning was broken
1559 	 * (all frames get flooded).
1560 	 */
1561 	table = &priv->static_config.tables[BLK_IDX_L2_LOOKUP_PARAMS];
1562 	l2_lookup_params = table->entries;
1563 	l2_lookup_params->shared_learn = !enabled;
1564 
1565 	rc = sja1105_static_config_reload(priv);
1566 	if (rc)
1567 		dev_err(ds->dev, "Failed to change VLAN Ethertype\n");
1568 
1569 	/* Switch port identification based on 802.1Q is only passable
1570 	 * if we are not under a vlan_filtering bridge. So make sure
1571 	 * the two configurations are mutually exclusive.
1572 	 */
1573 	return sja1105_setup_8021q_tagging(ds, !enabled);
1574 }
1575 
1576 static void sja1105_vlan_add(struct dsa_switch *ds, int port,
1577 			     const struct switchdev_obj_port_vlan *vlan)
1578 {
1579 	struct sja1105_private *priv = ds->priv;
1580 	u16 vid;
1581 	int rc;
1582 
1583 	for (vid = vlan->vid_begin; vid <= vlan->vid_end; vid++) {
1584 		rc = sja1105_vlan_apply(priv, port, vid, true, vlan->flags &
1585 					BRIDGE_VLAN_INFO_UNTAGGED);
1586 		if (rc < 0) {
1587 			dev_err(ds->dev, "Failed to add VLAN %d to port %d: %d\n",
1588 				vid, port, rc);
1589 			return;
1590 		}
1591 		if (vlan->flags & BRIDGE_VLAN_INFO_PVID) {
1592 			rc = sja1105_pvid_apply(ds->priv, port, vid);
1593 			if (rc < 0) {
1594 				dev_err(ds->dev, "Failed to set pvid %d on port %d: %d\n",
1595 					vid, port, rc);
1596 				return;
1597 			}
1598 		}
1599 	}
1600 }
1601 
1602 static int sja1105_vlan_del(struct dsa_switch *ds, int port,
1603 			    const struct switchdev_obj_port_vlan *vlan)
1604 {
1605 	struct sja1105_private *priv = ds->priv;
1606 	u16 vid;
1607 	int rc;
1608 
1609 	for (vid = vlan->vid_begin; vid <= vlan->vid_end; vid++) {
1610 		rc = sja1105_vlan_apply(priv, port, vid, false, vlan->flags &
1611 					BRIDGE_VLAN_INFO_UNTAGGED);
1612 		if (rc < 0) {
1613 			dev_err(ds->dev, "Failed to remove VLAN %d from port %d: %d\n",
1614 				vid, port, rc);
1615 			return rc;
1616 		}
1617 	}
1618 	return 0;
1619 }
1620 
1621 /* The programming model for the SJA1105 switch is "all-at-once" via static
1622  * configuration tables. Some of these can be dynamically modified at runtime,
1623  * but not the xMII mode parameters table.
1624  * Furthermode, some PHYs may not have crystals for generating their clocks
1625  * (e.g. RMII). Instead, their 50MHz clock is supplied via the SJA1105 port's
1626  * ref_clk pin. So port clocking needs to be initialized early, before
1627  * connecting to PHYs is attempted, otherwise they won't respond through MDIO.
1628  * Setting correct PHY link speed does not matter now.
1629  * But dsa_slave_phy_setup is called later than sja1105_setup, so the PHY
1630  * bindings are not yet parsed by DSA core. We need to parse early so that we
1631  * can populate the xMII mode parameters table.
1632  */
1633 static int sja1105_setup(struct dsa_switch *ds)
1634 {
1635 	struct sja1105_dt_port ports[SJA1105_NUM_PORTS];
1636 	struct sja1105_private *priv = ds->priv;
1637 	int rc;
1638 
1639 	rc = sja1105_parse_dt(priv, ports);
1640 	if (rc < 0) {
1641 		dev_err(ds->dev, "Failed to parse DT: %d\n", rc);
1642 		return rc;
1643 	}
1644 
1645 	/* Error out early if internal delays are required through DT
1646 	 * and we can't apply them.
1647 	 */
1648 	rc = sja1105_parse_rgmii_delays(priv, ports);
1649 	if (rc < 0) {
1650 		dev_err(ds->dev, "RGMII delay not supported\n");
1651 		return rc;
1652 	}
1653 
1654 	rc = sja1105_ptp_clock_register(ds);
1655 	if (rc < 0) {
1656 		dev_err(ds->dev, "Failed to register PTP clock: %d\n", rc);
1657 		return rc;
1658 	}
1659 	/* Create and send configuration down to device */
1660 	rc = sja1105_static_config_load(priv, ports);
1661 	if (rc < 0) {
1662 		dev_err(ds->dev, "Failed to load static config: %d\n", rc);
1663 		return rc;
1664 	}
1665 	/* Configure the CGU (PHY link modes and speeds) */
1666 	rc = sja1105_clocking_setup(priv);
1667 	if (rc < 0) {
1668 		dev_err(ds->dev, "Failed to configure MII clocking: %d\n", rc);
1669 		return rc;
1670 	}
1671 	/* On SJA1105, VLAN filtering per se is always enabled in hardware.
1672 	 * The only thing we can do to disable it is lie about what the 802.1Q
1673 	 * EtherType is.
1674 	 * So it will still try to apply VLAN filtering, but all ingress
1675 	 * traffic (except frames received with EtherType of ETH_P_SJA1105)
1676 	 * will be internally tagged with a distorted VLAN header where the
1677 	 * TPID is ETH_P_SJA1105, and the VLAN ID is the port pvid.
1678 	 */
1679 	ds->vlan_filtering_is_global = true;
1680 
1681 	/* Advertise the 8 egress queues */
1682 	ds->num_tx_queues = SJA1105_NUM_TC;
1683 
1684 	/* The DSA/switchdev model brings up switch ports in standalone mode by
1685 	 * default, and that means vlan_filtering is 0 since they're not under
1686 	 * a bridge, so it's safe to set up switch tagging at this time.
1687 	 */
1688 	return sja1105_setup_8021q_tagging(ds, true);
1689 }
1690 
1691 static void sja1105_teardown(struct dsa_switch *ds)
1692 {
1693 	struct sja1105_private *priv = ds->priv;
1694 
1695 	sja1105_tas_teardown(ds);
1696 	sja1105_ptp_clock_unregister(ds);
1697 	sja1105_static_config_free(&priv->static_config);
1698 }
1699 
1700 static int sja1105_port_enable(struct dsa_switch *ds, int port,
1701 			       struct phy_device *phy)
1702 {
1703 	struct net_device *slave;
1704 
1705 	if (!dsa_is_user_port(ds, port))
1706 		return 0;
1707 
1708 	slave = dsa_to_port(ds, port)->slave;
1709 
1710 	slave->features &= ~NETIF_F_HW_VLAN_CTAG_FILTER;
1711 
1712 	return 0;
1713 }
1714 
1715 static int sja1105_mgmt_xmit(struct dsa_switch *ds, int port, int slot,
1716 			     struct sk_buff *skb, bool takets)
1717 {
1718 	struct sja1105_mgmt_entry mgmt_route = {0};
1719 	struct sja1105_private *priv = ds->priv;
1720 	struct ethhdr *hdr;
1721 	int timeout = 10;
1722 	int rc;
1723 
1724 	hdr = eth_hdr(skb);
1725 
1726 	mgmt_route.macaddr = ether_addr_to_u64(hdr->h_dest);
1727 	mgmt_route.destports = BIT(port);
1728 	mgmt_route.enfport = 1;
1729 	mgmt_route.tsreg = 0;
1730 	mgmt_route.takets = takets;
1731 
1732 	rc = sja1105_dynamic_config_write(priv, BLK_IDX_MGMT_ROUTE,
1733 					  slot, &mgmt_route, true);
1734 	if (rc < 0) {
1735 		kfree_skb(skb);
1736 		return rc;
1737 	}
1738 
1739 	/* Transfer skb to the host port. */
1740 	dsa_enqueue_skb(skb, dsa_to_port(ds, port)->slave);
1741 
1742 	/* Wait until the switch has processed the frame */
1743 	do {
1744 		rc = sja1105_dynamic_config_read(priv, BLK_IDX_MGMT_ROUTE,
1745 						 slot, &mgmt_route);
1746 		if (rc < 0) {
1747 			dev_err_ratelimited(priv->ds->dev,
1748 					    "failed to poll for mgmt route\n");
1749 			continue;
1750 		}
1751 
1752 		/* UM10944: The ENFPORT flag of the respective entry is
1753 		 * cleared when a match is found. The host can use this
1754 		 * flag as an acknowledgment.
1755 		 */
1756 		cpu_relax();
1757 	} while (mgmt_route.enfport && --timeout);
1758 
1759 	if (!timeout) {
1760 		/* Clean up the management route so that a follow-up
1761 		 * frame may not match on it by mistake.
1762 		 * This is only hardware supported on P/Q/R/S - on E/T it is
1763 		 * a no-op and we are silently discarding the -EOPNOTSUPP.
1764 		 */
1765 		sja1105_dynamic_config_write(priv, BLK_IDX_MGMT_ROUTE,
1766 					     slot, &mgmt_route, false);
1767 		dev_err_ratelimited(priv->ds->dev, "xmit timed out\n");
1768 	}
1769 
1770 	return NETDEV_TX_OK;
1771 }
1772 
1773 /* Deferred work is unfortunately necessary because setting up the management
1774  * route cannot be done from atomit context (SPI transfer takes a sleepable
1775  * lock on the bus)
1776  */
1777 static netdev_tx_t sja1105_port_deferred_xmit(struct dsa_switch *ds, int port,
1778 					      struct sk_buff *skb)
1779 {
1780 	struct sja1105_private *priv = ds->priv;
1781 	struct sja1105_port *sp = &priv->ports[port];
1782 	int slot = sp->mgmt_slot;
1783 	struct sk_buff *clone;
1784 
1785 	/* The tragic fact about the switch having 4x2 slots for installing
1786 	 * management routes is that all of them except one are actually
1787 	 * useless.
1788 	 * If 2 slots are simultaneously configured for two BPDUs sent to the
1789 	 * same (multicast) DMAC but on different egress ports, the switch
1790 	 * would confuse them and redirect first frame it receives on the CPU
1791 	 * port towards the port configured on the numerically first slot
1792 	 * (therefore wrong port), then second received frame on second slot
1793 	 * (also wrong port).
1794 	 * So for all practical purposes, there needs to be a lock that
1795 	 * prevents that from happening. The slot used here is utterly useless
1796 	 * (could have simply been 0 just as fine), but we are doing it
1797 	 * nonetheless, in case a smarter idea ever comes up in the future.
1798 	 */
1799 	mutex_lock(&priv->mgmt_lock);
1800 
1801 	/* The clone, if there, was made by dsa_skb_tx_timestamp */
1802 	clone = DSA_SKB_CB(skb)->clone;
1803 
1804 	sja1105_mgmt_xmit(ds, port, slot, skb, !!clone);
1805 
1806 	if (!clone)
1807 		goto out;
1808 
1809 	sja1105_ptp_txtstamp_skb(ds, slot, clone);
1810 
1811 out:
1812 	mutex_unlock(&priv->mgmt_lock);
1813 	return NETDEV_TX_OK;
1814 }
1815 
1816 /* The MAXAGE setting belongs to the L2 Forwarding Parameters table,
1817  * which cannot be reconfigured at runtime. So a switch reset is required.
1818  */
1819 static int sja1105_set_ageing_time(struct dsa_switch *ds,
1820 				   unsigned int ageing_time)
1821 {
1822 	struct sja1105_l2_lookup_params_entry *l2_lookup_params;
1823 	struct sja1105_private *priv = ds->priv;
1824 	struct sja1105_table *table;
1825 	unsigned int maxage;
1826 
1827 	table = &priv->static_config.tables[BLK_IDX_L2_LOOKUP_PARAMS];
1828 	l2_lookup_params = table->entries;
1829 
1830 	maxage = SJA1105_AGEING_TIME_MS(ageing_time);
1831 
1832 	if (l2_lookup_params->maxage == maxage)
1833 		return 0;
1834 
1835 	l2_lookup_params->maxage = maxage;
1836 
1837 	return sja1105_static_config_reload(priv);
1838 }
1839 
1840 static int sja1105_port_setup_tc(struct dsa_switch *ds, int port,
1841 				 enum tc_setup_type type,
1842 				 void *type_data)
1843 {
1844 	switch (type) {
1845 	case TC_SETUP_QDISC_TAPRIO:
1846 		return sja1105_setup_tc_taprio(ds, port, type_data);
1847 	default:
1848 		return -EOPNOTSUPP;
1849 	}
1850 }
1851 
1852 /* We have a single mirror (@to) port, but can configure ingress and egress
1853  * mirroring on all other (@from) ports.
1854  * We need to allow mirroring rules only as long as the @to port is always the
1855  * same, and we need to unset the @to port from mirr_port only when there is no
1856  * mirroring rule that references it.
1857  */
1858 static int sja1105_mirror_apply(struct sja1105_private *priv, int from, int to,
1859 				bool ingress, bool enabled)
1860 {
1861 	struct sja1105_general_params_entry *general_params;
1862 	struct sja1105_mac_config_entry *mac;
1863 	struct sja1105_table *table;
1864 	bool already_enabled;
1865 	u64 new_mirr_port;
1866 	int rc;
1867 
1868 	table = &priv->static_config.tables[BLK_IDX_GENERAL_PARAMS];
1869 	general_params = table->entries;
1870 
1871 	mac = priv->static_config.tables[BLK_IDX_MAC_CONFIG].entries;
1872 
1873 	already_enabled = (general_params->mirr_port != SJA1105_NUM_PORTS);
1874 	if (already_enabled && enabled && general_params->mirr_port != to) {
1875 		dev_err(priv->ds->dev,
1876 			"Delete mirroring rules towards port %llu first\n",
1877 			general_params->mirr_port);
1878 		return -EBUSY;
1879 	}
1880 
1881 	new_mirr_port = to;
1882 	if (!enabled) {
1883 		bool keep = false;
1884 		int port;
1885 
1886 		/* Anybody still referencing mirr_port? */
1887 		for (port = 0; port < SJA1105_NUM_PORTS; port++) {
1888 			if (mac[port].ing_mirr || mac[port].egr_mirr) {
1889 				keep = true;
1890 				break;
1891 			}
1892 		}
1893 		/* Unset already_enabled for next time */
1894 		if (!keep)
1895 			new_mirr_port = SJA1105_NUM_PORTS;
1896 	}
1897 	if (new_mirr_port != general_params->mirr_port) {
1898 		general_params->mirr_port = new_mirr_port;
1899 
1900 		rc = sja1105_dynamic_config_write(priv, BLK_IDX_GENERAL_PARAMS,
1901 						  0, general_params, true);
1902 		if (rc < 0)
1903 			return rc;
1904 	}
1905 
1906 	if (ingress)
1907 		mac[from].ing_mirr = enabled;
1908 	else
1909 		mac[from].egr_mirr = enabled;
1910 
1911 	return sja1105_dynamic_config_write(priv, BLK_IDX_MAC_CONFIG, from,
1912 					    &mac[from], true);
1913 }
1914 
1915 static int sja1105_mirror_add(struct dsa_switch *ds, int port,
1916 			      struct dsa_mall_mirror_tc_entry *mirror,
1917 			      bool ingress)
1918 {
1919 	return sja1105_mirror_apply(ds->priv, port, mirror->to_local_port,
1920 				    ingress, true);
1921 }
1922 
1923 static void sja1105_mirror_del(struct dsa_switch *ds, int port,
1924 			       struct dsa_mall_mirror_tc_entry *mirror)
1925 {
1926 	sja1105_mirror_apply(ds->priv, port, mirror->to_local_port,
1927 			     mirror->ingress, false);
1928 }
1929 
1930 static const struct dsa_switch_ops sja1105_switch_ops = {
1931 	.get_tag_protocol	= sja1105_get_tag_protocol,
1932 	.setup			= sja1105_setup,
1933 	.teardown		= sja1105_teardown,
1934 	.set_ageing_time	= sja1105_set_ageing_time,
1935 	.phylink_validate	= sja1105_phylink_validate,
1936 	.phylink_mac_config	= sja1105_mac_config,
1937 	.phylink_mac_link_up	= sja1105_mac_link_up,
1938 	.phylink_mac_link_down	= sja1105_mac_link_down,
1939 	.get_strings		= sja1105_get_strings,
1940 	.get_ethtool_stats	= sja1105_get_ethtool_stats,
1941 	.get_sset_count		= sja1105_get_sset_count,
1942 	.get_ts_info		= sja1105_get_ts_info,
1943 	.port_enable		= sja1105_port_enable,
1944 	.port_fdb_dump		= sja1105_fdb_dump,
1945 	.port_fdb_add		= sja1105_fdb_add,
1946 	.port_fdb_del		= sja1105_fdb_del,
1947 	.port_bridge_join	= sja1105_bridge_join,
1948 	.port_bridge_leave	= sja1105_bridge_leave,
1949 	.port_stp_state_set	= sja1105_bridge_stp_state_set,
1950 	.port_vlan_prepare	= sja1105_vlan_prepare,
1951 	.port_vlan_filtering	= sja1105_vlan_filtering,
1952 	.port_vlan_add		= sja1105_vlan_add,
1953 	.port_vlan_del		= sja1105_vlan_del,
1954 	.port_mdb_prepare	= sja1105_mdb_prepare,
1955 	.port_mdb_add		= sja1105_mdb_add,
1956 	.port_mdb_del		= sja1105_mdb_del,
1957 	.port_deferred_xmit	= sja1105_port_deferred_xmit,
1958 	.port_hwtstamp_get	= sja1105_hwtstamp_get,
1959 	.port_hwtstamp_set	= sja1105_hwtstamp_set,
1960 	.port_rxtstamp		= sja1105_port_rxtstamp,
1961 	.port_txtstamp		= sja1105_port_txtstamp,
1962 	.port_setup_tc		= sja1105_port_setup_tc,
1963 	.port_mirror_add	= sja1105_mirror_add,
1964 	.port_mirror_del	= sja1105_mirror_del,
1965 };
1966 
1967 static int sja1105_check_device_id(struct sja1105_private *priv)
1968 {
1969 	const struct sja1105_regs *regs = priv->info->regs;
1970 	u8 prod_id[SJA1105_SIZE_DEVICE_ID] = {0};
1971 	struct device *dev = &priv->spidev->dev;
1972 	u32 device_id;
1973 	u64 part_no;
1974 	int rc;
1975 
1976 	rc = sja1105_xfer_u32(priv, SPI_READ, regs->device_id, &device_id);
1977 	if (rc < 0)
1978 		return rc;
1979 
1980 	if (device_id != priv->info->device_id) {
1981 		dev_err(dev, "Expected device ID 0x%llx but read 0x%x\n",
1982 			priv->info->device_id, device_id);
1983 		return -ENODEV;
1984 	}
1985 
1986 	rc = sja1105_xfer_buf(priv, SPI_READ, regs->prod_id, prod_id,
1987 			      SJA1105_SIZE_DEVICE_ID);
1988 	if (rc < 0)
1989 		return rc;
1990 
1991 	sja1105_unpack(prod_id, &part_no, 19, 4, SJA1105_SIZE_DEVICE_ID);
1992 
1993 	if (part_no != priv->info->part_no) {
1994 		dev_err(dev, "Expected part number 0x%llx but read 0x%llx\n",
1995 			priv->info->part_no, part_no);
1996 		return -ENODEV;
1997 	}
1998 
1999 	return 0;
2000 }
2001 
2002 static int sja1105_probe(struct spi_device *spi)
2003 {
2004 	struct sja1105_tagger_data *tagger_data;
2005 	struct device *dev = &spi->dev;
2006 	struct sja1105_private *priv;
2007 	struct dsa_switch *ds;
2008 	int rc, i;
2009 
2010 	if (!dev->of_node) {
2011 		dev_err(dev, "No DTS bindings for SJA1105 driver\n");
2012 		return -EINVAL;
2013 	}
2014 
2015 	priv = devm_kzalloc(dev, sizeof(struct sja1105_private), GFP_KERNEL);
2016 	if (!priv)
2017 		return -ENOMEM;
2018 
2019 	/* Configure the optional reset pin and bring up switch */
2020 	priv->reset_gpio = devm_gpiod_get(dev, "reset", GPIOD_OUT_HIGH);
2021 	if (IS_ERR(priv->reset_gpio))
2022 		dev_dbg(dev, "reset-gpios not defined, ignoring\n");
2023 	else
2024 		sja1105_hw_reset(priv->reset_gpio, 1, 1);
2025 
2026 	/* Populate our driver private structure (priv) based on
2027 	 * the device tree node that was probed (spi)
2028 	 */
2029 	priv->spidev = spi;
2030 	spi_set_drvdata(spi, priv);
2031 
2032 	/* Configure the SPI bus */
2033 	spi->bits_per_word = 8;
2034 	rc = spi_setup(spi);
2035 	if (rc < 0) {
2036 		dev_err(dev, "Could not init SPI\n");
2037 		return rc;
2038 	}
2039 
2040 	priv->info = of_device_get_match_data(dev);
2041 
2042 	/* Detect hardware device */
2043 	rc = sja1105_check_device_id(priv);
2044 	if (rc < 0) {
2045 		dev_err(dev, "Device ID check failed: %d\n", rc);
2046 		return rc;
2047 	}
2048 
2049 	dev_info(dev, "Probed switch chip: %s\n", priv->info->name);
2050 
2051 	ds = devm_kzalloc(dev, sizeof(*ds), GFP_KERNEL);
2052 	if (!ds)
2053 		return -ENOMEM;
2054 
2055 	ds->dev = dev;
2056 	ds->num_ports = SJA1105_NUM_PORTS;
2057 	ds->ops = &sja1105_switch_ops;
2058 	ds->priv = priv;
2059 	priv->ds = ds;
2060 
2061 	tagger_data = &priv->tagger_data;
2062 
2063 	mutex_init(&priv->ptp_data.lock);
2064 	mutex_init(&priv->mgmt_lock);
2065 
2066 	sja1105_tas_setup(ds);
2067 
2068 	rc = dsa_register_switch(priv->ds);
2069 	if (rc)
2070 		return rc;
2071 
2072 	/* Connections between dsa_port and sja1105_port */
2073 	for (i = 0; i < SJA1105_NUM_PORTS; i++) {
2074 		struct sja1105_port *sp = &priv->ports[i];
2075 
2076 		dsa_to_port(ds, i)->priv = sp;
2077 		sp->dp = dsa_to_port(ds, i);
2078 		sp->data = tagger_data;
2079 	}
2080 
2081 	return 0;
2082 }
2083 
2084 static int sja1105_remove(struct spi_device *spi)
2085 {
2086 	struct sja1105_private *priv = spi_get_drvdata(spi);
2087 
2088 	dsa_unregister_switch(priv->ds);
2089 	return 0;
2090 }
2091 
2092 static const struct of_device_id sja1105_dt_ids[] = {
2093 	{ .compatible = "nxp,sja1105e", .data = &sja1105e_info },
2094 	{ .compatible = "nxp,sja1105t", .data = &sja1105t_info },
2095 	{ .compatible = "nxp,sja1105p", .data = &sja1105p_info },
2096 	{ .compatible = "nxp,sja1105q", .data = &sja1105q_info },
2097 	{ .compatible = "nxp,sja1105r", .data = &sja1105r_info },
2098 	{ .compatible = "nxp,sja1105s", .data = &sja1105s_info },
2099 	{ /* sentinel */ },
2100 };
2101 MODULE_DEVICE_TABLE(of, sja1105_dt_ids);
2102 
2103 static struct spi_driver sja1105_driver = {
2104 	.driver = {
2105 		.name  = "sja1105",
2106 		.owner = THIS_MODULE,
2107 		.of_match_table = of_match_ptr(sja1105_dt_ids),
2108 	},
2109 	.probe  = sja1105_probe,
2110 	.remove = sja1105_remove,
2111 };
2112 
2113 module_spi_driver(sja1105_driver);
2114 
2115 MODULE_AUTHOR("Vladimir Oltean <olteanv@gmail.com>");
2116 MODULE_AUTHOR("Georg Waibel <georg.waibel@sensor-technik.de>");
2117 MODULE_DESCRIPTION("SJA1105 Driver");
2118 MODULE_LICENSE("GPL v2");
2119