21679bf3a1aaae4ac376338407ead09ec16ec29f
[linux-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-3945-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_sta_priv {
78         struct iwl3945_rs_sta *rs_sta;
79 };
80
81 enum iwl3945_antenna {
82         IWL_ANTENNA_DIVERSITY,
83         IWL_ANTENNA_MAIN,
84         IWL_ANTENNA_AUX
85 };
86
87 /*
88  * RTS threshold here is total size [2347] minus 4 FCS bytes
89  * Per spec:
90  *   a value of 0 means RTS on all data/management packets
91  *   a value > max MSDU size means no RTS
92  * else RTS for data/management frames where MPDU is larger
93  *   than RTS value.
94  */
95 #define DEFAULT_RTS_THRESHOLD     2347U
96 #define MIN_RTS_THRESHOLD         0U
97 #define MAX_RTS_THRESHOLD         2347U
98 #define MAX_MSDU_SIZE             2304U
99 #define MAX_MPDU_SIZE             2346U
100 #define DEFAULT_BEACON_INTERVAL   100U
101 #define DEFAULT_SHORT_RETRY_LIMIT 7U
102 #define DEFAULT_LONG_RETRY_LIMIT  4U
103
104 #include "iwl-agn-rs.h"
105
106 #define IWL_TX_FIFO_AC0 0
107 #define IWL_TX_FIFO_AC1 1
108 #define IWL_TX_FIFO_AC2 2
109 #define IWL_TX_FIFO_AC3 3
110 #define IWL_TX_FIFO_HCCA_1      5
111 #define IWL_TX_FIFO_HCCA_2      6
112 #define IWL_TX_FIFO_NONE        7
113
114 #define IEEE80211_DATA_LEN              2304
115 #define IEEE80211_4ADDR_LEN             30
116 #define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
117 #define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
118
119 struct iwl3945_frame {
120         union {
121                 struct ieee80211_hdr frame;
122                 struct iwl3945_tx_beacon_cmd beacon;
123                 u8 raw[IEEE80211_FRAME_LEN];
124                 u8 cmd[360];
125         } u;
126         struct list_head list;
127 };
128
129 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
130 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
131 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
132
133 /*
134  * RX related structures and functions
135  */
136 #define RX_FREE_BUFFERS 64
137 #define RX_LOW_WATERMARK 8
138
139 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
140 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
141 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
142
143 #define IWL_SUPPORTED_RATES_IE_LEN         8
144
145 #define SCAN_INTERVAL 100
146
147 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
148 #define STATUS_HCMD_SYNC_ACTIVE 1       /* sync host command in progress */
149 #define STATUS_INT_ENABLED      2
150 #define STATUS_RF_KILL_HW       3
151 #define STATUS_INIT             5
152 #define STATUS_ALIVE            6
153 #define STATUS_READY            7
154 #define STATUS_TEMPERATURE      8
155 #define STATUS_GEO_CONFIGURED   9
156 #define STATUS_EXIT_PENDING     10
157 #define STATUS_STATISTICS       12
158 #define STATUS_SCANNING         13
159 #define STATUS_SCAN_ABORTING    14
160 #define STATUS_SCAN_HW          15
161 #define STATUS_POWER_PMI        16
162 #define STATUS_FW_ERROR         17
163 #define STATUS_CONF_PENDING     18
164
165 #define MAX_TID_COUNT        9
166
167 #define IWL_INVALID_RATE     0xFF
168 #define IWL_INVALID_VALUE    -1
169
170 #define STA_PS_STATUS_WAKE             0
171 #define STA_PS_STATUS_SLEEP            1
172
173 struct iwl3945_ibss_seq {
174         u8 mac[ETH_ALEN];
175         u16 seq_num;
176         u16 frag_num;
177         unsigned long packet_time;
178         struct list_head list;
179 };
180
181 #define IWL_RX_HDR(x) ((struct iwl3945_rx_frame_hdr *)(\
182                        x->u.rx_frame.stats.payload + \
183                        x->u.rx_frame.stats.phy_count))
184 #define IWL_RX_END(x) ((struct iwl3945_rx_frame_end *)(\
185                        IWL_RX_HDR(x)->payload + \
186                        le16_to_cpu(IWL_RX_HDR(x)->len)))
187 #define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
188 #define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)
189
190
191 /******************************************************************************
192  *
193  * Functions implemented in iwl-base.c which are forward declared here
194  * for use by iwl-*.c
195  *
196  *****************************************************************************/
197 extern int iwl3945_power_init_handle(struct iwl_priv *priv);
198 extern int iwl3945_eeprom_init(struct iwl_priv *priv);
199 extern int iwl3945_calc_db_from_ratio(int sig_ratio);
200 extern int iwl3945_calc_sig_qual(int rssi_dbm, int noise_dbm);
201 extern int iwl3945_tx_queue_init(struct iwl_priv *priv,
202                              struct iwl_tx_queue *txq, int count, u32 id);
203 extern void iwl3945_rx_replenish(void *data);
204 extern void iwl3945_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
205 extern void iwl3945_tx_queue_free(struct iwl_priv *priv, struct iwl_tx_queue *txq);
206 extern int iwl3945_send_cmd_pdu(struct iwl_priv *priv, u8 id, u16 len,
207                             const void *data);
208 extern int __must_check iwl3945_send_cmd(struct iwl_priv *priv,
209                                          struct iwl_host_cmd *cmd);
210 extern unsigned int iwl3945_fill_beacon_frame(struct iwl_priv *priv,
211                                         struct ieee80211_hdr *hdr,int left);
212 extern void iwl3945_dump_nic_event_log(struct iwl_priv *priv);
213 extern void iwl3945_dump_nic_error_log(struct iwl_priv *priv);
214
215 /*
216  * Currently used by iwl-3945-rs... look at restructuring so that it doesn't
217  * call this... todo... fix that.
218 */
219 extern u8 iwl3945_sync_station(struct iwl_priv *priv, int sta_id,
220                            u16 tx_rate, u8 flags);
221
222 /******************************************************************************
223  *
224  * Functions implemented in iwl-[34]*.c which are forward declared here
225  * for use by iwl-base.c
226  *
227  * NOTE:  The implementation of these functions are hardware specific
228  * which is why they are in the hardware specific files (vs. iwl-base.c)
229  *
230  * Naming convention --
231  * iwl3945_         <-- Its part of iwlwifi (should be changed to iwl3945_)
232  * iwl3945_hw_      <-- Hardware specific (implemented in iwl-XXXX.c by all HW)
233  * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
234  * iwl3945_bg_      <-- Called from work queue context
235  * iwl3945_mac_     <-- mac80211 callback
236  *
237  ****************************************************************************/
238 extern void iwl3945_hw_rx_handler_setup(struct iwl_priv *priv);
239 extern void iwl3945_hw_setup_deferred_work(struct iwl_priv *priv);
240 extern void iwl3945_hw_cancel_deferred_work(struct iwl_priv *priv);
241 extern int iwl3945_hw_rxq_stop(struct iwl_priv *priv);
242 extern int iwl3945_hw_set_hw_params(struct iwl_priv *priv);
243 extern int iwl3945_hw_nic_init(struct iwl_priv *priv);
244 extern int iwl3945_hw_nic_stop_master(struct iwl_priv *priv);
245 extern void iwl3945_hw_txq_ctx_free(struct iwl_priv *priv);
246 extern void iwl3945_hw_txq_ctx_stop(struct iwl_priv *priv);
247 extern int iwl3945_hw_nic_reset(struct iwl_priv *priv);
248 extern int iwl3945_hw_txq_attach_buf_to_tfd(struct iwl_priv *priv,
249                                             struct iwl_tx_queue *txq,
250                                             dma_addr_t addr, u16 len,
251                                             u8 reset, u8 pad);
252 extern void iwl3945_hw_txq_free_tfd(struct iwl_priv *priv,
253                                     struct iwl_tx_queue *txq);
254 extern int iwl3945_hw_get_temperature(struct iwl_priv *priv);
255 extern int iwl3945_hw_tx_queue_init(struct iwl_priv *priv,
256                                 struct iwl_tx_queue *txq);
257 extern unsigned int iwl3945_hw_get_beacon_cmd(struct iwl_priv *priv,
258                                  struct iwl3945_frame *frame, u8 rate);
259 void iwl3945_hw_build_tx_cmd_rate(struct iwl_priv *priv,
260                                   struct iwl_device_cmd *cmd,
261                                   struct ieee80211_tx_info *info,
262                                   struct ieee80211_hdr *hdr,
263                                   int sta_id, int tx_id);
264 extern int iwl3945_hw_reg_send_txpower(struct iwl_priv *priv);
265 extern int iwl3945_hw_reg_set_txpower(struct iwl_priv *priv, s8 power);
266 extern void iwl3945_hw_rx_statistics(struct iwl_priv *priv,
267                                  struct iwl_rx_mem_buffer *rxb);
268 extern void iwl3945_disable_events(struct iwl_priv *priv);
269 extern int iwl4965_get_temperature(const struct iwl_priv *priv);
270 extern void iwl3945_post_associate(struct iwl_priv *priv);
271 extern void iwl3945_config_ap(struct iwl_priv *priv);
272
273 /**
274  * iwl3945_hw_find_station - Find station id for a given BSSID
275  * @bssid: MAC address of station ID to find
276  *
277  * NOTE:  This should not be hardware specific but the code has
278  * not yet been merged into a single common layer for managing the
279  * station tables.
280  */
281 extern u8 iwl3945_hw_find_station(struct iwl_priv *priv, const u8 *bssid);
282
283 extern int iwl3945_hw_channel_switch(struct iwl_priv *priv, u16 channel);
284
285 /*
286  * Forward declare iwl-3945.c functions for iwl-base.c
287  */
288 extern __le32 iwl3945_get_antenna_flags(const struct iwl_priv *priv);
289 extern int iwl3945_init_hw_rate_table(struct iwl_priv *priv);
290 extern void iwl3945_reg_txpower_periodic(struct iwl_priv *priv);
291 extern int iwl3945_txpower_set_from_eeprom(struct iwl_priv *priv);
292 extern u8 iwl3945_sync_sta(struct iwl_priv *priv, int sta_id,
293                  u16 tx_rate, u8 flags);
294
295 extern const struct iwl_channel_info *iwl3945_get_channel_info(
296         const struct iwl_priv *priv, enum ieee80211_band band, u16 channel);
297
298 extern int iwl3945_rs_next_rate(struct iwl_priv *priv, int rate);
299
300 /* Requires full declaration of iwl_priv before including */
301 #include "iwl-io.h"
302
303 #endif