Add a UFS RPMB transport that moves fully-formed JEDEC RPMB frames to and from the RPMB Well-Known LUN using SCSI SECURITY PROTOCOL IN/OUT commands, exposed through ufs_rpmb_route_frames() for the OP-TEE RPMB supplicant and guarded by CONFIG_SUPPORT_UFS_RPMB.
The RPMB WLUN is untouched during boot, so its first SECURITY PROTOCOL command after power-on returns a power-on UNIT ATTENTION, which ufs_scsi_exec() surfaces as -EINVAL. U-Boot has no SCSI mid-layer to auto-retry, so retry the command a few times to avoid losing the first frame OP-TEE sends. Bounce unaligned frames through an ARCH_DMA_MINALIGN buffer, since the supplicant may pass a frame the controller cannot DMA (for example a status-result frame built on the stack). Signed-off-by: Jorge Ramirez-Ortiz <[email protected]> --- drivers/ufs/Kconfig | 13 +++ drivers/ufs/Makefile | 1 + drivers/ufs/ufs-rpmb.c | 168 +++++++++++++++++++++++++++++++++++++++ drivers/ufs/ufs-uclass.c | 6 +- drivers/ufs/ufs.h | 7 ++ include/scsi.h | 2 + include/ufs.h | 6 ++ 7 files changed, 200 insertions(+), 3 deletions(-) create mode 100644 drivers/ufs/ufs-rpmb.c diff --git a/drivers/ufs/Kconfig b/drivers/ufs/Kconfig index 49472933de3..d39fcda42dc 100644 --- a/drivers/ufs/Kconfig +++ b/drivers/ufs/Kconfig @@ -92,4 +92,17 @@ 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 + 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. + 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 diff --git a/drivers/ufs/Makefile b/drivers/ufs/Makefile index e7f3c1d30c4..d60440ca119 100644 --- a/drivers/ufs/Makefile +++ b/drivers/ufs/Makefile @@ -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 diff --git a/drivers/ufs/ufs-rpmb.c b/drivers/ufs/ufs-rpmb.c new file mode 100644 index 00000000000..5417a4ec0bc --- /dev/null +++ b/drivers/ufs/ufs-rpmb.c @@ -0,0 +1,168 @@ +// 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 + +#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]; +} + +static int ufs_rpmb_secprot(struct udevice *scsi_dev, unsigned int region, + u8 opcode, void *buf, unsigned int nframes, + enum dma_data_direction dir) +{ + struct scsi_cmd pccb; + u32 len = nframes * RPMB_FRAME_SIZE; + u16 spsp = (region << 8) | UFS_RPMB_SEC_PROTOCOL_ID; + 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; + 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; + 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; + 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: + 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; + 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; + } +} + +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; + + 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; +} diff --git a/drivers/ufs/ufs-uclass.c b/drivers/ufs/ufs-uclass.c index 8f120fbbee8..e320a6dcfbc 100644 --- a/drivers/ufs/ufs-uclass.c +++ b/drivers/ufs/ufs-uclass.c @@ -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; diff --git a/drivers/ufs/ufs.h b/drivers/ufs/ufs.h index 0f6c93fbce7..9f55735602b 100644 --- a/drivers/ufs/ufs.h +++ b/drivers/ufs/ufs.h @@ -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 diff --git a/include/scsi.h b/include/scsi.h index 2520a8b8fe6..cc79b6dd4c4 100644 --- a/include/scsi.h +++ b/include/scsi.h @@ -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 diff --git a/include/ufs.h b/include/ufs.h index f6e27d90e43..f2e46bc5fbf 100644 --- a/include/ufs.h +++ b/include/ufs.h @@ -20,4 +20,10 @@ 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); + +int ufs_rpmb_read_geometry(struct udevice *scsi_dev, u8 *rpmb_rw_size); + #endif -- 2.54.0
