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/cs.h>
61 #include <pcmcia/cistpl.h>
62 #include <pcmcia/ds.h>
64 #include <asm/uaccess.h>
66 #include <asm/system.h>
69 #include "../tokenring/ibmtr.c"
72 /*====================================================================*/
74 /* Parameters that can be set with 'insmod' */
76 /* MMIO base address */
77 static u_long mmiobase = 0xce000;
79 /* SRAM base address */
80 static u_long srambase = 0xd0000;
82 /* SRAM size 8,16,32,64 */
83 static u_long sramsize = 64;
86 static int ringspeed = 16;
88 module_param(mmiobase, ulong, 0);
89 module_param(srambase, ulong, 0);
90 module_param(sramsize, ulong, 0);
91 module_param(ringspeed, int, 0);
92 MODULE_LICENSE("GPL");
94 /*====================================================================*/
96 static int ibmtr_config(struct pcmcia_device *link);
97 static void ibmtr_hw_setup(struct net_device *dev, u_int mmiobase);
98 static void ibmtr_release(struct pcmcia_device *link);
99 static void ibmtr_detach(struct pcmcia_device *p_dev);
101 /*====================================================================*/
103 typedef struct ibmtr_dev_t {
104 struct pcmcia_device *p_dev;
105 struct net_device *dev;
106 window_handle_t sram_win_handle;
110 static void netdev_get_drvinfo(struct net_device *dev,
111 struct ethtool_drvinfo *info)
113 strcpy(info->driver, "ibmtr_cs");
116 static const struct ethtool_ops netdev_ethtool_ops = {
117 .get_drvinfo = netdev_get_drvinfo,
120 static irqreturn_t ibmtr_interrupt(int irq, void *dev_id) {
121 ibmtr_dev_t *info = dev_id;
122 struct net_device *dev = info->dev;
123 return tok_interrupt(irq, dev);
126 /*======================================================================
128 ibmtr_attach() creates an "instance" of the driver, allocating
129 local data structures for one device. The device is registered
132 ======================================================================*/
134 static int __devinit ibmtr_attach(struct pcmcia_device *link)
137 struct net_device *dev;
139 dev_dbg(&link->dev, "ibmtr_attach()\n");
141 /* Create new token-ring device */
142 info = kzalloc(sizeof(*info), GFP_KERNEL);
143 if (!info) return -ENOMEM;
144 dev = alloc_trdev(sizeof(struct tok_info));
152 info->ti = netdev_priv(dev);
154 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
155 link->io.NumPorts1 = 4;
156 link->io.IOAddrLines = 16;
157 link->conf.Attributes = CONF_ENABLE_IRQ;
158 link->conf.IntType = INT_MEMORY_AND_IO;
159 link->conf.Present = PRESENT_OPTION;
163 SET_ETHTOOL_OPS(dev, &netdev_ethtool_ops);
165 return ibmtr_config(link);
168 /*======================================================================
170 This deletes a driver "instance". The device is de-registered
171 with Card Services. If it has been released, all local data
172 structures are freed. Otherwise, the structures will be freed
173 when the device is released.
175 ======================================================================*/
177 static void ibmtr_detach(struct pcmcia_device *link)
179 struct ibmtr_dev_t *info = link->priv;
180 struct net_device *dev = info->dev;
181 struct tok_info *ti = netdev_priv(dev);
183 dev_dbg(&link->dev, "ibmtr_detach\n");
186 * When the card removal interrupt hits tok_interrupt(),
187 * bail out early, so we don't crash the machine
191 unregister_netdev(dev);
193 del_timer_sync(&(ti->tr_timer));
201 /*======================================================================
203 ibmtr_config() is scheduled to run after a CARD_INSERTION event
204 is received, to configure the PCMCIA socket, and to make the
205 token-ring device available to the system.
207 ======================================================================*/
209 static int __devinit ibmtr_config(struct pcmcia_device *link)
211 ibmtr_dev_t *info = link->priv;
212 struct net_device *dev = info->dev;
213 struct tok_info *ti = netdev_priv(dev);
218 dev_dbg(&link->dev, "ibmtr_config\n");
220 link->conf.ConfigIndex = 0x61;
222 /* Determine if this is PRIMARY or ALTERNATE. */
224 /* Try PRIMARY card at 0xA20-0xA23 */
225 link->io.BasePort1 = 0xA20;
226 i = pcmcia_request_io(link, &link->io);
228 /* Couldn't get 0xA20-0xA23. Try ALTERNATE at 0xA24-0xA27. */
229 link->io.BasePort1 = 0xA24;
230 ret = pcmcia_request_io(link, &link->io);
234 dev->base_addr = link->resource[0]->start;
236 ret = pcmcia_request_exclusive_irq(link, ibmtr_interrupt);
239 dev->irq = link->irq;
241 ti->global_int_enable=GLOBAL_INT_ENABLE+((dev->irq==9) ? 2 : dev->irq);
243 /* Allocate the MMIO memory window */
244 req.Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM|WIN_ENABLE;
245 req.Attributes |= WIN_USE_WAIT;
248 req.AccessSpeed = 250;
249 ret = pcmcia_request_window(link, &req, &link->win);
253 mem.CardOffset = mmiobase;
255 ret = pcmcia_map_mem_page(link, link->win, &mem);
258 ti->mmio = ioremap(req.Base, req.Size);
260 /* Allocate the SRAM memory window */
261 req.Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM|WIN_ENABLE;
262 req.Attributes |= WIN_USE_WAIT;
264 req.Size = sramsize * 1024;
265 req.AccessSpeed = 250;
266 ret = pcmcia_request_window(link, &req, &info->sram_win_handle);
270 mem.CardOffset = srambase;
272 ret = pcmcia_map_mem_page(link, info->sram_win_handle, &mem);
276 ti->sram_base = mem.CardOffset >> 12;
277 ti->sram_virt = ioremap(req.Base, req.Size);
278 ti->sram_phys = req.Base;
280 ret = pcmcia_request_configuration(link, &link->conf);
284 /* Set up the Token-Ring Controller Configuration Register and
285 turn on the card. Check the "Local Area Network Credit Card
286 Adapters Technical Reference" SC30-3585 for this info. */
287 ibmtr_hw_setup(dev, mmiobase);
289 SET_NETDEV_DEV(dev, &link->dev);
291 i = ibmtr_probe_card(dev);
293 printk(KERN_NOTICE "ibmtr_cs: register_netdev() failed\n");
298 "%s: port %#3lx, irq %d, mmio %#5lx, sram %#5lx, hwaddr=%pM\n",
299 dev->name, dev->base_addr, dev->irq,
300 (u_long)ti->mmio, (u_long)(ti->sram_base << 12),
309 /*======================================================================
311 After a card is removed, ibmtr_release() will unregister the net
312 device, and release the PCMCIA configuration. If the device is
313 still open, this will be postponed until it is closed.
315 ======================================================================*/
317 static void ibmtr_release(struct pcmcia_device *link)
319 ibmtr_dev_t *info = link->priv;
320 struct net_device *dev = info->dev;
322 dev_dbg(&link->dev, "ibmtr_release\n");
325 struct tok_info *ti = netdev_priv(dev);
327 pcmcia_release_window(link, info->sram_win_handle);
329 pcmcia_disable_device(link);
332 static int ibmtr_suspend(struct pcmcia_device *link)
334 ibmtr_dev_t *info = link->priv;
335 struct net_device *dev = info->dev;
338 netif_device_detach(dev);
343 static int __devinit ibmtr_resume(struct pcmcia_device *link)
345 ibmtr_dev_t *info = link->priv;
346 struct net_device *dev = info->dev;
349 ibmtr_probe(dev); /* really? */
350 netif_device_attach(dev);
357 /*====================================================================*/
359 static void ibmtr_hw_setup(struct net_device *dev, u_int mmiobase)
363 /* Bizarre IBM behavior, there are 16 bits of information we
364 need to set, but the card only allows us to send 4 bits at a
365 time. For each byte sent to base_addr, bits 7-4 tell the
366 card which part of the 16 bits we are setting, bits 3-0 contain
367 the actual information */
369 /* First nibble provides 4 bits of mmio */
370 i = (mmiobase >> 16) & 0x0F;
371 outb(i, dev->base_addr);
373 /* Second nibble provides 3 bits of mmio */
374 i = 0x10 | ((mmiobase >> 12) & 0x0E);
375 outb(i, dev->base_addr);
377 /* Third nibble, hard-coded values */
379 outb(i, dev->base_addr);
381 /* Fourth nibble sets shared ram page size */
383 /* 8 = 00, 16 = 01, 32 = 10, 64 = 11 */
384 i = (sramsize >> 4) & 0x07;
385 i = ((i == 4) ? 3 : i) << 2;
390 if (dev->base_addr == 0xA24)
392 outb(i, dev->base_addr);
394 /* 0x40 will release the card for use */
395 outb(0x40, dev->base_addr);
398 static struct pcmcia_device_id ibmtr_ids[] = {
399 PCMCIA_DEVICE_PROD_ID12("3Com", "TokenLink Velocity PC Card", 0x41240e5b, 0x82c3734e),
400 PCMCIA_DEVICE_PROD_ID12("IBM", "TOKEN RING", 0xb569a6e5, 0xbf8eed47),
403 MODULE_DEVICE_TABLE(pcmcia, ibmtr_ids);
405 static struct pcmcia_driver ibmtr_cs_driver = {
406 .owner = THIS_MODULE,
410 .probe = ibmtr_attach,
411 .remove = ibmtr_detach,
412 .id_table = ibmtr_ids,
413 .suspend = ibmtr_suspend,
414 .resume = ibmtr_resume,
417 static int __init init_ibmtr_cs(void)
419 return pcmcia_register_driver(&ibmtr_cs_driver);
422 static void __exit exit_ibmtr_cs(void)
424 pcmcia_unregister_driver(&ibmtr_cs_driver);
427 module_init(init_ibmtr_cs);
428 module_exit(exit_ibmtr_cs);