Merge branch 'master' of master.kernel.org:/pub/scm/linux/kernel/git/davem/net-2.6
[linux-2.6] / drivers / net / wireless / ath / ar9170 / ar9170.h
1 /*
2  * Atheros AR9170 driver
3  *
4  * Driver specific definitions
5  *
6  * Copyright 2008, Johannes Berg <johannes@sipsolutions.net>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; see the file COPYING.  If not, see
20  * http://www.gnu.org/licenses/.
21  *
22  * This file incorporates work covered by the following copyright and
23  * permission notice:
24  *    Copyright (c) 2007-2008 Atheros Communications, Inc.
25  *
26  *    Permission to use, copy, modify, and/or distribute this software for any
27  *    purpose with or without fee is hereby granted, provided that the above
28  *    copyright notice and this permission notice appear in all copies.
29  *
30  *    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
31  *    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
32  *    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
33  *    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
34  *    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
35  *    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
36  *    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
37  */
38 #ifndef __AR9170_H
39 #define __AR9170_H
40
41 #include <linux/completion.h>
42 #include <linux/spinlock.h>
43 #include <net/cfg80211.h>
44 #include <net/mac80211.h>
45 #ifdef CONFIG_AR9170_LEDS
46 #include <linux/leds.h>
47 #endif /* CONFIG_AR9170_LEDS */
48 #include "eeprom.h"
49 #include "hw.h"
50
51 #include "../regd.h"
52
53 #define PAYLOAD_MAX     (AR9170_MAX_CMD_LEN/4 - 1)
54
55 enum ar9170_bw {
56         AR9170_BW_20,
57         AR9170_BW_40_BELOW,
58         AR9170_BW_40_ABOVE,
59
60         __AR9170_NUM_BW,
61 };
62
63 static inline enum ar9170_bw nl80211_to_ar9170(enum nl80211_channel_type type)
64 {
65         switch (type) {
66         case NL80211_CHAN_NO_HT:
67         case NL80211_CHAN_HT20:
68                 return AR9170_BW_20;
69         case NL80211_CHAN_HT40MINUS:
70                 return AR9170_BW_40_BELOW;
71         case NL80211_CHAN_HT40PLUS:
72                 return AR9170_BW_40_ABOVE;
73         default:
74                 BUG();
75         }
76 }
77
78 enum ar9170_rf_init_mode {
79         AR9170_RFI_NONE,
80         AR9170_RFI_WARM,
81         AR9170_RFI_COLD,
82 };
83
84 #define AR9170_MAX_RX_BUFFER_SIZE               8192
85
86 #ifdef CONFIG_AR9170_LEDS
87 struct ar9170;
88
89 struct ar9170_led {
90         struct ar9170 *ar;
91         struct led_classdev l;
92         char name[32];
93         unsigned int toggled;
94         bool registered;
95 };
96
97 #endif /* CONFIG_AR9170_LEDS */
98
99 enum ar9170_device_state {
100         AR9170_UNKNOWN_STATE,
101         AR9170_STOPPED,
102         AR9170_IDLE,
103         AR9170_STARTED,
104         AR9170_ASSOCIATED,
105 };
106
107 struct ar9170_rxstream_mpdu_merge {
108         struct ar9170_rx_head plcp;
109         bool has_plcp;
110 };
111
112 struct ar9170 {
113         struct ieee80211_hw *hw;
114         struct mutex mutex;
115         enum ar9170_device_state state;
116         unsigned long bad_hw_nagger;
117
118         int (*open)(struct ar9170 *);
119         void (*stop)(struct ar9170 *);
120         int (*tx)(struct ar9170 *, struct sk_buff *, bool, unsigned int);
121         int (*exec_cmd)(struct ar9170 *, enum ar9170_cmd, u32 ,
122                         void *, u32 , void *);
123         void (*callback_cmd)(struct ar9170 *, u32 , void *);
124
125         /* interface mode settings */
126         struct ieee80211_vif *vif;
127         u8 mac_addr[ETH_ALEN];
128         u8 bssid[ETH_ALEN];
129
130         /* beaconing */
131         struct sk_buff *beacon;
132         struct work_struct beacon_work;
133
134         /* cryptographic engine */
135         u64 usedkeys;
136         bool rx_software_decryption;
137         bool disable_offload;
138
139         /* filter settings */
140         struct work_struct filter_config_work;
141         u64 cur_mc_hash, want_mc_hash;
142         u32 cur_filter, want_filter;
143         unsigned int filter_changed;
144         unsigned int filter_state;
145         bool sniffer_enabled;
146
147         /* PHY */
148         struct ieee80211_channel *channel;
149         int noise[4];
150
151         /* power calibration data */
152         u8 power_5G_leg[4];
153         u8 power_2G_cck[4];
154         u8 power_2G_ofdm[4];
155         u8 power_5G_ht20[8];
156         u8 power_5G_ht40[8];
157         u8 power_2G_ht20[8];
158         u8 power_2G_ht40[8];
159
160 #ifdef CONFIG_AR9170_LEDS
161         struct delayed_work led_work;
162         struct ar9170_led leds[AR9170_NUM_LEDS];
163 #endif /* CONFIG_AR9170_LEDS */
164
165         /* qos queue settings */
166         spinlock_t tx_stats_lock;
167         struct ieee80211_tx_queue_stats tx_stats[5];
168         struct ieee80211_tx_queue_params edcf[5];
169
170         spinlock_t cmdlock;
171         __le32 cmdbuf[PAYLOAD_MAX + 1];
172
173         /* MAC statistics */
174         struct ieee80211_low_level_stats stats;
175
176         /* EEPROM */
177         struct ar9170_eeprom eeprom;
178         struct ath_regulatory regulatory;
179
180         /* global tx status for unregistered Stations. */
181         struct sk_buff_head global_tx_status;
182         struct sk_buff_head global_tx_status_waste;
183         struct delayed_work tx_status_janitor;
184
185         /* rxstream mpdu merge */
186         struct ar9170_rxstream_mpdu_merge rx_mpdu;
187         struct sk_buff *rx_failover;
188         int rx_failover_missing;
189 };
190
191 struct ar9170_sta_info {
192         struct sk_buff_head tx_status[__AR9170_NUM_TXQ];
193 };
194
195 #define IS_STARTED(a)           (a->state >= AR9170_STARTED)
196 #define IS_ACCEPTING_CMD(a)     (a->state >= AR9170_IDLE)
197
198 #define AR9170_FILTER_CHANGED_PROMISC           BIT(0)
199 #define AR9170_FILTER_CHANGED_MULTICAST         BIT(1)
200 #define AR9170_FILTER_CHANGED_FRAMEFILTER       BIT(2)
201
202 /* exported interface */
203 void *ar9170_alloc(size_t priv_size);
204 int ar9170_register(struct ar9170 *ar, struct device *pdev);
205 void ar9170_rx(struct ar9170 *ar, struct sk_buff *skb);
206 void ar9170_unregister(struct ar9170 *ar);
207 void ar9170_handle_tx_status(struct ar9170 *ar, struct sk_buff *skb,
208                              bool update_statistics, u16 tx_status);
209
210 /* MAC */
211 int ar9170_op_tx(struct ieee80211_hw *hw, struct sk_buff *skb);
212 int ar9170_init_mac(struct ar9170 *ar);
213 int ar9170_set_qos(struct ar9170 *ar);
214 int ar9170_update_multicast(struct ar9170 *ar);
215 int ar9170_update_frame_filter(struct ar9170 *ar);
216 int ar9170_set_operating_mode(struct ar9170 *ar);
217 int ar9170_set_beacon_timers(struct ar9170 *ar);
218 int ar9170_set_hwretry_limit(struct ar9170 *ar, u32 max_retry);
219 int ar9170_update_beacon(struct ar9170 *ar);
220 void ar9170_new_beacon(struct work_struct *work);
221 int ar9170_upload_key(struct ar9170 *ar, u8 id, const u8 *mac, u8 ktype,
222                       u8 keyidx, u8 *keydata, int keylen);
223 int ar9170_disable_key(struct ar9170 *ar, u8 id);
224
225 /* LEDs */
226 #ifdef CONFIG_AR9170_LEDS
227 int ar9170_register_leds(struct ar9170 *ar);
228 void ar9170_unregister_leds(struct ar9170 *ar);
229 #endif /* CONFIG_AR9170_LEDS */
230 int ar9170_init_leds(struct ar9170 *ar);
231 int ar9170_set_leds_state(struct ar9170 *ar, u32 led_state);
232
233 /* PHY / RF */
234 int ar9170_init_phy(struct ar9170 *ar, enum ieee80211_band band);
235 int ar9170_init_rf(struct ar9170 *ar);
236 int ar9170_set_channel(struct ar9170 *ar, struct ieee80211_channel *channel,
237                        enum ar9170_rf_init_mode rfi, enum ar9170_bw bw);
238
239 #endif /* __AR9170_H */