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 static int pc_debug
= PCMCIA_DEBUG
;
74 module_param(pc_debug
, int, 0);
75 #define DEBUG(n, args...) if (pc_debug>(n)) printk(KERN_DEBUG args)
76 static char *version
=
77 "ibmtr_cs.c 1.10 1996/01/06 05:19:00 (Steve Kipisz)\n"
78 " 2.2.7 1999/05/03 12:00:00 (Mike Phillips)\n"
79 " 2.4.2 2001/30/28 Midnight (Burt Silverman)\n";
81 #define DEBUG(n, args...)
84 /*====================================================================*/
86 /* Parameters that can be set with 'insmod' */
88 /* MMIO base address */
89 static u_long mmiobase
= 0xce000;
91 /* SRAM base address */
92 static u_long srambase
= 0xd0000;
94 /* SRAM size 8,16,32,64 */
95 static u_long sramsize
= 64;
98 static int ringspeed
= 16;
100 module_param(mmiobase
, ulong
, 0);
101 module_param(srambase
, ulong
, 0);
102 module_param(sramsize
, ulong
, 0);
103 module_param(ringspeed
, int, 0);
104 MODULE_LICENSE("GPL");
106 /*====================================================================*/
108 static int ibmtr_config(struct pcmcia_device
*link
);
109 static void ibmtr_hw_setup(struct net_device
*dev
, u_int mmiobase
);
110 static void ibmtr_release(struct pcmcia_device
*link
);
111 static void ibmtr_detach(struct pcmcia_device
*p_dev
);
113 /*====================================================================*/
115 typedef struct ibmtr_dev_t
{
116 struct pcmcia_device
*p_dev
;
117 struct net_device
*dev
;
119 window_handle_t sram_win_handle
;
123 static void netdev_get_drvinfo(struct net_device
*dev
,
124 struct ethtool_drvinfo
*info
)
126 strcpy(info
->driver
, "ibmtr_cs");
129 static const struct ethtool_ops netdev_ethtool_ops
= {
130 .get_drvinfo
= netdev_get_drvinfo
,
133 /*======================================================================
135 ibmtr_attach() creates an "instance" of the driver, allocating
136 local data structures for one device. The device is registered
139 ======================================================================*/
141 static int __devinit
ibmtr_attach(struct pcmcia_device
*link
)
144 struct net_device
*dev
;
146 DEBUG(0, "ibmtr_attach()\n");
148 /* Create new token-ring device */
149 info
= kzalloc(sizeof(*info
), GFP_KERNEL
);
150 if (!info
) return -ENOMEM
;
151 dev
= alloc_trdev(sizeof(struct tok_info
));
159 info
->ti
= netdev_priv(dev
);
161 link
->io
.Attributes1
= IO_DATA_PATH_WIDTH_8
;
162 link
->io
.NumPorts1
= 4;
163 link
->io
.IOAddrLines
= 16;
164 link
->irq
.Attributes
= IRQ_TYPE_EXCLUSIVE
| IRQ_HANDLE_PRESENT
;
165 link
->irq
.IRQInfo1
= IRQ_LEVEL_ID
;
166 link
->irq
.Handler
= &tok_interrupt
;
167 link
->conf
.Attributes
= CONF_ENABLE_IRQ
;
168 link
->conf
.IntType
= INT_MEMORY_AND_IO
;
169 link
->conf
.Present
= PRESENT_OPTION
;
171 link
->irq
.Instance
= info
->dev
= dev
;
173 SET_ETHTOOL_OPS(dev
, &netdev_ethtool_ops
);
175 return ibmtr_config(link
);
178 /*======================================================================
180 This deletes a driver "instance". The device is de-registered
181 with Card Services. If it has been released, all local data
182 structures are freed. Otherwise, the structures will be freed
183 when the device is released.
185 ======================================================================*/
187 static void ibmtr_detach(struct pcmcia_device
*link
)
189 struct ibmtr_dev_t
*info
= link
->priv
;
190 struct net_device
*dev
= info
->dev
;
191 struct tok_info
*ti
= netdev_priv(dev
);
193 DEBUG(0, "ibmtr_detach(0x%p)\n", link
);
196 * When the card removal interrupt hits tok_interrupt(),
197 * bail out early, so we don't crash the machine
202 unregister_netdev(dev
);
204 del_timer_sync(&(ti
->tr_timer
));
212 /*======================================================================
214 ibmtr_config() is scheduled to run after a CARD_INSERTION event
215 is received, to configure the PCMCIA socket, and to make the
216 token-ring device available to the system.
218 ======================================================================*/
220 #define CS_CHECK(fn, ret) \
221 do { last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; } while (0)
223 static int __devinit
ibmtr_config(struct pcmcia_device
*link
)
225 ibmtr_dev_t
*info
= link
->priv
;
226 struct net_device
*dev
= info
->dev
;
227 struct tok_info
*ti
= netdev_priv(dev
);
230 int i
, last_ret
, last_fn
;
232 DEBUG(0, "ibmtr_config(0x%p)\n", link
);
234 link
->conf
.ConfigIndex
= 0x61;
236 /* Determine if this is PRIMARY or ALTERNATE. */
238 /* Try PRIMARY card at 0xA20-0xA23 */
239 link
->io
.BasePort1
= 0xA20;
240 i
= pcmcia_request_io(link
, &link
->io
);
241 if (i
!= CS_SUCCESS
) {
242 /* Couldn't get 0xA20-0xA23. Try ALTERNATE at 0xA24-0xA27. */
243 link
->io
.BasePort1
= 0xA24;
244 CS_CHECK(RequestIO
, pcmcia_request_io(link
, &link
->io
));
246 dev
->base_addr
= link
->io
.BasePort1
;
248 CS_CHECK(RequestIRQ
, pcmcia_request_irq(link
, &link
->irq
));
249 dev
->irq
= link
->irq
.AssignedIRQ
;
250 ti
->irq
= link
->irq
.AssignedIRQ
;
251 ti
->global_int_enable
=GLOBAL_INT_ENABLE
+((dev
->irq
==9) ? 2 : dev
->irq
);
253 /* Allocate the MMIO memory window */
254 req
.Attributes
= WIN_DATA_WIDTH_16
|WIN_MEMORY_TYPE_CM
|WIN_ENABLE
;
255 req
.Attributes
|= WIN_USE_WAIT
;
258 req
.AccessSpeed
= 250;
259 CS_CHECK(RequestWindow
, pcmcia_request_window(&link
, &req
, &link
->win
));
261 mem
.CardOffset
= mmiobase
;
263 CS_CHECK(MapMemPage
, pcmcia_map_mem_page(link
->win
, &mem
));
264 ti
->mmio
= ioremap(req
.Base
, req
.Size
);
266 /* Allocate the SRAM memory window */
267 req
.Attributes
= WIN_DATA_WIDTH_16
|WIN_MEMORY_TYPE_CM
|WIN_ENABLE
;
268 req
.Attributes
|= WIN_USE_WAIT
;
270 req
.Size
= sramsize
* 1024;
271 req
.AccessSpeed
= 250;
272 CS_CHECK(RequestWindow
, pcmcia_request_window(&link
, &req
, &info
->sram_win_handle
));
274 mem
.CardOffset
= srambase
;
276 CS_CHECK(MapMemPage
, pcmcia_map_mem_page(info
->sram_win_handle
, &mem
));
278 ti
->sram_base
= mem
.CardOffset
>> 12;
279 ti
->sram_virt
= ioremap(req
.Base
, req
.Size
);
280 ti
->sram_phys
= req
.Base
;
282 CS_CHECK(RequestConfiguration
, 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
);
301 printk(KERN_INFO
"%s: port %#3lx, irq %d,",
302 dev
->name
, dev
->base_addr
, dev
->irq
);
303 printk (" mmio %#5lx,", (u_long
)ti
->mmio
);
304 printk (" sram %#5lx,", (u_long
)ti
->sram_base
<< 12);
305 printk ("\n" KERN_INFO
" hwaddr=");
306 for (i
= 0; i
< TR_ALEN
; i
++)
307 printk("%02X", dev
->dev_addr
[i
]);
312 cs_error(link
, last_fn
, last_ret
);
318 /*======================================================================
320 After a card is removed, ibmtr_release() will unregister the net
321 device, and release the PCMCIA configuration. If the device is
322 still open, this will be postponed until it is closed.
324 ======================================================================*/
326 static void ibmtr_release(struct pcmcia_device
*link
)
328 ibmtr_dev_t
*info
= link
->priv
;
329 struct net_device
*dev
= info
->dev
;
331 DEBUG(0, "ibmtr_release(0x%p)\n", link
);
334 struct tok_info
*ti
= netdev_priv(dev
);
336 pcmcia_release_window(info
->sram_win_handle
);
338 pcmcia_disable_device(link
);
341 static int ibmtr_suspend(struct pcmcia_device
*link
)
343 ibmtr_dev_t
*info
= link
->priv
;
344 struct net_device
*dev
= info
->dev
;
347 netif_device_detach(dev
);
352 static int ibmtr_resume(struct pcmcia_device
*link
)
354 ibmtr_dev_t
*info
= link
->priv
;
355 struct net_device
*dev
= info
->dev
;
358 ibmtr_probe(dev
); /* really? */
359 netif_device_attach(dev
);
366 /*====================================================================*/
368 static void ibmtr_hw_setup(struct net_device
*dev
, u_int mmiobase
)
372 /* Bizarre IBM behavior, there are 16 bits of information we
373 need to set, but the card only allows us to send 4 bits at a
374 time. For each byte sent to base_addr, bits 7-4 tell the
375 card which part of the 16 bits we are setting, bits 3-0 contain
376 the actual information */
378 /* First nibble provides 4 bits of mmio */
379 i
= (mmiobase
>> 16) & 0x0F;
380 outb(i
, dev
->base_addr
);
382 /* Second nibble provides 3 bits of mmio */
383 i
= 0x10 | ((mmiobase
>> 12) & 0x0E);
384 outb(i
, dev
->base_addr
);
386 /* Third nibble, hard-coded values */
388 outb(i
, dev
->base_addr
);
390 /* Fourth nibble sets shared ram page size */
392 /* 8 = 00, 16 = 01, 32 = 10, 64 = 11 */
393 i
= (sramsize
>> 4) & 0x07;
394 i
= ((i
== 4) ? 3 : i
) << 2;
399 if (dev
->base_addr
== 0xA24)
401 outb(i
, dev
->base_addr
);
403 /* 0x40 will release the card for use */
404 outb(0x40, dev
->base_addr
);
409 static struct pcmcia_device_id ibmtr_ids
[] = {
410 PCMCIA_DEVICE_PROD_ID12("3Com", "TokenLink Velocity PC Card", 0x41240e5b, 0x82c3734e),
411 PCMCIA_DEVICE_PROD_ID12("IBM", "TOKEN RING", 0xb569a6e5, 0xbf8eed47),
414 MODULE_DEVICE_TABLE(pcmcia
, ibmtr_ids
);
416 static struct pcmcia_driver ibmtr_cs_driver
= {
417 .owner
= THIS_MODULE
,
421 .probe
= ibmtr_attach
,
422 .remove
= ibmtr_detach
,
423 .id_table
= ibmtr_ids
,
424 .suspend
= ibmtr_suspend
,
425 .resume
= ibmtr_resume
,
428 static int __init
init_ibmtr_cs(void)
430 return pcmcia_register_driver(&ibmtr_cs_driver
);
433 static void __exit
exit_ibmtr_cs(void)
435 pcmcia_unregister_driver(&ibmtr_cs_driver
);
438 module_init(init_ibmtr_cs
);
439 module_exit(exit_ibmtr_cs
);