sys/dev/netif/wi/if_wivar.h

   1 /*-
   2  * Copyright (c) 2002
   3  *      M Warner Losh <imp@freebsd.org>.  All rights reserved.
   4  * Copyright (c) 1997, 1998, 1999
   5  *      Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. All advertising materials mentioning features or use of this software
  16  *    must display the following acknowledgement:
  17  *      This product includes software developed by Bill Paul.
  18  * 4. Neither the name of the author nor the names of any co-contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  32  * THE POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  * $FreeBSD: head/sys/dev/wi/if_wivar.h 194023 2009-06-11 17:14:28Z avg $
  35  */
  36
  37 /*
  38  * Encryption controls. We can enable or disable encryption as
  39  * well as specify up to 4 encryption keys. We can also specify
  40  * which of the four keys will be used for transmit encryption.
  41  */
  42 #define WI_RID_ENCRYPTION       0xFC20
  43 #define WI_RID_AUTHTYPE         0xFC21
  44 #define WI_RID_DEFLT_CRYPT_KEYS 0xFCB0
  45 #define WI_RID_TX_CRYPT_KEY     0xFCB1
  46 #define WI_RID_WEP_AVAIL        0xFD4F
  47 #define WI_RID_P2_TX_CRYPT_KEY  0xFC23
  48 #define WI_RID_P2_CRYPT_KEY0    0xFC24
  49 #define WI_RID_P2_CRYPT_KEY1    0xFC25
  50 #define WI_RID_MICROWAVE_OVEN   0xFC25
  51 #define WI_RID_P2_CRYPT_KEY2    0xFC26
  52 #define WI_RID_P2_CRYPT_KEY3    0xFC27
  53 #define WI_RID_P2_ENCRYPTION    0xFC28
  54 #define WI_RID_ROAMING_MODE     0xFC2D
  55 #define WI_RID_CUR_TX_RATE      0xFD44 /* current TX rate */
  56
  57 #define WI_MAX_AID              256     /* max stations for ap operation */
  58
  59 struct wi_vap {
  60         struct ieee80211vap     wv_vap;
  61         struct ieee80211_beacon_offsets wv_bo;
  62
  63         void            (*wv_recv_mgmt)(struct ieee80211_node *, struct mbuf *,
  64                             int, int, int);
  65         int             (*wv_newstate)(struct ieee80211vap *,
  66                             enum ieee80211_state, int);
  67 };
  68 #define WI_VAP(vap)             ((struct wi_vap *)(vap))
  69
  70 struct wi_softc {
  71         struct arpcom           arpcom;
  72         struct ifnet            *sc_ifp;
  73         device_t                sc_dev;
  74         struct lock             sc_lock;
  75         struct callout          sc_watchdog;
  76         int                     sc_unit;
  77         int                     wi_gone;
  78         int                     sc_enabled;
  79         int                     sc_reset;
  80         int                     sc_firmware_type;
  81 #define WI_NOTYPE       0
  82 #define WI_LUCENT       1
  83 #define WI_INTERSIL     2
  84 #define WI_SYMBOL       3
  85         int                     sc_pri_firmware_ver;    /* Primary firmware */
  86         int                     sc_sta_firmware_ver;    /* Station firmware */
  87         unsigned int            sc_nic_id;              /* Type of NIC */
  88         char *                  sc_nic_name;
  89
  90         int                     wi_bus_type;    /* Bus attachment type */
  91         struct resource *       local;
  92         int                     local_rid;
  93         struct resource *       iobase;
  94         int                     iobase_rid;
  95         struct resource *       irq;
  96         int                     irq_rid;
  97         struct resource *       mem;
  98         int                     mem_rid;
  99         bus_space_handle_t      wi_localhandle;
 100         bus_space_tag_t         wi_localtag;
 101         bus_space_handle_t      wi_bhandle;
 102         bus_space_tag_t         wi_btag;
 103         bus_space_handle_t      wi_bmemhandle;
 104         bus_space_tag_t         wi_bmemtag;
 105         void *                  wi_intrhand;
 106         struct ieee80211_channel *wi_channel;
 107         int                     wi_io_addr;
 108         int                     wi_cmd_count;
 109
 110         int                     sc_flags;
 111         int                     sc_if_flags;
 112         int                     sc_bap_id;
 113         int                     sc_bap_off;
 114
 115         int                     sc_porttype;
 116         u_int16_t               sc_portnum;
 117         u_int16_t               sc_encryption;
 118         u_int16_t               sc_monitor_port;
 119
 120         /* RSSI interpretation */
 121         u_int16_t               sc_min_rssi;    /* clamp sc_min_rssi < RSSI */
 122         u_int16_t               sc_max_rssi;    /* clamp RSSI < sc_max_rssi */
 123         u_int16_t               sc_dbm_offset;  /* dBm ~ RSSI - sc_dbm_offset */
 124
 125         int                     sc_buflen;              /* TX buffer size */
 126         int                     sc_ntxbuf;
 127 #define WI_NTXBUF       3
 128         struct {
 129                 int             d_fid;
 130                 int             d_len;
 131         }                       sc_txd[WI_NTXBUF];      /* TX buffers */
 132         int                     sc_txnext;              /* index of next TX */
 133         int                     sc_txcur;               /* index of current TX*/
 134         int                     sc_tx_timer;
 135
 136         struct wi_counters      sc_stats;
 137         u_int16_t               sc_ibss_port;
 138
 139         struct timeval          sc_last_syn;
 140         int                     sc_false_syns;
 141
 142         u_int16_t               sc_txbuf[IEEE80211_MAX_LEN/2];
 143
 144         struct wi_tx_radiotap_header sc_tx_th;
 145         struct wi_rx_radiotap_header sc_rx_th;
 146
 147         struct sysctl_ctx_list  sc_sysctl_ctx;
 148 };
 149
 150 /* maximum consecutive false change-of-BSSID indications */
 151 #define WI_MAX_FALSE_SYNS               10
 152
 153 #define WI_FLAGS_HAS_ENHSECURITY        0x0001
 154 #define WI_FLAGS_HAS_WPASUPPORT         0x0002
 155 #define WI_FLAGS_HAS_ROAMING            0x0020
 156 #define WI_FLAGS_HAS_FRAGTHR            0x0200
 157 #define WI_FLAGS_HAS_DBMADJUST          0x0400
 158
 159 struct wi_card_ident {
 160         u_int16_t       card_id;
 161         char            *card_name;
 162         u_int8_t        firm_type;
 163 };
 164
 165 #define WI_PRISM_MIN_RSSI       0x1b
 166 #define WI_PRISM_MAX_RSSI       0x9a
 167 #define WI_PRISM_DBM_OFFSET     100 /* XXX */
 168
 169 #define WI_LUCENT_MIN_RSSI      47
 170 #define WI_LUCENT_MAX_RSSI      138
 171 #define WI_LUCENT_DBM_OFFSET    149
 172
 173 #define WI_RSSI_TO_DBM(sc, rssi) (MIN((sc)->sc_max_rssi, \
 174     MAX((sc)->sc_min_rssi, (rssi))) - (sc)->sc_dbm_offset)
 175
 176 #define WI_LOCK(_sc)            lockmgr(&(_sc)->sc_lock, LK_EXCLUSIVE)
 177 #define WI_UNLOCK(_sc)          lockmgr(&(_sc)->sc_lock, LK_RELEASE)
 178 #define WI_LOCK_ASSERT(_sc)     \
 179     KKASSERT(lockstatus(&(_sc)->sc_lock, curthread) == LK_EXCLUSIVE)
 180
 181 int     wi_attach(device_t);
 182 int     wi_detach(device_t);
 183 int     wi_shutdown(device_t);
 184 int     wi_alloc(device_t, int);
 185 void    wi_free(device_t);
 186 extern devclass_t wi_devclass;
 187 void    wi_init(void *);
 188 void    wi_intr(void *);
 189 int     wi_mgmt_xmit(struct wi_softc *, caddr_t, int);
 190 void    wi_stop(struct wi_softc *, int);