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