ufs: rpmb: route OP-TEE RPMB secure storage over UFS
Subsystems (3)
v3 cover ufs: rpmb: route OP-TEE RPMB secure storage over UFS
OP-TEE secure storage (CFG_RPMB_FS) relies on an RPMB partition, but U-Boot's OP-TEE RPMB supplicant only speaks the legacy single-command interface, which is bound to eMMC. SoCs that are UFS-only and have no eMMC (for example the Qualcomm SA8775P) therefore cannot back OP-TEE secure storage from U-Boot today. This series adds that support.
It introduces the transport-agnostic OP-TEE RPMB "subsystem" interface (PROBE_RESET / PROBE_NEXT / FRAMES), where the normal world enumerates the RPMB device and reports its kind, size and CID, then carries the signed frames. The legacy eMMC supplicant is preserved unchanged, only renamed to rpmb_emmc.c, with the new UFS backend added as a separate rpmb_ufs.c; the two are mutually exclusive via Kconfig (SUPPORT_UFS_RPMB depends on !SUPPORT_EMMC_RPMB) because the OP-TEE supplicant handles a single RPMB transport. The subsystem interface is UFS-only for now; eMMC can be migrated onto it later as the legacy path is retired.
On top of that it adds a UFS RPMB transport that moves JEDEC RPMB frames to and from the RPMB Well-Known LUN using SCSI SECURITY PROTOCOL IN/OUT. The per-region 16-byte CID is derived by BLAKE2b-hashing the exact device-id string the Linux kernel builds (ufshcd_create_device_id() plus a "-R<region>" suffix), so OP-TEE derives an RPMB key that matches the one Linux would use.
The first patch is a standalone UFS descriptor fix the RPMB path depends on (UTF-16BE string decoding); the transport patches also include a power-on UNIT ATTENTION retry and a DMA-alignment bounce for the RPMB WLUN.
Note: reading UFS descriptors reliably also requires the descriptor data-segment cache-invalidation fix, which has already been posted and merged separately, so this series is based on top of it.
Tested on the Qualcomm IQ-9075-EVK (SA8775P): OP-TEE with CFG_RPMB_FS programs the RPMB key through U-Boot and reads/writes secure-storage objects, with the derived CID matching the Linux UFS device_id ABI.
Dependencies:
Linux kernel:
https://lore.kernel.org/linux-scsi/[email protected]/
Op-tee
https://github.com/OP-TEE/optee_os/pull/7881
v3:
- Renamed the legacy eMMC supplicant to rpmb_emmc.c (was rpmb_legacy.c) and kept it as a pure 100% rename: the UFS RPMB subsystem backend now lives in its own rpmb_ufs.c instead of being folded into rpmb.c, so the eMMC path is left byte-for-byte unchanged.
- Added CONFIG_UFS_RPMB_CONTROLLER to select the RPMB-owning UFS controller on boards with more than one UFS controller.
- Reworked the commit messages to lead with the motivation rather than the implementation detail.
v2:
- Squashed the standalone "retry SECURITY PROTOCOL on power-on UNIT ATTENTION" and "bounce unaligned frames through a DMA-aligned buffer" patches into the UFS RPMB transport patch; the series is now 5 patches.
- Reused the existing ufshcd_read_desc_param() (now exported) for all descriptor reads instead of adding a new ufshcd_read_descriptor() wrapper.
- Moved the SECURITY PROTOCOL IN/OUT opcodes to the generic SCSI header as SCSI_SECURITY_PROTOCOL_IN/OUT instead of private UFS defines.
- Factored the UTF-16BE string-descriptor byte-swap into a ufshcd_str_desc_to_cpu() helper.
- Dropped the ufs_rpmb_get_scsi_dev() wrapper; callers now use uclass_get_device(UCLASS_SCSI, ...) directly.
Jorge Ramirez-Ortiz (5):
ufs: decode string descriptors as UTF-16 big-endian
ufs: add RPMB transport over SCSI SECURITY PROTOCOL
ufs: derive the per-region RPMB CID and size for OP-TEE
optee: rename rpmb.c to rpmb_emmc.c
optee: implement the RPMB subsystem interface for UFS
drivers/tee/optee/Makefile | 3 +-
drivers/tee/optee/optee_msg_supplicant.h | 8 +
drivers/tee/optee/optee_private.h | 41 +++
drivers/tee/optee/{rpmb.c => rpmb_emmc.c} | 0
drivers/tee/optee/rpmb_ufs.c | 141 ++++++++++
drivers/tee/optee/supplicant.c | 9 +
drivers/ufs/Kconfig | 21 ++
drivers/ufs/Makefile | 1 +
drivers/ufs/ufs-rpmb.c | 321 ++++++++++++++++++++++
drivers/ufs/ufs-uclass.c | 21 +-
drivers/ufs/ufs.h | 7 +
include/scsi.h | 2 +
include/ufs.h | 10 +
13 files changed, 581 insertions(+), 4 deletions(-)
rename drivers/tee/optee/{rpmb.c => rpmb_emmc.c} (100%)
create mode 100644 drivers/tee/optee/rpmb_ufs.c
create mode 100644 drivers/ufs/ufs-rpmb.cbase-commit: ece349ade2973e220f524ce59e59711cc919263f
Signature · 1 line
2.54.0
PATCH v3 1/5 ufs: decode string descriptors as UTF-16 big-endian
UFS string descriptors are UTF-16 big-endian (JESD220), but ufshcd_read_string_desc() fed the raw bytes to utf16_to_utf8(), which reads host-endian code units, leaving dev_desc->model blank. Byte-swap to host order before decoding, matching the kernel.
--- drivers/ufs/ufs-uclass.c | 15 +++++++++++++++ 1 file changed, 15 insertions(+)
drivers/ufs/ufs-uclass.c +15 -0
@@ -1533,6 +1533,19 @@ static inline void ufshcd_remove_non_printable(uint8_t *val) *val =' ' ; } +static inline void ufshcd_str_desc_to_cpu (u8 *desc,u32 size) +{ +u16 *p = (u16 *)&desc[QUERY_DESC_HDR_SIZE ]; +u32 len = desc[QUERY_DESC_LENGTH_OFFSET ]; +u32 i; + +if (len > size) + len = size; + +for (i =QUERY_DESC_HDR_SIZE ; i +1 < len; i +=2 , p++) + *p =be16_to_cpu (*p); +} +/** * ufshcd_uic_pwr_ctrl - executes UIC commands (which affects the link power * state) and waits for it to take effect.
@@ -1765,6 +1778,8 @@ static int ufshcd_read_string_desc(struct ufs_hba *hba, int desc_index, goto out; } +ufshcd_str_desc_to_cpu (buf, size); +/* * the descriptor contains string in UTF16 format * we need to convert to utf-8 so it can be displayed
Signature · 1 line
2.54.0
Re: [PATCH v3 1/5] ufs: decode string descriptors as UTF-16 big-endian
Quoted 19 lines · Jorge Ramirez-Ortiz
UFS string descriptors are UTF-16 big-endian (JESD220), but
ufshcd_read_string_desc()fed the raw bytes toutf16_to_utf8(), which reads host-endian code units, leavingdev_desc->modelblank. Byte-swap to host order before decoding, matching the kernel.Signed-off-by Jorge Ramirez-Ortiz <[email protected]>--- drivers/ufs/ufs-uclass.c | 15 +++++++++++++++ 1 file changed, 15 insertions(+)drivers/ufs/ufs-uclass.c +1
-0@@ -1533,6 +1533,19 @@ static inline void ufshcd_remove_non_printable(uint8_t *val) *val =' ' ; } +static inline void ufshcd_str_desc_to_cpu (u8 *desc,u32 size)
drivers/ufs/ufs-uclass.c static inline void ufshcd_remove_non_printable(uint8_t *val) · line 1546
Quoted 10 lines
drivers/ufs/ufs-uclass.c +10
-0+{ +u16 *p = (u16 *)&desc[QUERY_DESC_HDR_SIZE ]; +u32 len = desc[QUERY_DESC_LENGTH_OFFSET ]; +u32 i; + +if (len > size) + len = size; + +for (i =QUERY_DESC_HDR_SIZE ; i +1 < len; i +=2 , p++) + *p =be16_to_cpu (*p);
I'm not a huge fan of modifying data in place like this. What do people think about adding an endian parameter to utf16_to_utf8() instead?
Quoted 14 lines
drivers/ufs/ufs-uclass.c +4
-0+} +/** * ufshcd_uic_pwr_ctrl - executes UIC commands (which affects the link power * state) and waits for it to take effect. @@ -1765,6 +1778,8 @@ static int ufshcd_read_string_desc(struct ufs_hba *hba, int desc_index, goto out; } +ufshcd_str_desc_to_cpu (buf, size); +/* * the descriptor contains string in UTF16 format * we need to convert to utf-8 so it can be displayed
PATCH v3 2/5 ufs: add RPMB transport over SCSI SECURITY PROTOCOL
In reply to Jorge Ramirez-Ortiz via U-BootOP-TEE secure storage (CFG_RPMB_FS) requires RPMB, but on UFS-only platforms with no eMMC the OP-TEE RPMB supplicant has no way to reach the device's RPMB Well-Known LUN, which UFS exposes through SCSI SECURITY PROTOCOL IN/OUT commands rather than an eMMC-style RPMB partition; this transport provides that missing path so RPMB-backed secure storage works on UFS-based platforms.
--- drivers/ufs/Kconfig | 10 +++ drivers/ufs/Makefile | 1 + drivers/ufs/ufs-rpmb.c | 173 +++++++++++++++++++++++++++++++++++++++ drivers/ufs/ufs-uclass.c | 6 +- drivers/ufs/ufs.h | 7 ++ include/scsi.h | 2 + include/ufs.h | 4 + 7 files changed, 200 insertions(+), 3 deletions(-) create mode 100644 drivers/ufs/ufs-rpmb.c
drivers/ufs/Kconfig +10 -0
@@ -92,4 +92,14 @@ config UFS_TI_J721E This selects the glue layer driver for Cadence controller present on TI's J721E devices. +config SUPPORT_UFS_RPMB + bool "Enable UFS RPMB (Replay Protected Memory Block) support" + depends on UFS && OPTEE && !SUPPORT_EMMC_RPMB + help + Route OP-TEE RPMB requests to the UFS RPMB Well-Known LUN using + SCSI SECURITY PROTOCOL IN/OUT commands. Required for OP-TEE secure + storage (CFG_RPMB_FS) on UFS-based platforms that have no eMMC. + The OP-TEE supplicant handles a single RPMB transport, so this is + mutually exclusive with the eMMC RPMB supplicant (SUPPORT_EMMC_RPMB). + endmenu
drivers/ufs/Makefile +1 -0
@@ -13,3 +13,4 @@ obj-$(CONFIG_UFS_RENESAS) += ufs-renesas.o obj-$(CONFIG_UFS_RENESAS_GEN5) += ufs-renesas-rcar-gen5.o obj-$(CONFIG_UFS_ROCKCHIP) += ufs-rockchip.o obj-$(CONFIG_UFS_TI_J721E) += ti-j721e-ufs.o +obj-$(CONFIG_SUPPORT_UFS_RPMB) += ufs-rpmb.o
drivers/ufs/ufs-rpmb.c new file +173 -0
173 lines not on this page · raw message
drivers/ufs/ufs-uclass.c +3 -3
@@ -1457,9 +1457,9 @@ static int ufshcd_map_desc_id_to_length(struct ufs_hba *hba, enum desc_idn desc_* ufshcd_read_desc_param - read the specified descriptor parameter * */ -static int ufshcd_read_desc_param (struct ufs_hba *hba,enum desc_idn desc_id, -int desc_index,u8 param_offset, -u8 *param_read_buf,u8 param_size) +int ufshcd_read_desc_param (struct ufs_hba *hba,enum desc_idn desc_id, +int desc_index,u8 param_offset, +u8 *param_read_buf,u8 param_size) {int ret;u8 *desc_buf;
drivers/ufs/ufs.h +7 -0
@@ -10,6 +10,9 @@struct udevice ;#define UFS_CDB_SIZE 16 + +#define UFS_UPIU_RPMB_WLUN 0xC4 +#define UPIU_TRANSACTION_UIC_CMD 0x1F#define UIC_CMD_SIZE (sizeof(u32) * 4)#define RESPONSE_UPIU_SENSE_DATA_LENGTH 18
@@ -809,4 +812,8 @@ static inline void ufshcd_rmwl(struct ufs_hba *hba, u32 mask, u32 val, u32 reg)int ufshcd_probe (struct udevice *dev,struct ufs_hba_ops *hba_ops); +int ufshcd_read_desc_param (struct ufs_hba *hba,enum desc_idn desc_id, +int desc_index,u8 param_offset,u8 *param_read_buf, +u8 param_size); +#endif
include/scsi.h +2 -0
@@ -183,6 +183,8 @@ struct scsi_cmd {#define SCSI_WRITE_LONG 0x3F/* Write Long (O) */ #define SCSI_WRITE_SAME 0x41/* Write Same (O) */ #define SCSI_UNMAP 0x42/* Write 10-Byte (MANDATORY) */ +#define SCSI_SECURITY_PROTOCOL_IN 0xA2/* Security Protocol In (O) */ +#define SCSI_SECURITY_PROTOCOL_OUT 0xB5/* Security Protocol Out (O) */ /** * enum scsi_cmd_phase - current phase of the SCSI protocol
include/ufs.h +4 -0
@@ -20,4 +20,8 @@ int ufs_probe(void);*/ int ufs_probe_dev (int index); +int ufs_rpmb_route_frames (struct udevice *scsi_dev,unsigned int region, +void *req,unsigned long reqlen,void *rsp, +unsigned long rsplen); +#endif
Signature · 1 line
2.54.0
Re: [PATCH v3 2/5] ufs: add RPMB transport over SCSI SECURITY PROTOCOL
Quoted 77 lines · Jorge Ramirez-Ortiz
OP-TEE secure storage (
CFG_RPMB_FS) requires RPMB, but on UFS-only platforms with no eMMC the OP-TEE RPMB supplicant has no way to reach the device's RPMB Well-Known LUN, which UFS exposes through SCSI SECURITY PROTOCOL IN/OUT commands rather than an eMMC-style RPMB partition; this transport provides that missing path so RPMB-backed secure storage works on UFS-based platforms.Signed-off-by Jorge Ramirez-Ortiz <[email protected]>--- drivers/ufs/Kconfig | 10 +++ drivers/ufs/Makefile | 1 + drivers/ufs/ufs-rpmb.c | 173 +++++++++++++++++++++++++++++++++++++++ drivers/ufs/ufs-uclass.c | 6 +- drivers/ufs/ufs.h | 7 ++ include/scsi.h | 2 + include/ufs.h | 4 + 7 files changed, 200 insertions(+), 3 deletions(-) create mode 100644 drivers/ufs/ufs-rpmb.cdrivers/ufs/Kconfig +10
-0@@ -92,4 +92,14 @@ config UFS_TI_J721E This selects the glue layer driver for Cadence controller present on TI's J721E devices. +config SUPPORT_UFS_RPMB + bool "Enable UFS RPMB (Replay Protected Memory Block) support" + depends on UFS && OPTEE && !SUPPORT_EMMC_RPMB + help + Route OP-TEE RPMB requests to the UFS RPMB Well-Known LUN using + SCSI SECURITY PROTOCOL IN/OUT commands. Required for OP-TEE secure + storage (CFG_RPMB_FS) on UFS-based platforms that have no eMMC. + The OP-TEE supplicant handles a single RPMB transport, so this is + mutually exclusive with the eMMC RPMB supplicant (SUPPORT_EMMC_RPMB). + endmenudrivers/ufs/Makefile +1
-0@@ -13,3 +13,4 @@ obj-$(CONFIG_UFS_RENESAS) += ufs-renesas.o obj-$(CONFIG_UFS_RENESAS_GEN5) += ufs-renesas-rcar-gen5.o obj-$(CONFIG_UFS_ROCKCHIP) += ufs-rockchip.o obj-$(CONFIG_UFS_TI_J721E) += ti-j721e-ufs.o +obj-$(CONFIG_SUPPORT_UFS_RPMB) += ufs-rpmb.odrivers/ufs/ufs-rpmb.c new file +24
-0@@ -0,0 +1,173 @@ +// SPDX-License-Identifier: GPL-2.0+ +#include <dm.h> +#include <log.h> +#include <malloc.h> +#include <scsi.h> +#include <ufs.h> +#include <asm/cache.h> +#include <linux/errno.h> +#include <linux/string.h> +#include "ufs.h" + +#define RPMB_REQ_KEY 1 +#define RPMB_REQ_WCOUNTER 2 +#define RPMB_REQ_WRITE_DATA 3 +#define RPMB_REQ_READ_DATA 4 +#define RPMB_REQ_STATUS 5 + +#define RPMB_FRAME_SIZE 512 +#define RPMB_FRAME_REQ_OFFSET 510 + +#define UFS_RPMB_UA_RETRIES 3 + +#define SEC_PROTOCOL_UFS 0xEC +#define UFS_RPMB_SEC_PROTOCOL_ID 0x01
drivers/ufs/ufs-rpmb.c line 34
Quoted 10 lines
drivers/ufs/ufs-rpmb.c new file +10
-0+ +#define GEOMETRY_DESC_RPMB_RW_SIZE 0x17 + +static u16 rpmb_frame_request (const void *frame) +{ +const u8 *p = frame; + +return ((u16 )p[RPMB_FRAME_REQ_OFFSET ] <<8 ) | + p[RPMB_FRAME_REQ_OFFSET +1 ]; +}
I would drop the function and just use get_unaligned_be16() directly.
Quoted 19 lines
drivers/ufs/ufs-rpmb.c new file +19
-0+ +static int ufs_rpmb_secprot (struct udevice *scsi_dev,unsigned int region, +u8 opcode,void *buf,unsigned int nframes, +enum dma_data_direction dir) +{ +u16 spsp = (region <<8 ) |UFS_RPMB_SEC_PROTOCOL_ID ; +u32 len = nframes *RPMB_FRAME_SIZE ; +struct scsi_cmd pccb; +void *dma_buf = buf; +void *bounce =NULL ; +int retries; +int ret =0 ; + +if (!IS_ALIGNED ((uintptr_t )buf,ARCH_DMA_MINALIGN )) { + bounce =memalign (ARCH_DMA_MINALIGN , +ALIGN (len,ARCH_DMA_MINALIGN )); +if (!bounce) +return -ENOMEM ; + dma_buf = bounce;
drivers/ufs/ufs-rpmb.c line 63
Quoted 10 lines
drivers/ufs/ufs-rpmb.c new file +10
-0+if (dir ==DMA_TO_DEVICE ) +memcpy (bounce, buf, len); + } + +memset (&pccb,0 ,sizeof (pccb)); + pccb.lun =UFS_UPIU_RPMB_WLUN ; + pccb.cmd[0 ] = opcode; + pccb.cmd[1 ] =SEC_PROTOCOL_UFS ; + pccb.cmd[2 ] = (spsp >>8 ) &0xff ; + pccb.cmd[3 ] = spsp &0xff ;
How about using put_unaligned_be16()?
drivers/ufs/ufs-rpmb.c line 69
Quoted 6 lines
drivers/ufs/ufs-rpmb.c new file +6
-0+ pccb.cmd[4 ] =0 ; + pccb.cmd[5 ] =0 ; + pccb.cmd[6 ] = (len >>24 ) &0xff ; + pccb.cmd[7 ] = (len >>16 ) &0xff ; + pccb.cmd[8 ] = (len >>8 ) &0xff ; + pccb.cmd[9 ] = len &0xff ;
And put_unaligned_be32().
Quoted 54 lines
drivers/ufs/ufs-rpmb.c new file +54
-0+ pccb.cmd[10 ] =0 ; + pccb.cmd[11 ] =0 ; + pccb.cmdlen =12 ; + pccb.pdata = dma_buf; + pccb.datalen = len; + pccb.dma_dir = dir; + +for (retries =UFS_RPMB_UA_RETRIES ; retries >0 ; retries--) { + ret =scsi_exec (scsi_dev, &pccb); +if (!ret) +break ; + } + +if (bounce) { +if (!ret && dir ==DMA_FROM_DEVICE ) +memcpy (buf, bounce, len); + +free (bounce); + } + +return ret; +} + +static int ufs_rpmb_send (struct udevice *scsi_dev,unsigned int region, +void *frames,unsigned int nframes) +{ +return ufs_rpmb_secprot (scsi_dev, region,SCSI_SECURITY_PROTOCOL_OUT , + frames, nframes,DMA_TO_DEVICE ); +} + +static int ufs_rpmb_recv (struct udevice *scsi_dev,unsigned int region, +void *frames,unsigned int nframes) +{ +return ufs_rpmb_secprot (scsi_dev, region,SCSI_SECURITY_PROTOCOL_IN , + frames, nframes,DMA_FROM_DEVICE ); +} + +int ufs_rpmb_route_frames (struct udevice *scsi_dev,unsigned int region, +void *req,unsigned long reqlen,void *rsp, +unsigned long rsplen) +{ +unsigned int n_req = reqlen /RPMB_FRAME_SIZE ; +unsigned int n_rsp = rsplen /RPMB_FRAME_SIZE ; +u16 request; +int ret; + +if (!scsi_dev || reqlen %RPMB_FRAME_SIZE || + rsplen %RPMB_FRAME_SIZE || !n_req) +return -EINVAL ; + + request =rpmb_frame_request (req); + +switch (request) { +case RPMB_REQ_KEY :
drivers/ufs/ufs-rpmb.c line 133
Quoted 10 lines
drivers/ufs/ufs-rpmb.c new file +10
-0+case RPMB_REQ_WRITE_DATA : { +u8 status_frame[RPMB_FRAME_SIZE ]; + + ret =ufs_rpmb_send (scsi_dev, region, req, n_req); +if (ret) +return ret; + +memset (status_frame,0 ,sizeof (status_frame)); + status_frame[RPMB_FRAME_REQ_OFFSET ] =RPMB_REQ_STATUS >>8 ; + status_frame[RPMB_FRAME_REQ_OFFSET +1 ] =RPMB_REQ_STATUS &0xff ;
put_unaligned_be16()
Quoted 31 lines
drivers/ufs/ufs-rpmb.c new file +30
-0+ ret =ufs_rpmb_send (scsi_dev, region, status_frame,1 ); +if (ret) +return ret; + +if (n_rsp <1 ) +return -EINVAL ; + +return ufs_rpmb_recv (scsi_dev, region, rsp,1 ); + } +case RPMB_REQ_WCOUNTER : +case RPMB_REQ_READ_DATA : + ret =ufs_rpmb_send (scsi_dev, region, req,1 ); +if (ret) +return ret; + +if (n_rsp <1 ) +return -EINVAL ; + +return ufs_rpmb_recv (scsi_dev, region, rsp, n_rsp); +default : +debug ("ufs-rpmb: unsupported request 0x%x\n" , request); +return -EINVAL ; + } +} + +static int ufs_rpmb_read_geometry (struct udevice *scsi_dev,u8 *rpmb_rw_size) +{ +struct ufs_hba *hba =dev_get_uclass_priv (scsi_dev->parent); +u8 desc[QUERY_DESC_GEOMETRY_DEF_SIZE ]; +int ret;
drivers/ufs/ufs-rpmb.c line 173
Quoted 10 lines
drivers/ufs/ufs-rpmb.c new file +10
-0+ + ret =ufshcd_read_desc_param (hba,QUERY_DESC_IDN_GEOMETRY ,0 ,0 , + desc,sizeof (desc)); +if (ret) +return ret; + + *rpmb_rw_size = desc[GEOMETRY_DESC_RPMB_RW_SIZE ]; + +return 0 ; +}
This function should be defered to the next patch were it is used. Otherwise we could get compilers complaining during git bisect about unused static function.
PATCH v3 3/5 ufs: derive the per-region RPMB CID and size for OP-TEE
In reply to Jorge Ramirez-Ortiz via U-BootOP-TEE computes its RPMB authentication key from a device identifier, so U-Boot must hand it the exact same identifier the Linux kernel uses; otherwise the derived key differs and OP-TEE cannot access RPMB secure storage provisioned under Linux, and vice versa. The OP-TEE RPMB probe also needs each region's size and reliable-write count to discover which regions exist and how they may be written. Provide both so OP-TEE secure storage stays interoperable across U-Boot and Linux on the same device.
--- drivers/ufs/Kconfig | 7 +- drivers/ufs/ufs-rpmb.c | 148 +++++++++++++++++++++++++++++++++++++++++ include/ufs.h | 6 ++ 3 files changed, 159 insertions(+), 2 deletions(-)
drivers/ufs/Kconfig +5 -2
@@ -95,11 +95,14 @@ config UFS_TI_J721E config SUPPORT_UFS_RPMB bool "Enable UFS RPMB (Replay Protected Memory Block) support" depends on UFS && OPTEE && !SUPPORT_EMMC_RPMB + select BLAKE2 help Route OP-TEE RPMB requests to the UFS RPMB Well-Known LUN using SCSI SECURITY PROTOCOL IN/OUT commands. Required for OP-TEE secure storage (CFG_RPMB_FS) on UFS-based platforms that have no eMMC. - The OP-TEE supplicant handles a single RPMB transport, so this is - mutually exclusive with the eMMC RPMB supplicant (SUPPORT_EMMC_RPMB). + BLAKE2 is used to derive the fixed-length RPMB CID that matches the + Linux kernel UFS device_id ABI. The OP-TEE supplicant handles a + single RPMB transport, so this is mutually exclusive with the eMMC + RPMB supplicant (SUPPORT_EMMC_RPMB). endmenu
drivers/ufs/ufs-rpmb.c +148 -0
167 lines not on this page · raw message
include/ufs.h +6 -0
@@ -20,8 +20,14 @@ int ufs_probe(void);*/ int ufs_probe_dev (int index); +#define UFS_RPMB_CID_SIZE 16 +#define UFS_RPMB_NUM_REGIONS 4 +int ufs_rpmb_route_frames (struct udevice *scsi_dev,unsigned int region,void *req,unsigned long reqlen,void *rsp,unsigned long rsplen); +int ufs_rpmb_get_region_info (struct udevice *scsi_dev,unsigned int region, +u8 *size_mult,u8 *rel_wr,u8 *cid); +#endif
Signature · 1 line
2.54.0
Re: [PATCH v3 3/5] ufs: derive the per-region RPMB CID and size for OP-TEE
Quoted 41 lines · Jorge Ramirez-Ortiz
OP-TEE computes its RPMB authentication key from a device identifier, so U-Boot must hand it the exact same identifier the Linux kernel uses; otherwise the derived key differs and OP-TEE cannot access RPMB secure storage provisioned under Linux, and vice versa. The OP-TEE RPMB probe also needs each region's size and reliable-write count to discover which regions exist and how they may be written. Provide both so OP-TEE secure storage stays interoperable across U-Boot and Linux on the same device.
Signed-off-by Jorge Ramirez-Ortiz <[email protected]>--- drivers/ufs/Kconfig | 7 +- drivers/ufs/ufs-rpmb.c | 148 +++++++++++++++++++++++++++++++++++++++++ include/ufs.h | 6 ++ 3 files changed, 159 insertions(+), 2 deletions(-)drivers/ufs/Kconfig +5
-2@@ -95,11 +95,14 @@ config UFS_TI_J721E config SUPPORT_UFS_RPMB bool "Enable UFS RPMB (Replay Protected Memory Block) support" depends on UFS && OPTEE && !SUPPORT_EMMC_RPMB + select BLAKE2 help Route OP-TEE RPMB requests to the UFS RPMB Well-Known LUN using SCSI SECURITY PROTOCOL IN/OUT commands. Required for OP-TEE secure storage (CFG_RPMB_FS) on UFS-based platforms that have no eMMC. - The OP-TEE supplicant handles a single RPMB transport, so this is - mutually exclusive with the eMMC RPMB supplicant (SUPPORT_EMMC_RPMB). + BLAKE2 is used to derive the fixed-length RPMB CID that matches the + Linux kernel UFS device_id ABI. The OP-TEE supplicant handles a + single RPMB transport, so this is mutually exclusive with the eMMC + RPMB supplicant (SUPPORT_EMMC_RPMB). endmenudrivers/ufs/ufs-rpmb.c +0
-0
drivers/ufs/ufs-rpmb.c line 9
Quoted 9 lines
drivers/ufs/ufs-rpmb.c +3
-0@@ -1,10 +1,14 @@// SPDX-License-Identifier: GPL-2.0+ #include <dm.h> +#include <hexdump.h> #include <log.h> #include <malloc.h> #include <scsi.h> #include <ufs.h> +#include <vsprintf.h> +#include <u-boot/blake2.h>
These are mostly in alphabetical order, so would make sense to put <u-boot/... after <linux/...
Quoted 39 lines
drivers/ufs/ufs-rpmb.c +24
-0#include <asm/cache.h> +#include <asm/unaligned.h> #include <linux/errno.h> #include <linux/string.h> #include "ufs.h" @@ -25,6 +29,15 @@#define GEOMETRY_DESC_RPMB_RW_SIZE 0x17 +#define RPMB_UNIT_DESC_LOGICAL_BLK_SIZE 0x0A +#define RPMB_UNIT_DESC_LOGICAL_BLK_COUNT 0x0B +#define RPMB_UNIT_DESC_REGION0_SIZE 0x13 +#define RPMB_UNIT_DESC_REGION1_SIZE 0x14 +#define RPMB_UNIT_DESC_REGION2_SIZE 0x15 +#define RPMB_UNIT_DESC_REGION3_SIZE 0x16 +#define UFS_RPMB_LEGACY_SPEC_VER 0x0220 +#define UFS_RPMB_REGION_UNIT_SHIFT 17 +static u16 rpmb_frame_request (const void *frame) {const u8 *p = frame;@@ -171,3 +184,138 @@ static int ufs_rpmb_read_geometry(struct udevice *scsi_dev, u8 *rpmb_rw_size)return 0 ; } + +static int ufs_rpmb_read_region_sizes (struct ufs_hba *hba,u16 spec_ver, +u8 sizes[UFS_RPMB_NUM_REGIONS ]) +{ +u8 unit[QUERY_DESC_UNIT_DEF_SIZE ] = { }; +int ret; + + ret =ufshcd_read_desc_param (hba,QUERY_DESC_IDN_UNIT , +UFS_UPIU_RPMB_WLUN ,0 , unit,sizeof (unit)); +if (ret) +return ret; + +memset (sizes,0 ,UFS_RPMB_NUM_REGIONS ); +
drivers/ufs/ufs-rpmb.c static int ufs_rpmb_read_geometry(struct udevice *scsi_dev, u8 *rpmb_rw_size) · line 210
Quoted 10 lines
drivers/ufs/ufs-rpmb.c +10
-0+if (spec_ver >UFS_RPMB_LEGACY_SPEC_VER ) { + sizes[0 ] = unit[RPMB_UNIT_DESC_REGION0_SIZE ]; + sizes[1 ] = unit[RPMB_UNIT_DESC_REGION1_SIZE ]; + sizes[2 ] = unit[RPMB_UNIT_DESC_REGION2_SIZE ]; + sizes[3 ] = unit[RPMB_UNIT_DESC_REGION3_SIZE ]; + }else { +u64 region = (get_unaligned_be64 (unit + +RPMB_UNIT_DESC_LOGICAL_BLK_COUNT ) + << unit[RPMB_UNIT_DESC_LOGICAL_BLK_SIZE ]) + >>UFS_RPMB_REGION_UNIT_SHIFT ;
A bit hard to read. Maybe like this?
u64 region; region = get_unaligned_be64(unit + RPMB_UNIT_DESC_LOGICAL_BLK_COUNT); region <<= unit[RPMB_UNIT_DESC_LOGICAL_BLK_SIZE]; region >>= UFS_RPMB_REGION_UNIT_SHIFT;
Also probably worth checking value of unit[RPMB_UNIT_DESC_LOGICAL_BLK_SIZE] before using it if comes from a potentially untrusted source.
Quoted 10 lines
drivers/ufs/ufs-rpmb.c +10
-0+ + sizes[0 ] = region >0xff ?0xff : region; + } + +return 0 ; +} + +static void ufs_rpmb_string_to_ascii (const u8 *raw,char *out,size_t outsz) +{ +int nchars = ((int )raw[QUERY_DESC_LENGTH_OFFSET ] -QUERY_DESC_HDR_SIZE );
drivers/ufs/ufs-rpmb.c static int ufs_rpmb_read_geometry(struct udevice *scsi_dev, u8 *rpmb_rw_size) · line 230
Quoted 10 lines
drivers/ufs/ufs-rpmb.c +10
-0+int i, n =0 ; + + nchars = nchars >0 ? nchars /2 :0 ; +for (i =0 ; i < nchars && n < (int )outsz -1 ; i++) { +u16 c =get_unaligned_be16 (raw +QUERY_DESC_HDR_SIZE + i *2 ); + + out[n++] = (c >=0x20 && c <=0x7e ) ? (char )c :' ' ; + } + out[n] ='\0' ; +}
This looks similar to ufshcd_remove_non_printable(). Should we try to share code more?
Quoted 28 lines
drivers/ufs/ufs-rpmb.c +28
-0+ +static int ufs_rpmb_build_cid (struct ufs_hba *hba,const u8 *dev_desc, +unsigned int region,u8 *cid) +{ +char serial_hex[QUERY_DESC_MAX_SIZE *2 +1 ]; +u16 manf_id, spec_ver, dev_ver, manf_date; +u8 serial[QUERY_DESC_MAX_SIZE ] = { }; +char idstr[QUERY_DESC_MAX_SIZE *3 ]; +char model[MAX_MODEL_LEN *8 ]; +u8 raw[QUERY_DESC_MAX_SIZE ]; +u8 blen; +int ret; + + manf_date =get_unaligned_be16 (dev_desc +DEVICE_DESC_PARAM_MANF_DATE ); + spec_ver =get_unaligned_be16 (dev_desc +DEVICE_DESC_PARAM_SPEC_VER ); + manf_id =get_unaligned_be16 (dev_desc +DEVICE_DESC_PARAM_MANF_ID ); + dev_ver =get_unaligned_be16 (dev_desc +DEVICE_DESC_PARAM_DEV_VER ); + + ret =ufshcd_read_desc_param (hba,QUERY_DESC_IDN_STRING , + dev_desc[DEVICE_DESC_PARAM_PRDCT_NAME ],0 , + raw,sizeof (raw)); +if (ret) +return ret; + +ufs_rpmb_string_to_ascii (raw, model,sizeof (model)); + + ret = ufshcd_read_desc_param(hba, QUERY_DESC_IDN_STRING, + dev_desc[DEVICE_DESC_PARAM_SN], 0,
drivers/ufs/ufs-rpmb.c static int ufs_rpmb_read_geometry(struct udevice *scsi_dev, u8 *rpmb_rw_size) · line 268
Quoted 10 lines
drivers/ufs/ufs-rpmb.c +10
-0+ raw, sizeof(raw)); +if (ret) +return ret; + + blen = raw[QUERY_DESC_LENGTH_OFFSET ]; +if (blen <QUERY_DESC_HDR_SIZE ) +return -EINVAL ; + +memcpy (serial, raw +QUERY_DESC_HDR_SIZE , blen -QUERY_DESC_HDR_SIZE ); +bin2hex (serial_hex, serial, blen);
Why isn't this also blen - QUERY_DESC_HDR_SIZE? Is the 00 padding intentional?
Quoted 12 lines
drivers/ufs/ufs-rpmb.c +12
-0+ serial_hex[blen *2 ] ='\0' ; + +snprintf (idstr,sizeof (idstr),"%04X-%04X-%s-%s-%04X-%04X-R%u" , + manf_id, spec_ver, model, serial_hex, dev_ver, manf_date, + region); + +if (blake2b (cid,UFS_RPMB_CID_SIZE , idstr,strlen (idstr),NULL ,0 )) +return -EIO ; + +return 0 ; +} +
PATCH v3 4/5 optee: rename rpmb.c to rpmb_emmc.c
In reply to Jorge Ramirez-Ortiz via U-BootThis file implements the legacy single-command OPTEE_MSG_RPC_CMD_RPMB supplicant (eMMC only). Rename it to rpmb_emmc.c.
No functional change.
---
drivers/tee/optee/Makefile | 2 +-
drivers/tee/optee/{rpmb.c => rpmb_emmc.c} | 0
2 files changed, 1 insertion(+), 1 deletion(-)
rename drivers/tee/optee/{rpmb.c => rpmb_emmc.c} (100%)drivers/tee/optee/Makefile +1 -1
@@ -3,4 +3,4 @@ obj-$(CONFIG_OPTEE) += core.o obj-y += supplicant.o obj-$(CONFIG_DM_I2C) += i2c.o -obj-$(CONFIG_SUPPORT_EMMC_RPMB) += rpmb.o +obj-$(CONFIG_SUPPORT_EMMC_RPMB) += rpmb_emmc.o
drivers/tee/optee/rpmb_emmc.c renamed from drivers/tee/optee/rpmb.c +0 -0
Signature · 1 line
2.54.0
PATCH v3 5/5 optee: implement the RPMB subsystem interface for UFS
In reply to Jorge Ramirez-Ortiz via U-BootOP-TEE's legacy RPMB supplicant interface assumes the RPMB device is eMMC and derives the key from an eMMC-shaped device ID, so it can never reproduce the key Linux derives for a UFS device; secure storage on UFS-only platforms instead needs the transport-agnostic RPMB subsystem interface, through which the normal world describes the real RPMB device to OP-TEE. Add a UFS backend for it so OP-TEE derives a key matching Linux and can use RPMB secure storage on UFS, leaving the legacy eMMC path untouched.
This subsystem backend currently supports UFS drives only; eMMC still uses the legacy interface.
--- drivers/tee/optee/Makefile | 1 + drivers/tee/optee/optee_msg_supplicant.h | 8 ++ drivers/tee/optee/optee_private.h | 41 +++++++ drivers/tee/optee/rpmb_ufs.c | 141 +++++++++++++++++++++++ drivers/tee/optee/supplicant.c | 9 ++ drivers/ufs/Kconfig | 8 ++ 6 files changed, 208 insertions(+) create mode 100644 drivers/tee/optee/rpmb_ufs.c
drivers/tee/optee/Makefile +1 -0
@@ -4,3 +4,4 @@ obj-$(CONFIG_OPTEE) += core.o obj-y += supplicant.o obj-$(CONFIG_DM_I2C) += i2c.o obj-$(CONFIG_SUPPORT_EMMC_RPMB) += rpmb_emmc.o +obj-$(CONFIG_SUPPORT_UFS_RPMB) += rpmb_ufs.o
drivers/tee/optee/optee_msg_supplicant.h +8 -0
@@ -152,6 +152,14 @@*/ #define OPTEE_MSG_RPC_CMD_I2C_TRANSFER 21 +#define OPTEE_MSG_RPC_CMD_RPMB_PROBE_RESET 22 +#define OPTEE_MSG_RPC_CMD_RPMB_PROBE_NEXT 23 +#define OPTEE_MSG_RPC_CMD_RPMB_FRAMES 24 + +#define OPTEE_RPC_SHM_TYPE_APPL 0 + +#define OPTEE_RPC_RPMB_UFS 1 +/* * Was OPTEE_MSG_RPC_CMD_SQL_FS, which isn't supported any longer */
drivers/tee/optee/optee_private.h +41 -0
59 lines not on this page · raw message
drivers/tee/optee/rpmb_ufs.c new file +141 -0
141 lines not on this page · raw message
drivers/tee/optee/supplicant.c +9 -0
@@ -89,6 +89,15 @@ 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_RPMB_PROBE_RESET : +optee_suppl_cmd_rpmb_probe_reset (dev, arg); +break ; +case OPTEE_MSG_RPC_CMD_RPMB_PROBE_NEXT : +optee_suppl_cmd_rpmb_probe_next (dev, arg); +break ; +case OPTEE_MSG_RPC_CMD_RPMB_FRAMES : +optee_suppl_cmd_rpmb_frames (dev, arg); +break ;case OPTEE_MSG_RPC_CMD_I2C_TRANSFER :optee_suppl_cmd_i2c_transfer (arg);break ;
drivers/ufs/Kconfig +8 -0
@@ -105,4 +105,12 @@ config SUPPORT_UFS_RPMB single RPMB transport, so this is mutually exclusive with the eMMC RPMB supplicant (SUPPORT_EMMC_RPMB). +config UFS_RPMB_CONTROLLER + int "UFS controller index used for RPMB" + depends on SUPPORT_UFS_RPMB + default 0 + help + Index of the RPMB-owning UFS controller in the UCLASS_UFS device + list. Leave at 0 unless the board has more than one UFS controller. + endmenu
Signature · 1 line
2.54.0