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
68 /* NAPI poll budget */
69 #define ATH10K_NAPI_BUDGET 64
70 #define ATH10K_NAPI_QUOTA_LIMIT 60
79 static inline const char *ath10k_bus_str(enum ath10k_bus bus)
91 enum ath10k_skb_flags {
92 ATH10K_SKB_F_NO_HWCRYPT = BIT(0),
93 ATH10K_SKB_F_DTIM_ZERO = BIT(1),
94 ATH10K_SKB_F_DELIVER_CAB = BIT(2),
95 ATH10K_SKB_F_MGMT = BIT(3),
96 ATH10K_SKB_F_QOS = BIT(4),
99 struct ath10k_skb_cb {
104 struct ieee80211_vif *vif;
105 struct ieee80211_txq *txq;
108 struct ath10k_skb_rxcb {
110 struct hlist_node hlist;
113 static inline struct ath10k_skb_cb *ATH10K_SKB_CB(struct sk_buff *skb)
115 BUILD_BUG_ON(sizeof(struct ath10k_skb_cb) >
116 IEEE80211_TX_INFO_DRIVER_DATA_SIZE);
117 return (struct ath10k_skb_cb *)&IEEE80211_SKB_CB(skb)->driver_data;
120 static inline struct ath10k_skb_rxcb *ATH10K_SKB_RXCB(struct sk_buff *skb)
122 BUILD_BUG_ON(sizeof(struct ath10k_skb_rxcb) > sizeof(skb->cb));
123 return (struct ath10k_skb_rxcb *)skb->cb;
126 #define ATH10K_RXCB_SKB(rxcb) \
127 container_of((void *)rxcb, struct sk_buff, cb)
129 static inline u32 host_interest_item_address(u32 item_offset)
131 return QCA988X_HOST_INTEREST_ADDRESS + item_offset;
138 struct ath10k_mem_chunk {
146 enum ath10k_htc_ep_id eid;
147 struct completion service_ready;
148 struct completion unified_ready;
149 struct completion barrier;
150 wait_queue_head_t tx_credits_wq;
151 DECLARE_BITMAP(svc_map, WMI_SERVICE_MAX);
152 struct wmi_cmd_map *cmd;
153 struct wmi_vdev_param_map *vdev_param;
154 struct wmi_pdev_param_map *pdev_param;
155 const struct wmi_ops *ops;
156 const struct wmi_peer_flags_map *peer_flags;
160 struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS];
163 struct ath10k_fw_stats_peer {
164 struct list_head list;
166 u8 peer_macaddr[ETH_ALEN];
169 u32 peer_rx_rate; /* 10x only */
173 struct ath10k_fw_extd_stats_peer {
174 struct list_head list;
176 u8 peer_macaddr[ETH_ALEN];
180 struct ath10k_fw_stats_vdev {
181 struct list_head list;
186 u32 num_tx_frames[4];
188 u32 num_tx_frames_retries[4];
189 u32 num_tx_frames_failures[4];
194 u32 num_tx_not_acked;
195 u32 tx_rate_history[10];
196 u32 beacon_rssi_history[10];
199 struct ath10k_fw_stats_pdev {
200 struct list_head list;
204 u32 tx_frame_count; /* Cycles spent transmitting frames */
205 u32 rx_frame_count; /* Cycles spent receiving frames */
206 u32 rx_clear_count; /* Total channel busy time, evidently */
207 u32 cycle_count; /* Total on-channel time */
234 u32 sw_retry_failure;
235 u32 illgl_rate_phy_err;
236 u32 pdev_cont_xretry;
242 u32 seq_failed_queueing;
249 u32 mpdus_ack_failed;
253 s32 mid_ppdu_route_change;
270 struct ath10k_fw_stats {
272 struct list_head pdevs;
273 struct list_head vdevs;
274 struct list_head peers;
275 struct list_head peers_extd;
278 #define ATH10K_TPC_TABLE_TYPE_FLAG 1
279 #define ATH10K_TPC_PREAM_TABLE_END 0xFFFF
281 struct ath10k_tpc_table {
282 u32 pream_idx[WMI_TPC_RATE_MAX];
283 u8 rate_code[WMI_TPC_RATE_MAX];
284 char tpc_value[WMI_TPC_RATE_MAX][WMI_TPC_TX_N_CHAIN * WMI_TPC_BUF_SIZE];
287 struct ath10k_tpc_stats {
291 u32 twice_antenna_reduction;
292 u32 twice_max_rd_power;
293 s32 twice_antenna_gain;
298 u8 flag[WMI_TPC_FLAG];
299 struct ath10k_tpc_table tpc_table[WMI_TPC_FLAG];
302 struct ath10k_dfs_stats {
306 u32 pulses_discarded;
310 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
313 struct list_head list;
314 struct ieee80211_vif *vif;
315 struct ieee80211_sta *sta;
319 DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS);
321 /* protected by ar->data_lock */
322 struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
326 struct list_head list;
327 unsigned long num_fw_queued;
328 unsigned long num_push_allowed;
332 struct ath10k_vif *arvif;
334 /* the following are protected by ar->data_lock */
335 u32 changed; /* IEEE80211_RC_* */
341 struct work_struct update_wk;
343 #ifdef CONFIG_MAC80211_DEBUGFS
344 /* protected by conf_mutex */
350 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5 * HZ)
352 enum ath10k_beacon_state {
353 ATH10K_BEACON_SCHEDULED = 0,
354 ATH10K_BEACON_SENDING,
359 struct list_head list;
363 enum wmi_vdev_type vdev_type;
364 enum wmi_vdev_subtype vdev_subtype;
367 struct sk_buff *beacon;
368 /* protected by data_lock */
369 enum ath10k_beacon_state beacon_state;
371 dma_addr_t beacon_paddr;
372 unsigned long tx_paused; /* arbitrary values defined by target */
375 struct ieee80211_vif *vif;
379 bool spectral_enabled;
384 struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
398 u8 ssid[IEEE80211_MAX_SSID_LEN];
400 /* P2P_IE with NoA attribute for P2P_GO case */
408 int num_legacy_stations;
410 struct wmi_wmm_params_all_arg wmm_params;
411 struct work_struct ap_csa_work;
412 struct delayed_work connection_loss_work;
413 struct cfg80211_bitrate_mask bitrate_mask;
416 struct ath10k_vif_iter {
418 struct ath10k_vif *arvif;
421 /* used for crash-dump storage, protected by data-lock */
422 struct ath10k_fw_crash_data {
423 bool crashed_since_read;
426 struct timespec timestamp;
427 __le32 registers[REG_DUMP_COUNT_QCA988X];
430 struct ath10k_debug {
431 struct dentry *debugfs_phy;
433 struct ath10k_fw_stats fw_stats;
434 struct completion fw_stats_complete;
437 unsigned long htt_stats_mask;
438 struct delayed_work htt_stats_dwork;
439 struct ath10k_dfs_stats dfs_stats;
440 struct ath_dfs_pool_stats dfs_pool_stats;
442 /* used for tpc-dump storage, protected by data-lock */
443 struct ath10k_tpc_stats *tpc_stats;
445 struct completion tpc_complete;
447 /* protected by conf_mutex */
454 struct ath10k_fw_crash_data *fw_crash_data;
458 ATH10K_STATE_OFF = 0,
461 /* When doing firmware recovery the device is first powered down.
462 * mac80211 is supposed to call in to start() hook later on. It is
463 * however possible that driver unloading and firmware crash overlap.
464 * mac80211 can wait on conf_mutex in stop() while the device is
465 * stopped in ath10k_core_restart() work holding conf_mutex. The state
466 * RESTARTED means that the device is up and mac80211 has started hw
467 * reconfiguration. Once mac80211 is done with the reconfiguration we
468 * set the state to STATE_ON in reconfig_complete(). */
469 ATH10K_STATE_RESTARTING,
470 ATH10K_STATE_RESTARTED,
472 /* The device has crashed while restarting hw. This state is like ON
473 * but commands are blocked in HTC and -ECOMM response is given. This
474 * prevents completion timeouts and makes the driver more responsive to
475 * userspace commands. This is also prevents recursive recovery. */
482 enum ath10k_firmware_mode {
483 /* the default mode, standard 802.11 functionality */
484 ATH10K_FIRMWARE_MODE_NORMAL,
486 /* factory tests etc */
487 ATH10K_FIRMWARE_MODE_UTF,
490 enum ath10k_fw_features {
491 /* wmi_mgmt_rx_hdr contains extra RSSI information */
492 ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,
494 /* Firmware from 10X branch. Deprecated, don't use in new code. */
495 ATH10K_FW_FEATURE_WMI_10X = 1,
497 /* firmware support tx frame management over WMI, otherwise it's HTT */
498 ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,
500 /* Firmware does not support P2P */
501 ATH10K_FW_FEATURE_NO_P2P = 3,
503 /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature
504 * bit is required to be set as well. Deprecated, don't use in new
507 ATH10K_FW_FEATURE_WMI_10_2 = 4,
509 /* Some firmware revisions lack proper multi-interface client powersave
510 * implementation. Enabling PS could result in connection drops,
511 * traffic stalls, etc.
513 ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT = 5,
515 /* Some firmware revisions have an incomplete WoWLAN implementation
516 * despite WMI service bit being advertised. This feature flag is used
517 * to distinguish whether WoWLAN is really supported or not.
519 ATH10K_FW_FEATURE_WOWLAN_SUPPORT = 6,
521 /* Don't trust error code from otp.bin */
522 ATH10K_FW_FEATURE_IGNORE_OTP_RESULT = 7,
524 /* Some firmware revisions pad 4th hw address to 4 byte boundary making
525 * it 8 bytes long in Native Wifi Rx decap.
527 ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING = 8,
529 /* Firmware supports bypassing PLL setting on init. */
530 ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT = 9,
532 /* Raw mode support. If supported, FW supports receiving and trasmitting
533 * frames in raw mode.
535 ATH10K_FW_FEATURE_RAW_MODE_SUPPORT = 10,
537 /* Firmware Supports Adaptive CCA*/
538 ATH10K_FW_FEATURE_SUPPORTS_ADAPTIVE_CCA = 11,
540 /* Firmware supports management frame protection */
541 ATH10K_FW_FEATURE_MFP_SUPPORT = 12,
543 /* Firmware supports pull-push model where host shares it's software
544 * queue state with firmware and firmware generates fetch requests
545 * telling host which queues to dequeue tx from.
547 * Primary function of this is improved MU-MIMO performance with
550 ATH10K_FW_FEATURE_PEER_FLOW_CONTROL = 13,
552 /* Firmware supports BT-Coex without reloading firmware via pdev param.
553 * To support Bluetooth coexistence pdev param, WMI_COEX_GPIO_SUPPORT of
554 * extended resource config should be enabled always. This firmware IE
555 * is used to configure WMI_COEX_GPIO_SUPPORT.
557 ATH10K_FW_FEATURE_BTCOEX_PARAM = 14,
559 /* Older firmware with HTT delivers incorrect tx status for null func
560 * frames to driver, but this fixed in 10.2 and 10.4 firmware versions.
561 * Also this workaround results in reporting of incorrect null func
562 * status for 10.4. This flag is used to skip the workaround.
564 ATH10K_FW_FEATURE_SKIP_NULL_FUNC_WAR = 15,
567 ATH10K_FW_FEATURE_COUNT,
570 enum ath10k_dev_flags {
571 /* Indicates that ath10k device is during CAC phase of DFS */
573 ATH10K_FLAG_CORE_REGISTERED,
575 /* Device has crashed and needs to restart. This indicates any pending
576 * waiters should immediately cancel instead of waiting for a time out.
578 ATH10K_FLAG_CRASH_FLUSH,
580 /* Use Raw mode instead of native WiFi Tx/Rx encap mode.
581 * Raw mode supports both hardware and software crypto. Native WiFi only
582 * supports hardware crypto.
584 ATH10K_FLAG_RAW_MODE,
586 /* Disable HW crypto engine */
587 ATH10K_FLAG_HW_CRYPTO_DISABLED,
589 /* Bluetooth coexistance enabled */
592 /* Per Station statistics service */
593 ATH10K_FLAG_PEER_STATS,
596 enum ath10k_cal_mode {
597 ATH10K_CAL_MODE_FILE,
600 ATH10K_PRE_CAL_MODE_FILE,
601 ATH10K_PRE_CAL_MODE_DT,
602 ATH10K_CAL_MODE_EEPROM,
605 enum ath10k_crypt_mode {
606 /* Only use hardware crypto engine */
607 ATH10K_CRYPT_MODE_HW,
608 /* Only use software crypto engine */
609 ATH10K_CRYPT_MODE_SW,
612 static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode)
615 case ATH10K_CAL_MODE_FILE:
617 case ATH10K_CAL_MODE_OTP:
619 case ATH10K_CAL_MODE_DT:
621 case ATH10K_PRE_CAL_MODE_FILE:
622 return "pre-cal-file";
623 case ATH10K_PRE_CAL_MODE_DT:
625 case ATH10K_CAL_MODE_EEPROM:
632 enum ath10k_scan_state {
634 ATH10K_SCAN_STARTING,
636 ATH10K_SCAN_ABORTING,
639 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
642 case ATH10K_SCAN_IDLE:
644 case ATH10K_SCAN_STARTING:
646 case ATH10K_SCAN_RUNNING:
648 case ATH10K_SCAN_ABORTING:
655 enum ath10k_tx_pause_reason {
656 ATH10K_TX_PAUSE_Q_FULL,
660 struct ath10k_fw_file {
661 const struct firmware *firmware;
663 char fw_version[ETHTOOL_FWVERS_LEN];
665 DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
667 enum ath10k_fw_wmi_op_version wmi_op_version;
668 enum ath10k_fw_htt_op_version htt_op_version;
670 const void *firmware_data;
673 const void *otp_data;
676 const void *codeswap_data;
679 /* The original idea of struct ath10k_fw_file was that it only
680 * contains struct firmware and pointers to various parts (actual
681 * firmware binary, otp, metadata etc) of the file. This seg_info
682 * is actually created separate but as this is used similarly as
683 * the other firmware components it's more convenient to have it
686 struct ath10k_swap_code_seg_info *firmware_swap_code_seg_info;
689 struct ath10k_fw_components {
690 const struct firmware *board;
691 const void *board_data;
694 struct ath10k_fw_file fw_file;
698 struct ath_common ath_common;
699 struct ieee80211_hw *hw;
700 struct ieee80211_ops *ops;
702 u8 mac_addr[ETH_ALEN];
704 enum ath10k_hw_rev hw_rev;
709 u32 fw_version_minor;
710 u16 fw_version_release;
711 u16 fw_version_build;
712 u32 fw_stats_req_mask;
719 u32 max_spatial_stream;
720 /* protected by conf_mutex */
727 const struct ath10k_hif_ops *ops;
730 struct completion target_suspend;
732 const struct ath10k_hw_regs *regs;
733 const struct ath10k_hw_values *hw_values;
734 struct ath10k_bmi bmi;
735 struct ath10k_wmi wmi;
736 struct ath10k_htc htc;
737 struct ath10k_htt htt;
739 struct ath10k_hw_params hw_params;
741 /* contains the firmware images used with ATH10K_FIRMWARE_MODE_NORMAL */
742 struct ath10k_fw_components normal_mode_fw;
744 /* READ-ONLY images of the running firmware, which can be either
745 * normal or UTF. Do not modify, release etc!
747 const struct ath10k_fw_components *running_fw;
749 const struct firmware *pre_cal_file;
750 const struct firmware *cal_file;
755 u32 subsystem_vendor;
756 u32 subsystem_device;
765 enum ath10k_cal_mode cal_mode;
768 struct completion started;
769 struct completion completed;
770 struct completion on_channel;
771 struct delayed_work timeout;
772 enum ath10k_scan_state state;
780 struct ieee80211_supported_band sbands[NUM_NL80211_BANDS];
783 /* should never be NULL; needed for regular htt rx */
784 struct ieee80211_channel *rx_channel;
786 /* valid during scan; needed for mgmt rx during scan */
787 struct ieee80211_channel *scan_channel;
789 /* current operating channel definition */
790 struct cfg80211_chan_def chandef;
792 /* currently configured operating channel in firmware */
793 struct ieee80211_channel *tgt_oper_chan;
795 unsigned long long free_vdev_map;
796 struct ath10k_vif *monitor_arvif;
799 bool monitor_started;
800 unsigned int filter_flags;
801 unsigned long dev_flags;
802 bool dfs_block_radar_events;
804 /* protected by conf_mutex */
806 int num_started_vdevs;
808 /* Protected by conf-mutex */
812 struct completion install_key_done;
814 struct completion vdev_setup_done;
816 struct workqueue_struct *workqueue;
817 /* Auxiliary workqueue */
818 struct workqueue_struct *workqueue_aux;
820 /* prevents concurrent FW reconfiguration */
821 struct mutex conf_mutex;
823 /* protects shared structure data */
824 spinlock_t data_lock;
825 /* protects: ar->txqs, artxq->list */
826 spinlock_t txqs_lock;
828 struct list_head txqs;
829 struct list_head arvifs;
830 struct list_head peers;
831 struct ath10k_peer *peer_map[ATH10K_MAX_NUM_PEER_IDS];
832 wait_queue_head_t peer_mapping_wq;
834 /* protected by conf_mutex */
839 int max_num_stations;
841 int max_num_tdls_vdevs;
842 int num_active_peers;
845 struct work_struct svc_rdy_work;
846 struct sk_buff *svc_rdy_skb;
848 struct work_struct offchan_tx_work;
849 struct sk_buff_head offchan_tx_queue;
850 struct completion offchan_tx_completed;
851 struct sk_buff *offchan_tx_skb;
853 struct work_struct wmi_mgmt_tx_work;
854 struct sk_buff_head wmi_mgmt_tx_queue;
856 enum ath10k_state state;
858 struct work_struct register_work;
859 struct work_struct restart_work;
861 /* cycle count is reported twice for each visited channel during scan.
862 * access protected by data_lock */
863 u32 survey_last_rx_clear_count;
864 u32 survey_last_cycle_count;
865 struct survey_info survey[ATH10K_NUM_CHANS];
867 /* Channel info events are expected to come in pairs without and with
868 * COMPLETE flag set respectively for each channel visit during scan.
870 * However there are deviations from this rule. This flag is used to
871 * avoid reporting garbage data.
873 bool ch_info_can_report_survey;
874 struct completion bss_survey_done;
876 struct dfs_pattern_detector *dfs_detector;
878 unsigned long tx_paused; /* see ATH10K_TX_PAUSE_ */
880 #ifdef CONFIG_ATH10K_DEBUGFS
881 struct ath10k_debug debug;
883 /* relay(fs) channel for spectral scan */
884 struct rchan *rfs_chan_spec_scan;
886 /* spectral_mode and spec_config are protected by conf_mutex */
887 enum ath10k_spectral_mode mode;
888 struct ath10k_spec_scan config;
893 /* protected by conf_mutex */
894 struct ath10k_fw_components utf_mode_fw;
896 /* protected by data_lock */
901 /* protected by data_lock */
902 u32 fw_crash_counter;
903 u32 fw_warm_reset_counter;
904 u32 fw_cold_reset_counter;
907 struct ath10k_thermal thermal;
908 struct ath10k_wow wow;
911 struct net_device napi_dev;
912 struct napi_struct napi;
915 u8 drv_priv[0] __aligned(sizeof(void *));
918 static inline bool ath10k_peer_stats_enabled(struct ath10k *ar)
920 if (test_bit(ATH10K_FLAG_PEER_STATS, &ar->dev_flags) &&
921 test_bit(WMI_SERVICE_PEER_STATS, ar->wmi.svc_map))
927 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
929 enum ath10k_hw_rev hw_rev,
930 const struct ath10k_hif_ops *hif_ops);
931 void ath10k_core_destroy(struct ath10k *ar);
932 void ath10k_core_get_fw_features_str(struct ath10k *ar,
935 int ath10k_core_fetch_firmware_api_n(struct ath10k *ar, const char *name,
936 struct ath10k_fw_file *fw_file);
938 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode,
939 const struct ath10k_fw_components *fw_components);
940 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
941 void ath10k_core_stop(struct ath10k *ar);
942 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
943 void ath10k_core_unregister(struct ath10k *ar);
945 #endif /* _CORE_H_ */