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 struct ath10k_skb_cb {
  67         dma_addr_t paddr;
  68         u8 vdev_id;
  69
  70         struct {
  71                 u8 tid;
  72                 bool is_offchan;
  73                 struct ath10k_htt_txbuf *txbuf;
  74                 u32 txbuf_paddr;
  75         } __packed htt;
  76
  77         struct {
  78                 bool dtim_zero;
  79                 bool deliver_cab;
  80         } bcn;
  81 } __packed;
  82
  83 static inline struct ath10k_skb_cb *ATH10K_SKB_CB(struct sk_buff *skb)
  84 {
  85         BUILD_BUG_ON(sizeof(struct ath10k_skb_cb) >
  86                      IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
  87         return (struct ath10k_skb_cb *)&IEEE80211_SKB_CB(skb)->driver_data;
  88 }
  89
  90 static inline u32 host_interest_item_address(u32 item_offset)
  91 {
  92         return QCA988X_HOST_INTEREST_ADDRESS + item_offset;
  93 }
  94
  95 struct ath10k_bmi {
  96         bool done_sent;
  97 };
  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[WMI_MAX_MEM_REQS];
 117 };
 118
 119 struct ath10k_fw_stats_peer {
 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_fw_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_fw_stats_peer 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         void *beacon_buf;
 236         dma_addr_t beacon_paddr;
 237
 238         struct ath10k *ar;
 239         struct ieee80211_vif *vif;
 240
 241         bool is_started;
 242         bool is_up;
 243         bool spectral_enabled;
 244         u32 aid;
 245         u8 bssid[ETH_ALEN];
 246
 247         struct work_struct wep_key_work;
 248         struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
 249         u8 def_wep_key_idx;
 250         u8 def_wep_key_newidx;
 251
 252         u16 tx_seq_no;
 253
 254         union {
 255                 struct {
 256                         u32 uapsd;
 257                 } sta;
 258                 struct {
 259                         /* 127 stations; wmi limit */
 260                         u8 tim_bitmap[16];
 261                         u8 tim_len;
 262                         u32 ssid_len;
 263                         u8 ssid[IEEE80211_MAX_SSID_LEN];
 264                         bool hidden_ssid;
 265                         /* P2P_IE with NoA attribute for P2P_GO case */
 266                         u32 noa_len;
 267                         u8 *noa_data;
 268                 } ap;
 269         } u;
 270
 271         u8 fixed_rate;
 272         u8 fixed_nss;
 273         u8 force_sgi;
 274         bool use_cts_prot;
 275         int num_legacy_stations;
 276 };
 277
 278 struct ath10k_vif_iter {
 279         u32 vdev_id;
 280         struct ath10k_vif *arvif;
 281 };
 282
 283 /* used for crash-dump storage, protected by data-lock */
 284 struct ath10k_fw_crash_data {
 285         bool crashed_since_read;
 286
 287         uuid_le uuid;
 288         struct timespec timestamp;
 289         __le32 registers[REG_DUMP_COUNT_QCA988X];
 290 };
 291
 292 struct ath10k_debug {
 293         struct dentry *debugfs_phy;
 294
 295         struct ath10k_fw_stats fw_stats;
 296         struct completion fw_stats_complete;
 297         DECLARE_BITMAP(wmi_service_bitmap, WMI_SERVICE_MAX);
 298
 299         unsigned long htt_stats_mask;
 300         struct delayed_work htt_stats_dwork;
 301         struct ath10k_dfs_stats dfs_stats;
 302         struct ath_dfs_pool_stats dfs_pool_stats;
 303
 304         u32 fw_dbglog_mask;
 305
 306         u8 htt_max_amsdu;
 307         u8 htt_max_ampdu;
 308
 309         struct ath10k_fw_crash_data *fw_crash_data;
 310 };
 311
 312 enum ath10k_state {
 313         ATH10K_STATE_OFF = 0,
 314         ATH10K_STATE_ON,
 315
 316         /* When doing firmware recovery the device is first powered down.
 317          * mac80211 is supposed to call in to start() hook later on. It is
 318          * however possible that driver unloading and firmware crash overlap.
 319          * mac80211 can wait on conf_mutex in stop() while the device is
 320          * stopped in ath10k_core_restart() work holding conf_mutex. The state
 321          * RESTARTED means that the device is up and mac80211 has started hw
 322          * reconfiguration. Once mac80211 is done with the reconfiguration we
 323          * set the state to STATE_ON in restart_complete(). */
 324         ATH10K_STATE_RESTARTING,
 325         ATH10K_STATE_RESTARTED,
 326
 327         /* The device has crashed while restarting hw. This state is like ON
 328          * but commands are blocked in HTC and -ECOMM response is given. This
 329          * prevents completion timeouts and makes the driver more responsive to
 330          * userspace commands. This is also prevents recursive recovery. */
 331         ATH10K_STATE_WEDGED,
 332
 333         /* factory tests */
 334         ATH10K_STATE_UTF,
 335 };
 336
 337 enum ath10k_firmware_mode {
 338         /* the default mode, standard 802.11 functionality */
 339         ATH10K_FIRMWARE_MODE_NORMAL,
 340
 341         /* factory tests etc */
 342         ATH10K_FIRMWARE_MODE_UTF,
 343 };
 344
 345 enum ath10k_fw_features {
 346         /* wmi_mgmt_rx_hdr contains extra RSSI information */
 347         ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,
 348
 349         /* firmware from 10X branch */
 350         ATH10K_FW_FEATURE_WMI_10X = 1,
 351
 352         /* firmware support tx frame management over WMI, otherwise it's HTT */
 353         ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,
 354
 355         /* Firmware does not support P2P */
 356         ATH10K_FW_FEATURE_NO_P2P = 3,
 357
 358         /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature bit
 359          * is required to be set as well.
 360          */
 361         ATH10K_FW_FEATURE_WMI_10_2 = 4,
 362
 363         /* keep last */
 364         ATH10K_FW_FEATURE_COUNT,
 365 };
 366
 367 enum ath10k_dev_flags {
 368         /* Indicates that ath10k device is during CAC phase of DFS */
 369         ATH10K_CAC_RUNNING,
 370         ATH10K_FLAG_CORE_REGISTERED,
 371 };
 372
 373 enum ath10k_scan_state {
 374         ATH10K_SCAN_IDLE,
 375         ATH10K_SCAN_STARTING,
 376         ATH10K_SCAN_RUNNING,
 377         ATH10K_SCAN_ABORTING,
 378 };
 379
 380 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
 381 {
 382         switch (state) {
 383         case ATH10K_SCAN_IDLE:
 384                 return "idle";
 385         case ATH10K_SCAN_STARTING:
 386                 return "starting";
 387         case ATH10K_SCAN_RUNNING:
 388                 return "running";
 389         case ATH10K_SCAN_ABORTING:
 390                 return "aborting";
 391         }
 392
 393         return "unknown";
 394 }
 395
 396 struct ath10k {
 397         struct ath_common ath_common;
 398         struct ieee80211_hw *hw;
 399         struct device *dev;
 400         u8 mac_addr[ETH_ALEN];
 401
 402         u32 chip_id;
 403         u32 target_version;
 404         u8 fw_version_major;
 405         u32 fw_version_minor;
 406         u16 fw_version_release;
 407         u16 fw_version_build;
 408         u32 phy_capability;
 409         u32 hw_min_tx_power;
 410         u32 hw_max_tx_power;
 411         u32 ht_cap_info;
 412         u32 vht_cap_info;
 413         u32 num_rf_chains;
 414
 415         DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
 416
 417         struct targetdef *targetdef;
 418         struct hostdef *hostdef;
 419
 420         bool p2p;
 421
 422         struct {
 423                 const struct ath10k_hif_ops *ops;
 424         } hif;
 425
 426         struct completion target_suspend;
 427
 428         struct ath10k_bmi bmi;
 429         struct ath10k_wmi wmi;
 430         struct ath10k_htc htc;
 431         struct ath10k_htt htt;
 432
 433         struct ath10k_hw_params {
 434                 u32 id;
 435                 const char *name;
 436                 u32 patch_load_addr;
 437
 438                 struct ath10k_hw_params_fw {
 439                         const char *dir;
 440                         const char *fw;
 441                         const char *otp;
 442                         const char *board;
 443                 } fw;
 444         } hw_params;
 445
 446         const struct firmware *board;
 447         const void *board_data;
 448         size_t board_len;
 449
 450         const struct firmware *otp;
 451         const void *otp_data;
 452         size_t otp_len;
 453
 454         const struct firmware *firmware;
 455         const void *firmware_data;
 456         size_t firmware_len;
 457
 458         int fw_api;
 459
 460         struct {
 461                 struct completion started;
 462                 struct completion completed;
 463                 struct completion on_channel;
 464                 struct delayed_work timeout;
 465                 enum ath10k_scan_state state;
 466                 bool is_roc;
 467                 int vdev_id;
 468                 int roc_freq;
 469         } scan;
 470
 471         struct {
 472                 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
 473         } mac;
 474
 475         /* should never be NULL; needed for regular htt rx */
 476         struct ieee80211_channel *rx_channel;
 477
 478         /* valid during scan; needed for mgmt rx during scan */
 479         struct ieee80211_channel *scan_channel;
 480
 481         /* current operating channel definition */
 482         struct cfg80211_chan_def chandef;
 483
 484         int free_vdev_map;
 485         bool monitor;
 486         int monitor_vdev_id;
 487         bool monitor_started;
 488         unsigned int filter_flags;
 489         unsigned long dev_flags;
 490         u32 dfs_block_radar_events;
 491
 492         /* protected by conf_mutex */
 493         bool radar_enabled;
 494         int num_started_vdevs;
 495
 496         /* Protected by conf-mutex */
 497         u8 supp_tx_chainmask;
 498         u8 supp_rx_chainmask;
 499         u8 cfg_tx_chainmask;
 500         u8 cfg_rx_chainmask;
 501
 502         struct wmi_pdev_set_wmm_params_arg wmm_params;
 503         struct completion install_key_done;
 504
 505         struct completion vdev_setup_done;
 506
 507         struct workqueue_struct *workqueue;
 508
 509         /* prevents concurrent FW reconfiguration */
 510         struct mutex conf_mutex;
 511
 512         /* protects shared structure data */
 513         spinlock_t data_lock;
 514
 515         struct list_head arvifs;
 516         struct list_head peers;
 517         wait_queue_head_t peer_mapping_wq;
 518
 519         /* number of created peers; protected by data_lock */
 520         int num_peers;
 521
 522         struct work_struct offchan_tx_work;
 523         struct sk_buff_head offchan_tx_queue;
 524         struct completion offchan_tx_completed;
 525         struct sk_buff *offchan_tx_skb;
 526
 527         struct work_struct wmi_mgmt_tx_work;
 528         struct sk_buff_head wmi_mgmt_tx_queue;
 529
 530         enum ath10k_state state;
 531
 532         struct work_struct register_work;
 533         struct work_struct restart_work;
 534
 535         /* cycle count is reported twice for each visited channel during scan.
 536          * access protected by data_lock */
 537         u32 survey_last_rx_clear_count;
 538         u32 survey_last_cycle_count;
 539         struct survey_info survey[ATH10K_NUM_CHANS];
 540
 541         struct dfs_pattern_detector *dfs_detector;
 542
 543 #ifdef CONFIG_ATH10K_DEBUGFS
 544         struct ath10k_debug debug;
 545 #endif
 546
 547         struct {
 548                 /* relay(fs) channel for spectral scan */
 549                 struct rchan *rfs_chan_spec_scan;
 550
 551                 /* spectral_mode and spec_config are protected by conf_mutex */
 552                 enum ath10k_spectral_mode mode;
 553                 struct ath10k_spec_scan config;
 554         } spectral;
 555
 556         struct {
 557                 /* protected by conf_mutex */
 558                 const struct firmware *utf;
 559                 DECLARE_BITMAP(orig_fw_features, ATH10K_FW_FEATURE_COUNT);
 560
 561                 /* protected by data_lock */
 562                 bool utf_monitor;
 563         } testmode;
 564
 565         /* must be last */
 566         u8 drv_priv[0] __aligned(sizeof(void *));
 567 };
 568
 569 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
 570                                   const struct ath10k_hif_ops *hif_ops);
 571 void ath10k_core_destroy(struct ath10k *ar);
 572
 573 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode);
 574 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
 575 void ath10k_core_stop(struct ath10k *ar);
 576 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
 577 void ath10k_core_unregister(struct ath10k *ar);
 578
 579 #endif /* _CORE_H_ */