Commit | Line | Data |
---|---|---|
48f20d35 EG |
1 | /****************************************************************************** |
2 | * | |
3 | * This file is provided under a dual BSD/GPLv2 license. When using or | |
4 | * redistributing this file, you may do so under either license. | |
5 | * | |
6 | * GPL LICENSE SUMMARY | |
7 | * | |
8 | * Copyright(c) 2007 - 2011 Intel Corporation. All rights reserved. | |
9 | * | |
10 | * This program is free software; you can redistribute it and/or modify | |
11 | * it under the terms of version 2 of the GNU General Public License as | |
12 | * published by the Free Software Foundation. | |
13 | * | |
14 | * This program is distributed in the hope that it will be useful, but | |
15 | * WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
17 | * General Public License for more details. | |
18 | * | |
19 | * You should have received a copy of the GNU General Public License | |
20 | * along with this program; if not, write to the Free Software | |
21 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, | |
22 | * USA | |
23 | * | |
24 | * The full GNU General Public License is included in this distribution | |
25 | * in the file called LICENSE.GPL. | |
26 | * | |
27 | * Contact Information: | |
28 | * Intel Linux Wireless <ilw@linux.intel.com> | |
29 | * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 | |
30 | * | |
31 | * BSD LICENSE | |
32 | * | |
33 | * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved. | |
34 | * All rights reserved. | |
35 | * | |
36 | * Redistribution and use in source and binary forms, with or without | |
37 | * modification, are permitted provided that the following conditions | |
38 | * are met: | |
39 | * | |
40 | * * Redistributions of source code must retain the above copyright | |
41 | * notice, this list of conditions and the following disclaimer. | |
42 | * * Redistributions in binary form must reproduce the above copyright | |
43 | * notice, this list of conditions and the following disclaimer in | |
44 | * the documentation and/or other materials provided with the | |
45 | * distribution. | |
46 | * * Neither the name Intel Corporation nor the names of its | |
47 | * contributors may be used to endorse or promote products derived | |
48 | * from this software without specific prior written permission. | |
49 | * | |
50 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
51 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
52 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
53 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
54 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
55 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
56 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
57 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
58 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
59 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
60 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
61 | * | |
62 | *****************************************************************************/ | |
63 | #ifndef __iwl_shared_h__ | |
64 | #define __iwl_shared_h__ | |
65 | ||
a72b8b08 EG |
66 | #include <linux/types.h> |
67 | #include <linux/spinlock.h> | |
68 | #include <linux/mutex.h> | |
69 | #include <linux/gfp.h> | |
ba562f71 | 70 | #include <net/mac80211.h> |
a72b8b08 | 71 | |
5f85a789 EG |
72 | #include "iwl-commands.h" |
73 | ||
e6bb4c9c EG |
74 | /*This files includes all the types / functions that are exported by the |
75 | * upper layer to the bus and transport layer */ | |
76 | ||
48f20d35 | 77 | struct iwl_cfg; |
cac988a6 | 78 | struct iwl_bus; |
48f20d35 | 79 | struct iwl_priv; |
d6189124 | 80 | struct iwl_sensitivity_ranges; |
e6bb4c9c | 81 | struct iwl_trans_ops; |
48f20d35 | 82 | |
332a4bad EG |
83 | #define DRV_NAME "iwlagn" |
84 | #define IWLWIFI_VERSION "in-tree:" | |
85 | #define DRV_COPYRIGHT "Copyright(c) 2003-2011 Intel Corporation" | |
86 | #define DRV_AUTHOR "<ilw@linux.intel.com>" | |
87 | ||
48f20d35 EG |
88 | extern struct iwl_mod_params iwlagn_mod_params; |
89 | ||
e4ef84d9 WYG |
90 | /** |
91 | * struct iwl_mod_params | |
92 | * @sw_crypto: using hardware encryption, default = 0 | |
93 | * @num_of_queues: number of tx queue, HW dependent | |
94 | * @disable_11n: 11n capabilities enabled, default = 0 | |
95 | * @amsdu_size_8K: enable 8K amsdu size, default = 1 | |
96 | * @antenna: both antennas (use diversity), default = 0 | |
97 | * @restart_fw: restart firmware, default = 1 | |
98 | * @plcp_check: enable plcp health check, default = true | |
99 | * @ack_check: disable ack health check, default = false | |
100 | * @wd_disable: enable stuck queue check, default = false | |
101 | * @bt_coex_active: enable bt coex, default = true | |
102 | * @led_mode: system default, default = 0 | |
103 | * @no_sleep_autoadjust: disable autoadjust, default = true | |
104 | * @power_save: disable power save, default = false | |
105 | * @power_level: power level, default = 1 | |
106 | * @debug_level: levels are IWL_DL_* | |
107 | * @ant_coupling: antenna coupling in dB, default = 0 | |
108 | * @bt_ch_announce: BT channel inhibition, default = enable | |
109 | * @wanted_ucode_alternative: ucode alternative to use, default = 1 | |
110 | * @auto_agg: enable agg. without check, default = true | |
111 | */ | |
48f20d35 | 112 | struct iwl_mod_params { |
e4ef84d9 WYG |
113 | int sw_crypto; |
114 | int num_of_queues; | |
115 | int disable_11n; | |
116 | int amsdu_size_8K; | |
117 | int antenna; | |
118 | int restart_fw; | |
119 | bool plcp_check; | |
120 | bool ack_check; | |
121 | bool wd_disable; | |
122 | bool bt_coex_active; | |
123 | int led_mode; | |
124 | bool no_sleep_autoadjust; | |
125 | bool power_save; | |
126 | int power_level; | |
127 | u32 debug_level; | |
48f20d35 | 128 | int ant_coupling; |
e4ef84d9 | 129 | bool bt_ch_announce; |
48f20d35 | 130 | int wanted_ucode_alternative; |
e4ef84d9 | 131 | bool auto_agg; |
48f20d35 EG |
132 | }; |
133 | ||
d6189124 EG |
134 | /** |
135 | * struct iwl_hw_params | |
136 | * @max_txq_num: Max # Tx queues supported | |
fd656935 | 137 | * @num_ampdu_queues: num of ampdu queues |
d6189124 EG |
138 | * @tx/rx_chains_num: Number of TX/RX chains |
139 | * @valid_tx/rx_ant: usable antennas | |
d6189124 EG |
140 | * @max_stations: |
141 | * @ht40_channel: is 40MHz width possible in band 2.4 | |
fd656935 EG |
142 | * @beacon_time_tsf_bits: number of valid tsf bits for beacon time |
143 | * @sku: | |
144 | * @rx_page_order: Rx buffer page order | |
145 | * @rx_wrt_ptr_reg: FH{39}_RSCSR_CHNL0_WPTR | |
d6189124 EG |
146 | * BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ) |
147 | * @sw_crypto: 0 for hw, 1 for sw | |
148 | * @max_xxx_size: for ucode uses | |
149 | * @ct_kill_threshold: temperature threshold | |
f22be624 | 150 | * @wd_timeout: TX queues watchdog timeout |
d6189124 EG |
151 | * @calib_init_cfg: setup initial calibrations for the hw |
152 | * @calib_rt_cfg: setup runtime calibrations for the hw | |
153 | * @struct iwl_sensitivity_ranges: range of sensitivity values | |
154 | */ | |
155 | struct iwl_hw_params { | |
fd656935 EG |
156 | u8 max_txq_num; |
157 | u8 num_ampdu_queues; | |
d6189124 EG |
158 | u8 tx_chains_num; |
159 | u8 rx_chains_num; | |
160 | u8 valid_tx_ant; | |
161 | u8 valid_rx_ant; | |
d6189124 EG |
162 | u8 max_stations; |
163 | u8 ht40_channel; | |
fd656935 EG |
164 | bool shadow_reg_enable; |
165 | u16 beacon_time_tsf_bits; | |
166 | u16 sku; | |
167 | u32 rx_page_order; | |
d6189124 EG |
168 | u32 max_inst_size; |
169 | u32 max_data_size; | |
170 | u32 ct_kill_threshold; /* value in hw-dependent units */ | |
171 | u32 ct_kill_exit_threshold; /* value in hw-dependent units */ | |
172 | /* for 1000, 6000 series and up */ | |
f22be624 EG |
173 | unsigned int wd_timeout; |
174 | ||
d6189124 EG |
175 | u32 calib_init_cfg; |
176 | u32 calib_rt_cfg; | |
177 | const struct iwl_sensitivity_ranges *sens; | |
178 | }; | |
179 | ||
5f85a789 EG |
180 | /** |
181 | * struct iwl_ht_agg - aggregation status while waiting for block-ack | |
182 | * @txq_id: Tx queue used for Tx attempt | |
183 | * @wait_for_ba: Expect block-ack before next Tx reply | |
184 | * @rate_n_flags: Rate at which Tx was attempted | |
185 | * | |
186 | * If REPLY_TX indicates that aggregation was attempted, driver must wait | |
187 | * for block ack (REPLY_COMPRESSED_BA). This struct stores tx reply info | |
188 | * until block ack arrives. | |
189 | */ | |
190 | struct iwl_ht_agg { | |
191 | u16 txq_id; | |
192 | u16 wait_for_ba; | |
193 | u32 rate_n_flags; | |
194 | #define IWL_AGG_OFF 0 | |
195 | #define IWL_AGG_ON 1 | |
196 | #define IWL_EMPTYING_HW_QUEUE_ADDBA 2 | |
197 | #define IWL_EMPTYING_HW_QUEUE_DELBA 3 | |
198 | u8 state; | |
5f85a789 EG |
199 | }; |
200 | ||
201 | struct iwl_tid_data { | |
202 | u16 seq_number; /* agn only */ | |
203 | u16 tfds_in_queue; | |
204 | struct iwl_ht_agg agg; | |
205 | }; | |
206 | ||
cac988a6 EG |
207 | /** |
208 | * struct iwl_shared - shared fields for all the layers of the driver | |
209 | * | |
8f470ce3 EG |
210 | * @dbg_level_dev: dbg level set per device. Prevails on |
211 | * iwlagn_mod_params.debug_level if set (!= 0) | |
fd656935 | 212 | * @ucode_owner: IWL_OWNERSHIP_* |
cefeaa5f | 213 | * @cmd_queue: command queue number |
63013ae3 | 214 | * @status: STATUS_* |
cac988a6 EG |
215 | * @bus: pointer to the bus layer data |
216 | * @priv: pointer to the upper layer data | |
d6189124 | 217 | * @hw_params: see struct iwl_hw_params |
74e28e44 | 218 | * @workqueue: the workqueue used by all the layers of the driver |
10b15e6f | 219 | * @lock: protect general shared data |
f39c95e8 EG |
220 | * @sta_lock: protects the station table. |
221 | * If lock and sta_lock are needed, lock must be acquired first. | |
6ac2f839 | 222 | * @mutex: |
cac988a6 EG |
223 | */ |
224 | struct iwl_shared { | |
8f470ce3 EG |
225 | #ifdef CONFIG_IWLWIFI_DEBUG |
226 | u32 dbg_level_dev; | |
227 | #endif /* CONFIG_IWLWIFI_DEBUG */ | |
228 | ||
fd656935 EG |
229 | #define IWL_OWNERSHIP_DRIVER 0 |
230 | #define IWL_OWNERSHIP_TM 1 | |
231 | u8 ucode_owner; | |
cefeaa5f | 232 | u8 cmd_queue; |
63013ae3 | 233 | unsigned long status; |
57210f7c | 234 | bool wowlan; |
cefeaa5f | 235 | |
cac988a6 EG |
236 | struct iwl_bus *bus; |
237 | struct iwl_priv *priv; | |
e6bb4c9c | 238 | struct iwl_trans *trans; |
d6189124 | 239 | struct iwl_hw_params hw_params; |
74e28e44 EG |
240 | |
241 | struct workqueue_struct *workqueue; | |
10b15e6f | 242 | spinlock_t lock; |
f39c95e8 | 243 | spinlock_t sta_lock; |
6ac2f839 | 244 | struct mutex mutex; |
5f85a789 | 245 | |
e20d4341 EG |
246 | /*these 2 shouldn't really be here, but they are needed for |
247 | * iwl_queue_stop, which is called from the upper layer too | |
248 | */ | |
249 | u8 mac80211_registered; | |
250 | struct ieee80211_hw *hw; | |
251 | ||
5f85a789 | 252 | struct iwl_tid_data tid_data[IWLAGN_STATION_COUNT][IWL_MAX_TID_COUNT]; |
cac988a6 EG |
253 | }; |
254 | ||
255 | /*Whatever _m is (iwl_trans, iwl_priv, iwl_bus, these macros will work */ | |
256 | #define priv(_m) ((_m)->shrd->priv) | |
257 | #define bus(_m) ((_m)->shrd->bus) | |
e6bb4c9c | 258 | #define trans(_m) ((_m)->shrd->trans) |
d6189124 | 259 | #define hw_params(_m) ((_m)->shrd->hw_params) |
cac988a6 | 260 | |
8f470ce3 EG |
261 | #ifdef CONFIG_IWLWIFI_DEBUG |
262 | /* | |
263 | * iwl_get_debug_level: Return active debug level for device | |
264 | * | |
265 | * Using sysfs it is possible to set per device debug level. This debug | |
266 | * level will be used if set, otherwise the global debug level which can be | |
267 | * set via module parameter is used. | |
268 | */ | |
269 | static inline u32 iwl_get_debug_level(struct iwl_shared *shrd) | |
270 | { | |
271 | if (shrd->dbg_level_dev) | |
272 | return shrd->dbg_level_dev; | |
273 | else | |
274 | return iwlagn_mod_params.debug_level; | |
275 | } | |
276 | #else | |
277 | static inline u32 iwl_get_debug_level(struct iwl_shared *shrd) | |
278 | { | |
279 | return iwlagn_mod_params.debug_level; | |
280 | } | |
281 | #endif | |
282 | ||
790428b6 EG |
283 | static inline void iwl_free_pages(struct iwl_shared *shrd, unsigned long page) |
284 | { | |
285 | free_pages(page, shrd->hw_params.rx_page_order); | |
286 | } | |
287 | ||
5a878bf6 EG |
288 | struct iwl_rx_mem_buffer { |
289 | dma_addr_t page_dma; | |
290 | struct page *page; | |
291 | struct list_head list; | |
292 | }; | |
293 | ||
294 | #define rxb_addr(r) page_address(r->page) | |
295 | ||
ba562f71 EG |
296 | /* |
297 | * mac80211 queues, ACs, hardware queues, FIFOs. | |
298 | * | |
299 | * Cf. http://wireless.kernel.org/en/developers/Documentation/mac80211/queues | |
300 | * | |
301 | * Mac80211 uses the following numbers, which we get as from it | |
302 | * by way of skb_get_queue_mapping(skb): | |
303 | * | |
304 | * VO 0 | |
305 | * VI 1 | |
306 | * BE 2 | |
307 | * BK 3 | |
308 | * | |
309 | * | |
310 | * Regular (not A-MPDU) frames are put into hardware queues corresponding | |
311 | * to the FIFOs, see comments in iwl-prph.h. Aggregated frames get their | |
312 | * own queue per aggregation session (RA/TID combination), such queues are | |
313 | * set up to map into FIFOs too, for which we need an AC->FIFO mapping. In | |
314 | * order to map frames to the right queue, we also need an AC->hw queue | |
315 | * mapping. This is implemented here. | |
316 | * | |
317 | * Due to the way hw queues are set up (by the hw specific modules like | |
318 | * iwl-4965.c, iwl-5000.c etc.), the AC->hw queue mapping is the identity | |
319 | * mapping. | |
320 | */ | |
321 | ||
322 | static const u8 tid_to_ac[] = { | |
323 | IEEE80211_AC_BE, | |
324 | IEEE80211_AC_BK, | |
325 | IEEE80211_AC_BK, | |
326 | IEEE80211_AC_BE, | |
327 | IEEE80211_AC_VI, | |
328 | IEEE80211_AC_VI, | |
329 | IEEE80211_AC_VO, | |
330 | IEEE80211_AC_VO | |
331 | }; | |
332 | ||
288712a6 EG |
333 | static inline int get_ac_from_tid(u16 tid) |
334 | { | |
335 | if (likely(tid < ARRAY_SIZE(tid_to_ac))) | |
336 | return tid_to_ac[tid]; | |
337 | ||
338 | /* no support for TIDs 8-15 yet */ | |
339 | return -EINVAL; | |
340 | } | |
341 | ||
ba562f71 EG |
342 | enum iwl_rxon_context_id { |
343 | IWL_RXON_CTX_BSS, | |
344 | IWL_RXON_CTX_PAN, | |
345 | ||
346 | NUM_IWL_RXON_CTX | |
347 | }; | |
348 | ||
48f20d35 EG |
349 | #ifdef CONFIG_PM |
350 | int iwl_suspend(struct iwl_priv *priv); | |
351 | int iwl_resume(struct iwl_priv *priv); | |
352 | #endif /* !CONFIG_PM */ | |
353 | ||
e6bb4c9c EG |
354 | int iwl_probe(struct iwl_bus *bus, const struct iwl_trans_ops *trans_ops, |
355 | struct iwl_cfg *cfg); | |
48f20d35 EG |
356 | void __devexit iwl_remove(struct iwl_priv * priv); |
357 | ||
464021ff EG |
358 | void iwl_start_tx_ba_trans_ready(struct iwl_priv *priv, |
359 | enum iwl_rxon_context_id ctx, | |
288712a6 | 360 | u8 sta_id, u8 tid); |
464021ff EG |
361 | void iwl_stop_tx_ba_trans_ready(struct iwl_priv *priv, |
362 | enum iwl_rxon_context_id ctx, | |
363 | u8 sta_id, u8 tid); | |
288712a6 | 364 | |
845a9c0d EG |
365 | /***************************************************** |
366 | * DRIVER STATUS FUNCTIONS | |
367 | ******************************************************/ | |
368 | #define STATUS_HCMD_ACTIVE 0 /* host command in progress */ | |
369 | /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */ | |
370 | #define STATUS_INT_ENABLED 2 | |
371 | #define STATUS_RF_KILL_HW 3 | |
372 | #define STATUS_CT_KILL 4 | |
373 | #define STATUS_INIT 5 | |
374 | #define STATUS_ALIVE 6 | |
375 | #define STATUS_READY 7 | |
376 | #define STATUS_TEMPERATURE 8 | |
377 | #define STATUS_GEO_CONFIGURED 9 | |
378 | #define STATUS_EXIT_PENDING 10 | |
379 | #define STATUS_STATISTICS 12 | |
380 | #define STATUS_SCANNING 13 | |
381 | #define STATUS_SCAN_ABORTING 14 | |
382 | #define STATUS_SCAN_HW 15 | |
383 | #define STATUS_POWER_PMI 16 | |
384 | #define STATUS_FW_ERROR 17 | |
385 | #define STATUS_DEVICE_ENABLED 18 | |
386 | #define STATUS_CHANNEL_SWITCH_PENDING 19 | |
387 | ||
388 | static inline int iwl_is_ready(struct iwl_shared *shrd) | |
389 | { | |
390 | /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are | |
391 | * set but EXIT_PENDING is not */ | |
392 | return test_bit(STATUS_READY, &shrd->status) && | |
393 | test_bit(STATUS_GEO_CONFIGURED, &shrd->status) && | |
394 | !test_bit(STATUS_EXIT_PENDING, &shrd->status); | |
395 | } | |
396 | ||
397 | static inline int iwl_is_alive(struct iwl_shared *shrd) | |
398 | { | |
399 | return test_bit(STATUS_ALIVE, &shrd->status); | |
400 | } | |
401 | ||
402 | static inline int iwl_is_init(struct iwl_shared *shrd) | |
403 | { | |
404 | return test_bit(STATUS_INIT, &shrd->status); | |
405 | } | |
406 | ||
407 | static inline int iwl_is_rfkill_hw(struct iwl_shared *shrd) | |
408 | { | |
409 | return test_bit(STATUS_RF_KILL_HW, &shrd->status); | |
410 | } | |
411 | ||
412 | static inline int iwl_is_rfkill(struct iwl_shared *shrd) | |
413 | { | |
414 | return iwl_is_rfkill_hw(shrd); | |
415 | } | |
416 | ||
417 | static inline int iwl_is_ctkill(struct iwl_shared *shrd) | |
418 | { | |
419 | return test_bit(STATUS_CT_KILL, &shrd->status); | |
420 | } | |
421 | ||
422 | static inline int iwl_is_ready_rf(struct iwl_shared *shrd) | |
423 | { | |
424 | if (iwl_is_rfkill(shrd)) | |
425 | return 0; | |
426 | ||
427 | return iwl_is_ready(shrd); | |
428 | } | |
429 | ||
48f20d35 | 430 | #endif /* #__iwl_shared_h__ */ |