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) 2008 - 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_core_h__
64#define __iwl_core_h__
65
66#include "iwl-dev.h"
67#include "iwl-io.h"
68
69/************************
70 * forward declarations *
71 ************************/
72struct iwl_host_cmd;
73struct iwl_cmd;
74
75#define TIME_UNIT		1024
76
77struct iwl_lib_ops {
78	/* set hw dependent parameters */
79	int (*set_hw_params)(struct iwl_priv *priv);
80	/* setup BT Rx handler */
81	void (*bt_rx_handler_setup)(struct iwl_priv *priv);
82	/* setup BT related deferred work */
83	void (*bt_setup_deferred_work)(struct iwl_priv *priv);
84	/* cancel deferred work */
85	void (*cancel_deferred_work)(struct iwl_priv *priv);
86	int (*set_channel_switch)(struct iwl_priv *priv,
87				  struct ieee80211_channel_switch *ch_switch);
88	/* device specific configuration */
89	void (*nic_config)(struct iwl_priv *priv);
90
91	/* eeprom operations (as defined in iwl-eeprom.h) */
92	struct iwl_eeprom_ops eeprom_ops;
93
94	/* temperature */
95	void (*temperature)(struct iwl_priv *priv);
96};
97
98/*
99 * @max_ll_items: max number of OTP blocks
100 * @shadow_ram_support: shadow support for OTP memory
101 * @led_compensation: compensate on the led on/off time per HW according
102 *	to the deviation to achieve the desired led frequency.
103 *	The detail algorithm is described in iwl-led.c
104 * @chain_noise_num_beacons: number of beacons used to compute chain noise
105 * @adv_thermal_throttle: support advance thermal throttle
106 * @support_ct_kill_exit: support ct kill exit condition
107 * @support_wimax_coexist: support wimax/wifi co-exist
108 * @plcp_delta_threshold: plcp error rate threshold used to trigger
109 *	radio tuning when there is a high receiving plcp error rate
110 * @chain_noise_scale: default chain noise scale used for gain computation
111 * @wd_timeout: TX queues watchdog timeout
112 * @max_event_log_size: size of event log buffer size for ucode event logging
113 * @shadow_reg_enable: HW shadhow register bit
114 * @no_idle_support: do not support idle mode
115 * @hd_v2: v2 of enhanced sensitivity value, used for 2000 series and up
116 * wd_disable: disable watchdog timer
117 */
118struct iwl_base_params {
119	int eeprom_size;
120	int num_of_queues;	/* def: HW dependent */
121	int num_of_ampdu_queues;/* def: HW dependent */
122	/* for iwl_apm_init() */
123	u32 pll_cfg_val;
124
125	const u16 max_ll_items;
126	const bool shadow_ram_support;
127	u16 led_compensation;
128	bool adv_thermal_throttle;
129	bool support_ct_kill_exit;
130	const bool support_wimax_coexist;
131	u8 plcp_delta_threshold;
132	s32 chain_noise_scale;
133	unsigned int wd_timeout;
134	u32 max_event_log_size;
135	const bool shadow_reg_enable;
136	const bool no_idle_support;
137	const bool hd_v2;
138	const bool wd_disable;
139};
140/*
141 * @advanced_bt_coexist: support advanced bt coexist
142 * @bt_init_traffic_load: specify initial bt traffic load
143 * @bt_prio_boost: default bt priority boost value
144 * @agg_time_limit: maximum number of uSec in aggregation
145 * @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode
146 */
147struct iwl_bt_params {
148	bool advanced_bt_coexist;
149	u8 bt_init_traffic_load;
150	u8 bt_prio_boost;
151	u16 agg_time_limit;
152	bool bt_sco_disable;
153	bool bt_session_2;
154};
155/*
156 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
157 */
158struct iwl_ht_params {
159	const bool ht_greenfield_support; /* if used set to true */
160	bool use_rts_for_aggregation;
161	enum ieee80211_smps_mode smps_mode;
162};
163
164/***************************
165 *   L i b                 *
166 ***************************/
167
168void iwl_set_rxon_hwcrypto(struct iwl_priv *priv, struct iwl_rxon_context *ctx,
169			   int hw_decrypt);
170int iwl_check_rxon_cmd(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
171int iwl_full_rxon_required(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
172int iwl_set_rxon_channel(struct iwl_priv *priv, struct ieee80211_channel *ch,
173			 struct iwl_rxon_context *ctx);
174void iwl_set_flags_for_band(struct iwl_priv *priv,
175			    struct iwl_rxon_context *ctx,
176			    enum ieee80211_band band,
177			    struct ieee80211_vif *vif);
178u8 iwl_get_single_channel_number(struct iwl_priv *priv,
179				  enum ieee80211_band band);
180void iwl_set_rxon_ht(struct iwl_priv *priv, struct iwl_ht_config *ht_conf);
181bool iwl_is_ht40_tx_allowed(struct iwl_priv *priv,
182			    struct iwl_rxon_context *ctx,
183			    struct ieee80211_sta_ht_cap *ht_cap);
184void iwl_connection_init_rx_config(struct iwl_priv *priv,
185				   struct iwl_rxon_context *ctx);
186void iwl_set_rate(struct iwl_priv *priv);
187int iwl_cmd_echo_test(struct iwl_priv *priv);
188#ifdef CONFIG_IWLWIFI_DEBUGFS
189int iwl_alloc_traffic_mem(struct iwl_priv *priv);
190void iwl_free_traffic_mem(struct iwl_priv *priv);
191void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
192				u16 length, struct ieee80211_hdr *header);
193void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
194				u16 length, struct ieee80211_hdr *header);
195const char *get_mgmt_string(int cmd);
196const char *get_ctrl_string(int cmd);
197void iwl_clear_traffic_stats(struct iwl_priv *priv);
198void iwl_update_stats(struct iwl_priv *priv, bool is_tx, __le16 fc,
199		      u16 len);
200#else
201static inline int iwl_alloc_traffic_mem(struct iwl_priv *priv)
202{
203	return 0;
204}
205static inline void iwl_free_traffic_mem(struct iwl_priv *priv)
206{
207}
208static inline void iwl_reset_traffic_log(struct iwl_priv *priv)
209{
210}
211static inline void iwl_dbg_log_tx_data_frame(struct iwl_priv *priv,
212		      u16 length, struct ieee80211_hdr *header)
213{
214}
215static inline void iwl_dbg_log_rx_data_frame(struct iwl_priv *priv,
216		      u16 length, struct ieee80211_hdr *header)
217{
218}
219static inline void iwl_update_stats(struct iwl_priv *priv, bool is_tx,
220				    __le16 fc, u16 len)
221{
222}
223#endif
224
225/*****************************************************
226* RX
227******************************************************/
228void iwl_chswitch_done(struct iwl_priv *priv, bool is_success);
229
230void iwl_setup_watchdog(struct iwl_priv *priv);
231/*****************************************************
232 * TX power
233 ****************************************************/
234int iwl_set_tx_power(struct iwl_priv *priv, s8 tx_power, bool force);
235
236/*******************************************************************************
237 * Scanning
238 ******************************************************************************/
239void iwl_init_scan_params(struct iwl_priv *priv);
240int iwl_scan_cancel(struct iwl_priv *priv);
241void iwl_scan_cancel_timeout(struct iwl_priv *priv, unsigned long ms);
242void iwl_force_scan_end(struct iwl_priv *priv);
243void iwl_internal_short_hw_scan(struct iwl_priv *priv);
244int iwl_force_reset(struct iwl_priv *priv, int mode, bool external);
245u16 iwl_fill_probe_req(struct iwl_priv *priv, struct ieee80211_mgmt *frame,
246		       const u8 *ta, const u8 *ie, int ie_len, int left);
247void iwl_setup_rx_scan_handlers(struct iwl_priv *priv);
248void iwl_setup_scan_deferred_work(struct iwl_priv *priv);
249void iwl_cancel_scan_deferred_work(struct iwl_priv *priv);
250int __must_check iwl_scan_initiate(struct iwl_priv *priv,
251				   struct ieee80211_vif *vif,
252				   enum iwl_scan_type scan_type,
253				   enum ieee80211_band band);
254
255/* For faster active scanning, scan will move to the next channel if fewer than
256 * PLCP_QUIET_THRESH packets are heard on this channel within
257 * ACTIVE_QUIET_TIME after sending probe request.  This shortens the dwell
258 * time if it's a quiet channel (nothing responded to our probe, and there's
259 * no other traffic).
260 * Disable "quiet" feature by setting PLCP_QUIET_THRESH to 0. */
261#define IWL_ACTIVE_QUIET_TIME       cpu_to_le16(10)  /* msec */
262#define IWL_PLCP_QUIET_THRESH       cpu_to_le16(1)  /* packets */
263
264#define IWL_SCAN_CHECK_WATCHDOG		(HZ * 7)
265
266/*****************************************************
267 *   S e n d i n g     H o s t     C o m m a n d s   *
268 *****************************************************/
269
270void iwl_bg_watchdog(unsigned long data);
271u32 iwl_usecs_to_beacons(struct iwl_priv *priv, u32 usec, u32 beacon_interval);
272__le32 iwl_add_beacon_time(struct iwl_priv *priv, u32 base,
273			   u32 addon, u32 beacon_interval);
274
275
276/*****************************************************
277*  GEOS
278******************************************************/
279int iwl_init_geos(struct iwl_priv *priv);
280void iwl_free_geos(struct iwl_priv *priv);
281
282extern void iwl_send_bt_config(struct iwl_priv *priv);
283extern int iwl_send_statistics_request(struct iwl_priv *priv,
284				       u8 flags, bool clear);
285
286int iwl_send_rxon_timing(struct iwl_priv *priv, struct iwl_rxon_context *ctx);
287
288static inline const struct ieee80211_supported_band *iwl_get_hw_mode(
289			struct iwl_priv *priv, enum ieee80211_band band)
290{
291	return priv->hw->wiphy->bands[band];
292}
293
294static inline bool iwl_advanced_bt_coexist(struct iwl_priv *priv)
295{
296	return cfg(priv)->bt_params &&
297	       cfg(priv)->bt_params->advanced_bt_coexist;
298}
299
300static inline void iwl_enable_rfkill_int(struct iwl_priv *priv)
301{
302	IWL_DEBUG_ISR(priv, "Enabling rfkill interrupt\n");
303	iwl_write32(bus(priv), CSR_INT_MASK, CSR_INT_BIT_RF_KILL);
304}
305
306extern bool bt_siso_mode;
307
308#endif /* __iwl_core_h__ */
309