1 // SPDX-License-Identifier: GPL-2.0+
3 * Driver for ICPlus PHYs
5 * Copyright (c) 2007 Freescale Semiconductor, Inc.
7 #include <linux/kernel.h>
8 #include <linux/string.h>
9 #include <linux/errno.h>
10 #include <linux/unistd.h>
11 #include <linux/interrupt.h>
12 #include <linux/init.h>
13 #include <linux/delay.h>
14 #include <linux/netdevice.h>
15 #include <linux/etherdevice.h>
16 #include <linux/skbuff.h>
17 #include <linux/spinlock.h>
19 #include <linux/module.h>
20 #include <linux/mii.h>
21 #include <linux/ethtool.h>
22 #include <linux/phy.h>
23 #include <linux/property.h>
27 #include <linux/uaccess.h>
29 MODULE_DESCRIPTION("ICPlus IP175C/IP101A/IP101G/IC1001 PHY drivers");
30 MODULE_AUTHOR("Michael Barkowski");
31 MODULE_LICENSE("GPL");
33 /* IP101A/G - IP1001 */
34 #define IP10XX_SPEC_CTRL_STATUS 16 /* Spec. Control Register */
35 #define IP1001_RXPHASE_SEL BIT(0) /* Add delay on RX_CLK */
36 #define IP1001_TXPHASE_SEL BIT(1) /* Add delay on TX_CLK */
37 #define IP1001_SPEC_CTRL_STATUS_2 20 /* IP1001 Spec. Control Reg 2 */
38 #define IP1001_APS_ON 11 /* IP1001 APS Mode bit */
39 #define IP101A_G_APS_ON BIT(1) /* IP101A/G APS Mode bit */
40 #define IP101A_G_AUTO_MDIX_DIS BIT(11)
41 #define IP101A_G_IRQ_CONF_STATUS 0x11 /* Conf Info IRQ & Status Reg */
42 #define IP101A_G_IRQ_PIN_USED BIT(15) /* INTR pin used */
43 #define IP101A_G_IRQ_ALL_MASK BIT(11) /* IRQ's inactive */
44 #define IP101A_G_IRQ_SPEED_CHANGE BIT(2)
45 #define IP101A_G_IRQ_DUPLEX_CHANGE BIT(1)
46 #define IP101A_G_IRQ_LINK_CHANGE BIT(0)
47 #define IP101A_G_PHY_STATUS 18
48 #define IP101A_G_MDIX BIT(9)
49 #define IP101A_G_PHY_SPEC_CTRL 30
50 #define IP101A_G_FORCE_MDIX BIT(3)
52 #define IP101G_PAGE_CONTROL 0x14
53 #define IP101G_PAGE_CONTROL_MASK GENMASK(4, 0)
54 #define IP101G_DIGITAL_IO_SPEC_CTRL 0x1d
55 #define IP101G_DIGITAL_IO_SPEC_CTRL_SEL_INTR32 BIT(2)
57 #define IP101G_DEFAULT_PAGE 16
59 #define IP101G_P1_CNT_CTRL 17
60 #define CNT_CTRL_RX_EN BIT(13)
61 #define IP101G_P8_CNT_CTRL 17
62 #define CNT_CTRL_RDCLR_EN BIT(15)
63 #define IP101G_CNT_REG 18
65 #define IP175C_PHY_ID 0x02430d80
66 #define IP1001_PHY_ID 0x02430d90
67 #define IP101A_PHY_ID 0x02430c54
69 /* The 32-pin IP101GR package can re-configure the mode of the RXER/INTR_32 pin
70 * (pin number 21). The hardware default is RXER (receive error) mode. But it
71 * can be configured to interrupt mode manually.
73 enum ip101gr_sel_intr32
{
74 IP101GR_SEL_INTR32_KEEP
,
75 IP101GR_SEL_INTR32_INTR
,
76 IP101GR_SEL_INTR32_RXER
,
79 struct ip101g_hw_stat
{
84 static struct ip101g_hw_stat ip101g_hw_stats
[] = {
85 { "phy_crc_errors", 1 },
86 { "phy_symbol_errors", 11, },
89 struct ip101a_g_phy_priv
{
90 enum ip101gr_sel_intr32 sel_intr32
;
91 u64 stats
[ARRAY_SIZE(ip101g_hw_stats
)];
94 static int ip175c_config_init(struct phy_device
*phydev
)
97 static int full_reset_performed
;
99 if (full_reset_performed
== 0) {
102 err
= mdiobus_write(phydev
->mdio
.bus
, 30, 0, 0x175c);
106 /* ensure no bus delays overlap reset period */
107 err
= mdiobus_read(phydev
->mdio
.bus
, 30, 0);
109 /* data sheet specifies reset period is 2 msec */
112 /* enable IP175C mode */
113 err
= mdiobus_write(phydev
->mdio
.bus
, 29, 31, 0x175c);
117 /* Set MII0 speed and duplex (in PHY mode) */
118 err
= mdiobus_write(phydev
->mdio
.bus
, 29, 22, 0x420);
122 /* reset switch ports */
123 for (i
= 0; i
< 5; i
++) {
124 err
= mdiobus_write(phydev
->mdio
.bus
, i
,
125 MII_BMCR
, BMCR_RESET
);
130 for (i
= 0; i
< 5; i
++)
131 err
= mdiobus_read(phydev
->mdio
.bus
, i
, MII_BMCR
);
135 full_reset_performed
= 1;
138 if (phydev
->mdio
.addr
!= 4) {
139 phydev
->state
= PHY_RUNNING
;
140 phydev
->speed
= SPEED_100
;
141 phydev
->duplex
= DUPLEX_FULL
;
143 netif_carrier_on(phydev
->attached_dev
);
149 static int ip1001_config_init(struct phy_device
*phydev
)
153 /* Enable Auto Power Saving mode */
154 c
= phy_read(phydev
, IP1001_SPEC_CTRL_STATUS_2
);
158 c
= phy_write(phydev
, IP1001_SPEC_CTRL_STATUS_2
, c
);
162 if (phy_interface_is_rgmii(phydev
)) {
164 c
= phy_read(phydev
, IP10XX_SPEC_CTRL_STATUS
);
168 c
&= ~(IP1001_RXPHASE_SEL
| IP1001_TXPHASE_SEL
);
170 if (phydev
->interface
== PHY_INTERFACE_MODE_RGMII_ID
)
171 c
|= (IP1001_RXPHASE_SEL
| IP1001_TXPHASE_SEL
);
172 else if (phydev
->interface
== PHY_INTERFACE_MODE_RGMII_RXID
)
173 c
|= IP1001_RXPHASE_SEL
;
174 else if (phydev
->interface
== PHY_INTERFACE_MODE_RGMII_TXID
)
175 c
|= IP1001_TXPHASE_SEL
;
177 c
= phy_write(phydev
, IP10XX_SPEC_CTRL_STATUS
, c
);
185 static int ip175c_read_status(struct phy_device
*phydev
)
187 if (phydev
->mdio
.addr
== 4) /* WAN port */
188 genphy_read_status(phydev
);
190 /* Don't need to read status for switch ports */
191 phydev
->irq
= PHY_MAC_INTERRUPT
;
196 static int ip175c_config_aneg(struct phy_device
*phydev
)
198 if (phydev
->mdio
.addr
== 4) /* WAN port */
199 genphy_config_aneg(phydev
);
204 static int ip101a_g_probe(struct phy_device
*phydev
)
206 struct device
*dev
= &phydev
->mdio
.dev
;
207 struct ip101a_g_phy_priv
*priv
;
209 priv
= devm_kzalloc(dev
, sizeof(*priv
), GFP_KERNEL
);
213 /* Both functions (RX error and interrupt status) are sharing the same
214 * pin on the 32-pin IP101GR, so this is an exclusive choice.
216 if (device_property_read_bool(dev
, "icplus,select-rx-error") &&
217 device_property_read_bool(dev
, "icplus,select-interrupt")) {
219 "RXER and INTR mode cannot be selected together\n");
223 if (device_property_read_bool(dev
, "icplus,select-rx-error"))
224 priv
->sel_intr32
= IP101GR_SEL_INTR32_RXER
;
225 else if (device_property_read_bool(dev
, "icplus,select-interrupt"))
226 priv
->sel_intr32
= IP101GR_SEL_INTR32_INTR
;
228 priv
->sel_intr32
= IP101GR_SEL_INTR32_KEEP
;
235 static int ip101a_g_config_intr_pin(struct phy_device
*phydev
)
237 struct ip101a_g_phy_priv
*priv
= phydev
->priv
;
238 int oldpage
, err
= 0;
240 oldpage
= phy_select_page(phydev
, IP101G_DEFAULT_PAGE
);
244 /* configure the RXER/INTR_32 pin of the 32-pin IP101GR if needed: */
245 switch (priv
->sel_intr32
) {
246 case IP101GR_SEL_INTR32_RXER
:
247 err
= __phy_modify(phydev
, IP101G_DIGITAL_IO_SPEC_CTRL
,
248 IP101G_DIGITAL_IO_SPEC_CTRL_SEL_INTR32
, 0);
253 case IP101GR_SEL_INTR32_INTR
:
254 err
= __phy_modify(phydev
, IP101G_DIGITAL_IO_SPEC_CTRL
,
255 IP101G_DIGITAL_IO_SPEC_CTRL_SEL_INTR32
,
256 IP101G_DIGITAL_IO_SPEC_CTRL_SEL_INTR32
);
262 /* Don't touch IP101G_DIGITAL_IO_SPEC_CTRL because it's not
263 * documented on IP101A and it's not clear whether this would
265 * For the 32-pin IP101GR we simply keep the SEL_INTR32
266 * configuration as set by the bootloader when not configured
267 * to one of the special functions.
273 return phy_restore_page(phydev
, oldpage
, err
);
276 static int ip101a_config_init(struct phy_device
*phydev
)
280 /* Enable Auto Power Saving mode */
281 ret
= phy_set_bits(phydev
, IP10XX_SPEC_CTRL_STATUS
, IP101A_G_APS_ON
);
285 return ip101a_g_config_intr_pin(phydev
);
288 static int ip101g_config_init(struct phy_device
*phydev
)
292 /* Enable the PHY counters */
293 ret
= phy_modify_paged(phydev
, 1, IP101G_P1_CNT_CTRL
,
294 CNT_CTRL_RX_EN
, CNT_CTRL_RX_EN
);
298 /* Clear error counters on read */
299 ret
= phy_modify_paged(phydev
, 8, IP101G_P8_CNT_CTRL
,
300 CNT_CTRL_RDCLR_EN
, CNT_CTRL_RDCLR_EN
);
304 return ip101a_g_config_intr_pin(phydev
);
307 static int ip101a_g_read_status(struct phy_device
*phydev
)
309 int oldpage
, ret
, stat1
, stat2
;
311 ret
= genphy_read_status(phydev
);
315 oldpage
= phy_select_page(phydev
, IP101G_DEFAULT_PAGE
);
319 ret
= __phy_read(phydev
, IP10XX_SPEC_CTRL_STATUS
);
324 ret
= __phy_read(phydev
, IP101A_G_PHY_SPEC_CTRL
);
329 if (stat1
& IP101A_G_AUTO_MDIX_DIS
) {
330 if (stat2
& IP101A_G_FORCE_MDIX
)
331 phydev
->mdix_ctrl
= ETH_TP_MDI_X
;
333 phydev
->mdix_ctrl
= ETH_TP_MDI
;
335 phydev
->mdix_ctrl
= ETH_TP_MDI_AUTO
;
338 if (stat2
& IP101A_G_MDIX
)
339 phydev
->mdix
= ETH_TP_MDI_X
;
341 phydev
->mdix
= ETH_TP_MDI
;
346 return phy_restore_page(phydev
, oldpage
, ret
);
349 static int ip101a_g_config_mdix(struct phy_device
*phydev
)
351 u16 ctrl
= 0, ctrl2
= 0;
355 switch (phydev
->mdix_ctrl
) {
357 ctrl
= IP101A_G_AUTO_MDIX_DIS
;
360 ctrl
= IP101A_G_AUTO_MDIX_DIS
;
361 ctrl2
= IP101A_G_FORCE_MDIX
;
363 case ETH_TP_MDI_AUTO
:
369 oldpage
= phy_select_page(phydev
, IP101G_DEFAULT_PAGE
);
373 ret
= __phy_modify(phydev
, IP10XX_SPEC_CTRL_STATUS
,
374 IP101A_G_AUTO_MDIX_DIS
, ctrl
);
378 ret
= __phy_modify(phydev
, IP101A_G_PHY_SPEC_CTRL
,
379 IP101A_G_FORCE_MDIX
, ctrl2
);
382 return phy_restore_page(phydev
, oldpage
, ret
);
385 static int ip101a_g_config_aneg(struct phy_device
*phydev
)
389 ret
= ip101a_g_config_mdix(phydev
);
393 return genphy_config_aneg(phydev
);
396 static int ip101a_g_ack_interrupt(struct phy_device
*phydev
)
400 err
= phy_read_paged(phydev
, IP101G_DEFAULT_PAGE
,
401 IP101A_G_IRQ_CONF_STATUS
);
408 static int ip101a_g_config_intr(struct phy_device
*phydev
)
413 if (phydev
->interrupts
== PHY_INTERRUPT_ENABLED
) {
414 err
= ip101a_g_ack_interrupt(phydev
);
418 /* INTR pin used: Speed/link/duplex will cause an interrupt */
419 val
= IP101A_G_IRQ_PIN_USED
;
420 err
= phy_write_paged(phydev
, IP101G_DEFAULT_PAGE
,
421 IP101A_G_IRQ_CONF_STATUS
, val
);
423 val
= IP101A_G_IRQ_ALL_MASK
;
424 err
= phy_write_paged(phydev
, IP101G_DEFAULT_PAGE
,
425 IP101A_G_IRQ_CONF_STATUS
, val
);
429 err
= ip101a_g_ack_interrupt(phydev
);
435 static irqreturn_t
ip101a_g_handle_interrupt(struct phy_device
*phydev
)
439 irq_status
= phy_read_paged(phydev
, IP101G_DEFAULT_PAGE
,
440 IP101A_G_IRQ_CONF_STATUS
);
441 if (irq_status
< 0) {
446 if (!(irq_status
& (IP101A_G_IRQ_SPEED_CHANGE
|
447 IP101A_G_IRQ_DUPLEX_CHANGE
|
448 IP101A_G_IRQ_LINK_CHANGE
)))
451 phy_trigger_machine(phydev
);
456 /* The IP101A doesn't really have a page register. We just pretend to have one
457 * so we can use the paged versions of the callbacks of the IP101G.
459 static int ip101a_read_page(struct phy_device
*phydev
)
461 return IP101G_DEFAULT_PAGE
;
464 static int ip101a_write_page(struct phy_device
*phydev
, int page
)
466 WARN_ONCE(page
!= IP101G_DEFAULT_PAGE
, "wrong page selected\n");
471 static int ip101g_read_page(struct phy_device
*phydev
)
473 return __phy_read(phydev
, IP101G_PAGE_CONTROL
);
476 static int ip101g_write_page(struct phy_device
*phydev
, int page
)
478 return __phy_write(phydev
, IP101G_PAGE_CONTROL
, page
);
481 static int ip101a_g_has_page_register(struct phy_device
*phydev
)
483 int oldval
, val
, ret
;
485 oldval
= phy_read(phydev
, IP101G_PAGE_CONTROL
);
489 ret
= phy_write(phydev
, IP101G_PAGE_CONTROL
, 0xffff);
493 val
= phy_read(phydev
, IP101G_PAGE_CONTROL
);
497 ret
= phy_write(phydev
, IP101G_PAGE_CONTROL
, oldval
);
501 return val
== IP101G_PAGE_CONTROL_MASK
;
504 static int ip101a_g_match_phy_device(struct phy_device
*phydev
, bool ip101a
)
508 if (phydev
->phy_id
!= IP101A_PHY_ID
)
511 /* The IP101A and the IP101G share the same PHY identifier.The IP101G
512 * seems to be a successor of the IP101A and implements more functions.
513 * Amongst other things there is a page select register, which is not
514 * available on the IP101A. Use this to distinguish these two.
516 ret
= ip101a_g_has_page_register(phydev
);
520 return ip101a
== !ret
;
523 static int ip101a_match_phy_device(struct phy_device
*phydev
)
525 return ip101a_g_match_phy_device(phydev
, true);
528 static int ip101g_match_phy_device(struct phy_device
*phydev
)
530 return ip101a_g_match_phy_device(phydev
, false);
533 static int ip101g_get_sset_count(struct phy_device
*phydev
)
535 return ARRAY_SIZE(ip101g_hw_stats
);
538 static void ip101g_get_strings(struct phy_device
*phydev
, u8
*data
)
542 for (i
= 0; i
< ARRAY_SIZE(ip101g_hw_stats
); i
++)
543 ethtool_puts(&data
, ip101g_hw_stats
[i
].name
);
546 static u64
ip101g_get_stat(struct phy_device
*phydev
, int i
)
548 struct ip101g_hw_stat stat
= ip101g_hw_stats
[i
];
549 struct ip101a_g_phy_priv
*priv
= phydev
->priv
;
553 val
= phy_read_paged(phydev
, stat
.page
, IP101G_CNT_REG
);
557 priv
->stats
[i
] += val
;
558 ret
= priv
->stats
[i
];
564 static void ip101g_get_stats(struct phy_device
*phydev
,
565 struct ethtool_stats
*stats
, u64
*data
)
569 for (i
= 0; i
< ARRAY_SIZE(ip101g_hw_stats
); i
++)
570 data
[i
] = ip101g_get_stat(phydev
, i
);
573 static struct phy_driver icplus_driver
[] = {
575 PHY_ID_MATCH_MODEL(IP175C_PHY_ID
),
576 .name
= "ICPlus IP175C",
577 /* PHY_BASIC_FEATURES */
578 .config_init
= ip175c_config_init
,
579 .config_aneg
= ip175c_config_aneg
,
580 .read_status
= ip175c_read_status
,
581 .suspend
= genphy_suspend
,
582 .resume
= genphy_resume
,
584 PHY_ID_MATCH_MODEL(IP1001_PHY_ID
),
585 .name
= "ICPlus IP1001",
586 /* PHY_GBIT_FEATURES */
587 .config_init
= ip1001_config_init
,
588 .soft_reset
= genphy_soft_reset
,
589 .suspend
= genphy_suspend
,
590 .resume
= genphy_resume
,
592 .name
= "ICPlus IP101A",
593 .match_phy_device
= ip101a_match_phy_device
,
594 .probe
= ip101a_g_probe
,
595 .read_page
= ip101a_read_page
,
596 .write_page
= ip101a_write_page
,
597 .config_intr
= ip101a_g_config_intr
,
598 .handle_interrupt
= ip101a_g_handle_interrupt
,
599 .config_init
= ip101a_config_init
,
600 .config_aneg
= ip101a_g_config_aneg
,
601 .read_status
= ip101a_g_read_status
,
602 .soft_reset
= genphy_soft_reset
,
603 .suspend
= genphy_suspend
,
604 .resume
= genphy_resume
,
606 .name
= "ICPlus IP101G",
607 .match_phy_device
= ip101g_match_phy_device
,
608 .probe
= ip101a_g_probe
,
609 .read_page
= ip101g_read_page
,
610 .write_page
= ip101g_write_page
,
611 .config_intr
= ip101a_g_config_intr
,
612 .handle_interrupt
= ip101a_g_handle_interrupt
,
613 .config_init
= ip101g_config_init
,
614 .config_aneg
= ip101a_g_config_aneg
,
615 .read_status
= ip101a_g_read_status
,
616 .soft_reset
= genphy_soft_reset
,
617 .get_sset_count
= ip101g_get_sset_count
,
618 .get_strings
= ip101g_get_strings
,
619 .get_stats
= ip101g_get_stats
,
620 .suspend
= genphy_suspend
,
621 .resume
= genphy_resume
,
624 module_phy_driver(icplus_driver
);
626 static struct mdio_device_id __maybe_unused icplus_tbl
[] = {
627 { PHY_ID_MATCH_MODEL(IP175C_PHY_ID
) },
628 { PHY_ID_MATCH_MODEL(IP1001_PHY_ID
) },
629 { PHY_ID_MATCH_EXACT(IP101A_PHY_ID
) },
633 MODULE_DEVICE_TABLE(mdio
, icplus_tbl
);