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-eeprom.h"
  42 #include "iwl-csr.h"
  43 #include "iwl-debug.h"
  44 #include "iwl-agn-hw.h"
  45 #include "iwl-led.h"
  46 #include "iwl-power.h"
  47 #include "iwl-agn-rs.h"
  48 #include "iwl-agn-tt.h"
  49 #include "iwl-trans.h"
  50 #include "iwl-shared.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 /* management statistics */
 510 enum iwl_mgmt_stats {
 511         MANAGEMENT_ASSOC_REQ = 0,
 512         MANAGEMENT_ASSOC_RESP,
 513         MANAGEMENT_REASSOC_REQ,
 514         MANAGEMENT_REASSOC_RESP,
 515         MANAGEMENT_PROBE_REQ,
 516         MANAGEMENT_PROBE_RESP,
 517         MANAGEMENT_BEACON,
 518         MANAGEMENT_ATIM,
 519         MANAGEMENT_DISASSOC,
 520         MANAGEMENT_AUTH,
 521         MANAGEMENT_DEAUTH,
 522         MANAGEMENT_ACTION,
 523         MANAGEMENT_MAX,
 524 };
 525 /* control statistics */
 526 enum iwl_ctrl_stats {
 527         CONTROL_BACK_REQ =  0,
 528         CONTROL_BACK,
 529         CONTROL_PSPOLL,
 530         CONTROL_RTS,
 531         CONTROL_CTS,
 532         CONTROL_ACK,
 533         CONTROL_CFEND,
 534         CONTROL_CFENDACK,
 535         CONTROL_MAX,
 536 };
 537
 538 struct traffic_stats {
 539 #ifdef CONFIG_IWLWIFI_DEBUGFS
 540         u32 mgmt[MANAGEMENT_MAX];
 541         u32 ctrl[CONTROL_MAX];
 542         u32 data_cnt;
 543         u64 data_bytes;
 544 #endif
 545 };
 546
 547 /*
 548  * schedule the timer to wake up every UCODE_TRACE_PERIOD milliseconds
 549  * to perform continuous uCode event logging operation if enabled
 550  */
 551 #define UCODE_TRACE_PERIOD (10)
 552
 553 /*
 554  * iwl_event_log: current uCode event log position
 555  *
 556  * @ucode_trace: enable/disable ucode continuous trace timer
 557  * @num_wraps: how many times the event buffer wraps
 558  * @next_entry:  the entry just before the next one that uCode would fill
 559  * @non_wraps_count: counter for no wrap detected when dump ucode events
 560  * @wraps_once_count: counter for wrap once detected when dump ucode events
 561  * @wraps_more_count: counter for wrap more than once detected
 562  *                    when dump ucode events
 563  */
 564 struct iwl_event_log {
 565         bool ucode_trace;
 566         u32 num_wraps;
 567         u32 next_entry;
 568         int non_wraps_count;
 569         int wraps_once_count;
 570         int wraps_more_count;
 571 };
 572
 573 /*
 574  * This is the threshold value of plcp error rate per 100mSecs.  It is
 575  * used to set and check for the validity of plcp_delta.
 576  */
 577 #define IWL_MAX_PLCP_ERR_THRESHOLD_MIN  (1)
 578 #define IWL_MAX_PLCP_ERR_THRESHOLD_DEF  (50)
 579 #define IWL_MAX_PLCP_ERR_LONG_THRESHOLD_DEF     (100)
 580 #define IWL_MAX_PLCP_ERR_EXT_LONG_THRESHOLD_DEF (200)
 581 #define IWL_MAX_PLCP_ERR_THRESHOLD_MAX  (255)
 582 #define IWL_MAX_PLCP_ERR_THRESHOLD_DISABLE      (0)
 583
 584 #define IWL_DELAY_NEXT_FORCE_RF_RESET  (HZ*3)
 585
 586 /* TX queue watchdog timeouts in mSecs */
 587 #define IWL_WATCHHDOG_DISABLED  (0)
 588 #define IWL_DEF_WD_TIMEOUT      (2000)
 589 #define IWL_LONG_WD_TIMEOUT     (10000)
 590 #define IWL_MAX_WD_TIMEOUT      (120000)
 591
 592 /* BT Antenna Coupling Threshold (dB) */
 593 #define IWL_BT_ANTENNA_COUPLING_THRESHOLD       (35)
 594
 595 /* Firmware reload counter and Timestamp */
 596 #define IWL_MIN_RELOAD_DURATION         1000 /* 1000 ms */
 597 #define IWL_MAX_CONTINUE_RELOAD_CNT     4
 598
 599
 600 struct iwl_rf_reset {
 601         int reset_request_count;
 602         int reset_success_count;
 603         int reset_reject_count;
 604         unsigned long last_reset_jiffies;
 605 };
 606
 607 enum iwl_rxon_context_id {
 608         IWL_RXON_CTX_BSS,
 609         IWL_RXON_CTX_PAN,
 610
 611         NUM_IWL_RXON_CTX
 612 };
 613
 614 /* extend beacon time format bit shifting  */
 615 /*
 616  * for _agn devices
 617  * bits 31:22 - extended
 618  * bits 21:0  - interval
 619  */
 620 #define IWLAGN_EXT_BEACON_TIME_POS      22
 621
 622 struct iwl_rxon_context {
 623         struct ieee80211_vif *vif;
 624
 625         u8 mcast_queue;
 626         u8 ac_to_queue[IEEE80211_NUM_ACS];
 627         u8 ac_to_fifo[IEEE80211_NUM_ACS];
 628
 629         /*
 630          * We could use the vif to indicate active, but we
 631          * also need it to be active during disabling when
 632          * we already removed the vif for type setting.
 633          */
 634         bool always_active, is_active;
 635
 636         bool ht_need_multiple_chains;
 637
 638         enum iwl_rxon_context_id ctxid;
 639
 640         u32 interface_modes, exclusive_interface_modes;
 641         u8 unused_devtype, ap_devtype, ibss_devtype, station_devtype;
 642
 643         /*
 644          * We declare this const so it can only be
 645          * changed via explicit cast within the
 646          * routines that actually update the physical
 647          * hardware.
 648          */
 649         const struct iwl_rxon_cmd active;
 650         struct iwl_rxon_cmd staging;
 651
 652         struct iwl_rxon_time_cmd timing;
 653
 654         struct iwl_qos_info qos_data;
 655
 656         u8 bcast_sta_id, ap_sta_id;
 657
 658         u8 rxon_cmd, rxon_assoc_cmd, rxon_timing_cmd;
 659         u8 qos_cmd;
 660         u8 wep_key_cmd;
 661
 662         struct iwl_wep_key wep_keys[WEP_KEYS_MAX];
 663         u8 key_mapping_keys;
 664
 665         __le32 station_flags;
 666
 667         int beacon_int;
 668
 669         struct {
 670                 bool non_gf_sta_present;
 671                 u8 protection;
 672                 bool enabled, is_40mhz;
 673                 u8 extension_chan_offset;
 674         } ht;
 675 };
 676
 677 enum iwl_scan_type {
 678         IWL_SCAN_NORMAL,
 679         IWL_SCAN_RADIO_RESET,
 680         IWL_SCAN_ROC,
 681 };
 682
 683 /**
 684  * struct iwl_hw_params
 685  *
 686  * Holds the module parameters
 687  *
 688  * @tx_chains_num: Number of TX chains
 689  * @rx_chains_num: Number of RX chains
 690  * @valid_tx_ant: usable antennas for TX
 691  * @valid_rx_ant: usable antennas for RX
 692  * @ht40_channel: is 40MHz width possible: BIT(IEEE80211_BAND_XXX)
 693  * @sku: sku read from EEPROM
 694  * @ct_kill_threshold: temperature threshold - in hw dependent unit
 695  * @ct_kill_exit_threshold: when to reeable the device - in hw dependent unit
 696  *      relevant for 1000, 6000 and up
 697  * @struct iwl_sensitivity_ranges: range of sensitivity values
 698  * @use_rts_for_aggregation: use rts/cts protection for HT traffic
 699  */
 700 struct iwl_hw_params {
 701         u8  tx_chains_num;
 702         u8  rx_chains_num;
 703         u8  valid_tx_ant;
 704         u8  valid_rx_ant;
 705         u8  ht40_channel;
 706         bool use_rts_for_aggregation;
 707         u16 sku;
 708         u32 ct_kill_threshold;
 709         u32 ct_kill_exit_threshold;
 710
 711         const struct iwl_sensitivity_ranges *sens;
 712 };
 713
 714 struct iwl_lib_ops {
 715         /* set hw dependent parameters */
 716         void (*set_hw_params)(struct iwl_priv *priv);
 717         int (*set_channel_switch)(struct iwl_priv *priv,
 718                                   struct ieee80211_channel_switch *ch_switch);
 719         /* device specific configuration */
 720         void (*nic_config)(struct iwl_priv *priv);
 721
 722         /* eeprom operations (as defined in iwl-eeprom.h) */
 723         struct iwl_eeprom_ops eeprom_ops;
 724
 725         /* temperature */
 726         void (*temperature)(struct iwl_priv *priv);
 727 };
 728
 729 #ifdef CONFIG_IWLWIFI_DEVICE_TESTMODE
 730 struct iwl_testmode_trace {
 731         u32 buff_size;
 732         u32 total_size;
 733         u32 num_chunks;
 734         u8 *cpu_addr;
 735         u8 *trace_addr;
 736         dma_addr_t dma_addr;
 737         bool trace_enabled;
 738 };
 739 struct iwl_testmode_mem {
 740         u32 buff_size;
 741         u32 num_chunks;
 742         u8 *buff_addr;
 743         bool read_in_progress;
 744 };
 745 #endif
 746
 747 struct iwl_wipan_noa_data {
 748         struct rcu_head rcu_head;
 749         u32 length;
 750         u8 data[];
 751 };
 752
 753 /* Calibration disabling bit mask */
 754 enum {
 755         IWL_CALIB_ENABLE_ALL                    = 0,
 756
 757         IWL_SENSITIVITY_CALIB_DISABLED          = BIT(0),
 758         IWL_CHAIN_NOISE_CALIB_DISABLED          = BIT(1),
 759         IWL_TX_POWER_CALIB_DISABLED             = BIT(2),
 760
 761         IWL_CALIB_DISABLE_ALL                   = 0xFFFFFFFF,
 762 };
 763
 764 #define IWL_OP_MODE_GET_DVM(_iwl_op_mode) \
 765         ((struct iwl_priv *) ((_iwl_op_mode)->op_mode_specific))
 766
 767 #define IWL_MAC80211_GET_DVM(_hw) \
 768         ((struct iwl_priv *) ((struct iwl_op_mode *) \
 769         (_hw)->priv)->op_mode_specific)
 770
 771 struct iwl_priv {
 772
 773         struct iwl_trans *trans;
 774         struct device *dev;             /* for debug prints only */
 775         const struct iwl_cfg *cfg;
 776         const struct iwl_fw *fw;
 777         const struct iwl_lib_ops *lib;
 778         unsigned long status;
 779
 780         spinlock_t sta_lock;
 781         struct mutex mutex;
 782
 783         unsigned long transport_queue_stop;
 784         bool passive_no_rx;
 785 #define IWL_INVALID_AC  0xff
 786         u8 queue_to_ac[IWL_MAX_HW_QUEUES];
 787         atomic_t ac_stop_count[IEEE80211_NUM_ACS];
 788
 789         unsigned long agg_q_alloc[BITS_TO_LONGS(IWL_MAX_HW_QUEUES)];
 790
 791         /* ieee device used by generic ieee processing code */
 792         struct ieee80211_hw *hw;
 793         struct ieee80211_channel *ieee_channels;
 794         struct ieee80211_rate *ieee_rates;
 795
 796         struct list_head calib_results;
 797
 798         struct workqueue_struct *workqueue;
 799
 800         struct iwl_hw_params hw_params;
 801
 802         enum ieee80211_band band;
 803         u8 valid_contexts;
 804
 805         void (*pre_rx_handler)(struct iwl_priv *priv,
 806                                struct iwl_rx_cmd_buffer *rxb);
 807         int (*rx_handlers[REPLY_MAX])(struct iwl_priv *priv,
 808                                        struct iwl_rx_cmd_buffer *rxb,
 809                                        struct iwl_device_cmd *cmd);
 810
 811         struct iwl_notif_wait_data notif_wait;
 812
 813         struct ieee80211_supported_band bands[IEEE80211_NUM_BANDS];
 814
 815         /* spectrum measurement report caching */
 816         struct iwl_spectrum_notification measure_report;
 817         u8 measurement_status;
 818
 819 #define IWL_OWNERSHIP_DRIVER    0
 820 #define IWL_OWNERSHIP_TM        1
 821         u8 ucode_owner;
 822
 823         /* ucode beacon time */
 824         u32 ucode_beacon_time;
 825         int missed_beacon_threshold;
 826
 827         /* track IBSS manager (last beacon) status */
 828         u32 ibss_manager;
 829
 830         /* jiffies when last recovery from statistics was performed */
 831         unsigned long rx_statistics_jiffies;
 832
 833         /*counters */
 834         u32 rx_handlers_stats[REPLY_MAX];
 835
 836         /* rf reset */
 837         struct iwl_rf_reset rf_reset;
 838
 839         /* firmware reload counter and timestamp */
 840         unsigned long reload_jiffies;
 841         int reload_count;
 842         bool ucode_loaded;
 843         bool init_ucode_run;            /* Don't run init uCode again */
 844
 845         /* we allocate array of iwl_channel_info for NIC's valid channels.
 846          *    Access via channel # using indirect index array */
 847         struct iwl_channel_info *channel_info;  /* channel info array */
 848         u8 channel_count;       /* # of channels */
 849
 850         u8 plcp_delta_threshold;
 851
 852         /* thermal calibration */
 853         s32 temperature;        /* Celsius */
 854         s32 last_temperature;
 855
 856         struct iwl_wipan_noa_data __rcu *noa_data;
 857
 858         /* Scan related variables */
 859         unsigned long scan_start;
 860         unsigned long scan_start_tsf;
 861         void *scan_cmd;
 862         enum ieee80211_band scan_band;
 863         struct cfg80211_scan_request *scan_request;
 864         struct ieee80211_vif *scan_vif;
 865         enum iwl_scan_type scan_type;
 866         u8 scan_tx_ant[IEEE80211_NUM_BANDS];
 867         u8 mgmt_tx_ant;
 868
 869         /* max number of station keys */
 870         u8 sta_key_max_num;
 871
 872         bool new_scan_threshold_behaviour;
 873
 874         bool wowlan;
 875
 876         /* EEPROM MAC addresses */
 877         struct mac_address addresses[2];
 878
 879         struct iwl_rxon_context contexts[NUM_IWL_RXON_CTX];
 880
 881         __le16 switch_channel;
 882
 883         u8 start_calib;
 884         struct iwl_sensitivity_data sensitivity_data;
 885         struct iwl_chain_noise_data chain_noise_data;
 886         __le16 sensitivity_tbl[HD_TABLE_SIZE];
 887         __le16 enhance_sensitivity_tbl[ENHANCE_HD_TABLE_ENTRIES];
 888
 889         struct iwl_ht_config current_ht_config;
 890
 891         /* Rate scaling data */
 892         u8 retry_rate;
 893
 894         int activity_timer_active;
 895
 896         /* counts mgmt, ctl, and data packets */
 897         struct traffic_stats tx_stats;
 898         struct traffic_stats rx_stats;
 899
 900         struct iwl_power_mgr power_data;
 901         struct iwl_tt_mgmt thermal_throttle;
 902
 903         /* station table variables */
 904         int num_stations;
 905         struct iwl_station_entry stations[IWLAGN_STATION_COUNT];
 906         unsigned long ucode_key_table;
 907         struct iwl_tid_data tid_data[IWLAGN_STATION_COUNT][IWL_MAX_TID_COUNT];
 908
 909         u8 mac80211_registered;
 910
 911         /* Indication if ieee80211_ops->open has been called */
 912         u8 is_open;
 913
 914         enum nl80211_iftype iw_mode;
 915
 916         /* Last Rx'd beacon timestamp */
 917         u64 timestamp;
 918
 919         struct {
 920                 __le32 flag;
 921                 struct statistics_general_common common;
 922                 struct statistics_rx_non_phy rx_non_phy;
 923                 struct statistics_rx_phy rx_ofdm;
 924                 struct statistics_rx_ht_phy rx_ofdm_ht;
 925                 struct statistics_rx_phy rx_cck;
 926                 struct statistics_tx tx;
 927 #ifdef CONFIG_IWLWIFI_DEBUGFS
 928                 struct statistics_bt_activity bt_activity;
 929                 __le32 num_bt_kills, accum_num_bt_kills;
 930 #endif
 931                 spinlock_t lock;
 932         } statistics;
 933 #ifdef CONFIG_IWLWIFI_DEBUGFS
 934         struct {
 935                 struct statistics_general_common common;
 936                 struct statistics_rx_non_phy rx_non_phy;
 937                 struct statistics_rx_phy rx_ofdm;
 938                 struct statistics_rx_ht_phy rx_ofdm_ht;
 939                 struct statistics_rx_phy rx_cck;
 940                 struct statistics_tx tx;
 941                 struct statistics_bt_activity bt_activity;
 942         } accum_stats, delta_stats, max_delta_stats;
 943 #endif
 944
 945         /*
 946          * reporting the number of tids has AGG on. 0 means
 947          * no AGGREGATION
 948          */
 949         u8 agg_tids_count;
 950
 951         struct iwl_rx_phy_res last_phy_res;
 952         bool last_phy_res_valid;
 953
 954         /*
 955          * chain noise reset and gain commands are the
 956          * two extra calibration commands follows the standard
 957          * phy calibration commands
 958          */
 959         u8 phy_calib_chain_noise_reset_cmd;
 960         u8 phy_calib_chain_noise_gain_cmd;
 961
 962         /* counts reply_tx error */
 963         struct reply_tx_error_statistics reply_tx_stats;
 964         struct reply_agg_tx_error_statistics reply_agg_tx_stats;
 965
 966         /* remain-on-channel offload support */
 967         struct ieee80211_channel *hw_roc_channel;
 968         struct delayed_work hw_roc_disable_work;
 969         enum nl80211_channel_type hw_roc_chantype;
 970         int hw_roc_duration;
 971         bool hw_roc_setup, hw_roc_start_notified;
 972
 973         /* bt coex */
 974         u8 bt_enable_flag;
 975         u8 bt_status;
 976         u8 bt_traffic_load, last_bt_traffic_load;
 977         bool bt_ch_announce;
 978         bool bt_full_concurrent;
 979         bool bt_ant_couple_ok;
 980         __le32 kill_ack_mask;
 981         __le32 kill_cts_mask;
 982         __le16 bt_valid;
 983         u16 bt_on_thresh;
 984         u16 bt_duration;
 985         u16 dynamic_frag_thresh;
 986         u8 bt_ci_compliance;
 987         struct work_struct bt_traffic_change_work;
 988         bool bt_enable_pspoll;
 989         struct iwl_rxon_context *cur_rssi_ctx;
 990         bool bt_is_sco;
 991
 992         struct work_struct restart;
 993         struct work_struct scan_completed;
 994         struct work_struct abort_scan;
 995
 996         struct work_struct beacon_update;
 997         struct iwl_rxon_context *beacon_ctx;
 998         struct sk_buff *beacon_skb;
 999         void *beacon_cmd;
1000
1001         struct work_struct tt_work;
1002         struct work_struct ct_enter;
1003         struct work_struct ct_exit;
1004         struct work_struct start_internal_scan;
1005         struct work_struct tx_flush;
1006         struct work_struct bt_full_concurrency;
1007         struct work_struct bt_runtime_config;
1008
1009         struct delayed_work scan_check;
1010
1011         /* TX Power */
1012         s8 tx_power_user_lmt;
1013         s8 tx_power_device_lmt;
1014         s8 tx_power_lmt_in_half_dbm; /* max tx power in half-dBm format */
1015         s8 tx_power_next;
1016
1017 #ifdef CONFIG_IWLWIFI_DEBUGFS
1018         /* debugfs */
1019         u16 tx_traffic_idx;
1020         u16 rx_traffic_idx;
1021         u8 *tx_traffic;
1022         u8 *rx_traffic;
1023         struct dentry *debugfs_dir;
1024         u32 dbgfs_sram_offset, dbgfs_sram_len;
1025         bool disable_ht40;
1026         void *wowlan_sram;
1027 #endif /* CONFIG_IWLWIFI_DEBUGFS */
1028
1029         /* eeprom -- this is in the card's little endian byte order */
1030         u8 *eeprom;
1031         enum iwl_nvm_type nvm_device_type;
1032
1033         struct work_struct txpower_work;
1034         u32 calib_disabled;
1035         struct work_struct run_time_calib_work;
1036         struct timer_list statistics_periodic;
1037         struct timer_list ucode_trace;
1038
1039         struct iwl_event_log event_log;
1040
1041         struct led_classdev led;
1042         unsigned long blink_on, blink_off;
1043         bool led_registered;
1044 #ifdef CONFIG_IWLWIFI_DEVICE_TESTMODE
1045         struct iwl_testmode_trace testmode_trace;
1046         struct iwl_testmode_mem testmode_mem;
1047         u32 tm_fixed_rate;
1048 #endif
1049
1050         /* WoWLAN GTK rekey data */
1051         u8 kck[NL80211_KCK_LEN], kek[NL80211_KEK_LEN];
1052         __le64 replay_ctr;
1053         __le16 last_seq_ctl;
1054         bool have_rekey_data;
1055
1056         /* device_pointers: pointers to ucode event tables */
1057         struct {
1058                 u32 error_event_table;
1059                 u32 log_event_table;
1060         } device_pointers;
1061
1062         /* indicator of loaded ucode image */
1063         enum iwl_ucode_type cur_ucode;
1064 }; /*iwl_priv */
1065
1066 extern struct kmem_cache *iwl_tx_cmd_pool;
1067 extern struct iwl_mod_params iwlagn_mod_params;
1068
1069 static inline struct iwl_rxon_context *
1070 iwl_rxon_ctx_from_vif(struct ieee80211_vif *vif)
1071 {
1072         struct iwl_vif_priv *vif_priv = (void *)vif->drv_priv;
1073
1074         return vif_priv->ctx;
1075 }
1076
1077 #define for_each_context(priv, ctx)                             \
1078         for (ctx = &priv->contexts[IWL_RXON_CTX_BSS];           \
1079              ctx < &priv->contexts[NUM_IWL_RXON_CTX]; ctx++)    \
1080                 if (priv->valid_contexts & BIT(ctx->ctxid))
1081
1082 static inline int iwl_is_associated_ctx(struct iwl_rxon_context *ctx)
1083 {
1084         return (ctx->active.filter_flags & RXON_FILTER_ASSOC_MSK) ? 1 : 0;
1085 }
1086
1087 static inline int iwl_is_associated(struct iwl_priv *priv,
1088                                     enum iwl_rxon_context_id ctxid)
1089 {
1090         return iwl_is_associated_ctx(&priv->contexts[ctxid]);
1091 }
1092
1093 static inline int iwl_is_any_associated(struct iwl_priv *priv)
1094 {
1095         struct iwl_rxon_context *ctx;
1096         for_each_context(priv, ctx)
1097                 if (iwl_is_associated_ctx(ctx))
1098                         return true;
1099         return false;
1100 }
1101
1102 static inline int is_channel_valid(const struct iwl_channel_info *ch_info)
1103 {
1104         if (ch_info == NULL)
1105                 return 0;
1106         return (ch_info->flags & EEPROM_CHANNEL_VALID) ? 1 : 0;
1107 }
1108
1109 static inline int is_channel_radar(const struct iwl_channel_info *ch_info)
1110 {
1111         return (ch_info->flags & EEPROM_CHANNEL_RADAR) ? 1 : 0;
1112 }
1113
1114 static inline u8 is_channel_a_band(const struct iwl_channel_info *ch_info)
1115 {
1116         return ch_info->band == IEEE80211_BAND_5GHZ;
1117 }
1118
1119 static inline u8 is_channel_bg_band(const struct iwl_channel_info *ch_info)
1120 {
1121         return ch_info->band == IEEE80211_BAND_2GHZ;
1122 }
1123
1124 static inline int is_channel_passive(const struct iwl_channel_info *ch)
1125 {
1126         return (!(ch->flags & EEPROM_CHANNEL_ACTIVE)) ? 1 : 0;
1127 }
1128
1129 static inline int is_channel_ibss(const struct iwl_channel_info *ch)
1130 {
1131         return ((ch->flags & EEPROM_CHANNEL_IBSS)) ? 1 : 0;
1132 }
1133
1134 #endif                          /* __iwl_dev_h__ */