[deliverable/linux.git] / drivers / net / ethernet / i825xx / lasi_82596.c

/* lasi_82596.c -- driver for the intel 82596 ethernet controller, as
   munged into HPPA boxen .

   This driver is based upon 82596.c, original credits are below...
   but there were too many hoops which HP wants jumped through to
   keep this code in there in a sane manner.

   3 primary sources of the mess --
   1) hppa needs *lots* of cacheline flushing to keep this kind of
   MMIO running.

   2) The 82596 needs to see all of its pointers as their physical
   address.  Thus virt_to_bus/bus_to_virt are *everywhere*.

   3) The implementation HP is using seems to be significantly pickier
   about when and how the command and RX units are started.  some
   command ordering was changed.

   Examination of the mach driver leads one to believe that there
   might be a saner way to pull this off...  anyone who feels like a
   full rewrite can be my guest.

   Split 02/13/2000 Sam Creasey (sammy@oh.verio.com)

   02/01/2000  Initial modifications for parisc by Helge Deller (deller@gmx.de)
   03/02/2000  changes for better/correct(?) cache-flushing (deller)
*/

/* 82596.c: A generic 82596 ethernet driver for linux. */
/*
   Based on Apricot.c
   Written 1994 by Mark Evans.
   This driver is for the Apricot 82596 bus-master interface

   Modularised 12/94 Mark Evans


   Modified to support the 82596 ethernet chips on 680x0 VME boards.
   by Richard Hirst <richard@sleepie.demon.co.uk>
   Renamed to be 82596.c

   980825:  Changed to receive directly in to sk_buffs which are
   allocated at open() time.  Eliminates copy on incoming frames
   (small ones are still copied).  Shared data now held in a
   non-cached page, so we can run on 68060 in copyback mode.

   TBD:
   * look at deferring rx frames rather than discarding (as per tulip)
   * handle tx ring full as per tulip
   * performance test to tune rx_copybreak

   Most of my modifications relate to the braindead big-endian
   implementation by Intel.  When the i596 is operating in
   'big-endian' mode, it thinks a 32 bit value of 0x12345678
   should be stored as 0x56781234.  This is a real pain, when
   you have linked lists which are shared by the 680x0 and the
   i596.

   Driver skeleton
   Written 1993 by Donald Becker.
   Copyright 1993 United States Government as represented by the Director,
   National Security Agency. This software may only be used and distributed
   according to the terms of the GNU General Public License as modified by SRC,
   incorporated herein by reference.

   The author may be reached as becker@scyld.com, or C/O
   Scyld Computing Corporation, 410 Severn Ave., Suite 210, Annapolis MD 21403

 */

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/ptrace.h>
#include <linux/errno.h>
#include <linux/ioport.h>
#include <linux/interrupt.h>
#include <linux/delay.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/skbuff.h>
#include <linux/types.h>
#include <linux/bitops.h>
#include <linux/dma-mapping.h>

#include <asm/io.h>
#include <asm/irq.h>
#include <asm/pdc.h>
#include <asm/parisc-device.h>

#define LASI_82596_DRIVER_VERSION "LASI 82596 driver - Revision: 1.30"

#define PA_I82596_RESET		0	/* Offsets relative to LASI-LAN-Addr.*/
#define PA_CPU_PORT_L_ACCESS	4
#define PA_CHANNEL_ATTENTION	8

#define OPT_SWAP_PORT	0x0001	/* Need to wordswp on the MPU port */

#define DMA_ALLOC                        dma_alloc_noncoherent
#define DMA_FREE                         dma_free_noncoherent
#define DMA_WBACK(ndev, addr, len) \
	do { dma_cache_sync((ndev)->dev.parent, (void *)addr, len, DMA_TO_DEVICE); } while (0)

#define DMA_INV(ndev, addr, len) \
	do { dma_cache_sync((ndev)->dev.parent, (void *)addr, len, DMA_FROM_DEVICE); } while (0)

#define DMA_WBACK_INV(ndev, addr, len) \
	do { dma_cache_sync((ndev)->dev.parent, (void *)addr, len, DMA_BIDIRECTIONAL); } while (0)

#define SYSBUS      0x0000006c;

/* big endian CPU, 82596 "big" endian mode */
#define SWAP32(x)   (((u32)(x)<<16) | ((((u32)(x)))>>16))
#define SWAP16(x)   (x)

#include "lib82596.c"

MODULE_AUTHOR("Richard Hirst");
MODULE_DESCRIPTION("i82596 driver");
MODULE_LICENSE("GPL");
module_param(i596_debug, int, 0);
MODULE_PARM_DESC(i596_debug, "lasi_82596 debug mask");

static inline void ca(struct net_device *dev)
{
	gsc_writel(0, dev->base_addr + PA_CHANNEL_ATTENTION);
}


static void mpu_port(struct net_device *dev, int c, dma_addr_t x)
{
	struct i596_private *lp = netdev_priv(dev);

	u32 v = (u32) (c) | (u32) (x);
	u16 a, b;

	if (lp->options & OPT_SWAP_PORT) {
		a = v >> 16;
		b = v & 0xffff;
	} else {
		a = v & 0xffff;
		b = v >> 16;
	}

	gsc_writel(a, dev->base_addr + PA_CPU_PORT_L_ACCESS);
	udelay(1);
	gsc_writel(b, dev->base_addr + PA_CPU_PORT_L_ACCESS);
}

#define LAN_PROM_ADDR	0xF0810000

static int
lan_init_chip(struct parisc_device *dev)
{
	struct	net_device *netdevice;
	struct i596_private *lp;
	int	retval;
	int i;

	if (!dev->irq) {
		printk(KERN_ERR "%s: IRQ not found for i82596 at 0x%lx\n",
			__FILE__, (unsigned long)dev->hpa.start);
		return -ENODEV;
	}

	printk(KERN_INFO "Found i82596 at 0x%lx, IRQ %d\n",
			(unsigned long)dev->hpa.start, dev->irq);

	netdevice = alloc_etherdev(sizeof(struct i596_private));
	if (!netdevice)
		return -ENOMEM;
	SET_NETDEV_DEV(netdevice, &dev->dev);
	parisc_set_drvdata (dev, netdevice);

	netdevice->base_addr = dev->hpa.start;
	netdevice->irq = dev->irq;

	if (pdc_lan_station_id(netdevice->dev_addr, netdevice->base_addr)) {
		for (i = 0; i < 6; i++) {
			netdevice->dev_addr[i] = gsc_readb(LAN_PROM_ADDR + i);
		}
		printk(KERN_INFO
		       "%s: MAC of HP700 LAN read from EEPROM\n", __FILE__);
	}

	lp = netdev_priv(netdevice);
	lp->options = dev->id.sversion == 0x72 ? OPT_SWAP_PORT : 0;

	retval = i82596_probe(netdevice);
	if (retval) {
		free_netdev(netdevice);
		return -ENODEV;
	}
	return retval;
}

static int lan_remove_chip(struct parisc_device *pdev)
{
	struct net_device *dev = parisc_get_drvdata(pdev);
	struct i596_private *lp = netdev_priv(dev);

	unregister_netdev (dev);
	DMA_FREE(&pdev->dev, sizeof(struct i596_private),
		 (void *)lp->dma, lp->dma_addr);
	free_netdev (dev);
	return 0;
}

static struct parisc_device_id lan_tbl[] = {
	{ HPHW_FIO, HVERSION_REV_ANY_ID, HVERSION_ANY_ID, 0x0008a },
	{ HPHW_FIO, HVERSION_REV_ANY_ID, HVERSION_ANY_ID, 0x00072 },
	{ 0, }
};

MODULE_DEVICE_TABLE(parisc, lan_tbl);

static struct parisc_driver lan_driver = {
	.name		= "lasi_82596",
	.id_table	= lan_tbl,
	.probe		= lan_init_chip,
	.remove         = lan_remove_chip,
};

static int lasi_82596_init(void)
{
	printk(KERN_INFO LASI_82596_DRIVER_VERSION "\n");
	return register_parisc_driver(&lan_driver);
}

module_init(lasi_82596_init);

static void __exit lasi_82596_exit(void)
{
	unregister_parisc_driver(&lan_driver);
}

module_exit(lasi_82596_exit);
Commit	Line	Data
1da177e4 LT	1	/* lasi_82596.c -- driver for the intel 82596 ethernet controller, as
	2	munged into HPPA boxen .
	3
	4	This driver is based upon 82596.c, original credits are below...
	5	but there were too many hoops which HP wants jumped through to
	6	keep this code in there in a sane manner.
	7
6aa20a22	8	3 primary sources of the mess --
1da177e4 LT	9	1) hppa needs lots of cacheline flushing to keep this kind of
	10	MMIO running.
	11
	12	2) The 82596 needs to see all of its pointers as their physical
	13	address. Thus virt_to_bus/bus_to_virt are everywhere.
	14
6aa20a22	15	3) The implementation HP is using seems to be significantly pickier
1da177e4 LT	16	about when and how the command and RX units are started. some
	17	command ordering was changed.
	18
	19	Examination of the mach driver leads one to believe that there
	20	might be a saner way to pull this off... anyone who feels like a
	21	full rewrite can be my guest.
	22
	23	Split 02/13/2000 Sam Creasey (sammy@oh.verio.com)
6aa20a22	24
1da177e4 LT	25	02/01/2000 Initial modifications for parisc by Helge Deller (deller@gmx.de)
	26	03/02/2000 changes for better/correct(?) cache-flushing (deller)
	27	*/
	28
	29	/* 82596.c: A generic 82596 ethernet driver for linux. */
	30	/*
	31	Based on Apricot.c
	32	Written 1994 by Mark Evans.
	33	This driver is for the Apricot 82596 bus-master interface
	34
	35	Modularised 12/94 Mark Evans
	36
	37
	38	Modified to support the 82596 ethernet chips on 680x0 VME boards.
	39	by Richard Hirst <richard@sleepie.demon.co.uk>
	40	Renamed to be 82596.c
	41
	42	980825: Changed to receive directly in to sk_buffs which are
	43	allocated at open() time. Eliminates copy on incoming frames
	44	(small ones are still copied). Shared data now held in a
	45	non-cached page, so we can run on 68060 in copyback mode.
	46
	47	TBD:
	48	* look at deferring rx frames rather than discarding (as per tulip)
	49	* handle tx ring full as per tulip
af901ca1	50	* performance test to tune rx_copybreak
1da177e4 LT	51
	52	Most of my modifications relate to the braindead big-endian
	53	implementation by Intel. When the i596 is operating in
	54	'big-endian' mode, it thinks a 32 bit value of 0x12345678
	55	should be stored as 0x56781234. This is a real pain, when
	56	you have linked lists which are shared by the 680x0 and the
	57	i596.
	58
	59	Driver skeleton
	60	Written 1993 by Donald Becker.
	61	Copyright 1993 United States Government as represented by the Director,
	62	National Security Agency. This software may only be used and distributed
	63	according to the terms of the GNU General Public License as modified by SRC,
	64	incorporated herein by reference.
	65
	66	The author may be reached as becker@scyld.com, or C/O
	67	Scyld Computing Corporation, 410 Severn Ave., Suite 210, Annapolis MD 21403
	68
	69	*/
	70
	71	#include <linux/module.h>
	72	#include <linux/kernel.h>
	73	#include <linux/string.h>
	74	#include <linux/ptrace.h>
	75	#include <linux/errno.h>
	76	#include <linux/ioport.h>
1da177e4 LT	77	#include <linux/interrupt.h>
	78	#include <linux/delay.h>
	79	#include <linux/netdevice.h>
	80	#include <linux/etherdevice.h>
	81	#include <linux/skbuff.h>
1da177e4 LT	82	#include <linux/types.h>
1da177e4 LT	83	#include <linux/bitops.h>
76fb9278	84	#include <linux/dma-mapping.h>
1da177e4 LT	85
1da177e4 LT	86	#include <asm/io.h>
1da177e4 LT	87	#include <asm/irq.h>
1da177e4 LT	88	#include <asm/pdc.h>
1da177e4 LT	89	#include <asm/parisc-device.h>
	90
	91	#define LASI_82596_DRIVER_VERSION "LASI 82596 driver - Revision: 1.30"
	92
1da177e4 LT	93	#define PA_I82596_RESET 0 /* Offsets relative to LASI-LAN-Addr.*/
	94	#define PA_CPU_PORT_L_ACCESS 4
	95	#define PA_CHANNEL_ATTENTION 8
	96
2187f287	97	#define OPT_SWAP_PORT 0x0001 /* Need to wordswp on the MPU port */
1da177e4	98
2187f287 TB	99	#define DMA_ALLOC dma_alloc_noncoherent
	100	#define DMA_FREE dma_free_noncoherent
	101	#define DMA_WBACK(ndev, addr, len) \
	102	do { dma_cache_sync((ndev)->dev.parent, (void *)addr, len, DMA_TO_DEVICE); } while (0)
1da177e4	103
2187f287 TB	104	#define DMA_INV(ndev, addr, len) \
2187f287 TB	105	do { dma_cache_sync((ndev)->dev.parent, (void *)addr, len, DMA_FROM_DEVICE); } while (0)
1da177e4	106
2187f287 TB	107	#define DMA_WBACK_INV(ndev, addr, len) \
	108	do { dma_cache_sync((ndev)->dev.parent, (void *)addr, len, DMA_BIDIRECTIONAL); } while (0)
	109
	110	#define SYSBUS 0x0000006c;
	111
	112	/* big endian CPU, 82596 "big" endian mode */
	113	#define SWAP32(x) (((u32)(x)<<16) \| ((((u32)(x)))>>16))
	114	#define SWAP16(x) (x)
1da177e4	115
2187f287	116	#include "lib82596.c"
1da177e4 LT	117
	118	MODULE_AUTHOR("Richard Hirst");
	119	MODULE_DESCRIPTION("i82596 driver");
	120	MODULE_LICENSE("GPL");
8d3b33f6	121	module_param(i596_debug, int, 0);
1da177e4 LT	122	MODULE_PARM_DESC(i596_debug, "lasi_82596 debug mask");
1da177e4 LT	123
2187f287	124	static inline void ca(struct net_device *dev)
1da177e4 LT	125	{
	126	gsc_writel(0, dev->base_addr + PA_CHANNEL_ATTENTION);
	127	}
	128
	129
2187f287	130	static void mpu_port(struct net_device *dev, int c, dma_addr_t x)
1da177e4	131	{
2187f287	132	struct i596_private *lp = netdev_priv(dev);
1da177e4 LT	133
	134	u32 v = (u32) (c) \| (u32) (x);
	135	u16 a, b;
	136
	137	if (lp->options & OPT_SWAP_PORT) {
	138	a = v >> 16;
	139	b = v & 0xffff;
	140	} else {
	141	a = v & 0xffff;
	142	b = v >> 16;
	143	}
	144
	145	gsc_writel(a, dev->base_addr + PA_CPU_PORT_L_ACCESS);
	146	udelay(1);
	147	gsc_writel(b, dev->base_addr + PA_CPU_PORT_L_ACCESS);
	148	}
	149
1da177e4 LT	150	#define LAN_PROM_ADDR 0xF0810000
1da177e4 LT	151
58b10698	152	static int
1da177e4 LT	153	lan_init_chip(struct parisc_device *dev)
	154	{
	155	struct net_device *netdevice;
2187f287	156	struct i596_private *lp;
1da177e4	157	int retval;
2187f287	158	int i;
6aa20a22	159
1da177e4 LT	160	if (!dev->irq) {
1da177e4 LT	161	printk(KERN_ERR "%s: IRQ not found for i82596 at 0x%lx\n",
78a658d9	162	__FILE__, (unsigned long)dev->hpa.start);
1da177e4 LT	163	return -ENODEV;
	164	}
	165
78a658d9 AB	166	printk(KERN_INFO "Found i82596 at 0x%lx, IRQ %d\n",
78a658d9 AB	167	(unsigned long)dev->hpa.start, dev->irq);
1da177e4	168
2187f287	169	netdevice = alloc_etherdev(sizeof(struct i596_private));
1da177e4 LT	170	if (!netdevice)
1da177e4 LT	171	return -ENOMEM;
2187f287 TB	172	SET_NETDEV_DEV(netdevice, &dev->dev);
2187f287 TB	173	parisc_set_drvdata (dev, netdevice);
1da177e4	174
53f01bba	175	netdevice->base_addr = dev->hpa.start;
1da177e4 LT	176	netdevice->irq = dev->irq;
1da177e4 LT	177
2187f287 TB	178	if (pdc_lan_station_id(netdevice->dev_addr, netdevice->base_addr)) {
	179	for (i = 0; i < 6; i++) {
	180	netdevice->dev_addr[i] = gsc_readb(LAN_PROM_ADDR + i);
	181	}
	182	printk(KERN_INFO
	183	"%s: MAC of HP700 LAN read from EEPROM\n", __FILE__);
	184	}
	185
	186	lp = netdev_priv(netdevice);
	187	lp->options = dev->id.sversion == 0x72 ? OPT_SWAP_PORT : 0;
	188
	189	retval = i82596_probe(netdevice);
1da177e4 LT	190	if (retval) {
	191	free_netdev(netdevice);
	192	return -ENODEV;
	193	}
1da177e4 LT	194	return retval;
	195	}
	196
58b10698	197	static int lan_remove_chip(struct parisc_device *pdev)
2187f287 TB	198	{
	199	struct net_device *dev = parisc_get_drvdata(pdev);
	200	struct i596_private *lp = netdev_priv(dev);
	201
	202	unregister_netdev (dev);
	203	DMA_FREE(&pdev->dev, sizeof(struct i596_private),
	204	(void *)lp->dma, lp->dma_addr);
	205	free_netdev (dev);
	206	return 0;
	207	}
1da177e4 LT	208
	209	static struct parisc_device_id lan_tbl[] = {
	210	{ HPHW_FIO, HVERSION_REV_ANY_ID, HVERSION_ANY_ID, 0x0008a },
	211	{ HPHW_FIO, HVERSION_REV_ANY_ID, HVERSION_ANY_ID, 0x00072 },
	212	{ 0, }
	213	};
	214
	215	MODULE_DEVICE_TABLE(parisc, lan_tbl);
	216
	217	static struct parisc_driver lan_driver = {
bdad1f83	218	.name = "lasi_82596",
1da177e4 LT	219	.id_table = lan_tbl,
1da177e4 LT	220	.probe = lan_init_chip,
58b10698	221	.remove = lan_remove_chip,
1da177e4 LT	222	};
1da177e4 LT	223
58b10698	224	static int lasi_82596_init(void)
1da177e4	225	{
2187f287	226	printk(KERN_INFO LASI_82596_DRIVER_VERSION "\n");
1da177e4 LT	227	return register_parisc_driver(&lan_driver);
	228	}
	229
	230	module_init(lasi_82596_init);
	231
	232	static void __exit lasi_82596_exit(void)
	233	{
1da177e4 LT	234	unregister_parisc_driver(&lan_driver);
	235	}
	236
	237	module_exit(lasi_82596_exit);