hwmon: (applesmc) Ignore some temperature registers
[pandora-kernel.git] / drivers / net / wireless / iwlwifi / iwl-dev.h
1 /******************************************************************************
2  *
3  * Copyright(c) 2003 - 2012 Intel Corporation. All rights reserved.
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of version 2 of the GNU General Public License as
7  * published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
12  * more details.
13  *
14  * You should have received a copy of the GNU General Public License along with
15  * this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
17  *
18  * The full GNU General Public License is included in this distribution in the
19  * file called LICENSE.
20  *
21  * Contact Information:
22  *  Intel Linux Wireless <ilw@linux.intel.com>
23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
24  *
25  *****************************************************************************/
26 /*
27  * Please use this file (iwl-dev.h) for driver implementation definitions.
28  * Please use iwl-commands.h for uCode API definitions.
29  */
30
31 #ifndef __iwl_dev_h__
32 #define __iwl_dev_h__
33
34 #include <linux/interrupt.h>
35 #include <linux/kernel.h>
36 #include <linux/wait.h>
37 #include <linux/leds.h>
38 #include <linux/slab.h>
39 #include <linux/mutex.h>
40
41 #include "iwl-fw.h"
42 #include "iwl-eeprom.h"
43 #include "iwl-csr.h"
44 #include "iwl-debug.h"
45 #include "iwl-agn-hw.h"
46 #include "iwl-led.h"
47 #include "iwl-power.h"
48 #include "iwl-agn-rs.h"
49 #include "iwl-agn-tt.h"
50 #include "iwl-trans.h"
51 #include "iwl-op-mode.h"
52 #include "iwl-notif-wait.h"
53
54 /* CT-KILL constants */
55 #define CT_KILL_THRESHOLD_LEGACY   110 /* in Celsius */
56 #define CT_KILL_THRESHOLD          114 /* in Celsius */
57 #define CT_KILL_EXIT_THRESHOLD     95  /* in Celsius */
58
59 /* Default noise level to report when noise measurement is not available.
60  *   This may be because we're:
61  *   1)  Not associated  no beacon statistics being sent to driver)
62  *   2)  Scanning (noise measurement does not apply to associated channel)
63  * Use default noise value of -127 ... this is below the range of measurable
64  *   Rx dBm for all agn devices, so it can indicate "unmeasurable" to user.
65  *   Also, -127 works better than 0 when averaging frames with/without
66  *   noise info (e.g. averaging might be done in app); measured dBm values are
67  *   always negative ... using a negative value as the default keeps all
68  *   averages within an s8's (used in some apps) range of negative values. */
69 #define IWL_NOISE_MEAS_NOT_AVAILABLE (-127)
70
71 /*
72  * RTS threshold here is total size [2347] minus 4 FCS bytes
73  * Per spec:
74  *   a value of 0 means RTS on all data/management packets
75  *   a value > max MSDU size means no RTS
76  * else RTS for data/management frames where MPDU is larger
77  *   than RTS value.
78  */
79 #define DEFAULT_RTS_THRESHOLD     2347U
80 #define MIN_RTS_THRESHOLD         0U
81 #define MAX_RTS_THRESHOLD         2347U
82 #define MAX_MSDU_SIZE             2304U
83 #define MAX_MPDU_SIZE             2346U
84 #define DEFAULT_BEACON_INTERVAL   200U
85 #define DEFAULT_SHORT_RETRY_LIMIT 7U
86 #define DEFAULT_LONG_RETRY_LIMIT  4U
87
88 #define IWL_NUM_SCAN_RATES         (2)
89
90 /*
91  * One for each channel, holds all channel setup data
92  * Some of the fields (e.g. eeprom and flags/max_power_avg) are redundant
93  *     with one another!
94  */
95 struct iwl_channel_info {
96         struct iwl_eeprom_channel eeprom;       /* EEPROM regulatory limit */
97         struct iwl_eeprom_channel ht40_eeprom;  /* EEPROM regulatory limit for
98                                                  * HT40 channel */
99
100         u8 channel;       /* channel number */
101         u8 flags;         /* flags copied from EEPROM */
102         s8 max_power_avg; /* (dBm) regul. eeprom, normal Tx, any rate */
103         s8 curr_txpow;    /* (dBm) regulatory/spectrum/user (not h/w) limit */
104         s8 min_power;     /* always 0 */
105         s8 scan_power;    /* (dBm) regul. eeprom, direct scans, any rate */
106
107         u8 group_index;   /* 0-4, maps channel to group1/2/3/4/5 */
108         u8 band_index;    /* 0-4, maps channel to band1/2/3/4/5 */
109         enum ieee80211_band band;
110
111         /* HT40 channel info */
112         s8 ht40_max_power_avg;  /* (dBm) regul. eeprom, normal Tx, any rate */
113         u8 ht40_flags;          /* flags copied from EEPROM */
114         u8 ht40_extension_channel; /* HT_IE_EXT_CHANNEL_* */
115 };
116
117 /*
118  * Minimum number of queues. MAX_NUM is defined in hw specific files.
119  * Set the minimum to accommodate
120  *  - 4 standard TX queues
121  *  - the command queue
122  *  - 4 PAN TX queues
123  *  - the PAN multicast queue, and
124  *  - the AUX (TX during scan dwell) queue.
125  */
126 #define IWL_MIN_NUM_QUEUES      11
127
128 /*
129  * Command queue depends on iPAN support.
130  */
131 #define IWL_DEFAULT_CMD_QUEUE_NUM       4
132 #define IWL_IPAN_CMD_QUEUE_NUM          9
133
134 #define IEEE80211_DATA_LEN              2304
135 #define IEEE80211_4ADDR_LEN             30
136 #define IEEE80211_HLEN                  (IEEE80211_4ADDR_LEN)
137 #define IEEE80211_FRAME_LEN             (IEEE80211_DATA_LEN + IEEE80211_HLEN)
138
139 #define SUP_RATE_11A_MAX_NUM_CHANNELS  8
140 #define SUP_RATE_11B_MAX_NUM_CHANNELS  4
141 #define SUP_RATE_11G_MAX_NUM_CHANNELS  12
142
143 #define IWL_SUPPORTED_RATES_IE_LEN         8
144
145 #define IWL_INVALID_RATE     0xFF
146 #define IWL_INVALID_VALUE    -1
147
148 union iwl_ht_rate_supp {
149         u16 rates;
150         struct {
151                 u8 siso_rate;
152                 u8 mimo_rate;
153         };
154 };
155
156 #define CFG_HT_RX_AMPDU_FACTOR_8K   (0x0)
157 #define CFG_HT_RX_AMPDU_FACTOR_16K  (0x1)
158 #define CFG_HT_RX_AMPDU_FACTOR_32K  (0x2)
159 #define CFG_HT_RX_AMPDU_FACTOR_64K  (0x3)
160 #define CFG_HT_RX_AMPDU_FACTOR_DEF  CFG_HT_RX_AMPDU_FACTOR_64K
161 #define CFG_HT_RX_AMPDU_FACTOR_MAX  CFG_HT_RX_AMPDU_FACTOR_64K
162 #define CFG_HT_RX_AMPDU_FACTOR_MIN  CFG_HT_RX_AMPDU_FACTOR_8K
163
164 /*
165  * Maximal MPDU density for TX aggregation
166  * 4 - 2us density
167  * 5 - 4us density
168  * 6 - 8us density
169  * 7 - 16us density
170  */
171 #define CFG_HT_MPDU_DENSITY_2USEC   (0x4)
172 #define CFG_HT_MPDU_DENSITY_4USEC   (0x5)
173 #define CFG_HT_MPDU_DENSITY_8USEC   (0x6)
174 #define CFG_HT_MPDU_DENSITY_16USEC  (0x7)
175 #define CFG_HT_MPDU_DENSITY_DEF CFG_HT_MPDU_DENSITY_4USEC
176 #define CFG_HT_MPDU_DENSITY_MAX CFG_HT_MPDU_DENSITY_16USEC
177 #define CFG_HT_MPDU_DENSITY_MIN     (0x1)
178
179 struct iwl_ht_config {
180         bool single_chain_sufficient;
181         enum ieee80211_smps_mode smps; /* current smps mode */
182 };
183
184 /* QoS structures */
185 struct iwl_qos_info {
186         int qos_active;
187         struct iwl_qosparam_cmd def_qos_parm;
188 };
189
190 /**
191  * enum iwl_agg_state
192  *
193  * The state machine of the BA agreement establishment / tear down.
194  * These states relate to a specific RA / TID.
195  *
196  * @IWL_AGG_OFF: aggregation is not used
197  * @IWL_AGG_STARTING: aggregation are starting (between start and oper)
198  * @IWL_AGG_ON: aggregation session is up
199  * @IWL_EMPTYING_HW_QUEUE_ADDBA: establishing a BA session - waiting for the
200  *      HW queue to be empty from packets for this RA /TID.
201  * @IWL_EMPTYING_HW_QUEUE_DELBA: tearing down a BA session - waiting for the
202  *      HW queue to be empty from packets for this RA /TID.
203  */
204 enum iwl_agg_state {
205         IWL_AGG_OFF = 0,
206         IWL_AGG_STARTING,
207         IWL_AGG_ON,
208         IWL_EMPTYING_HW_QUEUE_ADDBA,
209         IWL_EMPTYING_HW_QUEUE_DELBA,
210 };
211
212 /**
213  * struct iwl_ht_agg - aggregation state machine
214
215  * This structs holds the states for the BA agreement establishment and tear
216  * down. It also holds the state during the BA session itself. This struct is
217  * duplicated for each RA / TID.
218
219  * @rate_n_flags: Rate at which Tx was attempted. Holds the data between the
220  *      Tx response (REPLY_TX), and the block ack notification
221  *      (REPLY_COMPRESSED_BA).
222  * @state: state of the BA agreement establishment / tear down.
223  * @txq_id: Tx queue used by the BA session
224  * @ssn: the first packet to be sent in AGG HW queue in Tx AGG start flow, or
225  *      the first packet to be sent in legacy HW queue in Tx AGG stop flow.
226  *      Basically when next_reclaimed reaches ssn, we can tell mac80211 that
227  *      we are ready to finish the Tx AGG stop / start flow.
228  * @wait_for_ba: Expect block-ack before next Tx reply
229  */
230 struct iwl_ht_agg {
231         u32 rate_n_flags;
232         enum iwl_agg_state state;
233         u16 txq_id;
234         u16 ssn;
235         bool wait_for_ba;
236 };
237
238 /**
239  * struct iwl_tid_data - one for each RA / TID
240
241  * This structs holds the states for each RA / TID.
242
243  * @seq_number: the next WiFi sequence number to use
244  * @next_reclaimed: the WiFi sequence number of the next packet to be acked.
245  *      This is basically (last acked packet++).
246  * @agg: aggregation state machine
247  */
248 struct iwl_tid_data {
249         u16 seq_number;
250         u16 next_reclaimed;
251         struct iwl_ht_agg agg;
252 };
253
254 /*
255  * Structure should be accessed with sta_lock held. When station addition
256  * is in progress (IWL_STA_UCODE_INPROGRESS) it is possible to access only
257  * the commands (iwl_addsta_cmd and iwl_link_quality_cmd) without sta_lock
258  * held.
259  */
260 struct iwl_station_entry {
261         struct iwl_addsta_cmd sta;
262         u8 used, ctxid;
263         struct iwl_link_quality_cmd *lq;
264 };
265
266 /*
267  * iwl_station_priv: Driver's private station information
268  *
269  * When mac80211 creates a station it reserves some space (hw->sta_data_size)
270  * in the structure for use by driver. This structure is places in that
271  * space.
272  */
273 struct iwl_station_priv {
274         struct iwl_rxon_context *ctx;
275         struct iwl_lq_sta lq_sta;
276         atomic_t pending_frames;
277         bool client;
278         bool asleep;
279         u8 max_agg_bufsize;
280         u8 sta_id;
281 };
282
283 /**
284  * struct iwl_vif_priv - driver's private per-interface information
285  *
286  * When mac80211 allocates a virtual interface, it can allocate
287  * space for us to put data into.
288  */
289 struct iwl_vif_priv {
290         struct iwl_rxon_context *ctx;
291         u8 ibss_bssid_sta_id;
292 };
293
294 struct iwl_sensitivity_ranges {
295         u16 min_nrg_cck;
296
297         u16 nrg_th_cck;
298         u16 nrg_th_ofdm;
299
300         u16 auto_corr_min_ofdm;
301         u16 auto_corr_min_ofdm_mrc;
302         u16 auto_corr_min_ofdm_x1;
303         u16 auto_corr_min_ofdm_mrc_x1;
304
305         u16 auto_corr_max_ofdm;
306         u16 auto_corr_max_ofdm_mrc;
307         u16 auto_corr_max_ofdm_x1;
308         u16 auto_corr_max_ofdm_mrc_x1;
309
310         u16 auto_corr_max_cck;
311         u16 auto_corr_max_cck_mrc;
312         u16 auto_corr_min_cck;
313         u16 auto_corr_min_cck_mrc;
314
315         u16 barker_corr_th_min;
316         u16 barker_corr_th_min_mrc;
317         u16 nrg_th_cca;
318 };
319
320
321 #define KELVIN_TO_CELSIUS(x) ((x)-273)
322 #define CELSIUS_TO_KELVIN(x) ((x)+273)
323
324
325 /******************************************************************************
326  *
327  * Functions implemented in core module which are forward declared here
328  * for use by iwl-[4-5].c
329  *
330  * NOTE:  The implementation of these functions are not hardware specific
331  * which is why they are in the core module files.
332  *
333  * Naming convention --
334  * iwl_         <-- Is part of iwlwifi
335  * iwlXXXX_     <-- Hardware specific (implemented in iwl-XXXX.c for XXXX)
336  *
337  ****************************************************************************/
338 extern void iwl_update_chain_flags(struct iwl_priv *priv);
339 extern const u8 iwl_bcast_addr[ETH_ALEN];
340
341 #define IWL_OPERATION_MODE_AUTO     0
342 #define IWL_OPERATION_MODE_HT_ONLY  1
343 #define IWL_OPERATION_MODE_MIXED    2
344 #define IWL_OPERATION_MODE_20MHZ    3
345
346 #define TX_POWER_IWL_ILLEGAL_VOLTAGE -10000
347
348 /* Sensitivity and chain noise calibration */
349 #define INITIALIZATION_VALUE            0xFFFF
350 #define IWL_CAL_NUM_BEACONS             16
351 #define MAXIMUM_ALLOWED_PATHLOSS        15
352
353 #define CHAIN_NOISE_MAX_DELTA_GAIN_CODE 3
354
355 #define MAX_FA_OFDM  50
356 #define MIN_FA_OFDM  5
357 #define MAX_FA_CCK   50
358 #define MIN_FA_CCK   5
359
360 #define AUTO_CORR_STEP_OFDM       1
361
362 #define AUTO_CORR_STEP_CCK     3
363 #define AUTO_CORR_MAX_TH_CCK   160
364
365 #define NRG_DIFF               2
366 #define NRG_STEP_CCK           2
367 #define NRG_MARGIN             8
368 #define MAX_NUMBER_CCK_NO_FA 100
369
370 #define AUTO_CORR_CCK_MIN_VAL_DEF    (125)
371
372 #define CHAIN_A             0
373 #define CHAIN_B             1
374 #define CHAIN_C             2
375 #define CHAIN_NOISE_DELTA_GAIN_INIT_VAL 4
376 #define ALL_BAND_FILTER                 0xFF00
377 #define IN_BAND_FILTER                  0xFF
378 #define MIN_AVERAGE_NOISE_MAX_VALUE     0xFFFFFFFF
379
380 #define NRG_NUM_PREV_STAT_L     20
381 #define NUM_RX_CHAINS           3
382
383 enum iwlagn_false_alarm_state {
384         IWL_FA_TOO_MANY = 0,
385         IWL_FA_TOO_FEW = 1,
386         IWL_FA_GOOD_RANGE = 2,
387 };
388
389 enum iwlagn_chain_noise_state {
390         IWL_CHAIN_NOISE_ALIVE = 0,  /* must be 0 */
391         IWL_CHAIN_NOISE_ACCUMULATE,
392         IWL_CHAIN_NOISE_CALIBRATED,
393         IWL_CHAIN_NOISE_DONE,
394 };
395
396 /* Sensitivity calib data */
397 struct iwl_sensitivity_data {
398         u32 auto_corr_ofdm;
399         u32 auto_corr_ofdm_mrc;
400         u32 auto_corr_ofdm_x1;
401         u32 auto_corr_ofdm_mrc_x1;
402         u32 auto_corr_cck;
403         u32 auto_corr_cck_mrc;
404
405         u32 last_bad_plcp_cnt_ofdm;
406         u32 last_fa_cnt_ofdm;
407         u32 last_bad_plcp_cnt_cck;
408         u32 last_fa_cnt_cck;
409
410         u32 nrg_curr_state;
411         u32 nrg_prev_state;
412         u32 nrg_value[10];
413         u8  nrg_silence_rssi[NRG_NUM_PREV_STAT_L];
414         u32 nrg_silence_ref;
415         u32 nrg_energy_idx;
416         u32 nrg_silence_idx;
417         u32 nrg_th_cck;
418         s32 nrg_auto_corr_silence_diff;
419         u32 num_in_cck_no_fa;
420         u32 nrg_th_ofdm;
421
422         u16 barker_corr_th_min;
423         u16 barker_corr_th_min_mrc;
424         u16 nrg_th_cca;
425 };
426
427 /* Chain noise (differential Rx gain) calib data */
428 struct iwl_chain_noise_data {
429         u32 active_chains;
430         u32 chain_noise_a;
431         u32 chain_noise_b;
432         u32 chain_noise_c;
433         u32 chain_signal_a;
434         u32 chain_signal_b;
435         u32 chain_signal_c;
436         u16 beacon_count;
437         u8 disconn_array[NUM_RX_CHAINS];
438         u8 delta_gain_code[NUM_RX_CHAINS];
439         u8 radio_write;
440         u8 state;
441 };
442
443 enum {
444         MEASUREMENT_READY = (1 << 0),
445         MEASUREMENT_ACTIVE = (1 << 1),
446 };
447
448 enum iwl_nvm_type {
449         NVM_DEVICE_TYPE_EEPROM = 0,
450         NVM_DEVICE_TYPE_OTP,
451 };
452
453 /*
454  * Two types of OTP memory access modes
455  *   IWL_OTP_ACCESS_ABSOLUTE - absolute address mode,
456  *                              based on physical memory addressing
457  *   IWL_OTP_ACCESS_RELATIVE - relative address mode,
458  *                             based on logical memory addressing
459  */
460 enum iwl_access_mode {
461         IWL_OTP_ACCESS_ABSOLUTE,
462         IWL_OTP_ACCESS_RELATIVE,
463 };
464
465 /* reply_tx_statistics (for _agn devices) */
466 struct reply_tx_error_statistics {
467         u32 pp_delay;
468         u32 pp_few_bytes;
469         u32 pp_bt_prio;
470         u32 pp_quiet_period;
471         u32 pp_calc_ttak;
472         u32 int_crossed_retry;
473         u32 short_limit;
474         u32 long_limit;
475         u32 fifo_underrun;
476         u32 drain_flow;
477         u32 rfkill_flush;
478         u32 life_expire;
479         u32 dest_ps;
480         u32 host_abort;
481         u32 bt_retry;
482         u32 sta_invalid;
483         u32 frag_drop;
484         u32 tid_disable;
485         u32 fifo_flush;
486         u32 insuff_cf_poll;
487         u32 fail_hw_drop;
488         u32 sta_color_mismatch;
489         u32 unknown;
490 };
491
492 /* reply_agg_tx_statistics (for _agn devices) */
493 struct reply_agg_tx_error_statistics {
494         u32 underrun;
495         u32 bt_prio;
496         u32 few_bytes;
497         u32 abort;
498         u32 last_sent_ttl;
499         u32 last_sent_try;
500         u32 last_sent_bt_kill;
501         u32 scd_query;
502         u32 bad_crc32;
503         u32 response;
504         u32 dump_tx;
505         u32 delay_tx;
506         u32 unknown;
507 };
508
509 /*
510  * schedule the timer to wake up every UCODE_TRACE_PERIOD milliseconds
511  * to perform continuous uCode event logging operation if enabled
512  */
513 #define UCODE_TRACE_PERIOD (10)
514
515 /*
516  * iwl_event_log: current uCode event log position
517  *
518  * @ucode_trace: enable/disable ucode continuous trace timer
519  * @num_wraps: how many times the event buffer wraps
520  * @next_entry:  the entry just before the next one that uCode would fill
521  * @non_wraps_count: counter for no wrap detected when dump ucode events
522  * @wraps_once_count: counter for wrap once detected when dump ucode events
523  * @wraps_more_count: counter for wrap more than once detected
524  *                    when dump ucode events
525  */
526 struct iwl_event_log {
527         bool ucode_trace;
528         u32 num_wraps;
529         u32 next_entry;
530         int non_wraps_count;
531         int wraps_once_count;
532         int wraps_more_count;
533 };
534
535 #define IWL_DELAY_NEXT_FORCE_RF_RESET  (HZ*3)
536
537 /* BT Antenna Coupling Threshold (dB) */
538 #define IWL_BT_ANTENNA_COUPLING_THRESHOLD       (35)
539
540 /* Firmware reload counter and Timestamp */
541 #define IWL_MIN_RELOAD_DURATION         1000 /* 1000 ms */
542 #define IWL_MAX_CONTINUE_RELOAD_CNT     4
543
544
545 struct iwl_rf_reset {
546         int reset_request_count;
547         int reset_success_count;
548         int reset_reject_count;
549         unsigned long last_reset_jiffies;
550 };
551
552 enum iwl_rxon_context_id {
553         IWL_RXON_CTX_BSS,
554         IWL_RXON_CTX_PAN,
555
556         NUM_IWL_RXON_CTX
557 };
558
559 /* extend beacon time format bit shifting  */
560 /*
561  * for _agn devices
562  * bits 31:22 - extended
563  * bits 21:0  - interval
564  */
565 #define IWLAGN_EXT_BEACON_TIME_POS      22
566
567 struct iwl_rxon_context {
568         struct ieee80211_vif *vif;
569
570         u8 mcast_queue;
571         u8 ac_to_queue[IEEE80211_NUM_ACS];
572         u8 ac_to_fifo[IEEE80211_NUM_ACS];
573
574         /*
575          * We could use the vif to indicate active, but we
576          * also need it to be active during disabling when
577          * we already removed the vif for type setting.
578          */
579         bool always_active, is_active;
580
581         bool ht_need_multiple_chains;
582
583         enum iwl_rxon_context_id ctxid;
584
585         u32 interface_modes, exclusive_interface_modes;
586         u8 unused_devtype, ap_devtype, ibss_devtype, station_devtype;
587
588         /*
589          * We declare this const so it can only be
590          * changed via explicit cast within the
591          * routines that actually update the physical
592          * hardware.
593          */
594         const struct iwl_rxon_cmd active;
595         struct iwl_rxon_cmd staging;
596
597         struct iwl_rxon_time_cmd timing;
598
599         struct iwl_qos_info qos_data;
600
601         u8 bcast_sta_id, ap_sta_id;
602
603         u8 rxon_cmd, rxon_assoc_cmd, rxon_timing_cmd;
604         u8 qos_cmd;
605         u8 wep_key_cmd;
606
607         struct iwl_wep_key wep_keys[WEP_KEYS_MAX];
608         u8 key_mapping_keys;
609
610         __le32 station_flags;
611
612         int beacon_int;
613
614         struct {
615                 bool non_gf_sta_present;
616                 u8 protection;
617                 bool enabled, is_40mhz;
618                 u8 extension_chan_offset;
619         } ht;
620 };
621
622 enum iwl_scan_type {
623         IWL_SCAN_NORMAL,
624         IWL_SCAN_RADIO_RESET,
625         IWL_SCAN_ROC,
626 };
627
628 /**
629  * struct iwl_hw_params
630  *
631  * Holds the module parameters
632  *
633  * @tx_chains_num: Number of TX chains
634  * @rx_chains_num: Number of RX chains
635  * @valid_tx_ant: usable antennas for TX
636  * @valid_rx_ant: usable antennas for RX
637  * @ht40_channel: is 40MHz width possible: BIT(IEEE80211_BAND_XXX)
638  * @sku: sku read from EEPROM
639  * @ct_kill_threshold: temperature threshold - in hw dependent unit
640  * @ct_kill_exit_threshold: when to reeable the device - in hw dependent unit
641  *      relevant for 1000, 6000 and up
642  * @struct iwl_sensitivity_ranges: range of sensitivity values
643  * @use_rts_for_aggregation: use rts/cts protection for HT traffic
644  */
645 struct iwl_hw_params {
646         u8  tx_chains_num;
647         u8  rx_chains_num;
648         u8  valid_tx_ant;
649         u8  valid_rx_ant;
650         u8  ht40_channel;
651         bool use_rts_for_aggregation;
652         u16 sku;
653         u32 ct_kill_threshold;
654         u32 ct_kill_exit_threshold;
655
656         const struct iwl_sensitivity_ranges *sens;
657 };
658
659 struct iwl_lib_ops {
660         /* set hw dependent parameters */
661         void (*set_hw_params)(struct iwl_priv *priv);
662         int (*set_channel_switch)(struct iwl_priv *priv,
663                                   struct ieee80211_channel_switch *ch_switch);
664         /* device specific configuration */
665         void (*nic_config)(struct iwl_priv *priv);
666
667         /* eeprom operations (as defined in iwl-eeprom.h) */
668         struct iwl_eeprom_ops eeprom_ops;
669
670         /* temperature */
671         void (*temperature)(struct iwl_priv *priv);
672 };
673
674 #ifdef CONFIG_IWLWIFI_DEVICE_TESTMODE
675 struct iwl_testmode_trace {
676         u32 buff_size;
677         u32 total_size;
678         u32 num_chunks;
679         u8 *cpu_addr;
680         u8 *trace_addr;
681         dma_addr_t dma_addr;
682         bool trace_enabled;
683 };
684 struct iwl_testmode_mem {
685         u32 buff_size;
686         u32 num_chunks;
687         u8 *buff_addr;
688         bool read_in_progress;
689 };
690 #endif
691
692 struct iwl_wipan_noa_data {
693         struct rcu_head rcu_head;
694         u32 length;
695         u8 data[];
696 };
697
698 /* Calibration disabling bit mask */
699 enum {
700         IWL_CALIB_ENABLE_ALL                    = 0,
701
702         IWL_SENSITIVITY_CALIB_DISABLED          = BIT(0),
703         IWL_CHAIN_NOISE_CALIB_DISABLED          = BIT(1),
704         IWL_TX_POWER_CALIB_DISABLED             = BIT(2),
705
706         IWL_CALIB_DISABLE_ALL                   = 0xFFFFFFFF,
707 };
708
709 #define IWL_OP_MODE_GET_DVM(_iwl_op_mode) \
710         ((struct iwl_priv *) ((_iwl_op_mode)->op_mode_specific))
711
712 #define IWL_MAC80211_GET_DVM(_hw) \
713         ((struct iwl_priv *) ((struct iwl_op_mode *) \
714         (_hw)->priv)->op_mode_specific)
715
716 struct iwl_priv {
717
718         struct iwl_trans *trans;
719         struct device *dev;             /* for debug prints only */
720         const struct iwl_cfg *cfg;
721         const struct iwl_fw *fw;
722         const struct iwl_lib_ops *lib;
723         unsigned long status;
724
725         spinlock_t sta_lock;
726         struct mutex mutex;
727
728         unsigned long transport_queue_stop;
729         bool passive_no_rx;
730 #define IWL_INVALID_MAC80211_QUEUE      0xff
731         u8 queue_to_mac80211[IWL_MAX_HW_QUEUES];
732         atomic_t queue_stop_count[IWL_MAX_HW_QUEUES];
733
734         unsigned long agg_q_alloc[BITS_TO_LONGS(IWL_MAX_HW_QUEUES)];
735
736         /* ieee device used by generic ieee processing code */
737         struct ieee80211_hw *hw;
738         struct ieee80211_channel *ieee_channels;
739         struct ieee80211_rate *ieee_rates;
740
741         struct list_head calib_results;
742
743         struct workqueue_struct *workqueue;
744
745         struct iwl_hw_params hw_params;
746
747         enum ieee80211_band band;
748         u8 valid_contexts;
749
750         void (*pre_rx_handler)(struct iwl_priv *priv,
751                                struct iwl_rx_cmd_buffer *rxb);
752         int (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
753                                        struct iwl_rx_cmd_buffer *rxb,
754                                        struct iwl_device_cmd *cmd);
755
756         struct iwl_notif_wait_data notif_wait;
757
758         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
759
760         /* spectrum measurement report caching */
761         struct iwl_spectrum_notification measure_report;
762         u8 measurement_status;
763
764 #define IWL_OWNERSHIP_DRIVER    0
765 #define IWL_OWNERSHIP_TM        1
766         u8 ucode_owner;
767
768         /* ucode beacon time */
769         u32 ucode_beacon_time;
770         int missed_beacon_threshold;
771
772         /* track IBSS manager (last beacon) status */
773         u32 ibss_manager;
774
775         /* jiffies when last recovery from statistics was performed */
776         unsigned long rx_statistics_jiffies;
777
778         /*counters */
779         u32 rx_handlers_stats[REPLY_MAX];
780
781         /* rf reset */
782         struct iwl_rf_reset rf_reset;
783
784         /* firmware reload counter and timestamp */
785         unsigned long reload_jiffies;
786         int reload_count;
787         bool ucode_loaded;
788         bool init_ucode_run;            /* Don't run init uCode again */
789
790         /* we allocate array of iwl_channel_info for NIC's valid channels.
791          *    Access via channel # using indirect index array */
792         struct iwl_channel_info *channel_info;  /* channel info array */
793         u8 channel_count;       /* # of channels */
794
795         u8 plcp_delta_threshold;
796
797         /* thermal calibration */
798         s32 temperature;        /* Celsius */
799         s32 last_temperature;
800
801         struct iwl_wipan_noa_data __rcu *noa_data;
802
803         /* Scan related variables */
804         unsigned long scan_start;
805         unsigned long scan_start_tsf;
806         void *scan_cmd;
807         enum ieee80211_band scan_band;
808         struct cfg80211_scan_request *scan_request;
809         struct ieee80211_vif *scan_vif;
810         enum iwl_scan_type scan_type;
811         u8 scan_tx_ant[IEEE80211_NUM_BANDS];
812         u8 mgmt_tx_ant;
813
814         /* max number of station keys */
815         u8 sta_key_max_num;
816
817         bool new_scan_threshold_behaviour;
818
819         bool wowlan;
820
821         /* EEPROM MAC addresses */
822         struct mac_address addresses[2];
823
824         struct iwl_rxon_context contexts[NUM_IWL_RXON_CTX];
825
826         __le16 switch_channel;
827
828         u8 start_calib;
829         struct iwl_sensitivity_data sensitivity_data;
830         struct iwl_chain_noise_data chain_noise_data;
831         __le16 sensitivity_tbl[HD_TABLE_SIZE];
832         __le16 enhance_sensitivity_tbl[ENHANCE_HD_TABLE_ENTRIES];
833
834         struct iwl_ht_config current_ht_config;
835
836         /* Rate scaling data */
837         u8 retry_rate;
838
839         int activity_timer_active;
840
841         struct iwl_power_mgr power_data;
842         struct iwl_tt_mgmt thermal_throttle;
843
844         /* station table variables */
845         int num_stations;
846         struct iwl_station_entry stations[IWLAGN_STATION_COUNT];
847         unsigned long ucode_key_table;
848         struct iwl_tid_data tid_data[IWLAGN_STATION_COUNT][IWL_MAX_TID_COUNT];
849
850         u8 mac80211_registered;
851
852         /* Indication if ieee80211_ops->open has been called */
853         u8 is_open;
854
855         enum nl80211_iftype iw_mode;
856
857         /* Last Rx'd beacon timestamp */
858         u64 timestamp;
859
860         struct {
861                 __le32 flag;
862                 struct statistics_general_common common;
863                 struct statistics_rx_non_phy rx_non_phy;
864                 struct statistics_rx_phy rx_ofdm;
865                 struct statistics_rx_ht_phy rx_ofdm_ht;
866                 struct statistics_rx_phy rx_cck;
867                 struct statistics_tx tx;
868 #ifdef CONFIG_IWLWIFI_DEBUGFS
869                 struct statistics_bt_activity bt_activity;
870                 __le32 num_bt_kills, accum_num_bt_kills;
871 #endif
872                 spinlock_t lock;
873         } statistics;
874 #ifdef CONFIG_IWLWIFI_DEBUGFS
875         struct {
876                 struct statistics_general_common common;
877                 struct statistics_rx_non_phy rx_non_phy;
878                 struct statistics_rx_phy rx_ofdm;
879                 struct statistics_rx_ht_phy rx_ofdm_ht;
880                 struct statistics_rx_phy rx_cck;
881                 struct statistics_tx tx;
882                 struct statistics_bt_activity bt_activity;
883         } accum_stats, delta_stats, max_delta_stats;
884 #endif
885
886         /*
887          * reporting the number of tids has AGG on. 0 means
888          * no AGGREGATION
889          */
890         u8 agg_tids_count;
891
892         struct iwl_rx_phy_res last_phy_res;
893         bool last_phy_res_valid;
894
895         /*
896          * chain noise reset and gain commands are the
897          * two extra calibration commands follows the standard
898          * phy calibration commands
899          */
900         u8 phy_calib_chain_noise_reset_cmd;
901         u8 phy_calib_chain_noise_gain_cmd;
902
903         /* counts reply_tx error */
904         struct reply_tx_error_statistics reply_tx_stats;
905         struct reply_agg_tx_error_statistics reply_agg_tx_stats;
906
907         /* remain-on-channel offload support */
908         struct ieee80211_channel *hw_roc_channel;
909         struct delayed_work hw_roc_disable_work;
910         enum nl80211_channel_type hw_roc_chantype;
911         int hw_roc_duration;
912         bool hw_roc_setup, hw_roc_start_notified;
913
914         /* bt coex */
915         u8 bt_enable_flag;
916         u8 bt_status;
917         u8 bt_traffic_load, last_bt_traffic_load;
918         bool bt_ch_announce;
919         bool bt_full_concurrent;
920         bool bt_ant_couple_ok;
921         __le32 kill_ack_mask;
922         __le32 kill_cts_mask;
923         __le16 bt_valid;
924         bool reduced_txpower;
925         u16 bt_on_thresh;
926         u16 bt_duration;
927         u16 dynamic_frag_thresh;
928         u8 bt_ci_compliance;
929         struct work_struct bt_traffic_change_work;
930         bool bt_enable_pspoll;
931         struct iwl_rxon_context *cur_rssi_ctx;
932         bool bt_is_sco;
933
934         struct work_struct restart;
935         struct work_struct scan_completed;
936         struct work_struct abort_scan;
937
938         struct work_struct beacon_update;
939         struct iwl_rxon_context *beacon_ctx;
940         struct sk_buff *beacon_skb;
941         void *beacon_cmd;
942
943         struct work_struct tt_work;
944         struct work_struct ct_enter;
945         struct work_struct ct_exit;
946         struct work_struct start_internal_scan;
947         struct work_struct tx_flush;
948         struct work_struct bt_full_concurrency;
949         struct work_struct bt_runtime_config;
950
951         struct delayed_work scan_check;
952
953         /* TX Power */
954         s8 tx_power_user_lmt;
955         s8 tx_power_device_lmt;
956         s8 tx_power_lmt_in_half_dbm; /* max tx power in half-dBm format */
957         s8 tx_power_next;
958
959 #ifdef CONFIG_IWLWIFI_DEBUGFS
960         /* debugfs */
961         struct dentry *debugfs_dir;
962         u32 dbgfs_sram_offset, dbgfs_sram_len;
963         bool disable_ht40;
964         void *wowlan_sram;
965 #endif /* CONFIG_IWLWIFI_DEBUGFS */
966
967         /* eeprom -- this is in the card's little endian byte order */
968         u8 *eeprom;
969         enum iwl_nvm_type nvm_device_type;
970
971         struct work_struct txpower_work;
972         u32 calib_disabled;
973         struct work_struct run_time_calib_work;
974         struct timer_list statistics_periodic;
975         struct timer_list ucode_trace;
976
977         struct iwl_event_log event_log;
978
979         struct led_classdev led;
980         unsigned long blink_on, blink_off;
981         bool led_registered;
982 #ifdef CONFIG_IWLWIFI_DEVICE_TESTMODE
983         struct iwl_testmode_trace testmode_trace;
984         struct iwl_testmode_mem testmode_mem;
985         u32 tm_fixed_rate;
986 #endif
987
988         /* WoWLAN GTK rekey data */
989         u8 kck[NL80211_KCK_LEN], kek[NL80211_KEK_LEN];
990         __le64 replay_ctr;
991         __le16 last_seq_ctl;
992         bool have_rekey_data;
993
994         /* device_pointers: pointers to ucode event tables */
995         struct {
996                 u32 error_event_table;
997                 u32 log_event_table;
998         } device_pointers;
999
1000         /* indicator of loaded ucode image */
1001         enum iwl_ucode_type cur_ucode;
1002 }; /*iwl_priv */
1003
1004 extern struct kmem_cache *iwl_tx_cmd_pool;
1005
1006 static inline struct iwl_rxon_context *
1007 iwl_rxon_ctx_from_vif(struct ieee80211_vif *vif)
1008 {
1009         struct iwl_vif_priv *vif_priv = (void *)vif->drv_priv;
1010
1011         return vif_priv->ctx;
1012 }
1013
1014 #define for_each_context(priv, ctx)                             \
1015         for (ctx = &priv->contexts[IWL_RXON_CTX_BSS];           \
1016              ctx < &priv->contexts[NUM_IWL_RXON_CTX]; ctx++)    \
1017                 if (priv->valid_contexts & BIT(ctx->ctxid))
1018
1019 static inline int iwl_is_associated_ctx(struct iwl_rxon_context *ctx)
1020 {
1021         return (ctx->active.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1022 }
1023
1024 static inline int iwl_is_associated(struct iwl_priv *priv,
1025                                     enum iwl_rxon_context_id ctxid)
1026 {
1027         return iwl_is_associated_ctx(&priv->contexts[ctxid]);
1028 }
1029
1030 static inline int iwl_is_any_associated(struct iwl_priv *priv)
1031 {
1032         struct iwl_rxon_context *ctx;
1033         for_each_context(priv, ctx)
1034                 if (iwl_is_associated_ctx(ctx))
1035                         return true;
1036         return false;
1037 }
1038
1039 static inline int is_channel_valid(const struct iwl_channel_info *ch_info)
1040 {
1041         if (ch_info == NULL)
1042                 return 0;
1043         return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1044 }
1045
1046 static inline int is_channel_radar(const struct iwl_channel_info *ch_info)
1047 {
1048         return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1049 }
1050
1051 static inline u8 is_channel_a_band(const struct iwl_channel_info *ch_info)
1052 {
1053         return ch_info->band == IEEE80211_BAND_5GHZ;
1054 }
1055
1056 static inline u8 is_channel_bg_band(const struct iwl_channel_info *ch_info)
1057 {
1058         return ch_info->band == IEEE80211_BAND_2GHZ;
1059 }
1060
1061 static inline int is_channel_passive(const struct iwl_channel_info *ch)
1062 {
1063         return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1064 }
1065
1066 static inline int is_channel_ibss(const struct iwl_channel_info *ch)
1067 {
1068         return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1069 }
1070
1071 #endif                          /* __iwl_dev_h__ */