1 /* SPDX-License-Identifier: ISC */ 2 /* 3 * Copyright (c) 2005-2011 Atheros Communications Inc. 4 * Copyright (c) 2011-2017 Qualcomm Atheros, Inc. 5 * Copyright (c) 2018, The Linux Foundation. All rights reserved. 6 */ 7 8 #ifndef _CORE_H_ 9 #define _CORE_H_ 10 11 #include <linux/completion.h> 12 #include <linux/if_ether.h> 13 #include <linux/types.h> 14 #include <linux/pci.h> 15 #include <linux/uuid.h> 16 #include <linux/time.h> 17 18 #include "htt.h" 19 #include "htc.h" 20 #include "hw.h" 21 #include "targaddrs.h" 22 #include "wmi.h" 23 #include "../ath.h" 24 #include "../regd.h" 25 #include "../dfs_pattern_detector.h" 26 #include "spectral.h" 27 #include "thermal.h" 28 #include "wow.h" 29 #include "swap.h" 30 31 #define MS(_v, _f) (((_v) & _f##_MASK) >> _f##_LSB) 32 #define SM(_v, _f) (((_v) << _f##_LSB) & _f##_MASK) 33 #define WO(_f) ((_f##_OFFSET) >> 2) 34 35 #define ATH10K_SCAN_ID 0 36 #define ATH10K_SCAN_CHANNEL_SWITCH_WMI_EVT_OVERHEAD 10 /* msec */ 37 #define WMI_READY_TIMEOUT (5 * HZ) 38 #define ATH10K_FLUSH_TIMEOUT_HZ (5 * HZ) 39 #define ATH10K_CONNECTION_LOSS_HZ (3 * HZ) 40 #define ATH10K_NUM_CHANS 41 41 #define ATH10K_MAX_5G_CHAN 173 42 43 /* Antenna noise floor */ 44 #define ATH10K_DEFAULT_NOISE_FLOOR -95 45 46 #define ATH10K_INVALID_RSSI 128 47 48 #define ATH10K_MAX_NUM_MGMT_PENDING 128 49 50 /* number of failed packets (20 packets with 16 sw reties each) */ 51 #define ATH10K_KICKOUT_THRESHOLD (20 * 16) 52 53 /* 54 * Use insanely high numbers to make sure that the firmware implementation 55 * won't start, we have the same functionality already in hostapd. Unit 56 * is seconds. 57 */ 58 #define ATH10K_KEEPALIVE_MIN_IDLE 3747 59 #define ATH10K_KEEPALIVE_MAX_IDLE 3895 60 #define ATH10K_KEEPALIVE_MAX_UNRESPONSIVE 3900 61 62 /* NAPI poll budget */ 63 #define ATH10K_NAPI_BUDGET 64 64 65 /* SMBIOS type containing Board Data File Name Extension */ 66 #define ATH10K_SMBIOS_BDF_EXT_TYPE 0xF8 67 68 /* SMBIOS type structure length (excluding strings-set) */ 69 #define ATH10K_SMBIOS_BDF_EXT_LENGTH 0x9 70 71 /* Offset pointing to Board Data File Name Extension */ 72 #define ATH10K_SMBIOS_BDF_EXT_OFFSET 0x8 73 74 /* Board Data File Name Extension string length. 75 * String format: BDF_<Customer ID>_<Extension>\0 76 */ 77 #define ATH10K_SMBIOS_BDF_EXT_STR_LENGTH 0x20 78 79 /* The magic used by QCA spec */ 80 #define ATH10K_SMBIOS_BDF_EXT_MAGIC "BDF_" 81 82 /* Default Airtime weight multipler (Tuned for multiclient performance) */ 83 #define ATH10K_AIRTIME_WEIGHT_MULTIPLIER 4 84 85 struct ath10k; 86 87 static inline const char *ath10k_bus_str(enum ath10k_bus bus) 88 { 89 switch (bus) { 90 case ATH10K_BUS_PCI: 91 return "pci"; 92 case ATH10K_BUS_AHB: 93 return "ahb"; 94 case ATH10K_BUS_SDIO: 95 return "sdio"; 96 case ATH10K_BUS_USB: 97 return "usb"; 98 case ATH10K_BUS_SNOC: 99 return "snoc"; 100 } 101 102 return "unknown"; 103 } 104 105 enum ath10k_skb_flags { 106 ATH10K_SKB_F_NO_HWCRYPT = BIT(0), 107 ATH10K_SKB_F_DTIM_ZERO = BIT(1), 108 ATH10K_SKB_F_DELIVER_CAB = BIT(2), 109 ATH10K_SKB_F_MGMT = BIT(3), 110 ATH10K_SKB_F_QOS = BIT(4), 111 ATH10K_SKB_F_RAW_TX = BIT(5), 112 }; 113 114 struct ath10k_skb_cb { 115 dma_addr_t paddr; 116 u8 flags; 117 u8 eid; 118 u16 msdu_id; 119 u16 airtime_est; 120 struct ieee80211_vif *vif; 121 struct ieee80211_txq *txq; 122 } __packed; 123 124 struct ath10k_skb_rxcb { 125 dma_addr_t paddr; 126 struct hlist_node hlist; 127 }; 128 129 static inline struct ath10k_skb_cb *ATH10K_SKB_CB(struct sk_buff *skb) 130 { 131 BUILD_BUG_ON(sizeof(struct ath10k_skb_cb) > 132 IEEE80211_TX_INFO_DRIVER_DATA_SIZE); 133 return (struct ath10k_skb_cb *)&IEEE80211_SKB_CB(skb)->driver_data; 134 } 135 136 static inline struct ath10k_skb_rxcb *ATH10K_SKB_RXCB(struct sk_buff *skb) 137 { 138 BUILD_BUG_ON(sizeof(struct ath10k_skb_rxcb) > sizeof(skb->cb)); 139 return (struct ath10k_skb_rxcb *)skb->cb; 140 } 141 142 #define ATH10K_RXCB_SKB(rxcb) \ 143 container_of((void *)rxcb, struct sk_buff, cb) 144 145 static inline u32 host_interest_item_address(u32 item_offset) 146 { 147 return QCA988X_HOST_INTEREST_ADDRESS + item_offset; 148 } 149 150 struct ath10k_bmi { 151 bool done_sent; 152 }; 153 154 struct ath10k_mem_chunk { 155 void *vaddr; 156 dma_addr_t paddr; 157 u32 len; 158 u32 req_id; 159 }; 160 161 struct ath10k_wmi { 162 enum ath10k_htc_ep_id eid; 163 struct completion service_ready; 164 struct completion unified_ready; 165 struct completion barrier; 166 struct completion radar_confirm; 167 wait_queue_head_t tx_credits_wq; 168 DECLARE_BITMAP(svc_map, WMI_SERVICE_MAX); 169 struct wmi_cmd_map *cmd; 170 struct wmi_vdev_param_map *vdev_param; 171 struct wmi_pdev_param_map *pdev_param; 172 const struct wmi_ops *ops; 173 const struct wmi_peer_flags_map *peer_flags; 174 175 u32 mgmt_max_num_pending_tx; 176 177 /* Protected by data_lock */ 178 struct idr mgmt_pending_tx; 179 180 u32 num_mem_chunks; 181 u32 rx_decap_mode; 182 struct ath10k_mem_chunk mem_chunks[WMI_MAX_MEM_REQS]; 183 }; 184 185 struct ath10k_fw_stats_peer { 186 struct list_head list; 187 188 u8 peer_macaddr[ETH_ALEN]; 189 u32 peer_rssi; 190 u32 peer_tx_rate; 191 u32 peer_rx_rate; /* 10x only */ 192 u64 rx_duration; 193 }; 194 195 struct ath10k_fw_extd_stats_peer { 196 struct list_head list; 197 198 u8 peer_macaddr[ETH_ALEN]; 199 u64 rx_duration; 200 }; 201 202 struct ath10k_fw_stats_vdev { 203 struct list_head list; 204 205 u32 vdev_id; 206 u32 beacon_snr; 207 u32 data_snr; 208 u32 num_tx_frames[4]; 209 u32 num_rx_frames; 210 u32 num_tx_frames_retries[4]; 211 u32 num_tx_frames_failures[4]; 212 u32 num_rts_fail; 213 u32 num_rts_success; 214 u32 num_rx_err; 215 u32 num_rx_discard; 216 u32 num_tx_not_acked; 217 u32 tx_rate_history[10]; 218 u32 beacon_rssi_history[10]; 219 }; 220 221 struct ath10k_fw_stats_vdev_extd { 222 struct list_head list; 223 224 u32 vdev_id; 225 u32 ppdu_aggr_cnt; 226 u32 ppdu_noack; 227 u32 mpdu_queued; 228 u32 ppdu_nonaggr_cnt; 229 u32 mpdu_sw_requeued; 230 u32 mpdu_suc_retry; 231 u32 mpdu_suc_multitry; 232 u32 mpdu_fail_retry; 233 u32 tx_ftm_suc; 234 u32 tx_ftm_suc_retry; 235 u32 tx_ftm_fail; 236 u32 rx_ftmr_cnt; 237 u32 rx_ftmr_dup_cnt; 238 u32 rx_iftmr_cnt; 239 u32 rx_iftmr_dup_cnt; 240 }; 241 242 struct ath10k_fw_stats_pdev { 243 struct list_head list; 244 245 /* PDEV stats */ 246 s32 ch_noise_floor; 247 u32 tx_frame_count; /* Cycles spent transmitting frames */ 248 u32 rx_frame_count; /* Cycles spent receiving frames */ 249 u32 rx_clear_count; /* Total channel busy time, evidently */ 250 u32 cycle_count; /* Total on-channel time */ 251 u32 phy_err_count; 252 u32 chan_tx_power; 253 u32 ack_rx_bad; 254 u32 rts_bad; 255 u32 rts_good; 256 u32 fcs_bad; 257 u32 no_beacons; 258 u32 mib_int_count; 259 260 /* PDEV TX stats */ 261 s32 comp_queued; 262 s32 comp_delivered; 263 s32 msdu_enqued; 264 s32 mpdu_enqued; 265 s32 wmm_drop; 266 s32 local_enqued; 267 s32 local_freed; 268 s32 hw_queued; 269 s32 hw_reaped; 270 s32 underrun; 271 u32 hw_paused; 272 s32 tx_abort; 273 s32 mpdus_requed; 274 u32 tx_ko; 275 u32 data_rc; 276 u32 self_triggers; 277 u32 sw_retry_failure; 278 u32 illgl_rate_phy_err; 279 u32 pdev_cont_xretry; 280 u32 pdev_tx_timeout; 281 u32 pdev_resets; 282 u32 phy_underrun; 283 u32 txop_ovf; 284 u32 seq_posted; 285 u32 seq_failed_queueing; 286 u32 seq_completed; 287 u32 seq_restarted; 288 u32 mu_seq_posted; 289 u32 mpdus_sw_flush; 290 u32 mpdus_hw_filter; 291 u32 mpdus_truncated; 292 u32 mpdus_ack_failed; 293 u32 mpdus_expired; 294 295 /* PDEV RX stats */ 296 s32 mid_ppdu_route_change; 297 s32 status_rcvd; 298 s32 r0_frags; 299 s32 r1_frags; 300 s32 r2_frags; 301 s32 r3_frags; 302 s32 htt_msdus; 303 s32 htt_mpdus; 304 s32 loc_msdus; 305 s32 loc_mpdus; 306 s32 oversize_amsdu; 307 s32 phy_errs; 308 s32 phy_err_drop; 309 s32 mpdu_errs; 310 s32 rx_ovfl_errs; 311 }; 312 313 struct ath10k_fw_stats { 314 bool extended; 315 struct list_head pdevs; 316 struct list_head vdevs; 317 struct list_head peers; 318 struct list_head peers_extd; 319 }; 320 321 #define ATH10K_TPC_TABLE_TYPE_FLAG 1 322 #define ATH10K_TPC_PREAM_TABLE_END 0xFFFF 323 324 struct ath10k_tpc_table { 325 u32 pream_idx[WMI_TPC_RATE_MAX]; 326 u8 rate_code[WMI_TPC_RATE_MAX]; 327 char tpc_value[WMI_TPC_RATE_MAX][WMI_TPC_TX_N_CHAIN * WMI_TPC_BUF_SIZE]; 328 }; 329 330 struct ath10k_tpc_stats { 331 u32 reg_domain; 332 u32 chan_freq; 333 u32 phy_mode; 334 u32 twice_antenna_reduction; 335 u32 twice_max_rd_power; 336 s32 twice_antenna_gain; 337 u32 power_limit; 338 u32 num_tx_chain; 339 u32 ctl; 340 u32 rate_max; 341 u8 flag[WMI_TPC_FLAG]; 342 struct ath10k_tpc_table tpc_table[WMI_TPC_FLAG]; 343 }; 344 345 struct ath10k_tpc_table_final { 346 u32 pream_idx[WMI_TPC_FINAL_RATE_MAX]; 347 u8 rate_code[WMI_TPC_FINAL_RATE_MAX]; 348 char tpc_value[WMI_TPC_FINAL_RATE_MAX][WMI_TPC_TX_N_CHAIN * WMI_TPC_BUF_SIZE]; 349 }; 350 351 struct ath10k_tpc_stats_final { 352 u32 reg_domain; 353 u32 chan_freq; 354 u32 phy_mode; 355 u32 twice_antenna_reduction; 356 u32 twice_max_rd_power; 357 s32 twice_antenna_gain; 358 u32 power_limit; 359 u32 num_tx_chain; 360 u32 ctl; 361 u32 rate_max; 362 u8 flag[WMI_TPC_FLAG]; 363 struct ath10k_tpc_table_final tpc_table_final[WMI_TPC_FLAG]; 364 }; 365 366 struct ath10k_dfs_stats { 367 u32 phy_errors; 368 u32 pulses_total; 369 u32 pulses_detected; 370 u32 pulses_discarded; 371 u32 radar_detected; 372 }; 373 374 enum ath10k_radar_confirmation_state { 375 ATH10K_RADAR_CONFIRMATION_IDLE = 0, 376 ATH10K_RADAR_CONFIRMATION_INPROGRESS, 377 ATH10K_RADAR_CONFIRMATION_STOPPED, 378 }; 379 380 struct ath10k_radar_found_info { 381 u32 pri_min; 382 u32 pri_max; 383 u32 width_min; 384 u32 width_max; 385 u32 sidx_min; 386 u32 sidx_max; 387 }; 388 389 #define ATH10K_MAX_NUM_PEER_IDS (1 << 11) /* htt rx_desc limit */ 390 391 struct ath10k_peer { 392 struct list_head list; 393 struct ieee80211_vif *vif; 394 struct ieee80211_sta *sta; 395 396 bool removed; 397 int vdev_id; 398 u8 addr[ETH_ALEN]; 399 DECLARE_BITMAP(peer_ids, ATH10K_MAX_NUM_PEER_IDS); 400 401 /* protected by ar->data_lock */ 402 struct ieee80211_key_conf *keys[WMI_MAX_KEY_INDEX + 1]; 403 union htt_rx_pn_t tids_last_pn[ATH10K_TXRX_NUM_EXT_TIDS]; 404 bool tids_last_pn_valid[ATH10K_TXRX_NUM_EXT_TIDS]; 405 union htt_rx_pn_t frag_tids_last_pn[ATH10K_TXRX_NUM_EXT_TIDS]; 406 u32 frag_tids_seq[ATH10K_TXRX_NUM_EXT_TIDS]; 407 struct { 408 enum htt_security_types sec_type; 409 int pn_len; 410 } rx_pn[ATH10K_HTT_TXRX_PEER_SECURITY_MAX]; 411 }; 412 413 struct ath10k_txq { 414 struct list_head list; 415 unsigned long num_fw_queued; 416 unsigned long num_push_allowed; 417 }; 418 419 enum ath10k_pkt_rx_err { 420 ATH10K_PKT_RX_ERR_FCS, 421 ATH10K_PKT_RX_ERR_TKIP, 422 ATH10K_PKT_RX_ERR_CRYPT, 423 ATH10K_PKT_RX_ERR_PEER_IDX_INVAL, 424 ATH10K_PKT_RX_ERR_MAX, 425 }; 426 427 enum ath10k_ampdu_subfrm_num { 428 ATH10K_AMPDU_SUBFRM_NUM_10, 429 ATH10K_AMPDU_SUBFRM_NUM_20, 430 ATH10K_AMPDU_SUBFRM_NUM_30, 431 ATH10K_AMPDU_SUBFRM_NUM_40, 432 ATH10K_AMPDU_SUBFRM_NUM_50, 433 ATH10K_AMPDU_SUBFRM_NUM_60, 434 ATH10K_AMPDU_SUBFRM_NUM_MORE, 435 ATH10K_AMPDU_SUBFRM_NUM_MAX, 436 }; 437 438 enum ath10k_amsdu_subfrm_num { 439 ATH10K_AMSDU_SUBFRM_NUM_1, 440 ATH10K_AMSDU_SUBFRM_NUM_2, 441 ATH10K_AMSDU_SUBFRM_NUM_3, 442 ATH10K_AMSDU_SUBFRM_NUM_4, 443 ATH10K_AMSDU_SUBFRM_NUM_MORE, 444 ATH10K_AMSDU_SUBFRM_NUM_MAX, 445 }; 446 447 struct ath10k_sta_tid_stats { 448 unsigned long rx_pkt_from_fw; 449 unsigned long rx_pkt_unchained; 450 unsigned long rx_pkt_drop_chained; 451 unsigned long rx_pkt_drop_filter; 452 unsigned long rx_pkt_err[ATH10K_PKT_RX_ERR_MAX]; 453 unsigned long rx_pkt_queued_for_mac; 454 unsigned long rx_pkt_ampdu[ATH10K_AMPDU_SUBFRM_NUM_MAX]; 455 unsigned long rx_pkt_amsdu[ATH10K_AMSDU_SUBFRM_NUM_MAX]; 456 }; 457 458 enum ath10k_counter_type { 459 ATH10K_COUNTER_TYPE_BYTES, 460 ATH10K_COUNTER_TYPE_PKTS, 461 ATH10K_COUNTER_TYPE_MAX, 462 }; 463 464 enum ath10k_stats_type { 465 ATH10K_STATS_TYPE_SUCC, 466 ATH10K_STATS_TYPE_FAIL, 467 ATH10K_STATS_TYPE_RETRY, 468 ATH10K_STATS_TYPE_AMPDU, 469 ATH10K_STATS_TYPE_MAX, 470 }; 471 472 struct ath10k_htt_data_stats { 473 u64 legacy[ATH10K_COUNTER_TYPE_MAX][ATH10K_LEGACY_NUM]; 474 u64 ht[ATH10K_COUNTER_TYPE_MAX][ATH10K_HT_MCS_NUM]; 475 u64 vht[ATH10K_COUNTER_TYPE_MAX][ATH10K_VHT_MCS_NUM]; 476 u64 bw[ATH10K_COUNTER_TYPE_MAX][ATH10K_BW_NUM]; 477 u64 nss[ATH10K_COUNTER_TYPE_MAX][ATH10K_NSS_NUM]; 478 u64 gi[ATH10K_COUNTER_TYPE_MAX][ATH10K_GI_NUM]; 479 u64 rate_table[ATH10K_COUNTER_TYPE_MAX][ATH10K_RATE_TABLE_NUM]; 480 }; 481 482 struct ath10k_htt_tx_stats { 483 struct ath10k_htt_data_stats stats[ATH10K_STATS_TYPE_MAX]; 484 u64 tx_duration; 485 u64 ba_fails; 486 u64 ack_fails; 487 }; 488 489 struct ath10k_sta { 490 struct ath10k_vif *arvif; 491 492 /* the following are protected by ar->data_lock */ 493 u32 changed; /* IEEE80211_RC_* */ 494 u32 bw; 495 u32 nss; 496 u32 smps; 497 u16 peer_id; 498 struct rate_info txrate; 499 struct ieee80211_tx_info tx_info; 500 u32 last_tx_bitrate; 501 502 struct work_struct update_wk; 503 u64 rx_duration; 504 struct ath10k_htt_tx_stats *tx_stats; 505 506 #ifdef CONFIG_MAC80211_DEBUGFS 507 /* protected by conf_mutex */ 508 bool aggr_mode; 509 510 /* Protected with ar->data_lock */ 511 struct ath10k_sta_tid_stats tid_stats[IEEE80211_NUM_TIDS + 1]; 512 #endif 513 /* Protected with ar->data_lock */ 514 u32 peer_ps_state; 515 }; 516 517 #define ATH10K_VDEV_SETUP_TIMEOUT_HZ (5 * HZ) 518 519 enum ath10k_beacon_state { 520 ATH10K_BEACON_SCHEDULED = 0, 521 ATH10K_BEACON_SENDING, 522 ATH10K_BEACON_SENT, 523 }; 524 525 struct ath10k_vif { 526 struct list_head list; 527 528 u32 vdev_id; 529 u16 peer_id; 530 enum wmi_vdev_type vdev_type; 531 enum wmi_vdev_subtype vdev_subtype; 532 u32 beacon_interval; 533 u32 dtim_period; 534 struct sk_buff *beacon; 535 /* protected by data_lock */ 536 enum ath10k_beacon_state beacon_state; 537 void *beacon_buf; 538 dma_addr_t beacon_paddr; 539 unsigned long tx_paused; /* arbitrary values defined by target */ 540 541 struct ath10k *ar; 542 struct ieee80211_vif *vif; 543 544 bool is_started; 545 bool is_up; 546 bool spectral_enabled; 547 bool ps; 548 u32 aid; 549 u8 bssid[ETH_ALEN]; 550 551 struct ieee80211_key_conf *wep_keys[WMI_MAX_KEY_INDEX + 1]; 552 s8 def_wep_key_idx; 553 554 u16 tx_seq_no; 555 556 union { 557 struct { 558 u32 uapsd; 559 } sta; 560 struct { 561 /* 512 stations */ 562 u8 tim_bitmap[64]; 563 u8 tim_len; 564 u32 ssid_len; 565 u8 ssid[IEEE80211_MAX_SSID_LEN]; 566 bool hidden_ssid; 567 /* P2P_IE with NoA attribute for P2P_GO case */ 568 u32 noa_len; 569 u8 *noa_data; 570 } ap; 571 } u; 572 573 bool use_cts_prot; 574 bool nohwcrypt; 575 int num_legacy_stations; 576 int txpower; 577 bool ftm_responder; 578 struct wmi_wmm_params_all_arg wmm_params; 579 struct work_struct ap_csa_work; 580 struct delayed_work connection_loss_work; 581 struct cfg80211_bitrate_mask bitrate_mask; 582 }; 583 584 struct ath10k_vif_iter { 585 u32 vdev_id; 586 struct ath10k_vif *arvif; 587 }; 588 589 /* Copy Engine register dump, protected by ce-lock */ 590 struct ath10k_ce_crash_data { 591 __le32 base_addr; 592 __le32 src_wr_idx; 593 __le32 src_r_idx; 594 __le32 dst_wr_idx; 595 __le32 dst_r_idx; 596 }; 597 598 struct ath10k_ce_crash_hdr { 599 __le32 ce_count; 600 __le32 reserved[3]; /* for future use */ 601 struct ath10k_ce_crash_data entries[]; 602 }; 603 604 #define MAX_MEM_DUMP_TYPE 5 605 606 /* used for crash-dump storage, protected by data-lock */ 607 struct ath10k_fw_crash_data { 608 guid_t guid; 609 struct timespec64 timestamp; 610 __le32 registers[REG_DUMP_COUNT_QCA988X]; 611 struct ath10k_ce_crash_data ce_crash_data[CE_COUNT_MAX]; 612 613 u8 *ramdump_buf; 614 size_t ramdump_buf_len; 615 }; 616 617 struct ath10k_debug { 618 struct dentry *debugfs_phy; 619 620 struct ath10k_fw_stats fw_stats; 621 struct completion fw_stats_complete; 622 bool fw_stats_done; 623 624 unsigned long htt_stats_mask; 625 unsigned long reset_htt_stats; 626 struct delayed_work htt_stats_dwork; 627 struct ath10k_dfs_stats dfs_stats; 628 struct ath_dfs_pool_stats dfs_pool_stats; 629 630 /* used for tpc-dump storage, protected by data-lock */ 631 struct ath10k_tpc_stats *tpc_stats; 632 struct ath10k_tpc_stats_final *tpc_stats_final; 633 634 struct completion tpc_complete; 635 636 /* protected by conf_mutex */ 637 u64 fw_dbglog_mask; 638 u32 fw_dbglog_level; 639 u32 reg_addr; 640 u32 nf_cal_period; 641 void *cal_data; 642 u32 enable_extd_tx_stats; 643 }; 644 645 enum ath10k_state { 646 ATH10K_STATE_OFF = 0, 647 ATH10K_STATE_ON, 648 649 /* When doing firmware recovery the device is first powered down. 650 * mac80211 is supposed to call in to start() hook later on. It is 651 * however possible that driver unloading and firmware crash overlap. 652 * mac80211 can wait on conf_mutex in stop() while the device is 653 * stopped in ath10k_core_restart() work holding conf_mutex. The state 654 * RESTARTED means that the device is up and mac80211 has started hw 655 * reconfiguration. Once mac80211 is done with the reconfiguration we 656 * set the state to STATE_ON in reconfig_complete(). 657 */ 658 ATH10K_STATE_RESTARTING, 659 ATH10K_STATE_RESTARTED, 660 661 /* The device has crashed while restarting hw. This state is like ON 662 * but commands are blocked in HTC and -ECOMM response is given. This 663 * prevents completion timeouts and makes the driver more responsive to 664 * userspace commands. This is also prevents recursive recovery. 665 */ 666 ATH10K_STATE_WEDGED, 667 668 /* factory tests */ 669 ATH10K_STATE_UTF, 670 }; 671 672 enum ath10k_firmware_mode { 673 /* the default mode, standard 802.11 functionality */ 674 ATH10K_FIRMWARE_MODE_NORMAL, 675 676 /* factory tests etc */ 677 ATH10K_FIRMWARE_MODE_UTF, 678 }; 679 680 enum ath10k_fw_features { 681 /* wmi_mgmt_rx_hdr contains extra RSSI information */ 682 ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX = 0, 683 684 /* Firmware from 10X branch. Deprecated, don't use in new code. */ 685 ATH10K_FW_FEATURE_WMI_10X = 1, 686 687 /* firmware support tx frame management over WMI, otherwise it's HTT */ 688 ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX = 2, 689 690 /* Firmware does not support P2P */ 691 ATH10K_FW_FEATURE_NO_P2P = 3, 692 693 /* Firmware 10.2 feature bit. The ATH10K_FW_FEATURE_WMI_10X feature 694 * bit is required to be set as well. Deprecated, don't use in new 695 * code. 696 */ 697 ATH10K_FW_FEATURE_WMI_10_2 = 4, 698 699 /* Some firmware revisions lack proper multi-interface client powersave 700 * implementation. Enabling PS could result in connection drops, 701 * traffic stalls, etc. 702 */ 703 ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT = 5, 704 705 /* Some firmware revisions have an incomplete WoWLAN implementation 706 * despite WMI service bit being advertised. This feature flag is used 707 * to distinguish whether WoWLAN is really supported or not. 708 */ 709 ATH10K_FW_FEATURE_WOWLAN_SUPPORT = 6, 710 711 /* Don't trust error code from otp.bin */ 712 ATH10K_FW_FEATURE_IGNORE_OTP_RESULT = 7, 713 714 /* Some firmware revisions pad 4th hw address to 4 byte boundary making 715 * it 8 bytes long in Native Wifi Rx decap. 716 */ 717 ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING = 8, 718 719 /* Firmware supports bypassing PLL setting on init. */ 720 ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT = 9, 721 722 /* Raw mode support. If supported, FW supports receiving and trasmitting 723 * frames in raw mode. 724 */ 725 ATH10K_FW_FEATURE_RAW_MODE_SUPPORT = 10, 726 727 /* Firmware Supports Adaptive CCA*/ 728 ATH10K_FW_FEATURE_SUPPORTS_ADAPTIVE_CCA = 11, 729 730 /* Firmware supports management frame protection */ 731 ATH10K_FW_FEATURE_MFP_SUPPORT = 12, 732 733 /* Firmware supports pull-push model where host shares it's software 734 * queue state with firmware and firmware generates fetch requests 735 * telling host which queues to dequeue tx from. 736 * 737 * Primary function of this is improved MU-MIMO performance with 738 * multiple clients. 739 */ 740 ATH10K_FW_FEATURE_PEER_FLOW_CONTROL = 13, 741 742 /* Firmware supports BT-Coex without reloading firmware via pdev param. 743 * To support Bluetooth coexistence pdev param, WMI_COEX_GPIO_SUPPORT of 744 * extended resource config should be enabled always. This firmware IE 745 * is used to configure WMI_COEX_GPIO_SUPPORT. 746 */ 747 ATH10K_FW_FEATURE_BTCOEX_PARAM = 14, 748 749 /* Unused flag and proven to be not working, enable this if you want 750 * to experiment sending NULL func data frames in HTT TX 751 */ 752 ATH10K_FW_FEATURE_SKIP_NULL_FUNC_WAR = 15, 753 754 /* Firmware allow other BSS mesh broadcast/multicast frames without 755 * creating monitor interface. Appropriate rxfilters are programmed for 756 * mesh vdev by firmware itself. This feature flags will be used for 757 * not creating monitor vdev while configuring mesh node. 758 */ 759 ATH10K_FW_FEATURE_ALLOWS_MESH_BCAST = 16, 760 761 /* Firmware does not support power save in station mode. */ 762 ATH10K_FW_FEATURE_NO_PS = 17, 763 764 /* Firmware allows management tx by reference instead of by value. */ 765 ATH10K_FW_FEATURE_MGMT_TX_BY_REF = 18, 766 767 /* Firmware load is done externally, not by bmi */ 768 ATH10K_FW_FEATURE_NON_BMI = 19, 769 770 /* Firmware sends only one chan_info event per channel */ 771 ATH10K_FW_FEATURE_SINGLE_CHAN_INFO_PER_CHANNEL = 20, 772 773 /* keep last */ 774 ATH10K_FW_FEATURE_COUNT, 775 }; 776 777 enum ath10k_dev_flags { 778 /* Indicates that ath10k device is during CAC phase of DFS */ 779 ATH10K_CAC_RUNNING, 780 ATH10K_FLAG_CORE_REGISTERED, 781 782 /* Device has crashed and needs to restart. This indicates any pending 783 * waiters should immediately cancel instead of waiting for a time out. 784 */ 785 ATH10K_FLAG_CRASH_FLUSH, 786 787 /* Use Raw mode instead of native WiFi Tx/Rx encap mode. 788 * Raw mode supports both hardware and software crypto. Native WiFi only 789 * supports hardware crypto. 790 */ 791 ATH10K_FLAG_RAW_MODE, 792 793 /* Disable HW crypto engine */ 794 ATH10K_FLAG_HW_CRYPTO_DISABLED, 795 796 /* Bluetooth coexistance enabled */ 797 ATH10K_FLAG_BTCOEX, 798 799 /* Per Station statistics service */ 800 ATH10K_FLAG_PEER_STATS, 801 }; 802 803 enum ath10k_cal_mode { 804 ATH10K_CAL_MODE_FILE, 805 ATH10K_CAL_MODE_OTP, 806 ATH10K_CAL_MODE_DT, 807 ATH10K_PRE_CAL_MODE_FILE, 808 ATH10K_PRE_CAL_MODE_DT, 809 ATH10K_CAL_MODE_EEPROM, 810 }; 811 812 enum ath10k_crypt_mode { 813 /* Only use hardware crypto engine */ 814 ATH10K_CRYPT_MODE_HW, 815 /* Only use software crypto engine */ 816 ATH10K_CRYPT_MODE_SW, 817 }; 818 819 static inline const char *ath10k_cal_mode_str(enum ath10k_cal_mode mode) 820 { 821 switch (mode) { 822 case ATH10K_CAL_MODE_FILE: 823 return "file"; 824 case ATH10K_CAL_MODE_OTP: 825 return "otp"; 826 case ATH10K_CAL_MODE_DT: 827 return "dt"; 828 case ATH10K_PRE_CAL_MODE_FILE: 829 return "pre-cal-file"; 830 case ATH10K_PRE_CAL_MODE_DT: 831 return "pre-cal-dt"; 832 case ATH10K_CAL_MODE_EEPROM: 833 return "eeprom"; 834 } 835 836 return "unknown"; 837 } 838 839 enum ath10k_scan_state { 840 ATH10K_SCAN_IDLE, 841 ATH10K_SCAN_STARTING, 842 ATH10K_SCAN_RUNNING, 843 ATH10K_SCAN_ABORTING, 844 }; 845 846 static inline const char *ath10k_scan_state_str(enum ath10k_scan_state state) 847 { 848 switch (state) { 849 case ATH10K_SCAN_IDLE: 850 return "idle"; 851 case ATH10K_SCAN_STARTING: 852 return "starting"; 853 case ATH10K_SCAN_RUNNING: 854 return "running"; 855 case ATH10K_SCAN_ABORTING: 856 return "aborting"; 857 } 858 859 return "unknown"; 860 } 861 862 enum ath10k_tx_pause_reason { 863 ATH10K_TX_PAUSE_Q_FULL, 864 ATH10K_TX_PAUSE_MAX, 865 }; 866 867 struct ath10k_fw_file { 868 const struct firmware *firmware; 869 870 char fw_version[ETHTOOL_FWVERS_LEN]; 871 872 DECLARE_BITMAP(fw_features, ATH10K_FW_FEATURE_COUNT); 873 874 enum ath10k_fw_wmi_op_version wmi_op_version; 875 enum ath10k_fw_htt_op_version htt_op_version; 876 877 const void *firmware_data; 878 size_t firmware_len; 879 880 const void *otp_data; 881 size_t otp_len; 882 883 const void *codeswap_data; 884 size_t codeswap_len; 885 886 /* The original idea of struct ath10k_fw_file was that it only 887 * contains struct firmware and pointers to various parts (actual 888 * firmware binary, otp, metadata etc) of the file. This seg_info 889 * is actually created separate but as this is used similarly as 890 * the other firmware components it's more convenient to have it 891 * here. 892 */ 893 struct ath10k_swap_code_seg_info *firmware_swap_code_seg_info; 894 }; 895 896 struct ath10k_fw_components { 897 const struct firmware *board; 898 const void *board_data; 899 size_t board_len; 900 const struct firmware *ext_board; 901 const void *ext_board_data; 902 size_t ext_board_len; 903 904 struct ath10k_fw_file fw_file; 905 }; 906 907 struct ath10k_per_peer_tx_stats { 908 u32 succ_bytes; 909 u32 retry_bytes; 910 u32 failed_bytes; 911 u8 ratecode; 912 u8 flags; 913 u16 peer_id; 914 u16 succ_pkts; 915 u16 retry_pkts; 916 u16 failed_pkts; 917 u16 duration; 918 u32 reserved1; 919 u32 reserved2; 920 }; 921 922 enum ath10k_dev_type { 923 ATH10K_DEV_TYPE_LL, 924 ATH10K_DEV_TYPE_HL, 925 }; 926 927 struct ath10k_bus_params { 928 u32 chip_id; 929 enum ath10k_dev_type dev_type; 930 bool link_can_suspend; 931 bool hl_msdu_ids; 932 }; 933 934 struct ath10k { 935 struct ath_common ath_common; 936 struct ieee80211_hw *hw; 937 struct ieee80211_ops *ops; 938 struct device *dev; 939 u8 mac_addr[ETH_ALEN]; 940 941 enum ath10k_hw_rev hw_rev; 942 u16 dev_id; 943 u32 chip_id; 944 enum ath10k_dev_type dev_type; 945 u32 target_version; 946 u8 fw_version_major; 947 u32 fw_version_minor; 948 u16 fw_version_release; 949 u16 fw_version_build; 950 u32 fw_stats_req_mask; 951 u32 phy_capability; 952 u32 hw_min_tx_power; 953 u32 hw_max_tx_power; 954 u32 hw_eeprom_rd; 955 u32 ht_cap_info; 956 u32 vht_cap_info; 957 u32 num_rf_chains; 958 u32 max_spatial_stream; 959 /* protected by conf_mutex */ 960 u32 low_5ghz_chan; 961 u32 high_5ghz_chan; 962 bool ani_enabled; 963 /* protected by conf_mutex */ 964 u8 ps_state_enable; 965 966 bool nlo_enabled; 967 bool p2p; 968 969 struct { 970 enum ath10k_bus bus; 971 const struct ath10k_hif_ops *ops; 972 } hif; 973 974 struct completion target_suspend; 975 struct completion driver_recovery; 976 977 const struct ath10k_hw_regs *regs; 978 const struct ath10k_hw_ce_regs *hw_ce_regs; 979 const struct ath10k_hw_values *hw_values; 980 struct ath10k_bmi bmi; 981 struct ath10k_wmi wmi; 982 struct ath10k_htc htc; 983 struct ath10k_htt htt; 984 985 struct ath10k_hw_params hw_params; 986 987 /* contains the firmware images used with ATH10K_FIRMWARE_MODE_NORMAL */ 988 struct ath10k_fw_components normal_mode_fw; 989 990 /* READ-ONLY images of the running firmware, which can be either 991 * normal or UTF. Do not modify, release etc! 992 */ 993 const struct ath10k_fw_components *running_fw; 994 995 const struct firmware *pre_cal_file; 996 const struct firmware *cal_file; 997 998 struct { 999 u32 vendor; 1000 u32 device; 1001 u32 subsystem_vendor; 1002 u32 subsystem_device; 1003 1004 bool bmi_ids_valid; 1005 bool qmi_ids_valid; 1006 u32 qmi_board_id; 1007 u8 bmi_board_id; 1008 u8 bmi_eboard_id; 1009 u8 bmi_chip_id; 1010 bool ext_bid_supported; 1011 1012 char bdf_ext[ATH10K_SMBIOS_BDF_EXT_STR_LENGTH]; 1013 } id; 1014 1015 int fw_api; 1016 int bd_api; 1017 enum ath10k_cal_mode cal_mode; 1018 1019 struct { 1020 struct completion started; 1021 struct completion completed; 1022 struct completion on_channel; 1023 struct delayed_work timeout; 1024 enum ath10k_scan_state state; 1025 bool is_roc; 1026 int vdev_id; 1027 int roc_freq; 1028 bool roc_notify; 1029 } scan; 1030 1031 struct { 1032 struct ieee80211_supported_band sbands[NUM_NL80211_BANDS]; 1033 } mac; 1034 1035 /* should never be NULL; needed for regular htt rx */ 1036 struct ieee80211_channel *rx_channel; 1037 1038 /* valid during scan; needed for mgmt rx during scan */ 1039 struct ieee80211_channel *scan_channel; 1040 1041 /* current operating channel definition */ 1042 struct cfg80211_chan_def chandef; 1043 1044 /* currently configured operating channel in firmware */ 1045 struct ieee80211_channel *tgt_oper_chan; 1046 1047 unsigned long long free_vdev_map; 1048 struct ath10k_vif *monitor_arvif; 1049 bool monitor; 1050 int monitor_vdev_id; 1051 bool monitor_started; 1052 unsigned int filter_flags; 1053 unsigned long dev_flags; 1054 bool dfs_block_radar_events; 1055 1056 /* protected by conf_mutex */ 1057 bool radar_enabled; 1058 int num_started_vdevs; 1059 1060 /* Protected by conf-mutex */ 1061 u8 cfg_tx_chainmask; 1062 u8 cfg_rx_chainmask; 1063 1064 struct completion install_key_done; 1065 1066 int last_wmi_vdev_start_status; 1067 struct completion vdev_setup_done; 1068 1069 struct workqueue_struct *workqueue; 1070 /* Auxiliary workqueue */ 1071 struct workqueue_struct *workqueue_aux; 1072 1073 /* prevents concurrent FW reconfiguration */ 1074 struct mutex conf_mutex; 1075 1076 /* protects coredump data */ 1077 struct mutex dump_mutex; 1078 1079 /* protects shared structure data */ 1080 spinlock_t data_lock; 1081 1082 struct list_head arvifs; 1083 struct list_head peers; 1084 struct ath10k_peer *peer_map[ATH10K_MAX_NUM_PEER_IDS]; 1085 wait_queue_head_t peer_mapping_wq; 1086 1087 /* protected by conf_mutex */ 1088 int num_peers; 1089 int num_stations; 1090 1091 int max_num_peers; 1092 int max_num_stations; 1093 int max_num_vdevs; 1094 int max_num_tdls_vdevs; 1095 int num_active_peers; 1096 int num_tids; 1097 1098 struct work_struct svc_rdy_work; 1099 struct sk_buff *svc_rdy_skb; 1100 1101 struct work_struct offchan_tx_work; 1102 struct sk_buff_head offchan_tx_queue; 1103 struct completion offchan_tx_completed; 1104 struct sk_buff *offchan_tx_skb; 1105 1106 struct work_struct wmi_mgmt_tx_work; 1107 struct sk_buff_head wmi_mgmt_tx_queue; 1108 1109 enum ath10k_state state; 1110 1111 struct work_struct register_work; 1112 struct work_struct restart_work; 1113 1114 /* cycle count is reported twice for each visited channel during scan. 1115 * access protected by data_lock 1116 */ 1117 u32 survey_last_rx_clear_count; 1118 u32 survey_last_cycle_count; 1119 struct survey_info survey[ATH10K_NUM_CHANS]; 1120 1121 /* Channel info events are expected to come in pairs without and with 1122 * COMPLETE flag set respectively for each channel visit during scan. 1123 * 1124 * However there are deviations from this rule. This flag is used to 1125 * avoid reporting garbage data. 1126 */ 1127 bool ch_info_can_report_survey; 1128 struct completion bss_survey_done; 1129 1130 struct dfs_pattern_detector *dfs_detector; 1131 1132 unsigned long tx_paused; /* see ATH10K_TX_PAUSE_ */ 1133 1134 #ifdef CONFIG_ATH10K_DEBUGFS 1135 struct ath10k_debug debug; 1136 struct { 1137 /* relay(fs) channel for spectral scan */ 1138 struct rchan *rfs_chan_spec_scan; 1139 1140 /* spectral_mode and spec_config are protected by conf_mutex */ 1141 enum ath10k_spectral_mode mode; 1142 struct ath10k_spec_scan config; 1143 } spectral; 1144 #endif 1145 1146 u32 pktlog_filter; 1147 1148 #ifdef CONFIG_DEV_COREDUMP 1149 struct { 1150 struct ath10k_fw_crash_data *fw_crash_data; 1151 } coredump; 1152 #endif 1153 1154 struct { 1155 /* protected by conf_mutex */ 1156 struct ath10k_fw_components utf_mode_fw; 1157 1158 /* protected by data_lock */ 1159 bool utf_monitor; 1160 } testmode; 1161 1162 struct { 1163 /* protected by data_lock */ 1164 u32 fw_crash_counter; 1165 u32 fw_warm_reset_counter; 1166 u32 fw_cold_reset_counter; 1167 } stats; 1168 1169 struct ath10k_thermal thermal; 1170 struct ath10k_wow wow; 1171 struct ath10k_per_peer_tx_stats peer_tx_stats; 1172 1173 /* NAPI */ 1174 struct net_device napi_dev; 1175 struct napi_struct napi; 1176 1177 struct work_struct set_coverage_class_work; 1178 /* protected by conf_mutex */ 1179 struct { 1180 /* writing also protected by data_lock */ 1181 s16 coverage_class; 1182 1183 u32 reg_phyclk; 1184 u32 reg_slottime_conf; 1185 u32 reg_slottime_orig; 1186 u32 reg_ack_cts_timeout_conf; 1187 u32 reg_ack_cts_timeout_orig; 1188 } fw_coverage; 1189 1190 u32 ampdu_reference; 1191 1192 const u8 *wmi_key_cipher; 1193 void *ce_priv; 1194 1195 u32 sta_tid_stats_mask; 1196 1197 /* protected by data_lock */ 1198 enum ath10k_radar_confirmation_state radar_conf_state; 1199 struct ath10k_radar_found_info last_radar_info; 1200 struct work_struct radar_confirmation_work; 1201 struct ath10k_bus_params bus_param; 1202 1203 /* must be last */ 1204 u8 drv_priv[0] __aligned(sizeof(void *)); 1205 }; 1206 1207 static inline bool ath10k_peer_stats_enabled(struct ath10k *ar) 1208 { 1209 if (test_bit(ATH10K_FLAG_PEER_STATS, &ar->dev_flags) && 1210 test_bit(WMI_SERVICE_PEER_STATS, ar->wmi.svc_map)) 1211 return true; 1212 1213 return false; 1214 } 1215 1216 extern unsigned long ath10k_coredump_mask; 1217 1218 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev, 1219 enum ath10k_bus bus, 1220 enum ath10k_hw_rev hw_rev, 1221 const struct ath10k_hif_ops *hif_ops); 1222 void ath10k_core_destroy(struct ath10k *ar); 1223 void ath10k_core_get_fw_features_str(struct ath10k *ar, 1224 char *buf, 1225 size_t max_len); 1226 int ath10k_core_fetch_firmware_api_n(struct ath10k *ar, const char *name, 1227 struct ath10k_fw_file *fw_file); 1228 1229 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode, 1230 const struct ath10k_fw_components *fw_components); 1231 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt); 1232 void ath10k_core_stop(struct ath10k *ar); 1233 int ath10k_core_register(struct ath10k *ar, 1234 const struct ath10k_bus_params *bus_params); 1235 void ath10k_core_unregister(struct ath10k *ar); 1236 int ath10k_core_fetch_board_file(struct ath10k *ar, int bd_ie_type); 1237 void ath10k_core_free_board_files(struct ath10k *ar); 1238 1239 #endif /* _CORE_H_ */ 1240