Inline crypto support on DragonBoard 845c
Subsystems (6)
Eric Biggers
maintainerv2 cover Inline crypto support on DragonBoard 845c
Hello,
This patchset implements UFS inline crypto support on the DragonBoard 845c, using the Qualcomm Inline Crypto Engine (ICE) that's present on the Snapdragon 845 SoC.
This is based on top of the patchset "[PATCH v7 0/9] Inline Encryption Support" by Satya Tangirala, which adds support for the UFS standard inline crypto, the block layer changes needed to use inline crypto, and support for inline crypto in fscrypt (ext4 and f2fs encryption). Link:
https://lkml.kernel.org/r/[email protected]
This new patchset is mostly a RFC showing hardware inline crypto working on a publicly available development board that runs the mainline Linux kernel. While patches 1-2 could be applied now, patches 3-4 depend on the main "Inline Encryption Support" patchset being merged first.
Most of the logic needed to use ICE is already handled by ufshcd-crypto and the blk-crypto framework, which are introduced by the "Inline Encryption Support" patchset. Therefore, this new patchset just adds the vendor-specific parts. I also only implemented support for version 3 of the ICE hardware, which seems to be easier to use than older versions; and for now I only implemented UFS support, not eMMC.
Due to these factors, I was able to greatly simplify the driver from the vendor's original. It seems to work fine in testing with fscrypt and with a blk-crypto self-test I'm also working on. But I'd appreciate feedback from anyone who may be more familiar with this hardware as to whether I might have missed anything important.
This patchset is also available in git at:
Repo: https://git.kernel.org/pub/scm/linux/kernel/git/ebiggers/linux.git Tag: db845c-crypto-v2
Changed v1 => v2:
- Rebased onto the v7 inline encryption patchset.
- Account for all the recent qcom_scm changes.
- Don't ignore errors from ->program_key().
- Don't dereference NULL hba->vops.
- Dropped the patch that added UFSHCD_QUIRK_BROKEN_CRYPTO, as this flag is now included in the main inline encryption patchset.
- Many other cleanups.
Eric Biggers (4):
firmware: qcom_scm: Add support for programming inline crypto keys
arm64: dts: sdm845: add Inline Crypto Engine registers and clock
scsi: ufs: add program_key() variant op
scsi: ufs-qcom: add Inline Crypto Engine support
MAINTAINERS | 2 +- arch/arm64/boot/dts/qcom/sdm845.dtsi | 13 +- drivers/firmware/qcom_scm.c | 96 +++++++++++ drivers/firmware/qcom_scm.h | 4 + drivers/scsi/ufs/Kconfig | 1 + drivers/scsi/ufs/Makefile | 4 +- drivers/scsi/ufs/ufs-qcom-ice.c | 245 +++++++++++++++++++++++++++ drivers/scsi/ufs/ufs-qcom.c | 18 +- drivers/scsi/ufs/ufs-qcom.h | 27 +++ drivers/scsi/ufs/ufshcd-crypto.c | 34 ++-- drivers/scsi/ufs/ufshcd.h | 3 + include/linux/qcom_scm.h | 19 +++ 12 files changed, 440 insertions(+), 26 deletions(-) create mode 100644 drivers/scsi/ufs/ufs-qcom-ice.c
Signature · 1 line
2.25.1
Eric Biggers
maintainerRFC PATCH v2 2/4 arm64: dts: sdm845: add Inline Crypto Engine registers and clock
From: Eric Biggers <[email protected]>
Add the vendor-specific registers and clock for Qualcomm ICE (Inline Crypto Engine) to the device tree node for the UFS host controller on sdm845, so that the ufs-qcom driver will be able to use inline crypto.
Use a separate register range rather than extending the main UFS range because there's a gap between the two, and the ICE registers are vendor-specific. (Actually, the hardware claims that the ICE range also includes the array of standard crypto configuration registers; however, on this SoC the Linux kernel isn't permitted to access them directly.)
--- arch/arm64/boot/dts/qcom/sdm845.dtsi | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-)
arch/arm64/boot/dts/qcom/sdm845.dtsi +9 -4
@@ -1367,7 +1367,9 @@ system-cache-controller@1100000 { ufs_mem_hc: ufshc@1d84000 { compatible = "qcom,sdm845-ufshc", "qcom,ufshc", "jedec,ufs-2.0"; - reg = <0 0x01d84000 0 0x2500>; + reg = <0 0x01d84000 0 0x2500>, + <0 0 0 0>, + <0 0x01d90000 0 0x8000>; interrupts = <GIC_SPI 265 IRQ_TYPE_LEVEL_HIGH>; phys = <&ufs_mem_phy_lanes>; phy-names = "ufsphy";
@@ -1387,7 +1389,8 @@ ufs_mem_hc: ufshc@1d84000 { "ref_clk", "tx_lane0_sync_clk", "rx_lane0_sync_clk", - "rx_lane1_sync_clk"; + "rx_lane1_sync_clk", + "ice_core_clk"; clocks = <&gcc GCC_UFS_PHY_AXI_CLK>, <&gcc GCC_AGGRE_UFS_PHY_AXI_CLK>,
@@ -1396,7 +1399,8 @@ ufs_mem_hc: ufshc@1d84000 { <&rpmhcc RPMH_CXO_CLK>, <&gcc GCC_UFS_PHY_TX_SYMBOL_0_CLK>, <&gcc GCC_UFS_PHY_RX_SYMBOL_0_CLK>, - <&gcc GCC_UFS_PHY_RX_SYMBOL_1_CLK>; + <&gcc GCC_UFS_PHY_RX_SYMBOL_1_CLK>, + <&gcc GCC_UFS_PHY_ICE_CORE_CLK>; freq-table-hz = <50000000 200000000>, <0 0>,
@@ -1405,7 +1409,8 @@ ufs_mem_hc: ufshc@1d84000 { <0 0>, <0 0>, <0 0>, - <0 0>; + <0 0>, + <0 300000000>; status = "disabled"; };
Signature · 1 line
2.25.1
Eric Biggers
maintainerRFC PATCH v2 1/4 firmware: qcom_scm: Add support for programming inline crypto keys
In reply to Eric BiggersFrom: Eric Biggers <[email protected]>
Add support for the Inline Crypto Engine (ICE) key programming interface that's needed for the ufs-qcom driver to use inline encryption on Snapdragon SoCs. This interface consists of two SCM calls: one to program a key into a keyslot, and one to invalidate a keyslot.
Although the UFS specification defines a standard way to do this, on these SoCs the Linux kernel isn't permitted to access the needed crypto configuration registers directly; these SCM calls must be used instead.
--- drivers/firmware/qcom_scm.c | 96 +++++++++++++++++++++++++++++++++++++ drivers/firmware/qcom_scm.h | 4 ++ include/linux/qcom_scm.h | 19 ++++++++ 3 files changed, 119 insertions(+)
drivers/firmware/qcom_scm.c +96 -0
@@ -9,6 +9,7 @@#include <linux/dma-direct.h> #include <linux/dma-mapping.h> #include <linux/module.h> +#include <linux/slab.h> #include <linux/types.h> #include <linux/qcom_scm.h> #include <linux/of.h>
@@ -926,6 +927,101 @@ int qcom_scm_ocmem_unlock(enum qcom_scm_ocmem_client id, u32 offset, u32 size) }EXPORT_SYMBOL (qcom_scm_ocmem_unlock); +/** +* qcom_scm_ice_available() - Is the ICE key programming interface available? +* +* Return: true iff the SCM calls wrapped by qcom_scm_ice_invalidate_key() and +* qcom_scm_ice_set_key() are available. +*/ +bool qcom_scm_ice_available (void ) +{ +return __qcom_scm_is_call_available (__scm->dev,QCOM_SCM_SVC_ES , +QCOM_SCM_ES_INVALIDATE_ICE_KEY ) && +__qcom_scm_is_call_available (__scm->dev,QCOM_SCM_SVC_ES , +QCOM_SCM_ES_CONFIG_SET_ICE_KEY ); +} +EXPORT_SYMBOL (qcom_scm_ice_available); + +/** +* qcom_scm_ice_invalidate_key() - Invalidate an inline encryption key +* @index: the keyslot to invalidate +* +* The UFSHCI standard defines a standard way to do this, but it doesn't work on +* these SoCs; only this SCM call does. +* +* Return: 0 on success; -errno on failure. +*/ +int qcom_scm_ice_invalidate_key (u32 index) +{ +struct qcom_scm_desc desc = { + .svc =QCOM_SCM_SVC_ES , + .cmd =QCOM_SCM_ES_INVALIDATE_ICE_KEY , + .arginfo =QCOM_SCM_ARGS (1 ), + .args[0 ] = index, + .owner =ARM_SMCCC_OWNER_SIP , + }; + +return qcom_scm_call (__scm->dev, &desc,NULL ); +} +EXPORT_SYMBOL (qcom_scm_ice_invalidate_key); + +/** +* qcom_scm_ice_set_key() - Set an inline encryption key +* @index: the keyslot into which to set the key +* @key: the key to program +* @key_size: the size of the key in bytes +* @cipher: the encryption algorithm the key is for +* @data_unit_size: the encryption data unit size, i.e. the size of each +* individual plaintext and ciphertext. Given in 512-byte +* units, e.g. 1 = 512 bytes, 8 = 4096 bytes, etc. +* +* Program a key into a keyslot of Qualcomm ICE (Inline Crypto Engine), where it +* can then be used to encrypt/decrypt UFS I/O requests inline. +* +* The UFSHCI standard defines a standard way to do this, but it doesn't work on +* these SoCs; only this SCM call does. +* +* Return: 0 on success; -errno on failure. +*/ +int qcom_scm_ice_set_key (u32 index,const u8 *key,int key_size, +enum qcom_scm_ice_cipher cipher,int data_unit_size) +{ +struct qcom_scm_desc desc = { + .svc =QCOM_SCM_SVC_ES , + .cmd =QCOM_SCM_ES_CONFIG_SET_ICE_KEY , + .arginfo =QCOM_SCM_ARGS (5 ,QCOM_SCM_VAL ,QCOM_SCM_RW , +QCOM_SCM_VAL ,QCOM_SCM_VAL , +QCOM_SCM_VAL ), + .args[0 ] = index, + .args[2 ] = key_size, + .args[3 ] = cipher, + .args[4 ] = data_unit_size, + .owner =ARM_SMCCC_OWNER_SIP , + }; +u8 *keybuf; +dma_addr_t key_phys; +int ret; + + keybuf =kmemdup (key, key_size,GFP_KERNEL ); +if (!keybuf) +return -ENOMEM ; + + key_phys =dma_map_single (__scm->dev, keybuf, key_size,DMA_TO_DEVICE ); +if (dma_mapping_error (__scm->dev, key_phys)) { + ret = -ENOMEM ; + goto out; + } + desc.args[1 ] = key_phys; + + ret =qcom_scm_call (__scm->dev, &desc,NULL ); + +dma_unmap_single (__scm->dev, key_phys, key_size,DMA_TO_DEVICE ); +out: +kzfree (keybuf); +return ret; +} +EXPORT_SYMBOL (qcom_scm_ice_set_key); +/** * qcom_scm_hdcp_available() - Check if secure environment supports HDCP. *
drivers/firmware/qcom_scm.h +4 -0
@@ -103,6 +103,10 @@ extern int scm_legacy_call(struct device *dev, const struct qcom_scm_desc *desc,#define QCOM_SCM_OCMEM_LOCK_CMD 0x01#define QCOM_SCM_OCMEM_UNLOCK_CMD 0x02 +#define QCOM_SCM_SVC_ES 0x10/* Enterprise Security */ +#define QCOM_SCM_ES_INVALIDATE_ICE_KEY 0x03 +#define QCOM_SCM_ES_CONFIG_SET_ICE_KEY 0x04 +#define QCOM_SCM_SVC_HDCP 0x11#define QCOM_SCM_HDCP_INVOKE 0x01
include/linux/qcom_scm.h +19 -0
@@ -44,6 +44,13 @@ enum qcom_scm_sec_dev_id { QCOM_SCM_ICE_DEV_ID = 20, }; +enum qcom_scm_ice_cipher { +QCOM_SCM_ICE_CIPHER_AES_128_XTS =0 , +QCOM_SCM_ICE_CIPHER_AES_128_CBC =1 , +QCOM_SCM_ICE_CIPHER_AES_256_XTS =3 , +QCOM_SCM_ICE_CIPHER_AES_256_CBC =4 , +}; +#define QCOM_SCM_VMID_HLOS 0x3#define QCOM_SCM_VMID_MSS_MSA 0xF#define QCOM_SCM_VMID_WLAN 0x18
@@ -88,6 +95,12 @@ extern int qcom_scm_ocmem_lock(enum qcom_scm_ocmem_client id, u32 offset,extern int qcom_scm_ocmem_unlock (enum qcom_scm_ocmem_client id,u32 offset,u32 size); +extern bool qcom_scm_ice_available (void ); +extern int qcom_scm_ice_invalidate_key (u32 index); +extern int qcom_scm_ice_set_key (u32 index,const u8 *key,int key_size, +enum qcom_scm_ice_cipher cipher, +int data_unit_size); +extern bool qcom_scm_hdcp_available (void );extern int qcom_scm_hdcp_req (struct qcom_scm_hdcp_req *req,u32 req_cnt,u32 *resp);
@@ -138,6 +151,12 @@ static inline int qcom_scm_ocmem_lock(enum qcom_scm_ocmem_client id, u32 offset,static inline int qcom_scm_ocmem_unlock (enum qcom_scm_ocmem_client id,u32 offset,u32 size) {return -ENODEV ; } +static inline bool qcom_scm_ice_available (void ) {return false; } +static inline int qcom_scm_ice_invalidate_key (u32 index) {return -ENODEV ; } +static inline int qcom_scm_ice_set_key (u32 index,const u8 *key,int key_size, +enum qcom_scm_ice_cipher cipher, +int data_unit_size) {return -ENODEV ; } +static inline bool qcom_scm_hdcp_available (void ) {return false; }static inline int qcom_scm_hdcp_req (struct qcom_scm_hdcp_req *req,u32 req_cnt,u32 *resp) {return -ENODEV ; }
Signature · 1 line
2.25.1
Eric Biggers
maintainerRFC PATCH v2 4/4 scsi: ufs-qcom: add Inline Crypto Engine support
In reply to Eric BiggersFrom: Eric Biggers <[email protected]>
Add support for Qualcomm Inline Crypto Engine (ICE) to ufs-qcom.
The standards-compliant parts, such as querying the crypto capabilities and enabling crypto for individual UFS requests, are already handled by ufshcd-crypto.c, which itself is wired into the blk-crypto framework. However, ICE requires vendor-specific init, enable, and resume logic, and it requires that keys be programmed and evicted by vendor-specific SMC calls. Make the ufs-qcom driver handle these details.
I tested this on Dragonboard 845c, which is a publicly available development board that uses the Snapdragon 845 SoC. This is the same SoC used in the Pixel 3 and Pixel 3 XL phones. This testing included (among other things) verifying that the expected ciphertext was produced for the key and IV used, both manually using ext4 encryption and automatically using a block layer self-test I've written.
This is based very loosely on the vendor-provided driver in the kernel source code for the Pixel 3, but I've greatly simplified it. Also, for now I've only included support for major version 3 of ICE, since that's all I have the hardware to test with the mainline kernel. Plus it appears that version 3 is easier to use than older versions of ICE.
For now, only allow using AES-256-XTS. The hardware also declares support for AES-128-XTS, AES-{128,256}-ECB, and AES-{128,256}-CBC (BitLocker variant). But none of these others are really useful, and they'd need to be individually tested to be sure they worked properly.
This commit also changes the name of the loadable module from "ufs-qcom" to "ufs_qcom", as this is necessary to compile it from multiple source files (unless we were to rename ufs-qcom.c).
--- MAINTAINERS | 2 +- drivers/scsi/ufs/Kconfig | 1 + drivers/scsi/ufs/Makefile | 4 +- drivers/scsi/ufs/ufs-qcom-ice.c | 244 ++++++++++++++++++++++++++++++++ drivers/scsi/ufs/ufs-qcom.c | 18 +-- drivers/scsi/ufs/ufs-qcom.h | 27 ++++ 6 files changed, 286 insertions(+), 10 deletions(-) create mode 100644 drivers/scsi/ufs/ufs-qcom-ice.c
MAINTAINERS +1 -1
@@ -2202,7 +2202,7 @@ F: drivers/pci/controller/dwc/pcie-qcom.c F: drivers/phy/qualcomm/ F: drivers/power/*/msm* F: drivers/reset/reset-qcom-* -F: drivers/scsi/ufs/ufs-qcom.* +F: drivers/scsi/ufs/ufs-qcom* F: drivers/spi/spi-qup.c F: drivers/spi/spi-geni-qcom.c F: drivers/spi/spi-qcom-qspi.c
drivers/scsi/ufs/Kconfig +1 -0
@@ -99,6 +99,7 @@ config SCSI_UFS_DWC_TC_PLATFORM config SCSI_UFS_QCOM tristate "QCOM specific hooks to UFS controller platform driver" depends on SCSI_UFSHCD_PLATFORM && ARCH_QCOM + select QCOM_SCM select RESET_CONTROLLER help This selects the QCOM specific additions to UFSHCD platform driver.
drivers/scsi/ufs/Makefile +3 -1
@@ -3,7 +3,9 @@ obj-$(CONFIG_SCSI_UFS_DWC_TC_PCI) += tc-dwc-g210-pci.o ufshcd-dwc.o tc-dwc-g210.o obj-$(CONFIG_SCSI_UFS_DWC_TC_PLATFORM) += tc-dwc-g210-pltfrm.o ufshcd-dwc.o tc-dwc-g210.o obj-$(CONFIG_SCSI_UFS_CDNS_PLATFORM) += cdns-pltfrm.o -obj-$(CONFIG_SCSI_UFS_QCOM) += ufs-qcom.o +obj-$(CONFIG_SCSI_UFS_QCOM) += ufs_qcom.o +ufs_qcom-y += ufs-qcom.o +ufs_qcom-$(CONFIG_SCSI_UFS_CRYPTO) += ufs-qcom-ice.o obj-$(CONFIG_SCSI_UFSHCD) += ufshcd-core.o ufshcd-core-y += ufshcd.o ufs-sysfs.o ufshcd-core-$(CONFIG_SCSI_UFS_BSG) += ufs_bsg.o
drivers/scsi/ufs/ufs-qcom-ice.c new file +244 -0
244 lines not on this page · raw message
drivers/scsi/ufs/ufs-qcom.c +10 -8
@@ -365,7 +365,7 @@ static int ufs_qcom_hce_enable_notify(struct ufs_hba *hba,/* check if UFS PHY moved from DISABLED to HIBERN8 */ err =ufs_qcom_check_hibern8 (hba);ufs_qcom_enable_hw_clk_gating (hba); - +ufs_qcom_ice_enable (host);break ;default :dev_err (hba->dev,"%s: invalid status %d\n" , __func__, status);
@@ -616,6 +616,10 @@ static int ufs_qcom_resume(struct ufs_hba *hba, enum ufs_pm_op pm_op)return err; } + err =ufs_qcom_ice_resume (host); +if (err) +return err; + hba->is_sys_suspended = false;return 0 ; }
@@ -1002,13 +1006,6 @@ static void ufs_qcom_advertise_quirks(struct ufs_hba *hba) | UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE | UFSHCD_QUIRK_BROKEN_PA_RXHSUNTERMCAP); } - -/* -* Inline crypto is currently broken with ufs-qcom at least because the -* device tree doesn't include the crypto registers. There are likely -* to be other issues that will need to be addressed too. -*/ - hba->quirks |=UFSHCD_QUIRK_BROKEN_CRYPTO ; }static void ufs_qcom_set_caps (struct ufs_hba *hba)
@@ -1245,6 +1242,10 @@ static int ufs_qcom_init(struct ufs_hba *hba)ufs_qcom_set_caps (hba);ufs_qcom_advertise_quirks (hba); + err =ufs_qcom_ice_init (host); +if (err) + goto out_variant_clear; +ufs_qcom_setup_clocks (hba, true,POST_CHANGE );if (hba->dev->id <MAX_UFS_QCOM_HOSTS )
@@ -1658,6 +1659,7 @@ static const struct ufs_hba_variant_ops ufs_hba_qcom_vops = { .resume = ufs_qcom_resume, .dbg_register_dump = ufs_qcom_dump_dbg_regs, .device_reset = ufs_qcom_device_reset, + .program_key = ufs_qcom_ice_program_key, };/**
drivers/scsi/ufs/ufs-qcom.h +27 -0
@@ -227,6 +227,9 @@ struct ufs_qcom_host {void __iomem *dev_ref_clk_ctrl_mmio;bool is_dev_ref_clk_enabled;struct ufs_hw_version hw_ver; +#ifdef CONFIG_SCSI_UFS_CRYPTO +void __iomem *ice_mmio; +#endif u32 dev_ref_clk_en_mask;
@@ -264,4 +267,28 @@ static inline bool ufs_qcom_cap_qunipro(struct ufs_qcom_host *host) return false; } +/* ufs-qcom-ice.c */ + +#ifdef CONFIG_SCSI_UFS_CRYPTO +int ufs_qcom_ice_init (struct ufs_qcom_host *host); +int ufs_qcom_ice_enable (struct ufs_qcom_host *host); +int ufs_qcom_ice_resume (struct ufs_qcom_host *host); +int ufs_qcom_ice_program_key (struct ufs_hba *hba, +const union ufs_crypto_cfg_entry *cfg,int slot); +#else +static inline int ufs_qcom_ice_init (struct ufs_qcom_host *host) +{ +return 0 ; +} +static inline int ufs_qcom_ice_enable (struct ufs_qcom_host *host) +{ +return 0 ; +} +static inline int ufs_qcom_ice_resume (struct ufs_qcom_host *host) +{ +return 0 ; +} +#define ufs_qcom_ice_program_key NULL +#endif /* !CONFIG_SCSI_UFS_CRYPTO */ +#endif /* UFS_QCOM_H_ */
Signature · 1 line
2.25.1
Eric Biggers
maintainerRFC PATCH v2 3/4 scsi: ufs: add program_key() variant op
In reply to Eric BiggersFrom: Eric Biggers <[email protected]>
On Snapdragon SoCs, the Linux kernel isn't permitted to directly access the standard UFS crypto configuration registers. Instead, programming and evicting keys must be done through vendor-specific SMC calls.
To support this hardware, add a ->program_key() method to 'struct ufs_hba_variant_ops'. This allows overriding the UFS standard key programming / eviction procedure.
--- drivers/scsi/ufs/ufshcd-crypto.c | 34 +++++++++++++++++++++----------- drivers/scsi/ufs/ufshcd.h | 3 +++ 2 files changed, 25 insertions(+), 12 deletions(-)
drivers/scsi/ufs/ufshcd-crypto.c +22 -12
@@ -131,14 +131,20 @@ static int ufshcd_crypto_cfg_entry_write_key(union ufs_crypto_cfg_entry *cfg,return -EINVAL ; } -static void ufshcd_program_key (struct ufs_hba *hba, -const union ufs_crypto_cfg_entry *cfg, -int slot) +static int ufshcd_program_key (struct ufs_hba *hba, +const union ufs_crypto_cfg_entry *cfg,int slot) {int i;u32 slot_offset = hba->crypto_cfg_register + slot *sizeof (*cfg); +int err =0 ;ufshcd_hold (hba, false); + +if (hba->vops && hba->vops->program_key) { + err = hba->vops->program_key (hba, cfg, slot); + goto out; + } +/* Ensure that CFGE is cleared before programming the key */ ufshcd_writel (hba,0 , slot_offset +16 *sizeof (cfg->reg_val[0 ]));for (i =0 ; i <16 ; i++) {
@@ -151,23 +157,28 @@ static void ufshcd_program_key(struct ufs_hba *hba,/* Dword 16 must be written last */ ufshcd_writel (hba,le32_to_cpu (cfg->reg_val[16 ]), slot_offset +16 *sizeof (cfg->reg_val[0 ])); +out:ufshcd_release (hba); +return err; } -static void ufshcd_clear_keyslot (struct ufs_hba *hba,int slot) +static int ufshcd_clear_keyslot (struct ufs_hba *hba,int slot) {union ufs_crypto_cfg_entry cfg = {0 }; -ufshcd_program_key (hba, &cfg, slot); +return ufshcd_program_key (hba, &cfg, slot); }/* Clear all keyslots at driver init time */ static void ufshcd_clear_all_keyslots (struct ufs_hba *hba) {int slot; +int err; -for (slot =0 ; slot <ufshcd_num_keyslots (hba); slot++) -ufshcd_clear_keyslot (hba, slot); +for (slot =0 ; slot <ufshcd_num_keyslots (hba); slot++) { + err =ufshcd_clear_keyslot (hba, slot); +WARN_ON_ONCE (err); + } } static int ufshcd_crypto_keyslot_program(struct keyslot_manager *ksm,
@@ -203,10 +214,11 @@ static int ufshcd_crypto_keyslot_program(struct keyslot_manager *ksm,if (err)return err; -ufshcd_program_key (hba, &cfg, slot); + err =ufshcd_program_key (hba, &cfg, slot);memzero_explicit (&cfg,sizeof (cfg)); -return 0 ; + +return err; } static int ufshcd_crypto_keyslot_evict(struct keyslot_manager *ksm,
@@ -223,9 +235,7 @@ static int ufshcd_crypto_keyslot_evict(struct keyslot_manager *ksm,* Clear the crypto cfg on the device. Clearing CFGE * might not be sufficient, so just clear the entire cfg. */ -ufshcd_clear_keyslot (hba, slot); - -return 0 ; +return ufshcd_clear_keyslot (hba, slot); }void ufshcd_crypto_enable (struct ufs_hba *hba)
drivers/scsi/ufs/ufshcd.h +3 -0
@@ -306,6 +306,7 @@ struct ufs_pwr_mode_info {* @dbg_register_dump: used to dump controller debug information * @phy_initialization: used to initialize phys * @device_reset: called to issue a reset pulse on the UFS device +* @program_key: program or evict an inline encryption key */ struct ufs_hba_variant_ops {const char *name;
@@ -335,6 +336,8 @@ struct ufs_hba_variant_ops {void (*dbg_register_dump)(struct ufs_hba *hba);int (*phy_initialization)(struct ufs_hba *);void (*device_reset)(struct ufs_hba *hba); +int (*program_key)(struct ufs_hba *hba, +const union ufs_crypto_cfg_entry *cfg,int slot); };/* clock gating state */
Signature · 1 line
2.25.1
Re: [RFC PATCH v2 1/4] firmware: qcom_scm: Add support for programming inline crypto keys
In reply to Eric BiggersQuoting Eric Biggers (2020-03-03 22:49:39)
Quoted 5 lines
drivers/firmware/qcom_scm.c +0
-0@@ -926,6 +927,101 @@ int qcom_scm_ocmem_unlock(enum qcom_scm_ocmem_client id, u32 offset, u32 size)
[...]
Quoted 11 lines
drivers/firmware/qcom_scm.c +11
-0+ +/** +* qcom_scm_ice_set_key() - Set an inline encryption key +* @index: the keyslot into which to set the key +* @key: the key to program +* @key_size: the size of the key in bytes +* @cipher: the encryption algorithm the key is for +* @data_unit_size: the encryption data unit size, i.e. the size of each +* individual plaintext and ciphertext. Given in 512-byte +* units, e.g. 1 = 512 bytes, 8 = 4096 bytes, etc. +*
drivers/firmware/qcom_scm.c int qcom_scm_ocmem_unlock(enum qcom_scm_ocmem_client id, u32 offset, u32 size) · line 987
Quoted 10 lines
drivers/firmware/qcom_scm.c +10
-0+* Program a key into a keyslot of Qualcomm ICE (Inline Crypto Engine), where it +* can then be used to encrypt/decrypt UFS I/O requests inline. +* +* The UFSHCI standard defines a standard way to do this, but it doesn't work on +* these SoCs; only this SCM call does. +* +* Return: 0 on success; -errno on failure. +*/ +int qcom_scm_ice_set_key (u32 index,const u8 *key,int key_size, +enum qcom_scm_ice_cipher cipher,int data_unit_size)
Why not make key_size and data_unit_size unsigned?
Quoted 8 lines
drivers/firmware/qcom_scm.c +8
-0+{ +struct qcom_scm_desc desc = { + .svc =QCOM_SCM_SVC_ES , + .cmd =QCOM_SCM_ES_CONFIG_SET_ICE_KEY , + .arginfo =QCOM_SCM_ARGS (5 ,QCOM_SCM_VAL ,QCOM_SCM_RW , +QCOM_SCM_VAL ,QCOM_SCM_VAL , +QCOM_SCM_VAL ), + .args[0 ] = index,
drivers/firmware/qcom_scm.c int qcom_scm_ocmem_unlock(enum qcom_scm_ocmem_client id, u32 offset, u32 size) · line 1005
Quoted 10 lines
drivers/firmware/qcom_scm.c +10
-0+ .args[2] = key_size, + .args[3] = cipher, + .args[4] = data_unit_size, + .owner = ARM_SMCCC_OWNER_SIP, + }; +u8 *keybuf; +dma_addr_t key_phys; +int ret; + + keybuf =kmemdup (key, key_size,GFP_KERNEL );
Is this to make the key physically contiguous? Probably worth a comment to help others understand why this is here.
Quoted 5 lines
drivers/firmware/qcom_scm.c +5
-0+if (!keybuf) +return -ENOMEM ; + + key_phys =dma_map_single (__scm->dev, keybuf, key_size,DMA_TO_DEVICE ); +if (dma_mapping_error (__scm->dev, key_phys)) {
drivers/firmware/qcom_scm.c int qcom_scm_ocmem_unlock(enum qcom_scm_ocmem_client id, u32 offset, u32 size) · line 1020
Quoted 10 lines
drivers/firmware/qcom_scm.c +10
-0+ ret = -ENOMEM ; + goto out; + } + desc.args[1 ] = key_phys; + + ret =qcom_scm_call (__scm->dev, &desc,NULL ); + +dma_unmap_single (__scm->dev, key_phys, key_size,DMA_TO_DEVICE ); +out: +kzfree (keybuf);
And this is because we want to clear key contents out of the slab? What about if the dma_map_single() bounces to a bounce buffer? I think that isn't going to happen because __scm->dev is just some firmware device that doesn't require bounce buffers but it's worth another comment to clarify this.
Quoted 7 lines
drivers/firmware/qcom_scm.c +4
-0+return ret; +} +EXPORT_SYMBOL (qcom_scm_ice_set_key); +/** * qcom_scm_hdcp_available() - Check if secure environment supports HDCP. *
Re: [RFC PATCH v2 2/4] arm64: dts: sdm845: add Inline Crypto Engine registers and clock
In reply to Eric BiggersQuoting Eric Biggers (2020-03-03 22:49:40)
arch/arm64/boot/dts/qcom/sdm845.dtsi system-cache-controller@1100000 { · line 1372
Quoted 12 lines
arch/arm64/boot/dts/qcom/sdm845.dtsi +3
-1@@ -1367,7 +1367,9 @@ system-cache-controller@1100000 { ufs_mem_hc: ufshc@1d84000 { compatible = "qcom,sdm845-ufshc", "qcom,ufshc", "jedec,ufs-2.0"; - reg = <0 0x01d84000 0 0x2500>; + reg = <0 0x01d84000 0 0x2500>, + <0 0 0 0>, + <0 0x01d90000 0 0x8000>;
Nothing against this patch but the binding for ufs is really awful. It doesn't indicate what the order of registers are, doesn't list what clks are supposed to be there, has weird microamp properties that make no sense, and has a freq-table-hz property that is almost always full of zeroes because the driver is written in some weird qcom specific way.
It would be great to fix this binding and convert it to YAML so that we can drop the cruft and clearly describe why this patch needs to introduce a reg property that is all zeroes.
arch/arm64/boot/dts/qcom/sdm845.dtsi ufs_mem_hc: ufshc@1d84000 { · line 1393
Quoted 10 lines
arch/arm64/boot/dts/qcom/sdm845.dtsi +2
-1interrupts = <GIC_SPI 265 IRQ_TYPE_LEVEL_HIGH>; phys = <&ufs_mem_phy_lanes>; phy-names = "ufsphy";@@ -1387,7 +1389,8 @@ ufs_mem_hc: ufshc@1d84000 { "ref_clk", "tx_lane0_sync_clk", "rx_lane0_sync_clk", - "rx_lane1_sync_clk"; + "rx_lane1_sync_clk", + "ice_core_clk";
Would be great to drop _clk postfix on all of these.
Quoted 14 lines
arch/arm64/boot/dts/qcom/sdm845.dtsi +2
-1clocks = <&gcc GCC_UFS_PHY_AXI_CLK>, <&gcc GCC_AGGRE_UFS_PHY_AXI_CLK>,@@ -1396,7 +1399,8 @@ ufs_mem_hc: ufshc@1d84000 { <&rpmhcc RPMH_CXO_CLK>, <&gcc GCC_UFS_PHY_TX_SYMBOL_0_CLK>, <&gcc GCC_UFS_PHY_RX_SYMBOL_0_CLK>, - <&gcc GCC_UFS_PHY_RX_SYMBOL_1_CLK>; + <&gcc GCC_UFS_PHY_RX_SYMBOL_1_CLK>, + <&gcc GCC_UFS_PHY_ICE_CORE_CLK>; freq-table-hz = <50000000 200000000>, <0 0>,
arch/arm64/boot/dts/qcom/sdm845.dtsi ufs_mem_hc: ufshc@1d84000 { · line 1413
Quoted 6 lines
arch/arm64/boot/dts/qcom/sdm845.dtsi +2
-1@@ -1405,7 +1409,8 @@ ufs_mem_hc: ufshc@1d84000 { <0 0>, <0 0>, <0 0>, - <0 0>; + <0 0>, + <0 300000000>;
This can probably be done with assigned-clock-rates, but the driver is bad.
RE: [RFC PATCH v2 3/4] scsi: ufs: add program_key() variant op
In reply to Eric BiggersEric, I strongly recommend not to support the old mechanism of calling into TEE to set keys as this has been deprecated and will not work with newer hardware. There are few issues with this patch, it adds all the code within UFS and we would have to reimplement all the common ICE code for eMMC as well. For clearing a key, the patch uses program_key to set zeroes to the keyslot, without going into details (since newer hardware is not yet public) this will not work.
We have a plan to upstream ICE support with the new hardware along with the framework to support wrapped keys and add sdhci/cqhci-crypto support.
-----Original Message-----
From: [email protected] <[email protected]> On Behalf Of Eric Biggers
Sent: Tuesday, March 3, 2020 10:50 PM
To: [email protected]; [email protected]
Cc: [email protected]; [email protected]; Alim Akhtar <[email protected]>; Andy Gross <[email protected]>; Avri Altman <[email protected]>; Barani Muthukumaran <[email protected]>; Bjorn Andersson <[email protected]>; Can Guo <[email protected]>; Elliot Berman <[email protected]>; Jaegeuk Kim <[email protected]>
Subject: [RFC PATCH v2 3/4] scsi: ufs: add program_key() variant op
From: Eric Biggers <[email protected]>
On Snapdragon SoCs, the Linux kernel isn't permitted to directly access the standard UFS crypto configuration registers. Instead, programming and evicting keys must be done through vendor-specific SMC calls.
To support this hardware, add a ->program_key() method to 'struct ufs_hba_variant_ops'. This allows overriding the UFS standard key programming / eviction procedure.
--- drivers/scsi/ufs/ufshcd-crypto.c | 34 +++++++++++++++++++++----------- drivers/scsi/ufs/ufshcd.h | 3 +++ 2 files changed, 25 insertions(+), 12 deletions(-)
(quoted diff) +0 -0
b/drivers/scsi/ufs/ufshcd-crypto.c
index cd7ca50a1dd9..7c50d1d4f58c 100644
drivers/scsi/ufs/ufshcd-crypto.c +0 -0
@@ -131,14 +131,20 @@ static int ufshcd_crypto_cfg_entry_write_key(union
ufs_crypto_cfg_entry *cfg,
return -EINVAL;
}
-static void ufshcd_program_key(struct ufs_hba *hba,
- const union ufs_crypto_cfg_entry *cfg,
- int slot)
+static int ufshcd_program_key(struct ufs_hba *hba,
+ const union ufs_crypto_cfg_entry *cfg, int
slot)
{
int i;
u32 slot_offset = hba->crypto_cfg_register + slot * sizeof(*cfg);
+ int err = 0;
ufshcd_hold(hba, false);
+
+ if (hba->vops && hba->vops->program_key) {
+ err = hba->vops->program_key(hba, cfg, slot);
+ goto out;
+ }
+
/* Ensure that CFGE is cleared before programming the key */ ufshcd_writel(hba, 0, slot_offset + 16 * sizeof(cfg->reg_val[0])); for (i = 0; i < 16; i++) {
@@ -151,23 +157,28 @@ static void ufshcd_program_key(struct ufs_hba *hba,
/* Dword 16 must be written last */
ufshcd_writel(hba, le32_to_cpu(cfg->reg_val[16]),
slot_offset + 16 * sizeof(cfg->reg_val[0]));
+out:
ufshcd_release(hba);
+ return err;
}
-static void ufshcd_clear_keyslot(struct ufs_hba *hba, int slot) +static int ufshcd_clear_keyslot(struct ufs_hba *hba, int slot)
{
union ufs_crypto_cfg_entry cfg = { 0 };
- ufshcd_program_key(hba, &cfg, slot);
+ return ufshcd_program_key(hba, &cfg, slot);
}
/* Clear all keyslots at driver init time */ static voidufshcd_clear_all_keyslots(struct ufs_hba *hba) {
int slot;
+ int err;
- for (slot = 0; slot < ufshcd_num_keyslots(hba); slot++)
- ufshcd_clear_keyslot(hba, slot);
+ for (slot = 0; slot < ufshcd_num_keyslots(hba); slot++) {
+ err = ufshcd_clear_keyslot(hba, slot);
+ WARN_ON_ONCE(err);
+ }
}
static int ufshcd_crypto_keyslot_program(struct keyslot_manager *ksm, @@
-203,10 +214,11 @@ static int ufshcd_crypto_keyslot_program(struct keyslot_manager *ksm,
if (err)
return err;
- ufshcd_program_key(hba, &cfg, slot);
+ err = ufshcd_program_key(hba, &cfg, slot);
memzero_explicit(&cfg, sizeof(cfg));
- return 0;
+
+ return err;
}
static int ufshcd_crypto_keyslot_evict(struct keyslot_manager *ksm, @@
-223,9 +235,7 @@ static int ufshcd_crypto_keyslot_evict(struct keyslot_manager *ksm,
* Clear the crypto cfg on the device. Clearing CFGE
* might not be sufficient, so just clear the entire cfg. */
- ufshcd_clear_keyslot(hba, slot);
-
- return 0;
+ return ufshcd_clear_keyslot(hba, slot);
}
void ufshcd_crypto_enable(struct ufs_hba *hba) diff --gita/drivers/scsi/ufs/ufshcd.h b/drivers/scsi/ufs/ufshcd.h index c8f948aa5e3d..c2656575e24b 100644
drivers/scsi/ufs/ufshcd.h +3 -0
@@ -306,6 +306,7 @@ struct ufs_pwr_mode_info {* @dbg_register_dump: used to dump controller debug information * @phy_initialization: used to initialize phys * @device_reset: called to issue a reset pulse on the UFS device +* @program_key: program or evict an inline encryption key */ struct ufs_hba_variant_ops {const char *name;
@@ -335,6 +336,8 @@ struct ufs_hba_variant_ops {void (*dbg_register_dump)(struct ufs_hba *hba);int (*phy_initialization)(struct ufs_hba *);void (*device_reset)(struct ufs_hba *hba); +int (*program_key)(struct ufs_hba *hba, + const union ufs_crypto_cfg_entry *cfg, int
slot);
};
/* clock gating state */
--
2.25.1
Eric Biggers
maintainerRe: [RFC PATCH v2 3/4] scsi: ufs: add program_key() variant op
Hi Barani,
Quoted 3 lines · On Wed, Mar 04, 2020 at 12:18:20PM -0800, [email protected] wrote:
Eric, I strongly recommend not to support the old mechanism of calling into TEE to set keys as this has been deprecated and will not work with newer hardware.
Actually, I've also verified that this driver works nearly as-is on Snapdragon 865 and Snapdragon 765. (Those SoCs currently lack upstream support, but I tested with downstream kernels.) IIUC, this is the latest Qualcomm hardware in the real world. Lots of phones will be shipping with those SoCS this year.
So your position is that crypto support for current Qualcomm hardware shouldn't be added, and instead we should wait years for new hardware that hasn't even been announced/released yet and has no upstream kernel support at all yet? Snapdragon 845 (via DragonBoard 845c) already has upstream support.
We can easily support multiple hardware versions in the driver, so I don't see why this is an issue.
In particular, if Qualcomm releases new hardware that just complies with the UFS standard and doesn't require these weird vendor-specific SCM calls, we can just conditionally skip the quirks when standard hardware is detected.
Quoted 3 lines
There are few issues with this patch, it adds all the code within UFS and we would have to reimplement all the common ICE code for eMMC as well.
The downstream solution of having a separate ICE "device" and "driver" is really horrendous and results in lots of layering violations and unnecessary code, since as far as I can tell ICE is actually part of the UFS and eMMC controllers and not a separate device.
So I think starting with the ICE logic in ufs-qcom is the right approach.
If it turns out that sdhci-msm needs similar ICE management code, we can put it in a library. Though, note that after I removed all the unneeded stuff, we're only talking about ~200 lines of code, so it may not even be worthwhile.
However, an issue with eMMC is that the eMMC crypto standard hasn't actually been published yet. And I haven't heard of any vendors implementing it besides Qualcomm, nor do I know of any upstream SoC we can use to develop it.
So if you want eMMC crypto support, you're going to have to help with it.
Quoted 3 lines
For clearing a key, the patch uses
program_keyto set zeroes to the keyslot, without going into details (since newer hardware is not yet public) this will not work.
That's incorrect; this patch uses the SCM call QCOM_SCM_ES_INVALIDATE_ICE_KEY to evict keys. That's exactly what the downstream driver does.
Of course, when we add support for newer hardware we can use whatever keyslot management method works on that hardware. Hopefully, it's the standard UFS method and not another weird vendor-specific method.
Quoted 2 lines
We have a plan to upstream ICE support with the new hardware along with the framework to support wrapped keys and add sdhci/cqhci-crypto support.
Great, what's the timeline on this? Are there patches you can point to anywhere? How would one get ahold of this hardware, and does it / will it have upstream kernel support like sda845 does?
- Eric
Eric Biggers
maintainerRe: [RFC PATCH v2 1/4] firmware: qcom_scm: Add support for programming inline crypto keys
In reply to Stephen BoydQuoted 22 lines · Stephen Boyd
Quoting Eric Biggers (2020-03-03 22:49:39)
Quoted 5 lines
drivers/firmware/qcom_scm.c +0
-0@@ -926,6 +927,101 @@ int qcom_scm_ocmem_unlock(enum qcom_scm_ocmem_client id, u32 offset, u32 size)[...]
Quoted 15 lines
drivers/firmware/qcom_scm.c +15
-0+ +/** +* qcom_scm_ice_set_key() - Set an inline encryption key +* @index: the keyslot into which to set the key +* @key: the key to program +* @key_size: the size of the key in bytes +* @cipher: the encryption algorithm the key is for +* @data_unit_size: the encryption data unit size, i.e. the size of each +* individual plaintext and ciphertext. Given in 512-byte +* units, e.g. 1 = 512 bytes, 8 = 4096 bytes, etc. +* +* Program a key into a keyslot of Qualcomm ICE (Inline Crypto Engine), where it +* can then be used to encrypt/decrypt UFS I/O requests inline. +* +* The UFSHCI standard defines a standard way to do this, but it doesn't work on
Quoted 8 lines
drivers/firmware/qcom_scm.c int qcom_scm_ocmem_unlock(enum qcom_scm_ocmem_client id, u32 offset, u32 size) · line 987
Quoted 6 lines
+ * these SoCs; only this SCM call does.
+ *
+ * Return: 0 on success; -errno on failure.
+ */drivers/firmware/qcom_scm.c +2
-0+int qcom_scm_ice_set_key (u32 index,const u8 *key,int key_size, +enum qcom_scm_ice_cipher cipher,int data_unit_size)Why not make
key_sizeanddata_unit_sizeunsigned?
No reason other than that 'int' is fewer characters and is a good default when no other particular type is warranted. But I can change them to 'unsigned int' if people prefer to make it clearer that they can't be negative.
Quoted 14 lines
Quoted 14 lines
drivers/firmware/qcom_scm.c +13
-0+{ +struct qcom_scm_desc desc = { + .svc =QCOM_SCM_SVC_ES , + .cmd =QCOM_SCM_ES_CONFIG_SET_ICE_KEY , + .arginfo =QCOM_SCM_ARGS (5 ,QCOM_SCM_VAL ,QCOM_SCM_RW , +QCOM_SCM_VAL ,QCOM_SCM_VAL , +QCOM_SCM_VAL ), + .args[0 ] = index, + .args[2 ] = key_size, + .args[3 ] = cipher, + .args[4 ] = data_unit_size, + .owner =ARM_SMCCC_OWNER_SIP , + };
Quoted 8 lines
drivers/firmware/qcom_scm.c int qcom_scm_ocmem_unlock(enum qcom_scm_ocmem_client id, u32 offset, u32 size) · line 1005
Quoted 5 lines
drivers/firmware/qcom_scm.c +5
-0+u8 *keybuf; +dma_addr_t key_phys; +int ret; + + keybuf =kmemdup (key, key_size,GFP_KERNEL );Is this to make the key physically contiguous? Probably worth a comment to help others understand why this is here.
Yes, dma_map_single() requires physically contiguous memory. I'll add a comment.
Quoted 14 lines
Quoted 14 lines
drivers/firmware/qcom_scm.c +13
-0+if (!keybuf) +return -ENOMEM ; + + key_phys =dma_map_single (__scm->dev, keybuf, key_size,DMA_TO_DEVICE ); +if (dma_mapping_error (__scm->dev, key_phys)) { + ret = -ENOMEM ; + goto out; + } + desc.args[1 ] = key_phys; + + ret =qcom_scm_call (__scm->dev, &desc,NULL ); + +dma_unmap_single (__scm->dev, key_phys, key_size,DMA_TO_DEVICE );
Quoted 8 lines
drivers/firmware/qcom_scm.c int qcom_scm_ocmem_unlock(enum qcom_scm_ocmem_client id, u32 offset, u32 size) · line 1020
Quoted 2 lines
drivers/firmware/qcom_scm.c +2
-0+out: +kzfree (keybuf);And this is because we want to clear key contents out of the slab? What about if the
dma_map_single()bounces to a bounce buffer? I think that isn't going to happen because__scm->devis just some firmware device that doesn't require bounce buffers but it's worth another comment to clarify this.
Yes, in crypto-related code we always try to wipe keys after use. I don't think a bounce buffer would actually be used here, though it would be preferable to wipe the DMA memory too so that we don't rely on that. But I didn't see how to do that; I'm not a DMA API expert. Maybe dma_alloc_coherent()? This isn't really performance-critical.
- Eric