2 * Copyright (c) 2005-2011 Atheros Communications Inc.
3 * Copyright (c) 2011-2013 Qualcomm Atheros, Inc.
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.
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.
18 #include <linux/module.h>
19 #include <linux/firmware.h>
30 unsigned int ath10k_debug_mask;
31 static bool uart_print;
32 static unsigned int ath10k_p2p;
33 module_param_named(debug_mask, ath10k_debug_mask, uint, 0644);
34 module_param(uart_print, bool, 0644);
35 module_param_named(p2p, ath10k_p2p, uint, 0644);
36 MODULE_PARM_DESC(debug_mask, "Debugging mask");
37 MODULE_PARM_DESC(uart_print, "Uart target debugging");
38 MODULE_PARM_DESC(p2p, "Enable ath10k P2P support");
40 static const struct ath10k_hw_params ath10k_hw_params_list[] = {
42 .id = QCA988X_HW_2_0_VERSION,
43 .name = "qca988x hw2.0",
44 .patch_load_addr = QCA988X_HW_2_0_PATCH_LOAD_ADDR,
46 .dir = QCA988X_HW_2_0_FW_DIR,
47 .fw = QCA988X_HW_2_0_FW_FILE,
48 .otp = QCA988X_HW_2_0_OTP_FILE,
49 .board = QCA988X_HW_2_0_BOARD_DATA_FILE,
54 static void ath10k_send_suspend_complete(struct ath10k *ar)
56 ath10k_dbg(ATH10K_DBG_BOOT, "boot suspend complete\n");
58 ar->is_target_paused = true;
59 wake_up(&ar->event_queue);
62 static int ath10k_check_fw_version(struct ath10k *ar)
66 if (ar->fw_version_major >= SUPPORTED_FW_MAJOR &&
67 ar->fw_version_minor >= SUPPORTED_FW_MINOR &&
68 ar->fw_version_release >= SUPPORTED_FW_RELEASE &&
69 ar->fw_version_build >= SUPPORTED_FW_BUILD)
72 snprintf(version, sizeof(version), "%u.%u.%u.%u",
73 SUPPORTED_FW_MAJOR, SUPPORTED_FW_MINOR,
74 SUPPORTED_FW_RELEASE, SUPPORTED_FW_BUILD);
76 ath10k_warn("WARNING: Firmware version %s is not officially supported.\n",
77 ar->hw->wiphy->fw_version);
78 ath10k_warn("Please upgrade to version %s (or newer)\n", version);
83 static int ath10k_init_connect_htc(struct ath10k *ar)
87 status = ath10k_wmi_connect_htc_service(ar);
92 status = ath10k_htc_start(&ar->htc);
96 /* Wait for WMI event to be ready */
97 status = ath10k_wmi_wait_for_service_ready(ar);
99 ath10k_warn("wmi service ready event not received");
104 ath10k_dbg(ATH10K_DBG_BOOT, "boot wmi ready\n");
108 ath10k_htc_stop(&ar->htc);
113 static int ath10k_init_configure_target(struct ath10k *ar)
118 /* tell target which HTC version it is used*/
119 ret = ath10k_bmi_write32(ar, hi_app_host_interest,
120 HTC_PROTOCOL_VERSION);
122 ath10k_err("settings HTC version failed\n");
126 /* set the firmware mode to STA/IBSS/AP */
127 ret = ath10k_bmi_read32(ar, hi_option_flag, ¶m_host);
129 ath10k_err("setting firmware mode (1/2) failed\n");
133 /* TODO following parameters need to be re-visited. */
135 param_host |= (1 << HI_OPTION_NUM_DEV_SHIFT);
137 /* FIXME: Why FW_MODE_AP ??.*/
138 param_host |= (HI_OPTION_FW_MODE_AP << HI_OPTION_FW_MODE_SHIFT);
139 /* mac_addr_method */
140 param_host |= (1 << HI_OPTION_MAC_ADDR_METHOD_SHIFT);
141 /* firmware_bridge */
142 param_host |= (0 << HI_OPTION_FW_BRIDGE_SHIFT);
144 param_host |= (0 << HI_OPTION_FW_SUBMODE_SHIFT);
146 ret = ath10k_bmi_write32(ar, hi_option_flag, param_host);
148 ath10k_err("setting firmware mode (2/2) failed\n");
152 /* We do all byte-swapping on the host */
153 ret = ath10k_bmi_write32(ar, hi_be, 0);
155 ath10k_err("setting host CPU BE mode failed\n");
159 /* FW descriptor/Data swap flags */
160 ret = ath10k_bmi_write32(ar, hi_fw_swap, 0);
163 ath10k_err("setting FW data/desc swap flags failed\n");
170 static const struct firmware *ath10k_fetch_fw_file(struct ath10k *ar,
175 const struct firmware *fw;
179 return ERR_PTR(-ENOENT);
184 snprintf(filename, sizeof(filename), "%s/%s", dir, file);
185 ret = request_firmware(&fw, filename, ar->dev);
192 static int ath10k_push_board_ext_data(struct ath10k *ar,
193 const struct firmware *fw)
195 u32 board_data_size = QCA988X_BOARD_DATA_SZ;
196 u32 board_ext_data_size = QCA988X_BOARD_EXT_DATA_SZ;
197 u32 board_ext_data_addr;
200 ret = ath10k_bmi_read32(ar, hi_board_ext_data, &board_ext_data_addr);
202 ath10k_err("could not read board ext data addr (%d)\n", ret);
206 ath10k_dbg(ATH10K_DBG_BOOT,
207 "boot push board extended data addr 0x%x\n",
208 board_ext_data_addr);
210 if (board_ext_data_addr == 0)
213 if (fw->size != (board_data_size + board_ext_data_size)) {
214 ath10k_err("invalid board (ext) data sizes %zu != %d+%d\n",
215 fw->size, board_data_size, board_ext_data_size);
219 ret = ath10k_bmi_write_memory(ar, board_ext_data_addr,
220 fw->data + board_data_size,
221 board_ext_data_size);
223 ath10k_err("could not write board ext data (%d)\n", ret);
227 ret = ath10k_bmi_write32(ar, hi_board_ext_data_config,
228 (board_ext_data_size << 16) | 1);
230 ath10k_err("could not write board ext data bit (%d)\n", ret);
237 static int ath10k_download_board_data(struct ath10k *ar)
239 const struct firmware *fw = ar->board_data;
240 u32 board_data_size = QCA988X_BOARD_DATA_SZ;
244 ret = ath10k_push_board_ext_data(ar, fw);
246 ath10k_err("could not push board ext data (%d)\n", ret);
250 ret = ath10k_bmi_read32(ar, hi_board_data, &address);
252 ath10k_err("could not read board data addr (%d)\n", ret);
256 ret = ath10k_bmi_write_memory(ar, address, fw->data,
257 min_t(u32, board_data_size, fw->size));
259 ath10k_err("could not write board data (%d)\n", ret);
263 ret = ath10k_bmi_write32(ar, hi_board_data_initialized, 1);
265 ath10k_err("could not write board data bit (%d)\n", ret);
273 static int ath10k_download_and_run_otp(struct ath10k *ar)
275 const struct firmware *fw = ar->otp;
276 u32 address = ar->hw_params.patch_load_addr;
280 /* OTP is optional */
285 ret = ath10k_bmi_fast_download(ar, address, fw->data, fw->size);
287 ath10k_err("could not write otp (%d)\n", ret);
292 ret = ath10k_bmi_execute(ar, address, &exec_param);
294 ath10k_err("could not execute otp (%d)\n", ret);
302 static int ath10k_download_fw(struct ath10k *ar)
304 const struct firmware *fw = ar->firmware;
308 address = ar->hw_params.patch_load_addr;
310 ret = ath10k_bmi_fast_download(ar, address, fw->data, fw->size);
312 ath10k_err("could not write fw (%d)\n", ret);
320 static void ath10k_core_free_firmware_files(struct ath10k *ar)
322 if (ar->board_data && !IS_ERR(ar->board_data))
323 release_firmware(ar->board_data);
325 if (ar->otp && !IS_ERR(ar->otp))
326 release_firmware(ar->otp);
328 if (ar->firmware && !IS_ERR(ar->firmware))
329 release_firmware(ar->firmware);
331 ar->board_data = NULL;
336 static int ath10k_core_fetch_firmware_files(struct ath10k *ar)
340 if (ar->hw_params.fw.fw == NULL) {
341 ath10k_err("firmware file not defined\n");
345 if (ar->hw_params.fw.board == NULL) {
346 ath10k_err("board data file not defined");
350 ar->board_data = ath10k_fetch_fw_file(ar,
351 ar->hw_params.fw.dir,
352 ar->hw_params.fw.board);
353 if (IS_ERR(ar->board_data)) {
354 ret = PTR_ERR(ar->board_data);
355 ath10k_err("could not fetch board data (%d)\n", ret);
359 ar->firmware = ath10k_fetch_fw_file(ar,
360 ar->hw_params.fw.dir,
361 ar->hw_params.fw.fw);
362 if (IS_ERR(ar->firmware)) {
363 ret = PTR_ERR(ar->firmware);
364 ath10k_err("could not fetch firmware (%d)\n", ret);
368 /* OTP may be undefined. If so, don't fetch it at all */
369 if (ar->hw_params.fw.otp == NULL)
372 ar->otp = ath10k_fetch_fw_file(ar,
373 ar->hw_params.fw.dir,
374 ar->hw_params.fw.otp);
375 if (IS_ERR(ar->otp)) {
376 ret = PTR_ERR(ar->otp);
377 ath10k_err("could not fetch otp (%d)\n", ret);
384 ath10k_core_free_firmware_files(ar);
388 static int ath10k_init_download_firmware(struct ath10k *ar)
392 ret = ath10k_download_board_data(ar);
396 ret = ath10k_download_and_run_otp(ar);
400 ret = ath10k_download_fw(ar);
407 static int ath10k_init_uart(struct ath10k *ar)
412 * Explicitly setting UART prints to zero as target turns it on
413 * based on scratch registers.
415 ret = ath10k_bmi_write32(ar, hi_serial_enable, 0);
417 ath10k_warn("could not disable UART prints (%d)\n", ret);
422 ath10k_info("UART prints disabled\n");
426 ret = ath10k_bmi_write32(ar, hi_dbg_uart_txpin, 7);
428 ath10k_warn("could not enable UART prints (%d)\n", ret);
432 ret = ath10k_bmi_write32(ar, hi_serial_enable, 1);
434 ath10k_warn("could not enable UART prints (%d)\n", ret);
438 /* Set the UART baud rate to 19200. */
439 ret = ath10k_bmi_write32(ar, hi_desired_baud_rate, 19200);
441 ath10k_warn("could not set the baud rate (%d)\n", ret);
445 ath10k_info("UART prints enabled\n");
449 static int ath10k_init_hw_params(struct ath10k *ar)
451 const struct ath10k_hw_params *uninitialized_var(hw_params);
454 for (i = 0; i < ARRAY_SIZE(ath10k_hw_params_list); i++) {
455 hw_params = &ath10k_hw_params_list[i];
457 if (hw_params->id == ar->target_version)
461 if (i == ARRAY_SIZE(ath10k_hw_params_list)) {
462 ath10k_err("Unsupported hardware version: 0x%x\n",
467 ar->hw_params = *hw_params;
469 ath10k_info("Hardware name %s version 0x%x\n",
470 ar->hw_params.name, ar->target_version);
475 static void ath10k_core_restart(struct work_struct *work)
477 struct ath10k *ar = container_of(work, struct ath10k, restart_work);
479 mutex_lock(&ar->conf_mutex);
482 case ATH10K_STATE_ON:
484 ar->state = ATH10K_STATE_RESTARTING;
485 ieee80211_restart_hw(ar->hw);
487 case ATH10K_STATE_OFF:
488 /* this can happen if driver is being unloaded */
489 ath10k_warn("cannot restart a device that hasn't been started\n");
491 case ATH10K_STATE_RESTARTING:
492 case ATH10K_STATE_RESTARTED:
493 ar->state = ATH10K_STATE_WEDGED;
495 case ATH10K_STATE_WEDGED:
496 ath10k_warn("device is wedged, will not restart\n");
500 mutex_unlock(&ar->conf_mutex);
503 struct ath10k *ath10k_core_create(void *hif_priv, struct device *dev,
504 const struct ath10k_hif_ops *hif_ops)
508 ar = ath10k_mac_create();
512 ar->ath_common.priv = ar;
513 ar->ath_common.hw = ar->hw;
515 ar->p2p = !!ath10k_p2p;
518 ar->hif.priv = hif_priv;
519 ar->hif.ops = hif_ops;
521 init_completion(&ar->scan.started);
522 init_completion(&ar->scan.completed);
523 init_completion(&ar->scan.on_channel);
525 init_completion(&ar->install_key_done);
526 init_completion(&ar->vdev_setup_done);
528 setup_timer(&ar->scan.timeout, ath10k_reset_scan, (unsigned long)ar);
530 ar->workqueue = create_singlethread_workqueue("ath10k_wq");
534 mutex_init(&ar->conf_mutex);
535 spin_lock_init(&ar->data_lock);
537 INIT_LIST_HEAD(&ar->peers);
538 init_waitqueue_head(&ar->peer_mapping_wq);
540 init_completion(&ar->offchan_tx_completed);
541 INIT_WORK(&ar->offchan_tx_work, ath10k_offchan_tx_work);
542 skb_queue_head_init(&ar->offchan_tx_queue);
544 init_waitqueue_head(&ar->event_queue);
546 INIT_WORK(&ar->restart_work, ath10k_core_restart);
551 ath10k_mac_destroy(ar);
554 EXPORT_SYMBOL(ath10k_core_create);
556 void ath10k_core_destroy(struct ath10k *ar)
558 flush_workqueue(ar->workqueue);
559 destroy_workqueue(ar->workqueue);
561 ath10k_mac_destroy(ar);
563 EXPORT_SYMBOL(ath10k_core_destroy);
565 int ath10k_core_start(struct ath10k *ar)
569 ath10k_bmi_start(ar);
571 if (ath10k_init_configure_target(ar)) {
576 status = ath10k_init_download_firmware(ar);
580 status = ath10k_init_uart(ar);
584 ar->htc.htc_ops.target_send_suspend_complete =
585 ath10k_send_suspend_complete;
587 status = ath10k_htc_init(ar);
589 ath10k_err("could not init HTC (%d)\n", status);
593 status = ath10k_bmi_done(ar);
597 status = ath10k_wmi_attach(ar);
599 ath10k_err("WMI attach failed: %d\n", status);
603 status = ath10k_htc_wait_target(&ar->htc);
607 status = ath10k_htt_attach(ar);
609 ath10k_err("could not attach htt (%d)\n", status);
613 status = ath10k_init_connect_htc(ar);
617 ath10k_info("firmware %s booted\n", ar->hw->wiphy->fw_version);
619 status = ath10k_check_fw_version(ar);
621 goto err_disconnect_htc;
623 status = ath10k_wmi_cmd_init(ar);
625 ath10k_err("could not send WMI init command (%d)\n", status);
626 goto err_disconnect_htc;
629 status = ath10k_wmi_wait_for_unified_ready(ar);
631 ath10k_err("wmi unified ready event not received\n");
633 goto err_disconnect_htc;
636 status = ath10k_htt_attach_target(&ar->htt);
638 goto err_disconnect_htc;
640 status = ath10k_debug_start(ar);
642 goto err_disconnect_htc;
644 ar->free_vdev_map = (1 << TARGET_NUM_VDEVS) - 1;
649 ath10k_htc_stop(&ar->htc);
651 ath10k_htt_detach(&ar->htt);
653 ath10k_wmi_detach(ar);
657 EXPORT_SYMBOL(ath10k_core_start);
659 void ath10k_core_stop(struct ath10k *ar)
661 ath10k_debug_stop(ar);
662 ath10k_htc_stop(&ar->htc);
663 ath10k_htt_detach(&ar->htt);
664 ath10k_wmi_detach(ar);
666 EXPORT_SYMBOL(ath10k_core_stop);
668 /* mac80211 manages fw/hw initialization through start/stop hooks. However in
669 * order to know what hw capabilities should be advertised to mac80211 it is
670 * necessary to load the firmware (and tear it down immediately since start
671 * hook will try to init it again) before registering */
672 static int ath10k_core_probe_fw(struct ath10k *ar)
674 struct bmi_target_info target_info;
677 ret = ath10k_hif_power_up(ar);
679 ath10k_err("could not start pci hif (%d)\n", ret);
683 memset(&target_info, 0, sizeof(target_info));
684 ret = ath10k_bmi_get_target_info(ar, &target_info);
686 ath10k_err("could not get target info (%d)\n", ret);
687 ath10k_hif_power_down(ar);
691 ar->target_version = target_info.version;
692 ar->hw->wiphy->hw_version = target_info.version;
694 ret = ath10k_init_hw_params(ar);
696 ath10k_err("could not get hw params (%d)\n", ret);
697 ath10k_hif_power_down(ar);
701 ret = ath10k_core_fetch_firmware_files(ar);
703 ath10k_err("could not fetch firmware files (%d)\n", ret);
704 ath10k_hif_power_down(ar);
708 ret = ath10k_core_start(ar);
710 ath10k_err("could not init core (%d)\n", ret);
711 ath10k_core_free_firmware_files(ar);
712 ath10k_hif_power_down(ar);
716 ath10k_core_stop(ar);
717 ath10k_hif_power_down(ar);
721 static int ath10k_core_check_chip_id(struct ath10k *ar)
723 u32 hw_revision = MS(ar->chip_id, SOC_CHIP_ID_REV);
725 ath10k_dbg(ATH10K_DBG_BOOT, "boot chip_id 0x%08x hw_revision 0x%x\n",
726 ar->chip_id, hw_revision);
728 /* Check that we are not using hw1.0 (some of them have same pci id
729 * as hw2.0) before doing anything else as ath10k crashes horribly
730 * due to missing hw1.0 workarounds. */
731 switch (hw_revision) {
732 case QCA988X_HW_1_0_CHIP_ID_REV:
733 ath10k_err("ERROR: qca988x hw1.0 is not supported\n");
736 case QCA988X_HW_2_0_CHIP_ID_REV:
737 /* known hardware revision, continue normally */
741 ath10k_warn("Warning: hardware revision unknown (0x%x), expect problems\n",
749 int ath10k_core_register(struct ath10k *ar, u32 chip_id)
753 ar->chip_id = chip_id;
755 status = ath10k_core_check_chip_id(ar);
757 ath10k_err("Unsupported chip id 0x%08x\n", ar->chip_id);
761 status = ath10k_core_probe_fw(ar);
763 ath10k_err("could not probe fw (%d)\n", status);
767 status = ath10k_mac_register(ar);
769 ath10k_err("could not register to mac80211 (%d)\n", status);
773 status = ath10k_debug_create(ar);
775 ath10k_err("unable to initialize debugfs\n");
776 goto err_unregister_mac;
782 ath10k_mac_unregister(ar);
784 ath10k_core_free_firmware_files(ar);
787 EXPORT_SYMBOL(ath10k_core_register);
789 void ath10k_core_unregister(struct ath10k *ar)
791 /* We must unregister from mac80211 before we stop HTC and HIF.
792 * Otherwise we will fail to submit commands to FW and mac80211 will be
793 * unhappy about callback failures. */
794 ath10k_mac_unregister(ar);
796 ath10k_core_free_firmware_files(ar);
798 EXPORT_SYMBOL(ath10k_core_unregister);
800 MODULE_AUTHOR("Qualcomm Atheros");
801 MODULE_DESCRIPTION("Core module for QCA988X PCIe devices.");
802 MODULE_LICENSE("Dual BSD/GPL");