[linux-2.6-block.git] / drivers / net / ibm_newemac / rgmii.c

/*
 * drivers/net/ibm_newemac/rgmii.c
 *
 * Driver for PowerPC 4xx on-chip ethernet controller, RGMII bridge support.
 *
 * Copyright 2007 Benjamin Herrenschmidt, IBM Corp.
 *                <benh@kernel.crashing.org>
 *
 * Based on the arch/ppc version of the driver:
 *
 * Copyright (c) 2004, 2005 Zultys Technologies.
 * Eugene Surovegin <eugene.surovegin@zultys.com> or <ebs@ebshome.net>
 *
 * Based on original work by
 * 	Matt Porter <mporter@kernel.crashing.org>
 * 	Copyright 2004 MontaVista Software, 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/ethtool.h>
#include <asm/io.h>

#include "emac.h"
#include "debug.h"

// XXX FIXME: Axon seems to support a subset of the RGMII, we
// thus need to take that into account and possibly change some
// of the bit settings below that don't seem to quite match the
// AXON spec

/* RGMIIx_FER */
#define RGMII_FER_MASK(idx)	(0x7 << ((idx) * 4))
#define RGMII_FER_RTBI(idx)	(0x4 << ((idx) * 4))
#define RGMII_FER_RGMII(idx)	(0x5 << ((idx) * 4))
#define RGMII_FER_TBI(idx)	(0x6 << ((idx) * 4))
#define RGMII_FER_GMII(idx)	(0x7 << ((idx) * 4))
#define RGMII_FER_MII(idx)	RGMII_FER_GMII(idx)

/* RGMIIx_SSR */
#define RGMII_SSR_MASK(idx)	(0x7 << ((idx) * 8))
#define RGMII_SSR_100(idx)	(0x2 << ((idx) * 8))
#define RGMII_SSR_1000(idx)	(0x4 << ((idx) * 8))

/* RGMII bridge supports only GMII/TBI and RGMII/RTBI PHYs */
static inline int rgmii_valid_mode(int phy_mode)
{
	return  phy_mode == PHY_MODE_GMII ||
		phy_mode == PHY_MODE_MII ||
		phy_mode == PHY_MODE_RGMII ||
		phy_mode == PHY_MODE_TBI ||
		phy_mode == PHY_MODE_RTBI;
}

static inline const char *rgmii_mode_name(int mode)
{
	switch (mode) {
	case PHY_MODE_RGMII:
		return "RGMII";
	case PHY_MODE_TBI:
		return "TBI";
	case PHY_MODE_GMII:
		return "GMII";
	case PHY_MODE_MII:
		return "MII";
	case PHY_MODE_RTBI:
		return "RTBI";
	default:
		BUG();
	}
}

static inline u32 rgmii_mode_mask(int mode, int input)
{
	switch (mode) {
	case PHY_MODE_RGMII:
		return RGMII_FER_RGMII(input);
	case PHY_MODE_TBI:
		return RGMII_FER_TBI(input);
	case PHY_MODE_GMII:
		return RGMII_FER_GMII(input);
	case PHY_MODE_MII:
		return RGMII_FER_MII(input);
	case PHY_MODE_RTBI:
		return RGMII_FER_RTBI(input);
	default:
		BUG();
	}
}

int __devinit rgmii_attach(struct of_device *ofdev, int input, int mode)
{
	struct rgmii_instance *dev = dev_get_drvdata(&ofdev->dev);
	struct rgmii_regs __iomem *p = dev->base;

	RGMII_DBG(dev, "attach(%d)" NL, input);

	/* Check if we need to attach to a RGMII */
	if (input < 0 || !rgmii_valid_mode(mode)) {
		printk(KERN_ERR "%s: unsupported settings !\n",
		       ofdev->node->full_name);
		return -ENODEV;
	}

	mutex_lock(&dev->lock);

	/* Enable this input */
	out_be32(&p->fer, in_be32(&p->fer) | rgmii_mode_mask(mode, input));

	printk(KERN_NOTICE "%s: input %d in %s mode\n",
	       ofdev->node->full_name, input, rgmii_mode_name(mode));

	++dev->users;

	mutex_unlock(&dev->lock);

	return 0;
}

void rgmii_set_speed(struct of_device *ofdev, int input, int speed)
{
	struct rgmii_instance *dev = dev_get_drvdata(&ofdev->dev);
	struct rgmii_regs __iomem *p = dev->base;
	u32 ssr;

	mutex_lock(&dev->lock);

	ssr = in_be32(&p->ssr) & ~RGMII_SSR_MASK(input);

	RGMII_DBG(dev, "speed(%d, %d)" NL, input, speed);

	if (speed == SPEED_1000)
		ssr |= RGMII_SSR_1000(input);
	else if (speed == SPEED_100)
		ssr |= RGMII_SSR_100(input);

	out_be32(&p->ssr, ssr);

	mutex_unlock(&dev->lock);
}

void rgmii_get_mdio(struct of_device *ofdev, int input)
{
	struct rgmii_instance *dev = dev_get_drvdata(&ofdev->dev);
	struct rgmii_regs __iomem *p = dev->base;
	u32 fer;

	RGMII_DBG2(dev, "get_mdio(%d)" NL, input);

	if (!(dev->flags & EMAC_RGMII_FLAG_HAS_MDIO))
		return;

	mutex_lock(&dev->lock);

	fer = in_be32(&p->fer);
	fer |= 0x00080000u >> input;
	out_be32(&p->fer, fer);
	(void)in_be32(&p->fer);

	DBG2(dev, " fer = 0x%08x\n", fer);
}

void rgmii_put_mdio(struct of_device *ofdev, int input)
{
	struct rgmii_instance *dev = dev_get_drvdata(&ofdev->dev);
	struct rgmii_regs __iomem *p = dev->base;
	u32 fer;

	RGMII_DBG2(dev, "put_mdio(%d)" NL, input);

	if (!(dev->flags & EMAC_RGMII_FLAG_HAS_MDIO))
		return;

	fer = in_be32(&p->fer);
	fer &= ~(0x00080000u >> input);
	out_be32(&p->fer, fer);
	(void)in_be32(&p->fer);

	DBG2(dev, " fer = 0x%08x\n", fer);

	mutex_unlock(&dev->lock);
}

void rgmii_detach(struct of_device *ofdev, int input)
{
	struct rgmii_instance *dev = dev_get_drvdata(&ofdev->dev);
	struct rgmii_regs __iomem *p;

	BUG_ON(!dev || dev->users == 0);
	p = dev->base;

	mutex_lock(&dev->lock);

	RGMII_DBG(dev, "detach(%d)" NL, input);

	/* Disable this input */
	out_be32(&p->fer, in_be32(&p->fer) & ~RGMII_FER_MASK(input));

	--dev->users;

	mutex_unlock(&dev->lock);
}

int rgmii_get_regs_len(struct of_device *ofdev)
{
	return sizeof(struct emac_ethtool_regs_subhdr) +
		sizeof(struct rgmii_regs);
}

void *rgmii_dump_regs(struct of_device *ofdev, void *buf)
{
	struct rgmii_instance *dev = dev_get_drvdata(&ofdev->dev);
	struct emac_ethtool_regs_subhdr *hdr = buf;
	struct rgmii_regs *regs = (struct rgmii_regs *)(hdr + 1);

	hdr->version = 0;
	hdr->index = 0; /* for now, are there chips with more than one
			 * rgmii ? if yes, then we'll add a cell_index
			 * like we do for emac
			 */
	memcpy_fromio(regs, dev->base, sizeof(struct rgmii_regs));
	return regs + 1;
}


static int __devinit rgmii_probe(struct of_device *ofdev,
				 const struct of_device_id *match)
{
	struct device_node *np = ofdev->node;
	struct rgmii_instance *dev;
	struct resource regs;
	int rc;

	rc = -ENOMEM;
	dev = kzalloc(sizeof(struct rgmii_instance), GFP_KERNEL);
	if (dev == NULL) {
		printk(KERN_ERR "%s: could not allocate RGMII device!\n",
		       np->full_name);
		goto err_gone;
	}

	mutex_init(&dev->lock);
	dev->ofdev = ofdev;

	rc = -ENXIO;
	if (of_address_to_resource(np, 0, &regs)) {
		printk(KERN_ERR "%s: Can't get registers address\n",
		       np->full_name);
		goto err_free;
	}

	rc = -ENOMEM;
	dev->base = (struct rgmii_regs __iomem *)ioremap(regs.start,
						 sizeof(struct rgmii_regs));
	if (dev->base == NULL) {
		printk(KERN_ERR "%s: Can't map device registers!\n",
		       np->full_name);
		goto err_free;
	}

	/* Check for RGMII flags */
	if (of_get_property(ofdev->node, "has-mdio", NULL))
		dev->flags |= EMAC_RGMII_FLAG_HAS_MDIO;

	/* CAB lacks the right properties, fix this up */
	if (of_device_is_compatible(ofdev->node, "ibm,rgmii-axon"))
		dev->flags |= EMAC_RGMII_FLAG_HAS_MDIO;

	DBG2(dev, " Boot FER = 0x%08x, SSR = 0x%08x\n",
	     in_be32(&dev->base->fer), in_be32(&dev->base->ssr));

	/* Disable all inputs by default */
	out_be32(&dev->base->fer, 0);

	printk(KERN_INFO
	       "RGMII %s initialized with%s MDIO support\n",
	       ofdev->node->full_name,
	       (dev->flags & EMAC_RGMII_FLAG_HAS_MDIO) ? "" : "out");

	wmb();
	dev_set_drvdata(&ofdev->dev, dev);

	return 0;

 err_free:
	kfree(dev);
 err_gone:
	return rc;
}

static int __devexit rgmii_remove(struct of_device *ofdev)
{
	struct rgmii_instance *dev = dev_get_drvdata(&ofdev->dev);

	dev_set_drvdata(&ofdev->dev, NULL);

	WARN_ON(dev->users != 0);

	iounmap(dev->base);
	kfree(dev);

	return 0;
}

static struct of_device_id rgmii_match[] =
{
	{
		.compatible	= "ibm,rgmii",
	},
	{
		.type		= "emac-rgmii",
	},
	{},
};

static struct of_platform_driver rgmii_driver = {
	.name = "emac-rgmii",
	.match_table = rgmii_match,

	.probe = rgmii_probe,
	.remove = rgmii_remove,
};

int __init rgmii_init(void)
{
	return of_register_platform_driver(&rgmii_driver);
}

void rgmii_exit(void)
{
	of_unregister_platform_driver(&rgmii_driver);
}
Commit	Line	Data
1d3bb996 DG	1	/*
	2	* drivers/net/ibm_newemac/rgmii.c
	3	*
	4	* Driver for PowerPC 4xx on-chip ethernet controller, RGMII bridge support.
	5	*
17cf803a BH	6	* Copyright 2007 Benjamin Herrenschmidt, IBM Corp.
	7	* <benh@kernel.crashing.org>
	8	*
	9	* Based on the arch/ppc version of the driver:
	10	*
1d3bb996 DG	11	* Copyright (c) 2004, 2005 Zultys Technologies.
	12	* Eugene Surovegin <eugene.surovegin@zultys.com> or <ebs@ebshome.net>
	13	*
	14	* Based on original work by
	15	* Matt Porter <mporter@kernel.crashing.org>
	16	* Copyright 2004 MontaVista Software, Inc.
	17	*
	18	* This program is free software; you can redistribute it and/or modify it
	19	* under the terms of the GNU General Public License as published by the
	20	* Free Software Foundation; either version 2 of the License, or (at your
	21	* option) any later version.
	22	*
	23	*/
	24	#include <linux/kernel.h>
	25	#include <linux/ethtool.h>
	26	#include <asm/io.h>
	27
	28	#include "emac.h"
	29	#include "debug.h"
	30
	31	// XXX FIXME: Axon seems to support a subset of the RGMII, we
	32	// thus need to take that into account and possibly change some
	33	// of the bit settings below that don't seem to quite match the
	34	// AXON spec
	35
	36	/* RGMIIx_FER */
	37	#define RGMII_FER_MASK(idx) (0x7 << ((idx) * 4))
	38	#define RGMII_FER_RTBI(idx) (0x4 << ((idx) * 4))
	39	#define RGMII_FER_RGMII(idx) (0x5 << ((idx) * 4))
	40	#define RGMII_FER_TBI(idx) (0x6 << ((idx) * 4))
	41	#define RGMII_FER_GMII(idx) (0x7 << ((idx) * 4))
004ea683	42	#define RGMII_FER_MII(idx) RGMII_FER_GMII(idx)
1d3bb996 DG	43
	44	/* RGMIIx_SSR */
	45	#define RGMII_SSR_MASK(idx) (0x7 << ((idx) * 8))
	46	#define RGMII_SSR_100(idx) (0x2 << ((idx) * 8))
	47	#define RGMII_SSR_1000(idx) (0x4 << ((idx) * 8))
	48
	49	/* RGMII bridge supports only GMII/TBI and RGMII/RTBI PHYs */
	50	static inline int rgmii_valid_mode(int phy_mode)
	51	{
	52	return phy_mode == PHY_MODE_GMII \|\|
004ea683	53	phy_mode == PHY_MODE_MII \|\|
1d3bb996 DG	54	phy_mode == PHY_MODE_RGMII \|\|
	55	phy_mode == PHY_MODE_TBI \|\|
	56	phy_mode == PHY_MODE_RTBI;
	57	}
	58
	59	static inline const char *rgmii_mode_name(int mode)
	60	{
	61	switch (mode) {
	62	case PHY_MODE_RGMII:
	63	return "RGMII";
	64	case PHY_MODE_TBI:
	65	return "TBI";
	66	case PHY_MODE_GMII:
	67	return "GMII";
004ea683 GE	68	case PHY_MODE_MII:
004ea683 GE	69	return "MII";
1d3bb996 DG	70	case PHY_MODE_RTBI:
	71	return "RTBI";
	72	default:
	73	BUG();
	74	}
	75	}
	76
	77	static inline u32 rgmii_mode_mask(int mode, int input)
	78	{
	79	switch (mode) {
	80	case PHY_MODE_RGMII:
	81	return RGMII_FER_RGMII(input);
	82	case PHY_MODE_TBI:
	83	return RGMII_FER_TBI(input);
	84	case PHY_MODE_GMII:
	85	return RGMII_FER_GMII(input);
004ea683 GE	86	case PHY_MODE_MII:
004ea683 GE	87	return RGMII_FER_MII(input);
1d3bb996 DG	88	case PHY_MODE_RTBI:
	89	return RGMII_FER_RTBI(input);
	90	default:
	91	BUG();
	92	}
	93	}
	94
	95	int __devinit rgmii_attach(struct of_device *ofdev, int input, int mode)
	96	{
	97	struct rgmii_instance *dev = dev_get_drvdata(&ofdev->dev);
eb4d84f1	98	struct rgmii_regs __iomem *p = dev->base;
1d3bb996 DG	99
	100	RGMII_DBG(dev, "attach(%d)" NL, input);
	101
	102	/* Check if we need to attach to a RGMII */
	103	if (input < 0 \|\| !rgmii_valid_mode(mode)) {
	104	printk(KERN_ERR "%s: unsupported settings !\n",
	105	ofdev->node->full_name);
	106	return -ENODEV;
	107	}
	108
	109	mutex_lock(&dev->lock);
	110
	111	/* Enable this input */
	112	out_be32(&p->fer, in_be32(&p->fer) \| rgmii_mode_mask(mode, input));
	113
	114	printk(KERN_NOTICE "%s: input %d in %s mode\n",
	115	ofdev->node->full_name, input, rgmii_mode_name(mode));
	116
	117	++dev->users;
	118
	119	mutex_unlock(&dev->lock);
	120
	121	return 0;
	122	}
	123
	124	void rgmii_set_speed(struct of_device *ofdev, int input, int speed)
	125	{
	126	struct rgmii_instance *dev = dev_get_drvdata(&ofdev->dev);
eb4d84f1	127	struct rgmii_regs __iomem *p = dev->base;
1d3bb996 DG	128	u32 ssr;
	129
	130	mutex_lock(&dev->lock);
	131
	132	ssr = in_be32(&p->ssr) & ~RGMII_SSR_MASK(input);
	133
	134	RGMII_DBG(dev, "speed(%d, %d)" NL, input, speed);
	135
	136	if (speed == SPEED_1000)
	137	ssr \|= RGMII_SSR_1000(input);
	138	else if (speed == SPEED_100)
	139	ssr \|= RGMII_SSR_100(input);
	140
	141	out_be32(&p->ssr, ssr);
	142
	143	mutex_unlock(&dev->lock);
	144	}
	145
	146	void rgmii_get_mdio(struct of_device *ofdev, int input)
	147	{
	148	struct rgmii_instance *dev = dev_get_drvdata(&ofdev->dev);
eb4d84f1	149	struct rgmii_regs __iomem *p = dev->base;
1d3bb996 DG	150	u32 fer;
	151
	152	RGMII_DBG2(dev, "get_mdio(%d)" NL, input);
	153
1f57877a	154	if (!(dev->flags & EMAC_RGMII_FLAG_HAS_MDIO))
1d3bb996 DG	155	return;
	156
	157	mutex_lock(&dev->lock);
	158
	159	fer = in_be32(&p->fer);
	160	fer \|= 0x00080000u >> input;
	161	out_be32(&p->fer, fer);
	162	(void)in_be32(&p->fer);
	163
	164	DBG2(dev, " fer = 0x%08x\n", fer);
	165	}
	166
	167	void rgmii_put_mdio(struct of_device *ofdev, int input)
	168	{
	169	struct rgmii_instance *dev = dev_get_drvdata(&ofdev->dev);
eb4d84f1	170	struct rgmii_regs __iomem *p = dev->base;
1d3bb996 DG	171	u32 fer;
	172
	173	RGMII_DBG2(dev, "put_mdio(%d)" NL, input);
	174
1f57877a	175	if (!(dev->flags & EMAC_RGMII_FLAG_HAS_MDIO))
1d3bb996 DG	176	return;
	177
	178	fer = in_be32(&p->fer);
	179	fer &= ~(0x00080000u >> input);
	180	out_be32(&p->fer, fer);
	181	(void)in_be32(&p->fer);
	182
	183	DBG2(dev, " fer = 0x%08x\n", fer);
	184
	185	mutex_unlock(&dev->lock);
	186	}
	187
51d4a1cc	188	void rgmii_detach(struct of_device *ofdev, int input)
1d3bb996 DG	189	{
1d3bb996 DG	190	struct rgmii_instance *dev = dev_get_drvdata(&ofdev->dev);
0021195c	191	struct rgmii_regs __iomem *p;
1d3bb996 DG	192
1d3bb996 DG	193	BUG_ON(!dev \|\| dev->users == 0);
0021195c JL	194	p = dev->base;
	195
	196	mutex_lock(&dev->lock);
1d3bb996 DG	197
	198	RGMII_DBG(dev, "detach(%d)" NL, input);
	199
	200	/* Disable this input */
	201	out_be32(&p->fer, in_be32(&p->fer) & ~RGMII_FER_MASK(input));
	202
	203	--dev->users;
	204
	205	mutex_unlock(&dev->lock);
	206	}
	207
	208	int rgmii_get_regs_len(struct of_device *ofdev)
	209	{
	210	return sizeof(struct emac_ethtool_regs_subhdr) +
	211	sizeof(struct rgmii_regs);
	212	}
	213
	214	void rgmii_dump_regs(struct of_device ofdev, void *buf)
	215	{
	216	struct rgmii_instance *dev = dev_get_drvdata(&ofdev->dev);
	217	struct emac_ethtool_regs_subhdr *hdr = buf;
	218	struct rgmii_regs regs = (struct rgmii_regs )(hdr + 1);
	219
	220	hdr->version = 0;
	221	hdr->index = 0; /* for now, are there chips with more than one
	222	* rgmii ? if yes, then we'll add a cell_index
	223	* like we do for emac
	224	*/
	225	memcpy_fromio(regs, dev->base, sizeof(struct rgmii_regs));
	226	return regs + 1;
	227	}
	228
	229
	230	static int __devinit rgmii_probe(struct of_device *ofdev,
	231	const struct of_device_id *match)
	232	{
	233	struct device_node *np = ofdev->node;
	234	struct rgmii_instance *dev;
	235	struct resource regs;
	236	int rc;
	237
	238	rc = -ENOMEM;
	239	dev = kzalloc(sizeof(struct rgmii_instance), GFP_KERNEL);
	240	if (dev == NULL) {
	241	printk(KERN_ERR "%s: could not allocate RGMII device!\n",
	242	np->full_name);
	243	goto err_gone;
	244	}
	245
	246	mutex_init(&dev->lock);
	247	dev->ofdev = ofdev;
	248
	249	rc = -ENXIO;
	250	if (of_address_to_resource(np, 0, &regs)) {
	251	printk(KERN_ERR "%s: Can't get registers address\n",
	252	np->full_name);
	253	goto err_free;
	254	}
	255
	256	rc = -ENOMEM;
eb4d84f1	257	dev->base = (struct rgmii_regs __iomem *)ioremap(regs.start,
1d3bb996 DG	258	sizeof(struct rgmii_regs));
	259	if (dev->base == NULL) {
	260	printk(KERN_ERR "%s: Can't map device registers!\n",
	261	np->full_name);
	262	goto err_free;
	263	}
	264
1f57877a BH	265	/* Check for RGMII flags */
	266	if (of_get_property(ofdev->node, "has-mdio", NULL))
	267	dev->flags \|= EMAC_RGMII_FLAG_HAS_MDIO;
	268
	269	/* CAB lacks the right properties, fix this up */
97be91c1	270	if (of_device_is_compatible(ofdev->node, "ibm,rgmii-axon"))
1f57877a	271	dev->flags \|= EMAC_RGMII_FLAG_HAS_MDIO;
1d3bb996 DG	272
	273	DBG2(dev, " Boot FER = 0x%08x, SSR = 0x%08x\n",
	274	in_be32(&dev->base->fer), in_be32(&dev->base->ssr));
	275
	276	/* Disable all inputs by default */
	277	out_be32(&dev->base->fer, 0);
	278
	279	printk(KERN_INFO
1f57877a BH	280	"RGMII %s initialized with%s MDIO support\n",
	281	ofdev->node->full_name,
	282	(dev->flags & EMAC_RGMII_FLAG_HAS_MDIO) ? "" : "out");
1d3bb996 DG	283
	284	wmb();
	285	dev_set_drvdata(&ofdev->dev, dev);
	286
	287	return 0;
	288
	289	err_free:
	290	kfree(dev);
	291	err_gone:
	292	return rc;
	293	}
	294
	295	static int __devexit rgmii_remove(struct of_device *ofdev)
	296	{
	297	struct rgmii_instance *dev = dev_get_drvdata(&ofdev->dev);
	298
	299	dev_set_drvdata(&ofdev->dev, NULL);
	300
	301	WARN_ON(dev->users != 0);
	302
	303	iounmap(dev->base);
	304	kfree(dev);
	305
	306	return 0;
	307	}
	308
	309	static struct of_device_id rgmii_match[] =
	310	{
	311	{
1d3bb996 DG	312	.compatible = "ibm,rgmii",
	313	},
	314	{
	315	.type = "emac-rgmii",
	316	},
	317	{},
	318	};
	319
	320	static struct of_platform_driver rgmii_driver = {
	321	.name = "emac-rgmii",
	322	.match_table = rgmii_match,
	323
	324	.probe = rgmii_probe,
	325	.remove = rgmii_remove,
	326	};
	327
	328	int __init rgmii_init(void)
	329	{
	330	return of_register_platform_driver(&rgmii_driver);
	331	}
	332
	333	void rgmii_exit(void)
	334	{
	335	of_unregister_platform_driver(&rgmii_driver);
	336	}