From mboxrd@z Thu Jan 1 00:00:00 1970 From: Simon Goldschmidt Date: Tue, 7 May 2019 20:16:07 +0200 Subject: [U-Boot] [PATCH 04/13] arm: K3: Introduce System Firmware loader framework In-Reply-To: <20190507172542.31359-5-dannenberg@ti.com> References: <20190507172542.31359-1-dannenberg@ti.com> <20190507172542.31359-5-dannenberg@ti.com> Message-ID: List-Id: MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit To: u-boot@lists.denx.de On 07.05.19 19:25, Andreas Dannenberg wrote: > Introduce a framework that allows loading the System Firmware (SYSFW) > binary as well as the associated configuration data from an image tree > blob named "sysfw.itb" from an FS-based MMC boot media or from an MMC > RAW mode partition or sector. > > To simplify the handling of and loading from the different boot media > we tap into the existing U-Boot SPL framework usually used for loading > U-Boot by building on an earlier commit that exposes some of that > functionality. > > Note that this initial implementation only supports FS and RAW-based > eMMC/SD card boot. > > Signed-off-by: Andreas Dannenberg > Signed-off-by: Lokesh Vutla Without having a too deep understanding of this, all this stuff looks like it would be similar to drivers/misc/fs_loader.c? Could it build on top of that? Regards, Simon > --- > arch/arm/mach-k3/Kconfig | 40 +++ > arch/arm/mach-k3/Makefile | 1 + > arch/arm/mach-k3/include/mach/sysfw-loader.h | 12 + > arch/arm/mach-k3/sysfw-loader.c | 263 +++++++++++++++++++ > 4 files changed, 316 insertions(+) > create mode 100644 arch/arm/mach-k3/include/mach/sysfw-loader.h > create mode 100644 arch/arm/mach-k3/sysfw-loader.c > > diff --git a/arch/arm/mach-k3/Kconfig b/arch/arm/mach-k3/Kconfig > index e677a2e01b..f1731dda58 100644 > --- a/arch/arm/mach-k3/Kconfig > +++ b/arch/arm/mach-k3/Kconfig > @@ -58,6 +58,46 @@ config SYS_K3_BOOT_CORE_ID > int > default 16 > > +config K3_LOAD_SYSFW > + bool > + depends on SPL > + default n > + > +config K3_SYSFW_IMAGE_NAME > + string "File name of SYSFW firmware and configuration blob" > + depends on K3_LOAD_SYSFW > + default "sysfw.itb" > + help > + Filename of the combined System Firmware and configuration image tree > + blob to be loaded when booting from a filesystem. > + > +config K3_SYSFW_IMAGE_MMCSD_RAW_MODE_SECT > + hex "MMC sector to load SYSFW firmware and configuration blob from" > + depends on K3_LOAD_SYSFW && SYS_MMCSD_RAW_MODE_U_BOOT_USE_SECTOR > + default 0x3600 > + help > + Address on the MMC to load the combined System Firmware and > + configuration image tree blob from, when the MMC is being used > + in raw mode. Units: MMC sectors (1 sector = 512 bytes). > + > +config K3_SYSFW_IMAGE_MMCSD_RAW_MODE_PART > + hex "MMC partition to load SYSFW firmware and configuration blob from" > + depends on K3_LOAD_SYSFW && SYS_MMCSD_RAW_MODE_U_BOOT_USE_PARTITION > + default 2 > + help > + Partition on the MMC to the combined System Firmware and configuration > + image tree blob from, when the MMC is being used in raw mode. > + > +config K3_SYSFW_IMAGE_SIZE_MAX > + int "Amount of memory dynamically allocated for loading SYSFW blob" > + depends on K3_LOAD_SYSFW > + default 269000 > + help > + Amount of memory reserved through dynamic allocation at runtime for > + loading the combined System Firmware and configuration image tree > + blob. Keep it as tight as possible, as this directly affects the > + overall SPL memory footprint. > + > config SYS_K3_SPL_ATF > bool "Start Cortex-A from SPL" > depends on SPL && CPU_V7R > diff --git a/arch/arm/mach-k3/Makefile b/arch/arm/mach-k3/Makefile > index 0c3a4f7db1..6c895400c2 100644 > --- a/arch/arm/mach-k3/Makefile > +++ b/arch/arm/mach-k3/Makefile > @@ -7,4 +7,5 @@ obj-$(CONFIG_SOC_K3_AM6) += am6_init.o > obj-$(CONFIG_ARM64) += arm64-mmu.o > obj-$(CONFIG_CPU_V7R) += r5_mpu.o lowlevel_init.o > obj-$(CONFIG_TI_SECURE_DEVICE) += security.o > +obj-$(CONFIG_K3_LOAD_SYSFW) += sysfw-loader.o > obj-y += common.o > diff --git a/arch/arm/mach-k3/include/mach/sysfw-loader.h b/arch/arm/mach-k3/include/mach/sysfw-loader.h > new file mode 100644 > index 0000000000..36eb265348 > --- /dev/null > +++ b/arch/arm/mach-k3/include/mach/sysfw-loader.h > @@ -0,0 +1,12 @@ > +/* SPDX-License-Identifier: GPL-2.0+ */ > +/* > + * Copyright (C) 2019 Texas Instruments Incorporated - http://www.ti.com/ > + * Andreas Dannenberg > + */ > + > +#ifndef _SYSFW_LOADER_H_ > +#define _SYSFW_LOADER_H_ > + > +void k3_sysfw_loader(void (*config_pm_done_callback)(void)); > + > +#endif > diff --git a/arch/arm/mach-k3/sysfw-loader.c b/arch/arm/mach-k3/sysfw-loader.c > new file mode 100644 > index 0000000000..a222266c27 > --- /dev/null > +++ b/arch/arm/mach-k3/sysfw-loader.c > @@ -0,0 +1,263 @@ > +// SPDX-License-Identifier: GPL-2.0+ > +/* > + * K3: System Firmware Loader > + * > + * Copyright (C) 2019 Texas Instruments Incorporated - http://www.ti.com/ > + * Andreas Dannenberg > + */ > + > +#include > +#include > +#include > +#include > +#include > +#include > + > +/* Name of the FIT image nodes for SYSFW and its config data */ > +#define SYSFW_FIRMWARE "sysfw.bin" > +#define SYSFW_CFG_BOARD "board-cfg.bin" > +#define SYSFW_CFG_PM "pm-cfg.bin" > +#define SYSFW_CFG_RM "rm-cfg.bin" > +#define SYSFW_CFG_SEC "sec-cfg.bin" > + > +#ifdef CONFIG_SPL_BUILD > + > +static bool sysfw_loaded; > +static void *sysfw_load_address; > + > +/* > + * Populate SPL hook to override the default load address used by the SPL > + * loader function with a custom address for SYSFW loading. > + */ > +struct image_header *spl_get_load_buffer(ssize_t offset, size_t size) > +{ > + if (sysfw_loaded) > + return (struct image_header *)(CONFIG_SYS_TEXT_BASE + offset); > + else if (sysfw_load_address) > + return sysfw_load_address; > + else > + panic("SYSFW load address not defined!"); > +} > + > +/* > + * Populate SPL hook to skip the default SPL loader FIT post-processing steps > + * during SYSFW loading and return to the calling function so we can perform > + * our own custom processing. > + */ > +bool spl_load_simple_fit_skip_processing(void) > +{ > + return !sysfw_loaded; > +} > + > +static int fit_get_data_by_name(const void *fit, int images, const char *name, > + const void **addr, size_t *size) > +{ > + int node_offset; > + > + node_offset = fdt_subnode_offset(fit, images, name); > + if (node_offset < 0) > + return -ENOENT; > + > + return fit_image_get_data(fit, node_offset, addr, size); > +} > + > +static void k3_sysfw_load_using_fit(void *fit) > +{ > + int images; > + const void *sysfw_addr; > + size_t sysfw_size; > + int ret; > + > + /* Find the node holding the images information */ > + images = fdt_path_offset(fit, FIT_IMAGES_PATH); > + if (images < 0) > + panic("Cannot find /images node (%d)\n", images); > + > + /* Extract System Firmware (SYSFW) image from FIT */ > + ret = fit_get_data_by_name(fit, images, SYSFW_FIRMWARE, > + &sysfw_addr, &sysfw_size); > + if (ret < 0) > + panic("Error accessing %s node in FIT (%d)\n", SYSFW_FIRMWARE, > + ret); > + > + /* > + * Start up system controller firmware > + * > + * It is assumed that remoteproc device 0 is the corresponding > + * system-controller that runs SYSFW. Make sure DT reflects the same. > + */ > + ret = rproc_dev_init(0); > + if (ret) > + panic("rproc failed to be initialized (%d)\n", ret); > + > + ret = rproc_load(0, (ulong)sysfw_addr, (ulong)sysfw_size); > + if (ret) > + panic("Firmware failed to start on rproc (%d)\n", ret); > + > + ret = rproc_start(0); > + if (ret) > + panic("Firmware init failed on rproc (%d)\n", ret); > +} > + > +static void k3_sysfw_configure_using_fit(void *fit, > + struct ti_sci_handle *ti_sci) > +{ > + struct ti_sci_board_ops *board_ops = &ti_sci->ops.board_ops; > + int images; > + const void *cfg_fragment_addr; > + size_t cfg_fragment_size; > + int ret; > + > + /* Find the node holding the images information */ > + images = fdt_path_offset(fit, FIT_IMAGES_PATH); > + if (images < 0) > + panic("Cannot find /images node (%d)\n", images); > + > + /* Extract board configuration from FIT */ > + ret = fit_get_data_by_name(fit, images, SYSFW_CFG_BOARD, > + &cfg_fragment_addr, &cfg_fragment_size); > + if (ret < 0) > + panic("Error accessing %s node in FIT (%d)\n", SYSFW_CFG_BOARD, > + ret); > + > + /* Apply board configuration to SYSFW */ > + ret = board_ops->board_config(ti_sci, > + (u64)(u32)cfg_fragment_addr, > + (u32)cfg_fragment_size); > + if (ret) > + panic("Failed to set board configuration (%d)\n", ret); > + > + /* Extract power/clock (PM) specific configuration from FIT */ > + ret = fit_get_data_by_name(fit, images, SYSFW_CFG_PM, > + &cfg_fragment_addr, &cfg_fragment_size); > + if (ret < 0) > + panic("Error accessing %s node in FIT (%d)\n", SYSFW_CFG_PM, > + ret); > + > + /* Apply power/clock (PM) specific configuration to SYSFW */ > + ret = board_ops->board_config_pm(ti_sci, > + (u64)(u32)cfg_fragment_addr, > + (u32)cfg_fragment_size); > + if (ret) > + panic("Failed to set board PM configuration (%d)\n", ret); > + > + /* Extract resource management (RM) specific configuration from FIT */ > + ret = fit_get_data_by_name(fit, images, SYSFW_CFG_RM, > + &cfg_fragment_addr, &cfg_fragment_size); > + if (ret < 0) > + panic("Error accessing %s node in FIT (%d)\n", SYSFW_CFG_RM, > + ret); > + > + /* Apply resource management (RM) configuration to SYSFW */ > + ret = board_ops->board_config_rm(ti_sci, > + (u64)(u32)cfg_fragment_addr, > + (u32)cfg_fragment_size); > + if (ret) > + panic("Failed to set board RM configuration (%d)\n", ret); > + > + /* Extract security specific configuration from FIT */ > + ret = fit_get_data_by_name(fit, images, SYSFW_CFG_SEC, > + &cfg_fragment_addr, &cfg_fragment_size); > + if (ret < 0) > + panic("Error accessing %s node in FIT (%d)\n", SYSFW_CFG_SEC, > + ret); > + > + /* Apply security configuration to SYSFW */ > + ret = board_ops->board_config_security(ti_sci, > + (u64)(u32)cfg_fragment_addr, > + (u32)cfg_fragment_size); > + if (ret) > + panic("Failed to set board security configuration (%d)\n", > + ret); > +} > + > +void k3_sysfw_loader(void (*config_pm_done_callback)(void)) > +{ > + struct spl_image_info spl_image = { 0 }; > + struct spl_boot_device bootdev = { 0 }; > + struct ti_sci_handle *ti_sci; > + int ret; > + > + /* Reserve a block of aligned memory for loading the SYSFW image */ > + sysfw_load_address = memalign(ARCH_DMA_MINALIGN, > + CONFIG_K3_SYSFW_IMAGE_SIZE_MAX); > + if (!sysfw_load_address) > + panic("Error allocating %u bytes of memory for SYSFW image\n", > + CONFIG_K3_SYSFW_IMAGE_SIZE_MAX); > + > + debug("%s: allocated %u bytes at 0x%p\n", __func__, > + CONFIG_K3_SYSFW_IMAGE_SIZE_MAX, sysfw_load_address); > + > + /* Set load address for legacy modes that bypass spl_get_load_buffer */ > + spl_image.load_addr = (uintptr_t)sysfw_load_address; > + > + bootdev.boot_device = spl_boot_device(); > + > + /* Load combined System Controller firmware and config data image */ > + switch (bootdev.boot_device) { > +#if CONFIG_IS_ENABLED(MMC_SUPPORT) > + case BOOT_DEVICE_MMC1: > + case BOOT_DEVICE_MMC2: > + case BOOT_DEVICE_MMC2_2: > + ret = spl_mmc_load(&spl_image, &bootdev, > +#ifdef CONFIG_K3_SYSFW_IMAGE_NAME > + CONFIG_K3_SYSFW_IMAGE_NAME, > +#else > + NULL, > +#endif > +#ifdef CONFIG_K3_SYSFW_IMAGE_MMCSD_RAW_MODE_PART > + CONFIG_K3_SYSFW_IMAGE_MMCSD_RAW_MODE_PART, > +#else > + 0, > +#endif > +#ifdef CONFIG_K3_SYSFW_IMAGE_MMCSD_RAW_MODE_SECT > + CONFIG_K3_SYSFW_IMAGE_MMCSD_RAW_MODE_SECT); > +#else > + 0); > +#endif > + break; > +#endif > + default: > + panic("Loading SYSFW image from device %u not supported!\n", > + bootdev.boot_device); > + } > + > + if (ret) > + panic("Error %d occurred during loading SYSFW image!\n", ret); > + > + /* > + * Now that SYSFW got loaded set helper flag to restore regular SPL > + * loader behavior so we can later boot into the next stage as expected. > + */ > + sysfw_loaded = true; > + > + /* Ensure the SYSFW image is in FIT format */ > + if (image_get_magic((const image_header_t *)sysfw_load_address) != > + FDT_MAGIC) > + panic("SYSFW image not in FIT format!\n"); > + > + /* Extract and start SYSFW */ > + k3_sysfw_load_using_fit(sysfw_load_address); > + > + /* Get handle for accessing SYSFW services */ > + ti_sci = get_ti_sci_handle(); > + > + /* Parse and apply the different SYSFW configuration fragments */ > + k3_sysfw_configure_using_fit(sysfw_load_address, ti_sci); > + > + /* > + * Now that all clocks and PM aspects are setup, invoke a user- > + * provided callback function. Usually this callback would be used > + * to setup or re-configure the U-Boot console UART. > + */ > + if (config_pm_done_callback) > + config_pm_done_callback(); > + > + /* Output System Firmware version info */ > + printf("SYSFW ABI: %d.%d (firmware rev 0x%04x '%.*s')\n", > + ti_sci->version.abi_major, ti_sci->version.abi_minor, > + ti_sci->version.firmware_revision, > + sizeof(ti_sci->version.firmware_description), > + ti_sci->version.firmware_description); > +} > +#endif >