Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net-2.6
[sfrench/cifs-2.6.git] / drivers / net / wireless / iwlwifi / iwl-3945.h
1 /******************************************************************************
2  *
3  * Copyright(c) 2003 - 2009 Intel Corporation. All rights reserved.
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of version 2 of the GNU General Public License as
7  * published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
12  * more details.
13  *
14  * You should have received a copy of the GNU General Public License along with
15  * this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
17  *
18  * The full GNU General Public License is included in this distribution in the
19  * file called LICENSE.
20  *
21  * Contact Information:
22  *  Intel Linux Wireless <ilw@linux.intel.com>
23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
24  *
25  *****************************************************************************/
26 /*
27  * Please use this file (iwl-3945.h) for driver implementation definitions.
28  * Please use iwl-3945-commands.h for uCode API definitions.
29  * Please use iwl-3945-hw.h for hardware-related definitions.
30  */
31
32 #ifndef __iwl_3945_h__
33 #define __iwl_3945_h__
34
35 #include <linux/pci.h> /* for struct pci_device_id */
36 #include <linux/kernel.h>
37 #include <net/ieee80211_radiotap.h>
38
39 /* Hardware specific file defines the PCI IDs table for that hardware module */
40 extern struct pci_device_id iwl3945_hw_card_ids[];
41
42 #include "iwl-csr.h"
43 #include "iwl-prph.h"
44 #include "iwl-fh.h"
45 #include "iwl-3945-hw.h"
46 #include "iwl-debug.h"
47 #include "iwl-power.h"
48 #include "iwl-dev.h"
49 #include "iwl-led.h"
50
51 /* Highest firmware API version supported */
52 #define IWL3945_UCODE_API_MAX 2
53
54 /* Lowest firmware API version supported */
55 #define IWL3945_UCODE_API_MIN 1
56
57 #define IWL3945_FW_PRE  "iwlwifi-3945-"
58 #define _IWL3945_MODULE_FIRMWARE(api) IWL3945_FW_PRE #api ".ucode"
59 #define IWL3945_MODULE_FIRMWARE(api) _IWL3945_MODULE_FIRMWARE(api)
60
61 /* Default noise level to report when noise measurement is not available.
62  *   This may be because we're:
63  *   1)  Not associated (4965, no beacon statistics being sent to driver)
64  *   2)  Scanning (noise measurement does not apply to associated channel)
65  *   3)  Receiving CCK (3945 delivers noise info only for OFDM frames)
66  * Use default noise value of -127 ... this is below the range of measurable
67  *   Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
68  *   Also, -127 works better than 0 when averaging frames with/without
69  *   noise info (e.g. averaging might be done in app); measured dBm values are
70  *   always negative ... using a negative value as the default keeps all
71  *   averages within an s8's (used in some apps) range of negative values. */
72 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
73
74 /* Module parameters accessible from iwl-*.c */
75 extern struct iwl_mod_params iwl3945_mod_params;
76
77 struct iwl3945_rate_scale_data {
78         u64 data;
79         s32 success_counter;
80         s32 success_ratio;
81         s32 counter;
82         s32 average_tpt;
83         unsigned long stamp;
84 };
85
86 struct iwl3945_rs_sta {
87         spinlock_t lock;
88         struct iwl_priv *priv;
89         s32 *expected_tpt;
90         unsigned long last_partial_flush;
91         unsigned long last_flush;
92         u32 flush_time;
93         u32 last_tx_packets;
94         u32 tx_packets;
95         u8 tgg;
96         u8 flush_pending;
97         u8 start_rate;
98         u8 ibss_sta_added;
99         struct timer_list rate_scale_flush;
100         struct iwl3945_rate_scale_data win[IWL_RATE_COUNT_3945];
101 #ifdef CONFIG_MAC80211_DEBUGFS
102         struct dentry *rs_sta_dbgfs_stats_table_file;
103 #endif
104
105         /* used to be in sta_info */
106         int last_txrate_idx;
107 };
108
109
110 struct iwl3945_sta_priv {
111         struct iwl3945_rs_sta rs_sta;
112 };
113
114 enum iwl3945_antenna {
115         IWL_ANTENNA_DIVERSITY,
116         IWL_ANTENNA_MAIN,
117         IWL_ANTENNA_AUX
118 };
119
120 /*
121  * RTS threshold here is total size [2347] minus 4 FCS bytes
122  * Per spec:
123  *   a value of 0 means RTS on all data/management packets
124  *   a value > max MSDU size means no RTS
125  * else RTS for data/management frames where MPDU is larger
126  *   than RTS value.
127  */
128 #define DEFAULT_RTS_THRESHOLD     2347U
129 #define MIN_RTS_THRESHOLD         0U
130 #define MAX_RTS_THRESHOLD         2347U
131 #define MAX_MSDU_SIZE             2304U
132 #define MAX_MPDU_SIZE             2346U
133 #define DEFAULT_BEACON_INTERVAL   100U
134 #define DEFAULT_SHORT_RETRY_LIMIT 7U
135 #define DEFAULT_LONG_RETRY_LIMIT  4U
136
137 #include "iwl-agn-rs.h"
138
139 #define IWL_TX_FIFO_AC0 0
140 #define IWL_TX_FIFO_AC1 1
141 #define IWL_TX_FIFO_AC2 2
142 #define IWL_TX_FIFO_AC3 3
143 #define IWL_TX_FIFO_HCCA_1      5
144 #define IWL_TX_FIFO_HCCA_2      6
145 #define IWL_TX_FIFO_NONE        7
146
147 #define IEEE80211_DATA_LEN              2304
148 #define IEEE80211_4ADDR_LEN             30
149 #define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
150 #define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
151
152 struct iwl3945_frame {
153         union {
154                 struct ieee80211_hdr frame;
155                 struct iwl3945_tx_beacon_cmd beacon;
156                 u8 raw[IEEE80211_FRAME_LEN];
157                 u8 cmd[360];
158         } u;
159         struct list_head list;
160 };
161
162 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
163 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
164 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
165
166 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
167 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
168 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
169
170 #define IWL_SUPPORTED_RATES_IE_LEN         8
171
172 #define SCAN_INTERVAL 100
173
174 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
175 #define STATUS_HCMD_SYNC_ACTIVE 1       /* sync host command in progress */
176 #define STATUS_INT_ENABLED      2
177 #define STATUS_RF_KILL_HW       3
178 #define STATUS_INIT             5
179 #define STATUS_ALIVE            6
180 #define STATUS_READY            7
181 #define STATUS_TEMPERATURE      8
182 #define STATUS_GEO_CONFIGURED   9
183 #define STATUS_EXIT_PENDING     10
184 #define STATUS_STATISTICS       12
185 #define STATUS_SCANNING         13
186 #define STATUS_SCAN_ABORTING    14
187 #define STATUS_SCAN_HW          15
188 #define STATUS_POWER_PMI        16
189 #define STATUS_FW_ERROR         17
190 #define STATUS_CONF_PENDING     18
191
192 #define MAX_TID_COUNT        9
193
194 #define IWL_INVALID_RATE     0xFF
195 #define IWL_INVALID_VALUE    -1
196
197 #define STA_PS_STATUS_WAKE             0
198 #define STA_PS_STATUS_SLEEP            1
199
200 struct iwl3945_ibss_seq {
201         u8 mac[ETH_ALEN];
202         u16 seq_num;
203         u16 frag_num;
204         unsigned long packet_time;
205         struct list_head list;
206 };
207
208 #define IWL_RX_HDR(x) ((struct iwl3945_rx_frame_hdr *)(\
209                        x->u.rx_frame.stats.payload + \
210                        x->u.rx_frame.stats.phy_count))
211 #define IWL_RX_END(x) ((struct iwl3945_rx_frame_end *)(\
212                        IWL_RX_HDR(x)->payload + \
213                        le16_to_cpu(IWL_RX_HDR(x)->len)))
214 #define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
215 #define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)
216
217
218 /******************************************************************************
219  *
220  * Functions implemented in iwl-base.c which are forward declared here
221  * for use by iwl-*.c
222  *
223  *****************************************************************************/
224 extern int iwl3945_calc_db_from_ratio(int sig_ratio);
225 extern void iwl3945_rx_replenish(void *data);
226 extern void iwl3945_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
227 extern unsigned int iwl3945_fill_beacon_frame(struct iwl_priv *priv,
228                                         struct ieee80211_hdr *hdr,int left);
229 extern void iwl3945_dump_nic_event_log(struct iwl_priv *priv, bool full_log);
230 extern void iwl3945_dump_nic_error_log(struct iwl_priv *priv);
231
232 /*
233  * Currently used by iwl-3945-rs... look at restructuring so that it doesn't
234  * call this... todo... fix that.
235 */
236 extern u8 iwl3945_sync_station(struct iwl_priv *priv, int sta_id,
237                            u16 tx_rate, u8 flags);
238
239 /******************************************************************************
240  *
241  * Functions implemented in iwl-[34]*.c which are forward declared here
242  * for use by iwl-base.c
243  *
244  * NOTE:  The implementation of these functions are hardware specific
245  * which is why they are in the hardware specific files (vs. iwl-base.c)
246  *
247  * Naming convention --
248  * iwl3945_         <-- Its part of iwlwifi (should be changed to iwl3945_)
249  * iwl3945_hw_      <-- Hardware specific (implemented in iwl-XXXX.c by all HW)
250  * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
251  * iwl3945_bg_      <-- Called from work queue context
252  * iwl3945_mac_     <-- mac80211 callback
253  *
254  ****************************************************************************/
255 extern void iwl3945_hw_rx_handler_setup(struct iwl_priv *priv);
256 extern void iwl3945_hw_setup_deferred_work(struct iwl_priv *priv);
257 extern void iwl3945_hw_cancel_deferred_work(struct iwl_priv *priv);
258 extern int iwl3945_hw_rxq_stop(struct iwl_priv *priv);
259 extern int iwl3945_hw_set_hw_params(struct iwl_priv *priv);
260 extern int iwl3945_hw_nic_init(struct iwl_priv *priv);
261 extern int iwl3945_hw_nic_stop_master(struct iwl_priv *priv);
262 extern void iwl3945_hw_txq_ctx_free(struct iwl_priv *priv);
263 extern void iwl3945_hw_txq_ctx_stop(struct iwl_priv *priv);
264 extern int iwl3945_hw_nic_reset(struct iwl_priv *priv);
265 extern int iwl3945_hw_txq_attach_buf_to_tfd(struct iwl_priv *priv,
266                                             struct iwl_tx_queue *txq,
267                                             dma_addr_t addr, u16 len,
268                                             u8 reset, u8 pad);
269 extern void iwl3945_hw_txq_free_tfd(struct iwl_priv *priv,
270                                     struct iwl_tx_queue *txq);
271 extern int iwl3945_hw_get_temperature(struct iwl_priv *priv);
272 extern int iwl3945_hw_tx_queue_init(struct iwl_priv *priv,
273                                 struct iwl_tx_queue *txq);
274 extern unsigned int iwl3945_hw_get_beacon_cmd(struct iwl_priv *priv,
275                                  struct iwl3945_frame *frame, u8 rate);
276 void iwl3945_hw_build_tx_cmd_rate(struct iwl_priv *priv,
277                                   struct iwl_device_cmd *cmd,
278                                   struct ieee80211_tx_info *info,
279                                   struct ieee80211_hdr *hdr,
280                                   int sta_id, int tx_id);
281 extern int iwl3945_hw_reg_send_txpower(struct iwl_priv *priv);
282 extern int iwl3945_hw_reg_set_txpower(struct iwl_priv *priv, s8 power);
283 extern void iwl3945_hw_rx_statistics(struct iwl_priv *priv,
284                                  struct iwl_rx_mem_buffer *rxb);
285 extern void iwl3945_disable_events(struct iwl_priv *priv);
286 extern int iwl4965_get_temperature(const struct iwl_priv *priv);
287 extern void iwl3945_post_associate(struct iwl_priv *priv);
288 extern void iwl3945_config_ap(struct iwl_priv *priv);
289
290 /**
291  * iwl3945_hw_find_station - Find station id for a given BSSID
292  * @bssid: MAC address of station ID to find
293  *
294  * NOTE:  This should not be hardware specific but the code has
295  * not yet been merged into a single common layer for managing the
296  * station tables.
297  */
298 extern u8 iwl3945_hw_find_station(struct iwl_priv *priv, const u8 *bssid);
299
300 /*
301  * Forward declare iwl-3945.c functions for iwl-base.c
302  */
303 extern __le32 iwl3945_get_antenna_flags(const struct iwl_priv *priv);
304 extern int iwl3945_init_hw_rate_table(struct iwl_priv *priv);
305 extern void iwl3945_reg_txpower_periodic(struct iwl_priv *priv);
306 extern int iwl3945_txpower_set_from_eeprom(struct iwl_priv *priv);
307 extern u8 iwl3945_sync_sta(struct iwl_priv *priv, int sta_id,
308                  u16 tx_rate, u8 flags);
309
310 extern const struct iwl_channel_info *iwl3945_get_channel_info(
311         const struct iwl_priv *priv, enum ieee80211_band band, u16 channel);
312
313 extern int iwl3945_rs_next_rate(struct iwl_priv *priv, int rate);
314
315 /* Requires full declaration of iwl_priv before including */
316 #include "iwl-io.h"
317
318 #endif