arm/trusted-services: Enable the fTPM SP

Trusted Services has introduced a Firmware TPM (fTPM) secure partition. This change enables building and deploying the fTPM SP through meta-arm. The secure partition is based on the TPM2 reference implementation, msp-tpm20-ref, which has been patched to use MbedTLS as its crypto backend and psa-its for non-volatile storage. Signed-off-by: Gabor Toth <gabor.toth2@arm.com> Signed-off-by: Gyorgy Szing <gyorgy.szing@arm.com> Signed-off-by: Jon Mason <jon.mason@arm.com>
2026-04-20 11:29:54 +00:00 · 2026-03-04 09:27:10 +01:00
parent 4e94b90c1c
commit 7601b7e0db
10 changed files with 428 additions and 0 deletions
--- a/meta-arm-bsp/recipes-kernel/linux/files/fvp-base/0002-Add-TPM-CRB-FF-A-DT-support.patch
+++ b/meta-arm-bsp/recipes-kernel/linux/files/fvp-base/0002-Add-TPM-CRB-FF-A-DT-support.patch
@@ -0,0 +1,297 @@
+From 016eec200c2da5949dd3b1886f4d0ff078085594 Mon Sep 17 00:00:00 2001
+From: kas User <kas@example.com>
+Date: Sat, 24 Jan 2026 11:15:25 +0000
+Subject: Add TPM CRB FF-A DT support
+
+Add DT support and limit FF-A communication to 32 bit
+FFA_MSG_SEND_DIRECT_REQ calls.
+
+This patch is a protorype implementation, proper DT support would need
+wider changes (e.g. code is not reading carveout location from DT).
+
+Upstream-Status: Inappropriate [other]
+Signed-off-by: Balint Dobszay <balint.dobszay@arm.com>
+Signed-Off-By: Gyorgy Szing <gyorgy.szing@arm.com>
+---
+ arch/arm64/boot/dts/arm/fvp-base-revc.dts |  11 ++
+ drivers/char/tpm/tpm_crb.c                | 187 ++++++++++++++++++++--
+ drivers/char/tpm/tpm_crb_ffa.c            |   7 +-
+ 3 files changed, 186 insertions(+), 19 deletions(-)
+
+diff --git a/arch/arm64/boot/dts/arm/fvp-base-revc.dts b/arch/arm64/boot/dts/arm/fvp-base-revc.dts
+index 68a69f17e93d..c0ee96bddb61 100644
+--- a/arch/arm64/boot/dts/arm/fvp-base-revc.dts
+++ b/arch/arm64/boot/dts/arm/fvp-base-revc.dts
+@@ -217,6 +217,17 @@ vram: vram@18000000 {
+ 			reg = <0x00000000 0x18000000 0 0x00800000>;
+ 			no-map;
+ 		};
+
+		/* TPM CRB carveout for SWd communication */
+		tpm-crb@84000000 {
+			reg = <0x00000000 0x84000000 0 0x4000>;
+			no-map;
+		};
+	};
+
+	ftpm {
+		/* Dummy node for TPM CRB platform driver */
+		compatible = "arm,ftpm";
+ 	};
+ 
+ 	gic: interrupt-controller@2f000000 {
+diff --git a/drivers/char/tpm/tpm_crb.c b/drivers/char/tpm/tpm_crb.c
+index c75a531cfb98..3bd60cf34daf 100644
+--- a/drivers/char/tpm/tpm_crb.c
+++ b/drivers/char/tpm/tpm_crb.c
+@@ -16,6 +16,8 @@
+ #include <linux/rculist.h>
+ #include <linux/module.h>
+ #include <linux/pm_runtime.h>
+#include <linux/platform_device.h>
+#include <linux/of.h>
+ #ifdef CONFIG_ARM64
+ #include <linux/arm-smccc.h>
+ #endif
+@@ -25,6 +27,10 @@
+ #define ACPI_SIG_TPM2 "TPM2"
+ #define TPM_CRB_MAX_RESOURCES 3
+ 
+/* TPM CRB carveout. Should be marked as reserved-memory with no-map in the DT */
+static const u64 carveout_addr = 0x84000000;
+static const size_t carveout_size = 4 * SZ_4K;
+
+ static const guid_t crb_acpi_start_guid =
+ 	GUID_INIT(0x6BBF6CAB, 0x5463, 0x4714,
+ 		  0xB7, 0xCD, 0xF0, 0x20, 0x3C, 0x03, 0x68, 0xD4);
+@@ -907,29 +913,180 @@ static void crb_acpi_remove(struct acpi_device *device)
+ 	tpm_chip_unregister(chip);
+ }
+ 
+static int crb_map_of_io(struct platform_device *pdev, struct crb_priv *priv)
+{
+	struct device *dev = &pdev->dev;
+	u32 pa_high, pa_low;
+	u64 cmd_pa;
+	u32 cmd_size;
+	__le64 __rsp_pa;
+	u64 rsp_pa;
+	u32 rsp_size;
+	int ret;
+	void __iomem *carveout;
+
+	carveout = ioremap_np(carveout_addr, carveout_size);
+	if (!carveout)
+		return -EINVAL;
+
+	priv->regs_h = (struct crb_regs_head *)carveout;
+	priv->regs_t = (struct crb_regs_tail *)((u8 *)carveout + 0x40);
+	priv->cmd = (u8 *)carveout + 0x80;
+
+	ret = __crb_request_locality(dev, priv, 0);
+	if (ret)
+		return ret;
+
+	pa_high = ioread32(&priv->regs_t->ctrl_cmd_pa_high);
+	pa_low  = ioread32(&priv->regs_t->ctrl_cmd_pa_low);
+	cmd_pa = ((u64)pa_high << 32) | pa_low;
+	cmd_size = ioread32(&priv->regs_t->ctrl_cmd_size);
+
+	dev_dbg(dev, "cmd_hi = %X cmd_low = %X cmd_size %X\n",
+		pa_high, pa_low, cmd_size);
+
+	memcpy_fromio(&__rsp_pa, &priv->regs_t->ctrl_rsp_pa, 8);
+	rsp_pa = le64_to_cpu(__rsp_pa);
+	rsp_size = ioread32(&priv->regs_t->ctrl_rsp_size);
+
+	/* According to the PTP specification, overlapping command and response
+	 * buffer sizes must be identical.
+	 */
+	if (cmd_size != rsp_size) {
+		dev_err(dev, FW_BUG "overlapping command and response buffer sizes are not identical");
+		ret = -EINVAL;
+		goto out;
+	}
+
+	priv->rsp = priv->cmd;
+
+out:
+	if (!ret)
+		priv->cmd_size = cmd_size;
+
+	__crb_go_idle(dev, priv, 0);
+	__crb_relinquish_locality(dev, priv, 0);
+
+	return ret;
+}
+
+static int crb_of_add(struct platform_device *pdev)
+{
+	struct crb_priv *priv;
+	struct tpm_chip *chip;
+	struct device *dev = &pdev->dev;
+	int rc;
+
+	priv = devm_kzalloc(dev, sizeof(struct crb_priv), GFP_KERNEL);
+	if (!priv) {
+		rc = -ENOMEM;
+		goto out;
+	}
+
+	priv->ffa_flags = 0;
+	priv->ffa_attributes = 0;
+	priv->sm = ACPI_TPM2_CRB_WITH_ARM_FFA;
+	priv->hid = "ftpm-ffa";
+
+	rc = tpm_crb_ffa_init();
+	if (rc) {
+		if (rc == -ENOENT) {
+			/* FF-A driver is not available yet */
+			rc = -EPROBE_DEFER;
+		}
+		goto out;
+	}
+
+	rc = crb_map_of_io(pdev, priv);
+	if (rc)
+		goto out;
+
+	chip = tpmm_chip_alloc(dev, &tpm_crb);
+	if (IS_ERR(chip)) {
+		rc = PTR_ERR(chip);
+		goto out;
+	}
+
+	dev_set_drvdata(&chip->dev, priv);
+	chip->flags = TPM_CHIP_FLAG_TPM2;
+
+	rc = tpm_chip_bootstrap(chip);
+	if (rc)
+		goto out;
+
+	rc = tpm_chip_register(chip);
+
+out:
+	return rc;
+}
+
+static void crb_of_remove(struct platform_device *pdev)
+{
+	struct device *dev = &pdev->dev;
+	struct tpm_chip *chip = dev_get_drvdata(dev);
+
+	tpm_chip_unregister(chip);
+}
+
+static int crb_probe(struct platform_device *pdev)
+{
+	struct device_node *node = pdev->dev.of_node;
+	int rc;
+
+	if (node)
+		rc = crb_of_add(pdev);
+	else if (ACPI_HANDLE(&pdev->dev))
+		rc = crb_acpi_add(ACPI_COMPANION(&pdev->dev));
+	else
+		return -EINVAL;
+
+	return rc;
+}
+
+static void crb_remove(struct platform_device *pdev)
+{
+	struct device_node *node = pdev->dev.of_node;
+
+	if (node)
+		crb_of_remove(pdev);
+	else if (ACPI_HANDLE(&pdev->dev))
+		crb_acpi_remove(ACPI_COMPANION(&pdev->dev));
+}
+
+
+ static const struct dev_pm_ops crb_pm = {
+ 	SET_SYSTEM_SLEEP_PM_OPS(tpm_pm_suspend, tpm_pm_resume)
+ };
+ 
+-static const struct acpi_device_id crb_device_ids[] = {
+#ifdef CONFIG_OF
+static const struct of_device_id crb_of_device_ids[] = {
+	{ .compatible = "arm,ftpm" },
+	{},
+};
+MODULE_DEVICE_TABLE(of, crb_of_device_ids);
+#endif
+
+#ifdef CONFIG_ACPI
+static const struct acpi_device_id crb_acpi_device_ids[] = {
+ 	{"MSFT0101", 0},
+ 	{"", 0},
+ };
+-MODULE_DEVICE_TABLE(acpi, crb_device_ids);
+-
+-static struct acpi_driver crb_acpi_driver = {
+-	.name = "tpm_crb",
+-	.ids = crb_device_ids,
+-	.ops = {
+-		.add = crb_acpi_add,
+-		.remove = crb_acpi_remove,
+-	},
+-	.drv = {
+-		.pm = &crb_pm,
+-	},
+-};
+MODULE_DEVICE_TABLE(acpi, crb_acpi_device_ids);
+#endif
+
+static struct platform_driver crb_driver = {
+	.probe = crb_probe,
+	.remove = crb_remove,
+	.driver = {
+		.name = "tpm_crb",
+ 		.pm = &crb_pm,
+		.of_match_table = of_match_ptr(crb_of_device_ids),
+		.acpi_match_table = ACPI_PTR(crb_acpi_device_ids),
+ 	},
+ };
+
+module_platform_driver(crb_driver);
+ 
+-module_acpi_driver(crb_acpi_driver);
+ MODULE_AUTHOR("Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com>");
+ MODULE_DESCRIPTION("TPM2 Driver");
+ MODULE_VERSION("0.1");
+diff --git a/drivers/char/tpm/tpm_crb_ffa.c b/drivers/char/tpm/tpm_crb_ffa.c
+index 755b77b32ea4..84b2ebc5c7c3 100644
+--- a/drivers/char/tpm/tpm_crb_ffa.c
+++ b/drivers/char/tpm/tpm_crb_ffa.c
+@@ -340,8 +340,7 @@ static int tpm_crb_ffa_probe(struct ffa_device *ffa_dev)
+ 
+ 	tpm_crb_ffa = ERR_PTR(-ENODEV); // set tpm_crb_ffa so we can detect probe failure
+ 
+-	if (!ffa_partition_supports_direct_recv(ffa_dev) &&
+-	    !ffa_partition_supports_direct_req2_recv(ffa_dev)) {
+	if (!ffa_partition_supports_direct_recv(ffa_dev)) {
+ 		dev_warn(&ffa_dev->dev, "partition doesn't support direct message receive.\n");
+ 		return -EINVAL;
+ 	}
+@@ -356,7 +355,7 @@ static int tpm_crb_ffa_probe(struct ffa_device *ffa_dev)
+ 	ffa_dev_set_drvdata(ffa_dev, tpm_crb_ffa);
+ 
+ 	/* if TPM is aarch32 use 32-bit SMCs */
+-	if (!ffa_partition_check_property(ffa_dev, FFA_PARTITION_AARCH64_EXEC))
+	if (!ffa_partition_check_property(ffa_dev, FFA_PARTITION_AARCH64_EXEC))
+ 		ffa_dev->ops->msg_ops->mode_32bit_set(ffa_dev);
+ 
+ 	/* verify compatibility of TPM service version number */
+@@ -406,7 +405,7 @@ static struct ffa_driver tpm_crb_ffa_driver = {
+ };
+ 
+ #ifdef MODULE
+-module_ffa_driver(tpm_crb_ffa_driver);
+(tpm_crb_ffa_driver);
+ #endif
+ 
+ MODULE_AUTHOR("Arm");
+-- 
+2.43.0
+
--- a/meta-arm-bsp/recipes-kernel/linux/files/fvp-base/tpm-crb.cfg
+++ b/meta-arm-bsp/recipes-kernel/linux/files/fvp-base/tpm-crb.cfg
@@ -0,0 +1,3 @@
+CONFIG_ACPI=y
+CONFIG_TCG_TPM=y
+CONFIG_TCG_CRB=y
--- a/meta-arm-bsp/recipes-kernel/linux/linux-arm-platforms.inc
+++ b/meta-arm-bsp/recipes-kernel/linux/linux-arm-platforms.inc
@@ -81,9 +81,18 @@ KERNEL_FEATURES:corstone1000:cortexa320 = ""
 COMPATIBLE_MACHINE:fvp-base = "fvp-base"
 KMACHINE:fvp-base = "fvp"
 FILESEXTRAPATHS:prepend:fvp-base := "${ARMBSPFILESPATHS}:${ARMFILESPATHS}"
+
+
+FTPM_SRC = " \
+     file://0002-Add-TPM-CRB-FF-A-DT-support.patch \
+     file://tpm-crb.cfg \
+"
+
 SRC_URI:append:fvp-base = " \
    file://0001-arm64-dts-fvp-Enable-virtio-rng-support.patch \
    file://tee.cfg \
+    ${@bb.utils.contains('MACHINE_FEATURES', 'ts-ftpm', \
+                         '${FTPM_SRC}', '' , d)} \
    ${@bb.utils.contains('MACHINE_FEATURES', 'ts-smm-gateway', \
                         'file://no-strict-devmem.cfg', '' , d)} \
 "
--- a/meta-arm-bsp/recipes-security/trusted-services/ts-sp-ftpm_%.bbappend
+++ b/meta-arm-bsp/recipes-security/trusted-services/ts-sp-ftpm_%.bbappend
@@ -0,0 +1 @@
+require ts-arm-platforms.inc
--- a/meta-arm/recipes-security/optee/optee-os-ts.inc
+++ b/meta-arm/recipes-security/optee/optee-os-ts.inc
@@ -86,6 +86,13 @@ DEPENDS:append  = "${@bb.utils.contains('MACHINE_FEATURES', 'ts-logging', \
 SP_PATHS:append = "${@bb.utils.contains('MACHINE_FEATURES', 'ts-logging', \
                                        ' ${TS_BIN}/${LOGGING_SP_UUID}${SP_EXT}', '', d)}"

+# FTPM SP
+DEPENDS:append  = "${@bb.utils.contains('MACHINE_FEATURES', 'ts-ftpm', \
+                                        ' ts-sp-ftpm', '' , d)}"
+
+SP_PATHS:append = "${@bb.utils.contains('MACHINE_FEATURES', 'ts-ftpm', \
+                                        ' ${TS_BIN}/${TS_FTPM_UUID}${SP_EXT}', '', d)}"
+

 EXTRA_OEMAKE:append = "${@oe.utils.conditional('SP_PATHS', '', '', \
                        ' CFG_MAP_EXT_DT_SECURE=y CFG_SECURE_PARTITION=y \
--- a/meta-arm/recipes-security/trusted-services/files/0001-fTPM-add-go_idle-support.patch
+++ b/meta-arm/recipes-security/trusted-services/files/0001-fTPM-add-go_idle-support.patch
@@ -0,0 +1,84 @@
+From 08fa0610c8796675ea8c8e5aabc6313b1c237f9c Mon Sep 17 00:00:00 2001
+From: Gyorgy Szing <gyorgy.szing@arm.com>
+Date: Mon, 2 Feb 2026 11:18:22 +0100
+Subject: [PATCH 1/1] fTPM: add go_idle support
+
+The Linux tpm_crb driver was changed to assume an fTPM instance accessed
+trough FF-A CRB to support idle bit handing in the TPM_CRB_CTRL_REQ
+register. Withouth this the kernel fails to start the device with a
+timeout error. Add a minimal implementation to restore compatibility.
+
+Upstream-Status: Pending
+
+Signed-off-by: Gyorgy Szing <gyorgy.szing@arm.com>
+---
+ .../service/tpm/provider/tpm_crb_provider.c   | 29 +++++++++++++++++--
+ 1 file changed, 27 insertions(+), 2 deletions(-)
+
+diff --git a/components/service/tpm/provider/tpm_crb_provider.c b/components/service/tpm/provider/tpm_crb_provider.c
+index a0c8c4bf5..4a932624f 100644
+--- a/components/service/tpm/provider/tpm_crb_provider.c
+++ b/components/service/tpm/provider/tpm_crb_provider.c
+@@ -142,6 +142,27 @@ static inline uint32_t tpm_get_request_length(uint8_t *buf)
+ 	return (uint32_t)((buf[2] << 24) + (buf[3] << 16) + (buf[4] << 8 ) + buf[5]);
+ }
+ 
+#define WRITE_ALIAS_REG(this_instance, reg_name, value) \
+	do { \
+		unsigned int loc; \
+		for (loc=0; loc < sizeof(this_instance->loc_ptr)/sizeof(this_instance->loc_ptr[0]); loc++) { \
+			this_instance->loc_ptr[loc]->reg_name = (value); \
+		} \
+	} while(0)
+
+static inline void go_busy(struct tpm_crb_provider *this_instance) {
+	WRITE_ALIAS_REG(this_instance, ctrl_status, 0);
+}
+
+static inline void go_idle(struct tpm_crb_provider *this_instance, unsigned int locality) {
+	/* All operations done:
+		- clear the pending request
+		- set idle bit */
+	this_instance->loc_ptr[locality]->ctrl_request = 0;
+	this_instance->loc_ptr[locality]->ctrl_start = 0;
+	WRITE_ALIAS_REG(this_instance, ctrl_status, CRB_CTRL_STS_TPM_IDLE);
+}
+
+ static rpc_status_t command_handler(void *context, struct rpc_request *req)
+ {
+ 	struct tpm_crb_provider *this_instance = (struct tpm_crb_provider *)context;
+@@ -161,25 +182,29 @@ static rpc_status_t command_handler(void *context, struct rpc_request *req)
+ 
+ 	if (!(req_loc->ctrl_start & CRB_CTRL_START_COMMAND)) {
+ 		req->service_status = TPM_ERROR_INV_CRB_CTRL_DATA;
+		go_idle(this_instance, locality);
+ 		return RPC_ERROR_INTERNAL;
+ 	}
+ 
+ 	req_len = tpm_get_request_length(req_loc->data_buffer);
+ 	if (req_len == 0 || crb_size < req_len) {
+ 		req->service_status = TPM_ERROR_INV_CRB_CTRL_DATA;
+		go_idle(this_instance, locality);
+ 		return RPC_ERROR_INTERNAL;
+ 	}
+ 
+	go_busy(this_instance);
+
+ 	req_data = req_loc->data_buffer;
+ 	resp_data = req_loc->data_buffer;
+ 	resp_max_size = crb_size;
+ 
+ 	ms_tpm_backend_execute_command(req_data, req_len, &resp_data, &resp_len, resp_max_size);
+ 
+-	/* All operations done, clear the pending request */
+-	req_loc->ctrl_start &= ~CRB_CTRL_START_COMMAND;
+ 	req->service_status = TPM_STATUS_OK;
+ 
+	go_idle(this_instance, locality);
+
+ 	return RPC_SUCCESS;
+ }
+ 
+-- 
+2.43.0
+
--- a/meta-arm/recipes-security/trusted-services/trusted-services-src.inc
+++ b/meta-arm/recipes-security/trusted-services/trusted-services-src.inc
@@ -52,6 +52,7 @@ SRC_URI = "git://git.trustedfirmware.org/TS/trusted-services.git;protocol=https;
           file://0001-Allow-configuring-flash-image-files-compile-time.patch \
           file://0002-Fix-MbedTLS-3.6-and-GCC-14-compatibility.patch \
           file://0001-Relax-pyelftools-dependency.patch \
+           file://0001-fTPM-add-go_idle-support.patch \
 "
 S =        "${UNPACKDIR}/ts"

--- a/meta-arm/recipes-security/trusted-services/ts-ms-tpm20-ref_git.inc
+++ b/meta-arm/recipes-security/trusted-services/ts-ms-tpm20-ref_git.inc
@@ -0,0 +1,16 @@
+SUMMARY = "ms-tpm20-ref for Trusted Services"
+
+SRC_URI_MS_TPM20_REF = "git://github.com/microsoft/ms-tpm-20-ref;protocol=https;branch=v1.83"
+
+SRCREV_ms-tpm-20-ref = "e9fc7b89d865536c46deb63f9c7d0121a3ded49c"
+
+LIC_FILES_CHKSUM += "file://ts-external/mstpm/LICENSE;md5=5a3925ece0806073ae9ebbb08ff6f11e"
+
+EXTRA_OECMAKE += "-DMS_TPM_SOURCE_DIR=${S}/ts-external/mstpm"
+
+SRC_URI += "${SRC_URI_MS_TPM20_REF};name=ms-tpm-20-ref;destsuffix=ts/ts-external/mstpm \
+"
+
+do_apply_local_src_patches:append() {
+     apply_local_src_patches ${S}/external/ms_tpm ${S}/ts-external/mstpm
+}
--- a/meta-arm/recipes-security/trusted-services/ts-sp-ftpm_git.bb
+++ b/meta-arm/recipes-security/trusted-services/ts-sp-ftpm_git.bb
@@ -0,0 +1,9 @@
+DESCRIPTION = "Trusted Services Firmware Trusted Platform Module (fTPM) service provider"
+
+require ts-sp-common.inc
+require ts-ms-tpm20-ref_git.inc
+
+SP_UUID = "${TS_FTPM_UUID}"
+TS_SP_FTPM_CONFIG ?= "default"
+
+OECMAKE_SOURCEPATH = "${S}/deployments/ftpm/config/${TS_SP_FTPM_CONFIG}-${TS_ENV}"
--- a/meta-arm/recipes-security/trusted-services/ts-uuid.inc
+++ b/meta-arm/recipes-security/trusted-services/ts-uuid.inc
@@ -14,3 +14,4 @@ SPM_TEST4_UUID   = "423762ed-7772-406f-99d8-0c27da0abbf8"
 FWU_UUID         = "6823a838-1b06-470e-9774-0cce8bfb53fd"
 BLOCK_STORAGE_UUID = "63646e80-eb52-462f-ac4f-8cdf3987519c"
 LOGGING_SP_UUID  = "da9dffbd-d590-40ed-975f-19c65a3d52d3"
+TS_FTPM_UUID     = "17b862a4-1806-4faf-86b3-089a58353861"