Linux Audio

Check our new training course

Loading...
Note: File does not exist in v6.8.
  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 - 2012 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 - 2012 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_CONFIG_H__
 64#define __IWL_CONFIG_H__
 65
 66#include <linux/types.h>
 67#include <net/mac80211.h>
 68
 69
 70enum iwl_device_family {
 71	IWL_DEVICE_FAMILY_UNDEFINED,
 72	IWL_DEVICE_FAMILY_1000,
 73	IWL_DEVICE_FAMILY_100,
 74	IWL_DEVICE_FAMILY_2000,
 75	IWL_DEVICE_FAMILY_2030,
 76	IWL_DEVICE_FAMILY_105,
 77	IWL_DEVICE_FAMILY_135,
 78	IWL_DEVICE_FAMILY_5000,
 79	IWL_DEVICE_FAMILY_5150,
 80	IWL_DEVICE_FAMILY_6000,
 81	IWL_DEVICE_FAMILY_6000i,
 82	IWL_DEVICE_FAMILY_6005,
 83	IWL_DEVICE_FAMILY_6030,
 84	IWL_DEVICE_FAMILY_6050,
 85	IWL_DEVICE_FAMILY_6150,
 86};
 87
 88/*
 89 * LED mode
 90 *    IWL_LED_DEFAULT:  use device default
 91 *    IWL_LED_RF_STATE: turn LED on/off based on RF state
 92 *			LED ON  = RF ON
 93 *			LED OFF = RF OFF
 94 *    IWL_LED_BLINK:    adjust led blink rate based on blink table
 95 *    IWL_LED_DISABLE:	led disabled
 96 */
 97enum iwl_led_mode {
 98	IWL_LED_DEFAULT,
 99	IWL_LED_RF_STATE,
100	IWL_LED_BLINK,
101	IWL_LED_DISABLE,
102};
103
104/*
105 * This is the threshold value of plcp error rate per 100mSecs.  It is
106 * used to set and check for the validity of plcp_delta.
107 */
108#define IWL_MAX_PLCP_ERR_THRESHOLD_MIN		1
109#define IWL_MAX_PLCP_ERR_THRESHOLD_DEF		50
110#define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF	100
111#define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF	200
112#define IWL_MAX_PLCP_ERR_THRESHOLD_MAX		255
113#define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE	0
114
115/* TX queue watchdog timeouts in mSecs */
116#define IWL_WATCHHDOG_DISABLED	0
117#define IWL_DEF_WD_TIMEOUT	2000
118#define IWL_LONG_WD_TIMEOUT	10000
119#define IWL_MAX_WD_TIMEOUT	120000
120
121/* Antenna presence definitions */
122#define	ANT_NONE	0x0
123#define	ANT_A		BIT(0)
124#define	ANT_B		BIT(1)
125#define ANT_C		BIT(2)
126#define	ANT_AB		(ANT_A | ANT_B)
127#define	ANT_AC		(ANT_A | ANT_C)
128#define ANT_BC		(ANT_B | ANT_C)
129#define ANT_ABC		(ANT_A | ANT_B | ANT_C)
130
131
132/*
133 * @max_ll_items: max number of OTP blocks
134 * @shadow_ram_support: shadow support for OTP memory
135 * @led_compensation: compensate on the led on/off time per HW according
136 *	to the deviation to achieve the desired led frequency.
137 *	The detail algorithm is described in iwl-led.c
138 * @chain_noise_num_beacons: number of beacons used to compute chain noise
139 * @adv_thermal_throttle: support advance thermal throttle
140 * @support_ct_kill_exit: support ct kill exit condition
141 * @plcp_delta_threshold: plcp error rate threshold used to trigger
142 *	radio tuning when there is a high receiving plcp error rate
143 * @chain_noise_scale: default chain noise scale used for gain computation
144 * @wd_timeout: TX queues watchdog timeout
145 * @max_event_log_size: size of event log buffer size for ucode event logging
146 * @shadow_reg_enable: HW shadhow register bit
147 * @hd_v2: v2 of enhanced sensitivity value, used for 2000 series and up
148 * @no_idle_support: do not support idle mode
149 */
150struct iwl_base_params {
151	int eeprom_size;
152	int num_of_queues;	/* def: HW dependent */
153	/* for iwl_apm_init() */
154	u32 pll_cfg_val;
155
156	const u16 max_ll_items;
157	const bool shadow_ram_support;
158	u16 led_compensation;
159	bool adv_thermal_throttle;
160	bool support_ct_kill_exit;
161	u8 plcp_delta_threshold;
162	s32 chain_noise_scale;
163	unsigned int wd_timeout;
164	u32 max_event_log_size;
165	const bool shadow_reg_enable;
166	const bool hd_v2;
167	const bool no_idle_support;
168};
169
170/*
171 * @advanced_bt_coexist: support advanced bt coexist
172 * @bt_init_traffic_load: specify initial bt traffic load
173 * @bt_prio_boost: default bt priority boost value
174 * @agg_time_limit: maximum number of uSec in aggregation
175 * @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode
176 */
177struct iwl_bt_params {
178	bool advanced_bt_coexist;
179	u8 bt_init_traffic_load;
180	u8 bt_prio_boost;
181	u16 agg_time_limit;
182	bool bt_sco_disable;
183	bool bt_session_2;
184};
185/*
186 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
187 */
188struct iwl_ht_params {
189	const bool ht_greenfield_support; /* if used set to true */
190	bool use_rts_for_aggregation;
191	enum ieee80211_smps_mode smps_mode;
192};
193
194/**
195 * struct iwl_cfg
196 * @name: Offical name of the device
197 * @fw_name_pre: Firmware filename prefix. The api version and extension
198 *	(.ucode) will be added to filename before loading from disk. The
199 *	filename is constructed as fw_name_pre<api>.ucode.
200 * @ucode_api_max: Highest version of uCode API supported by driver.
201 * @ucode_api_ok: oldest version of the uCode API that is OK to load
202 *	without a warning, for use in transitions
203 * @ucode_api_min: Lowest version of uCode API supported by driver.
204 * @max_inst_size: The maximal length of the fw inst section
205 * @max_data_size: The maximal length of the fw data section
206 * @valid_tx_ant: valid transmit antenna
207 * @valid_rx_ant: valid receive antenna
208 * @eeprom_ver: EEPROM version
209 * @eeprom_calib_ver: EEPROM calibration version
210 * @lib: pointer to the lib ops
211 * @base_params: pointer to basic parameters
212 * @ht_params: point to ht patameters
213 * @bt_params: pointer to bt parameters
214 * @need_temp_offset_calib: need to perform temperature offset calibration
215 * @no_xtal_calib: some devices do not need crystal calibration data,
216 *	don't send it to those
217 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
218 * @adv_pm: advance power management
219 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
220 * @internal_wimax_coex: internal wifi/wimax combo device
221 * @temp_offset_v2: support v2 of temperature offset calibration
222 *
223 * We enable the driver to be backward compatible wrt. hardware features.
224 * API differences in uCode shouldn't be handled here but through TLVs
225 * and/or the uCode API version instead.
226 */
227struct iwl_cfg {
228	/* params specific to an individual device within a device family */
229	const char *name;
230	const char *fw_name_pre;
231	const unsigned int ucode_api_max;
232	const unsigned int ucode_api_ok;
233	const unsigned int ucode_api_min;
234	const enum iwl_device_family device_family;
235	const u32 max_data_size;
236	const u32 max_inst_size;
237	u8   valid_tx_ant;
238	u8   valid_rx_ant;
239	u16  eeprom_ver;
240	u16  eeprom_calib_ver;
241	/* params not likely to change within a device family */
242	const struct iwl_base_params *base_params;
243	/* params likely to change within a device family */
244	const struct iwl_ht_params *ht_params;
245	const struct iwl_bt_params *bt_params;
246	const bool need_temp_offset_calib; /* if used set to true */
247	const bool no_xtal_calib;
248	enum iwl_led_mode led_mode;
249	const bool adv_pm;
250	const bool rx_with_siso_diversity;
251	const bool internal_wimax_coex;
252	const bool temp_offset_v2;
253};
254
255#endif /* __IWL_CONFIG_H__ */