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 40
  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 /* NAPI poll budget */
  69 #define ATH10K_NAPI_BUDGET      64
  70 #define ATH10K_NAPI_QUOTA_LIMIT 60
  71
  72 /* SMBIOS type containing Board Data File Name Extension */
  73 #define ATH10K_SMBIOS_BDF_EXT_TYPE 0xF8
  74
  75 /* SMBIOS type structure length (excluding strings-set) */
  76 #define ATH10K_SMBIOS_BDF_EXT_LENGTH 0x9
  77
  78 /* Offset pointing to Board Data File Name Extension */
  79 #define ATH10K_SMBIOS_BDF_EXT_OFFSET 0x8
  80
  81 /* Board Data File Name Extension string length.
  82  * String format: BDF_<Customer ID>_<Extension>\0
  83  */
  84 #define ATH10K_SMBIOS_BDF_EXT_STR_LENGTH 0x20
  85
  86 /* The magic used by QCA spec */
  87 #define ATH10K_SMBIOS_BDF_EXT_MAGIC "BDF_"
  88
  89 struct ath10k;
  90
  91 enum ath10k_bus {
  92         ATH10K_BUS_PCI,
  93         ATH10K_BUS_AHB,
  94         ATH10K_BUS_SDIO,
  95         ATH10K_BUS_USB,
  96 };
  97
  98 static inline const char *ath10k_bus_str(enum ath10k_bus bus)
  99 {
 100         switch (bus) {
 101         case ATH10K_BUS_PCI:
 102                 return "pci";
 103         case ATH10K_BUS_AHB:
 104                 return "ahb";
 105         case ATH10K_BUS_SDIO:
 106                 return "sdio";
 107         case ATH10K_BUS_USB:
 108                 return "usb";
 109         }
 110
 111         return "unknown";
 112 }
 113
 114 enum ath10k_skb_flags {
 115         ATH10K_SKB_F_NO_HWCRYPT = BIT(0),
 116         ATH10K_SKB_F_DTIM_ZERO = BIT(1),
 117         ATH10K_SKB_F_DELIVER_CAB = BIT(2),
 118         ATH10K_SKB_F_MGMT = BIT(3),
 119         ATH10K_SKB_F_QOS = BIT(4),
 120 };
 121
 122 struct ath10k_skb_cb {
 123         dma_addr_t paddr;
 124         u8 flags;
 125         u8 eid;
 126         u16 msdu_id;
 127         struct ieee80211_vif *vif;
 128         struct ieee80211_txq *txq;
 129 } __packed;
 130
 131 struct ath10k_skb_rxcb {
 132         dma_addr_t paddr;
 133         struct hlist_node hlist;
 134 };
 135
 136 static inline struct ath10k_skb_cb *ATH10K_SKB_CB(struct sk_buff *skb)
 137 {
 138         BUILD_BUG_ON(sizeof(struct ath10k_skb_cb) >
 139                      IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
 140         return (struct ath10k_skb_cb *)&IEEE80211_SKB_CB(skb)->driver_data;
 141 }
 142
 143 static inline struct ath10k_skb_rxcb *ATH10K_SKB_RXCB(struct sk_buff *skb)
 144 {
 145         BUILD_BUG_ON(sizeof(struct ath10k_skb_rxcb) > sizeof(skb->cb));
 146         return (struct ath10k_skb_rxcb *)skb->cb;
 147 }
 148
 149 #define ATH10K_RXCB_SKB(rxcb) \
 150                 container_of((void *)rxcb, struct sk_buff, cb)
 151
 152 static inline u32 host_interest_item_address(u32 item_offset)
 153 {
 154         return QCA988X_HOST_INTEREST_ADDRESS + item_offset;
 155 }
 156
 157 struct ath10k_bmi {
 158         bool done_sent;
 159 };
 160
 161 struct ath10k_mem_chunk {
 162         void *vaddr;
 163         dma_addr_t paddr;
 164         u32 len;
 165         u32 req_id;
 166 };
 167
 168 struct ath10k_wmi {
 169         enum ath10k_htc_ep_id eid;
 170         struct completion service_ready;
 171         struct completion unified_ready;
 172         struct completion barrier;
 173         wait_queue_head_t tx_credits_wq;
 174         DECLARE_BITMAP(svc_map, WMI_SERVICE_MAX);
 175         struct wmi_cmd_map *cmd;
 176         struct wmi_vdev_param_map *vdev_param;
 177         struct wmi_pdev_param_map *pdev_param;
 178         const struct wmi_ops *ops;
 179         const struct wmi_peer_flags_map *peer_flags;
 180
 181         u32 num_mem_chunks;
 182         u32 rx_decap_mode;
 183         struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS];
 184 };
 185
 186 struct ath10k_fw_stats_peer {
 187         struct list_head list;
 188
 189         u8 peer_macaddr[ETH_ALEN];
 190         u32 peer_rssi;
 191         u32 peer_tx_rate;
 192         u32 peer_rx_rate; /* 10x only */
 193         u32 rx_duration;
 194 };
 195
 196 struct ath10k_fw_extd_stats_peer {
 197         struct list_head list;
 198
 199         u8 peer_macaddr[ETH_ALEN];
 200         u32 rx_duration;
 201 };
 202
 203 struct ath10k_fw_stats_vdev {
 204         struct list_head list;
 205
 206         u32 vdev_id;
 207         u32 beacon_snr;
 208         u32 data_snr;
 209         u32 num_tx_frames[4];
 210         u32 num_rx_frames;
 211         u32 num_tx_frames_retries[4];
 212         u32 num_tx_frames_failures[4];
 213         u32 num_rts_fail;
 214         u32 num_rts_success;
 215         u32 num_rx_err;
 216         u32 num_rx_discard;
 217         u32 num_tx_not_acked;
 218         u32 tx_rate_history[10];
 219         u32 beacon_rssi_history[10];
 220 };
 221
 222 struct ath10k_fw_stats_pdev {
 223         struct list_head list;
 224
 225         /* PDEV stats */
 226         s32 ch_noise_floor;
 227         u32 tx_frame_count; /* Cycles spent transmitting frames */
 228         u32 rx_frame_count; /* Cycles spent receiving frames */
 229         u32 rx_clear_count; /* Total channel busy time, evidently */
 230         u32 cycle_count; /* Total on-channel time */
 231         u32 phy_err_count;
 232         u32 chan_tx_power;
 233         u32 ack_rx_bad;
 234         u32 rts_bad;
 235         u32 rts_good;
 236         u32 fcs_bad;
 237         u32 no_beacons;
 238         u32 mib_int_count;
 239
 240         /* PDEV TX stats */
 241         s32 comp_queued;
 242         s32 comp_delivered;
 243         s32 msdu_enqued;
 244         s32 mpdu_enqued;
 245         s32 wmm_drop;
 246         s32 local_enqued;
 247         s32 local_freed;
 248         s32 hw_queued;
 249         s32 hw_reaped;
 250         s32 underrun;
 251         u32 hw_paused;
 252         s32 tx_abort;
 253         s32 mpdus_requed;
 254         u32 tx_ko;
 255         u32 data_rc;
 256         u32 self_triggers;
 257         u32 sw_retry_failure;
 258         u32 illgl_rate_phy_err;
 259         u32 pdev_cont_xretry;
 260         u32 pdev_tx_timeout;
 261         u32 pdev_resets;
 262         u32 phy_underrun;
 263         u32 txop_ovf;
 264         u32 seq_posted;
 265         u32 seq_failed_queueing;
 266         u32 seq_completed;
 267         u32 seq_restarted;
 268         u32 mu_seq_posted;
 269         u32 mpdus_sw_flush;
 270         u32 mpdus_hw_filter;
 271         u32 mpdus_truncated;
 272         u32 mpdus_ack_failed;
 273         u32 mpdus_expired;
 274
 275         /* PDEV RX stats */
 276         s32 mid_ppdu_route_change;
 277         s32 status_rcvd;
 278         s32 r0_frags;
 279         s32 r1_frags;
 280         s32 r2_frags;
 281         s32 r3_frags;
 282         s32 htt_msdus;
 283         s32 htt_mpdus;
 284         s32 loc_msdus;
 285         s32 loc_mpdus;
 286         s32 oversize_amsdu;
 287         s32 phy_errs;
 288         s32 phy_err_drop;
 289         s32 mpdu_errs;
 290         s32 rx_ovfl_errs;
 291 };
 292
 293 struct ath10k_fw_stats {
 294         bool extended;
 295         struct list_head pdevs;
 296         struct list_head vdevs;
 297         struct list_head peers;
 298         struct list_head peers_extd;
 299 };
 300
 301 #define ATH10K_TPC_TABLE_TYPE_FLAG      1
 302 #define ATH10K_TPC_PREAM_TABLE_END      0xFFFF
 303
 304 struct ath10k_tpc_table {
 305         u32 pream_idx[WMI_TPC_RATE_MAX];
 306         u8 rate_code[WMI_TPC_RATE_MAX];
 307         char tpc_value[WMI_TPC_RATE_MAX][WMI_TPC_TX_N_CHAIN * WMI_TPC_BUF_SIZE];
 308 };
 309
 310 struct ath10k_tpc_stats {
 311         u32 reg_domain;
 312         u32 chan_freq;
 313         u32 phy_mode;
 314         u32 twice_antenna_reduction;
 315         u32 twice_max_rd_power;
 316         s32 twice_antenna_gain;
 317         u32 power_limit;
 318         u32 num_tx_chain;
 319         u32 ctl;
 320         u32 rate_max;
 321         u8 flag[WMI_TPC_FLAG];
 322         struct ath10k_tpc_table tpc_table[WMI_TPC_FLAG];
 323 };
 324
 325 struct ath10k_dfs_stats {
 326         u32 phy_errors;
 327         u32 pulses_total;
 328         u32 pulses_detected;
 329         u32 pulses_discarded;
 330         u32 radar_detected;
 331 };
 332
 333 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
 334
 335 struct ath10k_peer {
 336         struct list_head list;
 337         struct ieee80211_vif *vif;
 338         struct ieee80211_sta *sta;
 339
 340         bool removed;
 341         int vdev_id;
 342         u8 addr[ETH_ALEN];
 343         DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS);
 344
 345         /* protected by ar->data_lock */
 346         struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
 347 };
 348
 349 struct ath10k_txq {
 350         struct list_head list;
 351         unsigned long num_fw_queued;
 352         unsigned long num_push_allowed;
 353 };
 354
 355 struct ath10k_sta {
 356         struct ath10k_vif *arvif;
 357
 358         /* the following are protected by ar->data_lock */
 359         u32 changed; /* IEEE80211_RC_* */
 360         u32 bw;
 361         u32 nss;
 362         u32 smps;
 363         u16 peer_id;
 364         struct rate_info txrate;
 365
 366         struct work_struct update_wk;
 367
 368 #ifdef CONFIG_MAC80211_DEBUGFS
 369         /* protected by conf_mutex */
 370         bool aggr_mode;
 371         u64 rx_duration;
 372 #endif
 373 };
 374
 375 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5 * HZ)
 376
 377 enum ath10k_beacon_state {
 378         ATH10K_BEACON_SCHEDULED = 0,
 379         ATH10K_BEACON_SENDING,
 380         ATH10K_BEACON_SENT,
 381 };
 382
 383 struct ath10k_vif {
 384         struct list_head list;
 385
 386         u32 vdev_id;
 387         u16 peer_id;
 388         enum wmi_vdev_type vdev_type;
 389         enum wmi_vdev_subtype vdev_subtype;
 390         u32 beacon_interval;
 391         u32 dtim_period;
 392         struct sk_buff *beacon;
 393         /* protected by data_lock */
 394         enum ath10k_beacon_state beacon_state;
 395         void *beacon_buf;
 396         dma_addr_t beacon_paddr;
 397         unsigned long tx_paused; /* arbitrary values defined by target */
 398
 399         struct ath10k *ar;
 400         struct ieee80211_vif *vif;
 401
 402         bool is_started;
 403         bool is_up;
 404         bool spectral_enabled;
 405         bool ps;
 406         u32 aid;
 407         u8 bssid[ETH_ALEN];
 408
 409         struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
 410         s8 def_wep_key_idx;
 411
 412         u16 tx_seq_no;
 413
 414         union {
 415                 struct {
 416                         u32 uapsd;
 417                 } sta;
 418                 struct {
 419                         /* 512 stations */
 420                         u8 tim_bitmap[64];
 421                         u8 tim_len;
 422                         u32 ssid_len;
 423                         u8 ssid[IEEE80211_MAX_SSID_LEN];
 424                         bool hidden_ssid;
 425                         /* P2P_IE with NoA attribute for P2P_GO case */
 426                         u32 noa_len;
 427                         u8 *noa_data;
 428                 } ap;
 429         } u;
 430
 431         bool use_cts_prot;
 432         bool nohwcrypt;
 433         int num_legacy_stations;
 434         int txpower;
 435         struct wmi_wmm_params_all_arg wmm_params;
 436         struct work_struct ap_csa_work;
 437         struct delayed_work connection_loss_work;
 438         struct cfg80211_bitrate_mask bitrate_mask;
 439 };
 440
 441 struct ath10k_vif_iter {
 442         u32 vdev_id;
 443         struct ath10k_vif *arvif;
 444 };
 445
 446 /* Copy Engine register dump, protected by ce-lock */
 447 struct ath10k_ce_crash_data {
 448         __le32 base_addr;
 449         __le32 src_wr_idx;
 450         __le32 src_r_idx;
 451         __le32 dst_wr_idx;
 452         __le32 dst_r_idx;
 453 };
 454
 455 struct ath10k_ce_crash_hdr {
 456         __le32 ce_count;
 457         __le32 reserved[3]; /* for future use */
 458         struct ath10k_ce_crash_data entries[];
 459 };
 460
 461 /* used for crash-dump storage, protected by data-lock */
 462 struct ath10k_fw_crash_data {
 463         bool crashed_since_read;
 464
 465         guid_t guid;
 466         struct timespec timestamp;
 467         __le32 registers[REG_DUMP_COUNT_QCA988X];
 468         struct ath10k_ce_crash_data ce_crash_data[CE_COUNT_MAX];
 469 };
 470
 471 struct ath10k_debug {
 472         struct dentry *debugfs_phy;
 473
 474         struct ath10k_fw_stats fw_stats;
 475         struct completion fw_stats_complete;
 476         bool fw_stats_done;
 477
 478         unsigned long htt_stats_mask;
 479         struct delayed_work htt_stats_dwork;
 480         struct ath10k_dfs_stats dfs_stats;
 481         struct ath_dfs_pool_stats dfs_pool_stats;
 482
 483         /* used for tpc-dump storage, protected by data-lock */
 484         struct ath10k_tpc_stats *tpc_stats;
 485
 486         struct completion tpc_complete;
 487
 488         /* protected by conf_mutex */
 489         u64 fw_dbglog_mask;
 490         u32 fw_dbglog_level;
 491         u32 pktlog_filter;
 492         u32 reg_addr;
 493         u32 nf_cal_period;
 494         void *cal_data;
 495
 496         struct ath10k_fw_crash_data *fw_crash_data;
 497 };
 498
 499 enum ath10k_state {
 500         ATH10K_STATE_OFF = 0,
 501         ATH10K_STATE_ON,
 502
 503         /* When doing firmware recovery the device is first powered down.
 504          * mac80211 is supposed to call in to start() hook later on. It is
 505          * however possible that driver unloading and firmware crash overlap.
 506          * mac80211 can wait on conf_mutex in stop() while the device is
 507          * stopped in ath10k_core_restart() work holding conf_mutex. The state
 508          * RESTARTED means that the device is up and mac80211 has started hw
 509          * reconfiguration. Once mac80211 is done with the reconfiguration we
 510          * set the state to STATE_ON in reconfig_complete().
 511          */
 512         ATH10K_STATE_RESTARTING,
 513         ATH10K_STATE_RESTARTED,
 514
 515         /* The device has crashed while restarting hw. This state is like ON
 516          * but commands are blocked in HTC and -ECOMM response is given. This
 517          * prevents completion timeouts and makes the driver more responsive to
 518          * userspace commands. This is also prevents recursive recovery.
 519          */
 520         ATH10K_STATE_WEDGED,
 521
 522         /* factory tests */
 523         ATH10K_STATE_UTF,
 524 };
 525
 526 enum ath10k_firmware_mode {
 527         /* the default mode, standard 802.11 functionality */
 528         ATH10K_FIRMWARE_MODE_NORMAL,
 529
 530         /* factory tests etc */
 531         ATH10K_FIRMWARE_MODE_UTF,
 532 };
 533
 534 enum ath10k_fw_features {
 535         /* wmi_mgmt_rx_hdr contains extra RSSI information */
 536         ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,
 537
 538         /* Firmware from 10X branch. Deprecated, don't use in new code. */
 539         ATH10K_FW_FEATURE_WMI_10X = 1,
 540
 541         /* firmware support tx frame management over WMI, otherwise it's HTT */
 542         ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,
 543
 544         /* Firmware does not support P2P */
 545         ATH10K_FW_FEATURE_NO_P2P = 3,
 546
 547         /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature
 548          * bit is required to be set as well. Deprecated, don't use in new
 549          * code.
 550          */
 551         ATH10K_FW_FEATURE_WMI_10_2 = 4,
 552
 553         /* Some firmware revisions lack proper multi-interface client powersave
 554          * implementation. Enabling PS could result in connection drops,
 555          * traffic stalls, etc.
 556          */
 557         ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT = 5,
 558
 559         /* Some firmware revisions have an incomplete WoWLAN implementation
 560          * despite WMI service bit being advertised. This feature flag is used
 561          * to distinguish whether WoWLAN is really supported or not.
 562          */
 563         ATH10K_FW_FEATURE_WOWLAN_SUPPORT = 6,
 564
 565         /* Don't trust error code from otp.bin */
 566         ATH10K_FW_FEATURE_IGNORE_OTP_RESULT = 7,
 567
 568         /* Some firmware revisions pad 4th hw address to 4 byte boundary making
 569          * it 8 bytes long in Native Wifi Rx decap.
 570          */
 571         ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING = 8,
 572
 573         /* Firmware supports bypassing PLL setting on init. */
 574         ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT = 9,
 575
 576         /* Raw mode support. If supported, FW supports receiving and trasmitting
 577          * frames in raw mode.
 578          */
 579         ATH10K_FW_FEATURE_RAW_MODE_SUPPORT = 10,
 580
 581         /* Firmware Supports Adaptive CCA*/
 582         ATH10K_FW_FEATURE_SUPPORTS_ADAPTIVE_CCA = 11,
 583
 584         /* Firmware supports management frame protection */
 585         ATH10K_FW_FEATURE_MFP_SUPPORT = 12,
 586
 587         /* Firmware supports pull-push model where host shares it's software
 588          * queue state with firmware and firmware generates fetch requests
 589          * telling host which queues to dequeue tx from.
 590          *
 591          * Primary function of this is improved MU-MIMO performance with
 592          * multiple clients.
 593          */
 594         ATH10K_FW_FEATURE_PEER_FLOW_CONTROL = 13,
 595
 596         /* Firmware supports BT-Coex without reloading firmware via pdev param.
 597          * To support Bluetooth coexistence pdev param, WMI_COEX_GPIO_SUPPORT of
 598          * extended resource config should be enabled always. This firmware IE
 599          * is used to configure WMI_COEX_GPIO_SUPPORT.
 600          */
 601         ATH10K_FW_FEATURE_BTCOEX_PARAM = 14,
 602
 603         /* Unused flag and proven to be not working, enable this if you want
 604          * to experiment sending NULL func data frames in HTT TX
 605          */
 606         ATH10K_FW_FEATURE_SKIP_NULL_FUNC_WAR = 15,
 607
 608         /* Firmware allow other BSS mesh broadcast/multicast frames without
 609          * creating monitor interface. Appropriate rxfilters are programmed for
 610          * mesh vdev by firmware itself. This feature flags will be used for
 611          * not creating monitor vdev while configuring mesh node.
 612          */
 613         ATH10K_FW_FEATURE_ALLOWS_MESH_BCAST = 16,
 614
 615         /* keep last */
 616         ATH10K_FW_FEATURE_COUNT,
 617 };
 618
 619 enum ath10k_dev_flags {
 620         /* Indicates that ath10k device is during CAC phase of DFS */
 621         ATH10K_CAC_RUNNING,
 622         ATH10K_FLAG_CORE_REGISTERED,
 623
 624         /* Device has crashed and needs to restart. This indicates any pending
 625          * waiters should immediately cancel instead of waiting for a time out.
 626          */
 627         ATH10K_FLAG_CRASH_FLUSH,
 628
 629         /* Use Raw mode instead of native WiFi Tx/Rx encap mode.
 630          * Raw mode supports both hardware and software crypto. Native WiFi only
 631          * supports hardware crypto.
 632          */
 633         ATH10K_FLAG_RAW_MODE,
 634
 635         /* Disable HW crypto engine */
 636         ATH10K_FLAG_HW_CRYPTO_DISABLED,
 637
 638         /* Bluetooth coexistance enabled */
 639         ATH10K_FLAG_BTCOEX,
 640
 641         /* Per Station statistics service */
 642         ATH10K_FLAG_PEER_STATS,
 643 };
 644
 645 enum ath10k_cal_mode {
 646         ATH10K_CAL_MODE_FILE,
 647         ATH10K_CAL_MODE_OTP,
 648         ATH10K_CAL_MODE_DT,
 649         ATH10K_PRE_CAL_MODE_FILE,
 650         ATH10K_PRE_CAL_MODE_DT,
 651         ATH10K_CAL_MODE_EEPROM,
 652 };
 653
 654 enum ath10k_crypt_mode {
 655         /* Only use hardware crypto engine */
 656         ATH10K_CRYPT_MODE_HW,
 657         /* Only use software crypto engine */
 658         ATH10K_CRYPT_MODE_SW,
 659 };
 660
 661 static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode)
 662 {
 663         switch (mode) {
 664         case ATH10K_CAL_MODE_FILE:
 665                 return "file";
 666         case ATH10K_CAL_MODE_OTP:
 667                 return "otp";
 668         case ATH10K_CAL_MODE_DT:
 669                 return "dt";
 670         case ATH10K_PRE_CAL_MODE_FILE:
 671                 return "pre-cal-file";
 672         case ATH10K_PRE_CAL_MODE_DT:
 673                 return "pre-cal-dt";
 674         case ATH10K_CAL_MODE_EEPROM:
 675                 return "eeprom";
 676         }
 677
 678         return "unknown";
 679 }
 680
 681 enum ath10k_scan_state {
 682         ATH10K_SCAN_IDLE,
 683         ATH10K_SCAN_STARTING,
 684         ATH10K_SCAN_RUNNING,
 685         ATH10K_SCAN_ABORTING,
 686 };
 687
 688 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
 689 {
 690         switch (state) {
 691         case ATH10K_SCAN_IDLE:
 692                 return "idle";
 693         case ATH10K_SCAN_STARTING:
 694                 return "starting";
 695         case ATH10K_SCAN_RUNNING:
 696                 return "running";
 697         case ATH10K_SCAN_ABORTING:
 698                 return "aborting";
 699         }
 700
 701         return "unknown";
 702 }
 703
 704 enum ath10k_tx_pause_reason {
 705         ATH10K_TX_PAUSE_Q_FULL,
 706         ATH10K_TX_PAUSE_MAX,
 707 };
 708
 709 struct ath10k_fw_file {
 710         const struct firmware *firmware;
 711
 712         char fw_version[ETHTOOL_FWVERS_LEN];
 713
 714         DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
 715
 716         enum ath10k_fw_wmi_op_version wmi_op_version;
 717         enum ath10k_fw_htt_op_version htt_op_version;
 718
 719         const void *firmware_data;
 720         size_t firmware_len;
 721
 722         const void *otp_data;
 723         size_t otp_len;
 724
 725         const void *codeswap_data;
 726         size_t codeswap_len;
 727
 728         /* The original idea of struct ath10k_fw_file was that it only
 729          * contains struct firmware and pointers to various parts (actual
 730          * firmware binary, otp, metadata etc) of the file. This seg_info
 731          * is actually created separate but as this is used similarly as
 732          * the other firmware components it's more convenient to have it
 733          * here.
 734          */
 735         struct ath10k_swap_code_seg_info *firmware_swap_code_seg_info;
 736 };
 737
 738 struct ath10k_fw_components {
 739         const struct firmware *board;
 740         const void *board_data;
 741         size_t board_len;
 742
 743         struct ath10k_fw_file fw_file;
 744 };
 745
 746 struct ath10k_per_peer_tx_stats {
 747         u32     succ_bytes;
 748         u32     retry_bytes;
 749         u32     failed_bytes;
 750         u8      ratecode;
 751         u8      flags;
 752         u16     peer_id;
 753         u16     succ_pkts;
 754         u16     retry_pkts;
 755         u16     failed_pkts;
 756         u16     duration;
 757         u32     reserved1;
 758         u32     reserved2;
 759 };
 760
 761 struct ath10k {
 762         struct ath_common ath_common;
 763         struct ieee80211_hw *hw;
 764         struct ieee80211_ops *ops;
 765         struct device *dev;
 766         u8 mac_addr[ETH_ALEN];
 767
 768         enum ath10k_hw_rev hw_rev;
 769         u16 dev_id;
 770         u32 chip_id;
 771         u32 target_version;
 772         u8 fw_version_major;
 773         u32 fw_version_minor;
 774         u16 fw_version_release;
 775         u16 fw_version_build;
 776         u32 fw_stats_req_mask;
 777         u32 phy_capability;
 778         u32 hw_min_tx_power;
 779         u32 hw_max_tx_power;
 780         u32 hw_eeprom_rd;
 781         u32 ht_cap_info;
 782         u32 vht_cap_info;
 783         u32 num_rf_chains;
 784         u32 max_spatial_stream;
 785         /* protected by conf_mutex */
 786         u32 low_5ghz_chan;
 787         u32 high_5ghz_chan;
 788         bool ani_enabled;
 789
 790         bool p2p;
 791
 792         struct {
 793                 enum ath10k_bus bus;
 794                 const struct ath10k_hif_ops *ops;
 795         } hif;
 796
 797         struct completion target_suspend;
 798
 799         const struct ath10k_hw_regs *regs;
 800         const struct ath10k_hw_ce_regs *hw_ce_regs;
 801         const struct ath10k_hw_values *hw_values;
 802         struct ath10k_bmi bmi;
 803         struct ath10k_wmi wmi;
 804         struct ath10k_htc htc;
 805         struct ath10k_htt htt;
 806
 807         struct ath10k_hw_params hw_params;
 808
 809         /* contains the firmware images used with ATH10K_FIRMWARE_MODE_NORMAL */
 810         struct ath10k_fw_components normal_mode_fw;
 811
 812         /* READ-ONLY images of the running firmware, which can be either
 813          * normal or UTF. Do not modify, release etc!
 814          */
 815         const struct ath10k_fw_components *running_fw;
 816
 817         const struct firmware *pre_cal_file;
 818         const struct firmware *cal_file;
 819
 820         struct {
 821                 u32 vendor;
 822                 u32 device;
 823                 u32 subsystem_vendor;
 824                 u32 subsystem_device;
 825
 826                 bool bmi_ids_valid;
 827                 u8 bmi_board_id;
 828                 u8 bmi_chip_id;
 829
 830                 char bdf_ext[ATH10K_SMBIOS_BDF_EXT_STR_LENGTH];
 831         } id;
 832
 833         int fw_api;
 834         int bd_api;
 835         enum ath10k_cal_mode cal_mode;
 836
 837         struct {
 838                 struct completion started;
 839                 struct completion completed;
 840                 struct completion on_channel;
 841                 struct delayed_work timeout;
 842                 enum ath10k_scan_state state;
 843                 bool is_roc;
 844                 int vdev_id;
 845                 int roc_freq;
 846                 bool roc_notify;
 847         } scan;
 848
 849         struct {
 850                 struct ieee80211_supported_band sbands[NUM_NL80211_BANDS];
 851         } mac;
 852
 853         /* should never be NULL; needed for regular htt rx */
 854         struct ieee80211_channel *rx_channel;
 855
 856         /* valid during scan; needed for mgmt rx during scan */
 857         struct ieee80211_channel *scan_channel;
 858
 859         /* current operating channel definition */
 860         struct cfg80211_chan_def chandef;
 861
 862         /* currently configured operating channel in firmware */
 863         struct ieee80211_channel *tgt_oper_chan;
 864
 865         unsigned long long free_vdev_map;
 866         struct ath10k_vif *monitor_arvif;
 867         bool monitor;
 868         int monitor_vdev_id;
 869         bool monitor_started;
 870         unsigned int filter_flags;
 871         unsigned long dev_flags;
 872         bool dfs_block_radar_events;
 873
 874         /* protected by conf_mutex */
 875         bool radar_enabled;
 876         int num_started_vdevs;
 877
 878         /* Protected by conf-mutex */
 879         u8 cfg_tx_chainmask;
 880         u8 cfg_rx_chainmask;
 881
 882         struct completion install_key_done;
 883
 884         int last_wmi_vdev_start_status;
 885         struct completion vdev_setup_done;
 886
 887         struct workqueue_struct *workqueue;
 888         /* Auxiliary workqueue */
 889         struct workqueue_struct *workqueue_aux;
 890
 891         /* prevents concurrent FW reconfiguration */
 892         struct mutex conf_mutex;
 893
 894         /* protects shared structure data */
 895         spinlock_t data_lock;
 896         /* protects: ar->txqs, artxq->list */
 897         spinlock_t txqs_lock;
 898
 899         struct list_head txqs;
 900         struct list_head arvifs;
 901         struct list_head peers;
 902         struct ath10k_peer *peer_map[ATH10K_MAX_NUM_PEER_IDS];
 903         wait_queue_head_t peer_mapping_wq;
 904
 905         /* protected by conf_mutex */
 906         int num_peers;
 907         int num_stations;
 908
 909         int max_num_peers;
 910         int max_num_stations;
 911         int max_num_vdevs;
 912         int max_num_tdls_vdevs;
 913         int num_active_peers;
 914         int num_tids;
 915
 916         struct work_struct svc_rdy_work;
 917         struct sk_buff *svc_rdy_skb;
 918
 919         struct work_struct offchan_tx_work;
 920         struct sk_buff_head offchan_tx_queue;
 921         struct completion offchan_tx_completed;
 922         struct sk_buff *offchan_tx_skb;
 923
 924         struct work_struct wmi_mgmt_tx_work;
 925         struct sk_buff_head wmi_mgmt_tx_queue;
 926
 927         enum ath10k_state state;
 928
 929         struct work_struct register_work;
 930         struct work_struct restart_work;
 931
 932         /* cycle count is reported twice for each visited channel during scan.
 933          * access protected by data_lock
 934          */
 935         u32 survey_last_rx_clear_count;
 936         u32 survey_last_cycle_count;
 937         struct survey_info survey[ATH10K_NUM_CHANS];
 938
 939         /* Channel info events are expected to come in pairs without and with
 940          * COMPLETE flag set respectively for each channel visit during scan.
 941          *
 942          * However there are deviations from this rule. This flag is used to
 943          * avoid reporting garbage data.
 944          */
 945         bool ch_info_can_report_survey;
 946         struct completion bss_survey_done;
 947
 948         struct dfs_pattern_detector *dfs_detector;
 949
 950         unsigned long tx_paused; /* see ATH10K_TX_PAUSE_ */
 951
 952 #ifdef CONFIG_ATH10K_DEBUGFS
 953         struct ath10k_debug debug;
 954         struct {
 955                 /* relay(fs) channel for spectral scan */
 956                 struct rchan *rfs_chan_spec_scan;
 957
 958                 /* spectral_mode and spec_config are protected by conf_mutex */
 959                 enum ath10k_spectral_mode mode;
 960                 struct ath10k_spec_scan config;
 961         } spectral;
 962 #endif
 963
 964         struct {
 965                 /* protected by conf_mutex */
 966                 struct ath10k_fw_components utf_mode_fw;
 967
 968                 /* protected by data_lock */
 969                 bool utf_monitor;
 970         } testmode;
 971
 972         struct {
 973                 /* protected by data_lock */
 974                 u32 fw_crash_counter;
 975                 u32 fw_warm_reset_counter;
 976                 u32 fw_cold_reset_counter;
 977         } stats;
 978
 979         struct ath10k_thermal thermal;
 980         struct ath10k_wow wow;
 981         struct ath10k_per_peer_tx_stats peer_tx_stats;
 982
 983         /* NAPI */
 984         struct net_device napi_dev;
 985         struct napi_struct napi;
 986
 987         struct work_struct set_coverage_class_work;
 988         /* protected by conf_mutex */
 989         struct {
 990                 /* writing also protected by data_lock */
 991                 s16 coverage_class;
 992
 993                 u32 reg_phyclk;
 994                 u32 reg_slottime_conf;
 995                 u32 reg_slottime_orig;
 996                 u32 reg_ack_cts_timeout_conf;
 997                 u32 reg_ack_cts_timeout_orig;
 998         } fw_coverage;
 999
1000         u32 ampdu_reference;
1001
1002         void *ce_priv;
1003
1004         /* must be last */
1005         u8 drv_priv[0] __aligned(sizeof(void *));
1006 };
1007
1008 static inline bool ath10k_peer_stats_enabled(struct ath10k *ar)
1009 {
1010         if (test_bit(ATH10K_FLAG_PEER_STATS, &ar->dev_flags) &&
1011             test_bit(WMI_SERVICE_PEER_STATS, ar->wmi.svc_map))
1012                 return true;
1013
1014         return false;
1015 }
1016
1017 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
1018                                   enum ath10k_bus bus,
1019                                   enum ath10k_hw_rev hw_rev,
1020                                   const struct ath10k_hif_ops *hif_ops);
1021 void ath10k_core_destroy(struct ath10k *ar);
1022 void ath10k_core_get_fw_features_str(struct ath10k *ar,
1023                                      char *buf,
1024                                      size_t max_len);
1025 int ath10k_core_fetch_firmware_api_n(struct ath10k *ar, const char *name,
1026                                      struct ath10k_fw_file *fw_file);
1027
1028 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode,
1029                       const struct ath10k_fw_components *fw_components);
1030 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
1031 void ath10k_core_stop(struct ath10k *ar);
1032 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
1033 void ath10k_core_unregister(struct ath10k *ar);
1034
1035 #endif /* _CORE_H_ */