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"
40 #define MS(_v, _f) (((_v) & _f##_MASK) >> _f##_LSB)
41 #define SM(_v, _f) (((_v) << _f##_LSB) & _f##_MASK)
42 #define WO(_f) ((_f##_OFFSET) >> 2)
44 #define ATH10K_SCAN_ID 0
45 #define WMI_READY_TIMEOUT (5 * HZ)
46 #define ATH10K_FLUSH_TIMEOUT_HZ (5*HZ)
47 #define ATH10K_CONNECTION_LOSS_HZ (3*HZ)
48 #define ATH10K_NUM_CHANS 39
50 /* Antenna noise floor */
51 #define ATH10K_DEFAULT_NOISE_FLOOR -95
53 #define ATH10K_MAX_NUM_MGMT_PENDING 128
55 /* number of failed packets (20 packets with 16 sw reties each) */
56 #define ATH10K_KICKOUT_THRESHOLD (20 * 16)
59 * Use insanely high numbers to make sure that the firmware implementation
60 * won't start, we have the same functionality already in hostapd. Unit
63 #define ATH10K_KEEPALIVE_MIN_IDLE 3747
64 #define ATH10K_KEEPALIVE_MAX_IDLE 3895
65 #define ATH10K_KEEPALIVE_MAX_UNRESPONSIVE 3900
73 static inline const char *ath10k_bus_str(enum ath10k_bus bus
)
83 struct ath10k_skb_cb
{
87 enum ath10k_hw_txrx_mode txmode
;
94 struct ath10k_htt_txbuf
*txbuf
;
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
;
154 struct ath10k_mem_chunk mem_chunks
[WMI_MAX_MEM_REQS
];
157 struct ath10k_fw_stats_peer
{
158 struct list_head list
;
160 u8 peer_macaddr
[ETH_ALEN
];
163 u32 peer_rx_rate
; /* 10x only */
166 struct ath10k_fw_stats_vdev
{
167 struct list_head list
;
172 u32 num_tx_frames
[4];
174 u32 num_tx_frames_retries
[4];
175 u32 num_tx_frames_failures
[4];
180 u32 num_tx_not_acked
;
181 u32 tx_rate_history
[10];
182 u32 beacon_rssi_history
[10];
185 struct ath10k_fw_stats_pdev
{
186 struct list_head list
;
219 u32 sw_retry_failure
;
220 u32 illgl_rate_phy_err
;
221 u32 pdev_cont_xretry
;
228 s32 mid_ppdu_route_change
;
244 struct ath10k_fw_stats
{
245 struct list_head pdevs
;
246 struct list_head vdevs
;
247 struct list_head peers
;
250 struct ath10k_dfs_stats
{
254 u32 pulses_discarded
;
258 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
261 struct list_head list
;
264 DECLARE_BITMAP(peer_ids
, ATH10K_MAX_NUM_PEER_IDS
);
266 /* protected by ar->data_lock */
267 struct ieee80211_key_conf
*keys
[WMI_MAX_KEY_INDEX
+ 1];
271 struct ath10k_vif
*arvif
;
273 /* the following are protected by ar->data_lock */
274 u32 changed
; /* IEEE80211_RC_* */
279 struct work_struct update_wk
;
281 #ifdef CONFIG_MAC80211_DEBUGFS
282 /* protected by conf_mutex */
287 struct ath10k_chanctx
{
288 /* Used to story copy of chanctx_conf to avoid inconsistencies. Ideally
289 * mac80211 should allow some sort of explicit locking to guarantee
290 * that the publicly available chanctx_conf can be accessed safely at
293 struct ieee80211_chanctx_conf conf
;
296 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5*HZ)
298 enum ath10k_beacon_state
{
299 ATH10K_BEACON_SCHEDULED
= 0,
300 ATH10K_BEACON_SENDING
,
305 struct list_head list
;
308 enum wmi_vdev_type vdev_type
;
309 enum wmi_vdev_subtype vdev_subtype
;
312 struct sk_buff
*beacon
;
313 /* protected by data_lock */
314 enum ath10k_beacon_state beacon_state
;
316 dma_addr_t beacon_paddr
;
317 unsigned long tx_paused
; /* arbitrary values defined by target */
320 struct ieee80211_vif
*vif
;
324 bool spectral_enabled
;
329 struct ieee80211_key_conf
*wep_keys
[WMI_MAX_KEY_INDEX
+ 1];
339 /* 127 stations; wmi limit */
343 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
345 /* P2P_IE with NoA attribute for P2P_GO case */
352 int num_legacy_stations
;
354 struct wmi_wmm_params_all_arg wmm_params
;
355 struct work_struct ap_csa_work
;
356 struct delayed_work connection_loss_work
;
359 struct ath10k_vif_iter
{
361 struct ath10k_vif
*arvif
;
364 /* used for crash-dump storage, protected by data-lock */
365 struct ath10k_fw_crash_data
{
366 bool crashed_since_read
;
369 struct timespec timestamp
;
370 __le32 registers
[REG_DUMP_COUNT_QCA988X
];
373 struct ath10k_debug
{
374 struct dentry
*debugfs_phy
;
376 struct ath10k_fw_stats fw_stats
;
377 struct completion fw_stats_complete
;
380 unsigned long htt_stats_mask
;
381 struct delayed_work htt_stats_dwork
;
382 struct ath10k_dfs_stats dfs_stats
;
383 struct ath_dfs_pool_stats dfs_pool_stats
;
385 /* protected by conf_mutex */
395 struct ath10k_fw_crash_data
*fw_crash_data
;
399 ATH10K_STATE_OFF
= 0,
402 /* When doing firmware recovery the device is first powered down.
403 * mac80211 is supposed to call in to start() hook later on. It is
404 * however possible that driver unloading and firmware crash overlap.
405 * mac80211 can wait on conf_mutex in stop() while the device is
406 * stopped in ath10k_core_restart() work holding conf_mutex. The state
407 * RESTARTED means that the device is up and mac80211 has started hw
408 * reconfiguration. Once mac80211 is done with the reconfiguration we
409 * set the state to STATE_ON in reconfig_complete(). */
410 ATH10K_STATE_RESTARTING
,
411 ATH10K_STATE_RESTARTED
,
413 /* The device has crashed while restarting hw. This state is like ON
414 * but commands are blocked in HTC and -ECOMM response is given. This
415 * prevents completion timeouts and makes the driver more responsive to
416 * userspace commands. This is also prevents recursive recovery. */
423 enum ath10k_firmware_mode
{
424 /* the default mode, standard 802.11 functionality */
425 ATH10K_FIRMWARE_MODE_NORMAL
,
427 /* factory tests etc */
428 ATH10K_FIRMWARE_MODE_UTF
,
431 enum ath10k_fw_features
{
432 /* wmi_mgmt_rx_hdr contains extra RSSI information */
433 ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX
= 0,
435 /* Firmware from 10X branch. Deprecated, don't use in new code. */
436 ATH10K_FW_FEATURE_WMI_10X
= 1,
438 /* firmware support tx frame management over WMI, otherwise it's HTT */
439 ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX
= 2,
441 /* Firmware does not support P2P */
442 ATH10K_FW_FEATURE_NO_P2P
= 3,
444 /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature
445 * bit is required to be set as well. Deprecated, don't use in new
448 ATH10K_FW_FEATURE_WMI_10_2
= 4,
450 /* Some firmware revisions lack proper multi-interface client powersave
451 * implementation. Enabling PS could result in connection drops,
452 * traffic stalls, etc.
454 ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT
= 5,
456 /* Some firmware revisions have an incomplete WoWLAN implementation
457 * despite WMI service bit being advertised. This feature flag is used
458 * to distinguish whether WoWLAN is really supported or not.
460 ATH10K_FW_FEATURE_WOWLAN_SUPPORT
= 6,
463 ATH10K_FW_FEATURE_COUNT
,
466 enum ath10k_dev_flags
{
467 /* Indicates that ath10k device is during CAC phase of DFS */
469 ATH10K_FLAG_CORE_REGISTERED
,
471 /* Device has crashed and needs to restart. This indicates any pending
472 * waiters should immediately cancel instead of waiting for a time out.
474 ATH10K_FLAG_CRASH_FLUSH
,
477 enum ath10k_cal_mode
{
478 ATH10K_CAL_MODE_FILE
,
483 static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode
)
486 case ATH10K_CAL_MODE_FILE
:
488 case ATH10K_CAL_MODE_OTP
:
490 case ATH10K_CAL_MODE_DT
:
497 enum ath10k_scan_state
{
499 ATH10K_SCAN_STARTING
,
501 ATH10K_SCAN_ABORTING
,
504 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state
)
507 case ATH10K_SCAN_IDLE
:
509 case ATH10K_SCAN_STARTING
:
511 case ATH10K_SCAN_RUNNING
:
513 case ATH10K_SCAN_ABORTING
:
520 enum ath10k_tx_pause_reason
{
521 ATH10K_TX_PAUSE_Q_FULL
,
526 struct ath_common ath_common
;
527 struct ieee80211_hw
*hw
;
529 u8 mac_addr
[ETH_ALEN
];
531 enum ath10k_hw_rev hw_rev
;
535 u32 fw_version_minor
;
536 u16 fw_version_release
;
537 u16 fw_version_build
;
538 u32 fw_stats_req_mask
;
545 /* protected by conf_mutex */
548 DECLARE_BITMAP(fw_features
, ATH10K_FW_FEATURE_COUNT
);
554 const struct ath10k_hif_ops
*ops
;
557 struct completion target_suspend
;
559 const struct ath10k_hw_regs
*regs
;
560 struct ath10k_bmi bmi
;
561 struct ath10k_wmi wmi
;
562 struct ath10k_htc htc
;
563 struct ath10k_htt htt
;
565 struct ath10k_hw_params
{
571 struct ath10k_hw_params_fw
{
577 size_t board_ext_size
;
581 const struct firmware
*board
;
582 const void *board_data
;
585 const struct firmware
*otp
;
586 const void *otp_data
;
589 const struct firmware
*firmware
;
590 const void *firmware_data
;
593 const struct firmware
*cal_file
;
595 char spec_board_id
[100];
596 bool spec_board_loaded
;
599 enum ath10k_cal_mode cal_mode
;
602 struct completion started
;
603 struct completion completed
;
604 struct completion on_channel
;
605 struct delayed_work timeout
;
606 enum ath10k_scan_state state
;
613 struct ieee80211_supported_band sbands
[IEEE80211_NUM_BANDS
];
616 /* should never be NULL; needed for regular htt rx */
617 struct ieee80211_channel
*rx_channel
;
619 /* valid during scan; needed for mgmt rx during scan */
620 struct ieee80211_channel
*scan_channel
;
622 /* current operating channel definition */
623 struct cfg80211_chan_def chandef
;
625 unsigned long long free_vdev_map
;
626 struct ath10k_vif
*monitor_arvif
;
629 bool monitor_started
;
630 unsigned int filter_flags
;
631 unsigned long dev_flags
;
632 u32 dfs_block_radar_events
;
634 /* protected by conf_mutex */
636 int num_started_vdevs
;
638 /* Protected by conf-mutex */
639 u8 supp_tx_chainmask
;
640 u8 supp_rx_chainmask
;
644 struct completion install_key_done
;
646 struct completion vdev_setup_done
;
648 struct workqueue_struct
*workqueue
;
650 /* prevents concurrent FW reconfiguration */
651 struct mutex conf_mutex
;
653 /* protects shared structure data */
654 spinlock_t data_lock
;
656 struct list_head arvifs
;
657 struct list_head peers
;
658 wait_queue_head_t peer_mapping_wq
;
660 /* protected by conf_mutex */
665 int max_num_stations
;
667 int max_num_tdls_vdevs
;
669 struct work_struct offchan_tx_work
;
670 struct sk_buff_head offchan_tx_queue
;
671 struct completion offchan_tx_completed
;
672 struct sk_buff
*offchan_tx_skb
;
674 struct work_struct wmi_mgmt_tx_work
;
675 struct sk_buff_head wmi_mgmt_tx_queue
;
677 enum ath10k_state state
;
679 struct work_struct register_work
;
680 struct work_struct restart_work
;
682 /* cycle count is reported twice for each visited channel during scan.
683 * access protected by data_lock */
684 u32 survey_last_rx_clear_count
;
685 u32 survey_last_cycle_count
;
686 struct survey_info survey
[ATH10K_NUM_CHANS
];
688 struct dfs_pattern_detector
*dfs_detector
;
690 unsigned long tx_paused
; /* see ATH10K_TX_PAUSE_ */
692 #ifdef CONFIG_ATH10K_DEBUGFS
693 struct ath10k_debug debug
;
697 /* relay(fs) channel for spectral scan */
698 struct rchan
*rfs_chan_spec_scan
;
700 /* spectral_mode and spec_config are protected by conf_mutex */
701 enum ath10k_spectral_mode mode
;
702 struct ath10k_spec_scan config
;
706 /* protected by conf_mutex */
707 const struct firmware
*utf
;
708 DECLARE_BITMAP(orig_fw_features
, ATH10K_FW_FEATURE_COUNT
);
709 enum ath10k_fw_wmi_op_version orig_wmi_op_version
;
711 /* protected by data_lock */
716 /* protected by data_lock */
717 u32 fw_crash_counter
;
718 u32 fw_warm_reset_counter
;
719 u32 fw_cold_reset_counter
;
722 struct ath10k_thermal thermal
;
723 struct ath10k_wow wow
;
726 u8 drv_priv
[0] __aligned(sizeof(void *));
729 struct ath10k
*ath10k_core_create(size_t priv_size
, struct device
*dev
,
731 enum ath10k_hw_rev hw_rev
,
732 const struct ath10k_hif_ops
*hif_ops
);
733 void ath10k_core_destroy(struct ath10k
*ar
);
735 int ath10k_core_start(struct ath10k
*ar
, enum ath10k_firmware_mode mode
);
736 int ath10k_wait_for_suspend(struct ath10k
*ar
, u32 suspend_opt
);
737 void ath10k_core_stop(struct ath10k
*ar
);
738 int ath10k_core_register(struct ath10k
*ar
, u32 chip_id
);
739 void ath10k_core_unregister(struct ath10k
*ar
);
741 #endif /* _CORE_H_ */