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