2 * Copyright (c) 2005-2011 Atheros Communications Inc.
3 * Copyright (c) 2011-2013 Qualcomm Atheros, Inc.
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.
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.
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>
31 #include "targaddrs.h"
35 #include "../dfs_pattern_detector.h"
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)
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
47 /* Antenna noise floor */
48 #define ATH10K_DEFAULT_NOISE_FLOOR -95
50 #define ATH10K_MAX_NUM_MGMT_PENDING 128
52 /* number of failed packets */
53 #define ATH10K_KICKOUT_THRESHOLD 50
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
60 #define ATH10K_KEEPALIVE_MIN_IDLE 3747
61 #define ATH10K_KEEPALIVE_MAX_IDLE 3895
62 #define ATH10K_KEEPALIVE_MAX_UNRESPONSIVE 3900
66 struct ath10k_skb_cb {
73 struct ath10k_htt_txbuf *txbuf;
83 static inline struct ath10k_skb_cb *ATH10K_SKB_CB(struct sk_buff *skb)
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;
90 static inline u32 host_interest_item_address(u32 item_offset)
92 return QCA988X_HOST_INTEREST_ADDRESS + item_offset;
99 struct ath10k_mem_chunk {
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;
116 struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS];
119 struct ath10k_fw_stats_peer {
120 struct list_head list;
122 u8 peer_macaddr[ETH_ALEN];
125 u32 peer_rx_rate; /* 10x only */
128 struct ath10k_fw_stats_pdev {
129 struct list_head list;
162 u32 sw_retry_failure;
163 u32 illgl_rate_phy_err;
164 u32 pdev_cont_xretry;
171 s32 mid_ppdu_route_change;
187 struct ath10k_fw_stats {
188 struct list_head pdevs;
189 struct list_head peers;
192 struct ath10k_dfs_stats {
196 u32 pulses_discarded;
200 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
203 struct list_head list;
206 DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS);
207 struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
211 struct ath10k_vif *arvif;
213 /* the following are protected by ar->data_lock */
214 u32 changed; /* IEEE80211_RC_* */
219 struct work_struct update_wk;
222 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5*HZ)
225 struct list_head list;
228 enum wmi_vdev_type vdev_type;
229 enum wmi_vdev_subtype vdev_subtype;
232 struct sk_buff *beacon;
233 /* protected by data_lock */
236 dma_addr_t beacon_paddr;
239 struct ieee80211_vif *vif;
243 bool spectral_enabled;
247 struct work_struct wep_key_work;
248 struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
250 u8 def_wep_key_newidx;
259 /* 127 stations; wmi limit */
263 u8 ssid[IEEE80211_MAX_SSID_LEN];
265 /* P2P_IE with NoA attribute for P2P_GO case */
275 int num_legacy_stations;
278 struct ath10k_vif_iter {
280 struct ath10k_vif *arvif;
283 /* used for crash-dump storage, protected by data-lock */
284 struct ath10k_fw_crash_data {
285 bool crashed_since_read;
288 struct timespec timestamp;
289 __le32 registers[REG_DUMP_COUNT_QCA988X];
292 struct ath10k_debug {
293 struct dentry *debugfs_phy;
295 struct ath10k_fw_stats fw_stats;
296 struct completion fw_stats_complete;
298 DECLARE_BITMAP(wmi_service_bitmap, WMI_SERVICE_MAX);
300 unsigned long htt_stats_mask;
301 struct delayed_work htt_stats_dwork;
302 struct ath10k_dfs_stats dfs_stats;
303 struct ath_dfs_pool_stats dfs_pool_stats;
305 /* protected by conf_mutex */
312 struct ath10k_fw_crash_data *fw_crash_data;
316 ATH10K_STATE_OFF = 0,
319 /* When doing firmware recovery the device is first powered down.
320 * mac80211 is supposed to call in to start() hook later on. It is
321 * however possible that driver unloading and firmware crash overlap.
322 * mac80211 can wait on conf_mutex in stop() while the device is
323 * stopped in ath10k_core_restart() work holding conf_mutex. The state
324 * RESTARTED means that the device is up and mac80211 has started hw
325 * reconfiguration. Once mac80211 is done with the reconfiguration we
326 * set the state to STATE_ON in restart_complete(). */
327 ATH10K_STATE_RESTARTING,
328 ATH10K_STATE_RESTARTED,
330 /* The device has crashed while restarting hw. This state is like ON
331 * but commands are blocked in HTC and -ECOMM response is given. This
332 * prevents completion timeouts and makes the driver more responsive to
333 * userspace commands. This is also prevents recursive recovery. */
340 enum ath10k_firmware_mode {
341 /* the default mode, standard 802.11 functionality */
342 ATH10K_FIRMWARE_MODE_NORMAL,
344 /* factory tests etc */
345 ATH10K_FIRMWARE_MODE_UTF,
348 enum ath10k_fw_features {
349 /* wmi_mgmt_rx_hdr contains extra RSSI information */
350 ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,
352 /* firmware from 10X branch */
353 ATH10K_FW_FEATURE_WMI_10X = 1,
355 /* firmware support tx frame management over WMI, otherwise it's HTT */
356 ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,
358 /* Firmware does not support P2P */
359 ATH10K_FW_FEATURE_NO_P2P = 3,
361 /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature bit
362 * is required to be set as well.
364 ATH10K_FW_FEATURE_WMI_10_2 = 4,
367 ATH10K_FW_FEATURE_COUNT,
370 enum ath10k_dev_flags {
371 /* Indicates that ath10k device is during CAC phase of DFS */
373 ATH10K_FLAG_CORE_REGISTERED,
376 enum ath10k_scan_state {
378 ATH10K_SCAN_STARTING,
380 ATH10K_SCAN_ABORTING,
383 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
386 case ATH10K_SCAN_IDLE:
388 case ATH10K_SCAN_STARTING:
390 case ATH10K_SCAN_RUNNING:
392 case ATH10K_SCAN_ABORTING:
400 struct ath_common ath_common;
401 struct ieee80211_hw *hw;
403 u8 mac_addr[ETH_ALEN];
408 u32 fw_version_minor;
409 u16 fw_version_release;
410 u16 fw_version_build;
418 DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
420 struct targetdef *targetdef;
421 struct hostdef *hostdef;
426 const struct ath10k_hif_ops *ops;
429 struct completion target_suspend;
431 struct ath10k_bmi bmi;
432 struct ath10k_wmi wmi;
433 struct ath10k_htc htc;
434 struct ath10k_htt htt;
436 struct ath10k_hw_params {
441 struct ath10k_hw_params_fw {
449 const struct firmware *board;
450 const void *board_data;
453 const struct firmware *otp;
454 const void *otp_data;
457 const struct firmware *firmware;
458 const void *firmware_data;
464 struct completion started;
465 struct completion completed;
466 struct completion on_channel;
467 struct delayed_work timeout;
468 enum ath10k_scan_state state;
475 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
478 /* should never be NULL; needed for regular htt rx */
479 struct ieee80211_channel *rx_channel;
481 /* valid during scan; needed for mgmt rx during scan */
482 struct ieee80211_channel *scan_channel;
484 /* current operating channel definition */
485 struct cfg80211_chan_def chandef;
487 unsigned long long free_vdev_map;
490 bool monitor_started;
491 unsigned int filter_flags;
492 unsigned long dev_flags;
493 u32 dfs_block_radar_events;
495 /* protected by conf_mutex */
497 int num_started_vdevs;
499 /* Protected by conf-mutex */
500 u8 supp_tx_chainmask;
501 u8 supp_rx_chainmask;
505 struct wmi_pdev_set_wmm_params_arg wmm_params;
506 struct completion install_key_done;
508 struct completion vdev_setup_done;
510 struct workqueue_struct *workqueue;
512 /* prevents concurrent FW reconfiguration */
513 struct mutex conf_mutex;
515 /* protects shared structure data */
516 spinlock_t data_lock;
518 struct list_head arvifs;
519 struct list_head peers;
520 wait_queue_head_t peer_mapping_wq;
522 /* number of created peers; protected by data_lock */
525 struct work_struct offchan_tx_work;
526 struct sk_buff_head offchan_tx_queue;
527 struct completion offchan_tx_completed;
528 struct sk_buff *offchan_tx_skb;
530 struct work_struct wmi_mgmt_tx_work;
531 struct sk_buff_head wmi_mgmt_tx_queue;
533 enum ath10k_state state;
535 struct work_struct register_work;
536 struct work_struct restart_work;
538 /* cycle count is reported twice for each visited channel during scan.
539 * access protected by data_lock */
540 u32 survey_last_rx_clear_count;
541 u32 survey_last_cycle_count;
542 struct survey_info survey[ATH10K_NUM_CHANS];
544 struct dfs_pattern_detector *dfs_detector;
546 #ifdef CONFIG_ATH10K_DEBUGFS
547 struct ath10k_debug debug;
551 /* relay(fs) channel for spectral scan */
552 struct rchan *rfs_chan_spec_scan;
554 /* spectral_mode and spec_config are protected by conf_mutex */
555 enum ath10k_spectral_mode mode;
556 struct ath10k_spec_scan config;
560 /* protected by conf_mutex */
561 const struct firmware *utf;
562 DECLARE_BITMAP(orig_fw_features, ATH10K_FW_FEATURE_COUNT);
564 /* protected by data_lock */
569 /* protected by data_lock */
570 u32 fw_crash_counter;
571 u32 fw_warm_reset_counter;
572 u32 fw_cold_reset_counter;
576 u8 drv_priv[0] __aligned(sizeof(void *));
579 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
580 const struct ath10k_hif_ops *hif_ops);
581 void ath10k_core_destroy(struct ath10k *ar);
583 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode);
584 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
585 void ath10k_core_stop(struct ath10k *ar);
586 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
587 void ath10k_core_unregister(struct ath10k *ar);
589 #endif /* _CORE_H_ */