[deliverable/linux.git] / drivers / net / tokenring / tmspci.c

/*
 *  tmspci.c: A generic network driver for TMS380-based PCI token ring cards.
 *
 *  Written 1999 by Adam Fritzler
 *
 *  This software may be used and distributed according to the terms
 *  of the GNU General Public License, incorporated herein by reference.
 *
 *  This driver module supports the following cards:
 *	- SysKonnect TR4/16(+) PCI	(SK-4590)
 *	- SysKonnect TR4/16 PCI		(SK-4591)
 *      - Compaq TR 4/16 PCI
 *      - Thomas-Conrad TC4048 4/16 PCI 
 *      - 3Com 3C339 Token Link Velocity
 *
 *  Maintainer(s):
 *    AF	Adam Fritzler		mid@auk.cx
 *
 *  Modification History:
 *	30-Dec-99	AF	Split off from the tms380tr driver.
 *	22-Jan-00	AF	Updated to use indirect read/writes
 *	23-Nov-00	JG	New PCI API, cleanups
 *
 *  TODO:
 *	1. See if we can use MMIO instead of port accesses
 *
 */

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/pci.h>
#include <linux/init.h>
#include <linux/netdevice.h>
#include <linux/trdevice.h>

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

#include "tms380tr.h"

static char version[] __devinitdata =
"tmspci.c: v1.02 23/11/2000 by Adam Fritzler\n";

#define TMS_PCI_IO_EXTENT 32

struct card_info {
	unsigned char nselout[2]; /* NSELOUT vals for 4mb([0]) and 16mb([1]) */
	char *name;
};

static struct card_info card_info_table[] = {
	{ {0x03, 0x01}, "Compaq 4/16 TR PCI"},
	{ {0x03, 0x01}, "SK NET TR 4/16 PCI"},
	{ {0x03, 0x01}, "Thomas-Conrad TC4048 PCI 4/16"},
	{ {0x03, 0x01}, "3Com Token Link Velocity"},
};

static struct pci_device_id tmspci_pci_tbl[] = {
	{ PCI_VENDOR_ID_COMPAQ, PCI_DEVICE_ID_COMPAQ_TOKENRING, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 },
	{ PCI_VENDOR_ID_SYSKONNECT, PCI_DEVICE_ID_SYSKONNECT_TR, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 1 },
	{ PCI_VENDOR_ID_TCONRAD, PCI_DEVICE_ID_TCONRAD_TOKENRING, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 2 },
	{ PCI_VENDOR_ID_3COM, PCI_DEVICE_ID_3COM_3C339, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 3 },
	{ }			/* Terminating entry */
};
MODULE_DEVICE_TABLE(pci, tmspci_pci_tbl);

MODULE_LICENSE("GPL");

static void tms_pci_read_eeprom(struct net_device *dev);
static unsigned short tms_pci_setnselout_pins(struct net_device *dev);

static unsigned short tms_pci_sifreadb(struct net_device *dev, unsigned short reg)
{
	return inb(dev->base_addr + reg);
}

static unsigned short tms_pci_sifreadw(struct net_device *dev, unsigned short reg)
{
	return inw(dev->base_addr + reg);
}

static void tms_pci_sifwriteb(struct net_device *dev, unsigned short val, unsigned short reg)
{
	outb(val, dev->base_addr + reg);
}

static void tms_pci_sifwritew(struct net_device *dev, unsigned short val, unsigned short reg)
{
	outw(val, dev->base_addr + reg);
}

static int __devinit tms_pci_attach(struct pci_dev *pdev, const struct pci_device_id *ent)
{	
	static int versionprinted;
	struct net_device *dev;
	struct net_local *tp;
	int ret;
	unsigned int pci_irq_line;
	unsigned long pci_ioaddr;
	struct card_info *cardinfo = &card_info_table[ent->driver_data];
	DECLARE_MAC_BUF(mac);

	if (versionprinted++ == 0)
		printk("%s", version);

	if (pci_enable_device(pdev))
		return -EIO;

	/* Remove I/O space marker in bit 0. */
	pci_irq_line = pdev->irq;
	pci_ioaddr = pci_resource_start (pdev, 0);

	/* At this point we have found a valid card. */
	dev = alloc_trdev(sizeof(struct net_local));
	if (!dev)
		return -ENOMEM;

	if (!request_region(pci_ioaddr, TMS_PCI_IO_EXTENT, dev->name)) {
		ret = -EBUSY;
		goto err_out_trdev;
	}

	ret = request_irq(pdev->irq, tms380tr_interrupt, IRQF_SHARED,
			  dev->name, dev);
	if (ret)
		goto err_out_region;

	dev->base_addr	= pci_ioaddr;
	dev->irq 	= pci_irq_line;
	dev->dma	= 0;

	printk("%s: %s\n", dev->name, cardinfo->name);
	printk("%s:    IO: %#4lx  IRQ: %d\n",
	       dev->name, dev->base_addr, dev->irq);
		
	tms_pci_read_eeprom(dev);

	printk("%s:    Ring Station Address: %s\n",
	       dev->name, print_mac(mac, dev->dev_addr));
		
	ret = tmsdev_init(dev, &pdev->dev);
	if (ret) {
		printk("%s: unable to get memory for dev->priv.\n", dev->name);
		goto err_out_irq;
	}

	tp = netdev_priv(dev);
	tp->setnselout = tms_pci_setnselout_pins;
		
	tp->sifreadb = tms_pci_sifreadb;
	tp->sifreadw = tms_pci_sifreadw;
	tp->sifwriteb = tms_pci_sifwriteb;
	tp->sifwritew = tms_pci_sifwritew;
		
	memcpy(tp->ProductID, cardinfo->name, PROD_ID_SIZE + 1);

	tp->tmspriv = cardinfo;

	dev->open = tms380tr_open;
	dev->stop = tms380tr_close;
	pci_set_drvdata(pdev, dev);
	SET_NETDEV_DEV(dev, &pdev->dev);

	ret = register_netdev(dev);
	if (ret)
		goto err_out_tmsdev;
	
	return 0;

err_out_tmsdev:
	pci_set_drvdata(pdev, NULL);
	tmsdev_term(dev);
err_out_irq:
	free_irq(pdev->irq, dev);
err_out_region:
	release_region(pci_ioaddr, TMS_PCI_IO_EXTENT);
err_out_trdev:
	free_netdev(dev);
	return ret;
}

/*
 * Reads MAC address from adapter RAM, which should've read it from
 * the onboard ROM.  
 *
 * Calling this on a board that does not support it can be a very
 * dangerous thing.  The Madge board, for instance, will lock your
 * machine hard when this is called.  Luckily, its supported in a
 * separate driver.  --ASF
 */
static void tms_pci_read_eeprom(struct net_device *dev)
{
	int i;
	
	/* Address: 0000:0000 */
	tms_pci_sifwritew(dev, 0, SIFADX);
	tms_pci_sifwritew(dev, 0, SIFADR);	
	
	/* Read six byte MAC address data */
	dev->addr_len = 6;
	for(i = 0; i < 6; i++)
		dev->dev_addr[i] = tms_pci_sifreadw(dev, SIFINC) >> 8;
}

static unsigned short tms_pci_setnselout_pins(struct net_device *dev)
{
	unsigned short val = 0;
	struct net_local *tp = netdev_priv(dev);
	struct card_info *cardinfo = tp->tmspriv;
  
	if(tp->DataRate == SPEED_4)
		val |= cardinfo->nselout[0];	/* Set 4Mbps */
	else
		val |= cardinfo->nselout[1];	/* Set 16Mbps */
	return val;
}

static void __devexit tms_pci_detach (struct pci_dev *pdev)
{
	struct net_device *dev = pci_get_drvdata(pdev);

	BUG_ON(!dev);
	unregister_netdev(dev);
	release_region(dev->base_addr, TMS_PCI_IO_EXTENT);
	free_irq(dev->irq, dev);
	tmsdev_term(dev);
	free_netdev(dev);
	pci_set_drvdata(pdev, NULL);
}

static struct pci_driver tms_pci_driver = {
	.name		= "tmspci",
	.id_table	= tmspci_pci_tbl,
	.probe		= tms_pci_attach,
	.remove		= __devexit_p(tms_pci_detach),
};

static int __init tms_pci_init (void)
{
	return pci_register_driver(&tms_pci_driver);
}

static void __exit tms_pci_rmmod (void)
{
	pci_unregister_driver (&tms_pci_driver);
}

module_init(tms_pci_init);
module_exit(tms_pci_rmmod);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* tmspci.c: A generic network driver for TMS380-based PCI token ring cards.
	3	*
	4	* Written 1999 by Adam Fritzler
	5	*
	6	* This software may be used and distributed according to the terms
	7	* of the GNU General Public License, incorporated herein by reference.
	8	*
	9	* This driver module supports the following cards:
	10	* - SysKonnect TR4/16(+) PCI (SK-4590)
	11	* - SysKonnect TR4/16 PCI (SK-4591)
	12	* - Compaq TR 4/16 PCI
	13	* - Thomas-Conrad TC4048 4/16 PCI
	14	* - 3Com 3C339 Token Link Velocity
	15	*
	16	* Maintainer(s):
	17	* AF Adam Fritzler mid@auk.cx
	18	*
	19	* Modification History:
	20	* 30-Dec-99 AF Split off from the tms380tr driver.
	21	* 22-Jan-00 AF Updated to use indirect read/writes
	22	* 23-Nov-00 JG New PCI API, cleanups
	23	*
	24	* TODO:
	25	* 1. See if we can use MMIO instead of port accesses
	26	*
	27	*/
	28
	29	#include <linux/module.h>
	30	#include <linux/kernel.h>
	31	#include <linux/errno.h>
	32	#include <linux/pci.h>
	33	#include <linux/init.h>
	34	#include <linux/netdevice.h>
	35	#include <linux/trdevice.h>
	36
	37	#include <asm/system.h>
	38	#include <asm/io.h>
	39	#include <asm/irq.h>
	40
	41	#include "tms380tr.h"
	42
	43	static char version[] __devinitdata =
	44	"tmspci.c: v1.02 23/11/2000 by Adam Fritzler\n";
	45
	46	#define TMS_PCI_IO_EXTENT 32
	47
	48	struct card_info {
	49	unsigned char nselout[2]; /* NSELOUT vals for 4mb([0]) and 16mb([1]) */
	50	char *name;
	51	};
	52
	53	static struct card_info card_info_table[] = {
	54	{ {0x03, 0x01}, "Compaq 4/16 TR PCI"},
	55	{ {0x03, 0x01}, "SK NET TR 4/16 PCI"},
	56	{ {0x03, 0x01}, "Thomas-Conrad TC4048 PCI 4/16"},
	57	{ {0x03, 0x01}, "3Com Token Link Velocity"},
	58	};
	59
	60	static struct pci_device_id tmspci_pci_tbl[] = {
	61	{ PCI_VENDOR_ID_COMPAQ, PCI_DEVICE_ID_COMPAQ_TOKENRING, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 },
	62	{ PCI_VENDOR_ID_SYSKONNECT, PCI_DEVICE_ID_SYSKONNECT_TR, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 1 },
	63	{ PCI_VENDOR_ID_TCONRAD, PCI_DEVICE_ID_TCONRAD_TOKENRING, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 2 },
	64	{ PCI_VENDOR_ID_3COM, PCI_DEVICE_ID_3COM_3C339, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 3 },
65	{ } /* Terminating entry */
66	};
67	MODULE_DEVICE_TABLE(pci, tmspci_pci_tbl);
68
69	MODULE_LICENSE("GPL");
70
71	static void tms_pci_read_eeprom(struct net_device *dev);
72	static unsigned short tms_pci_setnselout_pins(struct net_device *dev);
73
74	static unsigned short tms_pci_sifreadb(struct net_device *dev, unsigned short reg)
75	{
76	return inb(dev->base_addr + reg);
77	}
78
79	static unsigned short tms_pci_sifreadw(struct net_device *dev, unsigned short reg)
80	{
81	return inw(dev->base_addr + reg);
82	}
83
84	static void tms_pci_sifwriteb(struct net_device *dev, unsigned short val, unsigned short reg)
85	{
86	outb(val, dev->base_addr + reg);
87	}
88
89	static void tms_pci_sifwritew(struct net_device *dev, unsigned short val, unsigned short reg)
90	{
91	outw(val, dev->base_addr + reg);
92	}
93
94	static int __devinit tms_pci_attach(struct pci_dev pdev, const struct pci_device_id ent)
95	{
96	static int versionprinted;
97	struct net_device *dev;
98	struct net_local *tp;
0795af57	99	int ret;
1da177e4 LT	100	unsigned int pci_irq_line;
	101	unsigned long pci_ioaddr;
	102	struct card_info *cardinfo = &card_info_table[ent->driver_data];
0795af57	103	DECLARE_MAC_BUF(mac);
504ff16c	104
1da177e4 LT	105	if (versionprinted++ == 0)
	106	printk("%s", version);
	107
	108	if (pci_enable_device(pdev))
	109	return -EIO;
	110
	111	/* Remove I/O space marker in bit 0. */
	112	pci_irq_line = pdev->irq;
	113	pci_ioaddr = pci_resource_start (pdev, 0);
	114
	115	/* At this point we have found a valid card. */
	116	dev = alloc_trdev(sizeof(struct net_local));
	117	if (!dev)
	118	return -ENOMEM;
1da177e4 LT	119
	120	if (!request_region(pci_ioaddr, TMS_PCI_IO_EXTENT, dev->name)) {
	121	ret = -EBUSY;
	122	goto err_out_trdev;
	123	}
	124
1fb9df5d	125	ret = request_irq(pdev->irq, tms380tr_interrupt, IRQF_SHARED,
1da177e4 LT	126	dev->name, dev);
	127	if (ret)
	128	goto err_out_region;
	129
	130	dev->base_addr = pci_ioaddr;
	131	dev->irq = pci_irq_line;
	132	dev->dma = 0;
	133
	134	printk("%s: %s\n", dev->name, cardinfo->name);
	135	printk("%s: IO: %#4lx IRQ: %d\n",
	136	dev->name, dev->base_addr, dev->irq);
	137
	138	tms_pci_read_eeprom(dev);
	139
0795af57 JP	140	printk("%s: Ring Station Address: %s\n",
0795af57 JP	141	dev->name, print_mac(mac, dev->dev_addr));
1da177e4	142
84c3ea01	143	ret = tmsdev_init(dev, &pdev->dev);
1da177e4 LT	144	if (ret) {
	145	printk("%s: unable to get memory for dev->priv.\n", dev->name);
	146	goto err_out_irq;
	147	}
	148
eda10531	149	tp = netdev_priv(dev);
1da177e4 LT	150	tp->setnselout = tms_pci_setnselout_pins;
	151
	152	tp->sifreadb = tms_pci_sifreadb;
	153	tp->sifreadw = tms_pci_sifreadw;
	154	tp->sifwriteb = tms_pci_sifwriteb;
	155	tp->sifwritew = tms_pci_sifwritew;
	156
	157	memcpy(tp->ProductID, cardinfo->name, PROD_ID_SIZE + 1);
	158
	159	tp->tmspriv = cardinfo;
	160
	161	dev->open = tms380tr_open;
	162	dev->stop = tms380tr_close;
	163	pci_set_drvdata(pdev, dev);
	164	SET_NETDEV_DEV(dev, &pdev->dev);
	165
	166	ret = register_netdev(dev);
	167	if (ret)
	168	goto err_out_tmsdev;
	169
	170	return 0;
	171
	172	err_out_tmsdev:
	173	pci_set_drvdata(pdev, NULL);
	174	tmsdev_term(dev);
	175	err_out_irq:
	176	free_irq(pdev->irq, dev);
	177	err_out_region:
	178	release_region(pci_ioaddr, TMS_PCI_IO_EXTENT);
	179	err_out_trdev:
	180	free_netdev(dev);
	181	return ret;
	182	}
	183
	184	/*
	185	* Reads MAC address from adapter RAM, which should've read it from
	186	* the onboard ROM.
	187	*
	188	* Calling this on a board that does not support it can be a very
	189	* dangerous thing. The Madge board, for instance, will lock your
	190	* machine hard when this is called. Luckily, its supported in a
	191	* separate driver. --ASF
	192	*/
	193	static void tms_pci_read_eeprom(struct net_device *dev)
	194	{
	195	int i;
	196
	197	/* Address: 0000:0000 */
	198	tms_pci_sifwritew(dev, 0, SIFADX);
	199	tms_pci_sifwritew(dev, 0, SIFADR);
	200
	201	/* Read six byte MAC address data */
	202	dev->addr_len = 6;
	203	for(i = 0; i < 6; i++)
	204	dev->dev_addr[i] = tms_pci_sifreadw(dev, SIFINC) >> 8;
	205	}
	206
	207	static unsigned short tms_pci_setnselout_pins(struct net_device *dev)
	208	{
	209	unsigned short val = 0;
eda10531	210	struct net_local *tp = netdev_priv(dev);
1da177e4 LT	211	struct card_info *cardinfo = tp->tmspriv;
	212
	213	if(tp->DataRate == SPEED_4)
	214	val \|= cardinfo->nselout[0]; /* Set 4Mbps */
	215	else
	216	val \|= cardinfo->nselout[1]; /* Set 16Mbps */
	217	return val;
	218	}
	219
	220	static void __devexit tms_pci_detach (struct pci_dev *pdev)
	221	{
	222	struct net_device *dev = pci_get_drvdata(pdev);
	223
644c12d7	224	BUG_ON(!dev);
1da177e4 LT	225	unregister_netdev(dev);
	226	release_region(dev->base_addr, TMS_PCI_IO_EXTENT);
	227	free_irq(dev->irq, dev);
	228	tmsdev_term(dev);
	229	free_netdev(dev);
	230	pci_set_drvdata(pdev, NULL);
	231	}
	232
	233	static struct pci_driver tms_pci_driver = {
	234	.name = "tmspci",
	235	.id_table = tmspci_pci_tbl,
	236	.probe = tms_pci_attach,
	237	.remove = __devexit_p(tms_pci_detach),
	238	};
	239
	240	static int __init tms_pci_init (void)
	241	{
	242	return pci_register_driver(&tms_pci_driver);
	243	}
	244
	245	static void __exit tms_pci_rmmod (void)
	246	{
	247	pci_unregister_driver (&tms_pci_driver);
	248	}
	249
	250	module_init(tms_pci_init);
	251	module_exit(tms_pci_rmmod);
	252