1 /* $FreeBSD: src/sys/dev/iwi/if_iwivar.h,v 1.21 2009/05/21 15:30:59 sam Exp $ */ 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 int8_t wr_antsignal; 37 int8_t wr_antnoise; 38 uint8_t wr_antenna; 39 }; 40 41 #define IWI_RX_RADIOTAP_PRESENT \ 42 ((1 << IEEE80211_RADIOTAP_FLAGS) | \ 43 (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 49 struct 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 60 struct 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 71 struct iwi_tx_data { 72 bus_dmamap_t map; 73 struct mbuf *m; 74 struct ieee80211_node *ni; 75 }; 76 77 struct 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 92 struct iwi_rx_data { 93 bus_dmamap_t map; 94 bus_addr_t physaddr; 95 uint32_t reg; 96 struct mbuf *m; 97 }; 98 99 struct iwi_rx_ring { 100 bus_dma_tag_t data_dmat; 101 struct iwi_rx_data *data; 102 int count; 103 int cur; 104 }; 105 106 struct iwi_node { 107 struct ieee80211_node in_node; 108 int in_station; 109 #define IWI_MAX_IBSSNODE 32 110 }; 111 112 struct 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 119 struct 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 127 struct iwi_softc { 128 struct ifnet *sc_ifp; 129 void (*sc_node_free)(struct ieee80211_node *); 130 device_t sc_dev; 131 132 struct lock sc_lock; 133 uint8_t sc_mcast[IEEE80211_ADDR_LEN]; 134 struct devfs_bitmap 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 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_restarttask; /* restart adapter processing */ 194 struct task sc_disassoctask; 195 struct task sc_wmetask; /* set wme parameters */ 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_callout; /* led off timer */ 210 struct callout sc_wdtimer_callout; /* watchdog timer */ 211 struct callout sc_rftimer_callout; /* rfkill timer */ 212 213 int sc_tx_timer; 214 int sc_state_timer; /* firmware state timer */ 215 int sc_busy_timer; /* firmware cmd timer */ 216 217 struct iwi_rx_radiotap_header sc_rxtap; 218 struct iwi_tx_radiotap_header sc_txtap; 219 }; 220 221 #define IWI_STATE_BEGIN(_sc, _state) do { \ 222 KASSERT(_sc->fw_state == IWI_FW_IDLE, \ 223 ("iwi firmware not idle, state %s", iwi_fw_states[_sc->fw_state]));\ 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