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>
6 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
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>
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>
26 static void sja1105_hw_reset(struct gpio_desc *gpio, unsigned int pulse_len,
27 unsigned int startup_delay)
29 gpiod_set_value_cansleep(gpio, 1);
30 /* Wait for minimum reset pulse length */
32 gpiod_set_value_cansleep(gpio, 0);
33 /* Wait until chip is ready after reset */
34 msleep(startup_delay);
38 sja1105_port_allow_traffic(struct sja1105_l2_forwarding_entry *l2_fwd,
39 int from, int to, bool allow)
42 l2_fwd[from].bc_domain |= BIT(to);
43 l2_fwd[from].reach_port |= BIT(to);
44 l2_fwd[from].fl_domain |= BIT(to);
46 l2_fwd[from].bc_domain &= ~BIT(to);
47 l2_fwd[from].reach_port &= ~BIT(to);
48 l2_fwd[from].fl_domain &= ~BIT(to);
52 /* Structure used to temporarily transport device tree
53 * settings into sja1105_setup
55 struct sja1105_dt_port {
56 phy_interface_t phy_mode;
57 sja1105_mii_role_t role;
60 static int sja1105_init_mac_settings(struct sja1105_private *priv)
62 struct sja1105_mac_config_entry default_mac = {
63 /* Enable all 8 priority queues on egress.
64 * Every queue i holds top[i] - base[i] frames.
65 * Sum of top[i] - base[i] is 511 (max hardware limit).
67 .top = {0x3F, 0x7F, 0xBF, 0xFF, 0x13F, 0x17F, 0x1BF, 0x1FF},
68 .base = {0x0, 0x40, 0x80, 0xC0, 0x100, 0x140, 0x180, 0x1C0},
69 .enabled = {true, true, true, true, true, true, true, true},
70 /* Keep standard IFG of 12 bytes on egress. */
72 /* Always put the MAC speed in automatic mode, where it can be
73 * adjusted at runtime by PHYLINK.
75 .speed = SJA1105_SPEED_AUTO,
76 /* No static correction for 1-step 1588 events */
79 /* Disable aging for critical TTEthernet traffic */
81 /* Internal VLAN (pvid) to apply to untagged ingress */
86 /* Don't drop traffic with other EtherType than ETH_P_IP */
88 /* Don't drop double-tagged traffic */
90 /* Don't drop untagged traffic */
92 /* Don't retag 802.1p (VID 0) traffic with the pvid */
94 /* Disable learning and I/O on user ports by default -
101 struct sja1105_mac_config_entry *mac;
102 struct sja1105_table *table;
105 table = &priv->static_config.tables[BLK_IDX_MAC_CONFIG];
107 /* Discard previous MAC Configuration Table */
108 if (table->entry_count) {
109 kfree(table->entries);
110 table->entry_count = 0;
113 table->entries = kcalloc(SJA1105_NUM_PORTS,
114 table->ops->unpacked_entry_size, GFP_KERNEL);
118 table->entry_count = SJA1105_NUM_PORTS;
120 mac = table->entries;
122 for (i = 0; i < SJA1105_NUM_PORTS; i++) {
123 mac[i] = default_mac;
124 if (i == dsa_upstream_port(priv->ds, i)) {
125 /* STP doesn't get called for CPU port, so we need to
126 * set the I/O parameters statically.
128 mac[i].dyn_learn = true;
129 mac[i].ingress = true;
130 mac[i].egress = true;
137 static int sja1105_init_mii_settings(struct sja1105_private *priv,
138 struct sja1105_dt_port *ports)
140 struct device *dev = &priv->spidev->dev;
141 struct sja1105_xmii_params_entry *mii;
142 struct sja1105_table *table;
145 table = &priv->static_config.tables[BLK_IDX_XMII_PARAMS];
147 /* Discard previous xMII Mode Parameters Table */
148 if (table->entry_count) {
149 kfree(table->entries);
150 table->entry_count = 0;
153 table->entries = kcalloc(SJA1105_MAX_XMII_PARAMS_COUNT,
154 table->ops->unpacked_entry_size, GFP_KERNEL);
158 /* Override table based on PHYLINK DT bindings */
159 table->entry_count = SJA1105_MAX_XMII_PARAMS_COUNT;
161 mii = table->entries;
163 for (i = 0; i < SJA1105_NUM_PORTS; i++) {
164 switch (ports[i].phy_mode) {
165 case PHY_INTERFACE_MODE_MII:
166 mii->xmii_mode[i] = XMII_MODE_MII;
168 case PHY_INTERFACE_MODE_RMII:
169 mii->xmii_mode[i] = XMII_MODE_RMII;
171 case PHY_INTERFACE_MODE_RGMII:
172 case PHY_INTERFACE_MODE_RGMII_ID:
173 case PHY_INTERFACE_MODE_RGMII_RXID:
174 case PHY_INTERFACE_MODE_RGMII_TXID:
175 mii->xmii_mode[i] = XMII_MODE_RGMII;
178 dev_err(dev, "Unsupported PHY mode %s!\n",
179 phy_modes(ports[i].phy_mode));
182 mii->phy_mac[i] = ports[i].role;
187 static int sja1105_init_static_fdb(struct sja1105_private *priv)
189 struct sja1105_table *table;
191 table = &priv->static_config.tables[BLK_IDX_L2_LOOKUP];
193 /* We only populate the FDB table through dynamic
194 * L2 Address Lookup entries
196 if (table->entry_count) {
197 kfree(table->entries);
198 table->entry_count = 0;
203 static int sja1105_init_l2_lookup_params(struct sja1105_private *priv)
205 struct sja1105_table *table;
206 u64 max_fdb_entries = SJA1105_MAX_L2_LOOKUP_COUNT / SJA1105_NUM_PORTS;
207 struct sja1105_l2_lookup_params_entry default_l2_lookup_params = {
208 /* Learned FDB entries are forgotten after 300 seconds */
209 .maxage = SJA1105_AGEING_TIME_MS(300000),
210 /* All entries within a FDB bin are available for learning */
211 .dyn_tbsz = SJA1105ET_FDB_BIN_SIZE,
212 /* And the P/Q/R/S equivalent setting: */
214 .maxaddrp = {max_fdb_entries, max_fdb_entries, max_fdb_entries,
215 max_fdb_entries, max_fdb_entries, },
216 /* 2^8 + 2^5 + 2^3 + 2^2 + 2^1 + 1 in Koopman notation */
218 /* This selects between Independent VLAN Learning (IVL) and
219 * Shared VLAN Learning (SVL)
221 .shared_learn = false,
222 /* Don't discard management traffic based on ENFPORT -
223 * we don't perform SMAC port enforcement anyway, so
224 * what we are setting here doesn't matter.
226 .no_enf_hostprt = false,
227 /* Don't learn SMAC for mac_fltres1 and mac_fltres0.
228 * Maybe correlate with no_linklocal_learn from bridge driver?
230 .no_mgmt_learn = true,
233 /* Dynamically learned FDB entries can overwrite other (older)
234 * dynamic FDB entries
240 table = &priv->static_config.tables[BLK_IDX_L2_LOOKUP_PARAMS];
242 if (table->entry_count) {
243 kfree(table->entries);
244 table->entry_count = 0;
247 table->entries = kcalloc(SJA1105_MAX_L2_LOOKUP_PARAMS_COUNT,
248 table->ops->unpacked_entry_size, GFP_KERNEL);
252 table->entry_count = SJA1105_MAX_L2_LOOKUP_PARAMS_COUNT;
254 /* This table only has a single entry */
255 ((struct sja1105_l2_lookup_params_entry *)table->entries)[0] =
256 default_l2_lookup_params;
261 static int sja1105_init_static_vlan(struct sja1105_private *priv)
263 struct sja1105_table *table;
264 struct sja1105_vlan_lookup_entry pvid = {
274 table = &priv->static_config.tables[BLK_IDX_VLAN_LOOKUP];
276 /* The static VLAN table will only contain the initial pvid of 1.
277 * All other VLANs are to be configured through dynamic entries,
278 * and kept in the static configuration table as backing memory.
280 if (table->entry_count) {
281 kfree(table->entries);
282 table->entry_count = 0;
285 table->entries = kcalloc(1, table->ops->unpacked_entry_size,
290 table->entry_count = 1;
292 /* VLAN 1: all DT-defined ports are members; no restrictions on
293 * forwarding; always transmit priority-tagged frames as untagged.
295 for (i = 0; i < SJA1105_NUM_PORTS; i++) {
296 pvid.vmemb_port |= BIT(i);
297 pvid.vlan_bc |= BIT(i);
298 pvid.tag_port &= ~BIT(i);
301 ((struct sja1105_vlan_lookup_entry *)table->entries)[0] = pvid;
305 static int sja1105_init_l2_forwarding(struct sja1105_private *priv)
307 struct sja1105_l2_forwarding_entry *l2fwd;
308 struct sja1105_table *table;
311 table = &priv->static_config.tables[BLK_IDX_L2_FORWARDING];
313 if (table->entry_count) {
314 kfree(table->entries);
315 table->entry_count = 0;
318 table->entries = kcalloc(SJA1105_MAX_L2_FORWARDING_COUNT,
319 table->ops->unpacked_entry_size, GFP_KERNEL);
323 table->entry_count = SJA1105_MAX_L2_FORWARDING_COUNT;
325 l2fwd = table->entries;
327 /* First 5 entries define the forwarding rules */
328 for (i = 0; i < SJA1105_NUM_PORTS; i++) {
329 unsigned int upstream = dsa_upstream_port(priv->ds, i);
331 for (j = 0; j < SJA1105_NUM_TC; j++)
332 l2fwd[i].vlan_pmap[j] = j;
337 sja1105_port_allow_traffic(l2fwd, i, upstream, true);
338 sja1105_port_allow_traffic(l2fwd, upstream, i, true);
340 /* Next 8 entries define VLAN PCP mapping from ingress to egress.
341 * Create a one-to-one mapping.
343 for (i = 0; i < SJA1105_NUM_TC; i++)
344 for (j = 0; j < SJA1105_NUM_PORTS; j++)
345 l2fwd[SJA1105_NUM_PORTS + i].vlan_pmap[j] = i;
350 static int sja1105_init_l2_forwarding_params(struct sja1105_private *priv)
352 struct sja1105_l2_forwarding_params_entry default_l2fwd_params = {
353 /* Disallow dynamic reconfiguration of vlan_pmap */
355 /* Use a single memory partition for all ingress queues */
356 .part_spc = { SJA1105_MAX_FRAME_MEMORY, 0, 0, 0, 0, 0, 0, 0 },
358 struct sja1105_table *table;
360 table = &priv->static_config.tables[BLK_IDX_L2_FORWARDING_PARAMS];
362 if (table->entry_count) {
363 kfree(table->entries);
364 table->entry_count = 0;
367 table->entries = kcalloc(SJA1105_MAX_L2_FORWARDING_PARAMS_COUNT,
368 table->ops->unpacked_entry_size, GFP_KERNEL);
372 table->entry_count = SJA1105_MAX_L2_FORWARDING_PARAMS_COUNT;
374 /* This table only has a single entry */
375 ((struct sja1105_l2_forwarding_params_entry *)table->entries)[0] =
376 default_l2fwd_params;
381 static int sja1105_init_general_params(struct sja1105_private *priv)
383 struct sja1105_general_params_entry default_general_params = {
384 /* Disallow dynamic changing of the mirror port */
386 .switchid = priv->ds->index,
387 /* Priority queue for link-local frames trapped to CPU */
389 .mac_fltres1 = SJA1105_LINKLOCAL_FILTER_A,
390 .mac_flt1 = SJA1105_LINKLOCAL_FILTER_A_MASK,
391 .incl_srcpt1 = false,
393 .mac_fltres0 = SJA1105_LINKLOCAL_FILTER_B,
394 .mac_flt0 = SJA1105_LINKLOCAL_FILTER_B_MASK,
395 .incl_srcpt0 = false,
397 /* The destination for traffic matching mac_fltres1 and
398 * mac_fltres0 on all ports except host_port. Such traffic
399 * receieved on host_port itself would be dropped, except
400 * by installing a temporary 'management route'
402 .host_port = dsa_upstream_port(priv->ds, 0),
403 /* Same as host port */
404 .mirr_port = dsa_upstream_port(priv->ds, 0),
405 /* Link-local traffic received on casc_port will be forwarded
406 * to host_port without embedding the source port and device ID
407 * info in the destination MAC address (presumably because it
408 * is a cascaded port and a downstream SJA switch already did
409 * that). Default to an invalid port (to disable the feature)
410 * and overwrite this if we find any DSA (cascaded) ports.
412 .casc_port = SJA1105_NUM_PORTS,
417 /* Only update correctionField for 1-step PTP (L2 transport) */
419 /* Forcefully disable VLAN filtering by telling
420 * the switch that VLAN has a different EtherType.
422 .tpid = ETH_P_SJA1105,
423 .tpid2 = ETH_P_SJA1105,
425 struct sja1105_table *table;
428 for (i = 0; i < SJA1105_NUM_PORTS; i++) {
429 if (dsa_is_dsa_port(priv->ds, i))
430 default_general_params.casc_port = i;
431 else if (dsa_is_user_port(priv->ds, i))
432 priv->ports[i].mgmt_slot = k++;
435 table = &priv->static_config.tables[BLK_IDX_GENERAL_PARAMS];
437 if (table->entry_count) {
438 kfree(table->entries);
439 table->entry_count = 0;
442 table->entries = kcalloc(SJA1105_MAX_GENERAL_PARAMS_COUNT,
443 table->ops->unpacked_entry_size, GFP_KERNEL);
447 table->entry_count = SJA1105_MAX_GENERAL_PARAMS_COUNT;
449 /* This table only has a single entry */
450 ((struct sja1105_general_params_entry *)table->entries)[0] =
451 default_general_params;
456 #define SJA1105_RATE_MBPS(speed) (((speed) * 64000) / 1000)
459 sja1105_setup_policer(struct sja1105_l2_policing_entry *policing,
462 policing[index].sharindx = index;
463 policing[index].smax = 65535; /* Burst size in bytes */
464 policing[index].rate = SJA1105_RATE_MBPS(1000);
465 policing[index].maxlen = ETH_FRAME_LEN + VLAN_HLEN + ETH_FCS_LEN;
466 policing[index].partition = 0;
469 static int sja1105_init_l2_policing(struct sja1105_private *priv)
471 struct sja1105_l2_policing_entry *policing;
472 struct sja1105_table *table;
475 table = &priv->static_config.tables[BLK_IDX_L2_POLICING];
477 /* Discard previous L2 Policing Table */
478 if (table->entry_count) {
479 kfree(table->entries);
480 table->entry_count = 0;
483 table->entries = kcalloc(SJA1105_MAX_L2_POLICING_COUNT,
484 table->ops->unpacked_entry_size, GFP_KERNEL);
488 table->entry_count = SJA1105_MAX_L2_POLICING_COUNT;
490 policing = table->entries;
492 /* k sweeps through all unicast policers (0-39).
493 * bcast sweeps through policers 40-44.
495 for (i = 0, k = 0; i < SJA1105_NUM_PORTS; i++) {
496 int bcast = (SJA1105_NUM_PORTS * SJA1105_NUM_TC) + i;
498 for (j = 0; j < SJA1105_NUM_TC; j++, k++)
499 sja1105_setup_policer(policing, k);
501 /* Set up this port's policer for broadcast traffic */
502 sja1105_setup_policer(policing, bcast);
507 static int sja1105_init_avb_params(struct sja1105_private *priv,
510 struct sja1105_avb_params_entry *avb;
511 struct sja1105_table *table;
513 table = &priv->static_config.tables[BLK_IDX_AVB_PARAMS];
515 /* Discard previous AVB Parameters Table */
516 if (table->entry_count) {
517 kfree(table->entries);
518 table->entry_count = 0;
521 /* Configure the reception of meta frames only if requested */
525 table->entries = kcalloc(SJA1105_MAX_AVB_PARAMS_COUNT,
526 table->ops->unpacked_entry_size, GFP_KERNEL);
530 table->entry_count = SJA1105_MAX_AVB_PARAMS_COUNT;
532 avb = table->entries;
534 avb->destmeta = SJA1105_META_DMAC;
535 avb->srcmeta = SJA1105_META_SMAC;
540 static int sja1105_static_config_load(struct sja1105_private *priv,
541 struct sja1105_dt_port *ports)
545 sja1105_static_config_free(&priv->static_config);
546 rc = sja1105_static_config_init(&priv->static_config,
547 priv->info->static_ops,
548 priv->info->device_id);
552 /* Build static configuration */
553 rc = sja1105_init_mac_settings(priv);
556 rc = sja1105_init_mii_settings(priv, ports);
559 rc = sja1105_init_static_fdb(priv);
562 rc = sja1105_init_static_vlan(priv);
565 rc = sja1105_init_l2_lookup_params(priv);
568 rc = sja1105_init_l2_forwarding(priv);
571 rc = sja1105_init_l2_forwarding_params(priv);
574 rc = sja1105_init_l2_policing(priv);
577 rc = sja1105_init_general_params(priv);
580 rc = sja1105_init_avb_params(priv, false);
584 /* Send initial configuration to hardware via SPI */
585 return sja1105_static_config_upload(priv);
588 static int sja1105_parse_rgmii_delays(struct sja1105_private *priv,
589 const struct sja1105_dt_port *ports)
593 for (i = 0; i < SJA1105_NUM_PORTS; i++) {
594 if (ports->role == XMII_MAC)
597 if (ports->phy_mode == PHY_INTERFACE_MODE_RGMII_RXID ||
598 ports->phy_mode == PHY_INTERFACE_MODE_RGMII_ID)
599 priv->rgmii_rx_delay[i] = true;
601 if (ports->phy_mode == PHY_INTERFACE_MODE_RGMII_TXID ||
602 ports->phy_mode == PHY_INTERFACE_MODE_RGMII_ID)
603 priv->rgmii_tx_delay[i] = true;
605 if ((priv->rgmii_rx_delay[i] || priv->rgmii_tx_delay[i]) &&
606 !priv->info->setup_rgmii_delay)
612 static int sja1105_parse_ports_node(struct sja1105_private *priv,
613 struct sja1105_dt_port *ports,
614 struct device_node *ports_node)
616 struct device *dev = &priv->spidev->dev;
617 struct device_node *child;
619 for_each_child_of_node(ports_node, child) {
620 struct device_node *phy_node;
624 /* Get switch port number from DT */
625 if (of_property_read_u32(child, "reg", &index) < 0) {
626 dev_err(dev, "Port number not defined in device tree "
627 "(property \"reg\")\n");
631 /* Get PHY mode from DT */
632 phy_mode = of_get_phy_mode(child);
634 dev_err(dev, "Failed to read phy-mode or "
635 "phy-interface-type property for port %d\n",
639 ports[index].phy_mode = phy_mode;
641 phy_node = of_parse_phandle(child, "phy-handle", 0);
643 if (!of_phy_is_fixed_link(child)) {
644 dev_err(dev, "phy-handle or fixed-link "
645 "properties missing!\n");
648 /* phy-handle is missing, but fixed-link isn't.
649 * So it's a fixed link. Default to PHY role.
651 ports[index].role = XMII_PHY;
653 /* phy-handle present => put port in MAC role */
654 ports[index].role = XMII_MAC;
655 of_node_put(phy_node);
658 /* The MAC/PHY role can be overridden with explicit bindings */
659 if (of_property_read_bool(child, "sja1105,role-mac"))
660 ports[index].role = XMII_MAC;
661 else if (of_property_read_bool(child, "sja1105,role-phy"))
662 ports[index].role = XMII_PHY;
668 static int sja1105_parse_dt(struct sja1105_private *priv,
669 struct sja1105_dt_port *ports)
671 struct device *dev = &priv->spidev->dev;
672 struct device_node *switch_node = dev->of_node;
673 struct device_node *ports_node;
676 ports_node = of_get_child_by_name(switch_node, "ports");
678 dev_err(dev, "Incorrect bindings: absent \"ports\" node\n");
682 rc = sja1105_parse_ports_node(priv, ports, ports_node);
683 of_node_put(ports_node);
688 /* Convert link speed from SJA1105 to ethtool encoding */
689 static int sja1105_speed[] = {
690 [SJA1105_SPEED_AUTO] = SPEED_UNKNOWN,
691 [SJA1105_SPEED_10MBPS] = SPEED_10,
692 [SJA1105_SPEED_100MBPS] = SPEED_100,
693 [SJA1105_SPEED_1000MBPS] = SPEED_1000,
696 /* Set link speed in the MAC configuration for a specific port. */
697 static int sja1105_adjust_port_config(struct sja1105_private *priv, int port,
700 struct sja1105_xmii_params_entry *mii;
701 struct sja1105_mac_config_entry *mac;
702 struct device *dev = priv->ds->dev;
703 sja1105_phy_interface_t phy_mode;
704 sja1105_speed_t speed;
707 /* On P/Q/R/S, one can read from the device via the MAC reconfiguration
708 * tables. On E/T, MAC reconfig tables are not readable, only writable.
709 * We have to *know* what the MAC looks like. For the sake of keeping
710 * the code common, we'll use the static configuration tables as a
711 * reasonable approximation for both E/T and P/Q/R/S.
713 mac = priv->static_config.tables[BLK_IDX_MAC_CONFIG].entries;
714 mii = priv->static_config.tables[BLK_IDX_XMII_PARAMS].entries;
716 switch (speed_mbps) {
718 /* PHYLINK called sja1105_mac_config() to inform us about
719 * the state->interface, but AN has not completed and the
720 * speed is not yet valid. UM10944.pdf says that setting
721 * SJA1105_SPEED_AUTO at runtime disables the port, so that is
722 * ok for power consumption in case AN will never complete -
723 * otherwise PHYLINK should come back with a new update.
725 speed = SJA1105_SPEED_AUTO;
728 speed = SJA1105_SPEED_10MBPS;
731 speed = SJA1105_SPEED_100MBPS;
734 speed = SJA1105_SPEED_1000MBPS;
737 dev_err(dev, "Invalid speed %iMbps\n", speed_mbps);
741 /* Overwrite SJA1105_SPEED_AUTO from the static MAC configuration
742 * table, since this will be used for the clocking setup, and we no
743 * longer need to store it in the static config (already told hardware
744 * we want auto during upload phase).
746 mac[port].speed = speed;
748 /* Write to the dynamic reconfiguration tables */
749 rc = sja1105_dynamic_config_write(priv, BLK_IDX_MAC_CONFIG, port,
752 dev_err(dev, "Failed to write MAC config: %d\n", rc);
756 /* Reconfigure the PLLs for the RGMII interfaces (required 125 MHz at
757 * gigabit, 25 MHz at 100 Mbps and 2.5 MHz at 10 Mbps). For MII and
758 * RMII no change of the clock setup is required. Actually, changing
759 * the clock setup does interrupt the clock signal for a certain time
760 * which causes trouble for all PHYs relying on this signal.
762 phy_mode = mii->xmii_mode[port];
763 if (phy_mode != XMII_MODE_RGMII)
766 return sja1105_clocking_setup_port(priv, port);
769 /* The SJA1105 MAC programming model is through the static config (the xMII
770 * Mode table cannot be dynamically reconfigured), and we have to program
771 * that early (earlier than PHYLINK calls us, anyway).
772 * So just error out in case the connected PHY attempts to change the initial
773 * system interface MII protocol from what is defined in the DT, at least for
776 static bool sja1105_phy_mode_mismatch(struct sja1105_private *priv, int port,
777 phy_interface_t interface)
779 struct sja1105_xmii_params_entry *mii;
780 sja1105_phy_interface_t phy_mode;
782 mii = priv->static_config.tables[BLK_IDX_XMII_PARAMS].entries;
783 phy_mode = mii->xmii_mode[port];
786 case PHY_INTERFACE_MODE_MII:
787 return (phy_mode != XMII_MODE_MII);
788 case PHY_INTERFACE_MODE_RMII:
789 return (phy_mode != XMII_MODE_RMII);
790 case PHY_INTERFACE_MODE_RGMII:
791 case PHY_INTERFACE_MODE_RGMII_ID:
792 case PHY_INTERFACE_MODE_RGMII_RXID:
793 case PHY_INTERFACE_MODE_RGMII_TXID:
794 return (phy_mode != XMII_MODE_RGMII);
800 static void sja1105_mac_config(struct dsa_switch *ds, int port,
801 unsigned int link_an_mode,
802 const struct phylink_link_state *state)
804 struct sja1105_private *priv = ds->priv;
806 if (sja1105_phy_mode_mismatch(priv, port, state->interface))
809 sja1105_adjust_port_config(priv, port, state->speed);
812 static void sja1105_mac_link_down(struct dsa_switch *ds, int port,
814 phy_interface_t interface)
816 sja1105_inhibit_tx(ds->priv, BIT(port), true);
819 static void sja1105_mac_link_up(struct dsa_switch *ds, int port,
821 phy_interface_t interface,
822 struct phy_device *phydev)
824 sja1105_inhibit_tx(ds->priv, BIT(port), false);
827 static void sja1105_phylink_validate(struct dsa_switch *ds, int port,
828 unsigned long *supported,
829 struct phylink_link_state *state)
831 /* Construct a new mask which exhaustively contains all link features
832 * supported by the MAC, and then apply that (logical AND) to what will
833 * be sent to the PHY for "marketing".
835 __ETHTOOL_DECLARE_LINK_MODE_MASK(mask) = { 0, };
836 struct sja1105_private *priv = ds->priv;
837 struct sja1105_xmii_params_entry *mii;
839 mii = priv->static_config.tables[BLK_IDX_XMII_PARAMS].entries;
841 /* include/linux/phylink.h says:
842 * When @state->interface is %PHY_INTERFACE_MODE_NA, phylink
843 * expects the MAC driver to return all supported link modes.
845 if (state->interface != PHY_INTERFACE_MODE_NA &&
846 sja1105_phy_mode_mismatch(priv, port, state->interface)) {
847 bitmap_zero(supported, __ETHTOOL_LINK_MODE_MASK_NBITS);
851 /* The MAC does not support pause frames, and also doesn't
852 * support half-duplex traffic modes.
854 phylink_set(mask, Autoneg);
855 phylink_set(mask, MII);
856 phylink_set(mask, 10baseT_Full);
857 phylink_set(mask, 100baseT_Full);
858 if (mii->xmii_mode[port] == XMII_MODE_RGMII)
859 phylink_set(mask, 1000baseT_Full);
861 bitmap_and(supported, supported, mask, __ETHTOOL_LINK_MODE_MASK_NBITS);
862 bitmap_and(state->advertising, state->advertising, mask,
863 __ETHTOOL_LINK_MODE_MASK_NBITS);
867 sja1105_find_static_fdb_entry(struct sja1105_private *priv, int port,
868 const struct sja1105_l2_lookup_entry *requested)
870 struct sja1105_l2_lookup_entry *l2_lookup;
871 struct sja1105_table *table;
874 table = &priv->static_config.tables[BLK_IDX_L2_LOOKUP];
875 l2_lookup = table->entries;
877 for (i = 0; i < table->entry_count; i++)
878 if (l2_lookup[i].macaddr == requested->macaddr &&
879 l2_lookup[i].vlanid == requested->vlanid &&
880 l2_lookup[i].destports & BIT(port))
886 /* We want FDB entries added statically through the bridge command to persist
887 * across switch resets, which are a common thing during normal SJA1105
888 * operation. So we have to back them up in the static configuration tables
889 * and hence apply them on next static config upload... yay!
892 sja1105_static_fdb_change(struct sja1105_private *priv, int port,
893 const struct sja1105_l2_lookup_entry *requested,
896 struct sja1105_l2_lookup_entry *l2_lookup;
897 struct sja1105_table *table;
900 table = &priv->static_config.tables[BLK_IDX_L2_LOOKUP];
902 match = sja1105_find_static_fdb_entry(priv, port, requested);
904 /* Can't delete a missing entry. */
908 /* No match => new entry */
909 rc = sja1105_table_resize(table, table->entry_count + 1);
913 match = table->entry_count - 1;
916 /* Assign pointer after the resize (it may be new memory) */
917 l2_lookup = table->entries;
920 * If the job was to add this FDB entry, it's already done (mostly
921 * anyway, since the port forwarding mask may have changed, case in
922 * which we update it).
923 * Otherwise we have to delete it.
926 l2_lookup[match] = *requested;
930 /* To remove, the strategy is to overwrite the element with
931 * the last one, and then reduce the array size by 1
933 l2_lookup[match] = l2_lookup[table->entry_count - 1];
934 return sja1105_table_resize(table, table->entry_count - 1);
937 /* First-generation switches have a 4-way set associative TCAM that
938 * holds the FDB entries. An FDB index spans from 0 to 1023 and is comprised of
939 * a "bin" (grouping of 4 entries) and a "way" (an entry within a bin).
940 * For the placement of a newly learnt FDB entry, the switch selects the bin
941 * based on a hash function, and the way within that bin incrementally.
943 static inline int sja1105et_fdb_index(int bin, int way)
945 return bin * SJA1105ET_FDB_BIN_SIZE + way;
948 static int sja1105et_is_fdb_entry_in_bin(struct sja1105_private *priv, int bin,
949 const u8 *addr, u16 vid,
950 struct sja1105_l2_lookup_entry *match,
955 for (way = 0; way < SJA1105ET_FDB_BIN_SIZE; way++) {
956 struct sja1105_l2_lookup_entry l2_lookup = {0};
957 int index = sja1105et_fdb_index(bin, way);
959 /* Skip unused entries, optionally marking them
960 * into the return value
962 if (sja1105_dynamic_config_read(priv, BLK_IDX_L2_LOOKUP,
963 index, &l2_lookup)) {
969 if (l2_lookup.macaddr == ether_addr_to_u64(addr) &&
970 l2_lookup.vlanid == vid) {
976 /* Return an invalid entry index if not found */
980 int sja1105et_fdb_add(struct dsa_switch *ds, int port,
981 const unsigned char *addr, u16 vid)
983 struct sja1105_l2_lookup_entry l2_lookup = {0};
984 struct sja1105_private *priv = ds->priv;
985 struct device *dev = ds->dev;
986 int last_unused = -1;
989 bin = sja1105et_fdb_hash(priv, addr, vid);
991 way = sja1105et_is_fdb_entry_in_bin(priv, bin, addr, vid,
992 &l2_lookup, &last_unused);
994 /* We have an FDB entry. Is our port in the destination
995 * mask? If yes, we need to do nothing. If not, we need
996 * to rewrite the entry by adding this port to it.
998 if (l2_lookup.destports & BIT(port))
1000 l2_lookup.destports |= BIT(port);
1002 int index = sja1105et_fdb_index(bin, way);
1004 /* We don't have an FDB entry. We construct a new one and
1005 * try to find a place for it within the FDB table.
1007 l2_lookup.macaddr = ether_addr_to_u64(addr);
1008 l2_lookup.destports = BIT(port);
1009 l2_lookup.vlanid = vid;
1011 if (last_unused >= 0) {
1014 /* Bin is full, need to evict somebody.
1015 * Choose victim at random. If you get these messages
1016 * often, you may need to consider changing the
1017 * distribution function:
1018 * static_config[BLK_IDX_L2_LOOKUP_PARAMS].entries->poly
1020 get_random_bytes(&way, sizeof(u8));
1021 way %= SJA1105ET_FDB_BIN_SIZE;
1022 dev_warn(dev, "Warning, FDB bin %d full while adding entry for %pM. Evicting entry %u.\n",
1025 sja1105_dynamic_config_write(priv, BLK_IDX_L2_LOOKUP,
1026 index, NULL, false);
1029 l2_lookup.index = sja1105et_fdb_index(bin, way);
1031 rc = sja1105_dynamic_config_write(priv, BLK_IDX_L2_LOOKUP,
1032 l2_lookup.index, &l2_lookup,
1037 return sja1105_static_fdb_change(priv, port, &l2_lookup, true);
1040 int sja1105et_fdb_del(struct dsa_switch *ds, int port,
1041 const unsigned char *addr, u16 vid)
1043 struct sja1105_l2_lookup_entry l2_lookup = {0};
1044 struct sja1105_private *priv = ds->priv;
1045 int index, bin, way, rc;
1048 bin = sja1105et_fdb_hash(priv, addr, vid);
1049 way = sja1105et_is_fdb_entry_in_bin(priv, bin, addr, vid,
1053 index = sja1105et_fdb_index(bin, way);
1055 /* We have an FDB entry. Is our port in the destination mask? If yes,
1056 * we need to remove it. If the resulting port mask becomes empty, we
1057 * need to completely evict the FDB entry.
1058 * Otherwise we just write it back.
1060 l2_lookup.destports &= ~BIT(port);
1062 if (l2_lookup.destports)
1067 rc = sja1105_dynamic_config_write(priv, BLK_IDX_L2_LOOKUP,
1068 index, &l2_lookup, keep);
1072 return sja1105_static_fdb_change(priv, port, &l2_lookup, keep);
1075 int sja1105pqrs_fdb_add(struct dsa_switch *ds, int port,
1076 const unsigned char *addr, u16 vid)
1078 struct sja1105_l2_lookup_entry l2_lookup = {0};
1079 struct sja1105_private *priv = ds->priv;
1082 /* Search for an existing entry in the FDB table */
1083 l2_lookup.macaddr = ether_addr_to_u64(addr);
1084 l2_lookup.vlanid = vid;
1085 l2_lookup.iotag = SJA1105_S_TAG;
1086 l2_lookup.mask_macaddr = GENMASK_ULL(ETH_ALEN * 8 - 1, 0);
1087 l2_lookup.mask_vlanid = VLAN_VID_MASK;
1088 l2_lookup.mask_iotag = BIT(0);
1089 l2_lookup.destports = BIT(port);
1091 rc = sja1105_dynamic_config_read(priv, BLK_IDX_L2_LOOKUP,
1092 SJA1105_SEARCH, &l2_lookup);
1094 /* Found and this port is already in the entry's
1095 * port mask => job done
1097 if (l2_lookup.destports & BIT(port))
1099 /* l2_lookup.index is populated by the switch in case it
1102 l2_lookup.destports |= BIT(port);
1103 goto skip_finding_an_index;
1106 /* Not found, so try to find an unused spot in the FDB.
1107 * This is slightly inefficient because the strategy is knock-knock at
1108 * every possible position from 0 to 1023.
1110 for (i = 0; i < SJA1105_MAX_L2_LOOKUP_COUNT; i++) {
1111 rc = sja1105_dynamic_config_read(priv, BLK_IDX_L2_LOOKUP,
1116 if (i == SJA1105_MAX_L2_LOOKUP_COUNT) {
1117 dev_err(ds->dev, "FDB is full, cannot add entry.\n");
1120 l2_lookup.lockeds = true;
1121 l2_lookup.index = i;
1123 skip_finding_an_index:
1124 rc = sja1105_dynamic_config_write(priv, BLK_IDX_L2_LOOKUP,
1125 l2_lookup.index, &l2_lookup,
1130 return sja1105_static_fdb_change(priv, port, &l2_lookup, true);
1133 int sja1105pqrs_fdb_del(struct dsa_switch *ds, int port,
1134 const unsigned char *addr, u16 vid)
1136 struct sja1105_l2_lookup_entry l2_lookup = {0};
1137 struct sja1105_private *priv = ds->priv;
1141 l2_lookup.macaddr = ether_addr_to_u64(addr);
1142 l2_lookup.vlanid = vid;
1143 l2_lookup.iotag = SJA1105_S_TAG;
1144 l2_lookup.mask_macaddr = GENMASK_ULL(ETH_ALEN * 8 - 1, 0);
1145 l2_lookup.mask_vlanid = VLAN_VID_MASK;
1146 l2_lookup.mask_iotag = BIT(0);
1147 l2_lookup.destports = BIT(port);
1149 rc = sja1105_dynamic_config_read(priv, BLK_IDX_L2_LOOKUP,
1150 SJA1105_SEARCH, &l2_lookup);
1154 l2_lookup.destports &= ~BIT(port);
1156 /* Decide whether we remove just this port from the FDB entry,
1157 * or if we remove it completely.
1159 if (l2_lookup.destports)
1164 rc = sja1105_dynamic_config_write(priv, BLK_IDX_L2_LOOKUP,
1165 l2_lookup.index, &l2_lookup, keep);
1169 return sja1105_static_fdb_change(priv, port, &l2_lookup, keep);
1172 static int sja1105_fdb_add(struct dsa_switch *ds, int port,
1173 const unsigned char *addr, u16 vid)
1175 struct sja1105_private *priv = ds->priv;
1179 if (dsa_port_is_vlan_filtering(&ds->ports[port]))
1180 return priv->info->fdb_add_cmd(ds, port, addr, vid);
1182 /* Since we make use of VLANs even when the bridge core doesn't tell us
1183 * to, translate these FDB entries into the correct dsa_8021q ones.
1184 * The basic idea (also repeats for removal below) is:
1185 * - Each of the other front-panel ports needs to be able to forward a
1186 * pvid-tagged (aka tagged with their rx_vid) frame that matches this
1188 * - The CPU port (aka the tx_vid of this port) needs to be able to
1189 * send a frame matching this DMAC to the specified port.
1190 * For a better picture see net/dsa/tag_8021q.c.
1192 for (i = 0; i < SJA1105_NUM_PORTS; i++) {
1195 if (i == dsa_upstream_port(priv->ds, port))
1198 rx_vid = dsa_8021q_rx_vid(ds, i);
1199 rc = priv->info->fdb_add_cmd(ds, port, addr, rx_vid);
1203 tx_vid = dsa_8021q_tx_vid(ds, port);
1204 return priv->info->fdb_add_cmd(ds, port, addr, tx_vid);
1207 static int sja1105_fdb_del(struct dsa_switch *ds, int port,
1208 const unsigned char *addr, u16 vid)
1210 struct sja1105_private *priv = ds->priv;
1214 if (dsa_port_is_vlan_filtering(&ds->ports[port]))
1215 return priv->info->fdb_del_cmd(ds, port, addr, vid);
1217 for (i = 0; i < SJA1105_NUM_PORTS; i++) {
1220 if (i == dsa_upstream_port(priv->ds, port))
1223 rx_vid = dsa_8021q_rx_vid(ds, i);
1224 rc = priv->info->fdb_del_cmd(ds, port, addr, rx_vid);
1228 tx_vid = dsa_8021q_tx_vid(ds, port);
1229 return priv->info->fdb_del_cmd(ds, port, addr, tx_vid);
1232 static int sja1105_fdb_dump(struct dsa_switch *ds, int port,
1233 dsa_fdb_dump_cb_t *cb, void *data)
1235 struct sja1105_private *priv = ds->priv;
1236 struct device *dev = ds->dev;
1240 rx_vid = dsa_8021q_rx_vid(ds, port);
1241 tx_vid = dsa_8021q_tx_vid(ds, port);
1243 for (i = 0; i < SJA1105_MAX_L2_LOOKUP_COUNT; i++) {
1244 struct sja1105_l2_lookup_entry l2_lookup = {0};
1245 u8 macaddr[ETH_ALEN];
1248 rc = sja1105_dynamic_config_read(priv, BLK_IDX_L2_LOOKUP,
1250 /* No fdb entry at i, not an issue */
1254 dev_err(dev, "Failed to dump FDB: %d\n", rc);
1258 /* FDB dump callback is per port. This means we have to
1259 * disregard a valid entry if it's not for this port, even if
1260 * only to revisit it later. This is inefficient because the
1261 * 1024-sized FDB table needs to be traversed 4 times through
1262 * SPI during a 'bridge fdb show' command.
1264 if (!(l2_lookup.destports & BIT(port)))
1266 u64_to_ether_addr(l2_lookup.macaddr, macaddr);
1268 /* On SJA1105 E/T, the switch doesn't implement the LOCKEDS
1269 * bit, so it doesn't tell us whether a FDB entry is static
1271 * But, of course, we can find out - we're the ones who added
1272 * it in the first place.
1274 if (priv->info->device_id == SJA1105E_DEVICE_ID ||
1275 priv->info->device_id == SJA1105T_DEVICE_ID) {
1278 match = sja1105_find_static_fdb_entry(priv, port,
1280 l2_lookup.lockeds = (match >= 0);
1283 /* We need to hide the dsa_8021q VLANs from the user. This
1284 * basically means hiding the duplicates and only showing
1285 * the pvid that is supposed to be active in standalone and
1286 * non-vlan_filtering modes (aka 1).
1287 * - For statically added FDB entries (bridge fdb add), we
1288 * can convert the TX VID (coming from the CPU port) into the
1289 * pvid and ignore the RX VIDs of the other ports.
1290 * - For dynamically learned FDB entries, a single entry with
1291 * no duplicates is learned - that which has the real port's
1294 if (!dsa_port_is_vlan_filtering(&ds->ports[port])) {
1295 if (l2_lookup.vlanid == tx_vid ||
1296 l2_lookup.vlanid == rx_vid)
1297 l2_lookup.vlanid = 1;
1301 cb(macaddr, l2_lookup.vlanid, l2_lookup.lockeds, data);
1306 /* This callback needs to be present */
1307 static int sja1105_mdb_prepare(struct dsa_switch *ds, int port,
1308 const struct switchdev_obj_port_mdb *mdb)
1313 static void sja1105_mdb_add(struct dsa_switch *ds, int port,
1314 const struct switchdev_obj_port_mdb *mdb)
1316 sja1105_fdb_add(ds, port, mdb->addr, mdb->vid);
1319 static int sja1105_mdb_del(struct dsa_switch *ds, int port,
1320 const struct switchdev_obj_port_mdb *mdb)
1322 return sja1105_fdb_del(ds, port, mdb->addr, mdb->vid);
1325 static int sja1105_bridge_member(struct dsa_switch *ds, int port,
1326 struct net_device *br, bool member)
1328 struct sja1105_l2_forwarding_entry *l2_fwd;
1329 struct sja1105_private *priv = ds->priv;
1332 l2_fwd = priv->static_config.tables[BLK_IDX_L2_FORWARDING].entries;
1334 for (i = 0; i < SJA1105_NUM_PORTS; i++) {
1335 /* Add this port to the forwarding matrix of the
1336 * other ports in the same bridge, and viceversa.
1338 if (!dsa_is_user_port(ds, i))
1340 /* For the ports already under the bridge, only one thing needs
1341 * to be done, and that is to add this port to their
1342 * reachability domain. So we can perform the SPI write for
1343 * them immediately. However, for this port itself (the one
1344 * that is new to the bridge), we need to add all other ports
1345 * to its reachability domain. So we do that incrementally in
1346 * this loop, and perform the SPI write only at the end, once
1347 * the domain contains all other bridge ports.
1351 if (dsa_to_port(ds, i)->bridge_dev != br)
1353 sja1105_port_allow_traffic(l2_fwd, i, port, member);
1354 sja1105_port_allow_traffic(l2_fwd, port, i, member);
1356 rc = sja1105_dynamic_config_write(priv, BLK_IDX_L2_FORWARDING,
1357 i, &l2_fwd[i], true);
1362 return sja1105_dynamic_config_write(priv, BLK_IDX_L2_FORWARDING,
1363 port, &l2_fwd[port], true);
1366 static void sja1105_bridge_stp_state_set(struct dsa_switch *ds, int port,
1369 struct sja1105_private *priv = ds->priv;
1370 struct sja1105_mac_config_entry *mac;
1372 mac = priv->static_config.tables[BLK_IDX_MAC_CONFIG].entries;
1375 case BR_STATE_DISABLED:
1376 case BR_STATE_BLOCKING:
1377 /* From UM10944 description of DRPDTAG (why put this there?):
1378 * "Management traffic flows to the port regardless of the state
1379 * of the INGRESS flag". So BPDUs are still be allowed to pass.
1380 * At the moment no difference between DISABLED and BLOCKING.
1382 mac[port].ingress = false;
1383 mac[port].egress = false;
1384 mac[port].dyn_learn = false;
1386 case BR_STATE_LISTENING:
1387 mac[port].ingress = true;
1388 mac[port].egress = false;
1389 mac[port].dyn_learn = false;
1391 case BR_STATE_LEARNING:
1392 mac[port].ingress = true;
1393 mac[port].egress = false;
1394 mac[port].dyn_learn = true;
1396 case BR_STATE_FORWARDING:
1397 mac[port].ingress = true;
1398 mac[port].egress = true;
1399 mac[port].dyn_learn = true;
1402 dev_err(ds->dev, "invalid STP state: %d\n", state);
1406 sja1105_dynamic_config_write(priv, BLK_IDX_MAC_CONFIG, port,
1410 static int sja1105_bridge_join(struct dsa_switch *ds, int port,
1411 struct net_device *br)
1413 return sja1105_bridge_member(ds, port, br, true);
1416 static void sja1105_bridge_leave(struct dsa_switch *ds, int port,
1417 struct net_device *br)
1419 sja1105_bridge_member(ds, port, br, false);
1422 /* For situations where we need to change a setting at runtime that is only
1423 * available through the static configuration, resetting the switch in order
1424 * to upload the new static config is unavoidable. Back up the settings we
1425 * modify at runtime (currently only MAC) and restore them after uploading,
1426 * such that this operation is relatively seamless.
1428 static int sja1105_static_config_reload(struct sja1105_private *priv)
1430 struct sja1105_mac_config_entry *mac;
1431 int speed_mbps[SJA1105_NUM_PORTS];
1434 mac = priv->static_config.tables[BLK_IDX_MAC_CONFIG].entries;
1436 /* Back up the dynamic link speed changed by sja1105_adjust_port_config
1437 * in order to temporarily restore it to SJA1105_SPEED_AUTO - which the
1438 * switch wants to see in the static config in order to allow us to
1439 * change it through the dynamic interface later.
1441 for (i = 0; i < SJA1105_NUM_PORTS; i++) {
1442 speed_mbps[i] = sja1105_speed[mac[i].speed];
1443 mac[i].speed = SJA1105_SPEED_AUTO;
1446 /* Reset switch and send updated static configuration */
1447 rc = sja1105_static_config_upload(priv);
1451 /* Configure the CGU (PLLs) for MII and RMII PHYs.
1452 * For these interfaces there is no dynamic configuration
1453 * needed, since PLLs have same settings at all speeds.
1455 rc = sja1105_clocking_setup(priv);
1459 for (i = 0; i < SJA1105_NUM_PORTS; i++) {
1460 rc = sja1105_adjust_port_config(priv, i, speed_mbps[i]);
1468 static int sja1105_pvid_apply(struct sja1105_private *priv, int port, u16 pvid)
1470 struct sja1105_mac_config_entry *mac;
1472 mac = priv->static_config.tables[BLK_IDX_MAC_CONFIG].entries;
1474 mac[port].vlanid = pvid;
1476 return sja1105_dynamic_config_write(priv, BLK_IDX_MAC_CONFIG, port,
1480 static int sja1105_is_vlan_configured(struct sja1105_private *priv, u16 vid)
1482 struct sja1105_vlan_lookup_entry *vlan;
1485 vlan = priv->static_config.tables[BLK_IDX_VLAN_LOOKUP].entries;
1486 count = priv->static_config.tables[BLK_IDX_VLAN_LOOKUP].entry_count;
1488 for (i = 0; i < count; i++)
1489 if (vlan[i].vlanid == vid)
1492 /* Return an invalid entry index if not found */
1496 static int sja1105_vlan_apply(struct sja1105_private *priv, int port, u16 vid,
1497 bool enabled, bool untagged)
1499 struct sja1105_vlan_lookup_entry *vlan;
1500 struct sja1105_table *table;
1504 table = &priv->static_config.tables[BLK_IDX_VLAN_LOOKUP];
1506 match = sja1105_is_vlan_configured(priv, vid);
1508 /* Can't delete a missing entry. */
1511 rc = sja1105_table_resize(table, table->entry_count + 1);
1514 match = table->entry_count - 1;
1516 /* Assign pointer after the resize (it's new memory) */
1517 vlan = table->entries;
1518 vlan[match].vlanid = vid;
1520 vlan[match].vlan_bc |= BIT(port);
1521 vlan[match].vmemb_port |= BIT(port);
1523 vlan[match].vlan_bc &= ~BIT(port);
1524 vlan[match].vmemb_port &= ~BIT(port);
1526 /* Also unset tag_port if removing this VLAN was requested,
1527 * just so we don't have a confusing bitmap (no practical purpose).
1529 if (untagged || !enabled)
1530 vlan[match].tag_port &= ~BIT(port);
1532 vlan[match].tag_port |= BIT(port);
1533 /* If there's no port left as member of this VLAN,
1534 * it's time for it to go.
1536 if (!vlan[match].vmemb_port)
1539 dev_dbg(priv->ds->dev,
1540 "%s: port %d, vid %llu, broadcast domain 0x%llx, "
1541 "port members 0x%llx, tagged ports 0x%llx, keep %d\n",
1542 __func__, port, vlan[match].vlanid, vlan[match].vlan_bc,
1543 vlan[match].vmemb_port, vlan[match].tag_port, keep);
1545 rc = sja1105_dynamic_config_write(priv, BLK_IDX_VLAN_LOOKUP, vid,
1546 &vlan[match], keep);
1551 return sja1105_table_delete_entry(table, match);
1556 static int sja1105_setup_8021q_tagging(struct dsa_switch *ds, bool enabled)
1560 for (i = 0; i < SJA1105_NUM_PORTS; i++) {
1561 rc = dsa_port_setup_8021q_tagging(ds, i, enabled);
1563 dev_err(ds->dev, "Failed to setup VLAN tagging for port %d: %d\n",
1568 dev_info(ds->dev, "%s switch tagging\n",
1569 enabled ? "Enabled" : "Disabled");
1573 static enum dsa_tag_protocol
1574 sja1105_get_tag_protocol(struct dsa_switch *ds, int port)
1576 return DSA_TAG_PROTO_SJA1105;
1579 /* This callback needs to be present */
1580 static int sja1105_vlan_prepare(struct dsa_switch *ds, int port,
1581 const struct switchdev_obj_port_vlan *vlan)
1586 /* The TPID setting belongs to the General Parameters table,
1587 * which can only be partially reconfigured at runtime (and not the TPID).
1588 * So a switch reset is required.
1590 static int sja1105_vlan_filtering(struct dsa_switch *ds, int port, bool enabled)
1592 struct sja1105_general_params_entry *general_params;
1593 struct sja1105_private *priv = ds->priv;
1594 struct sja1105_table *table;
1599 /* Enable VLAN filtering. */
1600 tpid = ETH_P_8021AD;
1601 tpid2 = ETH_P_8021Q;
1603 /* Disable VLAN filtering. */
1604 tpid = ETH_P_SJA1105;
1605 tpid2 = ETH_P_SJA1105;
1608 table = &priv->static_config.tables[BLK_IDX_GENERAL_PARAMS];
1609 general_params = table->entries;
1610 /* EtherType used to identify outer tagged (S-tag) VLAN traffic */
1611 general_params->tpid = tpid;
1612 /* EtherType used to identify inner tagged (C-tag) VLAN traffic */
1613 general_params->tpid2 = tpid2;
1614 /* When VLAN filtering is on, we need to at least be able to
1615 * decode management traffic through the "backup plan".
1617 general_params->incl_srcpt1 = enabled;
1618 general_params->incl_srcpt0 = enabled;
1620 rc = sja1105_static_config_reload(priv);
1622 dev_err(ds->dev, "Failed to change VLAN Ethertype\n");
1624 /* Switch port identification based on 802.1Q is only passable
1625 * if we are not under a vlan_filtering bridge. So make sure
1626 * the two configurations are mutually exclusive.
1628 return sja1105_setup_8021q_tagging(ds, !enabled);
1631 static void sja1105_vlan_add(struct dsa_switch *ds, int port,
1632 const struct switchdev_obj_port_vlan *vlan)
1634 struct sja1105_private *priv = ds->priv;
1638 for (vid = vlan->vid_begin; vid <= vlan->vid_end; vid++) {
1639 rc = sja1105_vlan_apply(priv, port, vid, true, vlan->flags &
1640 BRIDGE_VLAN_INFO_UNTAGGED);
1642 dev_err(ds->dev, "Failed to add VLAN %d to port %d: %d\n",
1646 if (vlan->flags & BRIDGE_VLAN_INFO_PVID) {
1647 rc = sja1105_pvid_apply(ds->priv, port, vid);
1649 dev_err(ds->dev, "Failed to set pvid %d on port %d: %d\n",
1657 static int sja1105_vlan_del(struct dsa_switch *ds, int port,
1658 const struct switchdev_obj_port_vlan *vlan)
1660 struct sja1105_private *priv = ds->priv;
1664 for (vid = vlan->vid_begin; vid <= vlan->vid_end; vid++) {
1665 rc = sja1105_vlan_apply(priv, port, vid, false, vlan->flags &
1666 BRIDGE_VLAN_INFO_UNTAGGED);
1668 dev_err(ds->dev, "Failed to remove VLAN %d from port %d: %d\n",
1676 /* The programming model for the SJA1105 switch is "all-at-once" via static
1677 * configuration tables. Some of these can be dynamically modified at runtime,
1678 * but not the xMII mode parameters table.
1679 * Furthermode, some PHYs may not have crystals for generating their clocks
1680 * (e.g. RMII). Instead, their 50MHz clock is supplied via the SJA1105 port's
1681 * ref_clk pin. So port clocking needs to be initialized early, before
1682 * connecting to PHYs is attempted, otherwise they won't respond through MDIO.
1683 * Setting correct PHY link speed does not matter now.
1684 * But dsa_slave_phy_setup is called later than sja1105_setup, so the PHY
1685 * bindings are not yet parsed by DSA core. We need to parse early so that we
1686 * can populate the xMII mode parameters table.
1688 static int sja1105_setup(struct dsa_switch *ds)
1690 struct sja1105_dt_port ports[SJA1105_NUM_PORTS];
1691 struct sja1105_private *priv = ds->priv;
1694 rc = sja1105_parse_dt(priv, ports);
1696 dev_err(ds->dev, "Failed to parse DT: %d\n", rc);
1700 /* Error out early if internal delays are required through DT
1701 * and we can't apply them.
1703 rc = sja1105_parse_rgmii_delays(priv, ports);
1705 dev_err(ds->dev, "RGMII delay not supported\n");
1709 rc = sja1105_ptp_clock_register(priv);
1711 dev_err(ds->dev, "Failed to register PTP clock: %d\n", rc);
1714 /* Create and send configuration down to device */
1715 rc = sja1105_static_config_load(priv, ports);
1717 dev_err(ds->dev, "Failed to load static config: %d\n", rc);
1720 /* Configure the CGU (PHY link modes and speeds) */
1721 rc = sja1105_clocking_setup(priv);
1723 dev_err(ds->dev, "Failed to configure MII clocking: %d\n", rc);
1726 /* On SJA1105, VLAN filtering per se is always enabled in hardware.
1727 * The only thing we can do to disable it is lie about what the 802.1Q
1729 * So it will still try to apply VLAN filtering, but all ingress
1730 * traffic (except frames received with EtherType of ETH_P_SJA1105)
1731 * will be internally tagged with a distorted VLAN header where the
1732 * TPID is ETH_P_SJA1105, and the VLAN ID is the port pvid.
1734 ds->vlan_filtering_is_global = true;
1736 /* The DSA/switchdev model brings up switch ports in standalone mode by
1737 * default, and that means vlan_filtering is 0 since they're not under
1738 * a bridge, so it's safe to set up switch tagging at this time.
1740 return sja1105_setup_8021q_tagging(ds, true);
1743 static void sja1105_teardown(struct dsa_switch *ds)
1745 struct sja1105_private *priv = ds->priv;
1747 cancel_work_sync(&priv->tagger_data.rxtstamp_work);
1748 skb_queue_purge(&priv->tagger_data.skb_rxtstamp_queue);
1751 static int sja1105_mgmt_xmit(struct dsa_switch *ds, int port, int slot,
1752 struct sk_buff *skb, bool takets)
1754 struct sja1105_mgmt_entry mgmt_route = {0};
1755 struct sja1105_private *priv = ds->priv;
1762 mgmt_route.macaddr = ether_addr_to_u64(hdr->h_dest);
1763 mgmt_route.destports = BIT(port);
1764 mgmt_route.enfport = 1;
1765 mgmt_route.tsreg = 0;
1766 mgmt_route.takets = takets;
1768 rc = sja1105_dynamic_config_write(priv, BLK_IDX_MGMT_ROUTE,
1769 slot, &mgmt_route, true);
1775 /* Transfer skb to the host port. */
1776 dsa_enqueue_skb(skb, ds->ports[port].slave);
1778 /* Wait until the switch has processed the frame */
1780 rc = sja1105_dynamic_config_read(priv, BLK_IDX_MGMT_ROUTE,
1783 dev_err_ratelimited(priv->ds->dev,
1784 "failed to poll for mgmt route\n");
1788 /* UM10944: The ENFPORT flag of the respective entry is
1789 * cleared when a match is found. The host can use this
1790 * flag as an acknowledgment.
1793 } while (mgmt_route.enfport && --timeout);
1796 /* Clean up the management route so that a follow-up
1797 * frame may not match on it by mistake.
1798 * This is only hardware supported on P/Q/R/S - on E/T it is
1799 * a no-op and we are silently discarding the -EOPNOTSUPP.
1801 sja1105_dynamic_config_write(priv, BLK_IDX_MGMT_ROUTE,
1802 slot, &mgmt_route, false);
1803 dev_err_ratelimited(priv->ds->dev, "xmit timed out\n");
1806 return NETDEV_TX_OK;
1809 /* Deferred work is unfortunately necessary because setting up the management
1810 * route cannot be done from atomit context (SPI transfer takes a sleepable
1813 static netdev_tx_t sja1105_port_deferred_xmit(struct dsa_switch *ds, int port,
1814 struct sk_buff *skb)
1816 struct sja1105_private *priv = ds->priv;
1817 struct sja1105_port *sp = &priv->ports[port];
1818 struct skb_shared_hwtstamps shwt = {0};
1819 int slot = sp->mgmt_slot;
1820 struct sk_buff *clone;
1824 /* The tragic fact about the switch having 4x2 slots for installing
1825 * management routes is that all of them except one are actually
1827 * If 2 slots are simultaneously configured for two BPDUs sent to the
1828 * same (multicast) DMAC but on different egress ports, the switch
1829 * would confuse them and redirect first frame it receives on the CPU
1830 * port towards the port configured on the numerically first slot
1831 * (therefore wrong port), then second received frame on second slot
1832 * (also wrong port).
1833 * So for all practical purposes, there needs to be a lock that
1834 * prevents that from happening. The slot used here is utterly useless
1835 * (could have simply been 0 just as fine), but we are doing it
1836 * nonetheless, in case a smarter idea ever comes up in the future.
1838 mutex_lock(&priv->mgmt_lock);
1840 /* The clone, if there, was made by dsa_skb_tx_timestamp */
1841 clone = DSA_SKB_CB(skb)->clone;
1843 sja1105_mgmt_xmit(ds, port, slot, skb, !!clone);
1848 skb_shinfo(clone)->tx_flags |= SKBTX_IN_PROGRESS;
1850 mutex_lock(&priv->ptp_lock);
1852 now = priv->tstamp_cc.read(&priv->tstamp_cc);
1854 rc = sja1105_ptpegr_ts_poll(priv, slot, &ts);
1856 dev_err(ds->dev, "xmit: timed out polling for tstamp\n");
1858 goto out_unlock_ptp;
1861 ts = sja1105_tstamp_reconstruct(priv, now, ts);
1862 ts = timecounter_cyc2time(&priv->tstamp_tc, ts);
1864 shwt.hwtstamp = ns_to_ktime(ts);
1865 skb_complete_tx_timestamp(clone, &shwt);
1868 mutex_unlock(&priv->ptp_lock);
1870 mutex_unlock(&priv->mgmt_lock);
1871 return NETDEV_TX_OK;
1874 /* The MAXAGE setting belongs to the L2 Forwarding Parameters table,
1875 * which cannot be reconfigured at runtime. So a switch reset is required.
1877 static int sja1105_set_ageing_time(struct dsa_switch *ds,
1878 unsigned int ageing_time)
1880 struct sja1105_l2_lookup_params_entry *l2_lookup_params;
1881 struct sja1105_private *priv = ds->priv;
1882 struct sja1105_table *table;
1883 unsigned int maxage;
1885 table = &priv->static_config.tables[BLK_IDX_L2_LOOKUP_PARAMS];
1886 l2_lookup_params = table->entries;
1888 maxage = SJA1105_AGEING_TIME_MS(ageing_time);
1890 if (l2_lookup_params->maxage == maxage)
1893 l2_lookup_params->maxage = maxage;
1895 return sja1105_static_config_reload(priv);
1898 /* Caller must hold priv->tagger_data.meta_lock */
1899 static int sja1105_change_rxtstamping(struct sja1105_private *priv,
1902 struct sja1105_general_params_entry *general_params;
1903 struct sja1105_table *table;
1906 table = &priv->static_config.tables[BLK_IDX_GENERAL_PARAMS];
1907 general_params = table->entries;
1908 general_params->send_meta1 = on;
1909 general_params->send_meta0 = on;
1911 rc = sja1105_init_avb_params(priv, on);
1915 /* Initialize the meta state machine to a known state */
1916 if (priv->tagger_data.stampable_skb) {
1917 kfree_skb(priv->tagger_data.stampable_skb);
1918 priv->tagger_data.stampable_skb = NULL;
1921 return sja1105_static_config_reload(priv);
1924 static int sja1105_hwtstamp_set(struct dsa_switch *ds, int port,
1927 struct sja1105_private *priv = ds->priv;
1928 struct hwtstamp_config config;
1932 if (copy_from_user(&config, ifr->ifr_data, sizeof(config)))
1935 switch (config.tx_type) {
1936 case HWTSTAMP_TX_OFF:
1937 priv->ports[port].hwts_tx_en = false;
1939 case HWTSTAMP_TX_ON:
1940 priv->ports[port].hwts_tx_en = true;
1946 switch (config.rx_filter) {
1947 case HWTSTAMP_FILTER_NONE:
1955 if (rx_on != priv->tagger_data.hwts_rx_en) {
1956 spin_lock(&priv->tagger_data.meta_lock);
1957 rc = sja1105_change_rxtstamping(priv, rx_on);
1958 spin_unlock(&priv->tagger_data.meta_lock);
1961 "Failed to change RX timestamping: %d\n", rc);
1964 priv->tagger_data.hwts_rx_en = rx_on;
1967 if (copy_to_user(ifr->ifr_data, &config, sizeof(config)))
1972 static int sja1105_hwtstamp_get(struct dsa_switch *ds, int port,
1975 struct sja1105_private *priv = ds->priv;
1976 struct hwtstamp_config config;
1979 if (priv->ports[port].hwts_tx_en)
1980 config.tx_type = HWTSTAMP_TX_ON;
1982 config.tx_type = HWTSTAMP_TX_OFF;
1983 if (priv->tagger_data.hwts_rx_en)
1984 config.rx_filter = HWTSTAMP_FILTER_PTP_V2_L2_EVENT;
1986 config.rx_filter = HWTSTAMP_FILTER_NONE;
1988 return copy_to_user(ifr->ifr_data, &config, sizeof(config)) ?
1992 #define to_tagger(d) \
1993 container_of((d), struct sja1105_tagger_data, rxtstamp_work)
1994 #define to_sja1105(d) \
1995 container_of((d), struct sja1105_private, tagger_data)
1997 static void sja1105_rxtstamp_work(struct work_struct *work)
1999 struct sja1105_tagger_data *data = to_tagger(work);
2000 struct sja1105_private *priv = to_sja1105(data);
2001 struct sk_buff *skb;
2004 mutex_lock(&priv->ptp_lock);
2006 now = priv->tstamp_cc.read(&priv->tstamp_cc);
2008 while ((skb = skb_dequeue(&data->skb_rxtstamp_queue)) != NULL) {
2009 struct skb_shared_hwtstamps *shwt = skb_hwtstamps(skb);
2012 *shwt = (struct skb_shared_hwtstamps) {0};
2014 ts = SJA1105_SKB_CB(skb)->meta_tstamp;
2015 ts = sja1105_tstamp_reconstruct(priv, now, ts);
2016 ts = timecounter_cyc2time(&priv->tstamp_tc, ts);
2018 shwt->hwtstamp = ns_to_ktime(ts);
2022 mutex_unlock(&priv->ptp_lock);
2025 /* Called from dsa_skb_defer_rx_timestamp */
2026 static bool sja1105_port_rxtstamp(struct dsa_switch *ds, int port,
2027 struct sk_buff *skb, unsigned int type)
2029 struct sja1105_private *priv = ds->priv;
2030 struct sja1105_tagger_data *data = &priv->tagger_data;
2032 if (!data->hwts_rx_en)
2035 /* We need to read the full PTP clock to reconstruct the Rx
2036 * timestamp. For that we need a sleepable context.
2038 skb_queue_tail(&data->skb_rxtstamp_queue, skb);
2039 schedule_work(&data->rxtstamp_work);
2043 /* Called from dsa_skb_tx_timestamp. This callback is just to make DSA clone
2044 * the skb and have it available in DSA_SKB_CB in the .port_deferred_xmit
2045 * callback, where we will timestamp it synchronously.
2047 static bool sja1105_port_txtstamp(struct dsa_switch *ds, int port,
2048 struct sk_buff *skb, unsigned int type)
2050 struct sja1105_private *priv = ds->priv;
2051 struct sja1105_port *sp = &priv->ports[port];
2053 if (!sp->hwts_tx_en)
2059 static const struct dsa_switch_ops sja1105_switch_ops = {
2060 .get_tag_protocol = sja1105_get_tag_protocol,
2061 .setup = sja1105_setup,
2062 .teardown = sja1105_teardown,
2063 .set_ageing_time = sja1105_set_ageing_time,
2064 .phylink_validate = sja1105_phylink_validate,
2065 .phylink_mac_config = sja1105_mac_config,
2066 .phylink_mac_link_up = sja1105_mac_link_up,
2067 .phylink_mac_link_down = sja1105_mac_link_down,
2068 .get_strings = sja1105_get_strings,
2069 .get_ethtool_stats = sja1105_get_ethtool_stats,
2070 .get_sset_count = sja1105_get_sset_count,
2071 .get_ts_info = sja1105_get_ts_info,
2072 .port_fdb_dump = sja1105_fdb_dump,
2073 .port_fdb_add = sja1105_fdb_add,
2074 .port_fdb_del = sja1105_fdb_del,
2075 .port_bridge_join = sja1105_bridge_join,
2076 .port_bridge_leave = sja1105_bridge_leave,
2077 .port_stp_state_set = sja1105_bridge_stp_state_set,
2078 .port_vlan_prepare = sja1105_vlan_prepare,
2079 .port_vlan_filtering = sja1105_vlan_filtering,
2080 .port_vlan_add = sja1105_vlan_add,
2081 .port_vlan_del = sja1105_vlan_del,
2082 .port_mdb_prepare = sja1105_mdb_prepare,
2083 .port_mdb_add = sja1105_mdb_add,
2084 .port_mdb_del = sja1105_mdb_del,
2085 .port_deferred_xmit = sja1105_port_deferred_xmit,
2086 .port_hwtstamp_get = sja1105_hwtstamp_get,
2087 .port_hwtstamp_set = sja1105_hwtstamp_set,
2088 .port_rxtstamp = sja1105_port_rxtstamp,
2089 .port_txtstamp = sja1105_port_txtstamp,
2092 static int sja1105_check_device_id(struct sja1105_private *priv)
2094 const struct sja1105_regs *regs = priv->info->regs;
2095 u8 prod_id[SJA1105_SIZE_DEVICE_ID] = {0};
2096 struct device *dev = &priv->spidev->dev;
2101 rc = sja1105_spi_send_int(priv, SPI_READ, regs->device_id,
2102 &device_id, SJA1105_SIZE_DEVICE_ID);
2106 if (device_id != priv->info->device_id) {
2107 dev_err(dev, "Expected device ID 0x%llx but read 0x%llx\n",
2108 priv->info->device_id, device_id);
2112 rc = sja1105_spi_send_packed_buf(priv, SPI_READ, regs->prod_id,
2113 prod_id, SJA1105_SIZE_DEVICE_ID);
2117 sja1105_unpack(prod_id, &part_no, 19, 4, SJA1105_SIZE_DEVICE_ID);
2119 if (part_no != priv->info->part_no) {
2120 dev_err(dev, "Expected part number 0x%llx but read 0x%llx\n",
2121 priv->info->part_no, part_no);
2128 static int sja1105_probe(struct spi_device *spi)
2130 struct sja1105_tagger_data *tagger_data;
2131 struct device *dev = &spi->dev;
2132 struct sja1105_private *priv;
2133 struct dsa_switch *ds;
2136 if (!dev->of_node) {
2137 dev_err(dev, "No DTS bindings for SJA1105 driver\n");
2141 priv = devm_kzalloc(dev, sizeof(struct sja1105_private), GFP_KERNEL);
2145 /* Configure the optional reset pin and bring up switch */
2146 priv->reset_gpio = devm_gpiod_get(dev, "reset", GPIOD_OUT_HIGH);
2147 if (IS_ERR(priv->reset_gpio))
2148 dev_dbg(dev, "reset-gpios not defined, ignoring\n");
2150 sja1105_hw_reset(priv->reset_gpio, 1, 1);
2152 /* Populate our driver private structure (priv) based on
2153 * the device tree node that was probed (spi)
2156 spi_set_drvdata(spi, priv);
2158 /* Configure the SPI bus */
2159 spi->bits_per_word = 8;
2160 rc = spi_setup(spi);
2162 dev_err(dev, "Could not init SPI\n");
2166 priv->info = of_device_get_match_data(dev);
2168 /* Detect hardware device */
2169 rc = sja1105_check_device_id(priv);
2171 dev_err(dev, "Device ID check failed: %d\n", rc);
2175 dev_info(dev, "Probed switch chip: %s\n", priv->info->name);
2177 ds = dsa_switch_alloc(dev, SJA1105_NUM_PORTS);
2181 ds->ops = &sja1105_switch_ops;
2185 tagger_data = &priv->tagger_data;
2186 skb_queue_head_init(&tagger_data->skb_rxtstamp_queue);
2187 INIT_WORK(&tagger_data->rxtstamp_work, sja1105_rxtstamp_work);
2189 /* Connections between dsa_port and sja1105_port */
2190 for (i = 0; i < SJA1105_NUM_PORTS; i++) {
2191 struct sja1105_port *sp = &priv->ports[i];
2193 ds->ports[i].priv = sp;
2194 sp->dp = &ds->ports[i];
2195 sp->data = tagger_data;
2197 mutex_init(&priv->mgmt_lock);
2199 return dsa_register_switch(priv->ds);
2202 static int sja1105_remove(struct spi_device *spi)
2204 struct sja1105_private *priv = spi_get_drvdata(spi);
2206 sja1105_ptp_clock_unregister(priv);
2207 dsa_unregister_switch(priv->ds);
2208 sja1105_static_config_free(&priv->static_config);
2212 static const struct of_device_id sja1105_dt_ids[] = {
2213 { .compatible = "nxp,sja1105e", .data = &sja1105e_info },
2214 { .compatible = "nxp,sja1105t", .data = &sja1105t_info },
2215 { .compatible = "nxp,sja1105p", .data = &sja1105p_info },
2216 { .compatible = "nxp,sja1105q", .data = &sja1105q_info },
2217 { .compatible = "nxp,sja1105r", .data = &sja1105r_info },
2218 { .compatible = "nxp,sja1105s", .data = &sja1105s_info },
2221 MODULE_DEVICE_TABLE(of, sja1105_dt_ids);
2223 static struct spi_driver sja1105_driver = {
2226 .owner = THIS_MODULE,
2227 .of_match_table = of_match_ptr(sja1105_dt_ids),
2229 .probe = sja1105_probe,
2230 .remove = sja1105_remove,
2233 module_spi_driver(sja1105_driver);
2235 MODULE_AUTHOR("Vladimir Oltean <olteanv@gmail.com>");
2236 MODULE_AUTHOR("Georg Waibel <georg.waibel@sensor-technik.de>");
2237 MODULE_DESCRIPTION("SJA1105 Driver");
2238 MODULE_LICENSE("GPL v2");