1 /*******************************************************************************
3 * Wireless device driver for Linux (wlags49).
5 * Copyright (c) 1998-2003 Agere Systems Inc.
9 * Initially developed by TriplePoint, Inc.
10 * http://www.triplepoint.com
12 *------------------------------------------------------------------------------
14 * This file contains processing and initialization specific to Card Services
15 * devices (PCMCIA, CF).
17 *------------------------------------------------------------------------------
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.
26 * Copyright © 2003 Agere Systems Inc.
27 * All rights reserved.
29 * Redistribution and use in source or binary forms, with or without
30 * modifications, are permitted provided that the following conditions are met:
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
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.
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.
47 * THIS SOFTWARE IS PROVIDED
\93AS IS
\94 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
60 ******************************************************************************/
62 /*******************************************************************************
64 ******************************************************************************/
65 #include <wl_version.h>
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>
75 #include <linux/delay.h>
77 #include <asm/system.h>
78 #include <asm/bitops.h>
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>
86 #include <pcmcia/cs_types.h>
87 #include <pcmcia/cs.h>
88 #include <pcmcia/cistpl.h>
89 #include <pcmcia/cisreg.h>
90 #include <pcmcia/ciscode.h>
91 #include <pcmcia/ds.h>
99 #include <wl_internal.h>
102 #include <wl_netdev.h>
104 #include <wl_sysfs.h>
107 /*******************************************************************************
109 ******************************************************************************/
111 extern dbg_info_t *DbgInfo;
115 /*******************************************************************************
116 * wl_adapter_attach()
117 *******************************************************************************
121 * Creates an instance of the driver, allocating local data structures for
122 * one device. The device is registered with Card Services.
130 * pointer to an allocated dev_link_t structure
133 ******************************************************************************/
134 static int wl_adapter_attach(struct pcmcia_device *link)
136 struct net_device *dev;
137 struct wl_private *lp;
138 /*------------------------------------------------------------------------*/
140 DBG_FUNC( "wl_adapter_attach" );
141 DBG_ENTER( DbgInfo );
143 dev = wl_device_alloc();
145 DBG_ERROR( DbgInfo, "wl_device_alloc returned NULL\n");
149 link->io.NumPorts1 = HCF_NUM_IO_PORTS;
150 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
151 link->io.IOAddrLines = 6;
152 link->conf.Attributes = CONF_ENABLE_IRQ;
153 link->conf.IntType = INT_MEMORY_AND_IO;
154 link->conf.ConfigIndex = 5;
155 link->conf.Present = PRESENT_OPTION;
161 wl_adapter_insert(link);
163 DBG_LEAVE( DbgInfo );
165 } // wl_adapter_attach
166 /*============================================================================*/
170 /*******************************************************************************
171 * wl_adapter_detach()
172 *******************************************************************************
176 * This deletes a driver "instance". The device is de-registered with Card
177 * Services. If it has been released, then the net device is unregistered, and
178 * all local data structures are freed. Otherwise, the structures will be
179 * freed when the device is released.
183 * link - pointer to the dev_link_t structure representing the device to
190 ******************************************************************************/
191 static void wl_adapter_detach(struct pcmcia_device *link)
193 struct net_device *dev = link->priv;
194 /*------------------------------------------------------------------------*/
197 DBG_FUNC( "wl_adapter_detach" );
198 DBG_ENTER( DbgInfo );
199 DBG_PARAM( DbgInfo, "link", "0x%p", link );
201 wl_adapter_release(link);
204 unregister_wlags_sysfs(dev);
205 unregister_netdev(dev);
208 wl_device_dealloc(dev);
210 DBG_LEAVE( DbgInfo );
211 } // wl_adapter_detach
212 /*============================================================================*/
215 /*******************************************************************************
216 * wl_adapter_release()
217 *******************************************************************************
221 * After a card is removed, this routine will release the PCMCIA
222 * configuration. If the device is still open, this will be postponed until it
227 * arg - a u_long representing a pointer to a dev_link_t structure for the
228 * device to be released.
234 ******************************************************************************/
235 void wl_adapter_release( struct pcmcia_device *link )
237 DBG_FUNC( "wl_adapter_release" );
238 DBG_ENTER( DbgInfo );
239 DBG_PARAM( DbgInfo, "link", "0x%p", link);
242 wl_remove(link->priv);
244 pcmcia_disable_device(link);
246 DBG_LEAVE( DbgInfo );
247 } // wl_adapter_release
248 /*============================================================================*/
250 static int wl_adapter_suspend(struct pcmcia_device *link)
252 struct net_device *dev = link->priv;
255 netif_device_detach(dev);
257 //// CHECK! pcmcia_release_configuration(link->handle);
261 } // wl_adapter_suspend
263 static int wl_adapter_resume(struct pcmcia_device *link)
265 struct net_device *dev = link->priv;
269 netif_device_attach( dev );
272 } // wl_adapter_resume
274 /*******************************************************************************
275 * wl_adapter_insert()
276 *******************************************************************************
280 * wl_adapter_insert() is scheduled to run after a CARD_INSERTION event is
281 * received, to configure the PCMCIA socket, and to make the ethernet device
282 * available to the system.
286 * link - pointer to the dev_link_t structure representing the device to
293 ******************************************************************************/
294 void wl_adapter_insert( struct pcmcia_device *link )
296 struct net_device *dev;
299 /*------------------------------------------------------------------------*/
301 DBG_FUNC( "wl_adapter_insert" );
302 DBG_ENTER( DbgInfo );
303 DBG_PARAM( DbgInfo, "link", "0x%p", link );
307 /* Do we need to allocate an interrupt? */
308 link->conf.Attributes |= CONF_ENABLE_IRQ;
310 ret = pcmcia_request_io(link, &link->io);
314 ret = pcmcia_request_irq(link, (void *) wl_isr);
318 ret = pcmcia_request_configuration(link, &link->conf);
322 dev->irq = link->irq;
323 dev->base_addr = link->io.BasePort1;
325 SET_NETDEV_DEV(dev, &link->dev);
326 if (register_netdev(dev) != 0) {
327 printk("%s: register_netdev() failed\n", MODULE_NAME);
331 register_wlags_sysfs(dev);
333 printk(KERN_INFO "%s: Wireless, io_addr %#03lx, irq %d, ""mac_address ",
334 dev->name, dev->base_addr, dev->irq);
335 for( i = 0; i < ETH_ALEN; i++ ) {
336 printk("%02X%c", dev->dev_addr[i], ((i < (ETH_ALEN-1)) ? ':' : '\n'));
339 DBG_LEAVE( DbgInfo );
343 wl_adapter_release( link );
347 } // wl_adapter_insert
348 /*============================================================================*/
351 /*******************************************************************************
353 *******************************************************************************
361 * dev - a pointer to a net_device structure representing the network
367 * errno value otherwise
369 ******************************************************************************/
370 int wl_adapter_open( struct net_device *dev )
372 struct wl_private *lp = wl_priv(dev);
373 struct pcmcia_device *link = lp->link;
375 int hcf_status = HCF_SUCCESS;
376 /*------------------------------------------------------------------------*/
379 DBG_FUNC( "wl_adapter_open" );
380 DBG_ENTER( DbgInfo );
381 DBG_PRINT( "%s\n", VERSION_INFO );
382 DBG_PARAM( DbgInfo, "dev", "%s (0x%p)", dev->name, dev );
384 if(!pcmcia_dev_present(link))
386 DBG_LEAVE( DbgInfo );
392 hcf_status = wl_open( dev );
394 if( hcf_status != HCF_SUCCESS ) {
399 DBG_LEAVE( DbgInfo );
402 /*============================================================================*/
405 /*******************************************************************************
407 *******************************************************************************
415 * dev - a pointer to a net_device structure representing the network
421 * errno value otherwise
423 ******************************************************************************/
424 int wl_adapter_close( struct net_device *dev )
426 struct wl_private *lp = wl_priv(dev);
427 struct pcmcia_device *link = lp->link;
428 /*------------------------------------------------------------------------*/
431 DBG_FUNC( "wl_adapter_close" );
432 DBG_ENTER( DbgInfo );
433 DBG_PARAM( DbgInfo, "dev", "%s (0x%p)", dev->name, dev );
436 DBG_LEAVE( DbgInfo );
440 DBG_TRACE( DbgInfo, "%s: Shutting down adapter.\n", dev->name );
445 DBG_LEAVE( DbgInfo );
447 } // wl_adapter_close
448 /*============================================================================*/
450 static struct pcmcia_device_id wl_adapter_ids[] = {
451 #if ! ((HCF_TYPE) & HCF_TYPE_HII5)
452 PCMCIA_DEVICE_MANF_CARD(0x0156, 0x0003),
453 PCMCIA_DEVICE_PROD_ID12("Agere Systems", "Wireless PC Card Model 0110",
454 0x33103a9b, 0xe175b0dd),
456 PCMCIA_DEVICE_MANF_CARD(0x0156, 0x0004),
457 PCMCIA_DEVICE_PROD_ID12("Linksys", "WCF54G_Wireless-G_CompactFlash_Card",
458 0x0733cc81, 0x98a599e1),
459 #endif // (HCF_TYPE) & HCF_TYPE_HII5
462 MODULE_DEVICE_TABLE(pcmcia, wl_adapter_ids);
464 static struct pcmcia_driver wlags49_driver = {
465 .owner = THIS_MODULE,
469 .probe = wl_adapter_attach,
470 .remove = wl_adapter_detach,
471 .id_table = wl_adapter_ids,
472 .suspend = wl_adapter_suspend,
473 .resume = wl_adapter_resume,
478 /*******************************************************************************
479 * wl_adapter_init_module()
480 *******************************************************************************
484 * Called by init_module() to perform PCMCIA driver initialization.
495 ******************************************************************************/
496 int wl_adapter_init_module( void )
499 /*------------------------------------------------------------------------*/
502 DBG_FUNC( "wl_adapter_init_module" );
503 DBG_ENTER( DbgInfo );
504 DBG_TRACE( DbgInfo, "wl_adapter_init_module() -- PCMCIA\n" );
506 ret = pcmcia_register_driver(&wlags49_driver);
508 DBG_LEAVE( DbgInfo );
510 } // wl_adapter_init_module
511 /*============================================================================*/
514 /*******************************************************************************
515 * wl_adapter_cleanup_module()
516 *******************************************************************************
520 * Called by cleanup_module() to perform driver uninitialization.
530 ******************************************************************************/
531 void wl_adapter_cleanup_module( void )
533 DBG_FUNC( "wl_adapter_cleanup_module" );
534 DBG_ENTER( DbgInfo );
535 DBG_TRACE( DbgInfo, "wl_adapter_cleanup_module() -- PCMCIA\n" );
538 pcmcia_unregister_driver(&wlags49_driver);
540 DBG_LEAVE( DbgInfo );
542 } // wl_adapter_cleanup_module
543 /*============================================================================*/
546 /*******************************************************************************
547 * wl_adapter_is_open()
548 *******************************************************************************
552 * Check with Card Services to determine if this device is open.
556 * dev - a pointer to the net_device structure whose open status will be
561 * nonzero if device is open
564 ******************************************************************************/
565 int wl_adapter_is_open( struct net_device *dev )
567 struct wl_private *lp = wl_priv(dev);
568 struct pcmcia_device *link = lp->link;
570 if(!pcmcia_dev_present(link)) {
574 return( link->open );
575 } // wl_adapter_is_open
576 /*============================================================================*/
581 /*******************************************************************************
583 *******************************************************************************
587 * Converts the card serivces events to text for debugging.
591 * mask - a integer representing the error(s) being reported by Card
596 * a pointer to a string describing the error(s)
598 ******************************************************************************/
599 const char* DbgEvent( int mask )
601 static char DbgBuffer[256];
603 /*------------------------------------------------------------------------*/
610 if( mask & CS_EVENT_WRITE_PROTECT )
611 strcat( pBuf, "WRITE_PROTECT " );
613 if(mask & CS_EVENT_CARD_LOCK)
614 strcat( pBuf, "CARD_LOCK " );
616 if(mask & CS_EVENT_CARD_INSERTION)
617 strcat( pBuf, "CARD_INSERTION " );
619 if(mask & CS_EVENT_CARD_REMOVAL)
620 strcat( pBuf, "CARD_REMOVAL " );
622 if(mask & CS_EVENT_BATTERY_DEAD)
623 strcat( pBuf, "BATTERY_DEAD " );
625 if(mask & CS_EVENT_BATTERY_LOW)
626 strcat( pBuf, "BATTERY_LOW " );
628 if(mask & CS_EVENT_READY_CHANGE)
629 strcat( pBuf, "READY_CHANGE " );
631 if(mask & CS_EVENT_CARD_DETECT)
632 strcat( pBuf, "CARD_DETECT " );
634 if(mask & CS_EVENT_RESET_REQUEST)
635 strcat( pBuf, "RESET_REQUEST " );
637 if(mask & CS_EVENT_RESET_PHYSICAL)
638 strcat( pBuf, "RESET_PHYSICAL " );
640 if(mask & CS_EVENT_CARD_RESET)
641 strcat( pBuf, "CARD_RESET " );
643 if(mask & CS_EVENT_REGISTRATION_COMPLETE)
644 strcat( pBuf, "REGISTRATION_COMPLETE " );
646 // if(mask & CS_EVENT_RESET_COMPLETE)
647 // strcat( pBuf, "RESET_COMPLETE " );
649 if(mask & CS_EVENT_PM_SUSPEND)
650 strcat( pBuf, "PM_SUSPEND " );
652 if(mask & CS_EVENT_PM_RESUME)
653 strcat( pBuf, "PM_RESUME " );
655 if(mask & CS_EVENT_INSERTION_REQUEST)
656 strcat( pBuf, "INSERTION_REQUEST " );
658 if(mask & CS_EVENT_EJECTION_REQUEST)
659 strcat( pBuf, "EJECTION_REQUEST " );
661 if(mask & CS_EVENT_MTD_REQUEST)
662 strcat( pBuf, "MTD_REQUEST " );
664 if(mask & CS_EVENT_ERASE_COMPLETE)
665 strcat( pBuf, "ERASE_COMPLETE " );
667 if(mask & CS_EVENT_REQUEST_ATTENTION)
668 strcat( pBuf, "REQUEST_ATTENTION " );
670 if(mask & CS_EVENT_CB_DETECT)
671 strcat( pBuf, "CB_DETECT " );
673 if(mask & CS_EVENT_3VCARD)
674 strcat( pBuf, "3VCARD " );
676 if(mask & CS_EVENT_XVCARD)
677 strcat( pBuf, "XVCARD " );
681 pBuf[strlen(pBuf) - 1] = '\0';
684 sprintf( pBuf, "<<0x%08x>>", mask );
690 /*============================================================================*/