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