[deliverable/linux.git] / drivers / net / ethernet / natsemi / jazzsonic.c

/*
 * jazzsonic.c
 *
 * (C) 2005 Finn Thain
 *
 * Converted to DMA API, and (from the mac68k project) introduced
 * dhd's support for 16-bit cards.
 *
 * (C) 1996,1998 by Thomas Bogendoerfer (tsbogend@alpha.franken.de)
 *
 * This driver is based on work from Andreas Busse, but most of
 * the code is rewritten.
 *
 * (C) 1995 by Andreas Busse (andy@waldorf-gmbh.de)
 *
 * A driver for the onboard Sonic ethernet controller on Mips Jazz
 * systems (Acer Pica-61, Mips Magnum 4000, Olivetti M700 and
 * perhaps others, too)
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/types.h>
#include <linux/fcntl.h>
#include <linux/gfp.h>
#include <linux/interrupt.h>
#include <linux/init.h>
#include <linux/ioport.h>
#include <linux/in.h>
#include <linux/string.h>
#include <linux/delay.h>
#include <linux/errno.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/skbuff.h>
#include <linux/platform_device.h>
#include <linux/dma-mapping.h>
#include <linux/slab.h>

#include <asm/bootinfo.h>
#include <asm/pgtable.h>
#include <asm/io.h>
#include <asm/dma.h>
#include <asm/jazz.h>
#include <asm/jazzdma.h>

static char jazz_sonic_string[] = "jazzsonic";

#define SONIC_MEM_SIZE	0x100

#include "sonic.h"

/*
 * Macros to access SONIC registers
 */
#define SONIC_READ(reg) (*((volatile unsigned int *)dev->base_addr+reg))

#define SONIC_WRITE(reg,val)						\
do {									\
	*((volatile unsigned int *)dev->base_addr+(reg)) = (val);		\
} while (0)


/* use 0 for production, 1 for verification, >1 for debug */
#ifdef SONIC_DEBUG
static unsigned int sonic_debug = SONIC_DEBUG;
#else
static unsigned int sonic_debug = 1;
#endif

/*
 * We cannot use station (ethernet) address prefixes to detect the
 * sonic controller since these are board manufacturer depended.
 * So we check for known Silicon Revision IDs instead.
 */
static unsigned short known_revisions[] =
{
	0x04,			/* Mips Magnum 4000 */
	0xffff			/* end of list */
};

static int jazzsonic_open(struct net_device* dev)
{
	int retval;

	retval = request_irq(dev->irq, sonic_interrupt, IRQF_DISABLED,
				"sonic", dev);
	if (retval) {
		printk(KERN_ERR "%s: unable to get IRQ %d.\n",
				dev->name, dev->irq);
		return retval;
	}

	retval = sonic_open(dev);
	if (retval)
		free_irq(dev->irq, dev);
	return retval;
}

static int jazzsonic_close(struct net_device* dev)
{
	int err;
	err = sonic_close(dev);
	free_irq(dev->irq, dev);
	return err;
}

static const struct net_device_ops sonic_netdev_ops = {
	.ndo_open		= jazzsonic_open,
	.ndo_stop		= jazzsonic_close,
	.ndo_start_xmit		= sonic_send_packet,
	.ndo_get_stats		= sonic_get_stats,
	.ndo_set_rx_mode	= sonic_multicast_list,
	.ndo_tx_timeout		= sonic_tx_timeout,
	.ndo_change_mtu		= eth_change_mtu,
	.ndo_validate_addr	= eth_validate_addr,
	.ndo_set_mac_address	= eth_mac_addr,
};

static int sonic_probe1(struct net_device *dev)
{
	static unsigned version_printed;
	unsigned int silicon_revision;
	unsigned int val;
	struct sonic_local *lp = netdev_priv(dev);
	int err = -ENODEV;
	int i;

	if (!request_mem_region(dev->base_addr, SONIC_MEM_SIZE, jazz_sonic_string))
		return -EBUSY;

	/*
	 * get the Silicon Revision ID. If this is one of the known
	 * one assume that we found a SONIC ethernet controller at
	 * the expected location.
	 */
	silicon_revision = SONIC_READ(SONIC_SR);
	if (sonic_debug > 1)
		printk("SONIC Silicon Revision = 0x%04x\n",silicon_revision);

	i = 0;
	while (known_revisions[i] != 0xffff &&
	       known_revisions[i] != silicon_revision)
		i++;

	if (known_revisions[i] == 0xffff) {
		printk("SONIC ethernet controller not found (0x%4x)\n",
		       silicon_revision);
		goto out;
	}

	if (sonic_debug  &&  version_printed++ == 0)
		printk(version);

	printk(KERN_INFO "%s: Sonic ethernet found at 0x%08lx, ",
	       dev_name(lp->device), dev->base_addr);

	/*
	 * Put the sonic into software reset, then
	 * retrieve and print the ethernet address.
	 */
	SONIC_WRITE(SONIC_CMD,SONIC_CR_RST);
	SONIC_WRITE(SONIC_CEP,0);
	for (i=0; i<3; i++) {
		val = SONIC_READ(SONIC_CAP0-i);
		dev->dev_addr[i*2] = val;
		dev->dev_addr[i*2+1] = val >> 8;
	}

	err = -ENOMEM;

	/* Initialize the device structure. */

	lp->dma_bitmode = SONIC_BITMODE32;

	/* Allocate the entire chunk of memory for the descriptors.
           Note that this cannot cross a 64K boundary. */
	lp->descriptors = dma_alloc_coherent(lp->device,
					     SIZEOF_SONIC_DESC *
					     SONIC_BUS_SCALE(lp->dma_bitmode),
					     &lp->descriptors_laddr,
					     GFP_KERNEL);
	if (lp->descriptors == NULL)
		goto out;

	/* Now set up the pointers to point to the appropriate places */
	lp->cda = lp->descriptors;
	lp->tda = lp->cda + (SIZEOF_SONIC_CDA
	                     * SONIC_BUS_SCALE(lp->dma_bitmode));
	lp->rda = lp->tda + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
	                     * SONIC_BUS_SCALE(lp->dma_bitmode));
	lp->rra = lp->rda + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
	                     * SONIC_BUS_SCALE(lp->dma_bitmode));

	lp->cda_laddr = lp->descriptors_laddr;
	lp->tda_laddr = lp->cda_laddr + (SIZEOF_SONIC_CDA
	                     * SONIC_BUS_SCALE(lp->dma_bitmode));
	lp->rda_laddr = lp->tda_laddr + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
	                     * SONIC_BUS_SCALE(lp->dma_bitmode));
	lp->rra_laddr = lp->rda_laddr + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
	                     * SONIC_BUS_SCALE(lp->dma_bitmode));

	dev->netdev_ops = &sonic_netdev_ops;
	dev->watchdog_timeo = TX_TIMEOUT;

	/*
	 * clear tally counter
	 */
	SONIC_WRITE(SONIC_CRCT,0xffff);
	SONIC_WRITE(SONIC_FAET,0xffff);
	SONIC_WRITE(SONIC_MPT,0xffff);

	return 0;
out:
	release_mem_region(dev->base_addr, SONIC_MEM_SIZE);
	return err;
}

/*
 * Probe for a SONIC ethernet controller on a Mips Jazz board.
 * Actually probing is superfluous but we're paranoid.
 */
static int jazz_sonic_probe(struct platform_device *pdev)
{
	struct net_device *dev;
	struct sonic_local *lp;
	struct resource *res;
	int err = 0;

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!res)
		return -ENODEV;

	dev = alloc_etherdev(sizeof(struct sonic_local));
	if (!dev)
		return -ENOMEM;

	lp = netdev_priv(dev);
	lp->device = &pdev->dev;
	SET_NETDEV_DEV(dev, &pdev->dev);
	platform_set_drvdata(pdev, dev);

	netdev_boot_setup_check(dev);

	dev->base_addr = res->start;
	dev->irq = platform_get_irq(pdev, 0);
	err = sonic_probe1(dev);
	if (err)
		goto out;
	err = register_netdev(dev);
	if (err)
		goto out1;

	printk("%s: MAC %pM IRQ %d\n", dev->name, dev->dev_addr, dev->irq);

	return 0;

out1:
	release_mem_region(dev->base_addr, SONIC_MEM_SIZE);
out:
	free_netdev(dev);

	return err;
}

MODULE_DESCRIPTION("Jazz SONIC ethernet driver");
module_param(sonic_debug, int, 0);
MODULE_PARM_DESC(sonic_debug, "jazzsonic debug level (1-4)");
MODULE_ALIAS("platform:jazzsonic");

#include "sonic.c"

static int jazz_sonic_device_remove(struct platform_device *pdev)
{
	struct net_device *dev = platform_get_drvdata(pdev);
	struct sonic_local* lp = netdev_priv(dev);

	unregister_netdev(dev);
	dma_free_coherent(lp->device, SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
	                  lp->descriptors, lp->descriptors_laddr);
	release_mem_region(dev->base_addr, SONIC_MEM_SIZE);
	free_netdev(dev);

	return 0;
}

static struct platform_driver jazz_sonic_driver = {
	.probe	= jazz_sonic_probe,
	.remove	= jazz_sonic_device_remove,
	.driver	= {
		.name	= jazz_sonic_string,
		.owner	= THIS_MODULE,
	},
};

module_platform_driver(jazz_sonic_driver);
Commit	Line	Data
1da177e4	1	/*
efcce839 FT	2	* jazzsonic.c
	3	*
	4	* (C) 2005 Finn Thain
	5	*
	6	* Converted to DMA API, and (from the mac68k project) introduced
	7	* dhd's support for 16-bit cards.
1da177e4 LT	8	*
1da177e4 LT	9	* (C) 1996,1998 by Thomas Bogendoerfer (tsbogend@alpha.franken.de)
6aa20a22	10	*
1da177e4 LT	11	* This driver is based on work from Andreas Busse, but most of
1da177e4 LT	12	* the code is rewritten.
6aa20a22	13	*
1da177e4 LT	14	* (C) 1995 by Andreas Busse (andy@waldorf-gmbh.de)
	15	*
	16	* A driver for the onboard Sonic ethernet controller on Mips Jazz
	17	* systems (Acer Pica-61, Mips Magnum 4000, Olivetti M700 and
	18	* perhaps others, too)
	19	*/
	20
	21	#include <linux/kernel.h>
	22	#include <linux/module.h>
	23	#include <linux/types.h>
	24	#include <linux/fcntl.h>
5a0e3ad6	25	#include <linux/gfp.h>
1da177e4 LT	26	#include <linux/interrupt.h>
	27	#include <linux/init.h>
	28	#include <linux/ioport.h>
	29	#include <linux/in.h>
1da177e4 LT	30	#include <linux/string.h>
	31	#include <linux/delay.h>
	32	#include <linux/errno.h>
	33	#include <linux/netdevice.h>
	34	#include <linux/etherdevice.h>
	35	#include <linux/skbuff.h>
d052d1be	36	#include <linux/platform_device.h>
efcce839	37	#include <linux/dma-mapping.h>
5a0e3ad6	38	#include <linux/slab.h>
1da177e4 LT	39
1da177e4 LT	40	#include <asm/bootinfo.h>
1da177e4 LT	41	#include <asm/pgtable.h>
	42	#include <asm/io.h>
	43	#include <asm/dma.h>
	44	#include <asm/jazz.h>
	45	#include <asm/jazzdma.h>
	46
	47	static char jazz_sonic_string[] = "jazzsonic";
1da177e4 LT	48
	49	#define SONIC_MEM_SIZE 0x100
	50
1da177e4 LT	51	#include "sonic.h"
	52
	53	/*
	54	* Macros to access SONIC registers
	55	*/
efcce839	56	#define SONIC_READ(reg) (((volatile unsigned int )dev->base_addr+reg))
1da177e4 LT	57
	58	#define SONIC_WRITE(reg,val) \
	59	do { \
efcce839	60	((volatile unsigned int )dev->base_addr+(reg)) = (val); \
1da177e4 LT	61	} while (0)
	62
	63
efcce839	64	/* use 0 for production, 1 for verification, >1 for debug */
1da177e4 LT	65	#ifdef SONIC_DEBUG
1da177e4 LT	66	static unsigned int sonic_debug = SONIC_DEBUG;
6aa20a22	67	#else
1da177e4 LT	68	static unsigned int sonic_debug = 1;
	69	#endif
	70
1da177e4 LT	71	/*
	72	* We cannot use station (ethernet) address prefixes to detect the
	73	* sonic controller since these are board manufacturer depended.
6aa20a22	74	* So we check for known Silicon Revision IDs instead.
1da177e4 LT	75	*/
	76	static unsigned short known_revisions[] =
	77	{
	78	0x04, /* Mips Magnum 4000 */
	79	0xffff /* end of list */
	80	};
	81
f4d86754 FT	82	static int jazzsonic_open(struct net_device* dev)
f4d86754 FT	83	{
62cd69a1 KV	84	int retval;
	85
	86	retval = request_irq(dev->irq, sonic_interrupt, IRQF_DISABLED,
	87	"sonic", dev);
	88	if (retval) {
	89	printk(KERN_ERR "%s: unable to get IRQ %d.\n",
	90	dev->name, dev->irq);
	91	return retval;
f4d86754	92	}
62cd69a1 KV	93
	94	retval = sonic_open(dev);
	95	if (retval)
	96	free_irq(dev->irq, dev);
	97	return retval;
f4d86754 FT	98	}
	99
	100	static int jazzsonic_close(struct net_device* dev)
	101	{
	102	int err;
	103	err = sonic_close(dev);
	104	free_irq(dev->irq, dev);
	105	return err;
	106	}
	107
502a326f AB	108	static const struct net_device_ops sonic_netdev_ops = {
	109	.ndo_open = jazzsonic_open,
	110	.ndo_stop = jazzsonic_close,
	111	.ndo_start_xmit = sonic_send_packet,
	112	.ndo_get_stats = sonic_get_stats,
afc4b13d	113	.ndo_set_rx_mode = sonic_multicast_list,
502a326f AB	114	.ndo_tx_timeout = sonic_tx_timeout,
	115	.ndo_change_mtu = eth_change_mtu,
	116	.ndo_validate_addr = eth_validate_addr,
	117	.ndo_set_mac_address = eth_mac_addr,
	118	};
	119
6980cbe4	120	static int sonic_probe1(struct net_device *dev)
1da177e4 LT	121	{
	122	static unsigned version_printed;
	123	unsigned int silicon_revision;
	124	unsigned int val;
efcce839	125	struct sonic_local *lp = netdev_priv(dev);
1da177e4 LT	126	int err = -ENODEV;
	127	int i;
	128
efcce839	129	if (!request_mem_region(dev->base_addr, SONIC_MEM_SIZE, jazz_sonic_string))
1da177e4	130	return -EBUSY;
efcce839	131
1da177e4 LT	132	/*
	133	* get the Silicon Revision ID. If this is one of the known
	134	* one assume that we found a SONIC ethernet controller at
	135	* the expected location.
	136	*/
	137	silicon_revision = SONIC_READ(SONIC_SR);
	138	if (sonic_debug > 1)
	139	printk("SONIC Silicon Revision = 0x%04x\n",silicon_revision);
	140
	141	i = 0;
8e95a202 JP	142	while (known_revisions[i] != 0xffff &&
8e95a202 JP	143	known_revisions[i] != silicon_revision)
1da177e4 LT	144	i++;
	145
	146	if (known_revisions[i] == 0xffff) {
	147	printk("SONIC ethernet controller not found (0x%4x)\n",
	148	silicon_revision);
	149	goto out;
	150	}
6aa20a22	151
1da177e4 LT	152	if (sonic_debug && version_printed++ == 0)
	153	printk(version);
	154
c2313557 KS	155	printk(KERN_INFO "%s: Sonic ethernet found at 0x%08lx, ",
c2313557 KS	156	dev_name(lp->device), dev->base_addr);
1da177e4 LT	157
	158	/*
	159	* Put the sonic into software reset, then
	160	* retrieve and print the ethernet address.
	161	*/
	162	SONIC_WRITE(SONIC_CMD,SONIC_CR_RST);
	163	SONIC_WRITE(SONIC_CEP,0);
	164	for (i=0; i<3; i++) {
	165	val = SONIC_READ(SONIC_CAP0-i);
	166	dev->dev_addr[i*2] = val;
	167	dev->dev_addr[i*2+1] = val >> 8;
	168	}
	169
1da177e4	170	err = -ENOMEM;
6aa20a22	171
1da177e4	172	/* Initialize the device structure. */
1da177e4	173
efcce839	174	lp->dma_bitmode = SONIC_BITMODE32;
1da177e4	175
efcce839 FT	176	/* Allocate the entire chunk of memory for the descriptors.
efcce839 FT	177	Note that this cannot cross a 64K boundary. */
d0320f75 JP	178	lp->descriptors = dma_alloc_coherent(lp->device,
	179	SIZEOF_SONIC_DESC *
	180	SONIC_BUS_SCALE(lp->dma_bitmode),
	181	&lp->descriptors_laddr,
	182	GFP_KERNEL);
	183	if (lp->descriptors == NULL)
efcce839	184	goto out;
1da177e4	185
efcce839 FT	186	/* Now set up the pointers to point to the appropriate places */
	187	lp->cda = lp->descriptors;
	188	lp->tda = lp->cda + (SIZEOF_SONIC_CDA
	189	* SONIC_BUS_SCALE(lp->dma_bitmode));
	190	lp->rda = lp->tda + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
	191	* SONIC_BUS_SCALE(lp->dma_bitmode));
	192	lp->rra = lp->rda + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
	193	* SONIC_BUS_SCALE(lp->dma_bitmode));
	194
	195	lp->cda_laddr = lp->descriptors_laddr;
	196	lp->tda_laddr = lp->cda_laddr + (SIZEOF_SONIC_CDA
	197	* SONIC_BUS_SCALE(lp->dma_bitmode));
	198	lp->rda_laddr = lp->tda_laddr + (SIZEOF_SONIC_TD * SONIC_NUM_TDS
	199	* SONIC_BUS_SCALE(lp->dma_bitmode));
	200	lp->rra_laddr = lp->rda_laddr + (SIZEOF_SONIC_RD * SONIC_NUM_RDS
	201	* SONIC_BUS_SCALE(lp->dma_bitmode));
	202
502a326f	203	dev->netdev_ops = &sonic_netdev_ops;
1da177e4 LT	204	dev->watchdog_timeo = TX_TIMEOUT;
	205
	206	/*
	207	* clear tally counter
	208	*/
	209	SONIC_WRITE(SONIC_CRCT,0xffff);
	210	SONIC_WRITE(SONIC_FAET,0xffff);
	211	SONIC_WRITE(SONIC_MPT,0xffff);
	212
	213	return 0;
1da177e4	214	out:
c9145a2d	215	release_mem_region(dev->base_addr, SONIC_MEM_SIZE);
1da177e4 LT	216	return err;
	217	}
	218
	219	/*
	220	* Probe for a SONIC ethernet controller on a Mips Jazz board.
	221	* Actually probing is superfluous but we're paranoid.
	222	*/
6980cbe4	223	static int jazz_sonic_probe(struct platform_device *pdev)
1da177e4 LT	224	{
	225	struct net_device *dev;
	226	struct sonic_local *lp;
ed9f0e0b	227	struct resource *res;
1da177e4	228	int err = 0;
1da177e4	229
ed9f0e0b TB	230	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
ed9f0e0b TB	231	if (!res)
1da177e4 LT	232	return -ENODEV;
1da177e4 LT	233
efcce839	234	dev = alloc_etherdev(sizeof(struct sonic_local));
1da177e4 LT	235	if (!dev)
	236	return -ENOMEM;
	237
efcce839	238	lp = netdev_priv(dev);
3ae5eaec RK	239	lp->device = &pdev->dev;
3ae5eaec RK	240	SET_NETDEV_DEV(dev, &pdev->dev);
4564cba7	241	platform_set_drvdata(pdev, dev);
efcce839	242
1da177e4	243	netdev_boot_setup_check(dev);
1da177e4	244
ed9f0e0b TB	245	dev->base_addr = res->start;
	246	dev->irq = platform_get_irq(pdev, 0);
	247	err = sonic_probe1(dev);
1da177e4 LT	248	if (err)
	249	goto out;
	250	err = register_netdev(dev);
	251	if (err)
	252	goto out1;
	253
e174961c	254	printk("%s: MAC %pM IRQ %d\n", dev->name, dev->dev_addr, dev->irq);
efcce839	255
1da177e4 LT	256	return 0;
	257
	258	out1:
c9145a2d	259	release_mem_region(dev->base_addr, SONIC_MEM_SIZE);
1da177e4 LT	260	out:
	261	free_netdev(dev);
	262
	263	return err;
	264	}
	265
efcce839 FT	266	MODULE_DESCRIPTION("Jazz SONIC ethernet driver");
	267	module_param(sonic_debug, int, 0);
	268	MODULE_PARM_DESC(sonic_debug, "jazzsonic debug level (1-4)");
72abb461	269	MODULE_ALIAS("platform:jazzsonic");
1da177e4	270
1da177e4 LT	271	#include "sonic.c"
1da177e4 LT	272
6980cbe4	273	static int jazz_sonic_device_remove(struct platform_device *pdev)
1da177e4	274	{
3ae5eaec	275	struct net_device *dev = platform_get_drvdata(pdev);
efcce839	276	struct sonic_local* lp = netdev_priv(dev);
1da177e4	277
d74472f0	278	unregister_netdev(dev);
efcce839 FT	279	dma_free_coherent(lp->device, SIZEOF_SONIC_DESC * SONIC_BUS_SCALE(lp->dma_bitmode),
efcce839 FT	280	lp->descriptors, lp->descriptors_laddr);
c9145a2d	281	release_mem_region(dev->base_addr, SONIC_MEM_SIZE);
d74472f0	282	free_netdev(dev);
1da177e4 LT	283
	284	return 0;
	285	}
	286
3ae5eaec	287	static struct platform_driver jazz_sonic_driver = {
1da177e4	288	.probe = jazz_sonic_probe,
6980cbe4	289	.remove = jazz_sonic_device_remove,
3ae5eaec RK	290	.driver = {
3ae5eaec RK	291	.name = jazz_sonic_string,
72abb461	292	.owner = THIS_MODULE,
3ae5eaec	293	},
1da177e4	294	};
efcce839	295
db62f684	296	module_platform_driver(jazz_sonic_driver);