[PATCH 07/17] Add boot.c, boot.h

michael.nemanov
2024-05-21T17:19:28Z

From: Michael Nemanov <Michael.Nemanov@ti.com>

Implements FW download for CC33xx. The FW comes in 2 parts - a 2nd stage
bootloader (cc33xx_2nd_loader.bin) and the actual FW (cc33xx_fw.bin).
Each file is requested from user space, and transferred to device
chunk by chunk. A dedicated IRQ is excepted after each stage
(Device power-on -> 2nd stage loader -> FW). This logic is implemnted in
cc33xx_init_fw.

Signed-off-by: Michael Nemanov <michael.nemanov@ti.com>
---
drivers/net/wireless/ti/cc33xx/boot.c | 363 ++++++++++++++++++++++++++
drivers/net/wireless/ti/cc33xx/boot.h | 24 ++
2 files changed, 387 insertions(+)
create mode 100644 drivers/net/wireless/ti/cc33xx/boot.c
create mode 100644 drivers/net/wireless/ti/cc33xx/boot.h

diff --git a/drivers/net/wireless/ti/cc33xx/boot.c b/drivers/net/wireless/ti/cc33xx/boot.c
new file mode 100644
index 000000000000..a0be54c7fbb7
--- /dev/null
+++ b/drivers/net/wireless/ti/cc33xx/boot.c
@@ -0,0 +1,363 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * Copyright (C) 2022-2024 Texas Instruments Incorporated - https://www.ti.com/
+ */
+
+#include <linux/firmware.h>
+
+#include "boot.h"
+#include "cmd.h"
+#include "debug.h"
+#include "init.h"
+#include "io.h"
+
+#define CC33XX_BOOT_TIMEOUT 2000
+
+struct hwinfo_bitmap {
+ u32 disable_5g : 1u;
+ u32 disable_6g : 1u;
+ u32 disable_ble : 1u;
+ u32 disable_ble_m0plus : 1u;
+ u32 disable_m33 : 1u;
+ u64 udi : 64u;
+ u32 pg_version : 4u;
+ u32 metal_version : 4u;
+ u32 boot_rom_version : 4u;
+ u32 m3_rom_version : 4u;
+ u32 fuse_rom_structure_version : 4u;
+ u64 mac_address : 48u;
+ u32 device_part_number : 6u;
+ u32 package_type : 4u;
+ u32 fw_rollback_protection_1 : 32u;
+ u32 fw_rollback_protection_2 : 32u;
+ u32 fw_rollback_protection_3 : 32u;
+ u32 reserved : 13u;
+} /* Aligned with boot code, must not be __packed */;
+
+union hw_info {
+ struct hwinfo_bitmap bitmap;
+ u8 bytes[sizeof(struct hwinfo_bitmap)];
+};
+
+/* Called from threaded irq context */
+void cc33xx_handle_boot_irqs(struct cc33xx *cc, u32 pending_interrupts)
+{
+ if (WARN_ON(!cc->fw_download))
+ return;
+
+ cc33xx_debug(DEBUG_BOOT, "BOOT IRQs: 0x%x", pending_interrupts);
+
+ atomic_or(pending_interrupts, &cc->fw_download->pending_irqs);
+ complete(&cc->fw_download->wait_on_irq);
+}
+
+static u8 *fetch_container(struct cc33xx *cc, const char *container_name,
+ size_t *container_len)
+{
+ u8 *container_data = NULL;
+ const struct firmware *container;
+ int ret;
+
+ ret = request_firmware(&container, container_name, cc->dev);
+
+ if (ret < 0) {
+ cc33xx_error("could not get container %s: (%d)",
+ container_name, ret);
+ return NULL;
+ }
+
+ if (container->size % 4) {
+ cc33xx_error("container size is not word-aligned: %zu",
+ container->size);
+ goto out;
+ }
+
+ *container_len = container->size;
+ container_data = vmalloc(container->size);
+
+ if (!container_data) {
+ cc33xx_error("could not allocate memory for the container");
+ goto out;
+ }
+
+ memcpy(container_data, container->data, container->size);
+
+out:
+ release_firmware(container);
+ return container_data;
+}
+
+static int cc33xx_set_power_on(struct cc33xx *cc)
+{
+ int ret;
+
+ msleep(CC33XX_PRE_POWER_ON_SLEEP);
+ ret = cc33xx_power_on(cc);
+ if (ret < 0)
+ goto out;
+ msleep(CC33XX_POWER_ON_SLEEP);
+ cc33xx_io_reset(cc);
+ cc33xx_io_init(cc);
+
+out:
+ return ret;
+}
+
+static int cc33xx_chip_wakeup(struct cc33xx *cc)
+{
+ int ret = 0;
+
+ cc33xx_debug(DEBUG_BOOT, "Chip wakeup");
+
+ ret = cc33xx_set_power_on(cc);
+ if (ret < 0)
+ goto out;
+
+ if (!cc33xx_set_block_size(cc))
+ cc->quirks &= ~CC33XX_QUIRK_TX_BLOCKSIZE_ALIGN;
+
+out:
+ return ret;
+}
+
+static int wait_for_boot_irq(struct cc33xx *cc, u32 boot_irq_mask,
+ unsigned long timeout)
+{
+ int ret;
+ u32 pending_irqs;
+ struct cc33xx_fw_download *fw_download;
+
+ fw_download = cc->fw_download;
+
+ ret = wait_for_completion_interruptible_timeout(&fw_download->wait_on_irq,
+ msecs_to_jiffies(timeout));
+
+ /* Fetch pending IRQs while clearing them in fw_download */
+ pending_irqs = atomic_fetch_and(0, &fw_download->pending_irqs);
+ pending_irqs &= ~HINT_COMMAND_COMPLETE;
+
+ reinit_completion(&fw_download->wait_on_irq);
+
+ if (ret == 0) {
+ cc33xx_error("boot IRQ timeout");
+ return -1;
+ } else if (ret < 0) {
+ cc33xx_error("boot IRQ completion error %d", ret);
+ return -2;
+ }
+
+ if (boot_irq_mask != pending_irqs) {
+ cc33xx_error("Unexpected IRQ received @ boot: 0x%x",
+ pending_irqs);
+ return -3;
+ }
+
+ return 0;
+}
+
+static int download_container(struct cc33xx *cc, u8 *container, size_t len)
+{
+ int ret = 0;
+ u8 *current_transfer;
+ size_t current_transfer_size;
+ u8 *const container_end = container + len;
+ size_t max_transfer_size = cc->fw_download->max_transfer_size;
+ bool is_last_transfer;
+
+ current_transfer = container;
+
+ while (current_transfer < container_end) {
+ current_transfer_size = container_end - current_transfer;
+ current_transfer_size =
+ min(current_transfer_size, max_transfer_size);
+
+ is_last_transfer = (current_transfer + current_transfer_size >= container_end);
+
+ ret = cmd_download_container_chunk(cc,
+ current_transfer,
+ current_transfer_size,
+ is_last_transfer);
+
+ current_transfer += current_transfer_size;
+
+ if (ret < 0) {
+ cc33xx_error("Chunk transfer failed");
+ goto out;
+ }
+ }
+
+out:
+ return ret;
+}
+
+static int container_download_and_wait(struct cc33xx *cc,
+ const char *container_name,
+ const u32 irq_wait_mask)
+{
+ int ret = -1;
+ u8 *container_data;
+ size_t container_len;
+
+ cc33xx_debug(DEBUG_BOOT,
+ "Downloading %s to device", container_name);
+
+ container_data = fetch_container(cc, container_name, &container_len);
+ if (!container_data)
+ return ret;
+
+ ret = download_container(cc, container_data, container_len);
+ if (ret < 0) {
+ cc33xx_error("Transfer error while downloading %s",
+ container_name);
+ goto out;
+ }
+
+ ret = wait_for_boot_irq(cc, irq_wait_mask, CC33XX_BOOT_TIMEOUT);
+
+ if (ret < 0) {
+ cc33xx_error("%s boot signal timeout", container_name);
+ goto out;
+ }
+
+ cc33xx_debug(DEBUG_BOOT, "%s loaded successfully", container_name);
+ ret = 0;
+
+out:
+ vfree(container_data);
+ return ret;
+}
+
+static int fw_download_alloc(struct cc33xx *cc)
+{
+ if (WARN_ON(cc->fw_download))
+ return -EFAULT;
+
+ cc->fw_download = kzalloc(sizeof(*cc->fw_download), GFP_KERNEL);
+ if (!cc->fw_download)
+ return -ENOMEM;
+
+ init_completion(&cc->fw_download->wait_on_irq);
+
+ return 0;
+}
+
+static void fw_download_free(struct cc33xx *cc)
+{
+ if (WARN_ON(!cc->fw_download))
+ return;
+
+ kfree(cc->fw_download);
+ cc->fw_download = NULL;
+}
+
+static int get_device_info(struct cc33xx *cc)
+{
+ int ret;
+ union hw_info hw_info;
+ u64 mac_address;
+
+ ret = cmd_get_device_info(cc, hw_info.bytes, sizeof(hw_info.bytes));
+ if (ret < 0)
+ return ret;
+
+ cc33xx_debug(DEBUG_BOOT,
+ "CC33XX device info: PG version: %d, Metal version: %d, Boot ROM version: %d, M3 ROM version: %d, MAC address: 0x%llx, Device part number: %d",
+ hw_info.bitmap.pg_version, hw_info.bitmap.metal_version,
+ hw_info.bitmap.boot_rom_version,
+ hw_info.bitmap.m3_rom_version,
+ (u64)hw_info.bitmap.mac_address,
+ hw_info.bitmap.device_part_number);
+
+ cc->fw_download->max_transfer_size = 640;
+
+ mac_address = hw_info.bitmap.mac_address;
+
+ cc->fuse_rom_structure_version = hw_info.bitmap.fuse_rom_structure_version;
+ cc->pg_version = hw_info.bitmap.pg_version;
+ cc->device_part_number = hw_info.bitmap.device_part_number;
+ cc->disable_5g = hw_info.bitmap.disable_5g;
+ cc->disable_6g = hw_info.bitmap.disable_6g;
+
+ cc->efuse_mac_address[5] = (u8)(mac_address);
+ cc->efuse_mac_address[4] = (u8)(mac_address >> 8);
+ cc->efuse_mac_address[3] = (u8)(mac_address >> 16);
+ cc->efuse_mac_address[2] = (u8)(mac_address >> 24);
+ cc->efuse_mac_address[1] = (u8)(mac_address >> 32);
+ cc->efuse_mac_address[0] = (u8)(mac_address >> 40);
+
+ return 0;
+}
+
+int cc33xx_init_fw(struct cc33xx *cc)
+{
+ int ret;
+
+ cc->max_cmd_size = CC33XX_CMD_MAX_SIZE;
+
+ ret = fw_download_alloc(cc);
+ if (ret < 0)
+ return ret;
+
+ reinit_completion(&cc->fw_download->wait_on_irq);
+
+ ret = cc33xx_chip_wakeup(cc);
+ if (ret < 0)
+ goto power_off;
+
+ cc33xx_enable_interrupts(cc);
+
+ ret = wait_for_boot_irq(cc, HINT_ROM_LOADER_INIT_COMPLETE,
+ CC33XX_BOOT_TIMEOUT);
+ if (ret < 0)
+ goto disable_irq;
+
+ ret = get_device_info(cc);
+ if (ret < 0)
+ goto disable_irq;
+
+ ret = container_download_and_wait(cc, SECOND_LOADER_NAME,
+ HINT_SECOND_LOADER_INIT_COMPLETE);
+ if (ret < 0)
+ goto disable_irq;
+
+ ret = container_download_and_wait(cc, FW_NAME,
+ HINT_FW_WAKEUP_COMPLETE);
+ if (ret < 0)
+ goto disable_irq;
+
+ ret = cc33xx_download_ini_params_and_wait(cc);
+
+ if (ret < 0)
+ goto disable_irq;
+
+ ret = wait_for_boot_irq(cc, HINT_FW_INIT_COMPLETE, CC33XX_BOOT_TIMEOUT);
+
+ if (ret < 0)
+ goto disable_irq;
+
+ ret = cc33xx_hw_init(cc);
+ if (ret < 0)
+ goto disable_irq;
+
+ /* Now we know if 11a is supported (info from the INI File), so disable
+ * 11a channels if not supported
+ */
+ cc->enable_11a = cc->conf.core.enable_5ghz;
+
+ cc33xx_debug(DEBUG_MAC80211, "11a is %ssupported",
+ cc->enable_11a ? "" : "not ");
+
+ cc->state = CC33XX_STATE_ON;
+ ret = 0;
+ goto out;
+
+disable_irq:
+ cc33xx_disable_interrupts_nosync(cc);
+
+power_off:
+ cc33xx_power_off(cc);
+
+out:
+ fw_download_free(cc);
+ return ret;
+}
diff --git a/drivers/net/wireless/ti/cc33xx/boot.h b/drivers/net/wireless/ti/cc33xx/boot.h
new file mode 100644
index 000000000000..d5b7763dcd0f
--- /dev/null
+++ b/drivers/net/wireless/ti/cc33xx/boot.h
@@ -0,0 +1,24 @@
+/* SPDX-License-Identifier: GPL-2.0-only
+ *
+ * Copyright (C) 2022-2024 Texas Instruments Incorporated - https://www.ti.com/
+ */
+
+#ifndef __BOOT_H__
+#define __BOOT_H__
+
+#include "cc33xx.h"
+
+int cc33xx_init_fw(struct cc33xx *cc);
+
+void cc33xx_handle_boot_irqs(struct cc33xx *cc, u32 pending_interrupts);
+
+#define SECOND_LOADER_NAME "ti-connectivity/cc33xx_2nd_loader.bin"
+#define FW_NAME "ti-connectivity/cc33xx_fw.bin"
+
+struct cc33xx_fw_download {
+ atomic_t pending_irqs;
+ struct completion wait_on_irq;
+ size_t max_transfer_size;
+};
+
+#endif /* __BOOT_H__ */
--
2.25.1