1 /* $FreeBSD$ */ 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 30 struct 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 47 struct 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 58 struct 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 69 struct iwi_tx_data { 70 bus_dmamap_t map; 71 struct mbuf *m; 72 struct ieee80211_node *ni; 73 }; 74 75 struct 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 90 struct iwi_rx_data { 91 bus_dmamap_t map; 92 bus_addr_t physaddr; 93 uint32_t reg; 94 struct mbuf *m; 95 }; 96 97 struct iwi_rx_ring { 98 bus_dma_tag_t data_dmat; 99 struct iwi_rx_data *data; 100 int count; 101 int cur; 102 }; 103 104 struct iwi_node { 105 struct ieee80211_node in_node; 106 int in_station; 107 #define IWI_MAX_IBSSNODE 32 108 }; 109 110 struct 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 117 struct iwi_softc { 118 struct ifnet *sc_ifp; 119 struct ieee80211com sc_ic; 120 int (*sc_newstate)(struct ieee80211com *, 121 enum ieee80211_state, int); 122 void (*sc_node_free)(struct ieee80211_node *); 123 device_t sc_dev; 124 125 struct mtx sc_mtx; 126 struct mtx sc_cmdlock; 127 char sc_cmdname[12]; /* e.g. "iwi0_cmd" */ 128 uint8_t sc_mcast[IEEE80211_ADDR_LEN]; 129 struct unrhdr *sc_unr; 130 struct taskqueue *sc_tq; /* private task queue */ 131 struct taskqueue *sc_tq2; /* reset task queue */ 132 #if __FreeBSD_version < 700000 133 struct proc *sc_tqproc; 134 #endif 135 136 uint32_t flags; 137 #define IWI_FLAG_FW_INITED (1 << 0) 138 #define IWI_FLAG_BUSY (1 << 3) /* busy sending a command */ 139 #define IWI_FLAG_ASSOCIATED (1 << 4) /* currently associated */ 140 #define IWI_FLAG_CHANNEL_SCAN (1 << 5) 141 uint32_t fw_state; 142 #define IWI_FW_IDLE 0 143 #define IWI_FW_LOADING 1 144 #define IWI_FW_ASSOCIATING 2 145 #define IWI_FW_DISASSOCIATING 3 146 #define IWI_FW_SCANNING 4 147 struct iwi_cmd_ring cmdq; 148 struct iwi_tx_ring txq[WME_NUM_AC]; 149 struct iwi_rx_ring rxq; 150 151 struct resource *irq; 152 struct resource *mem; 153 bus_space_tag_t sc_st; 154 bus_space_handle_t sc_sh; 155 void *sc_ih; 156 int mem_rid; 157 int irq_rid; 158 159 /* 160 * The card needs external firmware images to work, which is made of a 161 * bootloader, microcode and firmware proper. In version 3.00 and 162 * above, all pieces are contained in a single image, preceded by a 163 * struct iwi_firmware_hdr indicating the size of the 3 pieces. 164 * Old firmware < 3.0 has separate boot and ucode, so we need to 165 * load all of them explicitly. 166 * To avoid issues related to fragmentation, we keep the block of 167 * dma-ble memory around until detach time, and reallocate it when 168 * it becomes too small. fw_dma_size is the size currently allocated. 169 */ 170 int fw_dma_size; 171 uint32_t fw_flags; /* allocation status */ 172 #define IWI_FW_HAVE_DMAT 0x01 173 #define IWI_FW_HAVE_MAP 0x02 174 #define IWI_FW_HAVE_PHY 0x04 175 bus_dma_tag_t fw_dmat; 176 bus_dmamap_t fw_map; 177 bus_addr_t fw_physaddr; 178 void *fw_virtaddr; 179 enum ieee80211_opmode fw_mode; /* mode of current firmware */ 180 struct iwi_fw fw_boot; /* boot firmware */ 181 struct iwi_fw fw_uc; /* microcode */ 182 struct iwi_fw fw_fw; /* operating mode support */ 183 184 int curchan; /* current h/w channel # */ 185 int antenna; 186 int bluetooth; 187 struct iwi_associate assoc; 188 struct iwi_wme_params wme[3]; 189 u_int sc_scangen; 190 191 struct task sc_radiontask; /* radio on processing */ 192 struct task sc_radiofftask; /* radio off processing */ 193 struct task sc_scanaborttask; /* cancel active scan */ 194 struct task sc_restarttask; /* restart adapter processing */ 195 struct task sc_opstask; /* scan / auth processing */ 196 197 unsigned int sc_softled : 1, /* enable LED gpio status */ 198 sc_ledstate: 1, /* LED on/off state */ 199 sc_blinking: 1; /* LED blink operation active */ 200 u_int sc_nictype; /* NIC type from EEPROM */ 201 u_int sc_ledpin; /* mask for activity LED */ 202 u_int sc_ledidle; /* idle polling interval */ 203 int sc_ledevent; /* time of last LED event */ 204 u_int8_t sc_rxrate; /* current rx rate for LED */ 205 u_int8_t sc_rxrix; 206 u_int8_t sc_txrate; /* current tx rate for LED */ 207 u_int8_t sc_txrix; 208 u_int16_t sc_ledoff; /* off time for current blink */ 209 struct callout sc_ledtimer; /* led off timer */ 210 struct callout sc_wdtimer; /* watchdog timer */ 211 212 int sc_tx_timer; 213 int sc_rfkill_timer;/* poll for rfkill change */ 214 int sc_state_timer; /* firmware state timer */ 215 int sc_busy_timer; /* firmware cmd timer */ 216 217 #define IWI_SCAN_START (1 << 0) 218 #define IWI_SET_CHANNEL (1 << 1) 219 #define IWI_SCAN_END (1 << 2) 220 #define IWI_ASSOC (1 << 3) 221 #define IWI_DISASSOC (1 << 4) 222 #define IWI_SCAN_CURCHAN (1 << 5) 223 #define IWI_SCAN_ALLCHAN (1 << 6) 224 #define IWI_SET_WME (1 << 7) 225 #define IWI_CMD_MAXOPS 10 226 int sc_cmd[IWI_CMD_MAXOPS]; 227 int sc_cmd_cur; /* current queued scan task */ 228 int sc_cmd_next; /* last queued scan task */ 229 unsigned long sc_maxdwell; /* max dwell time for curchan */ 230 struct bpf_if *sc_drvbpf; 231 232 union { 233 struct iwi_rx_radiotap_header th; 234 uint8_t pad[64]; 235 } sc_rxtapu; 236 #define sc_rxtap sc_rxtapu.th 237 int sc_rxtap_len; 238 239 union { 240 struct iwi_tx_radiotap_header th; 241 uint8_t pad[64]; 242 } sc_txtapu; 243 #define sc_txtap sc_txtapu.th 244 int sc_txtap_len; 245 }; 246 247 #define IWI_STATE_BEGIN(_sc, _state) do { \ 248 KASSERT(_sc->fw_state == IWI_FW_IDLE, \ 249 ("iwi firmware not idle")); \ 250 _sc->fw_state = _state; \ 251 _sc->sc_state_timer = 5; \ 252 DPRINTF(("enter FW state %d\n", _state)); \ 253 } while (0) 254 255 #define IWI_STATE_END(_sc, _state) do { \ 256 if (_sc->fw_state == _state) \ 257 DPRINTF(("exit FW state %d\n", _state)); \ 258 else \ 259 DPRINTF(("expected FW state %d, got %d\n", \ 260 _state, _sc->fw_state)); \ 261 _sc->fw_state = IWI_FW_IDLE; \ 262 wakeup(_sc); \ 263 _sc->sc_state_timer = 0; \ 264 } while (0) 265 /* 266 * NB.: This models the only instance of async locking in iwi_init_locked 267 * and must be kept in sync. 268 */ 269 #define IWI_LOCK_INIT(sc) \ 270 mtx_init(&(sc)->sc_mtx, device_get_nameunit((sc)->sc_dev), \ 271 MTX_NETWORK_LOCK, MTX_DEF) 272 #define IWI_LOCK_DESTROY(sc) mtx_destroy(&(sc)->sc_mtx) 273 #define IWI_LOCK_DECL int __waslocked = 0 274 #define IWI_LOCK_ASSERT(sc) mtx_assert(&(sc)->sc_mtx, MA_OWNED) 275 #define IWI_LOCK(sc) do { \ 276 if (!(__waslocked = mtx_owned(&(sc)->sc_mtx))) \ 277 mtx_lock(&(sc)->sc_mtx); \ 278 } while (0) 279 #define IWI_UNLOCK(sc) do { \ 280 if (!__waslocked) \ 281 mtx_unlock(&(sc)->sc_mtx); \ 282 } while (0) 283 #define IWI_CMD_LOCK_INIT(sc) do { \ 284 snprintf((sc)->sc_cmdname, sizeof((sc)->sc_cmdname), "%s_cmd", \ 285 device_get_nameunit((sc)->sc_dev)); \ 286 mtx_init(&(sc)->sc_cmdlock, (sc)->sc_cmdname, NULL, MTX_DEF); \ 287 } while (0) 288 #define IWI_CMD_LOCK_DESTROY(sc) mtx_destroy(&(sc)->sc_cmdlock) 289 #define IWI_CMD_LOCK(sc) mtx_lock(&(sc)->sc_cmdlock) 290 #define IWI_CMD_UNLOCK(sc) mtx_unlock(&(sc)->sc_cmdlock) 291