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 - 2014 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 COPYING.
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 - 2014 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	IWL_DEVICE_FAMILY_7000,
87	IWL_DEVICE_FAMILY_8000,
88};
89
90static inline bool iwl_has_secure_boot(u32 hw_rev,
91				       enum iwl_device_family family)
92{
93	/* return 1 only for family 8000 B0 */
94	if ((family == IWL_DEVICE_FAMILY_8000) && (hw_rev & 0xC))
95		return true;
96
97	return false;
98}
99
100/*
101 * LED mode
102 *    IWL_LED_DEFAULT:  use device default
103 *    IWL_LED_RF_STATE: turn LED on/off based on RF state
104 *			LED ON  = RF ON
105 *			LED OFF = RF OFF
106 *    IWL_LED_BLINK:    adjust led blink rate based on blink table
107 *    IWL_LED_DISABLE:	led disabled
108 */
109enum iwl_led_mode {
110	IWL_LED_DEFAULT,
111	IWL_LED_RF_STATE,
112	IWL_LED_BLINK,
113	IWL_LED_DISABLE,
114};
115
116/*
117 * This is the threshold value of plcp error rate per 100mSecs.  It is
118 * used to set and check for the validity of plcp_delta.
119 */
120#define IWL_MAX_PLCP_ERR_THRESHOLD_MIN		1
121#define IWL_MAX_PLCP_ERR_THRESHOLD_DEF		50
122#define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF	100
123#define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF	200
124#define IWL_MAX_PLCP_ERR_THRESHOLD_MAX		255
125#define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE	0
126
127/* TX queue watchdog timeouts in mSecs */
128#define IWL_WATCHDOG_DISABLED	0
129#define IWL_DEF_WD_TIMEOUT	2500
130#define IWL_LONG_WD_TIMEOUT	10000
131#define IWL_MAX_WD_TIMEOUT	120000
132
133#define IWL_DEFAULT_MAX_TX_POWER 22
134
135/* Antenna presence definitions */
136#define	ANT_NONE	0x0
137#define	ANT_A		BIT(0)
138#define	ANT_B		BIT(1)
139#define ANT_C		BIT(2)
140#define	ANT_AB		(ANT_A | ANT_B)
141#define	ANT_AC		(ANT_A | ANT_C)
142#define ANT_BC		(ANT_B | ANT_C)
143#define ANT_ABC		(ANT_A | ANT_B | ANT_C)
144
145static inline u8 num_of_ant(u8 mask)
146{
147	return  !!((mask) & ANT_A) +
148		!!((mask) & ANT_B) +
149		!!((mask) & ANT_C);
150}
151
152/*
153 * @max_ll_items: max number of OTP blocks
154 * @shadow_ram_support: shadow support for OTP memory
155 * @led_compensation: compensate on the led on/off time per HW according
156 *	to the deviation to achieve the desired led frequency.
157 *	The detail algorithm is described in iwl-led.c
158 * @wd_timeout: TX queues watchdog timeout
159 * @max_event_log_size: size of event log buffer size for ucode event logging
160 * @shadow_reg_enable: HW shadow register support
161 * @apmg_wake_up_wa: should the MAC access REQ be asserted when a command
162 *	is in flight. This is due to a HW bug in 7260, 3160 and 7265.
163 * @scd_chain_ext_wa: should the chain extension feature in SCD be disabled.
164 */
165struct iwl_base_params {
166	int eeprom_size;
167	int num_of_queues;	/* def: HW dependent */
168	/* for iwl_pcie_apm_init() */
169	u32 pll_cfg_val;
170
171	const u16 max_ll_items;
172	const bool shadow_ram_support;
173	u16 led_compensation;
174	unsigned int wd_timeout;
175	u32 max_event_log_size;
176	const bool shadow_reg_enable;
177	const bool pcie_l1_allowed;
178	const bool apmg_wake_up_wa;
179	const bool scd_chain_ext_wa;
180};
181
182/*
183 * @stbc: support Tx STBC and 1*SS Rx STBC
184 * @ldpc: support Tx/Rx with LDPC
185 * @use_rts_for_aggregation: use rts/cts protection for HT traffic
186 * @ht40_bands: bitmap of bands (using %IEEE80211_BAND_*) that support HT40
187 */
188struct iwl_ht_params {
189	enum ieee80211_smps_mode smps_mode;
190	const bool ht_greenfield_support; /* if used set to true */
191	const bool stbc;
192	const bool ldpc;
193	bool use_rts_for_aggregation;
194	u8 ht40_bands;
195};
196
197/*
198 * information on how to parse the EEPROM
199 */
200#define EEPROM_REG_BAND_1_CHANNELS		0x08
201#define EEPROM_REG_BAND_2_CHANNELS		0x26
202#define EEPROM_REG_BAND_3_CHANNELS		0x42
203#define EEPROM_REG_BAND_4_CHANNELS		0x5C
204#define EEPROM_REG_BAND_5_CHANNELS		0x74
205#define EEPROM_REG_BAND_24_HT40_CHANNELS	0x82
206#define EEPROM_REG_BAND_52_HT40_CHANNELS	0x92
207#define EEPROM_6000_REG_BAND_24_HT40_CHANNELS	0x80
208#define EEPROM_REGULATORY_BAND_NO_HT40		0
209
210/* lower blocks contain EEPROM image and calibration data */
211#define OTP_LOW_IMAGE_SIZE		(2 * 512 * sizeof(u16)) /* 2 KB */
212#define OTP_LOW_IMAGE_SIZE_FAMILY_7000	(16 * 512 * sizeof(u16)) /* 16 KB */
213#define OTP_LOW_IMAGE_SIZE_FAMILY_8000	(32 * 512 * sizeof(u16)) /* 32 KB */
214
215struct iwl_eeprom_params {
216	const u8 regulatory_bands[7];
217	bool enhanced_txpower;
218};
219
220/* Tx-backoff power threshold
221 * @pwr: The power limit in mw
222 * @backoff: The tx-backoff in uSec
223 */
224struct iwl_pwr_tx_backoff {
225	u32 pwr;
226	u32 backoff;
227};
228
229/**
230 * struct iwl_cfg
231 * @name: Official name of the device
232 * @fw_name_pre: Firmware filename prefix. The api version and extension
233 *	(.ucode) will be added to filename before loading from disk. The
234 *	filename is constructed as fw_name_pre<api>.ucode.
235 * @ucode_api_max: Highest version of uCode API supported by driver.
236 * @ucode_api_ok: oldest version of the uCode API that is OK to load
237 *	without a warning, for use in transitions
238 * @ucode_api_min: Lowest version of uCode API supported by driver.
239 * @max_inst_size: The maximal length of the fw inst section
240 * @max_data_size: The maximal length of the fw data section
241 * @valid_tx_ant: valid transmit antenna
242 * @valid_rx_ant: valid receive antenna
243 * @non_shared_ant: the antenna that is for WiFi only
244 * @nvm_ver: NVM version
245 * @nvm_calib_ver: NVM calibration version
246 * @lib: pointer to the lib ops
247 * @base_params: pointer to basic parameters
248 * @ht_params: point to ht parameters
249 * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
250 * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
251 * @internal_wimax_coex: internal wifi/wimax combo device
252 * @high_temp: Is this NIC is designated to be in high temperature.
253 * @host_interrupt_operation_mode: device needs host interrupt operation
254 *	mode set
255 * @d0i3: device uses d0i3 instead of d3
256 * @nvm_hw_section_num: the ID of the HW NVM section
257 * @pwr_tx_backoffs: translation table between power limits and backoffs
258 * @max_rx_agg_size: max RX aggregation size of the ADDBA request/response
259 * @max_tx_agg_size: max TX aggregation size of the ADDBA request/response
260 * @max_ht_ampdu_factor: the exponent of the max length of A-MPDU that the
261 *	station can receive in HT
262 * @max_vht_ampdu_exponent: the exponent of the max length of A-MPDU that the
263 *	station can receive in VHT
264 * @dccm_offset: offset from which DCCM begins
265 * @dccm_len: length of DCCM (including runtime stack CCM)
266 * @dccm2_offset: offset from which the second DCCM begins
267 * @dccm2_len: length of the second DCCM
268 * @smem_offset: offset from which the SMEM begins
269 * @smem_len: the length of SMEM
270 *
271 * We enable the driver to be backward compatible wrt. hardware features.
272 * API differences in uCode shouldn't be handled here but through TLVs
273 * and/or the uCode API version instead.
274 */
275struct iwl_cfg {
276	/* params specific to an individual device within a device family */
277	const char *name;
278	const char *fw_name_pre;
279	const unsigned int ucode_api_max;
280	const unsigned int ucode_api_ok;
281	const unsigned int ucode_api_min;
282	const enum iwl_device_family device_family;
283	const u32 max_data_size;
284	const u32 max_inst_size;
285	u8   valid_tx_ant;
286	u8   valid_rx_ant;
287	u8   non_shared_ant;
288	bool bt_shared_single_ant;
289	u16  nvm_ver;
290	u16  nvm_calib_ver;
291	/* params not likely to change within a device family */
292	const struct iwl_base_params *base_params;
293	/* params likely to change within a device family */
294	const struct iwl_ht_params *ht_params;
295	const struct iwl_eeprom_params *eeprom_params;
296	enum iwl_led_mode led_mode;
297	const bool rx_with_siso_diversity;
298	const bool internal_wimax_coex;
299	const bool host_interrupt_operation_mode;
300	bool high_temp;
301	bool d0i3;
302	u8   nvm_hw_section_num;
303	bool lp_xtal_workaround;
304	const struct iwl_pwr_tx_backoff *pwr_tx_backoffs;
305	bool no_power_up_nic_in_init;
306	const char *default_nvm_file_B_step;
307	const char *default_nvm_file_C_step;
308	unsigned int max_rx_agg_size;
309	bool disable_dummy_notification;
310	unsigned int max_tx_agg_size;
311	unsigned int max_ht_ampdu_exponent;
312	unsigned int max_vht_ampdu_exponent;
313	const u32 dccm_offset;
314	const u32 dccm_len;
315	const u32 dccm2_offset;
316	const u32 dccm2_len;
317	const u32 smem_offset;
318	const u32 smem_len;
319};
320
321/*
322 * This list declares the config structures for all devices.
323 */
324#if IS_ENABLED(CONFIG_IWLDVM)
325extern const struct iwl_cfg iwl5300_agn_cfg;
326extern const struct iwl_cfg iwl5100_agn_cfg;
327extern const struct iwl_cfg iwl5350_agn_cfg;
328extern const struct iwl_cfg iwl5100_bgn_cfg;
329extern const struct iwl_cfg iwl5100_abg_cfg;
330extern const struct iwl_cfg iwl5150_agn_cfg;
331extern const struct iwl_cfg iwl5150_abg_cfg;
332extern const struct iwl_cfg iwl6005_2agn_cfg;
333extern const struct iwl_cfg iwl6005_2abg_cfg;
334extern const struct iwl_cfg iwl6005_2bg_cfg;
335extern const struct iwl_cfg iwl6005_2agn_sff_cfg;
336extern const struct iwl_cfg iwl6005_2agn_d_cfg;
337extern const struct iwl_cfg iwl6005_2agn_mow1_cfg;
338extern const struct iwl_cfg iwl6005_2agn_mow2_cfg;
339extern const struct iwl_cfg iwl1030_bgn_cfg;
340extern const struct iwl_cfg iwl1030_bg_cfg;
341extern const struct iwl_cfg iwl6030_2agn_cfg;
342extern const struct iwl_cfg iwl6030_2abg_cfg;
343extern const struct iwl_cfg iwl6030_2bgn_cfg;
344extern const struct iwl_cfg iwl6030_2bg_cfg;
345extern const struct iwl_cfg iwl6000i_2agn_cfg;
346extern const struct iwl_cfg iwl6000i_2abg_cfg;
347extern const struct iwl_cfg iwl6000i_2bg_cfg;
348extern const struct iwl_cfg iwl6000_3agn_cfg;
349extern const struct iwl_cfg iwl6050_2agn_cfg;
350extern const struct iwl_cfg iwl6050_2abg_cfg;
351extern const struct iwl_cfg iwl6150_bgn_cfg;
352extern const struct iwl_cfg iwl6150_bg_cfg;
353extern const struct iwl_cfg iwl1000_bgn_cfg;
354extern const struct iwl_cfg iwl1000_bg_cfg;
355extern const struct iwl_cfg iwl100_bgn_cfg;
356extern const struct iwl_cfg iwl100_bg_cfg;
357extern const struct iwl_cfg iwl130_bgn_cfg;
358extern const struct iwl_cfg iwl130_bg_cfg;
359extern const struct iwl_cfg iwl2000_2bgn_cfg;
360extern const struct iwl_cfg iwl2000_2bgn_d_cfg;
361extern const struct iwl_cfg iwl2030_2bgn_cfg;
362extern const struct iwl_cfg iwl6035_2agn_cfg;
363extern const struct iwl_cfg iwl6035_2agn_sff_cfg;
364extern const struct iwl_cfg iwl105_bgn_cfg;
365extern const struct iwl_cfg iwl105_bgn_d_cfg;
366extern const struct iwl_cfg iwl135_bgn_cfg;
367#endif /* CONFIG_IWLDVM */
368#if IS_ENABLED(CONFIG_IWLMVM)
369extern const struct iwl_cfg iwl7260_2ac_cfg;
370extern const struct iwl_cfg iwl7260_2ac_cfg_high_temp;
371extern const struct iwl_cfg iwl7260_2n_cfg;
372extern const struct iwl_cfg iwl7260_n_cfg;
373extern const struct iwl_cfg iwl3160_2ac_cfg;
374extern const struct iwl_cfg iwl3160_2n_cfg;
375extern const struct iwl_cfg iwl3160_n_cfg;
376extern const struct iwl_cfg iwl3165_2ac_cfg;
377extern const struct iwl_cfg iwl7265_2ac_cfg;
378extern const struct iwl_cfg iwl7265_2n_cfg;
379extern const struct iwl_cfg iwl7265_n_cfg;
380extern const struct iwl_cfg iwl7265d_2ac_cfg;
381extern const struct iwl_cfg iwl7265d_2n_cfg;
382extern const struct iwl_cfg iwl7265d_n_cfg;
383extern const struct iwl_cfg iwl8260_2n_cfg;
384extern const struct iwl_cfg iwl8260_2ac_cfg;
385extern const struct iwl_cfg iwl4165_2ac_cfg;
386extern const struct iwl_cfg iwl8260_2ac_sdio_cfg;
387extern const struct iwl_cfg iwl4165_2ac_sdio_cfg;
388#endif /* CONFIG_IWLMVM */
389
390#endif /* __IWL_CONFIG_H__ */
391