/* * Copyright (c) 2005-2011 Atheros Communications Inc. * Copyright (c) 2011-2013 Qualcomm Atheros, Inc. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #ifndef _CORE_H_ #define _CORE_H_ #include #include #include #include #include #include #include "htt.h" #include "htc.h" #include "hw.h" #include "targaddrs.h" #include "wmi.h" #include "../ath.h" #include "../regd.h" #include "../dfs_pattern_detector.h" #include "spectral.h" #include "thermal.h" #include "wow.h" #include "swap.h" #define MS(_v, _f) (((_v) & _f##_MASK) >> _f##_LSB) #define SM(_v, _f) (((_v) << _f##_LSB) & _f##_MASK) #define WO(_f) ((_f##_OFFSET) >> 2) #define ATH10K_SCAN_ID 0 #define WMI_READY_TIMEOUT (5 * HZ) #define ATH10K_FLUSH_TIMEOUT_HZ (5*HZ) #define ATH10K_CONNECTION_LOSS_HZ (3*HZ) #define ATH10K_NUM_CHANS 39 /* Antenna noise floor */ #define ATH10K_DEFAULT_NOISE_FLOOR -95 #define ATH10K_MAX_NUM_MGMT_PENDING 128 /* number of failed packets (20 packets with 16 sw reties each) */ #define ATH10K_KICKOUT_THRESHOLD (20 * 16) /* * Use insanely high numbers to make sure that the firmware implementation * won't start, we have the same functionality already in hostapd. Unit * is seconds. */ #define ATH10K_KEEPALIVE_MIN_IDLE 3747 #define ATH10K_KEEPALIVE_MAX_IDLE 3895 #define ATH10K_KEEPALIVE_MAX_UNRESPONSIVE 3900 struct ath10k; enum ath10k_bus { ATH10K_BUS_PCI, }; static inline const char *ath10k_bus_str(enum ath10k_bus bus) { switch (bus) { case ATH10K_BUS_PCI: return "pci"; } return "unknown"; } struct ath10k_skb_cb { dma_addr_t paddr; u8 eid; u8 vdev_id; enum ath10k_hw_txrx_mode txmode; bool is_protected; struct { u8 tid; u16 freq; bool is_offchan; bool nohwcrypt; struct ath10k_htt_txbuf *txbuf; u32 txbuf_paddr; } __packed htt; struct { bool dtim_zero; bool deliver_cab; } bcn; } __packed; struct ath10k_skb_rxcb { dma_addr_t paddr; struct hlist_node hlist; }; static inline struct ath10k_skb_cb *ATH10K_SKB_CB(struct sk_buff *skb) { BUILD_BUG_ON(sizeof(struct ath10k_skb_cb) > IEEE80211_TX_INFO_DRIVER_DATA_SIZE); return (struct ath10k_skb_cb *)&IEEE80211_SKB_CB(skb)->driver_data; } static inline struct ath10k_skb_rxcb *ATH10K_SKB_RXCB(struct sk_buff *skb) { BUILD_BUG_ON(sizeof(struct ath10k_skb_rxcb) > sizeof(skb->cb)); return (struct ath10k_skb_rxcb *)skb->cb; } #define ATH10K_RXCB_SKB(rxcb) \ container_of((void *)rxcb, struct sk_buff, cb) static inline u32 host_interest_item_address(u32 item_offset) { return QCA988X_HOST_INTEREST_ADDRESS + item_offset; } struct ath10k_bmi { bool done_sent; }; struct ath10k_mem_chunk { void *vaddr; dma_addr_t paddr; u32 len; u32 req_id; }; struct ath10k_wmi { enum ath10k_fw_wmi_op_version op_version; enum ath10k_htc_ep_id eid; struct completion service_ready; struct completion unified_ready; wait_queue_head_t tx_credits_wq; DECLARE_BITMAP(svc_map, WMI_SERVICE_MAX); struct wmi_cmd_map *cmd; struct wmi_vdev_param_map *vdev_param; struct wmi_pdev_param_map *pdev_param; const struct wmi_ops *ops; u32 num_mem_chunks; u32 rx_decap_mode; struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS]; }; struct ath10k_fw_stats_peer { struct list_head list; u8 peer_macaddr[ETH_ALEN]; u32 peer_rssi; u32 peer_tx_rate; u32 peer_rx_rate; /* 10x only */ }; struct ath10k_fw_stats_vdev { struct list_head list; u32 vdev_id; u32 beacon_snr; u32 data_snr; u32 num_tx_frames[4]; u32 num_rx_frames; u32 num_tx_frames_retries[4]; u32 num_tx_frames_failures[4]; u32 num_rts_fail; u32 num_rts_success; u32 num_rx_err; u32 num_rx_discard; u32 num_tx_not_acked; u32 tx_rate_history[10]; u32 beacon_rssi_history[10]; }; struct ath10k_fw_stats_pdev { struct list_head list; /* PDEV stats */ s32 ch_noise_floor; u32 tx_frame_count; u32 rx_frame_count; u32 rx_clear_count; u32 cycle_count; u32 phy_err_count; u32 chan_tx_power; u32 ack_rx_bad; u32 rts_bad; u32 rts_good; u32 fcs_bad; u32 no_beacons; u32 mib_int_count; /* PDEV TX stats */ s32 comp_queued; s32 comp_delivered; s32 msdu_enqued; s32 mpdu_enqued; s32 wmm_drop; s32 local_enqued; s32 local_freed; s32 hw_queued; s32 hw_reaped; s32 underrun; s32 tx_abort; s32 mpdus_requed; u32 tx_ko; u32 data_rc; u32 self_triggers; u32 sw_retry_failure; u32 illgl_rate_phy_err; u32 pdev_cont_xretry; u32 pdev_tx_timeout; u32 pdev_resets; u32 phy_underrun; u32 txop_ovf; /* PDEV RX stats */ s32 mid_ppdu_route_change; s32 status_rcvd; s32 r0_frags; s32 r1_frags; s32 r2_frags; s32 r3_frags; s32 htt_msdus; s32 htt_mpdus; s32 loc_msdus; s32 loc_mpdus; s32 oversize_amsdu; s32 phy_errs; s32 phy_err_drop; s32 mpdu_errs; }; struct ath10k_fw_stats { struct list_head pdevs; struct list_head vdevs; struct list_head peers; }; struct ath10k_dfs_stats { u32 phy_errors; u32 pulses_total; u32 pulses_detected; u32 pulses_discarded; u32 radar_detected; }; #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */ struct ath10k_peer { struct list_head list; int vdev_id; u8 addr[ETH_ALEN]; DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS); /* protected by ar->data_lock */ struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1]; }; struct ath10k_sta { struct ath10k_vif *arvif; /* the following are protected by ar->data_lock */ u32 changed; /* IEEE80211_RC_* */ u32 bw; u32 nss; u32 smps; struct work_struct update_wk; #ifdef CONFIG_MAC80211_DEBUGFS /* protected by conf_mutex */ bool aggr_mode; #endif }; #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5*HZ) enum ath10k_beacon_state { ATH10K_BEACON_SCHEDULED = 0, ATH10K_BEACON_SENDING, ATH10K_BEACON_SENT, }; struct ath10k_vif { struct list_head list; u32 vdev_id; enum wmi_vdev_type vdev_type; enum wmi_vdev_subtype vdev_subtype; u32 beacon_interval; u32 dtim_period; struct sk_buff *beacon; /* protected by data_lock */ enum ath10k_beacon_state beacon_state; void *beacon_buf; dma_addr_t beacon_paddr; unsigned long tx_paused; /* arbitrary values defined by target */ struct ath10k *ar; struct ieee80211_vif *vif; bool is_started; bool is_up; bool spectral_enabled; bool ps; u32 aid; u8 bssid[ETH_ALEN]; struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1]; s8 def_wep_key_idx; u16 tx_seq_no; union { struct { u32 uapsd; } sta; struct { /* 512 stations */ u8 tim_bitmap[64]; u8 tim_len; u32 ssid_len; u8 ssid[IEEE80211_MAX_SSID_LEN]; bool hidden_ssid; /* P2P_IE with NoA attribute for P2P_GO case */ u32 noa_len; u8 *noa_data; } ap; } u; bool use_cts_prot; bool nohwcrypt; int num_legacy_stations; int txpower; struct wmi_wmm_params_all_arg wmm_params; struct work_struct ap_csa_work; struct delayed_work connection_loss_work; struct cfg80211_bitrate_mask bitrate_mask; }; struct ath10k_vif_iter { u32 vdev_id; struct ath10k_vif *arvif; }; /* used for crash-dump storage, protected by data-lock */ struct ath10k_fw_crash_data { bool crashed_since_read; uuid_le uuid; struct timespec timestamp; __le32 registers[REG_DUMP_COUNT_QCA988X]; }; struct ath10k_debug { struct dentry *debugfs_phy; struct ath10k_fw_stats fw_stats; struct completion fw_stats_complete; bool fw_stats_done; unsigned long htt_stats_mask; struct delayed_work htt_stats_dwork; struct ath10k_dfs_stats dfs_stats; struct ath_dfs_pool_stats dfs_pool_stats; /* protected by conf_mutex */ u32 fw_dbglog_mask; u32 fw_dbglog_level; u32 pktlog_filter; u32 reg_addr; u32 nf_cal_period; struct ath10k_fw_crash_data *fw_crash_data; }; enum ath10k_state { ATH10K_STATE_OFF = 0, ATH10K_STATE_ON, /* When doing firmware recovery the device is first powered down. * mac80211 is supposed to call in to start() hook later on. It is * however possible that driver unloading and firmware crash overlap. * mac80211 can wait on conf_mutex in stop() while the device is * stopped in ath10k_core_restart() work holding conf_mutex. The state * RESTARTED means that the device is up and mac80211 has started hw * reconfiguration. Once mac80211 is done with the reconfiguration we * set the state to STATE_ON in reconfig_complete(). */ ATH10K_STATE_RESTARTING, ATH10K_STATE_RESTARTED, /* The device has crashed while restarting hw. This state is like ON * but commands are blocked in HTC and -ECOMM response is given. This * prevents completion timeouts and makes the driver more responsive to * userspace commands. This is also prevents recursive recovery. */ ATH10K_STATE_WEDGED, /* factory tests */ ATH10K_STATE_UTF, }; enum ath10k_firmware_mode { /* the default mode, standard 802.11 functionality */ ATH10K_FIRMWARE_MODE_NORMAL, /* factory tests etc */ ATH10K_FIRMWARE_MODE_UTF, }; enum ath10k_fw_features { /* wmi_mgmt_rx_hdr contains extra RSSI information */ ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0, /* Firmware from 10X branch. Deprecated, don't use in new code. */ ATH10K_FW_FEATURE_WMI_10X = 1, /* firmware support tx frame management over WMI, otherwise it's HTT */ ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2, /* Firmware does not support P2P */ ATH10K_FW_FEATURE_NO_P2P = 3, /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature * bit is required to be set as well. Deprecated, don't use in new * code. */ ATH10K_FW_FEATURE_WMI_10_2 = 4, /* Some firmware revisions lack proper multi-interface client powersave * implementation. Enabling PS could result in connection drops, * traffic stalls, etc. */ ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT = 5, /* Some firmware revisions have an incomplete WoWLAN implementation * despite WMI service bit being advertised. This feature flag is used * to distinguish whether WoWLAN is really supported or not. */ ATH10K_FW_FEATURE_WOWLAN_SUPPORT = 6, /* Don't trust error code from otp.bin */ ATH10K_FW_FEATURE_IGNORE_OTP_RESULT = 7, /* Some firmware revisions pad 4th hw address to 4 byte boundary making * it 8 bytes long in Native Wifi Rx decap. */ ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING = 8, /* Firmware supports bypassing PLL setting on init. */ ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT = 9, /* Raw mode support. If supported, FW supports receiving and trasmitting * frames in raw mode. */ ATH10K_FW_FEATURE_RAW_MODE_SUPPORT = 10, /* keep last */ ATH10K_FW_FEATURE_COUNT, }; enum ath10k_dev_flags { /* Indicates that ath10k device is during CAC phase of DFS */ ATH10K_CAC_RUNNING, ATH10K_FLAG_CORE_REGISTERED, /* Device has crashed and needs to restart. This indicates any pending * waiters should immediately cancel instead of waiting for a time out. */ ATH10K_FLAG_CRASH_FLUSH, /* Use Raw mode instead of native WiFi Tx/Rx encap mode. * Raw mode supports both hardware and software crypto. Native WiFi only * supports hardware crypto. */ ATH10K_FLAG_RAW_MODE, /* Disable HW crypto engine */ ATH10K_FLAG_HW_CRYPTO_DISABLED, }; enum ath10k_cal_mode { ATH10K_CAL_MODE_FILE, ATH10K_CAL_MODE_OTP, ATH10K_CAL_MODE_DT, }; enum ath10k_crypt_mode { /* Only use hardware crypto engine */ ATH10K_CRYPT_MODE_HW, /* Only use software crypto engine */ ATH10K_CRYPT_MODE_SW, }; static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode) { switch (mode) { case ATH10K_CAL_MODE_FILE: return "file"; case ATH10K_CAL_MODE_OTP: return "otp"; case ATH10K_CAL_MODE_DT: return "dt"; } return "unknown"; } enum ath10k_scan_state { ATH10K_SCAN_IDLE, ATH10K_SCAN_STARTING, ATH10K_SCAN_RUNNING, ATH10K_SCAN_ABORTING, }; static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state) { switch (state) { case ATH10K_SCAN_IDLE: return "idle"; case ATH10K_SCAN_STARTING: return "starting"; case ATH10K_SCAN_RUNNING: return "running"; case ATH10K_SCAN_ABORTING: return "aborting"; } return "unknown"; } enum ath10k_tx_pause_reason { ATH10K_TX_PAUSE_Q_FULL, ATH10K_TX_PAUSE_MAX, }; struct ath10k { struct ath_common ath_common; struct ieee80211_hw *hw; struct device *dev; u8 mac_addr[ETH_ALEN]; enum ath10k_hw_rev hw_rev; u32 chip_id; u32 target_version; u8 fw_version_major; u32 fw_version_minor; u16 fw_version_release; u16 fw_version_build; u32 fw_stats_req_mask; u32 phy_capability; u32 hw_min_tx_power; u32 hw_max_tx_power; u32 ht_cap_info; u32 vht_cap_info; u32 num_rf_chains; u32 max_spatial_stream; /* protected by conf_mutex */ bool ani_enabled; DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT); bool p2p; struct { enum ath10k_bus bus; const struct ath10k_hif_ops *ops; } hif; struct completion target_suspend; const struct ath10k_hw_regs *regs; const struct ath10k_hw_values *hw_values; struct ath10k_bmi bmi; struct ath10k_wmi wmi; struct ath10k_htc htc; struct ath10k_htt htt; struct ath10k_hw_params { u32 id; const char *name; u32 patch_load_addr; int uart_pin; u32 otp_exe_param; /* This is true if given HW chip has a quirky Cycle Counter * wraparound which resets to 0x7fffffff instead of 0. All * other CC related counters (e.g. Rx Clear Count) are divided * by 2 so they never wraparound themselves. */ bool has_shifted_cc_wraparound; /* Some of chip expects fragment descriptor to be continuous * memory for any TX operation. Set continuous_frag_desc flag * for the hardware which have such requirement. */ bool continuous_frag_desc; u32 channel_counters_freq_hz; struct ath10k_hw_params_fw { const char *dir; const char *fw; const char *otp; const char *board; size_t board_size; size_t board_ext_size; } fw; } hw_params; const struct firmware *board; const void *board_data; size_t board_len; const struct firmware *otp; const void *otp_data; size_t otp_len; const struct firmware *firmware; const void *firmware_data; size_t firmware_len; const struct firmware *cal_file; struct { const void *firmware_codeswap_data; size_t firmware_codeswap_len; struct ath10k_swap_code_seg_info *firmware_swap_code_seg_info; } swap; char spec_board_id[100]; bool spec_board_loaded; int fw_api; enum ath10k_cal_mode cal_mode; struct { struct completion started; struct completion completed; struct completion on_channel; struct delayed_work timeout; enum ath10k_scan_state state; bool is_roc; int vdev_id; int roc_freq; bool roc_notify; } scan; struct { struct ieee80211_supported_band sbands[IEEE80211_NUM_BANDS]; } mac; /* should never be NULL; needed for regular htt rx */ struct ieee80211_channel *rx_channel; /* valid during scan; needed for mgmt rx during scan */ struct ieee80211_channel *scan_channel; /* current operating channel definition */ struct cfg80211_chan_def chandef; unsigned long long free_vdev_map; struct ath10k_vif *monitor_arvif; bool monitor; int monitor_vdev_id; bool monitor_started; unsigned int filter_flags; unsigned long dev_flags; u32 dfs_block_radar_events; /* protected by conf_mutex */ bool radar_enabled; int num_started_vdevs; /* Protected by conf-mutex */ u8 supp_tx_chainmask; u8 supp_rx_chainmask; u8 cfg_tx_chainmask; u8 cfg_rx_chainmask; struct completion install_key_done; struct completion vdev_setup_done; struct workqueue_struct *workqueue; /* Auxiliary workqueue */ struct workqueue_struct *workqueue_aux; /* prevents concurrent FW reconfiguration */ struct mutex conf_mutex; /* protects shared structure data */ spinlock_t data_lock; struct list_head arvifs; struct list_head peers; wait_queue_head_t peer_mapping_wq; /* protected by conf_mutex */ int num_peers; int num_stations; int max_num_peers; int max_num_stations; int max_num_vdevs; int max_num_tdls_vdevs; int num_active_peers; int num_tids; struct work_struct svc_rdy_work; struct sk_buff *svc_rdy_skb; struct work_struct offchan_tx_work; struct sk_buff_head offchan_tx_queue; struct completion offchan_tx_completed; struct sk_buff *offchan_tx_skb; struct work_struct wmi_mgmt_tx_work; struct sk_buff_head wmi_mgmt_tx_queue; enum ath10k_state state; struct work_struct register_work; struct work_struct restart_work; /* cycle count is reported twice for each visited channel during scan. * access protected by data_lock */ u32 survey_last_rx_clear_count; u32 survey_last_cycle_count; struct survey_info survey[ATH10K_NUM_CHANS]; /* Channel info events are expected to come in pairs without and with * COMPLETE flag set respectively for each channel visit during scan. * * However there are deviations from this rule. This flag is used to * avoid reporting garbage data. */ bool ch_info_can_report_survey; struct dfs_pattern_detector *dfs_detector; unsigned long tx_paused; /* see ATH10K_TX_PAUSE_ */ #ifdef CONFIG_ATH10K_DEBUGFS struct ath10k_debug debug; #endif struct { /* relay(fs) channel for spectral scan */ struct rchan *rfs_chan_spec_scan; /* spectral_mode and spec_config are protected by conf_mutex */ enum ath10k_spectral_mode mode; struct ath10k_spec_scan config; } spectral; struct { /* protected by conf_mutex */ const struct firmware *utf; DECLARE_BITMAP(orig_fw_features, ATH10K_FW_FEATURE_COUNT); enum ath10k_fw_wmi_op_version orig_wmi_op_version; /* protected by data_lock */ bool utf_monitor; } testmode; struct { /* protected by data_lock */ u32 fw_crash_counter; u32 fw_warm_reset_counter; u32 fw_cold_reset_counter; } stats; struct ath10k_thermal thermal; struct ath10k_wow wow; /* must be last */ u8 drv_priv[0] __aligned(sizeof(void *)); }; struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev, enum ath10k_bus bus, enum ath10k_hw_rev hw_rev, const struct ath10k_hif_ops *hif_ops); void ath10k_core_destroy(struct ath10k *ar); void ath10k_core_get_fw_features_str(struct ath10k *ar, char *buf, size_t max_len); int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode); int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt); void ath10k_core_stop(struct ath10k *ar); int ath10k_core_register(struct ath10k *ar, u32 chip_id); void ath10k_core_unregister(struct ath10k *ar); #endif /* _CORE_H_ */