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_types.h>
61 #include <pcmcia/cs.h>
62 #include <pcmcia/cistpl.h>
63 #include <pcmcia/ds.h>
65 #include <asm/uaccess.h>
67 #include <asm/system.h>
70 #include "../tokenring/ibmtr.c"
73 /*====================================================================*/
75 /* Parameters that can be set with 'insmod' */
77 /* MMIO base address */
78 static u_long mmiobase = 0xce000;
80 /* SRAM base address */
81 static u_long srambase = 0xd0000;
83 /* SRAM size 8,16,32,64 */
84 static u_long sramsize = 64;
87 static int ringspeed = 16;
89 module_param(mmiobase, ulong, 0);
90 module_param(srambase, ulong, 0);
91 module_param(sramsize, ulong, 0);
92 module_param(ringspeed, int, 0);
93 MODULE_LICENSE("GPL");
95 /*====================================================================*/
97 static int ibmtr_config(struct pcmcia_device *link);
98 static void ibmtr_hw_setup(struct net_device *dev, u_int mmiobase);
99 static void ibmtr_release(struct pcmcia_device *link);
100 static void ibmtr_detach(struct pcmcia_device *p_dev);
102 /*====================================================================*/
104 typedef struct ibmtr_dev_t {
105 struct pcmcia_device *p_dev;
106 struct net_device *dev;
107 window_handle_t sram_win_handle;
111 static void netdev_get_drvinfo(struct net_device *dev,
112 struct ethtool_drvinfo *info)
114 strcpy(info->driver, "ibmtr_cs");
117 static const struct ethtool_ops netdev_ethtool_ops = {
118 .get_drvinfo = netdev_get_drvinfo,
121 static irqreturn_t ibmtr_interrupt(int irq, void *dev_id) {
122 ibmtr_dev_t *info = dev_id;
123 struct net_device *dev = info->dev;
124 return tok_interrupt(irq, dev);
127 /*======================================================================
129 ibmtr_attach() creates an "instance" of the driver, allocating
130 local data structures for one device. The device is registered
133 ======================================================================*/
135 static int __devinit ibmtr_attach(struct pcmcia_device *link)
138 struct net_device *dev;
140 dev_dbg(&link->dev, "ibmtr_attach()\n");
142 /* Create new token-ring device */
143 info = kzalloc(sizeof(*info), GFP_KERNEL);
144 if (!info) return -ENOMEM;
145 dev = alloc_trdev(sizeof(struct tok_info));
153 info->ti = netdev_priv(dev);
155 link->io.Attributes1 = IO_DATA_PATH_WIDTH_8;
156 link->io.NumPorts1 = 4;
157 link->io.IOAddrLines = 16;
158 link->conf.Attributes = CONF_ENABLE_IRQ;
159 link->conf.IntType = INT_MEMORY_AND_IO;
160 link->conf.Present = PRESENT_OPTION;
164 SET_ETHTOOL_OPS(dev, &netdev_ethtool_ops);
166 return ibmtr_config(link);
169 /*======================================================================
171 This deletes a driver "instance". The device is de-registered
172 with Card Services. If it has been released, all local data
173 structures are freed. Otherwise, the structures will be freed
174 when the device is released.
176 ======================================================================*/
178 static void ibmtr_detach(struct pcmcia_device *link)
180 struct ibmtr_dev_t *info = link->priv;
181 struct net_device *dev = info->dev;
182 struct tok_info *ti = netdev_priv(dev);
184 dev_dbg(&link->dev, "ibmtr_detach\n");
187 * When the card removal interrupt hits tok_interrupt(),
188 * bail out early, so we don't crash the machine
192 unregister_netdev(dev);
194 del_timer_sync(&(ti->tr_timer));
202 /*======================================================================
204 ibmtr_config() is scheduled to run after a CARD_INSERTION event
205 is received, to configure the PCMCIA socket, and to make the
206 token-ring device available to the system.
208 ======================================================================*/
210 static int __devinit ibmtr_config(struct pcmcia_device *link)
212 ibmtr_dev_t *info = link->priv;
213 struct net_device *dev = info->dev;
214 struct tok_info *ti = netdev_priv(dev);
219 dev_dbg(&link->dev, "ibmtr_config\n");
221 link->conf.ConfigIndex = 0x61;
223 /* Determine if this is PRIMARY or ALTERNATE. */
225 /* Try PRIMARY card at 0xA20-0xA23 */
226 link->io.BasePort1 = 0xA20;
227 i = pcmcia_request_io(link, &link->io);
229 /* Couldn't get 0xA20-0xA23. Try ALTERNATE at 0xA24-0xA27. */
230 link->io.BasePort1 = 0xA24;
231 ret = pcmcia_request_io(link, &link->io);
235 dev->base_addr = link->io.BasePort1;
237 ret = pcmcia_request_exclusive_irq(link, ibmtr_interrupt);
240 dev->irq = link->irq;
242 ti->global_int_enable=GLOBAL_INT_ENABLE+((dev->irq==9) ? 2 : dev->irq);
244 /* Allocate the MMIO memory window */
245 req.Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM|WIN_ENABLE;
246 req.Attributes |= WIN_USE_WAIT;
249 req.AccessSpeed = 250;
250 ret = pcmcia_request_window(link, &req, &link->win);
254 mem.CardOffset = mmiobase;
256 ret = pcmcia_map_mem_page(link, link->win, &mem);
259 ti->mmio = ioremap(req.Base, req.Size);
261 /* Allocate the SRAM memory window */
262 req.Attributes = WIN_DATA_WIDTH_16|WIN_MEMORY_TYPE_CM|WIN_ENABLE;
263 req.Attributes |= WIN_USE_WAIT;
265 req.Size = sramsize * 1024;
266 req.AccessSpeed = 250;
267 ret = pcmcia_request_window(link, &req, &info->sram_win_handle);
271 mem.CardOffset = srambase;
273 ret = pcmcia_map_mem_page(link, info->sram_win_handle, &mem);
277 ti->sram_base = mem.CardOffset >> 12;
278 ti->sram_virt = ioremap(req.Base, req.Size);
279 ti->sram_phys = req.Base;
281 ret = pcmcia_request_configuration(link, &link->conf);
285 /* Set up the Token-Ring Controller Configuration Register and
286 turn on the card. Check the "Local Area Network Credit Card
287 Adapters Technical Reference" SC30-3585 for this info. */
288 ibmtr_hw_setup(dev, mmiobase);
290 SET_NETDEV_DEV(dev, &link->dev);
292 i = ibmtr_probe_card(dev);
294 printk(KERN_NOTICE "ibmtr_cs: register_netdev() failed\n");
299 "%s: port %#3lx, irq %d, mmio %#5lx, sram %#5lx, hwaddr=%pM\n",
300 dev->name, dev->base_addr, dev->irq,
301 (u_long)ti->mmio, (u_long)(ti->sram_base << 12),
310 /*======================================================================
312 After a card is removed, ibmtr_release() will unregister the net
313 device, and release the PCMCIA configuration. If the device is
314 still open, this will be postponed until it is closed.
316 ======================================================================*/
318 static void ibmtr_release(struct pcmcia_device *link)
320 ibmtr_dev_t *info = link->priv;
321 struct net_device *dev = info->dev;
323 dev_dbg(&link->dev, "ibmtr_release\n");
326 struct tok_info *ti = netdev_priv(dev);
328 pcmcia_release_window(link, info->sram_win_handle);
330 pcmcia_disable_device(link);
333 static int ibmtr_suspend(struct pcmcia_device *link)
335 ibmtr_dev_t *info = link->priv;
336 struct net_device *dev = info->dev;
339 netif_device_detach(dev);
344 static int __devinit ibmtr_resume(struct pcmcia_device *link)
346 ibmtr_dev_t *info = link->priv;
347 struct net_device *dev = info->dev;
350 ibmtr_probe(dev); /* really? */
351 netif_device_attach(dev);
358 /*====================================================================*/
360 static void ibmtr_hw_setup(struct net_device *dev, u_int mmiobase)
364 /* Bizarre IBM behavior, there are 16 bits of information we
365 need to set, but the card only allows us to send 4 bits at a
366 time. For each byte sent to base_addr, bits 7-4 tell the
367 card which part of the 16 bits we are setting, bits 3-0 contain
368 the actual information */
370 /* First nibble provides 4 bits of mmio */
371 i = (mmiobase >> 16) & 0x0F;
372 outb(i, dev->base_addr);
374 /* Second nibble provides 3 bits of mmio */
375 i = 0x10 | ((mmiobase >> 12) & 0x0E);
376 outb(i, dev->base_addr);
378 /* Third nibble, hard-coded values */
380 outb(i, dev->base_addr);
382 /* Fourth nibble sets shared ram page size */
384 /* 8 = 00, 16 = 01, 32 = 10, 64 = 11 */
385 i = (sramsize >> 4) & 0x07;
386 i = ((i == 4) ? 3 : i) << 2;
391 if (dev->base_addr == 0xA24)
393 outb(i, dev->base_addr);
395 /* 0x40 will release the card for use */
396 outb(0x40, dev->base_addr);
399 static struct pcmcia_device_id ibmtr_ids[] = {
400 PCMCIA_DEVICE_PROD_ID12("3Com", "TokenLink Velocity PC Card", 0x41240e5b, 0x82c3734e),
401 PCMCIA_DEVICE_PROD_ID12("IBM", "TOKEN RING", 0xb569a6e5, 0xbf8eed47),
404 MODULE_DEVICE_TABLE(pcmcia, ibmtr_ids);
406 static struct pcmcia_driver ibmtr_cs_driver = {
407 .owner = THIS_MODULE,
411 .probe = ibmtr_attach,
412 .remove = ibmtr_detach,
413 .id_table = ibmtr_ids,
414 .suspend = ibmtr_suspend,
415 .resume = ibmtr_resume,
418 static int __init init_ibmtr_cs(void)
420 return pcmcia_register_driver(&ibmtr_cs_driver);
423 static void __exit exit_ibmtr_cs(void)
425 pcmcia_unregister_driver(&ibmtr_cs_driver);
428 module_init(init_ibmtr_cs);
429 module_exit(exit_ibmtr_cs);