Impressum core.c   Sprache: C

// SPDX-License-Identifier: ISC
/*
 * Copyright (c) 2005-2011 Atheros Communications Inc.
 * Copyright (c) 2011-2017 Qualcomm Atheros, Inc.
 * Copyright (c) 2018-2019, The Linux Foundation. All rights reserved.
 * Copyright (c) 2021-2024 Qualcomm Innovation Center, Inc. All rights reserved.
 * Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
 */

#include <linux/export.h>
#include <linux/module.h>
#include <linux/firmware.h>
#include <linux/of.h>
#include <linux/property.h>
#include <linux/dmi.h>
#include <linux/ctype.h>
#include <linux/pm_qos.h>
#include <linux/nvmem-consumer.h>
#include <asm/byteorder.h>

#include "core.h"
#include "mac.h"
#include "htc.h"
#include "hif.h"
#include "wmi.h"
#include "bmi.h"
#include "debug.h"
#include "htt.h"
#include "testmode.h"
#include "wmi-ops.h"
#include "coredump.h"
#include "leds.h"

unsigned int ath10k_debug_mask;
EXPORT_SYMBOL(ath10k_debug_mask);

static unsigned int ath10k_cryptmode_param;
static bool uart_print;
static bool skip_otp;
static bool fw_diag_log;

/* frame mode values are mapped as per enum ath10k_hw_txrx_mode */
unsigned int ath10k_frame_mode = ATH10K_HW_TXRX_NATIVE_WIFI;

unsigned long ath10k_coredump_mask = BIT(ATH10K_FW_CRASH_DUMP_REGISTERS) |
         BIT(ATH10K_FW_CRASH_DUMP_CE_DATA);

/* FIXME: most of these should be readonly */
module_param_named(debug_mask, ath10k_debug_mask, uint, 0644);
module_param_named(cryptmode, ath10k_cryptmode_param, uint, 0644);
module_param(uart_print, bool, 0644);
module_param(skip_otp, bool, 0644);
module_param(fw_diag_log, bool, 0644);
module_param_named(frame_mode, ath10k_frame_mode, uint, 0644);
module_param_named(coredump_mask, ath10k_coredump_mask, ulong, 0444);

MODULE_PARM_DESC(debug_mask, "Debugging mask");
MODULE_PARM_DESC(uart_print, "Uart target debugging");
MODULE_PARM_DESC(skip_otp, "Skip otp failure for calibration in testmode");
MODULE_PARM_DESC(cryptmode, "Crypto mode: 0-hardware, 1-software");
MODULE_PARM_DESC(frame_mode,
   "Datapath frame mode (0: raw, 1: native wifi (default), 2: ethernet)");
MODULE_PARM_DESC(coredump_mask, "Bitfield of what to include in firmware crash file");
MODULE_PARM_DESC(fw_diag_log, "Diag based fw log debugging");

static const struct ath10k_hw_params ath10k_hw_params_list[] = {
 {
  .id = QCA988X_HW_2_0_VERSION,
  .dev_id = QCA988X_2_0_DEVICE_ID,
  .bus = ATH10K_BUS_PCI,
  .name = "qca988x hw2.0",
  .patch_load_addr = QCA988X_HW_2_0_PATCH_LOAD_ADDR,
  .uart_pin = 7,
  .led_pin = 1,
  .cc_wraparound_type = ATH10K_HW_CC_WRAP_SHIFTED_ALL,
  .otp_exe_param = 0,
  .channel_counters_freq_hz = 88000,
  .max_probe_resp_desc_thres = 0,
  .cal_data_len = 2116,
  .fw = {
   .dir = QCA988X_HW_2_0_FW_DIR,
   .board_size = QCA988X_BOARD_DATA_SZ,
   .board_ext_size = QCA988X_BOARD_EXT_DATA_SZ,
  },
  .rx_desc_ops = &qca988x_rx_desc_ops,
  .hw_ops = &qca988x_ops,
  .decap_align_bytes = 4,
  .spectral_bin_discard = 0,
  .spectral_bin_offset = 0,
  .vht160_mcs_rx_highest = 0,
  .vht160_mcs_tx_highest = 0,
  .n_cipher_suites = 8,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .target_64bit = false,
  .rx_ring_fill_level = HTT_RX_RING_FILL_LEVEL,
  .shadow_reg_support = false,
  .rri_on_ddr = false,
  .hw_filter_reset_required = true,
  .fw_diag_ce_download = false,
  .credit_size_workaround = false,
  .tx_stats_over_pktlog = true,
  .dynamic_sar_support = false,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = false,
 },
 {
  .id = QCA988X_HW_2_0_VERSION,
  .dev_id = QCA988X_2_0_DEVICE_ID_UBNT,
  .name = "qca988x hw2.0 ubiquiti",
  .patch_load_addr = QCA988X_HW_2_0_PATCH_LOAD_ADDR,
  .uart_pin = 7,
  .led_pin = 0,
  .cc_wraparound_type = ATH10K_HW_CC_WRAP_SHIFTED_ALL,
  .otp_exe_param = 0,
  .channel_counters_freq_hz = 88000,
  .max_probe_resp_desc_thres = 0,
  .cal_data_len = 2116,
  .fw = {
   .dir = QCA988X_HW_2_0_FW_DIR,
   .board_size = QCA988X_BOARD_DATA_SZ,
   .board_ext_size = QCA988X_BOARD_EXT_DATA_SZ,
  },
  .rx_desc_ops = &qca988x_rx_desc_ops,
  .hw_ops = &qca988x_ops,
  .decap_align_bytes = 4,
  .spectral_bin_discard = 0,
  .spectral_bin_offset = 0,
  .vht160_mcs_rx_highest = 0,
  .vht160_mcs_tx_highest = 0,
  .n_cipher_suites = 8,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .target_64bit = false,
  .rx_ring_fill_level = HTT_RX_RING_FILL_LEVEL,
  .shadow_reg_support = false,
  .rri_on_ddr = false,
  .hw_filter_reset_required = true,
  .fw_diag_ce_download = false,
  .credit_size_workaround = false,
  .tx_stats_over_pktlog = true,
  .dynamic_sar_support = false,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = false,
 },
 {
  .id = QCA9887_HW_1_0_VERSION,
  .dev_id = QCA9887_1_0_DEVICE_ID,
  .bus = ATH10K_BUS_PCI,
  .name = "qca9887 hw1.0",
  .patch_load_addr = QCA9887_HW_1_0_PATCH_LOAD_ADDR,
  .uart_pin = 7,
  .led_pin = 1,
  .cc_wraparound_type = ATH10K_HW_CC_WRAP_SHIFTED_ALL,
  .otp_exe_param = 0,
  .channel_counters_freq_hz = 88000,
  .max_probe_resp_desc_thres = 0,
  .cal_data_len = 2116,
  .fw = {
   .dir = QCA9887_HW_1_0_FW_DIR,
   .board_size = QCA9887_BOARD_DATA_SZ,
   .board_ext_size = QCA9887_BOARD_EXT_DATA_SZ,
  },
  .rx_desc_ops = &qca988x_rx_desc_ops,
  .hw_ops = &qca988x_ops,
  .decap_align_bytes = 4,
  .spectral_bin_discard = 0,
  .spectral_bin_offset = 0,
  .vht160_mcs_rx_highest = 0,
  .vht160_mcs_tx_highest = 0,
  .n_cipher_suites = 8,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .target_64bit = false,
  .rx_ring_fill_level = HTT_RX_RING_FILL_LEVEL,
  .shadow_reg_support = false,
  .rri_on_ddr = false,
  .hw_filter_reset_required = true,
  .fw_diag_ce_download = false,
  .credit_size_workaround = false,
  .tx_stats_over_pktlog = false,
  .dynamic_sar_support = false,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = false,
 },
 {
  .id = QCA6174_HW_3_2_VERSION,
  .dev_id = QCA6174_3_2_DEVICE_ID,
  .bus = ATH10K_BUS_SDIO,
  .name = "qca6174 hw3.2 sdio",
  .patch_load_addr = QCA6174_HW_3_0_PATCH_LOAD_ADDR,
  .uart_pin = 19,
  .led_pin = 0,
  .otp_exe_param = 0,
  .channel_counters_freq_hz = 88000,
  .max_probe_resp_desc_thres = 0,
  .cal_data_len = 0,
  .fw = {
   .dir = QCA6174_HW_3_0_FW_DIR,
   .board_size = QCA6174_BOARD_DATA_SZ,
   .board_ext_size = QCA6174_BOARD_EXT_DATA_SZ,
  },
  .rx_desc_ops = &qca988x_rx_desc_ops,
  .hw_ops = &qca6174_sdio_ops,
  .hw_clk = qca6174_clk,
  .target_cpu_freq = 176000000,
  .decap_align_bytes = 4,
  .n_cipher_suites = 8,
  .num_peers = 10,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .uart_pin_workaround = true,
  .tx_stats_over_pktlog = false,
  .credit_size_workaround = false,
  .bmi_large_size_download = true,
  .supports_peer_stats_info = true,
  .dynamic_sar_support = true,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = false,
 },
 {
  .id = QCA6174_HW_2_1_VERSION,
  .dev_id = QCA6164_2_1_DEVICE_ID,
  .bus = ATH10K_BUS_PCI,
  .name = "qca6164 hw2.1",
  .patch_load_addr = QCA6174_HW_2_1_PATCH_LOAD_ADDR,
  .uart_pin = 6,
  .led_pin = 0,
  .otp_exe_param = 0,
  .channel_counters_freq_hz = 88000,
  .max_probe_resp_desc_thres = 0,
  .cal_data_len = 8124,
  .fw = {
   .dir = QCA6174_HW_2_1_FW_DIR,
   .board_size = QCA6174_BOARD_DATA_SZ,
   .board_ext_size = QCA6174_BOARD_EXT_DATA_SZ,
  },
  .rx_desc_ops = &qca988x_rx_desc_ops,
  .hw_ops = &qca988x_ops,
  .decap_align_bytes = 4,
  .spectral_bin_discard = 0,
  .spectral_bin_offset = 0,
  .vht160_mcs_rx_highest = 0,
  .vht160_mcs_tx_highest = 0,
  .n_cipher_suites = 8,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .target_64bit = false,
  .rx_ring_fill_level = HTT_RX_RING_FILL_LEVEL,
  .shadow_reg_support = false,
  .rri_on_ddr = false,
  .hw_filter_reset_required = true,
  .fw_diag_ce_download = false,
  .credit_size_workaround = false,
  .tx_stats_over_pktlog = false,
  .dynamic_sar_support = false,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = false,
 },
 {
  .id = QCA6174_HW_2_1_VERSION,
  .dev_id = QCA6174_2_1_DEVICE_ID,
  .bus = ATH10K_BUS_PCI,
  .name = "qca6174 hw2.1",
  .patch_load_addr = QCA6174_HW_2_1_PATCH_LOAD_ADDR,
  .uart_pin = 6,
  .led_pin = 0,
  .otp_exe_param = 0,
  .channel_counters_freq_hz = 88000,
  .max_probe_resp_desc_thres = 0,
  .cal_data_len = 8124,
  .fw = {
   .dir = QCA6174_HW_2_1_FW_DIR,
   .board_size = QCA6174_BOARD_DATA_SZ,
   .board_ext_size = QCA6174_BOARD_EXT_DATA_SZ,
  },
  .rx_desc_ops = &qca988x_rx_desc_ops,
  .hw_ops = &qca988x_ops,
  .decap_align_bytes = 4,
  .spectral_bin_discard = 0,
  .spectral_bin_offset = 0,
  .vht160_mcs_rx_highest = 0,
  .vht160_mcs_tx_highest = 0,
  .n_cipher_suites = 8,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .target_64bit = false,
  .rx_ring_fill_level = HTT_RX_RING_FILL_LEVEL,
  .shadow_reg_support = false,
  .rri_on_ddr = false,
  .hw_filter_reset_required = true,
  .fw_diag_ce_download = false,
  .credit_size_workaround = false,
  .tx_stats_over_pktlog = false,
  .dynamic_sar_support = false,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = false,
 },
 {
  .id = QCA6174_HW_3_0_VERSION,
  .dev_id = QCA6174_2_1_DEVICE_ID,
  .bus = ATH10K_BUS_PCI,
  .name = "qca6174 hw3.0",
  .patch_load_addr = QCA6174_HW_3_0_PATCH_LOAD_ADDR,
  .uart_pin = 6,
  .led_pin = 0,
  .otp_exe_param = 0,
  .channel_counters_freq_hz = 88000,
  .max_probe_resp_desc_thres = 0,
  .cal_data_len = 8124,
  .fw = {
   .dir = QCA6174_HW_3_0_FW_DIR,
   .board_size = QCA6174_BOARD_DATA_SZ,
   .board_ext_size = QCA6174_BOARD_EXT_DATA_SZ,
  },
  .rx_desc_ops = &qca988x_rx_desc_ops,
  .hw_ops = &qca988x_ops,
  .decap_align_bytes = 4,
  .spectral_bin_discard = 0,
  .spectral_bin_offset = 0,
  .vht160_mcs_rx_highest = 0,
  .vht160_mcs_tx_highest = 0,
  .n_cipher_suites = 8,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .target_64bit = false,
  .rx_ring_fill_level = HTT_RX_RING_FILL_LEVEL,
  .shadow_reg_support = false,
  .rri_on_ddr = false,
  .hw_filter_reset_required = true,
  .fw_diag_ce_download = false,
  .credit_size_workaround = false,
  .tx_stats_over_pktlog = false,
  .dynamic_sar_support = false,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = false,
 },
 {
  .id = QCA6174_HW_3_2_VERSION,
  .dev_id = QCA6174_2_1_DEVICE_ID,
  .bus = ATH10K_BUS_PCI,
  .name = "qca6174 hw3.2",
  .patch_load_addr = QCA6174_HW_3_0_PATCH_LOAD_ADDR,
  .uart_pin = 6,
  .led_pin = 0,
  .otp_exe_param = 0,
  .channel_counters_freq_hz = 88000,
  .max_probe_resp_desc_thres = 0,
  .cal_data_len = 8124,
  .fw = {
   /* uses same binaries as hw3.0 */
   .dir = QCA6174_HW_3_0_FW_DIR,
   .board_size = QCA6174_BOARD_DATA_SZ,
   .board_ext_size = QCA6174_BOARD_EXT_DATA_SZ,
  },
  .rx_desc_ops = &qca988x_rx_desc_ops,
  .hw_ops = &qca6174_ops,
  .hw_clk = qca6174_clk,
  .target_cpu_freq = 176000000,
  .decap_align_bytes = 4,
  .spectral_bin_discard = 0,
  .spectral_bin_offset = 0,
  .vht160_mcs_rx_highest = 0,
  .vht160_mcs_tx_highest = 0,
  .n_cipher_suites = 8,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .target_64bit = false,
  .rx_ring_fill_level = HTT_RX_RING_FILL_LEVEL,
  .shadow_reg_support = false,
  .rri_on_ddr = false,
  .hw_filter_reset_required = true,
  .fw_diag_ce_download = true,
  .credit_size_workaround = false,
  .tx_stats_over_pktlog = false,
  .supports_peer_stats_info = true,
  .dynamic_sar_support = true,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = true,
 },
 {
  .id = QCA99X0_HW_2_0_DEV_VERSION,
  .dev_id = QCA99X0_2_0_DEVICE_ID,
  .bus = ATH10K_BUS_PCI,
  .name = "qca99x0 hw2.0",
  .patch_load_addr = QCA99X0_HW_2_0_PATCH_LOAD_ADDR,
  .uart_pin = 7,
  .led_pin = 17,
  .otp_exe_param = 0x00000700,
  .continuous_frag_desc = true,
  .cck_rate_map_rev2 = true,
  .channel_counters_freq_hz = 150000,
  .max_probe_resp_desc_thres = 24,
  .tx_chain_mask = 0xf,
  .rx_chain_mask = 0xf,
  .max_spatial_stream = 4,
  .cal_data_len = 12064,
  .fw = {
   .dir = QCA99X0_HW_2_0_FW_DIR,
   .board_size = QCA99X0_BOARD_DATA_SZ,
   .board_ext_size = QCA99X0_BOARD_EXT_DATA_SZ,
  },
  .sw_decrypt_mcast_mgmt = true,
  .rx_desc_ops = &qca99x0_rx_desc_ops,
  .hw_ops = &qca99x0_ops,
  .decap_align_bytes = 1,
  .spectral_bin_discard = 4,
  .spectral_bin_offset = 0,
  .vht160_mcs_rx_highest = 0,
  .vht160_mcs_tx_highest = 0,
  .n_cipher_suites = 11,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .target_64bit = false,
  .rx_ring_fill_level = HTT_RX_RING_FILL_LEVEL,
  .shadow_reg_support = false,
  .rri_on_ddr = false,
  .hw_filter_reset_required = true,
  .fw_diag_ce_download = false,
  .credit_size_workaround = false,
  .tx_stats_over_pktlog = false,
  .dynamic_sar_support = false,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = false,
 },
 {
  .id = QCA9984_HW_1_0_DEV_VERSION,
  .dev_id = QCA9984_1_0_DEVICE_ID,
  .bus = ATH10K_BUS_PCI,
  .name = "qca9984/qca9994 hw1.0",
  .patch_load_addr = QCA9984_HW_1_0_PATCH_LOAD_ADDR,
  .uart_pin = 7,
  .led_pin = 17,
  .cc_wraparound_type = ATH10K_HW_CC_WRAP_SHIFTED_EACH,
  .otp_exe_param = 0x00000700,
  .continuous_frag_desc = true,
  .cck_rate_map_rev2 = true,
  .channel_counters_freq_hz = 150000,
  .max_probe_resp_desc_thres = 24,
  .tx_chain_mask = 0xf,
  .rx_chain_mask = 0xf,
  .max_spatial_stream = 4,
  .cal_data_len = 12064,
  .fw = {
   .dir = QCA9984_HW_1_0_FW_DIR,
   .board_size = QCA99X0_BOARD_DATA_SZ,
   .board_ext_size = QCA99X0_BOARD_EXT_DATA_SZ,
   .ext_board_size = QCA99X0_EXT_BOARD_DATA_SZ,
  },
  .sw_decrypt_mcast_mgmt = true,
  .rx_desc_ops = &qca99x0_rx_desc_ops,
  .hw_ops = &qca99x0_ops,
  .decap_align_bytes = 1,
  .spectral_bin_discard = 12,
  .spectral_bin_offset = 8,

  /* Can do only 2x2 VHT160 or 80+80. 1560Mbps is 4x4 80Mhz
   * or 2x2 160Mhz, long-guard-interval.
 */
  .vht160_mcs_rx_highest = 1560,
  .vht160_mcs_tx_highest = 1560,
  .n_cipher_suites = 11,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .target_64bit = false,
  .rx_ring_fill_level = HTT_RX_RING_FILL_LEVEL,
  .shadow_reg_support = false,
  .rri_on_ddr = false,
  .hw_filter_reset_required = true,
  .fw_diag_ce_download = false,
  .credit_size_workaround = false,
  .tx_stats_over_pktlog = false,
  .dynamic_sar_support = false,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = false,
 },
 {
  .id = QCA9888_HW_2_0_DEV_VERSION,
  .dev_id = QCA9888_2_0_DEVICE_ID,
  .bus = ATH10K_BUS_PCI,
  .name = "qca9888 hw2.0",
  .patch_load_addr = QCA9888_HW_2_0_PATCH_LOAD_ADDR,
  .uart_pin = 7,
  .led_pin = 17,
  .cc_wraparound_type = ATH10K_HW_CC_WRAP_SHIFTED_EACH,
  .otp_exe_param = 0x00000700,
  .continuous_frag_desc = true,
  .channel_counters_freq_hz = 150000,
  .max_probe_resp_desc_thres = 24,
  .tx_chain_mask = 3,
  .rx_chain_mask = 3,
  .max_spatial_stream = 2,
  .cal_data_len = 12064,
  .fw = {
   .dir = QCA9888_HW_2_0_FW_DIR,
   .board_size = QCA99X0_BOARD_DATA_SZ,
   .board_ext_size = QCA99X0_BOARD_EXT_DATA_SZ,
  },
  .sw_decrypt_mcast_mgmt = true,
  .rx_desc_ops = &qca99x0_rx_desc_ops,
  .hw_ops = &qca99x0_ops,
  .decap_align_bytes = 1,
  .spectral_bin_discard = 12,
  .spectral_bin_offset = 8,

  /* Can do only 1x1 VHT160 or 80+80. 780Mbps is 2x2 80Mhz or
   * 1x1 160Mhz, long-guard-interval.
 */
  .vht160_mcs_rx_highest = 780,
  .vht160_mcs_tx_highest = 780,
  .n_cipher_suites = 11,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .target_64bit = false,
  .rx_ring_fill_level = HTT_RX_RING_FILL_LEVEL,
  .shadow_reg_support = false,
  .rri_on_ddr = false,
  .hw_filter_reset_required = true,
  .fw_diag_ce_download = false,
  .credit_size_workaround = false,
  .tx_stats_over_pktlog = false,
  .dynamic_sar_support = false,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = false,
 },
 {
  .id = QCA9377_HW_1_0_DEV_VERSION,
  .dev_id = QCA9377_1_0_DEVICE_ID,
  .bus = ATH10K_BUS_PCI,
  .name = "qca9377 hw1.0",
  .patch_load_addr = QCA9377_HW_1_0_PATCH_LOAD_ADDR,
  .uart_pin = 6,
  .led_pin = 0,
  .otp_exe_param = 0,
  .channel_counters_freq_hz = 88000,
  .max_probe_resp_desc_thres = 0,
  .cal_data_len = 8124,
  .fw = {
   .dir = QCA9377_HW_1_0_FW_DIR,
   .board_size = QCA9377_BOARD_DATA_SZ,
   .board_ext_size = QCA9377_BOARD_EXT_DATA_SZ,
  },
  .rx_desc_ops = &qca988x_rx_desc_ops,
  .hw_ops = &qca988x_ops,
  .decap_align_bytes = 4,
  .spectral_bin_discard = 0,
  .spectral_bin_offset = 0,
  .vht160_mcs_rx_highest = 0,
  .vht160_mcs_tx_highest = 0,
  .n_cipher_suites = 8,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .target_64bit = false,
  .rx_ring_fill_level = HTT_RX_RING_FILL_LEVEL,
  .shadow_reg_support = false,
  .rri_on_ddr = false,
  .hw_filter_reset_required = true,
  .fw_diag_ce_download = false,
  .credit_size_workaround = false,
  .tx_stats_over_pktlog = false,
  .dynamic_sar_support = false,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = false,
 },
 {
  .id = QCA9377_HW_1_1_DEV_VERSION,
  .dev_id = QCA9377_1_0_DEVICE_ID,
  .bus = ATH10K_BUS_PCI,
  .name = "qca9377 hw1.1",
  .patch_load_addr = QCA9377_HW_1_0_PATCH_LOAD_ADDR,
  .uart_pin = 6,
  .led_pin = 0,
  .otp_exe_param = 0,
  .channel_counters_freq_hz = 88000,
  .max_probe_resp_desc_thres = 0,
  .cal_data_len = 8124,
  .fw = {
   .dir = QCA9377_HW_1_0_FW_DIR,
   .board_size = QCA9377_BOARD_DATA_SZ,
   .board_ext_size = QCA9377_BOARD_EXT_DATA_SZ,
  },
  .rx_desc_ops = &qca988x_rx_desc_ops,
  .hw_ops = &qca6174_ops,
  .hw_clk = qca6174_clk,
  .target_cpu_freq = 176000000,
  .decap_align_bytes = 4,
  .spectral_bin_discard = 0,
  .spectral_bin_offset = 0,
  .vht160_mcs_rx_highest = 0,
  .vht160_mcs_tx_highest = 0,
  .n_cipher_suites = 8,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .target_64bit = false,
  .rx_ring_fill_level = HTT_RX_RING_FILL_LEVEL,
  .shadow_reg_support = false,
  .rri_on_ddr = false,
  .hw_filter_reset_required = true,
  .fw_diag_ce_download = true,
  .credit_size_workaround = false,
  .tx_stats_over_pktlog = false,
  .dynamic_sar_support = false,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = false,
 },
 {
  .id = QCA9377_HW_1_1_DEV_VERSION,
  .dev_id = QCA9377_1_0_DEVICE_ID,
  .bus = ATH10K_BUS_SDIO,
  .name = "qca9377 hw1.1 sdio",
  .patch_load_addr = QCA9377_HW_1_0_PATCH_LOAD_ADDR,
  .uart_pin = 19,
  .led_pin = 0,
  .otp_exe_param = 0,
  .channel_counters_freq_hz = 88000,
  .max_probe_resp_desc_thres = 0,
  .cal_data_len = 8124,
  .fw = {
   .dir = QCA9377_HW_1_0_FW_DIR,
   .board_size = QCA9377_BOARD_DATA_SZ,
   .board_ext_size = QCA9377_BOARD_EXT_DATA_SZ,
  },
  .rx_desc_ops = &qca988x_rx_desc_ops,
  .hw_ops = &qca6174_ops,
  .hw_clk = qca6174_clk,
  .target_cpu_freq = 176000000,
  .decap_align_bytes = 4,
  .n_cipher_suites = 8,
  .num_peers = TARGET_QCA9377_HL_NUM_PEERS,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .uart_pin_workaround = true,
  .credit_size_workaround = true,
  .dynamic_sar_support = false,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = false,
 },
 {
  .id = QCA4019_HW_1_0_DEV_VERSION,
  .dev_id = 0,
  .bus = ATH10K_BUS_AHB,
  .name = "qca4019 hw1.0",
  .patch_load_addr = QCA4019_HW_1_0_PATCH_LOAD_ADDR,
  .uart_pin = 7,
  .led_pin = 0,
  .cc_wraparound_type = ATH10K_HW_CC_WRAP_SHIFTED_EACH,
  .otp_exe_param = 0x0010000,
  .continuous_frag_desc = true,
  .cck_rate_map_rev2 = true,
  .channel_counters_freq_hz = 125000,
  .max_probe_resp_desc_thres = 24,
  .tx_chain_mask = 0x3,
  .rx_chain_mask = 0x3,
  .max_spatial_stream = 2,
  .cal_data_len = 12064,
  .fw = {
   .dir = QCA4019_HW_1_0_FW_DIR,
   .board_size = QCA4019_BOARD_DATA_SZ,
   .board_ext_size = QCA4019_BOARD_EXT_DATA_SZ,
  },
  .sw_decrypt_mcast_mgmt = true,
  .rx_desc_ops = &qca99x0_rx_desc_ops,
  .hw_ops = &qca99x0_ops,
  .decap_align_bytes = 1,
  .spectral_bin_discard = 4,
  .spectral_bin_offset = 0,
  .vht160_mcs_rx_highest = 0,
  .vht160_mcs_tx_highest = 0,
  .n_cipher_suites = 11,
  .ast_skid_limit = 0x10,
  .num_wds_entries = 0x20,
  .target_64bit = false,
  .rx_ring_fill_level = HTT_RX_RING_FILL_LEVEL,
  .shadow_reg_support = false,
  .rri_on_ddr = false,
  .hw_filter_reset_required = true,
  .fw_diag_ce_download = false,
  .credit_size_workaround = false,
  .tx_stats_over_pktlog = false,
  .dynamic_sar_support = false,
  .hw_restart_disconnect = false,
  .use_fw_tx_credits = true,
  .delay_unmap_buffer = false,
  .mcast_frame_registration = false,
 },
 {
  .id = WCN3990_HW_1_0_DEV_VERSION,
  .dev_id = 0,
  .bus = ATH10K_BUS_SNOC,
  .name = "wcn3990 hw1.0",
  .led_pin = 0,
  .continuous_frag_desc = true,
  .tx_chain_mask = 0x7,
  .rx_chain_mask = 0x7,
  .max_spatial_stream = 4,
  .fw = {
   .dir = WCN3990_HW_1_0_FW_DIR,
   .board_size = WCN3990_BOARD_DATA_SZ,
   .board_ext_size = WCN3990_BOARD_EXT_DATA_SZ,
  },
  .sw_decrypt_mcast_mgmt = true,
  .rx_desc_ops = &wcn3990_rx_desc_ops,
  .hw_ops = &wcn3990_ops,
  .decap_align_bytes = 1,
  .num_peers = TARGET_HL_TLV_NUM_PEERS,
  .n_cipher_suites = 11,
  .ast_skid_limit = TARGET_HL_TLV_AST_SKID_LIMIT,
  .num_wds_entries = TARGET_HL_TLV_NUM_WDS_ENTRIES,
  .target_64bit = true,
  .rx_ring_fill_level = HTT_RX_RING_FILL_LEVEL_DUAL_MAC,
  .shadow_reg_support = true,
  .rri_on_ddr = true,
  .hw_filter_reset_required = false,
  .fw_diag_ce_download = false,
  .credit_size_workaround = false,
  .tx_stats_over_pktlog = false,
  .dynamic_sar_support = true,
  .hw_restart_disconnect = true,
  .use_fw_tx_credits = false,
  .delay_unmap_buffer = true,
  .mcast_frame_registration = false,
 },
};

static const char *const ath10k_core_fw_feature_str[] = {
 [ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX] = "wmi-mgmt-rx",
 [ATH10K_FW_FEATURE_WMI_10X] = "wmi-10.x",
 [ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX] = "has-wmi-mgmt-tx",
 [ATH10K_FW_FEATURE_NO_P2P] = "no-p2p",
 [ATH10K_FW_FEATURE_WMI_10_2] = "wmi-10.2",
 [ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT] = "multi-vif-ps",
 [ATH10K_FW_FEATURE_WOWLAN_SUPPORT] = "wowlan",
 [ATH10K_FW_FEATURE_IGNORE_OTP_RESULT] = "ignore-otp",
 [ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING] = "no-4addr-pad",
 [ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT] = "skip-clock-init",
 [ATH10K_FW_FEATURE_RAW_MODE_SUPPORT] = "raw-mode",
 [ATH10K_FW_FEATURE_SUPPORTS_ADAPTIVE_CCA] = "adaptive-cca",
 [ATH10K_FW_FEATURE_MFP_SUPPORT] = "mfp",
 [ATH10K_FW_FEATURE_PEER_FLOW_CONTROL] = "peer-flow-ctrl",
 [ATH10K_FW_FEATURE_BTCOEX_PARAM] = "btcoex-param",
 [ATH10K_FW_FEATURE_SKIP_NULL_FUNC_WAR] = "skip-null-func-war",
 [ATH10K_FW_FEATURE_ALLOWS_MESH_BCAST] = "allows-mesh-bcast",
 [ATH10K_FW_FEATURE_NO_PS] = "no-ps",
 [ATH10K_FW_FEATURE_MGMT_TX_BY_REF] = "mgmt-tx-by-reference",
 [ATH10K_FW_FEATURE_NON_BMI] = "non-bmi",
 [ATH10K_FW_FEATURE_SINGLE_CHAN_INFO_PER_CHANNEL] = "single-chan-info-per-channel",
 [ATH10K_FW_FEATURE_PEER_FIXED_RATE] = "peer-fixed-rate",
 [ATH10K_FW_FEATURE_IRAM_RECOVERY] = "iram-recovery",
};

static unsigned int ath10k_core_get_fw_feature_str(char *buf,
         size_t buf_len,
         enum ath10k_fw_features feat)
{
 /* make sure that ath10k_core_fw_feature_str[] gets updated */
 BUILD_BUG_ON(ARRAY_SIZE(ath10k_core_fw_feature_str) !=
       ATH10K_FW_FEATURE_COUNT);

 if (feat >= ARRAY_SIZE(ath10k_core_fw_feature_str) ||
     WARN_ON(!ath10k_core_fw_feature_str[feat])) {
  return scnprintf(buf, buf_len, "bit%d", feat);
 }

 return scnprintf(buf, buf_len, "%s", ath10k_core_fw_feature_str[feat]);
}

void ath10k_core_get_fw_features_str(struct ath10k *ar,
         char *buf,
         size_t buf_len)
{
 size_t len = 0;
 int i;

 for (i = 0; i < ATH10K_FW_FEATURE_COUNT; i++) {
  if (test_bit(i, ar->normal_mode_fw.fw_file.fw_features)) {
   if (len > 0)
    len += scnprintf(buf + len, buf_len - len, ",");

   len += ath10k_core_get_fw_feature_str(buf + len,
             buf_len - len,
             i);
  }
 }
}

static void ath10k_send_suspend_complete(struct ath10k *ar)
{
 ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot suspend complete\n");

 complete(&ar->target_suspend);
}

static int ath10k_init_sdio(struct ath10k *ar, enum ath10k_firmware_mode mode)
{
 bool mtu_workaround = ar->hw_params.credit_size_workaround;
 int ret;
 u32 param = 0;

 ret = ath10k_bmi_write32(ar, hi_mbox_io_block_sz, 256);
 if (ret)
  return ret;

 ret = ath10k_bmi_write32(ar, hi_mbox_isr_yield_limit, 99);
 if (ret)
  return ret;

 ret = ath10k_bmi_read32(ar, hi_acs_flags, ¶m);
 if (ret)
  return ret;

 param |= HI_ACS_FLAGS_SDIO_REDUCE_TX_COMPL_SET;

 if (mode == ATH10K_FIRMWARE_MODE_NORMAL && !mtu_workaround)
  param |= HI_ACS_FLAGS_ALT_DATA_CREDIT_SIZE;
 else
  param &= ~HI_ACS_FLAGS_ALT_DATA_CREDIT_SIZE;

 if (mode == ATH10K_FIRMWARE_MODE_UTF)
  param &= ~HI_ACS_FLAGS_SDIO_SWAP_MAILBOX_SET;
 else
  param |= HI_ACS_FLAGS_SDIO_SWAP_MAILBOX_SET;

 ret = ath10k_bmi_write32(ar, hi_acs_flags, param);
 if (ret)
  return ret;

 ret = ath10k_bmi_read32(ar, hi_option_flag2, ¶m);
 if (ret)
  return ret;

 param |= HI_OPTION_SDIO_CRASH_DUMP_ENHANCEMENT_HOST;

 ret = ath10k_bmi_write32(ar, hi_option_flag2, param);
 if (ret)
  return ret;

 return 0;
}

static int ath10k_init_configure_target(struct ath10k *ar)
{
 u32 param_host;
 int ret;

 /* tell target which HTC version it is used*/
 ret = ath10k_bmi_write32(ar, hi_app_host_interest,
     HTC_PROTOCOL_VERSION);
 if (ret) {
  ath10k_err(ar, "settings HTC version failed\n");
  return ret;
 }

 /* set the firmware mode to STA/IBSS/AP */
 ret = ath10k_bmi_read32(ar, hi_option_flag, ¶m_host);
 if (ret) {
  ath10k_err(ar, "setting firmware mode (1/2) failed\n");
  return ret;
 }

 /* TODO following parameters need to be re-visited. */
 /* num_device */
 param_host |= (1 << HI_OPTION_NUM_DEV_SHIFT);
 /* Firmware mode */
 /* FIXME: Why FW_MODE_AP ??.*/
 param_host |= (HI_OPTION_FW_MODE_AP << HI_OPTION_FW_MODE_SHIFT);
 /* mac_addr_method */
 param_host |= (1 << HI_OPTION_MAC_ADDR_METHOD_SHIFT);
 /* firmware_bridge */
 param_host |= (0 << HI_OPTION_FW_BRIDGE_SHIFT);
 /* fwsubmode */
 param_host |= (0 << HI_OPTION_FW_SUBMODE_SHIFT);

 ret = ath10k_bmi_write32(ar, hi_option_flag, param_host);
 if (ret) {
  ath10k_err(ar, "setting firmware mode (2/2) failed\n");
  return ret;
 }

 /* We do all byte-swapping on the host */
 ret = ath10k_bmi_write32(ar, hi_be, 0);
 if (ret) {
  ath10k_err(ar, "setting host CPU BE mode failed\n");
  return ret;
 }

 /* FW descriptor/Data swap flags */
 ret = ath10k_bmi_write32(ar, hi_fw_swap, 0);

 if (ret) {
  ath10k_err(ar, "setting FW data/desc swap flags failed\n");
  return ret;
 }

 /* Some devices have a special sanity check that verifies the PCI
  * Device ID is written to this host interest var. It is known to be
  * required to boot QCA6164.
 */
 ret = ath10k_bmi_write32(ar, hi_hci_uart_pwr_mgmt_params_ext,
     ar->dev_id);
 if (ret) {
  ath10k_err(ar, "failed to set pwr_mgmt_params: %d\n", ret);
  return ret;
 }

 return 0;
}

static const struct firmware *ath10k_fetch_fw_file(struct ath10k *ar,
         const char *dir,
         const char *file)
{
 char filename[100];
 const struct firmware *fw;
 int ret;

 if (file == NULL)
  return ERR_PTR(-ENOENT);

 if (dir == NULL)
  dir = ".";

 if (ar->board_name) {
  snprintf(filename, sizeof(filename), "%s/%s/%s",
    dir, ar->board_name, file);
  ret = firmware_request_nowarn(&fw, filename, ar->dev);
  ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot fw request '%s': %d\n",
      filename, ret);
  if (!ret)
   return fw;
 }

 snprintf(filename, sizeof(filename), "%s/%s", dir, file);
 ret = firmware_request_nowarn(&fw, filename, ar->dev);
 ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot fw request '%s': %d\n",
     filename, ret);
 if (ret)
  return ERR_PTR(ret);

 return fw;
}

static int ath10k_push_board_ext_data(struct ath10k *ar, const void *data,
          size_t data_len)
{
 u32 board_data_size = ar->hw_params.fw.board_size;
 u32 board_ext_data_size = ar->hw_params.fw.board_ext_size;
 u32 board_ext_data_addr;
 int ret;

 ret = ath10k_bmi_read32(ar, hi_board_ext_data, &board_ext_data_addr);
 if (ret) {
  ath10k_err(ar, "could not read board ext data addr (%d)\n",
      ret);
  return ret;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "boot push board extended data addr 0x%x\n",
     board_ext_data_addr);

 if (board_ext_data_addr == 0)
  return 0;

 if (data_len != (board_data_size + board_ext_data_size)) {
  ath10k_err(ar, "invalid board (ext) data sizes %zu != %d+%d\n",
      data_len, board_data_size, board_ext_data_size);
  return -EINVAL;
 }

 ret = ath10k_bmi_write_memory(ar, board_ext_data_addr,
          data + board_data_size,
          board_ext_data_size);
 if (ret) {
  ath10k_err(ar, "could not write board ext data (%d)\n", ret);
  return ret;
 }

 ret = ath10k_bmi_write32(ar, hi_board_ext_data_config,
     (board_ext_data_size << 16) | 1);
 if (ret) {
  ath10k_err(ar, "could not write board ext data bit (%d)\n",
      ret);
  return ret;
 }

 return 0;
}

static int ath10k_core_get_board_id_from_otp(struct ath10k *ar)
{
 u32 result, address;
 u8 board_id, chip_id;
 bool ext_bid_support;
 int ret, bmi_board_id_param;

 address = ar->hw_params.patch_load_addr;

 if (!ar->normal_mode_fw.fw_file.otp_data ||
     !ar->normal_mode_fw.fw_file.otp_len) {
  ath10k_warn(ar,
       "failed to retrieve board id because of invalid otp\n");
  return -ENODATA;
 }

 if (ar->id.bmi_ids_valid) {
  ath10k_dbg(ar, ATH10K_DBG_BOOT,
      "boot already acquired valid otp board id,skip download, board_id %d chip_id %d\n",
      ar->id.bmi_board_id, ar->id.bmi_chip_id);
  goto skip_otp_download;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "boot upload otp to 0x%x len %zd for board id\n",
     address, ar->normal_mode_fw.fw_file.otp_len);

 ret = ath10k_bmi_fast_download(ar, address,
           ar->normal_mode_fw.fw_file.otp_data,
           ar->normal_mode_fw.fw_file.otp_len);
 if (ret) {
  ath10k_err(ar, "could not write otp for board id check: %d\n",
      ret);
  return ret;
 }

 if (ar->cal_mode == ATH10K_PRE_CAL_MODE_DT ||
     ar->cal_mode == ATH10K_PRE_CAL_MODE_FILE ||
     ar->cal_mode == ATH10K_PRE_CAL_MODE_NVMEM)
  bmi_board_id_param = BMI_PARAM_GET_FLASH_BOARD_ID;
 else
  bmi_board_id_param = BMI_PARAM_GET_EEPROM_BOARD_ID;

 ret = ath10k_bmi_execute(ar, address, bmi_board_id_param, &result);
 if (ret) {
  ath10k_err(ar, "could not execute otp for board id check: %d\n",
      ret);
  return ret;
 }

 board_id = MS(result, ATH10K_BMI_BOARD_ID_FROM_OTP);
 chip_id = MS(result, ATH10K_BMI_CHIP_ID_FROM_OTP);
 ext_bid_support = (result & ATH10K_BMI_EXT_BOARD_ID_SUPPORT);

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "boot get otp board id result 0x%08x board_id %d chip_id %d ext_bid_support %d\n",
     result, board_id, chip_id, ext_bid_support);

 ar->id.ext_bid_supported = ext_bid_support;

 if ((result & ATH10K_BMI_BOARD_ID_STATUS_MASK) != 0 ||
     (board_id == 0)) {
  ath10k_dbg(ar, ATH10K_DBG_BOOT,
      "board id does not exist in otp, ignore it\n");
  return -EOPNOTSUPP;
 }

 ar->id.bmi_ids_valid = true;
 ar->id.bmi_board_id = board_id;
 ar->id.bmi_chip_id = chip_id;

skip_otp_download:

 return 0;
}

static void ath10k_core_check_bdfext(const struct dmi_header *hdr, void *data)
{
 struct ath10k *ar = data;
 const char *bdf_ext;
 const char *magic = ATH10K_SMBIOS_BDF_EXT_MAGIC;
 u8 bdf_enabled;
 int i;

 if (hdr->type != ATH10K_SMBIOS_BDF_EXT_TYPE)
  return;

 if (hdr->length != ATH10K_SMBIOS_BDF_EXT_LENGTH) {
  ath10k_dbg(ar, ATH10K_DBG_BOOT,
      "wrong smbios bdf ext type length (%d).\n",
      hdr->length);
  return;
 }

 bdf_enabled = *((u8 *)hdr + ATH10K_SMBIOS_BDF_EXT_OFFSET);
 if (!bdf_enabled) {
  ath10k_dbg(ar, ATH10K_DBG_BOOT, "bdf variant name not found.\n");
  return;
 }

 /* Only one string exists (per spec) */
 bdf_ext = (char *)hdr + hdr->length;

 if (memcmp(bdf_ext, magic, strlen(magic)) != 0) {
  ath10k_dbg(ar, ATH10K_DBG_BOOT,
      "bdf variant magic does not match.\n");
  return;
 }

 for (i = 0; i < strlen(bdf_ext); i++) {
  if (!isascii(bdf_ext[i]) || !isprint(bdf_ext[i])) {
   ath10k_dbg(ar, ATH10K_DBG_BOOT,
       "bdf variant name contains non ascii chars.\n");
   return;
  }
 }

 /* Copy extension name without magic suffix */
 if (strscpy(ar->id.bdf_ext, bdf_ext + strlen(magic),
      sizeof(ar->id.bdf_ext)) < 0) {
  ath10k_dbg(ar, ATH10K_DBG_BOOT,
      "bdf variant string is longer than the buffer can accommodate (variant: %s)\n",
       bdf_ext);
  return;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "found and validated bdf variant smbios_type 0x%x bdf %s\n",
     ATH10K_SMBIOS_BDF_EXT_TYPE, bdf_ext);
}

static int ath10k_core_check_smbios(struct ath10k *ar)
{
 ar->id.bdf_ext[0] = '\0';
 dmi_walk(ath10k_core_check_bdfext, ar);

 if (ar->id.bdf_ext[0] == '\0')
  return -ENODATA;

 return 0;
}

int ath10k_core_check_dt(struct ath10k *ar)
{
 struct device_node *node;
 const char *variant = NULL;

 node = ar->dev->of_node;
 if (!node)
  return -ENOENT;

 of_property_read_string(node, "qcom,calibration-variant",
    &variant);
 if (!variant)
  of_property_read_string(node, "qcom,ath10k-calibration-variant",
     &variant);
 if (!variant)
  return -ENODATA;

 if (strscpy(ar->id.bdf_ext, variant, sizeof(ar->id.bdf_ext)) < 0)
  ath10k_dbg(ar, ATH10K_DBG_BOOT,
      "bdf variant string is longer than the buffer can accommodate (variant: %s)\n",
       variant);

 return 0;
}
EXPORT_SYMBOL(ath10k_core_check_dt);

static int ath10k_download_fw(struct ath10k *ar)
{
 u32 address, data_len;
 const void *data;
 int ret;
 struct pm_qos_request latency_qos;

 address = ar->hw_params.patch_load_addr;

 data = ar->running_fw->fw_file.firmware_data;
 data_len = ar->running_fw->fw_file.firmware_len;

 ret = ath10k_swap_code_seg_configure(ar, &ar->running_fw->fw_file);
 if (ret) {
  ath10k_err(ar, "failed to configure fw code swap: %d\n",
      ret);
  return ret;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "boot uploading firmware image %p len %d\n",
     data, data_len);

 /* Check if device supports to download firmware via
  * diag copy engine. Downloading firmware via diag CE
  * greatly reduces the time to download firmware.
 */
 if (ar->hw_params.fw_diag_ce_download) {
  ret = ath10k_hw_diag_fast_download(ar, address,
         data, data_len);
  if (ret == 0)
   /* firmware upload via diag ce was successful */
   return 0;

  ath10k_warn(ar,
       "failed to upload firmware via diag ce, trying BMI: %d",
       ret);
 }

 memset(&latency_qos, 0, sizeof(latency_qos));
 cpu_latency_qos_add_request(&latency_qos, 0);

 ret = ath10k_bmi_fast_download(ar, address, data, data_len);

 cpu_latency_qos_remove_request(&latency_qos);

 return ret;
}

void ath10k_core_free_board_files(struct ath10k *ar)
{
 if (!IS_ERR(ar->normal_mode_fw.board))
  release_firmware(ar->normal_mode_fw.board);

 if (!IS_ERR(ar->normal_mode_fw.ext_board))
  release_firmware(ar->normal_mode_fw.ext_board);

 ar->normal_mode_fw.board = NULL;
 ar->normal_mode_fw.board_data = NULL;
 ar->normal_mode_fw.board_len = 0;
 ar->normal_mode_fw.ext_board = NULL;
 ar->normal_mode_fw.ext_board_data = NULL;
 ar->normal_mode_fw.ext_board_len = 0;
}
EXPORT_SYMBOL(ath10k_core_free_board_files);

static void ath10k_core_free_firmware_files(struct ath10k *ar)
{
 if (!IS_ERR(ar->normal_mode_fw.fw_file.firmware))
  release_firmware(ar->normal_mode_fw.fw_file.firmware);

 if (!IS_ERR(ar->cal_file))
  release_firmware(ar->cal_file);

 if (!IS_ERR(ar->pre_cal_file))
  release_firmware(ar->pre_cal_file);

 ath10k_swap_code_seg_release(ar, &ar->normal_mode_fw.fw_file);

 ar->normal_mode_fw.fw_file.otp_data = NULL;
 ar->normal_mode_fw.fw_file.otp_len = 0;

 ar->normal_mode_fw.fw_file.firmware = NULL;
 ar->normal_mode_fw.fw_file.firmware_data = NULL;
 ar->normal_mode_fw.fw_file.firmware_len = 0;

 ar->cal_file = NULL;
 ar->pre_cal_file = NULL;
}

static int ath10k_fetch_cal_file(struct ath10k *ar)
{
 char filename[100];

 /* pre-cal-<bus>-<id>.bin */
 scnprintf(filename, sizeof(filename), "pre-cal-%s-%s.bin",
    ath10k_bus_str(ar->hif.bus), dev_name(ar->dev));

 ar->pre_cal_file = ath10k_fetch_fw_file(ar, ATH10K_FW_DIR, filename);
 if (!IS_ERR(ar->pre_cal_file))
  goto success;

 /* cal-<bus>-<id>.bin */
 scnprintf(filename, sizeof(filename), "cal-%s-%s.bin",
    ath10k_bus_str(ar->hif.bus), dev_name(ar->dev));

 ar->cal_file = ath10k_fetch_fw_file(ar, ATH10K_FW_DIR, filename);
 if (IS_ERR(ar->cal_file))
  /* calibration file is optional, don't print any warnings */
  return PTR_ERR(ar->cal_file);
success:
 ath10k_dbg(ar, ATH10K_DBG_BOOT, "found calibration file %s/%s\n",
     ATH10K_FW_DIR, filename);

 return 0;
}

static int ath10k_core_fetch_board_data_api_1(struct ath10k *ar, int bd_ie_type)
{
 const struct firmware *fw;
 char boardname[100];

 if (bd_ie_type == ATH10K_BD_IE_BOARD) {
  scnprintf(boardname, sizeof(boardname), "board-%s-%s.bin",
     ath10k_bus_str(ar->hif.bus), dev_name(ar->dev));

  ar->normal_mode_fw.board = ath10k_fetch_fw_file(ar,
        ar->hw_params.fw.dir,
        boardname);
  if (IS_ERR(ar->normal_mode_fw.board)) {
   fw = ath10k_fetch_fw_file(ar,
        ar->hw_params.fw.dir,
        ATH10K_BOARD_DATA_FILE);
   ar->normal_mode_fw.board = fw;
  }

  if (IS_ERR(ar->normal_mode_fw.board))
   return PTR_ERR(ar->normal_mode_fw.board);

  ar->normal_mode_fw.board_data = ar->normal_mode_fw.board->data;
  ar->normal_mode_fw.board_len = ar->normal_mode_fw.board->size;
 } else if (bd_ie_type == ATH10K_BD_IE_BOARD_EXT) {
  fw = ath10k_fetch_fw_file(ar, ar->hw_params.fw.dir,
       ATH10K_EBOARD_DATA_FILE);
  ar->normal_mode_fw.ext_board = fw;
  if (IS_ERR(ar->normal_mode_fw.ext_board))
   return PTR_ERR(ar->normal_mode_fw.ext_board);

  ar->normal_mode_fw.ext_board_data = ar->normal_mode_fw.ext_board->data;
  ar->normal_mode_fw.ext_board_len = ar->normal_mode_fw.ext_board->size;
 }

 return 0;
}

static int ath10k_core_parse_bd_ie_board(struct ath10k *ar,
      const void *buf, size_t buf_len,
      const char *boardname,
      int bd_ie_type)
{
 const struct ath10k_fw_ie *hdr;
 bool name_match_found;
 int ret, board_ie_id;
 size_t board_ie_len;
 const void *board_ie_data;

 name_match_found = false;

 /* go through ATH10K_BD_IE_BOARD_ elements */
 while (buf_len > sizeof(struct ath10k_fw_ie)) {
  hdr = buf;
  board_ie_id = le32_to_cpu(hdr->id);
  board_ie_len = le32_to_cpu(hdr->len);
  board_ie_data = hdr->data;

  buf_len -= sizeof(*hdr);
  buf += sizeof(*hdr);

  if (buf_len < ALIGN(board_ie_len, 4)) {
   ath10k_err(ar, "invalid ATH10K_BD_IE_BOARD length: %zu < %zu\n",
       buf_len, ALIGN(board_ie_len, 4));
   ret = -EINVAL;
   goto out;
  }

  switch (board_ie_id) {
  case ATH10K_BD_IE_BOARD_NAME:
   ath10k_dbg_dump(ar, ATH10K_DBG_BOOT, "board name", "",
     board_ie_data, board_ie_len);

   if (board_ie_len != strlen(boardname))
    break;

   ret = memcmp(board_ie_data, boardname, strlen(boardname));
   if (ret)
    break;

   name_match_found = true;
   ath10k_dbg(ar, ATH10K_DBG_BOOT,
       "boot found match for name '%s'",
       boardname);
   break;
  case ATH10K_BD_IE_BOARD_DATA:
   if (!name_match_found)
    /* no match found */
    break;

   if (bd_ie_type == ATH10K_BD_IE_BOARD) {
    ath10k_dbg(ar, ATH10K_DBG_BOOT,
        "boot found board data for '%s'",
      boardname);

    ar->normal_mode_fw.board_data = board_ie_data;
    ar->normal_mode_fw.board_len = board_ie_len;
   } else if (bd_ie_type == ATH10K_BD_IE_BOARD_EXT) {
    ath10k_dbg(ar, ATH10K_DBG_BOOT,
        "boot found eboard data for '%s'",
      boardname);

    ar->normal_mode_fw.ext_board_data = board_ie_data;
    ar->normal_mode_fw.ext_board_len = board_ie_len;
   }

   ret = 0;
   goto out;
  default:
   ath10k_warn(ar, "unknown ATH10K_BD_IE_BOARD found: %d\n",
        board_ie_id);
   break;
  }

  /* jump over the padding */
  board_ie_len = ALIGN(board_ie_len, 4);

  buf_len -= board_ie_len;
  buf += board_ie_len;
 }

 /* no match found */
 ret = -ENOENT;

out:
 return ret;
}

static int ath10k_core_search_bd(struct ath10k *ar,
     const char *boardname,
     const u8 *data,
     size_t len)
{
 size_t ie_len;
 struct ath10k_fw_ie *hdr;
 int ret = -ENOENT, ie_id;

 while (len > sizeof(struct ath10k_fw_ie)) {
  hdr = (struct ath10k_fw_ie *)data;
  ie_id = le32_to_cpu(hdr->id);
  ie_len = le32_to_cpu(hdr->len);

  len -= sizeof(*hdr);
  data = hdr->data;

  if (len < ALIGN(ie_len, 4)) {
   ath10k_err(ar, "invalid length for board ie_id %d ie_len %zu len %zu\n",
       ie_id, ie_len, len);
   return -EINVAL;
  }

  switch (ie_id) {
  case ATH10K_BD_IE_BOARD:
   ret = ath10k_core_parse_bd_ie_board(ar, data, ie_len,
           boardname,
           ATH10K_BD_IE_BOARD);
   if (ret == -ENOENT)
    /* no match found, continue */
    break;

   /* either found or error, so stop searching */
   goto out;
  case ATH10K_BD_IE_BOARD_EXT:
   ret = ath10k_core_parse_bd_ie_board(ar, data, ie_len,
           boardname,
           ATH10K_BD_IE_BOARD_EXT);
   if (ret == -ENOENT)
    /* no match found, continue */
    break;

   /* either found or error, so stop searching */
   goto out;
  }

  /* jump over the padding */
  ie_len = ALIGN(ie_len, 4);

  len -= ie_len;
  data += ie_len;
 }

out:
 /* return result of parse_bd_ie_board() or -ENOENT */
 return ret;
}

static int ath10k_core_fetch_board_data_api_n(struct ath10k *ar,
           const char *boardname,
           const char *fallback_boardname1,
           const char *fallback_boardname2,
           const char *filename)
{
 size_t len, magic_len;
 const u8 *data;
 int ret;

 /* Skip if already fetched during board data download */
 if (!ar->normal_mode_fw.board)
  ar->normal_mode_fw.board = ath10k_fetch_fw_file(ar,
        ar->hw_params.fw.dir,
        filename);
 if (IS_ERR(ar->normal_mode_fw.board))
  return PTR_ERR(ar->normal_mode_fw.board);

 data = ar->normal_mode_fw.board->data;
 len = ar->normal_mode_fw.board->size;

 /* magic has extra null byte padded */
 magic_len = strlen(ATH10K_BOARD_MAGIC) + 1;
 if (len < magic_len) {
  ath10k_err(ar, "failed to find magic value in %s/%s, file too short: %zu\n",
      ar->hw_params.fw.dir, filename, len);
  ret = -EINVAL;
  goto err;
 }

 if (memcmp(data, ATH10K_BOARD_MAGIC, magic_len)) {
  ath10k_err(ar, "found invalid board magic\n");
  ret = -EINVAL;
  goto err;
 }

 /* magic is padded to 4 bytes */
 magic_len = ALIGN(magic_len, 4);
 if (len < magic_len) {
  ath10k_err(ar, "failed: %s/%s too small to contain board data, len: %zu\n",
      ar->hw_params.fw.dir, filename, len);
  ret = -EINVAL;
  goto err;
 }

 data += magic_len;
 len -= magic_len;

 /* attempt to find boardname in the IE list */
 ret = ath10k_core_search_bd(ar, boardname, data, len);

 /* if we didn't find it and have a fallback name, try that */
 if (ret == -ENOENT && fallback_boardname1)
  ret = ath10k_core_search_bd(ar, fallback_boardname1, data, len);

 if (ret == -ENOENT && fallback_boardname2)
  ret = ath10k_core_search_bd(ar, fallback_boardname2, data, len);

 if (ret == -ENOENT) {
  ath10k_err(ar,
      "failed to fetch board data for %s from %s/%s\n",
      boardname, ar->hw_params.fw.dir, filename);
  ret = -ENODATA;
 }

 if (ret)
  goto err;

 return 0;

err:
 ath10k_core_free_board_files(ar);
 return ret;
}

static int ath10k_core_create_board_name(struct ath10k *ar, char *name,
      size_t name_len, bool with_variant,
      bool with_chip_id)
{
 /* strlen(',variant=') + strlen(ar->id.bdf_ext) */
 char variant[9 + ATH10K_SMBIOS_BDF_EXT_STR_LENGTH] = {};

 if (with_variant && ar->id.bdf_ext[0] != '\0')
  scnprintf(variant, sizeof(variant), ",variant=%s",
     ar->id.bdf_ext);

 if (ar->id.bmi_ids_valid) {
  scnprintf(name, name_len,
     "bus=%s,bmi-chip-id=%d,bmi-board-id=%d%s",
     ath10k_bus_str(ar->hif.bus),
     ar->id.bmi_chip_id,
     ar->id.bmi_board_id, variant);
  goto out;
 }

 if (ar->id.qmi_ids_valid) {
  if (with_chip_id)
   scnprintf(name, name_len,
      "bus=%s,qmi-board-id=%x,qmi-chip-id=%x%s",
      ath10k_bus_str(ar->hif.bus),
      ar->id.qmi_board_id, ar->id.qmi_chip_id,
      variant);
  else
   scnprintf(name, name_len,
      "bus=%s,qmi-board-id=%x",
      ath10k_bus_str(ar->hif.bus),
      ar->id.qmi_board_id);
  goto out;
 }

 scnprintf(name, name_len,
    "bus=%s,vendor=%04x,device=%04x,subsystem-vendor=%04x,subsystem-device=%04x%s",
    ath10k_bus_str(ar->hif.bus),
    ar->id.vendor, ar->id.device,
    ar->id.subsystem_vendor, ar->id.subsystem_device, variant);
out:
 ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot using board name '%s'\n", name);

 return 0;
}

static int ath10k_core_create_eboard_name(struct ath10k *ar, char *name,
       size_t name_len)
{
 if (ar->id.bmi_ids_valid) {
  scnprintf(name, name_len,
     "bus=%s,bmi-chip-id=%d,bmi-eboard-id=%d",
     ath10k_bus_str(ar->hif.bus),
     ar->id.bmi_chip_id,
     ar->id.bmi_eboard_id);

  ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot using eboard name '%s'\n", name);
  return 0;
 }
 /* Fallback if returned board id is zero */
 return -1;
}

int ath10k_core_fetch_board_file(struct ath10k *ar, int bd_ie_type)
{
 char boardname[100], fallback_boardname1[100], fallback_boardname2[100];
 int ret;

 if (bd_ie_type == ATH10K_BD_IE_BOARD) {
  /* With variant and chip id */
  ret = ath10k_core_create_board_name(ar, boardname,
          sizeof(boardname), true,
          true);
  if (ret) {
   ath10k_err(ar, "failed to create board name: %d", ret);
   return ret;
  }

  /* Without variant and only chip-id */
  ret = ath10k_core_create_board_name(ar, fallback_boardname1,
          sizeof(boardname), false,
          true);
  if (ret) {
   ath10k_err(ar, "failed to create 1st fallback board name: %d",
       ret);
   return ret;
  }

  /* Without variant and without chip-id */
  ret = ath10k_core_create_board_name(ar, fallback_boardname2,
          sizeof(boardname), false,
          false);
  if (ret) {
   ath10k_err(ar, "failed to create 2nd fallback board name: %d",
       ret);
   return ret;
  }
 } else if (bd_ie_type == ATH10K_BD_IE_BOARD_EXT) {
  ret = ath10k_core_create_eboard_name(ar, boardname,
           sizeof(boardname));
  if (ret) {
   ath10k_err(ar, "fallback to eboard.bin since board id 0");
   goto fallback;
  }
 }

 ar->bd_api = 2;
 ret = ath10k_core_fetch_board_data_api_n(ar, boardname,
       fallback_boardname1,
       fallback_boardname2,
       ATH10K_BOARD_API2_FILE);
 if (!ret)
  goto success;

fallback:
 ar->bd_api = 1;
 ret = ath10k_core_fetch_board_data_api_1(ar, bd_ie_type);
 if (ret) {
  ath10k_err(ar, "failed to fetch board-2.bin or board.bin from %s\n",
      ar->hw_params.fw.dir);
  return ret;
 }

success:
 ath10k_dbg(ar, ATH10K_DBG_BOOT, "using board api %d\n", ar->bd_api);
 return 0;
}
EXPORT_SYMBOL(ath10k_core_fetch_board_file);

static int ath10k_core_get_ext_board_id_from_otp(struct ath10k *ar)
{
 u32 result, address;
 u8 ext_board_id;
 int ret;

 address = ar->hw_params.patch_load_addr;

 if (!ar->normal_mode_fw.fw_file.otp_data ||
     !ar->normal_mode_fw.fw_file.otp_len) {
  ath10k_warn(ar,
       "failed to retrieve extended board id due to otp binary missing\n");
  return -ENODATA;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "boot upload otp to 0x%x len %zd for ext board id\n",
     address, ar->normal_mode_fw.fw_file.otp_len);

 ret = ath10k_bmi_fast_download(ar, address,
           ar->normal_mode_fw.fw_file.otp_data,
           ar->normal_mode_fw.fw_file.otp_len);
 if (ret) {
  ath10k_err(ar, "could not write otp for ext board id check: %d\n",
      ret);
  return ret;
 }

 ret = ath10k_bmi_execute(ar, address, BMI_PARAM_GET_EXT_BOARD_ID, &result);
 if (ret) {
  ath10k_err(ar, "could not execute otp for ext board id check: %d\n",
      ret);
  return ret;
 }

 if (!result) {
  ath10k_dbg(ar, ATH10K_DBG_BOOT,
      "ext board id does not exist in otp, ignore it\n");
  return -EOPNOTSUPP;
 }

 ext_board_id = result & ATH10K_BMI_EBOARD_ID_STATUS_MASK;

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "boot get otp ext board id result 0x%08x ext_board_id %d\n",
     result, ext_board_id);

 ar->id.bmi_eboard_id = ext_board_id;

 return 0;
}

static int ath10k_download_board_data(struct ath10k *ar, const void *data,
          size_t data_len)
{
 u32 board_data_size = ar->hw_params.fw.board_size;
 u32 eboard_data_size = ar->hw_params.fw.ext_board_size;
 u32 board_address;
 u32 ext_board_address;
 int ret;

 ret = ath10k_push_board_ext_data(ar, data, data_len);
 if (ret) {
  ath10k_err(ar, "could not push board ext data (%d)\n", ret);
  goto exit;
 }

 ret = ath10k_bmi_read32(ar, hi_board_data, &board_address);
 if (ret) {
  ath10k_err(ar, "could not read board data addr (%d)\n", ret);
  goto exit;
 }

 ret = ath10k_bmi_write_memory(ar, board_address, data,
          min_t(u32, board_data_size,
         data_len));
 if (ret) {
  ath10k_err(ar, "could not write board data (%d)\n", ret);
  goto exit;
 }

 ret = ath10k_bmi_write32(ar, hi_board_data_initialized, 1);
 if (ret) {
  ath10k_err(ar, "could not write board data bit (%d)\n", ret);
  goto exit;
 }

 if (!ar->id.ext_bid_supported)
  goto exit;

 /* Extended board data download */
 ret = ath10k_core_get_ext_board_id_from_otp(ar);
 if (ret == -EOPNOTSUPP) {
  /* Not fetching ext_board_data if ext board id is 0 */
  ath10k_dbg(ar, ATH10K_DBG_BOOT, "otp returned ext board id 0\n");
  return 0;
 } else if (ret) {
  ath10k_err(ar, "failed to get extended board id: %d\n", ret);
  goto exit;
 }

 ret = ath10k_core_fetch_board_file(ar, ATH10K_BD_IE_BOARD_EXT);
 if (ret)
  goto exit;

 if (ar->normal_mode_fw.ext_board_data) {
  ext_board_address = board_address + EXT_BOARD_ADDRESS_OFFSET;
  ath10k_dbg(ar, ATH10K_DBG_BOOT,
      "boot writing ext board data to addr 0x%x",
      ext_board_address);
  ret = ath10k_bmi_write_memory(ar, ext_board_address,
           ar->normal_mode_fw.ext_board_data,
           min_t(u32, eboard_data_size, data_len));
  if (ret)
   ath10k_err(ar, "failed to write ext board data: %d\n", ret);
 }

exit:
 return ret;
}

static int ath10k_download_and_run_otp(struct ath10k *ar)
{
 u32 result, address = ar->hw_params.patch_load_addr;
 u32 bmi_otp_exe_param = ar->hw_params.otp_exe_param;
 int ret;

 ret = ath10k_download_board_data(ar,
      ar->running_fw->board_data,
      ar->running_fw->board_len);
 if (ret) {
  ath10k_err(ar, "failed to download board data: %d\n", ret);
  return ret;
 }

 /* OTP is optional */

 if (!ar->running_fw->fw_file.otp_data ||
     !ar->running_fw->fw_file.otp_len) {
  ath10k_warn(ar, "Not running otp, calibration will be incorrect (otp-data %p otp_len %zd)!\n",
       ar->running_fw->fw_file.otp_data,
       ar->running_fw->fw_file.otp_len);
  return 0;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot upload otp to 0x%x len %zd\n",
     address, ar->running_fw->fw_file.otp_len);

 ret = ath10k_bmi_fast_download(ar, address,
           ar->running_fw->fw_file.otp_data,
           ar->running_fw->fw_file.otp_len);
 if (ret) {
  ath10k_err(ar, "could not write otp (%d)\n", ret);
  return ret;
 }

 /* As of now pre-cal is valid for 10_4 variants */
 if (ar->cal_mode == ATH10K_PRE_CAL_MODE_DT ||
     ar->cal_mode == ATH10K_PRE_CAL_MODE_FILE ||
     ar->cal_mode == ATH10K_PRE_CAL_MODE_NVMEM)
  bmi_otp_exe_param = BMI_PARAM_FLASH_SECTION_ALL;

 ret = ath10k_bmi_execute(ar, address, bmi_otp_exe_param, &result);
 if (ret) {
  ath10k_err(ar, "could not execute otp (%d)\n", ret);
  return ret;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot otp execute result %d\n", result);

 if (!(skip_otp || test_bit(ATH10K_FW_FEATURE_IGNORE_OTP_RESULT,
       ar->running_fw->fw_file.fw_features)) &&
     result != 0) {
  ath10k_err(ar, "otp calibration failed: %d", result);
  return -EINVAL;
 }

 return 0;
}

static int ath10k_download_cal_file(struct ath10k *ar,
        const struct firmware *file)
{
 int ret;

 if (!file)
  return -ENOENT;

 if (IS_ERR(file))
  return PTR_ERR(file);

 ret = ath10k_download_board_data(ar, file->data, file->size);
 if (ret) {
  ath10k_err(ar, "failed to download cal_file data: %d\n", ret);
  return ret;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot cal file downloaded\n");

 return 0;
}

static int ath10k_download_cal_dt(struct ath10k *ar, const char *dt_name)
{
 struct device_node *node;
 int data_len;
 void *data;
 int ret;

 node = ar->dev->of_node;
 if (!node)
  /* Device Tree is optional, don't print any warnings if
   * there's no node for ath10k.
 */
  return -ENOENT;

 if (!of_get_property(node, dt_name, &data_len)) {
  /* The calibration data node is optional */
  return -ENOENT;
 }

 if (data_len != ar->hw_params.cal_data_len) {
  ath10k_warn(ar, "invalid calibration data length in DT: %d\n",
       data_len);
  ret = -EMSGSIZE;
  goto out;
 }

 data = kmalloc(data_len, GFP_KERNEL);
 if (!data) {
  ret = -ENOMEM;
  goto out;
 }

 ret = of_property_read_u8_array(node, dt_name, data, data_len);
 if (ret) {
  ath10k_warn(ar, "failed to read calibration data from DT: %d\n",
       ret);
  goto out_free;
 }

 ret = ath10k_download_board_data(ar, data, data_len);
 if (ret) {
  ath10k_warn(ar, "failed to download calibration data from Device Tree: %d\n",
       ret);
  goto out_free;
 }

 ret = 0;

out_free:
 kfree(data);

out:
 return ret;
}

static int ath10k_download_cal_eeprom(struct ath10k *ar)
{
 size_t data_len;
 void *data = NULL;
 int ret;

 ret = ath10k_hif_fetch_cal_eeprom(ar, &data, &data_len);
 if (ret) {
  if (ret != -EOPNOTSUPP)
   ath10k_warn(ar, "failed to read calibration data from EEPROM: %d\n",
        ret);
  goto out_free;
 }

 ret = ath10k_download_board_data(ar, data, data_len);
 if (ret) {
  ath10k_warn(ar, "failed to download calibration data from EEPROM: %d\n",
       ret);
  goto out_free;
 }

 ret = 0;

out_free:
 kfree(data);

 return ret;
}

static int ath10k_download_cal_nvmem(struct ath10k *ar, const char *cell_name)
{
 struct nvmem_cell *cell;
 void *buf;
 size_t len;
 int ret;

 cell = devm_nvmem_cell_get(ar->dev, cell_name);
 if (IS_ERR(cell)) {
  ret = PTR_ERR(cell);
  return ret;
 }

 buf = nvmem_cell_read(cell, &len);
 if (IS_ERR(buf))
  return PTR_ERR(buf);

 if (ar->hw_params.cal_data_len != len) {
  kfree(buf);
  ath10k_warn(ar, "invalid calibration data length in nvmem-cell '%s': %zu != %u\n",
       cell_name, len, ar->hw_params.cal_data_len);
  return -EMSGSIZE;
 }

 ret = ath10k_download_board_data(ar, buf, len);
 kfree(buf);
 if (ret)
  ath10k_warn(ar, "failed to download calibration data from nvmem-cell '%s': %d\n",
       cell_name, ret);

 return ret;
}

int ath10k_core_fetch_firmware_api_n(struct ath10k *ar, const char *name,
         struct ath10k_fw_file *fw_file)
{
 size_t magic_len, len, ie_len;
 int ie_id, i, index, bit, ret;
 struct ath10k_fw_ie *hdr;
 const u8 *data;
 __le32 *timestamp, *version;

 /* first fetch the firmware file (firmware-*.bin) */
 fw_file->firmware = ath10k_fetch_fw_file(ar, ar->hw_params.fw.dir,
       name);
 if (IS_ERR(fw_file->firmware))
  return PTR_ERR(fw_file->firmware);

 data = fw_file->firmware->data;
 len = fw_file->firmware->size;

 /* magic also includes the null byte, check that as well */
 magic_len = strlen(ATH10K_FIRMWARE_MAGIC) + 1;

 if (len < magic_len) {
  ath10k_err(ar, "firmware file '%s/%s' too small to contain magic: %zu\n",
      ar->hw_params.fw.dir, name, len);
  ret = -EINVAL;
  goto err;
 }

 if (memcmp(data, ATH10K_FIRMWARE_MAGIC, magic_len) != 0) {
  ath10k_err(ar, "invalid firmware magic\n");
  ret = -EINVAL;
  goto err;
 }

 /* jump over the padding */
 magic_len = ALIGN(magic_len, 4);

 len -= magic_len;
 data += magic_len;

 /* loop elements */
 while (len > sizeof(struct ath10k_fw_ie)) {
  hdr = (struct ath10k_fw_ie *)data;

  ie_id = le32_to_cpu(hdr->id);
  ie_len = le32_to_cpu(hdr->len);

  len -= sizeof(*hdr);
  data += sizeof(*hdr);

  if (len < ie_len) {
   ath10k_err(ar, "invalid length for FW IE %d (%zu < %zu)\n",
       ie_id, len, ie_len);
   ret = -EINVAL;
   goto err;
  }

  switch (ie_id) {
  case ATH10K_FW_IE_FW_VERSION:
   if (ie_len > sizeof(fw_file->fw_version) - 1)
    break;

   memcpy(fw_file->fw_version, data, ie_len);
   fw_file->fw_version[ie_len] = '\0';

   ath10k_dbg(ar, ATH10K_DBG_BOOT,
       "found fw version %s\n",
        fw_file->fw_version);
   break;
  case ATH10K_FW_IE_TIMESTAMP:
   if (ie_len != sizeof(u32))
    break;

   timestamp = (__le32 *)data;

   ath10k_dbg(ar, ATH10K_DBG_BOOT, "found fw timestamp %d\n",
       le32_to_cpup(timestamp));
   break;
  case ATH10K_FW_IE_FEATURES:
   ath10k_dbg(ar, ATH10K_DBG_BOOT,
       "found firmware features ie (%zd B)\n",
       ie_len);

   for (i = 0; i < ATH10K_FW_FEATURE_COUNT; i++) {
    index = i / 8;
    bit = i % 8;

    if (index == ie_len)
     break;

    if (data[index] & (1 << bit)) {
     ath10k_dbg(ar, ATH10K_DBG_BOOT,
         "Enabling feature bit: %i\n",
         i);
     __set_bit(i, fw_file->fw_features);
    }
   }

   ath10k_dbg_dump(ar, ATH10K_DBG_BOOT, "features", "",
     fw_file->fw_features,
     sizeof(fw_file->fw_features));
   break;
  case ATH10K_FW_IE_FW_IMAGE:
   ath10k_dbg(ar, ATH10K_DBG_BOOT,
       "found fw image ie (%zd B)\n",
       ie_len);

   fw_file->firmware_data = data;
   fw_file->firmware_len = ie_len;

   break;
  case ATH10K_FW_IE_OTP_IMAGE:
   ath10k_dbg(ar, ATH10K_DBG_BOOT,
       "found otp image ie (%zd B)\n",
       ie_len);

   fw_file->otp_data = data;
   fw_file->otp_len = ie_len;

   break;
  case ATH10K_FW_IE_WMI_OP_VERSION:
   if (ie_len != sizeof(u32))
    break;

   version = (__le32 *)data;

   fw_file->wmi_op_version = le32_to_cpup(version);

   ath10k_dbg(ar, ATH10K_DBG_BOOT, "found fw ie wmi op version %d\n",
       fw_file->wmi_op_version);
   break;
  case ATH10K_FW_IE_HTT_OP_VERSION:
   if (ie_len != sizeof(u32))
    break;

   version = (__le32 *)data;

   fw_file->htt_op_version = le32_to_cpup(version);

   ath10k_dbg(ar, ATH10K_DBG_BOOT, "found fw ie htt op version %d\n",
       fw_file->htt_op_version);
   break;
  case ATH10K_FW_IE_FW_CODE_SWAP_IMAGE:
   ath10k_dbg(ar, ATH10K_DBG_BOOT,
       "found fw code swap image ie (%zd B)\n",
       ie_len);
   fw_file->codeswap_data = data;
   fw_file->codeswap_len = ie_len;
   break;
  default:
   ath10k_warn(ar, "Unknown FW IE: %u\n",
        le32_to_cpu(hdr->id));
   break;
  }

  /* jump over the padding */
  ie_len = ALIGN(ie_len, 4);

  len -= ie_len;
  data += ie_len;
 }

 if (!test_bit(ATH10K_FW_FEATURE_NON_BMI, fw_file->fw_features) &&
     (!fw_file->firmware_data || !fw_file->firmware_len)) {
  ath10k_warn(ar, "No ATH10K_FW_IE_FW_IMAGE found from '%s/%s', skipping\n",
       ar->hw_params.fw.dir, name);
  ret = -ENOMEDIUM;
  goto err;
 }

 return 0;

err:
 ath10k_core_free_firmware_files(ar);
 return ret;
}

static void ath10k_core_get_fw_name(struct ath10k *ar, char *fw_name,
        size_t fw_name_len, int fw_api)
{
 switch (ar->hif.bus) {
 case ATH10K_BUS_SDIO:
 case ATH10K_BUS_USB:
  scnprintf(fw_name, fw_name_len, "%s-%s-%d.bin",
     ATH10K_FW_FILE_BASE, ath10k_bus_str(ar->hif.bus),
     fw_api);
  break;
 case ATH10K_BUS_PCI:
 case ATH10K_BUS_AHB:
 case ATH10K_BUS_SNOC:
  scnprintf(fw_name, fw_name_len, "%s-%d.bin",
     ATH10K_FW_FILE_BASE, fw_api);
  break;
 }
}

static int ath10k_core_fetch_firmware_files(struct ath10k *ar)
{
 int ret, i;
 char fw_name[100];

 /* calibration file is optional, don't check for any errors */
 ath10k_fetch_cal_file(ar);

 for (i = ATH10K_FW_API_MAX; i >= ATH10K_FW_API_MIN; i--) {
  ar->fw_api = i;
  ath10k_dbg(ar, ATH10K_DBG_BOOT, "trying fw api %d\n",
      ar->fw_api);

  ath10k_core_get_fw_name(ar, fw_name, sizeof(fw_name), ar->fw_api);
  ret = ath10k_core_fetch_firmware_api_n(ar, fw_name,
             &ar->normal_mode_fw.fw_file);
  if (!ret)
   goto success;
 }

 /* we end up here if we couldn't fetch any firmware */

 ath10k_err(ar, "Failed to find firmware-N.bin (N between %d and %d) from %s: %d",
     ATH10K_FW_API_MIN, ATH10K_FW_API_MAX, ar->hw_params.fw.dir,
     ret);

 return ret;

success:
 ath10k_dbg(ar, ATH10K_DBG_BOOT, "using fw api %d\n", ar->fw_api);

 return 0;
}

static int ath10k_core_pre_cal_download(struct ath10k *ar)
{
 int ret;

 ret = ath10k_download_cal_nvmem(ar, "pre-calibration");
 if (ret == 0) {
  ar->cal_mode = ATH10K_PRE_CAL_MODE_NVMEM;
  goto success;
 } else if (ret == -EPROBE_DEFER) {
  return ret;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "boot did not find a pre-calibration nvmem-cell, try file next: %d\n",
     ret);

 ret = ath10k_download_cal_file(ar, ar->pre_cal_file);
 if (ret == 0) {
  ar->cal_mode = ATH10K_PRE_CAL_MODE_FILE;
  goto success;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "boot did not find a pre calibration file, try DT next: %d\n",
     ret);

 ret = ath10k_download_cal_dt(ar, "qcom,pre-calibration-data");
 if (ret == -ENOENT)
  ret = ath10k_download_cal_dt(ar, "qcom,ath10k-pre-calibration-data");
 if (ret) {
  ath10k_dbg(ar, ATH10K_DBG_BOOT,
      "unable to load pre cal data from DT: %d\n", ret);
  return ret;
 }
 ar->cal_mode = ATH10K_PRE_CAL_MODE_DT;

success:
 ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot using calibration mode %s\n",
     ath10k_cal_mode_str(ar->cal_mode));

 return 0;
}

static int ath10k_core_pre_cal_config(struct ath10k *ar)
{
 int ret;

 ret = ath10k_core_pre_cal_download(ar);
 if (ret) {
  ath10k_dbg(ar, ATH10K_DBG_BOOT,
      "failed to load pre cal data: %d\n", ret);
  return ret;
 }

 ret = ath10k_core_get_board_id_from_otp(ar);
 if (ret) {
  ath10k_err(ar, "failed to get board id: %d\n", ret);
  return ret;
 }

 ret = ath10k_download_and_run_otp(ar);
 if (ret) {
  ath10k_err(ar, "failed to run otp: %d\n", ret);
  return ret;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "pre cal configuration done successfully\n");

 return 0;
}

static int ath10k_download_cal_data(struct ath10k *ar)
{
 int ret;

 ret = ath10k_core_pre_cal_config(ar);
 if (ret == 0)
  return 0;

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "pre cal download procedure failed, try cal file: %d\n",
     ret);

 ret = ath10k_download_cal_nvmem(ar, "calibration");
 if (ret == 0) {
  ar->cal_mode = ATH10K_CAL_MODE_NVMEM;
  goto done;
 } else if (ret == -EPROBE_DEFER) {
  return ret;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "boot did not find a calibration nvmem-cell, try file next: %d\n",
     ret);

 ret = ath10k_download_cal_file(ar, ar->cal_file);
 if (ret == 0) {
  ar->cal_mode = ATH10K_CAL_MODE_FILE;
  goto done;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "boot did not find a calibration file, try DT next: %d\n",
     ret);

 ret = ath10k_download_cal_dt(ar, "qcom,calibration-data");
 if (ret == -ENOENT)
  ret = ath10k_download_cal_dt(ar, "qcom,ath10k-calibration-data");
 if (ret == 0) {
  ar->cal_mode = ATH10K_CAL_MODE_DT;
  goto done;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "boot did not find DT entry, try target EEPROM next: %d\n",
     ret);

 ret = ath10k_download_cal_eeprom(ar);
 if (ret == 0) {
  ar->cal_mode = ATH10K_CAL_MODE_EEPROM;
  goto done;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT,
     "boot did not find target EEPROM entry, try OTP next: %d\n",
     ret);

 ret = ath10k_download_and_run_otp(ar);
 if (ret) {
  ath10k_err(ar, "failed to run otp: %d\n", ret);
  return ret;
 }

 ar->cal_mode = ATH10K_CAL_MODE_OTP;

done:
 ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot using calibration mode %s\n",
     ath10k_cal_mode_str(ar->cal_mode));
 return 0;
}

static void ath10k_core_fetch_btcoex_dt(struct ath10k *ar)
{
 struct device_node *node;
 u8 coex_support = 0;
 int ret;

 node = ar->dev->of_node;
 if (!node)
  goto out;

 ret = of_property_read_u8(node, "qcom,coexist-support", &coex_support);
 if (ret) {
  ar->coex_support = true;
  goto out;
 }

 if (coex_support) {
  ar->coex_support = true;
 } else {
  ar->coex_support = false;
  ar->coex_gpio_pin = -1;
  goto out;
 }

 ret = of_property_read_u32(node, "qcom,coexist-gpio-pin",
       &ar->coex_gpio_pin);
 if (ret)
  ar->coex_gpio_pin = -1;

out:
 ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot coex_support %d coex_gpio_pin %d\n",
     ar->coex_support, ar->coex_gpio_pin);
}

static int ath10k_init_uart(struct ath10k *ar)
{
 int ret;

 /*
  * Explicitly setting UART prints to zero as target turns it on
  * based on scratch registers.
 */
 ret = ath10k_bmi_write32(ar, hi_serial_enable, 0);
 if (ret) {
  ath10k_warn(ar, "could not disable UART prints (%d)\n", ret);
  return ret;
 }

 if (!uart_print) {
  if (ar->hw_params.uart_pin_workaround) {
   ret = ath10k_bmi_write32(ar, hi_dbg_uart_txpin,
       ar->hw_params.uart_pin);
   if (ret) {
    ath10k_warn(ar, "failed to set UART TX pin: %d",
         ret);
    return ret;
   }
  }

  return 0;
 }

 ret = ath10k_bmi_write32(ar, hi_dbg_uart_txpin, ar->hw_params.uart_pin);
 if (ret) {
  ath10k_warn(ar, "could not enable UART prints (%d)\n", ret);
  return ret;
 }

 ret = ath10k_bmi_write32(ar, hi_serial_enable, 1);
 if (ret) {
  ath10k_warn(ar, "could not enable UART prints (%d)\n", ret);
  return ret;
 }

 /* Set the UART baud rate to 19200. */
 ret = ath10k_bmi_write32(ar, hi_desired_baud_rate, 19200);
 if (ret) {
  ath10k_warn(ar, "could not set the baud rate (%d)\n", ret);
  return ret;
 }

 ath10k_info(ar, "UART prints enabled\n");
 return 0;
}

static int ath10k_init_hw_params(struct ath10k *ar)
{
 const struct ath10k_hw_params *hw_params;
 int i;

 for (i = 0; i < ARRAY_SIZE(ath10k_hw_params_list); i++) {
  hw_params = &ath10k_hw_params_list[i];

  if (hw_params->bus == ar->hif.bus &&
      hw_params->id == ar->target_version &&
      hw_params->dev_id == ar->dev_id)
   break;
 }

 if (i == ARRAY_SIZE(ath10k_hw_params_list)) {
  ath10k_err(ar, "Unsupported hardware version: 0x%x\n",
      ar->target_version);
  return -EINVAL;
 }

 ar->hw_params = *hw_params;

 ath10k_dbg(ar, ATH10K_DBG_BOOT, "Hardware name %s version 0x%x\n",
     ar->hw_params.name, ar->target_version);

 return 0;
}

static bool ath10k_core_needs_recovery(struct ath10k *ar)
{
 long time_left;

 /* Sometimes the recovery will fail and then the next all recovery fail,
  * so avoid infinite recovery.
 */
 if (atomic_read(&ar->fail_cont_count) >= ATH10K_RECOVERY_MAX_FAIL_COUNT) {
  ath10k_err(ar, "consecutive fail %d times, will shutdown driver!",
      atomic_read(&ar->fail_cont_count));
  ar->state = ATH10K_STATE_WEDGED;
  return false;
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT, "total recovery count: %d", ++ar->recovery_count);

 if (atomic_read(&ar->pending_recovery)) {
  /* Sometimes it happened another recovery work before the previous one
   * completed, then the second recovery work will destroy the previous
   * one, thus below is to avoid that.
 */
  time_left = wait_for_completion_timeout(&ar->driver_recovery,
       ATH10K_RECOVERY_TIMEOUT_HZ);
  if (time_left) {
   ath10k_warn(ar, "previous recovery succeeded, skip this!\n");
   return false;
  }

  /* Record the continuous recovery fail count when recovery failed. */
  atomic_inc(&ar->fail_cont_count);

  /* Avoid having multiple recoveries at the same time. */
  return false;
 }

 atomic_inc(&ar->pending_recovery);

 return true;
}

void ath10k_core_start_recovery(struct ath10k *ar)
{
 if (!ath10k_core_needs_recovery(ar))
  return;

 queue_work(ar->workqueue, &ar->restart_work);
}
EXPORT_SYMBOL(ath10k_core_start_recovery);

void ath10k_core_napi_enable(struct ath10k *ar)
{
 lockdep_assert_held(&ar->conf_mutex);

 if (test_bit(ATH10K_FLAG_NAPI_ENABLED, &ar->dev_flags))
  return;

 napi_enable(&ar->napi);
 set_bit(ATH10K_FLAG_NAPI_ENABLED, &ar->dev_flags);
}
EXPORT_SYMBOL(ath10k_core_napi_enable);

void ath10k_core_napi_sync_disable(struct ath10k *ar)
{
 lockdep_assert_held(&ar->conf_mutex);

 if (!test_bit(ATH10K_FLAG_NAPI_ENABLED, &ar->dev_flags))
  return;

 napi_synchronize(&ar->napi);
 napi_disable(&ar->napi);
 clear_bit(ATH10K_FLAG_NAPI_ENABLED, &ar->dev_flags);
}
EXPORT_SYMBOL(ath10k_core_napi_sync_disable);

static void ath10k_core_restart(struct work_struct *work)
{
 struct ath10k *ar = container_of(work, struct ath10k, restart_work);
 int ret;

 reinit_completion(&ar->driver_recovery);

 set_bit(ATH10K_FLAG_CRASH_FLUSH, &ar->dev_flags);

 /* Place a barrier to make sure the compiler doesn't reorder
  * CRASH_FLUSH and calling other functions.
 */
 barrier();

 ieee80211_stop_queues(ar->hw);
 ath10k_drain_tx(ar);
 complete(&ar->scan.started);
 complete(&ar->scan.completed);
 complete(&ar->scan.on_channel);
 complete(&ar->offchan_tx_completed);
 complete(&ar->install_key_done);
 complete(&ar->vdev_setup_done);
 complete(&ar->vdev_delete_done);
 complete(&ar->thermal.wmi_sync);
 complete(&ar->bss_survey_done);
 wake_up(&ar->htt.empty_tx_wq);
 wake_up(&ar->wmi.tx_credits_wq);
 wake_up(&ar->peer_mapping_wq);

 /* TODO: We can have one instance of cancelling coverage_class_work by
  * moving it to ath10k_halt(), so that both stop() and restart() would
  * call that but it takes conf_mutex() and if we call cancel_work_sync()
  * with conf_mutex it will deadlock.
 */
 cancel_work_sync(&ar->set_coverage_class_work);

 mutex_lock(&ar->conf_mutex);

 switch (ar->state) {
 case ATH10K_STATE_ON:
  ar->state = ATH10K_STATE_RESTARTING;
  ath10k_halt(ar);
  ath10k_scan_finish(ar);
  ieee80211_restart_hw(ar->hw);
  break;
 case ATH10K_STATE_OFF:
  /* this can happen if driver is being unloaded
   * or if the crash happens during FW probing
 */
  ath10k_warn(ar, "cannot restart a device that hasn't been started\n");
  break;
 case ATH10K_STATE_RESTARTING:
  /* hw restart might be requested from multiple places */
  break;
 case ATH10K_STATE_RESTARTED:
  ar->state = ATH10K_STATE_WEDGED;
  fallthrough;
 case ATH10K_STATE_WEDGED:
  ath10k_warn(ar, "device is wedged, will not restart\n");
  break;
 case ATH10K_STATE_UTF:
  ath10k_warn(ar, "firmware restart in UTF mode not supported\n");
  break;
 }

 mutex_unlock(&ar->conf_mutex);

 ret = ath10k_coredump_submit(ar);
 if (ret)
  ath10k_warn(ar, "failed to send firmware crash dump via devcoredump: %d",
       ret);
}

static void ath10k_core_set_coverage_class_work(struct work_struct *work)
{
 struct ath10k *ar = container_of(work, struct ath10k,
      set_coverage_class_work);

 if (ar->hw_params.hw_ops->set_coverage_class)
  ar->hw_params.hw_ops->set_coverage_class(ar, -1, -1);
}

static int ath10k_core_init_firmware_features(struct ath10k *ar)
{
 struct ath10k_fw_file *fw_file = &ar->normal_mode_fw.fw_file;
 int max_num_peers;

 if (test_bit(ATH10K_FW_FEATURE_WMI_10_2, fw_file->fw_features) &&
     !test_bit(ATH10K_FW_FEATURE_WMI_10X, fw_file->fw_features)) {
  ath10k_err(ar, "feature bits corrupted: 10.2 feature requires 10.x feature to be set as well");
  return -EINVAL;
 }

 if (fw_file->wmi_op_version >= ATH10K_FW_WMI_OP_VERSION_MAX) {
  ath10k_err(ar, "unsupported WMI OP version (max %d): %d\n",
      ATH10K_FW_WMI_OP_VERSION_MAX, fw_file->wmi_op_version);
  return -EINVAL;
 }

 ar->wmi.rx_decap_mode = ATH10K_HW_TXRX_NATIVE_WIFI;
 switch (ath10k_cryptmode_param) {
 case ATH10K_CRYPT_MODE_HW:
  clear_bit(ATH10K_FLAG_RAW_MODE, &ar->dev_flags);
  clear_bit(ATH10K_FLAG_HW_CRYPTO_DISABLED, &ar->dev_flags);
  break;
 case ATH10K_CRYPT_MODE_SW:
  if (!test_bit(ATH10K_FW_FEATURE_RAW_MODE_SUPPORT,
         fw_file->fw_features)) {
   ath10k_err(ar, "cryptmode > 0 requires raw mode support from firmware");
   return -EINVAL;
  }

  set_bit(ATH10K_FLAG_RAW_MODE, &ar->dev_flags);
  set_bit(ATH10K_FLAG_HW_CRYPTO_DISABLED, &ar->dev_flags);
  break;
 default:
  ath10k_info(ar, "invalid cryptmode: %d\n",
       ath10k_cryptmode_param);
  return -EINVAL;
 }

 ar->htt.max_num_amsdu = ATH10K_HTT_MAX_NUM_AMSDU_DEFAULT;
 ar->htt.max_num_ampdu = ATH10K_HTT_MAX_NUM_AMPDU_DEFAULT;

 if (ath10k_frame_mode == ATH10K_HW_TXRX_RAW) {
  if (!test_bit(ATH10K_FW_FEATURE_RAW_MODE_SUPPORT,
         fw_file->fw_features)) {
   ath10k_err(ar, "rawmode = 1 requires support from firmware");
   return -EINVAL;
  }
  set_bit(ATH10K_FLAG_RAW_MODE, &ar->dev_flags);
 }

 if (test_bit(ATH10K_FLAG_RAW_MODE, &ar->dev_flags)) {
  ar->wmi.rx_decap_mode = ATH10K_HW_TXRX_RAW;

  /* Workaround:
   *
   * Firmware A-MSDU aggregation breaks with RAW Tx encap mode
   * and causes enormous performance issues (malformed frames,
   * etc).
   *
   * Disabling A-MSDU makes RAW mode stable with heavy traffic
   * albeit a bit slower compared to regular operation.
 */
  ar->htt.max_num_amsdu = 1;
 }

 /* Backwards compatibility for firmwares without
  * ATH10K_FW_IE_WMI_OP_VERSION.
 */
 if (fw_file->wmi_op_version == ATH10K_FW_WMI_OP_VERSION_UNSET) {
  if (test_bit(ATH10K_FW_FEATURE_WMI_10X, fw_file->fw_features)) {
   if (test_bit(ATH10K_FW_FEATURE_WMI_10_2,
         fw_file->fw_features))
    fw_file->wmi_op_version = ATH10K_FW_WMI_OP_VERSION_10_2;
   else
    fw_file->wmi_op_version = ATH10K_FW_WMI_OP_VERSION_10_1;
  } else {
   fw_file->wmi_op_version = ATH10K_FW_WMI_OP_VERSION_MAIN;
  }
 }

 switch (fw_file->wmi_op_version) {
 case ATH10K_FW_WMI_OP_VERSION_MAIN:
  max_num_peers = TARGET_NUM_PEERS;
  ar->max_num_stations = TARGET_NUM_STATIONS;
  ar->max_num_vdevs = TARGET_NUM_VDEVS;
  ar->htt.max_num_pending_tx = TARGET_NUM_MSDU_DESC;
  ar->fw_stats_req_mask = WMI_STAT_PDEV | WMI_STAT_VDEV |
   WMI_STAT_PEER;
  ar->max_spatial_stream = WMI_MAX_SPATIAL_STREAM;
  break;
 case ATH10K_FW_WMI_OP_VERSION_10_1:
 case ATH10K_FW_WMI_OP_VERSION_10_2:
 case ATH10K_FW_WMI_OP_VERSION_10_2_4:
  if (ath10k_peer_stats_enabled(ar)) {
   max_num_peers = TARGET_10X_TX_STATS_NUM_PEERS;
   ar->max_num_stations = TARGET_10X_TX_STATS_NUM_STATIONS;
  } else {
   max_num_peers = TARGET_10X_NUM_PEERS;
   ar->max_num_stations = TARGET_10X_NUM_STATIONS;
  }
  ar->max_num_vdevs = TARGET_10X_NUM_VDEVS;
  ar->htt.max_num_pending_tx = TARGET_10X_NUM_MSDU_DESC;
  ar->fw_stats_req_mask = WMI_STAT_PEER;
  ar->max_spatial_stream = WMI_MAX_SPATIAL_STREAM;
  break;
 case ATH10K_FW_WMI_OP_VERSION_TLV:
  max_num_peers = TARGET_TLV_NUM_PEERS;
  ar->max_num_stations = TARGET_TLV_NUM_STATIONS;
  ar->max_num_vdevs = TARGET_TLV_NUM_VDEVS;
  ar->max_num_tdls_vdevs = TARGET_TLV_NUM_TDLS_VDEVS;
  if (ar->hif.bus == ATH10K_BUS_SDIO)
   ar->htt.max_num_pending_tx =
    TARGET_TLV_NUM_MSDU_DESC_HL;
  else
   ar->htt.max_num_pending_tx = TARGET_TLV_NUM_MSDU_DESC;
  ar->wow.max_num_patterns = TARGET_TLV_NUM_WOW_PATTERNS;
  ar->fw_stats_req_mask = WMI_TLV_STAT_PDEV | WMI_TLV_STAT_VDEV |
   WMI_TLV_STAT_PEER | WMI_TLV_STAT_PEER_EXTD;
  ar->max_spatial_stream = WMI_MAX_SPATIAL_STREAM;
  ar->wmi.mgmt_max_num_pending_tx = TARGET_TLV_MGMT_NUM_MSDU_DESC;
  break;
 case ATH10K_FW_WMI_OP_VERSION_10_4:
  max_num_peers = TARGET_10_4_NUM_PEERS;
  ar->max_num_stations = TARGET_10_4_NUM_STATIONS;
  ar->num_active_peers = TARGET_10_4_ACTIVE_PEERS;
  ar->max_num_vdevs = TARGET_10_4_NUM_VDEVS;
  ar->num_tids = TARGET_10_4_TGT_NUM_TIDS;
  ar->fw_stats_req_mask = WMI_10_4_STAT_PEER |
     WMI_10_4_STAT_PEER_EXTD |
     WMI_10_4_STAT_VDEV_EXTD;
  ar->max_spatial_stream = ar->hw_params.max_spatial_stream;
  ar->max_num_tdls_vdevs = TARGET_10_4_NUM_TDLS_VDEVS;

  if (test_bit(ATH10K_FW_FEATURE_PEER_FLOW_CONTROL,
        fw_file->fw_features))
   ar->htt.max_num_pending_tx = TARGET_10_4_NUM_MSDU_DESC_PFC;
  else
   ar->htt.max_num_pending_tx = TARGET_10_4_NUM_MSDU_DESC;
  break;
 case ATH10K_FW_WMI_OP_VERSION_UNSET:
 case ATH10K_FW_WMI_OP_VERSION_MAX:
 default:
  WARN_ON(1);
  return -EINVAL;
 }

 if (ar->hw_params.num_peers)
  ar->max_num_peers = ar->hw_params.num_peers;
 else
  ar->max_num_peers = max_num_peers;

 /* Backwards compatibility for firmwares without
  * ATH10K_FW_IE_HTT_OP_VERSION.
 */
 if (fw_file->htt_op_version == ATH10K_FW_HTT_OP_VERSION_UNSET) {
  switch (fw_file->wmi_op_version) {
  case ATH10K_FW_WMI_OP_VERSION_MAIN:
   fw_file->htt_op_version = ATH10K_FW_HTT_OP_VERSION_MAIN;
   break;
  case ATH10K_FW_WMI_OP_VERSION_10_1:
  case ATH10K_FW_WMI_OP_VERSION_10_2:
  case ATH10K_FW_WMI_OP_VERSION_10_2_4:
   fw_file->htt_op_version = ATH10K_FW_HTT_OP_VERSION_10_1;
   break;
  case ATH10K_FW_WMI_OP_VERSION_TLV:
   fw_file->htt_op_version = ATH10K_FW_HTT_OP_VERSION_TLV;
   break;
  case ATH10K_FW_WMI_OP_VERSION_10_4:
  case ATH10K_FW_WMI_OP_VERSION_UNSET:
  case ATH10K_FW_WMI_OP_VERSION_MAX:
   ath10k_err(ar, "htt op version not found from fw meta data");
   return -EINVAL;
  }
 }

 return 0;
}

static int ath10k_core_reset_rx_filter(struct ath10k *ar)
{
 int ret;
 int vdev_id;
 int vdev_type;
 int vdev_subtype;
 const u8 *vdev_addr;

 vdev_id = 0;
 vdev_type = WMI_VDEV_TYPE_STA;
 vdev_subtype = ath10k_wmi_get_vdev_subtype(ar, WMI_VDEV_SUBTYPE_NONE);
 vdev_addr = ar->mac_addr;

 ret = ath10k_wmi_vdev_create(ar, vdev_id, vdev_type, vdev_subtype,
         vdev_addr);
 if (ret) {
  ath10k_err(ar, "failed to create dummy vdev: %d\n", ret);
  return ret;
 }

 ret = ath10k_wmi_vdev_delete(ar, vdev_id);
 if (ret) {
  ath10k_err(ar, "failed to delete dummy vdev: %d\n", ret);
  return ret;
 }

 /* WMI and HTT may use separate HIF pipes and are not guaranteed to be
  * serialized properly implicitly.
  *
  * Moreover (most) WMI commands have no explicit acknowledges. It is
  * possible to infer it implicitly by poking firmware with echo
  * command - getting a reply means all preceding comments have been
  * (mostly) processed.
  *
  * In case of vdev create/delete this is sufficient.
  *
  * Without this it's possible to end up with a race when HTT Rx ring is
  * started before vdev create/delete hack is complete allowing a short
  * window of opportunity to receive (and Tx ACK) a bunch of frames.
 */
 ret = ath10k_wmi_barrier(ar);
 if (ret) {
  ath10k_err(ar, "failed to ping firmware: %d\n", ret);
  return ret;
 }

 return 0;
}

static int ath10k_core_compat_services(struct ath10k *ar)
{
 struct ath10k_fw_file *fw_file = &ar->normal_mode_fw.fw_file;

 /* all 10.x firmware versions support thermal throttling but don't
  * advertise the support via service flags so we have to hardcode
  * it here
 */
 switch (fw_file->wmi_op_version) {
 case ATH10K_FW_WMI_OP_VERSION_10_1:
 case ATH10K_FW_WMI_OP_VERSION_10_2:
 case ATH10K_FW_WMI_OP_VERSION_10_2_4:
 case ATH10K_FW_WMI_OP_VERSION_10_4:
  set_bit(WMI_SERVICE_THERM_THROT, ar->wmi.svc_map);
  break;
 default:
  break;
 }

 return 0;
}

#define TGT_IRAM_READ_PER_ITR (8 * 1024)

static int ath10k_core_copy_target_iram(struct ath10k *ar)
{
 const struct ath10k_hw_mem_layout *hw_mem;
 const struct ath10k_mem_region *tmp, *mem_region = NULL;
 dma_addr_t paddr;
 void *vaddr = NULL;
 u8 num_read_itr;
 int i, ret;
 u32 len, remaining_len;

 /* copy target iram feature must work also when
  * ATH10K_FW_CRASH_DUMP_RAM_DATA is disabled, so
  * _ath10k_coredump_get_mem_layout() to accomplist that
 */
 hw_mem = _ath10k_coredump_get_mem_layout(ar);
 if (!hw_mem)
  /* if CONFIG_DEV_COREDUMP is disabled we get NULL, then
   * just silently disable the feature by doing nothing
 */
  return 0;

 for (i = 0; i < hw_mem->region_table.size; i++) {
  tmp = &hw_mem->region_table.regions[i];
  if (tmp->type == ATH10K_MEM_REGION_TYPE_REG) {
   mem_region = tmp;
   break;
  }
 }

 if (!mem_region)
  return -ENOMEM;

 for (i = 0; i < ar->wmi.num_mem_chunks; i++) {
  if (ar->wmi.mem_chunks[i].req_id ==
      WMI_IRAM_RECOVERY_HOST_MEM_REQ_ID) {
   vaddr = ar->wmi.mem_chunks[i].vaddr;
   len = ar->wmi.mem_chunks[i].len;
   break;
  }
 }

 if (!vaddr || !len) {
  ath10k_warn(ar, "No allocated memory for IRAM back up");
  return -ENOMEM;
 }

 len = (len < mem_region->len) ? len : mem_region->len;
 paddr = mem_region->start;
 num_read_itr = len / TGT_IRAM_READ_PER_ITR;
 remaining_len = len % TGT_IRAM_READ_PER_ITR;
 for (i = 0; i < num_read_itr; i++) {
  ret = ath10k_hif_diag_read(ar, paddr, vaddr,
        TGT_IRAM_READ_PER_ITR);
  if (ret) {
   ath10k_warn(ar, "failed to copy firmware IRAM contents: %d",
        ret);
   return ret;
  }

  paddr += TGT_IRAM_READ_PER_ITR;
  vaddr += TGT_IRAM_READ_PER_ITR;
 }

 if (remaining_len) {
  ret = ath10k_hif_diag_read(ar, paddr, vaddr, remaining_len);
  if (ret) {
   ath10k_warn(ar, "failed to copy firmware IRAM contents: %d",
        ret);
   return ret;
  }
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT, "target IRAM back up completed\n");

 return 0;
}

int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode,
        const struct ath10k_fw_components *fw)
{
 int status;
 u32 val;

 lockdep_assert_held(&ar->conf_mutex);

 clear_bit(ATH10K_FLAG_CRASH_FLUSH, &ar->dev_flags);

 ar->running_fw = fw;

 if (!test_bit(ATH10K_FW_FEATURE_NON_BMI,
        ar->running_fw->fw_file.fw_features)) {
  ath10k_bmi_start(ar);

  /* Enable hardware clock to speed up firmware download */
  if (ar->hw_params.hw_ops->enable_pll_clk) {
   status = ar->hw_params.hw_ops->enable_pll_clk(ar);
   ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot enable pll ret %d\n",
       status);
  }

  if (ath10k_init_configure_target(ar)) {
   status = -EINVAL;
   goto err;
  }

  status = ath10k_download_cal_data(ar);
  if (status)
   goto err;

  /* Some of qca988x solutions are having global reset issue
   * during target initialization. Bypassing PLL setting before
   * downloading firmware and letting the SoC run on REF_CLK is
   * fixing the problem. Corresponding firmware change is also
   * needed to set the clock source once the target is
   * initialized.
 */
  if (test_bit(ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT,
        ar->running_fw->fw_file.fw_features)) {
   status = ath10k_bmi_write32(ar, hi_skip_clock_init, 1);
   if (status) {
    ath10k_err(ar, "could not write to skip_clock_init: %d\n",
        status);
    goto err;
   }
  }

  status = ath10k_download_fw(ar);
  if (status)
   goto err;

  status = ath10k_init_uart(ar);
  if (status)
   goto err;

  if (ar->hif.bus == ATH10K_BUS_SDIO) {
   status = ath10k_init_sdio(ar, mode);
   if (status) {
    ath10k_err(ar, "failed to init SDIO: %d\n", status);
    goto err;
   }
  }
 }

 ar->htc.htc_ops.target_send_suspend_complete =
  ath10k_send_suspend_complete;

 status = ath10k_htc_init(ar);
 if (status) {
  ath10k_err(ar, "could not init HTC (%d)\n", status);
  goto err;
 }

 if (!test_bit(ATH10K_FW_FEATURE_NON_BMI,
        ar->running_fw->fw_file.fw_features)) {
  status = ath10k_bmi_done(ar);
  if (status)
   goto err;
 }

 status = ath10k_wmi_attach(ar);
 if (status) {
  ath10k_err(ar, "WMI attach failed: %d\n", status);
  goto err;
 }

 status = ath10k_htt_init(ar);
 if (status) {
  ath10k_err(ar, "failed to init htt: %d\n", status);
  goto err_wmi_detach;
 }

 status = ath10k_htt_tx_start(&ar->htt);
 if (status) {
  ath10k_err(ar, "failed to alloc htt tx: %d\n", status);
  goto err_wmi_detach;
 }

 /* If firmware indicates Full Rx Reorder support it must be used in a
  * slightly different manner. Let HTT code know.
 */
 ar->htt.rx_ring.in_ord_rx = !!(test_bit(WMI_SERVICE_RX_FULL_REORDER,
      ar->wmi.svc_map));

 status = ath10k_htt_rx_alloc(&ar->htt);
 if (status) {
  ath10k_err(ar, "failed to alloc htt rx: %d\n", status);
  goto err_htt_tx_detach;
 }

 status = ath10k_hif_start(ar);
 if (status) {
  ath10k_err(ar, "could not start HIF: %d\n", status);
  goto err_htt_rx_detach;
 }

 status = ath10k_htc_wait_target(&ar->htc);
 if (status) {
  ath10k_err(ar, "failed to connect to HTC: %d\n", status);
  goto err_hif_stop;
 }

 status = ath10k_hif_start_post(ar);
 if (status) {
  ath10k_err(ar, "failed to swap mailbox: %d\n", status);
  goto err_hif_stop;
 }

 if (mode == ATH10K_FIRMWARE_MODE_NORMAL) {
  status = ath10k_htt_connect(&ar->htt);
  if (status) {
   ath10k_err(ar, "failed to connect htt (%d)\n", status);
   goto err_hif_stop;
  }
 }

 status = ath10k_wmi_connect(ar);
 if (status) {
  ath10k_err(ar, "could not connect wmi: %d\n", status);
  goto err_hif_stop;
 }

 status = ath10k_htc_start(&ar->htc);
 if (status) {
  ath10k_err(ar, "failed to start htc: %d\n", status);
  goto err_hif_stop;
 }

 if (mode == ATH10K_FIRMWARE_MODE_NORMAL) {
  status = ath10k_wmi_wait_for_service_ready(ar);
  if (status) {
   ath10k_warn(ar, "wmi service ready event not received");
   goto err_hif_stop;
  }
 }

 ath10k_dbg(ar, ATH10K_DBG_BOOT, "firmware %s booted\n",
     ar->hw->wiphy->fw_version);

 if (test_bit(ATH10K_FW_FEATURE_IRAM_RECOVERY,
       ar->running_fw->fw_file.fw_features)) {
  status = ath10k_core_copy_target_iram(ar);
  if (status) {
   ath10k_warn(ar, "failed to copy target iram contents: %d",
        status);
   goto err_hif_stop;
  }
 }

 if (test_bit(WMI_SERVICE_EXT_RES_CFG_SUPPORT, ar->wmi.svc_map) &&
     mode == ATH10K_FIRMWARE_MODE_NORMAL) {
  val = 0;
  if (ath10k_peer_stats_enabled(ar))
   val = WMI_10_4_PEER_STATS;

  /* Enable vdev stats by default */
  val |= WMI_10_4_VDEV_STATS;

  if (test_bit(WMI_SERVICE_BSS_CHANNEL_INFO_64, ar->wmi.svc_map))
   val |= WMI_10_4_BSS_CHANNEL_INFO_64;

  ath10k_core_fetch_btcoex_dt(ar);

  /* 10.4 firmware supports BT-Coex without reloading firmware
   * via pdev param. To support Bluetooth coexistence pdev param,
   * WMI_COEX_GPIO_SUPPORT of extended resource config should be
   * enabled always.
   *
   * We can still enable BTCOEX if firmware has the support
   * even though btceox_support value is
   * ATH10K_DT_BTCOEX_NOT_FOUND
 */

  if (test_bit(WMI_SERVICE_COEX_GPIO, ar->wmi.svc_map) &&
      test_bit(ATH10K_FW_FEATURE_BTCOEX_PARAM,
        ar->running_fw->fw_file.fw_features) &&
      ar->coex_support)
   val |= WMI_10_4_COEX_GPIO_SUPPORT;

  if (test_bit(WMI_SERVICE_TDLS_EXPLICIT_MODE_ONLY,
        ar->wmi.svc_map))
   val |= WMI_10_4_TDLS_EXPLICIT_MODE_ONLY;

  if (test_bit(WMI_SERVICE_TDLS_UAPSD_BUFFER_STA,
        ar->wmi.svc_map))
   val |= WMI_10_4_TDLS_UAPSD_BUFFER_STA;

  if (test_bit(WMI_SERVICE_TX_DATA_ACK_RSSI,
        ar->wmi.svc_map))
   val |= WMI_10_4_TX_DATA_ACK_RSSI;

  if (test_bit(WMI_SERVICE_REPORT_AIRTIME, ar->wmi.svc_map))
   val |= WMI_10_4_REPORT_AIRTIME;

  if (test_bit(WMI_SERVICE_EXT_PEER_TID_CONFIGS_SUPPORT,
        ar->wmi.svc_map))
   val |= WMI_10_4_EXT_PEER_TID_CONFIGS_SUPPORT;

  status = ath10k_mac_ext_resource_config(ar, val);
  if (status) {
   ath10k_err(ar,
       "failed to send ext resource cfg command : %d\n",
       status);
   goto err_hif_stop;
  }
 }

 status = ath10k_wmi_cmd_init(ar);
 if (status) {
  ath10k_err(ar, "could not send WMI init command (%d)\n",
      status);
  goto err_hif_stop;
 }

 status = ath10k_wmi_wait_for_unified_ready(ar);
 if (status) {
  ath10k_err(ar, "wmi unified ready event not received\n");
  goto err_hif_stop;
 }

 status = ath10k_core_compat_services(ar);
 if (status) {
  ath10k_err(ar, "compat services failed: %d\n", status);
  goto err_hif_stop;
 }

 status = ath10k_wmi_pdev_set_base_macaddr(ar, ar->mac_addr);
 if (status && status != -EOPNOTSUPP) {
  ath10k_err(ar,
      "failed to set base mac address: %d\n", status);
  goto err_hif_stop;
 }

 /* Some firmware revisions do not properly set up hardware rx filter
  * registers.
  *
  * A known example from QCA9880 and 10.2.4 is that MAC_PCU_ADDR1_MASK
  * is filled with 0s instead of 1s allowing HW to respond with ACKs to
  * any frames that matches MAC_PCU_RX_FILTER which is also
  * misconfigured to accept anything.
  *
  * The ADDR1 is programmed using internal firmware structure field and
  * can't be (easily/sanely) reached from the driver explicitly. It is
  * possible to implicitly make it correct by creating a dummy vdev and
  * then deleting it.
 */
 if (ar->hw_params.hw_filter_reset_required &&
     mode == ATH10K_FIRMWARE_MODE_NORMAL) {
  status = ath10k_core_reset_rx_filter(ar);
  if (status) {
   ath10k_err(ar,
       "failed to reset rx filter: %d\n", status);
   goto err_hif_stop;
  }
 }

 status = ath10k_htt_rx_ring_refill(ar);
 if (status) {
  ath10k_err(ar, "failed to refill htt rx ring: %d\n", status);
  goto err_hif_stop;
 }

 if (ar->max_num_vdevs >= 64)
  ar->free_vdev_map = 0xFFFFFFFFFFFFFFFFLL;
 else
  ar->free_vdev_map = (1LL << ar->max_num_vdevs) - 1;

 INIT_LIST_HEAD(&ar->arvifs);

 /* we don't care about HTT in UTF mode */
 if (mode == ATH10K_FIRMWARE_MODE_NORMAL) {
  status = ath10k_htt_setup(&ar->htt);
  if (status) {
   ath10k_err(ar, "failed to setup htt: %d\n", status);
   goto err_hif_stop;
  }
 }

 status = ath10k_debug_start(ar);
 if (status)
  goto err_hif_stop;

 status = ath10k_hif_set_target_log_mode(ar, fw_diag_log);
 if (status && status != -EOPNOTSUPP) {
  ath10k_warn(ar, "set target log mode failed: %d\n", status);
  goto err_hif_stop;
 }

 status = ath10k_leds_start(ar);
 if (status)
  goto err_hif_stop;

 return 0;

err_hif_stop:
 ath10k_hif_stop(ar);
err_htt_rx_detach:
 ath10k_htt_rx_free(&ar->htt);
err_htt_tx_detach:
 ath10k_htt_tx_free(&ar->htt);
err_wmi_detach:
 ath10k_wmi_detach(ar);
err:
 return status;
}
EXPORT_SYMBOL(ath10k_core_start);

int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt)
{
 int ret;
 unsigned long time_left;

 reinit_completion(&ar->target_suspend);

 ret = ath10k_wmi_pdev_suspend_target(ar, suspend_opt);
 if (ret) {
  ath10k_warn(ar, "could not suspend target (%d)\n", ret);
  return ret;
 }

 time_left = wait_for_completion_timeout(&ar->target_suspend, 1 * HZ);

 if (!time_left) {
  ath10k_warn(ar, "suspend timed out - target pause event never came\n");
  return -ETIMEDOUT;
 }

 return 0;
}

void ath10k_core_stop(struct ath10k *ar)
{
 lockdep_assert_held(&ar->conf_mutex);
 ath10k_debug_stop(ar);

 /* try to suspend target */
 if (ar->state != ATH10K_STATE_RESTARTING &&
     ar->state != ATH10K_STATE_UTF)
  ath10k_wait_for_suspend(ar, WMI_PDEV_SUSPEND_AND_DISABLE_INTR);

 ath10k_hif_stop(ar);
 ath10k_htt_tx_stop(&ar->htt);
 ath10k_htt_rx_free(&ar->htt);
 ath10k_wmi_detach(ar);

 ar->id.bmi_ids_valid = false;
}
EXPORT_SYMBOL(ath10k_core_stop);

/* mac80211 manages fw/hw initialization through start/stop hooks. However in
 * order to know what hw capabilities should be advertised to mac80211 it is
 * necessary to load the firmware (and tear it down immediately since start
 * hook will try to init it again) before registering
 */
static int ath10k_core_probe_fw(struct ath10k *ar)
{
 struct bmi_target_info target_info;
 int ret = 0;

 ret = ath10k_hif_power_up(ar, ATH10K_FIRMWARE_MODE_NORMAL);
 if (ret) {
  ath10k_err(ar, "could not power on hif bus (%d)\n", ret);
  return ret;
 }

 switch (ar->hif.bus) {
 case ATH10K_BUS_SDIO:
  memset(&target_info, 0, sizeof(target_info));
  ret = ath10k_bmi_get_target_info_sdio(ar, &target_info);
  if (ret) {
   ath10k_err(ar, "could not get target info (%d)\n", ret);
   goto err_power_down;
  }
  ar->target_version = target_info.version;
  ar->hw->wiphy->hw_version = target_info.version;
  break;
 case ATH10K_BUS_PCI:
 case ATH10K_BUS_AHB:
 case ATH10K_BUS_USB:
  memset(&target_info, 0, sizeof(target_info));
  ret = ath10k_bmi_get_target_info(ar, &target_info);
  if (ret) {
   ath10k_err(ar, "could not get target info (%d)\n", ret);
   goto err_power_down;
  }
  ar->target_version = target_info.version;
  ar->hw->wiphy->hw_version = target_info.version;
  break;
 case ATH10K_BUS_SNOC:
  memset(&target_info, 0, sizeof(target_info));
  ret = ath10k_hif_get_target_info(ar, &target_info);
  if (ret) {
   ath10k_err(ar, "could not get target info (%d)\n", ret);
   goto err_power_down;
  }
  ar->target_version = target_info.version;
  ar->hw->wiphy->hw_version = target_info.version;
  break;
 default:
  ath10k_err(ar, "incorrect hif bus type: %d\n", ar->hif.bus);
 }

 ret = ath10k_init_hw_params(ar);
 if (ret) {
  ath10k_err(ar, "could not get hw params (%d)\n", ret);
  goto err_power_down;
 }

 ret = ath10k_core_fetch_firmware_files(ar);
 if (ret) {
  ath10k_err(ar, "could not fetch firmware files (%d)\n", ret);
  goto err_power_down;
 }

 BUILD_BUG_ON(sizeof(ar->hw->wiphy->fw_version) !=
       sizeof(ar->normal_mode_fw.fw_file.fw_version));
 memcpy(ar->hw->wiphy->fw_version, ar->normal_mode_fw.fw_file.fw_version,
        sizeof(ar->hw->wiphy->fw_version));

 ath10k_debug_print_hwfw_info(ar);

 if (!test_bit(ATH10K_FW_FEATURE_NON_BMI,
        ar->normal_mode_fw.fw_file.fw_features)) {
  ret = ath10k_core_pre_cal_download(ar);
  if (ret) {
   /* pre calibration data download is not necessary
    * for all the chipsets. Ignore failures and continue.
 */
   ath10k_dbg(ar, ATH10K_DBG_BOOT,
       "could not load pre cal data: %d\n", ret);
  }

  ret = ath10k_core_get_board_id_from_otp(ar);
  if (ret && ret != -EOPNOTSUPP) {
   ath10k_err(ar, "failed to get board id from otp: %d\n",
       ret);
   goto err_free_firmware_files;
  }

  ret = ath10k_core_check_smbios(ar);
  if (ret)
   ath10k_dbg(ar, ATH10K_DBG_BOOT, "SMBIOS bdf variant name not set.\n");

  ret = ath10k_core_check_dt(ar);
  if (ret)
   ath10k_dbg(ar, ATH10K_DBG_BOOT, "DT bdf variant name not set.\n");

  ret = ath10k_core_fetch_board_file(ar, ATH10K_BD_IE_BOARD);
  if (ret) {
   ath10k_err(ar, "failed to fetch board file: %d\n", ret);
   goto err_free_firmware_files;
  }

  ath10k_debug_print_board_info(ar);
 }

 device_get_mac_address(ar->dev, ar->mac_addr);

 ret = ath10k_core_init_firmware_features(ar);
 if (ret) {
  ath10k_err(ar, "fatal problem with firmware features: %d\n",
      ret);
  goto err_free_firmware_files;
 }

 if (!test_bit(ATH10K_FW_FEATURE_NON_BMI,
        ar->normal_mode_fw.fw_file.fw_features)) {
  ret = ath10k_swap_code_seg_init(ar,
      &ar->normal_mode_fw.fw_file);
  if (ret) {
   ath10k_err(ar, "failed to initialize code swap segment: %d\n",
       ret);
   goto err_free_firmware_files;
  }
 }

 mutex_lock(&ar->conf_mutex);

 ret = ath10k_core_start(ar, ATH10K_FIRMWARE_MODE_NORMAL,
    &ar->normal_mode_fw);
 if (ret) {
  ath10k_err(ar, "could not init core (%d)\n", ret);
  goto err_unlock;
 }

 ath10k_debug_print_boot_info(ar);
 ath10k_core_stop(ar);

 mutex_unlock(&ar->conf_mutex);

 ath10k_hif_power_down(ar);
 return 0;

err_unlock:
 mutex_unlock(&ar->conf_mutex);

err_free_firmware_files:
 ath10k_core_free_firmware_files(ar);

err_power_down:
 ath10k_hif_power_down(ar);

 return ret;
}

static void ath10k_core_register_work(struct work_struct *work)
{
 struct ath10k *ar = container_of(work, struct ath10k, register_work);
 int status;

 /* peer stats are enabled by default */
 set_bit(ATH10K_FLAG_PEER_STATS, &ar->dev_flags);

 status = ath10k_core_probe_fw(ar);
 if (status) {
  ath10k_err(ar, "could not probe fw (%d)\n", status);
  goto err;
 }

 status = ath10k_mac_register(ar);
 if (status) {
  ath10k_err(ar, "could not register to mac80211 (%d)\n", status);
  goto err_release_fw;
 }

 status = ath10k_coredump_register(ar);
 if (status) {
  ath10k_err(ar, "unable to register coredump\n");
  goto err_unregister_mac;
 }

 status = ath10k_debug_register(ar);
 if (status) {
  ath10k_err(ar, "unable to initialize debugfs\n");
  goto err_unregister_coredump;
 }

 status = ath10k_spectral_create(ar);
 if (status) {
  ath10k_err(ar, "failed to initialize spectral\n");
  goto err_debug_destroy;
 }

 status = ath10k_thermal_register(ar);
 if (status) {
  ath10k_err(ar, "could not register thermal device: %d\n",
      status);
  goto err_spectral_destroy;
 }

 status = ath10k_leds_register(ar);
 if (status) {
  ath10k_err(ar, "could not register leds: %d\n",
      status);
  goto err_thermal_unregister;
 }

 set_bit(ATH10K_FLAG_CORE_REGISTERED, &ar->dev_flags);
 return;

err_thermal_unregister:
 ath10k_thermal_unregister(ar);
err_spectral_destroy:
 ath10k_spectral_destroy(ar);
err_debug_destroy:
 ath10k_debug_destroy(ar);
err_unregister_coredump:
 ath10k_coredump_unregister(ar);
err_unregister_mac:
 ath10k_mac_unregister(ar);
err_release_fw:
 ath10k_core_free_firmware_files(ar);
err:
 /* TODO: It's probably a good idea to release device from the driver
  * but calling device_release_driver() here will cause a deadlock.
 */
 return;
}

int ath10k_core_register(struct ath10k *ar,
    const struct ath10k_bus_params *bus_params)
{
 ar->bus_param = *bus_params;

 queue_work(ar->workqueue, &ar->register_work);

 return 0;
}
EXPORT_SYMBOL(ath10k_core_register);

void ath10k_core_unregister(struct ath10k *ar)
{
 cancel_work_sync(&ar->register_work);

 if (!test_bit(ATH10K_FLAG_CORE_REGISTERED, &ar->dev_flags))
  return;

 ath10k_leds_unregister(ar);

 ath10k_thermal_unregister(ar);
 /* Stop spectral before unregistering from mac80211 to remove the
  * relayfs debugfs file cleanly. Otherwise the parent debugfs tree
  * would be already be free'd recursively, leading to a double free.
 */
 ath10k_spectral_destroy(ar);

 /* We must unregister from mac80211 before we stop HTC and HIF.
  * Otherwise we will fail to submit commands to FW and mac80211 will be
  * unhappy about callback failures.
 */
 ath10k_mac_unregister(ar);

 ath10k_testmode_destroy(ar);

 ath10k_core_free_firmware_files(ar);
 ath10k_core_free_board_files(ar);

 ath10k_debug_unregister(ar);
}
EXPORT_SYMBOL(ath10k_core_unregister);

struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
      enum ath10k_bus bus,
      enum ath10k_hw_rev hw_rev,
      const struct ath10k_hif_ops *hif_ops)
{
 struct ath10k *ar;
 int ret;

 ar = ath10k_mac_create(priv_size);
 if (!ar)
  return NULL;

 ar->ath_common.priv = ar;
 ar->ath_common.hw = ar->hw;
 ar->dev = dev;
 ar->hw_rev = hw_rev;
 ar->hif.ops = hif_ops;
 ar->hif.bus = bus;

 switch (hw_rev) {
 case ATH10K_HW_QCA988X:
 case ATH10K_HW_QCA9887:
  ar->regs = &qca988x_regs;
  ar->hw_ce_regs = &qcax_ce_regs;
  ar->hw_values = &qca988x_values;
  break;
 case ATH10K_HW_QCA6174:
 case ATH10K_HW_QCA9377:
  ar->regs = &qca6174_regs;
  ar->hw_ce_regs = &qcax_ce_regs;
  ar->hw_values = &qca6174_values;
  break;
 case ATH10K_HW_QCA99X0:
 case ATH10K_HW_QCA9984:
  ar->regs = &qca99x0_regs;
  ar->hw_ce_regs = &qcax_ce_regs;
  ar->hw_values = &qca99x0_values;
  break;
 case ATH10K_HW_QCA9888:
  ar->regs = &qca99x0_regs;
  ar->hw_ce_regs = &qcax_ce_regs;
  ar->hw_values = &qca9888_values;
  break;
 case ATH10K_HW_QCA4019:
  ar->regs = &qca4019_regs;
  ar->hw_ce_regs = &qcax_ce_regs;
  ar->hw_values = &qca4019_values;
  break;
 case ATH10K_HW_WCN3990:
  ar->regs = &wcn3990_regs;
  ar->hw_ce_regs = &wcn3990_ce_regs;
  ar->hw_values = &wcn3990_values;
  break;
 default:
  ath10k_err(ar, "unsupported core hardware revision %d\n",
      hw_rev);
  ret = -EOPNOTSUPP;
  goto err_free_mac;
 }

 init_completion(&ar->scan.started);
 init_completion(&ar->scan.completed);
 init_completion(&ar->scan.on_channel);
 init_completion(&ar->target_suspend);
 init_completion(&ar->driver_recovery);
 init_completion(&ar->wow.wakeup_completed);

 init_completion(&ar->install_key_done);
 init_completion(&ar->vdev_setup_done);
 init_completion(&ar->vdev_delete_done);
 init_completion(&ar->thermal.wmi_sync);
 init_completion(&ar->bss_survey_done);
 init_completion(&ar->peer_delete_done);
 init_completion(&ar->peer_stats_info_complete);

 INIT_DELAYED_WORK(&ar->scan.timeout, ath10k_scan_timeout_work);

 ar->workqueue = create_singlethread_workqueue("ath10k_wq");
 if (!ar->workqueue)
  goto err_free_mac;

 ar->workqueue_aux = create_singlethread_workqueue("ath10k_aux_wq");
 if (!ar->workqueue_aux)
  goto err_free_wq;

 ar->workqueue_tx_complete =
  create_singlethread_workqueue("ath10k_tx_complete_wq");
 if (!ar->workqueue_tx_complete)
  goto err_free_aux_wq;

 mutex_init(&ar->conf_mutex);
 mutex_init(&ar->dump_mutex);
 spin_lock_init(&ar->data_lock);

 for (int ac = 0; ac < IEEE80211_NUM_ACS; ac++)
  spin_lock_init(&ar->queue_lock[ac]);

 INIT_LIST_HEAD(&ar->peers);
 init_waitqueue_head(&ar->peer_mapping_wq);
 init_waitqueue_head(&ar->htt.empty_tx_wq);
 init_waitqueue_head(&ar->wmi.tx_credits_wq);

 skb_queue_head_init(&ar->htt.rx_indication_head);

 init_completion(&ar->offchan_tx_completed);
 INIT_WORK(&ar->offchan_tx_work, ath10k_offchan_tx_work);
 skb_queue_head_init(&ar->offchan_tx_queue);

 INIT_WORK(&ar->wmi_mgmt_tx_work, ath10k_mgmt_over_wmi_tx_work);
 skb_queue_head_init(&ar->wmi_mgmt_tx_queue);

 INIT_WORK(&ar->register_work, ath10k_core_register_work);
 INIT_WORK(&ar->restart_work, ath10k_core_restart);
 INIT_WORK(&ar->set_coverage_class_work,
    ath10k_core_set_coverage_class_work);

 ar->napi_dev = alloc_netdev_dummy(0);
 if (!ar->napi_dev)
  goto err_free_tx_complete;

 ret = ath10k_coredump_create(ar);
 if (ret)
  goto err_free_netdev;

 ret = ath10k_debug_create(ar);
 if (ret)
  goto err_free_coredump;

 return ar;

err_free_coredump:
 ath10k_coredump_destroy(ar);
err_free_netdev:
 free_netdev(ar->napi_dev);
err_free_tx_complete:
 destroy_workqueue(ar->workqueue_tx_complete);
err_free_aux_wq:
 destroy_workqueue(ar->workqueue_aux);
err_free_wq:
 destroy_workqueue(ar->workqueue);
err_free_mac:
 ath10k_mac_destroy(ar);

 return NULL;
}
EXPORT_SYMBOL(ath10k_core_create);

void ath10k_core_destroy(struct ath10k *ar)
{
 destroy_workqueue(ar->workqueue);

 destroy_workqueue(ar->workqueue_aux);

 destroy_workqueue(ar->workqueue_tx_complete);

 free_netdev(ar->napi_dev);
 ath10k_debug_destroy(ar);
 ath10k_coredump_destroy(ar);
 ath10k_htt_tx_destroy(&ar->htt);
 ath10k_wmi_free_host_mem(ar);
 ath10k_mac_destroy(ar);
}
EXPORT_SYMBOL(ath10k_core_destroy);

MODULE_AUTHOR("Qualcomm Atheros");
MODULE_DESCRIPTION("Core module for Qualcomm Atheros 802.11ac wireless LAN cards.");
MODULE_LICENSE("Dual BSD/GPL");