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"
38 #define MS(_v, _f) (((_v) & _f##_MASK) >> _f##_LSB)
39 #define SM(_v, _f) (((_v) << _f##_LSB) & _f##_MASK)
40 #define WO(_f) ((_f##_OFFSET) >> 2)
42 #define ATH10K_SCAN_ID 0
43 #define WMI_READY_TIMEOUT (5 * HZ)
44 #define ATH10K_FLUSH_TIMEOUT_HZ (5*HZ)
45 #define ATH10K_NUM_CHANS 38
47 /* Antenna noise floor */
48 #define ATH10K_DEFAULT_NOISE_FLOOR -95
50 #define ATH10K_MAX_NUM_MGMT_PENDING 128
52 /* number of failed packets */
53 #define ATH10K_KICKOUT_THRESHOLD 50
56 * Use insanely high numbers to make sure that the firmware implementation
57 * won't start, we have the same functionality already in hostapd. Unit
60 #define ATH10K_KEEPALIVE_MIN_IDLE 3747
61 #define ATH10K_KEEPALIVE_MAX_IDLE 3895
62 #define ATH10K_KEEPALIVE_MAX_UNRESPONSIVE 3900
66 struct ath10k_skb_cb
{
73 struct ath10k_htt_txbuf
*txbuf
;
83 static inline struct ath10k_skb_cb
*ATH10K_SKB_CB(struct sk_buff
*skb
)
85 BUILD_BUG_ON(sizeof(struct ath10k_skb_cb
) >
86 IEEE80211_TX_INFO_DRIVER_DATA_SIZE
);
87 return (struct ath10k_skb_cb
*)&IEEE80211_SKB_CB(skb
)->driver_data
;
90 static inline u32
host_interest_item_address(u32 item_offset
)
92 return QCA988X_HOST_INTEREST_ADDRESS
+ item_offset
;
99 #define ATH10K_MAX_MEM_REQS 16
101 struct ath10k_mem_chunk
{
109 enum ath10k_htc_ep_id eid
;
110 struct completion service_ready
;
111 struct completion unified_ready
;
112 wait_queue_head_t tx_credits_wq
;
113 struct wmi_cmd_map
*cmd
;
114 struct wmi_vdev_param_map
*vdev_param
;
115 struct wmi_pdev_param_map
*pdev_param
;
118 struct ath10k_mem_chunk mem_chunks
[ATH10K_MAX_MEM_REQS
];
121 struct ath10k_peer_stat
{
122 u8 peer_macaddr
[ETH_ALEN
];
125 u32 peer_rx_rate
; /* 10x only */
128 struct ath10k_target_stats
{
160 u32 sw_retry_failure
;
161 u32 illgl_rate_phy_err
;
162 u32 pdev_cont_xretry
;
169 s32 mid_ppdu_route_change
;
188 struct ath10k_peer_stat peer_stat
[TARGET_NUM_PEERS
];
190 /* TODO: Beacon filter stats */
194 struct ath10k_dfs_stats
{
198 u32 pulses_discarded
;
202 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */
205 struct list_head list
;
208 DECLARE_BITMAP(peer_ids
, ATH10K_MAX_NUM_PEER_IDS
);
209 struct ieee80211_key_conf
*keys
[WMI_MAX_KEY_INDEX
+ 1];
213 struct ath10k_vif
*arvif
;
215 /* the following are protected by ar->data_lock */
216 u32 changed
; /* IEEE80211_RC_* */
221 struct work_struct update_wk
;
224 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5*HZ)
227 struct list_head list
;
230 enum wmi_vdev_type vdev_type
;
231 enum wmi_vdev_subtype vdev_subtype
;
234 struct sk_buff
*beacon
;
235 /* protected by data_lock */
239 struct ieee80211_vif
*vif
;
243 bool spectral_enabled
;
247 struct work_struct wep_key_work
;
248 struct ieee80211_key_conf
*wep_keys
[WMI_MAX_KEY_INDEX
+ 1];
250 u8 def_wep_key_newidx
;
259 /* 127 stations; wmi limit */
263 u8 ssid
[IEEE80211_MAX_SSID_LEN
];
265 /* P2P_IE with NoA attribute for P2P_GO case */
275 int num_legacy_stations
;
278 struct ath10k_vif_iter
{
280 struct ath10k_vif
*arvif
;
283 /* used for crash-dump storage, protected by data-lock */
284 struct ath10k_fw_crash_data
{
285 bool crashed_since_read
;
288 struct timespec timestamp
;
289 __le32 registers
[REG_DUMP_COUNT_QCA988X
];
292 struct ath10k_debug
{
293 struct dentry
*debugfs_phy
;
295 struct ath10k_target_stats target_stats
;
296 DECLARE_BITMAP(wmi_service_bitmap
, WMI_SERVICE_MAX
);
298 struct completion event_stats_compl
;
300 unsigned long htt_stats_mask
;
301 struct delayed_work htt_stats_dwork
;
302 struct ath10k_dfs_stats dfs_stats
;
303 struct ath_dfs_pool_stats dfs_pool_stats
;
310 struct ath10k_fw_crash_data
*fw_crash_data
;
314 ATH10K_STATE_OFF
= 0,
317 /* When doing firmware recovery the device is first powered down.
318 * mac80211 is supposed to call in to start() hook later on. It is
319 * however possible that driver unloading and firmware crash overlap.
320 * mac80211 can wait on conf_mutex in stop() while the device is
321 * stopped in ath10k_core_restart() work holding conf_mutex. The state
322 * RESTARTED means that the device is up and mac80211 has started hw
323 * reconfiguration. Once mac80211 is done with the reconfiguration we
324 * set the state to STATE_ON in restart_complete(). */
325 ATH10K_STATE_RESTARTING
,
326 ATH10K_STATE_RESTARTED
,
328 /* The device has crashed while restarting hw. This state is like ON
329 * but commands are blocked in HTC and -ECOMM response is given. This
330 * prevents completion timeouts and makes the driver more responsive to
331 * userspace commands. This is also prevents recursive recovery. */
338 enum ath10k_firmware_mode
{
339 /* the default mode, standard 802.11 functionality */
340 ATH10K_FIRMWARE_MODE_NORMAL
,
342 /* factory tests etc */
343 ATH10K_FIRMWARE_MODE_UTF
,
346 enum ath10k_fw_features
{
347 /* wmi_mgmt_rx_hdr contains extra RSSI information */
348 ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX
= 0,
350 /* firmware from 10X branch */
351 ATH10K_FW_FEATURE_WMI_10X
= 1,
353 /* firmware support tx frame management over WMI, otherwise it's HTT */
354 ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX
= 2,
356 /* Firmware does not support P2P */
357 ATH10K_FW_FEATURE_NO_P2P
= 3,
359 /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature bit
360 * is required to be set as well.
362 ATH10K_FW_FEATURE_WMI_10_2
= 4,
365 ATH10K_FW_FEATURE_COUNT
,
368 enum ath10k_dev_flags
{
369 /* Indicates that ath10k device is during CAC phase of DFS */
371 ATH10K_FLAG_CORE_REGISTERED
,
374 enum ath10k_scan_state
{
376 ATH10K_SCAN_STARTING
,
378 ATH10K_SCAN_ABORTING
,
381 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state
)
384 case ATH10K_SCAN_IDLE
:
386 case ATH10K_SCAN_STARTING
:
388 case ATH10K_SCAN_RUNNING
:
390 case ATH10K_SCAN_ABORTING
:
398 struct ath_common ath_common
;
399 struct ieee80211_hw
*hw
;
401 u8 mac_addr
[ETH_ALEN
];
406 u32 fw_version_minor
;
407 u16 fw_version_release
;
408 u16 fw_version_build
;
416 DECLARE_BITMAP(fw_features
, ATH10K_FW_FEATURE_COUNT
);
418 struct targetdef
*targetdef
;
419 struct hostdef
*hostdef
;
424 const struct ath10k_hif_ops
*ops
;
427 struct completion target_suspend
;
429 struct ath10k_bmi bmi
;
430 struct ath10k_wmi wmi
;
431 struct ath10k_htc htc
;
432 struct ath10k_htt htt
;
434 struct ath10k_hw_params
{
439 struct ath10k_hw_params_fw
{
447 const struct firmware
*board
;
448 const void *board_data
;
451 const struct firmware
*otp
;
452 const void *otp_data
;
455 const struct firmware
*firmware
;
456 const void *firmware_data
;
462 struct completion started
;
463 struct completion completed
;
464 struct completion on_channel
;
465 struct delayed_work timeout
;
466 enum ath10k_scan_state state
;
473 struct ieee80211_supported_band sbands
[IEEE80211_NUM_BANDS
];
476 /* should never be NULL; needed for regular htt rx */
477 struct ieee80211_channel
*rx_channel
;
479 /* valid during scan; needed for mgmt rx during scan */
480 struct ieee80211_channel
*scan_channel
;
482 /* current operating channel definition */
483 struct cfg80211_chan_def chandef
;
488 bool monitor_started
;
489 unsigned int filter_flags
;
490 unsigned long dev_flags
;
491 u32 dfs_block_radar_events
;
493 /* protected by conf_mutex */
495 int num_started_vdevs
;
497 /* Protected by conf-mutex */
498 u8 supp_tx_chainmask
;
499 u8 supp_rx_chainmask
;
503 struct wmi_pdev_set_wmm_params_arg wmm_params
;
504 struct completion install_key_done
;
506 struct completion vdev_setup_done
;
508 struct workqueue_struct
*workqueue
;
510 /* prevents concurrent FW reconfiguration */
511 struct mutex conf_mutex
;
513 /* protects shared structure data */
514 spinlock_t data_lock
;
516 struct list_head arvifs
;
517 struct list_head peers
;
518 wait_queue_head_t peer_mapping_wq
;
520 /* number of created peers; protected by data_lock */
523 struct work_struct offchan_tx_work
;
524 struct sk_buff_head offchan_tx_queue
;
525 struct completion offchan_tx_completed
;
526 struct sk_buff
*offchan_tx_skb
;
528 struct work_struct wmi_mgmt_tx_work
;
529 struct sk_buff_head wmi_mgmt_tx_queue
;
531 enum ath10k_state state
;
533 struct work_struct register_work
;
534 struct work_struct restart_work
;
536 /* cycle count is reported twice for each visited channel during scan.
537 * access protected by data_lock */
538 u32 survey_last_rx_clear_count
;
539 u32 survey_last_cycle_count
;
540 struct survey_info survey
[ATH10K_NUM_CHANS
];
542 struct dfs_pattern_detector
*dfs_detector
;
544 #ifdef CONFIG_ATH10K_DEBUGFS
545 struct ath10k_debug debug
;
549 /* relay(fs) channel for spectral scan */
550 struct rchan
*rfs_chan_spec_scan
;
552 /* spectral_mode and spec_config are protected by conf_mutex */
553 enum ath10k_spectral_mode mode
;
554 struct ath10k_spec_scan config
;
558 /* protected by conf_mutex */
559 const struct firmware
*utf
;
560 DECLARE_BITMAP(orig_fw_features
, ATH10K_FW_FEATURE_COUNT
);
562 /* protected by data_lock */
567 u8 drv_priv
[0] __aligned(sizeof(void *));
570 struct ath10k
*ath10k_core_create(size_t priv_size
, struct device
*dev
,
571 const struct ath10k_hif_ops
*hif_ops
);
572 void ath10k_core_destroy(struct ath10k
*ar
);
574 int ath10k_core_start(struct ath10k
*ar
, enum ath10k_firmware_mode mode
);
575 int ath10k_wait_for_suspend(struct ath10k
*ar
, u32 suspend_opt
);
576 void ath10k_core_stop(struct ath10k
*ar
);
577 int ath10k_core_register(struct ath10k
*ar
, u32 chip_id
);
578 void ath10k_core_unregister(struct ath10k
*ar
);
580 #endif /* _CORE_H_ */