1 /******************************************************************************
2  *
3  * Copyright(c) 2003 - 2011 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 const 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 	struct timer_list rate_scale_flush;
99 	struct iwl3945_rate_scale_data win[IWL_RATE_COUNT_3945];
100 #ifdef CONFIG_MAC80211_DEBUGFS
101 	struct dentry *rs_sta_dbgfs_stats_table_file;
102 #endif
103 
104 	/* used to be in sta_info */
105 	int last_txrate_idx;
106 };
107 
108 
109 /*
110  * The common struct MUST be first because it is shared between
111  * 3945 and 4965!
112  */
113 struct iwl3945_sta_priv {
114 	struct iwl_station_priv_common common;
115 	struct iwl3945_rs_sta rs_sta;
116 };
117 
118 enum iwl3945_antenna {
119 	IWL_ANTENNA_DIVERSITY,
120 	IWL_ANTENNA_MAIN,
121 	IWL_ANTENNA_AUX
122 };
123 
124 /*
125  * RTS threshold here is total size [2347] minus 4 FCS bytes
126  * Per spec:
127  *   a value of 0 means RTS on all data/management packets
128  *   a value > max MSDU size means no RTS
129  * else RTS for data/management frames where MPDU is larger
130  *   than RTS value.
131  */
132 #define DEFAULT_RTS_THRESHOLD     2347U
133 #define MIN_RTS_THRESHOLD         0U
134 #define MAX_RTS_THRESHOLD         2347U
135 #define MAX_MSDU_SIZE		  2304U
136 #define MAX_MPDU_SIZE		  2346U
137 #define DEFAULT_BEACON_INTERVAL   100U
138 #define	DEFAULT_SHORT_RETRY_LIMIT 7U
139 #define	DEFAULT_LONG_RETRY_LIMIT  4U
140 
141 #define IWL_TX_FIFO_AC0	0
142 #define IWL_TX_FIFO_AC1	1
143 #define IWL_TX_FIFO_AC2	2
144 #define IWL_TX_FIFO_AC3	3
145 #define IWL_TX_FIFO_HCCA_1	5
146 #define IWL_TX_FIFO_HCCA_2	6
147 #define IWL_TX_FIFO_NONE	7
148 
149 #define IEEE80211_DATA_LEN              2304
150 #define IEEE80211_4ADDR_LEN             30
151 #define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
152 #define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
153 
154 struct iwl3945_frame {
155 	union {
156 		struct ieee80211_hdr frame;
157 		struct iwl3945_tx_beacon_cmd beacon;
158 		u8 raw[IEEE80211_FRAME_LEN];
159 		u8 cmd[360];
160 	} u;
161 	struct list_head list;
162 };
163 
164 #define SEQ_TO_SN(seq) (((seq) & IEEE80211_SCTL_SEQ) >> 4)
165 #define SN_TO_SEQ(ssn) (((ssn) << 4) & IEEE80211_SCTL_SEQ)
166 #define MAX_SN ((IEEE80211_SCTL_SEQ) >> 4)
167 
168 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
169 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
170 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
171 
172 #define IWL_SUPPORTED_RATES_IE_LEN         8
173 
174 #define SCAN_INTERVAL 100
175 
176 #define MAX_TID_COUNT        9
177 
178 #define IWL_INVALID_RATE     0xFF
179 #define IWL_INVALID_VALUE    -1
180 
181 #define STA_PS_STATUS_WAKE             0
182 #define STA_PS_STATUS_SLEEP            1
183 
184 struct iwl3945_ibss_seq {
185 	u8 mac[ETH_ALEN];
186 	u16 seq_num;
187 	u16 frag_num;
188 	unsigned long packet_time;
189 	struct list_head list;
190 };
191 
192 #define IWL_RX_HDR(x) ((struct iwl3945_rx_frame_hdr *)(\
193 		       x->u.rx_frame.stats.payload + \
194 		       x->u.rx_frame.stats.phy_count))
195 #define IWL_RX_END(x) ((struct iwl3945_rx_frame_end *)(\
196 		       IWL_RX_HDR(x)->payload + \
197 		       le16_to_cpu(IWL_RX_HDR(x)->len)))
198 #define IWL_RX_STATS(x) (&x->u.rx_frame.stats)
199 #define IWL_RX_DATA(x) (IWL_RX_HDR(x)->payload)
200 
201 
202 /******************************************************************************
203  *
204  * Functions implemented in iwl3945-base.c which are forward declared here
205  * for use by iwl-*.c
206  *
207  *****************************************************************************/
208 extern int iwl3945_calc_db_from_ratio(int sig_ratio);
209 extern void iwl3945_rx_replenish(void *data);
210 extern void iwl3945_rx_queue_reset(struct iwl_priv *priv, struct iwl_rx_queue *rxq);
211 extern unsigned int iwl3945_fill_beacon_frame(struct iwl_priv *priv,
212 					struct ieee80211_hdr *hdr, int left);
213 extern int iwl3945_dump_nic_event_log(struct iwl_priv *priv, bool full_log,
214 				       char **buf, bool display);
215 extern void iwl3945_dump_nic_error_log(struct iwl_priv *priv);
216 
217 /******************************************************************************
218  *
219  * Functions implemented in iwl-[34]*.c which are forward declared here
220  * for use by iwl3945-base.c
221  *
222  * NOTE:  The implementation of these functions are hardware specific
223  * which is why they are in the hardware specific files (vs. iwl-base.c)
224  *
225  * Naming convention --
226  * iwl3945_         <-- Its part of iwlwifi (should be changed to iwl3945_)
227  * iwl3945_hw_      <-- Hardware specific (implemented in iwl-XXXX.c by all HW)
228  * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
229  * iwl3945_bg_      <-- Called from work queue context
230  * iwl3945_mac_     <-- mac80211 callback
231  *
232  ****************************************************************************/
233 extern void iwl3945_hw_rx_handler_setup(struct iwl_priv *priv);
234 extern void iwl3945_hw_setup_deferred_work(struct iwl_priv *priv);
235 extern void iwl3945_hw_cancel_deferred_work(struct iwl_priv *priv);
236 extern int iwl3945_hw_rxq_stop(struct iwl_priv *priv);
237 extern int iwl3945_hw_set_hw_params(struct iwl_priv *priv);
238 extern int iwl3945_hw_nic_init(struct iwl_priv *priv);
239 extern int iwl3945_hw_nic_stop_master(struct iwl_priv *priv);
240 extern void iwl3945_hw_txq_ctx_free(struct iwl_priv *priv);
241 extern void iwl3945_hw_txq_ctx_stop(struct iwl_priv *priv);
242 extern int iwl3945_hw_nic_reset(struct iwl_priv *priv);
243 extern int iwl3945_hw_txq_attach_buf_to_tfd(struct iwl_priv *priv,
244 					    struct iwl_tx_queue *txq,
245 					    dma_addr_t addr, u16 len,
246 					    u8 reset, u8 pad);
247 extern void iwl3945_hw_txq_free_tfd(struct iwl_priv *priv,
248 				    struct iwl_tx_queue *txq);
249 extern int iwl3945_hw_get_temperature(struct iwl_priv *priv);
250 extern int iwl3945_hw_tx_queue_init(struct iwl_priv *priv,
251 				struct iwl_tx_queue *txq);
252 extern unsigned int iwl3945_hw_get_beacon_cmd(struct iwl_priv *priv,
253 				 struct iwl3945_frame *frame, u8 rate);
254 void iwl3945_hw_build_tx_cmd_rate(struct iwl_priv *priv,
255 				  struct iwl_device_cmd *cmd,
256 				  struct ieee80211_tx_info *info,
257 				  struct ieee80211_hdr *hdr,
258 				  int sta_id, int tx_id);
259 extern int iwl3945_hw_reg_send_txpower(struct iwl_priv *priv);
260 extern int iwl3945_hw_reg_set_txpower(struct iwl_priv *priv, s8 power);
261 extern void iwl3945_hw_rx_statistics(struct iwl_priv *priv,
262 				 struct iwl_rx_mem_buffer *rxb);
263 void iwl3945_reply_statistics(struct iwl_priv *priv,
264 			      struct iwl_rx_mem_buffer *rxb);
265 extern void iwl3945_disable_events(struct iwl_priv *priv);
266 extern int iwl4965_get_temperature(const struct iwl_priv *priv);
267 extern void iwl3945_post_associate(struct iwl_priv *priv);
268 extern void iwl3945_config_ap(struct iwl_priv *priv);
269 
270 extern int iwl3945_commit_rxon(struct iwl_priv *priv,
271 			       struct iwl_rxon_context *ctx);
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 struct ieee80211_ops iwl3945_hw_ops;
284 
285 /*
286  * Forward declare iwl-3945.c functions for iwl3945-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 
293 extern const struct iwl_channel_info *iwl3945_get_channel_info(
294 	const struct iwl_priv *priv, enum ieee80211_band band, u16 channel);
295 
296 extern int iwl3945_rs_next_rate(struct iwl_priv *priv, int rate);
297 
298 /* scanning */
299 int iwl3945_request_scan(struct iwl_priv *priv, struct ieee80211_vif *vif);
300 void iwl3945_post_scan(struct iwl_priv *priv);
301 
302 /* rates */
303 extern const struct iwl3945_rate_info iwl3945_rates[IWL_RATE_COUNT_3945];
304 
305 /* Requires full declaration of iwl_priv before including */
306 #include "iwl-io.h"
307 
308 #endif
309