OP-TEE I2C trampoline and associated tests
Subsystems (2)
v8 cover OP-TEE I2C trampoline and associated tests
From: Igor Opaniuk <[email protected]>
This patchset allows OP-TEE to communicate with I2C devices; a typical use case would be servicing U-Boot requests that require underlying cryptographic operations implemented by an I2C chip.
On a board fitted with the NXP SE050 I2C secure element, OP-TEE can route some of the cryptographic operations it needs to that device (ie RSA, ECC, CTR..).
Before the REE executes, OP-TEE would use its own I2C drivers to communicate with the device on the bus; later on, once the REE is up, accesses to the I2C bus should be coordinated with the REE to avoid collisions. However instead of implementing such a synchronization mechanism, this trampoline service permits OP-TEE to route those I2C requests back to U-boot without then having to worry about collisions.
Lets suppose that U-Boot executes the trusted application Android Verified Boot; when OP-TEE receives the request - and before executing the application - it uses RSA to verify it. So on the back of the TA function invocation, OP-TEE returns to U-boot with a sequence of RPC calls requesting I2C transfers (check carefully the implementation in do_call_with_arg(...) implemented in drivers/tee/optee/core.c and notice the while loop)
When using sandbox testing, RPC is called directly to validate its actual implementation; however as succintly described above, these calls will always be originated in OP-TEE.
Changes v8:
* [Etienne Carriere] extended TA param description (missed one param)
Changes v7:
* [Etienne Carriere] extended TA param description, adding info about i2c xfer flags. Applied A-b and R-b tags
* [Jens Wiklander] applied R-b tag
Changes v6:
* [Etienne Carriere] fixed func return code handling
* [Etienne Carriere] tee_optee_ta_uuid passing a pointer instead of full struct
* [Etienne Carriere] pass additionally i2c control flags in tests
* Fixed mispelling in the comments
Changes v5:
* [Jens Wiklander] Addressed comment about optee_alloc_and_init_page_list():
drop inline, proper return value and comment
Changes v4:
* [Simon Glass] Reduced amount ifdefs warnings and move to if (IS_ENABLED(CONFIG_*)) where possible
* Fixed pointer-sign warnings
Changes v3:
* [Simon Glass] Added RPC I2C test coverage
Changes v2:
* [Simon Glass] Adjusted the usage of DM internal api (dev_get_parent_platdata)
* [Simon Glass] Added additional comments to functions
* [Jens Wiklander] s/tmem/rmem/g
Igor Opaniuk (3):
test: py: add pygit2 and pyelftools to requirements.txt
drivers: tee: sandbox: add rpc test ta emulation
test: dm: tee: extend with RPC test
Jorge Ramirez-Ortiz (1):
drivers: tee: i2c trampoline driver
drivers/tee/Makefile | 2 + drivers/tee/optee/Kconfig | 9 ++ drivers/tee/optee/Makefile | 1 + drivers/tee/optee/i2c.c | 90 ++++++++++++++ drivers/tee/optee/optee_msg.h | 21 ++++ drivers/tee/optee/optee_msg_supplicant.h | 5 + drivers/tee/optee/optee_private.h | 17 +++ drivers/tee/optee/supplicant.c | 3 + drivers/tee/sandbox.c | 142 ++++++++++++++++++++++- include/tee/optee_ta_rpc_test.h | 30 +++++ test/dm/tee.c | 116 ++++++++++++++++-- test/py/requirements.txt | 2 + 12 files changed, 427 insertions(+), 11 deletions(-) create mode 100644 drivers/tee/optee/i2c.c create mode 100644 include/tee/optee_ta_rpc_test.h
Signature · 1 line
2.25.1
PATCH v8 1/4 drivers: tee: i2c trampoline driver
From: Jorge Ramirez-Ortiz <[email protected]>
This commit gives the secure world access to the I2C bus so it can communicate with I2C slaves (typically those would be secure elements like the NXP SE050).
A similar service implementation has been merged in linux:c05210ab ("drivers: optee: allow op-tee to access devices on the i2c bus")
---
drivers/tee/optee/Makefile | 1 + drivers/tee/optee/i2c.c | 90 ++++++++++++++++++++++++ drivers/tee/optee/optee_msg.h | 21 ++++++ drivers/tee/optee/optee_msg_supplicant.h | 5 ++ drivers/tee/optee/optee_private.h | 17 +++++ drivers/tee/optee/supplicant.c | 3 + 6 files changed, 137 insertions(+) create mode 100644 drivers/tee/optee/i2c.c
drivers/tee/optee/Makefile +1 -0
@@ -2,4 +2,5 @@ obj-y += core.o obj-y += supplicant.o +obj-$(CONFIG_DM_I2C) += i2c.o obj-$(CONFIG_SUPPORT_EMMC_RPMB) += rpmb.o
drivers/tee/optee/i2c.c new file +90 -0
90 lines not on this page · raw message
drivers/tee/optee/optee_msg.h +21 -0
@@ -422,4 +422,25 @@ struct optee_msg_arg {*/ #define OPTEE_MSG_RPC_CMD_SHM_FREE 7 +/* +* Access a device on an i2c bus +* +* [in] param[0].u.value.a mode: RD(0), WR(1) +* [in] param[0].u.value.b i2c adapter +* [in] param[0].u.value.c i2c chip +* +* [in] param[1].u.value.a i2c control flags +* +* [in/out] memref[2] buffer to exchange the transfer data +* with the secure world +* +* [out] param[3].u.value.a bytes transferred by the driver +*/ +#define OPTEE_MSG_RPC_CMD_I2C_TRANSFER 21 +/* I2C master transfer modes */ +#define OPTEE_MSG_RPC_CMD_I2C_TRANSFER_RD 0 +#define OPTEE_MSG_RPC_CMD_I2C_TRANSFER_WR 1 +/* I2C master control flags */ +#define OPTEE_MSG_RPC_CMD_I2C_FLAGS_TEN_BIT BIT(0) +#endif /* _OPTEE_MSG_H */
drivers/tee/optee/optee_msg_supplicant.h +5 -0
@@ -147,6 +147,11 @@#define OPTEE_MSG_RPC_CMD_SHM_ALLOC 6#define OPTEE_MSG_RPC_CMD_SHM_FREE 7 +/* +* I2C bus access +*/ +#define OPTEE_MSG_RPC_CMD_I2C_TRANSFER 21 +/* * Was OPTEE_MSG_RPC_CMD_SQL_FS, which isn't supported any longer */
drivers/tee/optee/optee_private.h +17 -0
@@ -60,6 +60,23 @@ static inline void optee_suppl_rpmb_release(struct udevice *dev) }#endif +#ifdef CONFIG_DM_I2C +/** +* optee_suppl_cmd_i2c_transfer() - route I2C requests to an I2C chip +* @arg: OP-TEE message (layout specified in optee_msg.h) defining the +* transfer mode (read/write), adapter, chip and control flags. +* +* Handles OP-TEE requests to transfer data to the I2C chip on the I2C adapter. +*/ +void optee_suppl_cmd_i2c_transfer (struct optee_msg_arg *arg); +#else +static inline void optee_suppl_cmd_i2c_transfer (struct optee_msg_arg *arg) +{ +debug ("OPTEE_MSG_RPC_CMD_I2C_TRANSFER not implemented\n" ); + arg->ret =TEE_ERROR_NOT_IMPLEMENTED ; +} +#endif +void *optee_alloc_and_init_page_list (void *buf,ulong len,u64 *phys_buf_ptr);#endif /* __OPTEE_PRIVATE_H */
drivers/tee/optee/supplicant.c +3 -0
@@ -89,6 +89,9 @@ void optee_suppl_cmd(struct udevice *dev, struct tee_shm *shm_arg,case OPTEE_MSG_RPC_CMD_RPMB :optee_suppl_cmd_rpmb (dev, arg);break ; +case OPTEE_MSG_RPC_CMD_I2C_TRANSFER : +optee_suppl_cmd_i2c_transfer (arg); +break ;default : arg->ret =TEE_ERROR_NOT_IMPLEMENTED ; }
Signature · 1 line
2.25.1
PATCH v8 1/4 drivers: tee: i2c trampoline driver
Quoted 6 lines · Igor Opaniuk
From: Jorge Ramirez-Ortiz <[email protected]>
This commit gives the secure world access to the I2C bus so it can communicate with I2C slaves (typically those would be secure elements like the NXP SE050).
Quoted 7 lines
A similar service implementation has been merged in linux:
c05210ab("drivers: optee: allow op-tee to access devices on the i2c bus")Signed-off-by Jorge Ramirez-Ortiz <[email protected]>Reviewed-by Simon Glass <[email protected]>Reviewed-by Etienne Carriere <[email protected]>
Applied to u-boot/master, thanks!
Signature · 8 lines
Tom -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 659 bytes Desc: not available URL: <https://lists.denx.de/pipermail/u-boot/attachments/20210216/d3ae0f86/attachment.sig>
PATCH v8 2/4 test: py: add pygit2 and pyelftools to requirements.txt
In reply to Igor OpaniukFrom: Igor Opaniuk <[email protected]>
Add pygit2 and pyelftools to the list of packages for virtualenv needed to run all sets of pytests.This fixes warnings like:
binman.elf_test.TestElf.testDecodeElf (subunit.RemotedTestCase):
Python elftools not available
---
test/py/requirements.txt | 2 ++ 1 file changed, 2 insertions(+)
test/py/requirements.txt +2 -0
@@ -10,6 +10,8 @@ packaging==19.2 pbr==5.4.3 pluggy==0.13.0 py==1.8.0 +pyelftools==0.27 +pygit2==1.4.0 pyparsing==2.4.2 pytest==5.2.1 python-mimeparse==1.6.0
Signature · 1 line
2.25.1
PATCH v8 2/4 test: py: add pygit2 and pyelftools to requirements.txt
Quoted 10 lines · Igor Opaniuk
From: Igor Opaniuk <[email protected]>
Add pygit2 and pyelftools to the list of packages for virtualenv needed to run all sets of pytests.This fixes warnings like:
binman.elf_test.TestElf.testDecodeElf (subunit.RemotedTestCase):
Python elftools not availableSigned-off-by Igor Opaniuk <[email protected]>Reviewed-by Simon Glass <[email protected]>
Applied to u-boot/master, thanks!
Signature · 8 lines
Tom -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 659 bytes Desc: not available URL: <https://lists.denx.de/pipermail/u-boot/attachments/20210216/2c4a17ef/attachment.sig>
PATCH v8 3/4 drivers: tee: sandbox: add rpc test ta emulation
In reply to Igor OpaniukFrom: Igor Opaniuk <[email protected]>
This adds support for RPC test trusted application emulation, which permits to test reverse RPC calls to TEE supplicant. Currently it covers requests to the I2C bus from TEE.
---
drivers/tee/Makefile | 2 + drivers/tee/optee/Kconfig | 9 ++ drivers/tee/sandbox.c | 142 +++++++++++++++++++++++++++++++- include/tee/optee_ta_rpc_test.h | 30 +++++++ 4 files changed, 179 insertions(+), 4 deletions(-) create mode 100644 include/tee/optee_ta_rpc_test.h
drivers/tee/Makefile +2 -0
@@ -2,5 +2,7 @@ obj-y += tee-uclass.o obj-$(CONFIG_SANDBOX) += sandbox.o +obj-$(CONFIG_OPTEE_TA_RPC_TEST) += optee/supplicant.o +obj-$(CONFIG_OPTEE_TA_RPC_TEST) += optee/i2c.o obj-$(CONFIG_OPTEE) += optee/ obj-y += broadcom/
drivers/tee/optee/Kconfig +9 -0
@@ -22,6 +22,15 @@ config OPTEE_TA_AVB The TA can support the "avb" subcommands "read_rb", "write"rb" and "is_unlocked". +config OPTEE_TA_RPC_TEST + bool "Support RPC TEST TA" + depends on SANDBOX_TEE + default y + help + Enables support for RPC test trusted application emulation, which + permits to test reverse RPC calls to TEE supplicant. Should + be used only in sandbox env. + endmenu endif
drivers/tee/sandbox.c +138 -4
175 lines not on this page · raw message
include/tee/optee_ta_rpc_test.h new file +30 -0
@@ -0,0 +1,30 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ +/* Copyright (c) 2020 Foundries Ltd */ + +#ifndef __TA_RPC_TEST_H +#define __TA_RPC_TEST_H + +#define TA_RPC_TEST_UUID { 0x48420575, 0x96ca, 0x401a, \ + { 0x89, 0x91, 0x1e, 0xfd, 0xce, 0xbd, 0x7d, 0x04 } } + +/* +* Does a reverse RPC call for I2C read +* +* in params[0].value.a: bus number +* in params[0].value.b: chip address +* in params[0].value.c: control flags +* inout params[1].u.memref: buffer to read data +*/ +#define TA_RPC_TEST_CMD_I2C_READ 0 + +/* +* Does a reverse RPC call for I2C write +* +* in params[0].value.a: bus number +* in params[0].value.b: chip address +* in params[0].value.c: control flags +* inout params[1].u.memref: buffer with data to write +*/ +#define TA_RPC_TEST_CMD_I2C_WRITE 1 + +#endif /* __TA_RPC_TEST_H */
Signature · 1 line
2.25.1
PATCH v8 3/4 drivers: tee: sandbox: add rpc test ta emulation
Quoted 10 lines · Igor Opaniuk
From: Igor Opaniuk <[email protected]>
This adds support for RPC test trusted application emulation, which permits to test reverse RPC calls to TEE supplicant. Currently it covers requests to the I2C bus from TEE.
Signed-off-by Igor Opaniuk <[email protected]>Reviewed-by Simon Glass <[email protected]>Reviewed-by Jens Wiklander <[email protected]>Acked-by Etienne Carriere <[email protected]>
Applied to u-boot/master, thanks!
Signature · 8 lines
Tom -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 659 bytes Desc: not available URL: <https://lists.denx.de/pipermail/u-boot/attachments/20210216/02b77611/attachment.sig>
PATCH v8 4/4 test: dm: tee: extend with RPC test
In reply to Igor OpaniukFrom: Igor Opaniuk <[email protected]>
Extend existing DM tee tests adding test coverage for reverse RPC calls. Currently this commit only adds tests for I2C requests from TEE driver to TEE supplicant, for instance reading/writing data to emulated i2c eeprom defines in standard sandbox test device tree (arch/sandbox/dts/test.dtb):
=> i2c bus
Bus 0: i2c at 0 (active 0)
2c: eeprom at 2c, offset len 1, flags 0
...
Running TEE tests:
=> ut dm tee
Test: dm_test_tee: tee.c
Test: dm_test_tee: tee.c (flat tree)
Failures: 0
---
test/dm/tee.c | 116 +++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 109 insertions(+), 7 deletions(-)
test/dm/tee.c +109 -7
@@ -13,15 +13,16 @@#include <test/test.h> #include <test/ut.h> #include <tee/optee_ta_avb.h> +#include <tee/optee_ta_rpc_test.h> -static int open_session (struct udevice *dev,u32 *session) +static int open_session (struct udevice *dev,u32 *session, +struct tee_optee_ta_uuid *uuid) {struct tee_open_session_arg arg; -const struct tee_optee_ta_uuid uuid =TA_AVB_UUID ;int rc;memset (&arg,0 ,sizeof (arg)); -tee_optee_ta_uuid_to_octets (arg.uuid, &uuid); +tee_optee_ta_uuid_to_octets (arg.uuid, uuid); rc =tee_open_session (dev, &arg,0 ,NULL );if (rc)return rc;
@@ -32,7 +33,7 @@ static int open_session(struct udevice *dev, u32 *session)return 0 ; } -static int invoke_func (struct udevice *dev,u32 session) +static int invoke_func_avb (struct udevice *dev,u32 session) {struct tee_param param = { .attr =TEE_PARAM_ATTR_TYPE_VALUE_OUTPUT };struct tee_invoke_arg arg;
@@ -47,6 +48,48 @@ static int invoke_func(struct udevice *dev, u32 session)return 0 ; } +static int invoke_func_rpc_test (struct udevice *dev,u32 session, +u64 op,u64 busnum,u64 chip_addr, +u64 xfer_flags,u8 *buf,size_t buf_size) +{ +struct tee_param param[2 ]; +struct tee_invoke_arg arg; +struct tee_shm *shm_buf; +int rc; + +memset (&arg,0 ,sizeof (arg)); + arg.session = session; + arg.func = op; + + rc =tee_shm_alloc (dev, buf_size, +TEE_SHM_ALLOC , &shm_buf); +if (rc) +return rc; + +if (op ==TA_RPC_TEST_CMD_I2C_WRITE ) +memcpy (shm_buf->addr, buf, buf_size); + +memset (param,0 ,sizeof (param)); + param[0 ].attr =TEE_PARAM_ATTR_TYPE_VALUE_INPUT ; + param[0 ].u.value.a = busnum; + param[0 ].u.value.b = chip_addr; + param[0 ].u.value.c = xfer_flags; + param[1 ].attr =TEE_PARAM_ATTR_TYPE_MEMREF_INOUT ; + param[1 ].u.memref.shm = shm_buf; + param[1 ].u.memref.size = buf_size; + +if (tee_invoke_func (dev, &arg,2 , param) || arg.ret) { + rc =-1 ; + goto out; + } + +if (op ==TA_RPC_TEST_CMD_I2C_READ ) +memcpy (buf, shm_buf->addr, buf_size); +out: +tee_shm_free (shm_buf); +return rc; +} +static int match (struct tee_version_data *vers,const void *data) {return vers->gen_caps &TEE_GEN_CAP_GP ;
@@ -62,6 +105,7 @@ static int test_tee(struct unit_test_state *uts, struct test_tee_vars *vars)struct tee_version_data vers;struct udevice *dev;struct sandbox_tee_state *state; +struct tee_optee_ta_uuid avb_uuid =TA_AVB_UUID ;u32 session =0 ;int rc;u8 data[128 ];
@@ -71,11 +115,11 @@ static int test_tee(struct unit_test_state *uts, struct test_tee_vars *vars) state =dev_get_priv (dev);ut_assert (!state->session); - rc =open_session (dev, &session); + rc =open_session (dev, &session, &avb_uuid);ut_assert (!rc);ut_assert (session == state->session); - rc =invoke_func (dev, session); + rc =invoke_func_avb (dev, session);ut_assert (!rc); rc =tee_close_session (dev, session);
@@ -100,7 +144,59 @@ static int test_tee(struct unit_test_state *uts, struct test_tee_vars *vars) vars->alloc_shm =NULL ;ut_assert (!state->num_shms); -return 0 ; +return rc; +} + +#define I2C_BUF_SIZE 64 + +static int test_tee_rpc (struct unit_test_state *uts) +{ +struct tee_version_data vers; +struct udevice *dev; +struct sandbox_tee_state *state; +struct tee_optee_ta_uuid rpc_test_uuid =TA_RPC_TEST_UUID ; +u32 session =0 ; +int rc; + +char *test_str ="Test string" ; +u8 data[I2C_BUF_SIZE ] = {0 }; +u8 data_from_eeprom[I2C_BUF_SIZE ] = {0 }; + +/* Use sandbox I2C EEPROM emulation; bus: 0, chip: 0x2c */ +u64 bus =0 ; +u64 chip =0x2c ; +u64 xfer_flags =0 ; + + dev =tee_find_device (NULL , match,NULL , &vers); +ut_assert (dev); + state =dev_get_priv (dev); +ut_assert (!state->session); + +/* Test RPC call asking for I2C service */ + rc =open_session (dev, &session, &rpc_test_uuid); +ut_assert (!rc); +ut_assert (session == state->session); + +/* Write buffer */ +strncpy ((char *)data, test_str,strlen (test_str)); + rc =invoke_func_rpc_test (dev, session,TA_RPC_TEST_CMD_I2C_WRITE , + bus, chip, xfer_flags, data,sizeof (data)); +ut_assert (!rc); + +/* Read buffer */ + rc =invoke_func_rpc_test (dev, session,TA_RPC_TEST_CMD_I2C_READ , + bus, chip, xfer_flags, data_from_eeprom, +sizeof (data_from_eeprom)); +ut_assert (!rc); + +/* Compare */ +ut_assert (!memcmp (data, data_from_eeprom,sizeof (data))); + + rc =tee_close_session (dev, session); +ut_assert (!rc); +ut_assert (!state->session); + +return rc; }static int dm_test_tee (struct unit_test_state *uts)
@@ -108,6 +204,12 @@ static int dm_test_tee(struct unit_test_state *uts)struct test_tee_vars vars = {NULL ,NULL };int rc =test_tee (uts, &vars); +if (rc) + goto out; + +if (IS_ENABLED (CONFIG_OPTEE_TA_RPC_TEST )) + rc =test_tee_rpc (uts); +out:/* In case test_tee() asserts these may still remain allocated */ tee_shm_free (vars.reg_shm);tee_shm_free (vars.alloc_shm);
Signature · 1 line
2.25.1
PATCH v8 4/4 test: dm: tee: extend with RPC test
Quoted 19 lines · Igor Opaniuk
From: Igor Opaniuk <[email protected]>
Extend existing DM tee tests adding test coverage for reverse RPC calls. Currently this commit only adds tests for I2C requests from TEE driver to TEE supplicant, for instance reading/writing data to emulated i2c eeprom defines in standard sandbox test device tree (
arch/sandbox/dts/test.dtb):=> i2c bus
Bus 0: i2c at 0 (active 0)
2c: eeprom at 2c, offset len 1, flags 0
...Running TEE tests:
=> ut dm tee
Test:dm_test_tee:tee.c
Test:dm_test_tee:tee.c(flat tree)
Failures: 0
Quoted 3 lines
Signed-off-by Igor Opaniuk <[email protected]>Reviewed-by Simon Glass <[email protected]>Acked-by Etienne Carriere <[email protected]>
Applied to u-boot/master, thanks!
Signature · 8 lines
Tom -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 659 bytes Desc: not available URL: <https://lists.denx.de/pipermail/u-boot/attachments/20210216/52b28c88/attachment.sig>