1/*
2 * Copyright (C) 2015 Microchip Technology
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see <http://www.gnu.org/licenses/>.
16 */
17#include <linux/kernel.h>
18#include <linux/module.h>
19#include <linux/mii.h>
20#include <linux/ethtool.h>
21#include <linux/phy.h>
22#include <linux/microchipphy.h>
23
24#define DRIVER_AUTHOR	"WOOJUNG HUH <woojung.huh@microchip.com>"
25#define DRIVER_DESC	"Microchip LAN88XX PHY driver"
26
27struct lan88xx_priv {
28	int	chip_id;
29	int	chip_rev;
30	__u32	wolopts;
31};
32
33static int lan88xx_phy_config_intr(struct phy_device *phydev)
34{
35	int rc;
36
37	if (phydev->interrupts == PHY_INTERRUPT_ENABLED) {
38		/* unmask all source and clear them before enable */
39		rc = phy_write(phydev, LAN88XX_INT_MASK, 0x7FFF);
40		rc = phy_read(phydev, LAN88XX_INT_STS);
41		rc = phy_write(phydev, LAN88XX_INT_MASK,
42			       LAN88XX_INT_MASK_MDINTPIN_EN_ |
43			       LAN88XX_INT_MASK_LINK_CHANGE_);
44	} else {
45		rc = phy_write(phydev, LAN88XX_INT_MASK, 0);
46	}
47
48	return rc < 0 ? rc : 0;
49}
50
51static int lan88xx_phy_ack_interrupt(struct phy_device *phydev)
52{
53	int rc = phy_read(phydev, LAN88XX_INT_STS);
54
55	return rc < 0 ? rc : 0;
56}
57
58int lan88xx_suspend(struct phy_device *phydev)
59{
60	struct lan88xx_priv *priv = phydev->priv;
61
62	/* do not power down PHY when WOL is enabled */
63	if (!priv->wolopts)
64		genphy_suspend(phydev);
65
66	return 0;
67}
68
69static int lan88xx_probe(struct phy_device *phydev)
70{
71	struct device *dev = &phydev->dev;
72	struct lan88xx_priv *priv;
73
74	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
75	if (!priv)
76		return -ENOMEM;
77
78	priv->wolopts = 0;
79
80	/* these values can be used to identify internal PHY */
81	priv->chip_id = phy_read_mmd_indirect(phydev, LAN88XX_MMD3_CHIP_ID,
82					      3, phydev->addr);
83	priv->chip_rev = phy_read_mmd_indirect(phydev, LAN88XX_MMD3_CHIP_REV,
84					       3, phydev->addr);
85
86	phydev->priv = priv;
87
88	return 0;
89}
90
91static void lan88xx_remove(struct phy_device *phydev)
92{
93	struct device *dev = &phydev->dev;
94	struct lan88xx_priv *priv = phydev->priv;
95
96	if (priv)
97		devm_kfree(dev, priv);
98}
99
100static int lan88xx_set_wol(struct phy_device *phydev,
101			   struct ethtool_wolinfo *wol)
102{
103	struct lan88xx_priv *priv = phydev->priv;
104
105	priv->wolopts = wol->wolopts;
106
107	return 0;
108}
109
110static struct phy_driver microchip_phy_driver[] = {
111{
112	.phy_id		= 0x0007c130,
113	.phy_id_mask	= 0xfffffff0,
114	.name		= "Microchip LAN88xx",
115
116	.features	= (PHY_GBIT_FEATURES |
117			   SUPPORTED_Pause | SUPPORTED_Asym_Pause),
118	.flags		= PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,
119
120	.probe		= lan88xx_probe,
121	.remove		= lan88xx_remove,
122
123	.config_init	= genphy_config_init,
124	.config_aneg	= genphy_config_aneg,
125	.read_status	= genphy_read_status,
126
127	.ack_interrupt	= lan88xx_phy_ack_interrupt,
128	.config_intr	= lan88xx_phy_config_intr,
129
130	.suspend	= lan88xx_suspend,
131	.resume		= genphy_resume,
132	.set_wol	= lan88xx_set_wol,
133
134	.driver		= { .owner = THIS_MODULE, }
135} };
136
137module_phy_driver(microchip_phy_driver);
138
139static struct mdio_device_id __maybe_unused microchip_tbl[] = {
140	{ 0x0007c130, 0xfffffff0 },
141	{ }
142};
143
144MODULE_DEVICE_TABLE(mdio, microchip_tbl);
145
146MODULE_AUTHOR(DRIVER_AUTHOR);
147MODULE_DESCRIPTION(DRIVER_DESC);
148MODULE_LICENSE("GPL");
149