[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_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);
	}

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

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

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

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

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

	.suspend	= genphy_suspend,
	.resume		= genphy_resume,

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

static int __init smsc_init(void)
{
	return phy_drivers_register(smsc_phy_driver,
		ARRAY_SIZE(smsc_phy_driver));
}

static void __exit smsc_exit(void)
{
	return phy_drivers_unregister(smsc_phy_driver,
		ARRAY_SIZE(smsc_phy_driver));
}

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

module_init(smsc_init);
module_exit(smsc_exit);

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