Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/bart/ide-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 /*used for rfkill*/
40 #include <linux/rfkill.h>
41 #include <linux/input.h>
42
43 /* Hardware specific file defines the PCI IDs table for that hardware module */
44 extern struct pci_device_id iwl3945_hw_card_ids[];
45
46 #include "iwl-csr.h"
47 #include "iwl-prph.h"
48 #include "iwl-fh.h"
49 #include "iwl-3945-hw.h"
50 #include "iwl-debug.h"
51 #include "iwl-power.h"
52 #include "iwl-dev.h"
53 #include "iwl-3945-led.h"
54
55 /* Highest firmware API version supported */
56 #define IWL3945_UCODE_API_MAX 2
57
58 /* Lowest firmware API version supported */
59 #define IWL3945_UCODE_API_MIN 1
60
61 #define IWL3945_FW_PRE  "iwlwifi-3945-"
62 #define _IWL3945_MODULE_FIRMWARE(api) IWL3945_FW_PRE #api ".ucode"
63 #define IWL3945_MODULE_FIRMWARE(api) _IWL3945_MODULE_FIRMWARE(api)
64
65 /* Default noise level to report when noise measurement is not available.
66  *   This may be because we're:
67  *   1)  Not associated (4965, no beacon statistics being sent to driver)
68  *   2)  Scanning (noise measurement does not apply to associated channel)
69  *   3)  Receiving CCK (3945 delivers noise info only for OFDM frames)
70  * Use default noise value of -127 ... this is below the range of measurable
71  *   Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
72  *   Also, -127 works better than 0 when averaging frames with/without
73  *   noise info (e.g. averaging might be done in app); measured dBm values are
74  *   always negative ... using a negative value as the default keeps all
75  *   averages within an s8's (used in some apps) range of negative values. */
76 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
77
78 /* Module parameters accessible from iwl-*.c */
79 extern struct iwl_mod_params iwl3945_mod_params;
80
81 struct iwl3945_sta_priv {
82         struct iwl3945_rs_sta *rs_sta;
83 };
84
85 enum iwl3945_antenna {
86         IWL_ANTENNA_DIVERSITY,
87         IWL_ANTENNA_MAIN,
88         IWL_ANTENNA_AUX
89 };
90
91 /*
92  * RTS threshold here is total size [2347] minus 4 FCS bytes
93  * Per spec:
94  *   a value of 0 means RTS on all data/management packets
95  *   a value > max MSDU size means no RTS
96  * else RTS for data/management frames where MPDU is larger
97  *   than RTS value.
98  */
99 #define DEFAULT_RTS_THRESHOLD     2347U
100 #define MIN_RTS_THRESHOLD         0U
101 #define MAX_RTS_THRESHOLD         2347U
102 #define MAX_MSDU_SIZE             2304U
103 #define MAX_MPDU_SIZE             2346U
104 #define DEFAULT_BEACON_INTERVAL   100U
105 #define DEFAULT_SHORT_RETRY_LIMIT 7U
106 #define DEFAULT_LONG_RETRY_LIMIT  4U
107
108 #include "iwl-agn-rs.h"
109
110 #define IWL_TX_FIFO_AC0 0
111 #define IWL_TX_FIFO_AC1 1
112 #define IWL_TX_FIFO_AC2 2
113 #define IWL_TX_FIFO_AC3 3
114 #define IWL_TX_FIFO_HCCA_1      5
115 #define IWL_TX_FIFO_HCCA_2      6
116 #define IWL_TX_FIFO_NONE        7
117
118 /* Minimum number of queues. MAX_NUM is defined in hw specific files */
119 #define IWL_MIN_NUM_QUEUES      4
120
121 #define IEEE80211_DATA_LEN              2304
122 #define IEEE80211_4ADDR_LEN             30
123 #define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
124 #define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
125
126 struct iwl3945_frame {
127         union {
128                 struct ieee80211_hdr frame;
129                 struct iwl3945_tx_beacon_cmd beacon;
130                 u8 raw[IEEE80211_FRAME_LEN];
131                 u8 cmd[360];
132         } u;
133         struct list_head list;
134 };
135
136 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
137 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
138 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
139
140 /*
141  * RX related structures and functions
142  */
143 #define RX_FREE_BUFFERS 64
144 #define RX_LOW_WATERMARK 8
145
146 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
147 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
148 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
149
150 #define IWL_SUPPORTED_RATES_IE_LEN         8
151
152 #define SCAN_INTERVAL 100
153
154 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
155 #define STATUS_HCMD_SYNC_ACTIVE 1       /* sync host command in progress */
156 #define STATUS_INT_ENABLED      2
157 #define STATUS_RF_KILL_HW       3
158 #define STATUS_RF_KILL_SW       4
159 #define STATUS_INIT             5
160 #define STATUS_ALIVE            6
161 #define STATUS_READY            7
162 #define STATUS_TEMPERATURE      8
163 #define STATUS_GEO_CONFIGURED   9
164 #define STATUS_EXIT_PENDING     10
165 #define STATUS_IN_SUSPEND       11
166 #define STATUS_STATISTICS       12
167 #define STATUS_SCANNING         13
168 #define STATUS_SCAN_ABORTING    14
169 #define STATUS_SCAN_HW          15
170 #define STATUS_POWER_PMI        16
171 #define STATUS_FW_ERROR         17
172 #define STATUS_CONF_PENDING     18
173
174 #define MAX_TID_COUNT        9
175
176 #define IWL_INVALID_RATE     0xFF
177 #define IWL_INVALID_VALUE    -1
178
179 #define STA_PS_STATUS_WAKE             0
180 #define STA_PS_STATUS_SLEEP            1
181
182 struct iwl3945_ibss_seq {
183         u8 mac[ETH_ALEN];
184         u16 seq_num;
185         u16 frag_num;
186         unsigned long packet_time;
187         struct list_head list;
188 };
189
190 #define IWL_RX_HDR(x) ((struct iwl3945_rx_frame_hdr *)(\
191                        x->u.rx_frame.stats.payload + \
192                        x->u.rx_frame.stats.phy_count))
193 #define IWL_RX_END(x) ((struct iwl3945_rx_frame_end *)(\
194                        IWL_RX_HDR(x)->payload + \
195                        le16_to_cpu(IWL_RX_HDR(x)->len)))
196 #define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
197 #define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)
198
199
200 /******************************************************************************
201  *
202  * Functions implemented in iwl-base.c which are forward declared here
203  * for use by iwl-*.c
204  *
205  *****************************************************************************/
206 struct iwl3945_addsta_cmd;
207 extern int iwl3945_send_add_station(struct iwl_priv *priv,
208                                 struct iwl3945_addsta_cmd *sta, u8 flags);
209 extern u8 iwl3945_add_station(struct iwl_priv *priv, const u8 *bssid,
210                           int is_ap, u8 flags);
211 extern int iwl3945_power_init_handle(struct iwl_priv *priv);
212 extern int iwl3945_eeprom_init(struct iwl_priv *priv);
213 extern int iwl3945_calc_db_from_ratio(int sig_ratio);
214 extern int iwl3945_calc_sig_qual(int rssi_dbm, int noise_dbm);
215 extern int iwl3945_tx_queue_init(struct iwl_priv *priv,
216                              struct iwl_tx_queue *txq, int count, u32 id);
217 extern void iwl3945_rx_replenish(void *data);
218 extern void iwl3945_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
219 extern void iwl3945_tx_queue_free(struct iwl_priv *priv, struct iwl_tx_queue *txq);
220 extern int iwl3945_send_cmd_pdu(struct iwl_priv *priv, u8 id, u16 len,
221                             const void *data);
222 extern int __must_check iwl3945_send_cmd(struct iwl_priv *priv,
223                                          struct iwl_host_cmd *cmd);
224 extern unsigned int iwl3945_fill_beacon_frame(struct iwl_priv *priv,
225                                         struct ieee80211_hdr *hdr,int left);
226
227 /*
228  * Currently used by iwl-3945-rs... look at restructuring so that it doesn't
229  * call this... todo... fix that.
230 */
231 extern u8 iwl3945_sync_station(struct iwl_priv *priv, int sta_id,
232                            u16 tx_rate, u8 flags);
233
234 /******************************************************************************
235  *
236  * Functions implemented in iwl-[34]*.c which are forward declared here
237  * for use by iwl-base.c
238  *
239  * NOTE:  The implementation of these functions are hardware specific
240  * which is why they are in the hardware specific files (vs. iwl-base.c)
241  *
242  * Naming convention --
243  * iwl3945_         <-- Its part of iwlwifi (should be changed to iwl3945_)
244  * iwl3945_hw_      <-- Hardware specific (implemented in iwl-XXXX.c by all HW)
245  * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
246  * iwl3945_bg_      <-- Called from work queue context
247  * iwl3945_mac_     <-- mac80211 callback
248  *
249  ****************************************************************************/
250 extern void iwl3945_hw_rx_handler_setup(struct iwl_priv *priv);
251 extern void iwl3945_hw_setup_deferred_work(struct iwl_priv *priv);
252 extern void iwl3945_hw_cancel_deferred_work(struct iwl_priv *priv);
253 extern int iwl3945_hw_rxq_stop(struct iwl_priv *priv);
254 extern int iwl3945_hw_set_hw_params(struct iwl_priv *priv);
255 extern int iwl3945_hw_nic_init(struct iwl_priv *priv);
256 extern int iwl3945_hw_nic_stop_master(struct iwl_priv *priv);
257 extern void iwl3945_hw_txq_ctx_free(struct iwl_priv *priv);
258 extern void iwl3945_hw_txq_ctx_stop(struct iwl_priv *priv);
259 extern int iwl3945_hw_nic_reset(struct iwl_priv *priv);
260 extern int iwl3945_hw_txq_attach_buf_to_tfd(struct iwl_priv *priv,
261                                             struct iwl_tx_queue *txq,
262                                             dma_addr_t addr, u16 len,
263                                             u8 reset, u8 pad);
264 extern void iwl3945_hw_txq_free_tfd(struct iwl_priv *priv,
265                                     struct iwl_tx_queue *txq);
266 extern int iwl3945_hw_get_temperature(struct iwl_priv *priv);
267 extern int iwl3945_hw_tx_queue_init(struct iwl_priv *priv,
268                                 struct iwl_tx_queue *txq);
269 extern unsigned int iwl3945_hw_get_beacon_cmd(struct iwl_priv *priv,
270                                  struct iwl3945_frame *frame, u8 rate);
271 void iwl3945_hw_build_tx_cmd_rate(struct iwl_priv *priv, struct iwl_cmd *cmd,
272                                      struct ieee80211_tx_info *info,
273                                      struct ieee80211_hdr *hdr,
274                                      int sta_id, int tx_id);
275 extern int iwl3945_hw_reg_send_txpower(struct iwl_priv *priv);
276 extern int iwl3945_hw_reg_set_txpower(struct iwl_priv *priv, s8 power);
277 extern void iwl3945_hw_rx_statistics(struct iwl_priv *priv,
278                                  struct iwl_rx_mem_buffer *rxb);
279 extern void iwl3945_disable_events(struct iwl_priv *priv);
280 extern int iwl4965_get_temperature(const struct iwl_priv *priv);
281
282 /**
283  * iwl3945_hw_find_station - Find station id for a given BSSID
284  * @bssid: MAC address of station ID to find
285  *
286  * NOTE:  This should not be hardware specific but the code has
287  * not yet been merged into a single common layer for managing the
288  * station tables.
289  */
290 extern u8 iwl3945_hw_find_station(struct iwl_priv *priv, const u8 *bssid);
291
292 extern int iwl3945_hw_channel_switch(struct iwl_priv *priv, u16 channel);
293
294 /*
295  * Forward declare iwl-3945.c functions for iwl-base.c
296  */
297 extern __le32 iwl3945_get_antenna_flags(const struct iwl_priv *priv);
298 extern int iwl3945_init_hw_rate_table(struct iwl_priv *priv);
299 extern void iwl3945_reg_txpower_periodic(struct iwl_priv *priv);
300 extern int iwl3945_txpower_set_from_eeprom(struct iwl_priv *priv);
301 extern u8 iwl3945_sync_sta(struct iwl_priv *priv, int sta_id,
302                  u16 tx_rate, u8 flags);
303
304 extern const struct iwl_channel_info *iwl3945_get_channel_info(
305         const struct iwl_priv *priv, enum ieee80211_band band, u16 channel);
306
307 extern int iwl3945_rs_next_rate(struct iwl_priv *priv, int rate);
308
309 /* Requires full declaration of iwl_priv before including */
310 #include "iwl-io.h"
311
312 #endif