iwlwifi: more modularity in fw images and sections
[firefly-linux-kernel-4.4.55.git] / drivers / net / wireless / iwlwifi / iwl-shared.h
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_shared_h__
64 #define __iwl_shared_h__
65
66 #include <linux/types.h>
67 #include <linux/spinlock.h>
68 #include <linux/gfp.h>
69 #include <net/mac80211.h>
70
71 #include "iwl-commands.h"
72 #include "iwl-fw.h"
73
74 /**
75  * DOC: shared area - role and goal
76  *
77  * The shared area contains all the data exported by the upper layer to the
78  * other layers. Since the bus and transport layer shouldn't dereference
79  * iwl_priv, all the data needed by the upper layer and the transport / bus
80  * layer must be here.
81  * The shared area also holds pointer to all the other layers. This allows a
82  * layer to call a function from another layer.
83  *
84  * NOTE: All the layers hold a pointer to the shared area which must be shrd.
85  *      A few macros assume that (_m)->shrd points to the shared area no matter
86  *      what _m is.
87  *
88  * gets notifications about enumeration, suspend, resume.
89  * For the moment, the bus layer is not a linux kernel module as itself, and
90  * the module_init function of the driver must call the bus specific
91  * registration functions. These functions are listed at the end of this file.
92  * For the moment, there is only one implementation of this interface: PCI-e.
93  * This implementation is iwl-pci.c
94  */
95
96 struct iwl_priv;
97 struct iwl_trans;
98 struct iwl_sensitivity_ranges;
99 struct iwl_trans_ops;
100
101 #define DRV_NAME        "iwlwifi"
102 #define IWLWIFI_VERSION "in-tree:"
103 #define DRV_COPYRIGHT   "Copyright(c) 2003-2012 Intel Corporation"
104 #define DRV_AUTHOR     "<ilw@linux.intel.com>"
105
106 extern struct iwl_mod_params iwlagn_mod_params;
107
108 #define IWL_DISABLE_HT_ALL      BIT(0)
109 #define IWL_DISABLE_HT_TXAGG    BIT(1)
110 #define IWL_DISABLE_HT_RXAGG    BIT(2)
111
112 /**
113  * struct iwl_mod_params
114  *
115  * Holds the module parameters
116  *
117  * @sw_crypto: using hardware encryption, default = 0
118  * @disable_11n: disable 11n capabilities, default = 0,
119  *      use IWL_DISABLE_HT_* constants
120  * @amsdu_size_8K: enable 8K amsdu size, default = 1
121  * @antenna: both antennas (use diversity), default = 0
122  * @restart_fw: restart firmware, default = 1
123  * @plcp_check: enable plcp health check, default = true
124  * @ack_check: disable ack health check, default = false
125  * @wd_disable: enable stuck queue check, default = 0
126  * @bt_coex_active: enable bt coex, default = true
127  * @led_mode: system default, default = 0
128  * @no_sleep_autoadjust: disable autoadjust, default = true
129  * @power_save: disable power save, default = false
130  * @power_level: power level, default = 1
131  * @debug_level: levels are IWL_DL_*
132  * @ant_coupling: antenna coupling in dB, default = 0
133  * @bt_ch_announce: BT channel inhibition, default = enable
134  * @wanted_ucode_alternative: ucode alternative to use, default = 1
135  * @auto_agg: enable agg. without check, default = true
136  */
137 struct iwl_mod_params {
138         int sw_crypto;
139         unsigned int disable_11n;
140         int amsdu_size_8K;
141         int antenna;
142         int restart_fw;
143         bool plcp_check;
144         bool ack_check;
145         int  wd_disable;
146         bool bt_coex_active;
147         int led_mode;
148         bool no_sleep_autoadjust;
149         bool power_save;
150         int power_level;
151         u32 debug_level;
152         int ant_coupling;
153         bool bt_ch_announce;
154         int wanted_ucode_alternative;
155         bool auto_agg;
156 };
157
158 /**
159  * struct iwl_hw_params
160  *
161  * Holds the module parameters
162  *
163  * @num_ampdu_queues: num of ampdu queues
164  * @tx_chains_num: Number of TX chains
165  * @rx_chains_num: Number of RX chains
166  * @valid_tx_ant: usable antennas for TX
167  * @valid_rx_ant: usable antennas for RX
168  * @ht40_channel: is 40MHz width possible: BIT(IEEE80211_BAND_XXX)
169  * @sku: sku read from EEPROM
170  * @rx_page_order: Rx buffer page order
171  * @ct_kill_threshold: temperature threshold - in hw dependent unit
172  * @ct_kill_exit_threshold: when to reeable the device - in hw dependent unit
173  *      relevant for 1000, 6000 and up
174  * @wd_timeout: TX queues watchdog timeout
175  * @struct iwl_sensitivity_ranges: range of sensitivity values
176  * @use_rts_for_aggregation: use rts/cts protection for HT traffic
177  */
178 struct iwl_hw_params {
179         u8  num_ampdu_queues;
180         u8  tx_chains_num;
181         u8  rx_chains_num;
182         u8  valid_tx_ant;
183         u8  valid_rx_ant;
184         u8  ht40_channel;
185         bool use_rts_for_aggregation;
186         u16 sku;
187         u32 rx_page_order;
188         u32 ct_kill_threshold;
189         u32 ct_kill_exit_threshold;
190         unsigned int wd_timeout;
191
192         const struct iwl_sensitivity_ranges *sens;
193 };
194
195 /**
196  * enum iwl_ucode_type
197  *
198  * The type of ucode.
199  *
200  * @IWL_UCODE_REGULAR: Normal runtime ucode
201  * @IWL_UCODE_INIT: Initial ucode
202  * @IWL_UCODE_WOWLAN: Wake on Wireless enabled ucode
203  */
204 enum iwl_ucode_type {
205         IWL_UCODE_REGULAR,
206         IWL_UCODE_INIT,
207         IWL_UCODE_WOWLAN,
208         IWL_UCODE_TYPE_MAX,
209 };
210
211 /*
212  * LED mode
213  *    IWL_LED_DEFAULT:  use device default
214  *    IWL_LED_RF_STATE: turn LED on/off based on RF state
215  *                      LED ON  = RF ON
216  *                      LED OFF = RF OFF
217  *    IWL_LED_BLINK:    adjust led blink rate based on blink table
218  *    IWL_LED_DISABLE:  led disabled
219  */
220 enum iwl_led_mode {
221         IWL_LED_DEFAULT,
222         IWL_LED_RF_STATE,
223         IWL_LED_BLINK,
224         IWL_LED_DISABLE,
225 };
226
227 /*
228  * @max_ll_items: max number of OTP blocks
229  * @shadow_ram_support: shadow support for OTP memory
230  * @led_compensation: compensate on the led on/off time per HW according
231  *      to the deviation to achieve the desired led frequency.
232  *      The detail algorithm is described in iwl-led.c
233  * @chain_noise_num_beacons: number of beacons used to compute chain noise
234  * @adv_thermal_throttle: support advance thermal throttle
235  * @support_ct_kill_exit: support ct kill exit condition
236  * @support_wimax_coexist: support wimax/wifi co-exist
237  * @plcp_delta_threshold: plcp error rate threshold used to trigger
238  *      radio tuning when there is a high receiving plcp error rate
239  * @chain_noise_scale: default chain noise scale used for gain computation
240  * @wd_timeout: TX queues watchdog timeout
241  * @max_event_log_size: size of event log buffer size for ucode event logging
242  * @shadow_reg_enable: HW shadhow register bit
243  * @hd_v2: v2 of enhanced sensitivity value, used for 2000 series and up
244  * @no_idle_support: do not support idle mode
245  * wd_disable: disable watchdog timer
246  */
247 struct iwl_base_params {
248         int eeprom_size;
249         int num_of_queues;      /* def: HW dependent */
250         int num_of_ampdu_queues;/* def: HW dependent */
251         /* for iwl_apm_init() */
252         u32 pll_cfg_val;
253
254         const u16 max_ll_items;
255         const bool shadow_ram_support;
256         u16 led_compensation;
257         bool adv_thermal_throttle;
258         bool support_ct_kill_exit;
259         const bool support_wimax_coexist;
260         u8 plcp_delta_threshold;
261         s32 chain_noise_scale;
262         unsigned int wd_timeout;
263         u32 max_event_log_size;
264         const bool shadow_reg_enable;
265         const bool hd_v2;
266         const bool no_idle_support;
267         const bool wd_disable;
268 };
269
270 /*
271  * @advanced_bt_coexist: support advanced bt coexist
272  * @bt_init_traffic_load: specify initial bt traffic load
273  * @bt_prio_boost: default bt priority boost value
274  * @agg_time_limit: maximum number of uSec in aggregation
275  * @bt_sco_disable: uCode should not response to BT in SCO/ESCO mode
276  */
277 struct iwl_bt_params {
278         bool advanced_bt_coexist;
279         u8 bt_init_traffic_load;
280         u8 bt_prio_boost;
281         u16 agg_time_limit;
282         bool bt_sco_disable;
283         bool bt_session_2;
284 };
285 /*
286  * @use_rts_for_aggregation: use rts/cts protection for HT traffic
287  */
288 struct iwl_ht_params {
289         const bool ht_greenfield_support; /* if used set to true */
290         bool use_rts_for_aggregation;
291         enum ieee80211_smps_mode smps_mode;
292 };
293
294 /**
295  * struct iwl_cfg
296  * @name: Offical name of the device
297  * @fw_name_pre: Firmware filename prefix. The api version and extension
298  *      (.ucode) will be added to filename before loading from disk. The
299  *      filename is constructed as fw_name_pre<api>.ucode.
300  * @ucode_api_max: Highest version of uCode API supported by driver.
301  * @ucode_api_ok: oldest version of the uCode API that is OK to load
302  *      without a warning, for use in transitions
303  * @ucode_api_min: Lowest version of uCode API supported by driver.
304  * @max_inst_size: The maximal length of the fw inst section
305  * @max_data_size: The maximal length of the fw data section
306  * @valid_tx_ant: valid transmit antenna
307  * @valid_rx_ant: valid receive antenna
308  * @eeprom_ver: EEPROM version
309  * @eeprom_calib_ver: EEPROM calibration version
310  * @lib: pointer to the lib ops
311  * @additional_nic_config: additional nic configuration
312  * @base_params: pointer to basic parameters
313  * @ht_params: point to ht patameters
314  * @bt_params: pointer to bt parameters
315  * @need_temp_offset_calib: need to perform temperature offset calibration
316  * @no_xtal_calib: some devices do not need crystal calibration data,
317  *      don't send it to those
318  * @scan_rx_antennas: available antenna for scan operation
319  * @led_mode: 0=blinking, 1=On(RF On)/Off(RF Off)
320  * @adv_pm: advance power management
321  * @rx_with_siso_diversity: 1x1 device with rx antenna diversity
322  * @internal_wimax_coex: internal wifi/wimax combo device
323  * @iq_invert: I/Q inversion
324  * @temp_offset_v2: support v2 of temperature offset calibration
325  *
326  * We enable the driver to be backward compatible wrt API version. The
327  * driver specifies which APIs it supports (with @ucode_api_max being the
328  * highest and @ucode_api_min the lowest). Firmware will only be loaded if
329  * it has a supported API version.
330  *
331  * The ideal usage of this infrastructure is to treat a new ucode API
332  * release as a new hardware revision.
333  */
334 struct iwl_cfg {
335         /* params specific to an individual device within a device family */
336         const char *name;
337         const char *fw_name_pre;
338         const unsigned int ucode_api_max;
339         const unsigned int ucode_api_ok;
340         const unsigned int ucode_api_min;
341         const u32 max_data_size;
342         const u32 max_inst_size;
343         u8   valid_tx_ant;
344         u8   valid_rx_ant;
345         u16  eeprom_ver;
346         u16  eeprom_calib_ver;
347         const struct iwl_lib_ops *lib;
348         void (*additional_nic_config)(struct iwl_priv *priv);
349         /* params not likely to change within a device family */
350         const struct iwl_base_params *base_params;
351         /* params likely to change within a device family */
352         const struct iwl_ht_params *ht_params;
353         const struct iwl_bt_params *bt_params;
354         const bool need_temp_offset_calib; /* if used set to true */
355         const bool no_xtal_calib;
356         u8 scan_rx_antennas[IEEE80211_NUM_BANDS];
357         enum iwl_led_mode led_mode;
358         const bool adv_pm;
359         const bool rx_with_siso_diversity;
360         const bool internal_wimax_coex;
361         const bool iq_invert;
362         const bool temp_offset_v2;
363 };
364
365 /**
366  * struct iwl_shared - shared fields for all the layers of the driver
367  *
368  * @status: STATUS_*
369  * @wowlan: are we running wowlan uCode
370  * @valid_contexts: microcode/device supports multiple contexts
371  * @bus: pointer to the bus layer data
372  * @cfg: see struct iwl_cfg
373  * @priv: pointer to the upper layer data
374  * @trans: pointer to the transport layer data
375  * @nic: pointer to the nic data
376  * @hw_params: see struct iwl_hw_params
377  * @lock: protect general shared data
378  * @eeprom: pointer to the eeprom/OTP image
379  * @ucode_type: indicator of loaded ucode image
380  * @device_pointers: pointers to ucode event tables
381  */
382 struct iwl_shared {
383         unsigned long status;
384         u8 valid_contexts;
385
386         const struct iwl_cfg *cfg;
387         struct iwl_trans *trans;
388         void *drv;
389         struct iwl_hw_params hw_params;
390         const struct iwl_fw *fw;
391
392         /* eeprom -- this is in the card's little endian byte order */
393         u8 *eeprom;
394
395         /* ucode related variables */
396         enum iwl_ucode_type ucode_type;
397
398         struct {
399                 u32 error_event_table;
400                 u32 log_event_table;
401         } device_pointers;
402
403 };
404
405 /*Whatever _m is (iwl_trans, iwl_priv, these macros will work */
406 #define cfg(_m)         ((_m)->shrd->cfg)
407 #define trans(_m)       ((_m)->shrd->trans)
408 #define hw_params(_m)   ((_m)->shrd->hw_params)
409
410 static inline bool iwl_have_debug_level(u32 level)
411 {
412         return iwlagn_mod_params.debug_level & level;
413 }
414
415 enum iwl_rxon_context_id {
416         IWL_RXON_CTX_BSS,
417         IWL_RXON_CTX_PAN,
418
419         NUM_IWL_RXON_CTX
420 };
421
422 int iwlagn_hw_valid_rtc_data_addr(u32 addr);
423 const char *get_cmd_string(u8 cmd);
424
425 #define IWL_CMD(x) case x: return #x
426
427 /*****************************************************
428 * DRIVER STATUS FUNCTIONS
429 ******************************************************/
430 #define STATUS_HCMD_ACTIVE      0       /* host command in progress */
431 /* 1 is unused (used to be STATUS_HCMD_SYNC_ACTIVE) */
432 #define STATUS_INT_ENABLED      2
433 #define STATUS_RF_KILL_HW       3
434 #define STATUS_CT_KILL          4
435 #define STATUS_INIT             5
436 #define STATUS_ALIVE            6
437 #define STATUS_READY            7
438 #define STATUS_TEMPERATURE      8
439 #define STATUS_GEO_CONFIGURED   9
440 #define STATUS_EXIT_PENDING     10
441 #define STATUS_STATISTICS       12
442 #define STATUS_SCANNING         13
443 #define STATUS_SCAN_ABORTING    14
444 #define STATUS_SCAN_HW          15
445 #define STATUS_POWER_PMI        16
446 #define STATUS_FW_ERROR         17
447 #define STATUS_DEVICE_ENABLED   18
448 #define STATUS_CHANNEL_SWITCH_PENDING 19
449 #define STATUS_SCAN_COMPLETE    20
450
451 #endif /* #__iwl_shared_h__ */