core.h 12.8 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*
 * 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 <linux/completion.h>
#include <linux/if_ether.h>
#include <linux/types.h>
#include <linux/pci.h>
25 26
#include <linux/uuid.h>
#include <linux/time.h>
27

28
#include "htt.h"
29 30 31 32 33 34
#include "htc.h"
#include "hw.h"
#include "targaddrs.h"
#include "wmi.h"
#include "../ath.h"
#include "../regd.h"
J
Janusz Dziedzic 已提交
35
#include "../dfs_pattern_detector.h"
36
#include "spectral.h"
37 38 39 40 41 42 43 44

#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)
M
Michal Kazior 已提交
45
#define ATH10K_NUM_CHANS 38
46 47 48 49

/* Antenna noise floor */
#define ATH10K_DEFAULT_NOISE_FLOOR -95

50
#define ATH10K_MAX_NUM_MGMT_PENDING 128
51

52 53 54 55 56 57 58 59 60 61 62 63
/* number of failed packets */
#define ATH10K_KICKOUT_THRESHOLD 50

/*
 * 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

64 65 66 67
struct ath10k;

struct ath10k_skb_cb {
	dma_addr_t paddr;
68
	u8 vdev_id;
69 70 71 72

	struct {
		u8 tid;
		bool is_offchan;
73 74
		struct ath10k_htt_txbuf *txbuf;
		u32 txbuf_paddr;
75
	} __packed htt;
76 77 78 79 80

	struct {
		bool dtim_zero;
		bool deliver_cab;
	} bcn;
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
} __packed;

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 u32 host_interest_item_address(u32 item_offset)
{
	return QCA988X_HOST_INTEREST_ADDRESS + item_offset;
}

struct ath10k_bmi {
	bool done_sent;
};

99 100 101 102 103 104 105
struct ath10k_mem_chunk {
	void *vaddr;
	dma_addr_t paddr;
	u32 len;
	u32 req_id;
};

106 107 108 109
struct ath10k_wmi {
	enum ath10k_htc_ep_id eid;
	struct completion service_ready;
	struct completion unified_ready;
110
	wait_queue_head_t tx_credits_wq;
111
	struct wmi_cmd_map *cmd;
112
	struct wmi_vdev_param_map *vdev_param;
113
	struct wmi_pdev_param_map *pdev_param;
114 115

	u32 num_mem_chunks;
116
	struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS];
117 118
};

119
struct ath10k_fw_stats_peer {
120 121 122
	u8 peer_macaddr[ETH_ALEN];
	u32 peer_rssi;
	u32 peer_tx_rate;
B
Ben Greear 已提交
123
	u32 peer_rx_rate; /* 10x only */
124 125
};

126
struct ath10k_fw_stats {
127 128 129 130 131 132 133 134
	/* 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;
135 136 137 138 139 140
	u32 ack_rx_bad;
	u32 rts_bad;
	u32 rts_good;
	u32 fcs_bad;
	u32 no_beacons;
	u32 mib_int_count;
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185

	/* 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;

	/* VDEV STATS */

	/* PEER STATS */
	u8 peers;
186
	struct ath10k_fw_stats_peer peer_stat[TARGET_NUM_PEERS];
187 188 189 190 191

	/* TODO: Beacon filter stats */

};

J
Janusz Dziedzic 已提交
192 193 194 195 196 197 198 199
struct ath10k_dfs_stats {
	u32 phy_errors;
	u32 pulses_total;
	u32 pulses_detected;
	u32 pulses_discarded;
	u32 radar_detected;
};

200 201 202 203 204 205 206 207 208 209
#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);
	struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1];
};

210 211 212 213 214 215 216 217 218 219 220 221
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;
};

222 223 224
#define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5*HZ)

struct ath10k_vif {
M
Michal Kazior 已提交
225 226
	struct list_head list;

227 228 229 230 231
	u32 vdev_id;
	enum wmi_vdev_type vdev_type;
	enum wmi_vdev_subtype vdev_subtype;
	u32 beacon_interval;
	u32 dtim_period;
232
	struct sk_buff *beacon;
233 234
	/* protected by data_lock */
	bool beacon_sent;
235 236
	void *beacon_buf;
	dma_addr_t beacon_paddr;
237 238 239 240

	struct ath10k *ar;
	struct ieee80211_vif *vif;

241 242
	bool is_started;
	bool is_up;
243
	bool spectral_enabled;
244 245 246
	u32 aid;
	u8 bssid[ETH_ALEN];

247
	struct work_struct wep_key_work;
248
	struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1];
249 250
	u8 def_wep_key_idx;
	u8 def_wep_key_newidx;
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269

	u16 tx_seq_no;

	union {
		struct {
			u32 uapsd;
		} sta;
		struct {
			/* 127 stations; wmi limit */
			u8 tim_bitmap[16];
			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;
270 271 272

	u8 fixed_rate;
	u8 fixed_nss;
273
	u8 force_sgi;
274 275
	bool use_cts_prot;
	int num_legacy_stations;
276 277 278 279 280 281 282
};

struct ath10k_vif_iter {
	u32 vdev_id;
	struct ath10k_vif *arvif;
};

283 284 285 286 287 288 289 290 291
/* 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];
};

292 293 294
struct ath10k_debug {
	struct dentry *debugfs_phy;

295 296
	struct ath10k_fw_stats fw_stats;
	struct completion fw_stats_complete;
297
	DECLARE_BITMAP(wmi_service_bitmap, WMI_SERVICE_MAX);
298

299 300
	unsigned long htt_stats_mask;
	struct delayed_work htt_stats_dwork;
J
Janusz Dziedzic 已提交
301 302
	struct ath10k_dfs_stats dfs_stats;
	struct ath_dfs_pool_stats dfs_pool_stats;
303 304

	u32 fw_dbglog_mask;
305 306 307

	u8 htt_max_amsdu;
	u8 htt_max_ampdu;
308 309

	struct ath10k_fw_crash_data *fw_crash_data;
310 311
};

312 313 314
enum ath10k_state {
	ATH10K_STATE_OFF = 0,
	ATH10K_STATE_ON,
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331

	/* 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 restart_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,
K
Kalle Valo 已提交
332 333 334 335 336 337 338 339 340 341 342

	/* 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,
343 344
};

345 346 347 348
enum ath10k_fw_features {
	/* wmi_mgmt_rx_hdr contains extra RSSI information */
	ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0,

349 350 351
	/* firmware from 10X branch */
	ATH10K_FW_FEATURE_WMI_10X = 1,

352 353 354
	/* firmware support tx frame management over WMI, otherwise it's HTT */
	ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2,

355 356 357
	/* Firmware does not support P2P */
	ATH10K_FW_FEATURE_NO_P2P = 3,

358 359 360 361 362
	/* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature bit
	 * is required to be set as well.
	 */
	ATH10K_FW_FEATURE_WMI_10_2 = 4,

363 364 365 366
	/* keep last */
	ATH10K_FW_FEATURE_COUNT,
};

367 368 369
enum ath10k_dev_flags {
	/* Indicates that ath10k device is during CAC phase of DFS */
	ATH10K_CAC_RUNNING,
370
	ATH10K_FLAG_CORE_REGISTERED,
371 372
};

373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
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";
}

396 397 398 399 400 401
struct ath10k {
	struct ath_common ath_common;
	struct ieee80211_hw *hw;
	struct device *dev;
	u8 mac_addr[ETH_ALEN];

402
	u32 chip_id;
403 404 405 406 407 408 409 410 411 412
	u32 target_version;
	u8 fw_version_major;
	u32 fw_version_minor;
	u16 fw_version_release;
	u16 fw_version_build;
	u32 phy_capability;
	u32 hw_min_tx_power;
	u32 hw_max_tx_power;
	u32 ht_cap_info;
	u32 vht_cap_info;
413
	u32 num_rf_chains;
414

415 416
	DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT);

417 418 419 420 421 422 423 424 425
	struct targetdef *targetdef;
	struct hostdef *hostdef;

	bool p2p;

	struct {
		const struct ath10k_hif_ops *ops;
	} hif;

426
	struct completion target_suspend;
427 428

	struct ath10k_bmi bmi;
429
	struct ath10k_wmi wmi;
430
	struct ath10k_htc htc;
431
	struct ath10k_htt htt;
432 433 434 435 436 437 438 439 440 441 442 443 444 445

	struct ath10k_hw_params {
		u32 id;
		const char *name;
		u32 patch_load_addr;

		struct ath10k_hw_params_fw {
			const char *dir;
			const char *fw;
			const char *otp;
			const char *board;
		} fw;
	} hw_params;

446
	const struct firmware *board;
447 448 449
	const void *board_data;
	size_t board_len;

450
	const struct firmware *otp;
451 452 453
	const void *otp_data;
	size_t otp_len;

454
	const struct firmware *firmware;
455 456
	const void *firmware_data;
	size_t firmware_len;
457

458 459
	int fw_api;

460 461 462 463
	struct {
		struct completion started;
		struct completion completed;
		struct completion on_channel;
464 465
		struct delayed_work timeout;
		enum ath10k_scan_state state;
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
		bool is_roc;
		int vdev_id;
		int roc_freq;
	} 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;

481 482 483
	/* current operating channel definition */
	struct cfg80211_chan_def chandef;

484
	int free_vdev_map;
M
Michal Kazior 已提交
485
	bool monitor;
486
	int monitor_vdev_id;
M
Michal Kazior 已提交
487
	bool monitor_started;
488
	unsigned int filter_flags;
489
	unsigned long dev_flags;
490
	u32 dfs_block_radar_events;
491

492 493 494 495
	/* protected by conf_mutex */
	bool radar_enabled;
	int num_started_vdevs;

496 497 498 499 500 501
	/* Protected by conf-mutex */
	u8 supp_tx_chainmask;
	u8 supp_rx_chainmask;
	u8 cfg_tx_chainmask;
	u8 cfg_rx_chainmask;

502 503 504 505 506 507 508 509 510 511 512 513 514
	struct wmi_pdev_set_wmm_params_arg wmm_params;
	struct completion install_key_done;

	struct completion vdev_setup_done;

	struct workqueue_struct *workqueue;

	/* prevents concurrent FW reconfiguration */
	struct mutex conf_mutex;

	/* protects shared structure data */
	spinlock_t data_lock;

M
Michal Kazior 已提交
515
	struct list_head arvifs;
516 517 518
	struct list_head peers;
	wait_queue_head_t peer_mapping_wq;

519 520 521
	/* number of created peers; protected by data_lock */
	int num_peers;

522 523 524 525 526
	struct work_struct offchan_tx_work;
	struct sk_buff_head offchan_tx_queue;
	struct completion offchan_tx_completed;
	struct sk_buff *offchan_tx_skb;

527 528 529
	struct work_struct wmi_mgmt_tx_work;
	struct sk_buff_head wmi_mgmt_tx_queue;

530 531
	enum ath10k_state state;

532
	struct work_struct register_work;
533 534
	struct work_struct restart_work;

M
Michal Kazior 已提交
535 536 537 538 539 540
	/* 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];

J
Janusz Dziedzic 已提交
541 542
	struct dfs_pattern_detector *dfs_detector;

543 544 545
#ifdef CONFIG_ATH10K_DEBUGFS
	struct ath10k_debug debug;
#endif
546 547 548 549 550 551 552 553 554

	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;
M
Michal Kazior 已提交
555

K
Kalle Valo 已提交
556 557 558 559 560 561 562 563 564
	struct {
		/* protected by conf_mutex */
		const struct firmware *utf;
		DECLARE_BITMAP(orig_fw_features, ATH10K_FW_FEATURE_COUNT);

		/* protected by data_lock */
		bool utf_monitor;
	} testmode;

M
Michal Kazior 已提交
565 566
	/* must be last */
	u8 drv_priv[0] __aligned(sizeof(void *));
567 568
};

M
Michal Kazior 已提交
569
struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
570 571 572
				  const struct ath10k_hif_ops *hif_ops);
void ath10k_core_destroy(struct ath10k *ar);

K
Kalle Valo 已提交
573
int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode);
574
int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt);
575
void ath10k_core_stop(struct ath10k *ar);
576
int ath10k_core_register(struct ath10k *ar, u32 chip_id);
577 578 579
void ath10k_core_unregister(struct ath10k *ar);

#endif /* _CORE_H_ */