[linux-2.6-block.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 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,

	.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	= 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, }
}, {
	.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	93	/*
776829de IP	94	* The LAN87xx suffers from rare absence of the ENERGYON-bit when Ethernet cable
	95	* plugs in while LAN87xx is in Energy Detect Power-Down mode. This leads to
	96	* unstable detection of plugging in Ethernet cable.
	97	* This workaround disables Energy Detect Power-Down mode and waiting for
	98	* response on link pulses to detect presence of plugged Ethernet cable.
	99	* The Energy Detect Power-Down mode is enabled again in the end of procedure to
	100	* save approximately 220 mW of power if cable is unplugged.
4223dbff PT	101	*/
4223dbff PT	102	static int lan87xx_read_status(struct phy_device *phydev)
698244ac	103	{
4223dbff	104	int err = genphy_read_status(phydev);
776829de	105	int i;
4223dbff PT	106
	107	if (!phydev->link) {
	108	/* Disable EDPD to wake up PHY */
	109	int rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
	110	if (rc < 0)
	111	return rc;
	112
	113	rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
	114	rc & ~MII_LAN83C185_EDPWRDOWN);
	115	if (rc < 0)
	116	return rc;
	117
776829de IP	118	/* Wait max 640 ms to detect energy */
	119	for (i = 0; i < 64; i++) {
	120	/* Sleep to allow link test pulses to be sent */
	121	msleep(10);
	122	rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
	123	if (rc < 0)
	124	return rc;
	125	if (rc & MII_LAN83C185_ENERGYON)
	126	break;
ff94c742	127	}
4223dbff PT	128
	129	/* Re-enable EDPD */
	130	rc = phy_read(phydev, MII_LAN83C185_CTRL_STATUS);
	131	if (rc < 0)
	132	return rc;
	133
	134	rc = phy_write(phydev, MII_LAN83C185_CTRL_STATUS,
	135	rc \| MII_LAN83C185_EDPWRDOWN);
	136	if (rc < 0)
	137	return rc;
	138	}
	139
	140	return err;
698244ac	141	}
c9e055ac	142
d5bf9071 CH	143	static struct phy_driver smsc_phy_driver[] = {
d5bf9071 CH	144	{
c9e055ac HVR	145	.phy_id = 0x0007c0a0, /* OUI=0x00800f, Model#=0x0a */
	146	.phy_id_mask = 0xfffffff0,
	147	.name = "SMSC LAN83C185",
	148
	149	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	150	\| SUPPORTED_Asym_Pause),
	151	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	152
	153	/* basic functions */
	154	.config_aneg = genphy_config_aneg,
	155	.read_status = genphy_read_status,
48c41b99	156	.config_init = smsc_phy_config_init,
21009686	157	.soft_reset = smsc_phy_reset,
c9e055ac HVR	158
c9e055ac HVR	159	/* IRQ related */
48c41b99 SG	160	.ack_interrupt = smsc_phy_ack_interrupt,
48c41b99 SG	161	.config_intr = smsc_phy_config_intr,
c9e055ac	162
c64d2a9a SG	163	.suspend = genphy_suspend,
	164	.resume = genphy_resume,
	165
c9e055ac	166	.driver = { .owner = THIS_MODULE, }
d5bf9071	167	}, {
4d9b1a02 SG	168	.phy_id = 0x0007c0b0, /* OUI=0x00800f, Model#=0x0b */
	169	.phy_id_mask = 0xfffffff0,
	170	.name = "SMSC LAN8187",
	171
	172	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	173	\| SUPPORTED_Asym_Pause),
	174	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	175
	176	/* basic functions */
	177	.config_aneg = genphy_config_aneg,
	178	.read_status = genphy_read_status,
	179	.config_init = smsc_phy_config_init,
21009686	180	.soft_reset = smsc_phy_reset,
4d9b1a02 SG	181
	182	/* IRQ related */
	183	.ack_interrupt = smsc_phy_ack_interrupt,
	184	.config_intr = smsc_phy_config_intr,
	185
c64d2a9a SG	186	.suspend = genphy_suspend,
	187	.resume = genphy_resume,
	188
4d9b1a02	189	.driver = { .owner = THIS_MODULE, }
d5bf9071	190	}, {
4d9b1a02 SG	191	.phy_id = 0x0007c0c0, /* OUI=0x00800f, Model#=0x0c */
	192	.phy_id_mask = 0xfffffff0,
	193	.name = "SMSC LAN8700",
	194
	195	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	196	\| SUPPORTED_Asym_Pause),
	197	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	198
	199	/* basic functions */
	200	.config_aneg = genphy_config_aneg,
776829de	201	.read_status = lan87xx_read_status,
4d9b1a02	202	.config_init = smsc_phy_config_init,
21009686	203	.soft_reset = smsc_phy_reset,
4d9b1a02 SG	204
	205	/* IRQ related */
	206	.ack_interrupt = smsc_phy_ack_interrupt,
	207	.config_intr = smsc_phy_config_intr,
	208
c64d2a9a SG	209	.suspend = genphy_suspend,
	210	.resume = genphy_resume,
	211
4d9b1a02	212	.driver = { .owner = THIS_MODULE, }
d5bf9071	213	}, {
fd9abb3d SG	214	.phy_id = 0x0007c0d0, /* OUI=0x00800f, Model#=0x0d */
	215	.phy_id_mask = 0xfffffff0,
	216	.name = "SMSC LAN911x Internal PHY",
	217
	218	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	219	\| SUPPORTED_Asym_Pause),
	220	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	221
	222	/* basic functions */
	223	.config_aneg = genphy_config_aneg,
	224	.read_status = genphy_read_status,
698244ac	225	.config_init = lan911x_config_init,
fd9abb3d SG	226
	227	/* IRQ related */
	228	.ack_interrupt = smsc_phy_ack_interrupt,
	229	.config_intr = smsc_phy_config_intr,
	230
c64d2a9a SG	231	.suspend = genphy_suspend,
	232	.resume = genphy_resume,
	233
fd9abb3d	234	.driver = { .owner = THIS_MODULE, }
d5bf9071	235	}, {
e072b639 SG	236	.phy_id = 0x0007c0f0, /* OUI=0x00800f, Model#=0x0f */
	237	.phy_id_mask = 0xfffffff0,
	238	.name = "SMSC LAN8710/LAN8720",
	239
	240	.features = (PHY_BASIC_FEATURES \| SUPPORTED_Pause
	241	\| SUPPORTED_Asym_Pause),
	242	.flags = PHY_HAS_INTERRUPT \| PHY_HAS_MAGICANEG,
	243
	244	/* basic functions */
	245	.config_aneg = genphy_config_aneg,
4223dbff	246	.read_status = lan87xx_read_status,
4257d583	247	.config_init = smsc_phy_config_init,
21009686	248	.soft_reset = smsc_phy_reset,
e072b639 SG	249
	250	/* IRQ related */
	251	.ack_interrupt = smsc_phy_ack_interrupt,
	252	.config_intr = smsc_phy_config_intr,
	253
	254	.suspend = genphy_suspend,
	255	.resume = genphy_resume,
	256
	257	.driver = { .owner = THIS_MODULE, }
d5bf9071	258	} };
e072b639	259
50fd7150	260	module_phy_driver(smsc_phy_driver);
c9e055ac HVR	261
	262	MODULE_DESCRIPTION("SMSC PHY driver");
	263	MODULE_AUTHOR("Herbert Valerio Riedel");
	264	MODULE_LICENSE("GPL");
	265
cf93c945	266	static struct mdio_device_id __maybe_unused smsc_tbl[] = {
4e4f10f6 DW	267	{ 0x0007c0a0, 0xfffffff0 },
	268	{ 0x0007c0b0, 0xfffffff0 },
	269	{ 0x0007c0c0, 0xfffffff0 },
	270	{ 0x0007c0d0, 0xfffffff0 },
	271	{ 0x0007c0f0, 0xfffffff0 },
	272	{ }
	273	};
	274
	275	MODULE_DEVICE_TABLE(mdio, smsc_tbl);