1 /******************************************************************************
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.
8 * Copyright(c) 2007 - 2011 Intel Corporation. All rights reserved.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2011 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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.
62 *****************************************************************************/
63 #ifndef __iwl_shared_h__
64 #define __iwl_shared_h__
66 #include <linux/types.h>
67 #include <linux/spinlock.h>
68 #include <linux/mutex.h>
69 #include <linux/gfp.h>
71 #include "iwl-commands.h"
73 /*This files includes all the types / functions that are exported by the
74 * upper layer to the bus and transport layer */
79 struct iwl_sensitivity_ranges
;
82 #define DRV_NAME "iwlagn"
83 #define IWLWIFI_VERSION "in-tree:"
84 #define DRV_COPYRIGHT "Copyright(c) 2003-2011 Intel Corporation"
85 #define DRV_AUTHOR "<ilw@linux.intel.com>"
87 extern struct iwl_mod_params iwlagn_mod_params
;
90 * struct iwl_mod_params
91 * @sw_crypto: using hardware encryption, default = 0
92 * @num_of_queues: number of tx queue, HW dependent
93 * @disable_11n: 11n capabilities enabled, default = 0
94 * @amsdu_size_8K: enable 8K amsdu size, default = 1
95 * @antenna: both antennas (use diversity), default = 0
96 * @restart_fw: restart firmware, default = 1
97 * @plcp_check: enable plcp health check, default = true
98 * @ack_check: disable ack health check, default = false
99 * @wd_disable: enable stuck queue check, default = false
100 * @bt_coex_active: enable bt coex, default = true
101 * @led_mode: system default, default = 0
102 * @no_sleep_autoadjust: disable autoadjust, default = true
103 * @power_save: disable power save, default = false
104 * @power_level: power level, default = 1
105 * @debug_level: levels are IWL_DL_*
106 * @ant_coupling: antenna coupling in dB, default = 0
107 * @bt_ch_announce: BT channel inhibition, default = enable
108 * @wanted_ucode_alternative: ucode alternative to use, default = 1
109 * @auto_agg: enable agg. without check, default = true
111 struct iwl_mod_params
{
123 bool no_sleep_autoadjust
;
129 int wanted_ucode_alternative
;
134 * struct iwl_hw_params
135 * @max_txq_num: Max # Tx queues supported
136 * @num_ampdu_queues: num of ampdu queues
137 * @tx/rx_chains_num: Number of TX/RX chains
138 * @valid_tx/rx_ant: usable antennas
140 * @ht40_channel: is 40MHz width possible in band 2.4
141 * @beacon_time_tsf_bits: number of valid tsf bits for beacon time
143 * @rx_page_order: Rx buffer page order
144 * @rx_wrt_ptr_reg: FH{39}_RSCSR_CHNL0_WPTR
145 * BIT(IEEE80211_BAND_5GHZ) BIT(IEEE80211_BAND_5GHZ)
146 * @sw_crypto: 0 for hw, 1 for sw
147 * @max_xxx_size: for ucode uses
148 * @ct_kill_threshold: temperature threshold
149 * @calib_init_cfg: setup initial calibrations for the hw
150 * @calib_rt_cfg: setup runtime calibrations for the hw
151 * @struct iwl_sensitivity_ranges: range of sensitivity values
153 struct iwl_hw_params
{
162 bool shadow_reg_enable
;
163 u16 beacon_time_tsf_bits
;
168 u32 ct_kill_threshold
; /* value in hw-dependent units */
169 u32 ct_kill_exit_threshold
; /* value in hw-dependent units */
170 /* for 1000, 6000 series and up */
173 const struct iwl_sensitivity_ranges
*sens
;
177 * struct iwl_ht_agg - aggregation status while waiting for block-ack
178 * @txq_id: Tx queue used for Tx attempt
179 * @wait_for_ba: Expect block-ack before next Tx reply
180 * @rate_n_flags: Rate at which Tx was attempted
182 * If REPLY_TX indicates that aggregation was attempted, driver must wait
183 * for block ack (REPLY_COMPRESSED_BA). This struct stores tx reply info
184 * until block ack arrives.
190 #define IWL_AGG_OFF 0
192 #define IWL_EMPTYING_HW_QUEUE_ADDBA 2
193 #define IWL_EMPTYING_HW_QUEUE_DELBA 3
198 struct iwl_tid_data
{
199 u16 seq_number
; /* agn only */
201 struct iwl_ht_agg agg
;
205 * struct iwl_shared - shared fields for all the layers of the driver
207 * @dbg_level_dev: dbg level set per device. Prevails on
208 * iwlagn_mod_params.debug_level if set (!= 0)
209 * @ucode_owner: IWL_OWNERSHIP_*
210 * @cmd_queue: command queue number
212 * @bus: pointer to the bus layer data
213 * @priv: pointer to the upper layer data
214 * @hw_params: see struct iwl_hw_params
215 * @workqueue: the workqueue used by all the layers of the driver
216 * @lock: protect general shared data
217 * @sta_lock: protects the station table.
218 * If lock and sta_lock are needed, lock must be acquired first.
222 #ifdef CONFIG_IWLWIFI_DEBUG
224 #endif /* CONFIG_IWLWIFI_DEBUG */
226 #define IWL_OWNERSHIP_DRIVER 0
227 #define IWL_OWNERSHIP_TM 1
230 unsigned long status
;
234 struct iwl_priv
*priv
;
235 struct iwl_trans
*trans
;
236 struct iwl_hw_params hw_params
;
238 struct workqueue_struct
*workqueue
;
243 struct iwl_tid_data tid_data
[IWLAGN_STATION_COUNT
][IWL_MAX_TID_COUNT
];
246 /*Whatever _m is (iwl_trans, iwl_priv, iwl_bus, these macros will work */
247 #define priv(_m) ((_m)->shrd->priv)
248 #define bus(_m) ((_m)->shrd->bus)
249 #define trans(_m) ((_m)->shrd->trans)
250 #define hw_params(_m) ((_m)->shrd->hw_params)
252 #ifdef CONFIG_IWLWIFI_DEBUG
254 * iwl_get_debug_level: Return active debug level for device
256 * Using sysfs it is possible to set per device debug level. This debug
257 * level will be used if set, otherwise the global debug level which can be
258 * set via module parameter is used.
260 static inline u32
iwl_get_debug_level(struct iwl_shared
*shrd
)
262 if (shrd
->dbg_level_dev
)
263 return shrd
->dbg_level_dev
;
265 return iwlagn_mod_params
.debug_level
;
268 static inline u32
iwl_get_debug_level(struct iwl_shared
*shrd
)
270 return iwlagn_mod_params
.debug_level
;
274 static inline void iwl_free_pages(struct iwl_shared
*shrd
, unsigned long page
)
276 free_pages(page
, shrd
->hw_params
.rx_page_order
);
279 struct iwl_rx_mem_buffer
{
282 struct list_head list
;
285 #define rxb_addr(r) page_address(r->page)
288 int iwl_suspend(struct iwl_priv
*priv
);
289 int iwl_resume(struct iwl_priv
*priv
);
290 #endif /* !CONFIG_PM */
292 int iwl_probe(struct iwl_bus
*bus
, const struct iwl_trans_ops
*trans_ops
,
293 struct iwl_cfg
*cfg
);
294 void __devexit
iwl_remove(struct iwl_priv
* priv
);
296 /*****************************************************
297 * DRIVER STATUS FUNCTIONS
298 ******************************************************/
299 #define STATUS_HCMD_ACTIVE 0 /* host command in progress */
300 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
301 #define STATUS_INT_ENABLED 2
302 #define STATUS_RF_KILL_HW 3
303 #define STATUS_CT_KILL 4
304 #define STATUS_INIT 5
305 #define STATUS_ALIVE 6
306 #define STATUS_READY 7
307 #define STATUS_TEMPERATURE 8
308 #define STATUS_GEO_CONFIGURED 9
309 #define STATUS_EXIT_PENDING 10
310 #define STATUS_STATISTICS 12
311 #define STATUS_SCANNING 13
312 #define STATUS_SCAN_ABORTING 14
313 #define STATUS_SCAN_HW 15
314 #define STATUS_POWER_PMI 16
315 #define STATUS_FW_ERROR 17
316 #define STATUS_DEVICE_ENABLED 18
317 #define STATUS_CHANNEL_SWITCH_PENDING 19
319 static inline int iwl_is_ready(struct iwl_shared
*shrd
)
321 /* The adapter is 'ready' if READY and GEO_CONFIGURED bits are
322 * set but EXIT_PENDING is not */
323 return test_bit(STATUS_READY
, &shrd
->status
) &&
324 test_bit(STATUS_GEO_CONFIGURED
, &shrd
->status
) &&
325 !test_bit(STATUS_EXIT_PENDING
, &shrd
->status
);
328 static inline int iwl_is_alive(struct iwl_shared
*shrd
)
330 return test_bit(STATUS_ALIVE
, &shrd
->status
);
333 static inline int iwl_is_init(struct iwl_shared
*shrd
)
335 return test_bit(STATUS_INIT
, &shrd
->status
);
338 static inline int iwl_is_rfkill_hw(struct iwl_shared
*shrd
)
340 return test_bit(STATUS_RF_KILL_HW
, &shrd
->status
);
343 static inline int iwl_is_rfkill(struct iwl_shared
*shrd
)
345 return iwl_is_rfkill_hw(shrd
);
348 static inline int iwl_is_ctkill(struct iwl_shared
*shrd
)
350 return test_bit(STATUS_CT_KILL
, &shrd
->status
);
353 static inline int iwl_is_ready_rf(struct iwl_shared
*shrd
)
355 if (iwl_is_rfkill(shrd
))
358 return iwl_is_ready(shrd
);
361 #endif /* #__iwl_shared_h__ */