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"
41 #define MS(_v, _f) (((_v) & _f##_MASK) >> _f##_LSB)
42 #define SM(_v, _f) (((_v) << _f##_LSB) & _f##_MASK)
43 #define WO(_f) ((_f##_OFFSET) >> 2)
45 #define ATH10K_SCAN_ID 0
46 #define WMI_READY_TIMEOUT (5 * HZ)
47 #define ATH10K_FLUSH_TIMEOUT_HZ (5*HZ)
48 #define ATH10K_CONNECTION_LOSS_HZ (3*HZ)
49 #define ATH10K_NUM_CHANS 39
51 /* Antenna noise floor */
52 #define ATH10K_DEFAULT_NOISE_FLOOR -95
54 #define ATH10K_MAX_NUM_MGMT_PENDING 128
56 /* number of failed packets (20 packets with 16 sw reties each) */
57 #define ATH10K_KICKOUT_THRESHOLD (20 * 16)
60 * Use insanely high numbers to make sure that the firmware implementation
61 * won't start, we have the same functionality already in hostapd. Unit
64 #define ATH10K_KEEPALIVE_MIN_IDLE 3747
65 #define ATH10K_KEEPALIVE_MAX_IDLE 3895
66 #define ATH10K_KEEPALIVE_MAX_UNRESPONSIVE 3900
75 static inline const char *ath10k_bus_str(enum ath10k_bus bus)
87 enum ath10k_skb_flags {
88 ATH10K_SKB_F_NO_HWCRYPT = BIT(0),
89 ATH10K_SKB_F_DTIM_ZERO = BIT(1),
90 ATH10K_SKB_F_DELIVER_CAB = BIT(2),
91 ATH10K_SKB_F_MGMT = BIT(3),
92 ATH10K_SKB_F_QOS = BIT(4),
95 struct ath10k_skb_cb {
100 struct ieee80211_vif *vif;
101 struct ieee80211_txq *txq;
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;
152 const struct wmi_peer_flags_map *peer_flags;
156 struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS];
159 struct ath10k_fw_stats_peer {
160 struct list_head list;
162 u8 peer_macaddr[ETH_ALEN];
165 u32 peer_rx_rate; /* 10x only */
169 struct ath10k_fw_stats_vdev {
170 struct list_head list;
175 u32 num_tx_frames[4];
177 u32 num_tx_frames_retries[4];
178 u32 num_tx_frames_failures[4];
183 u32 num_tx_not_acked;
184 u32 tx_rate_history[10];
185 u32 beacon_rssi_history[10];
188 struct ath10k_fw_stats_pdev {
189 struct list_head list;
223 u32 sw_retry_failure;
224 u32 illgl_rate_phy_err;
225 u32 pdev_cont_xretry;
231 u32 seq_failed_queueing;
238 u32 mpdus_ack_failed;
242 s32 mid_ppdu_route_change;
259 struct ath10k_fw_stats {
260 struct list_head pdevs;
261 struct list_head vdevs;
262 struct list_head peers;
265 #define ATH10K_TPC_TABLE_TYPE_FLAG 1
266 #define ATH10K_TPC_PREAM_TABLE_END 0xFFFF
268 struct ath10k_tpc_table {
269 u32 pream_idx[WMI_TPC_RATE_MAX];
270 u8 rate_code[WMI_TPC_RATE_MAX];
271 char tpc_value[WMI_TPC_RATE_MAX][WMI_TPC_TX_N_CHAIN * WMI_TPC_BUF_SIZE];
274 struct ath10k_tpc_stats {
278 u32 twice_antenna_reduction;
279 u32 twice_max_rd_power;
280 s32 twice_antenna_gain;
285 u8 flag[WMI_TPC_FLAG];
286 struct ath10k_tpc_table tpc_table[WMI_TPC_FLAG];
289 struct ath10k_dfs_stats {
293 u32 pulses_discarded;
297 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
300 struct list_head list;
301 struct ieee80211_vif *vif;
302 struct ieee80211_sta *sta;
306 DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS);
308 /* protected by ar->data_lock */
309 struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
313 struct list_head list;
314 unsigned long num_fw_queued;
315 unsigned long num_push_allowed;
319 struct ath10k_vif *arvif;
321 /* the following are protected by ar->data_lock */
322 u32 changed; /* IEEE80211_RC_* */
328 struct work_struct update_wk;
330 #ifdef CONFIG_MAC80211_DEBUGFS
331 /* protected by conf_mutex */
337 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5*HZ)
339 enum ath10k_beacon_state {
340 ATH10K_BEACON_SCHEDULED = 0,
341 ATH10K_BEACON_SENDING,
346 struct list_head list;
350 enum wmi_vdev_type vdev_type;
351 enum wmi_vdev_subtype vdev_subtype;
354 struct sk_buff *beacon;
355 /* protected by data_lock */
356 enum ath10k_beacon_state beacon_state;
358 dma_addr_t beacon_paddr;
359 unsigned long tx_paused; /* arbitrary values defined by target */
362 struct ieee80211_vif *vif;
366 bool spectral_enabled;
371 struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
385 u8 ssid[IEEE80211_MAX_SSID_LEN];
387 /* P2P_IE with NoA attribute for P2P_GO case */
395 int num_legacy_stations;
397 struct wmi_wmm_params_all_arg wmm_params;
398 struct work_struct ap_csa_work;
399 struct delayed_work connection_loss_work;
400 struct cfg80211_bitrate_mask bitrate_mask;
403 struct ath10k_vif_iter {
405 struct ath10k_vif *arvif;
408 /* used for crash-dump storage, protected by data-lock */
409 struct ath10k_fw_crash_data {
410 bool crashed_since_read;
413 struct timespec timestamp;
414 __le32 registers[REG_DUMP_COUNT_QCA988X];
417 struct ath10k_debug {
418 struct dentry *debugfs_phy;
420 struct ath10k_fw_stats fw_stats;
421 struct completion fw_stats_complete;
424 unsigned long htt_stats_mask;
425 struct delayed_work htt_stats_dwork;
426 struct ath10k_dfs_stats dfs_stats;
427 struct ath_dfs_pool_stats dfs_pool_stats;
429 /* used for tpc-dump storage, protected by data-lock */
430 struct ath10k_tpc_stats *tpc_stats;
432 struct completion tpc_complete;
434 /* protected by conf_mutex */
441 struct ath10k_fw_crash_data *fw_crash_data;
445 ATH10K_STATE_OFF = 0,
448 /* When doing firmware recovery the device is first powered down.
449 * mac80211 is supposed to call in to start() hook later on. It is
450 * however possible that driver unloading and firmware crash overlap.
451 * mac80211 can wait on conf_mutex in stop() while the device is
452 * stopped in ath10k_core_restart() work holding conf_mutex. The state
453 * RESTARTED means that the device is up and mac80211 has started hw
454 * reconfiguration. Once mac80211 is done with the reconfiguration we
455 * set the state to STATE_ON in reconfig_complete(). */
456 ATH10K_STATE_RESTARTING,
457 ATH10K_STATE_RESTARTED,
459 /* The device has crashed while restarting hw. This state is like ON
460 * but commands are blocked in HTC and -ECOMM response is given. This
461 * prevents completion timeouts and makes the driver more responsive to
462 * userspace commands. This is also prevents recursive recovery. */
469 enum ath10k_firmware_mode {
470 /* the default mode, standard 802.11 functionality */
471 ATH10K_FIRMWARE_MODE_NORMAL,
473 /* factory tests etc */
474 ATH10K_FIRMWARE_MODE_UTF,
477 enum ath10k_fw_features {
478 /* wmi_mgmt_rx_hdr contains extra RSSI information */
479 ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,
481 /* Firmware from 10X branch. Deprecated, don't use in new code. */
482 ATH10K_FW_FEATURE_WMI_10X = 1,
484 /* firmware support tx frame management over WMI, otherwise it's HTT */
485 ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,
487 /* Firmware does not support P2P */
488 ATH10K_FW_FEATURE_NO_P2P = 3,
490 /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature
491 * bit is required to be set as well. Deprecated, don't use in new
494 ATH10K_FW_FEATURE_WMI_10_2 = 4,
496 /* Some firmware revisions lack proper multi-interface client powersave
497 * implementation. Enabling PS could result in connection drops,
498 * traffic stalls, etc.
500 ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT = 5,
502 /* Some firmware revisions have an incomplete WoWLAN implementation
503 * despite WMI service bit being advertised. This feature flag is used
504 * to distinguish whether WoWLAN is really supported or not.
506 ATH10K_FW_FEATURE_WOWLAN_SUPPORT = 6,
508 /* Don't trust error code from otp.bin */
509 ATH10K_FW_FEATURE_IGNORE_OTP_RESULT = 7,
511 /* Some firmware revisions pad 4th hw address to 4 byte boundary making
512 * it 8 bytes long in Native Wifi Rx decap.
514 ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING = 8,
516 /* Firmware supports bypassing PLL setting on init. */
517 ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT = 9,
519 /* Raw mode support. If supported, FW supports receiving and trasmitting
520 * frames in raw mode.
522 ATH10K_FW_FEATURE_RAW_MODE_SUPPORT = 10,
524 /* Firmware Supports Adaptive CCA*/
525 ATH10K_FW_FEATURE_SUPPORTS_ADAPTIVE_CCA = 11,
527 /* Firmware supports management frame protection */
528 ATH10K_FW_FEATURE_MFP_SUPPORT = 12,
530 /* Firmware supports pull-push model where host shares it's software
531 * queue state with firmware and firmware generates fetch requests
532 * telling host which queues to dequeue tx from.
534 * Primary function of this is improved MU-MIMO performance with
537 ATH10K_FW_FEATURE_PEER_FLOW_CONTROL = 13,
540 ATH10K_FW_FEATURE_COUNT,
543 enum ath10k_dev_flags {
544 /* Indicates that ath10k device is during CAC phase of DFS */
546 ATH10K_FLAG_CORE_REGISTERED,
548 /* Device has crashed and needs to restart. This indicates any pending
549 * waiters should immediately cancel instead of waiting for a time out.
551 ATH10K_FLAG_CRASH_FLUSH,
553 /* Use Raw mode instead of native WiFi Tx/Rx encap mode.
554 * Raw mode supports both hardware and software crypto. Native WiFi only
555 * supports hardware crypto.
557 ATH10K_FLAG_RAW_MODE,
559 /* Disable HW crypto engine */
560 ATH10K_FLAG_HW_CRYPTO_DISABLED,
562 /* Bluetooth coexistance enabled */
565 /* Per Station statistics service */
566 ATH10K_FLAG_PEER_STATS,
569 enum ath10k_cal_mode {
570 ATH10K_CAL_MODE_FILE,
573 ATH10K_PRE_CAL_MODE_FILE,
574 ATH10K_PRE_CAL_MODE_DT,
577 enum ath10k_crypt_mode {
578 /* Only use hardware crypto engine */
579 ATH10K_CRYPT_MODE_HW,
580 /* Only use software crypto engine */
581 ATH10K_CRYPT_MODE_SW,
584 static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode)
587 case ATH10K_CAL_MODE_FILE:
589 case ATH10K_CAL_MODE_OTP:
591 case ATH10K_CAL_MODE_DT:
593 case ATH10K_PRE_CAL_MODE_FILE:
594 return "pre-cal-file";
595 case ATH10K_PRE_CAL_MODE_DT:
602 enum ath10k_scan_state {
604 ATH10K_SCAN_STARTING,
606 ATH10K_SCAN_ABORTING,
609 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
612 case ATH10K_SCAN_IDLE:
614 case ATH10K_SCAN_STARTING:
616 case ATH10K_SCAN_RUNNING:
618 case ATH10K_SCAN_ABORTING:
625 enum ath10k_tx_pause_reason {
626 ATH10K_TX_PAUSE_Q_FULL,
631 struct ath_common ath_common;
632 struct ieee80211_hw *hw;
634 u8 mac_addr[ETH_ALEN];
636 enum ath10k_hw_rev hw_rev;
641 u32 fw_version_minor;
642 u16 fw_version_release;
643 u16 fw_version_build;
644 u32 fw_stats_req_mask;
651 u32 max_spatial_stream;
652 /* protected by conf_mutex */
655 DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
661 const struct ath10k_hif_ops *ops;
664 struct completion target_suspend;
666 const struct ath10k_hw_regs *regs;
667 const struct ath10k_hw_values *hw_values;
668 struct ath10k_bmi bmi;
669 struct ath10k_wmi wmi;
670 struct ath10k_htc htc;
671 struct ath10k_htt htt;
673 struct ath10k_hw_params {
681 /* This is true if given HW chip has a quirky Cycle Counter
682 * wraparound which resets to 0x7fffffff instead of 0. All
683 * other CC related counters (e.g. Rx Clear Count) are divided
684 * by 2 so they never wraparound themselves.
686 bool has_shifted_cc_wraparound;
688 /* Some of chip expects fragment descriptor to be continuous
689 * memory for any TX operation. Set continuous_frag_desc flag
690 * for the hardware which have such requirement.
692 bool continuous_frag_desc;
694 u32 channel_counters_freq_hz;
696 /* Mgmt tx descriptors threshold for limiting probe response
699 u32 max_probe_resp_desc_thres;
701 /* The padding bytes's location is different on various chips */
702 enum ath10k_hw_4addr_pad hw_4addr_pad;
706 u32 max_spatial_stream;
709 struct ath10k_hw_params_fw {
715 size_t board_ext_size;
719 const struct firmware *board;
720 const void *board_data;
723 const struct firmware *otp;
724 const void *otp_data;
727 const struct firmware *firmware;
728 const void *firmware_data;
731 const struct firmware *pre_cal_file;
732 const struct firmware *cal_file;
735 const void *firmware_codeswap_data;
736 size_t firmware_codeswap_len;
737 struct ath10k_swap_code_seg_info *firmware_swap_code_seg_info;
743 u32 subsystem_vendor;
744 u32 subsystem_device;
753 enum ath10k_cal_mode cal_mode;
756 struct completion started;
757 struct completion completed;
758 struct completion on_channel;
759 struct delayed_work timeout;
760 enum ath10k_scan_state state;
768 struct ieee80211_supported_band sbands[NUM_NL80211_BANDS];
771 /* should never be NULL; needed for regular htt rx */
772 struct ieee80211_channel *rx_channel;
774 /* valid during scan; needed for mgmt rx during scan */
775 struct ieee80211_channel *scan_channel;
777 /* current operating channel definition */
778 struct cfg80211_chan_def chandef;
780 /* currently configured operating channel in firmware */
781 struct ieee80211_channel *tgt_oper_chan;
783 unsigned long long free_vdev_map;
784 struct ath10k_vif *monitor_arvif;
787 bool monitor_started;
788 unsigned int filter_flags;
789 unsigned long dev_flags;
790 bool dfs_block_radar_events;
792 /* protected by conf_mutex */
794 int num_started_vdevs;
796 /* Protected by conf-mutex */
800 struct completion install_key_done;
802 struct completion vdev_setup_done;
804 struct workqueue_struct *workqueue;
805 /* Auxiliary workqueue */
806 struct workqueue_struct *workqueue_aux;
808 /* prevents concurrent FW reconfiguration */
809 struct mutex conf_mutex;
811 /* protects shared structure data */
812 spinlock_t data_lock;
813 /* protects: ar->txqs, artxq->list */
814 spinlock_t txqs_lock;
816 struct list_head txqs;
817 struct list_head arvifs;
818 struct list_head peers;
819 struct ath10k_peer *peer_map[ATH10K_MAX_NUM_PEER_IDS];
820 wait_queue_head_t peer_mapping_wq;
822 /* protected by conf_mutex */
827 int max_num_stations;
829 int max_num_tdls_vdevs;
830 int num_active_peers;
833 struct work_struct svc_rdy_work;
834 struct sk_buff *svc_rdy_skb;
836 struct work_struct offchan_tx_work;
837 struct sk_buff_head offchan_tx_queue;
838 struct completion offchan_tx_completed;
839 struct sk_buff *offchan_tx_skb;
841 struct work_struct wmi_mgmt_tx_work;
842 struct sk_buff_head wmi_mgmt_tx_queue;
844 enum ath10k_state state;
846 struct work_struct register_work;
847 struct work_struct restart_work;
849 /* cycle count is reported twice for each visited channel during scan.
850 * access protected by data_lock */
851 u32 survey_last_rx_clear_count;
852 u32 survey_last_cycle_count;
853 struct survey_info survey[ATH10K_NUM_CHANS];
855 /* Channel info events are expected to come in pairs without and with
856 * COMPLETE flag set respectively for each channel visit during scan.
858 * However there are deviations from this rule. This flag is used to
859 * avoid reporting garbage data.
861 bool ch_info_can_report_survey;
863 struct dfs_pattern_detector *dfs_detector;
865 unsigned long tx_paused; /* see ATH10K_TX_PAUSE_ */
867 #ifdef CONFIG_ATH10K_DEBUGFS
868 struct ath10k_debug debug;
872 /* relay(fs) channel for spectral scan */
873 struct rchan *rfs_chan_spec_scan;
875 /* spectral_mode and spec_config are protected by conf_mutex */
876 enum ath10k_spectral_mode mode;
877 struct ath10k_spec_scan config;
881 /* protected by conf_mutex */
882 const struct firmware *utf;
883 char utf_version[32];
884 const void *utf_firmware_data;
885 size_t utf_firmware_len;
886 DECLARE_BITMAP(orig_fw_features, ATH10K_FW_FEATURE_COUNT);
887 enum ath10k_fw_wmi_op_version orig_wmi_op_version;
888 enum ath10k_fw_wmi_op_version op_version;
889 /* protected by data_lock */
894 /* protected by data_lock */
895 u32 fw_crash_counter;
896 u32 fw_warm_reset_counter;
897 u32 fw_cold_reset_counter;
900 struct ath10k_thermal thermal;
901 struct ath10k_wow wow;
904 u8 drv_priv[0] __aligned(sizeof(void *));
907 static inline bool ath10k_peer_stats_enabled(struct ath10k *ar)
909 if (test_bit(ATH10K_FLAG_PEER_STATS, &ar->dev_flags) &&
910 test_bit(WMI_SERVICE_PEER_STATS, ar->wmi.svc_map))
916 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
918 enum ath10k_hw_rev hw_rev,
919 const struct ath10k_hif_ops *hif_ops);
920 void ath10k_core_destroy(struct ath10k *ar);
921 void ath10k_core_get_fw_features_str(struct ath10k *ar,
925 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode);
926 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
927 void ath10k_core_stop(struct ath10k *ar);
928 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
929 void ath10k_core_unregister(struct ath10k *ar);
931 #endif /* _CORE_H_ */