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