drivers/net/wireless/ath/ath.h

   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/skbuff.h>
  21 #include <linux/if_ether.h>
  22 #include <net/mac80211.h>
  23
  24 /*
  25  * The key cache is used for h/w cipher state and also for
  26  * tracking station state such as the current tx antenna.
  27  * We also setup a mapping table between key cache slot indices
  28  * and station state to short-circuit node lookups on rx.
  29  * Different parts have different size key caches.  We handle
  30  * up to ATH_KEYMAX entries (could dynamically allocate state).
  31  */
  32 #define ATH_KEYMAX              128     /* max key cache size we handle */
  33
  34 static const u8 ath_bcast_mac[ETH_ALEN] = {0xff, 0xff, 0xff, 0xff, 0xff, 0xff};
  35
  36 struct ath_ani {
  37         bool caldone;
  38         unsigned int longcal_timer;
  39         unsigned int shortcal_timer;
  40         unsigned int resetcal_timer;
  41         unsigned int checkani_timer;
  42         struct timer_list timer;
  43 };
  44
  45 enum ath_device_state {
  46         ATH_HW_UNAVAILABLE,
  47         ATH_HW_INITIALIZED,
  48 };
  49
  50 enum ath_bus_type {
  51         ATH_PCI,
  52         ATH_AHB,
  53         ATH_USB,
  54 };
  55
  56 struct reg_dmn_pair_mapping {
  57         u16 regDmnEnum;
  58         u16 reg_5ghz_ctl;
  59         u16 reg_2ghz_ctl;
  60 };
  61
  62 struct ath_regulatory {
  63         char alpha2[2];
  64         u16 country_code;
  65         u16 max_power_level;
  66         u32 tp_scale;
  67         u16 current_rd;
  68         u16 current_rd_ext;
  69         int16_t power_limit;
  70         struct reg_dmn_pair_mapping *regpair;
  71 };
  72
  73 enum ath_crypt_caps {
  74         ATH_CRYPT_CAP_CIPHER_AESCCM             = BIT(0),
  75         ATH_CRYPT_CAP_MIC_COMBINED              = BIT(1),
  76 };
  77
  78 struct ath_keyval {
  79         u8 kv_type;
  80         u8 kv_pad;
  81         u16 kv_len;
  82         u8 kv_val[16]; /* TK */
  83         u8 kv_mic[8]; /* Michael MIC key */
  84         u8 kv_txmic[8]; /* Michael MIC TX key (used only if the hardware
  85                          * supports both MIC keys in the same key cache entry;
  86                          * in that case, kv_mic is the RX key) */
  87 };
  88
  89 enum ath_cipher {
  90         ATH_CIPHER_WEP = 0,
  91         ATH_CIPHER_AES_OCB = 1,
  92         ATH_CIPHER_AES_CCM = 2,
  93         ATH_CIPHER_CKIP = 3,
  94         ATH_CIPHER_TKIP = 4,
  95         ATH_CIPHER_CLR = 5,
  96         ATH_CIPHER_MIC = 127
  97 };
  98
  99 /**
 100  * struct ath_ops - Register read/write operations
 101  *
 102  * @read: Register read
 103  * @write: Register write
 104  * @enable_write_buffer: Enable multiple register writes
 105  * @disable_write_buffer: Disable multiple register writes
 106  * @write_flush: Flush buffered register writes
 107  */
 108 struct ath_ops {
 109         unsigned int (*read)(void *, u32 reg_offset);
 110         void (*write)(void *, u32 val, u32 reg_offset);
 111         void (*enable_write_buffer)(void *);
 112         void (*disable_write_buffer)(void *);
 113         void (*write_flush) (void *);
 114 };
 115
 116 struct ath_common;
 117
 118 struct ath_bus_ops {
 119         enum ath_bus_type ath_bus_type;
 120         void (*read_cachesize)(struct ath_common *common, int *csz);
 121         bool (*eeprom_read)(struct ath_common *common, u32 off, u16 *data);
 122         void (*bt_coex_prep)(struct ath_common *common);
 123 };
 124
 125 struct ath_common {
 126         void *ah;
 127         void *priv;
 128         struct ieee80211_hw *hw;
 129         int debug_mask;
 130         enum ath_device_state state;
 131
 132         struct ath_ani ani;
 133
 134         u16 cachelsz;
 135         u16 curaid;
 136         u8 macaddr[ETH_ALEN];
 137         u8 curbssid[ETH_ALEN];
 138         u8 bssidmask[ETH_ALEN];
 139
 140         u8 tx_chainmask;
 141         u8 rx_chainmask;
 142
 143         u32 rx_bufsize;
 144
 145         u32 keymax;
 146         DECLARE_BITMAP(keymap, ATH_KEYMAX);
 147         DECLARE_BITMAP(tkip_keymap, ATH_KEYMAX);
 148         enum ath_crypt_caps crypt_caps;
 149
 150         struct ath_regulatory regulatory;
 151         const struct ath_ops *ops;
 152         const struct ath_bus_ops *bus_ops;
 153 };
 154
 155 struct sk_buff *ath_rxbuf_alloc(struct ath_common *common,
 156                                 u32 len,
 157                                 gfp_t gfp_mask);
 158
 159 void ath_hw_setbssidmask(struct ath_common *common);
 160 void ath_key_delete(struct ath_common *common, struct ieee80211_key_conf *key);
 161 int ath_key_config(struct ath_common *common,
 162                           struct ieee80211_vif *vif,
 163                           struct ieee80211_sta *sta,
 164                           struct ieee80211_key_conf *key);
 165 bool ath_hw_keyreset(struct ath_common *common, u16 entry);
 166
 167 #endif /* ATH_H */