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
->irq
.Attributes
= IRQ_TYPE_DYNAMIC_SHARING
| IRQ_HANDLE_PRESENT
;
160 link
->irq
.IRQInfo1
= IRQ_INFO2_VALID
| IRQ_LEVEL_ID
;
161 link
->irq
.Handler
= &wl_isr
;
162 link
->conf
.Attributes
= CONF_ENABLE_IRQ
;
163 link
->conf
.IntType
= INT_MEMORY_AND_IO
;
164 link
->conf
.ConfigIndex
= 5;
165 link
->conf
.Present
= PRESENT_OPTION
;
167 link
->priv
= link
->irq
.Instance
= dev
;
171 wl_adapter_insert(link
);
173 DBG_LEAVE( DbgInfo
);
175 } // wl_adapter_attach
176 /*============================================================================*/
180 /*******************************************************************************
181 * wl_adapter_detach()
182 *******************************************************************************
186 * This deletes a driver "instance". The device is de-registered with Card
187 * Services. If it has been released, then the net device is unregistered, and
188 * all local data structures are freed. Otherwise, the structures will be
189 * freed when the device is released.
193 * link - pointer to the dev_link_t structure representing the device to
200 ******************************************************************************/
201 static void wl_adapter_detach(struct pcmcia_device
*link
)
203 struct net_device
*dev
= link
->priv
;
204 /*------------------------------------------------------------------------*/
207 DBG_FUNC( "wl_adapter_detach" );
208 DBG_ENTER( DbgInfo
);
209 DBG_PARAM( DbgInfo
, "link", "0x%p", link
);
211 wl_adapter_release(link
);
214 unregister_wlags_sysfs(dev
);
215 unregister_netdev(dev
);
218 wl_device_dealloc(dev
);
220 DBG_LEAVE( DbgInfo
);
221 } // wl_adapter_detach
222 /*============================================================================*/
225 /*******************************************************************************
226 * wl_adapter_release()
227 *******************************************************************************
231 * After a card is removed, this routine will release the PCMCIA
232 * configuration. If the device is still open, this will be postponed until it
237 * arg - a u_long representing a pointer to a dev_link_t structure for the
238 * device to be released.
244 ******************************************************************************/
245 void wl_adapter_release( struct pcmcia_device
*link
)
247 DBG_FUNC( "wl_adapter_release" );
248 DBG_ENTER( DbgInfo
);
249 DBG_PARAM( DbgInfo
, "link", "0x%p", link
);
252 wl_remove(link
->priv
);
254 pcmcia_disable_device(link
);
256 DBG_LEAVE( DbgInfo
);
257 } // wl_adapter_release
258 /*============================================================================*/
260 static int wl_adapter_suspend(struct pcmcia_device
*link
)
262 struct net_device
*dev
= link
->priv
;
265 netif_device_detach(dev
);
267 //// CHECK! pcmcia_release_configuration(link->handle);
271 } // wl_adapter_suspend
273 static int wl_adapter_resume(struct pcmcia_device
*link
)
275 struct net_device
*dev
= link
->priv
;
279 netif_device_attach( dev
);
282 } // wl_adapter_resume
284 /*******************************************************************************
285 * wl_adapter_insert()
286 *******************************************************************************
290 * wl_adapter_insert() is scheduled to run after a CARD_INSERTION event is
291 * received, to configure the PCMCIA socket, and to make the ethernet device
292 * available to the system.
296 * link - pointer to the dev_link_t structure representing the device to
303 ******************************************************************************/
304 void wl_adapter_insert( struct pcmcia_device
*link
)
306 struct net_device
*dev
;
308 int last_fn
, last_ret
;
309 /*------------------------------------------------------------------------*/
311 DBG_FUNC( "wl_adapter_insert" );
312 DBG_ENTER( DbgInfo
);
313 DBG_PARAM( DbgInfo
, "link", "0x%p", link
);
317 /* Do we need to allocate an interrupt? */
318 link
->conf
.Attributes
|= CONF_ENABLE_IRQ
;
320 CS_CHECK(RequestIO
, pcmcia_request_io(link
, &link
->io
));
321 CS_CHECK(RequestIRQ
, pcmcia_request_irq(link
, &link
->irq
));
322 CS_CHECK(RequestConfiguration
, pcmcia_request_configuration(link
, &link
->conf
));
325 dev
->irq
= link
->irq
.AssignedIRQ
;
326 dev
->base_addr
= link
->io
.BasePort1
;
328 SET_NETDEV_DEV(dev
, &handle_to_dev(link
));
329 if (register_netdev(dev
) != 0) {
330 printk("%s: register_netdev() failed\n", MODULE_NAME
);
333 link
->dev_node
= &( wl_priv(dev
) )->node
;
334 strcpy(( wl_priv(dev
) )->node
.dev_name
, dev
->name
);
335 register_wlags_sysfs(dev
);
337 printk(KERN_INFO
"%s: Wireless, io_addr %#03lx, irq %d, ""mac_address ",
338 dev
->name
, dev
->base_addr
, dev
->irq
);
339 for( i
= 0; i
< ETH_ALEN
; i
++ ) {
340 printk("%02X%c", dev
->dev_addr
[i
], ((i
< (ETH_ALEN
-1)) ? ':' : '\n'));
343 DBG_LEAVE( DbgInfo
);
348 cs_error( link
, last_fn
, last_ret
);
352 wl_adapter_release( link
);
356 } // wl_adapter_insert
357 /*============================================================================*/
360 /*******************************************************************************
362 *******************************************************************************
370 * dev - a pointer to a net_device structure representing the network
376 * errno value otherwise
378 ******************************************************************************/
379 int wl_adapter_open( struct net_device
*dev
)
381 struct wl_private
*lp
= wl_priv(dev
);
382 struct pcmcia_device
*link
= lp
->link
;
384 int hcf_status
= HCF_SUCCESS
;
385 /*------------------------------------------------------------------------*/
388 DBG_FUNC( "wl_adapter_open" );
389 DBG_ENTER( DbgInfo
);
390 DBG_PRINT( "%s\n", VERSION_INFO
);
391 DBG_PARAM( DbgInfo
, "dev", "%s (0x%p)", dev
->name
, dev
);
393 if(!pcmcia_dev_present(link
))
395 DBG_LEAVE( DbgInfo
);
401 hcf_status
= wl_open( dev
);
403 if( hcf_status
!= HCF_SUCCESS
) {
408 DBG_LEAVE( DbgInfo
);
411 /*============================================================================*/
414 /*******************************************************************************
416 *******************************************************************************
424 * dev - a pointer to a net_device structure representing the network
430 * errno value otherwise
432 ******************************************************************************/
433 int wl_adapter_close( struct net_device
*dev
)
435 struct wl_private
*lp
= wl_priv(dev
);
436 struct pcmcia_device
*link
= lp
->link
;
437 /*------------------------------------------------------------------------*/
440 DBG_FUNC( "wl_adapter_close" );
441 DBG_ENTER( DbgInfo
);
442 DBG_PARAM( DbgInfo
, "dev", "%s (0x%p)", dev
->name
, dev
);
445 DBG_LEAVE( DbgInfo
);
449 DBG_TRACE( DbgInfo
, "%s: Shutting down adapter.\n", dev
->name
);
454 DBG_LEAVE( DbgInfo
);
456 } // wl_adapter_close
457 /*============================================================================*/
459 static struct pcmcia_device_id wl_adapter_ids
[] = {
460 #if ! ((HCF_TYPE) & HCF_TYPE_HII5)
461 PCMCIA_DEVICE_MANF_CARD(0x0156, 0x0003),
462 PCMCIA_DEVICE_PROD_ID12("Agere Systems", "Wireless PC Card Model 0110",
463 0x33103a9b, 0xe175b0dd),
465 PCMCIA_DEVICE_MANF_CARD(0x0156, 0x0004),
466 PCMCIA_DEVICE_PROD_ID12("Linksys", "WCF54G_Wireless-G_CompactFlash_Card",
467 0x0733cc81, 0x98a599e1),
468 #endif // (HCF_TYPE) & HCF_TYPE_HII5
471 MODULE_DEVICE_TABLE(pcmcia
, wl_adapter_ids
);
473 static struct pcmcia_driver wlags49_driver
= {
474 .owner
= THIS_MODULE
,
478 .probe
= wl_adapter_attach
,
479 .remove
= wl_adapter_detach
,
480 .id_table
= wl_adapter_ids
,
481 .suspend
= wl_adapter_suspend
,
482 .resume
= wl_adapter_resume
,
487 /*******************************************************************************
488 * wl_adapter_init_module()
489 *******************************************************************************
493 * Called by init_module() to perform PCMCIA driver initialization.
504 ******************************************************************************/
505 int wl_adapter_init_module( void )
508 /*------------------------------------------------------------------------*/
511 DBG_FUNC( "wl_adapter_init_module" );
512 DBG_ENTER( DbgInfo
);
513 DBG_TRACE( DbgInfo
, "wl_adapter_init_module() -- PCMCIA\n" );
515 ret
= pcmcia_register_driver(&wlags49_driver
);
517 DBG_LEAVE( DbgInfo
);
519 } // wl_adapter_init_module
520 /*============================================================================*/
523 /*******************************************************************************
524 * wl_adapter_cleanup_module()
525 *******************************************************************************
529 * Called by cleanup_module() to perform driver uninitialization.
539 ******************************************************************************/
540 void wl_adapter_cleanup_module( void )
542 DBG_FUNC( "wl_adapter_cleanup_module" );
543 DBG_ENTER( DbgInfo
);
544 DBG_TRACE( DbgInfo
, "wl_adapter_cleanup_module() -- PCMCIA\n" );
547 pcmcia_unregister_driver(&wlags49_driver
);
549 DBG_LEAVE( DbgInfo
);
551 } // wl_adapter_cleanup_module
552 /*============================================================================*/
555 /*******************************************************************************
556 * wl_adapter_is_open()
557 *******************************************************************************
561 * Check with Card Services to determine if this device is open.
565 * dev - a pointer to the net_device structure whose open status will be
570 * nonzero if device is open
573 ******************************************************************************/
574 int wl_adapter_is_open( struct net_device
*dev
)
576 struct wl_private
*lp
= wl_priv(dev
);
577 struct pcmcia_device
*link
= lp
->link
;
579 if(!pcmcia_dev_present(link
)) {
583 return( link
->open
);
584 } // wl_adapter_is_open
585 /*============================================================================*/
590 /*******************************************************************************
592 *******************************************************************************
596 * Converts the card serivces events to text for debugging.
600 * mask - a integer representing the error(s) being reported by Card
605 * a pointer to a string describing the error(s)
607 ******************************************************************************/
608 const char* DbgEvent( int mask
)
610 static char DbgBuffer
[256];
612 /*------------------------------------------------------------------------*/
619 if( mask
& CS_EVENT_WRITE_PROTECT
)
620 strcat( pBuf
, "WRITE_PROTECT " );
622 if(mask
& CS_EVENT_CARD_LOCK
)
623 strcat( pBuf
, "CARD_LOCK " );
625 if(mask
& CS_EVENT_CARD_INSERTION
)
626 strcat( pBuf
, "CARD_INSERTION " );
628 if(mask
& CS_EVENT_CARD_REMOVAL
)
629 strcat( pBuf
, "CARD_REMOVAL " );
631 if(mask
& CS_EVENT_BATTERY_DEAD
)
632 strcat( pBuf
, "BATTERY_DEAD " );
634 if(mask
& CS_EVENT_BATTERY_LOW
)
635 strcat( pBuf
, "BATTERY_LOW " );
637 if(mask
& CS_EVENT_READY_CHANGE
)
638 strcat( pBuf
, "READY_CHANGE " );
640 if(mask
& CS_EVENT_CARD_DETECT
)
641 strcat( pBuf
, "CARD_DETECT " );
643 if(mask
& CS_EVENT_RESET_REQUEST
)
644 strcat( pBuf
, "RESET_REQUEST " );
646 if(mask
& CS_EVENT_RESET_PHYSICAL
)
647 strcat( pBuf
, "RESET_PHYSICAL " );
649 if(mask
& CS_EVENT_CARD_RESET
)
650 strcat( pBuf
, "CARD_RESET " );
652 if(mask
& CS_EVENT_REGISTRATION_COMPLETE
)
653 strcat( pBuf
, "REGISTRATION_COMPLETE " );
655 // if(mask & CS_EVENT_RESET_COMPLETE)
656 // strcat( pBuf, "RESET_COMPLETE " );
658 if(mask
& CS_EVENT_PM_SUSPEND
)
659 strcat( pBuf
, "PM_SUSPEND " );
661 if(mask
& CS_EVENT_PM_RESUME
)
662 strcat( pBuf
, "PM_RESUME " );
664 if(mask
& CS_EVENT_INSERTION_REQUEST
)
665 strcat( pBuf
, "INSERTION_REQUEST " );
667 if(mask
& CS_EVENT_EJECTION_REQUEST
)
668 strcat( pBuf
, "EJECTION_REQUEST " );
670 if(mask
& CS_EVENT_MTD_REQUEST
)
671 strcat( pBuf
, "MTD_REQUEST " );
673 if(mask
& CS_EVENT_ERASE_COMPLETE
)
674 strcat( pBuf
, "ERASE_COMPLETE " );
676 if(mask
& CS_EVENT_REQUEST_ATTENTION
)
677 strcat( pBuf
, "REQUEST_ATTENTION " );
679 if(mask
& CS_EVENT_CB_DETECT
)
680 strcat( pBuf
, "CB_DETECT " );
682 if(mask
& CS_EVENT_3VCARD
)
683 strcat( pBuf
, "3VCARD " );
685 if(mask
& CS_EVENT_XVCARD
)
686 strcat( pBuf
, "XVCARD " );
690 pBuf
[strlen(pBuf
) - 1] = '\0';
693 sprintf( pBuf
, "<<0x%08x>>", mask
);
699 /*============================================================================*/