1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2022 Schneider Electric
5 * Clément Léger <clement.leger@bootlin.com>
9 #include <linux/device.h>
10 #include <linux/mdio.h>
12 #include <linux/of_platform.h>
13 #include <linux/pcs-rzn1-miic.h>
14 #include <linux/phylink.h>
15 #include <linux/platform_device.h>
16 #include <linux/pm_runtime.h>
17 #include <dt-bindings/net/pcs-rzn1-miic.h>
19 #define MIIC_PRCMD 0x0
20 #define MIIC_ESID_CODE 0x4
22 #define MIIC_MODCTRL 0x20
23 #define MIIC_MODCTRL_SW_MODE GENMASK(4, 0)
25 #define MIIC_CONVCTRL(port) (0x100 + (port) * 4)
27 #define MIIC_CONVCTRL_CONV_SPEED GENMASK(1, 0)
28 #define CONV_MODE_10MBPS 0
29 #define CONV_MODE_100MBPS 1
30 #define CONV_MODE_1000MBPS 2
32 #define MIIC_CONVCTRL_CONV_MODE GENMASK(3, 2)
33 #define CONV_MODE_MII 0
34 #define CONV_MODE_RMII 1
35 #define CONV_MODE_RGMII 2
37 #define MIIC_CONVCTRL_FULLD BIT(8)
38 #define MIIC_CONVCTRL_RGMII_LINK BIT(12)
39 #define MIIC_CONVCTRL_RGMII_DUPLEX BIT(13)
40 #define MIIC_CONVCTRL_RGMII_SPEED GENMASK(15, 14)
42 #define MIIC_CONVRST 0x114
43 #define MIIC_CONVRST_PHYIF_RST(port) BIT(port)
44 #define MIIC_CONVRST_PHYIF_RST_MASK GENMASK(4, 0)
46 #define MIIC_SWCTRL 0x304
47 #define MIIC_SWDUPC 0x308
49 #define MIIC_MAX_NR_PORTS 5
51 #define MIIC_MODCTRL_CONF_CONV_NUM 6
52 #define MIIC_MODCTRL_CONF_NONE -1
55 * struct modctrl_match - Matching table entry for convctrl configuration
56 * See section 8.2.1 of manual.
57 * @mode_cfg: Configuration value for convctrl
58 * @conv: Configuration of ethernet port muxes. First index is SWITCH_PORTIN,
59 * then index 1 - 5 are CONV1 - CONV5.
61 struct modctrl_match {
63 u8 conv[MIIC_MODCTRL_CONF_CONV_NUM];
66 static struct modctrl_match modctrl_match_table[] = {
67 {0x0, {MIIC_RTOS_PORT, MIIC_GMAC1_PORT, MIIC_SWITCH_PORTD,
68 MIIC_SWITCH_PORTC, MIIC_SERCOS_PORTB, MIIC_SERCOS_PORTA}},
69 {0x1, {MIIC_RTOS_PORT, MIIC_GMAC1_PORT, MIIC_SWITCH_PORTD,
70 MIIC_SWITCH_PORTC, MIIC_ETHERCAT_PORTB, MIIC_ETHERCAT_PORTA}},
71 {0x2, {MIIC_RTOS_PORT, MIIC_GMAC1_PORT, MIIC_SWITCH_PORTD,
72 MIIC_ETHERCAT_PORTC, MIIC_ETHERCAT_PORTB, MIIC_ETHERCAT_PORTA}},
73 {0x3, {MIIC_RTOS_PORT, MIIC_GMAC1_PORT, MIIC_SWITCH_PORTD,
74 MIIC_SWITCH_PORTC, MIIC_SWITCH_PORTB, MIIC_SWITCH_PORTA}},
76 {0x8, {MIIC_RTOS_PORT, MIIC_GMAC1_PORT, MIIC_SWITCH_PORTD,
77 MIIC_SWITCH_PORTC, MIIC_SERCOS_PORTB, MIIC_SERCOS_PORTA}},
78 {0x9, {MIIC_RTOS_PORT, MIIC_GMAC1_PORT, MIIC_SWITCH_PORTD,
79 MIIC_SWITCH_PORTC, MIIC_ETHERCAT_PORTB, MIIC_ETHERCAT_PORTA}},
80 {0xA, {MIIC_RTOS_PORT, MIIC_GMAC1_PORT, MIIC_SWITCH_PORTD,
81 MIIC_ETHERCAT_PORTC, MIIC_ETHERCAT_PORTB, MIIC_ETHERCAT_PORTA}},
82 {0xB, {MIIC_RTOS_PORT, MIIC_GMAC1_PORT, MIIC_SWITCH_PORTD,
83 MIIC_SWITCH_PORTC, MIIC_SWITCH_PORTB, MIIC_SWITCH_PORTA}},
85 {0x10, {MIIC_GMAC2_PORT, MIIC_GMAC1_PORT, MIIC_SWITCH_PORTD,
86 MIIC_SWITCH_PORTC, MIIC_SERCOS_PORTB, MIIC_SERCOS_PORTA}},
87 {0x11, {MIIC_GMAC2_PORT, MIIC_GMAC1_PORT, MIIC_SWITCH_PORTD,
88 MIIC_SWITCH_PORTC, MIIC_ETHERCAT_PORTB, MIIC_ETHERCAT_PORTA}},
89 {0x12, {MIIC_GMAC2_PORT, MIIC_GMAC1_PORT, MIIC_SWITCH_PORTD,
90 MIIC_ETHERCAT_PORTC, MIIC_ETHERCAT_PORTB, MIIC_ETHERCAT_PORTA}},
91 {0x13, {MIIC_GMAC2_PORT, MIIC_GMAC1_PORT, MIIC_SWITCH_PORTD,
92 MIIC_SWITCH_PORTC, MIIC_SWITCH_PORTB, MIIC_SWITCH_PORTA}}
95 static const char * const conf_to_string[] = {
96 [MIIC_GMAC1_PORT] = "GMAC1_PORT",
97 [MIIC_GMAC2_PORT] = "GMAC2_PORT",
98 [MIIC_RTOS_PORT] = "RTOS_PORT",
99 [MIIC_SERCOS_PORTA] = "SERCOS_PORTA",
100 [MIIC_SERCOS_PORTB] = "SERCOS_PORTB",
101 [MIIC_ETHERCAT_PORTA] = "ETHERCAT_PORTA",
102 [MIIC_ETHERCAT_PORTB] = "ETHERCAT_PORTB",
103 [MIIC_ETHERCAT_PORTC] = "ETHERCAT_PORTC",
104 [MIIC_SWITCH_PORTA] = "SWITCH_PORTA",
105 [MIIC_SWITCH_PORTB] = "SWITCH_PORTB",
106 [MIIC_SWITCH_PORTC] = "SWITCH_PORTC",
107 [MIIC_SWITCH_PORTD] = "SWITCH_PORTD",
108 [MIIC_HSR_PORTA] = "HSR_PORTA",
109 [MIIC_HSR_PORTB] = "HSR_PORTB",
112 static const char *index_to_string[MIIC_MODCTRL_CONF_CONV_NUM] = {
122 * struct miic - MII converter structure
123 * @base: base address of the MII converter
124 * @dev: Device associated to the MII converter
125 * @lock: Lock used for read-modify-write access
134 * struct miic_port - Per port MII converter struct
135 * @miic: backiling to MII converter structure
136 * @pcs: PCS structure associated to the port
138 * @interface: interface mode of the port
142 struct phylink_pcs pcs;
144 phy_interface_t interface;
147 static struct miic_port *phylink_pcs_to_miic_port(struct phylink_pcs *pcs)
149 return container_of(pcs, struct miic_port, pcs);
152 static void miic_reg_writel(struct miic *miic, int offset, u32 value)
154 writel(value, miic->base + offset);
157 static u32 miic_reg_readl(struct miic *miic, int offset)
159 return readl(miic->base + offset);
162 static void miic_reg_rmw(struct miic *miic, int offset, u32 mask, u32 val)
166 spin_lock(&miic->lock);
168 reg = miic_reg_readl(miic, offset);
171 miic_reg_writel(miic, offset, reg);
173 spin_unlock(&miic->lock);
176 static void miic_converter_enable(struct miic *miic, int port, int enable)
181 val = MIIC_CONVRST_PHYIF_RST(port);
183 miic_reg_rmw(miic, MIIC_CONVRST, MIIC_CONVRST_PHYIF_RST(port), val);
186 static int miic_config(struct phylink_pcs *pcs, unsigned int mode,
187 phy_interface_t interface,
188 const unsigned long *advertising, bool permit)
190 struct miic_port *miic_port = phylink_pcs_to_miic_port(pcs);
191 struct miic *miic = miic_port->miic;
192 u32 speed, conv_mode, val, mask;
193 int port = miic_port->port;
196 case PHY_INTERFACE_MODE_RMII:
197 conv_mode = CONV_MODE_RMII;
198 speed = CONV_MODE_100MBPS;
200 case PHY_INTERFACE_MODE_RGMII:
201 case PHY_INTERFACE_MODE_RGMII_ID:
202 case PHY_INTERFACE_MODE_RGMII_TXID:
203 case PHY_INTERFACE_MODE_RGMII_RXID:
204 conv_mode = CONV_MODE_RGMII;
205 speed = CONV_MODE_1000MBPS;
207 case PHY_INTERFACE_MODE_MII:
208 conv_mode = CONV_MODE_MII;
209 /* When in MII mode, speed should be set to 0 (which is actually
212 speed = CONV_MODE_10MBPS;
218 val = FIELD_PREP(MIIC_CONVCTRL_CONV_MODE, conv_mode);
219 mask = MIIC_CONVCTRL_CONV_MODE;
221 /* Update speed only if we are going to change the interface because
222 * the link might already be up and it would break it if the speed is
225 if (interface != miic_port->interface) {
226 val |= FIELD_PREP(MIIC_CONVCTRL_CONV_SPEED, speed);
227 mask |= MIIC_CONVCTRL_CONV_SPEED;
228 miic_port->interface = interface;
231 miic_reg_rmw(miic, MIIC_CONVCTRL(port), mask, val);
232 miic_converter_enable(miic, miic_port->port, 1);
237 static void miic_link_up(struct phylink_pcs *pcs, unsigned int mode,
238 phy_interface_t interface, int speed, int duplex)
240 struct miic_port *miic_port = phylink_pcs_to_miic_port(pcs);
241 struct miic *miic = miic_port->miic;
242 u32 conv_speed = 0, val = 0;
243 int port = miic_port->port;
245 if (duplex == DUPLEX_FULL)
246 val |= MIIC_CONVCTRL_FULLD;
248 /* No speed in MII through-mode */
249 if (interface != PHY_INTERFACE_MODE_MII) {
252 conv_speed = CONV_MODE_1000MBPS;
255 conv_speed = CONV_MODE_100MBPS;
258 conv_speed = CONV_MODE_10MBPS;
265 val |= FIELD_PREP(MIIC_CONVCTRL_CONV_SPEED, conv_speed);
267 miic_reg_rmw(miic, MIIC_CONVCTRL(port),
268 (MIIC_CONVCTRL_CONV_SPEED | MIIC_CONVCTRL_FULLD), val);
271 static int miic_validate(struct phylink_pcs *pcs, unsigned long *supported,
272 const struct phylink_link_state *state)
274 if (phy_interface_mode_is_rgmii(state->interface) ||
275 state->interface == PHY_INTERFACE_MODE_RMII ||
276 state->interface == PHY_INTERFACE_MODE_MII)
282 static const struct phylink_pcs_ops miic_phylink_ops = {
283 .pcs_validate = miic_validate,
284 .pcs_config = miic_config,
285 .pcs_link_up = miic_link_up,
288 struct phylink_pcs *miic_create(struct device *dev, struct device_node *np)
290 struct platform_device *pdev;
291 struct miic_port *miic_port;
292 struct device_node *pcs_np;
296 if (!of_device_is_available(np))
297 return ERR_PTR(-ENODEV);
299 if (of_property_read_u32(np, "reg", &port))
300 return ERR_PTR(-EINVAL);
302 if (port > MIIC_MAX_NR_PORTS || port < 1)
303 return ERR_PTR(-EINVAL);
305 /* The PCS pdev is attached to the parent node */
306 pcs_np = of_get_parent(np);
308 return ERR_PTR(-ENODEV);
310 if (!of_device_is_available(pcs_np)) {
312 return ERR_PTR(-ENODEV);
315 pdev = of_find_device_by_node(pcs_np);
317 if (!pdev || !platform_get_drvdata(pdev)) {
319 put_device(&pdev->dev);
320 return ERR_PTR(-EPROBE_DEFER);
323 miic_port = kzalloc(sizeof(*miic_port), GFP_KERNEL);
325 put_device(&pdev->dev);
326 return ERR_PTR(-ENOMEM);
329 miic = platform_get_drvdata(pdev);
330 device_link_add(dev, miic->dev, DL_FLAG_AUTOREMOVE_CONSUMER);
331 put_device(&pdev->dev);
333 miic_port->miic = miic;
334 miic_port->port = port - 1;
335 miic_port->pcs.ops = &miic_phylink_ops;
337 return &miic_port->pcs;
339 EXPORT_SYMBOL(miic_create);
341 void miic_destroy(struct phylink_pcs *pcs)
343 struct miic_port *miic_port = phylink_pcs_to_miic_port(pcs);
345 miic_converter_enable(miic_port->miic, miic_port->port, 0);
348 EXPORT_SYMBOL(miic_destroy);
350 static int miic_init_hw(struct miic *miic, u32 cfg_mode)
354 /* Unlock write access to accessory registers (cf datasheet). If this
355 * is going to be used in conjunction with the Cortex-M3, this sequence
356 * will have to be moved in register write
358 miic_reg_writel(miic, MIIC_PRCMD, 0x00A5);
359 miic_reg_writel(miic, MIIC_PRCMD, 0x0001);
360 miic_reg_writel(miic, MIIC_PRCMD, 0xFFFE);
361 miic_reg_writel(miic, MIIC_PRCMD, 0x0001);
363 miic_reg_writel(miic, MIIC_MODCTRL,
364 FIELD_PREP(MIIC_MODCTRL_SW_MODE, cfg_mode));
366 for (port = 0; port < MIIC_MAX_NR_PORTS; port++) {
367 miic_converter_enable(miic, port, 0);
368 /* Disable speed/duplex control from these registers, datasheet
369 * says switch registers should be used to setup switch port
372 miic_reg_writel(miic, MIIC_SWCTRL, 0x0);
373 miic_reg_writel(miic, MIIC_SWDUPC, 0x0);
379 static bool miic_modctrl_match(s8 table_val[MIIC_MODCTRL_CONF_CONV_NUM],
380 s8 dt_val[MIIC_MODCTRL_CONF_CONV_NUM])
384 for (i = 0; i < MIIC_MODCTRL_CONF_CONV_NUM; i++) {
385 if (dt_val[i] == MIIC_MODCTRL_CONF_NONE)
388 if (dt_val[i] != table_val[i])
395 static void miic_dump_conf(struct device *dev,
396 s8 conf[MIIC_MODCTRL_CONF_CONV_NUM])
398 const char *conf_name;
401 for (i = 0; i < MIIC_MODCTRL_CONF_CONV_NUM; i++) {
402 if (conf[i] != MIIC_MODCTRL_CONF_NONE)
403 conf_name = conf_to_string[conf[i]];
407 dev_err(dev, "%s: %s\n", index_to_string[i], conf_name);
411 static int miic_match_dt_conf(struct device *dev,
412 s8 dt_val[MIIC_MODCTRL_CONF_CONV_NUM],
415 struct modctrl_match *table_entry;
418 for (i = 0; i < ARRAY_SIZE(modctrl_match_table); i++) {
419 table_entry = &modctrl_match_table[i];
421 if (miic_modctrl_match(table_entry->conv, dt_val)) {
422 *mode_cfg = table_entry->mode_cfg;
427 dev_err(dev, "Failed to apply requested configuration\n");
428 miic_dump_conf(dev, dt_val);
433 static int miic_parse_dt(struct device *dev, u32 *mode_cfg)
435 s8 dt_val[MIIC_MODCTRL_CONF_CONV_NUM];
436 struct device_node *np = dev->of_node;
437 struct device_node *conv;
441 memset(dt_val, MIIC_MODCTRL_CONF_NONE, sizeof(dt_val));
443 if (of_property_read_u32(np, "renesas,miic-switch-portin", &conf) == 0)
446 for_each_child_of_node(np, conv) {
447 if (of_property_read_u32(conv, "reg", &port))
450 if (!of_device_is_available(conv))
453 if (of_property_read_u32(conv, "renesas,miic-input", &conf) == 0)
457 return miic_match_dt_conf(dev, dt_val, mode_cfg);
460 static int miic_probe(struct platform_device *pdev)
462 struct device *dev = &pdev->dev;
467 ret = miic_parse_dt(dev, &mode_cfg);
471 miic = devm_kzalloc(dev, sizeof(*miic), GFP_KERNEL);
475 spin_lock_init(&miic->lock);
477 miic->base = devm_platform_ioremap_resource(pdev, 0);
478 if (IS_ERR(miic->base))
479 return PTR_ERR(miic->base);
481 ret = devm_pm_runtime_enable(dev);
485 ret = pm_runtime_resume_and_get(dev);
489 ret = miic_init_hw(miic, mode_cfg);
491 goto disable_runtime_pm;
493 /* miic_create() relies on that fact that data are attached to the
494 * platform device to determine if the driver is ready so this needs to
495 * be the last thing to be done after everything is initialized
498 platform_set_drvdata(pdev, miic);
508 static void miic_remove(struct platform_device *pdev)
510 pm_runtime_put(&pdev->dev);
513 static const struct of_device_id miic_of_mtable[] = {
514 { .compatible = "renesas,rzn1-miic" },
517 MODULE_DEVICE_TABLE(of, miic_of_mtable);
519 static struct platform_driver miic_driver = {
522 .suppress_bind_attrs = true,
523 .of_match_table = miic_of_mtable,
526 .remove_new = miic_remove,
528 module_platform_driver(miic_driver);
530 MODULE_LICENSE("GPL");
531 MODULE_DESCRIPTION("Renesas MII converter PCS driver");
532 MODULE_AUTHOR("Clément Léger <clement.leger@bootlin.com>");