[deliverable/linux.git] / drivers / net / phy / smsc.c

/*
 * drivers/net/phy/smsc.c
 *
 * Driver for SMSC PHYs
 *
 * Author: Herbert Valerio Riedel
 *
 * Copyright (c) 2006 Herbert Valerio Riedel <hvr@gnu.org>
 *
 * This program is free software; you can redistribute  it and/or modify it
 * under  the terms of  the GNU General  Public License as published by the
 * Free Software Foundation;  either version 2 of the  License, or (at your
 * option) any later version.
 *
 * Support added for SMSC LAN8187 and LAN8700 by steve.glendinning@shawell.net
 *
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/mii.h>
#include <linux/ethtool.h>
#include <linux/phy.h>
#include <linux/netdevice.h>
#include <linux/smscphy.h>

static int smsc_phy_config_intr(struct phy_device *phydev)
{
	int rc = phy_write (phydev, MII_LAN83C185_IM,
			((PHY_INTERRUPT_ENABLED == phydev->interrupts)
			? MII_LAN83C185_ISF_INT_PHYLIB_EVENTS
			: 0));

	return rc < 0 ? rc : 0;
}

static int smsc_phy_ack_interrupt(struct phy_device *phydev)
{
	int rc = phy_read (phydev, MII_LAN83C185_ISF);

	return rc < 0 ? rc : 0;
}

static int smsc_phy_config_init(struct phy_device *phydev)
{
	int __maybe_unused len;
	struct device *dev __maybe_unused = &phydev->mdio.dev;
	struct device_node *of_node __maybe_unused = dev->of_node;
	int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
	int enable_energy = 1;

	if (rc < 0)
		return rc;

	if (of_find_property(of_node, "smsc,disable-energy-detect", &len))
		enable_energy = 0;

	if (enable_energy) {
		/* Enable energy detect mode for this SMSC Transceivers */
		rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
			       rc | MII_LAN83C185_EDPWRDOWN);
		if (rc < 0)
			return rc;
	}

	return smsc_phy_ack_interrupt(phydev);
}

static int smsc_phy_reset(struct phy_device *phydev)
{
	int rc = phy_read(phydev, MII_LAN83C185_SPECIAL_MODES);
	if (rc < 0)
		return rc;

	/* If the SMSC PHY is in power down mode, then set it
	 * in all capable mode before using it.
	 */
	if ((rc & MII_LAN83C185_MODE_MASK) == MII_LAN83C185_MODE_POWERDOWN) {
		int timeout = 50000;

		/* set "all capable" mode and reset the phy */
		rc |= MII_LAN83C185_MODE_ALL;
		phy_write(phydev, MII_LAN83C185_SPECIAL_MODES, rc);
		phy_write(phydev, MII_BMCR, BMCR_RESET);

		/* wait end of reset (max 500 ms) */
		do {
			udelay(10);
			if (timeout-- == 0)
				return -1;
			rc = phy_read(phydev, MII_BMCR);
		} while (rc & BMCR_RESET);
	}
	return 0;
}

static int lan911x_config_init(struct phy_device *phydev)
{
	return smsc_phy_ack_interrupt(phydev);
}

/*
 * The LAN87xx suffers from rare absence of the ENERGYON-bit when Ethernet cable
 * plugs in while LAN87xx is in Energy Detect Power-Down mode. This leads to
 * unstable detection of plugging in Ethernet cable.
 * This workaround disables Energy Detect Power-Down mode and waiting for
 * response on link pulses to detect presence of plugged Ethernet cable.
 * The Energy Detect Power-Down mode is enabled again in the end of procedure to
 * save approximately 220 mW of power if cable is unplugged.
 */
static int lan87xx_read_status(struct phy_device *phydev)
{
	int err = genphy_read_status(phydev);
	int i;

	if (!phydev->link) {
		/* Disable EDPD to wake up PHY */
		int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
		if (rc < 0)
			return rc;

		rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
			       rc & ~MII_LAN83C185_EDPWRDOWN);
		if (rc < 0)
			return rc;

		/* Wait max 640 ms to detect energy */
		for (i = 0; i < 64; i++) {
			/* Sleep to allow link test pulses to be sent */
			msleep(10);
			rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
			if (rc < 0)
				return rc;
			if (rc & MII_LAN83C185_ENERGYON)
				break;
		}

		/* Re-enable EDPD */
		rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
		if (rc < 0)
			return rc;

		rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
			       rc | MII_LAN83C185_EDPWRDOWN);
		if (rc < 0)
			return rc;
	}

	return err;
}

static struct phy_driver smsc_phy_driver[] = {
{
	.phy_id		= 0x0007c0a0, /* OUI=0x00800f, Model#=0x0a */
	.phy_id_mask	= 0xfffffff0,
	.name		= "SMSC LAN83C185",

	.features	= (PHY_BASIC_FEATURES | SUPPORTED_Pause
				| SUPPORTED_Asym_Pause),
	.flags		= PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,

	/* basic functions */
	.config_aneg	= genphy_config_aneg,
	.read_status	= genphy_read_status,
	.config_init	= smsc_phy_config_init,
	.soft_reset	= smsc_phy_reset,

	/* IRQ related */
	.ack_interrupt	= smsc_phy_ack_interrupt,
	.config_intr	= smsc_phy_config_intr,

	.suspend	= genphy_suspend,
	.resume		= genphy_resume,
}, {
	.phy_id		= 0x0007c0b0, /* OUI=0x00800f, Model#=0x0b */
	.phy_id_mask	= 0xfffffff0,
	.name		= "SMSC LAN8187",

	.features	= (PHY_BASIC_FEATURES | SUPPORTED_Pause
				| SUPPORTED_Asym_Pause),
	.flags		= PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,

	/* basic functions */
	.config_aneg	= genphy_config_aneg,
	.read_status	= genphy_read_status,
	.config_init	= smsc_phy_config_init,
	.soft_reset	= smsc_phy_reset,

	/* IRQ related */
	.ack_interrupt	= smsc_phy_ack_interrupt,
	.config_intr	= smsc_phy_config_intr,

	.suspend	= genphy_suspend,
	.resume		= genphy_resume,
}, {
	.phy_id		= 0x0007c0c0, /* OUI=0x00800f, Model#=0x0c */
	.phy_id_mask	= 0xfffffff0,
	.name		= "SMSC LAN8700",

	.features	= (PHY_BASIC_FEATURES | SUPPORTED_Pause
				| SUPPORTED_Asym_Pause),
	.flags		= PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,

	/* basic functions */
	.config_aneg	= genphy_config_aneg,
	.read_status	= lan87xx_read_status,
	.config_init	= smsc_phy_config_init,
	.soft_reset	= smsc_phy_reset,

	/* IRQ related */
	.ack_interrupt	= smsc_phy_ack_interrupt,
	.config_intr	= smsc_phy_config_intr,

	.suspend	= genphy_suspend,
	.resume		= genphy_resume,
}, {
	.phy_id		= 0x0007c0d0, /* OUI=0x00800f, Model#=0x0d */
	.phy_id_mask	= 0xfffffff0,
	.name		= "SMSC LAN911x Internal PHY",

	.features	= (PHY_BASIC_FEATURES | SUPPORTED_Pause
				| SUPPORTED_Asym_Pause),
	.flags		= PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,

	/* basic functions */
	.config_aneg	= genphy_config_aneg,
	.read_status	= genphy_read_status,
	.config_init	= lan911x_config_init,

	/* IRQ related */
	.ack_interrupt	= smsc_phy_ack_interrupt,
	.config_intr	= smsc_phy_config_intr,

	.suspend	= genphy_suspend,
	.resume		= genphy_resume,
}, {
	.phy_id		= 0x0007c0f0, /* OUI=0x00800f, Model#=0x0f */
	.phy_id_mask	= 0xfffffff0,
	.name		= "SMSC LAN8710/LAN8720",

	.features	= (PHY_BASIC_FEATURES | SUPPORTED_Pause
				| SUPPORTED_Asym_Pause),
	.flags		= PHY_HAS_INTERRUPT | PHY_HAS_MAGICANEG,

	/* basic functions */
	.config_aneg	= genphy_config_aneg,
	.read_status	= lan87xx_read_status,
	.config_init	= smsc_phy_config_init,
	.soft_reset	= smsc_phy_reset,

	/* IRQ related */
	.ack_interrupt	= smsc_phy_ack_interrupt,
	.config_intr	= smsc_phy_config_intr,

	.suspend	= genphy_suspend,
	.resume		= genphy_resume,
} };

module_phy_driver(smsc_phy_driver);

MODULE_DESCRIPTION("SMSC PHY driver");
MODULE_AUTHOR("Herbert Valerio Riedel");
MODULE_LICENSE("GPL");

static struct mdio_device_id __maybe_unused smsc_tbl[] = {
	{ 0x0007c0a0, 0xfffffff0 },
	{ 0x0007c0b0, 0xfffffff0 },
	{ 0x0007c0c0, 0xfffffff0 },
	{ 0x0007c0d0, 0xfffffff0 },
	{ 0x0007c0f0, 0xfffffff0 },
	{ }
};

MODULE_DEVICE_TABLE(mdio, smsc_tbl);
Commit	Line	Data
c9e055ac HVR	1	/*
	2	* drivers/net/phy/smsc.c
	3	*
	4	* Driver for SMSC PHYs
	5	*
	6	* Author: Herbert Valerio Riedel
	7	*
	8	* Copyright (c) 2006 Herbert Valerio Riedel <hvr@gnu.org>
	9	*
	10	* This program is free software; you can redistribute it and/or modify it
	11	* under the terms of the GNU General Public License as published by the
	12	* Free Software Foundation; either version 2 of the License, or (at your
	13	* option) any later version.
	14	*
90b24cfb	15	* Support added for SMSC LAN8187 and LAN8700 by steve.glendinning@shawell.net
4d9b1a02	16	*
c9e055ac HVR	17	*/
c9e055ac HVR	18
c9e055ac HVR	19	#include <linux/kernel.h>
	20	#include <linux/module.h>
	21	#include <linux/mii.h>
	22	#include <linux/ethtool.h>
	23	#include <linux/phy.h>
	24	#include <linux/netdevice.h>
43c6759e	25	#include <linux/smscphy.h>
c9e055ac	26
48c41b99	27	static int smsc_phy_config_intr(struct phy_device *phydev)
c9e055ac HVR	28	{
	29	int rc = phy_write (phydev, MII_LAN83C185_IM,
	30	((PHY_INTERRUPT_ENABLED == phydev->interrupts)
	31	? MII_LAN83C185_ISF_INT_PHYLIB_EVENTS
	32	: 0));
	33
	34	return rc < 0 ? rc : 0;
	35	}
	36
48c41b99	37	static int smsc_phy_ack_interrupt(struct phy_device *phydev)
c9e055ac HVR	38	{
	39	int rc = phy_read (phydev, MII_LAN83C185_ISF);
	40
	41	return rc < 0 ? rc : 0;
	42	}
	43
48c41b99	44	static int smsc_phy_config_init(struct phy_device *phydev)
21009686	45	{
d88ecb37	46	int __maybe_unused len;
e5a03bfd	47	struct device *dev __maybe_unused = &phydev->mdio.dev;
d88ecb37	48	struct device_node *of_node __maybe_unused = dev->of_node;
21009686	49	int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
d88ecb37	50	int enable_energy = 1;
21009686 GGM	51
	52	if (rc < 0)
	53	return rc;
	54
d88ecb37 HS	55	if (of_find_property(of_node, "smsc,disable-energy-detect", &len))
	56	enable_energy = 0;
	57
	58	if (enable_energy) {
	59	/* Enable energy detect mode for this SMSC Transceivers */
	60	rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
	61	rc \| MII_LAN83C185_EDPWRDOWN);
	62	if (rc < 0)
	63	return rc;
	64	}
21009686 GGM	65
	66	return smsc_phy_ack_interrupt(phydev);
	67	}
	68
	69	static int smsc_phy_reset(struct phy_device *phydev)
c9e055ac	70	{
6ded7cd6	71	int rc = phy_read(phydev, MII_LAN83C185_SPECIAL_MODES);
	72	if (rc < 0)
	73	return rc;
	74
	75	/* If the SMSC PHY is in power down mode, then set it
	76	* in all capable mode before using it.
	77	*/
	78	if ((rc & MII_LAN83C185_MODE_MASK) == MII_LAN83C185_MODE_POWERDOWN) {
	79	int timeout = 50000;
	80
	81	/* set "all capable" mode and reset the phy */
	82	rc \|= MII_LAN83C185_MODE_ALL;
	83	phy_write(phydev, MII_LAN83C185_SPECIAL_MODES, rc);
	84	phy_write(phydev, MII_BMCR, BMCR_RESET);
	85
	86	/* wait end of reset (max 500 ms) */
	87	do {
	88	udelay(10);
	89	if (timeout-- == 0)
	90	return -1;
	91	rc = phy_read(phydev, MII_BMCR);
	92	} while (rc & BMCR_RESET);
	93	}
21009686	94	return 0;
c9e055ac HVR	95	}
c9e055ac HVR	96
4223dbff	97	static int lan911x_config_init(struct phy_device *phydev)
b629820d	98	{
b629820d MV	99	return smsc_phy_ack_interrupt(phydev);
	100	}
	101
4223dbff	102	/*
776829de IP	103	* The LAN87xx suffers from rare absence of the ENERGYON-bit when Ethernet cable
	104	* plugs in while LAN87xx is in Energy Detect Power-Down mode. This leads to
	105	* unstable detection of plugging in Ethernet cable.
	106	* This workaround disables Energy Detect Power-Down mode and waiting for
	107	* response on link pulses to detect presence of plugged Ethernet cable.
	108	* The Energy Detect Power-Down mode is enabled again in the end of procedure to
	109	* save approximately 220 mW of power if cable is unplugged.
4223dbff PT	110	*/
4223dbff PT	111	static int lan87xx_read_status(struct phy_device *phydev)
698244ac	112	{
4223dbff	113	int err = genphy_read_status(phydev);
776829de	114	int i;
4223dbff PT	115
	116	if (!phydev->link) {
	117	/* Disable EDPD to wake up PHY */
	118	int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
	119	if (rc < 0)
	120	return rc;
	121
	122	rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
	123	rc & ~MII_LAN83C185_EDPWRDOWN);
	124	if (rc < 0)
	125	return rc;
	126
776829de IP	127	/* Wait max 640 ms to detect energy */
	128	for (i = 0; i < 64; i++) {
	129	/* Sleep to allow link test pulses to be sent */
	130	msleep(10);
	131	rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
	132	if (rc < 0)
	133	return rc;
	134	if (rc & MII_LAN83C185_ENERGYON)
	135	break;
ff94c742	136	}
4223dbff PT	137
	138	/* Re-enable EDPD */
	139	rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
	140	if (rc < 0)
	141	return rc;
	142
	143	rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
	144	rc \| MII_LAN83C185_EDPWRDOWN);
	145	if (rc < 0)
	146	return rc;
	147	}
	148
	149	return err;
698244ac	150	}
c9e055ac	151
d5bf9071 CH	152	static struct phy_driver smsc_phy_driver[] = {
d5bf9071 CH	153	{
c9e055ac HVR	154	.phy_id = 0x0007c0a0, /* OUI=0x00800f, Model#=0x0a */
	155	.phy_id_mask = 0xfffffff0,
	156	.name = "SMSC LAN83C185",
	157
	158	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	159	\| SUPPORTED_Asym_Pause),
	160	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	161
	162	/* basic functions */
	163	.config_aneg = genphy_config_aneg,
	164	.read_status = genphy_read_status,
48c41b99	165	.config_init = smsc_phy_config_init,
21009686	166	.soft_reset = smsc_phy_reset,
c9e055ac HVR	167
c9e055ac HVR	168	/* IRQ related */
48c41b99 SG	169	.ack_interrupt = smsc_phy_ack_interrupt,
48c41b99 SG	170	.config_intr = smsc_phy_config_intr,
c9e055ac	171
c64d2a9a SG	172	.suspend = genphy_suspend,
c64d2a9a SG	173	.resume = genphy_resume,
d5bf9071	174	}, {
4d9b1a02 SG	175	.phy_id = 0x0007c0b0, /* OUI=0x00800f, Model#=0x0b */
	176	.phy_id_mask = 0xfffffff0,
	177	.name = "SMSC LAN8187",
	178
	179	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	180	\| SUPPORTED_Asym_Pause),
	181	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	182
	183	/* basic functions */
	184	.config_aneg = genphy_config_aneg,
	185	.read_status = genphy_read_status,
	186	.config_init = smsc_phy_config_init,
21009686	187	.soft_reset = smsc_phy_reset,
4d9b1a02 SG	188
	189	/* IRQ related */
	190	.ack_interrupt = smsc_phy_ack_interrupt,
	191	.config_intr = smsc_phy_config_intr,
	192
c64d2a9a SG	193	.suspend = genphy_suspend,
c64d2a9a SG	194	.resume = genphy_resume,
d5bf9071	195	}, {
4d9b1a02 SG	196	.phy_id = 0x0007c0c0, /* OUI=0x00800f, Model#=0x0c */
	197	.phy_id_mask = 0xfffffff0,
	198	.name = "SMSC LAN8700",
	199
	200	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	201	\| SUPPORTED_Asym_Pause),
	202	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	203
	204	/* basic functions */
	205	.config_aneg = genphy_config_aneg,
776829de	206	.read_status = lan87xx_read_status,
4d9b1a02	207	.config_init = smsc_phy_config_init,
21009686	208	.soft_reset = smsc_phy_reset,
4d9b1a02 SG	209
	210	/* IRQ related */
	211	.ack_interrupt = smsc_phy_ack_interrupt,
	212	.config_intr = smsc_phy_config_intr,
	213
c64d2a9a SG	214	.suspend = genphy_suspend,
c64d2a9a SG	215	.resume = genphy_resume,
d5bf9071	216	}, {
fd9abb3d SG	217	.phy_id = 0x0007c0d0, /* OUI=0x00800f, Model#=0x0d */
	218	.phy_id_mask = 0xfffffff0,
	219	.name = "SMSC LAN911x Internal PHY",
	220
	221	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	222	\| SUPPORTED_Asym_Pause),
	223	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	224
	225	/* basic functions */
	226	.config_aneg = genphy_config_aneg,
	227	.read_status = genphy_read_status,
698244ac	228	.config_init = lan911x_config_init,
fd9abb3d SG	229
	230	/* IRQ related */
	231	.ack_interrupt = smsc_phy_ack_interrupt,
	232	.config_intr = smsc_phy_config_intr,
	233
c64d2a9a SG	234	.suspend = genphy_suspend,
c64d2a9a SG	235	.resume = genphy_resume,
d5bf9071	236	}, {
e072b639 SG	237	.phy_id = 0x0007c0f0, /* OUI=0x00800f, Model#=0x0f */
	238	.phy_id_mask = 0xfffffff0,
	239	.name = "SMSC LAN8710/LAN8720",
	240
	241	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	242	\| SUPPORTED_Asym_Pause),
	243	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	244
	245	/* basic functions */
	246	.config_aneg = genphy_config_aneg,
4223dbff	247	.read_status = lan87xx_read_status,
4257d583	248	.config_init = smsc_phy_config_init,
21009686	249	.soft_reset = smsc_phy_reset,
e072b639 SG	250
	251	/* IRQ related */
	252	.ack_interrupt = smsc_phy_ack_interrupt,
	253	.config_intr = smsc_phy_config_intr,
	254
	255	.suspend = genphy_suspend,
	256	.resume = genphy_resume,
d5bf9071	257	} };
e072b639	258
50fd7150	259	module_phy_driver(smsc_phy_driver);
c9e055ac HVR	260
	261	MODULE_DESCRIPTION("SMSC PHY driver");
	262	MODULE_AUTHOR("Herbert Valerio Riedel");
	263	MODULE_LICENSE("GPL");
	264
cf93c945	265	static struct mdio_device_id __maybe_unused smsc_tbl[] = {
4e4f10f6 DW	266	{ 0x0007c0a0, 0xfffffff0 },
	267	{ 0x0007c0b0, 0xfffffff0 },
	268	{ 0x0007c0c0, 0xfffffff0 },
	269	{ 0x0007c0d0, 0xfffffff0 },
	270	{ 0x0007c0f0, 0xfffffff0 },
	271	{ }
	272	};
	273
	274	MODULE_DEVICE_TABLE(mdio, smsc_tbl);