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
 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
 43static char version[] __devinitdata =
 44"tmspci.c: v1.02 23/11/2000 by Adam Fritzler\n";
 45
 46#define TMS_PCI_IO_EXTENT 32
 47
 48struct card_info {
 49	unsigned char nselout[2]; /* NSELOUT vals for 4mb([0]) and 16mb([1]) */
 50	char *name;
 51};
 52
 53static 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
 60static DEFINE_PCI_DEVICE_TABLE(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};
 67MODULE_DEVICE_TABLE(pci, tmspci_pci_tbl);
 68
 69MODULE_LICENSE("GPL");
 70
 71static void tms_pci_read_eeprom(struct net_device *dev);
 72static unsigned short tms_pci_setnselout_pins(struct net_device *dev);
 73
 74static unsigned short tms_pci_sifreadb(struct net_device *dev, unsigned short reg)
 75{
 76	return inb(dev->base_addr + reg);
 77}
 78
 79static unsigned short tms_pci_sifreadw(struct net_device *dev, unsigned short reg)
 80{
 81	return inw(dev->base_addr + reg);
 82}
 83
 84static void tms_pci_sifwriteb(struct net_device *dev, unsigned short val, unsigned short reg)
 85{
 86	outb(val, dev->base_addr + reg);
 87}
 88
 89static void tms_pci_sifwritew(struct net_device *dev, unsigned short val, unsigned short reg)
 90{
 91	outw(val, dev->base_addr + reg);
 92}
 93
 94static 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;
 99	int ret;
100	unsigned int pci_irq_line;
101	unsigned long pci_ioaddr;
102	struct card_info *cardinfo = &card_info_table[ent->driver_data];
103
104	if (versionprinted++ == 0)
105		printk("%s", version);
106
107	if (pci_enable_device(pdev))
108		return -EIO;
109
110	/* Remove I/O space marker in bit 0. */
111	pci_irq_line = pdev->irq;
112	pci_ioaddr = pci_resource_start (pdev, 0);
113
114	/* At this point we have found a valid card. */
115	dev = alloc_trdev(sizeof(struct net_local));
116	if (!dev)
117		return -ENOMEM;
118
119	if (!request_region(pci_ioaddr, TMS_PCI_IO_EXTENT, dev->name)) {
120		ret = -EBUSY;
121		goto err_out_trdev;
122	}
123
124	dev->base_addr	= pci_ioaddr;
125	dev->irq 	= pci_irq_line;
126	dev->dma	= 0;
127
128	dev_info(&pdev->dev, "%s\n", cardinfo->name);
129	dev_info(&pdev->dev, "    IO: %#4lx  IRQ: %d\n", dev->base_addr, dev->irq);
130		
131	tms_pci_read_eeprom(dev);
132
133	dev_info(&pdev->dev, "    Ring Station Address: %pM\n", dev->dev_addr);
134		
135	ret = tmsdev_init(dev, &pdev->dev);
136	if (ret) {
137		dev_info(&pdev->dev, "unable to get memory for dev->priv.\n");
138		goto err_out_region;
139	}
140
141	tp = netdev_priv(dev);
142	tp->setnselout = tms_pci_setnselout_pins;
143		
144	tp->sifreadb = tms_pci_sifreadb;
145	tp->sifreadw = tms_pci_sifreadw;
146	tp->sifwriteb = tms_pci_sifwriteb;
147	tp->sifwritew = tms_pci_sifwritew;
148		
149	memcpy(tp->ProductID, cardinfo->name, PROD_ID_SIZE + 1);
150
151	tp->tmspriv = cardinfo;
152
153	dev->netdev_ops = &tms380tr_netdev_ops;
154
155	ret = request_irq(pdev->irq, tms380tr_interrupt, IRQF_SHARED,
156			  dev->name, dev);
157	if (ret)
158		goto err_out_tmsdev;
159
160	pci_set_drvdata(pdev, dev);
161	SET_NETDEV_DEV(dev, &pdev->dev);
162
163	ret = register_netdev(dev);
164	if (ret)
165		goto err_out_irq;
166	
167	return 0;
168
169err_out_irq:
170	free_irq(pdev->irq, dev);
171err_out_tmsdev:
172	pci_set_drvdata(pdev, NULL);
173	tmsdev_term(dev);
174err_out_region:
175	release_region(pci_ioaddr, TMS_PCI_IO_EXTENT);
176err_out_trdev:
177	free_netdev(dev);
178	return ret;
179}
180
181/*
182 * Reads MAC address from adapter RAM, which should've read it from
183 * the onboard ROM.  
184 *
185 * Calling this on a board that does not support it can be a very
186 * dangerous thing.  The Madge board, for instance, will lock your
187 * machine hard when this is called.  Luckily, its supported in a
188 * separate driver.  --ASF
189 */
190static void tms_pci_read_eeprom(struct net_device *dev)
191{
192	int i;
193	
194	/* Address: 0000:0000 */
195	tms_pci_sifwritew(dev, 0, SIFADX);
196	tms_pci_sifwritew(dev, 0, SIFADR);	
197	
198	/* Read six byte MAC address data */
199	dev->addr_len = 6;
200	for(i = 0; i < 6; i++)
201		dev->dev_addr[i] = tms_pci_sifreadw(dev, SIFINC) >> 8;
202}
203
204static unsigned short tms_pci_setnselout_pins(struct net_device *dev)
205{
206	unsigned short val = 0;
207	struct net_local *tp = netdev_priv(dev);
208	struct card_info *cardinfo = tp->tmspriv;
209  
210	if(tp->DataRate == SPEED_4)
211		val |= cardinfo->nselout[0];	/* Set 4Mbps */
212	else
213		val |= cardinfo->nselout[1];	/* Set 16Mbps */
214	return val;
215}
216
217static void __devexit tms_pci_detach (struct pci_dev *pdev)
218{
219	struct net_device *dev = pci_get_drvdata(pdev);
220
221	BUG_ON(!dev);
222	unregister_netdev(dev);
223	release_region(dev->base_addr, TMS_PCI_IO_EXTENT);
224	free_irq(dev->irq, dev);
225	tmsdev_term(dev);
226	free_netdev(dev);
227	pci_set_drvdata(pdev, NULL);
228}
229
230static struct pci_driver tms_pci_driver = {
231	.name		= "tmspci",
232	.id_table	= tmspci_pci_tbl,
233	.probe		= tms_pci_attach,
234	.remove		= __devexit_p(tms_pci_detach),
235};
236
237static int __init tms_pci_init (void)
238{
239	return pci_register_driver(&tms_pci_driver);
240}
241
242static void __exit tms_pci_rmmod (void)
243{
244	pci_unregister_driver (&tms_pci_driver);
245}
246
247module_init(tms_pci_init);
248module_exit(tms_pci_rmmod);
249