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