10Sduke/* $FreeBSD: releng/10.3/sys/dev/iwi/if_iwivar.h 264954 2014-04-25 22:19:18Z marius $ */ 22362Sohair 30Sduke/*- 40Sduke * Copyright (c) 2004, 2005 50Sduke * Damien Bergamini <damien.bergamini@free.fr>. All rights reserved. 60Sduke * 70Sduke * Redistribution and use in source and binary forms, with or without 80Sduke * modification, are permitted provided that the following conditions 90Sduke * are met: 100Sduke * 1. Redistributions of source code must retain the above copyright 110Sduke * notice unmodified, this list of conditions, and the following 120Sduke * disclaimer. 130Sduke * 2. Redistributions in binary form must reproduce the above copyright 140Sduke * notice, this list of conditions and the following disclaimer in the 150Sduke * documentation and/or other materials provided with the distribution. 160Sduke * 170Sduke * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 180Sduke * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 192362Sohair * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 202362Sohair * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 212362Sohair * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 220Sduke * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 230Sduke * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 240Sduke * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 250Sduke * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 260Sduke * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 270Sduke * SUCH DAMAGE. 280Sduke */ 290Sduke 300Sdukestruct iwi_rx_radiotap_header { 310Sduke struct ieee80211_radiotap_header wr_ihdr; 320Sduke uint8_t wr_flags; 330Sduke uint8_t wr_rate; 340Sduke uint16_t wr_chan_freq; 350Sduke uint16_t wr_chan_flags; 360Sduke int8_t wr_antsignal; 370Sduke int8_t wr_antnoise; 380Sduke uint8_t wr_antenna; 390Sduke}; 400Sduke 410Sduke#define IWI_RX_RADIOTAP_PRESENT \ 420Sduke ((1 << IEEE80211_RADIOTAP_FLAGS) | \ 430Sduke (1 << IEEE80211_RADIOTAP_RATE) | \ 44 (1 << IEEE80211_RADIOTAP_CHANNEL) | \ 45 (1 << IEEE80211_RADIOTAP_DBM_ANTSIGNAL) | \ 46 (1 << IEEE80211_RADIOTAP_DBM_ANTNOISE) | \ 47 (1 << IEEE80211_RADIOTAP_ANTENNA)) 48 49struct iwi_tx_radiotap_header { 50 struct ieee80211_radiotap_header wt_ihdr; 51 uint8_t wt_flags; 52 uint16_t wt_chan_freq; 53 uint16_t wt_chan_flags; 54}; 55 56#define IWI_TX_RADIOTAP_PRESENT \ 57 ((1 << IEEE80211_RADIOTAP_FLAGS) | \ 58 (1 << IEEE80211_RADIOTAP_CHANNEL)) 59 60struct iwi_cmd_ring { 61 bus_dma_tag_t desc_dmat; 62 bus_dmamap_t desc_map; 63 bus_addr_t physaddr; 64 struct iwi_cmd_desc *desc; 65 int count; 66 int queued; 67 int cur; 68 int next; 69}; 70 71struct iwi_tx_data { 72 bus_dmamap_t map; 73 struct mbuf *m; 74 struct ieee80211_node *ni; 75}; 76 77struct iwi_tx_ring { 78 bus_dma_tag_t desc_dmat; 79 bus_dma_tag_t data_dmat; 80 bus_dmamap_t desc_map; 81 bus_addr_t physaddr; 82 bus_addr_t csr_ridx; 83 bus_addr_t csr_widx; 84 struct iwi_tx_desc *desc; 85 struct iwi_tx_data *data; 86 int count; 87 int queued; 88 int cur; 89 int next; 90}; 91 92struct iwi_rx_data { 93 bus_dmamap_t map; 94 bus_addr_t physaddr; 95 uint32_t reg; 96 struct mbuf *m; 97}; 98 99struct iwi_rx_ring { 100 bus_dma_tag_t data_dmat; 101 struct iwi_rx_data *data; 102 int count; 103 int cur; 104}; 105 106struct iwi_node { 107 struct ieee80211_node in_node; 108 int in_station; 109#define IWI_MAX_IBSSNODE 32 110}; 111 112struct iwi_fw { 113 const struct firmware *fp; /* image handle */ 114 const char *data; /* firmware image data */ 115 size_t size; /* firmware image size */ 116 const char *name; /* associated image name */ 117}; 118 119struct iwi_vap { 120 struct ieee80211vap iwi_vap; 121 122 int (*iwi_newstate)(struct ieee80211vap *, 123 enum ieee80211_state, int); 124}; 125#define IWI_VAP(vap) ((struct iwi_vap *)(vap)) 126 127struct iwi_softc { 128 struct ifnet *sc_ifp; 129 void (*sc_node_free)(struct ieee80211_node *); 130 device_t sc_dev; 131 132 struct mtx sc_mtx; 133 uint8_t sc_mcast[IEEE80211_ADDR_LEN]; 134 struct unrhdr *sc_unr; 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 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 struct task sc_wmetask; /* set wme parameters */ 194 struct task sc_monitortask; 195 196 unsigned int sc_softled : 1, /* enable LED gpio status */ 197 sc_ledstate: 1, /* LED on/off state */ 198 sc_blinking: 1; /* LED blink operation active */ 199 u_int sc_nictype; /* NIC type from EEPROM */ 200 u_int sc_ledpin; /* mask for activity LED */ 201 u_int sc_ledidle; /* idle polling interval */ 202 int sc_ledevent; /* time of last LED event */ 203 u_int8_t sc_rxrate; /* current rx rate for LED */ 204 u_int8_t sc_rxrix; 205 u_int8_t sc_txrate; /* current tx rate for LED */ 206 u_int8_t sc_txrix; 207 u_int16_t sc_ledoff; /* off time for current blink */ 208 struct callout sc_ledtimer; /* led off timer */ 209 struct callout sc_wdtimer; /* watchdog timer */ 210 struct callout sc_rftimer; /* rfkill timer */ 211 212 int sc_tx_timer; 213 int sc_state_timer; /* firmware state timer */ 214 int sc_busy_timer; /* firmware cmd timer */ 215 216 struct iwi_rx_radiotap_header sc_rxtap; 217 struct iwi_tx_radiotap_header sc_txtap; 218}; 219 220#define IWI_STATE_BEGIN(_sc, _state) do { \ 221 KASSERT(_sc->fw_state == IWI_FW_IDLE, \ 222 ("iwi firmware not idle, state %s", iwi_fw_states[_sc->fw_state]));\ 223 _sc->fw_state = _state; \ 224 _sc->sc_state_timer = 5; \ 225 DPRINTF(("enter %s state\n", iwi_fw_states[_state])); \ 226} while (0) 227 228#define IWI_STATE_END(_sc, _state) do { \ 229 if (_sc->fw_state == _state) \ 230 DPRINTF(("exit %s state\n", iwi_fw_states[_state])); \ 231 else \ 232 DPRINTF(("expected %s state, got %s\n", \ 233 iwi_fw_states[_state], iwi_fw_states[_sc->fw_state])); \ 234 _sc->fw_state = IWI_FW_IDLE; \ 235 wakeup(_sc); \ 236 _sc->sc_state_timer = 0; \ 237} while (0) 238/* 239 * NB.: This models the only instance of async locking in iwi_init_locked 240 * and must be kept in sync. 241 */ 242#define IWI_LOCK_INIT(sc) \ 243 mtx_init(&(sc)->sc_mtx, device_get_nameunit((sc)->sc_dev), \ 244 MTX_NETWORK_LOCK, MTX_DEF) 245#define IWI_LOCK_DESTROY(sc) mtx_destroy(&(sc)->sc_mtx) 246#define IWI_LOCK_DECL int __waslocked = 0 247#define IWI_LOCK_ASSERT(sc) mtx_assert(&(sc)->sc_mtx, MA_OWNED) 248#define IWI_LOCK(sc) do { \ 249 if (!(__waslocked = mtx_owned(&(sc)->sc_mtx))) \ 250 mtx_lock(&(sc)->sc_mtx); \ 251} while (0) 252#define IWI_UNLOCK(sc) do { \ 253 if (!__waslocked) \ 254 mtx_unlock(&(sc)->sc_mtx); \ 255} while (0) 256