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_stats_vdev {
169 struct list_head list;
174 u32 num_tx_frames[4];
176 u32 num_tx_frames_retries[4];
177 u32 num_tx_frames_failures[4];
182 u32 num_tx_not_acked;
183 u32 tx_rate_history[10];
184 u32 beacon_rssi_history[10];
187 struct ath10k_fw_stats_pdev {
188 struct list_head list;
222 u32 sw_retry_failure;
223 u32 illgl_rate_phy_err;
224 u32 pdev_cont_xretry;
230 u32 seq_failed_queueing;
237 u32 mpdus_ack_failed;
241 s32 mid_ppdu_route_change;
258 struct ath10k_fw_stats {
259 struct list_head pdevs;
260 struct list_head vdevs;
261 struct list_head peers;
264 #define ATH10K_TPC_TABLE_TYPE_FLAG 1
265 #define ATH10K_TPC_PREAM_TABLE_END 0xFFFF
267 struct ath10k_tpc_table {
268 u32 pream_idx[WMI_TPC_RATE_MAX];
269 u8 rate_code[WMI_TPC_RATE_MAX];
270 char tpc_value[WMI_TPC_RATE_MAX][WMI_TPC_TX_N_CHAIN * WMI_TPC_BUF_SIZE];
273 struct ath10k_tpc_stats {
277 u32 twice_antenna_reduction;
278 u32 twice_max_rd_power;
279 s32 twice_antenna_gain;
284 u8 flag[WMI_TPC_FLAG];
285 struct ath10k_tpc_table tpc_table[WMI_TPC_FLAG];
288 struct ath10k_dfs_stats {
292 u32 pulses_discarded;
296 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
299 struct list_head list;
300 struct ieee80211_vif *vif;
301 struct ieee80211_sta *sta;
305 DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS);
307 /* protected by ar->data_lock */
308 struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
312 struct list_head list;
313 unsigned long num_fw_queued;
314 unsigned long num_push_allowed;
318 struct ath10k_vif *arvif;
320 /* the following are protected by ar->data_lock */
321 u32 changed; /* IEEE80211_RC_* */
327 struct work_struct update_wk;
329 #ifdef CONFIG_MAC80211_DEBUGFS
330 /* protected by conf_mutex */
336 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5 * HZ)
338 enum ath10k_beacon_state {
339 ATH10K_BEACON_SCHEDULED = 0,
340 ATH10K_BEACON_SENDING,
345 struct list_head list;
349 enum wmi_vdev_type vdev_type;
350 enum wmi_vdev_subtype vdev_subtype;
353 struct sk_buff *beacon;
354 /* protected by data_lock */
355 enum ath10k_beacon_state beacon_state;
357 dma_addr_t beacon_paddr;
358 unsigned long tx_paused; /* arbitrary values defined by target */
361 struct ieee80211_vif *vif;
365 bool spectral_enabled;
370 struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
384 u8 ssid[IEEE80211_MAX_SSID_LEN];
386 /* P2P_IE with NoA attribute for P2P_GO case */
394 int num_legacy_stations;
396 struct wmi_wmm_params_all_arg wmm_params;
397 struct work_struct ap_csa_work;
398 struct delayed_work connection_loss_work;
399 struct cfg80211_bitrate_mask bitrate_mask;
402 struct ath10k_vif_iter {
404 struct ath10k_vif *arvif;
407 /* used for crash-dump storage, protected by data-lock */
408 struct ath10k_fw_crash_data {
409 bool crashed_since_read;
412 struct timespec timestamp;
413 __le32 registers[REG_DUMP_COUNT_QCA988X];
416 struct ath10k_debug {
417 struct dentry *debugfs_phy;
419 struct ath10k_fw_stats fw_stats;
420 struct completion fw_stats_complete;
423 unsigned long htt_stats_mask;
424 struct delayed_work htt_stats_dwork;
425 struct ath10k_dfs_stats dfs_stats;
426 struct ath_dfs_pool_stats dfs_pool_stats;
428 /* used for tpc-dump storage, protected by data-lock */
429 struct ath10k_tpc_stats *tpc_stats;
431 struct completion tpc_complete;
433 /* protected by conf_mutex */
440 struct ath10k_fw_crash_data *fw_crash_data;
444 ATH10K_STATE_OFF = 0,
447 /* When doing firmware recovery the device is first powered down.
448 * mac80211 is supposed to call in to start() hook later on. It is
449 * however possible that driver unloading and firmware crash overlap.
450 * mac80211 can wait on conf_mutex in stop() while the device is
451 * stopped in ath10k_core_restart() work holding conf_mutex. The state
452 * RESTARTED means that the device is up and mac80211 has started hw
453 * reconfiguration. Once mac80211 is done with the reconfiguration we
454 * set the state to STATE_ON in reconfig_complete(). */
455 ATH10K_STATE_RESTARTING,
456 ATH10K_STATE_RESTARTED,
458 /* The device has crashed while restarting hw. This state is like ON
459 * but commands are blocked in HTC and -ECOMM response is given. This
460 * prevents completion timeouts and makes the driver more responsive to
461 * userspace commands. This is also prevents recursive recovery. */
468 enum ath10k_firmware_mode {
469 /* the default mode, standard 802.11 functionality */
470 ATH10K_FIRMWARE_MODE_NORMAL,
472 /* factory tests etc */
473 ATH10K_FIRMWARE_MODE_UTF,
476 enum ath10k_fw_features {
477 /* wmi_mgmt_rx_hdr contains extra RSSI information */
478 ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,
480 /* Firmware from 10X branch. Deprecated, don't use in new code. */
481 ATH10K_FW_FEATURE_WMI_10X = 1,
483 /* firmware support tx frame management over WMI, otherwise it's HTT */
484 ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,
486 /* Firmware does not support P2P */
487 ATH10K_FW_FEATURE_NO_P2P = 3,
489 /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature
490 * bit is required to be set as well. Deprecated, don't use in new
493 ATH10K_FW_FEATURE_WMI_10_2 = 4,
495 /* Some firmware revisions lack proper multi-interface client powersave
496 * implementation. Enabling PS could result in connection drops,
497 * traffic stalls, etc.
499 ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT = 5,
501 /* Some firmware revisions have an incomplete WoWLAN implementation
502 * despite WMI service bit being advertised. This feature flag is used
503 * to distinguish whether WoWLAN is really supported or not.
505 ATH10K_FW_FEATURE_WOWLAN_SUPPORT = 6,
507 /* Don't trust error code from otp.bin */
508 ATH10K_FW_FEATURE_IGNORE_OTP_RESULT = 7,
510 /* Some firmware revisions pad 4th hw address to 4 byte boundary making
511 * it 8 bytes long in Native Wifi Rx decap.
513 ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING = 8,
515 /* Firmware supports bypassing PLL setting on init. */
516 ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT = 9,
518 /* Raw mode support. If supported, FW supports receiving and trasmitting
519 * frames in raw mode.
521 ATH10K_FW_FEATURE_RAW_MODE_SUPPORT = 10,
523 /* Firmware Supports Adaptive CCA*/
524 ATH10K_FW_FEATURE_SUPPORTS_ADAPTIVE_CCA = 11,
526 /* Firmware supports management frame protection */
527 ATH10K_FW_FEATURE_MFP_SUPPORT = 12,
529 /* Firmware supports pull-push model where host shares it's software
530 * queue state with firmware and firmware generates fetch requests
531 * telling host which queues to dequeue tx from.
533 * Primary function of this is improved MU-MIMO performance with
536 ATH10K_FW_FEATURE_PEER_FLOW_CONTROL = 13,
539 ATH10K_FW_FEATURE_COUNT,
542 enum ath10k_dev_flags {
543 /* Indicates that ath10k device is during CAC phase of DFS */
545 ATH10K_FLAG_CORE_REGISTERED,
547 /* Device has crashed and needs to restart. This indicates any pending
548 * waiters should immediately cancel instead of waiting for a time out.
550 ATH10K_FLAG_CRASH_FLUSH,
552 /* Use Raw mode instead of native WiFi Tx/Rx encap mode.
553 * Raw mode supports both hardware and software crypto. Native WiFi only
554 * supports hardware crypto.
556 ATH10K_FLAG_RAW_MODE,
558 /* Disable HW crypto engine */
559 ATH10K_FLAG_HW_CRYPTO_DISABLED,
561 /* Bluetooth coexistance enabled */
564 /* Per Station statistics service */
565 ATH10K_FLAG_PEER_STATS,
568 enum ath10k_cal_mode {
569 ATH10K_CAL_MODE_FILE,
572 ATH10K_PRE_CAL_MODE_FILE,
573 ATH10K_PRE_CAL_MODE_DT,
576 enum ath10k_crypt_mode {
577 /* Only use hardware crypto engine */
578 ATH10K_CRYPT_MODE_HW,
579 /* Only use software crypto engine */
580 ATH10K_CRYPT_MODE_SW,
583 static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode)
586 case ATH10K_CAL_MODE_FILE:
588 case ATH10K_CAL_MODE_OTP:
590 case ATH10K_CAL_MODE_DT:
592 case ATH10K_PRE_CAL_MODE_FILE:
593 return "pre-cal-file";
594 case ATH10K_PRE_CAL_MODE_DT:
601 enum ath10k_scan_state {
603 ATH10K_SCAN_STARTING,
605 ATH10K_SCAN_ABORTING,
608 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state)
611 case ATH10K_SCAN_IDLE:
613 case ATH10K_SCAN_STARTING:
615 case ATH10K_SCAN_RUNNING:
617 case ATH10K_SCAN_ABORTING:
624 enum ath10k_tx_pause_reason {
625 ATH10K_TX_PAUSE_Q_FULL,
629 struct ath10k_fw_file {
630 const struct firmware *firmware;
632 char fw_version[ETHTOOL_FWVERS_LEN];
634 DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);
636 enum ath10k_fw_wmi_op_version wmi_op_version;
637 enum ath10k_fw_htt_op_version htt_op_version;
639 const void *firmware_data;
642 const void *otp_data;
645 const void *codeswap_data;
649 struct ath10k_fw_components {
650 const struct firmware *board;
651 const void *board_data;
654 struct ath10k_fw_file fw_file;
658 struct ath_common ath_common;
659 struct ieee80211_hw *hw;
661 u8 mac_addr[ETH_ALEN];
663 enum ath10k_hw_rev hw_rev;
668 u32 fw_version_minor;
669 u16 fw_version_release;
670 u16 fw_version_build;
671 u32 fw_stats_req_mask;
678 u32 max_spatial_stream;
679 /* protected by conf_mutex */
686 const struct ath10k_hif_ops *ops;
689 struct completion target_suspend;
691 const struct ath10k_hw_regs *regs;
692 const struct ath10k_hw_values *hw_values;
693 struct ath10k_bmi bmi;
694 struct ath10k_wmi wmi;
695 struct ath10k_htc htc;
696 struct ath10k_htt htt;
698 struct ath10k_hw_params {
706 /* This is true if given HW chip has a quirky Cycle Counter
707 * wraparound which resets to 0x7fffffff instead of 0. All
708 * other CC related counters (e.g. Rx Clear Count) are divided
709 * by 2 so they never wraparound themselves.
711 bool has_shifted_cc_wraparound;
713 /* Some of chip expects fragment descriptor to be continuous
714 * memory for any TX operation. Set continuous_frag_desc flag
715 * for the hardware which have such requirement.
717 bool continuous_frag_desc;
719 u32 channel_counters_freq_hz;
721 /* Mgmt tx descriptors threshold for limiting probe response
724 u32 max_probe_resp_desc_thres;
726 /* The padding bytes's location is different on various chips */
727 enum ath10k_hw_4addr_pad hw_4addr_pad;
731 u32 max_spatial_stream;
734 struct ath10k_hw_params_fw {
738 size_t board_ext_size;
742 /* contains the firmware images used with ATH10K_FIRMWARE_MODE_NORMAL */
743 struct ath10k_fw_components normal_mode_fw;
745 /* READ-ONLY images of the running firmware, which can be either
746 * normal or UTF. Do not modify, release etc!
748 const struct ath10k_fw_components *running_fw;
750 const struct firmware *pre_cal_file;
751 const struct firmware *cal_file;
754 struct ath10k_swap_code_seg_info *firmware_swap_code_seg_info;
760 u32 subsystem_vendor;
761 u32 subsystem_device;
770 enum ath10k_cal_mode cal_mode;
773 struct completion started;
774 struct completion completed;
775 struct completion on_channel;
776 struct delayed_work timeout;
777 enum ath10k_scan_state state;
785 struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS];
788 /* should never be NULL; needed for regular htt rx */
789 struct ieee80211_channel *rx_channel;
791 /* valid during scan; needed for mgmt rx during scan */
792 struct ieee80211_channel *scan_channel;
794 /* current operating channel definition */
795 struct cfg80211_chan_def chandef;
797 /* currently configured operating channel in firmware */
798 struct ieee80211_channel *tgt_oper_chan;
800 unsigned long long free_vdev_map;
801 struct ath10k_vif *monitor_arvif;
804 bool monitor_started;
805 unsigned int filter_flags;
806 unsigned long dev_flags;
807 bool dfs_block_radar_events;
809 /* protected by conf_mutex */
811 int num_started_vdevs;
813 /* Protected by conf-mutex */
817 struct completion install_key_done;
819 struct completion vdev_setup_done;
821 struct workqueue_struct *workqueue;
822 /* Auxiliary workqueue */
823 struct workqueue_struct *workqueue_aux;
825 /* prevents concurrent FW reconfiguration */
826 struct mutex conf_mutex;
828 /* protects shared structure data */
829 spinlock_t data_lock;
830 /* protects: ar->txqs, artxq->list */
831 spinlock_t txqs_lock;
833 struct list_head txqs;
834 struct list_head arvifs;
835 struct list_head peers;
836 struct ath10k_peer *peer_map[ATH10K_MAX_NUM_PEER_IDS];
837 wait_queue_head_t peer_mapping_wq;
839 /* protected by conf_mutex */
844 int max_num_stations;
846 int max_num_tdls_vdevs;
847 int num_active_peers;
850 struct work_struct svc_rdy_work;
851 struct sk_buff *svc_rdy_skb;
853 struct work_struct offchan_tx_work;
854 struct sk_buff_head offchan_tx_queue;
855 struct completion offchan_tx_completed;
856 struct sk_buff *offchan_tx_skb;
858 struct work_struct wmi_mgmt_tx_work;
859 struct sk_buff_head wmi_mgmt_tx_queue;
861 enum ath10k_state state;
863 struct work_struct register_work;
864 struct work_struct restart_work;
866 /* cycle count is reported twice for each visited channel during scan.
867 * access protected by data_lock */
868 u32 survey_last_rx_clear_count;
869 u32 survey_last_cycle_count;
870 struct survey_info survey[ATH10K_NUM_CHANS];
872 /* Channel info events are expected to come in pairs without and with
873 * COMPLETE flag set respectively for each channel visit during scan.
875 * However there are deviations from this rule. This flag is used to
876 * avoid reporting garbage data.
878 bool ch_info_can_report_survey;
880 struct dfs_pattern_detector *dfs_detector;
882 unsigned long tx_paused; /* see ATH10K_TX_PAUSE_ */
884 #ifdef CONFIG_ATH10K_DEBUGFS
885 struct ath10k_debug debug;
889 /* relay(fs) channel for spectral scan */
890 struct rchan *rfs_chan_spec_scan;
892 /* spectral_mode and spec_config are protected by conf_mutex */
893 enum ath10k_spectral_mode mode;
894 struct ath10k_spec_scan config;
898 /* protected by conf_mutex */
899 struct ath10k_fw_components utf_mode_fw;
901 /* protected by data_lock */
906 /* protected by data_lock */
907 u32 fw_crash_counter;
908 u32 fw_warm_reset_counter;
909 u32 fw_cold_reset_counter;
912 struct ath10k_thermal thermal;
913 struct ath10k_wow wow;
916 u8 drv_priv[0] __aligned(sizeof(void *));
919 static inline bool ath10k_peer_stats_enabled(struct ath10k *ar)
921 if (test_bit(ATH10K_FLAG_PEER_STATS, &ar->dev_flags) &&
922 test_bit(WMI_SERVICE_PEER_STATS, ar->wmi.svc_map))
928 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
930 enum ath10k_hw_rev hw_rev,
931 const struct ath10k_hif_ops *hif_ops);
932 void ath10k_core_destroy(struct ath10k *ar);
933 void ath10k_core_get_fw_features_str(struct ath10k *ar,
937 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode,
938 const struct ath10k_fw_components *fw_components);
939 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
940 void ath10k_core_stop(struct ath10k *ar);
941 int ath10k_core_register(struct ath10k *ar, u32 chip_id);
942 void ath10k_core_unregister(struct ath10k *ar);
944 #endif /* _CORE_H_ */