if_iwivar.h revision 191746
1/* $FreeBSD: head/sys/dev/iwi/if_iwivar.h 191746 2009-05-02 15:14:18Z thompsa $ */ 2 3/*- 4 * Copyright (c) 2004, 2005 5 * Damien Bergamini <damien.bergamini@free.fr>. 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 unmodified, this list of conditions, and the following 12 * disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30struct iwi_rx_radiotap_header { 31 struct ieee80211_radiotap_header wr_ihdr; 32 uint8_t wr_flags; 33 uint8_t wr_rate; 34 uint16_t wr_chan_freq; 35 uint16_t wr_chan_flags; 36 uint8_t wr_antsignal; 37 uint8_t wr_antenna; 38}; 39 40#define IWI_RX_RADIOTAP_PRESENT \ 41 ((1 << IEEE80211_RADIOTAP_FLAGS) | \ 42 (1 << IEEE80211_RADIOTAP_RATE) | \ 43 (1 << IEEE80211_RADIOTAP_CHANNEL) | \ 44 (1 << IEEE80211_RADIOTAP_DB_ANTSIGNAL) | \ 45 (1 << IEEE80211_RADIOTAP_ANTENNA)) 46 47struct iwi_tx_radiotap_header { 48 struct ieee80211_radiotap_header wt_ihdr; 49 uint8_t wt_flags; 50 uint16_t wt_chan_freq; 51 uint16_t wt_chan_flags; 52}; 53 54#define IWI_TX_RADIOTAP_PRESENT \ 55 ((1 << IEEE80211_RADIOTAP_FLAGS) | \ 56 (1 << IEEE80211_RADIOTAP_CHANNEL)) 57 58struct iwi_cmd_ring { 59 bus_dma_tag_t desc_dmat; 60 bus_dmamap_t desc_map; 61 bus_addr_t physaddr; 62 struct iwi_cmd_desc *desc; 63 int count; 64 int queued; 65 int cur; 66 int next; 67}; 68 69struct iwi_tx_data { 70 bus_dmamap_t map; 71 struct mbuf *m; 72 struct ieee80211_node *ni; 73}; 74 75struct iwi_tx_ring { 76 bus_dma_tag_t desc_dmat; 77 bus_dma_tag_t data_dmat; 78 bus_dmamap_t desc_map; 79 bus_addr_t physaddr; 80 bus_addr_t csr_ridx; 81 bus_addr_t csr_widx; 82 struct iwi_tx_desc *desc; 83 struct iwi_tx_data *data; 84 int count; 85 int queued; 86 int cur; 87 int next; 88}; 89 90struct iwi_rx_data { 91 bus_dmamap_t map; 92 bus_addr_t physaddr; 93 uint32_t reg; 94 struct mbuf *m; 95}; 96 97struct iwi_rx_ring { 98 bus_dma_tag_t data_dmat; 99 struct iwi_rx_data *data; 100 int count; 101 int cur; 102}; 103 104struct iwi_node { 105 struct ieee80211_node in_node; 106 int in_station; 107#define IWI_MAX_IBSSNODE 32 108}; 109 110struct iwi_fw { 111 const struct firmware *fp; /* image handle */ 112 const char *data; /* firmware image data */ 113 size_t size; /* firmware image size */ 114 const char *name; /* associated image name */ 115}; 116 117struct iwi_vap { 118 struct ieee80211vap iwi_vap; 119 120 int (*iwi_newstate)(struct ieee80211vap *, 121 enum ieee80211_state, int); 122}; 123#define IWI_VAP(vap) ((struct iwi_vap *)(vap)) 124 125struct iwi_softc { 126 struct ifnet *sc_ifp; 127 void (*sc_node_free)(struct ieee80211_node *); 128 device_t sc_dev; 129 130 struct mtx sc_mtx; 131 uint8_t sc_mcast[IEEE80211_ADDR_LEN]; 132 struct unrhdr *sc_unr; 133 134 uint32_t flags; 135#define IWI_FLAG_FW_INITED (1 << 0) 136#define IWI_FLAG_BUSY (1 << 3) /* busy sending a command */ 137#define IWI_FLAG_ASSOCIATED (1 << 4) /* currently associated */ 138#define IWI_FLAG_CHANNEL_SCAN (1 << 5) 139 uint32_t fw_state; 140#define IWI_FW_IDLE 0 141#define IWI_FW_LOADING 1 142#define IWI_FW_ASSOCIATING 2 143#define IWI_FW_DISASSOCIATING 3 144#define IWI_FW_SCANNING 4 145 struct iwi_cmd_ring cmdq; 146 struct iwi_tx_ring txq[WME_NUM_AC]; 147 struct iwi_rx_ring rxq; 148 149 struct resource *irq; 150 struct resource *mem; 151 bus_space_tag_t sc_st; 152 bus_space_handle_t sc_sh; 153 void *sc_ih; 154 int mem_rid; 155 int irq_rid; 156 157 /* 158 * The card needs external firmware images to work, which is made of a 159 * bootloader, microcode and firmware proper. In version 3.00 and 160 * above, all pieces are contained in a single image, preceded by a 161 * struct iwi_firmware_hdr indicating the size of the 3 pieces. 162 * Old firmware < 3.0 has separate boot and ucode, so we need to 163 * load all of them explicitly. 164 * To avoid issues related to fragmentation, we keep the block of 165 * dma-ble memory around until detach time, and reallocate it when 166 * it becomes too small. fw_dma_size is the size currently allocated. 167 */ 168 int fw_dma_size; 169 uint32_t fw_flags; /* allocation status */ 170#define IWI_FW_HAVE_DMAT 0x01 171#define IWI_FW_HAVE_MAP 0x02 172#define IWI_FW_HAVE_PHY 0x04 173 bus_dma_tag_t fw_dmat; 174 bus_dmamap_t fw_map; 175 bus_addr_t fw_physaddr; 176 void *fw_virtaddr; 177 enum ieee80211_opmode fw_mode; /* mode of current firmware */ 178 struct iwi_fw fw_boot; /* boot firmware */ 179 struct iwi_fw fw_uc; /* microcode */ 180 struct iwi_fw fw_fw; /* operating mode support */ 181 182 int curchan; /* current h/w channel # */ 183 int antenna; 184 int bluetooth; 185 struct iwi_associate assoc; 186 struct iwi_wme_params wme[3]; 187 u_int sc_scangen; 188 189 struct task sc_radiontask; /* radio on processing */ 190 struct task sc_radiofftask; /* radio off processing */ 191 struct task sc_restarttask; /* restart adapter processing */ 192 struct task sc_disassoctask; 193 194 unsigned int sc_softled : 1, /* enable LED gpio status */ 195 sc_ledstate: 1, /* LED on/off state */ 196 sc_blinking: 1; /* LED blink operation active */ 197 u_int sc_nictype; /* NIC type from EEPROM */ 198 u_int sc_ledpin; /* mask for activity LED */ 199 u_int sc_ledidle; /* idle polling interval */ 200 int sc_ledevent; /* time of last LED event */ 201 u_int8_t sc_rxrate; /* current rx rate for LED */ 202 u_int8_t sc_rxrix; 203 u_int8_t sc_txrate; /* current tx rate for LED */ 204 u_int8_t sc_txrix; 205 u_int16_t sc_ledoff; /* off time for current blink */ 206 struct callout sc_ledtimer; /* led off timer */ 207 struct callout sc_wdtimer; /* watchdog timer */ 208 struct callout sc_rftimer; /* rfkill timer */ 209 210 int sc_tx_timer; 211 int sc_state_timer; /* firmware state timer */ 212 int sc_busy_timer; /* firmware cmd timer */ 213 214 struct iwi_rx_radiotap_header sc_rxtap; 215 int sc_rxtap_len; 216 217 struct iwi_tx_radiotap_header sc_txtap; 218 int sc_txtap_len; 219}; 220 221#define IWI_STATE_BEGIN(_sc, _state) do { \ 222 KASSERT(_sc->fw_state == IWI_FW_IDLE, \ 223 ("iwi firmware not idle")); \ 224 _sc->fw_state = _state; \ 225 _sc->sc_state_timer = 5; \ 226 DPRINTF(("enter %s state\n", iwi_fw_states[_state])); \ 227} while (0) 228 229#define IWI_STATE_END(_sc, _state) do { \ 230 if (_sc->fw_state == _state) \ 231 DPRINTF(("exit %s state\n", iwi_fw_states[_state])); \ 232 else \ 233 DPRINTF(("expected %s state, got %s\n", \ 234 iwi_fw_states[_state], iwi_fw_states[_sc->fw_state])); \ 235 _sc->fw_state = IWI_FW_IDLE; \ 236 wakeup(_sc); \ 237 _sc->sc_state_timer = 0; \ 238} while (0) 239/* 240 * NB.: This models the only instance of async locking in iwi_init_locked 241 * and must be kept in sync. 242 */ 243#define IWI_LOCK_INIT(sc) \ 244 mtx_init(&(sc)->sc_mtx, device_get_nameunit((sc)->sc_dev), \ 245 MTX_NETWORK_LOCK, MTX_DEF) 246#define IWI_LOCK_DESTROY(sc) mtx_destroy(&(sc)->sc_mtx) 247#define IWI_LOCK_DECL int __waslocked = 0 248#define IWI_LOCK_ASSERT(sc) mtx_assert(&(sc)->sc_mtx, MA_OWNED) 249#define IWI_LOCK(sc) do { \ 250 if (!(__waslocked = mtx_owned(&(sc)->sc_mtx))) \ 251 mtx_lock(&(sc)->sc_mtx); \ 252} while (0) 253#define IWI_UNLOCK(sc) do { \ 254 if (!__waslocked) \ 255 mtx_unlock(&(sc)->sc_mtx); \ 256} while (0) 257