]> pilppa.org Git - linux-2.6-omap-h63xx.git/blob - drivers/net/wireless/iwlwifi/iwl-3945.h
098ac768ee26bc3a37389f746208fcd5c46ad686
[linux-2.6-omap-h63xx.git] / drivers / net / wireless / iwlwifi / iwl-3945.h
1 /******************************************************************************
2  *
3  * Copyright(c) 2003 - 2008 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-3945-hw.h"
49 #include "iwl-debug.h"
50 #include "iwl-power.h"
51 #include "iwl-dev.h"
52 #include "iwl-3945-led.h"
53
54 /* Highest firmware API version supported */
55 #define IWL3945_UCODE_API_MAX 2
56
57 /* Lowest firmware API version supported */
58 #define IWL3945_UCODE_API_MIN 1
59
60 #define IWL3945_FW_PRE  "iwlwifi-3945-"
61 #define _IWL3945_MODULE_FIRMWARE(api) IWL3945_FW_PRE #api ".ucode"
62 #define IWL3945_MODULE_FIRMWARE(api) _IWL3945_MODULE_FIRMWARE(api)
63
64 /* Default noise level to report when noise measurement is not available.
65  *   This may be because we're:
66  *   1)  Not associated (4965, no beacon statistics being sent to driver)
67  *   2)  Scanning (noise measurement does not apply to associated channel)
68  *   3)  Receiving CCK (3945 delivers noise info only for OFDM frames)
69  * Use default noise value of -127 ... this is below the range of measurable
70  *   Rx dBm for either 3945 or 4965, so it can indicate "unmeasurable" to user.
71  *   Also, -127 works better than 0 when averaging frames with/without
72  *   noise info (e.g. averaging might be done in app); measured dBm values are
73  *   always negative ... using a negative value as the default keeps all
74  *   averages within an s8's (used in some apps) range of negative values. */
75 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
76
77 /* Module parameters accessible from iwl-*.c */
78 extern int iwl3945_param_hwcrypto;
79 extern int iwl3945_param_queues_num;
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 IWL_RX_BUF_SIZE           3000U
100 #define DEFAULT_RTS_THRESHOLD     2347U
101 #define MIN_RTS_THRESHOLD         0U
102 #define MAX_RTS_THRESHOLD         2347U
103 #define MAX_MSDU_SIZE             2304U
104 #define MAX_MPDU_SIZE             2346U
105 #define DEFAULT_BEACON_INTERVAL   100U
106 #define DEFAULT_SHORT_RETRY_LIMIT 7U
107 #define DEFAULT_LONG_RETRY_LIMIT  4U
108
109 int iwl3945_x2_queue_used(const struct iwl_queue *q, int i);
110
111 #define MAX_NUM_OF_TBS          (20)
112
113 /* One for each TFD */
114 struct iwl3945_tx_info {
115         struct sk_buff *skb[MAX_NUM_OF_TBS];
116 };
117
118 #include "iwl-agn-rs.h"
119
120 #define IWL_TX_FIFO_AC0 0
121 #define IWL_TX_FIFO_AC1 1
122 #define IWL_TX_FIFO_AC2 2
123 #define IWL_TX_FIFO_AC3 3
124 #define IWL_TX_FIFO_HCCA_1      5
125 #define IWL_TX_FIFO_HCCA_2      6
126 #define IWL_TX_FIFO_NONE        7
127
128 /* Minimum number of queues. MAX_NUM is defined in hw specific files */
129 #define IWL_MIN_NUM_QUEUES      4
130
131 #define IEEE80211_DATA_LEN              2304
132 #define IEEE80211_4ADDR_LEN             30
133 #define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
134 #define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
135
136 struct iwl3945_frame {
137         union {
138                 struct ieee80211_hdr frame;
139                 struct iwl3945_tx_beacon_cmd beacon;
140                 u8 raw[IEEE80211_FRAME_LEN];
141                 u8 cmd[360];
142         } u;
143         struct list_head list;
144 };
145
146 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
147 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
148 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
149
150 struct iwl3945_cmd;
151 struct iwl_priv;
152
153 struct iwl3945_cmd_meta {
154         struct iwl3945_cmd_meta *source;
155         union {
156                 struct sk_buff *skb;
157                 int (*callback)(struct iwl_priv *priv,
158                                 struct iwl3945_cmd *cmd, struct sk_buff *skb);
159         } __attribute__ ((packed)) u;
160
161         /* The CMD_SIZE_HUGE flag bit indicates that the command
162          * structure is stored at the end of the shared queue memory. */
163         u32 flags;
164
165 } __attribute__ ((packed));
166
167 /**
168  * struct iwl3945_cmd
169  *
170  * For allocation of the command and tx queues, this establishes the overall
171  * size of the largest command we send to uCode, except for a scan command
172  * (which is relatively huge; space is allocated separately).
173  */
174 struct iwl3945_cmd {
175         struct iwl3945_cmd_meta meta;
176         struct iwl_cmd_header hdr;
177         union {
178                 struct iwl3945_addsta_cmd addsta;
179                 struct iwl_led_cmd led;
180                 u32 flags;
181                 u8 val8;
182                 u16 val16;
183                 u32 val32;
184                 struct iwl_bt_cmd bt;
185                 struct iwl_rxon_time_cmd rxon_time;
186                 struct iwl_powertable_cmd powertable;
187                 struct iwl_qosparam_cmd qosparam;
188                 struct iwl3945_tx_cmd tx;
189                 struct iwl3945_tx_beacon_cmd tx_beacon;
190                 struct iwl3945_rxon_assoc_cmd rxon_assoc;
191                 u8 *indirect;
192                 u8 payload[360];
193         } __attribute__ ((packed)) cmd;
194 } __attribute__ ((packed));
195
196 struct iwl3945_host_cmd {
197         u8 id;
198         u16 len;
199         struct iwl3945_cmd_meta meta;
200         const void *data;
201 };
202
203 #define TFD39_MAX_PAYLOAD_SIZE (sizeof(struct iwl3945_cmd) - \
204                               sizeof(struct iwl3945_cmd_meta))
205
206 /*
207  * RX related structures and functions
208  */
209 #define RX_FREE_BUFFERS 64
210 #define RX_LOW_WATERMARK 8
211
212 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
213 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
214 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
215
216 #define IWL_SUPPORTED_RATES_IE_LEN         8
217
218 #define SCAN_INTERVAL 100
219
220 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
221 #define STATUS_HCMD_SYNC_ACTIVE 1       /* sync host command in progress */
222 #define STATUS_INT_ENABLED      2
223 #define STATUS_RF_KILL_HW       3
224 #define STATUS_RF_KILL_SW       4
225 #define STATUS_INIT             5
226 #define STATUS_ALIVE            6
227 #define STATUS_READY            7
228 #define STATUS_TEMPERATURE      8
229 #define STATUS_GEO_CONFIGURED   9
230 #define STATUS_EXIT_PENDING     10
231 #define STATUS_IN_SUSPEND       11
232 #define STATUS_STATISTICS       12
233 #define STATUS_SCANNING         13
234 #define STATUS_SCAN_ABORTING    14
235 #define STATUS_SCAN_HW          15
236 #define STATUS_POWER_PMI        16
237 #define STATUS_FW_ERROR         17
238 #define STATUS_CONF_PENDING     18
239
240 #define MAX_TID_COUNT        9
241
242 #define IWL_INVALID_RATE     0xFF
243 #define IWL_INVALID_VALUE    -1
244
245 #define STA_PS_STATUS_WAKE             0
246 #define STA_PS_STATUS_SLEEP            1
247
248 struct iwl3945_ibss_seq {
249         u8 mac[ETH_ALEN];
250         u16 seq_num;
251         u16 frag_num;
252         unsigned long packet_time;
253         struct list_head list;
254 };
255
256 #define IWL_RX_HDR(x) ((struct iwl3945_rx_frame_hdr *)(\
257                        x->u.rx_frame.stats.payload + \
258                        x->u.rx_frame.stats.phy_count))
259 #define IWL_RX_END(x) ((struct iwl3945_rx_frame_end *)(\
260                        IWL_RX_HDR(x)->payload + \
261                        le16_to_cpu(IWL_RX_HDR(x)->len)))
262 #define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
263 #define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)
264
265
266 /******************************************************************************
267  *
268  * Functions implemented in iwl-base.c which are forward declared here
269  * for use by iwl-*.c
270  *
271  *****************************************************************************/
272 struct iwl3945_addsta_cmd;
273 extern int iwl3945_send_add_station(struct iwl_priv *priv,
274                                 struct iwl3945_addsta_cmd *sta, u8 flags);
275 extern u8 iwl3945_add_station(struct iwl_priv *priv, const u8 *bssid,
276                           int is_ap, u8 flags);
277 extern int iwl3945_power_init_handle(struct iwl_priv *priv);
278 extern int iwl3945_eeprom_init(struct iwl_priv *priv);
279 extern int iwl3945_rx_queue_alloc(struct iwl_priv *priv);
280 extern void iwl3945_rx_queue_reset(struct iwl_priv *priv,
281                                struct iwl_rx_queue *rxq);
282 extern int iwl3945_calc_db_from_ratio(int sig_ratio);
283 extern int iwl3945_calc_sig_qual(int rssi_dbm, int noise_dbm);
284 extern int iwl3945_tx_queue_init(struct iwl_priv *priv,
285                              struct iwl3945_tx_queue *txq, int count, u32 id);
286 extern void iwl3945_rx_replenish(void *data);
287 extern void iwl3945_tx_queue_free(struct iwl_priv *priv, struct iwl3945_tx_queue *txq);
288 extern int iwl3945_send_cmd_pdu(struct iwl_priv *priv, u8 id, u16 len,
289                             const void *data);
290 extern int __must_check iwl3945_send_cmd(struct iwl_priv *priv,
291                 struct iwl3945_host_cmd *cmd);
292 extern unsigned int iwl3945_fill_beacon_frame(struct iwl_priv *priv,
293                                         struct ieee80211_hdr *hdr,int left);
294 extern int iwl3945_rx_queue_update_write_ptr(struct iwl_priv *priv,
295                                          struct iwl_rx_queue *q);
296 extern int iwl3945_send_statistics_request(struct iwl_priv *priv);
297 extern void iwl3945_set_decrypted_flag(struct iwl_priv *priv, struct sk_buff *skb,
298                                    u32 decrypt_res,
299                                    struct ieee80211_rx_status *stats);
300
301 /*
302  * Currently used by iwl-3945-rs... look at restructuring so that it doesn't
303  * call this... todo... fix that.
304 */
305 extern u8 iwl3945_sync_station(struct iwl_priv *priv, int sta_id,
306                            u16 tx_rate, u8 flags);
307
308 /******************************************************************************
309  *
310  * Functions implemented in iwl-[34]*.c which are forward declared here
311  * for use by iwl-base.c
312  *
313  * NOTE:  The implementation of these functions are hardware specific
314  * which is why they are in the hardware specific files (vs. iwl-base.c)
315  *
316  * Naming convention --
317  * iwl3945_         <-- Its part of iwlwifi (should be changed to iwl3945_)
318  * iwl3945_hw_      <-- Hardware specific (implemented in iwl-XXXX.c by all HW)
319  * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
320  * iwl3945_bg_      <-- Called from work queue context
321  * iwl3945_mac_     <-- mac80211 callback
322  *
323  ****************************************************************************/
324 extern void iwl3945_hw_rx_handler_setup(struct iwl_priv *priv);
325 extern void iwl3945_hw_setup_deferred_work(struct iwl_priv *priv);
326 extern void iwl3945_hw_cancel_deferred_work(struct iwl_priv *priv);
327 extern int iwl3945_hw_rxq_stop(struct iwl_priv *priv);
328 extern int iwl3945_hw_set_hw_params(struct iwl_priv *priv);
329 extern int iwl3945_hw_nic_init(struct iwl_priv *priv);
330 extern int iwl3945_hw_nic_stop_master(struct iwl_priv *priv);
331 extern void iwl3945_hw_txq_ctx_free(struct iwl_priv *priv);
332 extern void iwl3945_hw_txq_ctx_stop(struct iwl_priv *priv);
333 extern int iwl3945_hw_nic_reset(struct iwl_priv *priv);
334 extern int iwl3945_hw_txq_attach_buf_to_tfd(struct iwl_priv *priv, void *tfd,
335                                         dma_addr_t addr, u16 len);
336 extern int iwl3945_hw_txq_free_tfd(struct iwl_priv *priv, struct iwl3945_tx_queue *txq);
337 extern int iwl3945_hw_get_temperature(struct iwl_priv *priv);
338 extern int iwl3945_hw_tx_queue_init(struct iwl_priv *priv,
339                                 struct iwl3945_tx_queue *txq);
340 extern unsigned int iwl3945_hw_get_beacon_cmd(struct iwl_priv *priv,
341                                  struct iwl3945_frame *frame, u8 rate);
342 extern int iwl3945_hw_get_rx_read(struct iwl_priv *priv);
343 extern void iwl3945_hw_build_tx_cmd_rate(struct iwl_priv *priv,
344                                      struct iwl3945_cmd *cmd,
345                                      struct ieee80211_tx_info *info,
346                                      struct ieee80211_hdr *hdr,
347                                      int sta_id, int tx_id);
348 extern int iwl3945_hw_reg_send_txpower(struct iwl_priv *priv);
349 extern int iwl3945_hw_reg_set_txpower(struct iwl_priv *priv, s8 power);
350 extern void iwl3945_hw_rx_statistics(struct iwl_priv *priv,
351                                  struct iwl_rx_mem_buffer *rxb);
352 extern void iwl3945_disable_events(struct iwl_priv *priv);
353 extern int iwl4965_get_temperature(const struct iwl_priv *priv);
354
355 /**
356  * iwl3945_hw_find_station - Find station id for a given BSSID
357  * @bssid: MAC address of station ID to find
358  *
359  * NOTE:  This should not be hardware specific but the code has
360  * not yet been merged into a single common layer for managing the
361  * station tables.
362  */
363 extern u8 iwl3945_hw_find_station(struct iwl_priv *priv, const u8 *bssid);
364
365 extern int iwl3945_hw_channel_switch(struct iwl_priv *priv, u16 channel);
366
367 /*
368  * Forward declare iwl-3945.c functions for iwl-base.c
369  */
370 extern __le32 iwl3945_get_antenna_flags(const struct iwl_priv *priv);
371 extern int iwl3945_init_hw_rate_table(struct iwl_priv *priv);
372 extern void iwl3945_reg_txpower_periodic(struct iwl_priv *priv);
373 extern int iwl3945_txpower_set_from_eeprom(struct iwl_priv *priv);
374 extern u8 iwl3945_sync_sta(struct iwl_priv *priv, int sta_id,
375                  u16 tx_rate, u8 flags);
376
377 #ifdef CONFIG_IWL3945_RFKILL
378 struct iwl_priv;
379
380 void iwl3945_rfkill_set_hw_state(struct iwl_priv *priv);
381 void iwl3945_rfkill_unregister(struct iwl_priv *priv);
382 int iwl3945_rfkill_init(struct iwl_priv *priv);
383 #else
384 static inline void iwl3945_rfkill_set_hw_state(struct iwl_priv *priv) {}
385 static inline void iwl3945_rfkill_unregister(struct iwl_priv *priv) {}
386 static inline int iwl3945_rfkill_init(struct iwl_priv *priv) { return 0; }
387 #endif
388
389 static inline int iwl3945_is_associated(struct iwl_priv *priv)
390 {
391         return (priv->active39_rxon.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
392 }
393
394 extern const struct iwl_channel_info *iwl3945_get_channel_info(
395         const struct iwl_priv *priv, enum ieee80211_band band, u16 channel);
396
397 extern int iwl3945_rs_next_rate(struct iwl_priv *priv, int rate);
398
399 /* Requires full declaration of iwl_priv before including */
400 #include "iwl-3945-io.h"
401
402 #endif