drivers/net/wireless/iwlwifi/mvm/mvm.h

   1 /******************************************************************************
   2  *
   3  * This file is provided under a dual BSD/GPLv2 license.  When using or
   4  * redistributing this file, you may do so under either license.
   5  *
   6  * GPL LICENSE SUMMARY
   7  *
   8  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of version 2 of the GNU General Public License as
  12  * published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  22  * USA
  23  *
  24  * The full GNU General Public License is included in this distribution
  25  * in the file called COPYING.
  26  *
  27  * Contact Information:
  28  *  Intel Linux Wireless <ilw@linux.intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2012 - 2014 Intel Corporation. All rights reserved.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  *
  40  *  * Redistributions of source code must retain the above copyright
  41  *    notice, this list of conditions and the following disclaimer.
  42  *  * Redistributions in binary form must reproduce the above copyright
  43  *    notice, this list of conditions and the following disclaimer in
  44  *    the documentation and/or other materials provided with the
  45  *    distribution.
  46  *  * Neither the name Intel Corporation nor the names of its
  47  *    contributors may be used to endorse or promote products derived
  48  *    from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  54  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  56  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  60  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  *
  62  *****************************************************************************/
  63
  64 #ifndef __IWL_MVM_H__
  65 #define __IWL_MVM_H__
  66
  67 #include <linux/list.h>
  68 #include <linux/spinlock.h>
  69 #include <linux/leds.h>
  70 #include <linux/in6.h>
  71
  72 #include "iwl-op-mode.h"
  73 #include "iwl-trans.h"
  74 #include "iwl-notif-wait.h"
  75 #include "iwl-eeprom-parse.h"
  76 #include "sta.h"
  77 #include "fw-api.h"
  78 #include "constants.h"
  79
  80 #define IWL_INVALID_MAC80211_QUEUE      0xff
  81 #define IWL_MVM_MAX_ADDRESSES           5
  82 /* RSSI offset for WkP */
  83 #define IWL_RSSI_OFFSET 50
  84 #define IWL_MVM_MISSED_BEACONS_THRESHOLD 8
  85
  86 enum iwl_mvm_tx_fifo {
  87         IWL_MVM_TX_FIFO_BK = 0,
  88         IWL_MVM_TX_FIFO_BE,
  89         IWL_MVM_TX_FIFO_VI,
  90         IWL_MVM_TX_FIFO_VO,
  91         IWL_MVM_TX_FIFO_MCAST = 5,
  92 };
  93
  94 extern const struct ieee80211_ops iwl_mvm_hw_ops;
  95
  96 /**
  97  * struct iwl_mvm_mod_params - module parameters for iwlmvm
  98  * @init_dbg: if true, then the NIC won't be stopped if the INIT fw asserted.
  99  *      We will register to mac80211 to have testmode working. The NIC must not
 100  *      be up'ed after the INIT fw asserted. This is useful to be able to use
 101  *      proprietary tools over testmode to debug the INIT fw.
 102  * @power_scheme: CAM(Continuous Active Mode)-1, BPS(Balanced Power
 103  *      Save)-2(default), LP(Low Power)-3
 104  */
 105 struct iwl_mvm_mod_params {
 106         bool init_dbg;
 107         int power_scheme;
 108 };
 109 extern struct iwl_mvm_mod_params iwlmvm_mod_params;
 110
 111 struct iwl_mvm_phy_ctxt {
 112         u16 id;
 113         u16 color;
 114         u32 ref;
 115
 116         /*
 117          * TODO: This should probably be removed. Currently here only for rate
 118          * scaling algorithm
 119          */
 120         struct ieee80211_channel *channel;
 121 };
 122
 123 struct iwl_mvm_time_event_data {
 124         struct ieee80211_vif *vif;
 125         struct list_head list;
 126         unsigned long end_jiffies;
 127         u32 duration;
 128         bool running;
 129         u32 uid;
 130
 131         /*
 132          * The access to the 'id' field must be done when the
 133          * mvm->time_event_lock is held, as it value is used to indicate
 134          * if the te is in the time event list or not (when id == TE_MAX)
 135          */
 136         u32 id;
 137 };
 138
 139  /* Power management */
 140
 141 /**
 142  * enum iwl_power_scheme
 143  * @IWL_POWER_LEVEL_CAM - Continuously Active Mode
 144  * @IWL_POWER_LEVEL_BPS - Balanced Power Save (default)
 145  * @IWL_POWER_LEVEL_LP  - Low Power
 146  */
 147 enum iwl_power_scheme {
 148         IWL_POWER_SCHEME_CAM = 1,
 149         IWL_POWER_SCHEME_BPS,
 150         IWL_POWER_SCHEME_LP
 151 };
 152
 153 #define IWL_CONN_MAX_LISTEN_INTERVAL    70
 154 #define IWL_UAPSD_AC_INFO               (IEEE80211_WMM_IE_STA_QOSINFO_AC_VO |\
 155                                          IEEE80211_WMM_IE_STA_QOSINFO_AC_VI |\
 156                                          IEEE80211_WMM_IE_STA_QOSINFO_AC_BK |\
 157                                          IEEE80211_WMM_IE_STA_QOSINFO_AC_BE)
 158 #define IWL_UAPSD_MAX_SP                IEEE80211_WMM_IE_STA_QOSINFO_SP_2
 159
 160 #ifdef CONFIG_IWLWIFI_DEBUGFS
 161 enum iwl_dbgfs_pm_mask {
 162         MVM_DEBUGFS_PM_KEEP_ALIVE = BIT(0),
 163         MVM_DEBUGFS_PM_SKIP_OVER_DTIM = BIT(1),
 164         MVM_DEBUGFS_PM_SKIP_DTIM_PERIODS = BIT(2),
 165         MVM_DEBUGFS_PM_RX_DATA_TIMEOUT = BIT(3),
 166         MVM_DEBUGFS_PM_TX_DATA_TIMEOUT = BIT(4),
 167         MVM_DEBUGFS_PM_DISABLE_POWER_OFF = BIT(5),
 168         MVM_DEBUGFS_PM_LPRX_ENA = BIT(6),
 169         MVM_DEBUGFS_PM_LPRX_RSSI_THRESHOLD = BIT(7),
 170         MVM_DEBUGFS_PM_SNOOZE_ENABLE = BIT(8),
 171         MVM_DEBUGFS_PM_UAPSD_MISBEHAVING = BIT(9),
 172 };
 173
 174 struct iwl_dbgfs_pm {
 175         u16 keep_alive_seconds;
 176         u32 rx_data_timeout;
 177         u32 tx_data_timeout;
 178         bool skip_over_dtim;
 179         u8 skip_dtim_periods;
 180         bool disable_power_off;
 181         bool lprx_ena;
 182         u32 lprx_rssi_threshold;
 183         bool snooze_ena;
 184         bool uapsd_misbehaving;
 185         int mask;
 186 };
 187
 188 /* beacon filtering */
 189
 190 enum iwl_dbgfs_bf_mask {
 191         MVM_DEBUGFS_BF_ENERGY_DELTA = BIT(0),
 192         MVM_DEBUGFS_BF_ROAMING_ENERGY_DELTA = BIT(1),
 193         MVM_DEBUGFS_BF_ROAMING_STATE = BIT(2),
 194         MVM_DEBUGFS_BF_TEMP_THRESHOLD = BIT(3),
 195         MVM_DEBUGFS_BF_TEMP_FAST_FILTER = BIT(4),
 196         MVM_DEBUGFS_BF_TEMP_SLOW_FILTER = BIT(5),
 197         MVM_DEBUGFS_BF_ENABLE_BEACON_FILTER = BIT(6),
 198         MVM_DEBUGFS_BF_DEBUG_FLAG = BIT(7),
 199         MVM_DEBUGFS_BF_ESCAPE_TIMER = BIT(8),
 200         MVM_DEBUGFS_BA_ESCAPE_TIMER = BIT(9),
 201         MVM_DEBUGFS_BA_ENABLE_BEACON_ABORT = BIT(10),
 202 };
 203
 204 struct iwl_dbgfs_bf {
 205         u32 bf_energy_delta;
 206         u32 bf_roaming_energy_delta;
 207         u32 bf_roaming_state;
 208         u32 bf_temp_threshold;
 209         u32 bf_temp_fast_filter;
 210         u32 bf_temp_slow_filter;
 211         u32 bf_enable_beacon_filter;
 212         u32 bf_debug_flag;
 213         u32 bf_escape_timer;
 214         u32 ba_escape_timer;
 215         u32 ba_enable_beacon_abort;
 216         int mask;
 217 };
 218 #endif
 219
 220 enum iwl_mvm_smps_type_request {
 221         IWL_MVM_SMPS_REQ_BT_COEX,
 222         IWL_MVM_SMPS_REQ_TT,
 223         NUM_IWL_MVM_SMPS_REQ,
 224 };
 225
 226 enum iwl_mvm_ref_type {
 227         IWL_MVM_REF_UCODE_DOWN,
 228         IWL_MVM_REF_SCAN,
 229         IWL_MVM_REF_ROC,
 230         IWL_MVM_REF_P2P_CLIENT,
 231         IWL_MVM_REF_AP_IBSS,
 232         IWL_MVM_REF_USER,
 233
 234         IWL_MVM_REF_COUNT,
 235 };
 236
 237 /**
 238 * struct iwl_mvm_vif_bf_data - beacon filtering related data
 239 * @bf_enabled: indicates if beacon filtering is enabled
 240 * @ba_enabled: indicated if beacon abort is enabled
 241 * @last_beacon_signal: last beacon rssi signal in dbm
 242 * @ave_beacon_signal: average beacon signal
 243 * @last_cqm_event: rssi of the last cqm event
 244 * @bt_coex_min_thold: minimum threshold for BT coex
 245 * @bt_coex_max_thold: maximum threshold for BT coex
 246 * @last_bt_coex_event: rssi of the last BT coex event
 247 */
 248 struct iwl_mvm_vif_bf_data {
 249         bool bf_enabled;
 250         bool ba_enabled;
 251         s8 ave_beacon_signal;
 252         s8 last_cqm_event;
 253         s8 bt_coex_min_thold;
 254         s8 bt_coex_max_thold;
 255         s8 last_bt_coex_event;
 256 };
 257
 258 /**
 259  * struct iwl_mvm_vif - data per Virtual Interface, it is a MAC context
 260  * @id: between 0 and 3
 261  * @color: to solve races upon MAC addition and removal
 262  * @ap_sta_id: the sta_id of the AP - valid only if VIF type is STA
 263  * @uploaded: indicates the MAC context has been added to the device
 264  * @ap_ibss_active: indicates that AP/IBSS is configured and that the interface
 265  *      should get quota etc.
 266  * @monitor_active: indicates that monitor context is configured, and that the
 267  *      interface should get quota etc.
 268  * @low_latency: indicates that this interface is in low-latency mode
 269  *      (VMACLowLatencyMode)
 270  * @queue_params: QoS params for this MAC
 271  * @bcast_sta: station used for broadcast packets. Used by the following
 272  *  vifs: P2P_DEVICE, GO and AP.
 273  * @beacon_skb: the skb used to hold the AP/GO beacon template
 274  * @smps_requests: the SMPS requests of differents parts of the driver,
 275  *      combined on update to yield the overall request to mac80211.
 276  */
 277 struct iwl_mvm_vif {
 278         u16 id;
 279         u16 color;
 280         u8 ap_sta_id;
 281
 282         bool uploaded;
 283         bool ap_ibss_active;
 284         bool monitor_active;
 285         bool low_latency;
 286         struct iwl_mvm_vif_bf_data bf_data;
 287
 288         u32 ap_beacon_time;
 289
 290         enum iwl_tsf_id tsf_id;
 291
 292         /*
 293          * QoS data from mac80211, need to store this here
 294          * as mac80211 has a separate callback but we need
 295          * to have the data for the MAC context
 296          */
 297         struct ieee80211_tx_queue_params queue_params[IEEE80211_NUM_ACS];
 298         struct iwl_mvm_time_event_data time_event_data;
 299
 300         struct iwl_mvm_int_sta bcast_sta;
 301
 302         /*
 303          * Assigned while mac80211 has the interface in a channel context,
 304          * or, for P2P Device, while it exists.
 305          */
 306         struct iwl_mvm_phy_ctxt *phy_ctxt;
 307
 308 #ifdef CONFIG_PM_SLEEP
 309         /* WoWLAN GTK rekey data */
 310         struct {
 311                 u8 kck[NL80211_KCK_LEN], kek[NL80211_KEK_LEN];
 312                 __le64 replay_ctr;
 313                 bool valid;
 314         } rekey_data;
 315
 316         int tx_key_idx;
 317
 318         bool seqno_valid;
 319         u16 seqno;
 320
 321 #if IS_ENABLED(CONFIG_IPV6)
 322         /* IPv6 addresses for WoWLAN */
 323         struct in6_addr target_ipv6_addrs[IWL_PROTO_OFFLOAD_NUM_IPV6_ADDRS_MAX];
 324         int num_target_ipv6_addrs;
 325 #endif
 326 #endif
 327
 328 #ifdef CONFIG_IWLWIFI_DEBUGFS
 329         struct iwl_mvm *mvm;
 330         struct dentry *dbgfs_dir;
 331         struct dentry *dbgfs_slink;
 332         struct iwl_dbgfs_pm dbgfs_pm;
 333         struct iwl_dbgfs_bf dbgfs_bf;
 334         struct iwl_mac_power_cmd mac_pwr_cmd;
 335 #endif
 336
 337         enum ieee80211_smps_mode smps_requests[NUM_IWL_MVM_SMPS_REQ];
 338
 339         /* FW identified misbehaving AP */
 340         u8 uapsd_misbehaving_bssid[ETH_ALEN];
 341 };
 342
 343 static inline struct iwl_mvm_vif *
 344 iwl_mvm_vif_from_mac80211(struct ieee80211_vif *vif)
 345 {
 346         return (void *)vif->drv_priv;
 347 }
 348
 349 enum iwl_scan_status {
 350         IWL_MVM_SCAN_NONE,
 351         IWL_MVM_SCAN_OS,
 352         IWL_MVM_SCAN_SCHED,
 353 };
 354
 355 /**
 356  * struct iwl_nvm_section - describes an NVM section in memory.
 357  *
 358  * This struct holds an NVM section read from the NIC using NVM_ACCESS_CMD,
 359  * and saved for later use by the driver. Not all NVM sections are saved
 360  * this way, only the needed ones.
 361  */
 362 struct iwl_nvm_section {
 363         u16 length;
 364         const u8 *data;
 365 };
 366
 367 /*
 368  * Tx-backoff threshold
 369  * @temperature: The threshold in Celsius
 370  * @backoff: The tx-backoff in uSec
 371  */
 372 struct iwl_tt_tx_backoff {
 373         s32 temperature;
 374         u32 backoff;
 375 };
 376
 377 #define TT_TX_BACKOFF_SIZE 6
 378
 379 /**
 380  * struct iwl_tt_params - thermal throttling parameters
 381  * @ct_kill_entry: CT Kill entry threshold
 382  * @ct_kill_exit: CT Kill exit threshold
 383  * @ct_kill_duration: The time  intervals (in uSec) in which the driver needs
 384  *      to checks whether to exit CT Kill.
 385  * @dynamic_smps_entry: Dynamic SMPS entry threshold
 386  * @dynamic_smps_exit: Dynamic SMPS exit threshold
 387  * @tx_protection_entry: TX protection entry threshold
 388  * @tx_protection_exit: TX protection exit threshold
 389  * @tx_backoff: Array of thresholds for tx-backoff , in ascending order.
 390  * @support_ct_kill: Support CT Kill?
 391  * @support_dynamic_smps: Support dynamic SMPS?
 392  * @support_tx_protection: Support tx protection?
 393  * @support_tx_backoff: Support tx-backoff?
 394  */
 395 struct iwl_tt_params {
 396         s32 ct_kill_entry;
 397         s32 ct_kill_exit;
 398         u32 ct_kill_duration;
 399         s32 dynamic_smps_entry;
 400         s32 dynamic_smps_exit;
 401         s32 tx_protection_entry;
 402         s32 tx_protection_exit;
 403         struct iwl_tt_tx_backoff tx_backoff[TT_TX_BACKOFF_SIZE];
 404         bool support_ct_kill;
 405         bool support_dynamic_smps;
 406         bool support_tx_protection;
 407         bool support_tx_backoff;
 408 };
 409
 410 /**
 411  * struct iwl_mvm_tt_mgnt - Thermal Throttling Management structure
 412  * @ct_kill_exit: worker to exit thermal kill
 413  * @dynamic_smps: Is thermal throttling enabled dynamic_smps?
 414  * @tx_backoff: The current thremal throttling tx backoff in uSec.
 415  * @min_backoff: The minimal tx backoff due to power restrictions
 416  * @params: Parameters to configure the thermal throttling algorithm.
 417  * @throttle: Is thermal throttling is active?
 418  */
 419 struct iwl_mvm_tt_mgmt {
 420         struct delayed_work ct_kill_exit;
 421         bool dynamic_smps;
 422         u32 tx_backoff;
 423         u32 min_backoff;
 424         const struct iwl_tt_params *params;
 425         bool throttle;
 426 };
 427
 428 #define IWL_MVM_NUM_LAST_FRAMES_UCODE_RATES 8
 429
 430 struct iwl_mvm_frame_stats {
 431         u32 legacy_frames;
 432         u32 ht_frames;
 433         u32 vht_frames;
 434         u32 bw_20_frames;
 435         u32 bw_40_frames;
 436         u32 bw_80_frames;
 437         u32 bw_160_frames;
 438         u32 sgi_frames;
 439         u32 ngi_frames;
 440         u32 siso_frames;
 441         u32 mimo2_frames;
 442         u32 agg_frames;
 443         u32 ampdu_count;
 444         u32 success_frames;
 445         u32 fail_frames;
 446         u32 last_rates[IWL_MVM_NUM_LAST_FRAMES_UCODE_RATES];
 447         int last_frame_idx;
 448 };
 449
 450 struct iwl_mvm {
 451         /* for logger access */
 452         struct device *dev;
 453
 454         struct iwl_trans *trans;
 455         const struct iwl_fw *fw;
 456         const struct iwl_cfg *cfg;
 457         struct iwl_phy_db *phy_db;
 458         struct ieee80211_hw *hw;
 459
 460         /* for protecting access to iwl_mvm */
 461         struct mutex mutex;
 462         struct list_head async_handlers_list;
 463         spinlock_t async_handlers_lock;
 464         struct work_struct async_handlers_wk;
 465
 466         struct work_struct roc_done_wk;
 467
 468         unsigned long status;
 469
 470         /*
 471          * for beacon filtering -
 472          * currently only one interface can be supported
 473          */
 474         struct iwl_mvm_vif *bf_allowed_vif;
 475
 476         enum iwl_ucode_type cur_ucode;
 477         bool ucode_loaded;
 478         bool init_ucode_complete;
 479         u32 error_event_table;
 480         u32 log_event_table;
 481         u32 umac_error_event_table;
 482         bool support_umac_log;
 483
 484         u32 ampdu_ref;
 485
 486         struct iwl_notif_wait_data notif_wait;
 487
 488         struct mvm_statistics_rx rx_stats;
 489
 490         unsigned long transport_queue_stop;
 491         u8 queue_to_mac80211[IWL_MAX_HW_QUEUES];
 492         atomic_t queue_stop_count[IWL_MAX_HW_QUEUES];
 493
 494         struct iwl_nvm_data *nvm_data;
 495         /* NVM sections */
 496         struct iwl_nvm_section nvm_sections[NVM_MAX_NUM_SECTIONS];
 497
 498         /* EEPROM MAC addresses */
 499         struct mac_address addresses[IWL_MVM_MAX_ADDRESSES];
 500
 501         /* data related to data path */
 502         struct iwl_rx_phy_info last_phy_info;
 503         struct ieee80211_sta __rcu *fw_id_to_mac_id[IWL_MVM_STATION_COUNT];
 504         struct work_struct sta_drained_wk;
 505         unsigned long sta_drained[BITS_TO_LONGS(IWL_MVM_STATION_COUNT)];
 506         atomic_t pending_frames[IWL_MVM_STATION_COUNT];
 507         u8 rx_ba_sessions;
 508
 509         /* configured by mac80211 */
 510         u32 rts_threshold;
 511
 512         /* Scan status, cmd (pre-allocated) and auxiliary station */
 513         enum iwl_scan_status scan_status;
 514         struct iwl_scan_cmd *scan_cmd;
 515         struct iwl_mcast_filter_cmd *mcast_filter_cmd;
 516
 517         /* rx chain antennas set through debugfs for the scan command */
 518         u8 scan_rx_ant;
 519
 520 #ifdef CONFIG_IWLWIFI_BCAST_FILTERING
 521         /* broadcast filters to configure for each associated station */
 522         const struct iwl_fw_bcast_filter *bcast_filters;
 523 #ifdef CONFIG_IWLWIFI_DEBUGFS
 524         struct {
 525                 u32 override; /* u32 for debugfs_create_bool */
 526                 struct iwl_bcast_filter_cmd cmd;
 527         } dbgfs_bcast_filtering;
 528 #endif
 529 #endif
 530
 531         /* Internal station */
 532         struct iwl_mvm_int_sta aux_sta;
 533
 534         u8 scan_last_antenna_idx; /* to toggle TX between antennas */
 535         u8 mgmt_last_antenna_idx;
 536
 537         /* last smart fifo state that was successfully sent to firmware */
 538         enum iwl_sf_state sf_state;
 539
 540 #ifdef CONFIG_IWLWIFI_DEBUGFS
 541         struct dentry *debugfs_dir;
 542         u32 dbgfs_sram_offset, dbgfs_sram_len;
 543         u32 dbgfs_prph_reg_addr;
 544         bool disable_power_off;
 545         bool disable_power_off_d3;
 546
 547         struct debugfs_blob_wrapper nvm_hw_blob;
 548         struct debugfs_blob_wrapper nvm_sw_blob;
 549         struct debugfs_blob_wrapper nvm_calib_blob;
 550         struct debugfs_blob_wrapper nvm_prod_blob;
 551
 552         struct iwl_mvm_frame_stats drv_rx_stats;
 553         spinlock_t drv_stats_lock;
 554 #endif
 555
 556         struct iwl_mvm_phy_ctxt phy_ctxts[NUM_PHY_CTX];
 557
 558         struct list_head time_event_list;
 559         spinlock_t time_event_lock;
 560
 561         /*
 562          * A bitmap indicating the index of the key in use. The firmware
 563          * can hold 16 keys at most. Reflect this fact.
 564          */
 565         unsigned long fw_key_table[BITS_TO_LONGS(STA_KEY_MAX_NUM)];
 566
 567         /* A bitmap of reference types taken by the driver. */
 568         unsigned long ref_bitmap[BITS_TO_LONGS(IWL_MVM_REF_COUNT)];
 569
 570         u8 vif_count;
 571
 572         /* -1 for always, 0 for never, >0 for that many times */
 573         s8 restart_fw;
 574
 575         struct led_classdev led;
 576
 577         struct ieee80211_vif *p2p_device_vif;
 578
 579 #ifdef CONFIG_PM_SLEEP
 580         struct wiphy_wowlan_support wowlan;
 581         int gtk_ivlen, gtk_icvlen, ptk_ivlen, ptk_icvlen;
 582 #ifdef CONFIG_IWLWIFI_DEBUGFS
 583         u32 d3_wake_sysassert; /* must be u32 for debugfs_create_bool */
 584         bool d3_test_active;
 585         bool store_d3_resume_sram;
 586         void *d3_resume_sram;
 587         u32 d3_test_pme_ptr;
 588         struct ieee80211_vif *keep_vif;
 589 #endif
 590 #endif
 591
 592         /* d0i3 */
 593         u8 d0i3_ap_sta_id;
 594         struct work_struct d0i3_exit_work;
 595
 596         /* BT-Coex */
 597         u8 bt_kill_msk;
 598         struct iwl_bt_coex_profile_notif last_bt_notif;
 599         struct iwl_bt_coex_ci_cmd last_bt_ci_cmd;
 600
 601         /* Thermal Throttling and CTkill */
 602         struct iwl_mvm_tt_mgmt thermal_throttle;
 603         s32 temperature;        /* Celsius */
 604
 605 #ifdef CONFIG_NL80211_TESTMODE
 606         u32 noa_duration;
 607         struct ieee80211_vif *noa_vif;
 608 #endif
 609
 610         /* Tx queues */
 611         u8 aux_queue;
 612         u8 first_agg_queue;
 613         u8 last_agg_queue;
 614
 615         /* Indicate if device power save is allowed */
 616         bool ps_disabled;
 617         /* Indicate if device power management is allowed */
 618         bool pm_disabled;
 619 };
 620
 621 /* Extract MVM priv from op_mode and _hw */
 622 #define IWL_OP_MODE_GET_MVM(_iwl_op_mode)               \
 623         ((struct iwl_mvm *)(_iwl_op_mode)->op_mode_specific)
 624
 625 #define IWL_MAC80211_GET_MVM(_hw)                       \
 626         IWL_OP_MODE_GET_MVM((struct iwl_op_mode *)((_hw)->priv))
 627
 628 enum iwl_mvm_status {
 629         IWL_MVM_STATUS_HW_RFKILL,
 630         IWL_MVM_STATUS_HW_CTKILL,
 631         IWL_MVM_STATUS_ROC_RUNNING,
 632         IWL_MVM_STATUS_IN_HW_RESTART,
 633 };
 634
 635 static inline bool iwl_mvm_is_radio_killed(struct iwl_mvm *mvm)
 636 {
 637         return test_bit(IWL_MVM_STATUS_HW_RFKILL, &mvm->status) ||
 638                test_bit(IWL_MVM_STATUS_HW_CTKILL, &mvm->status);
 639 }
 640
 641 static inline struct iwl_mvm_sta *
 642 iwl_mvm_sta_from_staid_protected(struct iwl_mvm *mvm, u8 sta_id)
 643 {
 644         struct ieee80211_sta *sta;
 645
 646         if (sta_id >= ARRAY_SIZE(mvm->fw_id_to_mac_id))
 647                 return NULL;
 648
 649         sta = rcu_dereference_protected(mvm->fw_id_to_mac_id[sta_id],
 650                                         lockdep_is_held(&mvm->mutex));
 651
 652         /* This can happen if the station has been removed right now */
 653         if (IS_ERR_OR_NULL(sta))
 654                 return NULL;
 655
 656         return iwl_mvm_sta_from_mac80211(sta);
 657 }
 658
 659 extern const u8 iwl_mvm_ac_to_tx_fifo[];
 660
 661 struct iwl_rate_info {
 662         u8 plcp;        /* uCode API:  IWL_RATE_6M_PLCP, etc. */
 663         u8 plcp_siso;   /* uCode API:  IWL_RATE_SISO_6M_PLCP, etc. */
 664         u8 plcp_mimo2;  /* uCode API:  IWL_RATE_MIMO2_6M_PLCP, etc. */
 665         u8 plcp_mimo3;  /* uCode API:  IWL_RATE_MIMO3_6M_PLCP, etc. */
 666         u8 ieee;        /* MAC header:  IWL_RATE_6M_IEEE, etc. */
 667 };
 668
 669 /******************
 670  * MVM Methods
 671  ******************/
 672 /* uCode */
 673 int iwl_run_init_mvm_ucode(struct iwl_mvm *mvm, bool read_nvm);
 674
 675 /* Utils */
 676 int iwl_mvm_legacy_rate_to_mac80211_idx(u32 rate_n_flags,
 677                                         enum ieee80211_band band);
 678 void iwl_mvm_hwrate_to_tx_rate(u32 rate_n_flags,
 679                                enum ieee80211_band band,
 680                                struct ieee80211_tx_rate *r);
 681 u8 iwl_mvm_mac80211_idx_to_hwrate(int rate_idx);
 682 void iwl_mvm_dump_nic_error_log(struct iwl_mvm *mvm);
 683 void iwl_mvm_dump_sram(struct iwl_mvm *mvm);
 684 u8 first_antenna(u8 mask);
 685 u8 iwl_mvm_next_antenna(struct iwl_mvm *mvm, u8 valid, u8 last_idx);
 686
 687 /* Tx / Host Commands */
 688 int __must_check iwl_mvm_send_cmd(struct iwl_mvm *mvm,
 689                                   struct iwl_host_cmd *cmd);
 690 int __must_check iwl_mvm_send_cmd_pdu(struct iwl_mvm *mvm, u8 id,
 691                                       u32 flags, u16 len, const void *data);
 692 int __must_check iwl_mvm_send_cmd_status(struct iwl_mvm *mvm,
 693                                          struct iwl_host_cmd *cmd,
 694                                          u32 *status);
 695 int __must_check iwl_mvm_send_cmd_pdu_status(struct iwl_mvm *mvm, u8 id,
 696                                              u16 len, const void *data,
 697                                              u32 *status);
 698 int iwl_mvm_tx_skb(struct iwl_mvm *mvm, struct sk_buff *skb,
 699                    struct ieee80211_sta *sta);
 700 int iwl_mvm_tx_skb_non_sta(struct iwl_mvm *mvm, struct sk_buff *skb);
 701 #ifdef CONFIG_IWLWIFI_DEBUG
 702 const char *iwl_mvm_get_tx_fail_reason(u32 status);
 703 #else
 704 static inline const char *iwl_mvm_get_tx_fail_reason(u32 status) { return ""; }
 705 #endif
 706 int iwl_mvm_flush_tx_path(struct iwl_mvm *mvm, u32 tfd_msk, bool sync);
 707 void iwl_mvm_async_handlers_purge(struct iwl_mvm *mvm);
 708
 709 /* Statistics */
 710 int iwl_mvm_rx_reply_statistics(struct iwl_mvm *mvm,
 711                                 struct iwl_rx_cmd_buffer *rxb,
 712                                 struct iwl_device_cmd *cmd);
 713 int iwl_mvm_rx_statistics(struct iwl_mvm *mvm,
 714                           struct iwl_rx_cmd_buffer *rxb,
 715                           struct iwl_device_cmd *cmd);
 716
 717 /* NVM */
 718 int iwl_nvm_init(struct iwl_mvm *mvm);
 719 int iwl_mvm_load_nvm_to_nic(struct iwl_mvm *mvm);
 720
 721 int iwl_mvm_up(struct iwl_mvm *mvm);
 722 int iwl_mvm_load_d3_fw(struct iwl_mvm *mvm);
 723
 724 int iwl_mvm_mac_setup_register(struct iwl_mvm *mvm);
 725 bool iwl_mvm_bcast_filter_build_cmd(struct iwl_mvm *mvm,
 726                                     struct iwl_bcast_filter_cmd *cmd);
 727
 728 /*
 729  * FW notifications / CMD responses handlers
 730  * Convention: iwl_mvm_rx_<NAME OF THE CMD>
 731  */
 732 int iwl_mvm_rx_rx_phy_cmd(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
 733                           struct iwl_device_cmd *cmd);
 734 int iwl_mvm_rx_rx_mpdu(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
 735                        struct iwl_device_cmd *cmd);
 736 int iwl_mvm_rx_tx_cmd(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
 737                       struct iwl_device_cmd *cmd);
 738 int iwl_mvm_rx_ba_notif(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
 739                         struct iwl_device_cmd *cmd);
 740 int iwl_mvm_rx_radio_ver(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
 741                          struct iwl_device_cmd *cmd);
 742 int iwl_mvm_rx_fw_error(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
 743                           struct iwl_device_cmd *cmd);
 744 int iwl_mvm_rx_card_state_notif(struct iwl_mvm *mvm,
 745                                 struct iwl_rx_cmd_buffer *rxb,
 746                                 struct iwl_device_cmd *cmd);
 747 int iwl_mvm_rx_radio_ver(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
 748                          struct iwl_device_cmd *cmd);
 749
 750 /* MVM PHY */
 751 int iwl_mvm_phy_ctxt_add(struct iwl_mvm *mvm, struct iwl_mvm_phy_ctxt *ctxt,
 752                          struct cfg80211_chan_def *chandef,
 753                          u8 chains_static, u8 chains_dynamic);
 754 int iwl_mvm_phy_ctxt_changed(struct iwl_mvm *mvm, struct iwl_mvm_phy_ctxt *ctxt,
 755                              struct cfg80211_chan_def *chandef,
 756                              u8 chains_static, u8 chains_dynamic);
 757 void iwl_mvm_phy_ctxt_ref(struct iwl_mvm *mvm,
 758                           struct iwl_mvm_phy_ctxt *ctxt);
 759 void iwl_mvm_phy_ctxt_unref(struct iwl_mvm *mvm,
 760                             struct iwl_mvm_phy_ctxt *ctxt);
 761
 762 /* MAC (virtual interface) programming */
 763 int iwl_mvm_mac_ctxt_init(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
 764 void iwl_mvm_mac_ctxt_release(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
 765 int iwl_mvm_mac_ctxt_add(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
 766 int iwl_mvm_mac_ctxt_changed(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
 767 int iwl_mvm_mac_ctxt_remove(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
 768 u32 iwl_mvm_mac_get_queues_mask(struct iwl_mvm *mvm,
 769                                 struct ieee80211_vif *vif);
 770 int iwl_mvm_mac_ctxt_beacon_changed(struct iwl_mvm *mvm,
 771                                     struct ieee80211_vif *vif);
 772 int iwl_mvm_rx_beacon_notif(struct iwl_mvm *mvm,
 773                             struct iwl_rx_cmd_buffer *rxb,
 774                             struct iwl_device_cmd *cmd);
 775 int iwl_mvm_rx_missed_beacons_notif(struct iwl_mvm *mvm,
 776                                     struct iwl_rx_cmd_buffer *rxb,
 777                                     struct iwl_device_cmd *cmd);
 778 void iwl_mvm_mac_ctxt_recalc_tsf_id(struct iwl_mvm *mvm,
 779                                     struct ieee80211_vif *vif);
 780
 781 /* Bindings */
 782 int iwl_mvm_binding_add_vif(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
 783 int iwl_mvm_binding_remove_vif(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
 784
 785 /* Quota management */
 786 int iwl_mvm_update_quotas(struct iwl_mvm *mvm, struct ieee80211_vif *newvif);
 787
 788 /* Scanning */
 789 int iwl_mvm_scan_request(struct iwl_mvm *mvm,
 790                          struct ieee80211_vif *vif,
 791                          struct cfg80211_scan_request *req);
 792 int iwl_mvm_rx_scan_response(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
 793                              struct iwl_device_cmd *cmd);
 794 int iwl_mvm_rx_scan_complete(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
 795                              struct iwl_device_cmd *cmd);
 796 void iwl_mvm_cancel_scan(struct iwl_mvm *mvm);
 797
 798 /* Scheduled scan */
 799 int iwl_mvm_rx_scan_offload_complete_notif(struct iwl_mvm *mvm,
 800                                            struct iwl_rx_cmd_buffer *rxb,
 801                                            struct iwl_device_cmd *cmd);
 802 int iwl_mvm_config_sched_scan(struct iwl_mvm *mvm,
 803                               struct ieee80211_vif *vif,
 804                               struct cfg80211_sched_scan_request *req,
 805                               struct ieee80211_sched_scan_ies *ies);
 806 int iwl_mvm_config_sched_scan_profiles(struct iwl_mvm *mvm,
 807                                        struct cfg80211_sched_scan_request *req);
 808 int iwl_mvm_sched_scan_start(struct iwl_mvm *mvm,
 809                              struct cfg80211_sched_scan_request *req);
 810 void iwl_mvm_sched_scan_stop(struct iwl_mvm *mvm);
 811 int iwl_mvm_rx_sched_scan_results(struct iwl_mvm *mvm,
 812                                   struct iwl_rx_cmd_buffer *rxb,
 813                                   struct iwl_device_cmd *cmd);
 814
 815 /* MVM debugfs */
 816 #ifdef CONFIG_IWLWIFI_DEBUGFS
 817 int iwl_mvm_dbgfs_register(struct iwl_mvm *mvm, struct dentry *dbgfs_dir);
 818 void iwl_mvm_vif_dbgfs_register(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
 819 void iwl_mvm_vif_dbgfs_clean(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
 820 #else
 821 static inline int iwl_mvm_dbgfs_register(struct iwl_mvm *mvm,
 822                                          struct dentry *dbgfs_dir)
 823 {
 824         return 0;
 825 }
 826 static inline void
 827 iwl_mvm_vif_dbgfs_register(struct iwl_mvm *mvm, struct ieee80211_vif *vif)
 828 {
 829 }
 830 static inline void
 831 iwl_mvm_vif_dbgfs_clean(struct iwl_mvm *mvm, struct ieee80211_vif *vif)
 832 {
 833 }
 834 #endif /* CONFIG_IWLWIFI_DEBUGFS */
 835
 836 /* rate scaling */
 837 int iwl_mvm_send_lq_cmd(struct iwl_mvm *mvm, struct iwl_lq_cmd *lq, bool init);
 838 void iwl_mvm_update_frame_stats(struct iwl_mvm *mvm,
 839                                 struct iwl_mvm_frame_stats *stats,
 840                                 u32 rate, bool agg);
 841 int rs_pretty_print_rate(char *buf, const u32 rate);
 842
 843 /* power management */
 844 int iwl_power_legacy_set_cam_mode(struct iwl_mvm *mvm);
 845
 846 int iwl_mvm_power_update_device(struct iwl_mvm *mvm);
 847 int iwl_mvm_power_update_mac(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
 848 int iwl_mvm_power_mac_dbgfs_read(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
 849                                  char *buf, int bufsz);
 850
 851 void iwl_mvm_power_vif_assoc(struct iwl_mvm *mvm, struct ieee80211_vif *vif);
 852 int iwl_mvm_power_uapsd_misbehaving_ap_notif(struct iwl_mvm *mvm,
 853                                              struct iwl_rx_cmd_buffer *rxb,
 854                                              struct iwl_device_cmd *cmd);
 855
 856 int iwl_mvm_leds_init(struct iwl_mvm *mvm);
 857 void iwl_mvm_leds_exit(struct iwl_mvm *mvm);
 858
 859 /* D3 (WoWLAN, NetDetect) */
 860 int iwl_mvm_suspend(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
 861 int iwl_mvm_resume(struct ieee80211_hw *hw);
 862 void iwl_mvm_set_wakeup(struct ieee80211_hw *hw, bool enabled);
 863 void iwl_mvm_set_rekey_data(struct ieee80211_hw *hw,
 864                             struct ieee80211_vif *vif,
 865                             struct cfg80211_gtk_rekey_data *data);
 866 void iwl_mvm_ipv6_addr_change(struct ieee80211_hw *hw,
 867                               struct ieee80211_vif *vif,
 868                               struct inet6_dev *idev);
 869 void iwl_mvm_set_default_unicast_key(struct ieee80211_hw *hw,
 870                                      struct ieee80211_vif *vif, int idx);
 871 extern const struct file_operations iwl_dbgfs_d3_test_ops;
 872 #ifdef CONFIG_PM_SLEEP
 873 void iwl_mvm_set_last_nonqos_seq(struct iwl_mvm *mvm,
 874                                  struct ieee80211_vif *vif);
 875 #else
 876 static inline void
 877 iwl_mvm_set_last_nonqos_seq(struct iwl_mvm *mvm, struct ieee80211_vif *vif)
 878 {
 879 }
 880 #endif
 881
 882 /* D0i3 */
 883 void iwl_mvm_ref(struct iwl_mvm *mvm, enum iwl_mvm_ref_type ref_type);
 884 void iwl_mvm_unref(struct iwl_mvm *mvm, enum iwl_mvm_ref_type ref_type);
 885
 886 /* BT Coex */
 887 int iwl_send_bt_prio_tbl(struct iwl_mvm *mvm);
 888 int iwl_send_bt_init_conf(struct iwl_mvm *mvm);
 889 int iwl_mvm_rx_bt_coex_notif(struct iwl_mvm *mvm,
 890                              struct iwl_rx_cmd_buffer *rxb,
 891                              struct iwl_device_cmd *cmd);
 892 void iwl_mvm_bt_rssi_event(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
 893                            enum ieee80211_rssi_event rssi_event);
 894 void iwl_mvm_bt_coex_vif_change(struct iwl_mvm *mvm);
 895 u16 iwl_mvm_bt_coex_agg_time_limit(struct iwl_mvm *mvm,
 896                                    struct ieee80211_sta *sta);
 897 bool iwl_mvm_bt_coex_is_mimo_allowed(struct iwl_mvm *mvm,
 898                                      struct ieee80211_sta *sta);
 899 int iwl_mvm_bt_coex_reduced_txp(struct iwl_mvm *mvm, u8 sta_id, bool enable);
 900
 901 enum iwl_bt_kill_msk {
 902         BT_KILL_MSK_DEFAULT,
 903         BT_KILL_MSK_SCO_HID_A2DP,
 904         BT_KILL_MSK_REDUCED_TXPOW,
 905         BT_KILL_MSK_MAX,
 906 };
 907 extern const u32 iwl_bt_ack_kill_msk[BT_KILL_MSK_MAX];
 908 extern const u32 iwl_bt_cts_kill_msk[BT_KILL_MSK_MAX];
 909
 910 /* beacon filtering */
 911 #ifdef CONFIG_IWLWIFI_DEBUGFS
 912 void
 913 iwl_mvm_beacon_filter_debugfs_parameters(struct ieee80211_vif *vif,
 914                                          struct iwl_beacon_filter_cmd *cmd);
 915 #else
 916 static inline void
 917 iwl_mvm_beacon_filter_debugfs_parameters(struct ieee80211_vif *vif,
 918                                          struct iwl_beacon_filter_cmd *cmd)
 919 {}
 920 #endif
 921 int iwl_mvm_update_d0i3_power_mode(struct iwl_mvm *mvm,
 922                                    struct ieee80211_vif *vif,
 923                                    bool enable, u32 flags);
 924 int iwl_mvm_enable_beacon_filter(struct iwl_mvm *mvm,
 925                                  struct ieee80211_vif *vif,
 926                                  u32 flags);
 927 int iwl_mvm_disable_beacon_filter(struct iwl_mvm *mvm,
 928                                   struct ieee80211_vif *vif,
 929                                   u32 flags);
 930 int iwl_mvm_update_beacon_abort(struct iwl_mvm *mvm,
 931                                 struct ieee80211_vif *vif, bool enable);
 932 int iwl_mvm_update_beacon_filter(struct iwl_mvm *mvm,
 933                                  struct ieee80211_vif *vif,
 934                                  bool force,
 935                                  u32 flags);
 936
 937 /* SMPS */
 938 void iwl_mvm_update_smps(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
 939                                 enum iwl_mvm_smps_type_request req_type,
 940                                 enum ieee80211_smps_mode smps_request);
 941
 942 /* Low latency */
 943 int iwl_mvm_update_low_latency(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
 944                                bool value);
 945 /* get VMACLowLatencyMode */
 946 static inline bool iwl_mvm_vif_low_latency(struct iwl_mvm_vif *mvmvif)
 947 {
 948         /*
 949          * should this consider associated/active/... state?
 950          *
 951          * Normally low-latency should only be active on interfaces
 952          * that are active, but at least with debugfs it can also be
 953          * enabled on interfaces that aren't active. However, when
 954          * interface aren't active then they aren't added into the
 955          * binding, so this has no real impact. For now, just return
 956          * the current desired low-latency state.
 957          */
 958
 959         return mvmvif->low_latency;
 960 }
 961
 962 /* Thermal management and CT-kill */
 963 void iwl_mvm_tt_tx_backoff(struct iwl_mvm *mvm, u32 backoff);
 964 void iwl_mvm_tt_handler(struct iwl_mvm *mvm);
 965 void iwl_mvm_tt_initialize(struct iwl_mvm *mvm, u32 min_backoff);
 966 void iwl_mvm_tt_exit(struct iwl_mvm *mvm);
 967 void iwl_mvm_set_hw_ctkill_state(struct iwl_mvm *mvm, bool state);
 968
 969 /* smart fifo */
 970 int iwl_mvm_sf_update(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
 971                       bool added_vif);
 972
 973 #endif /* __IWL_MVM_H__ */