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                                              ATH10K_SWAP_CODE_SEG_BIN_TYPE_FW);
 652         if (ret) {
 653                 ath10k_err(ar, "failed to configure fw code swap: %d\n",
 654                            ret);
 655                 return ret;
 656         }
 657
 658         ath10k_dbg(ar, ATH10K_DBG_BOOT,
 659                    "boot uploading firmware image %p len %d\n",
 660                    data, data_len);
 661
 662         ret = ath10k_bmi_fast_download(ar, address, data, data_len);
 663         if (ret) {
 664                 ath10k_err(ar, "failed to download firmware: %d\n",
 665                            ret);
 666                 return ret;
 667         }
 668
 669         return ret;
 670 }
 671
 672 static void ath10k_core_free_board_files(struct ath10k *ar)
 673 {
 674         if (!IS_ERR(ar->normal_mode_fw.board))
 675                 release_firmware(ar->normal_mode_fw.board);
 676
 677         ar->normal_mode_fw.board = NULL;
 678         ar->normal_mode_fw.board_data = NULL;
 679         ar->normal_mode_fw.board_len = 0;
 680 }
 681
 682 static void ath10k_core_free_firmware_files(struct ath10k *ar)
 683 {
 684         if (!IS_ERR(ar->normal_mode_fw.fw_file.firmware))
 685                 release_firmware(ar->normal_mode_fw.fw_file.firmware);
 686
 687         if (!IS_ERR(ar->cal_file))
 688                 release_firmware(ar->cal_file);
 689
 690         ath10k_swap_code_seg_release(ar);
 691
 692         ar->normal_mode_fw.fw_file.otp_data = NULL;
 693         ar->normal_mode_fw.fw_file.otp_len = 0;
 694
 695         ar->normal_mode_fw.fw_file.firmware = NULL;
 696         ar->normal_mode_fw.fw_file.firmware_data = NULL;
 697         ar->normal_mode_fw.fw_file.firmware_len = 0;
 698
 699         ar->cal_file = NULL;
 700 }
 701
 702 static int ath10k_fetch_cal_file(struct ath10k *ar)
 703 {
 704         char filename[100];
 705
 706         /* pre-cal-<bus>-<id>.bin */
 707         scnprintf(filename, sizeof(filename), "pre-cal-%s-%s.bin",
 708                   ath10k_bus_str(ar->hif.bus), dev_name(ar->dev));
 709
 710         ar->pre_cal_file = ath10k_fetch_fw_file(ar, ATH10K_FW_DIR, filename);
 711         if (!IS_ERR(ar->pre_cal_file))
 712                 goto success;
 713
 714         /* cal-<bus>-<id>.bin */
 715         scnprintf(filename, sizeof(filename), "cal-%s-%s.bin",
 716                   ath10k_bus_str(ar->hif.bus), dev_name(ar->dev));
 717
 718         ar->cal_file = ath10k_fetch_fw_file(ar, ATH10K_FW_DIR, filename);
 719         if (IS_ERR(ar->cal_file))
 720                 /* calibration file is optional, don't print any warnings */
 721                 return PTR_ERR(ar->cal_file);
 722 success:
 723         ath10k_dbg(ar, ATH10K_DBG_BOOT, "found calibration file %s/%s\n",
 724                    ATH10K_FW_DIR, filename);
 725
 726         return 0;
 727 }
 728
 729 static int ath10k_core_fetch_board_data_api_1(struct ath10k *ar)
 730 {
 731         if (!ar->hw_params.fw.board) {
 732                 ath10k_err(ar, "failed to find board file fw entry\n");
 733                 return -EINVAL;
 734         }
 735
 736         ar->normal_mode_fw.board = ath10k_fetch_fw_file(ar,
 737                                                         ar->hw_params.fw.dir,
 738                                                         ar->hw_params.fw.board);
 739         if (IS_ERR(ar->normal_mode_fw.board))
 740                 return PTR_ERR(ar->normal_mode_fw.board);
 741
 742         ar->normal_mode_fw.board_data = ar->normal_mode_fw.board->data;
 743         ar->normal_mode_fw.board_len = ar->normal_mode_fw.board->size;
 744
 745         return 0;
 746 }
 747
 748 static int ath10k_core_parse_bd_ie_board(struct ath10k *ar,
 749                                          const void *buf, size_t buf_len,
 750                                          const char *boardname)
 751 {
 752         const struct ath10k_fw_ie *hdr;
 753         bool name_match_found;
 754         int ret, board_ie_id;
 755         size_t board_ie_len;
 756         const void *board_ie_data;
 757
 758         name_match_found = false;
 759
 760         /* go through ATH10K_BD_IE_BOARD_ elements */
 761         while (buf_len > sizeof(struct ath10k_fw_ie)) {
 762                 hdr = buf;
 763                 board_ie_id = le32_to_cpu(hdr->id);
 764                 board_ie_len = le32_to_cpu(hdr->len);
 765                 board_ie_data = hdr->data;
 766
 767                 buf_len -= sizeof(*hdr);
 768                 buf += sizeof(*hdr);
 769
 770                 if (buf_len < ALIGN(board_ie_len, 4)) {
 771                         ath10k_err(ar, "invalid ATH10K_BD_IE_BOARD length: %zu < %zu\n",
 772                                    buf_len, ALIGN(board_ie_len, 4));
 773                         ret = -EINVAL;
 774                         goto out;
 775                 }
 776
 777                 switch (board_ie_id) {
 778                 case ATH10K_BD_IE_BOARD_NAME:
 779                         ath10k_dbg_dump(ar, ATH10K_DBG_BOOT, "board name", "",
 780                                         board_ie_data, board_ie_len);
 781
 782                         if (board_ie_len != strlen(boardname))
 783                                 break;
 784
 785                         ret = memcmp(board_ie_data, boardname, strlen(boardname));
 786                         if (ret)
 787                                 break;
 788
 789                         name_match_found = true;
 790                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
 791                                    "boot found match for name '%s'",
 792                                    boardname);
 793                         break;
 794                 case ATH10K_BD_IE_BOARD_DATA:
 795                         if (!name_match_found)
 796                                 /* no match found */
 797                                 break;
 798
 799                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
 800                                    "boot found board data for '%s'",
 801                                    boardname);
 802
 803                         ar->normal_mode_fw.board_data = board_ie_data;
 804                         ar->normal_mode_fw.board_len = board_ie_len;
 805
 806                         ret = 0;
 807                         goto out;
 808                 default:
 809                         ath10k_warn(ar, "unknown ATH10K_BD_IE_BOARD found: %d\n",
 810                                     board_ie_id);
 811                         break;
 812                 }
 813
 814                 /* jump over the padding */
 815                 board_ie_len = ALIGN(board_ie_len, 4);
 816
 817                 buf_len -= board_ie_len;
 818                 buf += board_ie_len;
 819         }
 820
 821         /* no match found */
 822         ret = -ENOENT;
 823
 824 out:
 825         return ret;
 826 }
 827
 828 static int ath10k_core_fetch_board_data_api_n(struct ath10k *ar,
 829                                               const char *boardname,
 830                                               const char *filename)
 831 {
 832         size_t len, magic_len, ie_len;
 833         struct ath10k_fw_ie *hdr;
 834         const u8 *data;
 835         int ret, ie_id;
 836
 837         ar->normal_mode_fw.board = ath10k_fetch_fw_file(ar,
 838                                                         ar->hw_params.fw.dir,
 839                                                         filename);
 840         if (IS_ERR(ar->normal_mode_fw.board))
 841                 return PTR_ERR(ar->normal_mode_fw.board);
 842
 843         data = ar->normal_mode_fw.board->data;
 844         len = ar->normal_mode_fw.board->size;
 845
 846         /* magic has extra null byte padded */
 847         magic_len = strlen(ATH10K_BOARD_MAGIC) + 1;
 848         if (len < magic_len) {
 849                 ath10k_err(ar, "failed to find magic value in %s/%s, file too short: %zu\n",
 850                            ar->hw_params.fw.dir, filename, len);
 851                 ret = -EINVAL;
 852                 goto err;
 853         }
 854
 855         if (memcmp(data, ATH10K_BOARD_MAGIC, magic_len)) {
 856                 ath10k_err(ar, "found invalid board magic\n");
 857                 ret = -EINVAL;
 858                 goto err;
 859         }
 860
 861         /* magic is padded to 4 bytes */
 862         magic_len = ALIGN(magic_len, 4);
 863         if (len < magic_len) {
 864                 ath10k_err(ar, "failed: %s/%s too small to contain board data, len: %zu\n",
 865                            ar->hw_params.fw.dir, filename, len);
 866                 ret = -EINVAL;
 867                 goto err;
 868         }
 869
 870         data += magic_len;
 871         len -= magic_len;
 872
 873         while (len > sizeof(struct ath10k_fw_ie)) {
 874                 hdr = (struct ath10k_fw_ie *)data;
 875                 ie_id = le32_to_cpu(hdr->id);
 876                 ie_len = le32_to_cpu(hdr->len);
 877
 878                 len -= sizeof(*hdr);
 879                 data = hdr->data;
 880
 881                 if (len < ALIGN(ie_len, 4)) {
 882                         ath10k_err(ar, "invalid length for board ie_id %d ie_len %zu len %zu\n",
 883                                    ie_id, ie_len, len);
 884                         ret = -EINVAL;
 885                         goto err;
 886                 }
 887
 888                 switch (ie_id) {
 889                 case ATH10K_BD_IE_BOARD:
 890                         ret = ath10k_core_parse_bd_ie_board(ar, data, ie_len,
 891                                                             boardname);
 892                         if (ret == -ENOENT)
 893                                 /* no match found, continue */
 894                                 break;
 895                         else if (ret)
 896                                 /* there was an error, bail out */
 897                                 goto err;
 898
 899                         /* board data found */
 900                         goto out;
 901                 }
 902
 903                 /* jump over the padding */
 904                 ie_len = ALIGN(ie_len, 4);
 905
 906                 len -= ie_len;
 907                 data += ie_len;
 908         }
 909
 910 out:
 911         if (!ar->normal_mode_fw.board_data || !ar->normal_mode_fw.board_len) {
 912                 ath10k_err(ar,
 913                            "failed to fetch board data for %s from %s/%s\n",
 914                            boardname, ar->hw_params.fw.dir, filename);
 915                 ret = -ENODATA;
 916                 goto err;
 917         }
 918
 919         return 0;
 920
 921 err:
 922         ath10k_core_free_board_files(ar);
 923         return ret;
 924 }
 925
 926 static int ath10k_core_create_board_name(struct ath10k *ar, char *name,
 927                                          size_t name_len)
 928 {
 929         if (ar->id.bmi_ids_valid) {
 930                 scnprintf(name, name_len,
 931                           "bus=%s,bmi-chip-id=%d,bmi-board-id=%d",
 932                           ath10k_bus_str(ar->hif.bus),
 933                           ar->id.bmi_chip_id,
 934                           ar->id.bmi_board_id);
 935                 goto out;
 936         }
 937
 938         scnprintf(name, name_len,
 939                   "bus=%s,vendor=%04x,device=%04x,subsystem-vendor=%04x,subsystem-device=%04x",
 940                   ath10k_bus_str(ar->hif.bus),
 941                   ar->id.vendor, ar->id.device,
 942                   ar->id.subsystem_vendor, ar->id.subsystem_device);
 943
 944 out:
 945         ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot using board name '%s'\n", name);
 946
 947         return 0;
 948 }
 949
 950 static int ath10k_core_fetch_board_file(struct ath10k *ar)
 951 {
 952         char boardname[100];
 953         int ret;
 954
 955         ret = ath10k_core_create_board_name(ar, boardname, sizeof(boardname));
 956         if (ret) {
 957                 ath10k_err(ar, "failed to create board name: %d", ret);
 958                 return ret;
 959         }
 960
 961         ar->bd_api = 2;
 962         ret = ath10k_core_fetch_board_data_api_n(ar, boardname,
 963                                                  ATH10K_BOARD_API2_FILE);
 964         if (!ret)
 965                 goto success;
 966
 967         ar->bd_api = 1;
 968         ret = ath10k_core_fetch_board_data_api_1(ar);
 969         if (ret) {
 970                 ath10k_err(ar, "failed to fetch board data\n");
 971                 return ret;
 972         }
 973
 974 success:
 975         ath10k_dbg(ar, ATH10K_DBG_BOOT, "using board api %d\n", ar->bd_api);
 976         return 0;
 977 }
 978
 979 static int ath10k_core_fetch_firmware_api_n(struct ath10k *ar, const char *name,
 980                                             struct ath10k_fw_file *fw_file)
 981 {
 982         size_t magic_len, len, ie_len;
 983         int ie_id, i, index, bit, ret;
 984         struct ath10k_fw_ie *hdr;
 985         const u8 *data;
 986         __le32 *timestamp, *version;
 987
 988         /* first fetch the firmware file (firmware-*.bin) */
 989         fw_file->firmware = ath10k_fetch_fw_file(ar, ar->hw_params.fw.dir,
 990                                                  name);
 991         if (IS_ERR(fw_file->firmware)) {
 992                 ath10k_err(ar, "could not fetch firmware file '%s/%s': %ld\n",
 993                            ar->hw_params.fw.dir, name,
 994                            PTR_ERR(fw_file->firmware));
 995                 return PTR_ERR(fw_file->firmware);
 996         }
 997
 998         data = fw_file->firmware->data;
 999         len = fw_file->firmware->size;
1000
1001         /* magic also includes the null byte, check that as well */
1002         magic_len = strlen(ATH10K_FIRMWARE_MAGIC) + 1;
1003
1004         if (len < magic_len) {
1005                 ath10k_err(ar, "firmware file '%s/%s' too small to contain magic: %zu\n",
1006                            ar->hw_params.fw.dir, name, len);
1007                 ret = -EINVAL;
1008                 goto err;
1009         }
1010
1011         if (memcmp(data, ATH10K_FIRMWARE_MAGIC, magic_len) != 0) {
1012                 ath10k_err(ar, "invalid firmware magic\n");
1013                 ret = -EINVAL;
1014                 goto err;
1015         }
1016
1017         /* jump over the padding */
1018         magic_len = ALIGN(magic_len, 4);
1019
1020         len -= magic_len;
1021         data += magic_len;
1022
1023         /* loop elements */
1024         while (len > sizeof(struct ath10k_fw_ie)) {
1025                 hdr = (struct ath10k_fw_ie *)data;
1026
1027                 ie_id = le32_to_cpu(hdr->id);
1028                 ie_len = le32_to_cpu(hdr->len);
1029
1030                 len -= sizeof(*hdr);
1031                 data += sizeof(*hdr);
1032
1033                 if (len < ie_len) {
1034                         ath10k_err(ar, "invalid length for FW IE %d (%zu < %zu)\n",
1035                                    ie_id, len, ie_len);
1036                         ret = -EINVAL;
1037                         goto err;
1038                 }
1039
1040                 switch (ie_id) {
1041                 case ATH10K_FW_IE_FW_VERSION:
1042                         if (ie_len > sizeof(fw_file->fw_version) - 1)
1043                                 break;
1044
1045                         memcpy(fw_file->fw_version, data, ie_len);
1046                         fw_file->fw_version[ie_len] = '\0';
1047
1048                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1049                                    "found fw version %s\n",
1050                                     fw_file->fw_version);
1051                         break;
1052                 case ATH10K_FW_IE_TIMESTAMP:
1053                         if (ie_len != sizeof(u32))
1054                                 break;
1055
1056                         timestamp = (__le32 *)data;
1057
1058                         ath10k_dbg(ar, ATH10K_DBG_BOOT, "found fw timestamp %d\n",
1059                                    le32_to_cpup(timestamp));
1060                         break;
1061                 case ATH10K_FW_IE_FEATURES:
1062                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1063                                    "found firmware features ie (%zd B)\n",
1064                                    ie_len);
1065
1066                         for (i = 0; i < ATH10K_FW_FEATURE_COUNT; i++) {
1067                                 index = i / 8;
1068                                 bit = i % 8;
1069
1070                                 if (index == ie_len)
1071                                         break;
1072
1073                                 if (data[index] & (1 << bit)) {
1074                                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1075                                                    "Enabling feature bit: %i\n",
1076                                                    i);
1077                                         __set_bit(i, fw_file->fw_features);
1078                                 }
1079                         }
1080
1081                         ath10k_dbg_dump(ar, ATH10K_DBG_BOOT, "features", "",
1082                                         ar->running_fw->fw_file.fw_features,
1083                                         sizeof(fw_file->fw_features));
1084                         break;
1085                 case ATH10K_FW_IE_FW_IMAGE:
1086                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1087                                    "found fw image ie (%zd B)\n",
1088                                    ie_len);
1089
1090                         fw_file->firmware_data = data;
1091                         fw_file->firmware_len = ie_len;
1092
1093                         break;
1094                 case ATH10K_FW_IE_OTP_IMAGE:
1095                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1096                                    "found otp image ie (%zd B)\n",
1097                                    ie_len);
1098
1099                         fw_file->otp_data = data;
1100                         fw_file->otp_len = ie_len;
1101
1102                         break;
1103                 case ATH10K_FW_IE_WMI_OP_VERSION:
1104                         if (ie_len != sizeof(u32))
1105                                 break;
1106
1107                         version = (__le32 *)data;
1108
1109                         fw_file->wmi_op_version = le32_to_cpup(version);
1110
1111                         ath10k_dbg(ar, ATH10K_DBG_BOOT, "found fw ie wmi op version %d\n",
1112                                    fw_file->wmi_op_version);
1113                         break;
1114                 case ATH10K_FW_IE_HTT_OP_VERSION:
1115                         if (ie_len != sizeof(u32))
1116                                 break;
1117
1118                         version = (__le32 *)data;
1119
1120                         ar->htt.op_version = le32_to_cpup(version);
1121
1122                         ath10k_dbg(ar, ATH10K_DBG_BOOT, "found fw ie htt op version %d\n",
1123                                    ar->htt.op_version);
1124                         break;
1125                 case ATH10K_FW_IE_FW_CODE_SWAP_IMAGE:
1126                         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1127                                    "found fw code swap image ie (%zd B)\n",
1128                                    ie_len);
1129                         fw_file->codeswap_data = data;
1130                         fw_file->codeswap_len = ie_len;
1131                         break;
1132                 default:
1133                         ath10k_warn(ar, "Unknown FW IE: %u\n",
1134                                     le32_to_cpu(hdr->id));
1135                         break;
1136                 }
1137
1138                 /* jump over the padding */
1139                 ie_len = ALIGN(ie_len, 4);
1140
1141                 len -= ie_len;
1142                 data += ie_len;
1143         }
1144
1145         if (!fw_file->firmware_data ||
1146             !fw_file->firmware_len) {
1147                 ath10k_warn(ar, "No ATH10K_FW_IE_FW_IMAGE found from '%s/%s', skipping\n",
1148                             ar->hw_params.fw.dir, name);
1149                 ret = -ENOMEDIUM;
1150                 goto err;
1151         }
1152
1153         return 0;
1154
1155 err:
1156         ath10k_core_free_firmware_files(ar);
1157         return ret;
1158 }
1159
1160 static int ath10k_core_fetch_firmware_files(struct ath10k *ar)
1161 {
1162         int ret;
1163
1164         /* calibration file is optional, don't check for any errors */
1165         ath10k_fetch_cal_file(ar);
1166
1167         ar->fw_api = 5;
1168         ath10k_dbg(ar, ATH10K_DBG_BOOT, "trying fw api %d\n", ar->fw_api);
1169
1170         ret = ath10k_core_fetch_firmware_api_n(ar, ATH10K_FW_API5_FILE,
1171                                                &ar->normal_mode_fw.fw_file);
1172         if (ret == 0)
1173                 goto success;
1174
1175         ar->fw_api = 4;
1176         ath10k_dbg(ar, ATH10K_DBG_BOOT, "trying fw api %d\n", ar->fw_api);
1177
1178         ret = ath10k_core_fetch_firmware_api_n(ar, ATH10K_FW_API4_FILE,
1179                                                &ar->normal_mode_fw.fw_file);
1180         if (ret == 0)
1181                 goto success;
1182
1183         ar->fw_api = 3;
1184         ath10k_dbg(ar, ATH10K_DBG_BOOT, "trying fw api %d\n", ar->fw_api);
1185
1186         ret = ath10k_core_fetch_firmware_api_n(ar, ATH10K_FW_API3_FILE,
1187                                                &ar->normal_mode_fw.fw_file);
1188         if (ret == 0)
1189                 goto success;
1190
1191         ar->fw_api = 2;
1192         ath10k_dbg(ar, ATH10K_DBG_BOOT, "trying fw api %d\n", ar->fw_api);
1193
1194         ret = ath10k_core_fetch_firmware_api_n(ar, ATH10K_FW_API2_FILE,
1195                                                &ar->normal_mode_fw.fw_file);
1196         if (ret)
1197                 return ret;
1198
1199 success:
1200         ath10k_dbg(ar, ATH10K_DBG_BOOT, "using fw api %d\n", ar->fw_api);
1201
1202         return 0;
1203 }
1204
1205 static int ath10k_core_pre_cal_download(struct ath10k *ar)
1206 {
1207         int ret;
1208
1209         ret = ath10k_download_cal_file(ar, ar->pre_cal_file);
1210         if (ret == 0) {
1211                 ar->cal_mode = ATH10K_PRE_CAL_MODE_FILE;
1212                 goto success;
1213         }
1214
1215         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1216                    "boot did not find a pre calibration file, try DT next: %d\n",
1217                    ret);
1218
1219         ret = ath10k_download_cal_dt(ar, "qcom,ath10k-pre-calibration-data");
1220         if (ret) {
1221                 ath10k_dbg(ar, ATH10K_DBG_BOOT,
1222                            "unable to load pre cal data from DT: %d\n", ret);
1223                 return ret;
1224         }
1225         ar->cal_mode = ATH10K_PRE_CAL_MODE_DT;
1226
1227 success:
1228         ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot using calibration mode %s\n",
1229                    ath10k_cal_mode_str(ar->cal_mode));
1230
1231         return 0;
1232 }
1233
1234 static int ath10k_core_pre_cal_config(struct ath10k *ar)
1235 {
1236         int ret;
1237
1238         ret = ath10k_core_pre_cal_download(ar);
1239         if (ret) {
1240                 ath10k_dbg(ar, ATH10K_DBG_BOOT,
1241                            "failed to load pre cal data: %d\n", ret);
1242                 return ret;
1243         }
1244
1245         ret = ath10k_core_get_board_id_from_otp(ar);
1246         if (ret) {
1247                 ath10k_err(ar, "failed to get board id: %d\n", ret);
1248                 return ret;
1249         }
1250
1251         ret = ath10k_download_and_run_otp(ar);
1252         if (ret) {
1253                 ath10k_err(ar, "failed to run otp: %d\n", ret);
1254                 return ret;
1255         }
1256
1257         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1258                    "pre cal configuration done successfully\n");
1259
1260         return 0;
1261 }
1262
1263 static int ath10k_download_cal_data(struct ath10k *ar)
1264 {
1265         int ret;
1266
1267         ret = ath10k_core_pre_cal_config(ar);
1268         if (ret == 0)
1269                 return 0;
1270
1271         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1272                    "pre cal download procedure failed, try cal file: %d\n",
1273                    ret);
1274
1275         ret = ath10k_download_cal_file(ar, ar->cal_file);
1276         if (ret == 0) {
1277                 ar->cal_mode = ATH10K_CAL_MODE_FILE;
1278                 goto done;
1279         }
1280
1281         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1282                    "boot did not find a calibration file, try DT next: %d\n",
1283                    ret);
1284
1285         ret = ath10k_download_cal_dt(ar, "qcom,ath10k-calibration-data");
1286         if (ret == 0) {
1287                 ar->cal_mode = ATH10K_CAL_MODE_DT;
1288                 goto done;
1289         }
1290
1291         ath10k_dbg(ar, ATH10K_DBG_BOOT,
1292                    "boot did not find DT entry, try OTP next: %d\n",
1293                    ret);
1294
1295         ret = ath10k_download_and_run_otp(ar);
1296         if (ret) {
1297                 ath10k_err(ar, "failed to run otp: %d\n", ret);
1298                 return ret;
1299         }
1300
1301         ar->cal_mode = ATH10K_CAL_MODE_OTP;
1302
1303 done:
1304         ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot using calibration mode %s\n",
1305                    ath10k_cal_mode_str(ar->cal_mode));
1306         return 0;
1307 }
1308
1309 static int ath10k_init_uart(struct ath10k *ar)
1310 {
1311         int ret;
1312
1313         /*
1314          * Explicitly setting UART prints to zero as target turns it on
1315          * based on scratch registers.
1316          */
1317         ret = ath10k_bmi_write32(ar, hi_serial_enable, 0);
1318         if (ret) {
1319                 ath10k_warn(ar, "could not disable UART prints (%d)\n", ret);
1320                 return ret;
1321         }
1322
1323         if (!uart_print)
1324                 return 0;
1325
1326         ret = ath10k_bmi_write32(ar, hi_dbg_uart_txpin, ar->hw_params.uart_pin);
1327         if (ret) {
1328                 ath10k_warn(ar, "could not enable UART prints (%d)\n", ret);
1329                 return ret;
1330         }
1331
1332         ret = ath10k_bmi_write32(ar, hi_serial_enable, 1);
1333         if (ret) {
1334                 ath10k_warn(ar, "could not enable UART prints (%d)\n", ret);
1335                 return ret;
1336         }
1337
1338         /* Set the UART baud rate to 19200. */
1339         ret = ath10k_bmi_write32(ar, hi_desired_baud_rate, 19200);
1340         if (ret) {
1341                 ath10k_warn(ar, "could not set the baud rate (%d)\n", ret);
1342                 return ret;
1343         }
1344
1345         ath10k_info(ar, "UART prints enabled\n");
1346         return 0;
1347 }
1348
1349 static int ath10k_init_hw_params(struct ath10k *ar)
1350 {
1351         const struct ath10k_hw_params *uninitialized_var(hw_params);
1352         int i;
1353
1354         for (i = 0; i < ARRAY_SIZE(ath10k_hw_params_list); i++) {
1355                 hw_params = &ath10k_hw_params_list[i];
1356
1357                 if (hw_params->id == ar->target_version &&
1358                     hw_params->dev_id == ar->dev_id)
1359                         break;
1360         }
1361
1362         if (i == ARRAY_SIZE(ath10k_hw_params_list)) {
1363                 ath10k_err(ar, "Unsupported hardware version: 0x%x\n",
1364                            ar->target_version);
1365                 return -EINVAL;
1366         }
1367
1368         ar->hw_params = *hw_params;
1369
1370         ath10k_dbg(ar, ATH10K_DBG_BOOT, "Hardware name %s version 0x%x\n",
1371                    ar->hw_params.name, ar->target_version);
1372
1373         return 0;
1374 }
1375
1376 static void ath10k_core_restart(struct work_struct *work)
1377 {
1378         struct ath10k *ar = container_of(work, struct ath10k, restart_work);
1379
1380         set_bit(ATH10K_FLAG_CRASH_FLUSH, &ar->dev_flags);
1381
1382         /* Place a barrier to make sure the compiler doesn't reorder
1383          * CRASH_FLUSH and calling other functions.
1384          */
1385         barrier();
1386
1387         ieee80211_stop_queues(ar->hw);
1388         ath10k_drain_tx(ar);
1389         complete_all(&ar->scan.started);
1390         complete_all(&ar->scan.completed);
1391         complete_all(&ar->scan.on_channel);
1392         complete_all(&ar->offchan_tx_completed);
1393         complete_all(&ar->install_key_done);
1394         complete_all(&ar->vdev_setup_done);
1395         complete_all(&ar->thermal.wmi_sync);
1396         wake_up(&ar->htt.empty_tx_wq);
1397         wake_up(&ar->wmi.tx_credits_wq);
1398         wake_up(&ar->peer_mapping_wq);
1399
1400         mutex_lock(&ar->conf_mutex);
1401
1402         switch (ar->state) {
1403         case ATH10K_STATE_ON:
1404                 ar->state = ATH10K_STATE_RESTARTING;
1405                 ath10k_hif_stop(ar);
1406                 ath10k_scan_finish(ar);
1407                 ieee80211_restart_hw(ar->hw);
1408                 break;
1409         case ATH10K_STATE_OFF:
1410                 /* this can happen if driver is being unloaded
1411                  * or if the crash happens during FW probing */
1412                 ath10k_warn(ar, "cannot restart a device that hasn't been started\n");
1413                 break;
1414         case ATH10K_STATE_RESTARTING:
1415                 /* hw restart might be requested from multiple places */
1416                 break;
1417         case ATH10K_STATE_RESTARTED:
1418                 ar->state = ATH10K_STATE_WEDGED;
1419                 /* fall through */
1420         case ATH10K_STATE_WEDGED:
1421                 ath10k_warn(ar, "device is wedged, will not restart\n");
1422                 break;
1423         case ATH10K_STATE_UTF:
1424                 ath10k_warn(ar, "firmware restart in UTF mode not supported\n");
1425                 break;
1426         }
1427
1428         mutex_unlock(&ar->conf_mutex);
1429 }
1430
1431 static int ath10k_core_init_firmware_features(struct ath10k *ar)
1432 {
1433         struct ath10k_fw_file *fw_file = &ar->normal_mode_fw.fw_file;
1434
1435         if (test_bit(ATH10K_FW_FEATURE_WMI_10_2, fw_file->fw_features) &&
1436             !test_bit(ATH10K_FW_FEATURE_WMI_10X, fw_file->fw_features)) {
1437                 ath10k_err(ar, "feature bits corrupted: 10.2 feature requires 10.x feature to be set as well");
1438                 return -EINVAL;
1439         }
1440
1441         if (fw_file->wmi_op_version >= ATH10K_FW_WMI_OP_VERSION_MAX) {
1442                 ath10k_err(ar, "unsupported WMI OP version (max %d): %d\n",
1443                            ATH10K_FW_WMI_OP_VERSION_MAX, fw_file->wmi_op_version);
1444                 return -EINVAL;
1445         }
1446
1447         ar->wmi.rx_decap_mode = ATH10K_HW_TXRX_NATIVE_WIFI;
1448         switch (ath10k_cryptmode_param) {
1449         case ATH10K_CRYPT_MODE_HW:
1450                 clear_bit(ATH10K_FLAG_RAW_MODE, &ar->dev_flags);
1451                 clear_bit(ATH10K_FLAG_HW_CRYPTO_DISABLED, &ar->dev_flags);
1452                 break;
1453         case ATH10K_CRYPT_MODE_SW:
1454                 if (!test_bit(ATH10K_FW_FEATURE_RAW_MODE_SUPPORT,
1455                               fw_file->fw_features)) {
1456                         ath10k_err(ar, "cryptmode > 0 requires raw mode support from firmware");
1457                         return -EINVAL;
1458                 }
1459
1460                 set_bit(ATH10K_FLAG_RAW_MODE, &ar->dev_flags);
1461                 set_bit(ATH10K_FLAG_HW_CRYPTO_DISABLED, &ar->dev_flags);
1462                 break;
1463         default:
1464                 ath10k_info(ar, "invalid cryptmode: %d\n",
1465                             ath10k_cryptmode_param);
1466                 return -EINVAL;
1467         }
1468
1469         ar->htt.max_num_amsdu = ATH10K_HTT_MAX_NUM_AMSDU_DEFAULT;
1470         ar->htt.max_num_ampdu = ATH10K_HTT_MAX_NUM_AMPDU_DEFAULT;
1471
1472         if (rawmode) {
1473                 if (!test_bit(ATH10K_FW_FEATURE_RAW_MODE_SUPPORT,
1474                               fw_file->fw_features)) {
1475                         ath10k_err(ar, "rawmode = 1 requires support from firmware");
1476                         return -EINVAL;
1477                 }
1478                 set_bit(ATH10K_FLAG_RAW_MODE, &ar->dev_flags);
1479         }
1480
1481         if (test_bit(ATH10K_FLAG_RAW_MODE, &ar->dev_flags)) {
1482                 ar->wmi.rx_decap_mode = ATH10K_HW_TXRX_RAW;
1483
1484                 /* Workaround:
1485                  *
1486                  * Firmware A-MSDU aggregation breaks with RAW Tx encap mode
1487                  * and causes enormous performance issues (malformed frames,
1488                  * etc).
1489                  *
1490                  * Disabling A-MSDU makes RAW mode stable with heavy traffic
1491                  * albeit a bit slower compared to regular operation.
1492                  */
1493                 ar->htt.max_num_amsdu = 1;
1494         }
1495
1496         /* Backwards compatibility for firmwares without
1497          * ATH10K_FW_IE_WMI_OP_VERSION.
1498          */
1499         if (fw_file->wmi_op_version == ATH10K_FW_WMI_OP_VERSION_UNSET) {
1500                 if (test_bit(ATH10K_FW_FEATURE_WMI_10X, fw_file->fw_features)) {
1501                         if (test_bit(ATH10K_FW_FEATURE_WMI_10_2,
1502                                      fw_file->fw_features))
1503                                 fw_file->wmi_op_version = ATH10K_FW_WMI_OP_VERSION_10_2;
1504                         else
1505                                 fw_file->wmi_op_version = ATH10K_FW_WMI_OP_VERSION_10_1;
1506                 } else {
1507                         fw_file->wmi_op_version = ATH10K_FW_WMI_OP_VERSION_MAIN;
1508                 }
1509         }
1510
1511         switch (fw_file->wmi_op_version) {
1512         case ATH10K_FW_WMI_OP_VERSION_MAIN:
1513                 ar->max_num_peers = TARGET_NUM_PEERS;
1514                 ar->max_num_stations = TARGET_NUM_STATIONS;
1515                 ar->max_num_vdevs = TARGET_NUM_VDEVS;
1516                 ar->htt.max_num_pending_tx = TARGET_NUM_MSDU_DESC;
1517                 ar->fw_stats_req_mask = WMI_STAT_PDEV | WMI_STAT_VDEV |
1518                         WMI_STAT_PEER;
1519                 ar->max_spatial_stream = WMI_MAX_SPATIAL_STREAM;
1520                 break;
1521         case ATH10K_FW_WMI_OP_VERSION_10_1:
1522         case ATH10K_FW_WMI_OP_VERSION_10_2:
1523         case ATH10K_FW_WMI_OP_VERSION_10_2_4:
1524                 if (ath10k_peer_stats_enabled(ar)) {
1525                         ar->max_num_peers = TARGET_10X_TX_STATS_NUM_PEERS;
1526                         ar->max_num_stations = TARGET_10X_TX_STATS_NUM_STATIONS;
1527                 } else {
1528                         ar->max_num_peers = TARGET_10X_NUM_PEERS;
1529                         ar->max_num_stations = TARGET_10X_NUM_STATIONS;
1530                 }
1531                 ar->max_num_vdevs = TARGET_10X_NUM_VDEVS;
1532                 ar->htt.max_num_pending_tx = TARGET_10X_NUM_MSDU_DESC;
1533                 ar->fw_stats_req_mask = WMI_STAT_PEER;
1534                 ar->max_spatial_stream = WMI_MAX_SPATIAL_STREAM;
1535                 break;
1536         case ATH10K_FW_WMI_OP_VERSION_TLV:
1537                 ar->max_num_peers = TARGET_TLV_NUM_PEERS;
1538                 ar->max_num_stations = TARGET_TLV_NUM_STATIONS;
1539                 ar->max_num_vdevs = TARGET_TLV_NUM_VDEVS;
1540                 ar->max_num_tdls_vdevs = TARGET_TLV_NUM_TDLS_VDEVS;
1541                 ar->htt.max_num_pending_tx = TARGET_TLV_NUM_MSDU_DESC;
1542                 ar->wow.max_num_patterns = TARGET_TLV_NUM_WOW_PATTERNS;
1543                 ar->fw_stats_req_mask = WMI_STAT_PDEV | WMI_STAT_VDEV |
1544                         WMI_STAT_PEER;
1545                 ar->max_spatial_stream = WMI_MAX_SPATIAL_STREAM;
1546                 break;
1547         case ATH10K_FW_WMI_OP_VERSION_10_4:
1548                 ar->max_num_peers = TARGET_10_4_NUM_PEERS;
1549                 ar->max_num_stations = TARGET_10_4_NUM_STATIONS;
1550                 ar->num_active_peers = TARGET_10_4_ACTIVE_PEERS;
1551                 ar->max_num_vdevs = TARGET_10_4_NUM_VDEVS;
1552                 ar->num_tids = TARGET_10_4_TGT_NUM_TIDS;
1553                 ar->fw_stats_req_mask = WMI_10_4_STAT_PEER |
1554                                         WMI_10_4_STAT_PEER_EXTD;
1555                 ar->max_spatial_stream = ar->hw_params.max_spatial_stream;
1556
1557                 if (test_bit(ATH10K_FW_FEATURE_PEER_FLOW_CONTROL,
1558                              fw_file->fw_features))
1559                         ar->htt.max_num_pending_tx = TARGET_10_4_NUM_MSDU_DESC_PFC;
1560                 else
1561                         ar->htt.max_num_pending_tx = TARGET_10_4_NUM_MSDU_DESC;
1562                 break;
1563         case ATH10K_FW_WMI_OP_VERSION_UNSET:
1564         case ATH10K_FW_WMI_OP_VERSION_MAX:
1565                 WARN_ON(1);
1566                 return -EINVAL;
1567         }
1568
1569         /* Backwards compatibility for firmwares without
1570          * ATH10K_FW_IE_HTT_OP_VERSION.
1571          */
1572         if (ar->htt.op_version == ATH10K_FW_HTT_OP_VERSION_UNSET) {
1573                 switch (fw_file->wmi_op_version) {
1574                 case ATH10K_FW_WMI_OP_VERSION_MAIN:
1575                         ar->htt.op_version = ATH10K_FW_HTT_OP_VERSION_MAIN;
1576                         break;
1577                 case ATH10K_FW_WMI_OP_VERSION_10_1:
1578                 case ATH10K_FW_WMI_OP_VERSION_10_2:
1579                 case ATH10K_FW_WMI_OP_VERSION_10_2_4:
1580                         ar->htt.op_version = ATH10K_FW_HTT_OP_VERSION_10_1;
1581                         break;
1582                 case ATH10K_FW_WMI_OP_VERSION_TLV:
1583                         ar->htt.op_version = ATH10K_FW_HTT_OP_VERSION_TLV;
1584                         break;
1585                 case ATH10K_FW_WMI_OP_VERSION_10_4:
1586                 case ATH10K_FW_WMI_OP_VERSION_UNSET:
1587                 case ATH10K_FW_WMI_OP_VERSION_MAX:
1588                         WARN_ON(1);
1589                         return -EINVAL;
1590                 }
1591         }
1592
1593         return 0;
1594 }
1595
1596 int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode,
1597                       const struct ath10k_fw_components *fw)
1598 {
1599         int status;
1600         u32 val;
1601
1602         lockdep_assert_held(&ar->conf_mutex);
1603
1604         clear_bit(ATH10K_FLAG_CRASH_FLUSH, &ar->dev_flags);
1605
1606         ar->running_fw = fw;
1607
1608         ath10k_bmi_start(ar);
1609
1610         if (ath10k_init_configure_target(ar)) {
1611                 status = -EINVAL;
1612                 goto err;
1613         }
1614
1615         status = ath10k_download_cal_data(ar);
1616         if (status)
1617                 goto err;
1618
1619         /* Some of of qca988x solutions are having global reset issue
1620          * during target initialization. Bypassing PLL setting before
1621          * downloading firmware and letting the SoC run on REF_CLK is
1622          * fixing the problem. Corresponding firmware change is also needed
1623          * to set the clock source once the target is initialized.
1624          */
1625         if (test_bit(ATH10K_FW_FEATURE_SUPPORTS_SKIP_CLOCK_INIT,
1626                      ar->running_fw->fw_file.fw_features)) {
1627                 status = ath10k_bmi_write32(ar, hi_skip_clock_init, 1);
1628                 if (status) {
1629                         ath10k_err(ar, "could not write to skip_clock_init: %d\n",
1630                                    status);
1631                         goto err;
1632                 }
1633         }
1634
1635         status = ath10k_download_fw(ar);
1636         if (status)
1637                 goto err;
1638
1639         status = ath10k_init_uart(ar);
1640         if (status)
1641                 goto err;
1642
1643         ar->htc.htc_ops.target_send_suspend_complete =
1644                 ath10k_send_suspend_complete;
1645
1646         status = ath10k_htc_init(ar);
1647         if (status) {
1648                 ath10k_err(ar, "could not init HTC (%d)\n", status);
1649                 goto err;
1650         }
1651
1652         status = ath10k_bmi_done(ar);
1653         if (status)
1654                 goto err;
1655
1656         status = ath10k_wmi_attach(ar);
1657         if (status) {
1658                 ath10k_err(ar, "WMI attach failed: %d\n", status);
1659                 goto err;
1660         }
1661
1662         status = ath10k_htt_init(ar);
1663         if (status) {
1664                 ath10k_err(ar, "failed to init htt: %d\n", status);
1665                 goto err_wmi_detach;
1666         }
1667
1668         status = ath10k_htt_tx_alloc(&ar->htt);
1669         if (status) {
1670                 ath10k_err(ar, "failed to alloc htt tx: %d\n", status);
1671                 goto err_wmi_detach;
1672         }
1673
1674         status = ath10k_htt_rx_alloc(&ar->htt);
1675         if (status) {
1676                 ath10k_err(ar, "failed to alloc htt rx: %d\n", status);
1677                 goto err_htt_tx_detach;
1678         }
1679
1680         status = ath10k_hif_start(ar);
1681         if (status) {
1682                 ath10k_err(ar, "could not start HIF: %d\n", status);
1683                 goto err_htt_rx_detach;
1684         }
1685
1686         status = ath10k_htc_wait_target(&ar->htc);
1687         if (status) {
1688                 ath10k_err(ar, "failed to connect to HTC: %d\n", status);
1689                 goto err_hif_stop;
1690         }
1691
1692         if (mode == ATH10K_FIRMWARE_MODE_NORMAL) {
1693                 status = ath10k_htt_connect(&ar->htt);
1694                 if (status) {
1695                         ath10k_err(ar, "failed to connect htt (%d)\n", status);
1696                         goto err_hif_stop;
1697                 }
1698         }
1699
1700         status = ath10k_wmi_connect(ar);
1701         if (status) {
1702                 ath10k_err(ar, "could not connect wmi: %d\n", status);
1703                 goto err_hif_stop;
1704         }
1705
1706         status = ath10k_htc_start(&ar->htc);
1707         if (status) {
1708                 ath10k_err(ar, "failed to start htc: %d\n", status);
1709                 goto err_hif_stop;
1710         }
1711
1712         if (mode == ATH10K_FIRMWARE_MODE_NORMAL) {
1713                 status = ath10k_wmi_wait_for_service_ready(ar);
1714                 if (status) {
1715                         ath10k_warn(ar, "wmi service ready event not received");
1716                         goto err_hif_stop;
1717                 }
1718         }
1719
1720         ath10k_dbg(ar, ATH10K_DBG_BOOT, "firmware %s booted\n",
1721                    ar->hw->wiphy->fw_version);
1722
1723         if (test_bit(WMI_SERVICE_EXT_RES_CFG_SUPPORT, ar->wmi.svc_map)) {
1724                 val = 0;
1725                 if (ath10k_peer_stats_enabled(ar))
1726                         val = WMI_10_4_PEER_STATS;
1727
1728                 status = ath10k_mac_ext_resource_config(ar, val);
1729                 if (status) {
1730                         ath10k_err(ar,
1731                                    "failed to send ext resource cfg command : %d\n",
1732                                    status);
1733                         goto err_hif_stop;
1734                 }
1735         }
1736
1737         status = ath10k_wmi_cmd_init(ar);
1738         if (status) {
1739                 ath10k_err(ar, "could not send WMI init command (%d)\n",
1740                            status);
1741                 goto err_hif_stop;
1742         }
1743
1744         status = ath10k_wmi_wait_for_unified_ready(ar);
1745         if (status) {
1746                 ath10k_err(ar, "wmi unified ready event not received\n");
1747                 goto err_hif_stop;
1748         }
1749
1750         /* If firmware indicates Full Rx Reorder support it must be used in a
1751          * slightly different manner. Let HTT code know.
1752          */
1753         ar->htt.rx_ring.in_ord_rx = !!(test_bit(WMI_SERVICE_RX_FULL_REORDER,
1754                                                 ar->wmi.svc_map));
1755
1756         status = ath10k_htt_rx_ring_refill(ar);
1757         if (status) {
1758                 ath10k_err(ar, "failed to refill htt rx ring: %d\n", status);
1759                 goto err_hif_stop;
1760         }
1761
1762         /* we don't care about HTT in UTF mode */
1763         if (mode == ATH10K_FIRMWARE_MODE_NORMAL) {
1764                 status = ath10k_htt_setup(&ar->htt);
1765                 if (status) {
1766                         ath10k_err(ar, "failed to setup htt: %d\n", status);
1767                         goto err_hif_stop;
1768                 }
1769         }
1770
1771         status = ath10k_debug_start(ar);
1772         if (status)
1773                 goto err_hif_stop;
1774
1775         ar->free_vdev_map = (1LL << ar->max_num_vdevs) - 1;
1776
1777         INIT_LIST_HEAD(&ar->arvifs);
1778
1779         return 0;
1780
1781 err_hif_stop:
1782         ath10k_hif_stop(ar);
1783 err_htt_rx_detach:
1784         ath10k_htt_rx_free(&ar->htt);
1785 err_htt_tx_detach:
1786         ath10k_htt_tx_free(&ar->htt);
1787 err_wmi_detach:
1788         ath10k_wmi_detach(ar);
1789 err:
1790         return status;
1791 }
1792 EXPORT_SYMBOL(ath10k_core_start);
1793
1794 int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt)
1795 {
1796         int ret;
1797         unsigned long time_left;
1798
1799         reinit_completion(&ar->target_suspend);
1800
1801         ret = ath10k_wmi_pdev_suspend_target(ar, suspend_opt);
1802         if (ret) {
1803                 ath10k_warn(ar, "could not suspend target (%d)\n", ret);
1804                 return ret;
1805         }
1806
1807         time_left = wait_for_completion_timeout(&ar->target_suspend, 1 * HZ);
1808
1809         if (!time_left) {
1810                 ath10k_warn(ar, "suspend timed out - target pause event never came\n");
1811                 return -ETIMEDOUT;
1812         }
1813
1814         return 0;
1815 }
1816
1817 void ath10k_core_stop(struct ath10k *ar)
1818 {
1819         lockdep_assert_held(&ar->conf_mutex);
1820         ath10k_debug_stop(ar);
1821
1822         /* try to suspend target */
1823         if (ar->state != ATH10K_STATE_RESTARTING &&
1824             ar->state != ATH10K_STATE_UTF)
1825                 ath10k_wait_for_suspend(ar, WMI_PDEV_SUSPEND_AND_DISABLE_INTR);
1826
1827         ath10k_hif_stop(ar);
1828         ath10k_htt_tx_free(&ar->htt);
1829         ath10k_htt_rx_free(&ar->htt);
1830         ath10k_wmi_detach(ar);
1831 }
1832 EXPORT_SYMBOL(ath10k_core_stop);
1833
1834 /* mac80211 manages fw/hw initialization through start/stop hooks. However in
1835  * order to know what hw capabilities should be advertised to mac80211 it is
1836  * necessary to load the firmware (and tear it down immediately since start
1837  * hook will try to init it again) before registering */
1838 static int ath10k_core_probe_fw(struct ath10k *ar)
1839 {
1840         struct bmi_target_info target_info;
1841         int ret = 0;
1842
1843         ret = ath10k_hif_power_up(ar);
1844         if (ret) {
1845                 ath10k_err(ar, "could not start pci hif (%d)\n", ret);
1846                 return ret;
1847         }
1848
1849         memset(&target_info, 0, sizeof(target_info));
1850         ret = ath10k_bmi_get_target_info(ar, &target_info);
1851         if (ret) {
1852                 ath10k_err(ar, "could not get target info (%d)\n", ret);
1853                 goto err_power_down;
1854         }
1855
1856         ar->target_version = target_info.version;
1857         ar->hw->wiphy->hw_version = target_info.version;
1858
1859         ret = ath10k_init_hw_params(ar);
1860         if (ret) {
1861                 ath10k_err(ar, "could not get hw params (%d)\n", ret);
1862                 goto err_power_down;
1863         }
1864
1865         ret = ath10k_core_fetch_firmware_files(ar);
1866         if (ret) {
1867                 ath10k_err(ar, "could not fetch firmware files (%d)\n", ret);
1868                 goto err_power_down;
1869         }
1870
1871         BUILD_BUG_ON(sizeof(ar->hw->wiphy->fw_version) !=
1872                      sizeof(ar->normal_mode_fw.fw_file.fw_version));
1873         memcpy(ar->hw->wiphy->fw_version, ar->normal_mode_fw.fw_file.fw_version,
1874                sizeof(ar->hw->wiphy->fw_version));
1875
1876         ath10k_debug_print_hwfw_info(ar);
1877
1878         ret = ath10k_core_pre_cal_download(ar);
1879         if (ret) {
1880                 /* pre calibration data download is not necessary
1881                  * for all the chipsets. Ignore failures and continue.
1882                  */
1883                 ath10k_dbg(ar, ATH10K_DBG_BOOT,
1884                            "could not load pre cal data: %d\n", ret);
1885         }
1886
1887         ret = ath10k_core_get_board_id_from_otp(ar);
1888         if (ret && ret != -EOPNOTSUPP) {
1889                 ath10k_err(ar, "failed to get board id from otp: %d\n",
1890                            ret);
1891                 goto err_free_firmware_files;
1892         }
1893
1894         ret = ath10k_core_fetch_board_file(ar);
1895         if (ret) {
1896                 ath10k_err(ar, "failed to fetch board file: %d\n", ret);
1897                 goto err_free_firmware_files;
1898         }
1899
1900         ath10k_debug_print_board_info(ar);
1901
1902         ret = ath10k_core_init_firmware_features(ar);
1903         if (ret) {
1904                 ath10k_err(ar, "fatal problem with firmware features: %d\n",
1905                            ret);
1906                 goto err_free_firmware_files;
1907         }
1908
1909         ret = ath10k_swap_code_seg_init(ar);
1910         if (ret) {
1911                 ath10k_err(ar, "failed to initialize code swap segment: %d\n",
1912                            ret);
1913                 goto err_free_firmware_files;
1914         }
1915
1916         mutex_lock(&ar->conf_mutex);
1917
1918         ret = ath10k_core_start(ar, ATH10K_FIRMWARE_MODE_NORMAL,
1919                                 &ar->normal_mode_fw);
1920         if (ret) {
1921                 ath10k_err(ar, "could not init core (%d)\n", ret);
1922                 goto err_unlock;
1923         }
1924
1925         ath10k_debug_print_boot_info(ar);
1926         ath10k_core_stop(ar);
1927
1928         mutex_unlock(&ar->conf_mutex);
1929
1930         ath10k_hif_power_down(ar);
1931         return 0;
1932
1933 err_unlock:
1934         mutex_unlock(&ar->conf_mutex);
1935
1936 err_free_firmware_files:
1937         ath10k_core_free_firmware_files(ar);
1938
1939 err_power_down:
1940         ath10k_hif_power_down(ar);
1941
1942         return ret;
1943 }
1944
1945 static void ath10k_core_register_work(struct work_struct *work)
1946 {
1947         struct ath10k *ar = container_of(work, struct ath10k, register_work);
1948         int status;
1949
1950         status = ath10k_core_probe_fw(ar);
1951         if (status) {
1952                 ath10k_err(ar, "could not probe fw (%d)\n", status);
1953                 goto err;
1954         }
1955
1956         status = ath10k_mac_register(ar);
1957         if (status) {
1958                 ath10k_err(ar, "could not register to mac80211 (%d)\n", status);
1959                 goto err_release_fw;
1960         }
1961
1962         status = ath10k_debug_register(ar);
1963         if (status) {
1964                 ath10k_err(ar, "unable to initialize debugfs\n");
1965                 goto err_unregister_mac;
1966         }
1967
1968         status = ath10k_spectral_create(ar);
1969         if (status) {
1970                 ath10k_err(ar, "failed to initialize spectral\n");
1971                 goto err_debug_destroy;
1972         }
1973
1974         status = ath10k_thermal_register(ar);
1975         if (status) {
1976                 ath10k_err(ar, "could not register thermal device: %d\n",
1977                            status);
1978                 goto err_spectral_destroy;
1979         }
1980
1981         set_bit(ATH10K_FLAG_CORE_REGISTERED, &ar->dev_flags);
1982         return;
1983
1984 err_spectral_destroy:
1985         ath10k_spectral_destroy(ar);
1986 err_debug_destroy:
1987         ath10k_debug_destroy(ar);
1988 err_unregister_mac:
1989         ath10k_mac_unregister(ar);
1990 err_release_fw:
1991         ath10k_core_free_firmware_files(ar);
1992 err:
1993         /* TODO: It's probably a good idea to release device from the driver
1994          * but calling device_release_driver() here will cause a deadlock.
1995          */
1996         return;
1997 }
1998
1999 int ath10k_core_register(struct ath10k *ar, u32 chip_id)
2000 {
2001         ar->chip_id = chip_id;
2002         queue_work(ar->workqueue, &ar->register_work);
2003
2004         return 0;
2005 }
2006 EXPORT_SYMBOL(ath10k_core_register);
2007
2008 void ath10k_core_unregister(struct ath10k *ar)
2009 {
2010         cancel_work_sync(&ar->register_work);
2011
2012         if (!test_bit(ATH10K_FLAG_CORE_REGISTERED, &ar->dev_flags))
2013                 return;
2014
2015         ath10k_thermal_unregister(ar);
2016         /* Stop spectral before unregistering from mac80211 to remove the
2017          * relayfs debugfs file cleanly. Otherwise the parent debugfs tree
2018          * would be already be free'd recursively, leading to a double free.
2019          */
2020         ath10k_spectral_destroy(ar);
2021
2022         /* We must unregister from mac80211 before we stop HTC and HIF.
2023          * Otherwise we will fail to submit commands to FW and mac80211 will be
2024          * unhappy about callback failures. */
2025         ath10k_mac_unregister(ar);
2026
2027         ath10k_testmode_destroy(ar);
2028
2029         ath10k_core_free_firmware_files(ar);
2030         ath10k_core_free_board_files(ar);
2031
2032         ath10k_debug_unregister(ar);
2033 }
2034 EXPORT_SYMBOL(ath10k_core_unregister);
2035
2036 struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
2037                                   enum ath10k_bus bus,
2038                                   enum ath10k_hw_rev hw_rev,
2039                                   const struct ath10k_hif_ops *hif_ops)
2040 {
2041         struct ath10k *ar;
2042         int ret;
2043
2044         ar = ath10k_mac_create(priv_size);
2045         if (!ar)
2046                 return NULL;
2047
2048         ar->ath_common.priv = ar;
2049         ar->ath_common.hw = ar->hw;
2050         ar->dev = dev;
2051         ar->hw_rev = hw_rev;
2052         ar->hif.ops = hif_ops;
2053         ar->hif.bus = bus;
2054
2055         switch (hw_rev) {
2056         case ATH10K_HW_QCA988X:
2057                 ar->regs = &qca988x_regs;
2058                 ar->hw_values = &qca988x_values;
2059                 break;
2060         case ATH10K_HW_QCA6174:
2061         case ATH10K_HW_QCA9377:
2062                 ar->regs = &qca6174_regs;
2063                 ar->hw_values = &qca6174_values;
2064                 break;
2065         case ATH10K_HW_QCA99X0:
2066                 ar->regs = &qca99x0_regs;
2067                 ar->hw_values = &qca99x0_values;
2068                 break;
2069         case ATH10K_HW_QCA4019:
2070                 ar->regs = &qca4019_regs;
2071                 ar->hw_values = &qca4019_values;
2072                 break;
2073         default:
2074                 ath10k_err(ar, "unsupported core hardware revision %d\n",
2075                            hw_rev);
2076                 ret = -ENOTSUPP;
2077                 goto err_free_mac;
2078         }
2079
2080         init_completion(&ar->scan.started);
2081         init_completion(&ar->scan.completed);
2082         init_completion(&ar->scan.on_channel);
2083         init_completion(&ar->target_suspend);
2084         init_completion(&ar->wow.wakeup_completed);
2085
2086         init_completion(&ar->install_key_done);
2087         init_completion(&ar->vdev_setup_done);
2088         init_completion(&ar->thermal.wmi_sync);
2089
2090         INIT_DELAYED_WORK(&ar->scan.timeout, ath10k_scan_timeout_work);
2091
2092         ar->workqueue = create_singlethread_workqueue("ath10k_wq");
2093         if (!ar->workqueue)
2094                 goto err_free_mac;
2095
2096         ar->workqueue_aux = create_singlethread_workqueue("ath10k_aux_wq");
2097         if (!ar->workqueue_aux)
2098                 goto err_free_wq;
2099
2100         mutex_init(&ar->conf_mutex);
2101         spin_lock_init(&ar->data_lock);
2102         spin_lock_init(&ar->txqs_lock);
2103
2104         INIT_LIST_HEAD(&ar->txqs);
2105         INIT_LIST_HEAD(&ar->peers);
2106         init_waitqueue_head(&ar->peer_mapping_wq);
2107         init_waitqueue_head(&ar->htt.empty_tx_wq);
2108         init_waitqueue_head(&ar->wmi.tx_credits_wq);
2109
2110         init_completion(&ar->offchan_tx_completed);
2111         INIT_WORK(&ar->offchan_tx_work, ath10k_offchan_tx_work);
2112         skb_queue_head_init(&ar->offchan_tx_queue);
2113
2114         INIT_WORK(&ar->wmi_mgmt_tx_work, ath10k_mgmt_over_wmi_tx_work);
2115         skb_queue_head_init(&ar->wmi_mgmt_tx_queue);
2116
2117         INIT_WORK(&ar->register_work, ath10k_core_register_work);
2118         INIT_WORK(&ar->restart_work, ath10k_core_restart);
2119
2120         ret = ath10k_debug_create(ar);
2121         if (ret)
2122                 goto err_free_aux_wq;
2123
2124         return ar;
2125
2126 err_free_aux_wq:
2127         destroy_workqueue(ar->workqueue_aux);
2128 err_free_wq:
2129         destroy_workqueue(ar->workqueue);
2130
2131 err_free_mac:
2132         ath10k_mac_destroy(ar);
2133
2134         return NULL;
2135 }
2136 EXPORT_SYMBOL(ath10k_core_create);
2137
2138 void ath10k_core_destroy(struct ath10k *ar)
2139 {
2140         flush_workqueue(ar->workqueue);
2141         destroy_workqueue(ar->workqueue);
2142
2143         flush_workqueue(ar->workqueue_aux);
2144         destroy_workqueue(ar->workqueue_aux);
2145
2146         ath10k_debug_destroy(ar);
2147         ath10k_wmi_free_host_mem(ar);
2148         ath10k_mac_destroy(ar);
2149 }
2150 EXPORT_SYMBOL(ath10k_core_destroy);
2151
2152 MODULE_AUTHOR("Qualcomm Atheros");
2153 MODULE_DESCRIPTION("Core module for QCA988X PCIe devices.");
2154 MODULE_LICENSE("Dual BSD/GPL");