[deliverable/linux.git] / drivers / net / gianfar_mii.c

/*
 * drivers/net/gianfar_mii.c
 *
 * Gianfar Ethernet Driver -- MIIM bus implementation
 * Provides Bus interface for MIIM regs
 *
 * Author: Andy Fleming
 * Maintainer: Kumar Gala
 *
 * Copyright (c) 2002-2004 Freescale Semiconductor, Inc.
 *
 * 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.
 *
 */

#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/errno.h>
#include <linux/unistd.h>
#include <linux/slab.h>
#include <linux/interrupt.h>
#include <linux/init.h>
#include <linux/delay.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/skbuff.h>
#include <linux/spinlock.h>
#include <linux/mm.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/crc32.h>
#include <linux/mii.h>
#include <linux/phy.h>

#include <asm/io.h>
#include <asm/irq.h>
#include <asm/uaccess.h>

#include "gianfar.h"
#include "gianfar_mii.h"

/*
 * Write value to the PHY at mii_id at register regnum,
 * on the bus attached to the local interface, which may be different from the
 * generic mdio bus (tied to a single interface), waiting until the write is
 * done before returning. This is helpful in programming interfaces like
 * the TBI which control interfaces like onchip SERDES and are always tied to
 * the local mdio pins, which may not be the same as system mdio bus, used for
 * controlling the external PHYs, for example.
 */
int gfar_local_mdio_write(struct gfar_mii __iomem *regs, int mii_id,
			  int regnum, u16 value)
{
	/* Set the PHY address and the register address we want to write */
	gfar_write(&regs->miimadd, (mii_id << 8) | regnum);

	/* Write out the value we want */
	gfar_write(&regs->miimcon, value);

	/* Wait for the transaction to finish */
	while (gfar_read(&regs->miimind) & MIIMIND_BUSY)
		cpu_relax();

	return 0;
}

/*
 * Read the bus for PHY at addr mii_id, register regnum, and
 * return the value.  Clears miimcom first.  All PHY operation
 * done on the bus attached to the local interface,
 * which may be different from the generic mdio bus
 * This is helpful in programming interfaces like
 * the TBI which, inturn, control interfaces like onchip SERDES
 * and are always tied to the local mdio pins, which may not be the
 * same as system mdio bus, used for controlling the external PHYs, for eg.
 */
int gfar_local_mdio_read(struct gfar_mii __iomem *regs, int mii_id, int regnum)
{
	u16 value;

	/* Set the PHY address and the register address we want to read */
	gfar_write(&regs->miimadd, (mii_id << 8) | regnum);

	/* Clear miimcom, and then initiate a read */
	gfar_write(&regs->miimcom, 0);
	gfar_write(&regs->miimcom, MII_READ_COMMAND);

	/* Wait for the transaction to finish */
	while (gfar_read(&regs->miimind) & (MIIMIND_NOTVALID | MIIMIND_BUSY))
		cpu_relax();

	/* Grab the value of the register from miimstat */
	value = gfar_read(&regs->miimstat);

	return value;
}

/* Write value to the PHY at mii_id at register regnum,
 * on the bus, waiting until the write is done before returning.
 * All PHY configuration is done through the TSEC1 MIIM regs */
int gfar_mdio_write(struct mii_bus *bus, int mii_id, int regnum, u16 value)
{
	struct gfar_mii __iomem *regs = (void __iomem *)bus->priv;

	/* Write to the local MII regs */
	return(gfar_local_mdio_write(regs, mii_id, regnum, value));
}

/* Read the bus for PHY at addr mii_id, register regnum, and
 * return the value.  Clears miimcom first.  All PHY
 * configuration has to be done through the TSEC1 MIIM regs */
int gfar_mdio_read(struct mii_bus *bus, int mii_id, int regnum)
{
	struct gfar_mii __iomem *regs = (void __iomem *)bus->priv;

	/* Read the local MII regs */
	return(gfar_local_mdio_read(regs, mii_id, regnum));
}

/* Reset the MIIM registers, and wait for the bus to free */
static int gfar_mdio_reset(struct mii_bus *bus)
{
	struct gfar_mii __iomem *regs = (void __iomem *)bus->priv;
	unsigned int timeout = PHY_INIT_TIMEOUT;

	mutex_lock(&bus->mdio_lock);

	/* Reset the management interface */
	gfar_write(&regs->miimcfg, MIIMCFG_RESET);

	/* Setup the MII Mgmt clock speed */
	gfar_write(&regs->miimcfg, MIIMCFG_INIT_VALUE);

	/* Wait until the bus is free */
	while ((gfar_read(&regs->miimind) & MIIMIND_BUSY) &&
			--timeout)
		cpu_relax();

	mutex_unlock(&bus->mdio_lock);

	if(timeout == 0) {
		printk(KERN_ERR "%s: The MII Bus is stuck!\n",
				bus->name);
		return -EBUSY;
	}

	return 0;
}


static int gfar_mdio_probe(struct device *dev)
{
	struct platform_device *pdev = to_platform_device(dev);
	struct gianfar_mdio_data *pdata;
	struct gfar_mii __iomem *regs;
	struct gfar __iomem *enet_regs;
	struct mii_bus *new_bus;
	struct resource *r;
	int i, err = 0;

	if (NULL == dev)
		return -EINVAL;

	new_bus = mdiobus_alloc();
	if (NULL == new_bus)
		return -ENOMEM;

	new_bus->name = "Gianfar MII Bus",
	new_bus->read = &gfar_mdio_read,
	new_bus->write = &gfar_mdio_write,
	new_bus->reset = &gfar_mdio_reset,
	snprintf(new_bus->id, MII_BUS_ID_SIZE, "%x", pdev->id);

	pdata = (struct gianfar_mdio_data *)pdev->dev.platform_data;

	if (NULL == pdata) {
		printk(KERN_ERR "gfar mdio %d: Missing platform data!\n", pdev->id);
		return -ENODEV;
	}

	r = platform_get_resource(pdev, IORESOURCE_MEM, 0);

	/* Set the PHY base address */
	regs = ioremap(r->start, sizeof (struct gfar_mii));

	if (NULL == regs) {
		err = -ENOMEM;
		goto reg_map_fail;
	}

	new_bus->priv = (void __force *)regs;

	new_bus->irq = pdata->irq;

	new_bus->parent = dev;
	dev_set_drvdata(dev, new_bus);

	/*
	 * This is mildly evil, but so is our hardware for doing this.
	 * Also, we have to cast back to struct gfar_mii because of
	 * definition weirdness done in gianfar.h.
	 */
	enet_regs = (struct gfar __iomem *)
		((char *)regs - offsetof(struct gfar, gfar_mii_regs));

	/* Scan the bus, looking for an empty spot for TBIPA */
	gfar_write(&enet_regs->tbipa, 0);
	for (i = PHY_MAX_ADDR; i > 0; i--) {
		u32 phy_id;

		err = get_phy_id(new_bus, i, &phy_id);
		if (err)
			goto bus_register_fail;

		if (phy_id == 0xffffffff)
			break;
	}

	/* The bus is full.  We don't support using 31 PHYs, sorry */
	if (i == 0) {
		err = -EBUSY;

		goto bus_register_fail;
	}

	gfar_write(&enet_regs->tbipa, i);

	err = mdiobus_register(new_bus);

	if (0 != err) {
		printk (KERN_ERR "%s: Cannot register as MDIO bus\n",
				new_bus->name);
		goto bus_register_fail;
	}

	return 0;

bus_register_fail:
	iounmap(regs);
reg_map_fail:
	mdiobus_free(new_bus);

	return err;
}


static int gfar_mdio_remove(struct device *dev)
{
	struct mii_bus *bus = dev_get_drvdata(dev);

	mdiobus_unregister(bus);

	dev_set_drvdata(dev, NULL);

	iounmap((void __iomem *)bus->priv);
	bus->priv = NULL;
	mdiobus_free(bus);

	return 0;
}

static struct device_driver gianfar_mdio_driver = {
	.name = "fsl-gianfar_mdio",
	.bus = &platform_bus_type,
	.probe = gfar_mdio_probe,
	.remove = gfar_mdio_remove,
};

int __init gfar_mdio_init(void)
{
	return driver_register(&gianfar_mdio_driver);
}

void gfar_mdio_exit(void)
{
	driver_unregister(&gianfar_mdio_driver);
}
Commit	Line	Data
6aa20a22	1	/*
bb40dcbb AF	2	* drivers/net/gianfar_mii.c
	3	*
	4	* Gianfar Ethernet Driver -- MIIM bus implementation
	5	* Provides Bus interface for MIIM regs
	6	*
	7	* Author: Andy Fleming
4c8d3d99	8	* Maintainer: Kumar Gala
bb40dcbb AF	9	*
	10	* Copyright (c) 2002-2004 Freescale Semiconductor, Inc.
	11	*
	12	* This program is free software; you can redistribute it and/or modify it
	13	* under the terms of the GNU General Public License as published by the
	14	* Free Software Foundation; either version 2 of the License, or (at your
	15	* option) any later version.
	16	*
	17	*/
	18
bb40dcbb	19	#include <linux/kernel.h>
bb40dcbb AF	20	#include <linux/string.h>
	21	#include <linux/errno.h>
	22	#include <linux/unistd.h>
	23	#include <linux/slab.h>
	24	#include <linux/interrupt.h>
	25	#include <linux/init.h>
	26	#include <linux/delay.h>
	27	#include <linux/netdevice.h>
	28	#include <linux/etherdevice.h>
	29	#include <linux/skbuff.h>
	30	#include <linux/spinlock.h>
	31	#include <linux/mm.h>
	32	#include <linux/module.h>
d052d1be	33	#include <linux/platform_device.h>
bb40dcbb AF	34	#include <linux/crc32.h>
	35	#include <linux/mii.h>
	36	#include <linux/phy.h>
	37
	38	#include <asm/io.h>
	39	#include <asm/irq.h>
	40	#include <asm/uaccess.h>
	41
	42	#include "gianfar.h"
	43	#include "gianfar_mii.h"
	44
d3c12873 KJ	45	/*
	46	* Write value to the PHY at mii_id at register regnum,
	47	* on the bus attached to the local interface, which may be different from the
	48	* generic mdio bus (tied to a single interface), waiting until the write is
	49	* done before returning. This is helpful in programming interfaces like
	50	* the TBI which control interfaces like onchip SERDES and are always tied to
	51	* the local mdio pins, which may not be the same as system mdio bus, used for
	52	* controlling the external PHYs, for example.
	53	*/
fdb26629	54	int gfar_local_mdio_write(struct gfar_mii __iomem *regs, int mii_id,
d3c12873	55	int regnum, u16 value)
bb40dcbb	56	{
bb40dcbb AF	57	/* Set the PHY address and the register address we want to write */
	58	gfar_write(&regs->miimadd, (mii_id << 8) \| regnum);
	59
	60	/* Write out the value we want */
	61	gfar_write(&regs->miimcon, value);
	62
	63	/* Wait for the transaction to finish */
	64	while (gfar_read(&regs->miimind) & MIIMIND_BUSY)
	65	cpu_relax();
	66
	67	return 0;
	68	}
	69
d3c12873 KJ	70	/*
	71	* Read the bus for PHY at addr mii_id, register regnum, and
	72	* return the value. Clears miimcom first. All PHY operation
	73	* done on the bus attached to the local interface,
	74	* which may be different from the generic mdio bus
	75	* This is helpful in programming interfaces like
	76	* the TBI which, inturn, control interfaces like onchip SERDES
	77	* and are always tied to the local mdio pins, which may not be the
	78	* same as system mdio bus, used for controlling the external PHYs, for eg.
	79	*/
fdb26629	80	int gfar_local_mdio_read(struct gfar_mii __iomem *regs, int mii_id, int regnum)
bb40dcbb	81	{
bb40dcbb AF	82	u16 value;
	83
	84	/* Set the PHY address and the register address we want to read */
	85	gfar_write(&regs->miimadd, (mii_id << 8) \| regnum);
	86
	87	/* Clear miimcom, and then initiate a read */
	88	gfar_write(&regs->miimcom, 0);
	89	gfar_write(&regs->miimcom, MII_READ_COMMAND);
	90
	91	/* Wait for the transaction to finish */
	92	while (gfar_read(&regs->miimind) & (MIIMIND_NOTVALID \| MIIMIND_BUSY))
	93	cpu_relax();
	94
	95	/* Grab the value of the register from miimstat */
	96	value = gfar_read(&regs->miimstat);
	97
	98	return value;
	99	}
	100
d3c12873 KJ	101	/* Write value to the PHY at mii_id at register regnum,
	102	* on the bus, waiting until the write is done before returning.
	103	* All PHY configuration is done through the TSEC1 MIIM regs */
	104	int gfar_mdio_write(struct mii_bus *bus, int mii_id, int regnum, u16 value)
	105	{
	106	struct gfar_mii __iomem regs = (void __iomem )bus->priv;
	107
	108	/* Write to the local MII regs */
	109	return(gfar_local_mdio_write(regs, mii_id, regnum, value));
	110	}
	111
	112	/* Read the bus for PHY at addr mii_id, register regnum, and
	113	* return the value. Clears miimcom first. All PHY
	114	* configuration has to be done through the TSEC1 MIIM regs */
	115	int gfar_mdio_read(struct mii_bus *bus, int mii_id, int regnum)
	116	{
	117	struct gfar_mii __iomem regs = (void __iomem )bus->priv;
	118
	119	/* Read the local MII regs */
	120	return(gfar_local_mdio_read(regs, mii_id, regnum));
	121	}
bb40dcbb AF	122
bb40dcbb AF	123	/* Reset the MIIM registers, and wait for the bus to free */
d0313587	124	static int gfar_mdio_reset(struct mii_bus *bus)
bb40dcbb	125	{
cc8c6e37	126	struct gfar_mii __iomem regs = (void __iomem )bus->priv;
bb40dcbb AF	127	unsigned int timeout = PHY_INIT_TIMEOUT;
bb40dcbb AF	128
15cf6dde	129	mutex_lock(&bus->mdio_lock);
bb40dcbb AF	130
	131	/* Reset the management interface */
	132	gfar_write(&regs->miimcfg, MIIMCFG_RESET);
	133
	134	/* Setup the MII Mgmt clock speed */
	135	gfar_write(&regs->miimcfg, MIIMCFG_INIT_VALUE);
	136
	137	/* Wait until the bus is free */
	138	while ((gfar_read(&regs->miimind) & MIIMIND_BUSY) &&
baac03d9	139	--timeout)
bb40dcbb AF	140	cpu_relax();
bb40dcbb AF	141
15cf6dde	142	mutex_unlock(&bus->mdio_lock);
bb40dcbb	143
baac03d9	144	if(timeout == 0) {
bb40dcbb AF	145	printk(KERN_ERR "%s: The MII Bus is stuck!\n",
	146	bus->name);
	147	return -EBUSY;
	148	}
	149
	150	return 0;
	151	}
	152
	153
d0313587	154	static int gfar_mdio_probe(struct device *dev)
bb40dcbb AF	155	{
	156	struct platform_device *pdev = to_platform_device(dev);
	157	struct gianfar_mdio_data *pdata;
cc8c6e37	158	struct gfar_mii __iomem *regs;
d0313587	159	struct gfar __iomem *enet_regs;
bb40dcbb	160	struct mii_bus *new_bus;
1d532677	161	struct resource *r;
d0313587	162	int i, err = 0;
bb40dcbb AF	163
	164	if (NULL == dev)
	165	return -EINVAL;
	166
298cf9be	167	new_bus = mdiobus_alloc();
bb40dcbb AF	168	if (NULL == new_bus)
	169	return -ENOMEM;
	170
	171	new_bus->name = "Gianfar MII Bus",
	172	new_bus->read = &gfar_mdio_read,
	173	new_bus->write = &gfar_mdio_write,
	174	new_bus->reset = &gfar_mdio_reset,
9d9326d3	175	snprintf(new_bus->id, MII_BUS_ID_SIZE, "%x", pdev->id);
bb40dcbb AF	176
	177	pdata = (struct gianfar_mdio_data *)pdev->dev.platform_data;
	178
	179	if (NULL == pdata) {
	180	printk(KERN_ERR "gfar mdio %d: Missing platform data!\n", pdev->id);
	181	return -ENODEV;
	182	}
	183
1d532677 KG	184	r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1d532677 KG	185
bb40dcbb	186	/* Set the PHY base address */
cc8c6e37	187	regs = ioremap(r->start, sizeof (struct gfar_mii));
bb40dcbb AF	188
	189	if (NULL == regs) {
	190	err = -ENOMEM;
	191	goto reg_map_fail;
	192	}
	193
cc8c6e37	194	new_bus->priv = (void __force *)regs;
bb40dcbb AF	195
	196	new_bus->irq = pdata->irq;
	197
18ee49dd	198	new_bus->parent = dev;
bb40dcbb AF	199	dev_set_drvdata(dev, new_bus);
bb40dcbb AF	200
d0313587 PG	201	/*
	202	* This is mildly evil, but so is our hardware for doing this.
	203	* Also, we have to cast back to struct gfar_mii because of
	204	* definition weirdness done in gianfar.h.
	205	*/
	206	enet_regs = (struct gfar __iomem *)
	207	((char *)regs - offsetof(struct gfar, gfar_mii_regs));
	208
	209	/* Scan the bus, looking for an empty spot for TBIPA */
	210	gfar_write(&enet_regs->tbipa, 0);
	211	for (i = PHY_MAX_ADDR; i > 0; i--) {
	212	u32 phy_id;
d0313587	213
ac7198bb AF	214	err = get_phy_id(new_bus, i, &phy_id);
	215	if (err)
	216	goto bus_register_fail;
d0313587 PG	217
	218	if (phy_id == 0xffffffff)
	219	break;
	220	}
	221
	222	/* The bus is full. We don't support using 31 PHYs, sorry */
ac7198bb AF	223	if (i == 0) {
	224	err = -EBUSY;
	225
	226	goto bus_register_fail;
	227	}
d0313587 PG	228
	229	gfar_write(&enet_regs->tbipa, i);
	230
bb40dcbb AF	231	err = mdiobus_register(new_bus);
	232
	233	if (0 != err) {
6aa20a22	234	printk (KERN_ERR "%s: Cannot register as MDIO bus\n",
bb40dcbb AF	235	new_bus->name);
	236	goto bus_register_fail;
	237	}
	238
	239	return 0;
	240
	241	bus_register_fail:
cc8c6e37	242	iounmap(regs);
bb40dcbb	243	reg_map_fail:
298cf9be	244	mdiobus_free(new_bus);
bb40dcbb AF	245
	246	return err;
	247	}
	248
	249
d0313587	250	static int gfar_mdio_remove(struct device *dev)
bb40dcbb AF	251	{
	252	struct mii_bus *bus = dev_get_drvdata(dev);
	253
	254	mdiobus_unregister(bus);
	255
	256	dev_set_drvdata(dev, NULL);
	257
cc8c6e37	258	iounmap((void __iomem *)bus->priv);
bb40dcbb	259	bus->priv = NULL;
298cf9be	260	mdiobus_free(bus);
bb40dcbb AF	261
	262	return 0;
	263	}
	264
	265	static struct device_driver gianfar_mdio_driver = {
	266	.name = "fsl-gianfar_mdio",
	267	.bus = &platform_bus_type,
	268	.probe = gfar_mdio_probe,
	269	.remove = gfar_mdio_remove,
	270	};
	271
	272	int __init gfar_mdio_init(void)
	273	{
	274	return driver_register(&gianfar_mdio_driver);
	275	}
	276
b9daf6c0	277	void gfar_mdio_exit(void)
bb40dcbb AF	278	{
	279	driver_unregister(&gianfar_mdio_driver);
	280	}