Inline crypto support on DragonBoard 845c
Subsystems (6)
Eric Biggers
maintainerv3 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 v8 00/11] 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://lore.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. (Note that unlike UFS, the eMMC crypto standard hasn't yet published, and I haven't yet found any upstream SoC that supports eMMC crypto.)
Due to these factors and others, I was able to greatly simplify the driver from the vendor's original. It works fine in testing with fscrypt and with a blk-crypto self-test I'm also working on.
This driver also works nearly as-is on Snapdragon 765 and Snapdragon 865, which are very recent SoCs, having just been announced in Dec 2019 (though these newer SoCs currently lack upstream kernel support).
This patchset is also available in git at:
Repo: https://git.kernel.org/pub/scm/linux/kernel/git/ebiggers/linux.git Tag: db845c-crypto-v3
Changed v2 => v3:
- Rebased onto the v8 inline encryption patchset. Now the driver has to opt into inline crypto support rather than opting out.
- Switched qcom_scm_ice_set_key() to use dma_alloc_coherent() so that we can reliably zeroing the key without assuming that bounce buffers aren't used. Also added a comment.
- Made the key_size and data_unit_size arguments to qcom_scm_ice_set_key() be 'u32' instead of 'int'.
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 | 101 +++++++++++ drivers/firmware/qcom_scm.h | 4 + drivers/scsi/ufs/Kconfig | 1 + drivers/scsi/ufs/Makefile | 4 +- drivers/scsi/ufs/ufs-qcom-ice.c | 244 +++++++++++++++++++++++++++ drivers/scsi/ufs/ufs-qcom.c | 12 +- drivers/scsi/ufs/ufs-qcom.h | 27 +++ drivers/scsi/ufs/ufshcd-crypto.c | 33 ++-- drivers/scsi/ufs/ufshcd.h | 3 + include/linux/qcom_scm.h | 19 +++ 12 files changed, 444 insertions(+), 19 deletions(-) create mode 100644 drivers/scsi/ufs/ufs-qcom-ice.c
Signature · 1 line
2.25.1
Eric Biggers
maintainerRFC PATCH v3 1/4 firmware: qcom_scm: Add support for programming inline crypto keys
From: 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 | 101 ++++++++++++++++++++++++++++++++++++ drivers/firmware/qcom_scm.h | 4 ++ include/linux/qcom_scm.h | 19 +++++++ 3 files changed, 124 insertions(+)
drivers/firmware/qcom_scm.c +101 -0
@@ -926,6 +926,107 @@ 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,u32 key_size, +enum qcom_scm_ice_cipher cipher,u32 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 , + }; +void *keybuf; +dma_addr_t key_phys; +int ret; + +/* +* 'key' may point to vmalloc()'ed memory, but we need to pass a +* physical address that's been properly flushed. The sanctioned way to +* do this is by using the DMA API. But as is best practice for crypto +* keys, we also must wipe the key after use. This makes kmemdup() + +* dma_map_single() not clearly correct, since the DMA API can use +* bounce buffers. Instead, just use dma_alloc_coherent(). Programming +* keys is normally rare and thus not performance-critical. +*/ + + keybuf =dma_alloc_coherent (__scm->dev, key_size, &key_phys, +GFP_KERNEL ); +if (!keybuf) +return -ENOMEM ; +memcpy (keybuf, key, key_size); + desc.args[1 ] = key_phys; + + ret =qcom_scm_call (__scm->dev, &desc,NULL ); + +memset (keybuf,0 , key_size); + +dma_free_coherent (__scm->dev, key_size, keybuf, key_phys); +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,u32 key_size, +enum qcom_scm_ice_cipher cipher, +u32 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,u32 key_size, +enum qcom_scm_ice_cipher cipher, +u32 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 v3 2/4 arm64: dts: sdm845: add Inline Crypto Engine registers and clock
In reply to Eric BiggersFrom: 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 v3 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 | 33 ++++++++++++++++++++------------ drivers/scsi/ufs/ufshcd.h | 3 +++ 2 files changed, 24 insertions(+), 12 deletions(-)
drivers/scsi/ufs/ufshcd-crypto.c +21 -12
@@ -144,14 +144,20 @@ static blk_status_t ufshcd_crypto_cfg_entry_write_key(return BLK_STS_IOERR ; } -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++) {
@@ -164,23 +170,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 blk_status_t ufshcd_crypto_keyslot_program(struct keyslot_manager *ksm,
@@ -216,10 +227,10 @@ static blk_status_t ufshcd_crypto_keyslot_program(struct keyslot_manager *ksm,if (err)return err; -ufshcd_program_key (hba, &cfg, slot); + err =errno_to_blk_status (ufshcd_program_key (hba, &cfg, slot));memzero_explicit (&cfg,sizeof (cfg)); -return BLK_STS_OK ; +return err; } static int ufshcd_crypto_keyslot_evict(struct keyslot_manager *ksm,
@@ -236,9 +247,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
Eric Biggers
maintainerRFC PATCH v3 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 and runs the upstream Linux kernel. 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, both manually using ext4 encryption and automatically using a block layer self-test I've written.
This driver also works nearly as-is on Snapdragon 765 and Snapdragon 865, which are very recent SoCs, having just been announced in Dec 2019 (though these newer SoCs currently lack upstream kernel support).
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 | 12 +- drivers/scsi/ufs/ufs-qcom.h | 27 ++++ 6 files changed, 287 insertions(+), 3 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 +11 -1
@@ -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 ; }
@@ -1011,6 +1015,7 @@ static void ufs_qcom_set_caps(struct ufs_hba *hba) hba->caps |=UFSHCD_CAP_CLK_GATING |UFSHCD_CAP_HIBERN8_WITH_CLK_GATING ; hba->caps |=UFSHCD_CAP_CLK_SCALING ; hba->caps |=UFSHCD_CAP_AUTO_BKOPS_SUSPEND ; + hba->caps |=UFSHCD_CAP_CRYPTO ;if (host->hw_ver.major >=0x2 ) { host->caps = UFS_QCOM_CAP_QUNIPRO |
@@ -1238,6 +1243,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 )
@@ -1651,6 +1660,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
RE: [RFC PATCH v3 4/4] scsi: ufs-qcom: add Inline Crypto Engine support
Hi Eric,
I am confused on why you are trying to re-implement functions already present within the crypto_vops. Is there a reason why the ICE driver cannot register for KSM with its own function for keyslot_program and keyslot_evict and register for crypto_vops with its own functions for 'init/enable/disable/suspend/resume/debug'. Given that the ufs-crypto has the interface to do this why do we have to re-implement the same functionality with another set of functions. In addition in the future if for performance reasons (with per-file keys) we have to use passthrough KSM and use prepare/complete_lrbp_crypto that can easily be added as well.
IMO the crypto_vops is a clean way for vendors to override the default functionality rather than using direct function calls from within the UFS driver and this can easily be extended for eMMC.
-----Original Message-----
From: Eric Biggers <[email protected]>
Sent: Thursday, March 12, 2020 10:13 AM
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]>; [email protected]; Can Guo <[email protected]>; Elliot Berman <[email protected]>; Jaegeuk Kim <[email protected]>; John Stultz <[email protected]>; Satya Tangirala <[email protected]>
Subject: [EXT] [RFC PATCH v3 4/4] scsi: ufs-qcom: add Inline Crypto Engine support
From: 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 and runs the upstream Linux kernel. 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, both manually using ext4 encryption and automatically using a block layer self-test I've written.
This driver also works nearly as-is on Snapdragon 765 and Snapdragon 865, which are very recent SoCs, having just been announced in Dec 2019 (though these newer SoCs currently lack upstream kernel support).
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 | 12 +- drivers/scsi/ufs/ufs-qcom.h | 27 ++++ 6 files changed, 287 insertions(+), 3 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 +2 -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 +237 -0
237 lines not on this page · raw message
drivers/scsi/ufs/ufs-qcom.c +1 -1
@@ -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;
}
@@ -1011,6 +1015,7 @@ static void ufs_qcom_set_caps(struct ufs_hba *hba)
hba->caps |= UFSHCD_CAP_CLK_GATING | UFSHCD_CAP_HIBERN8_WITH_CLK_GATING; hba->caps |= UFSHCD_CAP_CLK_SCALING; hba->caps |= UFSHCD_CAP_AUTO_BKOPS_SUSPEND; +hba->caps |= UFSHCD_CAP_CRYPTO;
if (host->hw_ver.major >= 0x2) {
host->caps = UFS_QCOM_CAP_QUNIPRO |
@@ -1238,6 +1243,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) @@ -1651,6 +1660,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 +23 -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_ */
--
2.25.1
Eric Biggers
maintainerRe: [RFC PATCH v3 4/4] scsi: ufs-qcom: add Inline Crypto Engine support
Hi Barani,
Quoted 12 lines · Barani Muthukumaran
Hi Eric,
I am confused on why you are trying to re-implement functions already present within the
crypto_vops. Is there a reason why the ICE driver cannot register for KSM with its own function forkeyslot_programandkeyslot_evictand register forcrypto_vopswith its own functions for 'init/enable/disable/suspend/resume/debug'. Given that the ufs-crypto has the interface to do this why do we have to re-implement the same functionality with another set of functions. In addition in the future if for performance reasons (with per-file keys) we have to use passthrough KSM and use prepare/complete_lrbp_crypto that can easily be added as well.
Quoted 3 lines
IMO the
crypto_vopsis a clean way for vendors to override the default functionality rather than using direct function calls from within the UFS driver and this can easily be extended for eMMC.
ufshcd_hba_crypto_variant_ops doesn't exist in the patchset for upstream.
We had to add ufshcd_hba_crypto_variant_ops out-of-tree to the Android common kernels to unblock vendors implementing their drivers this year, because we didn't know exactly what functionality they'd need. So we just had to guess and add ~10 different operations just in case people needed them. (Note that some or all of these may go away next year, once we see what was actually used.)
That's not acceptable for upstream. For upstream we can only add variant operations that are actually used by in-tree drivers.
So far the only hardware support actually proposed upstream are my patch for ufs-qcom, and Stanley's patch for ufs-mediatek. ufs-qcom only needs ->program_key(), and ufs-mediatek doesn't need any new variant op.
So, that's why only ->program_key() has been proposed upstream thus far: it's the minimal functionality that's been demonstrated to be needed.
Of course, if someone actually posts patches to support hardware that diverges from the UFS standard in new and "exciting" ways (whether it's another vendor's hardware or future Qualcomm hardware) then they'll need to post any variant operation(s) they need. They need to be targetted to only the specific quirk(s) needed, so that drivers don't have to unnecessarily re-implement stuff.
- Eric
RE: [RFC PATCH v3 4/4] scsi: ufs-qcom: add Inline Crypto Engine support
Hi Eric,
The crypto_variant_ops exposed were not a guess, we had worked with Satya to add the functionality that is required.
Can we define the below crypto_variant_ops that exposes the same functionality you have added, this allows us to extend this in the future in a seamless manner. As an example QC implementation uses 'debug', 'suspend' and we can add that when we upstream the implementation in the next few weeks once our validation is complete. Thanks.
struct ufs_hba_crypto_variant_ops {
int (*hba_init_crypto)(struct ufs_hba *hba,
const struct keyslot_mgmt_ll_ops *ksm_ops);
void (*enable)(struct ufs_hba *hba);
int (*resume)(struct ufs_hba *hba);
int (*program_key(struct ufs_hba *hba,
const union ufs_crypto_cfg_entry *cfg, int slot);
};-----Original Message-----
From: Eric Biggers <[email protected]>
Sent: Thursday, March 12, 2020 12:06 PM
To: Barani Muthukumaran <[email protected]>
Cc: [email protected]; [email protected]; [email protected]; [email protected]; Alim Akhtar <[email protected]>; Andy Gross <[email protected]>; Avri Altman <[email protected]>; [email protected]; Can Guo <[email protected]>; Elliot Berman <[email protected]>; Jaegeuk Kim <[email protected]>; John Stultz <[email protected]>; Satya Tangirala <[email protected]>
Subject: [EXT] Re: [RFC PATCH v3 4/4] scsi: ufs-qcom: add Inline Crypto Engine support
Hi Barani,
Quoted 12 lines · Barani Muthukumaran
Hi Eric,
I am confused on why you are trying to re-implement functions already present within the
crypto_vops. Is there a reason why the ICE driver cannot register for KSM with its own function forkeyslot_programandkeyslot_evictand register forcrypto_vopswith its own functions for 'init/enable/disable/suspend/resume/debug'. Given that the ufs-crypto has the interface to do this why do we have to re-implement the same functionality with another set of functions. In addition in the future if for performance reasons (with per-file keys) we have to use passthrough KSM and use prepare/complete_lrbp_crypto that can easily be added as well.
Quoted 3 lines
IMO the
crypto_vopsis a clean way for vendors to override the default functionality rather than using direct function calls from within the UFS driver and this can easily be extended for eMMC.
ufshcd_hba_crypto_variant_ops doesn't exist in the patchset for upstream.
We had to add ufshcd_hba_crypto_variant_ops out-of-tree to the Android common kernels to unblock vendors implementing their drivers this year, because we didn't know exactly what functionality they'd need. So we just had to guess and add ~10 different operations just in case people needed them. (Note that some or all of these may go away next year, once we see what was actually used.)
That's not acceptable for upstream. For upstream we can only add variant operations that are actually used by in-tree drivers.
So far the only hardware support actually proposed upstream are my patch for ufs-qcom, and Stanley's patch for ufs-mediatek. ufs-qcom only needs ->program_key(), and ufs-mediatek doesn't need any new variant op.
So, that's why only ->program_key() has been proposed upstream thus far: it's the minimal functionality that's been demonstrated to be needed.
Of course, if someone actually posts patches to support hardware that diverges from the UFS standard in new and "exciting" ways (whether it's another vendor's hardware or future Qualcomm hardware) then they'll need to post any variant operation(s) they need. They need to be targetted to only the specific quirk(s) needed, so that drivers don't have to unnecessarily re-implement stuff.
- Eric
Eric Biggers
maintainerRe: [RFC PATCH v3 4/4] scsi: ufs-qcom: add Inline Crypto Engine support
Quoted 4 lines · Barani Muthukumaran
Hi Eric,
The
crypto_variant_opsexposed were not a guess, we had worked with Satya to add the functionality that is required.
As far as I can tell, my patch works fine with just the new ->program_key() variant op.
Note that I'm also taking advantage of some of the existing, non-crypto-specific variant ops. For example, I didn't need to add a ->crypto_resume() operation because there's already ufs_hba_variant_ops::resume().
I understand that the old downstream ICE code defined and used a lot of crypto variant ops, which did give the impression that a lot more would be needed. But ultimately I found that most of them were unnecessary or could be replaced with the existing non-crypto-specific variant ops.
Quoted 6 lines
Can we define the below
crypto_variant_opsthat exposes the same functionality you have added, this allows us to extend this in the future in a seamless manner. As an example QC implementation uses 'debug', 'suspend' and we can add that when we upstream the implementation in the next few weeks once our validation is complete. Thanks.
Quoted 8 lines
struct
ufs_hba_crypto_variant_ops{
int (*hba_init_crypto)(structufs_hba*hba,const struct keyslot_mgmt_ll_ops *ksm_ops); void (*enable)(struct ufs_hba *hba); int (*resume)(struct ufs_hba *hba); int (*program_key(struct ufs_hba *hba, const union ufs_crypto_cfg_entry *cfg, int slot); };
To re-iterate, upstream doesn't add hooks with no in-tree users.
It's great to hear that you'll be sending out a patchset soon. Just send out the hooks you need along with them, so that they can all be properly reviewed.
- Eric
Re: [RFC PATCH v3 4/4] scsi: ufs-qcom: add Inline Crypto Engine support
In reply to Eric BiggersQuoted 5 lines · Eric Biggers
Of course, if someone actually posts patches to support hardware that diverges from the UFS standard in new and "exciting" ways (whether it's another vendor's hardware or future Qualcomm hardware) then they'll need to post any variant operation(s) they need. They need to be targetted to only the specific quirk(s) needed, so that drivers don't have to unnecessarily re-implement stuff.
I think the only sane answer is that we only support hardware upstream that conforms to the standard and we skip all that bullshit. The whole point of the standard is that things just work, and we should not give vendors a wild card to come up with bullshit like the interfaces handled in this patchset.