wavelan_cs.h
上传用户:lgb322
上传日期:2013-02-24
资源大小:30529k
文件大小:29k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

  1. /*
  2.  * Wavelan Pcmcia driver
  3.  *
  4.  * Jean II - HPLB '96
  5.  *
  6.  * Reorganisation and extension of the driver.
  7.  *
  8.  * This file contain all definition and declarations necessary for the
  9.  * wavelan pcmcia driver. This file is a private header, so it should
  10.  * be included only on wavelan_cs.c !!!
  11.  */
  12. #ifndef WAVELAN_CS_H
  13. #define WAVELAN_CS_H
  14. /************************** DOCUMENTATION **************************/
  15. /*
  16.  * This driver provide a Linux interface to the Wavelan Pcmcia hardware
  17.  * The Wavelan is a product of Lucent (http://www.wavelan.com/).
  18.  * This division was formerly part of NCR and then AT&T.
  19.  * Wavelan are also distributed by DEC (RoamAbout DS)...
  20.  *
  21.  * To know how to use this driver, read the PCMCIA HOWTO.
  22.  * If you want to exploit the many other fonctionalities, look comments
  23.  * in the code...
  24.  *
  25.  * This driver is the result of the effort of many peoples (see below).
  26.  */
  27. /* ------------------------ SPECIFIC NOTES ------------------------ */
  28. /*
  29.  * Web page
  30.  * --------
  31.  * I try to maintain a web page with the Wireless LAN Howto at :
  32.  *     http://www.hpl.hp.com/personal/Jean_Tourrilhes/Linux/Wavelan.html
  33.  *
  34.  * Debugging and options
  35.  * ---------------------
  36.  * You will find below a set of '#define" allowing a very fine control
  37.  * on the driver behaviour and the debug messages printed.
  38.  * The main options are :
  39.  * o WAVELAN_ROAMING, for the experimental roaming support.
  40.  * o SET_PSA_CRC, to have your card correctly recognised by
  41.  *   an access point and the Point-to-Point diagnostic tool.
  42.  * o USE_PSA_CONFIG, to read configuration from the PSA (EEprom)
  43.  *   (otherwise we always start afresh with some defaults)
  44.  *
  45.  * wavelan_cs.o is darn too big
  46.  * -------------------------
  47.  * That's true ! There is a very simple way to reduce the driver
  48.  * object by 33% (yes !). Comment out the following line :
  49.  * #include <linux/wireless.h>
  50.  * Other compile options can also reduce the size of it...
  51.  *
  52.  * MAC address and hardware detection :
  53.  * ----------------------------------
  54.  * The detection code of the wavelan chech that the first 3
  55.  * octets of the MAC address fit the company code. This type of
  56.  * detection work well for AT&T cards (because the AT&T code is
  57.  * hardcoded in wavelan.h), but of course will fail for other
  58.  * manufacturer.
  59.  *
  60.  * If you are sure that your card is derived from the wavelan,
  61.  * here is the way to configure it :
  62.  * 1) Get your MAC address
  63.  * a) With your card utilities (wfreqsel, instconf, ...)
  64.  * b) With the driver :
  65.  * o compile the kernel with DEBUG_CONFIG_INFO enabled
  66.  * o Boot and look the card messages
  67.  * 2) Set your MAC code (3 octets) in MAC_ADDRESSES[][3] (wavelan.h)
  68.  * 3) Compile & verify
  69.  * 4) Send me the MAC code - I will include it in the next version...
  70.  *
  71.  */
  72. /* --------------------- WIRELESS EXTENSIONS --------------------- */
  73. /*
  74.  * This driver is the first one to support "wireless extensions".
  75.  * This set of extensions provide you some way to control the wireless
  76.  * caracteristics of the hardware in a standard way and support for
  77.  * applications for taking advantage of it (like Mobile IP).
  78.  *
  79.  * You will need to enable the CONFIG_NET_RADIO define in the kernel
  80.  * configuration to enable the wireless extensions (this is the one
  81.  * giving access to the radio network device choice).
  82.  *
  83.  * It might also be a good idea as well to fetch the wireless tools to
  84.  * configure the device and play a bit.
  85.  */
  86. /* ---------------------------- FILES ---------------------------- */
  87. /*
  88.  * wavelan_cs.c : The actual code for the driver - C functions
  89.  *
  90.  * wavelan_cs.h : Private header : local types / vars for the driver
  91.  *
  92.  * wavelan.h : Description of the hardware interface & structs
  93.  *
  94.  * i82593.h : Description if the Ethernet controller
  95.  */
  96. /* --------------------------- HISTORY --------------------------- */
  97. /*
  98.  * The history of the Wavelan drivers is as complicated as history of
  99.  * the Wavelan itself (NCR -> AT&T -> Lucent).
  100.  *
  101.  * All started with Anders Klemets <klemets@paul.rutgers.edu>,
  102.  * writting a Wavelan ISA driver for the MACH microkernel. Girish
  103.  * Welling <welling@paul.rutgers.edu> had also worked on it.
  104.  * Keith Moore modify this for the Pcmcia hardware.
  105.  * 
  106.  * Robert Morris <rtm@das.harvard.edu> port these two drivers to BSDI
  107.  * and add specific Pcmcia support (there is currently no equivalent
  108.  * of the PCMCIA package under BSD...).
  109.  *
  110.  * Jim Binkley <jrb@cs.pdx.edu> port both BSDI drivers to FreeBSD.
  111.  *
  112.  * Bruce Janson <bruce@cs.usyd.edu.au> port the BSDI ISA driver to Linux.
  113.  *
  114.  * Anthony D. Joseph <adj@lcs.mit.edu> started modify Bruce driver
  115.  * (with help of the BSDI PCMCIA driver) for PCMCIA.
  116.  * Yunzhou Li <yunzhou@strat.iol.unh.edu> finished is work.
  117.  * Joe Finney <joe@comp.lancs.ac.uk> patched the driver to start
  118.  * correctly 2.00 cards (2.4 GHz with frequency selection).
  119.  * David Hinds <dhinds@pcmcia.sourceforge.org> integrated the whole in his
  120.  * Pcmcia package (+ bug corrections).
  121.  *
  122.  * I (Jean Tourrilhes - jt@hplb.hpl.hp.com) then started to make some
  123.  * patchs to the Pcmcia driver. After, I added code in the ISA driver
  124.  * for Wireless Extensions and full support of frequency selection
  125.  * cards. Now, I'm doing the same to the Pcmcia driver + some
  126.  * reorganisation.
  127.  * Loeke Brederveld <lbrederv@wavelan.com> from Lucent has given me
  128.  * much needed informations on the Wavelan hardware.
  129.  */
  130. /* By the way : for the copyright & legal stuff :
  131.  * Almost everybody wrote code under GNU or BSD license (or alike),
  132.  * and want that their original copyright remain somewhere in the
  133.  * code (for myself, I go with the GPL).
  134.  * Nobody want to take responsibility for anything, except the fame...
  135.  */
  136. /* --------------------------- CREDITS --------------------------- */
  137. /*
  138.  * Credits:
  139.  *    Special thanks to Jan Hoogendoorn of AT&T GIS Utrecht and
  140.  * Loeke Brederveld of Lucent for providing extremely useful
  141.  * information about WaveLAN PCMCIA hardware
  142.  *
  143.  *    This driver is based upon several other drivers, in particular:
  144.  * David Hinds' Linux driver for the PCMCIA 3c589 ethernet adapter
  145.  * Bruce Janson's Linux driver for the AT-bus WaveLAN adapter
  146.  * Anders Klemets' PCMCIA WaveLAN adapter driver
  147.  * Robert Morris' BSDI driver for the PCMCIA WaveLAN adapter
  148.  *
  149.  * Additional Credits:
  150.  *
  151.  *    This software was originally developed under Linux 1.2.3
  152.  * (Slackware 2.0 distribution).
  153.  *    And then under Linux 2.0.x (Debian 1.1 - pcmcia 2.8.18-23) with
  154.  * HP OmniBook 4000 & 5500.
  155.  *
  156.  *    It is based on other device drivers and information either written
  157.  *    or supplied by:
  158.  * James Ashton (jaa101@syseng.anu.edu.au),
  159.  * Ajay Bakre (bakre@paul.rutgers.edu),
  160.  * Donald Becker (becker@super.org),
  161.  * Jim Binkley <jrb@cs.pdx.edu>,
  162.  * Loeke Brederveld <lbrederv@wavelan.com>,
  163.  * Allan Creighton (allanc@cs.su.oz.au),
  164.  * Brent Elphick <belphick@uwaterloo.ca>,
  165.  * Joe Finney <joe@comp.lancs.ac.uk>,
  166.  * Matthew Geier (matthew@cs.su.oz.au),
  167.  * Remo di Giovanni (remo@cs.su.oz.au),
  168.  * Mark Hagan (mhagan@wtcpost.daytonoh.NCR.COM),
  169.  * David Hinds <dhinds@pcmcia.sourceforge.org>,
  170.  * Jan Hoogendoorn (c/o marteijn@lucent.com),
  171.  *      Bruce Janson <bruce@cs.usyd.edu.au>,
  172.  * Anthony D. Joseph <adj@lcs.mit.edu>,
  173.  * Anders Klemets (klemets@paul.rutgers.edu),
  174.  * Yunzhou Li <yunzhou@strat.iol.unh.edu>,
  175.  * Marc Meertens (mmeertens@lucent.com),
  176.  * Keith Moore,
  177.  * Robert Morris (rtm@das.harvard.edu),
  178.  * Ian Parkin (ian@cs.su.oz.au),
  179.  * John Rosenberg (johnr@cs.su.oz.au),
  180.  * George Rossi (george@phm.gov.au),
  181.  * Arthur Scott (arthur@cs.su.oz.au),
  182.  * Stanislav Sinyagin <stas@isf.ru>
  183.  * Peter Storey,
  184.  * Jean Tourrilhes <jt@hpl.hp.com>,
  185.  * Girish Welling (welling@paul.rutgers.edu)
  186.  * Clark Woodworth <clark@hiway1.exit109.com>
  187.  * Yongguang Zhang <ygz@isl.hrl.hac.com>...
  188.  */
  189. /* ------------------------- IMPROVEMENTS ------------------------- */
  190. /*
  191.  * I proudly present :
  192.  *
  193.  * Changes made in 2.8.22 :
  194.  * ----------------------
  195.  * - improved wv_set_multicast_list
  196.  * - catch spurious interrupt
  197.  * - correct release of the device
  198.  *
  199.  * Changes mades in release :
  200.  * ------------------------
  201.  * - Reorganisation of the code, function name change
  202.  * - Creation of private header (wavelan_cs.h)
  203.  * - Reorganised debug messages
  204.  * - More comments, history, ...
  205.  * - Configure earlier (in "insert" instead of "open")
  206.  *        and do things only once
  207.  * - mmc_init : configure the PSA if not done
  208.  * - mmc_init : 2.00 detection better code for 2.00 init
  209.  * - better info at startup
  210.  * - Correct a HUGE bug (volatile & uncalibrated busy loop)
  211.  *   in wv_82593_cmd => config speedup
  212.  * - Stop receiving & power down on close (and power up on open)
  213.  *   use "ifconfig down" & "ifconfig up ; route add -net ..."
  214.  * - Send packets : add watchdog instead of pooling
  215.  * - Receive : check frame wrap around & try to recover some frames
  216.  * - wavelan_set_multicast_list : avoid reset
  217.  * - add wireless extensions (ioctl & get_wireless_stats)
  218.  *   get/set nwid/frequency on fly, info for /proc/net/wireless
  219.  * - Suppress useless stuff from lp (net_local), but add link
  220.  * - More inlines
  221.  * - Lot of others minor details & cleanups
  222.  *
  223.  * Changes made in second release :
  224.  * ------------------------------
  225.  * - Optimise wv_85893_reconfig stuff, fix potential problems
  226.  * - Change error values for ioctl
  227.  * - Non blocking wv_ru_stop() + call wv_reset() in case of problems
  228.  * - Remove development printk from wavelan_watchdog()
  229.  * - Remove of the watchdog to wavelan_close instead of wavelan_release
  230.  *   fix potential problems...
  231.  * - Start debugging suspend stuff (but it's still a bit weird)
  232.  * - Debug & optimize dump header/packet in Rx & Tx (debug)
  233.  * - Use "readb" and "writeb" to be kernel 2.1 compliant
  234.  * - Better handling of bogus interrupts
  235.  * - Wireless extension : SETSPY and GETSPY
  236.  * - Remove old stuff (stats - for those needing it, just ask me...)
  237.  * - Make wireless extensions optional
  238.  *
  239.  * Changes made in third release :
  240.  * -----------------------------
  241.  * - cleanups & typos
  242.  * - modif wireless ext (spy -> only one pointer)
  243.  * - new private ioctl to set/get quality & level threshold
  244.  * - Init : correct default value of level threshold for pcmcia
  245.  * - kill watchdog in hw_reset
  246.  * - more 2.1 support (copy_to/from_user instead of memcpy_to/fromfs)
  247.  * - Add message level (debug stuff in /var/adm/debug & errors not
  248.  *   displayed at console and still in /var/adm/messages)
  249.  *
  250.  * Changes made in fourth release :
  251.  * ------------------------------
  252.  * - multicast support (yes !) thanks to Yongguang Zhang.
  253.  *
  254.  * Changes made in fifth release (2.9.0) :
  255.  * -------------------------------------
  256.  * - Revisited multicast code (it was mostly wrong).
  257.  * - protect code in wv_82593_reconfig with dev->tbusy (oups !)
  258.  *
  259.  * Changes made in sixth release (2.9.1a) :
  260.  * --------------------------------------
  261.  * - Change the detection code for multi manufacturer code support
  262.  * - Correct bug (hang kernel) in init when we were "rejecting" a card 
  263.  *
  264.  * Changes made in seventh release (2.9.1b) :
  265.  * ----------------------------------------
  266.  * - Update to wireless extensions changes
  267.  * - Silly bug in card initial configuration (psa_conf_status)
  268.  *
  269.  * Changes made in eigth release :
  270.  * -----------------------------
  271.  * - Small bug in debug code (probably not the last one...)
  272.  * - 1.2.13 support (thanks to Clark Woodworth)
  273.  *
  274.  * Changes made for release in 2.9.2b :
  275.  * ----------------------------------
  276.  * - Level threshold is now a standard wireless extension (version 4 !)
  277.  * - modules parameters types for kernel > 2.1.17
  278.  * - updated man page
  279.  * - Others cleanup from David Hinds
  280.  *
  281.  * Changes made for release in 2.9.5 :
  282.  * ---------------------------------
  283.  * - byte count stats (courtesy of David Hinds)
  284.  * - Remove dev_tint stuff (courtesy of David Hinds)
  285.  * - Others cleanup from David Hinds
  286.  * - Encryption setting from Brent Elphick (thanks a lot !)
  287.  * - 'base' to 'u_long' for the Alpha (thanks to Stanislav Sinyagin)
  288.  *
  289.  * Changes made for release in 2.9.6 :
  290.  * ---------------------------------
  291.  * - fix bug : no longuer disable watchdog in case of bogus interrupt
  292.  * - increase timeout in config code for picky hardware
  293.  * - mask unused bits in status (Wireless Extensions)
  294.  *
  295.  * Changes integrated by Justin Seger <jseger@MIT.EDU> & David Hinds :
  296.  * -----------------------------------------------------------------
  297.  * - Roaming "hack" from Joe Finney <joe@comp.lancs.ac.uk>
  298.  * - PSA CRC code from Bob Gray <rgray@bald.cs.dartmouth.edu>
  299.  * - Better initialisation of the i82593 controller
  300.  *   from Joseph K. O'Sullivan <josullvn+@cs.cmu.edu>
  301.  *
  302.  * Changes made for release in 3.0.10 :
  303.  * ----------------------------------
  304.  * - Fix eject "hang" of the driver under 2.2.X :
  305.  * o create wv_flush_stale_links()
  306.  * o Rename wavelan_release to wv_pcmcia_release & move up
  307.  * o move unregister_netdev to wavelan_detach()
  308.  * o wavelan_release() no longer call wavelan_detach()
  309.  * o Suppress "release" timer
  310.  * o Other cleanups & fixes
  311.  * - New MAC address in the probe
  312.  * - Reorg PSA_CRC code (endian neutral & cleaner)
  313.  * - Correct initialisation of the i82593 from Lucent manual
  314.  * - Put back the watchdog, with larger timeout
  315.  * - TRANSMIT_NO_CRC is a "normal" error, so recover from it
  316.  *   from Derrick J Brashear <shadow@dementia.org>
  317.  * - Better handling of TX and RX normal failure conditions
  318.  * - #ifdef out all the roaming code
  319.  * - Add ESSID & "AP current address" ioctl stubs
  320.  * - General cleanup of the code
  321.  *
  322.  * Changes made for release in 3.0.13 :
  323.  * ----------------------------------
  324.  * - Re-enable compilation of roaming code by default, but with
  325.  *   do_roaming = 0
  326.  * - Nuke `nwid=nwid^ntohs(beacon->domain_id)' in wl_roam_gather
  327.  *   at the demand of John Carol Langford <jcl@gs176.sp.cs.cmu.edu>
  328.  * - Introduced WAVELAN_ROAMING_EXT for incomplete ESSID stuff.
  329.  *
  330.  * Changes made for release in 3.0.15 :
  331.  * ----------------------------------
  332.  * - Change e-mail and web page addresses
  333.  * - Watchdog timer is now correctly expressed in HZ, not in jiffies
  334.  * - Add channel number to the list of frequencies in range
  335.  * - Add the (short) list of bit-rates in range
  336.  * - Developp a new sensitivity... (sens.value & sens.fixed)
  337.  *
  338.  * Changes made for release in 3.1.2 :
  339.  * ---------------------------------
  340.  * - Fix check for root permission (break instead of exit)
  341.  * - New nwid & encoding setting (Wireless Extension 9)
  342.  *
  343.  * Wishes & dreams:
  344.  * ----------------
  345.  * - Cleanup and integrate the roaming code
  346.  *   (std debug, set DomainID, decay avg and co...)
  347.  */
  348. /***************************** INCLUDES *****************************/
  349. /* Linux headers that we need */
  350. #include <linux/config.h>
  351. #include <linux/module.h>
  352. #include <linux/kernel.h>
  353. #include <linux/init.h>
  354. #include <linux/sched.h>
  355. #include <linux/ptrace.h>
  356. #include <linux/slab.h>
  357. #include <linux/string.h>
  358. #include <linux/timer.h>
  359. #include <linux/interrupt.h>
  360. #include <linux/in.h>
  361. #include <linux/delay.h>
  362. #include <asm/uaccess.h>
  363. #include <asm/io.h>
  364. #include <asm/system.h>
  365. #include <asm/bitops.h>
  366. #include <linux/netdevice.h>
  367. #include <linux/etherdevice.h>
  368. #include <linux/skbuff.h>
  369. #include <linux/if_arp.h>
  370. #include <linux/ioport.h>
  371. #include <linux/fcntl.h>
  372. #ifdef CONFIG_NET_PCMCIA_RADIO
  373. #include <linux/wireless.h> /* Wireless extensions */
  374. #endif /* CONFIG_NET_PCMCIA_RADIO */
  375. /* Pcmcia headers that we need */
  376. #include <pcmcia/cs_types.h>
  377. #include <pcmcia/cs.h>
  378. #include <pcmcia/cistpl.h>
  379. #include <pcmcia/cisreg.h>
  380. #include <pcmcia/ds.h>
  381. #include <pcmcia/version.h>
  382. /* Wavelan declarations */
  383. #include "i82593.h" /* Definitions for the Intel chip */
  384. #include "wavelan.h" /* Others bits of the hardware */
  385. /************************** DRIVER OPTIONS **************************/
  386. /*
  387.  * `#define' or `#undef' the following constant to change the behaviour
  388.  * of the driver...
  389.  */
  390. #define WAVELAN_ROAMING /* Include experimental roaming code */
  391. #undef WAVELAN_ROAMING_EXT /* Enable roaming wireless extensions */
  392. #undef SET_PSA_CRC /* Set the CRC in PSA (slower) */
  393. #define USE_PSA_CONFIG /* Use info from the PSA */
  394. #undef STRUCT_CHECK /* Verify padding of structures */
  395. #undef EEPROM_IS_PROTECTED /* Doesn't seem to be necessary */
  396. #define MULTICAST_AVOID /* Avoid extra multicast (I'm sceptical) */
  397. #undef SET_MAC_ADDRESS /* Experimental */
  398. #ifdef WIRELESS_EXT /* If wireless extension exist in the kernel */
  399. /* Warning : these stuff will slow down the driver... */
  400. #define WIRELESS_SPY /* Enable spying addresses */
  401. #undef HISTOGRAM /* Enable histogram of sig level... */
  402. #endif
  403. /****************************** DEBUG ******************************/
  404. #undef DEBUG_MODULE_TRACE /* Module insertion/removal */
  405. #undef DEBUG_CALLBACK_TRACE /* Calls made by Linux */
  406. #undef DEBUG_INTERRUPT_TRACE /* Calls to handler */
  407. #undef DEBUG_INTERRUPT_INFO /* type of interrupt & so on */
  408. #define DEBUG_INTERRUPT_ERROR /* problems */
  409. #undef DEBUG_CONFIG_TRACE /* Trace the config functions */
  410. #undef DEBUG_CONFIG_INFO /* What's going on... */
  411. #define DEBUG_CONFIG_ERRORS /* Errors on configuration */
  412. #undef DEBUG_TX_TRACE /* Transmission calls */
  413. #undef DEBUG_TX_INFO /* Header of the transmitted packet */
  414. #undef DEBUG_TX_FAIL /* Normal failure conditions */
  415. #define DEBUG_TX_ERROR /* Unexpected conditions */
  416. #undef DEBUG_RX_TRACE /* Transmission calls */
  417. #undef DEBUG_RX_INFO /* Header of the transmitted packet */
  418. #undef DEBUG_RX_FAIL /* Normal failure conditions */
  419. #define DEBUG_RX_ERROR /* Unexpected conditions */
  420. #undef DEBUG_PACKET_DUMP /* Dump packet on the screen */
  421. #undef DEBUG_IOCTL_TRACE /* Misc call by Linux */
  422. #undef DEBUG_IOCTL_INFO /* Various debug info */
  423. #define DEBUG_IOCTL_ERROR /* What's going wrong */
  424. #define DEBUG_BASIC_SHOW /* Show basic startup info */
  425. #undef DEBUG_VERSION_SHOW /* Print version info */
  426. #undef DEBUG_PSA_SHOW /* Dump psa to screen */
  427. #undef DEBUG_MMC_SHOW /* Dump mmc to screen */
  428. #undef DEBUG_SHOW_UNUSED /* Show also unused fields */
  429. #undef DEBUG_I82593_SHOW /* Show i82593 status */
  430. #undef DEBUG_DEVICE_SHOW /* Show device parameters */
  431. /************************ CONSTANTS & MACROS ************************/
  432. #ifdef DEBUG_VERSION_SHOW
  433. static const char *version = "wavelan_cs.c : v21 (wireless extensions) 18/10/99n";
  434. #endif
  435. /* Watchdog temporisation */
  436. #define WATCHDOG_JIFFIES (256*HZ/100)
  437. /* Fix a bug in some old wireless extension definitions */
  438. #ifndef IW_ESSID_MAX_SIZE
  439. #define IW_ESSID_MAX_SIZE 32
  440. #endif
  441. /* ------------------------ PRIVATE IOCTL ------------------------ */
  442. /* Wireless Extension Backward compatibility - Jean II
  443.  * If the new wireless device private ioctl range is not defined,
  444.  * default to standard device private ioctl range */
  445. #ifndef SIOCIWFIRSTPRIV
  446. #define SIOCIWFIRSTPRIV SIOCDEVPRIVATE
  447. #endif /* SIOCIWFIRSTPRIV */
  448. #define SIOCSIPQTHR SIOCIWFIRSTPRIV /* Set quality threshold */
  449. #define SIOCGIPQTHR SIOCIWFIRSTPRIV + 1 /* Get quality threshold */
  450. #define SIOCSIPROAM     SIOCIWFIRSTPRIV + 2 /* Set roaming state */
  451. #define SIOCGIPROAM     SIOCIWFIRSTPRIV + 3 /* Get roaming state */
  452. #define SIOCSIPHISTO SIOCIWFIRSTPRIV + 6 /* Set histogram ranges */
  453. #define SIOCGIPHISTO SIOCIWFIRSTPRIV + 7 /* Get histogram values */
  454. /*************************** WaveLAN Roaming  **************************/
  455. #ifdef WAVELAN_ROAMING /* Conditional compile, see above in options */
  456. #define WAVELAN_ROAMING_DEBUG  0 /* 1 = Trace of handover decisions */
  457. /* 2 = Info on each beacon rcvd... */
  458. #define MAX_WAVEPOINTS 7 /* Max visible at one time */
  459. #define WAVEPOINT_HISTORY 5 /* SNR sample history slow search */
  460. #define WAVEPOINT_FAST_HISTORY 2 /* SNR sample history fast search */
  461. #define SEARCH_THRESH_LOW 10 /* SNR to enter cell search */
  462. #define SEARCH_THRESH_HIGH 13 /* SNR to leave cell search */
  463. #define WAVELAN_ROAMING_DELTA 1 /* Hysteresis value (+/- SNR) */
  464. #define CELL_TIMEOUT 2*HZ /* in jiffies */
  465. #define FAST_CELL_SEARCH 1 /* Boolean values... */
  466. #define NWID_PROMISC 1 /* for code clarity. */
  467. typedef struct wavepoint_beacon
  468. {
  469.   unsigned char dsap, /* Unused */
  470. ssap, /* Unused */
  471. ctrl, /* Unused */
  472. O,U,I, /* Unused */
  473. spec_id1, /* Unused */
  474. spec_id2, /* Unused */
  475. pdu_type, /* Unused */
  476. seq; /* WavePoint beacon sequence number */
  477.   unsigned short domain_id, /* WavePoint Domain ID */
  478. nwid; /* WavePoint NWID */
  479. } wavepoint_beacon;
  480. typedef struct wavepoint_history
  481. {
  482.   unsigned short nwid; /* WavePoint's NWID */
  483.   int average_slow; /* SNR running average */
  484.   int average_fast; /* SNR running average */
  485.   unsigned char   sigqual[WAVEPOINT_HISTORY]; /* Ringbuffer of recent SNR's */
  486.   unsigned char qualptr; /* Index into ringbuffer */
  487.   unsigned char last_seq; /* Last seq. no seen for WavePoint */
  488.   struct wavepoint_history *next; /* Next WavePoint in table */
  489.   struct wavepoint_history *prev; /* Previous WavePoint in table */
  490.   unsigned long last_seen; /* Time of last beacon recvd, jiffies */
  491. } wavepoint_history;
  492. struct wavepoint_table
  493. {
  494.   wavepoint_history *head; /* Start of ringbuffer */
  495.   int num_wavepoints; /* No. of WavePoints visible */
  496.   unsigned char locked; /* Table lock */
  497. };
  498. #endif /* WAVELAN_ROAMING */
  499. /****************************** TYPES ******************************/
  500. /* Shortcuts */
  501. typedef struct net_device device;
  502. typedef struct net_device_stats en_stats;
  503. typedef struct iw_statistics iw_stats;
  504. typedef struct iw_quality iw_qual;
  505. typedef struct iw_freq iw_freq;
  506. typedef struct net_local net_local;
  507. typedef struct timer_list timer_list;
  508. /* Basic types */
  509. typedef u_char mac_addr[WAVELAN_ADDR_SIZE]; /* Hardware address */
  510. /*
  511.  * Static specific data for the interface.
  512.  *
  513.  * For each network interface, Linux keep data in two structure. "device"
  514.  * keep the generic data (same format for everybody) and "net_local" keep
  515.  * the additional specific data.
  516.  * Note that some of this specific data is in fact generic (en_stats, for
  517.  * example).
  518.  */
  519. struct net_local
  520. {
  521.   spinlock_t lock;
  522.   dev_node_t  node; /* ???? What is this stuff ???? */
  523.   device * dev; /* Reverse link... */
  524.   dev_link_t * link; /* pcmcia structure */
  525.   en_stats stats; /* Ethernet interface statistics */
  526.   int nresets; /* Number of hw resets */
  527.   u_char configured; /* If it is configured */
  528.   u_char reconfig_82593; /* Need to reconfigure the controller */
  529.   u_char promiscuous; /* Promiscuous mode */
  530.   u_char allmulticast; /* All Multicast mode */
  531.   int mc_count; /* Number of multicast addresses */
  532.   timer_list watchdog; /* To avoid blocking state */
  533.   u_char        status; /* Current i82593 status */
  534.   int    stop; /* Current i82593 Stop Hit Register */
  535.   int    rfp; /* Last DMA machine receive pointer */
  536.   int overrunning; /* Receiver overrun flag */
  537. #ifdef WIRELESS_EXT
  538.   iw_stats wstats; /* Wireless specific stats */
  539. #endif
  540. #ifdef WIRELESS_SPY
  541.   int spy_number; /* Number of addresses to spy */
  542.   mac_addr spy_address[IW_MAX_SPY]; /* The addresses to spy */
  543.   iw_qual spy_stat[IW_MAX_SPY]; /* Statistics gathered */
  544. #endif /* WIRELESS_SPY */
  545. #ifdef HISTOGRAM
  546.   int his_number; /* Number of intervals */
  547.   u_char his_range[16]; /* Boundaries of interval ]n-1; n] */
  548.   u_long his_sum[16]; /* Sum in interval */
  549. #endif /* HISTOGRAM */
  550. #ifdef WAVELAN_ROAMING
  551.   u_long domain_id; /* Domain ID we lock on for roaming */
  552.   int filter_domains; /* Check Domain ID of beacon found */
  553.  struct wavepoint_table wavepoint_table; /* Table of visible WavePoints*/
  554.   wavepoint_history * curr_point; /* Current wavepoint */
  555.   int cell_search; /* Searching for new cell? */
  556.   struct timer_list cell_timer; /* Garbage collection */
  557. #endif /* WAVELAN_ROAMING */
  558. };
  559. /**************************** PROTOTYPES ****************************/
  560. #ifdef WAVELAN_ROAMING
  561. /* ---------------------- ROAMING SUBROUTINES -----------------------*/
  562. wavepoint_history *wl_roam_check(unsigned short nwid, net_local *lp);
  563. wavepoint_history *wl_new_wavepoint(unsigned short nwid, unsigned char seq, net_local *lp);
  564. void wl_del_wavepoint(wavepoint_history *wavepoint, net_local *lp);
  565. void wl_cell_expiry(unsigned long data);
  566. wavepoint_history *wl_best_sigqual(int fast_search, net_local *lp);
  567. void wl_update_history(wavepoint_history *wavepoint, unsigned char sigqual, unsigned char seq);
  568. void wv_roam_handover(wavepoint_history *wavepoint, net_local *lp);
  569. void wv_nwid_filter(unsigned char mode, net_local *lp);
  570. void wv_roam_init(struct net_device *dev);
  571. void wv_roam_cleanup(struct net_device *dev);
  572. #endif /* WAVELAN_ROAMING */
  573. /* ----------------------- MISC SUBROUTINES ------------------------ */
  574. static void
  575. cs_error(client_handle_t, /* Report error to cardmgr */
  576.  int,
  577.  int);
  578. /* ----------------- MODEM MANAGEMENT SUBROUTINES ----------------- */
  579. static inline u_char /* data */
  580. hasr_read(u_long); /* Read the host interface : base address */
  581. static inline void
  582. hacr_write(u_long, /* Write to host interface : base address */
  583.    u_char), /* data */
  584. hacr_write_slow(u_long,
  585.    u_char);
  586. static void
  587. psa_read(device *, /* Read the Parameter Storage Area */
  588.  int, /* offset in PSA */
  589.  u_char *, /* buffer to fill */
  590.  int), /* size to read */
  591. psa_write(device *, /* Write to the PSA */
  592.   int, /* Offset in psa */
  593.   u_char *, /* Buffer in memory */
  594.   int); /* Length of buffer */
  595. static inline void
  596. mmc_out(u_long, /* Write 1 byte to the Modem Manag Control */
  597. u_short,
  598. u_char),
  599. mmc_write(u_long, /* Write n bytes to the MMC */
  600.   u_char,
  601.   u_char *,
  602.   int);
  603. static inline u_char /* Read 1 byte from the MMC */
  604. mmc_in(u_long,
  605.        u_short);
  606. static inline void
  607. mmc_read(u_long, /* Read n bytes from the MMC */
  608.  u_char,
  609.  u_char *,
  610.  int),
  611. fee_wait(u_long, /* Wait for frequency EEprom : base address */
  612.  int, /* Base delay to wait for */
  613.  int); /* Number of time to wait */
  614. static void
  615. fee_read(u_long, /* Read the frequency EEprom : base address */
  616.  u_short, /* destination offset */
  617.  u_short *, /* data buffer */
  618.  int); /* number of registers */
  619. /* ---------------------- I82593 SUBROUTINES ----------------------- */
  620. static int
  621. wv_82593_cmd(device *, /* synchronously send a command to i82593 */ 
  622.      char *,
  623.      int,
  624.      int);
  625. static inline int
  626. wv_diag(device *); /* Diagnostique the i82593 */
  627. static int
  628. read_ringbuf(device *, /* Read a receive buffer */
  629.      int,
  630.      char *,
  631.      int);
  632. static inline void
  633. wv_82593_reconfig(device *); /* Reconfigure the controller */
  634. /* ------------------- DEBUG & INFO SUBROUTINES ------------------- */
  635. static inline void
  636. wv_init_info(device *); /* display startup info */
  637. /* ------------------- IOCTL, STATS & RECONFIG ------------------- */
  638. static en_stats *
  639. wavelan_get_stats(device *); /* Give stats /proc/net/dev */
  640. /* ----------------------- PACKET RECEPTION ----------------------- */
  641. static inline int
  642. wv_start_of_frame(device *, /* Seek beggining of current frame */
  643.   int, /* end of frame */
  644.   int); /* start of buffer */
  645. static inline void
  646. wv_packet_read(device *, /* Read a packet from a frame */
  647.        int,
  648.        int),
  649. wv_packet_rcv(device *); /* Read all packets waiting */
  650. /* --------------------- PACKET TRANSMISSION --------------------- */
  651. static inline void
  652. wv_packet_write(device *, /* Write a packet to the Tx buffer */
  653. void *,
  654. short);
  655. static int
  656. wavelan_packet_xmit(struct sk_buff *, /* Send a packet */
  657.     device *);
  658. /* -------------------- HARDWARE CONFIGURATION -------------------- */
  659. static inline int
  660. wv_mmc_init(device *); /* Initialize the modem */
  661. static int
  662. wv_ru_stop(device *), /* Stop the i82593 receiver unit */
  663. wv_ru_start(device *); /* Start the i82593 receiver unit */
  664. static int
  665. wv_82593_config(device *); /* Configure the i82593 */
  666. static inline int
  667. wv_pcmcia_reset(device *); /* Reset the pcmcia interface */
  668. static int
  669. wv_hw_config(device *); /* Reset & configure the whole hardware */
  670. static inline void
  671. wv_hw_reset(device *); /* Same, + start receiver unit */
  672. static inline int
  673. wv_pcmcia_config(dev_link_t *); /* Configure the pcmcia interface */
  674. static void
  675. wv_pcmcia_release(u_long), /* Remove a device */
  676. wv_flush_stale_links(void); /* "detach" all possible devices */
  677. /* ---------------------- INTERRUPT HANDLING ---------------------- */
  678. static void
  679. wavelan_interrupt(int, /* Interrupt handler */
  680.   void *,
  681.   struct pt_regs *);
  682. static void
  683. wavelan_watchdog(u_long); /* Transmission watchdog */
  684. /* ------------------- CONFIGURATION CALLBACKS ------------------- */
  685. static int
  686. wavelan_open(device *), /* Open the device */
  687. wavelan_close(device *), /* Close the device */
  688. wavelan_init(device *); /* Do nothing */
  689. static dev_link_t *
  690. wavelan_attach(void); /* Create a new device */
  691. static void
  692. wavelan_detach(dev_link_t *); /* Destroy a removed device */
  693. static int
  694. wavelan_event(event_t, /* Manage pcmcia events */
  695.       int,
  696.       event_callback_args_t *);
  697. /**************************** VARIABLES ****************************/
  698. static dev_info_t dev_info = "wavelan_cs";
  699. static dev_link_t *dev_list; /* Linked list of devices */
  700. /* WARNING : the following variable MUST be volatile
  701.  * It is used by wv_82593_cmd to syncronise with wavelan_interrupt */ 
  702. static volatile int wv_wait_completed;
  703. /*
  704.  * Parameters that can be set with 'insmod'
  705.  * The exact syntax is 'insmod wavelan_cs.o <var>=<value>'
  706.  */
  707. /* Bit map of interrupts to choose from */
  708. /* This means pick from 15, 14, 12, 11, 10, 9, 7, 5, 4 and 3 */
  709. static int irq_mask = 0xdeb8;
  710. static int  irq_list[4] = { -1 };
  711. /* Shared memory speed, in ns */
  712. static int mem_speed;
  713. /* New module interface */
  714. MODULE_PARM(irq_mask, "i");
  715. MODULE_PARM(irq_list, "1-4i");
  716. MODULE_PARM(mem_speed, "i");
  717. #ifdef WAVELAN_ROAMING /* Conditional compile, see above in options */
  718. /* Enable roaming mode ? No ! Please keep this to 0 */
  719. static int do_roaming;
  720. MODULE_PARM(do_roaming, "i");
  721. #endif /* WAVELAN_ROAMING */
  722. #endif /* WAVELAN_CS_H */