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 ******************************************************************************/
110 #define CS_CHECK(fn, ret) do { \
111 last_fn = (fn); if ((last_ret = (ret)) != 0) goto cs_failed; \
114 /*******************************************************************************
116 ******************************************************************************/
118 extern dbg_info_t *DbgInfo;
122 /*******************************************************************************
123 * wl_adapter_attach()
124 *******************************************************************************
128 * Creates an instance of the driver, allocating local data structures for
129 * one device. The device is registered with Card Services.
137 * pointer to an allocated dev_link_t structure
140 ******************************************************************************/
141 static int wl_adapter_attach(struct pcmcia_device *link)
143 struct net_device *dev;
144 struct wl_private *lp;
145 /*------------------------------------------------------------------------*/
147 DBG_FUNC( "wl_adapter_attach" );
148 DBG_ENTER( DbgInfo );
150 dev = wl_device_alloc();
152 DBG_ERROR( DbgInfo, "wl_device_alloc returned NULL\n");
156 link->io.NumPorts1 = HCF_NUM_IO_PORTS;
157 link->io.Attributes1 = IO_DATA_PATH_WIDTH_16;
158 link->io.IOAddrLines = 6;
159 link->conf.Attributes = CONF_ENABLE_IRQ;
160 link->conf.IntType = INT_MEMORY_AND_IO;
161 link->conf.ConfigIndex = 5;
162 link->conf.Present = PRESENT_OPTION;
168 wl_adapter_insert(link);
170 DBG_LEAVE( DbgInfo );
172 } // wl_adapter_attach
173 /*============================================================================*/
177 /*******************************************************************************
178 * wl_adapter_detach()
179 *******************************************************************************
183 * This deletes a driver "instance". The device is de-registered with Card
184 * Services. If it has been released, then the net device is unregistered, and
185 * all local data structures are freed. Otherwise, the structures will be
186 * freed when the device is released.
190 * link - pointer to the dev_link_t structure representing the device to
197 ******************************************************************************/
198 static void wl_adapter_detach(struct pcmcia_device *link)
200 struct net_device *dev = link->priv;
201 /*------------------------------------------------------------------------*/
204 DBG_FUNC( "wl_adapter_detach" );
205 DBG_ENTER( DbgInfo );
206 DBG_PARAM( DbgInfo, "link", "0x%p", link );
208 wl_adapter_release(link);
211 unregister_wlags_sysfs(dev);
212 unregister_netdev(dev);
215 wl_device_dealloc(dev);
217 DBG_LEAVE( DbgInfo );
218 } // wl_adapter_detach
219 /*============================================================================*/
222 /*******************************************************************************
223 * wl_adapter_release()
224 *******************************************************************************
228 * After a card is removed, this routine will release the PCMCIA
229 * configuration. If the device is still open, this will be postponed until it
234 * arg - a u_long representing a pointer to a dev_link_t structure for the
235 * device to be released.
241 ******************************************************************************/
242 void wl_adapter_release( struct pcmcia_device *link )
244 DBG_FUNC( "wl_adapter_release" );
245 DBG_ENTER( DbgInfo );
246 DBG_PARAM( DbgInfo, "link", "0x%p", link);
249 wl_remove(link->priv);
251 pcmcia_disable_device(link);
253 DBG_LEAVE( DbgInfo );
254 } // wl_adapter_release
255 /*============================================================================*/
257 static int wl_adapter_suspend(struct pcmcia_device *link)
259 struct net_device *dev = link->priv;
262 netif_device_detach(dev);
264 //// CHECK! pcmcia_release_configuration(link->handle);
268 } // wl_adapter_suspend
270 static int wl_adapter_resume(struct pcmcia_device *link)
272 struct net_device *dev = link->priv;
276 netif_device_attach( dev );
279 } // wl_adapter_resume
281 /*******************************************************************************
282 * wl_adapter_insert()
283 *******************************************************************************
287 * wl_adapter_insert() is scheduled to run after a CARD_INSERTION event is
288 * received, to configure the PCMCIA socket, and to make the ethernet device
289 * available to the system.
293 * link - pointer to the dev_link_t structure representing the device to
300 ******************************************************************************/
301 void wl_adapter_insert( struct pcmcia_device *link )
303 struct net_device *dev;
305 int last_fn, last_ret;
306 /*------------------------------------------------------------------------*/
308 DBG_FUNC( "wl_adapter_insert" );
309 DBG_ENTER( DbgInfo );
310 DBG_PARAM( DbgInfo, "link", "0x%p", link );
314 /* Do we need to allocate an interrupt? */
315 link->conf.Attributes |= CONF_ENABLE_IRQ;
317 CS_CHECK(RequestIO, pcmcia_request_io(link, &link->io));
318 CS_CHECK(RequestIRQ, pcmcia_request_irq(link, wl_isr));
319 CS_CHECK(RequestConfiguration, pcmcia_request_configuration(link, &link->conf));
322 dev->irq = link->irq;
323 dev->base_addr = link->io.BasePort1;
325 SET_NETDEV_DEV(dev, &handle_to_dev(link));
326 if (register_netdev(dev) != 0) {
327 printk("%s: register_netdev() failed\n", MODULE_NAME);
330 link->dev_node = &( wl_priv(dev) )->node;
331 strcpy(( wl_priv(dev) )->node.dev_name, dev->name);
332 register_wlags_sysfs(dev);
334 printk(KERN_INFO "%s: Wireless, io_addr %#03lx, irq %d, ""mac_address ",
335 dev->name, dev->base_addr, dev->irq);
336 for( i = 0; i < ETH_ALEN; i++ ) {
337 printk("%02X%c", dev->dev_addr[i], ((i < (ETH_ALEN-1)) ? ':' : '\n'));
340 DBG_LEAVE( DbgInfo );
345 cs_error( link, last_fn, last_ret );
349 wl_adapter_release( link );
353 } // wl_adapter_insert
354 /*============================================================================*/
357 /*******************************************************************************
359 *******************************************************************************
367 * dev - a pointer to a net_device structure representing the network
373 * errno value otherwise
375 ******************************************************************************/
376 int wl_adapter_open( struct net_device *dev )
378 struct wl_private *lp = wl_priv(dev);
379 struct pcmcia_device *link = lp->link;
381 int hcf_status = HCF_SUCCESS;
382 /*------------------------------------------------------------------------*/
385 DBG_FUNC( "wl_adapter_open" );
386 DBG_ENTER( DbgInfo );
387 DBG_PRINT( "%s\n", VERSION_INFO );
388 DBG_PARAM( DbgInfo, "dev", "%s (0x%p)", dev->name, dev );
390 if(!pcmcia_dev_present(link))
392 DBG_LEAVE( DbgInfo );
398 hcf_status = wl_open( dev );
400 if( hcf_status != HCF_SUCCESS ) {
405 DBG_LEAVE( DbgInfo );
408 /*============================================================================*/
411 /*******************************************************************************
413 *******************************************************************************
421 * dev - a pointer to a net_device structure representing the network
427 * errno value otherwise
429 ******************************************************************************/
430 int wl_adapter_close( struct net_device *dev )
432 struct wl_private *lp = wl_priv(dev);
433 struct pcmcia_device *link = lp->link;
434 /*------------------------------------------------------------------------*/
437 DBG_FUNC( "wl_adapter_close" );
438 DBG_ENTER( DbgInfo );
439 DBG_PARAM( DbgInfo, "dev", "%s (0x%p)", dev->name, dev );
442 DBG_LEAVE( DbgInfo );
446 DBG_TRACE( DbgInfo, "%s: Shutting down adapter.\n", dev->name );
451 DBG_LEAVE( DbgInfo );
453 } // wl_adapter_close
454 /*============================================================================*/
456 static struct pcmcia_device_id wl_adapter_ids[] = {
457 #if ! ((HCF_TYPE) & HCF_TYPE_HII5)
458 PCMCIA_DEVICE_MANF_CARD(0x0156, 0x0003),
459 PCMCIA_DEVICE_PROD_ID12("Agere Systems", "Wireless PC Card Model 0110",
460 0x33103a9b, 0xe175b0dd),
462 PCMCIA_DEVICE_MANF_CARD(0x0156, 0x0004),
463 PCMCIA_DEVICE_PROD_ID12("Linksys", "WCF54G_Wireless-G_CompactFlash_Card",
464 0x0733cc81, 0x98a599e1),
465 #endif // (HCF_TYPE) & HCF_TYPE_HII5
468 MODULE_DEVICE_TABLE(pcmcia, wl_adapter_ids);
470 static struct pcmcia_driver wlags49_driver = {
471 .owner = THIS_MODULE,
475 .probe = wl_adapter_attach,
476 .remove = wl_adapter_detach,
477 .id_table = wl_adapter_ids,
478 .suspend = wl_adapter_suspend,
479 .resume = wl_adapter_resume,
484 /*******************************************************************************
485 * wl_adapter_init_module()
486 *******************************************************************************
490 * Called by init_module() to perform PCMCIA driver initialization.
501 ******************************************************************************/
502 int wl_adapter_init_module( void )
505 /*------------------------------------------------------------------------*/
508 DBG_FUNC( "wl_adapter_init_module" );
509 DBG_ENTER( DbgInfo );
510 DBG_TRACE( DbgInfo, "wl_adapter_init_module() -- PCMCIA\n" );
512 ret = pcmcia_register_driver(&wlags49_driver);
514 DBG_LEAVE( DbgInfo );
516 } // wl_adapter_init_module
517 /*============================================================================*/
520 /*******************************************************************************
521 * wl_adapter_cleanup_module()
522 *******************************************************************************
526 * Called by cleanup_module() to perform driver uninitialization.
536 ******************************************************************************/
537 void wl_adapter_cleanup_module( void )
539 DBG_FUNC( "wl_adapter_cleanup_module" );
540 DBG_ENTER( DbgInfo );
541 DBG_TRACE( DbgInfo, "wl_adapter_cleanup_module() -- PCMCIA\n" );
544 pcmcia_unregister_driver(&wlags49_driver);
546 DBG_LEAVE( DbgInfo );
548 } // wl_adapter_cleanup_module
549 /*============================================================================*/
552 /*******************************************************************************
553 * wl_adapter_is_open()
554 *******************************************************************************
558 * Check with Card Services to determine if this device is open.
562 * dev - a pointer to the net_device structure whose open status will be
567 * nonzero if device is open
570 ******************************************************************************/
571 int wl_adapter_is_open( struct net_device *dev )
573 struct wl_private *lp = wl_priv(dev);
574 struct pcmcia_device *link = lp->link;
576 if(!pcmcia_dev_present(link)) {
580 return( link->open );
581 } // wl_adapter_is_open
582 /*============================================================================*/
587 /*******************************************************************************
589 *******************************************************************************
593 * Converts the card serivces events to text for debugging.
597 * mask - a integer representing the error(s) being reported by Card
602 * a pointer to a string describing the error(s)
604 ******************************************************************************/
605 const char* DbgEvent( int mask )
607 static char DbgBuffer[256];
609 /*------------------------------------------------------------------------*/
616 if( mask & CS_EVENT_WRITE_PROTECT )
617 strcat( pBuf, "WRITE_PROTECT " );
619 if(mask & CS_EVENT_CARD_LOCK)
620 strcat( pBuf, "CARD_LOCK " );
622 if(mask & CS_EVENT_CARD_INSERTION)
623 strcat( pBuf, "CARD_INSERTION " );
625 if(mask & CS_EVENT_CARD_REMOVAL)
626 strcat( pBuf, "CARD_REMOVAL " );
628 if(mask & CS_EVENT_BATTERY_DEAD)
629 strcat( pBuf, "BATTERY_DEAD " );
631 if(mask & CS_EVENT_BATTERY_LOW)
632 strcat( pBuf, "BATTERY_LOW " );
634 if(mask & CS_EVENT_READY_CHANGE)
635 strcat( pBuf, "READY_CHANGE " );
637 if(mask & CS_EVENT_CARD_DETECT)
638 strcat( pBuf, "CARD_DETECT " );
640 if(mask & CS_EVENT_RESET_REQUEST)
641 strcat( pBuf, "RESET_REQUEST " );
643 if(mask & CS_EVENT_RESET_PHYSICAL)
644 strcat( pBuf, "RESET_PHYSICAL " );
646 if(mask & CS_EVENT_CARD_RESET)
647 strcat( pBuf, "CARD_RESET " );
649 if(mask & CS_EVENT_REGISTRATION_COMPLETE)
650 strcat( pBuf, "REGISTRATION_COMPLETE " );
652 // if(mask & CS_EVENT_RESET_COMPLETE)
653 // strcat( pBuf, "RESET_COMPLETE " );
655 if(mask & CS_EVENT_PM_SUSPEND)
656 strcat( pBuf, "PM_SUSPEND " );
658 if(mask & CS_EVENT_PM_RESUME)
659 strcat( pBuf, "PM_RESUME " );
661 if(mask & CS_EVENT_INSERTION_REQUEST)
662 strcat( pBuf, "INSERTION_REQUEST " );
664 if(mask & CS_EVENT_EJECTION_REQUEST)
665 strcat( pBuf, "EJECTION_REQUEST " );
667 if(mask & CS_EVENT_MTD_REQUEST)
668 strcat( pBuf, "MTD_REQUEST " );
670 if(mask & CS_EVENT_ERASE_COMPLETE)
671 strcat( pBuf, "ERASE_COMPLETE " );
673 if(mask & CS_EVENT_REQUEST_ATTENTION)
674 strcat( pBuf, "REQUEST_ATTENTION " );
676 if(mask & CS_EVENT_CB_DETECT)
677 strcat( pBuf, "CB_DETECT " );
679 if(mask & CS_EVENT_3VCARD)
680 strcat( pBuf, "3VCARD " );
682 if(mask & CS_EVENT_XVCARD)
683 strcat( pBuf, "XVCARD " );
687 pBuf[strlen(pBuf) - 1] = '\0';
690 sprintf( pBuf, "<<0x%08x>>", mask );
696 /*============================================================================*/