pcmcia: do not use io_req_t after call to pcmcia_request_io()
[linux-2.6.git] / drivers / staging / wlags49_h2 / wl_cs.c
1 /*******************************************************************************
2  * Agere Systems Inc.
3  * Wireless device driver for Linux (wlags49).
4  *
5  * Copyright (c) 1998-2003 Agere Systems Inc.
6  * All rights reserved.
7  *   http://www.agere.com
8  *
9  * Initially developed by TriplePoint, Inc.
10  *   http://www.triplepoint.com
11  *
12  *------------------------------------------------------------------------------
13  *
14  *   This file contains processing and initialization specific to Card Services
15  *   devices (PCMCIA, CF).
16  *
17  *------------------------------------------------------------------------------
18  *
19  * SOFTWARE LICENSE
20  *
21  * This software is provided subject to the following terms and conditions,
22  * which you should read carefully before using the software.  Using this
23  * software indicates your acceptance of these terms and conditions.  If you do
24  * not agree with these terms and conditions, do not use the software.
25  *
26  * Copyright © 2003 Agere Systems Inc.
27  * All rights reserved.
28  *
29  * Redistribution and use in source or binary forms, with or without
30  * modifications, are permitted provided that the following conditions are met:
31  *
32  * . Redistributions of source code must retain the above copyright notice, this
33  *    list of conditions and the following Disclaimer as comments in the code as
34  *    well as in the documentation and/or other materials provided with the
35  *    distribution.
36  *
37  * . Redistributions in binary form must reproduce the above copyright notice,
38  *    this list of conditions and the following Disclaimer in the documentation
39  *    and/or other materials provided with the distribution.
40  *
41  * . Neither the name of Agere Systems Inc. nor the names of the contributors
42  *    may be used to endorse or promote products derived from this software
43  *    without specific prior written permission.
44  *
45  * Disclaimer
46  *
47  * THIS SOFTWARE IS PROVIDED “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES,
48  * INCLUDING, BUT NOT LIMITED TO, INFRINGEMENT AND THE IMPLIED WARRANTIES OF
49  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  ANY
50  * USE, MODIFICATION OR DISTRIBUTION OF THIS SOFTWARE IS SOLELY AT THE USERS OWN
51  * RISK. IN NO EVENT SHALL AGERE SYSTEMS INC. OR CONTRIBUTORS BE LIABLE FOR ANY
52  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
53  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
54  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
55  * ON ANY THEORY OF LIABILITY, INCLUDING, BUT NOT LIMITED TO, CONTRACT, STRICT
56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
57  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
58  * DAMAGE.
59  *
60  ******************************************************************************/
61
62 /*******************************************************************************
63  *  include files
64  ******************************************************************************/
65 #include <wl_version.h>
66
67 #include <linux/kernel.h>
68 #include <linux/sched.h>
69 #include <linux/ptrace.h>
70 #include <linux/ctype.h>
71 #include <linux/string.h>
72 #include <linux/timer.h>
73 #include <linux/interrupt.h>
74 #include <linux/in.h>
75 #include <linux/delay.h>
76 #include <asm/io.h>
77 #include <asm/system.h>
78 #include <asm/bitops.h>
79
80 #include <linux/netdevice.h>
81 #include <linux/etherdevice.h>
82 #include <linux/skbuff.h>
83 #include <linux/if_arp.h>
84 #include <linux/ioport.h>
85
86 #include <pcmcia/cs.h>
87 #include <pcmcia/cistpl.h>
88 #include <pcmcia/cisreg.h>
89 #include <pcmcia/ciscode.h>
90 #include <pcmcia/ds.h>
91 #include <debug.h>
92
93 #include <hcf.h>
94 #include <dhf.h>
95 #include <hcfdef.h>
96
97 #include <wl_if.h>
98 #include <wl_internal.h>
99 #include <wl_util.h>
100 #include <wl_main.h>
101 #include <wl_netdev.h>
102 #include <wl_cs.h>
103 #include <wl_sysfs.h>
104
105
106 /*******************************************************************************
107  *  global definitions
108  ******************************************************************************/
109 #if DBG
110 extern dbg_info_t *DbgInfo;
111 #endif  /* DBG */
112
113
114 /*******************************************************************************
115  *      wl_adapter_attach()
116  *******************************************************************************
117  *
118  *  DESCRIPTION:
119  *
120  *      Creates an instance of the driver, allocating local data structures for
121  *  one device. The device is registered with Card Services.
122  *
123  *  PARAMETERS:
124  *
125  *      none
126  *
127  *  RETURNS:
128  *
129  *      pointer to an allocated dev_link_t structure
130  *      NULL on failure
131  *
132  ******************************************************************************/
133 static int wl_adapter_attach(struct pcmcia_device *link)
134 {
135     struct net_device   *dev;
136     struct wl_private   *lp;
137     /*------------------------------------------------------------------------*/
138
139     DBG_FUNC( "wl_adapter_attach" );
140     DBG_ENTER( DbgInfo );
141
142     dev = wl_device_alloc();
143     if(dev == NULL) {
144         DBG_ERROR( DbgInfo, "wl_device_alloc returned NULL\n");
145         return -ENOMEM;
146     }
147
148     link->io.NumPorts1      = HCF_NUM_IO_PORTS;
149     link->io.Attributes1    = IO_DATA_PATH_WIDTH_16;
150     link->io.IOAddrLines    = 6;
151     link->conf.Attributes   = CONF_ENABLE_IRQ;
152     link->conf.IntType      = INT_MEMORY_AND_IO;
153     link->conf.ConfigIndex  = 5;
154     link->conf.Present      = PRESENT_OPTION;
155
156     link->priv = dev;
157     lp = wl_priv(dev);
158     lp->link = link;
159
160     wl_adapter_insert(link);
161
162     DBG_LEAVE( DbgInfo );
163     return 0;
164 } // wl_adapter_attach
165 /*============================================================================*/
166
167
168
169 /*******************************************************************************
170  *      wl_adapter_detach()
171  *******************************************************************************
172  *
173  *  DESCRIPTION:
174  *
175  *      This deletes a driver "instance". The device is de-registered with Card
176  *  Services. If it has been released, then the net device is unregistered, and
177  *  all local data structures are freed. Otherwise, the structures will be
178  *  freed when the device is released.
179  *
180  *  PARAMETERS:
181  *
182  *      link    - pointer to the dev_link_t structure representing the device to
183  *                detach
184  *
185  *  RETURNS:
186  *
187  *      N/A
188  *
189  ******************************************************************************/
190 static void wl_adapter_detach(struct pcmcia_device *link)
191 {
192     struct net_device   *dev = link->priv;
193     /*------------------------------------------------------------------------*/
194
195
196     DBG_FUNC( "wl_adapter_detach" );
197     DBG_ENTER( DbgInfo );
198     DBG_PARAM( DbgInfo, "link", "0x%p", link );
199
200     wl_adapter_release(link);
201
202     if (dev) {
203         unregister_wlags_sysfs(dev);
204         unregister_netdev(dev);
205     }
206
207     wl_device_dealloc(dev);
208
209     DBG_LEAVE( DbgInfo );
210 } // wl_adapter_detach
211 /*============================================================================*/
212
213
214 /*******************************************************************************
215  *      wl_adapter_release()
216  *******************************************************************************
217  *
218  *  DESCRIPTION:
219  *
220  *      After a card is removed, this routine will release the PCMCIA
221  *  configuration. If the device is still open, this will be postponed until it
222  *  is closed.
223  *
224  *  PARAMETERS:
225  *
226  *      arg - a u_long representing a pointer to a dev_link_t structure for the
227  *            device to be released.
228  *
229  *  RETURNS:
230  *
231  *      N/A
232  *
233  ******************************************************************************/
234 void wl_adapter_release( struct pcmcia_device *link )
235 {
236     DBG_FUNC( "wl_adapter_release" );
237     DBG_ENTER( DbgInfo );
238     DBG_PARAM( DbgInfo, "link", "0x%p", link);
239
240     /* Stop hardware */
241     wl_remove(link->priv);
242
243     pcmcia_disable_device(link);
244
245     DBG_LEAVE( DbgInfo );
246 } // wl_adapter_release
247 /*============================================================================*/
248
249 static int wl_adapter_suspend(struct pcmcia_device *link)
250 {
251     struct net_device *dev = link->priv;
252
253     //if (link->open) {
254         netif_device_detach(dev);
255         wl_suspend(dev);
256 //// CHECK!            pcmcia_release_configuration(link->handle);
257     //}
258
259     return 0;
260 } // wl_adapter_suspend
261
262 static int wl_adapter_resume(struct pcmcia_device *link)
263 {
264         struct net_device *dev = link->priv;
265
266         wl_resume(dev);
267
268         netif_device_attach( dev );
269
270         return 0;
271 } // wl_adapter_resume
272
273 /*******************************************************************************
274  *      wl_adapter_insert()
275  *******************************************************************************
276  *
277  *  DESCRIPTION:
278  *
279  *      wl_adapter_insert() is scheduled to run after a CARD_INSERTION event is
280  *  received, to configure the PCMCIA socket, and to make the ethernet device
281  *  available to the system.
282  *
283  *  PARAMETERS:
284  *
285  *      link    - pointer to the dev_link_t structure representing the device to
286  *                insert
287  *
288  *  RETURNS:
289  *
290  *      N/A
291  *
292  ******************************************************************************/
293 void wl_adapter_insert( struct pcmcia_device *link )
294 {
295     struct net_device       *dev;
296     int i;
297     int                     ret;
298     /*------------------------------------------------------------------------*/
299
300     DBG_FUNC( "wl_adapter_insert" );
301     DBG_ENTER( DbgInfo );
302     DBG_PARAM( DbgInfo, "link", "0x%p", link );
303
304     dev     = link->priv;
305
306     /* Do we need to allocate an interrupt? */
307     link->conf.Attributes |= CONF_ENABLE_IRQ;
308
309     ret = pcmcia_request_io(link, &link->io);
310     if (ret != 0)
311         goto failed;
312
313     ret = pcmcia_request_irq(link, (void *) wl_isr);
314     if (ret != 0)
315         goto failed;
316
317     ret = pcmcia_request_configuration(link, &link->conf);
318     if (ret != 0)
319         goto failed;
320
321     dev->irq        = link->irq;
322     dev->base_addr  = link->resource[0]->start;
323
324     SET_NETDEV_DEV(dev, &link->dev);
325     if (register_netdev(dev) != 0) {
326         printk("%s: register_netdev() failed\n", MODULE_NAME);
327         goto failed;
328     }
329
330     register_wlags_sysfs(dev);
331
332     printk(KERN_INFO "%s: Wireless, io_addr %#03lx, irq %d, ""mac_address ",
333                dev->name, dev->base_addr, dev->irq);
334     for( i = 0; i < ETH_ALEN; i++ ) {
335         printk("%02X%c", dev->dev_addr[i], ((i < (ETH_ALEN-1)) ? ':' : '\n'));
336     }
337
338     DBG_LEAVE( DbgInfo );
339     return;
340
341 failed:
342     wl_adapter_release( link );
343
344     DBG_LEAVE(DbgInfo);
345     return;
346 } // wl_adapter_insert
347 /*============================================================================*/
348
349
350 /*******************************************************************************
351  *      wl_adapter_open()
352  *******************************************************************************
353  *
354  *  DESCRIPTION:
355  *
356  *      Open the device.
357  *
358  *  PARAMETERS:
359  *
360  *      dev - a pointer to a net_device structure representing the network
361  *            device to open.
362  *
363  *  RETURNS:
364  *
365  *      0 on success
366  *      errno value otherwise
367  *
368  ******************************************************************************/
369 int wl_adapter_open( struct net_device *dev )
370 {
371     struct wl_private *lp = wl_priv(dev);
372     struct pcmcia_device *link = lp->link;
373     int         result = 0;
374     int         hcf_status = HCF_SUCCESS;
375     /*------------------------------------------------------------------------*/
376
377
378     DBG_FUNC( "wl_adapter_open" );
379     DBG_ENTER( DbgInfo );
380         DBG_PRINT( "%s\n", VERSION_INFO );
381     DBG_PARAM( DbgInfo, "dev", "%s (0x%p)", dev->name, dev );
382
383     if(!pcmcia_dev_present(link))
384     {
385         DBG_LEAVE( DbgInfo );
386         return -ENODEV;
387     }
388
389     link->open++;
390
391     hcf_status = wl_open( dev );
392
393     if( hcf_status != HCF_SUCCESS ) {
394         link->open--;
395         result = -ENODEV;
396     }
397
398     DBG_LEAVE( DbgInfo );
399     return result;
400 } // wl_adapter_open
401 /*============================================================================*/
402
403
404 /*******************************************************************************
405  *      wl_adapter_close()
406  *******************************************************************************
407  *
408  *  DESCRIPTION:
409  *
410  *      Close the device.
411  *
412  *  PARAMETERS:
413  *
414  *      dev - a pointer to a net_device structure representing the network
415  *            device to close.
416  *
417  *  RETURNS:
418  *
419  *      0 on success
420  *      errno value otherwise
421  *
422  ******************************************************************************/
423 int wl_adapter_close( struct net_device *dev )
424 {
425     struct wl_private *lp = wl_priv(dev);
426     struct pcmcia_device *link = lp->link;
427     /*------------------------------------------------------------------------*/
428
429
430     DBG_FUNC( "wl_adapter_close" );
431     DBG_ENTER( DbgInfo );
432     DBG_PARAM( DbgInfo, "dev", "%s (0x%p)", dev->name, dev );
433
434     if( link == NULL ) {
435         DBG_LEAVE( DbgInfo );
436         return -ENODEV;
437     }
438
439     DBG_TRACE( DbgInfo, "%s: Shutting down adapter.\n", dev->name );
440     wl_close( dev );
441
442     link->open--;
443
444     DBG_LEAVE( DbgInfo );
445     return 0;
446 } // wl_adapter_close
447 /*============================================================================*/
448
449 static struct pcmcia_device_id wl_adapter_ids[] = {
450 #if ! ((HCF_TYPE) & HCF_TYPE_HII5)
451         PCMCIA_DEVICE_MANF_CARD(0x0156, 0x0003),
452         PCMCIA_DEVICE_PROD_ID12("Agere Systems", "Wireless PC Card Model 0110",
453                             0x33103a9b, 0xe175b0dd),
454 #else
455         PCMCIA_DEVICE_MANF_CARD(0x0156, 0x0004),
456         PCMCIA_DEVICE_PROD_ID12("Linksys", "WCF54G_Wireless-G_CompactFlash_Card",
457                             0x0733cc81, 0x98a599e1),
458 #endif  // (HCF_TYPE) & HCF_TYPE_HII5
459         PCMCIA_DEVICE_NULL,
460         };
461 MODULE_DEVICE_TABLE(pcmcia, wl_adapter_ids);
462
463 static struct pcmcia_driver wlags49_driver = {
464     .owner          = THIS_MODULE,
465     .drv            = {
466         .name   = DRIVER_NAME,
467     },
468     .probe      = wl_adapter_attach,
469     .remove     = wl_adapter_detach,
470     .id_table   = wl_adapter_ids,
471     .suspend    = wl_adapter_suspend,
472     .resume     = wl_adapter_resume,
473 };
474
475
476
477 /*******************************************************************************
478  *      wl_adapter_init_module()
479  *******************************************************************************
480  *
481  *  DESCRIPTION:
482  *
483  *      Called by init_module() to perform PCMCIA driver initialization.
484  *
485  *  PARAMETERS:
486  *
487  *      N/A
488  *
489  *  RETURNS:
490  *
491  *      0 on success
492  *      -1 on error
493  *
494  ******************************************************************************/
495 int wl_adapter_init_module( void )
496 {
497     int ret;
498     /*------------------------------------------------------------------------*/
499
500
501     DBG_FUNC( "wl_adapter_init_module" );
502     DBG_ENTER( DbgInfo );
503     DBG_TRACE( DbgInfo, "wl_adapter_init_module() -- PCMCIA\n" );
504
505     ret = pcmcia_register_driver(&wlags49_driver);
506
507     DBG_LEAVE( DbgInfo );
508     return ret;
509 } // wl_adapter_init_module
510 /*============================================================================*/
511
512
513 /*******************************************************************************
514  *      wl_adapter_cleanup_module()
515  *******************************************************************************
516  *
517  *  DESCRIPTION:
518  *
519  *      Called by cleanup_module() to perform driver uninitialization.
520  *
521  *  PARAMETERS:
522  *
523  *      N/A
524  *
525  *  RETURNS:
526  *
527  *      N/A
528  *
529  ******************************************************************************/
530 void wl_adapter_cleanup_module( void )
531 {
532     DBG_FUNC( "wl_adapter_cleanup_module" );
533     DBG_ENTER( DbgInfo );
534     DBG_TRACE( DbgInfo, "wl_adapter_cleanup_module() -- PCMCIA\n" );
535
536
537     pcmcia_unregister_driver(&wlags49_driver);
538
539     DBG_LEAVE( DbgInfo );
540     return;
541 } // wl_adapter_cleanup_module
542 /*============================================================================*/
543
544
545 /*******************************************************************************
546  *      wl_adapter_is_open()
547  *******************************************************************************
548  *
549  *  DESCRIPTION:
550  *
551  *      Check with Card Services to determine if this device is open.
552  *
553  *  PARAMETERS:
554  *
555  *      dev - a pointer to the net_device structure whose open status will be
556  *            checked
557  *
558  *  RETURNS:
559  *
560  *      nonzero if device is open
561  *      0 otherwise
562  *
563  ******************************************************************************/
564 int wl_adapter_is_open( struct net_device *dev )
565 {
566     struct wl_private *lp = wl_priv(dev);
567     struct pcmcia_device *link = lp->link;
568
569     if(!pcmcia_dev_present(link)) {
570         return 0;
571     }
572
573     return( link->open );
574 } // wl_adapter_is_open
575 /*============================================================================*/
576
577
578 #if DBG
579
580 /*******************************************************************************
581  *      DbgEvent()
582  *******************************************************************************
583  *
584  *  DESCRIPTION:
585  *
586  *      Converts the card serivces events to text for debugging.
587  *
588  *  PARAMETERS:
589  *
590  *      mask    - a integer representing the error(s) being reported by Card
591  *                Services.
592  *
593  *  RETURNS:
594  *
595  *      a pointer to a string describing the error(s)
596  *
597  ******************************************************************************/
598 const char* DbgEvent( int mask )
599 {
600     static char DbgBuffer[256];
601     char *pBuf;
602     /*------------------------------------------------------------------------*/
603
604
605     pBuf    = DbgBuffer;
606     *pBuf   = '\0';
607
608
609     if( mask & CS_EVENT_WRITE_PROTECT )
610         strcat( pBuf, "WRITE_PROTECT " );
611
612     if(mask & CS_EVENT_CARD_LOCK)
613         strcat( pBuf, "CARD_LOCK " );
614
615     if(mask & CS_EVENT_CARD_INSERTION)
616         strcat( pBuf, "CARD_INSERTION " );
617
618     if(mask & CS_EVENT_CARD_REMOVAL)
619         strcat( pBuf, "CARD_REMOVAL " );
620
621     if(mask & CS_EVENT_BATTERY_DEAD)
622         strcat( pBuf, "BATTERY_DEAD " );
623
624     if(mask & CS_EVENT_BATTERY_LOW)
625         strcat( pBuf, "BATTERY_LOW " );
626
627     if(mask & CS_EVENT_READY_CHANGE)
628         strcat( pBuf, "READY_CHANGE " );
629
630     if(mask & CS_EVENT_CARD_DETECT)
631         strcat( pBuf, "CARD_DETECT " );
632
633     if(mask & CS_EVENT_RESET_REQUEST)
634         strcat( pBuf, "RESET_REQUEST " );
635
636     if(mask & CS_EVENT_RESET_PHYSICAL)
637         strcat( pBuf, "RESET_PHYSICAL " );
638
639     if(mask & CS_EVENT_CARD_RESET)
640         strcat( pBuf, "CARD_RESET " );
641
642     if(mask & CS_EVENT_REGISTRATION_COMPLETE)
643         strcat( pBuf, "REGISTRATION_COMPLETE " );
644
645     // if(mask & CS_EVENT_RESET_COMPLETE)
646     //     strcat( pBuf, "RESET_COMPLETE " );
647
648     if(mask & CS_EVENT_PM_SUSPEND)
649         strcat( pBuf, "PM_SUSPEND " );
650
651     if(mask & CS_EVENT_PM_RESUME)
652         strcat( pBuf, "PM_RESUME " );
653
654     if(mask & CS_EVENT_INSERTION_REQUEST)
655         strcat( pBuf, "INSERTION_REQUEST " );
656
657     if(mask & CS_EVENT_EJECTION_REQUEST)
658         strcat( pBuf, "EJECTION_REQUEST " );
659
660     if(mask & CS_EVENT_MTD_REQUEST)
661         strcat( pBuf, "MTD_REQUEST " );
662
663     if(mask & CS_EVENT_ERASE_COMPLETE)
664         strcat( pBuf, "ERASE_COMPLETE " );
665
666     if(mask & CS_EVENT_REQUEST_ATTENTION)
667         strcat( pBuf, "REQUEST_ATTENTION " );
668
669     if(mask & CS_EVENT_CB_DETECT)
670         strcat( pBuf, "CB_DETECT " );
671
672     if(mask & CS_EVENT_3VCARD)
673         strcat( pBuf, "3VCARD " );
674
675     if(mask & CS_EVENT_XVCARD)
676         strcat( pBuf, "XVCARD " );
677
678
679     if( *pBuf ) {
680         pBuf[strlen(pBuf) - 1] = '\0';
681     } else {
682         if( mask != 0x0 ) {
683             sprintf( pBuf, "<<0x%08x>>", mask );
684         }
685     }
686
687     return pBuf;
688 } // DbgEvent
689 /*============================================================================*/
690
691 #endif  /* DBG */