1 /* 2 * Copyright (c) 2008-2009 Atheros Communications Inc. 3 * 4 * Permission to use, copy, modify, and/or distribute this software for any 5 * purpose with or without fee is hereby granted, provided that the above 6 * copyright notice and this permission notice appear in all copies. 7 * 8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15 */ 16 17 #ifndef ATH_H 18 #define ATH_H 19 20 #include <linux/etherdevice.h> 21 #include <linux/skbuff.h> 22 #include <linux/if_ether.h> 23 #include <linux/spinlock.h> 24 #include <net/mac80211.h> 25 26 /* 27 * The key cache is used for h/w cipher state and also for 28 * tracking station state such as the current tx antenna. 29 * We also setup a mapping table between key cache slot indices 30 * and station state to short-circuit node lookups on rx. 31 * Different parts have different size key caches. We handle 32 * up to ATH_KEYMAX entries (could dynamically allocate state). 33 */ 34 #define ATH_KEYMAX 128 /* max key cache size we handle */ 35 36 static const u8 ath_bcast_mac[ETH_ALEN] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff}; 37 38 struct ath_ani { 39 bool caldone; 40 unsigned int longcal_timer; 41 unsigned int shortcal_timer; 42 unsigned int resetcal_timer; 43 unsigned int checkani_timer; 44 struct timer_list timer; 45 }; 46 47 struct ath_cycle_counters { 48 u32 cycles; 49 u32 rx_busy; 50 u32 rx_frame; 51 u32 tx_frame; 52 }; 53 54 enum ath_device_state { 55 ATH_HW_UNAVAILABLE, 56 ATH_HW_INITIALIZED, 57 }; 58 59 enum ath_op_flags { 60 ATH_OP_INVALID, 61 ATH_OP_BEACONS, 62 ATH_OP_ANI_RUN, 63 ATH_OP_PRIM_STA_VIF, 64 ATH_OP_HW_RESET, 65 ATH_OP_SCANNING, 66 ATH_OP_MULTI_CHANNEL, 67 }; 68 69 enum ath_bus_type { 70 ATH_PCI, 71 ATH_AHB, 72 ATH_USB, 73 }; 74 75 struct reg_dmn_pair_mapping { 76 u16 reg_domain; 77 u16 reg_5ghz_ctl; 78 u16 reg_2ghz_ctl; 79 }; 80 81 struct ath_regulatory { 82 char alpha2[2]; 83 u16 country_code; 84 u16 max_power_level; 85 u16 current_rd; 86 int16_t power_limit; 87 struct reg_dmn_pair_mapping *regpair; 88 }; 89 90 enum ath_crypt_caps { 91 ATH_CRYPT_CAP_CIPHER_AESCCM = BIT(0), 92 ATH_CRYPT_CAP_MIC_COMBINED = BIT(1), 93 }; 94 95 struct ath_keyval { 96 u8 kv_type; 97 u8 kv_pad; 98 u16 kv_len; 99 u8 kv_val[16]; /* TK */ 100 u8 kv_mic[8]; /* Michael MIC key */ 101 u8 kv_txmic[8]; /* Michael MIC TX key (used only if the hardware 102 * supports both MIC keys in the same key cache entry; 103 * in that case, kv_mic is the RX key) */ 104 }; 105 106 enum ath_cipher { 107 ATH_CIPHER_WEP = 0, 108 ATH_CIPHER_AES_OCB = 1, 109 ATH_CIPHER_AES_CCM = 2, 110 ATH_CIPHER_CKIP = 3, 111 ATH_CIPHER_TKIP = 4, 112 ATH_CIPHER_CLR = 5, 113 ATH_CIPHER_MIC = 127 114 }; 115 116 /** 117 * struct ath_ops - Register read/write operations 118 * 119 * @read: Register read 120 * @multi_read: Multiple register read 121 * @write: Register write 122 * @enable_write_buffer: Enable multiple register writes 123 * @write_flush: flush buffered register writes and disable buffering 124 */ 125 struct ath_ops { 126 unsigned int (*read)(void *, u32 reg_offset); 127 void (*multi_read)(void *, u32 *addr, u32 *val, u16 count); 128 void (*write)(void *, u32 val, u32 reg_offset); 129 void (*enable_write_buffer)(void *); 130 void (*write_flush) (void *); 131 u32 (*rmw)(void *, u32 reg_offset, u32 set, u32 clr); 132 }; 133 134 struct ath_common; 135 struct ath_bus_ops; 136 137 struct ath_common { 138 void *ah; 139 void *priv; 140 struct ieee80211_hw *hw; 141 int debug_mask; 142 enum ath_device_state state; 143 unsigned long op_flags; 144 145 struct ath_ani ani; 146 147 u16 cachelsz; 148 u16 curaid; 149 u8 macaddr[ETH_ALEN]; 150 u8 curbssid[ETH_ALEN]; 151 u8 bssidmask[ETH_ALEN]; 152 153 u32 rx_bufsize; 154 155 u32 keymax; 156 DECLARE_BITMAP(keymap, ATH_KEYMAX); 157 DECLARE_BITMAP(tkip_keymap, ATH_KEYMAX); 158 DECLARE_BITMAP(ccmp_keymap, ATH_KEYMAX); 159 enum ath_crypt_caps crypt_caps; 160 161 unsigned int clockrate; 162 163 spinlock_t cc_lock; 164 struct ath_cycle_counters cc_ani; 165 struct ath_cycle_counters cc_survey; 166 167 struct ath_regulatory regulatory; 168 struct ath_regulatory reg_world_copy; 169 const struct ath_ops *ops; 170 const struct ath_bus_ops *bus_ops; 171 172 bool btcoex_enabled; 173 bool disable_ani; 174 bool bt_ant_diversity; 175 176 int last_rssi; 177 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS]; 178 }; 179 180 struct sk_buff *ath_rxbuf_alloc(struct ath_common *common, 181 u32 len, 182 gfp_t gfp_mask); 183 bool ath_is_mybeacon(struct ath_common *common, struct ieee80211_hdr *hdr); 184 185 void ath_hw_setbssidmask(struct ath_common *common); 186 void ath_key_delete(struct ath_common *common, struct ieee80211_key_conf *key); 187 int ath_key_config(struct ath_common *common, 188 struct ieee80211_vif *vif, 189 struct ieee80211_sta *sta, 190 struct ieee80211_key_conf *key); 191 bool ath_hw_keyreset(struct ath_common *common, u16 entry); 192 void ath_hw_cycle_counters_update(struct ath_common *common); 193 int32_t ath_hw_get_listen_time(struct ath_common *common); 194 195 __printf(3, 4) 196 void ath_printk(const char *level, const struct ath_common *common, 197 const char *fmt, ...); 198 199 #define ath_emerg(common, fmt, ...) \ 200 ath_printk(KERN_EMERG, common, fmt, ##__VA_ARGS__) 201 #define ath_alert(common, fmt, ...) \ 202 ath_printk(KERN_ALERT, common, fmt, ##__VA_ARGS__) 203 #define ath_crit(common, fmt, ...) \ 204 ath_printk(KERN_CRIT, common, fmt, ##__VA_ARGS__) 205 #define ath_err(common, fmt, ...) \ 206 ath_printk(KERN_ERR, common, fmt, ##__VA_ARGS__) 207 #define ath_warn(common, fmt, ...) \ 208 ath_printk(KERN_WARNING, common, fmt, ##__VA_ARGS__) 209 #define ath_notice(common, fmt, ...) \ 210 ath_printk(KERN_NOTICE, common, fmt, ##__VA_ARGS__) 211 #define ath_info(common, fmt, ...) \ 212 ath_printk(KERN_INFO, common, fmt, ##__VA_ARGS__) 213 214 /** 215 * enum ath_debug_level - atheros wireless debug level 216 * 217 * @ATH_DBG_RESET: reset processing 218 * @ATH_DBG_QUEUE: hardware queue management 219 * @ATH_DBG_EEPROM: eeprom processing 220 * @ATH_DBG_CALIBRATE: periodic calibration 221 * @ATH_DBG_INTERRUPT: interrupt processing 222 * @ATH_DBG_REGULATORY: regulatory processing 223 * @ATH_DBG_ANI: adaptive noise immunitive processing 224 * @ATH_DBG_XMIT: basic xmit operation 225 * @ATH_DBG_BEACON: beacon handling 226 * @ATH_DBG_CONFIG: configuration of the hardware 227 * @ATH_DBG_FATAL: fatal errors, this is the default, DBG_DEFAULT 228 * @ATH_DBG_PS: power save processing 229 * @ATH_DBG_HWTIMER: hardware timer handling 230 * @ATH_DBG_BTCOEX: bluetooth coexistance 231 * @ATH_DBG_BSTUCK: stuck beacons 232 * @ATH_DBG_MCI: Message Coexistence Interface, a private protocol 233 * used exclusively for WLAN-BT coexistence starting from 234 * AR9462. 235 * @ATH_DBG_DFS: radar datection 236 * @ATH_DBG_WOW: Wake on Wireless 237 * @ATH_DBG_ANY: enable all debugging 238 * 239 * The debug level is used to control the amount and type of debugging output 240 * we want to see. Each driver has its own method for enabling debugging and 241 * modifying debug level states -- but this is typically done through a 242 * module parameter 'debug' along with a respective 'debug' debugfs file 243 * entry. 244 */ 245 enum ATH_DEBUG { 246 ATH_DBG_RESET = 0x00000001, 247 ATH_DBG_QUEUE = 0x00000002, 248 ATH_DBG_EEPROM = 0x00000004, 249 ATH_DBG_CALIBRATE = 0x00000008, 250 ATH_DBG_INTERRUPT = 0x00000010, 251 ATH_DBG_REGULATORY = 0x00000020, 252 ATH_DBG_ANI = 0x00000040, 253 ATH_DBG_XMIT = 0x00000080, 254 ATH_DBG_BEACON = 0x00000100, 255 ATH_DBG_CONFIG = 0x00000200, 256 ATH_DBG_FATAL = 0x00000400, 257 ATH_DBG_PS = 0x00000800, 258 ATH_DBG_BTCOEX = 0x00001000, 259 ATH_DBG_WMI = 0x00002000, 260 ATH_DBG_BSTUCK = 0x00004000, 261 ATH_DBG_MCI = 0x00008000, 262 ATH_DBG_DFS = 0x00010000, 263 ATH_DBG_WOW = 0x00020000, 264 ATH_DBG_ANY = 0xffffffff 265 }; 266 267 #define ATH_DBG_DEFAULT (ATH_DBG_FATAL) 268 269 #ifdef CONFIG_ATH_DEBUG 270 271 #define ath_dbg(common, dbg_mask, fmt, ...) \ 272 do { \ 273 if ((common)->debug_mask & ATH_DBG_##dbg_mask) \ 274 ath_printk(KERN_DEBUG, common, fmt, ##__VA_ARGS__); \ 275 } while (0) 276 277 #define ATH_DBG_WARN(foo, arg...) WARN(foo, arg) 278 #define ATH_DBG_WARN_ON_ONCE(foo) WARN_ON_ONCE(foo) 279 280 #else 281 282 static inline __attribute__ ((format (printf, 3, 4))) 283 void _ath_dbg(struct ath_common *common, enum ATH_DEBUG dbg_mask, 284 const char *fmt, ...) 285 { 286 } 287 #define ath_dbg(common, dbg_mask, fmt, ...) \ 288 _ath_dbg(common, ATH_DBG_##dbg_mask, fmt, ##__VA_ARGS__) 289 290 #define ATH_DBG_WARN(foo, arg...) do {} while (0) 291 #define ATH_DBG_WARN_ON_ONCE(foo) ({ \ 292 int __ret_warn_once = !!(foo); \ 293 unlikely(__ret_warn_once); \ 294 }) 295 296 #endif /* CONFIG_ATH_DEBUG */ 297 298 /** Returns string describing opmode, or NULL if unknown mode. */ 299 #ifdef CONFIG_ATH_DEBUG 300 const char *ath_opmode_to_string(enum nl80211_iftype opmode); 301 #else 302 static inline const char *ath_opmode_to_string(enum nl80211_iftype opmode) 303 { 304 return "UNKNOWN"; 305 } 306 #endif 307 308 #endif /* ATH_H */ 309