Main updates from version V12[1]: Fix warning build by fixing the inline declaration in remoteproc_tee.h (when CONFIG_REMOTEPROC_TEE is not set). Reported-by: kernel test robot lkp@intel.com Closes: https://lore.kernel.org/oe-kbuild-all/202410262040.PWNrKv2Q-lkp@intel.com/
Main updates from version V11[2]: - rename structures, functions, and variables from "tee_rproc_xxx" to "rproc_tee_xxx", - update rproc_tee_register to return an error instead of "struct rproc_tee *" pointer
[1] https://lore.kernel.org/lkml/20241025205924.2087768-1-arnaud.pouliquen@foss.... [2] https://lore.kernel.org/lkml/ZxZ4cBilIlpf3IPw@p14s/T/
Tested-on: commit 42f7652d3eb5 ("Linux 6.12-rc4") Description of the feature: -------------------------- This series proposes the implementation of a remoteproc tee driver to communicate with a TEE trusted application responsible for authenticating and loading the remoteproc firmware image in an Arm secure context.
1) Principle:
The remoteproc tee driver provides services to communicate with the OP-TEE trusted application running on the Trusted Execution Context (TEE). The trusted application in TEE manages the remote processor lifecycle:
- authenticating and loading firmware images, - isolating and securing the remote processor memories, - supporting multi-firmware (e.g., TF-M + Zephyr on a Cortex-M33), - managing the start and stop of the firmware by the TEE.
2) Format of the signed image:
Refer to: https://github.com/OP-TEE/optee_os/blob/master/ta/remoteproc/src/remoteproc_...
3) OP-TEE trusted application API:
Refer to: https://github.com/OP-TEE/optee_os/blob/master/ta/remoteproc/include/ta_remo...
4) OP-TEE signature script
Refer to: https://github.com/OP-TEE/optee_os/blob/master/scripts/sign_rproc_fw.py
Example of usage: sign_rproc_fw.py --in <fw1.elf> --in <fw2.elf> --out <signed_fw.sign> --key ${OP-TEE_PATH}/keys/default.pem
5) Impact on User space Application
No sysfs impact. The user only needs to provide the signed firmware image instead of the ELF image.
For more information about the implementation, a presentation is available here (note that the format of the signed image has evolved between the presentation and the integration in OP-TEE).
https://resources.linaro.org/en/resource/6c5bGvZwUAjX56fvxthxds
Arnaud Pouliquen (7): remoteproc: core: Introduce rproc_pa_to_va helper remoteproc: Add TEE support remoteproc: core: Refactor resource table cleanup into rproc_release_fw remoteproc: Introduce release_fw optional operation dt-bindings: remoteproc: Add compatibility for TEE support remoteproc: stm32: Create sub-functions to request shutdown and release remoteproc: stm32: Add support of an OP-TEE TA to load the firmware
.../bindings/remoteproc/st,stm32-rproc.yaml | 58 +- drivers/remoteproc/Kconfig | 10 + drivers/remoteproc/Makefile | 1 + drivers/remoteproc/remoteproc_core.c | 72 ++- drivers/remoteproc/remoteproc_tee.c | 510 ++++++++++++++++++ drivers/remoteproc/stm32_rproc.c | 139 +++-- include/linux/remoteproc.h | 8 + include/linux/remoteproc_tee.h | 105 ++++ 8 files changed, 848 insertions(+), 55 deletions(-) create mode 100644 drivers/remoteproc/remoteproc_tee.c create mode 100644 include/linux/remoteproc_tee.h
base-commit: 42f7652d3eb527d03665b09edac47f85fb600924
When a resource table is loaded by an external entity such as U-boot or OP-TEE, we do not necessarily get the device address(da) but the physical address(pa). This helper performs similar translation than the rproc_da_to_va() but based on a physical address.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com --- drivers/remoteproc/remoteproc_core.c | 46 ++++++++++++++++++++++++++++ include/linux/remoteproc.h | 1 + 2 files changed, 47 insertions(+)
diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c index f276956f2c5c..ace11ea17097 100644 --- a/drivers/remoteproc/remoteproc_core.c +++ b/drivers/remoteproc/remoteproc_core.c @@ -230,6 +230,52 @@ void *rproc_da_to_va(struct rproc *rproc, u64 da, size_t len, bool *is_iomem) } EXPORT_SYMBOL(rproc_da_to_va);
+/** + * rproc_pa_to_va() - lookup the kernel virtual address for a physical address of a remoteproc + * memory + * + * @rproc: handle of a remote processor + * @pa: remoteproc physical address + * @len: length of the memory region @pa is pointing to + * @is_iomem: optional pointer filled in to indicate if @da is iomapped memory + * + * This function is a helper function similar to rproc_da_to_va() but it deals with physical + * addresses instead of device addresses. + * + * Return: a valid kernel address on success or NULL on failure + */ +void *rproc_pa_to_va(struct rproc *rproc, phys_addr_t pa, size_t len, bool *is_iomem) +{ + struct rproc_mem_entry *carveout; + void *ptr = NULL; + + list_for_each_entry(carveout, &rproc->carveouts, node) { + int offset = pa - carveout->dma; + + /* Verify that carveout is allocated */ + if (!carveout->va) + continue; + + /* try next carveout if da is too small */ + if (offset < 0) + continue; + + /* try next carveout if da is too large */ + if (offset + len > carveout->len) + continue; + + ptr = carveout->va + offset; + + if (is_iomem) + *is_iomem = carveout->is_iomem; + + break; + } + + return ptr; +} +EXPORT_SYMBOL(rproc_pa_to_va); + /** * rproc_find_carveout_by_name() - lookup the carveout region by a name * @rproc: handle of a remote processor diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h index b4795698d8c2..8fd0d7f63c8e 100644 --- a/include/linux/remoteproc.h +++ b/include/linux/remoteproc.h @@ -690,6 +690,7 @@ int rproc_detach(struct rproc *rproc); int rproc_set_firmware(struct rproc *rproc, const char *fw_name); void rproc_report_crash(struct rproc *rproc, enum rproc_crash_type type); void *rproc_da_to_va(struct rproc *rproc, u64 da, size_t len, bool *is_iomem); +void *rproc_pa_to_va(struct rproc *rproc, phys_addr_t pa, size_t len, bool *is_iomem);
/* from remoteproc_coredump.c */ void rproc_coredump_cleanup(struct rproc *rproc);
Add a remoteproc TEE (Trusted Execution Environment) driver that will be probed by the TEE bus. If the associated Trusted application is supported on secure part this driver offers a client interface to load a firmware by the secure part. This firmware could be authenticated by the secure trusted application.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com --- Updates from version V11: - rename structures, functions, and variables from "tee_rproc_xxx" to "rproc_tee_xxx", - update rproc_tee_register to return an error instead of "struct rproc_tee *" pointer, - update rproc_tee_unregister argument from "struct rproc_tee *trproc" to "struct rproc *rproc", - reword MODULE_DESCRIPTION. --- drivers/remoteproc/Kconfig | 10 + drivers/remoteproc/Makefile | 1 + drivers/remoteproc/remoteproc_tee.c | 510 ++++++++++++++++++++++++++++ include/linux/remoteproc.h | 4 + include/linux/remoteproc_tee.h | 105 ++++++ 5 files changed, 630 insertions(+) create mode 100644 drivers/remoteproc/remoteproc_tee.c create mode 100644 include/linux/remoteproc_tee.h
diff --git a/drivers/remoteproc/Kconfig b/drivers/remoteproc/Kconfig index 955e4e38477e..d0284220a194 100644 --- a/drivers/remoteproc/Kconfig +++ b/drivers/remoteproc/Kconfig @@ -23,6 +23,16 @@ config REMOTEPROC_CDEV
It's safe to say N if you don't want to use this interface.
+config REMOTEPROC_TEE + tristate "Remoteproc support by a TEE application" + depends on OPTEE + help + Support a remote processor with a TEE application. The Trusted + Execution Context is responsible for loading the trusted firmware + image and managing the remote processor's lifecycle. + + It's safe to say N if you don't want to use remoteproc TEE. + config IMX_REMOTEPROC tristate "i.MX remoteproc support" depends on ARCH_MXC diff --git a/drivers/remoteproc/Makefile b/drivers/remoteproc/Makefile index 5ff4e2fee4ab..f77e0abe8349 100644 --- a/drivers/remoteproc/Makefile +++ b/drivers/remoteproc/Makefile @@ -11,6 +11,7 @@ remoteproc-y += remoteproc_sysfs.o remoteproc-y += remoteproc_virtio.o remoteproc-y += remoteproc_elf_loader.o obj-$(CONFIG_REMOTEPROC_CDEV) += remoteproc_cdev.o +obj-$(CONFIG_REMOTEPROC_TEE) += remoteproc_tee.o obj-$(CONFIG_IMX_REMOTEPROC) += imx_rproc.o obj-$(CONFIG_IMX_DSP_REMOTEPROC) += imx_dsp_rproc.o obj-$(CONFIG_INGENIC_VPU_RPROC) += ingenic_rproc.o diff --git a/drivers/remoteproc/remoteproc_tee.c b/drivers/remoteproc/remoteproc_tee.c new file mode 100644 index 000000000000..f258b9304daf --- /dev/null +++ b/drivers/remoteproc/remoteproc_tee.c @@ -0,0 +1,510 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * Copyright (C) STMicroelectronics 2024 + * Author: Arnaud Pouliquen arnaud.pouliquen@foss.st.com + */ + +#include <linux/firmware.h> +#include <linux/io.h> +#include <linux/module.h> +#include <linux/remoteproc.h> +#include <linux/remoteproc_tee.h> +#include <linux/slab.h> +#include <linux/tee_drv.h> + +#define MAX_TEE_PARAM_ARRAY_MEMBER 4 + +/* + * Authentication of the firmware and load in the remote processor memory + * + * [in] params[0].value.a: unique 32bit identifier of the remote processor + * [in] params[1].memref: buffer containing the image of the buffer + */ +#define TA_RPROC_FW_CMD_LOAD_FW 1 + +/* + * Start the remote processor + * + * [in] params[0].value.a: unique 32bit identifier of the remote processor + */ +#define TA_RPROC_FW_CMD_START_FW 2 + +/* + * Stop the remote processor + * + * [in] params[0].value.a: unique 32bit identifier of the remote processor + */ +#define TA_RPROC_FW_CMD_STOP_FW 3 + +/* + * Return the address of the resource table, or 0 if not found + * No check is done to verify that the address returned is accessible by + * the non secure context. If the resource table is loaded in a protected + * memory the access by the non secure context will lead to a data abort. + * + * [in] params[0].value.a: unique 32bit identifier of the remote processor + * [out] params[1].value.a: 32bit LSB resource table memory address + * [out] params[1].value.b: 32bit MSB resource table memory address + * [out] params[2].value.a: 32bit LSB resource table memory size + * [out] params[2].value.b: 32bit MSB resource table memory size + */ +#define TA_RPROC_FW_CMD_GET_RSC_TABLE 4 + +/* + * Return the address of the core dump + * + * [in] params[0].value.a: unique 32bit identifier of the remote processor + * [out] params[1].memref: address of the core dump image if exist, + * else return Null + */ +#define TA_RPROC_FW_CMD_GET_COREDUMP 5 + +/* + * Release remote processor firmware images and associated resources. + * This command should be used in case an error occurs between the loading of + * the firmware images (A_RPROC_CMD_LOAD_FW) and the starting of the remote + * processor (TA_RPROC_CMD_START_FW) or after stopping the remote processor + * to release associated resources (TA_RPROC_CMD_STOP_FW). + * + * [in] params[0].value.a: Unique 32-bit remote processor identifier + */ +#define TA_RPROC_CMD_RELEASE_FW 6 + +struct rproc_tee_context { + struct list_head sessions; + struct tee_context *tee_ctx; + struct device *dev; +}; + +static struct rproc_tee_context *rproc_tee_ctx; + +static void rproc_tee_prepare_args(struct rproc_tee *trproc, int cmd, + struct tee_ioctl_invoke_arg *arg, + struct tee_param *param, + unsigned int num_params) +{ + memset(arg, 0, sizeof(*arg)); + memset(param, 0, MAX_TEE_PARAM_ARRAY_MEMBER * sizeof(*param)); + + arg->func = cmd; + arg->session = trproc->session_id; + arg->num_params = num_params + 1; + + param[0] = (struct tee_param) { + .attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT, + .u.value.a = trproc->rproc_id, + }; +} + +void rproc_tee_release_fw(struct rproc *rproc) +{ + struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER]; + struct rproc_tee *trproc = rproc->rproc_tee_itf; + struct tee_ioctl_invoke_arg arg; + int ret; + + if (!rproc) { + ret = -EINVAL; + goto out; + } + + /* + * If the remote processor state is RPROC_DETACHED, just ignore the + * request, as the remote processor is still running. + */ + if (rproc->state == RPROC_DETACHED) + return; + + if (rproc->state != RPROC_OFFLINE) { + ret = -EBUSY; + goto out; + } + + rproc_tee_prepare_args(trproc, TA_RPROC_CMD_RELEASE_FW, &arg, param, 0); + + ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param); + if (ret < 0 || arg.ret != 0) { + dev_err(rproc_tee_ctx->dev, + "TA_RPROC_CMD_RELEASE_FW invoke failed TEE err: %x, ret:%x\n", + arg.ret, ret); + ret = -EIO; + } + +out: + if (ret) + /* Unexpected state without solution to come back in a stable state */ + dev_err(rproc_tee_ctx->dev, "Failed to release TEE remoteproc firmware: %d\n", ret); +} +EXPORT_SYMBOL_GPL(rproc_tee_release_fw); + +int rproc_tee_load_fw(struct rproc *rproc, const struct firmware *fw) +{ + struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER]; + struct rproc_tee *trproc = rproc->rproc_tee_itf; + struct tee_ioctl_invoke_arg arg; + struct tee_shm *fw_shm; + int ret; + + if (!trproc) + return -EINVAL; + + fw_shm = tee_shm_register_kernel_buf(rproc_tee_ctx->tee_ctx, (void *)fw->data, fw->size); + if (IS_ERR(fw_shm)) + return PTR_ERR(fw_shm); + + rproc_tee_prepare_args(trproc, TA_RPROC_FW_CMD_LOAD_FW, &arg, param, 1); + + /* Provide the address of the firmware image */ + param[1] = (struct tee_param) { + .attr = TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT, + .u.memref = { + .shm = fw_shm, + .size = fw->size, + .shm_offs = 0, + }, + }; + + ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param); + if (ret < 0 || arg.ret != 0) { + dev_err(rproc_tee_ctx->dev, + "TA_RPROC_FW_CMD_LOAD_FW invoke failed TEE err: %x, ret:%x\n", + arg.ret, ret); + if (!ret) + ret = -EIO; + } + + tee_shm_free(fw_shm); + + return ret; +} +EXPORT_SYMBOL_GPL(rproc_tee_load_fw); + +static int rproc_tee_get_loaded_rsc_table(struct rproc *rproc, phys_addr_t *rsc_pa, + size_t *table_sz) +{ + struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER]; + struct rproc_tee *trproc = rproc->rproc_tee_itf; + struct tee_ioctl_invoke_arg arg; + int ret; + + if (!trproc) + return -EINVAL; + + rproc_tee_prepare_args(trproc, TA_RPROC_FW_CMD_GET_RSC_TABLE, &arg, param, 2); + + param[1].attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_OUTPUT; + param[2].attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_OUTPUT; + + ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param); + if (ret < 0 || arg.ret != 0) { + dev_err(rproc_tee_ctx->dev, + "TA_RPROC_FW_CMD_GET_RSC_TABLE invoke failed TEE err: %x, ret:%x\n", + arg.ret, ret); + return -EIO; + } + + *table_sz = param[2].u.value.a; + + if (*table_sz) + *rsc_pa = param[1].u.value.a; + else + *rsc_pa = 0; + + return 0; +} + +int rproc_tee_parse_fw(struct rproc *rproc, const struct firmware *fw) +{ + phys_addr_t rsc_table; + void __iomem *rsc_va; + size_t table_sz; + int ret; + + if (!rproc) + return -EINVAL; + + ret = rproc_tee_load_fw(rproc, fw); + if (ret) + return ret; + + ret = rproc_tee_get_loaded_rsc_table(rproc, &rsc_table, &table_sz); + if (ret) + goto release_fw; + + /* + * We assume here that the memory mapping is the same between the TEE and Linux kernel + * contexts. Else a new TEE remoteproc service could be needed to get a copy of the + * resource table + */ + rsc_va = ioremap_wc(rsc_table, table_sz); + if (IS_ERR_OR_NULL(rsc_va)) { + dev_err(rproc_tee_ctx->dev, "Unable to map memory region: %pa+%zx\n", + &rsc_table, table_sz); + ret = -ENOMEM; + goto release_fw; + } + + /* + * Create a copy of the resource table to have the same behavior as the ELF loader. + * This cached table will be used by the remoteproc core after the remoteproc stops + * to free resources and for crash recovery to reapply the settings. + * The cached table will be freed by the remoteproc core. + */ + rproc->cached_table = kmemdup((__force void *)rsc_va, table_sz, GFP_KERNEL); + iounmap(rsc_va); + + if (!rproc->cached_table) { + ret = -ENOMEM; + goto release_fw; + } + + rproc->table_ptr = rproc->cached_table; + rproc->table_sz = table_sz; + + return 0; + +release_fw: + rproc_tee_release_fw(rproc); + return ret; +} +EXPORT_SYMBOL_GPL(rproc_tee_parse_fw); + +struct resource_table *rproc_tee_find_loaded_rsc_table(struct rproc *rproc, + const struct firmware *fw) +{ + phys_addr_t rsc_table; + size_t table_sz; + int ret; + + ret = rproc_tee_get_loaded_rsc_table(rproc, &rsc_table, &table_sz); + if (ret) + return NULL; + + rproc->table_sz = table_sz; + if (!table_sz) + return NULL; + + /* + * At this step the memory area that contains the resource table should have been registered + * by the remote proc platform driver and allocated by rproc_alloc_registered_carveouts(). + */ + return (struct resource_table *)rproc_pa_to_va(rproc, rsc_table, table_sz, NULL); +} +EXPORT_SYMBOL_GPL(rproc_tee_find_loaded_rsc_table); + +int rproc_tee_start(struct rproc *rproc) +{ + struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER]; + struct rproc_tee *trproc = rproc->rproc_tee_itf; + struct tee_ioctl_invoke_arg arg; + int ret = 0; + + if (!trproc) + return -EINVAL; + + rproc_tee_prepare_args(trproc, TA_RPROC_FW_CMD_START_FW, &arg, param, 0); + + ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param); + if (ret < 0 || arg.ret != 0) { + dev_err(rproc_tee_ctx->dev, + "TA_RPROC_FW_CMD_START_FW invoke failed TEE err: %x, ret:%x\n", + arg.ret, ret); + if (!ret) + return -EIO; + } + + return 0; +} +EXPORT_SYMBOL_GPL(rproc_tee_start); + +int rproc_tee_stop(struct rproc *rproc) +{ + struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER]; + struct rproc_tee *trproc = rproc->rproc_tee_itf; + struct tee_ioctl_invoke_arg arg; + int ret; + + if (!trproc) + return -EINVAL; + + rproc_tee_prepare_args(trproc, TA_RPROC_FW_CMD_STOP_FW, &arg, param, 0); + + ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param); + if (ret < 0 || arg.ret != 0) { + dev_err(rproc_tee_ctx->dev, + "TA_RPROC_FW_CMD_STOP_FW invoke failed TEE err: %x, ret:%x\n", + arg.ret, ret); + if (!ret) + ret = -EIO; + } + + return ret; +} +EXPORT_SYMBOL_GPL(rproc_tee_stop); + +static const struct tee_client_device_id rproc_tee_id_table[] = { + {UUID_INIT(0x80a4c275, 0x0a47, 0x4905, 0x82, 0x85, 0x14, 0x86, 0xa9, 0x77, 0x1a, 0x08)}, + {} +}; + +int rproc_tee_register(struct device *dev, struct rproc *rproc, unsigned int rproc_id) +{ + struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER]; + struct tee_ioctl_open_session_arg sess_arg; + struct tee_client_device *tee_device; + struct rproc_tee *trproc; + int ret; + + /* + * Test if the device has been probed by the TEE bus. In case of failure, we ignore the + * reason. The bus could be not yet probed or the service not available in the secure + * firmware.The assumption in such a case is that the TEE remoteproc is not probed. + */ + if (!rproc_tee_ctx) + return -EPROBE_DEFER; + + /* Prevent rproc tee module from being removed */ + if (!try_module_get(THIS_MODULE)) { + dev_err(rproc_tee_ctx->dev, "can't get owner\n"); + return -ENODEV; + } + + trproc = devm_kzalloc(dev, sizeof(*trproc), GFP_KERNEL); + if (!trproc) { + ret = -ENOMEM; + goto module_put; + } + + tee_device = to_tee_client_device(rproc_tee_ctx->dev); + memset(&sess_arg, 0, sizeof(sess_arg)); + + memcpy(sess_arg.uuid, tee_device->id.uuid.b, TEE_IOCTL_UUID_LEN); + + sess_arg.clnt_login = TEE_IOCTL_LOGIN_REE_KERNEL; + sess_arg.num_params = 1; + + param[0] = (struct tee_param) { + .attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT, + .u.value.a = rproc_id, + }; + + ret = tee_client_open_session(rproc_tee_ctx->tee_ctx, &sess_arg, param); + if (ret < 0 || sess_arg.ret != 0) { + dev_err(dev, "tee_client_open_session failed, err: %x\n", sess_arg.ret); + ret = -EINVAL; + goto module_put; + } + + trproc->parent = dev; + trproc->rproc_id = rproc_id; + trproc->session_id = sess_arg.session; + + trproc->rproc = rproc; + rproc->rproc_tee_itf = trproc; + + list_add_tail(&trproc->node, &rproc_tee_ctx->sessions); + + return 0; + +module_put: + module_put(THIS_MODULE); + return ret; +} +EXPORT_SYMBOL_GPL(rproc_tee_register); + +int rproc_tee_unregister(struct rproc *rproc) +{ + struct rproc_tee *trproc = rproc->rproc_tee_itf; + int ret; + + if (!rproc->rproc_tee_itf) + return -ENODEV; + + ret = tee_client_close_session(rproc_tee_ctx->tee_ctx, trproc->session_id); + if (ret < 0) + dev_err(trproc->parent, "tee_client_close_session failed, err: %x\n", ret); + + list_del(&trproc->node); + rproc->rproc_tee_itf = NULL; + + module_put(THIS_MODULE); + + return ret; +} +EXPORT_SYMBOL_GPL(rproc_tee_unregister); + +static int rproc_tee_ctx_match(struct tee_ioctl_version_data *ver, const void *data) +{ + /* Today we support only the OP-TEE, could be extend to other tees */ + return (ver->impl_id == TEE_IMPL_ID_OPTEE); +} + +static int rproc_tee_probe(struct device *dev) +{ + struct tee_context *tee_ctx; + int ret; + + /* Open context with TEE driver */ + tee_ctx = tee_client_open_context(NULL, rproc_tee_ctx_match, NULL, NULL); + if (IS_ERR(tee_ctx)) + return PTR_ERR(tee_ctx); + + rproc_tee_ctx = devm_kzalloc(dev, sizeof(*rproc_tee_ctx), GFP_KERNEL); + if (!rproc_tee_ctx) { + ret = -ENOMEM; + goto err; + } + + rproc_tee_ctx->dev = dev; + rproc_tee_ctx->tee_ctx = tee_ctx; + INIT_LIST_HEAD(&rproc_tee_ctx->sessions); + + return 0; +err: + tee_client_close_context(tee_ctx); + + return ret; +} + +static int rproc_tee_remove(struct device *dev) +{ + struct rproc_tee *entry, *tmp; + + list_for_each_entry_safe(entry, tmp, &rproc_tee_ctx->sessions, node) { + tee_client_close_session(rproc_tee_ctx->tee_ctx, entry->session_id); + list_del(&entry->node); + kfree(entry); + } + + tee_client_close_context(rproc_tee_ctx->tee_ctx); + + return 0; +} + +MODULE_DEVICE_TABLE(tee, rproc_tee_id_table); + +static struct tee_client_driver rproc_tee_fw_driver = { + .id_table = rproc_tee_id_table, + .driver = { + .name = KBUILD_MODNAME, + .bus = &tee_bus_type, + .probe = rproc_tee_probe, + .remove = rproc_tee_remove, + }, +}; + +static int __init rproc_tee_fw_mod_init(void) +{ + return driver_register(&rproc_tee_fw_driver.driver); +} + +static void __exit rproc_tee_fw_mod_exit(void) +{ + driver_unregister(&rproc_tee_fw_driver.driver); +} + +module_init(rproc_tee_fw_mod_init); +module_exit(rproc_tee_fw_mod_exit); + +MODULE_DESCRIPTION(" remote processor TEE module"); +MODULE_LICENSE("GPL"); diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h index 8fd0d7f63c8e..2e0ddcb2d792 100644 --- a/include/linux/remoteproc.h +++ b/include/linux/remoteproc.h @@ -503,6 +503,8 @@ enum rproc_features { RPROC_MAX_FEATURES, };
+struct rproc_tee; + /** * struct rproc - represents a physical remote processor device * @node: list node of this rproc object @@ -545,6 +547,7 @@ enum rproc_features { * @cdev: character device of the rproc * @cdev_put_on_release: flag to indicate if remoteproc should be shutdown on @char_dev release * @features: indicate remoteproc features + * @rproc_tee_itf: pointer to the remoteproc tee context */ struct rproc { struct list_head node; @@ -586,6 +589,7 @@ struct rproc { struct cdev cdev; bool cdev_put_on_release; DECLARE_BITMAP(features, RPROC_MAX_FEATURES); + struct rproc_tee *rproc_tee_itf; };
/** diff --git a/include/linux/remoteproc_tee.h b/include/linux/remoteproc_tee.h new file mode 100644 index 000000000000..9b498a8eff4d --- /dev/null +++ b/include/linux/remoteproc_tee.h @@ -0,0 +1,105 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ +/* + * Copyright(c) 2024 STMicroelectronics + */ + +#ifndef REMOTEPROC_TEE_H +#define REMOTEPROC_TEE_H + +#include <linux/tee_drv.h> +#include <linux/firmware.h> +#include <linux/remoteproc.h> + +struct rproc; + +/** + * struct rproc_tee - TEE remoteproc structure + * @node: Reference in list + * @rproc: Remoteproc reference + * @parent: Parent device + * @rproc_id: Identifier of the target firmware + * @session_id: TEE session identifier + */ +struct rproc_tee { + struct list_head node; + struct rproc *rproc; + struct device *parent; + u32 rproc_id; + u32 session_id; +}; + +#if IS_REACHABLE(CONFIG_REMOTEPROC_TEE) + +int rproc_tee_register(struct device *dev, struct rproc *rproc, unsigned int rproc_id); +int rproc_tee_unregister(struct rproc *rproc); +int rproc_tee_parse_fw(struct rproc *rproc, const struct firmware *fw); +int rproc_tee_load_fw(struct rproc *rproc, const struct firmware *fw); +void rproc_tee_release_fw(struct rproc *rproc); +struct resource_table *rproc_tee_find_loaded_rsc_table(struct rproc *rproc, + const struct firmware *fw); +int rproc_tee_start(struct rproc *rproc); +int rproc_tee_stop(struct rproc *rproc); + +#else + +static inline int rproc_tee_register(struct device *dev, struct rproc *rproc, unsigned int rproc_id) +{ + return -ENODEV; +} + +static inline int rproc_tee_parse_fw(struct rproc *rproc, const struct firmware *fw) +{ + /* This shouldn't be possible */ + WARN_ON(1); + + return 0; +} + +static inline int rproc_tee_unregister(struct rproc *rproc) +{ + /* This shouldn't be possible */ + WARN_ON(1); + + return 0; +} + +static inline int rproc_tee_load_fw(struct rproc *rproc, const struct firmware *fw) +{ + /* This shouldn't be possible */ + WARN_ON(1); + + return 0; +} + +static inline int rproc_tee_start(struct rproc *rproc) +{ + /* This shouldn't be possible */ + WARN_ON(1); + + return 0; +} + +static inline int rproc_tee_stop(struct rproc *rproc) +{ + /* This shouldn't be possible */ + WARN_ON(1); + + return 0; +} + +static inline void rproc_tee_release_fw(struct rproc *rproc) +{ + /* This shouldn't be possible */ + WARN_ON(1); +} + +static inline struct resource_table * +rproc_tee_find_loaded_rsc_table(struct rproc *rproc, const struct firmware *fw) +{ + /* This shouldn't be possible */ + WARN_ON(1); + + return NULL; +} +#endif /* CONFIG_REMOTEPROC_TEE */ +#endif /* REMOTEPROC_TEE_H */
On Mon, Nov 04, 2024 at 02:35:10PM +0100, Arnaud Pouliquen wrote:
Add a remoteproc TEE (Trusted Execution Environment) driver that will be probed by the TEE bus. If the associated Trusted application is supported on secure part this driver offers a client interface to load a firmware by the secure part. This firmware could be authenticated by the secure trusted application.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
Updates from version V11:
- rename structures, functions, and variables from "tee_rproc_xxx" to "rproc_tee_xxx",
- update rproc_tee_register to return an error instead of "struct rproc_tee *" pointer,
- update rproc_tee_unregister argument from "struct rproc_tee *trproc" to "struct rproc *rproc",
- reword MODULE_DESCRIPTION.
drivers/remoteproc/Kconfig | 10 + drivers/remoteproc/Makefile | 1 + drivers/remoteproc/remoteproc_tee.c | 510 ++++++++++++++++++++++++++++ include/linux/remoteproc.h | 4 + include/linux/remoteproc_tee.h | 105 ++++++ 5 files changed, 630 insertions(+) create mode 100644 drivers/remoteproc/remoteproc_tee.c create mode 100644 include/linux/remoteproc_tee.h
diff --git a/drivers/remoteproc/Kconfig b/drivers/remoteproc/Kconfig index 955e4e38477e..d0284220a194 100644 --- a/drivers/remoteproc/Kconfig +++ b/drivers/remoteproc/Kconfig @@ -23,6 +23,16 @@ config REMOTEPROC_CDEV It's safe to say N if you don't want to use this interface. +config REMOTEPROC_TEE
- tristate "Remoteproc support by a TEE application"
Tristate? Didn't we agree this would be either compiled in or out, but not as a module?
- depends on OPTEE
- help
Support a remote processor with a TEE application. The TrustedExecution Context is responsible for loading the trusted firmwareimage and managing the remote processor's lifecycle.It's safe to say N if you don't want to use remoteproc TEE.config IMX_REMOTEPROC tristate "i.MX remoteproc support" depends on ARCH_MXC diff --git a/drivers/remoteproc/Makefile b/drivers/remoteproc/Makefile index 5ff4e2fee4ab..f77e0abe8349 100644 --- a/drivers/remoteproc/Makefile +++ b/drivers/remoteproc/Makefile @@ -11,6 +11,7 @@ remoteproc-y += remoteproc_sysfs.o remoteproc-y += remoteproc_virtio.o remoteproc-y += remoteproc_elf_loader.o obj-$(CONFIG_REMOTEPROC_CDEV) += remoteproc_cdev.o +obj-$(CONFIG_REMOTEPROC_TEE) += remoteproc_tee.o obj-$(CONFIG_IMX_REMOTEPROC) += imx_rproc.o obj-$(CONFIG_IMX_DSP_REMOTEPROC) += imx_dsp_rproc.o obj-$(CONFIG_INGENIC_VPU_RPROC) += ingenic_rproc.o diff --git a/drivers/remoteproc/remoteproc_tee.c b/drivers/remoteproc/remoteproc_tee.c new file mode 100644 index 000000000000..f258b9304daf --- /dev/null +++ b/drivers/remoteproc/remoteproc_tee.c @@ -0,0 +1,510 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/*
- Copyright (C) STMicroelectronics 2024
- Author: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
- */
+#include <linux/firmware.h> +#include <linux/io.h> +#include <linux/module.h> +#include <linux/remoteproc.h> +#include <linux/remoteproc_tee.h> +#include <linux/slab.h> +#include <linux/tee_drv.h>
+#define MAX_TEE_PARAM_ARRAY_MEMBER 4
+/*
- Authentication of the firmware and load in the remote processor memory
- [in] params[0].value.a: unique 32bit identifier of the remote processor
- [in] params[1].memref: buffer containing the image of the buffer
- */
+#define TA_RPROC_FW_CMD_LOAD_FW 1
+/*
- Start the remote processor
- [in] params[0].value.a: unique 32bit identifier of the remote processor
- */
+#define TA_RPROC_FW_CMD_START_FW 2
+/*
- Stop the remote processor
- [in] params[0].value.a: unique 32bit identifier of the remote processor
- */
+#define TA_RPROC_FW_CMD_STOP_FW 3
+/*
- Return the address of the resource table, or 0 if not found
- No check is done to verify that the address returned is accessible by
- the non secure context. If the resource table is loaded in a protected
- memory the access by the non secure context will lead to a data abort.
- [in] params[0].value.a: unique 32bit identifier of the remote processor
- [out] params[1].value.a: 32bit LSB resource table memory address
- [out] params[1].value.b: 32bit MSB resource table memory address
- [out] params[2].value.a: 32bit LSB resource table memory size
- [out] params[2].value.b: 32bit MSB resource table memory size
- */
+#define TA_RPROC_FW_CMD_GET_RSC_TABLE 4
+/*
- Return the address of the core dump
- [in] params[0].value.a: unique 32bit identifier of the remote processor
- [out] params[1].memref: address of the core dump image if exist,
else return Null- */
+#define TA_RPROC_FW_CMD_GET_COREDUMP 5
+/*
- Release remote processor firmware images and associated resources.
- This command should be used in case an error occurs between the loading of
- the firmware images (A_RPROC_CMD_LOAD_FW) and the starting of the remote
s/A_RPROC_CMD_LOAD_FW/TA_RPROC_CMD_LOAD_FW
- processor (TA_RPROC_CMD_START_FW) or after stopping the remote processor
- to release associated resources (TA_RPROC_CMD_STOP_FW).
- [in] params[0].value.a: Unique 32-bit remote processor identifier
- */
+#define TA_RPROC_CMD_RELEASE_FW 6
+struct rproc_tee_context {
- struct list_head sessions;
- struct tee_context *tee_ctx;
- struct device *dev;
+};
+static struct rproc_tee_context *rproc_tee_ctx;
+static void rproc_tee_prepare_args(struct rproc_tee *trproc, int cmd,
struct tee_ioctl_invoke_arg *arg,struct tee_param *param,unsigned int num_params)+{
- memset(arg, 0, sizeof(*arg));
- memset(param, 0, MAX_TEE_PARAM_ARRAY_MEMBER * sizeof(*param));
- arg->func = cmd;
- arg->session = trproc->session_id;
- arg->num_params = num_params + 1;
- param[0] = (struct tee_param) {
.attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT,.u.value.a = trproc->rproc_id,- };
+}
+void rproc_tee_release_fw(struct rproc *rproc) +{
- struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER];
- struct rproc_tee *trproc = rproc->rproc_tee_itf;
- struct tee_ioctl_invoke_arg arg;
- int ret;
- if (!rproc) {
ret = -EINVAL;goto out;- }
- /*
* If the remote processor state is RPROC_DETACHED, just ignore the* request, as the remote processor is still running.*/- if (rproc->state == RPROC_DETACHED)
return;- if (rproc->state != RPROC_OFFLINE) {
ret = -EBUSY;goto out;- }
- rproc_tee_prepare_args(trproc, TA_RPROC_CMD_RELEASE_FW, &arg, param, 0);
- ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param);
- if (ret < 0 || arg.ret != 0) {
dev_err(rproc_tee_ctx->dev,"TA_RPROC_CMD_RELEASE_FW invoke failed TEE err: %x, ret:%x\n",arg.ret, ret);ret = -EIO;- }
+out:
- if (ret)
/* Unexpected state without solution to come back in a stable state */dev_err(rproc_tee_ctx->dev, "Failed to release TEE remoteproc firmware: %d\n", ret);+} +EXPORT_SYMBOL_GPL(rproc_tee_release_fw);
+int rproc_tee_load_fw(struct rproc *rproc, const struct firmware *fw) +{
- struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER];
- struct rproc_tee *trproc = rproc->rproc_tee_itf;
- struct tee_ioctl_invoke_arg arg;
- struct tee_shm *fw_shm;
- int ret;
- if (!trproc)
return -EINVAL;- fw_shm = tee_shm_register_kernel_buf(rproc_tee_ctx->tee_ctx, (void *)fw->data, fw->size);
- if (IS_ERR(fw_shm))
return PTR_ERR(fw_shm);- rproc_tee_prepare_args(trproc, TA_RPROC_FW_CMD_LOAD_FW, &arg, param, 1);
- /* Provide the address of the firmware image */
- param[1] = (struct tee_param) {
.attr = TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT,.u.memref = {.shm = fw_shm,.size = fw->size,.shm_offs = 0,},- };
- ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param);
- if (ret < 0 || arg.ret != 0) {
dev_err(rproc_tee_ctx->dev,"TA_RPROC_FW_CMD_LOAD_FW invoke failed TEE err: %x, ret:%x\n",arg.ret, ret);if (!ret)ret = -EIO;- }
- tee_shm_free(fw_shm);
- return ret;
+} +EXPORT_SYMBOL_GPL(rproc_tee_load_fw);
+static int rproc_tee_get_loaded_rsc_table(struct rproc *rproc, phys_addr_t *rsc_pa,
size_t *table_sz)+{
- struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER];
- struct rproc_tee *trproc = rproc->rproc_tee_itf;
- struct tee_ioctl_invoke_arg arg;
- int ret;
- if (!trproc)
return -EINVAL;- rproc_tee_prepare_args(trproc, TA_RPROC_FW_CMD_GET_RSC_TABLE, &arg, param, 2);
- param[1].attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_OUTPUT;
- param[2].attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_OUTPUT;
- ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param);
- if (ret < 0 || arg.ret != 0) {
dev_err(rproc_tee_ctx->dev,"TA_RPROC_FW_CMD_GET_RSC_TABLE invoke failed TEE err: %x, ret:%x\n",arg.ret, ret);return -EIO;- }
- *table_sz = param[2].u.value.a;
- if (*table_sz)
*rsc_pa = param[1].u.value.a;- else
*rsc_pa = 0;- return 0;
+}
+int rproc_tee_parse_fw(struct rproc *rproc, const struct firmware *fw) +{
- phys_addr_t rsc_table;
- void __iomem *rsc_va;
- size_t table_sz;
- int ret;
- if (!rproc)
return -EINVAL;- ret = rproc_tee_load_fw(rproc, fw);
- if (ret)
return ret;- ret = rproc_tee_get_loaded_rsc_table(rproc, &rsc_table, &table_sz);
- if (ret)
goto release_fw;- /*
* We assume here that the memory mapping is the same between the TEE and Linux kernel* contexts. Else a new TEE remoteproc service could be needed to get a copy of the* resource table*/- rsc_va = ioremap_wc(rsc_table, table_sz);
- if (IS_ERR_OR_NULL(rsc_va)) {
dev_err(rproc_tee_ctx->dev, "Unable to map memory region: %pa+%zx\n",&rsc_table, table_sz);ret = -ENOMEM;goto release_fw;- }
- /*
* Create a copy of the resource table to have the same behavior as the ELF loader.* This cached table will be used by the remoteproc core after the remoteproc stops* to free resources and for crash recovery to reapply the settings.* The cached table will be freed by the remoteproc core.*/- rproc->cached_table = kmemdup((__force void *)rsc_va, table_sz, GFP_KERNEL);
- iounmap(rsc_va);
- if (!rproc->cached_table) {
ret = -ENOMEM;goto release_fw;- }
- rproc->table_ptr = rproc->cached_table;
- rproc->table_sz = table_sz;
- return 0;
+release_fw:
- rproc_tee_release_fw(rproc);
- return ret;
+} +EXPORT_SYMBOL_GPL(rproc_tee_parse_fw);
+struct resource_table *rproc_tee_find_loaded_rsc_table(struct rproc *rproc,
const struct firmware *fw)+{
- phys_addr_t rsc_table;
- size_t table_sz;
- int ret;
- ret = rproc_tee_get_loaded_rsc_table(rproc, &rsc_table, &table_sz);
- if (ret)
return NULL;- rproc->table_sz = table_sz;
- if (!table_sz)
return NULL;- /*
* At this step the memory area that contains the resource table should have been registered* by the remote proc platform driver and allocated by rproc_alloc_registered_carveouts().*/- return (struct resource_table *)rproc_pa_to_va(rproc, rsc_table, table_sz, NULL);
+} +EXPORT_SYMBOL_GPL(rproc_tee_find_loaded_rsc_table);
+int rproc_tee_start(struct rproc *rproc) +{
- struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER];
- struct rproc_tee *trproc = rproc->rproc_tee_itf;
- struct tee_ioctl_invoke_arg arg;
- int ret = 0;
- if (!trproc)
return -EINVAL;- rproc_tee_prepare_args(trproc, TA_RPROC_FW_CMD_START_FW, &arg, param, 0);
- ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param);
- if (ret < 0 || arg.ret != 0) {
dev_err(rproc_tee_ctx->dev,"TA_RPROC_FW_CMD_START_FW invoke failed TEE err: %x, ret:%x\n",arg.ret, ret);if (!ret)return -EIO;- }
- return 0;
+} +EXPORT_SYMBOL_GPL(rproc_tee_start);
+int rproc_tee_stop(struct rproc *rproc) +{
- struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER];
- struct rproc_tee *trproc = rproc->rproc_tee_itf;
- struct tee_ioctl_invoke_arg arg;
- int ret;
- if (!trproc)
return -EINVAL;- rproc_tee_prepare_args(trproc, TA_RPROC_FW_CMD_STOP_FW, &arg, param, 0);
- ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param);
- if (ret < 0 || arg.ret != 0) {
dev_err(rproc_tee_ctx->dev,"TA_RPROC_FW_CMD_STOP_FW invoke failed TEE err: %x, ret:%x\n",arg.ret, ret);if (!ret)ret = -EIO;- }
- return ret;
+} +EXPORT_SYMBOL_GPL(rproc_tee_stop);
+static const struct tee_client_device_id rproc_tee_id_table[] = {
- {UUID_INIT(0x80a4c275, 0x0a47, 0x4905, 0x82, 0x85, 0x14, 0x86, 0xa9, 0x77, 0x1a, 0x08)},
- {}
+};
+int rproc_tee_register(struct device *dev, struct rproc *rproc, unsigned int rproc_id) +{
- struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER];
- struct tee_ioctl_open_session_arg sess_arg;
- struct tee_client_device *tee_device;
- struct rproc_tee *trproc;
- int ret;
- /*
* Test if the device has been probed by the TEE bus. In case of failure, we ignore the* reason. The bus could be not yet probed or the service not available in the secure* firmware.The assumption in such a case is that the TEE remoteproc is not probed.*/- if (!rproc_tee_ctx)
return -EPROBE_DEFER;- /* Prevent rproc tee module from being removed */
- if (!try_module_get(THIS_MODULE)) {
dev_err(rproc_tee_ctx->dev, "can't get owner\n");return -ENODEV;- }
- trproc = devm_kzalloc(dev, sizeof(*trproc), GFP_KERNEL);
- if (!trproc) {
ret = -ENOMEM;goto module_put;- }
- tee_device = to_tee_client_device(rproc_tee_ctx->dev);
- memset(&sess_arg, 0, sizeof(sess_arg));
- memcpy(sess_arg.uuid, tee_device->id.uuid.b, TEE_IOCTL_UUID_LEN);
- sess_arg.clnt_login = TEE_IOCTL_LOGIN_REE_KERNEL;
- sess_arg.num_params = 1;
- param[0] = (struct tee_param) {
.attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT,.u.value.a = rproc_id,- };
- ret = tee_client_open_session(rproc_tee_ctx->tee_ctx, &sess_arg, param);
- if (ret < 0 || sess_arg.ret != 0) {
dev_err(dev, "tee_client_open_session failed, err: %x\n", sess_arg.ret);ret = -EINVAL;goto module_put;- }
- trproc->parent = dev;
- trproc->rproc_id = rproc_id;
- trproc->session_id = sess_arg.session;
- trproc->rproc = rproc;
- rproc->rproc_tee_itf = trproc;
- list_add_tail(&trproc->node, &rproc_tee_ctx->sessions);
- return 0;
+module_put:
- module_put(THIS_MODULE);
- return ret;
+} +EXPORT_SYMBOL_GPL(rproc_tee_register);
+int rproc_tee_unregister(struct rproc *rproc) +{
- struct rproc_tee *trproc = rproc->rproc_tee_itf;
- int ret;
- if (!rproc->rproc_tee_itf)
return -ENODEV;- ret = tee_client_close_session(rproc_tee_ctx->tee_ctx, trproc->session_id);
- if (ret < 0)
dev_err(trproc->parent, "tee_client_close_session failed, err: %x\n", ret);- list_del(&trproc->node);
- rproc->rproc_tee_itf = NULL;
- module_put(THIS_MODULE);
- return ret;
+} +EXPORT_SYMBOL_GPL(rproc_tee_unregister);
+static int rproc_tee_ctx_match(struct tee_ioctl_version_data *ver, const void *data) +{
- /* Today we support only the OP-TEE, could be extend to other tees */
- return (ver->impl_id == TEE_IMPL_ID_OPTEE);
+}
+static int rproc_tee_probe(struct device *dev) +{
- struct tee_context *tee_ctx;
- int ret;
- /* Open context with TEE driver */
- tee_ctx = tee_client_open_context(NULL, rproc_tee_ctx_match, NULL, NULL);
- if (IS_ERR(tee_ctx))
return PTR_ERR(tee_ctx);- rproc_tee_ctx = devm_kzalloc(dev, sizeof(*rproc_tee_ctx), GFP_KERNEL);
- if (!rproc_tee_ctx) {
ret = -ENOMEM;goto err;- }
- rproc_tee_ctx->dev = dev;
- rproc_tee_ctx->tee_ctx = tee_ctx;
- INIT_LIST_HEAD(&rproc_tee_ctx->sessions);
- return 0;
+err:
- tee_client_close_context(tee_ctx);
- return ret;
+}
+static int rproc_tee_remove(struct device *dev) +{
- struct rproc_tee *entry, *tmp;
- list_for_each_entry_safe(entry, tmp, &rproc_tee_ctx->sessions, node) {
tee_client_close_session(rproc_tee_ctx->tee_ctx, entry->session_id);list_del(&entry->node);kfree(entry);- }
- tee_client_close_context(rproc_tee_ctx->tee_ctx);
- return 0;
+}
+MODULE_DEVICE_TABLE(tee, rproc_tee_id_table);
+static struct tee_client_driver rproc_tee_fw_driver = {
- .id_table = rproc_tee_id_table,
- .driver = {
.name = KBUILD_MODNAME,.bus = &tee_bus_type,.probe = rproc_tee_probe,.remove = rproc_tee_remove,- },
+};
+static int __init rproc_tee_fw_mod_init(void) +{
- return driver_register(&rproc_tee_fw_driver.driver);
+}
+static void __exit rproc_tee_fw_mod_exit(void) +{
- driver_unregister(&rproc_tee_fw_driver.driver);
+}
+module_init(rproc_tee_fw_mod_init); +module_exit(rproc_tee_fw_mod_exit);
+MODULE_DESCRIPTION(" remote processor TEE module"); +MODULE_LICENSE("GPL"); diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h index 8fd0d7f63c8e..2e0ddcb2d792 100644 --- a/include/linux/remoteproc.h +++ b/include/linux/remoteproc.h @@ -503,6 +503,8 @@ enum rproc_features { RPROC_MAX_FEATURES, }; +struct rproc_tee;
/**
- struct rproc - represents a physical remote processor device
- @node: list node of this rproc object
@@ -545,6 +547,7 @@ enum rproc_features {
- @cdev: character device of the rproc
- @cdev_put_on_release: flag to indicate if remoteproc should be shutdown on @char_dev release
- @features: indicate remoteproc features
*/
- @rproc_tee_itf: pointer to the remoteproc tee context
struct rproc { struct list_head node; @@ -586,6 +589,7 @@ struct rproc { struct cdev cdev; bool cdev_put_on_release; DECLARE_BITMAP(features, RPROC_MAX_FEATURES);
- struct rproc_tee *rproc_tee_itf;
}; /** diff --git a/include/linux/remoteproc_tee.h b/include/linux/remoteproc_tee.h new file mode 100644 index 000000000000..9b498a8eff4d --- /dev/null +++ b/include/linux/remoteproc_tee.h @@ -0,0 +1,105 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ +/*
- Copyright(c) 2024 STMicroelectronics
- */
+#ifndef REMOTEPROC_TEE_H +#define REMOTEPROC_TEE_H
+#include <linux/tee_drv.h> +#include <linux/firmware.h> +#include <linux/remoteproc.h>
+struct rproc;
+/**
- struct rproc_tee - TEE remoteproc structure
- @node: Reference in list
- @rproc: Remoteproc reference
- @parent: Parent device
- @rproc_id: Identifier of the target firmware
- @session_id: TEE session identifier
- */
+struct rproc_tee {
- struct list_head node;
- struct rproc *rproc;
- struct device *parent;
- u32 rproc_id;
- u32 session_id;
+};
+#if IS_REACHABLE(CONFIG_REMOTEPROC_TEE)
+int rproc_tee_register(struct device *dev, struct rproc *rproc, unsigned int rproc_id); +int rproc_tee_unregister(struct rproc *rproc); +int rproc_tee_parse_fw(struct rproc *rproc, const struct firmware *fw); +int rproc_tee_load_fw(struct rproc *rproc, const struct firmware *fw); +void rproc_tee_release_fw(struct rproc *rproc); +struct resource_table *rproc_tee_find_loaded_rsc_table(struct rproc *rproc,
const struct firmware *fw);+int rproc_tee_start(struct rproc *rproc); +int rproc_tee_stop(struct rproc *rproc);
+#else
+static inline int rproc_tee_register(struct device *dev, struct rproc *rproc, unsigned int rproc_id) +{
- return -ENODEV;
+}
+static inline int rproc_tee_parse_fw(struct rproc *rproc, const struct firmware *fw) +{
- /* This shouldn't be possible */
- WARN_ON(1);
- return 0;
+}
+static inline int rproc_tee_unregister(struct rproc *rproc) +{
- /* This shouldn't be possible */
- WARN_ON(1);
- return 0;
+}
+static inline int rproc_tee_load_fw(struct rproc *rproc, const struct firmware *fw) +{
- /* This shouldn't be possible */
- WARN_ON(1);
- return 0;
+}
+static inline int rproc_tee_start(struct rproc *rproc) +{
- /* This shouldn't be possible */
- WARN_ON(1);
- return 0;
+}
+static inline int rproc_tee_stop(struct rproc *rproc) +{
- /* This shouldn't be possible */
- WARN_ON(1);
- return 0;
+}
+static inline void rproc_tee_release_fw(struct rproc *rproc) +{
- /* This shouldn't be possible */
- WARN_ON(1);
+}
+static inline struct resource_table * +rproc_tee_find_loaded_rsc_table(struct rproc *rproc, const struct firmware *fw) +{
- /* This shouldn't be possible */
- WARN_ON(1);
- return NULL;
+} +#endif /* CONFIG_REMOTEPROC_TEE */
+#endif /* REMOTEPROC_TEE_H */
2.25.1
Hello Mathieu
On 11/14/24 18:59, Mathieu Poirier wrote:
On Mon, Nov 04, 2024 at 02:35:10PM +0100, Arnaud Pouliquen wrote:
Add a remoteproc TEE (Trusted Execution Environment) driver that will be probed by the TEE bus. If the associated Trusted application is supported on secure part this driver offers a client interface to load a firmware by the secure part. This firmware could be authenticated by the secure trusted application.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
Updates from version V11:
- rename structures, functions, and variables from "tee_rproc_xxx" to "rproc_tee_xxx",
- update rproc_tee_register to return an error instead of "struct rproc_tee *" pointer,
- update rproc_tee_unregister argument from "struct rproc_tee *trproc" to "struct rproc *rproc",
- reword MODULE_DESCRIPTION.
drivers/remoteproc/Kconfig | 10 + drivers/remoteproc/Makefile | 1 + drivers/remoteproc/remoteproc_tee.c | 510 ++++++++++++++++++++++++++++ include/linux/remoteproc.h | 4 + include/linux/remoteproc_tee.h | 105 ++++++ 5 files changed, 630 insertions(+) create mode 100644 drivers/remoteproc/remoteproc_tee.c create mode 100644 include/linux/remoteproc_tee.h
diff --git a/drivers/remoteproc/Kconfig b/drivers/remoteproc/Kconfig index 955e4e38477e..d0284220a194 100644 --- a/drivers/remoteproc/Kconfig +++ b/drivers/remoteproc/Kconfig @@ -23,6 +23,16 @@ config REMOTEPROC_CDEV It's safe to say N if you don't want to use this interface. +config REMOTEPROC_TEE
- tristate "Remoteproc support by a TEE application"
Tristate? Didn't we agree this would be either compiled in or out, but not as a module?
It was built-in because we needed to build it with the remoteproc core. With the introduction of rproc->ops->release_fw, it is now independent and can be built as a module (OPTEE config is also in tristate).
That said, I can limit it to the boolean configuration if that makes more sense to you.
Thanks, Arnaud
- depends on OPTEE
- help
Support a remote processor with a TEE application. The TrustedExecution Context is responsible for loading the trusted firmwareimage and managing the remote processor's lifecycle.It's safe to say N if you don't want to use remoteproc TEE.config IMX_REMOTEPROC tristate "i.MX remoteproc support" depends on ARCH_MXC diff --git a/drivers/remoteproc/Makefile b/drivers/remoteproc/Makefile index 5ff4e2fee4ab..f77e0abe8349 100644 --- a/drivers/remoteproc/Makefile +++ b/drivers/remoteproc/Makefile @@ -11,6 +11,7 @@ remoteproc-y += remoteproc_sysfs.o remoteproc-y += remoteproc_virtio.o remoteproc-y += remoteproc_elf_loader.o obj-$(CONFIG_REMOTEPROC_CDEV) += remoteproc_cdev.o +obj-$(CONFIG_REMOTEPROC_TEE) += remoteproc_tee.o obj-$(CONFIG_IMX_REMOTEPROC) += imx_rproc.o obj-$(CONFIG_IMX_DSP_REMOTEPROC) += imx_dsp_rproc.o obj-$(CONFIG_INGENIC_VPU_RPROC) += ingenic_rproc.o diff --git a/drivers/remoteproc/remoteproc_tee.c b/drivers/remoteproc/remoteproc_tee.c new file mode 100644 index 000000000000..f258b9304daf --- /dev/null +++ b/drivers/remoteproc/remoteproc_tee.c @@ -0,0 +1,510 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/*
- Copyright (C) STMicroelectronics 2024
- Author: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
- */
+#include <linux/firmware.h> +#include <linux/io.h> +#include <linux/module.h> +#include <linux/remoteproc.h> +#include <linux/remoteproc_tee.h> +#include <linux/slab.h> +#include <linux/tee_drv.h>
+#define MAX_TEE_PARAM_ARRAY_MEMBER 4
+/*
- Authentication of the firmware and load in the remote processor memory
- [in] params[0].value.a: unique 32bit identifier of the remote processor
- [in] params[1].memref: buffer containing the image of the buffer
- */
+#define TA_RPROC_FW_CMD_LOAD_FW 1
+/*
- Start the remote processor
- [in] params[0].value.a: unique 32bit identifier of the remote processor
- */
+#define TA_RPROC_FW_CMD_START_FW 2
+/*
- Stop the remote processor
- [in] params[0].value.a: unique 32bit identifier of the remote processor
- */
+#define TA_RPROC_FW_CMD_STOP_FW 3
+/*
- Return the address of the resource table, or 0 if not found
- No check is done to verify that the address returned is accessible by
- the non secure context. If the resource table is loaded in a protected
- memory the access by the non secure context will lead to a data abort.
- [in] params[0].value.a: unique 32bit identifier of the remote processor
- [out] params[1].value.a: 32bit LSB resource table memory address
- [out] params[1].value.b: 32bit MSB resource table memory address
- [out] params[2].value.a: 32bit LSB resource table memory size
- [out] params[2].value.b: 32bit MSB resource table memory size
- */
+#define TA_RPROC_FW_CMD_GET_RSC_TABLE 4
+/*
- Return the address of the core dump
- [in] params[0].value.a: unique 32bit identifier of the remote processor
- [out] params[1].memref: address of the core dump image if exist,
else return Null- */
+#define TA_RPROC_FW_CMD_GET_COREDUMP 5
+/*
- Release remote processor firmware images and associated resources.
- This command should be used in case an error occurs between the loading of
- the firmware images (A_RPROC_CMD_LOAD_FW) and the starting of the remote
s/A_RPROC_CMD_LOAD_FW/TA_RPROC_CMD_LOAD_FW
- processor (TA_RPROC_CMD_START_FW) or after stopping the remote processor
- to release associated resources (TA_RPROC_CMD_STOP_FW).
- [in] params[0].value.a: Unique 32-bit remote processor identifier
- */
+#define TA_RPROC_CMD_RELEASE_FW 6
+struct rproc_tee_context {
- struct list_head sessions;
- struct tee_context *tee_ctx;
- struct device *dev;
+};
+static struct rproc_tee_context *rproc_tee_ctx;
+static void rproc_tee_prepare_args(struct rproc_tee *trproc, int cmd,
struct tee_ioctl_invoke_arg *arg,struct tee_param *param,unsigned int num_params)+{
- memset(arg, 0, sizeof(*arg));
- memset(param, 0, MAX_TEE_PARAM_ARRAY_MEMBER * sizeof(*param));
- arg->func = cmd;
- arg->session = trproc->session_id;
- arg->num_params = num_params + 1;
- param[0] = (struct tee_param) {
.attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT,.u.value.a = trproc->rproc_id,- };
+}
+void rproc_tee_release_fw(struct rproc *rproc) +{
- struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER];
- struct rproc_tee *trproc = rproc->rproc_tee_itf;
- struct tee_ioctl_invoke_arg arg;
- int ret;
- if (!rproc) {
ret = -EINVAL;goto out;- }
- /*
* If the remote processor state is RPROC_DETACHED, just ignore the* request, as the remote processor is still running.*/- if (rproc->state == RPROC_DETACHED)
return;- if (rproc->state != RPROC_OFFLINE) {
ret = -EBUSY;goto out;- }
- rproc_tee_prepare_args(trproc, TA_RPROC_CMD_RELEASE_FW, &arg, param, 0);
- ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param);
- if (ret < 0 || arg.ret != 0) {
dev_err(rproc_tee_ctx->dev,"TA_RPROC_CMD_RELEASE_FW invoke failed TEE err: %x, ret:%x\n",arg.ret, ret);ret = -EIO;- }
+out:
- if (ret)
/* Unexpected state without solution to come back in a stable state */dev_err(rproc_tee_ctx->dev, "Failed to release TEE remoteproc firmware: %d\n", ret);+} +EXPORT_SYMBOL_GPL(rproc_tee_release_fw);
+int rproc_tee_load_fw(struct rproc *rproc, const struct firmware *fw) +{
- struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER];
- struct rproc_tee *trproc = rproc->rproc_tee_itf;
- struct tee_ioctl_invoke_arg arg;
- struct tee_shm *fw_shm;
- int ret;
- if (!trproc)
return -EINVAL;- fw_shm = tee_shm_register_kernel_buf(rproc_tee_ctx->tee_ctx, (void *)fw->data, fw->size);
- if (IS_ERR(fw_shm))
return PTR_ERR(fw_shm);- rproc_tee_prepare_args(trproc, TA_RPROC_FW_CMD_LOAD_FW, &arg, param, 1);
- /* Provide the address of the firmware image */
- param[1] = (struct tee_param) {
.attr = TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT,.u.memref = {.shm = fw_shm,.size = fw->size,.shm_offs = 0,},- };
- ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param);
- if (ret < 0 || arg.ret != 0) {
dev_err(rproc_tee_ctx->dev,"TA_RPROC_FW_CMD_LOAD_FW invoke failed TEE err: %x, ret:%x\n",arg.ret, ret);if (!ret)ret = -EIO;- }
- tee_shm_free(fw_shm);
- return ret;
+} +EXPORT_SYMBOL_GPL(rproc_tee_load_fw);
+static int rproc_tee_get_loaded_rsc_table(struct rproc *rproc, phys_addr_t *rsc_pa,
size_t *table_sz)+{
- struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER];
- struct rproc_tee *trproc = rproc->rproc_tee_itf;
- struct tee_ioctl_invoke_arg arg;
- int ret;
- if (!trproc)
return -EINVAL;- rproc_tee_prepare_args(trproc, TA_RPROC_FW_CMD_GET_RSC_TABLE, &arg, param, 2);
- param[1].attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_OUTPUT;
- param[2].attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_OUTPUT;
- ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param);
- if (ret < 0 || arg.ret != 0) {
dev_err(rproc_tee_ctx->dev,"TA_RPROC_FW_CMD_GET_RSC_TABLE invoke failed TEE err: %x, ret:%x\n",arg.ret, ret);return -EIO;- }
- *table_sz = param[2].u.value.a;
- if (*table_sz)
*rsc_pa = param[1].u.value.a;- else
*rsc_pa = 0;- return 0;
+}
+int rproc_tee_parse_fw(struct rproc *rproc, const struct firmware *fw) +{
- phys_addr_t rsc_table;
- void __iomem *rsc_va;
- size_t table_sz;
- int ret;
- if (!rproc)
return -EINVAL;- ret = rproc_tee_load_fw(rproc, fw);
- if (ret)
return ret;- ret = rproc_tee_get_loaded_rsc_table(rproc, &rsc_table, &table_sz);
- if (ret)
goto release_fw;- /*
* We assume here that the memory mapping is the same between the TEE and Linux kernel* contexts. Else a new TEE remoteproc service could be needed to get a copy of the* resource table*/- rsc_va = ioremap_wc(rsc_table, table_sz);
- if (IS_ERR_OR_NULL(rsc_va)) {
dev_err(rproc_tee_ctx->dev, "Unable to map memory region: %pa+%zx\n",&rsc_table, table_sz);ret = -ENOMEM;goto release_fw;- }
- /*
* Create a copy of the resource table to have the same behavior as the ELF loader.* This cached table will be used by the remoteproc core after the remoteproc stops* to free resources and for crash recovery to reapply the settings.* The cached table will be freed by the remoteproc core.*/- rproc->cached_table = kmemdup((__force void *)rsc_va, table_sz, GFP_KERNEL);
- iounmap(rsc_va);
- if (!rproc->cached_table) {
ret = -ENOMEM;goto release_fw;- }
- rproc->table_ptr = rproc->cached_table;
- rproc->table_sz = table_sz;
- return 0;
+release_fw:
- rproc_tee_release_fw(rproc);
- return ret;
+} +EXPORT_SYMBOL_GPL(rproc_tee_parse_fw);
+struct resource_table *rproc_tee_find_loaded_rsc_table(struct rproc *rproc,
const struct firmware *fw)+{
- phys_addr_t rsc_table;
- size_t table_sz;
- int ret;
- ret = rproc_tee_get_loaded_rsc_table(rproc, &rsc_table, &table_sz);
- if (ret)
return NULL;- rproc->table_sz = table_sz;
- if (!table_sz)
return NULL;- /*
* At this step the memory area that contains the resource table should have been registered* by the remote proc platform driver and allocated by rproc_alloc_registered_carveouts().*/- return (struct resource_table *)rproc_pa_to_va(rproc, rsc_table, table_sz, NULL);
+} +EXPORT_SYMBOL_GPL(rproc_tee_find_loaded_rsc_table);
+int rproc_tee_start(struct rproc *rproc) +{
- struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER];
- struct rproc_tee *trproc = rproc->rproc_tee_itf;
- struct tee_ioctl_invoke_arg arg;
- int ret = 0;
- if (!trproc)
return -EINVAL;- rproc_tee_prepare_args(trproc, TA_RPROC_FW_CMD_START_FW, &arg, param, 0);
- ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param);
- if (ret < 0 || arg.ret != 0) {
dev_err(rproc_tee_ctx->dev,"TA_RPROC_FW_CMD_START_FW invoke failed TEE err: %x, ret:%x\n",arg.ret, ret);if (!ret)return -EIO;- }
- return 0;
+} +EXPORT_SYMBOL_GPL(rproc_tee_start);
+int rproc_tee_stop(struct rproc *rproc) +{
- struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER];
- struct rproc_tee *trproc = rproc->rproc_tee_itf;
- struct tee_ioctl_invoke_arg arg;
- int ret;
- if (!trproc)
return -EINVAL;- rproc_tee_prepare_args(trproc, TA_RPROC_FW_CMD_STOP_FW, &arg, param, 0);
- ret = tee_client_invoke_func(rproc_tee_ctx->tee_ctx, &arg, param);
- if (ret < 0 || arg.ret != 0) {
dev_err(rproc_tee_ctx->dev,"TA_RPROC_FW_CMD_STOP_FW invoke failed TEE err: %x, ret:%x\n",arg.ret, ret);if (!ret)ret = -EIO;- }
- return ret;
+} +EXPORT_SYMBOL_GPL(rproc_tee_stop);
+static const struct tee_client_device_id rproc_tee_id_table[] = {
- {UUID_INIT(0x80a4c275, 0x0a47, 0x4905, 0x82, 0x85, 0x14, 0x86, 0xa9, 0x77, 0x1a, 0x08)},
- {}
+};
+int rproc_tee_register(struct device *dev, struct rproc *rproc, unsigned int rproc_id) +{
- struct tee_param param[MAX_TEE_PARAM_ARRAY_MEMBER];
- struct tee_ioctl_open_session_arg sess_arg;
- struct tee_client_device *tee_device;
- struct rproc_tee *trproc;
- int ret;
- /*
* Test if the device has been probed by the TEE bus. In case of failure, we ignore the* reason. The bus could be not yet probed or the service not available in the secure* firmware.The assumption in such a case is that the TEE remoteproc is not probed.*/- if (!rproc_tee_ctx)
return -EPROBE_DEFER;- /* Prevent rproc tee module from being removed */
- if (!try_module_get(THIS_MODULE)) {
dev_err(rproc_tee_ctx->dev, "can't get owner\n");return -ENODEV;- }
- trproc = devm_kzalloc(dev, sizeof(*trproc), GFP_KERNEL);
- if (!trproc) {
ret = -ENOMEM;goto module_put;- }
- tee_device = to_tee_client_device(rproc_tee_ctx->dev);
- memset(&sess_arg, 0, sizeof(sess_arg));
- memcpy(sess_arg.uuid, tee_device->id.uuid.b, TEE_IOCTL_UUID_LEN);
- sess_arg.clnt_login = TEE_IOCTL_LOGIN_REE_KERNEL;
- sess_arg.num_params = 1;
- param[0] = (struct tee_param) {
.attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT,.u.value.a = rproc_id,- };
- ret = tee_client_open_session(rproc_tee_ctx->tee_ctx, &sess_arg, param);
- if (ret < 0 || sess_arg.ret != 0) {
dev_err(dev, "tee_client_open_session failed, err: %x\n", sess_arg.ret);ret = -EINVAL;goto module_put;- }
- trproc->parent = dev;
- trproc->rproc_id = rproc_id;
- trproc->session_id = sess_arg.session;
- trproc->rproc = rproc;
- rproc->rproc_tee_itf = trproc;
- list_add_tail(&trproc->node, &rproc_tee_ctx->sessions);
- return 0;
+module_put:
- module_put(THIS_MODULE);
- return ret;
+} +EXPORT_SYMBOL_GPL(rproc_tee_register);
+int rproc_tee_unregister(struct rproc *rproc) +{
- struct rproc_tee *trproc = rproc->rproc_tee_itf;
- int ret;
- if (!rproc->rproc_tee_itf)
return -ENODEV;- ret = tee_client_close_session(rproc_tee_ctx->tee_ctx, trproc->session_id);
- if (ret < 0)
dev_err(trproc->parent, "tee_client_close_session failed, err: %x\n", ret);- list_del(&trproc->node);
- rproc->rproc_tee_itf = NULL;
- module_put(THIS_MODULE);
- return ret;
+} +EXPORT_SYMBOL_GPL(rproc_tee_unregister);
+static int rproc_tee_ctx_match(struct tee_ioctl_version_data *ver, const void *data) +{
- /* Today we support only the OP-TEE, could be extend to other tees */
- return (ver->impl_id == TEE_IMPL_ID_OPTEE);
+}
+static int rproc_tee_probe(struct device *dev) +{
- struct tee_context *tee_ctx;
- int ret;
- /* Open context with TEE driver */
- tee_ctx = tee_client_open_context(NULL, rproc_tee_ctx_match, NULL, NULL);
- if (IS_ERR(tee_ctx))
return PTR_ERR(tee_ctx);- rproc_tee_ctx = devm_kzalloc(dev, sizeof(*rproc_tee_ctx), GFP_KERNEL);
- if (!rproc_tee_ctx) {
ret = -ENOMEM;goto err;- }
- rproc_tee_ctx->dev = dev;
- rproc_tee_ctx->tee_ctx = tee_ctx;
- INIT_LIST_HEAD(&rproc_tee_ctx->sessions);
- return 0;
+err:
- tee_client_close_context(tee_ctx);
- return ret;
+}
+static int rproc_tee_remove(struct device *dev) +{
- struct rproc_tee *entry, *tmp;
- list_for_each_entry_safe(entry, tmp, &rproc_tee_ctx->sessions, node) {
tee_client_close_session(rproc_tee_ctx->tee_ctx, entry->session_id);list_del(&entry->node);kfree(entry);- }
- tee_client_close_context(rproc_tee_ctx->tee_ctx);
- return 0;
+}
+MODULE_DEVICE_TABLE(tee, rproc_tee_id_table);
+static struct tee_client_driver rproc_tee_fw_driver = {
- .id_table = rproc_tee_id_table,
- .driver = {
.name = KBUILD_MODNAME,.bus = &tee_bus_type,.probe = rproc_tee_probe,.remove = rproc_tee_remove,- },
+};
+static int __init rproc_tee_fw_mod_init(void) +{
- return driver_register(&rproc_tee_fw_driver.driver);
+}
+static void __exit rproc_tee_fw_mod_exit(void) +{
- driver_unregister(&rproc_tee_fw_driver.driver);
+}
+module_init(rproc_tee_fw_mod_init); +module_exit(rproc_tee_fw_mod_exit);
+MODULE_DESCRIPTION(" remote processor TEE module"); +MODULE_LICENSE("GPL"); diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h index 8fd0d7f63c8e..2e0ddcb2d792 100644 --- a/include/linux/remoteproc.h +++ b/include/linux/remoteproc.h @@ -503,6 +503,8 @@ enum rproc_features { RPROC_MAX_FEATURES, }; +struct rproc_tee;
/**
- struct rproc - represents a physical remote processor device
- @node: list node of this rproc object
@@ -545,6 +547,7 @@ enum rproc_features {
- @cdev: character device of the rproc
- @cdev_put_on_release: flag to indicate if remoteproc should be shutdown on @char_dev release
- @features: indicate remoteproc features
*/
- @rproc_tee_itf: pointer to the remoteproc tee context
struct rproc { struct list_head node; @@ -586,6 +589,7 @@ struct rproc { struct cdev cdev; bool cdev_put_on_release; DECLARE_BITMAP(features, RPROC_MAX_FEATURES);
- struct rproc_tee *rproc_tee_itf;
}; /** diff --git a/include/linux/remoteproc_tee.h b/include/linux/remoteproc_tee.h new file mode 100644 index 000000000000..9b498a8eff4d --- /dev/null +++ b/include/linux/remoteproc_tee.h @@ -0,0 +1,105 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ +/*
- Copyright(c) 2024 STMicroelectronics
- */
+#ifndef REMOTEPROC_TEE_H +#define REMOTEPROC_TEE_H
+#include <linux/tee_drv.h> +#include <linux/firmware.h> +#include <linux/remoteproc.h>
+struct rproc;
+/**
- struct rproc_tee - TEE remoteproc structure
- @node: Reference in list
- @rproc: Remoteproc reference
- @parent: Parent device
- @rproc_id: Identifier of the target firmware
- @session_id: TEE session identifier
- */
+struct rproc_tee {
- struct list_head node;
- struct rproc *rproc;
- struct device *parent;
- u32 rproc_id;
- u32 session_id;
+};
+#if IS_REACHABLE(CONFIG_REMOTEPROC_TEE)
+int rproc_tee_register(struct device *dev, struct rproc *rproc, unsigned int rproc_id); +int rproc_tee_unregister(struct rproc *rproc); +int rproc_tee_parse_fw(struct rproc *rproc, const struct firmware *fw); +int rproc_tee_load_fw(struct rproc *rproc, const struct firmware *fw); +void rproc_tee_release_fw(struct rproc *rproc); +struct resource_table *rproc_tee_find_loaded_rsc_table(struct rproc *rproc,
const struct firmware *fw);+int rproc_tee_start(struct rproc *rproc); +int rproc_tee_stop(struct rproc *rproc);
+#else
+static inline int rproc_tee_register(struct device *dev, struct rproc *rproc, unsigned int rproc_id) +{
- return -ENODEV;
+}
+static inline int rproc_tee_parse_fw(struct rproc *rproc, const struct firmware *fw) +{
- /* This shouldn't be possible */
- WARN_ON(1);
- return 0;
+}
+static inline int rproc_tee_unregister(struct rproc *rproc) +{
- /* This shouldn't be possible */
- WARN_ON(1);
- return 0;
+}
+static inline int rproc_tee_load_fw(struct rproc *rproc, const struct firmware *fw) +{
- /* This shouldn't be possible */
- WARN_ON(1);
- return 0;
+}
+static inline int rproc_tee_start(struct rproc *rproc) +{
- /* This shouldn't be possible */
- WARN_ON(1);
- return 0;
+}
+static inline int rproc_tee_stop(struct rproc *rproc) +{
- /* This shouldn't be possible */
- WARN_ON(1);
- return 0;
+}
+static inline void rproc_tee_release_fw(struct rproc *rproc) +{
- /* This shouldn't be possible */
- WARN_ON(1);
+}
+static inline struct resource_table * +rproc_tee_find_loaded_rsc_table(struct rproc *rproc, const struct firmware *fw) +{
- /* This shouldn't be possible */
- WARN_ON(1);
- return NULL;
+} +#endif /* CONFIG_REMOTEPROC_TEE */
+#endif /* REMOTEPROC_TEE_H */
2.25.1
This patch centralizing the cleanup of the resource table into a new helper function rproc_release_fw().
More than just factorizing the code into a common function, it is the first step to integrate the release of the firmware image loaded by the OP-TEE remoteproc framework.
Suggested-by: Mathieu Poirier mathieu.poirier@linaro.org Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com --- drivers/remoteproc/remoteproc_core.c | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-)
diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c index ace11ea17097..7694817f25d4 100644 --- a/drivers/remoteproc/remoteproc_core.c +++ b/drivers/remoteproc/remoteproc_core.c @@ -1256,6 +1256,13 @@ static int rproc_alloc_registered_carveouts(struct rproc *rproc) return 0; }
+static void rproc_release_fw(struct rproc *rproc) +{ + /* Free the copy of the resource table */ + kfree(rproc->cached_table); + rproc->cached_table = NULL; + rproc->table_ptr = NULL; +}
/** * rproc_resource_cleanup() - clean up and free all acquired resources @@ -1485,9 +1492,7 @@ static int rproc_fw_boot(struct rproc *rproc, const struct firmware *fw)
clean_up_resources: rproc_resource_cleanup(rproc); - kfree(rproc->cached_table); - rproc->cached_table = NULL; - rproc->table_ptr = NULL; + rproc_release_fw(rproc); unprepare_rproc: /* release HW resources if needed */ rproc_unprepare_device(rproc); @@ -2067,10 +2072,7 @@ int rproc_shutdown(struct rproc *rproc)
rproc_disable_iommu(rproc);
- /* Free the copy of the resource table */ - kfree(rproc->cached_table); - rproc->cached_table = NULL; - rproc->table_ptr = NULL; + rproc_release_fw(rproc); out: mutex_unlock(&rproc->lock); return ret; @@ -2133,10 +2135,7 @@ int rproc_detach(struct rproc *rproc)
rproc_disable_iommu(rproc);
- /* Free the copy of the resource table */ - kfree(rproc->cached_table); - rproc->cached_table = NULL; - rproc->table_ptr = NULL; + rproc_release_fw(rproc); out: mutex_unlock(&rproc->lock); return ret;
This patch updates the rproc_ops struct to include an optional release_fw function.
The release_fw ops is responsible for releasing the remote processor firmware image. The ops is called in the following cases:
- An error occurs in rproc_start() between the loading of the segments and the start of the remote processor. - after stopping the remote processor.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com --- Updates from version V11: - fix typo in @release_fw comment --- drivers/remoteproc/remoteproc_core.c | 5 +++++ include/linux/remoteproc.h | 3 +++ 2 files changed, 8 insertions(+)
diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c index 7694817f25d4..46863e1ca307 100644 --- a/drivers/remoteproc/remoteproc_core.c +++ b/drivers/remoteproc/remoteproc_core.c @@ -1258,6 +1258,9 @@ static int rproc_alloc_registered_carveouts(struct rproc *rproc)
static void rproc_release_fw(struct rproc *rproc) { + if (rproc->ops->release_fw) + rproc->ops->release_fw(rproc); + /* Free the copy of the resource table */ kfree(rproc->cached_table); rproc->cached_table = NULL; @@ -1377,6 +1380,8 @@ static int rproc_start(struct rproc *rproc, const struct firmware *fw) unprepare_subdevices: rproc_unprepare_subdevices(rproc); reset_table_ptr: + if (rproc->ops->release_fw) + rproc->ops->release_fw(rproc); rproc->table_ptr = rproc->cached_table;
return ret; diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h index 2e0ddcb2d792..08e0187a84d9 100644 --- a/include/linux/remoteproc.h +++ b/include/linux/remoteproc.h @@ -381,6 +381,8 @@ enum rsc_handling_status { * @panic: optional callback to react to system panic, core will delay * panic at least the returned number of milliseconds * @coredump: collect firmware dump after the subsystem is shutdown + * @release_fw: optional function to release the firmware image from ROM memories. + * This function is called after stopping the remote processor or in case of an error */ struct rproc_ops { int (*prepare)(struct rproc *rproc); @@ -403,6 +405,7 @@ struct rproc_ops { u64 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw); unsigned long (*panic)(struct rproc *rproc); void (*coredump)(struct rproc *rproc); + void (*release_fw)(struct rproc *rproc); };
/**
On Mon, Nov 04, 2024 at 02:35:12PM +0100, Arnaud Pouliquen wrote:
This patch updates the rproc_ops struct to include an optional release_fw function.
The release_fw ops is responsible for releasing the remote processor firmware image. The ops is called in the following cases:
- An error occurs in rproc_start() between the loading of the segments and the start of the remote processor.
- after stopping the remote processor.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
Updates from version V11:
- fix typo in @release_fw comment
drivers/remoteproc/remoteproc_core.c | 5 +++++ include/linux/remoteproc.h | 3 +++ 2 files changed, 8 insertions(+)
diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c index 7694817f25d4..46863e1ca307 100644 --- a/drivers/remoteproc/remoteproc_core.c +++ b/drivers/remoteproc/remoteproc_core.c @@ -1258,6 +1258,9 @@ static int rproc_alloc_registered_carveouts(struct rproc *rproc) static void rproc_release_fw(struct rproc *rproc) {
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);- /* Free the copy of the resource table */ kfree(rproc->cached_table); rproc->cached_table = NULL;
@@ -1377,6 +1380,8 @@ static int rproc_start(struct rproc *rproc, const struct firmware *fw) unprepare_subdevices: rproc_unprepare_subdevices(rproc); reset_table_ptr:
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);
I always thought that looked hackish and brittle. I am trying to find a better solution.
Mathieu
rproc->table_ptr = rproc->cached_table; return ret; diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h index 2e0ddcb2d792..08e0187a84d9 100644 --- a/include/linux/remoteproc.h +++ b/include/linux/remoteproc.h @@ -381,6 +381,8 @@ enum rsc_handling_status {
- @panic: optional callback to react to system panic, core will delay
panic at least the returned number of milliseconds- @coredump: collect firmware dump after the subsystem is shutdown
- @release_fw: optional function to release the firmware image from ROM memories.
*/
This function is called after stopping the remote processor or in case of an errorstruct rproc_ops { int (*prepare)(struct rproc *rproc); @@ -403,6 +405,7 @@ struct rproc_ops { u64 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw); unsigned long (*panic)(struct rproc *rproc); void (*coredump)(struct rproc *rproc);
- void (*release_fw)(struct rproc *rproc);
}; /** -- 2.25.1
On Mon, Nov 04, 2024 at 02:35:12PM +0100, Arnaud Pouliquen wrote:
This patch updates the rproc_ops struct to include an optional release_fw function.
The release_fw ops is responsible for releasing the remote processor firmware image. The ops is called in the following cases:
- An error occurs in rproc_start() between the loading of the segments and the start of the remote processor.
- after stopping the remote processor.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
Updates from version V11:
- fix typo in @release_fw comment
drivers/remoteproc/remoteproc_core.c | 5 +++++ include/linux/remoteproc.h | 3 +++ 2 files changed, 8 insertions(+)
diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c index 7694817f25d4..46863e1ca307 100644 --- a/drivers/remoteproc/remoteproc_core.c +++ b/drivers/remoteproc/remoteproc_core.c @@ -1258,6 +1258,9 @@ static int rproc_alloc_registered_carveouts(struct rproc *rproc) static void rproc_release_fw(struct rproc *rproc) {
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);- /* Free the copy of the resource table */ kfree(rproc->cached_table); rproc->cached_table = NULL;
@@ -1377,6 +1380,8 @@ static int rproc_start(struct rproc *rproc, const struct firmware *fw) unprepare_subdevices: rproc_unprepare_subdevices(rproc); reset_table_ptr:
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);
I suggest the following:
1) Create two new functions, i.e rproc_load_fw() and rproc_release_fw(). The only thing those would do is call rproc->ops->load_fw() and rproc->ops->release_fw(), if they are present. When a TEE interface is available, ->load_fw() and ->release_fw() become rproc_tee_load_fw() and rproc_tee_release_fw().
2) Call rproc_load_fw() in rproc_boot(), just before rproc_fw_boot(). If the call to rproc_fw_boot() fails, call rproc_release_fw().
3) The same logic applies to rproc_boot_recovery(), i.e call rproc_load_fw() before rproc_start() and call rproc_release_fw() if rproc_start() fails.
4) Take rproc_tee_load_fw() out of rproc_tee_parse_fw(). It will now be called in rproc_load_fw().
5) As stated above function rproc_release_fw() now calls rproc_tee_release_fw(). The former is already called in rproc_shutdown() so we are good in that front.
With the above the cached_table management within the core remains the same and we can get rid of patch 3.7.
Thanks, Mathieu
return ret; diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h index 2e0ddcb2d792..08e0187a84d9 100644 --- a/include/linux/remoteproc.h +++ b/include/linux/remoteproc.h @@ -381,6 +381,8 @@ enum rsc_handling_status {
- @panic: optional callback to react to system panic, core will delay
panic at least the returned number of milliseconds- @coredump: collect firmware dump after the subsystem is shutdown
- @release_fw: optional function to release the firmware image from ROM memories.
*/
This function is called after stopping the remote processor or in case of an errorstruct rproc_ops { int (*prepare)(struct rproc *rproc); @@ -403,6 +405,7 @@ struct rproc_ops { u64 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw); unsigned long (*panic)(struct rproc *rproc); void (*coredump)(struct rproc *rproc);
- void (*release_fw)(struct rproc *rproc);
}; /** -- 2.25.1
hello Mathieu,
On 11/18/24 18:52, Mathieu Poirier wrote:
On Mon, Nov 04, 2024 at 02:35:12PM +0100, Arnaud Pouliquen wrote:
This patch updates the rproc_ops struct to include an optional release_fw function.
The release_fw ops is responsible for releasing the remote processor firmware image. The ops is called in the following cases:
- An error occurs in rproc_start() between the loading of the segments and the start of the remote processor.
- after stopping the remote processor.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
Updates from version V11:
- fix typo in @release_fw comment
drivers/remoteproc/remoteproc_core.c | 5 +++++ include/linux/remoteproc.h | 3 +++ 2 files changed, 8 insertions(+)
diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c index 7694817f25d4..46863e1ca307 100644 --- a/drivers/remoteproc/remoteproc_core.c +++ b/drivers/remoteproc/remoteproc_core.c @@ -1258,6 +1258,9 @@ static int rproc_alloc_registered_carveouts(struct rproc *rproc) static void rproc_release_fw(struct rproc *rproc) {
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);- /* Free the copy of the resource table */ kfree(rproc->cached_table); rproc->cached_table = NULL;
@@ -1377,6 +1380,8 @@ static int rproc_start(struct rproc *rproc, const struct firmware *fw) unprepare_subdevices: rproc_unprepare_subdevices(rproc); reset_table_ptr:
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);I suggest the following:
- Create two new functions, i.e rproc_load_fw() and rproc_release_fw(). The
only thing those would do is call rproc->ops->load_fw() and rproc->ops->release_fw(), if they are present. When a TEE interface is available, ->load_fw() and ->release_fw() become rproc_tee_load_fw() and rproc_tee_release_fw().
- Call rproc_load_fw() in rproc_boot(), just before rproc_fw_boot(). If the
call to rproc_fw_boot() fails, call rproc_release_fw().
- The same logic applies to rproc_boot_recovery(), i.e call rproc_load_fw()
before rproc_start() and call rproc_release_fw() if rproc_start() fails.
- Take rproc_tee_load_fw() out of rproc_tee_parse_fw(). It will now be called
in rproc_load_fw().
- As stated above function rproc_release_fw() now calls rproc_tee_release_fw().
The former is already called in rproc_shutdown() so we are good in that front.
With the above the cached_table management within the core remains the same and we can get rid of patch 3.7.
Thanks for your suggestion! I will try this in next revision.
Regards, Arnaud
Thanks, Mathieu
return ret; diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h index 2e0ddcb2d792..08e0187a84d9 100644 --- a/include/linux/remoteproc.h +++ b/include/linux/remoteproc.h @@ -381,6 +381,8 @@ enum rsc_handling_status {
- @panic: optional callback to react to system panic, core will delay
panic at least the returned number of milliseconds- @coredump: collect firmware dump after the subsystem is shutdown
- @release_fw: optional function to release the firmware image from ROM memories.
*/
This function is called after stopping the remote processor or in case of an errorstruct rproc_ops { int (*prepare)(struct rproc *rproc); @@ -403,6 +405,7 @@ struct rproc_ops { u64 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw); unsigned long (*panic)(struct rproc *rproc); void (*coredump)(struct rproc *rproc);
- void (*release_fw)(struct rproc *rproc);
}; /** -- 2.25.1
Hello Mathieu,
On 11/18/24 18:52, Mathieu Poirier wrote:
On Mon, Nov 04, 2024 at 02:35:12PM +0100, Arnaud Pouliquen wrote:
This patch updates the rproc_ops struct to include an optional release_fw function.
The release_fw ops is responsible for releasing the remote processor firmware image. The ops is called in the following cases:
- An error occurs in rproc_start() between the loading of the segments and the start of the remote processor.
- after stopping the remote processor.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
Updates from version V11:
- fix typo in @release_fw comment
drivers/remoteproc/remoteproc_core.c | 5 +++++ include/linux/remoteproc.h | 3 +++ 2 files changed, 8 insertions(+)
diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c index 7694817f25d4..46863e1ca307 100644 --- a/drivers/remoteproc/remoteproc_core.c +++ b/drivers/remoteproc/remoteproc_core.c @@ -1258,6 +1258,9 @@ static int rproc_alloc_registered_carveouts(struct rproc *rproc) static void rproc_release_fw(struct rproc *rproc) {
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);- /* Free the copy of the resource table */ kfree(rproc->cached_table); rproc->cached_table = NULL;
@@ -1377,6 +1380,8 @@ static int rproc_start(struct rproc *rproc, const struct firmware *fw) unprepare_subdevices: rproc_unprepare_subdevices(rproc); reset_table_ptr:
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);I suggest the following:
- Create two new functions, i.e rproc_load_fw() and rproc_release_fw(). The
only thing those would do is call rproc->ops->load_fw() and rproc->ops->release_fw(), if they are present. When a TEE interface is available, ->load_fw() and ->release_fw() become rproc_tee_load_fw() and rproc_tee_release_fw().
I'm wondering if it should be ->preload_fw() instead of ->load_fw() ops, as the ->load() op already exists.
- Call rproc_load_fw() in rproc_boot(), just before rproc_fw_boot(). If the
call to rproc_fw_boot() fails, call rproc_release_fw().
- The same logic applies to rproc_boot_recovery(), i.e call rproc_load_fw()
before rproc_start() and call rproc_release_fw() if rproc_start() fails.
I implemented this and I'm currently testing it. Thise second part requires a few adjustments to work. The ->load() ops needs to becomes optional to not be called if the "->preload_fw()" is used.
For that, I propose to return 0 in rproc_load_segments if rproc->ops->load is NULL and compensate by checking that at least "->preload_fw()" or ->load() is non-null in rproc_alloc_ops.
Thanks, Arnaud
- Take rproc_tee_load_fw() out of rproc_tee_parse_fw(). It will now be called
in rproc_load_fw().
- As stated above function rproc_release_fw() now calls rproc_tee_release_fw().
The former is already called in rproc_shutdown() so we are good in that front.
With the above the cached_table management within the core remains the same and we can get rid of patch 3.7.
Thanks, Mathieu
return ret; diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h index 2e0ddcb2d792..08e0187a84d9 100644 --- a/include/linux/remoteproc.h +++ b/include/linux/remoteproc.h @@ -381,6 +381,8 @@ enum rsc_handling_status {
- @panic: optional callback to react to system panic, core will delay
panic at least the returned number of milliseconds- @coredump: collect firmware dump after the subsystem is shutdown
- @release_fw: optional function to release the firmware image from ROM memories.
*/
This function is called after stopping the remote processor or in case of an errorstruct rproc_ops { int (*prepare)(struct rproc *rproc); @@ -403,6 +405,7 @@ struct rproc_ops { u64 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw); unsigned long (*panic)(struct rproc *rproc); void (*coredump)(struct rproc *rproc);
- void (*release_fw)(struct rproc *rproc);
}; /** -- 2.25.1
On Tue, 19 Nov 2024 at 11:14, Arnaud POULIQUEN arnaud.pouliquen@foss.st.com wrote:
Hello Mathieu,
On 11/18/24 18:52, Mathieu Poirier wrote:
On Mon, Nov 04, 2024 at 02:35:12PM +0100, Arnaud Pouliquen wrote:
This patch updates the rproc_ops struct to include an optional release_fw function.
The release_fw ops is responsible for releasing the remote processor firmware image. The ops is called in the following cases:
- An error occurs in rproc_start() between the loading of the segments and the start of the remote processor.
- after stopping the remote processor.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
Updates from version V11:
- fix typo in @release_fw comment
drivers/remoteproc/remoteproc_core.c | 5 +++++ include/linux/remoteproc.h | 3 +++ 2 files changed, 8 insertions(+)
diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c index 7694817f25d4..46863e1ca307 100644 --- a/drivers/remoteproc/remoteproc_core.c +++ b/drivers/remoteproc/remoteproc_core.c @@ -1258,6 +1258,9 @@ static int rproc_alloc_registered_carveouts(struct rproc *rproc)
static void rproc_release_fw(struct rproc *rproc) {
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);- /* Free the copy of the resource table */ kfree(rproc->cached_table); rproc->cached_table = NULL;
@@ -1377,6 +1380,8 @@ static int rproc_start(struct rproc *rproc, const struct firmware *fw) unprepare_subdevices: rproc_unprepare_subdevices(rproc); reset_table_ptr:
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);I suggest the following:
- Create two new functions, i.e rproc_load_fw() and rproc_release_fw(). The
only thing those would do is call rproc->ops->load_fw() and rproc->ops->release_fw(), if they are present. When a TEE interface is available, ->load_fw() and ->release_fw() become rproc_tee_load_fw() and rproc_tee_release_fw().
I'm wondering if it should be ->preload_fw() instead of ->load_fw() ops, as the ->load() op already exists.
I agree that ->load() and ->load_fw() will lead to confusion. I would support ->preload_fw() but there is no obvious antonyme.
Since we already have rproc_ops::prepare() and rproc_prepare_device() I suggest rproc_ops::prepare_fw() and rproc_prepare_fw(). The corollary would be rproc_ops::unprepare_fw() and rproc_unprepare_fm(). That said, I'm open to other ideas should you be interested in finding other alternatives.
- Call rproc_load_fw() in rproc_boot(), just before rproc_fw_boot(). If the
call to rproc_fw_boot() fails, call rproc_release_fw().
- The same logic applies to rproc_boot_recovery(), i.e call rproc_load_fw()
before rproc_start() and call rproc_release_fw() if rproc_start() fails.
I implemented this and I'm currently testing it. Thise second part requires a few adjustments to work. The ->load() ops needs to becomes optional to not be called if the "->preload_fw()" is used.
For that, I propose to return 0 in rproc_load_segments if rproc->ops->load is NULL and compensate by checking that at least "->preload_fw()" or ->load() is non-null in rproc_alloc_ops.
I agree.
Thanks, Arnaud
- Take rproc_tee_load_fw() out of rproc_tee_parse_fw(). It will now be called
in rproc_load_fw().
- As stated above function rproc_release_fw() now calls rproc_tee_release_fw().
The former is already called in rproc_shutdown() so we are good in that front.
With the above the cached_table management within the core remains the same and we can get rid of patch 3.7.
Thanks, Mathieu
return ret;diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h index 2e0ddcb2d792..08e0187a84d9 100644 --- a/include/linux/remoteproc.h +++ b/include/linux/remoteproc.h @@ -381,6 +381,8 @@ enum rsc_handling_status {
- @panic: optional callback to react to system panic, core will delay
panic at least the returned number of milliseconds- @coredump: collect firmware dump after the subsystem is shutdown
- @release_fw: optional function to release the firmware image from ROM memories.
*/
This function is called after stopping the remote processor or in case of an errorstruct rproc_ops { int (*prepare)(struct rproc *rproc); @@ -403,6 +405,7 @@ struct rproc_ops { u64 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw); unsigned long (*panic)(struct rproc *rproc); void (*coredump)(struct rproc *rproc);
- void (*release_fw)(struct rproc *rproc);
};
/**
2.25.1
On Tue, 19 Nov 2024 at 13:38, Mathieu Poirier mathieu.poirier@linaro.org wrote:
On Tue, 19 Nov 2024 at 11:14, Arnaud POULIQUEN arnaud.pouliquen@foss.st.com wrote:
Hello Mathieu,
On 11/18/24 18:52, Mathieu Poirier wrote:
On Mon, Nov 04, 2024 at 02:35:12PM +0100, Arnaud Pouliquen wrote:
This patch updates the rproc_ops struct to include an optional release_fw function.
The release_fw ops is responsible for releasing the remote processor firmware image. The ops is called in the following cases:
- An error occurs in rproc_start() between the loading of the segments and the start of the remote processor.
- after stopping the remote processor.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
Updates from version V11:
- fix typo in @release_fw comment
drivers/remoteproc/remoteproc_core.c | 5 +++++ include/linux/remoteproc.h | 3 +++ 2 files changed, 8 insertions(+)
diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c index 7694817f25d4..46863e1ca307 100644 --- a/drivers/remoteproc/remoteproc_core.c +++ b/drivers/remoteproc/remoteproc_core.c @@ -1258,6 +1258,9 @@ static int rproc_alloc_registered_carveouts(struct rproc *rproc)
static void rproc_release_fw(struct rproc *rproc) {
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);- /* Free the copy of the resource table */ kfree(rproc->cached_table); rproc->cached_table = NULL;
@@ -1377,6 +1380,8 @@ static int rproc_start(struct rproc *rproc, const struct firmware *fw) unprepare_subdevices: rproc_unprepare_subdevices(rproc); reset_table_ptr:
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);I suggest the following:
- Create two new functions, i.e rproc_load_fw() and rproc_release_fw(). The
only thing those would do is call rproc->ops->load_fw() and rproc->ops->release_fw(), if they are present. When a TEE interface is available, ->load_fw() and ->release_fw() become rproc_tee_load_fw() and rproc_tee_release_fw().
I'm wondering if it should be ->preload_fw() instead of ->load_fw() ops, as the ->load() op already exists.
I agree that ->load() and ->load_fw() will lead to confusion. I would support ->preload_fw() but there is no obvious antonyme.
Since we already have rproc_ops::prepare() and rproc_prepare_device() I suggest rproc_ops::prepare_fw() and rproc_prepare_fw(). The corollary would be rproc_ops::unprepare_fw() and rproc_unprepare_fm(). That said, I'm open to other ideas should you be interested in finding other alternatives.
Actually... A better approach might to rename rproc::load to rproc::load_segments. That way we can use rproc::load_fw() and rproc_load_fw() without confusion.
- Call rproc_load_fw() in rproc_boot(), just before rproc_fw_boot(). If the
call to rproc_fw_boot() fails, call rproc_release_fw().
- The same logic applies to rproc_boot_recovery(), i.e call rproc_load_fw()
before rproc_start() and call rproc_release_fw() if rproc_start() fails.
I implemented this and I'm currently testing it. Thise second part requires a few adjustments to work. The ->load() ops needs to becomes optional to not be called if the "->preload_fw()" is used.
For that, I propose to return 0 in rproc_load_segments if rproc->ops->load is NULL and compensate by checking that at least "->preload_fw()" or ->load() is non-null in rproc_alloc_ops.
I agree.
Thanks, Arnaud
- Take rproc_tee_load_fw() out of rproc_tee_parse_fw(). It will now be called
in rproc_load_fw().
- As stated above function rproc_release_fw() now calls rproc_tee_release_fw().
The former is already called in rproc_shutdown() so we are good in that front.
With the above the cached_table management within the core remains the same and we can get rid of patch 3.7.
Thanks, Mathieu
return ret;diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h index 2e0ddcb2d792..08e0187a84d9 100644 --- a/include/linux/remoteproc.h +++ b/include/linux/remoteproc.h @@ -381,6 +381,8 @@ enum rsc_handling_status {
- @panic: optional callback to react to system panic, core will delay
panic at least the returned number of milliseconds- @coredump: collect firmware dump after the subsystem is shutdown
- @release_fw: optional function to release the firmware image from ROM memories.
*/
This function is called after stopping the remote processor or in case of an errorstruct rproc_ops { int (*prepare)(struct rproc *rproc); @@ -403,6 +405,7 @@ struct rproc_ops { u64 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw); unsigned long (*panic)(struct rproc *rproc); void (*coredump)(struct rproc *rproc);
- void (*release_fw)(struct rproc *rproc);
};
/**
2.25.1
On 11/20/24 17:04, Mathieu Poirier wrote:
On Tue, 19 Nov 2024 at 13:38, Mathieu Poirier mathieu.poirier@linaro.org wrote:
On Tue, 19 Nov 2024 at 11:14, Arnaud POULIQUEN arnaud.pouliquen@foss.st.com wrote:
Hello Mathieu,
On 11/18/24 18:52, Mathieu Poirier wrote:
On Mon, Nov 04, 2024 at 02:35:12PM +0100, Arnaud Pouliquen wrote:
This patch updates the rproc_ops struct to include an optional release_fw function.
The release_fw ops is responsible for releasing the remote processor firmware image. The ops is called in the following cases:
- An error occurs in rproc_start() between the loading of the segments and the start of the remote processor.
- after stopping the remote processor.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
Updates from version V11:
- fix typo in @release_fw comment
drivers/remoteproc/remoteproc_core.c | 5 +++++ include/linux/remoteproc.h | 3 +++ 2 files changed, 8 insertions(+)
diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c index 7694817f25d4..46863e1ca307 100644 --- a/drivers/remoteproc/remoteproc_core.c +++ b/drivers/remoteproc/remoteproc_core.c @@ -1258,6 +1258,9 @@ static int rproc_alloc_registered_carveouts(struct rproc *rproc)
static void rproc_release_fw(struct rproc *rproc) {
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);- /* Free the copy of the resource table */ kfree(rproc->cached_table); rproc->cached_table = NULL;
@@ -1377,6 +1380,8 @@ static int rproc_start(struct rproc *rproc, const struct firmware *fw) unprepare_subdevices: rproc_unprepare_subdevices(rproc); reset_table_ptr:
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);I suggest the following:
- Create two new functions, i.e rproc_load_fw() and rproc_release_fw(). The
only thing those would do is call rproc->ops->load_fw() and rproc->ops->release_fw(), if they are present. When a TEE interface is available, ->load_fw() and ->release_fw() become rproc_tee_load_fw() and rproc_tee_release_fw().
I'm wondering if it should be ->preload_fw() instead of ->load_fw() ops, as the ->load() op already exists.
I agree that ->load() and ->load_fw() will lead to confusion. I would support ->preload_fw() but there is no obvious antonyme.
Since we already have rproc_ops::prepare() and rproc_prepare_device() I suggest rproc_ops::prepare_fw() and rproc_prepare_fw(). The corollary would be rproc_ops::unprepare_fw() and rproc_unprepare_fm(). That said, I'm open to other ideas should you be interested in finding other alternatives.
Actually... A better approach might to rename rproc::load to rproc::load_segments. That way we can use rproc::load_fw() and rproc_load_fw() without confusion.
Concerning this proposal, please correct me if I'm wrong - ops::load_segments() would be used for ELF format only as segment notion seems linked to this format. - ops:rproc_load_fw should be used for other formats.
The risk is that someone may later come with a requirement to get a resource table first to configure some memories before loading a non-ELF firmware.
- Call rproc_load_fw() in rproc_boot(), just before rproc_fw_boot(). If the
call to rproc_fw_boot() fails, call rproc_release_fw().
- The same logic applies to rproc_boot_recovery(), i.e call rproc_load_fw()
before rproc_start() and call rproc_release_fw() if rproc_start() fails.
I implemented this and I'm currently testing it. Thise second part requires a few adjustments to work. The ->load() ops needs to becomes optional to not be called if the "->preload_fw()" is used.
For that, I propose to return 0 in rproc_load_segments if rproc->ops->load is NULL and compensate by checking that at least "->preload_fw()" or ->load() is non-null in rproc_alloc_ops.
I agree.
Thanks, Arnaud
- Take rproc_tee_load_fw() out of rproc_tee_parse_fw(). It will now be called
in rproc_load_fw().
- As stated above function rproc_release_fw() now calls rproc_tee_release_fw().
The former is already called in rproc_shutdown() so we are good in that front.
With the above the cached_table management within the core remains the same and we can get rid of patch 3.7.
Thanks, Mathieu
return ret;diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h index 2e0ddcb2d792..08e0187a84d9 100644 --- a/include/linux/remoteproc.h +++ b/include/linux/remoteproc.h @@ -381,6 +381,8 @@ enum rsc_handling_status {
- @panic: optional callback to react to system panic, core will delay
panic at least the returned number of milliseconds- @coredump: collect firmware dump after the subsystem is shutdown
- @release_fw: optional function to release the firmware image from ROM memories.
*/
This function is called after stopping the remote processor or in case of an errorstruct rproc_ops { int (*prepare)(struct rproc *rproc); @@ -403,6 +405,7 @@ struct rproc_ops { u64 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw); unsigned long (*panic)(struct rproc *rproc); void (*coredump)(struct rproc *rproc);
- void (*release_fw)(struct rproc *rproc);
};
/**
2.25.1
On Wed, 20 Nov 2024 at 09:39, Arnaud POULIQUEN arnaud.pouliquen@foss.st.com wrote:
On 11/20/24 17:04, Mathieu Poirier wrote:
On Tue, 19 Nov 2024 at 13:38, Mathieu Poirier mathieu.poirier@linaro.org wrote:
On Tue, 19 Nov 2024 at 11:14, Arnaud POULIQUEN arnaud.pouliquen@foss.st.com wrote:
Hello Mathieu,
On 11/18/24 18:52, Mathieu Poirier wrote:
On Mon, Nov 04, 2024 at 02:35:12PM +0100, Arnaud Pouliquen wrote:
This patch updates the rproc_ops struct to include an optional release_fw function.
The release_fw ops is responsible for releasing the remote processor firmware image. The ops is called in the following cases:
- An error occurs in rproc_start() between the loading of the segments and the start of the remote processor.
- after stopping the remote processor.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
Updates from version V11:
- fix typo in @release_fw comment
drivers/remoteproc/remoteproc_core.c | 5 +++++ include/linux/remoteproc.h | 3 +++ 2 files changed, 8 insertions(+)
diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c index 7694817f25d4..46863e1ca307 100644 --- a/drivers/remoteproc/remoteproc_core.c +++ b/drivers/remoteproc/remoteproc_core.c @@ -1258,6 +1258,9 @@ static int rproc_alloc_registered_carveouts(struct rproc *rproc)
static void rproc_release_fw(struct rproc *rproc) {
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);- /* Free the copy of the resource table */ kfree(rproc->cached_table); rproc->cached_table = NULL;
@@ -1377,6 +1380,8 @@ static int rproc_start(struct rproc *rproc, const struct firmware *fw) unprepare_subdevices: rproc_unprepare_subdevices(rproc); reset_table_ptr:
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);I suggest the following:
- Create two new functions, i.e rproc_load_fw() and rproc_release_fw(). The
only thing those would do is call rproc->ops->load_fw() and rproc->ops->release_fw(), if they are present. When a TEE interface is available, ->load_fw() and ->release_fw() become rproc_tee_load_fw() and rproc_tee_release_fw().
I'm wondering if it should be ->preload_fw() instead of ->load_fw() ops, as the ->load() op already exists.
I agree that ->load() and ->load_fw() will lead to confusion. I would support ->preload_fw() but there is no obvious antonyme.
Since we already have rproc_ops::prepare() and rproc_prepare_device() I suggest rproc_ops::prepare_fw() and rproc_prepare_fw(). The corollary would be rproc_ops::unprepare_fw() and rproc_unprepare_fm(). That said, I'm open to other ideas should you be interested in finding other alternatives.
Actually... A better approach might to rename rproc::load to rproc::load_segments. That way we can use rproc::load_fw() and rproc_load_fw() without confusion.
Concerning this proposal, please correct me if I'm wrong
- ops::load_segments() would be used for ELF format only as segment notion seems
linked to this format.
Correct - nothing different from what it is now.
- ops:rproc_load_fw should be used for other formats.
The risk is that someone may later come with a requirement to get a resource table first to configure some memories before loading a non-ELF firmware.
We can address that problem if/when it comes about.
- Call rproc_load_fw() in rproc_boot(), just before rproc_fw_boot(). If the
call to rproc_fw_boot() fails, call rproc_release_fw().
- The same logic applies to rproc_boot_recovery(), i.e call rproc_load_fw()
before rproc_start() and call rproc_release_fw() if rproc_start() fails.
I implemented this and I'm currently testing it. Thise second part requires a few adjustments to work. The ->load() ops needs to becomes optional to not be called if the "->preload_fw()" is used.
For that, I propose to return 0 in rproc_load_segments if rproc->ops->load is NULL and compensate by checking that at least "->preload_fw()" or ->load() is non-null in rproc_alloc_ops.
I agree.
Thanks, Arnaud
- Take rproc_tee_load_fw() out of rproc_tee_parse_fw(). It will now be called
in rproc_load_fw().
- As stated above function rproc_release_fw() now calls rproc_tee_release_fw().
The former is already called in rproc_shutdown() so we are good in that front.
With the above the cached_table management within the core remains the same and we can get rid of patch 3.7.
Thanks, Mathieu
return ret;diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h index 2e0ddcb2d792..08e0187a84d9 100644 --- a/include/linux/remoteproc.h +++ b/include/linux/remoteproc.h @@ -381,6 +381,8 @@ enum rsc_handling_status {
- @panic: optional callback to react to system panic, core will delay
panic at least the returned number of milliseconds- @coredump: collect firmware dump after the subsystem is shutdown
- @release_fw: optional function to release the firmware image from ROM memories.
*/
This function is called after stopping the remote processor or in case of an errorstruct rproc_ops { int (*prepare)(struct rproc *rproc); @@ -403,6 +405,7 @@ struct rproc_ops { u64 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw); unsigned long (*panic)(struct rproc *rproc); void (*coredump)(struct rproc *rproc);
- void (*release_fw)(struct rproc *rproc);
};
/**
2.25.1
On 11/19/24 21:38, Mathieu Poirier wrote:
On Tue, 19 Nov 2024 at 11:14, Arnaud POULIQUEN arnaud.pouliquen@foss.st.com wrote:
Hello Mathieu,
On 11/18/24 18:52, Mathieu Poirier wrote:
On Mon, Nov 04, 2024 at 02:35:12PM +0100, Arnaud Pouliquen wrote:
This patch updates the rproc_ops struct to include an optional release_fw function.
The release_fw ops is responsible for releasing the remote processor firmware image. The ops is called in the following cases:
- An error occurs in rproc_start() between the loading of the segments and the start of the remote processor.
- after stopping the remote processor.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com
Updates from version V11:
- fix typo in @release_fw comment
drivers/remoteproc/remoteproc_core.c | 5 +++++ include/linux/remoteproc.h | 3 +++ 2 files changed, 8 insertions(+)
diff --git a/drivers/remoteproc/remoteproc_core.c b/drivers/remoteproc/remoteproc_core.c index 7694817f25d4..46863e1ca307 100644 --- a/drivers/remoteproc/remoteproc_core.c +++ b/drivers/remoteproc/remoteproc_core.c @@ -1258,6 +1258,9 @@ static int rproc_alloc_registered_carveouts(struct rproc *rproc)
static void rproc_release_fw(struct rproc *rproc) {
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);- /* Free the copy of the resource table */ kfree(rproc->cached_table); rproc->cached_table = NULL;
@@ -1377,6 +1380,8 @@ static int rproc_start(struct rproc *rproc, const struct firmware *fw) unprepare_subdevices: rproc_unprepare_subdevices(rproc); reset_table_ptr:
- if (rproc->ops->release_fw)
rproc->ops->release_fw(rproc);I suggest the following:
- Create two new functions, i.e rproc_load_fw() and rproc_release_fw(). The
only thing those would do is call rproc->ops->load_fw() and rproc->ops->release_fw(), if they are present. When a TEE interface is available, ->load_fw() and ->release_fw() become rproc_tee_load_fw() and rproc_tee_release_fw().
I'm wondering if it should be ->preload_fw() instead of ->load_fw() ops, as the ->load() op already exists.
I agree that ->load() and ->load_fw() will lead to confusion. I would support ->preload_fw() but there is no obvious antonyme.
Since we already have rproc_ops::prepare() and rproc_prepare_device() I suggest rproc_ops::prepare_fw() and rproc_prepare_fw(). The corollary would be rproc_ops::unprepare_fw() and rproc_unprepare_fm(). That said, I'm open to other ideas should you be interested in finding other alternatives.
1) Using ops::prepare_fw/unprepare_fw: My concern is that it could also lead to confusion as we would load the firmware on ops::prepare_fw and do nothing on ops::load(). That would not match with the ops action. look to me that in this option, ops::load() must be kept as mandatory ops for consistence.
2) Using ops::preload_fw: This seems to better reflect the use case. Concerning the antonym choice , could we consider that ops::release_fw() is the antonym of both ops;;preload_fw and ops::load? some other antonym proposal: - unload_fw - postunload_fw
3) Other alternatives:
3-a) using ops::rproc_prepare/unprepare_device. Same concern that prepare_fw/unprepare_fw another drawbackis that rproc_tee_load_fw() would be not directly mapped to an rproc ops but platform driver should need to call rproc_tee_load_fw() into its ops::prepare() function (a.e stm32_rproc_prepare).
3-b) Another alternative I can see is the one I proposed in version 3 [1]. The principle was to keep existing ops but propose an alternative boot sequence. Perhaps a backup solution is to reanalyze this option if no other is suitable.
[1] https://lore.kernel.org/lkml/8af59b01-53cf-4fc4-9946-6c630fb7b38e@quicinc.co...
Please just tell/confirm me your prefered solution that I propose it in next revision.
Regards, Arnaud
- Call rproc_load_fw() in rproc_boot(), just before rproc_fw_boot(). If the
call to rproc_fw_boot() fails, call rproc_release_fw().
- The same logic applies to rproc_boot_recovery(), i.e call rproc_load_fw()
before rproc_start() and call rproc_release_fw() if rproc_start() fails.
I implemented this and I'm currently testing it. Thise second part requires a few adjustments to work. The ->load() ops needs to becomes optional to not be called if the "->preload_fw()" is used.
For that, I propose to return 0 in rproc_load_segments if rproc->ops->load is NULL and compensate by checking that at least "->preload_fw()" or ->load() is non-null in rproc_alloc_ops.
I agree.
Thanks, Arnaud
- Take rproc_tee_load_fw() out of rproc_tee_parse_fw(). It will now be called
in rproc_load_fw().
- As stated above function rproc_release_fw() now calls rproc_tee_release_fw().
The former is already called in rproc_shutdown() so we are good in that front.
With the above the cached_table management within the core remains the same and we can get rid of patch 3.7.
Thanks, Mathieu
return ret;diff --git a/include/linux/remoteproc.h b/include/linux/remoteproc.h index 2e0ddcb2d792..08e0187a84d9 100644 --- a/include/linux/remoteproc.h +++ b/include/linux/remoteproc.h @@ -381,6 +381,8 @@ enum rsc_handling_status {
- @panic: optional callback to react to system panic, core will delay
panic at least the returned number of milliseconds- @coredump: collect firmware dump after the subsystem is shutdown
- @release_fw: optional function to release the firmware image from ROM memories.
*/
This function is called after stopping the remote processor or in case of an errorstruct rproc_ops { int (*prepare)(struct rproc *rproc); @@ -403,6 +405,7 @@ struct rproc_ops { u64 (*get_boot_addr)(struct rproc *rproc, const struct firmware *fw); unsigned long (*panic)(struct rproc *rproc); void (*coredump)(struct rproc *rproc);
- void (*release_fw)(struct rproc *rproc);
};
/**
2.25.1
The "st,stm32mp1-m4-tee" compatible is utilized in a system configuration where the Cortex-M4 firmware is loaded by the Trusted Execution Environment (TEE).
For instance, this compatible is used in both the Linux and OP-TEE device trees: - In OP-TEE, a node is defined in the device tree with the "st,stm32mp1-m4-tee" compatible to support signed remoteproc firmware. Based on DT properties, the OP-TEE remoteproc framework is initiated to expose a trusted application service to authenticate and load the remote processor firmware provided by the Linux remoteproc framework, as well as to start and stop the remote processor. - In Linux, when the compatibility is set, the Cortex-M resets should not be declared in the device tree. In such a configuration, the reset is managed by the OP-TEE remoteproc driver and is no longer accessible from the Linux kernel.
Associated with this new compatible, add the "st,proc-id" property to identify the remote processor. This ID is used to define a unique ID, common between Linux, U-Boot, and OP-TEE, to identify a coprocessor. This ID will be used in requests to the OP-TEE remoteproc Trusted Application to specify the remote processor.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com Reviewed-by: Rob Herring (Arm) robh@kernel.org --- .../bindings/remoteproc/st,stm32-rproc.yaml | 58 ++++++++++++++++--- 1 file changed, 50 insertions(+), 8 deletions(-)
diff --git a/Documentation/devicetree/bindings/remoteproc/st,stm32-rproc.yaml b/Documentation/devicetree/bindings/remoteproc/st,stm32-rproc.yaml index 370af61d8f28..409123cd4667 100644 --- a/Documentation/devicetree/bindings/remoteproc/st,stm32-rproc.yaml +++ b/Documentation/devicetree/bindings/remoteproc/st,stm32-rproc.yaml @@ -16,7 +16,12 @@ maintainers:
properties: compatible: - const: st,stm32mp1-m4 + enum: + - st,stm32mp1-m4 + - st,stm32mp1-m4-tee + description: + Use "st,stm32mp1-m4" for the Cortex-M4 coprocessor management by non-secure context + Use "st,stm32mp1-m4-tee" for the Cortex-M4 coprocessor management by secure context
reg: description: @@ -43,6 +48,10 @@ properties: - description: The offset of the hold boot setting register - description: The field mask of the hold boot
+ st,proc-id: + description: remote processor identifier + $ref: /schemas/types.yaml#/definitions/uint32 + st,syscfg-tz: deprecated: true description: @@ -142,21 +151,43 @@ properties: required: - compatible - reg - - resets
allOf: - if: properties: - reset-names: - not: - contains: - const: hold_boot + compatible: + contains: + const: st,stm32mp1-m4 then: + if: + properties: + reset-names: + not: + contains: + const: hold_boot + then: + required: + - st,syscfg-holdboot + else: + properties: + st,syscfg-holdboot: false + required: + - reset-names required: - - st,syscfg-holdboot - else: + - resets + + - if: + properties: + compatible: + contains: + const: st,stm32mp1-m4-tee + then: properties: st,syscfg-holdboot: false + reset-names: false + resets: false + required: + - st,proc-id
additionalProperties: false
@@ -188,5 +219,16 @@ examples: st,syscfg-rsc-tbl = <&tamp 0x144 0xFFFFFFFF>; st,syscfg-m4-state = <&tamp 0x148 0xFFFFFFFF>; }; + - | + #include <dt-bindings/reset/stm32mp1-resets.h> + m4@10000000 { + compatible = "st,stm32mp1-m4-tee"; + reg = <0x10000000 0x40000>, + <0x30000000 0x40000>, + <0x38000000 0x10000>; + st,proc-id = <0>; + st,syscfg-rsc-tbl = <&tamp 0x144 0xFFFFFFFF>; + st,syscfg-m4-state = <&tamp 0x148 0xFFFFFFFF>; + };
...
To prepare for the support of TEE remoteproc, create sub-functions that can be used in both cases, with and without remoteproc TEE support.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com --- drivers/remoteproc/stm32_rproc.c | 82 +++++++++++++++++++------------- 1 file changed, 49 insertions(+), 33 deletions(-)
diff --git a/drivers/remoteproc/stm32_rproc.c b/drivers/remoteproc/stm32_rproc.c index 8c7f7950b80e..288bd70c7861 100644 --- a/drivers/remoteproc/stm32_rproc.c +++ b/drivers/remoteproc/stm32_rproc.c @@ -209,6 +209,52 @@ static int stm32_rproc_mbox_idx(struct rproc *rproc, const unsigned char *name) return -EINVAL; }
+static void stm32_rproc_request_shutdown(struct rproc *rproc) +{ + struct stm32_rproc *ddata = rproc->priv; + int err, idx; + + /* Request shutdown of the remote processor */ + if (rproc->state != RPROC_OFFLINE && rproc->state != RPROC_CRASHED) { + idx = stm32_rproc_mbox_idx(rproc, STM32_MBX_SHUTDOWN); + if (idx >= 0 && ddata->mb[idx].chan) { + err = mbox_send_message(ddata->mb[idx].chan, "detach"); + if (err < 0) + dev_warn(&rproc->dev, "warning: remote FW shutdown without ack\n"); + } + } +} + +static int stm32_rproc_release(struct rproc *rproc) +{ + struct stm32_rproc *ddata = rproc->priv; + unsigned int err = 0; + + /* To allow platform Standby power mode, set remote proc Deep Sleep */ + if (ddata->pdds.map) { + err = regmap_update_bits(ddata->pdds.map, ddata->pdds.reg, + ddata->pdds.mask, 1); + if (err) { + dev_err(&rproc->dev, "failed to set pdds\n"); + return err; + } + } + + /* Update coprocessor state to OFF if available */ + if (ddata->m4_state.map) { + err = regmap_update_bits(ddata->m4_state.map, + ddata->m4_state.reg, + ddata->m4_state.mask, + M4_STATE_OFF); + if (err) { + dev_err(&rproc->dev, "failed to set copro state\n"); + return err; + } + } + + return 0; +} + static int stm32_rproc_prepare(struct rproc *rproc) { struct device *dev = rproc->dev.parent; @@ -519,17 +565,9 @@ static int stm32_rproc_detach(struct rproc *rproc) static int stm32_rproc_stop(struct rproc *rproc) { struct stm32_rproc *ddata = rproc->priv; - int err, idx; + int err;
- /* request shutdown of the remote processor */ - if (rproc->state != RPROC_OFFLINE && rproc->state != RPROC_CRASHED) { - idx = stm32_rproc_mbox_idx(rproc, STM32_MBX_SHUTDOWN); - if (idx >= 0 && ddata->mb[idx].chan) { - err = mbox_send_message(ddata->mb[idx].chan, "detach"); - if (err < 0) - dev_warn(&rproc->dev, "warning: remote FW shutdown without ack\n"); - } - } + stm32_rproc_request_shutdown(rproc);
err = stm32_rproc_set_hold_boot(rproc, true); if (err) @@ -541,29 +579,7 @@ static int stm32_rproc_stop(struct rproc *rproc) return err; }
- /* to allow platform Standby power mode, set remote proc Deep Sleep */ - if (ddata->pdds.map) { - err = regmap_update_bits(ddata->pdds.map, ddata->pdds.reg, - ddata->pdds.mask, 1); - if (err) { - dev_err(&rproc->dev, "failed to set pdds\n"); - return err; - } - } - - /* update coprocessor state to OFF if available */ - if (ddata->m4_state.map) { - err = regmap_update_bits(ddata->m4_state.map, - ddata->m4_state.reg, - ddata->m4_state.mask, - M4_STATE_OFF); - if (err) { - dev_err(&rproc->dev, "failed to set copro state\n"); - return err; - } - } - - return 0; + return stm32_rproc_release(rproc); }
static void stm32_rproc_kick(struct rproc *rproc, int vqid)
The new TEE remoteproc driver is used to manage remote firmware in a secure, trusted context. The 'st,stm32mp1-m4-tee' compatibility is introduced to delegate the loading of the firmware to the trusted execution context. In such cases, the firmware should be signed and adhere to the image format defined by the TEE.
Signed-off-by: Arnaud Pouliquen arnaud.pouliquen@foss.st.com --- Updates from version V11: - rename structures, variables and function from tee_rproc_xxx to rproc_tee_xxx, - rework code to take into account rproc_tee_register and rproc_tee_unregister APIs update, - optimize code around dev_err_probe() when rproc_tee_register() fails. --- drivers/remoteproc/stm32_rproc.c | 57 ++++++++++++++++++++++++++++++-- 1 file changed, 54 insertions(+), 3 deletions(-)
diff --git a/drivers/remoteproc/stm32_rproc.c b/drivers/remoteproc/stm32_rproc.c index 288bd70c7861..7875b26a38a5 100644 --- a/drivers/remoteproc/stm32_rproc.c +++ b/drivers/remoteproc/stm32_rproc.c @@ -18,6 +18,7 @@ #include <linux/pm_wakeirq.h> #include <linux/regmap.h> #include <linux/remoteproc.h> +#include <linux/remoteproc_tee.h> #include <linux/reset.h> #include <linux/slab.h> #include <linux/workqueue.h> @@ -255,6 +256,19 @@ static int stm32_rproc_release(struct rproc *rproc) return 0; }
+static int stm32_rproc_tee_stop(struct rproc *rproc) +{ + int err; + + stm32_rproc_request_shutdown(rproc); + + err = rproc_tee_stop(rproc); + if (err) + return err; + + return stm32_rproc_release(rproc); +} + static int stm32_rproc_prepare(struct rproc *rproc) { struct device *dev = rproc->dev.parent; @@ -691,8 +705,20 @@ static const struct rproc_ops st_rproc_ops = { .get_boot_addr = rproc_elf_get_boot_addr, };
+static const struct rproc_ops st_rproc_tee_ops = { + .prepare = stm32_rproc_prepare, + .start = rproc_tee_start, + .stop = stm32_rproc_tee_stop, + .kick = stm32_rproc_kick, + .load = rproc_tee_load_fw, + .parse_fw = rproc_tee_parse_fw, + .find_loaded_rsc_table = rproc_tee_find_loaded_rsc_table, + .release_fw = rproc_tee_release_fw, +}; + static const struct of_device_id stm32_rproc_match[] = { { .compatible = "st,stm32mp1-m4" }, + { .compatible = "st,stm32mp1-m4-tee" }, {}, }; MODULE_DEVICE_TABLE(of, stm32_rproc_match); @@ -853,15 +879,36 @@ static int stm32_rproc_probe(struct platform_device *pdev) struct device_node *np = dev->of_node; struct rproc *rproc; unsigned int state; + u32 proc_id; int ret;
ret = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(32)); if (ret) return ret;
- rproc = devm_rproc_alloc(dev, np->name, &st_rproc_ops, NULL, sizeof(*ddata)); - if (!rproc) - return -ENOMEM; + if (of_device_is_compatible(np, "st,stm32mp1-m4-tee")) { + /* + * Delegate the firmware management to the secure context. + * The firmware loaded has to be signed. + */ + ret = of_property_read_u32(np, "st,proc-id", &proc_id); + if (ret) { + dev_err(dev, "failed to read st,rproc-id property\n"); + return ret; + } + + rproc = devm_rproc_alloc(dev, np->name, &st_rproc_tee_ops, NULL, sizeof(*ddata)); + if (!rproc) + return -ENOMEM; + + ret = rproc_tee_register(dev, rproc, proc_id); + if (ret) + return dev_err_probe(dev, ret, "signed firmware not supported by TEE\n"); + } else { + rproc = devm_rproc_alloc(dev, np->name, &st_rproc_ops, NULL, sizeof(*ddata)); + if (!rproc) + return -ENOMEM; + }
ddata = rproc->priv;
@@ -913,6 +960,8 @@ static int stm32_rproc_probe(struct platform_device *pdev) dev_pm_clear_wake_irq(dev); device_init_wakeup(dev, false); } + rproc_tee_unregister(rproc); + return ret; }
@@ -933,6 +982,8 @@ static void stm32_rproc_remove(struct platform_device *pdev) dev_pm_clear_wake_irq(dev); device_init_wakeup(dev, false); } + + rproc_tee_unregister(rproc); }
static int stm32_rproc_suspend(struct device *dev)
op-tee@lists.trustedfirmware.org
-
Arnaud POULIQUEN -
Arnaud Pouliquen
-
Mathieu Poirier