1 // SPDX-License-Identifier: BSD-3-Clause-Clear
3 * Copyright (c) 2018-2019 The Linux Foundation. All rights reserved.
6 #include <linux/module.h>
7 #include <linux/slab.h>
8 #include <linux/remoteproc.h>
9 #include <linux/firmware.h>
16 unsigned int ath11k_debug_mask;
17 module_param_named(debug_mask, ath11k_debug_mask, uint, 0644);
18 MODULE_PARM_DESC(debug_mask, "Debugging mask");
20 static const struct ath11k_hw_params ath11k_hw_params = {
23 .dir = IPQ8074_FW_DIR,
24 .board_size = IPQ8074_MAX_BOARD_DATA_SZ,
25 .cal_size = IPQ8074_MAX_CAL_DATA_SZ,
29 /* Map from pdev index to hw mac index */
30 u8 ath11k_core_get_hw_mac_id(struct ath11k_base *ab, int pdev_idx)
40 ath11k_warn(ab, "Invalid pdev idx %d\n", pdev_idx);
41 return ATH11K_INVALID_HW_MAC_ID;
44 EXPORT_SYMBOL(ath11k_core_get_hw_mac_id);
46 static int ath11k_core_create_board_name(struct ath11k_base *ab, char *name,
49 /* Note: bus is fixed to ahb. When other bus type supported,
52 scnprintf(name, name_len,
53 "bus=ahb,qmi-chip-id=%d,qmi-board-id=%d",
54 ab->qmi.target.chip_id,
55 ab->qmi.target.board_id);
57 ath11k_dbg(ab, ATH11K_DBG_BOOT, "boot using board name '%s'\n", name);
62 static const struct firmware *ath11k_fetch_fw_file(struct ath11k_base *ab,
67 const struct firmware *fw;
71 return ERR_PTR(-ENOENT);
76 snprintf(filename, sizeof(filename), "%s/%s", dir, file);
77 ret = firmware_request_nowarn(&fw, filename, ab->dev);
78 ath11k_dbg(ab, ATH11K_DBG_BOOT, "boot fw request '%s': %d\n",
83 ath11k_warn(ab, "Downloading BDF: %s, size: %zu\n",
89 void ath11k_core_free_bdf(struct ath11k_base *ab, struct ath11k_board_data *bd)
92 release_firmware(bd->fw);
94 memset(bd, 0, sizeof(*bd));
97 static int ath11k_core_parse_bd_ie_board(struct ath11k_base *ab,
98 struct ath11k_board_data *bd,
99 const void *buf, size_t buf_len,
100 const char *boardname,
103 const struct ath11k_fw_ie *hdr;
104 bool name_match_found;
105 int ret, board_ie_id;
107 const void *board_ie_data;
109 name_match_found = false;
111 /* go through ATH11K_BD_IE_BOARD_ elements */
112 while (buf_len > sizeof(struct ath11k_fw_ie)) {
114 board_ie_id = le32_to_cpu(hdr->id);
115 board_ie_len = le32_to_cpu(hdr->len);
116 board_ie_data = hdr->data;
118 buf_len -= sizeof(*hdr);
121 if (buf_len < ALIGN(board_ie_len, 4)) {
122 ath11k_err(ab, "invalid ATH11K_BD_IE_BOARD length: %zu < %zu\n",
123 buf_len, ALIGN(board_ie_len, 4));
128 switch (board_ie_id) {
129 case ATH11K_BD_IE_BOARD_NAME:
130 ath11k_dbg_dump(ab, ATH11K_DBG_BOOT, "board name", "",
131 board_ie_data, board_ie_len);
133 if (board_ie_len != strlen(boardname))
136 ret = memcmp(board_ie_data, boardname, strlen(boardname));
140 name_match_found = true;
141 ath11k_dbg(ab, ATH11K_DBG_BOOT,
142 "boot found match for name '%s'",
145 case ATH11K_BD_IE_BOARD_DATA:
146 if (!name_match_found)
150 ath11k_dbg(ab, ATH11K_DBG_BOOT,
151 "boot found board data for '%s'", boardname);
153 bd->data = board_ie_data;
154 bd->len = board_ie_len;
159 ath11k_warn(ab, "unknown ATH11K_BD_IE_BOARD found: %d\n",
164 /* jump over the padding */
165 board_ie_len = ALIGN(board_ie_len, 4);
167 buf_len -= board_ie_len;
178 static int ath11k_core_fetch_board_data_api_n(struct ath11k_base *ab,
179 struct ath11k_board_data *bd,
180 const char *boardname)
182 size_t len, magic_len;
184 char *filename = ATH11K_BOARD_API2_FILE;
186 struct ath11k_fw_ie *hdr;
190 bd->fw = ath11k_fetch_fw_file(ab,
191 ab->hw_params.fw.dir,
194 return PTR_ERR(bd->fw);
199 /* magic has extra null byte padded */
200 magic_len = strlen(ATH11K_BOARD_MAGIC) + 1;
201 if (len < magic_len) {
202 ath11k_err(ab, "failed to find magic value in %s/%s, file too short: %zu\n",
203 ab->hw_params.fw.dir, filename, len);
208 if (memcmp(data, ATH11K_BOARD_MAGIC, magic_len)) {
209 ath11k_err(ab, "found invalid board magic\n");
214 /* magic is padded to 4 bytes */
215 magic_len = ALIGN(magic_len, 4);
216 if (len < magic_len) {
217 ath11k_err(ab, "failed: %s/%s too small to contain board data, len: %zu\n",
218 ab->hw_params.fw.dir, filename, len);
226 while (len > sizeof(struct ath11k_fw_ie)) {
227 hdr = (struct ath11k_fw_ie *)data;
228 ie_id = le32_to_cpu(hdr->id);
229 ie_len = le32_to_cpu(hdr->len);
234 if (len < ALIGN(ie_len, 4)) {
235 ath11k_err(ab, "invalid length for board ie_id %d ie_len %zu len %zu\n",
241 case ATH11K_BD_IE_BOARD:
242 ret = ath11k_core_parse_bd_ie_board(ab, bd, data,
247 /* no match found, continue */
250 /* there was an error, bail out */
252 /* either found or error, so stop searching */
256 /* jump over the padding */
257 ie_len = ALIGN(ie_len, 4);
264 if (!bd->data || !bd->len) {
266 "failed to fetch board data for %s from %s/%s\n",
267 boardname, ab->hw_params.fw.dir, filename);
275 ath11k_core_free_bdf(ab, bd);
279 static int ath11k_core_fetch_board_data_api_1(struct ath11k_base *ab,
280 struct ath11k_board_data *bd)
282 bd->fw = ath11k_fetch_fw_file(ab,
283 ab->hw_params.fw.dir,
284 ATH11K_DEFAULT_BOARD_FILE);
286 return PTR_ERR(bd->fw);
288 bd->data = bd->fw->data;
289 bd->len = bd->fw->size;
294 #define BOARD_NAME_SIZE 100
295 int ath11k_core_fetch_bdf(struct ath11k_base *ab, struct ath11k_board_data *bd)
297 char boardname[BOARD_NAME_SIZE];
300 ret = ath11k_core_create_board_name(ab, boardname, BOARD_NAME_SIZE);
302 ath11k_err(ab, "failed to create board name: %d", ret);
307 ret = ath11k_core_fetch_board_data_api_n(ab, bd, boardname);
312 ret = ath11k_core_fetch_board_data_api_1(ab, bd);
314 ath11k_err(ab, "failed to fetch board-2.bin or board.bin from %s\n",
315 ab->hw_params.fw.dir);
320 ath11k_dbg(ab, ATH11K_DBG_BOOT, "using board api %d\n", ab->bd_api);
324 static void ath11k_core_stop(struct ath11k_base *ab)
326 if (!test_bit(ATH11K_FLAG_CRASH_FLUSH, &ab->dev_flags))
327 ath11k_qmi_firmware_stop(ab);
329 ath11k_wmi_detach(ab);
330 ath11k_dp_pdev_reo_cleanup(ab);
332 /* De-Init of components as needed */
335 static int ath11k_core_soc_create(struct ath11k_base *ab)
339 ret = ath11k_qmi_init_service(ab);
341 ath11k_err(ab, "failed to initialize qmi :%d\n", ret);
345 ret = ath11k_debug_soc_create(ab);
347 ath11k_err(ab, "failed to create ath11k debugfs\n");
351 ret = ath11k_hif_power_up(ab);
353 ath11k_err(ab, "failed to power up :%d\n", ret);
354 goto err_debugfs_reg;
360 ath11k_debug_soc_destroy(ab);
362 ath11k_qmi_deinit_service(ab);
366 static void ath11k_core_soc_destroy(struct ath11k_base *ab)
368 ath11k_debug_soc_destroy(ab);
371 ath11k_qmi_deinit_service(ab);
374 static int ath11k_core_pdev_create(struct ath11k_base *ab)
378 ret = ath11k_debug_pdev_create(ab);
380 ath11k_err(ab, "failed to create core pdev debugfs: %d\n", ret);
384 ret = ath11k_mac_register(ab);
386 ath11k_err(ab, "failed register the radio with mac80211: %d\n", ret);
390 ret = ath11k_dp_pdev_alloc(ab);
392 ath11k_err(ab, "failed to attach DP pdev: %d\n", ret);
393 goto err_mac_unregister;
396 ret = ath11k_thermal_register(ab);
398 ath11k_err(ab, "could not register thermal device: %d\n",
400 goto err_dp_pdev_free;
403 ret = ath11k_spectral_init(ab);
405 ath11k_err(ab, "failed to init spectral %d\n", ret);
406 goto err_thermal_unregister;
411 err_thermal_unregister:
412 ath11k_thermal_unregister(ab);
414 ath11k_dp_pdev_free(ab);
416 ath11k_mac_unregister(ab);
418 ath11k_debug_pdev_destroy(ab);
423 static void ath11k_core_pdev_destroy(struct ath11k_base *ab)
425 ath11k_spectral_deinit(ab);
426 ath11k_thermal_unregister(ab);
427 ath11k_mac_unregister(ab);
428 ath11k_hif_irq_disable(ab);
429 ath11k_dp_pdev_free(ab);
430 ath11k_debug_pdev_destroy(ab);
433 static int ath11k_core_start(struct ath11k_base *ab,
434 enum ath11k_firmware_mode mode)
438 ret = ath11k_qmi_firmware_start(ab, mode);
440 ath11k_err(ab, "failed to attach wmi: %d\n", ret);
444 ret = ath11k_wmi_attach(ab);
446 ath11k_err(ab, "failed to attach wmi: %d\n", ret);
447 goto err_firmware_stop;
450 ret = ath11k_htc_init(ab);
452 ath11k_err(ab, "failed to init htc: %d\n", ret);
456 ret = ath11k_hif_start(ab);
458 ath11k_err(ab, "failed to start HIF: %d\n", ret);
462 ret = ath11k_htc_wait_target(&ab->htc);
464 ath11k_err(ab, "failed to connect to HTC: %d\n", ret);
468 ret = ath11k_dp_htt_connect(&ab->dp);
470 ath11k_err(ab, "failed to connect to HTT: %d\n", ret);
474 ret = ath11k_wmi_connect(ab);
476 ath11k_err(ab, "failed to connect wmi: %d\n", ret);
480 ret = ath11k_htc_start(&ab->htc);
482 ath11k_err(ab, "failed to start HTC: %d\n", ret);
486 ret = ath11k_wmi_wait_for_service_ready(ab);
488 ath11k_err(ab, "failed to receive wmi service ready event: %d\n",
493 ret = ath11k_mac_allocate(ab);
495 ath11k_err(ab, "failed to create new hw device with mac80211 :%d\n",
500 ath11k_dp_pdev_pre_alloc(ab);
502 ret = ath11k_dp_pdev_reo_setup(ab);
504 ath11k_err(ab, "failed to initialize reo destination rings: %d\n", ret);
505 goto err_mac_destroy;
508 ret = ath11k_wmi_cmd_init(ab);
510 ath11k_err(ab, "failed to send wmi init cmd: %d\n", ret);
511 goto err_reo_cleanup;
514 ret = ath11k_wmi_wait_for_unified_ready(ab);
516 ath11k_err(ab, "failed to receive wmi unified ready event: %d\n",
518 goto err_reo_cleanup;
521 ret = ath11k_dp_tx_htt_h2t_ver_req_msg(ab);
523 ath11k_err(ab, "failed to send htt version request message: %d\n",
525 goto err_reo_cleanup;
531 ath11k_dp_pdev_reo_cleanup(ab);
533 ath11k_mac_destroy(ab);
537 ath11k_wmi_detach(ab);
539 ath11k_qmi_firmware_stop(ab);
544 int ath11k_core_qmi_firmware_ready(struct ath11k_base *ab)
548 ret = ath11k_ce_init_pipes(ab);
550 ath11k_err(ab, "failed to initialize CE: %d\n", ret);
554 ret = ath11k_dp_alloc(ab);
556 ath11k_err(ab, "failed to init DP: %d\n", ret);
560 mutex_lock(&ab->core_lock);
561 ret = ath11k_core_start(ab, ATH11K_FIRMWARE_MODE_NORMAL);
563 ath11k_err(ab, "failed to start core: %d\n", ret);
567 ret = ath11k_core_pdev_create(ab);
569 ath11k_err(ab, "failed to create pdev core: %d\n", ret);
572 ath11k_hif_irq_enable(ab);
573 mutex_unlock(&ab->core_lock);
578 ath11k_core_stop(ab);
579 ath11k_mac_destroy(ab);
582 mutex_unlock(&ab->core_lock);
586 static int ath11k_core_reconfigure_on_crash(struct ath11k_base *ab)
590 mutex_lock(&ab->core_lock);
591 ath11k_thermal_unregister(ab);
592 ath11k_hif_irq_disable(ab);
593 ath11k_dp_pdev_free(ab);
594 ath11k_spectral_deinit(ab);
596 ath11k_wmi_detach(ab);
597 ath11k_dp_pdev_reo_cleanup(ab);
598 mutex_unlock(&ab->core_lock);
601 ath11k_hal_srng_deinit(ab);
603 ab->free_vdev_map = (1LL << (ab->num_radios * TARGET_NUM_VDEVS)) - 1;
605 ret = ath11k_hal_srng_init(ab);
609 clear_bit(ATH11K_FLAG_CRASH_FLUSH, &ab->dev_flags);
611 ret = ath11k_core_qmi_firmware_ready(ab);
613 goto err_hal_srng_deinit;
615 clear_bit(ATH11K_FLAG_RECOVERY, &ab->dev_flags);
620 ath11k_hal_srng_deinit(ab);
624 void ath11k_core_halt(struct ath11k *ar)
626 struct ath11k_base *ab = ar->ab;
628 lockdep_assert_held(&ar->conf_mutex);
630 ar->num_created_vdevs = 0;
631 ar->allocated_vdev_map = 0;
633 ath11k_mac_scan_finish(ar);
634 ath11k_mac_peer_cleanup_all(ar);
635 cancel_delayed_work_sync(&ar->scan.timeout);
636 cancel_work_sync(&ar->regd_update_work);
638 rcu_assign_pointer(ab->pdevs_active[ar->pdev_idx], NULL);
640 INIT_LIST_HEAD(&ar->arvifs);
641 idr_init(&ar->txmgmt_idr);
644 static void ath11k_core_restart(struct work_struct *work)
646 struct ath11k_base *ab = container_of(work, struct ath11k_base, restart_work);
648 struct ath11k_pdev *pdev;
651 spin_lock_bh(&ab->base_lock);
652 ab->stats.fw_crash_counter++;
653 spin_unlock_bh(&ab->base_lock);
655 for (i = 0; i < ab->num_radios; i++) {
656 pdev = &ab->pdevs[i];
658 if (!ar || ar->state == ATH11K_STATE_OFF)
661 ieee80211_stop_queues(ar->hw);
662 ath11k_mac_drain_tx(ar);
663 complete(&ar->scan.started);
664 complete(&ar->scan.completed);
665 complete(&ar->peer_assoc_done);
666 complete(&ar->install_key_done);
667 complete(&ar->vdev_setup_done);
668 complete(&ar->bss_survey_done);
669 complete(&ar->thermal.wmi_sync);
671 wake_up(&ar->dp.tx_empty_waitq);
672 idr_for_each(&ar->txmgmt_idr,
673 ath11k_mac_tx_mgmt_pending_free, ar);
674 idr_destroy(&ar->txmgmt_idr);
677 wake_up(&ab->wmi_ab.tx_credits_wq);
678 wake_up(&ab->peer_mapping_wq);
680 ret = ath11k_core_reconfigure_on_crash(ab);
682 ath11k_err(ab, "failed to reconfigure driver on crash recovery\n");
686 for (i = 0; i < ab->num_radios; i++) {
687 pdev = &ab->pdevs[i];
689 if (!ar || ar->state == ATH11K_STATE_OFF)
692 mutex_lock(&ar->conf_mutex);
695 case ATH11K_STATE_ON:
696 ar->state = ATH11K_STATE_RESTARTING;
697 ath11k_core_halt(ar);
698 ieee80211_restart_hw(ar->hw);
700 case ATH11K_STATE_OFF:
702 "cannot restart radio %d that hasn't been started\n",
705 case ATH11K_STATE_RESTARTING:
707 case ATH11K_STATE_RESTARTED:
708 ar->state = ATH11K_STATE_WEDGED;
710 case ATH11K_STATE_WEDGED:
712 "device is wedged, will not restart radio %d\n", i);
715 mutex_unlock(&ar->conf_mutex);
717 complete(&ab->driver_recovery);
720 int ath11k_core_init(struct ath11k_base *ab)
722 struct device *dev = ab->dev;
723 struct rproc *prproc;
724 phandle rproc_phandle;
727 if (of_property_read_u32(dev->of_node, "qcom,rproc", &rproc_phandle)) {
728 ath11k_err(ab, "failed to get q6_rproc handle\n");
732 prproc = rproc_get_by_phandle(rproc_phandle);
734 ath11k_err(ab, "failed to get rproc\n");
737 ab->tgt_rproc = prproc;
738 ab->hw_params = ath11k_hw_params;
740 ret = ath11k_core_soc_create(ab);
742 ath11k_err(ab, "failed to create soc core: %d\n", ret);
749 void ath11k_core_deinit(struct ath11k_base *ab)
751 mutex_lock(&ab->core_lock);
753 ath11k_core_pdev_destroy(ab);
754 ath11k_core_stop(ab);
756 mutex_unlock(&ab->core_lock);
758 ath11k_hif_power_down(ab);
759 ath11k_mac_destroy(ab);
760 ath11k_core_soc_destroy(ab);
763 void ath11k_core_free(struct ath11k_base *ab)
768 struct ath11k_base *ath11k_core_alloc(struct device *dev, size_t priv_size,
771 struct ath11k_base *ab;
773 ab = kzalloc(sizeof(*ab) + priv_size, GFP_KERNEL);
777 init_completion(&ab->driver_recovery);
779 ab->workqueue = create_singlethread_workqueue("ath11k_wq");
783 mutex_init(&ab->core_lock);
784 spin_lock_init(&ab->base_lock);
786 INIT_LIST_HEAD(&ab->peers);
787 init_waitqueue_head(&ab->peer_mapping_wq);
788 init_waitqueue_head(&ab->wmi_ab.tx_credits_wq);
789 INIT_WORK(&ab->restart_work, ath11k_core_restart);
790 timer_setup(&ab->rx_replenish_retry, ath11k_ce_rx_replenish_retry, 0);