sys/platform/pc32/include/if_wl_wavelan.h

   1 /* $FreeBSD: src/sys/i386/include/if_wl_wavelan.h,v 1.4 1999/08/28 00:44:15 peter Exp $ */
   2 /* $DragonFly: src/sys/platform/pc32/include/if_wl_wavelan.h,v 1.4 2003/11/22 19:30:56 asmodai Exp $ */
   3 /*
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain all copyright
   8  *    notices, this list of conditions and the following disclaimer.
   9  * 2. The names of the authors may not be used to endorse or promote products
  10  *    derived from this software without specific prior written permission
  11  *
  12  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
  13  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  14  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  15  * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  16  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  17  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  18  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  19  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  20  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  21  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  22  *
  23  */
  24 #ifndef _CHIPS_WAVELAN_H_
  25 #define _CHIPS_WAVELAN_H_
  26
  27 #include <sys/ioccom.h>
  28
  29 /* This file contains definitions that are common for all versions of
  30  * the NCR WaveLAN
  31  */
  32
  33 #define WAVELAN_ADDR_SIZE       6       /* Size of a MAC address */
  34 #define WAVELAN_MTU             1500    /* Maximum size of Wavelan packet */
  35
  36 /* Modem Management Controler write commands */
  37 #define MMC_ENCR_KEY            0x00    /* to 0x07 */
  38 #define MMC_ENCR_ENABLE         0x08
  39 #define MMC_DES_IO_INVERT       0x0a
  40 #define MMC_LOOPT_SEL           0x10
  41 #define MMC_JABBER_ENABLE       0x11
  42 #define MMC_FREEZE              0x12
  43 #define MMC_ANTEN_SEL           0x13
  44 #define MMC_IFS                 0x14
  45 #define MMC_MOD_DELAY           0x15
  46 #define MMC_JAM_TIME            0x16
  47 #define MMC_THR_PRE_SET         0x18
  48 #define MMC_DECAY_PRM           0x19
  49 #define MMC_DECAY_UPDAT_PRM     0x1a
  50 #define MMC_QUALITY_THR         0x1b
  51 #define MMC_NETW_ID_L           0x1c
  52 #define MMC_NETW_ID_H           0x1d
  53 #define MMC_MODE_SEL            0x1e
  54 #define MMC_EECTRL              0x20    /* 2.4 Gz */
  55 #define MMC_EEADDR              0x21    /* 2.4 Gz */
  56 #define MMC_EEDATAL             0x22    /* 2.4 Gz */
  57 #define MMC_EEDATAH             0x23    /* 2.4 Gz */
  58 #define MMC_ANALCTRL            0x24    /* 2.4 Gz */
  59
  60 /* fields in MMC registers that relate to EEPROM in WaveMODEM daughtercard */
  61 #define MMC_EECTRL_EEPRE        0x10    /* 2.4 Gz EEPROM Protect Reg Enable */
  62 #define MMC_EECTRL_DWLD         0x08    /* 2.4 Gz EEPROM Download Synths   */
  63 #define MMC_EECTRL_EEOP         0x07    /* 2.4 Gz EEPROM Opcode mask     */
  64 #define MMC_EECTRL_EEOP_READ    0x06    /* 2.4 Gz EEPROM Read Opcode     */
  65 #define MMC_EEADDR_CHAN         0xf0    /* 2.4 Gz EEPROM Channel # mask  */
  66 #define MMC_EEADDR_WDCNT        0x0f    /* 2.4 Gz EEPROM DNLD WordCount-1 */
  67 #define MMC_ANALCTRL_ANTPOL     0x02    /* 2.4 Gz Antenna Polarity mask  */
  68 #define MMC_ANALCTRL_EXTANT     0x01    /* 2.4 Gz External Antenna mask  */
  69
  70 /* MMC read register names */
  71 #define MMC_DCE_STATUS          0x10
  72 #define MMC_CORRECT_NWID_L      0x14
  73 #define MMC_CORRECT_NWID_H      0x15
  74 #define MMC_WRONG_NWID_L        0x16
  75 #define MMC_WRONG_NWID_H        0x17
  76 #define MMC_THR_PRE_SET         0x18
  77 #define MMC_SIGNAL_LVL          0x19
  78 #define MMC_SILENCE_LVL         0x1a
  79 #define MMC_SIGN_QUAL           0x1b
  80 #define MMC_DES_AVAIL           0x09
  81 #define MMC_EECTRLstat          0x20    /* 2.4 Gz  EEPROM r/w/dwld status */
  82 #define MMC_EEDATALrv           0x22    /* 2.4 Gz  EEPROM read value      */
  83 #define MMC_EEDATAHrv           0x23    /* 2.4 Gz  EEPROM read value      */
  84
  85 /* fields in MMC registers that relate to EEPROM in WaveMODEM daughtercard */
  86 #define MMC_EECTRLstat_ID24     0xf0    /* 2.4 Gz  =A0 rev-A, =B0 rev-B   */
  87 #define MMC_EECTRLstat_DWLD     0x08    /* 2.4 Gz  Synth/Tx-Pwr DWLD busy */
  88 #define MMC_EECTRLstat_EEBUSY   0x04    /* 2.4 Gz  EEPROM busy            */
  89
  90 /* additional socket ioctl params for wl card
  91  * see sys/sockio.h for numbers.  The 2nd params here
  92  * must be greater than any values in sockio.h
  93  */
  94
  95 #define SIOCGWLCNWID    _IOWR('i', 60, struct ifreq)    /* get wlan current nwid */
  96 #define SIOCSWLCNWID    _IOWR('i', 61, struct ifreq)    /* set wlan current nwid */
  97 #define SIOCGWLPSA      _IOWR('i', 62, struct ifreq)    /* get wlan PSA (all) */
  98 #define SIOCSWLPSA      _IOWR('i', 63, struct ifreq)    /* set wlan PSA (all) */
  99 #define SIOCDWLCACHE    _IOW('i',  64, struct ifreq)    /* clear SNR cache    */
 100 #define SIOCSWLTHR      _IOW('i',  65, struct ifreq)    /* set new quality threshold */
 101 #define SIOCGWLEEPROM   _IOWR('i', 66, struct ifreq)    /* get modem EEPROM   */
 102 #define SIOCGWLCACHE    _IOWR('i', 67, struct ifreq)    /* get SNR cache */
 103 #define SIOCGWLCITEM    _IOWR('i', 68, struct ifreq)    /* get cache element count */
 104
 105 /* PSA address definitions */
 106 #define WLPSA_ID                0x0     /* ID byte (0 for ISA, 0x14 for MCA) */
 107 #define WLPSA_IO1               0x1     /* I/O address 1 */
 108 #define WLPSA_IO2               0x2     /* I/O address 2 */
 109 #define WLPSA_IO3               0x3     /* I/O address 3 */
 110 #define WLPSA_BR1               0x4     /* Bootrom address 1 */
 111 #define WLPSA_BR2               0x5     /* Bootrom address 2 */
 112 #define WLPSA_BR3               0x6     /* Bootrom address 3 */
 113 #define WLPSA_HWCONF            0x7     /* HW config bits */
 114 #define WLPSA_IRQNO             0x8     /* IRQ value */
 115 #define WLPSA_UNIMAC            0x10    /* Universal MAC address */
 116 #define WLPSA_LOCALMAC          0x16    /* Locally configured MAC address */
 117 #define WLPSA_MACSEL            0x1c    /* MAC selector */
 118 #define WLPSA_COMPATNO          0x1d    /* compatibility number */
 119 #define WLPSA_THRESH            0x1e    /* RF modem threshold preset */
 120 #define WLPSA_FEATSEL           0x1f    /* feature select */
 121 #define WLPSA_SUBBAND           0x20    /* subband selector */
 122 #define WLPSA_QUALTHRESH        0x21    /* RF modem quality threshold preset */
 123 #define WLPSA_HWVERSION         0x22    /* hardware version indicator */
 124 #define WLPSA_NWID              0x23    /* network ID */
 125 #define WLPSA_NWIDENABLE        0x24    /* network ID enable */
 126 #define WLPSA_SECURITY          0x25    /* datalink security enable */
 127 #define WLPSA_DESKEY            0x26    /* datalink security DES key */
 128 #define WLPSA_DBWIDTH           0x2f    /* databus width select */
 129 #define WLPSA_CALLCODE          0x30    /* call code (japan only) */
 130 #define WLPSA_CONFIGURED        0x3c    /* configuration status */
 131 #define WLPSA_CRCLOW            0x3d    /* CRC-16 (lowbyte) */
 132 #define WLPSA_CRCHIGH           0x3e    /*        (highbyte) */
 133 #define WLPSA_CRCOK             0x3f    /* CRC OK flag */
 134
 135 #define WLPSA_COMPATNO_WL24B    0x04    /* 2.4 Gz WaveMODEM ISA rev-B  */
 136
 137 /*
 138  * signal strength cache
 139  *
 140  * driver (wlp only at the moment) keeps cache of last
 141  * IP (only) packets to arrive including signal strength info.
 142  * daemons may read this with kvm.  See if_wlp.c for globals
 143  * that may be accessed through kvm.
 144  *
 145  * Each entry in the w_sigcache has a unique macsrc and age.
 146  * Each entry is identified by its macsrc field.
 147  * Age of the packet is identified by its age field.
 148  */
 149
 150 #define  MAXCACHEITEMS  10
 151 #ifndef INT_MAX
 152 #define        INT_MAX         2147483647
 153 #endif
 154 #define  MAX_AGE        (INT_MAX - MAXCACHEITEMS)
 155
 156 /* signal is 7 bits, 0..63, although it doesn't seem to get to 63.
 157  * silence is 7 bits, 0..63
 158  * quality is 4 bits, 0..15
 159  */
 160 struct w_sigcache {
 161         char   macsrc[6]; /* unique MAC address for entry */
 162         int    ipsrc;     /* ip address associated with packet */
 163         int    signal;    /* signal strength of the packet */
 164         int    silence;   /* silence of the packet */
 165         int    quality;   /* quality of the packet */
 166         int    snr;       /* packet has unique age between 1 to MAX_AGE - 1 */
 167 };
 168
 169 #endif /* _CHIPS_WAVELAN_H_ */
 170