drivers/net/wireless/ath/ath10k/core.h

   1 /*
   2  * Copyright (c) 2005-2011 Atheros Communications Inc.
   3  * Copyright (c) 2011-2013 Qualcomm Atheros, Inc.
   4  *
   5  * Permission to use, copy, modify, and/or distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 #ifndef _CORE_H_
  19 #define _CORE_H_
  20
  21 #include <linux/completion.h>
  22 #include <linux/if_ether.h>
  23 #include <linux/types.h>
  24 #include <linux/pci.h>
  25 #include <linux/uuid.h>
  26 #include <linux/time.h>
  27
  28 #include "htt.h"
  29 #include "htc.h"
  30 #include "hw.h"
  31 #include "targaddrs.h"
  32 #include "wmi.h"
  33 #include "../ath.h"
  34 #include "../regd.h"
  35 #include "../dfs_pattern_detector.h"
  36 #include "spectral.h"
  37 #include "thermal.h"
  38 #include "wow.h"
  39 #include "swap.h"
  40
  41 #define MS(_v, _f) (((_v) & _f##_MASK) >> _f##_LSB)
  42 #define SM(_v, _f) (((_v) << _f##_LSB) & _f##_MASK)
  43 #define WO(_f)      ((_f##_OFFSET) >> 2)
  44
  45 #define ATH10K_SCAN_ID 0
  46 #define WMI_READY_TIMEOUT (5 * HZ)
  47 #define ATH10K_FLUSH_TIMEOUT_HZ (5*HZ)
  48 #define ATH10K_CONNECTION_LOSS_HZ (3*HZ)
  49 #define ATH10K_NUM_CHANS 39
  50
  51 /* Antenna noise floor */
  52 #define ATH10K_DEFAULT_NOISE_FLOOR -95
  53
  54 #define ATH10K_MAX_NUM_MGMT_PENDING 128
  55
  56 /* number of failed packets (20 packets with 16 sw reties each) */
  57 #define ATH10K_KICKOUT_THRESHOLD (20 * 16)
  58
  59 /*
  60  * Use insanely high numbers to make sure that the firmware implementation
  61  * won't start, we have the same functionality already in hostapd. Unit
  62  * is seconds.
  63  */
  64 #define ATH10K_KEEPALIVE_MIN_IDLE 3747
  65 #define ATH10K_KEEPALIVE_MAX_IDLE 3895
  66 #define ATH10K_KEEPALIVE_MAX_UNRESPONSIVE 3900
  67
  68 struct ath10k;
  69
  70 enum ath10k_bus {
  71         ATH10K_BUS_PCI,
  72 };
  73
  74 static inline const char *ath10k_bus_str(enum ath10k_bus bus)
  75 {
  76         switch (bus) {
  77         case ATH10K_BUS_PCI:
  78                 return "pci";
  79         }
  80
  81         return "unknown";
  82 }
  83
  84 enum ath10k_skb_flags {
  85         ATH10K_SKB_F_NO_HWCRYPT = BIT(0),
  86         ATH10K_SKB_F_DTIM_ZERO = BIT(1),
  87         ATH10K_SKB_F_DELIVER_CAB = BIT(2),
  88         ATH10K_SKB_F_MGMT = BIT(3),
  89         ATH10K_SKB_F_QOS = BIT(4),
  90 };
  91
  92 struct ath10k_skb_cb {
  93         dma_addr_t paddr;
  94         u8 flags;
  95         u8 eid;
  96         u16 msdu_id;
  97         struct ieee80211_vif *vif;
  98 } __packed;
  99
 100 struct ath10k_skb_rxcb {
 101         dma_addr_t paddr;
 102         struct hlist_node hlist;
 103 };
 104
 105 static inline struct ath10k_skb_cb *ATH10K_SKB_CB(struct sk_buff *skb)
 106 {
 107         BUILD_BUG_ON(sizeof(struct ath10k_skb_cb) >
 108                      IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
 109         return (struct ath10k_skb_cb *)&IEEE80211_SKB_CB(skb)->driver_data;
 110 }
 111
 112 static inline struct ath10k_skb_rxcb *ATH10K_SKB_RXCB(struct sk_buff *skb)
 113 {
 114         BUILD_BUG_ON(sizeof(struct ath10k_skb_rxcb) > sizeof(skb->cb));
 115         return (struct ath10k_skb_rxcb *)skb->cb;
 116 }
 117
 118 #define ATH10K_RXCB_SKB(rxcb) \
 119                 container_of((void *)rxcb, struct sk_buff, cb)
 120
 121 static inline u32 host_interest_item_address(u32 item_offset)
 122 {
 123         return QCA988X_HOST_INTEREST_ADDRESS + item_offset;
 124 }
 125
 126 struct ath10k_bmi {
 127         bool done_sent;
 128 };
 129
 130 struct ath10k_mem_chunk {
 131         void *vaddr;
 132         dma_addr_t paddr;
 133         u32 len;
 134         u32 req_id;
 135 };
 136
 137 struct ath10k_wmi {
 138         enum ath10k_fw_wmi_op_version op_version;
 139         enum ath10k_htc_ep_id eid;
 140         struct completion service_ready;
 141         struct completion unified_ready;
 142         wait_queue_head_t tx_credits_wq;
 143         DECLARE_BITMAP(svc_map, WMI_SERVICE_MAX);
 144         struct wmi_cmd_map *cmd;
 145         struct wmi_vdev_param_map *vdev_param;
 146         struct wmi_pdev_param_map *pdev_param;
 147         const struct wmi_ops *ops;
 148         const struct wmi_peer_flags_map *peer_flags;
 149
 150         u32 num_mem_chunks;
 151         u32 rx_decap_mode;
 152         struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS];
 153 };
 154
 155 struct ath10k_fw_stats_peer {
 156         struct list_head list;
 157
 158         u8 peer_macaddr[ETH_ALEN];
 159         u32 peer_rssi;
 160         u32 peer_tx_rate;
 161         u32 peer_rx_rate; /* 10x only */
 162         u32 rx_duration;
 163 };
 164
 165 struct ath10k_fw_stats_vdev {
 166         struct list_head list;
 167
 168         u32 vdev_id;
 169         u32 beacon_snr;
 170         u32 data_snr;
 171         u32 num_tx_frames[4];
 172         u32 num_rx_frames;
 173         u32 num_tx_frames_retries[4];
 174         u32 num_tx_frames_failures[4];
 175         u32 num_rts_fail;
 176         u32 num_rts_success;
 177         u32 num_rx_err;
 178         u32 num_rx_discard;
 179         u32 num_tx_not_acked;
 180         u32 tx_rate_history[10];
 181         u32 beacon_rssi_history[10];
 182 };
 183
 184 struct ath10k_fw_stats_pdev {
 185         struct list_head list;
 186
 187         /* PDEV stats */
 188         s32 ch_noise_floor;
 189         u32 tx_frame_count;
 190         u32 rx_frame_count;
 191         u32 rx_clear_count;
 192         u32 cycle_count;
 193         u32 phy_err_count;
 194         u32 chan_tx_power;
 195         u32 ack_rx_bad;
 196         u32 rts_bad;
 197         u32 rts_good;
 198         u32 fcs_bad;
 199         u32 no_beacons;
 200         u32 mib_int_count;
 201
 202         /* PDEV TX stats */
 203         s32 comp_queued;
 204         s32 comp_delivered;
 205         s32 msdu_enqued;
 206         s32 mpdu_enqued;
 207         s32 wmm_drop;
 208         s32 local_enqued;
 209         s32 local_freed;
 210         s32 hw_queued;
 211         s32 hw_reaped;
 212         s32 underrun;
 213         u32 hw_paused;
 214         s32 tx_abort;
 215         s32 mpdus_requed;
 216         u32 tx_ko;
 217         u32 data_rc;
 218         u32 self_triggers;
 219         u32 sw_retry_failure;
 220         u32 illgl_rate_phy_err;
 221         u32 pdev_cont_xretry;
 222         u32 pdev_tx_timeout;
 223         u32 pdev_resets;
 224         u32 phy_underrun;
 225         u32 txop_ovf;
 226         u32 seq_posted;
 227         u32 seq_failed_queueing;
 228         u32 seq_completed;
 229         u32 seq_restarted;
 230         u32 mu_seq_posted;
 231         u32 mpdus_sw_flush;
 232         u32 mpdus_hw_filter;
 233         u32 mpdus_truncated;
 234         u32 mpdus_ack_failed;
 235         u32 mpdus_expired;
 236
 237         /* PDEV RX stats */
 238         s32 mid_ppdu_route_change;
 239         s32 status_rcvd;
 240         s32 r0_frags;
 241         s32 r1_frags;
 242         s32 r2_frags;
 243         s32 r3_frags;
 244         s32 htt_msdus;
 245         s32 htt_mpdus;
 246         s32 loc_msdus;
 247         s32 loc_mpdus;
 248         s32 oversize_amsdu;
 249         s32 phy_errs;
 250         s32 phy_err_drop;
 251         s32 mpdu_errs;
 252         s32 rx_ovfl_errs;
 253 };
 254
 255 struct ath10k_fw_stats {
 256         struct list_head pdevs;
 257         struct list_head vdevs;
 258         struct list_head peers;
 259 };
 260
 261 #define ATH10K_TPC_TABLE_TYPE_FLAG      1
 262 #define ATH10K_TPC_PREAM_TABLE_END      0xFFFF
 263
 264 struct ath10k_tpc_table {
 265         u32 pream_idx[WMI_TPC_RATE_MAX];
 266         u8 rate_code[WMI_TPC_RATE_MAX];
 267         char tpc_value[WMI_TPC_RATE_MAX][WMI_TPC_TX_N_CHAIN * WMI_TPC_BUF_SIZE];
 268 };
 269
 270 struct ath10k_tpc_stats {
 271         u32 reg_domain;
 272         u32 chan_freq;
 273         u32 phy_mode;
 274         u32 twice_antenna_reduction;
 275         u32 twice_max_rd_power;
 276         s32 twice_antenna_gain;
 277         u32 power_limit;
 278         u32 num_tx_chain;
 279         u32 ctl;
 280         u32 rate_max;
 281         u8 flag[WMI_TPC_FLAG];
 282         struct ath10k_tpc_table tpc_table[WMI_TPC_FLAG];
 283 };
 284
 285 struct ath10k_dfs_stats {
 286         u32 phy_errors;
 287         u32 pulses_total;
 288         u32 pulses_detected;
 289         u32 pulses_discarded;
 290         u32 radar_detected;
 291 };
 292
 293 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
 294
 295 struct ath10k_peer {
 296         struct list_head list;
 297         int vdev_id;
 298         u8 addr[ETH_ALEN];
 299         DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS);
 300
 301         /* protected by ar->data_lock */
 302         struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
 303 };
 304
 305 struct ath10k_sta {
 306         struct ath10k_vif *arvif;
 307
 308         /* the following are protected by ar->data_lock */
 309         u32 changed; /* IEEE80211_RC_* */
 310         u32 bw;
 311         u32 nss;
 312         u32 smps;
 313
 314         struct work_struct update_wk;
 315
 316 #ifdef CONFIG_MAC80211_DEBUGFS
 317         /* protected by conf_mutex */
 318         bool aggr_mode;
 319         u64 rx_duration;
 320 #endif
 321 };
 322
 323 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5*HZ)
 324
 325 enum ath10k_beacon_state {
 326         ATH10K_BEACON_SCHEDULED = 0,
 327         ATH10K_BEACON_SENDING,
 328         ATH10K_BEACON_SENT,
 329 };
 330
 331 struct ath10k_vif {
 332         struct list_head list;
 333
 334         u32 vdev_id;
 335         enum wmi_vdev_type vdev_type;
 336         enum wmi_vdev_subtype vdev_subtype;
 337         u32 beacon_interval;
 338         u32 dtim_period;
 339         struct sk_buff *beacon;
 340         /* protected by data_lock */
 341         enum ath10k_beacon_state beacon_state;
 342         void *beacon_buf;
 343         dma_addr_t beacon_paddr;
 344         unsigned long tx_paused; /* arbitrary values defined by target */
 345
 346         struct ath10k *ar;
 347         struct ieee80211_vif *vif;
 348
 349         bool is_started;
 350         bool is_up;
 351         bool spectral_enabled;
 352         bool ps;
 353         u32 aid;
 354         u8 bssid[ETH_ALEN];
 355
 356         struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
 357         s8 def_wep_key_idx;
 358
 359         u16 tx_seq_no;
 360
 361         union {
 362                 struct {
 363                         u32 uapsd;
 364                 } sta;
 365                 struct {
 366                         /* 512 stations */
 367                         u8 tim_bitmap[64];
 368                         u8 tim_len;
 369                         u32 ssid_len;
 370                         u8 ssid[IEEE80211_MAX_SSID_LEN];
 371                         bool hidden_ssid;
 372                         /* P2P_IE with NoA attribute for P2P_GO case */
 373                         u32 noa_len;
 374                         u8 *noa_data;
 375                 } ap;
 376         } u;
 377
 378         bool use_cts_prot;
 379         bool nohwcrypt;
 380         int num_legacy_stations;
 381         int txpower;
 382         struct wmi_wmm_params_all_arg wmm_params;
 383         struct work_struct ap_csa_work;
 384         struct delayed_work connection_loss_work;
 385         struct cfg80211_bitrate_mask bitrate_mask;
 386 };
 387
 388 struct ath10k_vif_iter {
 389         u32 vdev_id;
 390         struct ath10k_vif *arvif;
 391 };
 392
 393 /* used for crash-dump storage, protected by data-lock */
 394 struct ath10k_fw_crash_data {
 395         bool crashed_since_read;
 396
 397         uuid_le uuid;
 398         struct timespec timestamp;
 399         __le32 registers[REG_DUMP_COUNT_QCA988X];
 400 };
 401
 402 struct ath10k_debug {
 403         struct dentry *debugfs_phy;
 404
 405         struct ath10k_fw_stats fw_stats;
 406         struct completion fw_stats_complete;
 407         bool fw_stats_done;
 408
 409         unsigned long htt_stats_mask;
 410         struct delayed_work htt_stats_dwork;
 411         struct ath10k_dfs_stats dfs_stats;
 412         struct ath_dfs_pool_stats dfs_pool_stats;
 413
 414         /* used for tpc-dump storage, protected by data-lock */
 415         struct ath10k_tpc_stats *tpc_stats;
 416
 417         struct completion tpc_complete;
 418
 419         /* protected by conf_mutex */
 420         u32 fw_dbglog_mask;
 421         u32 fw_dbglog_level;
 422         u32 pktlog_filter;
 423         u32 reg_addr;
 424         u32 nf_cal_period;
 425
 426         struct ath10k_fw_crash_data *fw_crash_data;
 427 };
 428
 429 enum ath10k_state {
 430         ATH10K_STATE_OFF = 0,
 431         ATH10K_STATE_ON,
 432
 433         /* When doing firmware recovery the device is first powered down.
 434          * mac80211 is supposed to call in to start() hook later on. It is
 435          * however possible that driver unloading and firmware crash overlap.
 436          * mac80211 can wait on conf_mutex in stop() while the device is
 437          * stopped in ath10k_core_restart() work holding conf_mutex. The state
 438          * RESTARTED means that the device is up and mac80211 has started hw
 439          * reconfiguration. Once mac80211 is done with the reconfiguration we
 440          * set the state to STATE_ON in reconfig_complete(). */
 441         ATH10K_STATE_RESTARTING,
 442         ATH10K_STATE_RESTARTED,
 443
 444         /* The device has crashed while restarting hw. This state is like ON
 445          * but commands are blocked in HTC and -ECOMM response is given. This
 446          * prevents completion timeouts and makes the driver more responsive to
 447          * userspace commands. This is also prevents recursive recovery. */
 448         ATH10K_STATE_WEDGED,
 449
 450         /* factory tests */
 451         ATH10K_STATE_UTF,
 452 };
 453
 454 enum ath10k_firmware_mode {
 455         /* the default mode, standard 802.11 functionality */
 456         ATH10K_FIRMWARE_MODE_NORMAL,
 457
 458         /* factory tests etc */
 459         ATH10K_FIRMWARE_MODE_UTF,
 460 };
 461
 462 enum ath10k_fw_features {
 463         /* wmi_mgmt_rx_hdr contains extra RSSI information */
 464         ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,
 465
 466         /* Firmware from 10X branch. Deprecated, don't use in new code. */
 467         ATH10K_FW_FEATURE_WMI_10X = 1,
 468
 469         /* firmware support tx frame management over WMI, otherwise it's HTT */
 470         ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,
 471
 472         /* Firmware does not support P2P */
 473         ATH10K_FW_FEATURE_NO_P2P = 3,
 474
 475         /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature
 476          * bit is required to be set as well. Deprecated, don't use in new
 477          * code.
 478          */
 479         ATH10K_FW_FEATURE_WMI_10_2 = 4,
 480
 481         /* Some firmware revisions lack proper multi-interface client powersave
 482          * implementation. Enabling PS could result in connection drops,
 483          * traffic stalls, etc.
 484          */
 485         ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT = 5,
 486
 487         /* Some firmware revisions have an incomplete WoWLAN implementation
 488          * despite WMI service bit being advertised. This feature flag is used
 489          * to distinguish whether WoWLAN is really supported or not.
 490          */
 491         ATH10K_FW_FEATURE_WOWLAN_SUPPORT = 6,
 492
 493         /* Don't trust error code from otp.bin */
 494         ATH10K_FW_FEATURE_IGNORE_OTP_RESULT = 7,
 495
 496         /* Some firmware revisions pad 4th hw address to 4 byte boundary making
 497          * it 8 bytes long in Native Wifi Rx decap.
 498          */
 499         ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING = 8,
 500
 501         /* Firmware supports bypassing PLL setting on init. */
 502         ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT = 9,
 503
 504         /* Raw mode support. If supported, FW supports receiving and trasmitting
 505          * frames in raw mode.
 506          */
 507         ATH10K_FW_FEATURE_RAW_MODE_SUPPORT = 10,
 508
 509         /* Firmware Supports Adaptive CCA*/
 510         ATH10K_FW_FEATURE_SUPPORTS_ADAPTIVE_CCA = 11,
 511
 512         /* Firmware supports management frame protection */
 513         ATH10K_FW_FEATURE_MFP_SUPPORT = 12,
 514
 515         /* keep last */
 516         ATH10K_FW_FEATURE_COUNT,
 517 };
 518
 519 enum ath10k_dev_flags {
 520         /* Indicates that ath10k device is during CAC phase of DFS */
 521         ATH10K_CAC_RUNNING,
 522         ATH10K_FLAG_CORE_REGISTERED,
 523
 524         /* Device has crashed and needs to restart. This indicates any pending
 525          * waiters should immediately cancel instead of waiting for a time out.
 526          */
 527         ATH10K_FLAG_CRASH_FLUSH,
 528
 529         /* Use Raw mode instead of native WiFi Tx/Rx encap mode.
 530          * Raw mode supports both hardware and software crypto. Native WiFi only
 531          * supports hardware crypto.
 532          */
 533         ATH10K_FLAG_RAW_MODE,
 534
 535         /* Disable HW crypto engine */
 536         ATH10K_FLAG_HW_CRYPTO_DISABLED,
 537
 538         /* Bluetooth coexistance enabled */
 539         ATH10K_FLAG_BTCOEX,
 540 };
 541
 542 enum ath10k_cal_mode {
 543         ATH10K_CAL_MODE_FILE,
 544         ATH10K_CAL_MODE_OTP,
 545         ATH10K_CAL_MODE_DT,
 546 };
 547
 548 enum ath10k_crypt_mode {
 549         /* Only use hardware crypto engine */
 550         ATH10K_CRYPT_MODE_HW,
 551         /* Only use software crypto engine */
 552         ATH10K_CRYPT_MODE_SW,
 553 };
 554
 555 static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode)
 556 {
 557         switch (mode) {
 558         case ATH10K_CAL_MODE_FILE:
 559                 return "file";
 560         case ATH10K_CAL_MODE_OTP:
 561                 return "otp";
 562         case ATH10K_CAL_MODE_DT:
 563                 return "dt";
 564         }
 565
 566         return "unknown";
 567 }
 568
 569 enum ath10k_scan_state {
 570         ATH10K_SCAN_IDLE,
 571         ATH10K_SCAN_STARTING,
 572         ATH10K_SCAN_RUNNING,
 573         ATH10K_SCAN_ABORTING,
 574 };
 575
 576 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
 577 {
 578         switch (state) {
 579         case ATH10K_SCAN_IDLE:
 580                 return "idle";
 581         case ATH10K_SCAN_STARTING:
 582                 return "starting";
 583         case ATH10K_SCAN_RUNNING:
 584                 return "running";
 585         case ATH10K_SCAN_ABORTING:
 586                 return "aborting";
 587         }
 588
 589         return "unknown";
 590 }
 591
 592 enum ath10k_tx_pause_reason {
 593         ATH10K_TX_PAUSE_Q_FULL,
 594         ATH10K_TX_PAUSE_MAX,
 595 };
 596
 597 struct ath10k {
 598         struct ath_common ath_common;
 599         struct ieee80211_hw *hw;
 600         struct device *dev;
 601         u8 mac_addr[ETH_ALEN];
 602
 603         enum ath10k_hw_rev hw_rev;
 604         u16 dev_id;
 605         u32 chip_id;
 606         u32 target_version;
 607         u8 fw_version_major;
 608         u32 fw_version_minor;
 609         u16 fw_version_release;
 610         u16 fw_version_build;
 611         u32 fw_stats_req_mask;
 612         u32 phy_capability;
 613         u32 hw_min_tx_power;
 614         u32 hw_max_tx_power;
 615         u32 ht_cap_info;
 616         u32 vht_cap_info;
 617         u32 num_rf_chains;
 618         u32 max_spatial_stream;
 619         /* protected by conf_mutex */
 620         bool ani_enabled;
 621
 622         DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
 623
 624         bool p2p;
 625
 626         struct {
 627                 enum ath10k_bus bus;
 628                 const struct ath10k_hif_ops *ops;
 629         } hif;
 630
 631         struct completion target_suspend;
 632
 633         const struct ath10k_hw_regs *regs;
 634         const struct ath10k_hw_values *hw_values;
 635         struct ath10k_bmi bmi;
 636         struct ath10k_wmi wmi;
 637         struct ath10k_htc htc;
 638         struct ath10k_htt htt;
 639
 640         struct ath10k_hw_params {
 641                 u32 id;
 642                 u16 dev_id;
 643                 const char *name;
 644                 u32 patch_load_addr;
 645                 int uart_pin;
 646                 u32 otp_exe_param;
 647
 648                 /* This is true if given HW chip has a quirky Cycle Counter
 649                  * wraparound which resets to 0x7fffffff instead of 0. All
 650                  * other CC related counters (e.g. Rx Clear Count) are divided
 651                  * by 2 so they never wraparound themselves.
 652                  */
 653                 bool has_shifted_cc_wraparound;
 654
 655                 /* Some of chip expects fragment descriptor to be continuous
 656                  * memory for any TX operation. Set continuous_frag_desc flag
 657                  * for the hardware which have such requirement.
 658                  */
 659                 bool continuous_frag_desc;
 660
 661                 u32 channel_counters_freq_hz;
 662
 663                 /* Mgmt tx descriptors threshold for limiting probe response
 664                  * frames.
 665                  */
 666                 u32 max_probe_resp_desc_thres;
 667
 668                 /* The padding bytes's location is different on various chips */
 669                 enum ath10k_hw_4addr_pad hw_4addr_pad;
 670
 671                 struct ath10k_hw_params_fw {
 672                         const char *dir;
 673                         const char *fw;
 674                         const char *otp;
 675                         const char *board;
 676                         size_t board_size;
 677                         size_t board_ext_size;
 678                 } fw;
 679         } hw_params;
 680
 681         const struct firmware *board;
 682         const void *board_data;
 683         size_t board_len;
 684
 685         const struct firmware *otp;
 686         const void *otp_data;
 687         size_t otp_len;
 688
 689         const struct firmware *firmware;
 690         const void *firmware_data;
 691         size_t firmware_len;
 692
 693         const struct firmware *cal_file;
 694
 695         struct {
 696                 const void *firmware_codeswap_data;
 697                 size_t firmware_codeswap_len;
 698                 struct ath10k_swap_code_seg_info *firmware_swap_code_seg_info;
 699         } swap;
 700
 701         struct {
 702                 u32 vendor;
 703                 u32 device;
 704                 u32 subsystem_vendor;
 705                 u32 subsystem_device;
 706
 707                 bool bmi_ids_valid;
 708                 u8 bmi_board_id;
 709                 u8 bmi_chip_id;
 710         } id;
 711
 712         int fw_api;
 713         int bd_api;
 714         enum ath10k_cal_mode cal_mode;
 715
 716         struct {
 717                 struct completion started;
 718                 struct completion completed;
 719                 struct completion on_channel;
 720                 struct delayed_work timeout;
 721                 enum ath10k_scan_state state;
 722                 bool is_roc;
 723                 int vdev_id;
 724                 int roc_freq;
 725                 bool roc_notify;
 726         } scan;
 727
 728         struct {
 729                 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
 730         } mac;
 731
 732         /* should never be NULL; needed for regular htt rx */
 733         struct ieee80211_channel *rx_channel;
 734
 735         /* valid during scan; needed for mgmt rx during scan */
 736         struct ieee80211_channel *scan_channel;
 737
 738         /* current operating channel definition */
 739         struct cfg80211_chan_def chandef;
 740
 741         unsigned long long free_vdev_map;
 742         struct ath10k_vif *monitor_arvif;
 743         bool monitor;
 744         int monitor_vdev_id;
 745         bool monitor_started;
 746         unsigned int filter_flags;
 747         unsigned long dev_flags;
 748         bool dfs_block_radar_events;
 749
 750         /* protected by conf_mutex */
 751         bool radar_enabled;
 752         int num_started_vdevs;
 753
 754         /* Protected by conf-mutex */
 755         u8 cfg_tx_chainmask;
 756         u8 cfg_rx_chainmask;
 757
 758         struct completion install_key_done;
 759
 760         struct completion vdev_setup_done;
 761
 762         struct workqueue_struct *workqueue;
 763         /* Auxiliary workqueue */
 764         struct workqueue_struct *workqueue_aux;
 765
 766         /* prevents concurrent FW reconfiguration */
 767         struct mutex conf_mutex;
 768
 769         /* protects shared structure data */
 770         spinlock_t data_lock;
 771
 772         struct list_head arvifs;
 773         struct list_head peers;
 774         wait_queue_head_t peer_mapping_wq;
 775
 776         /* protected by conf_mutex */
 777         int num_peers;
 778         int num_stations;
 779
 780         int max_num_peers;
 781         int max_num_stations;
 782         int max_num_vdevs;
 783         int max_num_tdls_vdevs;
 784         int num_active_peers;
 785         int num_tids;
 786
 787         struct work_struct svc_rdy_work;
 788         struct sk_buff *svc_rdy_skb;
 789
 790         struct work_struct offchan_tx_work;
 791         struct sk_buff_head offchan_tx_queue;
 792         struct completion offchan_tx_completed;
 793         struct sk_buff *offchan_tx_skb;
 794
 795         struct work_struct wmi_mgmt_tx_work;
 796         struct sk_buff_head wmi_mgmt_tx_queue;
 797
 798         enum ath10k_state state;
 799
 800         struct work_struct register_work;
 801         struct work_struct restart_work;
 802
 803         /* cycle count is reported twice for each visited channel during scan.
 804          * access protected by data_lock */
 805         u32 survey_last_rx_clear_count;
 806         u32 survey_last_cycle_count;
 807         struct survey_info survey[ATH10K_NUM_CHANS];
 808
 809         /* Channel info events are expected to come in pairs without and with
 810          * COMPLETE flag set respectively for each channel visit during scan.
 811          *
 812          * However there are deviations from this rule. This flag is used to
 813          * avoid reporting garbage data.
 814          */
 815         bool ch_info_can_report_survey;
 816
 817         struct dfs_pattern_detector *dfs_detector;
 818
 819         unsigned long tx_paused; /* see ATH10K_TX_PAUSE_ */
 820
 821 #ifdef CONFIG_ATH10K_DEBUGFS
 822         struct ath10k_debug debug;
 823 #endif
 824
 825         struct {
 826                 /* relay(fs) channel for spectral scan */
 827                 struct rchan *rfs_chan_spec_scan;
 828
 829                 /* spectral_mode and spec_config are protected by conf_mutex */
 830                 enum ath10k_spectral_mode mode;
 831                 struct ath10k_spec_scan config;
 832         } spectral;
 833
 834         struct {
 835                 /* protected by conf_mutex */
 836                 const struct firmware *utf;
 837                 char utf_version[32];
 838                 const void *utf_firmware_data;
 839                 size_t utf_firmware_len;
 840                 DECLARE_BITMAP(orig_fw_features, ATH10K_FW_FEATURE_COUNT);
 841                 enum ath10k_fw_wmi_op_version orig_wmi_op_version;
 842                 enum ath10k_fw_wmi_op_version op_version;
 843                 /* protected by data_lock */
 844                 bool utf_monitor;
 845         } testmode;
 846
 847         struct {
 848                 /* protected by data_lock */
 849                 u32 fw_crash_counter;
 850                 u32 fw_warm_reset_counter;
 851                 u32 fw_cold_reset_counter;
 852         } stats;
 853
 854         struct ath10k_thermal thermal;
 855         struct ath10k_wow wow;
 856
 857         /* must be last */
 858         u8 drv_priv[0] __aligned(sizeof(void *));
 859 };
 860
 861 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
 862                                   enum ath10k_bus bus,
 863                                   enum ath10k_hw_rev hw_rev,
 864                                   const struct ath10k_hif_ops *hif_ops);
 865 void ath10k_core_destroy(struct ath10k *ar);
 866 void ath10k_core_get_fw_features_str(struct ath10k *ar,
 867                                      char *buf,
 868                                      size_t max_len);
 869
 870 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode);
 871 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
 872 void ath10k_core_stop(struct ath10k *ar);
 873 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
 874 void ath10k_core_unregister(struct ath10k *ar);
 875
 876 #endif /* _CORE_H_ */