2 * Copyright (c) 2014-2015 Hisilicon Limited.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
10 #include <linux/acpi.h>
11 #include <linux/errno.h>
12 #include <linux/etherdevice.h>
13 #include <linux/init.h>
14 #include <linux/kernel.h>
15 #include <linux/mfd/syscon.h>
16 #include <linux/module.h>
17 #include <linux/mutex.h>
18 #include <linux/netdevice.h>
19 #include <linux/of_address.h>
21 #include <linux/of_mdio.h>
22 #include <linux/of_platform.h>
23 #include <linux/phy.h>
24 #include <linux/platform_device.h>
25 #include <linux/regmap.h>
26 #include <linux/spinlock_types.h>
28 #define MDIO_DRV_NAME "Hi-HNS_MDIO"
29 #define MDIO_BUS_NAME "Hisilicon MII Bus"
30 #define MDIO_DRV_VERSION "1.3.0"
31 #define MDIO_COPYRIGHT "Copyright(c) 2015 Huawei Corporation."
32 #define MDIO_DRV_STRING MDIO_BUS_NAME
33 #define MDIO_DEFAULT_DEVICE_DESCR MDIO_BUS_NAME
35 #define MDIO_CTL_DEV_ADDR(x) (x & 0x1f)
36 #define MDIO_CTL_PORT_ADDR(x) ((x & 0x1f) << 5)
38 #define MDIO_TIMEOUT 1000000
40 struct hns_mdio_sc_reg {
49 struct hns_mdio_device {
50 void *vbase; /* mdio reg base address */
51 struct regmap *subctrl_vbase;
52 struct hns_mdio_sc_reg sc_reg;
56 #define MDIO_COMMAND_REG 0x0
57 #define MDIO_ADDR_REG 0x4
58 #define MDIO_WDATA_REG 0x8
59 #define MDIO_RDATA_REG 0xc
60 #define MDIO_STA_REG 0x10
63 #define MDIO_CMD_DEVAD_M 0x1f
64 #define MDIO_CMD_DEVAD_S 0
65 #define MDIO_CMD_PRTAD_M 0x1f
66 #define MDIO_CMD_PRTAD_S 5
67 #define MDIO_CMD_OP_M 0x3
68 #define MDIO_CMD_OP_S 10
69 #define MDIO_CMD_ST_M 0x3
70 #define MDIO_CMD_ST_S 12
71 #define MDIO_CMD_START_B 14
73 #define MDIO_ADDR_DATA_M 0xffff
74 #define MDIO_ADDR_DATA_S 0
76 #define MDIO_WDATA_DATA_M 0xffff
77 #define MDIO_WDATA_DATA_S 0
79 #define MDIO_RDATA_DATA_M 0xffff
80 #define MDIO_RDATA_DATA_S 0
82 #define MDIO_STATE_STA_B 0
85 MDIO_ST_CLAUSE_45 = 0,
89 enum mdio_c22_op_seq {
94 enum mdio_c45_op_seq {
95 MDIO_C45_WRITE_ADDR = 0,
97 MDIO_C45_READ_INCREMENT,
101 /* peri subctrl reg */
102 #define MDIO_SC_CLK_EN 0x338
103 #define MDIO_SC_CLK_DIS 0x33C
104 #define MDIO_SC_RESET_REQ 0xA38
105 #define MDIO_SC_RESET_DREQ 0xA3C
106 #define MDIO_SC_CLK_ST 0x531C
107 #define MDIO_SC_RESET_ST 0x5A1C
109 static void mdio_write_reg(void *base, u32 reg, u32 value)
111 u8 __iomem *reg_addr = (u8 __iomem *)base;
113 writel_relaxed(value, reg_addr + reg);
116 #define MDIO_WRITE_REG(a, reg, value) \
117 mdio_write_reg((a)->vbase, (reg), (value))
119 static u32 mdio_read_reg(void *base, u32 reg)
121 u8 __iomem *reg_addr = (u8 __iomem *)base;
123 return readl_relaxed(reg_addr + reg);
126 #define mdio_set_field(origin, mask, shift, val) \
128 (origin) &= (~((mask) << (shift))); \
129 (origin) |= (((val) & (mask)) << (shift)); \
132 #define mdio_get_field(origin, mask, shift) (((origin) >> (shift)) & (mask))
134 static void mdio_set_reg_field(void *base, u32 reg, u32 mask, u32 shift,
137 u32 origin = mdio_read_reg(base, reg);
139 mdio_set_field(origin, mask, shift, val);
140 mdio_write_reg(base, reg, origin);
143 #define MDIO_SET_REG_FIELD(dev, reg, mask, shift, val) \
144 mdio_set_reg_field((dev)->vbase, (reg), (mask), (shift), (val))
146 static u32 mdio_get_reg_field(void *base, u32 reg, u32 mask, u32 shift)
150 origin = mdio_read_reg(base, reg);
151 return mdio_get_field(origin, mask, shift);
154 #define MDIO_GET_REG_FIELD(dev, reg, mask, shift) \
155 mdio_get_reg_field((dev)->vbase, (reg), (mask), (shift))
157 #define MDIO_GET_REG_BIT(dev, reg, bit) \
158 mdio_get_reg_field((dev)->vbase, (reg), 0x1ull, (bit))
160 #define MDIO_CHECK_SET_ST 1
161 #define MDIO_CHECK_CLR_ST 0
163 static int mdio_sc_cfg_reg_write(struct hns_mdio_device *mdio_dev,
164 u32 cfg_reg, u32 set_val,
165 u32 st_reg, u32 st_msk, u8 check_st)
171 regmap_write(mdio_dev->subctrl_vbase, cfg_reg, set_val);
173 for (time_cnt = MDIO_TIMEOUT; time_cnt; time_cnt--) {
174 ret = regmap_read(mdio_dev->subctrl_vbase, st_reg, ®_value);
179 if ((!!check_st) == (!!reg_value))
183 if ((!!check_st) != (!!reg_value))
189 static int hns_mdio_wait_ready(struct mii_bus *bus)
191 struct hns_mdio_device *mdio_dev = bus->priv;
193 u32 cmd_reg_value = 1;
195 /* waitting for MDIO_COMMAND_REG 's mdio_start==0 */
196 /* after that can do read or write*/
197 for (i = 0; cmd_reg_value; i++) {
198 cmd_reg_value = MDIO_GET_REG_BIT(mdio_dev,
201 if (i == MDIO_TIMEOUT)
208 static void hns_mdio_cmd_write(struct hns_mdio_device *mdio_dev,
209 u8 is_c45, u8 op, u8 phy_id, u16 cmd)
212 u8 st = is_c45 ? MDIO_ST_CLAUSE_45 : MDIO_ST_CLAUSE_22;
214 cmd_reg_value = st << MDIO_CMD_ST_S;
215 cmd_reg_value |= op << MDIO_CMD_OP_S;
217 (phy_id & MDIO_CMD_PRTAD_M) << MDIO_CMD_PRTAD_S;
218 cmd_reg_value |= (cmd & MDIO_CMD_DEVAD_M) << MDIO_CMD_DEVAD_S;
219 cmd_reg_value |= 1 << MDIO_CMD_START_B;
221 MDIO_WRITE_REG(mdio_dev, MDIO_COMMAND_REG, cmd_reg_value);
225 * hns_mdio_write - access phy register
228 * @regnum: register num
229 * @value: register value
231 * Return 0 on success, negative on failure
233 static int hns_mdio_write(struct mii_bus *bus,
234 int phy_id, int regnum, u16 data)
237 struct hns_mdio_device *mdio_dev = (struct hns_mdio_device *)bus->priv;
238 u8 devad = ((regnum >> 16) & 0x1f);
239 u8 is_c45 = !!(regnum & MII_ADDR_C45);
240 u16 reg = (u16)(regnum & 0xffff);
244 dev_dbg(&bus->dev, "mdio write %s,base is %p\n",
245 bus->id, mdio_dev->vbase);
246 dev_dbg(&bus->dev, "phy id=%d, is_c45=%d, devad=%d, reg=%#x, write data=%d\n",
247 phy_id, is_c45, devad, reg, data);
250 ret = hns_mdio_wait_ready(bus);
252 dev_err(&bus->dev, "MDIO bus is busy\n");
260 /* config the cmd-reg to write addr*/
261 MDIO_SET_REG_FIELD(mdio_dev, MDIO_ADDR_REG, MDIO_ADDR_DATA_M,
262 MDIO_ADDR_DATA_S, reg);
264 hns_mdio_cmd_write(mdio_dev, is_c45,
265 MDIO_C45_WRITE_ADDR, phy_id, devad);
267 /* check for read or write opt is finished */
268 ret = hns_mdio_wait_ready(bus);
270 dev_err(&bus->dev, "MDIO bus is busy\n");
274 /* config the data needed writing */
276 op = MDIO_C45_WRITE_ADDR;
279 MDIO_SET_REG_FIELD(mdio_dev, MDIO_WDATA_REG, MDIO_WDATA_DATA_M,
280 MDIO_WDATA_DATA_S, data);
282 hns_mdio_cmd_write(mdio_dev, is_c45, op, phy_id, cmd_reg_cfg);
288 * hns_mdio_read - access phy register
291 * @regnum: register num
292 * @value: register value
294 * Return phy register value
296 static int hns_mdio_read(struct mii_bus *bus, int phy_id, int regnum)
300 u8 devad = ((regnum >> 16) & 0x1f);
301 u8 is_c45 = !!(regnum & MII_ADDR_C45);
302 u16 reg = (u16)(regnum & 0xffff);
303 struct hns_mdio_device *mdio_dev = (struct hns_mdio_device *)bus->priv;
305 dev_dbg(&bus->dev, "mdio read %s,base is %p\n",
306 bus->id, mdio_dev->vbase);
307 dev_dbg(&bus->dev, "phy id=%d, is_c45=%d, devad=%d, reg=%#x!\n",
308 phy_id, is_c45, devad, reg);
310 /* Step 1: wait for ready */
311 ret = hns_mdio_wait_ready(bus);
313 dev_err(&bus->dev, "MDIO bus is busy\n");
318 hns_mdio_cmd_write(mdio_dev, is_c45,
319 MDIO_C22_READ, phy_id, reg);
321 MDIO_SET_REG_FIELD(mdio_dev, MDIO_ADDR_REG, MDIO_ADDR_DATA_M,
322 MDIO_ADDR_DATA_S, reg);
324 /* Step 2; config the cmd-reg to write addr*/
325 hns_mdio_cmd_write(mdio_dev, is_c45,
326 MDIO_C45_WRITE_ADDR, phy_id, devad);
328 /* Step 3: check for read or write opt is finished */
329 ret = hns_mdio_wait_ready(bus);
331 dev_err(&bus->dev, "MDIO bus is busy\n");
335 hns_mdio_cmd_write(mdio_dev, is_c45,
336 MDIO_C45_READ, phy_id, devad);
339 /* Step 5: waitting for MDIO_COMMAND_REG 's mdio_start==0,*/
340 /* check for read or write opt is finished */
341 ret = hns_mdio_wait_ready(bus);
343 dev_err(&bus->dev, "MDIO bus is busy\n");
347 reg_val = MDIO_GET_REG_BIT(mdio_dev, MDIO_STA_REG, MDIO_STATE_STA_B);
349 dev_err(&bus->dev, " ERROR! MDIO Read failed!\n");
353 /* Step 6; get out data*/
354 reg_val = (u16)MDIO_GET_REG_FIELD(mdio_dev, MDIO_RDATA_REG,
355 MDIO_RDATA_DATA_M, MDIO_RDATA_DATA_S);
361 * hns_mdio_reset - reset mdio bus
364 * Return 0 on success, negative on failure
366 static int hns_mdio_reset(struct mii_bus *bus)
368 struct hns_mdio_device *mdio_dev = (struct hns_mdio_device *)bus->priv;
369 const struct hns_mdio_sc_reg *sc_reg;
372 if (dev_of_node(bus->parent)) {
373 if (!mdio_dev->subctrl_vbase) {
374 dev_err(&bus->dev, "mdio sys ctl reg has not maped\n");
378 sc_reg = &mdio_dev->sc_reg;
379 /* 1. reset req, and read reset st check */
380 ret = mdio_sc_cfg_reg_write(mdio_dev, sc_reg->mdio_reset_req,
381 0x1, sc_reg->mdio_reset_st, 0x1,
384 dev_err(&bus->dev, "MDIO reset fail\n");
388 /* 2. dis clk, and read clk st check */
389 ret = mdio_sc_cfg_reg_write(mdio_dev, sc_reg->mdio_clk_dis,
390 0x1, sc_reg->mdio_clk_st, 0x1,
393 dev_err(&bus->dev, "MDIO dis clk fail\n");
397 /* 3. reset dreq, and read reset st check */
398 ret = mdio_sc_cfg_reg_write(mdio_dev, sc_reg->mdio_reset_dreq,
399 0x1, sc_reg->mdio_reset_st, 0x1,
402 dev_err(&bus->dev, "MDIO dis clk fail\n");
406 /* 4. en clk, and read clk st check */
407 ret = mdio_sc_cfg_reg_write(mdio_dev, sc_reg->mdio_clk_en,
408 0x1, sc_reg->mdio_clk_st, 0x1,
411 dev_err(&bus->dev, "MDIO en clk fail\n");
412 } else if (is_acpi_node(bus->parent->fwnode)) {
415 s = acpi_evaluate_object(ACPI_HANDLE(bus->parent),
417 if (ACPI_FAILURE(s)) {
418 dev_err(&bus->dev, "Reset failed, return:%#x\n", s);
424 dev_err(&bus->dev, "Can not get cfg data from DT or ACPI\n");
431 * hns_mdio_probe - probe mdio device
432 * @pdev: mdio platform device
434 * Return 0 on success, negative on failure
436 static int hns_mdio_probe(struct platform_device *pdev)
438 struct hns_mdio_device *mdio_dev;
439 struct mii_bus *new_bus;
440 struct resource *res;
444 dev_err(NULL, "pdev is NULL!\r\n");
448 mdio_dev = devm_kzalloc(&pdev->dev, sizeof(*mdio_dev), GFP_KERNEL);
452 new_bus = devm_mdiobus_alloc(&pdev->dev);
454 dev_err(&pdev->dev, "mdiobus_alloc fail!\n");
458 new_bus->name = MDIO_BUS_NAME;
459 new_bus->read = hns_mdio_read;
460 new_bus->write = hns_mdio_write;
461 new_bus->reset = hns_mdio_reset;
462 new_bus->priv = mdio_dev;
463 new_bus->parent = &pdev->dev;
465 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
466 mdio_dev->vbase = devm_ioremap_resource(&pdev->dev, res);
467 if (IS_ERR(mdio_dev->vbase)) {
468 ret = PTR_ERR(mdio_dev->vbase);
472 platform_set_drvdata(pdev, new_bus);
473 snprintf(new_bus->id, MII_BUS_ID_SIZE, "%s-%s", "Mii",
474 dev_name(&pdev->dev));
475 if (dev_of_node(&pdev->dev)) {
476 struct of_phandle_args reg_args;
478 ret = of_parse_phandle_with_fixed_args(pdev->dev.of_node,
484 mdio_dev->subctrl_vbase =
485 syscon_node_to_regmap(reg_args.np);
486 if (IS_ERR(mdio_dev->subctrl_vbase)) {
487 dev_warn(&pdev->dev, "syscon_node_to_regmap error\n");
488 mdio_dev->subctrl_vbase = NULL;
490 if (reg_args.args_count == 4) {
491 mdio_dev->sc_reg.mdio_clk_en =
492 (u16)reg_args.args[0];
493 mdio_dev->sc_reg.mdio_clk_dis =
494 (u16)reg_args.args[0] + 4;
495 mdio_dev->sc_reg.mdio_reset_req =
496 (u16)reg_args.args[1];
497 mdio_dev->sc_reg.mdio_reset_dreq =
498 (u16)reg_args.args[1] + 4;
499 mdio_dev->sc_reg.mdio_clk_st =
500 (u16)reg_args.args[2];
501 mdio_dev->sc_reg.mdio_reset_st =
502 (u16)reg_args.args[3];
505 mdio_dev->sc_reg.mdio_clk_en =
507 mdio_dev->sc_reg.mdio_clk_dis =
509 mdio_dev->sc_reg.mdio_reset_req =
511 mdio_dev->sc_reg.mdio_reset_dreq =
513 mdio_dev->sc_reg.mdio_clk_st =
515 mdio_dev->sc_reg.mdio_reset_st =
520 dev_warn(&pdev->dev, "find syscon ret = %#x\n", ret);
521 mdio_dev->subctrl_vbase = NULL;
524 ret = of_mdiobus_register(new_bus, pdev->dev.of_node);
525 } else if (is_acpi_node(pdev->dev.fwnode)) {
526 /* Clear all the IRQ properties */
527 memset(new_bus->irq, PHY_POLL, 4 * PHY_MAX_ADDR);
529 /* Mask out all PHYs from auto probing. */
530 new_bus->phy_mask = ~0;
532 /* Register the MDIO bus */
533 ret = mdiobus_register(new_bus);
535 dev_err(&pdev->dev, "Can not get cfg data from DT or ACPI\n");
540 dev_err(&pdev->dev, "Cannot register as MDIO bus!\n");
541 platform_set_drvdata(pdev, NULL);
549 * hns_mdio_remove - remove mdio device
550 * @pdev: mdio platform device
552 * Return 0 on success, negative on failure
554 static int hns_mdio_remove(struct platform_device *pdev)
558 bus = platform_get_drvdata(pdev);
560 mdiobus_unregister(bus);
561 platform_set_drvdata(pdev, NULL);
565 static const struct of_device_id hns_mdio_match[] = {
566 {.compatible = "hisilicon,mdio"},
567 {.compatible = "hisilicon,hns-mdio"},
570 MODULE_DEVICE_TABLE(of, hns_mdio_match);
572 static const struct acpi_device_id hns_mdio_acpi_match[] = {
576 MODULE_DEVICE_TABLE(acpi, hns_mdio_acpi_match);
578 static struct platform_driver hns_mdio_driver = {
579 .probe = hns_mdio_probe,
580 .remove = hns_mdio_remove,
582 .name = MDIO_DRV_NAME,
583 .of_match_table = hns_mdio_match,
584 .acpi_match_table = ACPI_PTR(hns_mdio_acpi_match),
588 module_platform_driver(hns_mdio_driver);
590 MODULE_LICENSE("GPL");
591 MODULE_AUTHOR("Huawei Tech. Co., Ltd.");
592 MODULE_DESCRIPTION("Hisilicon HNS MDIO driver");
593 MODULE_ALIAS("platform:" MDIO_DRV_NAME);