1 /*======================================================================
3 A PCMCIA token-ring driver for IBM-based cards
5 This driver supports the IBM PCMCIA Token-Ring Card.
6 Written by Steve Kipisz, kipisz@vnet.ibm.com or
11 This code is based on pcnet_cs.c from David Hinds.
13 V2.2.0 February 1999 - Mike Phillips phillim@amtrak.com
15 Linux V2.2.x presented significant changes to the underlying
16 ibmtr.c code. Mainly the code became a lot more organized and
19 This caused the old PCMCIA Token Ring driver to give up and go
20 home early. Instead of just patching the old code to make it
21 work, the PCMCIA code has been streamlined, updated and possibly
24 This code now only contains code required for the Card Services.
25 All we do here is set the card up enough so that the real ibmtr.c
26 driver can find it and work with it properly.
28 i.e. We set up the io port, irq, mmio memory and shared ram
29 memory. This enables ibmtr_probe in ibmtr.c to find the card and
30 configure it as though it was a normal ISA and/or PnP card.
34 v2.2.5 April 1999 Mike Phillips (phillim@amtrak.com)
35 Obscure bug fix, required changed to ibmtr.c not ibmtr_cs.c
37 v2.2.7 May 1999 Mike Phillips (phillim@amtrak.com)
38 Updated to version 2.2.7 to match the first version of the kernel
39 that the modification to ibmtr.c were incorporated into.
41 v2.2.17 July 2000 Burt Silverman (burts@us.ibm.com)
42 Address translation feature of PCMCIA controller is usable so
43 memory windows can be placed in High memory (meaning above
46 ======================================================================*/
48 #include <linux/kernel.h>
49 #include <linux/init.h>
50 #include <linux/ptrace.h>
51 #include <linux/slab.h>
52 #include <linux/string.h>
53 #include <linux/timer.h>
54 #include <linux/module.h>
55 #include <linux/ethtool.h>
56 #include <linux/netdevice.h>
57 #include <linux/trdevice.h>
58 #include <linux/ibmtr.h>
60 #include <pcmcia/cistpl.h>
61 #include <pcmcia/ds.h>
63 #include <asm/uaccess.h>
65 #include <asm/system.h>
68 #include "../tokenring/ibmtr.c"
71 /*====================================================================*/
73 /* Parameters that can be set with 'insmod' */
75 /* MMIO base address */
76 static u_long mmiobase = 0xce000;
78 /* SRAM base address */
79 static u_long srambase = 0xd0000;
81 /* SRAM size 8,16,32,64 */
82 static u_long sramsize = 64;
85 static int ringspeed = 16;
87 module_param(mmiobase, ulong, 0);
88 module_param(srambase, ulong, 0);
89 module_param(sramsize, ulong, 0);
90 module_param(ringspeed, int, 0);
91 MODULE_LICENSE("GPL");
93 /*====================================================================*/
95 static int ibmtr_config(struct pcmcia_device *link);
96 static void ibmtr_hw_setup(struct net_device *dev, u_int mmiobase);
97 static void ibmtr_release(struct pcmcia_device *link);
98 static void ibmtr_detach(struct pcmcia_device *p_dev);
100 /*====================================================================*/
102 typedef struct ibmtr_dev_t {
103 struct pcmcia_device *p_dev;
104 struct net_device *dev;
108 static void netdev_get_drvinfo(struct net_device *dev,
109 struct ethtool_drvinfo *info)
111 strcpy(info->driver, "ibmtr_cs");
114 static const struct ethtool_ops netdev_ethtool_ops = {
115 .get_drvinfo = netdev_get_drvinfo,
118 static irqreturn_t ibmtr_interrupt(int irq, void *dev_id) {
119 ibmtr_dev_t *info = dev_id;
120 struct net_device *dev = info->dev;
121 return tok_interrupt(irq, dev);
124 /*======================================================================
126 ibmtr_attach() creates an "instance" of the driver, allocating
127 local data structures for one device. The device is registered
130 ======================================================================*/
132 static int __devinit ibmtr_attach(struct pcmcia_device *link)
135 struct net_device *dev;
137 dev_dbg(&link->dev, "ibmtr_attach()\n");
139 /* Create new token-ring device */
140 info = kzalloc(sizeof(*info), GFP_KERNEL);
141 if (!info) return -ENOMEM;
142 dev = alloc_trdev(sizeof(struct tok_info));
150 info->ti = netdev_priv(dev);
152 link->resource[0]->flags |= IO_DATA_PATH_WIDTH_8;
153 link->resource[0]->end = 4;
154 link->config_flags |= CONF_ENABLE_IRQ;
155 link->config_regs = PRESENT_OPTION;
159 SET_ETHTOOL_OPS(dev, &netdev_ethtool_ops);
161 return ibmtr_config(link);
164 /*======================================================================
166 This deletes a driver "instance". The device is de-registered
167 with Card Services. If it has been released, all local data
168 structures are freed. Otherwise, the structures will be freed
169 when the device is released.
171 ======================================================================*/
173 static void ibmtr_detach(struct pcmcia_device *link)
175 struct ibmtr_dev_t *info = link->priv;
176 struct net_device *dev = info->dev;
177 struct tok_info *ti = netdev_priv(dev);
179 dev_dbg(&link->dev, "ibmtr_detach\n");
182 * When the card removal interrupt hits tok_interrupt(),
183 * bail out early, so we don't crash the machine
187 unregister_netdev(dev);
189 del_timer_sync(&(ti->tr_timer));
197 /*======================================================================
199 ibmtr_config() is scheduled to run after a CARD_INSERTION event
200 is received, to configure the PCMCIA socket, and to make the
201 token-ring device available to the system.
203 ======================================================================*/
205 static int __devinit ibmtr_config(struct pcmcia_device *link)
207 ibmtr_dev_t *info = link->priv;
208 struct net_device *dev = info->dev;
209 struct tok_info *ti = netdev_priv(dev);
212 dev_dbg(&link->dev, "ibmtr_config\n");
215 link->config_index = 0x61;
217 /* Determine if this is PRIMARY or ALTERNATE. */
219 /* Try PRIMARY card at 0xA20-0xA23 */
220 link->resource[0]->start = 0xA20;
221 i = pcmcia_request_io(link);
223 /* Couldn't get 0xA20-0xA23. Try ALTERNATE at 0xA24-0xA27. */
224 link->resource[0]->start = 0xA24;
225 ret = pcmcia_request_io(link);
229 dev->base_addr = link->resource[0]->start;
231 ret = pcmcia_request_exclusive_irq(link, ibmtr_interrupt);
234 dev->irq = link->irq;
236 ti->global_int_enable=GLOBAL_INT_ENABLE+((dev->irq==9) ? 2 : dev->irq);
238 /* Allocate the MMIO memory window */
239 link->resource[2]->flags |= WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM|WIN_ENABLE;
240 link->resource[2]->flags |= WIN_USE_WAIT;
241 link->resource[2]->start = 0;
242 link->resource[2]->end = 0x2000;
243 ret = pcmcia_request_window(link, link->resource[2], 250);
247 ret = pcmcia_map_mem_page(link, link->resource[2], mmiobase);
250 ti->mmio = ioremap(link->resource[2]->start,
251 resource_size(link->resource[2]));
253 /* Allocate the SRAM memory window */
254 link->resource[3]->flags = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM|WIN_ENABLE;
255 link->resource[3]->flags |= WIN_USE_WAIT;
256 link->resource[3]->start = 0;
257 link->resource[3]->end = sramsize * 1024;
258 ret = pcmcia_request_window(link, link->resource[3], 250);
262 ret = pcmcia_map_mem_page(link, link->resource[3], srambase);
266 ti->sram_base = srambase >> 12;
267 ti->sram_virt = ioremap(link->resource[3]->start,
268 resource_size(link->resource[3]));
269 ti->sram_phys = link->resource[3]->start;
271 ret = pcmcia_enable_device(link);
275 /* Set up the Token-Ring Controller Configuration Register and
276 turn on the card. Check the "Local Area Network Credit Card
277 Adapters Technical Reference" SC30-3585 for this info. */
278 ibmtr_hw_setup(dev, mmiobase);
280 SET_NETDEV_DEV(dev, &link->dev);
282 i = ibmtr_probe_card(dev);
284 printk(KERN_NOTICE "ibmtr_cs: register_netdev() failed\n");
289 "%s: port %#3lx, irq %d, mmio %#5lx, sram %#5lx, hwaddr=%pM\n",
290 dev->name, dev->base_addr, dev->irq,
291 (u_long)ti->mmio, (u_long)(ti->sram_base << 12),
300 /*======================================================================
302 After a card is removed, ibmtr_release() will unregister the net
303 device, and release the PCMCIA configuration. If the device is
304 still open, this will be postponed until it is closed.
306 ======================================================================*/
308 static void ibmtr_release(struct pcmcia_device *link)
310 ibmtr_dev_t *info = link->priv;
311 struct net_device *dev = info->dev;
313 dev_dbg(&link->dev, "ibmtr_release\n");
315 if (link->resource[2]->end) {
316 struct tok_info *ti = netdev_priv(dev);
319 pcmcia_disable_device(link);
322 static int ibmtr_suspend(struct pcmcia_device *link)
324 ibmtr_dev_t *info = link->priv;
325 struct net_device *dev = info->dev;
328 netif_device_detach(dev);
333 static int __devinit ibmtr_resume(struct pcmcia_device *link)
335 ibmtr_dev_t *info = link->priv;
336 struct net_device *dev = info->dev;
339 ibmtr_probe(dev); /* really? */
340 netif_device_attach(dev);
347 /*====================================================================*/
349 static void ibmtr_hw_setup(struct net_device *dev, u_int mmiobase)
353 /* Bizarre IBM behavior, there are 16 bits of information we
354 need to set, but the card only allows us to send 4 bits at a
355 time. For each byte sent to base_addr, bits 7-4 tell the
356 card which part of the 16 bits we are setting, bits 3-0 contain
357 the actual information */
359 /* First nibble provides 4 bits of mmio */
360 i = (mmiobase >> 16) & 0x0F;
361 outb(i, dev->base_addr);
363 /* Second nibble provides 3 bits of mmio */
364 i = 0x10 | ((mmiobase >> 12) & 0x0E);
365 outb(i, dev->base_addr);
367 /* Third nibble, hard-coded values */
369 outb(i, dev->base_addr);
371 /* Fourth nibble sets shared ram page size */
373 /* 8 = 00, 16 = 01, 32 = 10, 64 = 11 */
374 i = (sramsize >> 4) & 0x07;
375 i = ((i == 4) ? 3 : i) << 2;
380 if (dev->base_addr == 0xA24)
382 outb(i, dev->base_addr);
384 /* 0x40 will release the card for use */
385 outb(0x40, dev->base_addr);
388 static struct pcmcia_device_id ibmtr_ids[] = {
389 PCMCIA_DEVICE_PROD_ID12("3Com", "TokenLink Velocity PC Card", 0x41240e5b, 0x82c3734e),
390 PCMCIA_DEVICE_PROD_ID12("IBM", "TOKEN RING", 0xb569a6e5, 0xbf8eed47),
393 MODULE_DEVICE_TABLE(pcmcia, ibmtr_ids);
395 static struct pcmcia_driver ibmtr_cs_driver = {
396 .owner = THIS_MODULE,
400 .probe = ibmtr_attach,
401 .remove = ibmtr_detach,
402 .id_table = ibmtr_ids,
403 .suspend = ibmtr_suspend,
404 .resume = ibmtr_resume,
407 static int __init init_ibmtr_cs(void)
409 return pcmcia_register_driver(&ibmtr_cs_driver);
412 static void __exit exit_ibmtr_cs(void)
414 pcmcia_unregister_driver(&ibmtr_cs_driver);
417 module_init(init_ibmtr_cs);
418 module_exit(exit_ibmtr_cs);