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