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