[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 rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);

	if (rc < 0)
		return rc;

	/* 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 LAN8710/LAN8720 requires a minimum of 2 link pulses within 64ms of each
 * other in order to set the ENERGYON bit and exit EDPD mode.  If a link partner
 * does send the pulses within this interval, the PHY will remained powered
 * down.
 *
 * This workaround will manually toggle the PHY on/off upon calls to read_status
 * in order to generate link test pulses if the link is down.  If a link partner
 * is present, it will respond to the pulses, which will cause the ENERGYON bit
 * to be set and will cause the EDPD mode to be exited.
 */
static int lan87xx_read_status(struct phy_device *phydev)
{
	int err = genphy_read_status(phydev);

	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;

		/* Sleep 64 ms to allow ~5 link test pulses to be sent */
		msleep(64);

		/* 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,

	.driver		= { .owner = THIS_MODULE, }
}, {
	.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,

	.driver		= { .owner = THIS_MODULE, }
}, {
	.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	= 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,

	.driver		= { .owner = THIS_MODULE, }
}, {
	.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,

	.driver		= { .owner = THIS_MODULE, }
}, {
	.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,

	.driver		= { .owner = THIS_MODULE, }
} };

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 GGM	45	{
	46	int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
	47
	48	if (rc < 0)
	49	return rc;
	50
	51	/* Enable energy detect mode for this SMSC Transceivers */
	52	rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
	53	rc \| MII_LAN83C185_EDPWRDOWN);
	54	if (rc < 0)
	55	return rc;
	56
	57	return smsc_phy_ack_interrupt(phydev);
	58	}
	59
	60	static int smsc_phy_reset(struct phy_device *phydev)
c9e055ac	61	{
6ded7cd6	62	int rc = phy_read(phydev, MII_LAN83C185_SPECIAL_MODES);
	63	if (rc < 0)
	64	return rc;
	65
	66	/* If the SMSC PHY is in power down mode, then set it
	67	* in all capable mode before using it.
	68	*/
	69	if ((rc & MII_LAN83C185_MODE_MASK) == MII_LAN83C185_MODE_POWERDOWN) {
	70	int timeout = 50000;
	71
	72	/* set "all capable" mode and reset the phy */
	73	rc \|= MII_LAN83C185_MODE_ALL;
	74	phy_write(phydev, MII_LAN83C185_SPECIAL_MODES, rc);
	75	phy_write(phydev, MII_BMCR, BMCR_RESET);
	76
	77	/* wait end of reset (max 500 ms) */
	78	do {
	79	udelay(10);
	80	if (timeout-- == 0)
	81	return -1;
	82	rc = phy_read(phydev, MII_BMCR);
	83	} while (rc & BMCR_RESET);
	84	}
21009686	85	return 0;
c9e055ac HVR	86	}
c9e055ac HVR	87
4223dbff	88	static int lan911x_config_init(struct phy_device *phydev)
b629820d	89	{
b629820d MV	90	return smsc_phy_ack_interrupt(phydev);
	91	}
	92
4223dbff PT	93	/*
	94	* The LAN8710/LAN8720 requires a minimum of 2 link pulses within 64ms of each
	95	* other in order to set the ENERGYON bit and exit EDPD mode. If a link partner
	96	* does send the pulses within this interval, the PHY will remained powered
	97	* down.
	98	*
	99	* This workaround will manually toggle the PHY on/off upon calls to read_status
	100	* in order to generate link test pulses if the link is down. If a link partner
	101	* is present, it will respond to the pulses, which will cause the ENERGYON bit
	102	* to be set and will cause the EDPD mode to be exited.
	103	*/
	104	static int lan87xx_read_status(struct phy_device *phydev)
698244ac	105	{
4223dbff PT	106	int err = genphy_read_status(phydev);
	107
	108	if (!phydev->link) {
	109	/* Disable EDPD to wake up PHY */
	110	int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
	111	if (rc < 0)
	112	return rc;
	113
	114	rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
	115	rc & ~MII_LAN83C185_EDPWRDOWN);
	116	if (rc < 0)
	117	return rc;
	118
	119	/* Sleep 64 ms to allow ~5 link test pulses to be sent */
	120	msleep(64);
	121
	122	/* Re-enable EDPD */
	123	rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
	124	if (rc < 0)
	125	return rc;
	126
	127	rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
	128	rc \| MII_LAN83C185_EDPWRDOWN);
	129	if (rc < 0)
	130	return rc;
	131	}
	132
	133	return err;
698244ac	134	}
c9e055ac	135
d5bf9071 CH	136	static struct phy_driver smsc_phy_driver[] = {
d5bf9071 CH	137	{
c9e055ac HVR	138	.phy_id = 0x0007c0a0, /* OUI=0x00800f, Model#=0x0a */
	139	.phy_id_mask = 0xfffffff0,
	140	.name = "SMSC LAN83C185",
	141
	142	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	143	\| SUPPORTED_Asym_Pause),
	144	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	145
	146	/* basic functions */
	147	.config_aneg = genphy_config_aneg,
	148	.read_status = genphy_read_status,
48c41b99	149	.config_init = smsc_phy_config_init,
21009686	150	.soft_reset = smsc_phy_reset,
c9e055ac HVR	151
c9e055ac HVR	152	/* IRQ related */
48c41b99 SG	153	.ack_interrupt = smsc_phy_ack_interrupt,
48c41b99 SG	154	.config_intr = smsc_phy_config_intr,
c9e055ac	155
c64d2a9a SG	156	.suspend = genphy_suspend,
	157	.resume = genphy_resume,
	158
c9e055ac	159	.driver = { .owner = THIS_MODULE, }
d5bf9071	160	}, {
4d9b1a02 SG	161	.phy_id = 0x0007c0b0, /* OUI=0x00800f, Model#=0x0b */
	162	.phy_id_mask = 0xfffffff0,
	163	.name = "SMSC LAN8187",
	164
	165	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	166	\| SUPPORTED_Asym_Pause),
	167	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	168
	169	/* basic functions */
	170	.config_aneg = genphy_config_aneg,
	171	.read_status = genphy_read_status,
	172	.config_init = smsc_phy_config_init,
21009686	173	.soft_reset = smsc_phy_reset,
4d9b1a02 SG	174
	175	/* IRQ related */
	176	.ack_interrupt = smsc_phy_ack_interrupt,
	177	.config_intr = smsc_phy_config_intr,
	178
c64d2a9a SG	179	.suspend = genphy_suspend,
	180	.resume = genphy_resume,
	181
4d9b1a02	182	.driver = { .owner = THIS_MODULE, }
d5bf9071	183	}, {
4d9b1a02 SG	184	.phy_id = 0x0007c0c0, /* OUI=0x00800f, Model#=0x0c */
	185	.phy_id_mask = 0xfffffff0,
	186	.name = "SMSC LAN8700",
	187
	188	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	189	\| SUPPORTED_Asym_Pause),
	190	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	191
	192	/* basic functions */
	193	.config_aneg = genphy_config_aneg,
	194	.read_status = genphy_read_status,
	195	.config_init = smsc_phy_config_init,
21009686	196	.soft_reset = smsc_phy_reset,
4d9b1a02 SG	197
	198	/* IRQ related */
	199	.ack_interrupt = smsc_phy_ack_interrupt,
	200	.config_intr = smsc_phy_config_intr,
	201
c64d2a9a SG	202	.suspend = genphy_suspend,
	203	.resume = genphy_resume,
	204
4d9b1a02	205	.driver = { .owner = THIS_MODULE, }
d5bf9071	206	}, {
fd9abb3d SG	207	.phy_id = 0x0007c0d0, /* OUI=0x00800f, Model#=0x0d */
	208	.phy_id_mask = 0xfffffff0,
	209	.name = "SMSC LAN911x Internal PHY",
	210
	211	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	212	\| SUPPORTED_Asym_Pause),
	213	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	214
	215	/* basic functions */
	216	.config_aneg = genphy_config_aneg,
	217	.read_status = genphy_read_status,
698244ac	218	.config_init = lan911x_config_init,
fd9abb3d SG	219
	220	/* IRQ related */
	221	.ack_interrupt = smsc_phy_ack_interrupt,
	222	.config_intr = smsc_phy_config_intr,
	223
c64d2a9a SG	224	.suspend = genphy_suspend,
	225	.resume = genphy_resume,
	226
fd9abb3d	227	.driver = { .owner = THIS_MODULE, }
d5bf9071	228	}, {
e072b639 SG	229	.phy_id = 0x0007c0f0, /* OUI=0x00800f, Model#=0x0f */
	230	.phy_id_mask = 0xfffffff0,
	231	.name = "SMSC LAN8710/LAN8720",
	232
	233	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	234	\| SUPPORTED_Asym_Pause),
	235	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	236
	237	/* basic functions */
	238	.config_aneg = genphy_config_aneg,
4223dbff	239	.read_status = lan87xx_read_status,
4257d583	240	.config_init = smsc_phy_config_init,
21009686	241	.soft_reset = smsc_phy_reset,
e072b639 SG	242
	243	/* IRQ related */
	244	.ack_interrupt = smsc_phy_ack_interrupt,
	245	.config_intr = smsc_phy_config_intr,
	246
	247	.suspend = genphy_suspend,
	248	.resume = genphy_resume,
	249
	250	.driver = { .owner = THIS_MODULE, }
d5bf9071	251	} };
e072b639	252
50fd7150	253	module_phy_driver(smsc_phy_driver);
c9e055ac HVR	254
	255	MODULE_DESCRIPTION("SMSC PHY driver");
	256	MODULE_AUTHOR("Herbert Valerio Riedel");
	257	MODULE_LICENSE("GPL");
	258
cf93c945	259	static struct mdio_device_id __maybe_unused smsc_tbl[] = {
4e4f10f6 DW	260	{ 0x0007c0a0, 0xfffffff0 },
	261	{ 0x0007c0b0, 0xfffffff0 },
	262	{ 0x0007c0c0, 0xfffffff0 },
	263	{ 0x0007c0d0, 0xfffffff0 },
	264	{ 0x0007c0f0, 0xfffffff0 },
	265	{ }
	266	};
	267
	268	MODULE_DEVICE_TABLE(mdio, smsc_tbl);