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
;
108 window_handle_t sram_win_handle
;
112 static void netdev_get_drvinfo(struct net_device
*dev
,
113 struct ethtool_drvinfo
*info
)
115 strcpy(info
->driver
, "ibmtr_cs");
118 static const struct ethtool_ops netdev_ethtool_ops
= {
119 .get_drvinfo
= netdev_get_drvinfo
,
122 /*======================================================================
124 ibmtr_attach() creates an "instance" of the driver, allocating
125 local data structures for one device. The device is registered
128 ======================================================================*/
130 static int __devinit
ibmtr_attach(struct pcmcia_device
*link
)
133 struct net_device
*dev
;
135 dev_dbg(&link
->dev
, "ibmtr_attach()\n");
137 /* Create new token-ring device */
138 info
= kzalloc(sizeof(*info
), GFP_KERNEL
);
139 if (!info
) return -ENOMEM
;
140 dev
= alloc_trdev(sizeof(struct tok_info
));
148 info
->ti
= netdev_priv(dev
);
150 link
->io
.Attributes1
= IO_DATA_PATH_WIDTH_8
;
151 link
->io
.NumPorts1
= 4;
152 link
->io
.IOAddrLines
= 16;
153 link
->irq
.Attributes
= IRQ_TYPE_EXCLUSIVE
| IRQ_HANDLE_PRESENT
;
154 link
->irq
.IRQInfo1
= IRQ_LEVEL_ID
;
155 link
->irq
.Handler
= &tok_interrupt
;
156 link
->conf
.Attributes
= CONF_ENABLE_IRQ
;
157 link
->conf
.IntType
= INT_MEMORY_AND_IO
;
158 link
->conf
.Present
= PRESENT_OPTION
;
160 link
->irq
.Instance
= info
->dev
= dev
;
162 SET_ETHTOOL_OPS(dev
, &netdev_ethtool_ops
);
164 return ibmtr_config(link
);
167 /*======================================================================
169 This deletes a driver "instance". The device is de-registered
170 with Card Services. If it has been released, all local data
171 structures are freed. Otherwise, the structures will be freed
172 when the device is released.
174 ======================================================================*/
176 static void ibmtr_detach(struct pcmcia_device
*link
)
178 struct ibmtr_dev_t
*info
= link
->priv
;
179 struct net_device
*dev
= info
->dev
;
180 struct tok_info
*ti
= netdev_priv(dev
);
182 dev_dbg(&link
->dev
, "ibmtr_detach\n");
185 * When the card removal interrupt hits tok_interrupt(),
186 * 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
->io
.BasePort1
;
236 ret
= pcmcia_request_irq(link
, &link
->irq
);
239 dev
->irq
= link
->irq
.AssignedIRQ
;
240 ti
->irq
= link
->irq
.AssignedIRQ
;
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
->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(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 link
->dev_node
= &info
->node
;
290 SET_NETDEV_DEV(dev
, &handle_to_dev(link
));
292 i
= ibmtr_probe_card(dev
);
294 printk(KERN_NOTICE
"ibmtr_cs: register_netdev() failed\n");
295 link
->dev_node
= NULL
;
299 strcpy(info
->node
.dev_name
, dev
->name
);
302 "%s: port %#3lx, irq %d, mmio %#5lx, sram %#5lx, hwaddr=%pM\n",
303 dev
->name
, dev
->base_addr
, dev
->irq
,
304 (u_long
)ti
->mmio
, (u_long
)(ti
->sram_base
<< 12),
313 /*======================================================================
315 After a card is removed, ibmtr_release() will unregister the net
316 device, and release the PCMCIA configuration. If the device is
317 still open, this will be postponed until it is closed.
319 ======================================================================*/
321 static void ibmtr_release(struct pcmcia_device
*link
)
323 ibmtr_dev_t
*info
= link
->priv
;
324 struct net_device
*dev
= info
->dev
;
326 dev_dbg(&link
->dev
, "ibmtr_release\n");
329 struct tok_info
*ti
= netdev_priv(dev
);
331 pcmcia_release_window(info
->sram_win_handle
);
333 pcmcia_disable_device(link
);
336 static int ibmtr_suspend(struct pcmcia_device
*link
)
338 ibmtr_dev_t
*info
= link
->priv
;
339 struct net_device
*dev
= info
->dev
;
342 netif_device_detach(dev
);
347 static int __devinit
ibmtr_resume(struct pcmcia_device
*link
)
349 ibmtr_dev_t
*info
= link
->priv
;
350 struct net_device
*dev
= info
->dev
;
353 ibmtr_probe(dev
); /* really? */
354 netif_device_attach(dev
);
361 /*====================================================================*/
363 static void ibmtr_hw_setup(struct net_device
*dev
, u_int mmiobase
)
367 /* Bizarre IBM behavior, there are 16 bits of information we
368 need to set, but the card only allows us to send 4 bits at a
369 time. For each byte sent to base_addr, bits 7-4 tell the
370 card which part of the 16 bits we are setting, bits 3-0 contain
371 the actual information */
373 /* First nibble provides 4 bits of mmio */
374 i
= (mmiobase
>> 16) & 0x0F;
375 outb(i
, dev
->base_addr
);
377 /* Second nibble provides 3 bits of mmio */
378 i
= 0x10 | ((mmiobase
>> 12) & 0x0E);
379 outb(i
, dev
->base_addr
);
381 /* Third nibble, hard-coded values */
383 outb(i
, dev
->base_addr
);
385 /* Fourth nibble sets shared ram page size */
387 /* 8 = 00, 16 = 01, 32 = 10, 64 = 11 */
388 i
= (sramsize
>> 4) & 0x07;
389 i
= ((i
== 4) ? 3 : i
) << 2;
394 if (dev
->base_addr
== 0xA24)
396 outb(i
, dev
->base_addr
);
398 /* 0x40 will release the card for use */
399 outb(0x40, dev
->base_addr
);
404 static struct pcmcia_device_id ibmtr_ids
[] = {
405 PCMCIA_DEVICE_PROD_ID12("3Com", "TokenLink Velocity PC Card", 0x41240e5b, 0x82c3734e),
406 PCMCIA_DEVICE_PROD_ID12("IBM", "TOKEN RING", 0xb569a6e5, 0xbf8eed47),
409 MODULE_DEVICE_TABLE(pcmcia
, ibmtr_ids
);
411 static struct pcmcia_driver ibmtr_cs_driver
= {
412 .owner
= THIS_MODULE
,
416 .probe
= ibmtr_attach
,
417 .remove
= ibmtr_detach
,
418 .id_table
= ibmtr_ids
,
419 .suspend
= ibmtr_suspend
,
420 .resume
= ibmtr_resume
,
423 static int __init
init_ibmtr_cs(void)
425 return pcmcia_register_driver(&ibmtr_cs_driver
);
428 static void __exit
exit_ibmtr_cs(void)
430 pcmcia_unregister_driver(&ibmtr_cs_driver
);
433 module_init(init_ibmtr_cs
);
434 module_exit(exit_ibmtr_cs
);