drivers/net/wireless/ath/ath10k/core.c

   1 /*
   2  * Copyright (c) 2005-2011 Atheros Communications Inc.
   3  * Copyright (c) 2011-2013 Qualcomm Atheros, Inc.
   4  *
   5  * Permission to use, copy, modify, and/or distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 #include <linux/module.h>
  19 #include <linux/firmware.h>
  20 #include <linux/of.h>
  21
  22 #include "core.h"
  23 #include "mac.h"
  24 #include "htc.h"
  25 #include "hif.h"
  26 #include "wmi.h"
  27 #include "bmi.h"
  28 #include "debug.h"
  29 #include "htt.h"
  30 #include "testmode.h"
  31 #include "wmi-ops.h"
  32
  33 unsigned int ath10k_debug_mask;
  34 static unsigned int ath10k_cryptmode_param;
  35 static bool uart_print;
  36 static bool skip_otp;
  37 static bool rawmode;
  38
  39 module_param_named(debug_mask, ath10k_debug_mask, uint, 0644);
  40 module_param_named(cryptmode, ath10k_cryptmode_param, uint, 0644);
  41 module_param(uart_print, bool, 0644);
  42 module_param(skip_otp, bool, 0644);
  43 module_param(rawmode, bool, 0644);
  44
  45 MODULE_PARM_DESC(debug_mask, "Debugging mask");
  46 MODULE_PARM_DESC(uart_print, "Uart target debugging");
  47 MODULE_PARM_DESC(skip_otp, "Skip otp failure for calibration in testmode");
  48 MODULE_PARM_DESC(cryptmode, "Crypto mode: 0-hardware, 1-software");
  49 MODULE_PARM_DESC(rawmode, "Use raw 802.11 frame datapath");
  50
  51 static const struct ath10k_hw_params ath10k_hw_params_list[] = {
  52         {
  53                 .id = QCA988X_HW_2_0_VERSION,
  54                 .dev_id = QCA988X_2_0_DEVICE_ID,
  55                 .name = "qca988x hw2.0",
  56                 .patch_load_addr = QCA988X_HW_2_0_PATCH_LOAD_ADDR,
  57                 .uart_pin = 7,
  58                 .has_shifted_cc_wraparound = true,
  59                 .otp_exe_param = 0,
  60                 .channel_counters_freq_hz = 88000,
  61                 .max_probe_resp_desc_thres = 0,
  62                 .hw_4addr_pad = ATH10K_HW_4ADDR_PAD_AFTER,
  63                 .cal_data_len = 2116,
  64                 .fw = {
  65                         .dir = QCA988X_HW_2_0_FW_DIR,
  66                         .board = QCA988X_HW_2_0_BOARD_DATA_FILE,
  67                         .board_size = QCA988X_BOARD_DATA_SZ,
  68                         .board_ext_size = QCA988X_BOARD_EXT_DATA_SZ,
  69                 },
  70         },
  71         {
  72                 .id = QCA6174_HW_2_1_VERSION,
  73                 .dev_id = QCA6164_2_1_DEVICE_ID,
  74                 .name = "qca6164 hw2.1",
  75                 .patch_load_addr = QCA6174_HW_2_1_PATCH_LOAD_ADDR,
  76                 .uart_pin = 6,
  77                 .otp_exe_param = 0,
  78                 .channel_counters_freq_hz = 88000,
  79                 .max_probe_resp_desc_thres = 0,
  80                 .cal_data_len = 8124,
  81                 .fw = {
  82                         .dir = QCA6174_HW_2_1_FW_DIR,
  83                         .board = QCA6174_HW_2_1_BOARD_DATA_FILE,
  84                         .board_size = QCA6174_BOARD_DATA_SZ,
  85                         .board_ext_size = QCA6174_BOARD_EXT_DATA_SZ,
  86                 },
  87         },
  88         {
  89                 .id = QCA6174_HW_2_1_VERSION,
  90                 .dev_id = QCA6174_2_1_DEVICE_ID,
  91                 .name = "qca6174 hw2.1",
  92                 .patch_load_addr = QCA6174_HW_2_1_PATCH_LOAD_ADDR,
  93                 .uart_pin = 6,
  94                 .otp_exe_param = 0,
  95                 .channel_counters_freq_hz = 88000,
  96                 .max_probe_resp_desc_thres = 0,
  97                 .hw_4addr_pad = ATH10K_HW_4ADDR_PAD_AFTER,
  98                 .cal_data_len = 8124,
  99                 .fw = {
 100                         .dir = QCA6174_HW_2_1_FW_DIR,
 101                         .board = QCA6174_HW_2_1_BOARD_DATA_FILE,
 102                         .board_size = QCA6174_BOARD_DATA_SZ,
 103                         .board_ext_size = QCA6174_BOARD_EXT_DATA_SZ,
 104                 },
 105         },
 106         {
 107                 .id = QCA6174_HW_3_0_VERSION,
 108                 .dev_id = QCA6174_2_1_DEVICE_ID,
 109                 .name = "qca6174 hw3.0",
 110                 .patch_load_addr = QCA6174_HW_3_0_PATCH_LOAD_ADDR,
 111                 .uart_pin = 6,
 112                 .otp_exe_param = 0,
 113                 .channel_counters_freq_hz = 88000,
 114                 .max_probe_resp_desc_thres = 0,
 115                 .hw_4addr_pad = ATH10K_HW_4ADDR_PAD_AFTER,
 116                 .cal_data_len = 8124,
 117                 .fw = {
 118                         .dir = QCA6174_HW_3_0_FW_DIR,
 119                         .board = QCA6174_HW_3_0_BOARD_DATA_FILE,
 120                         .board_size = QCA6174_BOARD_DATA_SZ,
 121                         .board_ext_size = QCA6174_BOARD_EXT_DATA_SZ,
 122                 },
 123         },
 124         {
 125                 .id = QCA6174_HW_3_2_VERSION,
 126                 .dev_id = QCA6174_2_1_DEVICE_ID,
 127                 .name = "qca6174 hw3.2",
 128                 .patch_load_addr = QCA6174_HW_3_0_PATCH_LOAD_ADDR,
 129                 .uart_pin = 6,
 130                 .otp_exe_param = 0,
 131                 .channel_counters_freq_hz = 88000,
 132                 .max_probe_resp_desc_thres = 0,
 133                 .hw_4addr_pad = ATH10K_HW_4ADDR_PAD_AFTER,
 134                 .cal_data_len = 8124,
 135                 .fw = {
 136                         /* uses same binaries as hw3.0 */
 137                         .dir = QCA6174_HW_3_0_FW_DIR,
 138                         .board = QCA6174_HW_3_0_BOARD_DATA_FILE,
 139                         .board_size = QCA6174_BOARD_DATA_SZ,
 140                         .board_ext_size = QCA6174_BOARD_EXT_DATA_SZ,
 141                 },
 142         },
 143         {
 144                 .id = QCA99X0_HW_2_0_DEV_VERSION,
 145                 .dev_id = QCA99X0_2_0_DEVICE_ID,
 146                 .name = "qca99x0 hw2.0",
 147                 .patch_load_addr = QCA99X0_HW_2_0_PATCH_LOAD_ADDR,
 148                 .uart_pin = 7,
 149                 .otp_exe_param = 0x00000700,
 150                 .continuous_frag_desc = true,
 151                 .channel_counters_freq_hz = 150000,
 152                 .max_probe_resp_desc_thres = 24,
 153                 .hw_4addr_pad = ATH10K_HW_4ADDR_PAD_BEFORE,
 154                 .tx_chain_mask = 0xf,
 155                 .rx_chain_mask = 0xf,
 156                 .max_spatial_stream = 4,
 157                 .cal_data_len = 12064,
 158                 .fw = {
 159                         .dir = QCA99X0_HW_2_0_FW_DIR,
 160                         .board = QCA99X0_HW_2_0_BOARD_DATA_FILE,
 161                         .board_size = QCA99X0_BOARD_DATA_SZ,
 162                         .board_ext_size = QCA99X0_BOARD_EXT_DATA_SZ,
 163                 },
 164         },
 165         {
 166                 .id = QCA9377_HW_1_0_DEV_VERSION,
 167                 .dev_id = QCA9377_1_0_DEVICE_ID,
 168                 .name = "qca9377 hw1.0",
 169                 .patch_load_addr = QCA9377_HW_1_0_PATCH_LOAD_ADDR,
 170                 .uart_pin = 6,
 171                 .otp_exe_param = 0,
 172                 .channel_counters_freq_hz = 88000,
 173                 .max_probe_resp_desc_thres = 0,
 174                 .cal_data_len = 8124,
 175                 .fw = {
 176                         .dir = QCA9377_HW_1_0_FW_DIR,
 177                         .board = QCA9377_HW_1_0_BOARD_DATA_FILE,
 178                         .board_size = QCA9377_BOARD_DATA_SZ,
 179                         .board_ext_size = QCA9377_BOARD_EXT_DATA_SZ,
 180                 },
 181         },
 182         {
 183                 .id = QCA9377_HW_1_1_DEV_VERSION,
 184                 .dev_id = QCA9377_1_0_DEVICE_ID,
 185                 .name = "qca9377 hw1.1",
 186                 .patch_load_addr = QCA9377_HW_1_0_PATCH_LOAD_ADDR,
 187                 .uart_pin = 6,
 188                 .otp_exe_param = 0,
 189                 .channel_counters_freq_hz = 88000,
 190                 .max_probe_resp_desc_thres = 0,
 191                 .cal_data_len = 8124,
 192                 .fw = {
 193                         .dir = QCA9377_HW_1_0_FW_DIR,
 194                         .board = QCA9377_HW_1_0_BOARD_DATA_FILE,
 195                         .board_size = QCA9377_BOARD_DATA_SZ,
 196                         .board_ext_size = QCA9377_BOARD_EXT_DATA_SZ,
 197                 },
 198         },
 199         {
 200                 .id = QCA4019_HW_1_0_DEV_VERSION,
 201                 .dev_id = 0,
 202                 .name = "qca4019 hw1.0",
 203                 .patch_load_addr = QCA4019_HW_1_0_PATCH_LOAD_ADDR,
 204                 .uart_pin = 7,
 205                 .otp_exe_param = 0x0010000,
 206                 .continuous_frag_desc = true,
 207                 .channel_counters_freq_hz = 125000,
 208                 .max_probe_resp_desc_thres = 24,
 209                 .hw_4addr_pad = ATH10K_HW_4ADDR_PAD_BEFORE,
 210                 .tx_chain_mask = 0x3,
 211                 .rx_chain_mask = 0x3,
 212                 .max_spatial_stream = 2,
 213                 .cal_data_len = 12064,
 214                 .fw = {
 215                         .dir = QCA4019_HW_1_0_FW_DIR,
 216                         .board = QCA4019_HW_1_0_BOARD_DATA_FILE,
 217                         .board_size = QCA4019_BOARD_DATA_SZ,
 218                         .board_ext_size = QCA4019_BOARD_EXT_DATA_SZ,
 219                 },
 220         },
 221 };
 222
 223 static const char *const ath10k_core_fw_feature_str[] = {
 224         [ATH10K_FW_FEATURE_EXT_WMI_MGMT_RX] = "wmi-mgmt-rx",
 225         [ATH10K_FW_FEATURE_WMI_10X] = "wmi-10.x",
 226         [ATH10K_FW_FEATURE_HAS_WMI_MGMT_TX] = "has-wmi-mgmt-tx",
 227         [ATH10K_FW_FEATURE_NO_P2P] = "no-p2p",
 228         [ATH10K_FW_FEATURE_WMI_10_2] = "wmi-10.2",
 229         [ATH10K_FW_FEATURE_MULTI_VIF_PS_SUPPORT] = "multi-vif-ps",
 230         [ATH10K_FW_FEATURE_WOWLAN_SUPPORT] = "wowlan",
 231         [ATH10K_FW_FEATURE_IGNORE_OTP_RESULT] = "ignore-otp",
 232         [ATH10K_FW_FEATURE_NO_NWIFI_DECAP_4ADDR_PADDING] = "no-4addr-pad",
 233         [ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT] = "skip-clock-init",
 234         [ATH10K_FW_FEATURE_RAW_MODE_SUPPORT] = "raw-mode",
 235         [ATH10K_FW_FEATURE_SUPPORTS_ADAPTIVE_CCA] = "adaptive-cca",
 236         [ATH10K_FW_FEATURE_MFP_SUPPORT] = "mfp",
 237         [ATH10K_FW_FEATURE_PEER_FLOW_CONTROL] = "peer-flow-ctrl",
 238 };
 239
 240 static unsigned int ath10k_core_get_fw_feature_str(char *buf,
 241                                                    size_t buf_len,
 242                                                    enum ath10k_fw_features feat)
 243 {
 244         /* make sure that ath10k_core_fw_feature_str[] gets updated */
 245         BUILD_BUG_ON(ARRAY_SIZE(ath10k_core_fw_feature_str) !=
 246                      ATH10K_FW_FEATURE_COUNT);
 247
 248         if (feat >= ARRAY_SIZE(ath10k_core_fw_feature_str) ||
 249             WARN_ON(!ath10k_core_fw_feature_str[feat])) {
 250                 return scnprintf(buf, buf_len, "bit%d", feat);
 251         }
 252
 253         return scnprintf(buf, buf_len, "%s", ath10k_core_fw_feature_str[feat]);
 254 }
 255
 256 void ath10k_core_get_fw_features_str(struct ath10k *ar,
 257                                      char *buf,
 258                                      size_t buf_len)
 259 {
 260         unsigned int len = 0;
 261         int i;
 262
 263         for (i = 0; i < ATH10K_FW_FEATURE_COUNT; i++) {
 264                 if (test_bit(i, ar->normal_mode_fw.fw_file.fw_features)) {
 265                         if (len > 0)
 266                                 len += scnprintf(buf + len, buf_len - len, ",");
 267
 268                         len += ath10k_core_get_fw_feature_str(buf + len,
 269                                                               buf_len - len,
 270                                                               i);
 271                 }
 272         }
 273 }
 274
 275 static void ath10k_send_suspend_complete(struct ath10k *ar)
 276 {
 277         ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot suspend complete\n");
 278
 279         complete(&ar->target_suspend);
 280 }
 281
 282 static int ath10k_init_configure_target(struct ath10k *ar)
 283 {
 284         u32 param_host;
 285         int ret;
 286
 287         /* tell target which HTC version it is used*/
 288         ret = ath10k_bmi_write32(ar, hi_app_host_interest,
 289                                  HTC_PROTOCOL_VERSION);
 290         if (ret) {
 291                 ath10k_err(ar, "settings HTC version failed\n");
 292                 return ret;
 293         }
 294
 295         /* set the firmware mode to STA/IBSS/AP */
 296         ret = ath10k_bmi_read32(ar, hi_option_flag, &param_host);
 297         if (ret) {
 298                 ath10k_err(ar, "setting firmware mode (1/2) failed\n");
 299                 return ret;
 300         }
 301
 302         /* TODO following parameters need to be re-visited. */
 303         /* num_device */
 304         param_host |= (1 << HI_OPTION_NUM_DEV_SHIFT);
 305         /* Firmware mode */
 306         /* FIXME: Why FW_MODE_AP ??.*/
 307         param_host |= (HI_OPTION_FW_MODE_AP << HI_OPTION_FW_MODE_SHIFT);
 308         /* mac_addr_method */
 309         param_host |= (1 << HI_OPTION_MAC_ADDR_METHOD_SHIFT);
 310         /* firmware_bridge */
 311         param_host |= (0 << HI_OPTION_FW_BRIDGE_SHIFT);
 312         /* fwsubmode */
 313         param_host |= (0 << HI_OPTION_FW_SUBMODE_SHIFT);
 314
 315         ret = ath10k_bmi_write32(ar, hi_option_flag, param_host);
 316         if (ret) {
 317                 ath10k_err(ar, "setting firmware mode (2/2) failed\n");
 318                 return ret;
 319         }
 320
 321         /* We do all byte-swapping on the host */
 322         ret = ath10k_bmi_write32(ar, hi_be, 0);
 323         if (ret) {
 324                 ath10k_err(ar, "setting host CPU BE mode failed\n");
 325                 return ret;
 326         }
 327
 328         /* FW descriptor/Data swap flags */
 329         ret = ath10k_bmi_write32(ar, hi_fw_swap, 0);
 330
 331         if (ret) {
 332                 ath10k_err(ar, "setting FW data/desc swap flags failed\n");
 333                 return ret;
 334         }
 335
 336         /* Some devices have a special sanity check that verifies the PCI
 337          * Device ID is written to this host interest var. It is known to be
 338          * required to boot QCA6164.
 339          */
 340         ret = ath10k_bmi_write32(ar, hi_hci_uart_pwr_mgmt_params_ext,
 341                                  ar->dev_id);
 342         if (ret) {
 343                 ath10k_err(ar, "failed to set pwr_mgmt_params: %d\n", ret);
 344                 return ret;
 345         }
 346
 347         return 0;
 348 }
 349
 350 static const struct firmware *ath10k_fetch_fw_file(struct ath10k *ar,
 351                                                    const char *dir,
 352                                                    const char *file)
 353 {
 354         char filename[100];
 355         const struct firmware *fw;
 356         int ret;
 357
 358         if (file == NULL)
 359                 return ERR_PTR(-ENOENT);
 360
 361         if (dir == NULL)
 362                 dir = ".";
 363
 364         snprintf(filename, sizeof(filename), "%s/%s", dir, file);
 365         ret = request_firmware(&fw, filename, ar->dev);
 366         if (ret)
 367                 return ERR_PTR(ret);
 368
 369         return fw;
 370 }
 371
 372 static int ath10k_push_board_ext_data(struct ath10k *ar, const void *data,
 373                                       size_t data_len)
 374 {
 375         u32 board_data_size = ar->hw_params.fw.board_size;
 376         u32 board_ext_data_size = ar->hw_params.fw.board_ext_size;
 377         u32 board_ext_data_addr;
 378         int ret;
 379
 380         ret = ath10k_bmi_read32(ar, hi_board_ext_data, &board_ext_data_addr);
 381         if (ret) {
 382                 ath10k_err(ar, "could not read board ext data addr (%d)\n",
 383                            ret);
 384                 return ret;
 385         }
 386
 387         ath10k_dbg(ar, ATH10K_DBG_BOOT,
 388                    "boot push board extended data addr 0x%x\n",
 389                    board_ext_data_addr);
 390
 391         if (board_ext_data_addr == 0)
 392                 return 0;
 393
 394         if (data_len != (board_data_size + board_ext_data_size)) {
 395                 ath10k_err(ar, "invalid board (ext) data sizes %zu != %d+%d\n",
 396                            data_len, board_data_size, board_ext_data_size);
 397                 return -EINVAL;
 398         }
 399
 400         ret = ath10k_bmi_write_memory(ar, board_ext_data_addr,
 401                                       data + board_data_size,
 402                                       board_ext_data_size);
 403         if (ret) {
 404                 ath10k_err(ar, "could not write board ext data (%d)\n", ret);
 405                 return ret;
 406         }
 407
 408         ret = ath10k_bmi_write32(ar, hi_board_ext_data_config,
 409                                  (board_ext_data_size << 16) | 1);
 410         if (ret) {
 411                 ath10k_err(ar, "could not write board ext data bit (%d)\n",
 412                            ret);
 413                 return ret;
 414         }
 415
 416         return 0;
 417 }
 418
 419 static int ath10k_download_board_data(struct ath10k *ar, const void *data,
 420                                       size_t data_len)
 421 {
 422         u32 board_data_size = ar->hw_params.fw.board_size;
 423         u32 address;
 424         int ret;
 425
 426         ret = ath10k_push_board_ext_data(ar, data, data_len);
 427         if (ret) {
 428                 ath10k_err(ar, "could not push board ext data (%d)\n", ret);
 429                 goto exit;
 430         }
 431
 432         ret = ath10k_bmi_read32(ar, hi_board_data, &address);
 433         if (ret) {
 434                 ath10k_err(ar, "could not read board data addr (%d)\n", ret);
 435                 goto exit;
 436         }
 437
 438         ret = ath10k_bmi_write_memory(ar, address, data,
 439                                       min_t(u32, board_data_size,
 440                                             data_len));
 441         if (ret) {
 442                 ath10k_err(ar, "could not write board data (%d)\n", ret);
 443                 goto exit;
 444         }
 445
 446         ret = ath10k_bmi_write32(ar, hi_board_data_initialized, 1);
 447         if (ret) {
 448                 ath10k_err(ar, "could not write board data bit (%d)\n", ret);
 449                 goto exit;
 450         }
 451
 452 exit:
 453         return ret;
 454 }
 455
 456 static int ath10k_download_cal_file(struct ath10k *ar,
 457                                     const struct firmware *file)
 458 {
 459         int ret;
 460
 461         if (!file)
 462                 return -ENOENT;
 463
 464         if (IS_ERR(file))
 465                 return PTR_ERR(file);
 466
 467         ret = ath10k_download_board_data(ar, file->data, file->size);
 468         if (ret) {
 469                 ath10k_err(ar, "failed to download cal_file data: %d\n", ret);
 470                 return ret;
 471         }
 472
 473         ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot cal file downloaded\n");
 474
 475         return 0;
 476 }
 477
 478 static int ath10k_download_cal_dt(struct ath10k *ar, const char *dt_name)
 479 {
 480         struct device_node *node;
 481         int data_len;
 482         void *data;
 483         int ret;
 484
 485         node = ar->dev->of_node;
 486         if (!node)
 487                 /* Device Tree is optional, don't print any warnings if
 488                  * there's no node for ath10k.
 489                  */
 490                 return -ENOENT;
 491
 492         if (!of_get_property(node, dt_name, &data_len)) {
 493                 /* The calibration data node is optional */
 494                 return -ENOENT;
 495         }
 496
 497         if (data_len != ar->hw_params.cal_data_len) {
 498                 ath10k_warn(ar, "invalid calibration data length in DT: %d\n",
 499                             data_len);
 500                 ret = -EMSGSIZE;
 501                 goto out;
 502         }
 503
 504         data = kmalloc(data_len, GFP_KERNEL);
 505         if (!data) {
 506                 ret = -ENOMEM;
 507                 goto out;
 508         }
 509
 510         ret = of_property_read_u8_array(node, dt_name, data, data_len);
 511         if (ret) {
 512                 ath10k_warn(ar, "failed to read calibration data from DT: %d\n",
 513                             ret);
 514                 goto out_free;
 515         }
 516
 517         ret = ath10k_download_board_data(ar, data, data_len);
 518         if (ret) {
 519                 ath10k_warn(ar, "failed to download calibration data from Device Tree: %d\n",
 520                             ret);
 521                 goto out_free;
 522         }
 523
 524         ret = 0;
 525
 526 out_free:
 527         kfree(data);
 528
 529 out:
 530         return ret;
 531 }
 532
 533 static int ath10k_core_get_board_id_from_otp(struct ath10k *ar)
 534 {
 535         u32 result, address;
 536         u8 board_id, chip_id;
 537         int ret;
 538
 539         address = ar->hw_params.patch_load_addr;
 540
 541         if (!ar->normal_mode_fw.fw_file.otp_data ||
 542             !ar->normal_mode_fw.fw_file.otp_len) {
 543                 ath10k_warn(ar,
 544                             "failed to retrieve board id because of invalid otp\n");
 545                 return -ENODATA;
 546         }
 547
 548         ath10k_dbg(ar, ATH10K_DBG_BOOT,
 549                    "boot upload otp to 0x%x len %zd for board id\n",
 550                    address, ar->normal_mode_fw.fw_file.otp_len);
 551
 552         ret = ath10k_bmi_fast_download(ar, address,
 553                                        ar->normal_mode_fw.fw_file.otp_data,
 554                                        ar->normal_mode_fw.fw_file.otp_len);
 555         if (ret) {
 556                 ath10k_err(ar, "could not write otp for board id check: %d\n",
 557                            ret);
 558                 return ret;
 559         }
 560
 561         ret = ath10k_bmi_execute(ar, address, BMI_PARAM_GET_EEPROM_BOARD_ID,
 562                                  &result);
 563         if (ret) {
 564                 ath10k_err(ar, "could not execute otp for board id check: %d\n",
 565                            ret);
 566                 return ret;
 567         }
 568
 569         board_id = MS(result, ATH10K_BMI_BOARD_ID_FROM_OTP);
 570         chip_id = MS(result, ATH10K_BMI_CHIP_ID_FROM_OTP);
 571
 572         ath10k_dbg(ar, ATH10K_DBG_BOOT,
 573                    "boot get otp board id result 0x%08x board_id %d chip_id %d\n",
 574                    result, board_id, chip_id);
 575
 576         if ((result & ATH10K_BMI_BOARD_ID_STATUS_MASK) != 0)
 577                 return -EOPNOTSUPP;
 578
 579         ar->id.bmi_ids_valid = true;
 580         ar->id.bmi_board_id = board_id;
 581         ar->id.bmi_chip_id = chip_id;
 582
 583         return 0;
 584 }
 585
 586 static int ath10k_download_and_run_otp(struct ath10k *ar)
 587 {
 588         u32 result, address = ar->hw_params.patch_load_addr;
 589         u32 bmi_otp_exe_param = ar->hw_params.otp_exe_param;
 590         int ret;
 591
 592         ret = ath10k_download_board_data(ar,
 593                                          ar->running_fw->board_data,
 594                                          ar->running_fw->board_len);
 595         if (ret) {
 596                 ath10k_err(ar, "failed to download board data: %d\n", ret);
 597                 return ret;
 598         }
 599
 600         /* OTP is optional */
 601
 602         if (!ar->running_fw->fw_file.otp_data ||
 603             !ar->running_fw->fw_file.otp_len) {
 604                 ath10k_warn(ar, "Not running otp, calibration will be incorrect (otp-data %p otp_len %zd)!\n",
 605                             ar->running_fw->fw_file.otp_data,
 606                             ar->running_fw->fw_file.otp_len);
 607                 return 0;
 608         }
 609
 610         ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot upload otp to 0x%x len %zd\n",
 611                    address, ar->running_fw->fw_file.otp_len);
 612
 613         ret = ath10k_bmi_fast_download(ar, address,
 614                                        ar->running_fw->fw_file.otp_data,
 615                                        ar->running_fw->fw_file.otp_len);
 616         if (ret) {
 617                 ath10k_err(ar, "could not write otp (%d)\n", ret);
 618                 return ret;
 619         }
 620
 621         ret = ath10k_bmi_execute(ar, address, bmi_otp_exe_param, &result);
 622         if (ret) {
 623                 ath10k_err(ar, "could not execute otp (%d)\n", ret);
 624                 return ret;
 625         }
 626
 627         ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot otp execute result %d\n", result);
 628
 629         if (!(skip_otp || test_bit(ATH10K_FW_FEATURE_IGNORE_OTP_RESULT,
 630                                    ar->running_fw->fw_file.fw_features)) &&
 631             result != 0) {
 632                 ath10k_err(ar, "otp calibration failed: %d", result);
 633                 return -EINVAL;
 634         }
 635
 636         return 0;
 637 }
 638
 639 static int ath10k_download_fw(struct ath10k *ar)
 640 {
 641         u32 address, data_len;
 642         const void *data;
 643         int ret;
 644
 645         address = ar->hw_params.patch_load_addr;
 646
 647         data = ar->running_fw->fw_file.firmware_data;
 648         data_len = ar->running_fw->fw_file.firmware_len;
 649
 650         ret = ath10k_swap_code_seg_configure(ar);
 651         if (ret) {
 652                 ath10k_err(ar, "failed to configure fw code swap: %d\n",
 653                            ret);
 654                 return ret;
 655         }
 656
 657         ath10k_dbg(ar, ATH10K_DBG_BOOT,
 658                    "boot uploading firmware image %p len %d\n",
 659                    data, data_len);
 660
 661         ret = ath10k_bmi_fast_download(ar, address, data, data_len);
 662         if (ret) {
 663                 ath10k_err(ar, "failed to download firmware: %d\n",
 664                            ret);
 665                 return ret;
 666         }
 667
 668         return ret;
 669 }
 670
 671 static void ath10k_core_free_board_files(struct ath10k *ar)
 672 {
 673         if (!IS_ERR(ar->normal_mode_fw.board))
 674                 release_firmware(ar->normal_mode_fw.board);
 675
 676         ar->normal_mode_fw.board = NULL;
 677         ar->normal_mode_fw.board_data = NULL;
 678         ar->normal_mode_fw.board_len = 0;
 679 }
 680
 681 static void ath10k_core_free_firmware_files(struct ath10k *ar)
 682 {
 683         if (!IS_ERR(ar->normal_mode_fw.fw_file.firmware))
 684                 release_firmware(ar->normal_mode_fw.fw_file.firmware);
 685
 686         if (!IS_ERR(ar->cal_file))
 687                 release_firmware(ar->cal_file);
 688
 689         ath10k_swap_code_seg_release(ar);
 690
 691         ar->normal_mode_fw.fw_file.otp_data = NULL;
 692         ar->normal_mode_fw.fw_file.otp_len = 0;
 693
 694         ar->normal_mode_fw.fw_file.firmware = NULL;
 695         ar->normal_mode_fw.fw_file.firmware_data = NULL;
 696         ar->normal_mode_fw.fw_file.firmware_len = 0;
 697
 698         ar->cal_file = NULL;
 699 }
 700
 701 static int ath10k_fetch_cal_file(struct ath10k *ar)
 702 {
 703         char filename[100];
 704
 705         /* pre-cal-<bus>-<id>.bin */
 706         scnprintf(filename, sizeof(filename), "pre-cal-%s-%s.bin",
 707                   ath10k_bus_str(ar->hif.bus), dev_name(ar->dev));
 708
 709         ar->pre_cal_file = ath10k_fetch_fw_file(ar, ATH10K_FW_DIR, filename);
 710         if (!IS_ERR(ar->pre_cal_file))
 711                 goto success;
 712
 713         /* cal-<bus>-<id>.bin */
 714         scnprintf(filename, sizeof(filename), "cal-%s-%s.bin",
 715                   ath10k_bus_str(ar->hif.bus), dev_name(ar->dev));
 716
 717         ar->cal_file = ath10k_fetch_fw_file(ar, ATH10K_FW_DIR, filename);
 718         if (IS_ERR(ar->cal_file))
 719                 /* calibration file is optional, don't print any warnings */
 720                 return PTR_ERR(ar->cal_file);
 721 success:
 722         ath10k_dbg(ar, ATH10K_DBG_BOOT, "found calibration file %s/%s\n",
 723                    ATH10K_FW_DIR, filename);
 724
 725         return 0;
 726 }
 727
 728 static int ath10k_core_fetch_board_data_api_1(struct ath10k *ar)
 729 {
 730         if (!ar->hw_params.fw.board) {
 731                 ath10k_err(ar, "failed to find board file fw entry\n");
 732                 return -EINVAL;
 733         }
 734
 735         ar->normal_mode_fw.board = ath10k_fetch_fw_file(ar,
 736                                                         ar->hw_params.fw.dir,
 737                                                         ar->hw_params.fw.board);
 738         if (IS_ERR(ar->normal_mode_fw.board))
 739                 return PTR_ERR(ar->normal_mode_fw.board);
 740
 741         ar->normal_mode_fw.board_data = ar->normal_mode_fw.board->data;
 742         ar->normal_mode_fw.board_len = ar->normal_mode_fw.board->size;
 743
 744         return 0;
 745 }
 746
 747 static int ath10k_core_parse_bd_ie_board(struct ath10k *ar,
 748                                          const void *buf, size_t buf_len,
 749                                          const char *boardname)
 750 {
 751         const struct ath10k_fw_ie *hdr;
 752         bool name_match_found;
 753         int ret, board_ie_id;
 754         size_t board_ie_len;
 755         const void *board_ie_data;
 756
 757         name_match_found = false;
 758
 759         /* go through ATH10K_BD_IE_BOARD_ elements */
 760         while (buf_len > sizeof(struct ath10k_fw_ie)) {
 761                 hdr = buf;
 762                 board_ie_id = le32_to_cpu(hdr->id);
 763                 board_ie_len = le32_to_cpu(hdr->len);
 764                 board_ie_data = hdr->data;
 765
 766                 buf_len -= sizeof(*hdr);
 767                 buf += sizeof(*hdr);
 768
 769                 if (buf_len < ALIGN(board_ie_len, 4)) {
 770                         ath10k_err(ar, "invalid ATH10K_BD_IE_BOARD length: %zu < %zu\n",
 771                                    buf_len, ALIGN(board_ie_len, 4));
 772                         ret = -EINVAL;
 773                         goto out;
 774                 }
 775
 776                 switch (board_ie_id) {
 777                 case ATH10K_BD_IE_BOARD_NAME:
 778                         ath10k_dbg_dump(ar, ATH10K_DBG_BOOT, "board name", "",
 779                                         board_ie_data, board_ie_len);
 780
 781                         if (board_ie_len != strlen(boardname))
 782                                 break;
 783
 784                         ret = memcmp(board_ie_data, boardname, strlen(boardname));
 785                         if (ret)
 786                                 break;
 787
 788                         name_match_found = true;
 789                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
 790                                    "boot found match for name '%s'",
 791                                    boardname);
 792                         break;
 793                 case ATH10K_BD_IE_BOARD_DATA:
 794                         if (!name_match_found)
 795                                 /* no match found */
 796                                 break;
 797
 798                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
 799                                    "boot found board data for '%s'",
 800                                    boardname);
 801
 802                         ar->normal_mode_fw.board_data = board_ie_data;
 803                         ar->normal_mode_fw.board_len = board_ie_len;
 804
 805                         ret = 0;
 806                         goto out;
 807                 default:
 808                         ath10k_warn(ar, "unknown ATH10K_BD_IE_BOARD found: %d\n",
 809                                     board_ie_id);
 810                         break;
 811                 }
 812
 813                 /* jump over the padding */
 814                 board_ie_len = ALIGN(board_ie_len, 4);
 815
 816                 buf_len -= board_ie_len;
 817                 buf += board_ie_len;
 818         }
 819
 820         /* no match found */
 821         ret = -ENOENT;
 822
 823 out:
 824         return ret;
 825 }
 826
 827 static int ath10k_core_fetch_board_data_api_n(struct ath10k *ar,
 828                                               const char *boardname,
 829                                               const char *filename)
 830 {
 831         size_t len, magic_len, ie_len;
 832         struct ath10k_fw_ie *hdr;
 833         const u8 *data;
 834         int ret, ie_id;
 835
 836         ar->normal_mode_fw.board = ath10k_fetch_fw_file(ar,
 837                                                         ar->hw_params.fw.dir,
 838                                                         filename);
 839         if (IS_ERR(ar->normal_mode_fw.board))
 840                 return PTR_ERR(ar->normal_mode_fw.board);
 841
 842         data = ar->normal_mode_fw.board->data;
 843         len = ar->normal_mode_fw.board->size;
 844
 845         /* magic has extra null byte padded */
 846         magic_len = strlen(ATH10K_BOARD_MAGIC) + 1;
 847         if (len < magic_len) {
 848                 ath10k_err(ar, "failed to find magic value in %s/%s, file too short: %zu\n",
 849                            ar->hw_params.fw.dir, filename, len);
 850                 ret = -EINVAL;
 851                 goto err;
 852         }
 853
 854         if (memcmp(data, ATH10K_BOARD_MAGIC, magic_len)) {
 855                 ath10k_err(ar, "found invalid board magic\n");
 856                 ret = -EINVAL;
 857                 goto err;
 858         }
 859
 860         /* magic is padded to 4 bytes */
 861         magic_len = ALIGN(magic_len, 4);
 862         if (len < magic_len) {
 863                 ath10k_err(ar, "failed: %s/%s too small to contain board data, len: %zu\n",
 864                            ar->hw_params.fw.dir, filename, len);
 865                 ret = -EINVAL;
 866                 goto err;
 867         }
 868
 869         data += magic_len;
 870         len -= magic_len;
 871
 872         while (len > sizeof(struct ath10k_fw_ie)) {
 873                 hdr = (struct ath10k_fw_ie *)data;
 874                 ie_id = le32_to_cpu(hdr->id);
 875                 ie_len = le32_to_cpu(hdr->len);
 876
 877                 len -= sizeof(*hdr);
 878                 data = hdr->data;
 879
 880                 if (len < ALIGN(ie_len, 4)) {
 881                         ath10k_err(ar, "invalid length for board ie_id %d ie_len %zu len %zu\n",
 882                                    ie_id, ie_len, len);
 883                         ret = -EINVAL;
 884                         goto err;
 885                 }
 886
 887                 switch (ie_id) {
 888                 case ATH10K_BD_IE_BOARD:
 889                         ret = ath10k_core_parse_bd_ie_board(ar, data, ie_len,
 890                                                             boardname);
 891                         if (ret == -ENOENT)
 892                                 /* no match found, continue */
 893                                 break;
 894                         else if (ret)
 895                                 /* there was an error, bail out */
 896                                 goto err;
 897
 898                         /* board data found */
 899                         goto out;
 900                 }
 901
 902                 /* jump over the padding */
 903                 ie_len = ALIGN(ie_len, 4);
 904
 905                 len -= ie_len;
 906                 data += ie_len;
 907         }
 908
 909 out:
 910         if (!ar->normal_mode_fw.board_data || !ar->normal_mode_fw.board_len) {
 911                 ath10k_err(ar,
 912                            "failed to fetch board data for %s from %s/%s\n",
 913                            boardname, ar->hw_params.fw.dir, filename);
 914                 ret = -ENODATA;
 915                 goto err;
 916         }
 917
 918         return 0;
 919
 920 err:
 921         ath10k_core_free_board_files(ar);
 922         return ret;
 923 }
 924
 925 static int ath10k_core_create_board_name(struct ath10k *ar, char *name,
 926                                          size_t name_len)
 927 {
 928         if (ar->id.bmi_ids_valid) {
 929                 scnprintf(name, name_len,
 930                           "bus=%s,bmi-chip-id=%d,bmi-board-id=%d",
 931                           ath10k_bus_str(ar->hif.bus),
 932                           ar->id.bmi_chip_id,
 933                           ar->id.bmi_board_id);
 934                 goto out;
 935         }
 936
 937         scnprintf(name, name_len,
 938                   "bus=%s,vendor=%04x,device=%04x,subsystem-vendor=%04x,subsystem-device=%04x",
 939                   ath10k_bus_str(ar->hif.bus),
 940                   ar->id.vendor, ar->id.device,
 941                   ar->id.subsystem_vendor, ar->id.subsystem_device);
 942
 943 out:
 944         ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot using board name '%s'\n", name);
 945
 946         return 0;
 947 }
 948
 949 static int ath10k_core_fetch_board_file(struct ath10k *ar)
 950 {
 951         char boardname[100];
 952         int ret;
 953
 954         ret = ath10k_core_create_board_name(ar, boardname, sizeof(boardname));
 955         if (ret) {
 956                 ath10k_err(ar, "failed to create board name: %d", ret);
 957                 return ret;
 958         }
 959
 960         ar->bd_api = 2;
 961         ret = ath10k_core_fetch_board_data_api_n(ar, boardname,
 962                                                  ATH10K_BOARD_API2_FILE);
 963         if (!ret)
 964                 goto success;
 965
 966         ar->bd_api = 1;
 967         ret = ath10k_core_fetch_board_data_api_1(ar);
 968         if (ret) {
 969                 ath10k_err(ar, "failed to fetch board data\n");
 970                 return ret;
 971         }
 972
 973 success:
 974         ath10k_dbg(ar, ATH10K_DBG_BOOT, "using board api %d\n", ar->bd_api);
 975         return 0;
 976 }
 977
 978 int ath10k_core_fetch_firmware_api_n(struct ath10k *ar, const char *name,
 979                                      struct ath10k_fw_file *fw_file)
 980 {
 981         size_t magic_len, len, ie_len;
 982         int ie_id, i, index, bit, ret;
 983         struct ath10k_fw_ie *hdr;
 984         const u8 *data;
 985         __le32 *timestamp, *version;
 986
 987         /* first fetch the firmware file (firmware-*.bin) */
 988         fw_file->firmware = ath10k_fetch_fw_file(ar, ar->hw_params.fw.dir,
 989                                                  name);
 990         if (IS_ERR(fw_file->firmware)) {
 991                 ath10k_err(ar, "could not fetch firmware file '%s/%s': %ld\n",
 992                            ar->hw_params.fw.dir, name,
 993                            PTR_ERR(fw_file->firmware));
 994                 return PTR_ERR(fw_file->firmware);
 995         }
 996
 997         data = fw_file->firmware->data;
 998         len = fw_file->firmware->size;
 999
1000         /* magic also includes the null byte, check that as well */
1001         magic_len = strlen(ATH10K_FIRMWARE_MAGIC) + 1;
1002
1003         if (len < magic_len) {
1004                 ath10k_err(ar, "firmware file '%s/%s' too small to contain magic: %zu\n",
1005                            ar->hw_params.fw.dir, name, len);
1006                 ret = -EINVAL;
1007                 goto err;
1008         }
1009
1010         if (memcmp(data, ATH10K_FIRMWARE_MAGIC, magic_len) != 0) {
1011                 ath10k_err(ar, "invalid firmware magic\n");
1012                 ret = -EINVAL;
1013                 goto err;
1014         }
1015
1016         /* jump over the padding */
1017         magic_len = ALIGN(magic_len, 4);
1018
1019         len -= magic_len;
1020         data += magic_len;
1021
1022         /* loop elements */
1023         while (len > sizeof(struct ath10k_fw_ie)) {
1024                 hdr = (struct ath10k_fw_ie *)data;
1025
1026                 ie_id = le32_to_cpu(hdr->id);
1027                 ie_len = le32_to_cpu(hdr->len);
1028
1029                 len -= sizeof(*hdr);
1030                 data += sizeof(*hdr);
1031
1032                 if (len < ie_len) {
1033                         ath10k_err(ar, "invalid length for FW IE %d (%zu < %zu)\n",
1034                                    ie_id, len, ie_len);
1035                         ret = -EINVAL;
1036                         goto err;
1037                 }
1038
1039                 switch (ie_id) {
1040                 case ATH10K_FW_IE_FW_VERSION:
1041                         if (ie_len > sizeof(fw_file->fw_version) - 1)
1042                                 break;
1043
1044                         memcpy(fw_file->fw_version, data, ie_len);
1045                         fw_file->fw_version[ie_len] = '\0';
1046
1047                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1048                                    "found fw version %s\n",
1049                                     fw_file->fw_version);
1050                         break;
1051                 case ATH10K_FW_IE_TIMESTAMP:
1052                         if (ie_len != sizeof(u32))
1053                                 break;
1054
1055                         timestamp = (__le32 *)data;
1056
1057                         ath10k_dbg(ar, ATH10K_DBG_BOOT, "found fw timestamp %d\n",
1058                                    le32_to_cpup(timestamp));
1059                         break;
1060                 case ATH10K_FW_IE_FEATURES:
1061                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1062                                    "found firmware features ie (%zd B)\n",
1063                                    ie_len);
1064
1065                         for (i = 0; i < ATH10K_FW_FEATURE_COUNT; i++) {
1066                                 index = i / 8;
1067                                 bit = i % 8;
1068
1069                                 if (index == ie_len)
1070                                         break;
1071
1072                                 if (data[index] & (1 << bit)) {
1073                                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1074                                                    "Enabling feature bit: %i\n",
1075                                                    i);
1076                                         __set_bit(i, fw_file->fw_features);
1077                                 }
1078                         }
1079
1080                         ath10k_dbg_dump(ar, ATH10K_DBG_BOOT, "features", "",
1081                                         ar->running_fw->fw_file.fw_features,
1082                                         sizeof(fw_file->fw_features));
1083                         break;
1084                 case ATH10K_FW_IE_FW_IMAGE:
1085                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1086                                    "found fw image ie (%zd B)\n",
1087                                    ie_len);
1088
1089                         fw_file->firmware_data = data;
1090                         fw_file->firmware_len = ie_len;
1091
1092                         break;
1093                 case ATH10K_FW_IE_OTP_IMAGE:
1094                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1095                                    "found otp image ie (%zd B)\n",
1096                                    ie_len);
1097
1098                         fw_file->otp_data = data;
1099                         fw_file->otp_len = ie_len;
1100
1101                         break;
1102                 case ATH10K_FW_IE_WMI_OP_VERSION:
1103                         if (ie_len != sizeof(u32))
1104                                 break;
1105
1106                         version = (__le32 *)data;
1107
1108                         fw_file->wmi_op_version = le32_to_cpup(version);
1109
1110                         ath10k_dbg(ar, ATH10K_DBG_BOOT, "found fw ie wmi op version %d\n",
1111                                    fw_file->wmi_op_version);
1112                         break;
1113                 case ATH10K_FW_IE_HTT_OP_VERSION:
1114                         if (ie_len != sizeof(u32))
1115                                 break;
1116
1117                         version = (__le32 *)data;
1118
1119                         fw_file->htt_op_version = le32_to_cpup(version);
1120
1121                         ath10k_dbg(ar, ATH10K_DBG_BOOT, "found fw ie htt op version %d\n",
1122                                    fw_file->htt_op_version);
1123                         break;
1124                 case ATH10K_FW_IE_FW_CODE_SWAP_IMAGE:
1125                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1126                                    "found fw code swap image ie (%zd B)\n",
1127                                    ie_len);
1128                         fw_file->codeswap_data = data;
1129                         fw_file->codeswap_len = ie_len;
1130                         break;
1131                 default:
1132                         ath10k_warn(ar, "Unknown FW IE: %u\n",
1133                                     le32_to_cpu(hdr->id));
1134                         break;
1135                 }
1136
1137                 /* jump over the padding */
1138                 ie_len = ALIGN(ie_len, 4);
1139
1140                 len -= ie_len;
1141                 data += ie_len;
1142         }
1143
1144         if (!fw_file->firmware_data ||
1145             !fw_file->firmware_len) {
1146                 ath10k_warn(ar, "No ATH10K_FW_IE_FW_IMAGE found from '%s/%s', skipping\n",
1147                             ar->hw_params.fw.dir, name);
1148                 ret = -ENOMEDIUM;
1149                 goto err;
1150         }
1151
1152         return 0;
1153
1154 err:
1155         ath10k_core_free_firmware_files(ar);
1156         return ret;
1157 }
1158
1159 static int ath10k_core_fetch_firmware_files(struct ath10k *ar)
1160 {
1161         int ret;
1162
1163         /* calibration file is optional, don't check for any errors */
1164         ath10k_fetch_cal_file(ar);
1165
1166         ar->fw_api = 5;
1167         ath10k_dbg(ar, ATH10K_DBG_BOOT, "trying fw api %d\n", ar->fw_api);
1168
1169         ret = ath10k_core_fetch_firmware_api_n(ar, ATH10K_FW_API5_FILE,
1170                                                &ar->normal_mode_fw.fw_file);
1171         if (ret == 0)
1172                 goto success;
1173
1174         ar->fw_api = 4;
1175         ath10k_dbg(ar, ATH10K_DBG_BOOT, "trying fw api %d\n", ar->fw_api);
1176
1177         ret = ath10k_core_fetch_firmware_api_n(ar, ATH10K_FW_API4_FILE,
1178                                                &ar->normal_mode_fw.fw_file);
1179         if (ret == 0)
1180                 goto success;
1181
1182         ar->fw_api = 3;
1183         ath10k_dbg(ar, ATH10K_DBG_BOOT, "trying fw api %d\n", ar->fw_api);
1184
1185         ret = ath10k_core_fetch_firmware_api_n(ar, ATH10K_FW_API3_FILE,
1186                                                &ar->normal_mode_fw.fw_file);
1187         if (ret == 0)
1188                 goto success;
1189
1190         ar->fw_api = 2;
1191         ath10k_dbg(ar, ATH10K_DBG_BOOT, "trying fw api %d\n", ar->fw_api);
1192
1193         ret = ath10k_core_fetch_firmware_api_n(ar, ATH10K_FW_API2_FILE,
1194                                                &ar->normal_mode_fw.fw_file);
1195         if (ret)
1196                 return ret;
1197
1198 success:
1199         ath10k_dbg(ar, ATH10K_DBG_BOOT, "using fw api %d\n", ar->fw_api);
1200
1201         return 0;
1202 }
1203
1204 static int ath10k_core_pre_cal_download(struct ath10k *ar)
1205 {
1206         int ret;
1207
1208         ret = ath10k_download_cal_file(ar, ar->pre_cal_file);
1209         if (ret == 0) {
1210                 ar->cal_mode = ATH10K_PRE_CAL_MODE_FILE;
1211                 goto success;
1212         }
1213
1214         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1215                    "boot did not find a pre calibration file, try DT next: %d\n",
1216                    ret);
1217
1218         ret = ath10k_download_cal_dt(ar, "qcom,ath10k-pre-calibration-data");
1219         if (ret) {
1220                 ath10k_dbg(ar, ATH10K_DBG_BOOT,
1221                            "unable to load pre cal data from DT: %d\n", ret);
1222                 return ret;
1223         }
1224         ar->cal_mode = ATH10K_PRE_CAL_MODE_DT;
1225
1226 success:
1227         ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot using calibration mode %s\n",
1228                    ath10k_cal_mode_str(ar->cal_mode));
1229
1230         return 0;
1231 }
1232
1233 static int ath10k_core_pre_cal_config(struct ath10k *ar)
1234 {
1235         int ret;
1236
1237         ret = ath10k_core_pre_cal_download(ar);
1238         if (ret) {
1239                 ath10k_dbg(ar, ATH10K_DBG_BOOT,
1240                            "failed to load pre cal data: %d\n", ret);
1241                 return ret;
1242         }
1243
1244         ret = ath10k_core_get_board_id_from_otp(ar);
1245         if (ret) {
1246                 ath10k_err(ar, "failed to get board id: %d\n", ret);
1247                 return ret;
1248         }
1249
1250         ret = ath10k_download_and_run_otp(ar);
1251         if (ret) {
1252                 ath10k_err(ar, "failed to run otp: %d\n", ret);
1253                 return ret;
1254         }
1255
1256         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1257                    "pre cal configuration done successfully\n");
1258
1259         return 0;
1260 }
1261
1262 static int ath10k_download_cal_data(struct ath10k *ar)
1263 {
1264         int ret;
1265
1266         ret = ath10k_core_pre_cal_config(ar);
1267         if (ret == 0)
1268                 return 0;
1269
1270         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1271                    "pre cal download procedure failed, try cal file: %d\n",
1272                    ret);
1273
1274         ret = ath10k_download_cal_file(ar, ar->cal_file);
1275         if (ret == 0) {
1276                 ar->cal_mode = ATH10K_CAL_MODE_FILE;
1277                 goto done;
1278         }
1279
1280         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1281                    "boot did not find a calibration file, try DT next: %d\n",
1282                    ret);
1283
1284         ret = ath10k_download_cal_dt(ar, "qcom,ath10k-calibration-data");
1285         if (ret == 0) {
1286                 ar->cal_mode = ATH10K_CAL_MODE_DT;
1287                 goto done;
1288         }
1289
1290         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1291                    "boot did not find DT entry, try OTP next: %d\n",
1292                    ret);
1293
1294         ret = ath10k_download_and_run_otp(ar);
1295         if (ret) {
1296                 ath10k_err(ar, "failed to run otp: %d\n", ret);
1297                 return ret;
1298         }
1299
1300         ar->cal_mode = ATH10K_CAL_MODE_OTP;
1301
1302 done:
1303         ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot using calibration mode %s\n",
1304                    ath10k_cal_mode_str(ar->cal_mode));
1305         return 0;
1306 }
1307
1308 static int ath10k_init_uart(struct ath10k *ar)
1309 {
1310         int ret;
1311
1312         /*
1313          * Explicitly setting UART prints to zero as target turns it on
1314          * based on scratch registers.
1315          */
1316         ret = ath10k_bmi_write32(ar, hi_serial_enable, 0);
1317         if (ret) {
1318                 ath10k_warn(ar, "could not disable UART prints (%d)\n", ret);
1319                 return ret;
1320         }
1321
1322         if (!uart_print)
1323                 return 0;
1324
1325         ret = ath10k_bmi_write32(ar, hi_dbg_uart_txpin, ar->hw_params.uart_pin);
1326         if (ret) {
1327                 ath10k_warn(ar, "could not enable UART prints (%d)\n", ret);
1328                 return ret;
1329         }
1330
1331         ret = ath10k_bmi_write32(ar, hi_serial_enable, 1);
1332         if (ret) {
1333                 ath10k_warn(ar, "could not enable UART prints (%d)\n", ret);
1334                 return ret;
1335         }
1336
1337         /* Set the UART baud rate to 19200. */
1338         ret = ath10k_bmi_write32(ar, hi_desired_baud_rate, 19200);
1339         if (ret) {
1340                 ath10k_warn(ar, "could not set the baud rate (%d)\n", ret);
1341                 return ret;
1342         }
1343
1344         ath10k_info(ar, "UART prints enabled\n");
1345         return 0;
1346 }
1347
1348 static int ath10k_init_hw_params(struct ath10k *ar)
1349 {
1350         const struct ath10k_hw_params *uninitialized_var(hw_params);
1351         int i;
1352
1353         for (i = 0; i < ARRAY_SIZE(ath10k_hw_params_list); i++) {
1354                 hw_params = &ath10k_hw_params_list[i];
1355
1356                 if (hw_params->id == ar->target_version &&
1357                     hw_params->dev_id == ar->dev_id)
1358                         break;
1359         }
1360
1361         if (i == ARRAY_SIZE(ath10k_hw_params_list)) {
1362                 ath10k_err(ar, "Unsupported hardware version: 0x%x\n",
1363                            ar->target_version);
1364                 return -EINVAL;
1365         }
1366
1367         ar->hw_params = *hw_params;
1368
1369         ath10k_dbg(ar, ATH10K_DBG_BOOT, "Hardware name %s version 0x%x\n",
1370                    ar->hw_params.name, ar->target_version);
1371
1372         return 0;
1373 }
1374
1375 static void ath10k_core_restart(struct work_struct *work)
1376 {
1377         struct ath10k *ar = container_of(work, struct ath10k, restart_work);
1378
1379         set_bit(ATH10K_FLAG_CRASH_FLUSH, &ar->dev_flags);
1380
1381         /* Place a barrier to make sure the compiler doesn't reorder
1382          * CRASH_FLUSH and calling other functions.
1383          */
1384         barrier();
1385
1386         ieee80211_stop_queues(ar->hw);
1387         ath10k_drain_tx(ar);
1388         complete_all(&ar->scan.started);
1389         complete_all(&ar->scan.completed);
1390         complete_all(&ar->scan.on_channel);
1391         complete_all(&ar->offchan_tx_completed);
1392         complete_all(&ar->install_key_done);
1393         complete_all(&ar->vdev_setup_done);
1394         complete_all(&ar->thermal.wmi_sync);
1395         wake_up(&ar->htt.empty_tx_wq);
1396         wake_up(&ar->wmi.tx_credits_wq);
1397         wake_up(&ar->peer_mapping_wq);
1398
1399         mutex_lock(&ar->conf_mutex);
1400
1401         switch (ar->state) {
1402         case ATH10K_STATE_ON:
1403                 ar->state = ATH10K_STATE_RESTARTING;
1404                 ath10k_hif_stop(ar);
1405                 ath10k_scan_finish(ar);
1406                 ieee80211_restart_hw(ar->hw);
1407                 break;
1408         case ATH10K_STATE_OFF:
1409                 /* this can happen if driver is being unloaded
1410                  * or if the crash happens during FW probing */
1411                 ath10k_warn(ar, "cannot restart a device that hasn't been started\n");
1412                 break;
1413         case ATH10K_STATE_RESTARTING:
1414                 /* hw restart might be requested from multiple places */
1415                 break;
1416         case ATH10K_STATE_RESTARTED:
1417                 ar->state = ATH10K_STATE_WEDGED;
1418                 /* fall through */
1419         case ATH10K_STATE_WEDGED:
1420                 ath10k_warn(ar, "device is wedged, will not restart\n");
1421                 break;
1422         case ATH10K_STATE_UTF:
1423                 ath10k_warn(ar, "firmware restart in UTF mode not supported\n");
1424                 break;
1425         }
1426
1427         mutex_unlock(&ar->conf_mutex);
1428 }
1429
1430 static int ath10k_core_init_firmware_features(struct ath10k *ar)
1431 {
1432         struct ath10k_fw_file *fw_file = &ar->normal_mode_fw.fw_file;
1433
1434         if (test_bit(ATH10K_FW_FEATURE_WMI_10_2, fw_file->fw_features) &&
1435             !test_bit(ATH10K_FW_FEATURE_WMI_10X, fw_file->fw_features)) {
1436                 ath10k_err(ar, "feature bits corrupted: 10.2 feature requires 10.x feature to be set as well");
1437                 return -EINVAL;
1438         }
1439
1440         if (fw_file->wmi_op_version >= ATH10K_FW_WMI_OP_VERSION_MAX) {
1441                 ath10k_err(ar, "unsupported WMI OP version (max %d): %d\n",
1442                            ATH10K_FW_WMI_OP_VERSION_MAX, fw_file->wmi_op_version);
1443                 return -EINVAL;
1444         }
1445
1446         ar->wmi.rx_decap_mode = ATH10K_HW_TXRX_NATIVE_WIFI;
1447         switch (ath10k_cryptmode_param) {
1448         case ATH10K_CRYPT_MODE_HW:
1449                 clear_bit(ATH10K_FLAG_RAW_MODE, &ar->dev_flags);
1450                 clear_bit(ATH10K_FLAG_HW_CRYPTO_DISABLED, &ar->dev_flags);
1451                 break;
1452         case ATH10K_CRYPT_MODE_SW:
1453                 if (!test_bit(ATH10K_FW_FEATURE_RAW_MODE_SUPPORT,
1454                               fw_file->fw_features)) {
1455                         ath10k_err(ar, "cryptmode > 0 requires raw mode support from firmware");
1456                         return -EINVAL;
1457                 }
1458
1459                 set_bit(ATH10K_FLAG_RAW_MODE, &ar->dev_flags);
1460                 set_bit(ATH10K_FLAG_HW_CRYPTO_DISABLED, &ar->dev_flags);
1461                 break;
1462         default:
1463                 ath10k_info(ar, "invalid cryptmode: %d\n",
1464                             ath10k_cryptmode_param);
1465                 return -EINVAL;
1466         }
1467
1468         ar->htt.max_num_amsdu = ATH10K_HTT_MAX_NUM_AMSDU_DEFAULT;
1469         ar->htt.max_num_ampdu = ATH10K_HTT_MAX_NUM_AMPDU_DEFAULT;
1470
1471         if (rawmode) {
1472                 if (!test_bit(ATH10K_FW_FEATURE_RAW_MODE_SUPPORT,
1473                               fw_file->fw_features)) {
1474                         ath10k_err(ar, "rawmode = 1 requires support from firmware");
1475                         return -EINVAL;
1476                 }
1477                 set_bit(ATH10K_FLAG_RAW_MODE, &ar->dev_flags);
1478         }
1479
1480         if (test_bit(ATH10K_FLAG_RAW_MODE, &ar->dev_flags)) {
1481                 ar->wmi.rx_decap_mode = ATH10K_HW_TXRX_RAW;
1482
1483                 /* Workaround:
1484                  *
1485                  * Firmware A-MSDU aggregation breaks with RAW Tx encap mode
1486                  * and causes enormous performance issues (malformed frames,
1487                  * etc).
1488                  *
1489                  * Disabling A-MSDU makes RAW mode stable with heavy traffic
1490                  * albeit a bit slower compared to regular operation.
1491                  */
1492                 ar->htt.max_num_amsdu = 1;
1493         }
1494
1495         /* Backwards compatibility for firmwares without
1496          * ATH10K_FW_IE_WMI_OP_VERSION.
1497          */
1498         if (fw_file->wmi_op_version == ATH10K_FW_WMI_OP_VERSION_UNSET) {
1499                 if (test_bit(ATH10K_FW_FEATURE_WMI_10X, fw_file->fw_features)) {
1500                         if (test_bit(ATH10K_FW_FEATURE_WMI_10_2,
1501                                      fw_file->fw_features))
1502                                 fw_file->wmi_op_version = ATH10K_FW_WMI_OP_VERSION_10_2;
1503                         else
1504                                 fw_file->wmi_op_version = ATH10K_FW_WMI_OP_VERSION_10_1;
1505                 } else {
1506                         fw_file->wmi_op_version = ATH10K_FW_WMI_OP_VERSION_MAIN;
1507                 }
1508         }
1509
1510         switch (fw_file->wmi_op_version) {
1511         case ATH10K_FW_WMI_OP_VERSION_MAIN:
1512                 ar->max_num_peers = TARGET_NUM_PEERS;
1513                 ar->max_num_stations = TARGET_NUM_STATIONS;
1514                 ar->max_num_vdevs = TARGET_NUM_VDEVS;
1515                 ar->htt.max_num_pending_tx = TARGET_NUM_MSDU_DESC;
1516                 ar->fw_stats_req_mask = WMI_STAT_PDEV | WMI_STAT_VDEV |
1517                         WMI_STAT_PEER;
1518                 ar->max_spatial_stream = WMI_MAX_SPATIAL_STREAM;
1519                 break;
1520         case ATH10K_FW_WMI_OP_VERSION_10_1:
1521         case ATH10K_FW_WMI_OP_VERSION_10_2:
1522         case ATH10K_FW_WMI_OP_VERSION_10_2_4:
1523                 if (ath10k_peer_stats_enabled(ar)) {
1524                         ar->max_num_peers = TARGET_10X_TX_STATS_NUM_PEERS;
1525                         ar->max_num_stations = TARGET_10X_TX_STATS_NUM_STATIONS;
1526                 } else {
1527                         ar->max_num_peers = TARGET_10X_NUM_PEERS;
1528                         ar->max_num_stations = TARGET_10X_NUM_STATIONS;
1529                 }
1530                 ar->max_num_vdevs = TARGET_10X_NUM_VDEVS;
1531                 ar->htt.max_num_pending_tx = TARGET_10X_NUM_MSDU_DESC;
1532                 ar->fw_stats_req_mask = WMI_STAT_PEER;
1533                 ar->max_spatial_stream = WMI_MAX_SPATIAL_STREAM;
1534                 break;
1535         case ATH10K_FW_WMI_OP_VERSION_TLV:
1536                 ar->max_num_peers = TARGET_TLV_NUM_PEERS;
1537                 ar->max_num_stations = TARGET_TLV_NUM_STATIONS;
1538                 ar->max_num_vdevs = TARGET_TLV_NUM_VDEVS;
1539                 ar->max_num_tdls_vdevs = TARGET_TLV_NUM_TDLS_VDEVS;
1540                 ar->htt.max_num_pending_tx = TARGET_TLV_NUM_MSDU_DESC;
1541                 ar->wow.max_num_patterns = TARGET_TLV_NUM_WOW_PATTERNS;
1542                 ar->fw_stats_req_mask = WMI_STAT_PDEV | WMI_STAT_VDEV |
1543                         WMI_STAT_PEER;
1544                 ar->max_spatial_stream = WMI_MAX_SPATIAL_STREAM;
1545                 break;
1546         case ATH10K_FW_WMI_OP_VERSION_10_4:
1547                 ar->max_num_peers = TARGET_10_4_NUM_PEERS;
1548                 ar->max_num_stations = TARGET_10_4_NUM_STATIONS;
1549                 ar->num_active_peers = TARGET_10_4_ACTIVE_PEERS;
1550                 ar->max_num_vdevs = TARGET_10_4_NUM_VDEVS;
1551                 ar->num_tids = TARGET_10_4_TGT_NUM_TIDS;
1552                 ar->fw_stats_req_mask = WMI_10_4_STAT_PEER |
1553                                         WMI_10_4_STAT_PEER_EXTD;
1554                 ar->max_spatial_stream = ar->hw_params.max_spatial_stream;
1555
1556                 if (test_bit(ATH10K_FW_FEATURE_PEER_FLOW_CONTROL,
1557                              fw_file->fw_features))
1558                         ar->htt.max_num_pending_tx = TARGET_10_4_NUM_MSDU_DESC_PFC;
1559                 else
1560                         ar->htt.max_num_pending_tx = TARGET_10_4_NUM_MSDU_DESC;
1561                 break;
1562         case ATH10K_FW_WMI_OP_VERSION_UNSET:
1563         case ATH10K_FW_WMI_OP_VERSION_MAX:
1564                 WARN_ON(1);
1565                 return -EINVAL;
1566         }
1567
1568         /* Backwards compatibility for firmwares without
1569          * ATH10K_FW_IE_HTT_OP_VERSION.
1570          */
1571         if (fw_file->htt_op_version == ATH10K_FW_HTT_OP_VERSION_UNSET) {
1572                 switch (fw_file->wmi_op_version) {
1573                 case ATH10K_FW_WMI_OP_VERSION_MAIN:
1574                         fw_file->htt_op_version = ATH10K_FW_HTT_OP_VERSION_MAIN;
1575                         break;
1576                 case ATH10K_FW_WMI_OP_VERSION_10_1:
1577                 case ATH10K_FW_WMI_OP_VERSION_10_2:
1578                 case ATH10K_FW_WMI_OP_VERSION_10_2_4:
1579                         fw_file->htt_op_version = ATH10K_FW_HTT_OP_VERSION_10_1;
1580                         break;
1581                 case ATH10K_FW_WMI_OP_VERSION_TLV:
1582                         fw_file->htt_op_version = ATH10K_FW_HTT_OP_VERSION_TLV;
1583                         break;
1584                 case ATH10K_FW_WMI_OP_VERSION_10_4:
1585                 case ATH10K_FW_WMI_OP_VERSION_UNSET:
1586                 case ATH10K_FW_WMI_OP_VERSION_MAX:
1587                         WARN_ON(1);
1588                         return -EINVAL;
1589                 }
1590         }
1591
1592         return 0;
1593 }
1594
1595 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode,
1596                       const struct ath10k_fw_components *fw)
1597 {
1598         int status;
1599         u32 val;
1600
1601         lockdep_assert_held(&ar->conf_mutex);
1602
1603         clear_bit(ATH10K_FLAG_CRASH_FLUSH, &ar->dev_flags);
1604
1605         ar->running_fw = fw;
1606
1607         ath10k_bmi_start(ar);
1608
1609         if (ath10k_init_configure_target(ar)) {
1610                 status = -EINVAL;
1611                 goto err;
1612         }
1613
1614         status = ath10k_download_cal_data(ar);
1615         if (status)
1616                 goto err;
1617
1618         /* Some of of qca988x solutions are having global reset issue
1619          * during target initialization. Bypassing PLL setting before
1620          * downloading firmware and letting the SoC run on REF_CLK is
1621          * fixing the problem. Corresponding firmware change is also needed
1622          * to set the clock source once the target is initialized.
1623          */
1624         if (test_bit(ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT,
1625                      ar->running_fw->fw_file.fw_features)) {
1626                 status = ath10k_bmi_write32(ar, hi_skip_clock_init, 1);
1627                 if (status) {
1628                         ath10k_err(ar, "could not write to skip_clock_init: %d\n",
1629                                    status);
1630                         goto err;
1631                 }
1632         }
1633
1634         status = ath10k_download_fw(ar);
1635         if (status)
1636                 goto err;
1637
1638         status = ath10k_init_uart(ar);
1639         if (status)
1640                 goto err;
1641
1642         ar->htc.htc_ops.target_send_suspend_complete =
1643                 ath10k_send_suspend_complete;
1644
1645         status = ath10k_htc_init(ar);
1646         if (status) {
1647                 ath10k_err(ar, "could not init HTC (%d)\n", status);
1648                 goto err;
1649         }
1650
1651         status = ath10k_bmi_done(ar);
1652         if (status)
1653                 goto err;
1654
1655         status = ath10k_wmi_attach(ar);
1656         if (status) {
1657                 ath10k_err(ar, "WMI attach failed: %d\n", status);
1658                 goto err;
1659         }
1660
1661         status = ath10k_htt_init(ar);
1662         if (status) {
1663                 ath10k_err(ar, "failed to init htt: %d\n", status);
1664                 goto err_wmi_detach;
1665         }
1666
1667         status = ath10k_htt_tx_alloc(&ar->htt);
1668         if (status) {
1669                 ath10k_err(ar, "failed to alloc htt tx: %d\n", status);
1670                 goto err_wmi_detach;
1671         }
1672
1673         status = ath10k_htt_rx_alloc(&ar->htt);
1674         if (status) {
1675                 ath10k_err(ar, "failed to alloc htt rx: %d\n", status);
1676                 goto err_htt_tx_detach;
1677         }
1678
1679         status = ath10k_hif_start(ar);
1680         if (status) {
1681                 ath10k_err(ar, "could not start HIF: %d\n", status);
1682                 goto err_htt_rx_detach;
1683         }
1684
1685         status = ath10k_htc_wait_target(&ar->htc);
1686         if (status) {
1687                 ath10k_err(ar, "failed to connect to HTC: %d\n", status);
1688                 goto err_hif_stop;
1689         }
1690
1691         if (mode == ATH10K_FIRMWARE_MODE_NORMAL) {
1692                 status = ath10k_htt_connect(&ar->htt);
1693                 if (status) {
1694                         ath10k_err(ar, "failed to connect htt (%d)\n", status);
1695                         goto err_hif_stop;
1696                 }
1697         }
1698
1699         status = ath10k_wmi_connect(ar);
1700         if (status) {
1701                 ath10k_err(ar, "could not connect wmi: %d\n", status);
1702                 goto err_hif_stop;
1703         }
1704
1705         status = ath10k_htc_start(&ar->htc);
1706         if (status) {
1707                 ath10k_err(ar, "failed to start htc: %d\n", status);
1708                 goto err_hif_stop;
1709         }
1710
1711         if (mode == ATH10K_FIRMWARE_MODE_NORMAL) {
1712                 status = ath10k_wmi_wait_for_service_ready(ar);
1713                 if (status) {
1714                         ath10k_warn(ar, "wmi service ready event not received");
1715                         goto err_hif_stop;
1716                 }
1717         }
1718
1719         ath10k_dbg(ar, ATH10K_DBG_BOOT, "firmware %s booted\n",
1720                    ar->hw->wiphy->fw_version);
1721
1722         if (test_bit(WMI_SERVICE_EXT_RES_CFG_SUPPORT, ar->wmi.svc_map)) {
1723                 val = 0;
1724                 if (ath10k_peer_stats_enabled(ar))
1725                         val = WMI_10_4_PEER_STATS;
1726
1727                 status = ath10k_mac_ext_resource_config(ar, val);
1728                 if (status) {
1729                         ath10k_err(ar,
1730                                    "failed to send ext resource cfg command : %d\n",
1731                                    status);
1732                         goto err_hif_stop;
1733                 }
1734         }
1735
1736         status = ath10k_wmi_cmd_init(ar);
1737         if (status) {
1738                 ath10k_err(ar, "could not send WMI init command (%d)\n",
1739                            status);
1740                 goto err_hif_stop;
1741         }
1742
1743         status = ath10k_wmi_wait_for_unified_ready(ar);
1744         if (status) {
1745                 ath10k_err(ar, "wmi unified ready event not received\n");
1746                 goto err_hif_stop;
1747         }
1748
1749         /* If firmware indicates Full Rx Reorder support it must be used in a
1750          * slightly different manner. Let HTT code know.
1751          */
1752         ar->htt.rx_ring.in_ord_rx = !!(test_bit(WMI_SERVICE_RX_FULL_REORDER,
1753                                                 ar->wmi.svc_map));
1754
1755         status = ath10k_htt_rx_ring_refill(ar);
1756         if (status) {
1757                 ath10k_err(ar, "failed to refill htt rx ring: %d\n", status);
1758                 goto err_hif_stop;
1759         }
1760
1761         /* we don't care about HTT in UTF mode */
1762         if (mode == ATH10K_FIRMWARE_MODE_NORMAL) {
1763                 status = ath10k_htt_setup(&ar->htt);
1764                 if (status) {
1765                         ath10k_err(ar, "failed to setup htt: %d\n", status);
1766                         goto err_hif_stop;
1767                 }
1768         }
1769
1770         status = ath10k_debug_start(ar);
1771         if (status)
1772                 goto err_hif_stop;
1773
1774         ar->free_vdev_map = (1LL << ar->max_num_vdevs) - 1;
1775
1776         INIT_LIST_HEAD(&ar->arvifs);
1777
1778         return 0;
1779
1780 err_hif_stop:
1781         ath10k_hif_stop(ar);
1782 err_htt_rx_detach:
1783         ath10k_htt_rx_free(&ar->htt);
1784 err_htt_tx_detach:
1785         ath10k_htt_tx_free(&ar->htt);
1786 err_wmi_detach:
1787         ath10k_wmi_detach(ar);
1788 err:
1789         return status;
1790 }
1791 EXPORT_SYMBOL(ath10k_core_start);
1792
1793 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt)
1794 {
1795         int ret;
1796         unsigned long time_left;
1797
1798         reinit_completion(&ar->target_suspend);
1799
1800         ret = ath10k_wmi_pdev_suspend_target(ar, suspend_opt);
1801         if (ret) {
1802                 ath10k_warn(ar, "could not suspend target (%d)\n", ret);
1803                 return ret;
1804         }
1805
1806         time_left = wait_for_completion_timeout(&ar->target_suspend, 1 * HZ);
1807
1808         if (!time_left) {
1809                 ath10k_warn(ar, "suspend timed out - target pause event never came\n");
1810                 return -ETIMEDOUT;
1811         }
1812
1813         return 0;
1814 }
1815
1816 void ath10k_core_stop(struct ath10k *ar)
1817 {
1818         lockdep_assert_held(&ar->conf_mutex);
1819         ath10k_debug_stop(ar);
1820
1821         /* try to suspend target */
1822         if (ar->state != ATH10K_STATE_RESTARTING &&
1823             ar->state != ATH10K_STATE_UTF)
1824                 ath10k_wait_for_suspend(ar, WMI_PDEV_SUSPEND_AND_DISABLE_INTR);
1825
1826         ath10k_hif_stop(ar);
1827         ath10k_htt_tx_free(&ar->htt);
1828         ath10k_htt_rx_free(&ar->htt);
1829         ath10k_wmi_detach(ar);
1830 }
1831 EXPORT_SYMBOL(ath10k_core_stop);
1832
1833 /* mac80211 manages fw/hw initialization through start/stop hooks. However in
1834  * order to know what hw capabilities should be advertised to mac80211 it is
1835  * necessary to load the firmware (and tear it down immediately since start
1836  * hook will try to init it again) before registering */
1837 static int ath10k_core_probe_fw(struct ath10k *ar)
1838 {
1839         struct bmi_target_info target_info;
1840         int ret = 0;
1841
1842         ret = ath10k_hif_power_up(ar);
1843         if (ret) {
1844                 ath10k_err(ar, "could not start pci hif (%d)\n", ret);
1845                 return ret;
1846         }
1847
1848         memset(&target_info, 0, sizeof(target_info));
1849         ret = ath10k_bmi_get_target_info(ar, &target_info);
1850         if (ret) {
1851                 ath10k_err(ar, "could not get target info (%d)\n", ret);
1852                 goto err_power_down;
1853         }
1854
1855         ar->target_version = target_info.version;
1856         ar->hw->wiphy->hw_version = target_info.version;
1857
1858         ret = ath10k_init_hw_params(ar);
1859         if (ret) {
1860                 ath10k_err(ar, "could not get hw params (%d)\n", ret);
1861                 goto err_power_down;
1862         }
1863
1864         ret = ath10k_core_fetch_firmware_files(ar);
1865         if (ret) {
1866                 ath10k_err(ar, "could not fetch firmware files (%d)\n", ret);
1867                 goto err_power_down;
1868         }
1869
1870         BUILD_BUG_ON(sizeof(ar->hw->wiphy->fw_version) !=
1871                      sizeof(ar->normal_mode_fw.fw_file.fw_version));
1872         memcpy(ar->hw->wiphy->fw_version, ar->normal_mode_fw.fw_file.fw_version,
1873                sizeof(ar->hw->wiphy->fw_version));
1874
1875         ath10k_debug_print_hwfw_info(ar);
1876
1877         ret = ath10k_core_pre_cal_download(ar);
1878         if (ret) {
1879                 /* pre calibration data download is not necessary
1880                  * for all the chipsets. Ignore failures and continue.
1881                  */
1882                 ath10k_dbg(ar, ATH10K_DBG_BOOT,
1883                            "could not load pre cal data: %d\n", ret);
1884         }
1885
1886         ret = ath10k_core_get_board_id_from_otp(ar);
1887         if (ret && ret != -EOPNOTSUPP) {
1888                 ath10k_err(ar, "failed to get board id from otp: %d\n",
1889                            ret);
1890                 goto err_free_firmware_files;
1891         }
1892
1893         ret = ath10k_core_fetch_board_file(ar);
1894         if (ret) {
1895                 ath10k_err(ar, "failed to fetch board file: %d\n", ret);
1896                 goto err_free_firmware_files;
1897         }
1898
1899         ath10k_debug_print_board_info(ar);
1900
1901         ret = ath10k_core_init_firmware_features(ar);
1902         if (ret) {
1903                 ath10k_err(ar, "fatal problem with firmware features: %d\n",
1904                            ret);
1905                 goto err_free_firmware_files;
1906         }
1907
1908         ret = ath10k_swap_code_seg_init(ar);
1909         if (ret) {
1910                 ath10k_err(ar, "failed to initialize code swap segment: %d\n",
1911                            ret);
1912                 goto err_free_firmware_files;
1913         }
1914
1915         mutex_lock(&ar->conf_mutex);
1916
1917         ret = ath10k_core_start(ar, ATH10K_FIRMWARE_MODE_NORMAL,
1918                                 &ar->normal_mode_fw);
1919         if (ret) {
1920                 ath10k_err(ar, "could not init core (%d)\n", ret);
1921                 goto err_unlock;
1922         }
1923
1924         ath10k_debug_print_boot_info(ar);
1925         ath10k_core_stop(ar);
1926
1927         mutex_unlock(&ar->conf_mutex);
1928
1929         ath10k_hif_power_down(ar);
1930         return 0;
1931
1932 err_unlock:
1933         mutex_unlock(&ar->conf_mutex);
1934
1935 err_free_firmware_files:
1936         ath10k_core_free_firmware_files(ar);
1937
1938 err_power_down:
1939         ath10k_hif_power_down(ar);
1940
1941         return ret;
1942 }
1943
1944 static void ath10k_core_register_work(struct work_struct *work)
1945 {
1946         struct ath10k *ar = container_of(work, struct ath10k, register_work);
1947         int status;
1948
1949         status = ath10k_core_probe_fw(ar);
1950         if (status) {
1951                 ath10k_err(ar, "could not probe fw (%d)\n", status);
1952                 goto err;
1953         }
1954
1955         status = ath10k_mac_register(ar);
1956         if (status) {
1957                 ath10k_err(ar, "could not register to mac80211 (%d)\n", status);
1958                 goto err_release_fw;
1959         }
1960
1961         status = ath10k_debug_register(ar);
1962         if (status) {
1963                 ath10k_err(ar, "unable to initialize debugfs\n");
1964                 goto err_unregister_mac;
1965         }
1966
1967         status = ath10k_spectral_create(ar);
1968         if (status) {
1969                 ath10k_err(ar, "failed to initialize spectral\n");
1970                 goto err_debug_destroy;
1971         }
1972
1973         status = ath10k_thermal_register(ar);
1974         if (status) {
1975                 ath10k_err(ar, "could not register thermal device: %d\n",
1976                            status);
1977                 goto err_spectral_destroy;
1978         }
1979
1980         set_bit(ATH10K_FLAG_CORE_REGISTERED, &ar->dev_flags);
1981         return;
1982
1983 err_spectral_destroy:
1984         ath10k_spectral_destroy(ar);
1985 err_debug_destroy:
1986         ath10k_debug_destroy(ar);
1987 err_unregister_mac:
1988         ath10k_mac_unregister(ar);
1989 err_release_fw:
1990         ath10k_core_free_firmware_files(ar);
1991 err:
1992         /* TODO: It's probably a good idea to release device from the driver
1993          * but calling device_release_driver() here will cause a deadlock.
1994          */
1995         return;
1996 }
1997
1998 int ath10k_core_register(struct ath10k *ar, u32 chip_id)
1999 {
2000         ar->chip_id = chip_id;
2001         queue_work(ar->workqueue, &ar->register_work);
2002
2003         return 0;
2004 }
2005 EXPORT_SYMBOL(ath10k_core_register);
2006
2007 void ath10k_core_unregister(struct ath10k *ar)
2008 {
2009         cancel_work_sync(&ar->register_work);
2010
2011         if (!test_bit(ATH10K_FLAG_CORE_REGISTERED, &ar->dev_flags))
2012                 return;
2013
2014         ath10k_thermal_unregister(ar);
2015         /* Stop spectral before unregistering from mac80211 to remove the
2016          * relayfs debugfs file cleanly. Otherwise the parent debugfs tree
2017          * would be already be free'd recursively, leading to a double free.
2018          */
2019         ath10k_spectral_destroy(ar);
2020
2021         /* We must unregister from mac80211 before we stop HTC and HIF.
2022          * Otherwise we will fail to submit commands to FW and mac80211 will be
2023          * unhappy about callback failures. */
2024         ath10k_mac_unregister(ar);
2025
2026         ath10k_testmode_destroy(ar);
2027
2028         ath10k_core_free_firmware_files(ar);
2029         ath10k_core_free_board_files(ar);
2030
2031         ath10k_debug_unregister(ar);
2032 }
2033 EXPORT_SYMBOL(ath10k_core_unregister);
2034
2035 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
2036                                   enum ath10k_bus bus,
2037                                   enum ath10k_hw_rev hw_rev,
2038                                   const struct ath10k_hif_ops *hif_ops)
2039 {
2040         struct ath10k *ar;
2041         int ret;
2042
2043         ar = ath10k_mac_create(priv_size);
2044         if (!ar)
2045                 return NULL;
2046
2047         ar->ath_common.priv = ar;
2048         ar->ath_common.hw = ar->hw;
2049         ar->dev = dev;
2050         ar->hw_rev = hw_rev;
2051         ar->hif.ops = hif_ops;
2052         ar->hif.bus = bus;
2053
2054         switch (hw_rev) {
2055         case ATH10K_HW_QCA988X:
2056                 ar->regs = &qca988x_regs;
2057                 ar->hw_values = &qca988x_values;
2058                 break;
2059         case ATH10K_HW_QCA6174:
2060         case ATH10K_HW_QCA9377:
2061                 ar->regs = &qca6174_regs;
2062                 ar->hw_values = &qca6174_values;
2063                 break;
2064         case ATH10K_HW_QCA99X0:
2065                 ar->regs = &qca99x0_regs;
2066                 ar->hw_values = &qca99x0_values;
2067                 break;
2068         case ATH10K_HW_QCA4019:
2069                 ar->regs = &qca4019_regs;
2070                 ar->hw_values = &qca4019_values;
2071                 break;
2072         default:
2073                 ath10k_err(ar, "unsupported core hardware revision %d\n",
2074                            hw_rev);
2075                 ret = -ENOTSUPP;
2076                 goto err_free_mac;
2077         }
2078
2079         init_completion(&ar->scan.started);
2080         init_completion(&ar->scan.completed);
2081         init_completion(&ar->scan.on_channel);
2082         init_completion(&ar->target_suspend);
2083         init_completion(&ar->wow.wakeup_completed);
2084
2085         init_completion(&ar->install_key_done);
2086         init_completion(&ar->vdev_setup_done);
2087         init_completion(&ar->thermal.wmi_sync);
2088
2089         INIT_DELAYED_WORK(&ar->scan.timeout, ath10k_scan_timeout_work);
2090
2091         ar->workqueue = create_singlethread_workqueue("ath10k_wq");
2092         if (!ar->workqueue)
2093                 goto err_free_mac;
2094
2095         ar->workqueue_aux = create_singlethread_workqueue("ath10k_aux_wq");
2096         if (!ar->workqueue_aux)
2097                 goto err_free_wq;
2098
2099         mutex_init(&ar->conf_mutex);
2100         spin_lock_init(&ar->data_lock);
2101         spin_lock_init(&ar->txqs_lock);
2102
2103         INIT_LIST_HEAD(&ar->txqs);
2104         INIT_LIST_HEAD(&ar->peers);
2105         init_waitqueue_head(&ar->peer_mapping_wq);
2106         init_waitqueue_head(&ar->htt.empty_tx_wq);
2107         init_waitqueue_head(&ar->wmi.tx_credits_wq);
2108
2109         init_completion(&ar->offchan_tx_completed);
2110         INIT_WORK(&ar->offchan_tx_work, ath10k_offchan_tx_work);
2111         skb_queue_head_init(&ar->offchan_tx_queue);
2112
2113         INIT_WORK(&ar->wmi_mgmt_tx_work, ath10k_mgmt_over_wmi_tx_work);
2114         skb_queue_head_init(&ar->wmi_mgmt_tx_queue);
2115
2116         INIT_WORK(&ar->register_work, ath10k_core_register_work);
2117         INIT_WORK(&ar->restart_work, ath10k_core_restart);
2118
2119         ret = ath10k_debug_create(ar);
2120         if (ret)
2121                 goto err_free_aux_wq;
2122
2123         return ar;
2124
2125 err_free_aux_wq:
2126         destroy_workqueue(ar->workqueue_aux);
2127 err_free_wq:
2128         destroy_workqueue(ar->workqueue);
2129
2130 err_free_mac:
2131         ath10k_mac_destroy(ar);
2132
2133         return NULL;
2134 }
2135 EXPORT_SYMBOL(ath10k_core_create);
2136
2137 void ath10k_core_destroy(struct ath10k *ar)
2138 {
2139         flush_workqueue(ar->workqueue);
2140         destroy_workqueue(ar->workqueue);
2141
2142         flush_workqueue(ar->workqueue_aux);
2143         destroy_workqueue(ar->workqueue_aux);
2144
2145         ath10k_debug_destroy(ar);
2146         ath10k_wmi_free_host_mem(ar);
2147         ath10k_mac_destroy(ar);
2148 }
2149 EXPORT_SYMBOL(ath10k_core_destroy);
2150
2151 MODULE_AUTHOR("Qualcomm Atheros");
2152 MODULE_DESCRIPTION("Core module for QCA988X PCIe devices.");
2153 MODULE_LICENSE("Dual BSD/GPL");