1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
|
/*
* WaveLAN ISA driver
*
* Jean II - HPLB '96
*
* Reorganisation and extension of the driver.
*
* This file contains all definitions and declarations necessary for the
* WaveLAN ISA driver. This file is a private header, so it should
* be included only in wavelan.c!
*/
#ifndef WAVELAN_P_H
#define WAVELAN_P_H
/************************** DOCUMENTATION ***************************/
/*
* This driver provides a Linux interface to the WaveLAN ISA hardware.
* The WaveLAN is a product of Lucent (http://www.wavelan.com/).
* This division was formerly part of NCR and then AT&T.
* WaveLANs are also distributed by DEC (RoamAbout DS) and Digital Ocean.
*
* To learn how to use this driver, read the NET3 HOWTO.
* If you want to exploit the many other functionalities, read the comments
* in the code.
*
* This driver is the result of the effort of many people (see below).
*/
/* ------------------------ SPECIFIC NOTES ------------------------ */
/*
* Web page
* --------
* I try to maintain a web page with the Wireless LAN Howto at :
* http://www.hpl.hp.com/personal/Jean_Tourrilhes/Linux/Wavelan.html
*
* SMP
* ---
* We now are SMP compliant (I eventually fixed the remaining bugs).
* The driver has been tested on a dual P6-150 and survived my usual
* set of torture tests.
* Anyway, I spent enough time chasing interrupt re-entrancy during
* errors or reconfigure, and I designed the locked/unlocked sections
* of the driver with great care, and with the recent addition of
* the spinlock (thanks to the new API), we should be quite close to
* the truth.
* The SMP/IRQ locking is quite coarse and conservative (i.e. not fast),
* but better safe than sorry (especially at 2 Mb/s ;-).
*
* I have also looked into disabling only our interrupt on the card
* (via HACR) instead of all interrupts in the processor (via cli),
* so that other driver are not impacted, and it look like it's
* possible, but it's very tricky to do right (full of races). As
* the gain would be mostly for SMP systems, it can wait...
*
* Debugging and options
* ---------------------
* You will find below a set of '#define" allowing a very fine control
* on the driver behaviour and the debug messages printed.
* The main options are :
* o SET_PSA_CRC, to have your card correctly recognised by
* an access point and the Point-to-Point diagnostic tool.
* o USE_PSA_CONFIG, to read configuration from the PSA (EEprom)
* (otherwise we always start afresh with some defaults)
*
* wavelan.o is too darned big
* ---------------------------
* That's true! There is a very simple way to reduce the driver
* object by 33%! Comment out the following line:
* #include <linux/wireless.h>
* Other compile options can also reduce the size of it...
*
* MAC address and hardware detection:
* -----------------------------------
* The detection code for the WaveLAN checks that the first three
* octets of the MAC address fit the company code. This type of
* detection works well for AT&T cards (because the AT&T code is
* hardcoded in wavelan.h), but of course will fail for other
* manufacturers.
*
* If you are sure that your card is derived from the WaveLAN,
* here is the way to configure it:
* 1) Get your MAC address
* a) With your card utilities (wfreqsel, instconf, etc.)
* b) With the driver:
* o compile the kernel with DEBUG_CONFIG_INFO enabled
* o Boot and look the card messages
* 2) Set your MAC code (3 octets) in MAC_ADDRESSES[][3] (wavelan.h)
* 3) Compile and verify
* 4) Send me the MAC code. I will include it in the next version.
*
*/
/* --------------------- WIRELESS EXTENSIONS --------------------- */
/*
* This driver is the first to support "wireless extensions".
* This set of extensions provides a standard way to control the wireless
* characteristics of the hardware. Applications such as mobile IP may
* take advantage of it.
*
* It might be a good idea as well to fetch the wireless tools to
* configure the device and play a bit.
*/
/* ---------------------------- FILES ---------------------------- */
/*
* wavelan.c: actual code for the driver: C functions
*
* wavelan.p.h: private header: local types and variables for driver
*
* wavelan.h: description of the hardware interface and structs
*
* i82586.h: description of the Ethernet controller
*/
/* --------------------------- HISTORY --------------------------- */
/*
* This is based on information in the drivers' headers. It may not be
* accurate, and I guarantee only my best effort.
*
* The history of the WaveLAN drivers is as complicated as the history of
* the WaveLAN itself (NCR -> AT&T -> Lucent).
*
* It all started with Anders Klemets <klemets@paul.rutgers.edu>
* writing a WaveLAN ISA driver for the Mach microkernel. Girish
* Welling <welling@paul.rutgers.edu> had also worked on it.
* Keith Moore modified this for the PCMCIA hardware.
*
* Robert Morris <rtm@das.harvard.edu> ported these two drivers to BSDI
* and added specific PCMCIA support (there is currently no equivalent
* of the PCMCIA package under BSD).
*
* Jim Binkley <jrb@cs.pdx.edu> ported both BSDI drivers to FreeBSD.
*
* Bruce Janson <bruce@cs.usyd.edu.au> ported the BSDI ISA driver to Linux.
*
* Anthony D. Joseph <adj@lcs.mit.edu> started to modify Bruce's driver
* (with help of the BSDI PCMCIA driver) for PCMCIA.
* Yunzhou Li <yunzhou@strat.iol.unh.edu> finished this work.
* Joe Finney <joe@comp.lancs.ac.uk> patched the driver to start
* 2.00 cards correctly (2.4 GHz with frequency selection).
* David Hinds <dahinds@users.sourceforge.net> integrated the whole in his
* PCMCIA package (and bug corrections).
*
* I (Jean Tourrilhes - jt@hplb.hpl.hp.com) then started to make some
* patches to the PCMCIA driver. Later, I added code in the ISA driver
* for Wireless Extensions and full support of frequency selection
* cards. Then, I did the same to the PCMCIA driver, and did some
* reorganisation. Finally, I came back to the ISA driver to
* upgrade it at the same level as the PCMCIA one and reorganise
* the code.
* Loeke Brederveld <lbrederv@wavelan.com> from Lucent has given me
* much needed information on the WaveLAN hardware.
*/
/* The original copyrights and literature mention others' names and
* credits. I don't know what their part in this development was.
*/
/* By the way, for the copyright and legal stuff:
* almost everybody wrote code under the GNU or BSD license (or similar),
* and want their original copyright to remain somewhere in the
* code (for myself, I go with the GPL).
* Nobody wants to take responsibility for anything, except the fame.
*/
/* --------------------------- CREDITS --------------------------- */
/*
* This software was developed as a component of the
* Linux operating system.
* It is based on other device drivers and information
* either written or supplied by:
* Ajay Bakre <bakre@paul.rutgers.edu>,
* Donald Becker <becker@cesdis.gsfc.nasa.gov>,
* Loeke Brederveld <Loeke.Brederveld@Utrecht.NCR.com>,
* Brent Elphick <belphick@uwaterloo.ca>,
* Anders Klemets <klemets@it.kth.se>,
* Vladimir V. Kolpakov <w@stier.koenig.ru>,
* Marc Meertens <Marc.Meertens@Utrecht.NCR.com>,
* Pauline Middelink <middelin@polyware.iaf.nl>,
* Robert Morris <rtm@das.harvard.edu>,
* Jean Tourrilhes <jt@hpl.hp.com>,
* Girish Welling <welling@paul.rutgers.edu>,
* Clark Woodworth <clark@hiway1.exit109.com>
* Yongguang Zhang <ygz@isl.hrl.hac.com>
*
* Thanks go also to:
* James Ashton <jaa101@syseng.anu.edu.au>,
* Alan Cox <alan@lxorguk.ukuu.org.uk>,
* Allan Creighton <allanc@cs.usyd.edu.au>,
* Matthew Geier <matthew@cs.usyd.edu.au>,
* Remo di Giovanni <remo@cs.usyd.edu.au>,
* Eckhard Grah <grah@wrcs1.urz.uni-wuppertal.de>,
* Vipul Gupta <vgupta@cs.binghamton.edu>,
* Mark Hagan <mhagan@wtcpost.daytonoh.NCR.COM>,
* Tim Nicholson <tim@cs.usyd.edu.au>,
* Ian Parkin <ian@cs.usyd.edu.au>,
* John Rosenberg <johnr@cs.usyd.edu.au>,
* George Rossi <george@phm.gov.au>,
* Arthur Scott <arthur@cs.usyd.edu.au>,
* Stanislav Sinyagin <stas@isf.ru>
* and Peter Storey for their assistance and advice.
*
* Additional Credits:
*
* My development has been done initially under Debian 1.1 (Linux 2.0.x)
* and now under Debian 2.2, initially with an HP Vectra XP/60, and now
* an HP Vectra XP/90.
*
*/
/* ------------------------- IMPROVEMENTS ------------------------- */
/*
* I proudly present:
*
* Changes made in first pre-release:
* ----------------------------------
* - reorganisation of the code, function name change
* - creation of private header (wavelan.p.h)
* - reorganised debug messages
* - more comments, history, etc.
* - mmc_init: configure the PSA if not done
* - mmc_init: correct default value of level threshold for PCMCIA
* - mmc_init: 2.00 detection better code for 2.00 initialization
* - better info at startup
* - IRQ setting (note: this setting is permanent)
* - watchdog: change strategy (and solve module removal problems)
* - add wireless extensions (ioctl and get_wireless_stats)
* get/set nwid/frequency on fly, info for /proc/net/wireless
* - more wireless extensions: SETSPY and GETSPY
* - make wireless extensions optional
* - private ioctl to set/get quality and level threshold, histogram
* - remove /proc/net/wavelan
* - suppress useless stuff from lp (net_local)
* - kernel 2.1 support (copy_to/from_user instead of memcpy_to/fromfs)
* - add message level (debug stuff in /var/adm/debug and errors not
* displayed at console and still in /var/adm/messages)
* - multi device support
* - start fixing the probe (init code)
* - more inlines
* - man page
* - many other minor details and cleanups
*
* Changes made in second pre-release:
* -----------------------------------
* - clean up init code (probe and module init)
* - better multiple device support (module)
* - name assignment (module)
*
* Changes made in third pre-release:
* ----------------------------------
* - be more conservative on timers
* - preliminary support for multicast (I still lack some details)
*
* Changes made in fourth pre-release:
* -----------------------------------
* - multicast (revisited and finished)
* - avoid reset in set_multicast_list (a really big hack)
* if somebody could apply this code for other i82586 based drivers
* - share onboard memory 75% RU and 25% CU (instead of 50/50)
*
* Changes made for release in 2.1.15:
* -----------------------------------
* - change the detection code for multi manufacturer code support
*
* Changes made for release in 2.1.17:
* -----------------------------------
* - update to wireless extensions changes
* - silly bug in card initial configuration (psa_conf_status)
*
* Changes made for release in 2.1.27 & 2.0.30:
* --------------------------------------------
* - small bug in debug code (probably not the last one...)
* - remove extern keyword for wavelan_probe()
* - level threshold is now a standard wireless extension (version 4 !)
* - modules parameters types (new module interface)
*
* Changes made for release in 2.1.36:
* -----------------------------------
* - byte count stats (courtesy of David Hinds)
* - remove dev_tint stuff (courtesy of David Hinds)
* - encryption setting from Brent Elphick (thanks a lot!)
* - 'ioaddr' to 'u_long' for the Alpha (thanks to Stanislav Sinyagin)
*
* Other changes (not by me) :
* -------------------------
* - Spelling and gramar "rectification".
*
* Changes made for release in 2.0.37 & 2.2.2 :
* ------------------------------------------
* - Correct status in /proc/net/wireless
* - Set PSA CRC to make PtP diagnostic tool happy (Bob Gray)
* - Module init code don't fail if we found at least one card in
* the address list (Karlis Peisenieks)
* - Missing parenthesis (Christopher Peterson)
* - Correct i82586 configuration parameters
* - Encryption initialisation bug (Robert McCormack)
* - New mac addresses detected in the probe
* - Increase watchdog for busy environments
*
* Changes made for release in 2.0.38 & 2.2.7 :
* ------------------------------------------
* - Correct the reception logic to better report errors and avoid
* sending bogus packet up the stack
* - Delay RU config to avoid corrupting first received packet
* - Change config completion code (to actually check something)
* - Avoid reading out of bound in skbuf to transmit
* - Rectify a lot of (useless) debugging code
* - Change the way to `#ifdef SET_PSA_CRC'
*
* Changes made for release in 2.2.11 & 2.3.13 :
* -------------------------------------------
* - Change e-mail and web page addresses
* - Watchdog timer is now correctly expressed in HZ, not in jiffies
* - Add channel number to the list of frequencies in range
* - Add the (short) list of bit-rates in range
* - Developp a new sensitivity... (sens.value & sens.fixed)
*
* Changes made for release in 2.2.14 & 2.3.23 :
* -------------------------------------------
* - Fix check for root permission (break instead of exit)
* - New nwid & encoding setting (Wireless Extension 9)
*
* Changes made for release in 2.3.49 :
* ----------------------------------
* - Indentation reformating (Alan)
* - Update to new network API (softnet - 2.3.43) :
* o replace dev->tbusy (Alan)
* o replace dev->tstart (Alan)
* o remove dev->interrupt (Alan)
* o add SMP locking via spinlock in splxx (me)
* o add spinlock in interrupt handler (me)
* o use kernel watchdog instead of ours (me)
* o increase watchdog timeout (kernel is more sensitive) (me)
* o verify that all the changes make sense and work (me)
* - Fixup a potential gotcha when reconfiguring and thighten a bit
* the interactions with Tx queue.
*
* Changes made for release in 2.4.0 :
* ---------------------------------
* - Fix spinlock stupid bugs that I left in. The driver is now SMP
* compliant and doesn't lockup at startup.
*
* Changes made for release in 2.5.2 :
* ---------------------------------
* - Use new driver API for Wireless Extensions :
* o got rid of wavelan_ioctl()
* o use a bunch of iw_handler instead
*
* Changes made for release in 2.5.35 :
* ----------------------------------
* - Set dev->trans_start to avoid filling the logs
* - Handle better spurious/bogus interrupt
* - Avoid deadlocks in mmc_out()/mmc_in()
*
* Wishes & dreams:
* ----------------
* - roaming (see Pcmcia driver)
*/
/***************************** INCLUDES *****************************/
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/sched.h>
#include <linux/types.h>
#include <linux/fcntl.h>
#include <linux/interrupt.h>
#include <linux/stat.h>
#include <linux/ptrace.h>
#include <linux/ioport.h>
#include <linux/in.h>
#include <linux/string.h>
#include <linux/delay.h>
#include <linux/bitops.h>
#include <asm/system.h>
#include <asm/io.h>
#include <asm/dma.h>
#include <asm/uaccess.h>
#include <linux/errno.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/skbuff.h>
#include <linux/slab.h>
#include <linux/timer.h>
#include <linux/init.h>
#include <linux/wireless.h> /* Wireless extensions */
#include <net/iw_handler.h> /* Wireless handlers */
/* WaveLAN declarations */
#include "i82586.h"
#include "wavelan.h"
/************************** DRIVER OPTIONS **************************/
/*
* `#define' or `#undef' the following constant to change the behaviour
* of the driver...
*/
#undef SET_PSA_CRC /* Calculate and set the CRC on PSA (slower) */
#define USE_PSA_CONFIG /* Use info from the PSA. */
#undef EEPROM_IS_PROTECTED /* doesn't seem to be necessary */
#define MULTICAST_AVOID /* Avoid extra multicast (I'm sceptical). */
#undef SET_MAC_ADDRESS /* Experimental */
/* Warning: this stuff will slow down the driver. */
#define WIRELESS_SPY /* Enable spying addresses. */
#undef HISTOGRAM /* Enable histogram of signal level. */
/****************************** DEBUG ******************************/
#undef DEBUG_MODULE_TRACE /* module insertion/removal */
#undef DEBUG_CALLBACK_TRACE /* calls made by Linux */
#undef DEBUG_INTERRUPT_TRACE /* calls to handler */
#undef DEBUG_INTERRUPT_INFO /* type of interrupt and so on */
#define DEBUG_INTERRUPT_ERROR /* problems */
#undef DEBUG_CONFIG_TRACE /* Trace the config functions. */
#undef DEBUG_CONFIG_INFO /* what's going on */
#define DEBUG_CONFIG_ERROR /* errors on configuration */
#undef DEBUG_TX_TRACE /* transmission calls */
#undef DEBUG_TX_INFO /* header of the transmitted packet */
#undef DEBUG_TX_FAIL /* Normal failure conditions */
#define DEBUG_TX_ERROR /* Unexpected conditions */
#undef DEBUG_RX_TRACE /* transmission calls */
#undef DEBUG_RX_INFO /* header of the received packet */
#undef DEBUG_RX_FAIL /* Normal failure conditions */
#define DEBUG_RX_ERROR /* Unexpected conditions */
#undef DEBUG_PACKET_DUMP /* Dump packet on the screen if defined to 32. */
#undef DEBUG_IOCTL_TRACE /* misc. call by Linux */
#undef DEBUG_IOCTL_INFO /* various debugging info */
#define DEBUG_IOCTL_ERROR /* what's going wrong */
#define DEBUG_BASIC_SHOW /* Show basic startup info. */
#undef DEBUG_VERSION_SHOW /* Print version info. */
#undef DEBUG_PSA_SHOW /* Dump PSA to screen. */
#undef DEBUG_MMC_SHOW /* Dump mmc to screen. */
#undef DEBUG_SHOW_UNUSED /* Show unused fields too. */
#undef DEBUG_I82586_SHOW /* Show i82586 status. */
#undef DEBUG_DEVICE_SHOW /* Show device parameters. */
/************************ CONSTANTS & MACROS ************************/
#ifdef DEBUG_VERSION_SHOW
static const char *version = "wavelan.c : v24 (SMP + wireless extensions) 11/12/01\n";
#endif
/* Watchdog temporisation */
#define WATCHDOG_JIFFIES (512*HZ/100)
/* ------------------------ PRIVATE IOCTL ------------------------ */
#define SIOCSIPQTHR SIOCIWFIRSTPRIV /* Set quality threshold */
#define SIOCGIPQTHR (SIOCIWFIRSTPRIV + 1) /* Get quality threshold */
#define SIOCSIPHISTO (SIOCIWFIRSTPRIV + 2) /* Set histogram ranges */
#define SIOCGIPHISTO (SIOCIWFIRSTPRIV + 3) /* Get histogram values */
/****************************** TYPES ******************************/
/* Shortcuts */
typedef struct iw_statistics iw_stats;
typedef struct iw_quality iw_qual;
typedef struct iw_freq iw_freq;
typedef struct net_local net_local;
typedef struct timer_list timer_list;
/* Basic types */
typedef u_char mac_addr[WAVELAN_ADDR_SIZE];
|