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_init_connect_htc(struct ath10k *ar)
66 status = ath10k_wmi_connect_htc_service(ar);
71 status = ath10k_htc_start(&ar->htc);
75 /* Wait for WMI event to be ready */
76 status = ath10k_wmi_wait_for_service_ready(ar);
78 ath10k_warn("wmi service ready event not received");
83 ath10k_dbg(ATH10K_DBG_BOOT, "boot wmi ready\n");
87 ath10k_htc_stop(&ar->htc);
92 static int ath10k_init_configure_target(struct ath10k *ar)
97 /* tell target which HTC version it is used*/
98 ret = ath10k_bmi_write32(ar, hi_app_host_interest,
99 HTC_PROTOCOL_VERSION);
101 ath10k_err("settings HTC version failed\n");
105 /* set the firmware mode to STA/IBSS/AP */
106 ret = ath10k_bmi_read32(ar, hi_option_flag, ¶m_host);
108 ath10k_err("setting firmware mode (1/2) failed\n");
112 /* TODO following parameters need to be re-visited. */
114 param_host |= (1 << HI_OPTION_NUM_DEV_SHIFT);
116 /* FIXME: Why FW_MODE_AP ??.*/
117 param_host |= (HI_OPTION_FW_MODE_AP << HI_OPTION_FW_MODE_SHIFT);
118 /* mac_addr_method */
119 param_host |= (1 << HI_OPTION_MAC_ADDR_METHOD_SHIFT);
120 /* firmware_bridge */
121 param_host |= (0 << HI_OPTION_FW_BRIDGE_SHIFT);
123 param_host |= (0 << HI_OPTION_FW_SUBMODE_SHIFT);
125 ret = ath10k_bmi_write32(ar, hi_option_flag, param_host);
127 ath10k_err("setting firmware mode (2/2) failed\n");
131 /* We do all byte-swapping on the host */
132 ret = ath10k_bmi_write32(ar, hi_be, 0);
134 ath10k_err("setting host CPU BE mode failed\n");
138 /* FW descriptor/Data swap flags */
139 ret = ath10k_bmi_write32(ar, hi_fw_swap, 0);
142 ath10k_err("setting FW data/desc swap flags failed\n");
149 static const struct firmware *ath10k_fetch_fw_file(struct ath10k *ar,
154 const struct firmware *fw;
158 return ERR_PTR(-ENOENT);
163 snprintf(filename, sizeof(filename), "%s/%s", dir, file);
164 ret = request_firmware(&fw, filename, ar->dev);
171 static int ath10k_push_board_ext_data(struct ath10k *ar)
173 u32 board_data_size = QCA988X_BOARD_DATA_SZ;
174 u32 board_ext_data_size = QCA988X_BOARD_EXT_DATA_SZ;
175 u32 board_ext_data_addr;
178 ret = ath10k_bmi_read32(ar, hi_board_ext_data, &board_ext_data_addr);
180 ath10k_err("could not read board ext data addr (%d)\n", ret);
184 ath10k_dbg(ATH10K_DBG_BOOT,
185 "boot push board extended data addr 0x%x\n",
186 board_ext_data_addr);
188 if (board_ext_data_addr == 0)
191 if (ar->board_len != (board_data_size + board_ext_data_size)) {
192 ath10k_err("invalid board (ext) data sizes %zu != %d+%d\n",
193 ar->board_len, board_data_size, board_ext_data_size);
197 ret = ath10k_bmi_write_memory(ar, board_ext_data_addr,
198 ar->board_data + board_data_size,
199 board_ext_data_size);
201 ath10k_err("could not write board ext data (%d)\n", ret);
205 ret = ath10k_bmi_write32(ar, hi_board_ext_data_config,
206 (board_ext_data_size << 16) | 1);
208 ath10k_err("could not write board ext data bit (%d)\n", ret);
215 static int ath10k_download_board_data(struct ath10k *ar)
217 u32 board_data_size = QCA988X_BOARD_DATA_SZ;
221 ret = ath10k_push_board_ext_data(ar);
223 ath10k_err("could not push board ext data (%d)\n", ret);
227 ret = ath10k_bmi_read32(ar, hi_board_data, &address);
229 ath10k_err("could not read board data addr (%d)\n", ret);
233 ret = ath10k_bmi_write_memory(ar, address, ar->board_data,
234 min_t(u32, board_data_size,
237 ath10k_err("could not write board data (%d)\n", ret);
241 ret = ath10k_bmi_write32(ar, hi_board_data_initialized, 1);
243 ath10k_err("could not write board data bit (%d)\n", ret);
251 static int ath10k_download_and_run_otp(struct ath10k *ar)
253 u32 address = ar->hw_params.patch_load_addr;
257 /* OTP is optional */
259 if (!ar->otp_data || !ar->otp_len)
262 ret = ath10k_bmi_fast_download(ar, address, ar->otp_data, ar->otp_len);
264 ath10k_err("could not write otp (%d)\n", ret);
269 ret = ath10k_bmi_execute(ar, address, &exec_param);
271 ath10k_err("could not execute otp (%d)\n", ret);
279 static int ath10k_download_fw(struct ath10k *ar)
284 address = ar->hw_params.patch_load_addr;
286 ret = ath10k_bmi_fast_download(ar, address, ar->firmware_data,
289 ath10k_err("could not write fw (%d)\n", ret);
297 static void ath10k_core_free_firmware_files(struct ath10k *ar)
299 if (ar->board && !IS_ERR(ar->board))
300 release_firmware(ar->board);
302 if (ar->otp && !IS_ERR(ar->otp))
303 release_firmware(ar->otp);
305 if (ar->firmware && !IS_ERR(ar->firmware))
306 release_firmware(ar->firmware);
309 ar->board_data = NULL;
317 ar->firmware_data = NULL;
318 ar->firmware_len = 0;
321 static int ath10k_core_fetch_firmware_api_1(struct ath10k *ar)
325 if (ar->hw_params.fw.fw == NULL) {
326 ath10k_err("firmware file not defined\n");
330 if (ar->hw_params.fw.board == NULL) {
331 ath10k_err("board data file not defined");
335 ar->board = ath10k_fetch_fw_file(ar,
336 ar->hw_params.fw.dir,
337 ar->hw_params.fw.board);
338 if (IS_ERR(ar->board)) {
339 ret = PTR_ERR(ar->board);
340 ath10k_err("could not fetch board data (%d)\n", ret);
344 ar->board_data = ar->board->data;
345 ar->board_len = ar->board->size;
347 ar->firmware = ath10k_fetch_fw_file(ar,
348 ar->hw_params.fw.dir,
349 ar->hw_params.fw.fw);
350 if (IS_ERR(ar->firmware)) {
351 ret = PTR_ERR(ar->firmware);
352 ath10k_err("could not fetch firmware (%d)\n", ret);
356 ar->firmware_data = ar->firmware->data;
357 ar->firmware_len = ar->firmware->size;
359 /* OTP may be undefined. If so, don't fetch it at all */
360 if (ar->hw_params.fw.otp == NULL)
363 ar->otp = ath10k_fetch_fw_file(ar,
364 ar->hw_params.fw.dir,
365 ar->hw_params.fw.otp);
366 if (IS_ERR(ar->otp)) {
367 ret = PTR_ERR(ar->otp);
368 ath10k_err("could not fetch otp (%d)\n", ret);
372 ar->otp_data = ar->otp->data;
373 ar->otp_len = ar->otp->size;
378 ath10k_core_free_firmware_files(ar);
382 static int ath10k_core_fetch_firmware_api_n(struct ath10k *ar, const char *name)
384 size_t magic_len, len, ie_len;
385 int ie_id, i, index, bit, ret;
386 struct ath10k_fw_ie *hdr;
390 /* first fetch the firmware file (firmware-*.bin) */
391 ar->firmware = ath10k_fetch_fw_file(ar, ar->hw_params.fw.dir, name);
392 if (IS_ERR(ar->firmware)) {
393 ath10k_err("Could not fetch firmware file '%s': %ld\n",
394 name, PTR_ERR(ar->firmware));
395 return PTR_ERR(ar->firmware);
398 data = ar->firmware->data;
399 len = ar->firmware->size;
401 /* magic also includes the null byte, check that as well */
402 magic_len = strlen(ATH10K_FIRMWARE_MAGIC) + 1;
404 if (len < magic_len) {
405 ath10k_err("firmware image too small to contain magic: %d\n",
410 if (memcmp(data, ATH10K_FIRMWARE_MAGIC, magic_len) != 0) {
411 ath10k_err("Invalid firmware magic\n");
415 /* jump over the padding */
416 magic_len = ALIGN(magic_len, 4);
422 while (len > sizeof(struct ath10k_fw_ie)) {
423 hdr = (struct ath10k_fw_ie *)data;
425 ie_id = le32_to_cpu(hdr->id);
426 ie_len = le32_to_cpu(hdr->len);
429 data += sizeof(*hdr);
432 ath10k_err("Invalid length for FW IE %d (%d < %d)\n",
438 case ATH10K_FW_IE_FW_VERSION:
439 if (ie_len > sizeof(ar->hw->wiphy->fw_version) - 1)
442 memcpy(ar->hw->wiphy->fw_version, data, ie_len);
443 ar->hw->wiphy->fw_version[ie_len] = '\0';
445 ath10k_dbg(ATH10K_DBG_BOOT,
446 "found fw version %s\n",
447 ar->hw->wiphy->fw_version);
449 case ATH10K_FW_IE_TIMESTAMP:
450 if (ie_len != sizeof(u32))
453 timestamp = (__le32 *)data;
455 ath10k_dbg(ATH10K_DBG_BOOT, "found fw timestamp %d\n",
456 le32_to_cpup(timestamp));
458 case ATH10K_FW_IE_FEATURES:
459 ath10k_dbg(ATH10K_DBG_BOOT,
460 "found firmware features ie (%zd B)\n",
463 for (i = 0; i < ATH10K_FW_FEATURE_COUNT; i++) {
470 if (data[index] & (1 << bit))
471 __set_bit(i, ar->fw_features);
474 ath10k_dbg_dump(ATH10K_DBG_BOOT, "features", "",
476 sizeof(ar->fw_features));
478 case ATH10K_FW_IE_FW_IMAGE:
479 ath10k_dbg(ATH10K_DBG_BOOT,
480 "found fw image ie (%zd B)\n",
483 ar->firmware_data = data;
484 ar->firmware_len = ie_len;
487 case ATH10K_FW_IE_OTP_IMAGE:
488 ath10k_dbg(ATH10K_DBG_BOOT,
489 "found otp image ie (%zd B)\n",
493 ar->otp_len = ie_len;
497 ath10k_warn("Unknown FW IE: %u\n",
498 le32_to_cpu(hdr->id));
502 /* jump over the padding */
503 ie_len = ALIGN(ie_len, 4);
509 if (!ar->firmware_data || !ar->firmware_len) {
510 ath10k_warn("No ATH10K_FW_IE_FW_IMAGE found from %s, skipping\n",
516 /* now fetch the board file */
517 if (ar->hw_params.fw.board == NULL) {
518 ath10k_err("board data file not defined");
523 ar->board = ath10k_fetch_fw_file(ar,
524 ar->hw_params.fw.dir,
525 ar->hw_params.fw.board);
526 if (IS_ERR(ar->board)) {
527 ret = PTR_ERR(ar->board);
528 ath10k_err("could not fetch board data (%d)\n", ret);
532 ar->board_data = ar->board->data;
533 ar->board_len = ar->board->size;
538 ath10k_core_free_firmware_files(ar);
542 static int ath10k_core_fetch_firmware_files(struct ath10k *ar)
546 ret = ath10k_core_fetch_firmware_api_n(ar, ATH10K_FW_API2_FILE);
552 ret = ath10k_core_fetch_firmware_api_1(ar);
559 ath10k_dbg(ATH10K_DBG_BOOT, "using fw api %d\n", ar->fw_api);
564 static int ath10k_init_download_firmware(struct ath10k *ar)
568 ret = ath10k_download_board_data(ar);
572 ret = ath10k_download_and_run_otp(ar);
576 ret = ath10k_download_fw(ar);
583 static int ath10k_init_uart(struct ath10k *ar)
588 * Explicitly setting UART prints to zero as target turns it on
589 * based on scratch registers.
591 ret = ath10k_bmi_write32(ar, hi_serial_enable, 0);
593 ath10k_warn("could not disable UART prints (%d)\n", ret);
598 ath10k_info("UART prints disabled\n");
602 ret = ath10k_bmi_write32(ar, hi_dbg_uart_txpin, 7);
604 ath10k_warn("could not enable UART prints (%d)\n", ret);
608 ret = ath10k_bmi_write32(ar, hi_serial_enable, 1);
610 ath10k_warn("could not enable UART prints (%d)\n", ret);
614 /* Set the UART baud rate to 19200. */
615 ret = ath10k_bmi_write32(ar, hi_desired_baud_rate, 19200);
617 ath10k_warn("could not set the baud rate (%d)\n", ret);
621 ath10k_info("UART prints enabled\n");
625 static int ath10k_init_hw_params(struct ath10k *ar)
627 const struct ath10k_hw_params *uninitialized_var(hw_params);
630 for (i = 0; i < ARRAY_SIZE(ath10k_hw_params_list); i++) {
631 hw_params = &ath10k_hw_params_list[i];
633 if (hw_params->id == ar->target_version)
637 if (i == ARRAY_SIZE(ath10k_hw_params_list)) {
638 ath10k_err("Unsupported hardware version: 0x%x\n",
643 ar->hw_params = *hw_params;
645 ath10k_info("Hardware name %s version 0x%x\n",
646 ar->hw_params.name, ar->target_version);
651 static void ath10k_core_restart(struct work_struct *work)
653 struct ath10k *ar = container_of(work, struct ath10k, restart_work);
655 mutex_lock(&ar->conf_mutex);
658 case ATH10K_STATE_ON:
660 ar->state = ATH10K_STATE_RESTARTING;
661 ieee80211_restart_hw(ar->hw);
663 case ATH10K_STATE_OFF:
664 /* this can happen if driver is being unloaded */
665 ath10k_warn("cannot restart a device that hasn't been started\n");
667 case ATH10K_STATE_RESTARTING:
668 case ATH10K_STATE_RESTARTED:
669 ar->state = ATH10K_STATE_WEDGED;
671 case ATH10K_STATE_WEDGED:
672 ath10k_warn("device is wedged, will not restart\n");
676 mutex_unlock(&ar->conf_mutex);
679 struct ath10k *ath10k_core_create(void *hif_priv, struct device *dev,
680 const struct ath10k_hif_ops *hif_ops)
684 ar = ath10k_mac_create();
688 ar->ath_common.priv = ar;
689 ar->ath_common.hw = ar->hw;
691 ar->p2p = !!ath10k_p2p;
694 ar->hif.priv = hif_priv;
695 ar->hif.ops = hif_ops;
697 init_completion(&ar->scan.started);
698 init_completion(&ar->scan.completed);
699 init_completion(&ar->scan.on_channel);
701 init_completion(&ar->install_key_done);
702 init_completion(&ar->vdev_setup_done);
704 setup_timer(&ar->scan.timeout, ath10k_reset_scan, (unsigned long)ar);
706 ar->workqueue = create_singlethread_workqueue("ath10k_wq");
710 mutex_init(&ar->conf_mutex);
711 spin_lock_init(&ar->data_lock);
713 INIT_LIST_HEAD(&ar->peers);
714 init_waitqueue_head(&ar->peer_mapping_wq);
716 init_completion(&ar->offchan_tx_completed);
717 INIT_WORK(&ar->offchan_tx_work, ath10k_offchan_tx_work);
718 skb_queue_head_init(&ar->offchan_tx_queue);
720 INIT_WORK(&ar->wmi_mgmt_tx_work, ath10k_mgmt_over_wmi_tx_work);
721 skb_queue_head_init(&ar->wmi_mgmt_tx_queue);
723 init_waitqueue_head(&ar->event_queue);
725 INIT_WORK(&ar->restart_work, ath10k_core_restart);
730 ath10k_mac_destroy(ar);
733 EXPORT_SYMBOL(ath10k_core_create);
735 void ath10k_core_destroy(struct ath10k *ar)
737 flush_workqueue(ar->workqueue);
738 destroy_workqueue(ar->workqueue);
740 ath10k_mac_destroy(ar);
742 EXPORT_SYMBOL(ath10k_core_destroy);
744 int ath10k_core_start(struct ath10k *ar)
748 ath10k_bmi_start(ar);
750 if (ath10k_init_configure_target(ar)) {
755 status = ath10k_init_download_firmware(ar);
759 status = ath10k_init_uart(ar);
763 ar->htc.htc_ops.target_send_suspend_complete =
764 ath10k_send_suspend_complete;
766 status = ath10k_htc_init(ar);
768 ath10k_err("could not init HTC (%d)\n", status);
772 status = ath10k_bmi_done(ar);
776 status = ath10k_wmi_attach(ar);
778 ath10k_err("WMI attach failed: %d\n", status);
782 status = ath10k_htc_wait_target(&ar->htc);
786 status = ath10k_htt_attach(ar);
788 ath10k_err("could not attach htt (%d)\n", status);
792 status = ath10k_init_connect_htc(ar);
796 ath10k_info("firmware %s booted\n", ar->hw->wiphy->fw_version);
798 status = ath10k_wmi_cmd_init(ar);
800 ath10k_err("could not send WMI init command (%d)\n", status);
801 goto err_disconnect_htc;
804 status = ath10k_wmi_wait_for_unified_ready(ar);
806 ath10k_err("wmi unified ready event not received\n");
808 goto err_disconnect_htc;
811 status = ath10k_htt_attach_target(&ar->htt);
813 goto err_disconnect_htc;
815 status = ath10k_debug_start(ar);
817 goto err_disconnect_htc;
819 ar->free_vdev_map = (1 << TARGET_NUM_VDEVS) - 1;
824 ath10k_htc_stop(&ar->htc);
826 ath10k_htt_detach(&ar->htt);
828 ath10k_wmi_detach(ar);
832 EXPORT_SYMBOL(ath10k_core_start);
834 void ath10k_core_stop(struct ath10k *ar)
836 ath10k_debug_stop(ar);
837 ath10k_htc_stop(&ar->htc);
838 ath10k_htt_detach(&ar->htt);
839 ath10k_wmi_detach(ar);
841 EXPORT_SYMBOL(ath10k_core_stop);
843 /* mac80211 manages fw/hw initialization through start/stop hooks. However in
844 * order to know what hw capabilities should be advertised to mac80211 it is
845 * necessary to load the firmware (and tear it down immediately since start
846 * hook will try to init it again) before registering */
847 static int ath10k_core_probe_fw(struct ath10k *ar)
849 struct bmi_target_info target_info;
852 ret = ath10k_hif_power_up(ar);
854 ath10k_err("could not start pci hif (%d)\n", ret);
858 memset(&target_info, 0, sizeof(target_info));
859 ret = ath10k_bmi_get_target_info(ar, &target_info);
861 ath10k_err("could not get target info (%d)\n", ret);
862 ath10k_hif_power_down(ar);
866 ar->target_version = target_info.version;
867 ar->hw->wiphy->hw_version = target_info.version;
869 ret = ath10k_init_hw_params(ar);
871 ath10k_err("could not get hw params (%d)\n", ret);
872 ath10k_hif_power_down(ar);
876 ret = ath10k_core_fetch_firmware_files(ar);
878 ath10k_err("could not fetch firmware files (%d)\n", ret);
879 ath10k_hif_power_down(ar);
883 ret = ath10k_core_start(ar);
885 ath10k_err("could not init core (%d)\n", ret);
886 ath10k_core_free_firmware_files(ar);
887 ath10k_hif_power_down(ar);
891 ath10k_core_stop(ar);
892 ath10k_hif_power_down(ar);
896 static int ath10k_core_check_chip_id(struct ath10k *ar)
898 u32 hw_revision = MS(ar->chip_id, SOC_CHIP_ID_REV);
900 ath10k_dbg(ATH10K_DBG_BOOT, "boot chip_id 0x%08x hw_revision 0x%x\n",
901 ar->chip_id, hw_revision);
903 /* Check that we are not using hw1.0 (some of them have same pci id
904 * as hw2.0) before doing anything else as ath10k crashes horribly
905 * due to missing hw1.0 workarounds. */
906 switch (hw_revision) {
907 case QCA988X_HW_1_0_CHIP_ID_REV:
908 ath10k_err("ERROR: qca988x hw1.0 is not supported\n");
911 case QCA988X_HW_2_0_CHIP_ID_REV:
912 /* known hardware revision, continue normally */
916 ath10k_warn("Warning: hardware revision unknown (0x%x), expect problems\n",
924 int ath10k_core_register(struct ath10k *ar, u32 chip_id)
928 ar->chip_id = chip_id;
930 status = ath10k_core_check_chip_id(ar);
932 ath10k_err("Unsupported chip id 0x%08x\n", ar->chip_id);
936 status = ath10k_core_probe_fw(ar);
938 ath10k_err("could not probe fw (%d)\n", status);
942 status = ath10k_mac_register(ar);
944 ath10k_err("could not register to mac80211 (%d)\n", status);
948 status = ath10k_debug_create(ar);
950 ath10k_err("unable to initialize debugfs\n");
951 goto err_unregister_mac;
957 ath10k_mac_unregister(ar);
959 ath10k_core_free_firmware_files(ar);
962 EXPORT_SYMBOL(ath10k_core_register);
964 void ath10k_core_unregister(struct ath10k *ar)
966 /* We must unregister from mac80211 before we stop HTC and HIF.
967 * Otherwise we will fail to submit commands to FW and mac80211 will be
968 * unhappy about callback failures. */
969 ath10k_mac_unregister(ar);
971 ath10k_core_free_firmware_files(ar);
973 EXPORT_SYMBOL(ath10k_core_unregister);
975 MODULE_AUTHOR("Qualcomm Atheros");
976 MODULE_DESCRIPTION("Core module for QCA988X PCIe devices.");
977 MODULE_LICENSE("Dual BSD/GPL");