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 (c) 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 #include <linux/module.h>
86 
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  ******************************************************************************/
wl_adapter_attach(struct pcmcia_device * link)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->resource[0]->end  = HCF_NUM_IO_PORTS;
149 	link->resource[0]->flags= IO_DATA_PATH_WIDTH_16;
150 	link->config_flags     |= CONF_ENABLE_IRQ;
151 	link->config_index      = 5;
152 	link->config_regs       = PRESENT_OPTION;
153 
154 	link->priv = dev;
155 	lp = wl_priv(dev);
156 	lp->link = link;
157 
158 	wl_adapter_insert(link);
159 
160 	DBG_LEAVE(DbgInfo);
161 	return 0;
162 } /* wl_adapter_attach */
163 /*============================================================================*/
164 
165 
166 
wl_adapter_detach(struct pcmcia_device * link)167 static void wl_adapter_detach(struct pcmcia_device *link)
168 {
169 	struct net_device   *dev = link->priv;
170 	/*--------------------------------------------------------------------*/
171 
172 	DBG_FUNC("wl_adapter_detach");
173 	DBG_ENTER(DbgInfo);
174 	DBG_PARAM(DbgInfo, "link", "0x%p", link);
175 
176 	wl_adapter_release(link);
177 
178 	if (dev) {
179 		unregister_wlags_sysfs(dev);
180 		unregister_netdev(dev);
181 	}
182 
183 	wl_device_dealloc(dev);
184 
185 	DBG_LEAVE(DbgInfo);
186 } /* wl_adapter_detach */
187 /*============================================================================*/
188 
189 
wl_adapter_release(struct pcmcia_device * link)190 void wl_adapter_release(struct pcmcia_device *link)
191 {
192 	DBG_FUNC("wl_adapter_release");
193 	DBG_ENTER(DbgInfo);
194 	DBG_PARAM(DbgInfo, "link", "0x%p", link);
195 
196 	/* Stop hardware */
197 	wl_remove(link->priv);
198 
199 	pcmcia_disable_device(link);
200 
201 	DBG_LEAVE(DbgInfo);
202 } /* wl_adapter_release */
203 /*============================================================================*/
204 
wl_adapter_suspend(struct pcmcia_device * link)205 static int wl_adapter_suspend(struct pcmcia_device *link)
206 {
207 	struct net_device *dev = link->priv;
208 
209 	/* if (link->open) { */
210 	netif_device_detach(dev);
211 	wl_suspend(dev);
212 	/* CHECK! pcmcia_release_configuration(link->handle); */
213 	/* } */
214 
215 	return 0;
216 } /* wl_adapter_suspend */
217 
wl_adapter_resume(struct pcmcia_device * link)218 static int wl_adapter_resume(struct pcmcia_device *link)
219 {
220 	struct net_device *dev = link->priv;
221 
222 	wl_resume(dev);
223 
224 	netif_device_attach(dev);
225 
226 	return 0;
227 } /* wl_adapter_resume */
228 
wl_adapter_insert(struct pcmcia_device * link)229 void wl_adapter_insert(struct pcmcia_device *link)
230 {
231 	struct net_device *dev;
232 	int i;
233 	int ret;
234 	/*--------------------------------------------------------------------*/
235 
236 	DBG_FUNC("wl_adapter_insert");
237 	DBG_ENTER(DbgInfo);
238 	DBG_PARAM(DbgInfo, "link", "0x%p", link);
239 
240 	dev     = link->priv;
241 
242 	/* Do we need to allocate an interrupt? */
243 	link->config_flags |= CONF_ENABLE_IRQ;
244 	link->io_lines = 6;
245 
246 	ret = pcmcia_request_io(link);
247 	if (ret != 0)
248 		goto failed;
249 
250 	ret = pcmcia_request_irq(link, (void *) wl_isr);
251 	if (ret != 0)
252 		goto failed;
253 
254 	ret = pcmcia_enable_device(link);
255 	if (ret != 0)
256 		goto failed;
257 
258 	dev->irq        = link->irq;
259 	dev->base_addr  = link->resource[0]->start;
260 
261 	SET_NETDEV_DEV(dev, &link->dev);
262 	if (register_netdev(dev) != 0) {
263 		printk("%s: register_netdev() failed\n", MODULE_NAME);
264 		goto failed;
265 	}
266 
267 	register_wlags_sysfs(dev);
268 
269 	printk(KERN_INFO "%s: Wireless, io_addr %#03lx, irq %d, ""mac_address ",
270 		dev->name, dev->base_addr, dev->irq);
271 	for (i = 0; i < ETH_ALEN; i++)
272 		printk("%02X%c", dev->dev_addr[i], ((i < (ETH_ALEN-1)) ? ':' : '\n'));
273 
274 	DBG_LEAVE(DbgInfo);
275 	return;
276 
277 failed:
278 	wl_adapter_release(link);
279 
280 	DBG_LEAVE(DbgInfo);
281 	return;
282 } /* wl_adapter_insert */
283 /*============================================================================*/
284 
285 
286 /*******************************************************************************
287  *	wl_adapter_open()
288  *******************************************************************************
289  *
290  *  DESCRIPTION:
291  *
292  *      Open the device.
293  *
294  *  PARAMETERS:
295  *
296  *      dev - a pointer to a net_device structure representing the network
297  *            device to open.
298  *
299  *  RETURNS:
300  *
301  *      0 on success
302  *      errno value otherwise
303  *
304  ******************************************************************************/
wl_adapter_open(struct net_device * dev)305 int wl_adapter_open(struct net_device *dev)
306 {
307 	struct wl_private *lp = wl_priv(dev);
308 	struct pcmcia_device *link = lp->link;
309 	int result = 0;
310 	int hcf_status = HCF_SUCCESS;
311 	/*--------------------------------------------------------------------*/
312 
313 	DBG_FUNC("wl_adapter_open");
314 	DBG_ENTER(DbgInfo);
315 	DBG_PRINT("%s\n", VERSION_INFO);
316 	DBG_PARAM(DbgInfo, "dev", "%s (0x%p)", dev->name, dev);
317 
318 	if (!pcmcia_dev_present(link)) {
319 		DBG_LEAVE(DbgInfo);
320 		return -ENODEV;
321 	}
322 
323 	link->open++;
324 
325 	hcf_status = wl_open(dev);
326 
327 	if (hcf_status != HCF_SUCCESS) {
328 		link->open--;
329 		result = -ENODEV;
330 	}
331 
332 	DBG_LEAVE(DbgInfo);
333 	return result;
334 } /* wl_adapter_open */
335 /*============================================================================*/
336 
337 
338 /*******************************************************************************
339  *	wl_adapter_close()
340  *******************************************************************************
341  *
342  *  DESCRIPTION:
343  *
344  *      Close the device.
345  *
346  *  PARAMETERS:
347  *
348  *      dev - a pointer to a net_device structure representing the network
349  *            device to close.
350  *
351  *  RETURNS:
352  *
353  *      0 on success
354  *      errno value otherwise
355  *
356  ******************************************************************************/
wl_adapter_close(struct net_device * dev)357 int wl_adapter_close(struct net_device *dev)
358 {
359 	struct wl_private *lp = wl_priv(dev);
360 	struct pcmcia_device *link = lp->link;
361 	/*--------------------------------------------------------------------*/
362 
363 	DBG_FUNC("wl_adapter_close");
364 	DBG_ENTER(DbgInfo);
365 	DBG_PARAM(DbgInfo, "dev", "%s (0x%p)", dev->name, dev);
366 
367 	if (link == NULL) {
368 		DBG_LEAVE(DbgInfo);
369 		return -ENODEV;
370 	}
371 
372 	DBG_TRACE(DbgInfo, "%s: Shutting down adapter.\n", dev->name);
373 	wl_close(dev);
374 
375 	link->open--;
376 
377 	DBG_LEAVE(DbgInfo);
378 	return 0;
379 } /* wl_adapter_close */
380 /*============================================================================*/
381 
382 static const struct pcmcia_device_id wl_adapter_ids[] = {
383 #if !((HCF_TYPE) & HCF_TYPE_HII5)
384 	PCMCIA_DEVICE_MANF_CARD(0x0156, 0x0003),
385 	PCMCIA_DEVICE_PROD_ID12("Agere Systems", "Wireless PC Card Model 0110",
386 				0x33103a9b, 0xe175b0dd),
387 #else
388 	PCMCIA_DEVICE_MANF_CARD(0x0156, 0x0004),
389 	PCMCIA_DEVICE_PROD_ID12("Linksys", "WCF54G_Wireless-G_CompactFlash_Card",
390 				0x0733cc81, 0x98a599e1),
391 #endif  /* (HCF_TYPE) & HCF_TYPE_HII5 */
392 	PCMCIA_DEVICE_NULL,
393 };
394 MODULE_DEVICE_TABLE(pcmcia, wl_adapter_ids);
395 
396 static struct pcmcia_driver wlags49_driver = {
397 	.owner	    = THIS_MODULE,
398 	.name	    = DRIVER_NAME,
399 	.probe	    = wl_adapter_attach,
400 	.remove	    = wl_adapter_detach,
401 	.id_table   = wl_adapter_ids,
402 	.suspend    = wl_adapter_suspend,
403 	.resume	    = wl_adapter_resume,
404 };
405 
406 
407 
408 /*******************************************************************************
409  *	wl_adapter_init_module()
410  *******************************************************************************
411  *
412  *  DESCRIPTION:
413  *
414  *      Called by init_module() to perform PCMCIA driver initialization.
415  *
416  *  PARAMETERS:
417  *
418  *      N/A
419  *
420  *  RETURNS:
421  *
422  *      0 on success
423  *      -1 on error
424  *
425  ******************************************************************************/
wl_adapter_init_module(void)426 int wl_adapter_init_module(void)
427 {
428 	int ret;
429 	/*--------------------------------------------------------------------*/
430 
431 	DBG_FUNC("wl_adapter_init_module");
432 	DBG_ENTER(DbgInfo);
433 	DBG_TRACE(DbgInfo, "wl_adapter_init_module() -- PCMCIA\n");
434 
435 	ret = pcmcia_register_driver(&wlags49_driver);
436 
437 	DBG_LEAVE(DbgInfo);
438 	return ret;
439 } /* wl_adapter_init_module */
440 /*============================================================================*/
441 
442 
443 /*******************************************************************************
444  *	wl_adapter_cleanup_module()
445  *******************************************************************************
446  *
447  *  DESCRIPTION:
448  *
449  *      Called by cleanup_module() to perform driver uninitialization.
450  *
451  *  PARAMETERS:
452  *
453  *      N/A
454  *
455  *  RETURNS:
456  *
457  *      N/A
458  *
459  ******************************************************************************/
wl_adapter_cleanup_module(void)460 void wl_adapter_cleanup_module(void)
461 {
462 	DBG_FUNC("wl_adapter_cleanup_module");
463 	DBG_ENTER(DbgInfo);
464 	DBG_TRACE(DbgInfo, "wl_adapter_cleanup_module() -- PCMCIA\n");
465 
466 
467 	pcmcia_unregister_driver(&wlags49_driver);
468 
469 	DBG_LEAVE(DbgInfo);
470 	return;
471 } /* wl_adapter_cleanup_module */
472 /*============================================================================*/
473 
474 
475 /*******************************************************************************
476  *	wl_adapter_is_open()
477  *******************************************************************************
478  *
479  *  DESCRIPTION:
480  *
481  *      Check with Card Services to determine if this device is open.
482  *
483  *  PARAMETERS:
484  *
485  *      dev - a pointer to the net_device structure whose open status will be
486  *            checked
487  *
488  *  RETURNS:
489  *
490  *      nonzero if device is open
491  *      0 otherwise
492  *
493  ******************************************************************************/
wl_adapter_is_open(struct net_device * dev)494 int wl_adapter_is_open(struct net_device *dev)
495 {
496 	struct wl_private *lp = wl_priv(dev);
497 	struct pcmcia_device *link = lp->link;
498 
499 	if (!pcmcia_dev_present(link))
500 		return 0;
501 
502 	return link->open;
503 } /* wl_adapter_is_open */
504 /*============================================================================*/
505