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"
40 #define MS(_v, _f) (((_v) & _f##_MASK) >> _f##_LSB)
41 #define SM(_v, _f) (((_v) << _f##_LSB) & _f##_MASK)
42 #define WO(_f) ((_f##_OFFSET) >> 2)
44 #define ATH10K_SCAN_ID 0
45 #define WMI_READY_TIMEOUT (5 * HZ)
46 #define ATH10K_FLUSH_TIMEOUT_HZ (5*HZ)
47 #define ATH10K_CONNECTION_LOSS_HZ (3*HZ)
48 #define ATH10K_NUM_CHANS 39
50 /* Antenna noise floor */
51 #define ATH10K_DEFAULT_NOISE_FLOOR -95
53 #define ATH10K_MAX_NUM_MGMT_PENDING 128
55 /* number of failed packets (20 packets with 16 sw reties each) */
56 #define ATH10K_KICKOUT_THRESHOLD (20 * 16)
59 * Use insanely high numbers to make sure that the firmware implementation
60 * won't start, we have the same functionality already in hostapd. Unit
63 #define ATH10K_KEEPALIVE_MIN_IDLE 3747
64 #define ATH10K_KEEPALIVE_MAX_IDLE 3895
65 #define ATH10K_KEEPALIVE_MAX_UNRESPONSIVE 3900
73 static inline const char *ath10k_bus_str(enum ath10k_bus bus)
83 struct ath10k_skb_cb {
87 enum ath10k_hw_txrx_mode txmode;
94 struct ath10k_htt_txbuf *txbuf;
104 struct ath10k_skb_rxcb {
106 struct hlist_node hlist;
109 static inline struct ath10k_skb_cb *ATH10K_SKB_CB(struct sk_buff *skb)
111 BUILD_BUG_ON(sizeof(struct ath10k_skb_cb) >
112 IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
113 return (struct ath10k_skb_cb *)&IEEE80211_SKB_CB(skb)->driver_data;
116 static inline struct ath10k_skb_rxcb *ATH10K_SKB_RXCB(struct sk_buff *skb)
118 BUILD_BUG_ON(sizeof(struct ath10k_skb_rxcb) > sizeof(skb->cb));
119 return (struct ath10k_skb_rxcb *)skb->cb;
122 #define ATH10K_RXCB_SKB(rxcb) \
123 container_of((void *)rxcb, struct sk_buff, cb)
125 static inline u32 host_interest_item_address(u32 item_offset)
127 return QCA988X_HOST_INTEREST_ADDRESS + item_offset;
134 struct ath10k_mem_chunk {
142 enum ath10k_fw_wmi_op_version op_version;
143 enum ath10k_htc_ep_id eid;
144 struct completion service_ready;
145 struct completion unified_ready;
146 wait_queue_head_t tx_credits_wq;
147 DECLARE_BITMAP(svc_map, WMI_SERVICE_MAX);
148 struct wmi_cmd_map *cmd;
149 struct wmi_vdev_param_map *vdev_param;
150 struct wmi_pdev_param_map *pdev_param;
151 const struct wmi_ops *ops;
154 struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS];
157 struct ath10k_fw_stats_peer {
158 struct list_head list;
160 u8 peer_macaddr[ETH_ALEN];
163 u32 peer_rx_rate; /* 10x only */
166 struct ath10k_fw_stats_vdev {
167 struct list_head list;
172 u32 num_tx_frames[4];
174 u32 num_tx_frames_retries[4];
175 u32 num_tx_frames_failures[4];
180 u32 num_tx_not_acked;
181 u32 tx_rate_history[10];
182 u32 beacon_rssi_history[10];
185 struct ath10k_fw_stats_pdev {
186 struct list_head list;
219 u32 sw_retry_failure;
220 u32 illgl_rate_phy_err;
221 u32 pdev_cont_xretry;
228 s32 mid_ppdu_route_change;
244 struct ath10k_fw_stats {
245 struct list_head pdevs;
246 struct list_head vdevs;
247 struct list_head peers;
250 struct ath10k_dfs_stats {
254 u32 pulses_discarded;
258 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
261 struct list_head list;
264 DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS);
266 /* protected by ar->data_lock */
267 struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
271 struct ath10k_vif *arvif;
273 /* the following are protected by ar->data_lock */
274 u32 changed; /* IEEE80211_RC_* */
279 struct work_struct update_wk;
281 #ifdef CONFIG_MAC80211_DEBUGFS
282 /* protected by conf_mutex */
287 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5*HZ)
289 enum ath10k_beacon_state {
290 ATH10K_BEACON_SCHEDULED = 0,
291 ATH10K_BEACON_SENDING,
296 struct list_head list;
299 enum wmi_vdev_type vdev_type;
300 enum wmi_vdev_subtype vdev_subtype;
303 struct sk_buff *beacon;
304 /* protected by data_lock */
305 enum ath10k_beacon_state beacon_state;
307 dma_addr_t beacon_paddr;
308 unsigned long tx_paused; /* arbitrary values defined by target */
311 struct ieee80211_vif *vif;
315 bool spectral_enabled;
320 struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
330 /* 127 stations; wmi limit */
334 u8 ssid[IEEE80211_MAX_SSID_LEN];
336 /* P2P_IE with NoA attribute for P2P_GO case */
343 int num_legacy_stations;
345 struct wmi_wmm_params_all_arg wmm_params;
346 struct work_struct ap_csa_work;
347 struct delayed_work connection_loss_work;
348 struct cfg80211_bitrate_mask bitrate_mask;
351 struct ath10k_vif_iter {
353 struct ath10k_vif *arvif;
356 /* used for crash-dump storage, protected by data-lock */
357 struct ath10k_fw_crash_data {
358 bool crashed_since_read;
361 struct timespec timestamp;
362 __le32 registers[REG_DUMP_COUNT_QCA988X];
365 struct ath10k_debug {
366 struct dentry *debugfs_phy;
368 struct ath10k_fw_stats fw_stats;
369 struct completion fw_stats_complete;
372 unsigned long htt_stats_mask;
373 struct delayed_work htt_stats_dwork;
374 struct ath10k_dfs_stats dfs_stats;
375 struct ath_dfs_pool_stats dfs_pool_stats;
377 /* protected by conf_mutex */
387 struct ath10k_fw_crash_data *fw_crash_data;
391 ATH10K_STATE_OFF = 0,
394 /* When doing firmware recovery the device is first powered down.
395 * mac80211 is supposed to call in to start() hook later on. It is
396 * however possible that driver unloading and firmware crash overlap.
397 * mac80211 can wait on conf_mutex in stop() while the device is
398 * stopped in ath10k_core_restart() work holding conf_mutex. The state
399 * RESTARTED means that the device is up and mac80211 has started hw
400 * reconfiguration. Once mac80211 is done with the reconfiguration we
401 * set the state to STATE_ON in reconfig_complete(). */
402 ATH10K_STATE_RESTARTING,
403 ATH10K_STATE_RESTARTED,
405 /* The device has crashed while restarting hw. This state is like ON
406 * but commands are blocked in HTC and -ECOMM response is given. This
407 * prevents completion timeouts and makes the driver more responsive to
408 * userspace commands. This is also prevents recursive recovery. */
415 enum ath10k_firmware_mode {
416 /* the default mode, standard 802.11 functionality */
417 ATH10K_FIRMWARE_MODE_NORMAL,
419 /* factory tests etc */
420 ATH10K_FIRMWARE_MODE_UTF,
423 enum ath10k_fw_features {
424 /* wmi_mgmt_rx_hdr contains extra RSSI information */
425 ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,
427 /* Firmware from 10X branch. Deprecated, don't use in new code. */
428 ATH10K_FW_FEATURE_WMI_10X = 1,
430 /* firmware support tx frame management over WMI, otherwise it's HTT */
431 ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,
433 /* Firmware does not support P2P */
434 ATH10K_FW_FEATURE_NO_P2P = 3,
436 /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature
437 * bit is required to be set as well. Deprecated, don't use in new
440 ATH10K_FW_FEATURE_WMI_10_2 = 4,
442 /* Some firmware revisions lack proper multi-interface client powersave
443 * implementation. Enabling PS could result in connection drops,
444 * traffic stalls, etc.
446 ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT = 5,
448 /* Some firmware revisions have an incomplete WoWLAN implementation
449 * despite WMI service bit being advertised. This feature flag is used
450 * to distinguish whether WoWLAN is really supported or not.
452 ATH10K_FW_FEATURE_WOWLAN_SUPPORT = 6,
454 /* Don't trust error code from otp.bin */
455 ATH10K_FW_FEATURE_IGNORE_OTP_RESULT,
457 /* Some firmware revisions pad 4th hw address to 4 byte boundary making
458 * it 8 bytes long in Native Wifi Rx decap.
460 ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING,
462 /* Firmware supports bypassing PLL setting on init. */
463 ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT = 9,
466 ATH10K_FW_FEATURE_COUNT,
469 enum ath10k_dev_flags {
470 /* Indicates that ath10k device is during CAC phase of DFS */
472 ATH10K_FLAG_CORE_REGISTERED,
474 /* Device has crashed and needs to restart. This indicates any pending
475 * waiters should immediately cancel instead of waiting for a time out.
477 ATH10K_FLAG_CRASH_FLUSH,
480 enum ath10k_cal_mode {
481 ATH10K_CAL_MODE_FILE,
486 static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode)
489 case ATH10K_CAL_MODE_FILE:
491 case ATH10K_CAL_MODE_OTP:
493 case ATH10K_CAL_MODE_DT:
500 enum ath10k_scan_state {
502 ATH10K_SCAN_STARTING,
504 ATH10K_SCAN_ABORTING,
507 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
510 case ATH10K_SCAN_IDLE:
512 case ATH10K_SCAN_STARTING:
514 case ATH10K_SCAN_RUNNING:
516 case ATH10K_SCAN_ABORTING:
523 enum ath10k_tx_pause_reason {
524 ATH10K_TX_PAUSE_Q_FULL,
529 struct ath_common ath_common;
530 struct ieee80211_hw *hw;
532 u8 mac_addr[ETH_ALEN];
534 enum ath10k_hw_rev hw_rev;
538 u32 fw_version_minor;
539 u16 fw_version_release;
540 u16 fw_version_build;
541 u32 fw_stats_req_mask;
548 /* protected by conf_mutex */
551 DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
557 const struct ath10k_hif_ops *ops;
560 struct completion target_suspend;
562 const struct ath10k_hw_regs *regs;
563 struct ath10k_bmi bmi;
564 struct ath10k_wmi wmi;
565 struct ath10k_htc htc;
566 struct ath10k_htt htt;
568 struct ath10k_hw_params {
574 /* This is true if given HW chip has a quirky Cycle Counter
575 * wraparound which resets to 0x7fffffff instead of 0. All
576 * other CC related counters (e.g. Rx Clear Count) are divided
577 * by 2 so they never wraparound themselves.
579 bool has_shifted_cc_wraparound;
581 struct ath10k_hw_params_fw {
587 size_t board_ext_size;
591 const struct firmware *board;
592 const void *board_data;
595 const struct firmware *otp;
596 const void *otp_data;
599 const struct firmware *firmware;
600 const void *firmware_data;
603 const struct firmware *cal_file;
605 char spec_board_id[100];
606 bool spec_board_loaded;
609 enum ath10k_cal_mode cal_mode;
612 struct completion started;
613 struct completion completed;
614 struct completion on_channel;
615 struct delayed_work timeout;
616 enum ath10k_scan_state state;
623 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
626 /* should never be NULL; needed for regular htt rx */
627 struct ieee80211_channel *rx_channel;
629 /* valid during scan; needed for mgmt rx during scan */
630 struct ieee80211_channel *scan_channel;
632 /* current operating channel definition */
633 struct cfg80211_chan_def chandef;
635 unsigned long long free_vdev_map;
636 struct ath10k_vif *monitor_arvif;
639 bool monitor_started;
640 unsigned int filter_flags;
641 unsigned long dev_flags;
642 u32 dfs_block_radar_events;
644 /* protected by conf_mutex */
646 int num_started_vdevs;
648 /* Protected by conf-mutex */
649 u8 supp_tx_chainmask;
650 u8 supp_rx_chainmask;
654 struct completion install_key_done;
656 struct completion vdev_setup_done;
658 struct workqueue_struct *workqueue;
660 /* prevents concurrent FW reconfiguration */
661 struct mutex conf_mutex;
663 /* protects shared structure data */
664 spinlock_t data_lock;
666 struct list_head arvifs;
667 struct list_head peers;
668 wait_queue_head_t peer_mapping_wq;
670 /* protected by conf_mutex */
675 int max_num_stations;
677 int max_num_tdls_vdevs;
679 struct work_struct offchan_tx_work;
680 struct sk_buff_head offchan_tx_queue;
681 struct completion offchan_tx_completed;
682 struct sk_buff *offchan_tx_skb;
684 struct work_struct wmi_mgmt_tx_work;
685 struct sk_buff_head wmi_mgmt_tx_queue;
687 enum ath10k_state state;
689 struct work_struct register_work;
690 struct work_struct restart_work;
692 /* cycle count is reported twice for each visited channel during scan.
693 * access protected by data_lock */
694 u32 survey_last_rx_clear_count;
695 u32 survey_last_cycle_count;
696 struct survey_info survey[ATH10K_NUM_CHANS];
698 /* Channel info events are expected to come in pairs without and with
699 * COMPLETE flag set respectively for each channel visit during scan.
701 * However there are deviations from this rule. This flag is used to
702 * avoid reporting garbage data.
704 bool ch_info_can_report_survey;
706 struct dfs_pattern_detector *dfs_detector;
708 unsigned long tx_paused; /* see ATH10K_TX_PAUSE_ */
710 #ifdef CONFIG_ATH10K_DEBUGFS
711 struct ath10k_debug debug;
715 /* relay(fs) channel for spectral scan */
716 struct rchan *rfs_chan_spec_scan;
718 /* spectral_mode and spec_config are protected by conf_mutex */
719 enum ath10k_spectral_mode mode;
720 struct ath10k_spec_scan config;
724 /* protected by conf_mutex */
725 const struct firmware *utf;
726 DECLARE_BITMAP(orig_fw_features, ATH10K_FW_FEATURE_COUNT);
727 enum ath10k_fw_wmi_op_version orig_wmi_op_version;
729 /* protected by data_lock */
734 /* protected by data_lock */
735 u32 fw_crash_counter;
736 u32 fw_warm_reset_counter;
737 u32 fw_cold_reset_counter;
740 struct ath10k_thermal thermal;
741 struct ath10k_wow wow;
744 u8 drv_priv[0] __aligned(sizeof(void *));
747 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
749 enum ath10k_hw_rev hw_rev,
750 const struct ath10k_hif_ops *hif_ops);
751 void ath10k_core_destroy(struct ath10k *ar);
753 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode);
754 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
755 void ath10k_core_stop(struct ath10k *ar);
756 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
757 void ath10k_core_unregister(struct ath10k *ar);
759 #endif /* _CORE_H_ */