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
  38 #define MS(_v, _f) (((_v) & _f##_MASK) >> _f##_LSB)
  39 #define SM(_v, _f) (((_v) << _f##_LSB) & _f##_MASK)
  40 #define WO(_f)      ((_f##_OFFSET) >> 2)
  41
  42 #define ATH10K_SCAN_ID 0
  43 #define WMI_READY_TIMEOUT (5 * HZ)
  44 #define ATH10K_FLUSH_TIMEOUT_HZ (5*HZ)
  45 #define ATH10K_NUM_CHANS 38
  46
  47 /* Antenna noise floor */
  48 #define ATH10K_DEFAULT_NOISE_FLOOR -95
  49
  50 #define ATH10K_MAX_NUM_MGMT_PENDING 128
  51
  52 /* number of failed packets */
  53 #define ATH10K_KICKOUT_THRESHOLD 50
  54
  55 /*
  56  * Use insanely high numbers to make sure that the firmware implementation
  57  * won't start, we have the same functionality already in hostapd. Unit
  58  * is seconds.
  59  */
  60 #define ATH10K_KEEPALIVE_MIN_IDLE 3747
  61 #define ATH10K_KEEPALIVE_MAX_IDLE 3895
  62 #define ATH10K_KEEPALIVE_MAX_UNRESPONSIVE 3900
  63
  64 struct ath10k;
  65
  66 enum ath10k_bus {
  67         ATH10K_BUS_PCI,
  68 };
  69
  70 static inline const char *ath10k_bus_str(enum ath10k_bus bus)
  71 {
  72         switch (bus) {
  73         case ATH10K_BUS_PCI:
  74                 return "pci";
  75         }
  76
  77         return "unknown";
  78 }
  79
  80 struct ath10k_skb_cb {
  81         dma_addr_t paddr;
  82         u8 vdev_id;
  83
  84         struct {
  85                 u8 tid;
  86                 bool is_offchan;
  87                 struct ath10k_htt_txbuf *txbuf;
  88                 u32 txbuf_paddr;
  89         } __packed htt;
  90
  91         struct {
  92                 bool dtim_zero;
  93                 bool deliver_cab;
  94         } bcn;
  95 } __packed;
  96
  97 static inline struct ath10k_skb_cb *ATH10K_SKB_CB(struct sk_buff *skb)
  98 {
  99         BUILD_BUG_ON(sizeof(struct ath10k_skb_cb) >
 100                      IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
 101         return (struct ath10k_skb_cb *)&IEEE80211_SKB_CB(skb)->driver_data;
 102 }
 103
 104 static inline u32 host_interest_item_address(u32 item_offset)
 105 {
 106         return QCA988X_HOST_INTEREST_ADDRESS + item_offset;
 107 }
 108
 109 struct ath10k_bmi {
 110         bool done_sent;
 111 };
 112
 113 struct ath10k_mem_chunk {
 114         void *vaddr;
 115         dma_addr_t paddr;
 116         u32 len;
 117         u32 req_id;
 118 };
 119
 120 struct ath10k_wmi {
 121         enum ath10k_htc_ep_id eid;
 122         struct completion service_ready;
 123         struct completion unified_ready;
 124         wait_queue_head_t tx_credits_wq;
 125         struct wmi_cmd_map *cmd;
 126         struct wmi_vdev_param_map *vdev_param;
 127         struct wmi_pdev_param_map *pdev_param;
 128
 129         u32 num_mem_chunks;
 130         struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS];
 131 };
 132
 133 struct ath10k_fw_stats_peer {
 134         struct list_head list;
 135
 136         u8 peer_macaddr[ETH_ALEN];
 137         u32 peer_rssi;
 138         u32 peer_tx_rate;
 139         u32 peer_rx_rate; /* 10x only */
 140 };
 141
 142 struct ath10k_fw_stats_pdev {
 143         struct list_head list;
 144
 145         /* PDEV stats */
 146         s32 ch_noise_floor;
 147         u32 tx_frame_count;
 148         u32 rx_frame_count;
 149         u32 rx_clear_count;
 150         u32 cycle_count;
 151         u32 phy_err_count;
 152         u32 chan_tx_power;
 153         u32 ack_rx_bad;
 154         u32 rts_bad;
 155         u32 rts_good;
 156         u32 fcs_bad;
 157         u32 no_beacons;
 158         u32 mib_int_count;
 159
 160         /* PDEV TX stats */
 161         s32 comp_queued;
 162         s32 comp_delivered;
 163         s32 msdu_enqued;
 164         s32 mpdu_enqued;
 165         s32 wmm_drop;
 166         s32 local_enqued;
 167         s32 local_freed;
 168         s32 hw_queued;
 169         s32 hw_reaped;
 170         s32 underrun;
 171         s32 tx_abort;
 172         s32 mpdus_requed;
 173         u32 tx_ko;
 174         u32 data_rc;
 175         u32 self_triggers;
 176         u32 sw_retry_failure;
 177         u32 illgl_rate_phy_err;
 178         u32 pdev_cont_xretry;
 179         u32 pdev_tx_timeout;
 180         u32 pdev_resets;
 181         u32 phy_underrun;
 182         u32 txop_ovf;
 183
 184         /* PDEV RX stats */
 185         s32 mid_ppdu_route_change;
 186         s32 status_rcvd;
 187         s32 r0_frags;
 188         s32 r1_frags;
 189         s32 r2_frags;
 190         s32 r3_frags;
 191         s32 htt_msdus;
 192         s32 htt_mpdus;
 193         s32 loc_msdus;
 194         s32 loc_mpdus;
 195         s32 oversize_amsdu;
 196         s32 phy_errs;
 197         s32 phy_err_drop;
 198         s32 mpdu_errs;
 199 };
 200
 201 struct ath10k_fw_stats {
 202         struct list_head pdevs;
 203         struct list_head peers;
 204 };
 205
 206 struct ath10k_dfs_stats {
 207         u32 phy_errors;
 208         u32 pulses_total;
 209         u32 pulses_detected;
 210         u32 pulses_discarded;
 211         u32 radar_detected;
 212 };
 213
 214 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
 215
 216 struct ath10k_peer {
 217         struct list_head list;
 218         int vdev_id;
 219         u8 addr[ETH_ALEN];
 220         DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS);
 221         struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
 222 };
 223
 224 struct ath10k_sta {
 225         struct ath10k_vif *arvif;
 226
 227         /* the following are protected by ar->data_lock */
 228         u32 changed; /* IEEE80211_RC_* */
 229         u32 bw;
 230         u32 nss;
 231         u32 smps;
 232
 233         struct work_struct update_wk;
 234 };
 235
 236 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5*HZ)
 237
 238 struct ath10k_vif {
 239         struct list_head list;
 240
 241         u32 vdev_id;
 242         enum wmi_vdev_type vdev_type;
 243         enum wmi_vdev_subtype vdev_subtype;
 244         u32 beacon_interval;
 245         u32 dtim_period;
 246         struct sk_buff *beacon;
 247         /* protected by data_lock */
 248         bool beacon_sent;
 249         void *beacon_buf;
 250         dma_addr_t beacon_paddr;
 251
 252         struct ath10k *ar;
 253         struct ieee80211_vif *vif;
 254
 255         bool is_started;
 256         bool is_up;
 257         bool spectral_enabled;
 258         u32 aid;
 259         u8 bssid[ETH_ALEN];
 260
 261         struct work_struct wep_key_work;
 262         struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
 263         u8 def_wep_key_idx;
 264         u8 def_wep_key_newidx;
 265
 266         u16 tx_seq_no;
 267
 268         union {
 269                 struct {
 270                         u32 uapsd;
 271                 } sta;
 272                 struct {
 273                         /* 127 stations; wmi limit */
 274                         u8 tim_bitmap[16];
 275                         u8 tim_len;
 276                         u32 ssid_len;
 277                         u8 ssid[IEEE80211_MAX_SSID_LEN];
 278                         bool hidden_ssid;
 279                         /* P2P_IE with NoA attribute for P2P_GO case */
 280                         u32 noa_len;
 281                         u8 *noa_data;
 282                 } ap;
 283         } u;
 284
 285         u8 fixed_rate;
 286         u8 fixed_nss;
 287         u8 force_sgi;
 288         bool use_cts_prot;
 289         int num_legacy_stations;
 290 };
 291
 292 struct ath10k_vif_iter {
 293         u32 vdev_id;
 294         struct ath10k_vif *arvif;
 295 };
 296
 297 /* used for crash-dump storage, protected by data-lock */
 298 struct ath10k_fw_crash_data {
 299         bool crashed_since_read;
 300
 301         uuid_le uuid;
 302         struct timespec timestamp;
 303         __le32 registers[REG_DUMP_COUNT_QCA988X];
 304 };
 305
 306 struct ath10k_debug {
 307         struct dentry *debugfs_phy;
 308
 309         struct ath10k_fw_stats fw_stats;
 310         struct completion fw_stats_complete;
 311         bool fw_stats_done;
 312         DECLARE_BITMAP(wmi_service_bitmap, WMI_SERVICE_MAX);
 313
 314         unsigned long htt_stats_mask;
 315         struct delayed_work htt_stats_dwork;
 316         struct ath10k_dfs_stats dfs_stats;
 317         struct ath_dfs_pool_stats dfs_pool_stats;
 318
 319         /* protected by conf_mutex */
 320         u32 fw_dbglog_mask;
 321         u32 pktlog_filter;
 322
 323         u8 htt_max_amsdu;
 324         u8 htt_max_ampdu;
 325
 326         struct ath10k_fw_crash_data *fw_crash_data;
 327 };
 328
 329 enum ath10k_state {
 330         ATH10K_STATE_OFF = 0,
 331         ATH10K_STATE_ON,
 332
 333         /* When doing firmware recovery the device is first powered down.
 334          * mac80211 is supposed to call in to start() hook later on. It is
 335          * however possible that driver unloading and firmware crash overlap.
 336          * mac80211 can wait on conf_mutex in stop() while the device is
 337          * stopped in ath10k_core_restart() work holding conf_mutex. The state
 338          * RESTARTED means that the device is up and mac80211 has started hw
 339          * reconfiguration. Once mac80211 is done with the reconfiguration we
 340          * set the state to STATE_ON in restart_complete(). */
 341         ATH10K_STATE_RESTARTING,
 342         ATH10K_STATE_RESTARTED,
 343
 344         /* The device has crashed while restarting hw. This state is like ON
 345          * but commands are blocked in HTC and -ECOMM response is given. This
 346          * prevents completion timeouts and makes the driver more responsive to
 347          * userspace commands. This is also prevents recursive recovery. */
 348         ATH10K_STATE_WEDGED,
 349
 350         /* factory tests */
 351         ATH10K_STATE_UTF,
 352 };
 353
 354 enum ath10k_firmware_mode {
 355         /* the default mode, standard 802.11 functionality */
 356         ATH10K_FIRMWARE_MODE_NORMAL,
 357
 358         /* factory tests etc */
 359         ATH10K_FIRMWARE_MODE_UTF,
 360 };
 361
 362 enum ath10k_fw_features {
 363         /* wmi_mgmt_rx_hdr contains extra RSSI information */
 364         ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,
 365
 366         /* firmware from 10X branch */
 367         ATH10K_FW_FEATURE_WMI_10X = 1,
 368
 369         /* firmware support tx frame management over WMI, otherwise it's HTT */
 370         ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,
 371
 372         /* Firmware does not support P2P */
 373         ATH10K_FW_FEATURE_NO_P2P = 3,
 374
 375         /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature bit
 376          * is required to be set as well.
 377          */
 378         ATH10K_FW_FEATURE_WMI_10_2 = 4,
 379
 380         /* keep last */
 381         ATH10K_FW_FEATURE_COUNT,
 382 };
 383
 384 enum ath10k_dev_flags {
 385         /* Indicates that ath10k device is during CAC phase of DFS */
 386         ATH10K_CAC_RUNNING,
 387         ATH10K_FLAG_CORE_REGISTERED,
 388 };
 389
 390 enum ath10k_scan_state {
 391         ATH10K_SCAN_IDLE,
 392         ATH10K_SCAN_STARTING,
 393         ATH10K_SCAN_RUNNING,
 394         ATH10K_SCAN_ABORTING,
 395 };
 396
 397 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
 398 {
 399         switch (state) {
 400         case ATH10K_SCAN_IDLE:
 401                 return "idle";
 402         case ATH10K_SCAN_STARTING:
 403                 return "starting";
 404         case ATH10K_SCAN_RUNNING:
 405                 return "running";
 406         case ATH10K_SCAN_ABORTING:
 407                 return "aborting";
 408         }
 409
 410         return "unknown";
 411 }
 412
 413 struct ath10k {
 414         struct ath_common ath_common;
 415         struct ieee80211_hw *hw;
 416         struct device *dev;
 417         u8 mac_addr[ETH_ALEN];
 418
 419         u32 chip_id;
 420         u32 target_version;
 421         u8 fw_version_major;
 422         u32 fw_version_minor;
 423         u16 fw_version_release;
 424         u16 fw_version_build;
 425         u32 phy_capability;
 426         u32 hw_min_tx_power;
 427         u32 hw_max_tx_power;
 428         u32 ht_cap_info;
 429         u32 vht_cap_info;
 430         u32 num_rf_chains;
 431
 432         DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
 433
 434         struct targetdef *targetdef;
 435         struct hostdef *hostdef;
 436
 437         bool p2p;
 438
 439         struct {
 440                 enum ath10k_bus bus;
 441                 const struct ath10k_hif_ops *ops;
 442         } hif;
 443
 444         struct completion target_suspend;
 445
 446         struct ath10k_bmi bmi;
 447         struct ath10k_wmi wmi;
 448         struct ath10k_htc htc;
 449         struct ath10k_htt htt;
 450
 451         struct ath10k_hw_params {
 452                 u32 id;
 453                 const char *name;
 454                 u32 patch_load_addr;
 455
 456                 struct ath10k_hw_params_fw {
 457                         const char *dir;
 458                         const char *fw;
 459                         const char *otp;
 460                         const char *board;
 461                 } fw;
 462         } hw_params;
 463
 464         const struct firmware *board;
 465         const void *board_data;
 466         size_t board_len;
 467
 468         const struct firmware *otp;
 469         const void *otp_data;
 470         size_t otp_len;
 471
 472         const struct firmware *firmware;
 473         const void *firmware_data;
 474         size_t firmware_len;
 475
 476         int fw_api;
 477
 478         struct {
 479                 struct completion started;
 480                 struct completion completed;
 481                 struct completion on_channel;
 482                 struct delayed_work timeout;
 483                 enum ath10k_scan_state state;
 484                 bool is_roc;
 485                 int vdev_id;
 486                 int roc_freq;
 487         } scan;
 488
 489         struct {
 490                 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
 491         } mac;
 492
 493         /* should never be NULL; needed for regular htt rx */
 494         struct ieee80211_channel *rx_channel;
 495
 496         /* valid during scan; needed for mgmt rx during scan */
 497         struct ieee80211_channel *scan_channel;
 498
 499         /* current operating channel definition */
 500         struct cfg80211_chan_def chandef;
 501
 502         unsigned long long free_vdev_map;
 503         bool monitor;
 504         int monitor_vdev_id;
 505         bool monitor_started;
 506         unsigned int filter_flags;
 507         unsigned long dev_flags;
 508         u32 dfs_block_radar_events;
 509
 510         /* protected by conf_mutex */
 511         bool radar_enabled;
 512         int num_started_vdevs;
 513
 514         /* Protected by conf-mutex */
 515         u8 supp_tx_chainmask;
 516         u8 supp_rx_chainmask;
 517         u8 cfg_tx_chainmask;
 518         u8 cfg_rx_chainmask;
 519
 520         struct wmi_pdev_set_wmm_params_arg wmm_params;
 521         struct completion install_key_done;
 522
 523         struct completion vdev_setup_done;
 524
 525         struct workqueue_struct *workqueue;
 526
 527         /* prevents concurrent FW reconfiguration */
 528         struct mutex conf_mutex;
 529
 530         /* protects shared structure data */
 531         spinlock_t data_lock;
 532
 533         struct list_head arvifs;
 534         struct list_head peers;
 535         wait_queue_head_t peer_mapping_wq;
 536
 537         /* number of created peers; protected by data_lock */
 538         int num_peers;
 539
 540         struct work_struct offchan_tx_work;
 541         struct sk_buff_head offchan_tx_queue;
 542         struct completion offchan_tx_completed;
 543         struct sk_buff *offchan_tx_skb;
 544
 545         struct work_struct wmi_mgmt_tx_work;
 546         struct sk_buff_head wmi_mgmt_tx_queue;
 547
 548         enum ath10k_state state;
 549
 550         struct work_struct register_work;
 551         struct work_struct restart_work;
 552
 553         /* cycle count is reported twice for each visited channel during scan.
 554          * access protected by data_lock */
 555         u32 survey_last_rx_clear_count;
 556         u32 survey_last_cycle_count;
 557         struct survey_info survey[ATH10K_NUM_CHANS];
 558
 559         struct dfs_pattern_detector *dfs_detector;
 560
 561 #ifdef CONFIG_ATH10K_DEBUGFS
 562         struct ath10k_debug debug;
 563 #endif
 564
 565         struct {
 566                 /* relay(fs) channel for spectral scan */
 567                 struct rchan *rfs_chan_spec_scan;
 568
 569                 /* spectral_mode and spec_config are protected by conf_mutex */
 570                 enum ath10k_spectral_mode mode;
 571                 struct ath10k_spec_scan config;
 572         } spectral;
 573
 574         struct {
 575                 /* protected by conf_mutex */
 576                 const struct firmware *utf;
 577                 DECLARE_BITMAP(orig_fw_features, ATH10K_FW_FEATURE_COUNT);
 578
 579                 /* protected by data_lock */
 580                 bool utf_monitor;
 581         } testmode;
 582
 583         struct {
 584                 /* protected by data_lock */
 585                 u32 fw_crash_counter;
 586                 u32 fw_warm_reset_counter;
 587                 u32 fw_cold_reset_counter;
 588         } stats;
 589
 590         /* must be last */
 591         u8 drv_priv[0] __aligned(sizeof(void *));
 592 };
 593
 594 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
 595                                   enum ath10k_bus bus,
 596                                   const struct ath10k_hif_ops *hif_ops);
 597 void ath10k_core_destroy(struct ath10k *ar);
 598
 599 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode);
 600 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
 601 void ath10k_core_stop(struct ath10k *ar);
 602 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
 603 void ath10k_core_unregister(struct ath10k *ar);
 604
 605 #endif /* _CORE_H_ */