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