1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (c) 2014-2015 Hisilicon Limited.
6 #include <linux/acpi.h>
7 #include <linux/errno.h>
8 #include <linux/etherdevice.h>
9 #include <linux/init.h>
10 #include <linux/kernel.h>
11 #include <linux/mfd/syscon.h>
12 #include <linux/module.h>
13 #include <linux/mutex.h>
14 #include <linux/netdevice.h>
15 #include <linux/of_address.h>
17 #include <linux/of_mdio.h>
18 #include <linux/of_platform.h>
19 #include <linux/phy.h>
20 #include <linux/platform_device.h>
21 #include <linux/regmap.h>
23 #define MDIO_DRV_NAME "Hi-HNS_MDIO"
24 #define MDIO_BUS_NAME "Hisilicon MII Bus"
26 #define MDIO_TIMEOUT 1000000
28 struct hns_mdio_sc_reg
{
37 struct hns_mdio_device
{
38 u8 __iomem
*vbase
; /* mdio reg base address */
39 struct regmap
*subctrl_vbase
;
40 struct hns_mdio_sc_reg sc_reg
;
44 #define MDIO_COMMAND_REG 0x0
45 #define MDIO_ADDR_REG 0x4
46 #define MDIO_WDATA_REG 0x8
47 #define MDIO_RDATA_REG 0xc
48 #define MDIO_STA_REG 0x10
51 #define MDIO_CMD_DEVAD_M 0x1f
52 #define MDIO_CMD_DEVAD_S 0
53 #define MDIO_CMD_PRTAD_M 0x1f
54 #define MDIO_CMD_PRTAD_S 5
55 #define MDIO_CMD_OP_S 10
56 #define MDIO_CMD_ST_S 12
57 #define MDIO_CMD_START_B 14
59 #define MDIO_ADDR_DATA_M 0xffff
60 #define MDIO_ADDR_DATA_S 0
62 #define MDIO_WDATA_DATA_M 0xffff
63 #define MDIO_WDATA_DATA_S 0
65 #define MDIO_RDATA_DATA_M 0xffff
66 #define MDIO_RDATA_DATA_S 0
68 #define MDIO_STATE_STA_B 0
71 MDIO_ST_CLAUSE_45
= 0,
75 enum mdio_c22_op_seq
{
80 enum mdio_c45_op_seq
{
81 MDIO_C45_WRITE_ADDR
= 0,
83 MDIO_C45_READ_INCREMENT
,
87 /* peri subctrl reg */
88 #define MDIO_SC_CLK_EN 0x338
89 #define MDIO_SC_CLK_DIS 0x33C
90 #define MDIO_SC_RESET_REQ 0xA38
91 #define MDIO_SC_RESET_DREQ 0xA3C
92 #define MDIO_SC_CLK_ST 0x531C
93 #define MDIO_SC_RESET_ST 0x5A1C
95 static void mdio_write_reg(u8 __iomem
*base
, u32 reg
, u32 value
)
97 writel_relaxed(value
, base
+ reg
);
100 #define MDIO_WRITE_REG(a, reg, value) \
101 mdio_write_reg((a)->vbase, (reg), (value))
103 static u32
mdio_read_reg(u8 __iomem
*base
, u32 reg
)
105 return readl_relaxed(base
+ reg
);
108 #define mdio_set_field(origin, mask, shift, val) \
110 (origin) &= (~((mask) << (shift))); \
111 (origin) |= (((val) & (mask)) << (shift)); \
114 #define mdio_get_field(origin, mask, shift) (((origin) >> (shift)) & (mask))
116 static void mdio_set_reg_field(u8 __iomem
*base
, u32 reg
, u32 mask
, u32 shift
,
119 u32 origin
= mdio_read_reg(base
, reg
);
121 mdio_set_field(origin
, mask
, shift
, val
);
122 mdio_write_reg(base
, reg
, origin
);
125 #define MDIO_SET_REG_FIELD(dev, reg, mask, shift, val) \
126 mdio_set_reg_field((dev)->vbase, (reg), (mask), (shift), (val))
128 static u32
mdio_get_reg_field(u8 __iomem
*base
, u32 reg
, u32 mask
, u32 shift
)
132 origin
= mdio_read_reg(base
, reg
);
133 return mdio_get_field(origin
, mask
, shift
);
136 #define MDIO_GET_REG_FIELD(dev, reg, mask, shift) \
137 mdio_get_reg_field((dev)->vbase, (reg), (mask), (shift))
139 #define MDIO_GET_REG_BIT(dev, reg, bit) \
140 mdio_get_reg_field((dev)->vbase, (reg), 0x1ull, (bit))
142 #define MDIO_CHECK_SET_ST 1
143 #define MDIO_CHECK_CLR_ST 0
145 static int mdio_sc_cfg_reg_write(struct hns_mdio_device
*mdio_dev
,
146 u32 cfg_reg
, u32 set_val
,
147 u32 st_reg
, u32 st_msk
, u8 check_st
)
153 regmap_write(mdio_dev
->subctrl_vbase
, cfg_reg
, set_val
);
155 for (time_cnt
= MDIO_TIMEOUT
; time_cnt
; time_cnt
--) {
156 ret
= regmap_read(mdio_dev
->subctrl_vbase
, st_reg
, ®_value
);
161 if ((!!check_st
) == (!!reg_value
))
165 if ((!!check_st
) != (!!reg_value
))
171 static int hns_mdio_wait_ready(struct mii_bus
*bus
)
173 struct hns_mdio_device
*mdio_dev
= bus
->priv
;
177 /* waiting for MDIO_COMMAND_REG's mdio_start==0 */
178 /* after that can do read or write*/
179 for (i
= 0; i
< MDIO_TIMEOUT
; i
++) {
180 cmd_reg_value
= MDIO_GET_REG_BIT(mdio_dev
,
186 if ((i
== MDIO_TIMEOUT
) && cmd_reg_value
)
192 static void hns_mdio_cmd_write(struct hns_mdio_device
*mdio_dev
,
193 u8 is_c45
, u8 op
, u8 phy_id
, u16 cmd
)
196 u8 st
= is_c45
? MDIO_ST_CLAUSE_45
: MDIO_ST_CLAUSE_22
;
198 cmd_reg_value
= st
<< MDIO_CMD_ST_S
;
199 cmd_reg_value
|= op
<< MDIO_CMD_OP_S
;
201 (phy_id
& MDIO_CMD_PRTAD_M
) << MDIO_CMD_PRTAD_S
;
202 cmd_reg_value
|= (cmd
& MDIO_CMD_DEVAD_M
) << MDIO_CMD_DEVAD_S
;
203 cmd_reg_value
|= 1 << MDIO_CMD_START_B
;
205 MDIO_WRITE_REG(mdio_dev
, MDIO_COMMAND_REG
, cmd_reg_value
);
209 * hns_mdio_write_c22 - access phy register
212 * @regnum: register num
213 * @data: register value
215 * Return 0 on success, negative on failure
217 static int hns_mdio_write_c22(struct mii_bus
*bus
,
218 int phy_id
, int regnum
, u16 data
)
220 struct hns_mdio_device
*mdio_dev
= bus
->priv
;
221 u16 reg
= (u16
)(regnum
& 0xffff);
226 dev_dbg(&bus
->dev
, "mdio write %s,base is %p\n",
227 bus
->id
, mdio_dev
->vbase
);
228 dev_dbg(&bus
->dev
, "phy id=%d, reg=%#x, write data=%d\n",
232 ret
= hns_mdio_wait_ready(bus
);
234 dev_err(&bus
->dev
, "MDIO bus is busy\n");
241 MDIO_SET_REG_FIELD(mdio_dev
, MDIO_WDATA_REG
, MDIO_WDATA_DATA_M
,
242 MDIO_WDATA_DATA_S
, data
);
244 hns_mdio_cmd_write(mdio_dev
, false, op
, phy_id
, cmd_reg_cfg
);
250 * hns_mdio_write_c45 - access phy register
253 * @devad: device address to read
254 * @regnum: register num
255 * @data: register value
257 * Return 0 on success, negative on failure
259 static int hns_mdio_write_c45(struct mii_bus
*bus
, int phy_id
, int devad
,
260 int regnum
, u16 data
)
262 struct hns_mdio_device
*mdio_dev
= bus
->priv
;
263 u16 reg
= (u16
)(regnum
& 0xffff);
268 dev_dbg(&bus
->dev
, "mdio write %s,base is %p\n",
269 bus
->id
, mdio_dev
->vbase
);
270 dev_dbg(&bus
->dev
, "phy id=%d, devad=%d, reg=%#x, write data=%d\n",
271 phy_id
, devad
, reg
, data
);
274 ret
= hns_mdio_wait_ready(bus
);
276 dev_err(&bus
->dev
, "MDIO bus is busy\n");
280 /* config the cmd-reg to write addr*/
281 MDIO_SET_REG_FIELD(mdio_dev
, MDIO_ADDR_REG
, MDIO_ADDR_DATA_M
,
282 MDIO_ADDR_DATA_S
, reg
);
284 hns_mdio_cmd_write(mdio_dev
, true, MDIO_C45_WRITE_ADDR
, phy_id
, devad
);
286 /* check for read or write opt is finished */
287 ret
= hns_mdio_wait_ready(bus
);
289 dev_err(&bus
->dev
, "MDIO bus is busy\n");
293 /* config the data needed writing */
295 op
= MDIO_C45_WRITE_DATA
;
297 MDIO_SET_REG_FIELD(mdio_dev
, MDIO_WDATA_REG
, MDIO_WDATA_DATA_M
,
298 MDIO_WDATA_DATA_S
, data
);
300 hns_mdio_cmd_write(mdio_dev
, true, op
, phy_id
, cmd_reg_cfg
);
306 * hns_mdio_read_c22 - access phy register
309 * @regnum: register num
311 * Return phy register value
313 static int hns_mdio_read_c22(struct mii_bus
*bus
, int phy_id
, int regnum
)
315 struct hns_mdio_device
*mdio_dev
= bus
->priv
;
316 u16 reg
= (u16
)(regnum
& 0xffff);
320 dev_dbg(&bus
->dev
, "mdio read %s,base is %p\n",
321 bus
->id
, mdio_dev
->vbase
);
322 dev_dbg(&bus
->dev
, "phy id=%d, reg=%#x!\n", phy_id
, reg
);
324 /* Step 1: wait for ready */
325 ret
= hns_mdio_wait_ready(bus
);
327 dev_err(&bus
->dev
, "MDIO bus is busy\n");
331 hns_mdio_cmd_write(mdio_dev
, false, MDIO_C22_READ
, phy_id
, reg
);
333 /* Step 2: waiting for MDIO_COMMAND_REG 's mdio_start==0,*/
334 /* check for read or write opt is finished */
335 ret
= hns_mdio_wait_ready(bus
);
337 dev_err(&bus
->dev
, "MDIO bus is busy\n");
341 reg_val
= MDIO_GET_REG_BIT(mdio_dev
, MDIO_STA_REG
, MDIO_STATE_STA_B
);
343 dev_err(&bus
->dev
, " ERROR! MDIO Read failed!\n");
347 /* Step 3; get out data*/
348 reg_val
= (u16
)MDIO_GET_REG_FIELD(mdio_dev
, MDIO_RDATA_REG
,
349 MDIO_RDATA_DATA_M
, MDIO_RDATA_DATA_S
);
355 * hns_mdio_read_c45 - access phy register
358 * @devad: device address to read
359 * @regnum: register num
361 * Return phy register value
363 static int hns_mdio_read_c45(struct mii_bus
*bus
, int phy_id
, int devad
,
366 struct hns_mdio_device
*mdio_dev
= bus
->priv
;
367 u16 reg
= (u16
)(regnum
& 0xffff);
371 dev_dbg(&bus
->dev
, "mdio read %s,base is %p\n",
372 bus
->id
, mdio_dev
->vbase
);
373 dev_dbg(&bus
->dev
, "phy id=%d, devad=%d, reg=%#x!\n",
376 /* Step 1: wait for ready */
377 ret
= hns_mdio_wait_ready(bus
);
379 dev_err(&bus
->dev
, "MDIO bus is busy\n");
383 MDIO_SET_REG_FIELD(mdio_dev
, MDIO_ADDR_REG
, MDIO_ADDR_DATA_M
,
384 MDIO_ADDR_DATA_S
, reg
);
386 /* Step 2; config the cmd-reg to write addr*/
387 hns_mdio_cmd_write(mdio_dev
, true, MDIO_C45_WRITE_ADDR
, phy_id
, devad
);
389 /* Step 3: check for read or write opt is finished */
390 ret
= hns_mdio_wait_ready(bus
);
392 dev_err(&bus
->dev
, "MDIO bus is busy\n");
396 hns_mdio_cmd_write(mdio_dev
, true, MDIO_C45_READ
, phy_id
, devad
);
398 /* Step 5: waiting for MDIO_COMMAND_REG 's mdio_start==0,*/
399 /* check for read or write opt is finished */
400 ret
= hns_mdio_wait_ready(bus
);
402 dev_err(&bus
->dev
, "MDIO bus is busy\n");
406 reg_val
= MDIO_GET_REG_BIT(mdio_dev
, MDIO_STA_REG
, MDIO_STATE_STA_B
);
408 dev_err(&bus
->dev
, " ERROR! MDIO Read failed!\n");
412 /* Step 6; get out data*/
413 reg_val
= (u16
)MDIO_GET_REG_FIELD(mdio_dev
, MDIO_RDATA_REG
,
414 MDIO_RDATA_DATA_M
, MDIO_RDATA_DATA_S
);
420 * hns_mdio_reset - reset mdio bus
423 * Return 0 on success, negative on failure
425 static int hns_mdio_reset(struct mii_bus
*bus
)
427 struct hns_mdio_device
*mdio_dev
= bus
->priv
;
428 const struct hns_mdio_sc_reg
*sc_reg
;
431 if (dev_of_node(bus
->parent
)) {
432 if (!mdio_dev
->subctrl_vbase
) {
433 dev_err(&bus
->dev
, "mdio sys ctl reg has not mapped\n");
437 sc_reg
= &mdio_dev
->sc_reg
;
438 /* 1. reset req, and read reset st check */
439 ret
= mdio_sc_cfg_reg_write(mdio_dev
, sc_reg
->mdio_reset_req
,
440 0x1, sc_reg
->mdio_reset_st
, 0x1,
443 dev_err(&bus
->dev
, "MDIO reset fail\n");
447 /* 2. dis clk, and read clk st check */
448 ret
= mdio_sc_cfg_reg_write(mdio_dev
, sc_reg
->mdio_clk_dis
,
449 0x1, sc_reg
->mdio_clk_st
, 0x1,
452 dev_err(&bus
->dev
, "MDIO dis clk fail\n");
456 /* 3. reset dreq, and read reset st check */
457 ret
= mdio_sc_cfg_reg_write(mdio_dev
, sc_reg
->mdio_reset_dreq
,
458 0x1, sc_reg
->mdio_reset_st
, 0x1,
461 dev_err(&bus
->dev
, "MDIO dis clk fail\n");
465 /* 4. en clk, and read clk st check */
466 ret
= mdio_sc_cfg_reg_write(mdio_dev
, sc_reg
->mdio_clk_en
,
467 0x1, sc_reg
->mdio_clk_st
, 0x1,
470 dev_err(&bus
->dev
, "MDIO en clk fail\n");
471 } else if (is_acpi_node(bus
->parent
->fwnode
)) {
474 s
= acpi_evaluate_object(ACPI_HANDLE(bus
->parent
),
476 if (ACPI_FAILURE(s
)) {
477 dev_err(&bus
->dev
, "Reset failed, return:%#x\n", s
);
483 dev_err(&bus
->dev
, "Can not get cfg data from DT or ACPI\n");
490 * hns_mdio_probe - probe mdio device
491 * @pdev: mdio platform device
493 * Return 0 on success, negative on failure
495 static int hns_mdio_probe(struct platform_device
*pdev
)
497 struct hns_mdio_device
*mdio_dev
;
498 struct mii_bus
*new_bus
;
502 dev_err(NULL
, "pdev is NULL!\r\n");
506 mdio_dev
= devm_kzalloc(&pdev
->dev
, sizeof(*mdio_dev
), GFP_KERNEL
);
510 new_bus
= devm_mdiobus_alloc(&pdev
->dev
);
512 dev_err(&pdev
->dev
, "mdiobus_alloc fail!\n");
516 new_bus
->name
= MDIO_BUS_NAME
;
517 new_bus
->read
= hns_mdio_read_c22
;
518 new_bus
->write
= hns_mdio_write_c22
;
519 new_bus
->read_c45
= hns_mdio_read_c45
;
520 new_bus
->write_c45
= hns_mdio_write_c45
;
521 new_bus
->reset
= hns_mdio_reset
;
522 new_bus
->priv
= mdio_dev
;
523 new_bus
->parent
= &pdev
->dev
;
525 mdio_dev
->vbase
= devm_platform_ioremap_resource(pdev
, 0);
526 if (IS_ERR(mdio_dev
->vbase
)) {
527 ret
= PTR_ERR(mdio_dev
->vbase
);
531 platform_set_drvdata(pdev
, new_bus
);
532 snprintf(new_bus
->id
, MII_BUS_ID_SIZE
, "%s-%s", "Mii",
533 dev_name(&pdev
->dev
));
534 if (dev_of_node(&pdev
->dev
)) {
535 struct of_phandle_args reg_args
;
537 ret
= of_parse_phandle_with_fixed_args(pdev
->dev
.of_node
,
543 mdio_dev
->subctrl_vbase
=
544 syscon_node_to_regmap(reg_args
.np
);
545 if (IS_ERR(mdio_dev
->subctrl_vbase
)) {
546 dev_warn(&pdev
->dev
, "syscon_node_to_regmap error\n");
547 mdio_dev
->subctrl_vbase
= NULL
;
549 if (reg_args
.args_count
== 4) {
550 mdio_dev
->sc_reg
.mdio_clk_en
=
551 (u16
)reg_args
.args
[0];
552 mdio_dev
->sc_reg
.mdio_clk_dis
=
553 (u16
)reg_args
.args
[0] + 4;
554 mdio_dev
->sc_reg
.mdio_reset_req
=
555 (u16
)reg_args
.args
[1];
556 mdio_dev
->sc_reg
.mdio_reset_dreq
=
557 (u16
)reg_args
.args
[1] + 4;
558 mdio_dev
->sc_reg
.mdio_clk_st
=
559 (u16
)reg_args
.args
[2];
560 mdio_dev
->sc_reg
.mdio_reset_st
=
561 (u16
)reg_args
.args
[3];
564 mdio_dev
->sc_reg
.mdio_clk_en
=
566 mdio_dev
->sc_reg
.mdio_clk_dis
=
568 mdio_dev
->sc_reg
.mdio_reset_req
=
570 mdio_dev
->sc_reg
.mdio_reset_dreq
=
572 mdio_dev
->sc_reg
.mdio_clk_st
=
574 mdio_dev
->sc_reg
.mdio_reset_st
=
578 of_node_put(reg_args
.np
);
580 dev_warn(&pdev
->dev
, "find syscon ret = %#x\n", ret
);
581 mdio_dev
->subctrl_vbase
= NULL
;
584 ret
= of_mdiobus_register(new_bus
, pdev
->dev
.of_node
);
585 } else if (is_acpi_node(pdev
->dev
.fwnode
)) {
586 /* Clear all the IRQ properties */
587 memset(new_bus
->irq
, PHY_POLL
, 4 * PHY_MAX_ADDR
);
589 /* Mask out all PHYs from auto probing. */
590 new_bus
->phy_mask
= ~0;
592 /* Register the MDIO bus */
593 ret
= mdiobus_register(new_bus
);
595 dev_err(&pdev
->dev
, "Can not get cfg data from DT or ACPI\n");
600 dev_err(&pdev
->dev
, "Cannot register as MDIO bus!\n");
601 platform_set_drvdata(pdev
, NULL
);
609 * hns_mdio_remove - remove mdio device
610 * @pdev: mdio platform device
612 * Return 0 on success, negative on failure
614 static void hns_mdio_remove(struct platform_device
*pdev
)
618 bus
= platform_get_drvdata(pdev
);
620 mdiobus_unregister(bus
);
621 platform_set_drvdata(pdev
, NULL
);
624 static const struct of_device_id hns_mdio_match
[] = {
625 {.compatible
= "hisilicon,mdio"},
626 {.compatible
= "hisilicon,hns-mdio"},
629 MODULE_DEVICE_TABLE(of
, hns_mdio_match
);
631 static const struct acpi_device_id hns_mdio_acpi_match
[] = {
635 MODULE_DEVICE_TABLE(acpi
, hns_mdio_acpi_match
);
637 static struct platform_driver hns_mdio_driver
= {
638 .probe
= hns_mdio_probe
,
639 .remove
= hns_mdio_remove
,
641 .name
= MDIO_DRV_NAME
,
642 .of_match_table
= hns_mdio_match
,
643 .acpi_match_table
= ACPI_PTR(hns_mdio_acpi_match
),
647 module_platform_driver(hns_mdio_driver
);
649 MODULE_LICENSE("GPL");
650 MODULE_AUTHOR("Huawei Tech. Co., Ltd.");
651 MODULE_DESCRIPTION("Hisilicon HNS MDIO driver");
652 MODULE_ALIAS("platform:" MDIO_DRV_NAME
);