1 // SPDX-License-Identifier: GPL-2.0
2 /* Microchip LAN937X switch driver main logic
3 * Copyright (C) 2019-2022 Microchip Technology Inc.
5 #include <linux/kernel.h>
6 #include <linux/module.h>
7 #include <linux/iopoll.h>
9 #include <linux/of_net.h>
10 #include <linux/if_bridge.h>
11 #include <linux/if_vlan.h>
12 #include <linux/math.h>
14 #include <net/switchdev.h>
16 #include "lan937x_reg.h"
17 #include "ksz_common.h"
21 /* marker for ports without built-in PHY */
22 #define LAN937X_NO_PHY U8_MAX
25 * lan9370_phy_addr - Mapping of LAN9370 switch ports to PHY addresses.
27 * Each entry corresponds to a specific port on the LAN9370 switch,
28 * where ports 1-4 are connected to integrated 100BASE-T1 PHYs, and
29 * Port 5 is connected to an RGMII interface without a PHY. The values
30 * are based on the documentation (DS00003108E, section 3.3).
32 static const u8 lan9370_phy_addr
[] = {
33 [0] = 2, /* Port 1, T1 AFE0 */
34 [1] = 3, /* Port 2, T1 AFE1 */
35 [2] = 5, /* Port 3, T1 AFE3 */
36 [3] = 6, /* Port 4, T1 AFE4 */
37 [4] = LAN937X_NO_PHY
, /* Port 5, RGMII 2 */
41 * lan9371_phy_addr - Mapping of LAN9371 switch ports to PHY addresses.
43 * The values are based on the documentation (DS00003109E, section 3.3).
45 static const u8 lan9371_phy_addr
[] = {
46 [0] = 2, /* Port 1, T1 AFE0 */
47 [1] = 3, /* Port 2, T1 AFE1 */
48 [2] = 5, /* Port 3, T1 AFE3 */
49 [3] = 8, /* Port 4, TX PHY */
50 [4] = LAN937X_NO_PHY
, /* Port 5, RGMII 2 */
51 [5] = LAN937X_NO_PHY
, /* Port 6, RGMII 1 */
55 * lan9372_phy_addr - Mapping of LAN9372 switch ports to PHY addresses.
57 * The values are based on the documentation (DS00003110F, section 3.3).
59 static const u8 lan9372_phy_addr
[] = {
60 [0] = 2, /* Port 1, T1 AFE0 */
61 [1] = 3, /* Port 2, T1 AFE1 */
62 [2] = 5, /* Port 3, T1 AFE3 */
63 [3] = 8, /* Port 4, TX PHY */
64 [4] = LAN937X_NO_PHY
, /* Port 5, RGMII 2 */
65 [5] = LAN937X_NO_PHY
, /* Port 6, RGMII 1 */
66 [6] = 6, /* Port 7, T1 AFE4 */
67 [7] = 4, /* Port 8, T1 AFE2 */
71 * lan9373_phy_addr - Mapping of LAN9373 switch ports to PHY addresses.
73 * The values are based on the documentation (DS00003110F, section 3.3).
75 static const u8 lan9373_phy_addr
[] = {
76 [0] = 2, /* Port 1, T1 AFE0 */
77 [1] = 3, /* Port 2, T1 AFE1 */
78 [2] = 5, /* Port 3, T1 AFE3 */
79 [3] = LAN937X_NO_PHY
, /* Port 4, SGMII */
80 [4] = LAN937X_NO_PHY
, /* Port 5, RGMII 2 */
81 [5] = LAN937X_NO_PHY
, /* Port 6, RGMII 1 */
82 [6] = 6, /* Port 7, T1 AFE4 */
83 [7] = 4, /* Port 8, T1 AFE2 */
87 * lan9374_phy_addr - Mapping of LAN9374 switch ports to PHY addresses.
89 * The values are based on the documentation (DS00003110F, section 3.3).
91 static const u8 lan9374_phy_addr
[] = {
92 [0] = 2, /* Port 1, T1 AFE0 */
93 [1] = 3, /* Port 2, T1 AFE1 */
94 [2] = 5, /* Port 3, T1 AFE3 */
95 [3] = 7, /* Port 4, T1 AFE5 */
96 [4] = LAN937X_NO_PHY
, /* Port 5, RGMII 2 */
97 [5] = LAN937X_NO_PHY
, /* Port 6, RGMII 1 */
98 [6] = 6, /* Port 7, T1 AFE4 */
99 [7] = 4, /* Port 8, T1 AFE2 */
102 static int lan937x_cfg(struct ksz_device
*dev
, u32 addr
, u8 bits
, bool set
)
104 return regmap_update_bits(ksz_regmap_8(dev
), addr
, bits
, set
? bits
: 0);
107 static int lan937x_port_cfg(struct ksz_device
*dev
, int port
, int offset
,
110 return regmap_update_bits(ksz_regmap_8(dev
), PORT_CTRL_ADDR(port
, offset
),
111 bits
, set
? bits
: 0);
115 * lan937x_create_phy_addr_map - Create port-to-PHY address map for MDIO bus.
116 * @dev: Pointer to device structure.
117 * @side_mdio: Boolean indicating if the PHYs are accessed over a side MDIO bus.
119 * This function sets up the PHY address mapping for the LAN937x switches,
120 * which support two access modes for internal PHYs:
121 * 1. **SPI Access**: A straightforward one-to-one port-to-PHY address
122 * mapping is applied.
123 * 2. **MDIO Access**: The PHY address mapping varies based on chip variant
124 * and strap configuration. An offset is calculated based on strap settings
125 * to ensure correct PHY addresses are assigned. The offset calculation logic
126 * is based on Microchip's Article Number 000015828, available at:
127 * https://microchip.my.site.com/s/article/LAN9374-Virtual-PHY-PHY-Address-Mapping
129 * The function first checks if side MDIO access is disabled, in which case a
130 * simple direct mapping (port number = PHY address) is applied. If side MDIO
131 * access is enabled, it reads the strap configuration to determine the correct
132 * offset for PHY addresses.
134 * The appropriate mapping table is selected based on the chip ID, and the
135 * `phy_addr_map` is populated with the correct addresses for each port. Any
136 * port with no PHY is assigned a `LAN937X_NO_PHY` marker.
138 * Return: 0 on success, error code on failure.
140 int lan937x_create_phy_addr_map(struct ksz_device
*dev
, bool side_mdio
)
142 static const u8
*phy_addr_map
;
149 /* simple direct mapping */
150 for (i
= 0; i
< dev
->info
->port_cnt
; i
++)
151 dev
->phy_addr_map
[i
] = i
;
156 ret
= ksz_read32(dev
, REG_SW_CFG_STRAP_VAL
, &strap_val
);
160 if (!(strap_val
& SW_CASCADE_ID_CFG
) && !(strap_val
& SW_VPHY_ADD_CFG
))
162 else if (!(strap_val
& SW_CASCADE_ID_CFG
) && (strap_val
& SW_VPHY_ADD_CFG
))
164 else if ((strap_val
& SW_CASCADE_ID_CFG
) && !(strap_val
& SW_VPHY_ADD_CFG
))
169 switch (dev
->info
->chip_id
) {
170 case LAN9370_CHIP_ID
:
171 phy_addr_map
= lan9370_phy_addr
;
172 size
= ARRAY_SIZE(lan9370_phy_addr
);
174 case LAN9371_CHIP_ID
:
175 phy_addr_map
= lan9371_phy_addr
;
176 size
= ARRAY_SIZE(lan9371_phy_addr
);
178 case LAN9372_CHIP_ID
:
179 phy_addr_map
= lan9372_phy_addr
;
180 size
= ARRAY_SIZE(lan9372_phy_addr
);
182 case LAN9373_CHIP_ID
:
183 phy_addr_map
= lan9373_phy_addr
;
184 size
= ARRAY_SIZE(lan9373_phy_addr
);
186 case LAN9374_CHIP_ID
:
187 phy_addr_map
= lan9374_phy_addr
;
188 size
= ARRAY_SIZE(lan9374_phy_addr
);
194 if (size
< dev
->info
->port_cnt
)
197 for (i
= 0; i
< dev
->info
->port_cnt
; i
++) {
198 if (phy_addr_map
[i
] == LAN937X_NO_PHY
)
199 dev
->phy_addr_map
[i
] = phy_addr_map
[i
];
201 dev
->phy_addr_map
[i
] = phy_addr_map
[i
] + offset
;
208 * lan937x_mdio_bus_preinit - Pre-initialize MDIO bus for accessing PHYs.
209 * @dev: Pointer to device structure.
210 * @side_mdio: Boolean indicating if the PHYs are accessed over a side MDIO bus.
212 * This function configures the LAN937x switch for PHY access either through
213 * SPI or the side MDIO bus, unlocking the necessary registers for each access
217 * 1. **SPI Access**: Enables SPI indirect access to address clock domain
218 * crossing issues when SPI is used for PHY access.
219 * 2. **MDIO Access**: Grants access to internal PHYs over the side MDIO bus,
220 * required when using the MDIO bus for PHY management.
222 * Return: 0 on success, error code on failure.
224 int lan937x_mdio_bus_preinit(struct ksz_device
*dev
, bool side_mdio
)
229 /* Unlock access to the PHYs, needed for SPI and side MDIO access */
230 ret
= lan937x_cfg(dev
, REG_GLOBAL_CTRL_0
, SW_PHY_REG_BLOCK
, false);
235 /* Allow access to internal PHYs over MDIO bus */
236 data16
= VPHY_MDIO_INTERNAL_ENABLE
;
238 /* Enable SPI indirect access to address clock domain crossing
241 data16
= VPHY_SPI_INDIRECT_ENABLE
;
243 ret
= ksz_rmw16(dev
, REG_VPHY_SPECIAL_CTRL__2
,
244 VPHY_SPI_INDIRECT_ENABLE
| VPHY_MDIO_INTERNAL_ENABLE
,
249 dev_err(dev
->dev
, "failed to preinit the MDIO bus\n");
254 static int lan937x_vphy_ind_addr_wr(struct ksz_device
*dev
, int addr
, int reg
)
256 u16 addr_base
= REG_PORT_T1_PHY_CTRL_BASE
;
259 if (is_lan937x_tx_phy(dev
, addr
))
260 addr_base
= REG_PORT_TX_PHY_CTRL_BASE
;
262 /* get register address based on the logical port */
263 temp
= PORT_CTRL_ADDR(addr
, (addr_base
+ (reg
<< 2)));
265 return ksz_write16(dev
, REG_VPHY_IND_ADDR__2
, temp
);
268 static int lan937x_internal_phy_write(struct ksz_device
*dev
, int addr
, int reg
,
274 /* Check for internal phy port */
275 if (!dev
->info
->internal_phy
[addr
])
278 ret
= lan937x_vphy_ind_addr_wr(dev
, addr
, reg
);
282 /* Write the data to be written to the VPHY reg */
283 ret
= ksz_write16(dev
, REG_VPHY_IND_DATA__2
, val
);
287 /* Write the Write En and Busy bit */
288 ret
= ksz_write16(dev
, REG_VPHY_IND_CTRL__2
,
289 (VPHY_IND_WRITE
| VPHY_IND_BUSY
));
293 ret
= regmap_read_poll_timeout(ksz_regmap_16(dev
), REG_VPHY_IND_CTRL__2
,
294 value
, !(value
& VPHY_IND_BUSY
), 10,
297 dev_err(dev
->dev
, "Failed to write phy register\n");
304 static int lan937x_internal_phy_read(struct ksz_device
*dev
, int addr
, int reg
,
310 /* Check for internal phy port, return 0xffff for non-existent phy */
311 if (!dev
->info
->internal_phy
[addr
])
314 ret
= lan937x_vphy_ind_addr_wr(dev
, addr
, reg
);
318 /* Write Read and Busy bit to start the transaction */
319 ret
= ksz_write16(dev
, REG_VPHY_IND_CTRL__2
, VPHY_IND_BUSY
);
323 ret
= regmap_read_poll_timeout(ksz_regmap_16(dev
), REG_VPHY_IND_CTRL__2
,
324 value
, !(value
& VPHY_IND_BUSY
), 10,
327 dev_err(dev
->dev
, "Failed to read phy register\n");
331 /* Read the VPHY register which has the PHY data */
332 return ksz_read16(dev
, REG_VPHY_IND_DATA__2
, val
);
335 int lan937x_r_phy(struct ksz_device
*dev
, u16 addr
, u16 reg
, u16
*data
)
337 return lan937x_internal_phy_read(dev
, addr
, reg
, data
);
340 int lan937x_w_phy(struct ksz_device
*dev
, u16 addr
, u16 reg
, u16 val
)
342 return lan937x_internal_phy_write(dev
, addr
, reg
, val
);
345 int lan937x_reset_switch(struct ksz_device
*dev
)
351 ret
= lan937x_cfg(dev
, REG_SW_OPERATION
, SW_RESET
, true);
355 /* Enable Auto Aging */
356 ret
= lan937x_cfg(dev
, REG_SW_LUE_CTRL_1
, SW_LINK_AUTO_AGING
, true);
360 /* disable interrupts */
361 ret
= ksz_write32(dev
, REG_SW_INT_MASK__4
, SWITCH_INT_MASK
);
365 ret
= ksz_write32(dev
, REG_SW_INT_STATUS__4
, POR_READY_INT
);
369 ret
= ksz_write32(dev
, REG_SW_PORT_INT_MASK__4
, 0xFF);
373 return ksz_read32(dev
, REG_SW_PORT_INT_STATUS__4
, &data32
);
376 void lan937x_port_setup(struct ksz_device
*dev
, int port
, bool cpu_port
)
378 const u32
*masks
= dev
->info
->masks
;
379 const u16
*regs
= dev
->info
->regs
;
380 struct dsa_switch
*ds
= dev
->ds
;
383 /* enable tag tail for host port */
385 lan937x_port_cfg(dev
, port
, REG_PORT_CTRL_0
,
386 PORT_TAIL_TAG_ENABLE
, true);
388 /* Enable the Port Queue split */
389 ksz9477_port_queue_split(dev
, port
);
391 /* set back pressure for half duplex */
392 lan937x_port_cfg(dev
, port
, REG_PORT_MAC_CTRL_1
, PORT_BACK_PRESSURE
,
395 /* enable 802.1p priority */
396 lan937x_port_cfg(dev
, port
, P_PRIO_CTRL
, PORT_802_1P_PRIO_ENABLE
, true);
398 if (!dev
->info
->internal_phy
[port
])
399 lan937x_port_cfg(dev
, port
, regs
[P_XMII_CTRL_0
],
400 masks
[P_MII_TX_FLOW_CTRL
] |
401 masks
[P_MII_RX_FLOW_CTRL
],
405 member
= dsa_user_ports(ds
);
407 member
= BIT(dsa_upstream_port(ds
, port
));
409 dev
->dev_ops
->cfg_port_member(dev
, port
, member
);
412 void lan937x_config_cpu_port(struct dsa_switch
*ds
)
414 struct ksz_device
*dev
= ds
->priv
;
417 dsa_switch_for_each_cpu_port(dp
, ds
) {
418 if (dev
->info
->cpu_ports
& (1 << dp
->index
)) {
419 dev
->cpu_port
= dp
->index
;
421 /* enable cpu port */
422 lan937x_port_setup(dev
, dp
->index
, true);
426 dsa_switch_for_each_user_port(dp
, ds
) {
427 ksz_port_stp_state_set(ds
, dp
->index
, BR_STATE_DISABLED
);
431 int lan937x_change_mtu(struct ksz_device
*dev
, int port
, int new_mtu
)
433 struct dsa_switch
*ds
= dev
->ds
;
436 new_mtu
+= VLAN_ETH_HLEN
+ ETH_FCS_LEN
;
438 if (dsa_is_cpu_port(ds
, port
))
439 new_mtu
+= LAN937X_TAG_LEN
;
441 if (new_mtu
>= FR_MIN_SIZE
)
442 ret
= lan937x_port_cfg(dev
, port
, REG_PORT_MAC_CTRL_0
,
443 PORT_JUMBO_PACKET
, true);
445 ret
= lan937x_port_cfg(dev
, port
, REG_PORT_MAC_CTRL_0
,
446 PORT_JUMBO_PACKET
, false);
448 dev_err(ds
->dev
, "failed to enable jumbo\n");
452 /* Write the frame size in PORT_MAX_FR_SIZE register */
453 ret
= ksz_pwrite16(dev
, port
, PORT_MAX_FR_SIZE
, new_mtu
);
455 dev_err(ds
->dev
, "failed to update mtu for port %d\n", port
);
462 int lan937x_set_ageing_time(struct ksz_device
*dev
, unsigned int msecs
)
464 u32 secs
= msecs
/ 1000;
468 value
= FIELD_GET(SW_AGE_PERIOD_7_0_M
, secs
);
470 ret
= ksz_write8(dev
, REG_SW_AGE_PERIOD__1
, value
);
474 value
= FIELD_GET(SW_AGE_PERIOD_19_8_M
, secs
);
476 return ksz_write16(dev
, REG_SW_AGE_PERIOD__2
, value
);
479 static void lan937x_set_tune_adj(struct ksz_device
*dev
, int port
,
484 ksz_pread16(dev
, port
, reg
, &data16
);
486 /* Update tune Adjust */
487 data16
|= FIELD_PREP(PORT_TUNE_ADJ
, val
);
488 ksz_pwrite16(dev
, port
, reg
, data16
);
490 /* write DLL reset to take effect */
491 data16
|= PORT_DLL_RESET
;
492 ksz_pwrite16(dev
, port
, reg
, data16
);
495 static void lan937x_set_rgmii_tx_delay(struct ksz_device
*dev
, int port
)
499 /* Apply different codes based on the ports as per characterization
502 val
= (port
== LAN937X_RGMII_1_PORT
) ? RGMII_1_TX_DELAY_2NS
:
503 RGMII_2_TX_DELAY_2NS
;
505 lan937x_set_tune_adj(dev
, port
, REG_PORT_XMII_CTRL_5
, val
);
508 static void lan937x_set_rgmii_rx_delay(struct ksz_device
*dev
, int port
)
512 val
= (port
== LAN937X_RGMII_1_PORT
) ? RGMII_1_RX_DELAY_2NS
:
513 RGMII_2_RX_DELAY_2NS
;
515 lan937x_set_tune_adj(dev
, port
, REG_PORT_XMII_CTRL_4
, val
);
518 void lan937x_phylink_get_caps(struct ksz_device
*dev
, int port
,
519 struct phylink_config
*config
)
521 config
->mac_capabilities
= MAC_100FD
;
523 if (dev
->info
->supports_rgmii
[port
]) {
524 /* MII/RMII/RGMII ports */
525 config
->mac_capabilities
|= MAC_ASYM_PAUSE
| MAC_SYM_PAUSE
|
526 MAC_100HD
| MAC_10
| MAC_1000FD
;
527 } else if (is_lan937x_tx_phy(dev
, port
)) {
528 config
->mac_capabilities
|= MAC_ASYM_PAUSE
| MAC_SYM_PAUSE
|
533 void lan937x_setup_rgmii_delay(struct ksz_device
*dev
, int port
)
535 struct ksz_port
*p
= &dev
->ports
[port
];
537 if (p
->rgmii_tx_val
) {
538 lan937x_set_rgmii_tx_delay(dev
, port
);
539 dev_info(dev
->dev
, "Applied rgmii tx delay for the port %d\n",
543 if (p
->rgmii_rx_val
) {
544 lan937x_set_rgmii_rx_delay(dev
, port
);
545 dev_info(dev
->dev
, "Applied rgmii rx delay for the port %d\n",
550 int lan937x_tc_cbs_set_cinc(struct ksz_device
*dev
, int port
, u32 val
)
552 return ksz_pwrite32(dev
, port
, REG_PORT_MTI_CREDIT_INCREMENT
, val
);
555 int lan937x_switch_init(struct ksz_device
*dev
)
557 dev
->port_mask
= (1 << dev
->info
->port_cnt
) - 1;
562 int lan937x_setup(struct dsa_switch
*ds
)
564 struct ksz_device
*dev
= ds
->priv
;
567 /* The VLAN aware is a global setting. Mixed vlan
568 * filterings are not supported.
570 ds
->vlan_filtering_is_global
= true;
572 /* Enable aggressive back off for half duplex & UNH mode */
573 ret
= lan937x_cfg(dev
, REG_SW_MAC_CTRL_0
, (SW_PAUSE_UNH_MODE
|
575 SW_AGGR_BACKOFF
), true);
579 /* If NO_EXC_COLLISION_DROP bit is set, the switch will not drop
580 * packets when 16 or more collisions occur
582 ret
= lan937x_cfg(dev
, REG_SW_MAC_CTRL_1
, NO_EXC_COLLISION_DROP
, true);
586 /* enable global MIB counter freeze function */
587 ret
= lan937x_cfg(dev
, REG_SW_MAC_CTRL_6
, SW_MIB_COUNTER_FREEZE
, true);
591 /* disable CLK125 & CLK25, 1: disable, 0: enable */
592 ret
= lan937x_cfg(dev
, REG_SW_GLOBAL_OUTPUT_CTRL__1
,
593 (SW_CLK125_ENB
| SW_CLK25_ENB
), true);
597 /* Disable global VPHY support. Related to CPU interface only? */
598 return ksz_rmw32(dev
, REG_SW_CFG_STRAP_OVR
, SW_VPHY_DISABLE
,
602 void lan937x_teardown(struct dsa_switch
*ds
)
607 void lan937x_switch_exit(struct ksz_device
*dev
)
609 lan937x_reset_switch(dev
);
612 MODULE_AUTHOR("Arun Ramadoss <arun.ramadoss@microchip.com>");
613 MODULE_DESCRIPTION("Microchip LAN937x Series Switch DSA Driver");
614 MODULE_LICENSE("GPL");