ath/ath9k: Replace common->splitmic with a flag
[linux-2.6.git] / 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         int16_t noise_floor;
39         unsigned int longcal_timer;
40         unsigned int shortcal_timer;
41         unsigned int resetcal_timer;
42         unsigned int checkani_timer;
43         struct timer_list timer;
44 };
45
46 enum ath_device_state {
47         ATH_HW_UNAVAILABLE,
48         ATH_HW_INITIALIZED,
49 };
50
51 enum ath_bus_type {
52         ATH_PCI,
53         ATH_AHB,
54         ATH_USB,
55 };
56
57 struct reg_dmn_pair_mapping {
58         u16 regDmnEnum;
59         u16 reg_5ghz_ctl;
60         u16 reg_2ghz_ctl;
61 };
62
63 struct ath_regulatory {
64         char alpha2[2];
65         u16 country_code;
66         u16 max_power_level;
67         u32 tp_scale;
68         u16 current_rd;
69         u16 current_rd_ext;
70         int16_t power_limit;
71         struct reg_dmn_pair_mapping *regpair;
72 };
73
74 enum ath_crypt_caps {
75         ATH_CRYPT_CAP_MIC_AESCCM                = BIT(0),
76         ATH_CRYPT_CAP_MIC_CKIP                  = BIT(1),
77         ATH_CRYPT_CAP_MIC_TKIP                  = BIT(2),
78         ATH_CRYPT_CAP_CIPHER_AESCCM             = BIT(3),
79         ATH_CRYPT_CAP_CIPHER_CKIP               = BIT(4),
80         ATH_CRYPT_CAP_CIPHER_TKIP               = BIT(5),
81         ATH_CRYPT_CAP_MIC_COMBINED              = BIT(6),
82 };
83
84 struct ath_keyval {
85         u8 kv_type;
86         u8 kv_pad;
87         u16 kv_len;
88         u8 kv_val[16]; /* TK */
89         u8 kv_mic[8]; /* Michael MIC key */
90         u8 kv_txmic[8]; /* Michael MIC TX key (used only if the hardware
91                          * supports both MIC keys in the same key cache entry;
92                          * in that case, kv_mic is the RX key) */
93 };
94
95 enum ath_cipher {
96         ATH_CIPHER_WEP = 0,
97         ATH_CIPHER_AES_OCB = 1,
98         ATH_CIPHER_AES_CCM = 2,
99         ATH_CIPHER_CKIP = 3,
100         ATH_CIPHER_TKIP = 4,
101         ATH_CIPHER_CLR = 5,
102         ATH_CIPHER_MIC = 127
103 };
104
105 /**
106  * struct ath_ops - Register read/write operations
107  *
108  * @read: Register read
109  * @write: Register write
110  * @enable_write_buffer: Enable multiple register writes
111  * @disable_write_buffer: Disable multiple register writes
112  * @write_flush: Flush buffered register writes
113  */
114 struct ath_ops {
115         unsigned int (*read)(void *, u32 reg_offset);
116         void (*write)(void *, u32 val, u32 reg_offset);
117         void (*enable_write_buffer)(void *);
118         void (*disable_write_buffer)(void *);
119         void (*write_flush) (void *);
120 };
121
122 struct ath_common;
123
124 struct ath_bus_ops {
125         enum ath_bus_type ath_bus_type;
126         void (*read_cachesize)(struct ath_common *common, int *csz);
127         bool (*eeprom_read)(struct ath_common *common, u32 off, u16 *data);
128         void (*bt_coex_prep)(struct ath_common *common);
129 };
130
131 struct ath_common {
132         void *ah;
133         void *priv;
134         struct ieee80211_hw *hw;
135         int debug_mask;
136         enum ath_device_state state;
137
138         struct ath_ani ani;
139
140         u16 cachelsz;
141         u16 curaid;
142         u8 macaddr[ETH_ALEN];
143         u8 curbssid[ETH_ALEN];
144         u8 bssidmask[ETH_ALEN];
145
146         u8 tx_chainmask;
147         u8 rx_chainmask;
148
149         u32 rx_bufsize;
150
151         u32 keymax;
152         DECLARE_BITMAP(keymap, ATH_KEYMAX);
153         DECLARE_BITMAP(tkip_keymap, ATH_KEYMAX);
154         enum ath_crypt_caps crypt_caps;
155
156         struct ath_regulatory regulatory;
157         const struct ath_ops *ops;
158         const struct ath_bus_ops *bus_ops;
159 };
160
161 struct sk_buff *ath_rxbuf_alloc(struct ath_common *common,
162                                 u32 len,
163                                 gfp_t gfp_mask);
164
165 void ath_hw_setbssidmask(struct ath_common *common);
166 void ath_key_delete(struct ath_common *common, struct ieee80211_key_conf *key);
167 int ath_key_config(struct ath_common *common,
168                           struct ieee80211_vif *vif,
169                           struct ieee80211_sta *sta,
170                           struct ieee80211_key_conf *key);
171 bool ath_hw_keyreset(struct ath_common *common, u16 entry);
172
173 #endif /* ATH_H */