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_htc_ep_id eid;
143 struct completion service_ready;
144 struct completion unified_ready;
145 wait_queue_head_t tx_credits_wq;
146 DECLARE_BITMAP(svc_map, WMI_SERVICE_MAX);
147 struct wmi_cmd_map *cmd;
148 struct wmi_vdev_param_map *vdev_param;
149 struct wmi_pdev_param_map *pdev_param;
150 const struct wmi_ops *ops;
151 const struct wmi_peer_flags_map *peer_flags;
155 struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS];
158 struct ath10k_fw_stats_peer {
159 struct list_head list;
161 u8 peer_macaddr[ETH_ALEN];
164 u32 peer_rx_rate; /* 10x only */
168 struct ath10k_fw_extd_stats_peer {
169 struct list_head list;
171 u8 peer_macaddr[ETH_ALEN];
175 struct ath10k_fw_stats_vdev {
176 struct list_head list;
181 u32 num_tx_frames[4];
183 u32 num_tx_frames_retries[4];
184 u32 num_tx_frames_failures[4];
189 u32 num_tx_not_acked;
190 u32 tx_rate_history[10];
191 u32 beacon_rssi_history[10];
194 struct ath10k_fw_stats_pdev {
195 struct list_head list;
229 u32 sw_retry_failure;
230 u32 illgl_rate_phy_err;
231 u32 pdev_cont_xretry;
237 u32 seq_failed_queueing;
244 u32 mpdus_ack_failed;
248 s32 mid_ppdu_route_change;
265 struct ath10k_fw_stats {
267 struct list_head pdevs;
268 struct list_head vdevs;
269 struct list_head peers;
270 struct list_head peers_extd;
273 #define ATH10K_TPC_TABLE_TYPE_FLAG 1
274 #define ATH10K_TPC_PREAM_TABLE_END 0xFFFF
276 struct ath10k_tpc_table {
277 u32 pream_idx[WMI_TPC_RATE_MAX];
278 u8 rate_code[WMI_TPC_RATE_MAX];
279 char tpc_value[WMI_TPC_RATE_MAX][WMI_TPC_TX_N_CHAIN * WMI_TPC_BUF_SIZE];
282 struct ath10k_tpc_stats {
286 u32 twice_antenna_reduction;
287 u32 twice_max_rd_power;
288 s32 twice_antenna_gain;
293 u8 flag[WMI_TPC_FLAG];
294 struct ath10k_tpc_table tpc_table[WMI_TPC_FLAG];
297 struct ath10k_dfs_stats {
301 u32 pulses_discarded;
305 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
308 struct list_head list;
309 struct ieee80211_vif *vif;
310 struct ieee80211_sta *sta;
314 DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS);
316 /* protected by ar->data_lock */
317 struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
321 struct list_head list;
322 unsigned long num_fw_queued;
323 unsigned long num_push_allowed;
327 struct ath10k_vif *arvif;
329 /* the following are protected by ar->data_lock */
330 u32 changed; /* IEEE80211_RC_* */
336 struct work_struct update_wk;
338 #ifdef CONFIG_MAC80211_DEBUGFS
339 /* protected by conf_mutex */
345 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5 * HZ)
347 enum ath10k_beacon_state {
348 ATH10K_BEACON_SCHEDULED = 0,
349 ATH10K_BEACON_SENDING,
354 struct list_head list;
358 enum wmi_vdev_type vdev_type;
359 enum wmi_vdev_subtype vdev_subtype;
362 struct sk_buff *beacon;
363 /* protected by data_lock */
364 enum ath10k_beacon_state beacon_state;
366 dma_addr_t beacon_paddr;
367 unsigned long tx_paused; /* arbitrary values defined by target */
370 struct ieee80211_vif *vif;
374 bool spectral_enabled;
379 struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
393 u8 ssid[IEEE80211_MAX_SSID_LEN];
395 /* P2P_IE with NoA attribute for P2P_GO case */
403 int num_legacy_stations;
405 struct wmi_wmm_params_all_arg wmm_params;
406 struct work_struct ap_csa_work;
407 struct delayed_work connection_loss_work;
408 struct cfg80211_bitrate_mask bitrate_mask;
411 struct ath10k_vif_iter {
413 struct ath10k_vif *arvif;
416 /* used for crash-dump storage, protected by data-lock */
417 struct ath10k_fw_crash_data {
418 bool crashed_since_read;
421 struct timespec timestamp;
422 __le32 registers[REG_DUMP_COUNT_QCA988X];
425 struct ath10k_debug {
426 struct dentry *debugfs_phy;
428 struct ath10k_fw_stats fw_stats;
429 struct completion fw_stats_complete;
432 unsigned long htt_stats_mask;
433 struct delayed_work htt_stats_dwork;
434 struct ath10k_dfs_stats dfs_stats;
435 struct ath_dfs_pool_stats dfs_pool_stats;
437 /* used for tpc-dump storage, protected by data-lock */
438 struct ath10k_tpc_stats *tpc_stats;
440 struct completion tpc_complete;
442 /* protected by conf_mutex */
449 struct ath10k_fw_crash_data *fw_crash_data;
453 ATH10K_STATE_OFF = 0,
456 /* When doing firmware recovery the device is first powered down.
457 * mac80211 is supposed to call in to start() hook later on. It is
458 * however possible that driver unloading and firmware crash overlap.
459 * mac80211 can wait on conf_mutex in stop() while the device is
460 * stopped in ath10k_core_restart() work holding conf_mutex. The state
461 * RESTARTED means that the device is up and mac80211 has started hw
462 * reconfiguration. Once mac80211 is done with the reconfiguration we
463 * set the state to STATE_ON in reconfig_complete(). */
464 ATH10K_STATE_RESTARTING,
465 ATH10K_STATE_RESTARTED,
467 /* The device has crashed while restarting hw. This state is like ON
468 * but commands are blocked in HTC and -ECOMM response is given. This
469 * prevents completion timeouts and makes the driver more responsive to
470 * userspace commands. This is also prevents recursive recovery. */
477 enum ath10k_firmware_mode {
478 /* the default mode, standard 802.11 functionality */
479 ATH10K_FIRMWARE_MODE_NORMAL,
481 /* factory tests etc */
482 ATH10K_FIRMWARE_MODE_UTF,
485 enum ath10k_fw_features {
486 /* wmi_mgmt_rx_hdr contains extra RSSI information */
487 ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,
489 /* Firmware from 10X branch. Deprecated, don't use in new code. */
490 ATH10K_FW_FEATURE_WMI_10X = 1,
492 /* firmware support tx frame management over WMI, otherwise it's HTT */
493 ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,
495 /* Firmware does not support P2P */
496 ATH10K_FW_FEATURE_NO_P2P = 3,
498 /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature
499 * bit is required to be set as well. Deprecated, don't use in new
502 ATH10K_FW_FEATURE_WMI_10_2 = 4,
504 /* Some firmware revisions lack proper multi-interface client powersave
505 * implementation. Enabling PS could result in connection drops,
506 * traffic stalls, etc.
508 ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT = 5,
510 /* Some firmware revisions have an incomplete WoWLAN implementation
511 * despite WMI service bit being advertised. This feature flag is used
512 * to distinguish whether WoWLAN is really supported or not.
514 ATH10K_FW_FEATURE_WOWLAN_SUPPORT = 6,
516 /* Don't trust error code from otp.bin */
517 ATH10K_FW_FEATURE_IGNORE_OTP_RESULT = 7,
519 /* Some firmware revisions pad 4th hw address to 4 byte boundary making
520 * it 8 bytes long in Native Wifi Rx decap.
522 ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING = 8,
524 /* Firmware supports bypassing PLL setting on init. */
525 ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT = 9,
527 /* Raw mode support. If supported, FW supports receiving and trasmitting
528 * frames in raw mode.
530 ATH10K_FW_FEATURE_RAW_MODE_SUPPORT = 10,
532 /* Firmware Supports Adaptive CCA*/
533 ATH10K_FW_FEATURE_SUPPORTS_ADAPTIVE_CCA = 11,
535 /* Firmware supports management frame protection */
536 ATH10K_FW_FEATURE_MFP_SUPPORT = 12,
538 /* Firmware supports pull-push model where host shares it's software
539 * queue state with firmware and firmware generates fetch requests
540 * telling host which queues to dequeue tx from.
542 * Primary function of this is improved MU-MIMO performance with
545 ATH10K_FW_FEATURE_PEER_FLOW_CONTROL = 13,
547 /* Firmware supports BT-Coex without reloading firmware via pdev param.
548 * To support Bluetooth coexistence pdev param, WMI_COEX_GPIO_SUPPORT of
549 * extended resource config should be enabled always. This firmware IE
550 * is used to configure WMI_COEX_GPIO_SUPPORT.
552 ATH10K_FW_FEATURE_BTCOEX_PARAM = 14,
555 ATH10K_FW_FEATURE_COUNT,
558 enum ath10k_dev_flags {
559 /* Indicates that ath10k device is during CAC phase of DFS */
561 ATH10K_FLAG_CORE_REGISTERED,
563 /* Device has crashed and needs to restart. This indicates any pending
564 * waiters should immediately cancel instead of waiting for a time out.
566 ATH10K_FLAG_CRASH_FLUSH,
568 /* Use Raw mode instead of native WiFi Tx/Rx encap mode.
569 * Raw mode supports both hardware and software crypto. Native WiFi only
570 * supports hardware crypto.
572 ATH10K_FLAG_RAW_MODE,
574 /* Disable HW crypto engine */
575 ATH10K_FLAG_HW_CRYPTO_DISABLED,
577 /* Bluetooth coexistance enabled */
580 /* Per Station statistics service */
581 ATH10K_FLAG_PEER_STATS,
584 enum ath10k_cal_mode {
585 ATH10K_CAL_MODE_FILE,
588 ATH10K_PRE_CAL_MODE_FILE,
589 ATH10K_PRE_CAL_MODE_DT,
590 ATH10K_CAL_MODE_EEPROM,
593 enum ath10k_crypt_mode {
594 /* Only use hardware crypto engine */
595 ATH10K_CRYPT_MODE_HW,
596 /* Only use software crypto engine */
597 ATH10K_CRYPT_MODE_SW,
600 static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode)
603 case ATH10K_CAL_MODE_FILE:
605 case ATH10K_CAL_MODE_OTP:
607 case ATH10K_CAL_MODE_DT:
609 case ATH10K_PRE_CAL_MODE_FILE:
610 return "pre-cal-file";
611 case ATH10K_PRE_CAL_MODE_DT:
613 case ATH10K_CAL_MODE_EEPROM:
620 enum ath10k_scan_state {
622 ATH10K_SCAN_STARTING,
624 ATH10K_SCAN_ABORTING,
627 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
630 case ATH10K_SCAN_IDLE:
632 case ATH10K_SCAN_STARTING:
634 case ATH10K_SCAN_RUNNING:
636 case ATH10K_SCAN_ABORTING:
643 enum ath10k_tx_pause_reason {
644 ATH10K_TX_PAUSE_Q_FULL,
648 struct ath10k_fw_file {
649 const struct firmware *firmware;
651 char fw_version[ETHTOOL_FWVERS_LEN];
653 DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
655 enum ath10k_fw_wmi_op_version wmi_op_version;
656 enum ath10k_fw_htt_op_version htt_op_version;
658 const void *firmware_data;
661 const void *otp_data;
664 const void *codeswap_data;
668 struct ath10k_fw_components {
669 const struct firmware *board;
670 const void *board_data;
673 struct ath10k_fw_file fw_file;
677 struct ath_common ath_common;
678 struct ieee80211_hw *hw;
679 struct ieee80211_ops *ops;
681 u8 mac_addr[ETH_ALEN];
683 enum ath10k_hw_rev hw_rev;
688 u32 fw_version_minor;
689 u16 fw_version_release;
690 u16 fw_version_build;
691 u32 fw_stats_req_mask;
698 u32 max_spatial_stream;
699 /* protected by conf_mutex */
706 const struct ath10k_hif_ops *ops;
709 struct completion target_suspend;
711 const struct ath10k_hw_regs *regs;
712 const struct ath10k_hw_values *hw_values;
713 struct ath10k_bmi bmi;
714 struct ath10k_wmi wmi;
715 struct ath10k_htc htc;
716 struct ath10k_htt htt;
718 struct ath10k_hw_params {
726 /* Type of hw cycle counter wraparound logic, for more info
727 * refer enum ath10k_hw_cc_wraparound_type.
729 enum ath10k_hw_cc_wraparound_type cc_wraparound_type;
731 /* Some of chip expects fragment descriptor to be continuous
732 * memory for any TX operation. Set continuous_frag_desc flag
733 * for the hardware which have such requirement.
735 bool continuous_frag_desc;
737 /* CCK hardware rate table mapping for the newer chipsets
738 * like QCA99X0, QCA4019 got revised. The CCK h/w rate values
739 * are in a proper order with respect to the rate/preamble
741 bool cck_rate_map_rev2;
743 u32 channel_counters_freq_hz;
745 /* Mgmt tx descriptors threshold for limiting probe response
748 u32 max_probe_resp_desc_thres;
750 /* The padding bytes's location is different on various chips */
751 enum ath10k_hw_4addr_pad hw_4addr_pad;
755 u32 max_spatial_stream;
758 struct ath10k_hw_params_fw {
762 size_t board_ext_size;
766 /* contains the firmware images used with ATH10K_FIRMWARE_MODE_NORMAL */
767 struct ath10k_fw_components normal_mode_fw;
769 /* READ-ONLY images of the running firmware, which can be either
770 * normal or UTF. Do not modify, release etc!
772 const struct ath10k_fw_components *running_fw;
774 const struct firmware *pre_cal_file;
775 const struct firmware *cal_file;
778 struct ath10k_swap_code_seg_info *firmware_swap_code_seg_info;
784 u32 subsystem_vendor;
785 u32 subsystem_device;
794 enum ath10k_cal_mode cal_mode;
797 struct completion started;
798 struct completion completed;
799 struct completion on_channel;
800 struct delayed_work timeout;
801 enum ath10k_scan_state state;
809 struct ieee80211_supported_band sbands[NUM_NL80211_BANDS];
812 /* should never be NULL; needed for regular htt rx */
813 struct ieee80211_channel *rx_channel;
815 /* valid during scan; needed for mgmt rx during scan */
816 struct ieee80211_channel *scan_channel;
818 /* current operating channel definition */
819 struct cfg80211_chan_def chandef;
821 /* currently configured operating channel in firmware */
822 struct ieee80211_channel *tgt_oper_chan;
824 unsigned long long free_vdev_map;
825 struct ath10k_vif *monitor_arvif;
828 bool monitor_started;
829 unsigned int filter_flags;
830 unsigned long dev_flags;
831 bool dfs_block_radar_events;
833 /* protected by conf_mutex */
835 int num_started_vdevs;
837 /* Protected by conf-mutex */
841 struct completion install_key_done;
843 struct completion vdev_setup_done;
845 struct workqueue_struct *workqueue;
846 /* Auxiliary workqueue */
847 struct workqueue_struct *workqueue_aux;
849 /* prevents concurrent FW reconfiguration */
850 struct mutex conf_mutex;
852 /* protects shared structure data */
853 spinlock_t data_lock;
854 /* protects: ar->txqs, artxq->list */
855 spinlock_t txqs_lock;
857 struct list_head txqs;
858 struct list_head arvifs;
859 struct list_head peers;
860 struct ath10k_peer *peer_map[ATH10K_MAX_NUM_PEER_IDS];
861 wait_queue_head_t peer_mapping_wq;
863 /* protected by conf_mutex */
868 int max_num_stations;
870 int max_num_tdls_vdevs;
871 int num_active_peers;
874 struct work_struct svc_rdy_work;
875 struct sk_buff *svc_rdy_skb;
877 struct work_struct offchan_tx_work;
878 struct sk_buff_head offchan_tx_queue;
879 struct completion offchan_tx_completed;
880 struct sk_buff *offchan_tx_skb;
882 struct work_struct wmi_mgmt_tx_work;
883 struct sk_buff_head wmi_mgmt_tx_queue;
885 enum ath10k_state state;
887 struct work_struct register_work;
888 struct work_struct restart_work;
890 /* cycle count is reported twice for each visited channel during scan.
891 * access protected by data_lock */
892 u32 survey_last_rx_clear_count;
893 u32 survey_last_cycle_count;
894 struct survey_info survey[ATH10K_NUM_CHANS];
896 /* Channel info events are expected to come in pairs without and with
897 * COMPLETE flag set respectively for each channel visit during scan.
899 * However there are deviations from this rule. This flag is used to
900 * avoid reporting garbage data.
902 bool ch_info_can_report_survey;
903 struct completion bss_survey_done;
905 struct dfs_pattern_detector *dfs_detector;
907 unsigned long tx_paused; /* see ATH10K_TX_PAUSE_ */
909 #ifdef CONFIG_ATH10K_DEBUGFS
910 struct ath10k_debug debug;
912 /* relay(fs) channel for spectral scan */
913 struct rchan *rfs_chan_spec_scan;
915 /* spectral_mode and spec_config are protected by conf_mutex */
916 enum ath10k_spectral_mode mode;
917 struct ath10k_spec_scan config;
922 /* protected by conf_mutex */
923 struct ath10k_fw_components utf_mode_fw;
925 /* protected by data_lock */
930 /* protected by data_lock */
931 u32 fw_crash_counter;
932 u32 fw_warm_reset_counter;
933 u32 fw_cold_reset_counter;
936 struct ath10k_thermal thermal;
937 struct ath10k_wow wow;
940 u8 drv_priv[0] __aligned(sizeof(void *));
943 static inline bool ath10k_peer_stats_enabled(struct ath10k *ar)
945 if (test_bit(ATH10K_FLAG_PEER_STATS, &ar->dev_flags) &&
946 test_bit(WMI_SERVICE_PEER_STATS, ar->wmi.svc_map))
952 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
954 enum ath10k_hw_rev hw_rev,
955 const struct ath10k_hif_ops *hif_ops);
956 void ath10k_core_destroy(struct ath10k *ar);
957 void ath10k_core_get_fw_features_str(struct ath10k *ar,
960 int ath10k_core_fetch_firmware_api_n(struct ath10k *ar, const char *name,
961 struct ath10k_fw_file *fw_file);
963 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode,
964 const struct ath10k_fw_components *fw_components);
965 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
966 void ath10k_core_stop(struct ath10k *ar);
967 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
968 void ath10k_core_unregister(struct ath10k *ar);
970 #endif /* _CORE_H_ */