mirror of
				https://github.com/torvalds/linux.git
				synced 2025-11-04 02:30:34 +02:00 
			
		
		
		
	Split the drivers/scsi/ufs directory into 'core' and 'host' directories under the drivers/ufs/ directory. Move shared header files into the include/ufs/ directory. This separation makes it clear which header files UFS drivers are allowed to include (include/ufs/*.h) and which header files UFS drivers are not allowed to include (drivers/ufs/core/*.h). Update the MAINTAINERS file. Add myself as a UFS reviewer. Link: https://lore.kernel.org/r/20220511212552.655341-1-bvanassche@acm.org Cc: Adrian Hunter <adrian.hunter@intel.com> Cc: Avri Altman <avri.altman@wdc.com> Cc: Bean Huo <beanhuo@micron.com> Cc: Bjorn Andersson <bjorn.andersson@linaro.org> Cc: Keoseong Park <keosung.park@samsung.com> Tested-by: Bean Huo <beanhuo@micron.com> Tested-by: Adrian Hunter <adrian.hunter@intel.com> Reviewed-by: Bean Huo <beanhuo@micron.com> Acked-by: Avri Altman <avri.altman@wdc.com> Acked-by: Adrian Hunter <adrian.hunter@intel.com> Signed-off-by: Bart Van Assche <bvanassche@acm.org> Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
		
			
				
	
	
		
			245 lines
		
	
	
	
		
			6.6 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			245 lines
		
	
	
	
		
			6.6 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
// SPDX-License-Identifier: GPL-2.0-only
 | 
						|
/*
 | 
						|
 * Qualcomm ICE (Inline Crypto Engine) support.
 | 
						|
 *
 | 
						|
 * Copyright (c) 2014-2019, The Linux Foundation. All rights reserved.
 | 
						|
 * Copyright 2019 Google LLC
 | 
						|
 */
 | 
						|
 | 
						|
#include <linux/delay.h>
 | 
						|
#include <linux/platform_device.h>
 | 
						|
#include <linux/qcom_scm.h>
 | 
						|
 | 
						|
#include "ufs-qcom.h"
 | 
						|
 | 
						|
#define AES_256_XTS_KEY_SIZE			64
 | 
						|
 | 
						|
/* QCOM ICE registers */
 | 
						|
 | 
						|
#define QCOM_ICE_REG_CONTROL			0x0000
 | 
						|
#define QCOM_ICE_REG_RESET			0x0004
 | 
						|
#define QCOM_ICE_REG_VERSION			0x0008
 | 
						|
#define QCOM_ICE_REG_FUSE_SETTING		0x0010
 | 
						|
#define QCOM_ICE_REG_PARAMETERS_1		0x0014
 | 
						|
#define QCOM_ICE_REG_PARAMETERS_2		0x0018
 | 
						|
#define QCOM_ICE_REG_PARAMETERS_3		0x001C
 | 
						|
#define QCOM_ICE_REG_PARAMETERS_4		0x0020
 | 
						|
#define QCOM_ICE_REG_PARAMETERS_5		0x0024
 | 
						|
 | 
						|
/* QCOM ICE v3.X only */
 | 
						|
#define QCOM_ICE_GENERAL_ERR_STTS		0x0040
 | 
						|
#define QCOM_ICE_INVALID_CCFG_ERR_STTS		0x0030
 | 
						|
#define QCOM_ICE_GENERAL_ERR_MASK		0x0044
 | 
						|
 | 
						|
/* QCOM ICE v2.X only */
 | 
						|
#define QCOM_ICE_REG_NON_SEC_IRQ_STTS		0x0040
 | 
						|
#define QCOM_ICE_REG_NON_SEC_IRQ_MASK		0x0044
 | 
						|
 | 
						|
#define QCOM_ICE_REG_NON_SEC_IRQ_CLR		0x0048
 | 
						|
#define QCOM_ICE_REG_STREAM1_ERROR_SYNDROME1	0x0050
 | 
						|
#define QCOM_ICE_REG_STREAM1_ERROR_SYNDROME2	0x0054
 | 
						|
#define QCOM_ICE_REG_STREAM2_ERROR_SYNDROME1	0x0058
 | 
						|
#define QCOM_ICE_REG_STREAM2_ERROR_SYNDROME2	0x005C
 | 
						|
#define QCOM_ICE_REG_STREAM1_BIST_ERROR_VEC	0x0060
 | 
						|
#define QCOM_ICE_REG_STREAM2_BIST_ERROR_VEC	0x0064
 | 
						|
#define QCOM_ICE_REG_STREAM1_BIST_FINISH_VEC	0x0068
 | 
						|
#define QCOM_ICE_REG_STREAM2_BIST_FINISH_VEC	0x006C
 | 
						|
#define QCOM_ICE_REG_BIST_STATUS		0x0070
 | 
						|
#define QCOM_ICE_REG_BYPASS_STATUS		0x0074
 | 
						|
#define QCOM_ICE_REG_ADVANCED_CONTROL		0x1000
 | 
						|
#define QCOM_ICE_REG_ENDIAN_SWAP		0x1004
 | 
						|
#define QCOM_ICE_REG_TEST_BUS_CONTROL		0x1010
 | 
						|
#define QCOM_ICE_REG_TEST_BUS_REG		0x1014
 | 
						|
 | 
						|
/* BIST ("built-in self-test"?) status flags */
 | 
						|
#define QCOM_ICE_BIST_STATUS_MASK		0xF0000000
 | 
						|
 | 
						|
#define QCOM_ICE_FUSE_SETTING_MASK		0x1
 | 
						|
#define QCOM_ICE_FORCE_HW_KEY0_SETTING_MASK	0x2
 | 
						|
#define QCOM_ICE_FORCE_HW_KEY1_SETTING_MASK	0x4
 | 
						|
 | 
						|
#define qcom_ice_writel(host, val, reg)	\
 | 
						|
	writel((val), (host)->ice_mmio + (reg))
 | 
						|
#define qcom_ice_readl(host, reg)	\
 | 
						|
	readl((host)->ice_mmio + (reg))
 | 
						|
 | 
						|
static bool qcom_ice_supported(struct ufs_qcom_host *host)
 | 
						|
{
 | 
						|
	struct device *dev = host->hba->dev;
 | 
						|
	u32 regval = qcom_ice_readl(host, QCOM_ICE_REG_VERSION);
 | 
						|
	int major = regval >> 24;
 | 
						|
	int minor = (regval >> 16) & 0xFF;
 | 
						|
	int step = regval & 0xFFFF;
 | 
						|
 | 
						|
	/* For now this driver only supports ICE version 3. */
 | 
						|
	if (major != 3) {
 | 
						|
		dev_warn(dev, "Unsupported ICE version: v%d.%d.%d\n",
 | 
						|
			 major, minor, step);
 | 
						|
		return false;
 | 
						|
	}
 | 
						|
 | 
						|
	dev_info(dev, "Found QC Inline Crypto Engine (ICE) v%d.%d.%d\n",
 | 
						|
		 major, minor, step);
 | 
						|
 | 
						|
	/* If fuses are blown, ICE might not work in the standard way. */
 | 
						|
	regval = qcom_ice_readl(host, QCOM_ICE_REG_FUSE_SETTING);
 | 
						|
	if (regval & (QCOM_ICE_FUSE_SETTING_MASK |
 | 
						|
		      QCOM_ICE_FORCE_HW_KEY0_SETTING_MASK |
 | 
						|
		      QCOM_ICE_FORCE_HW_KEY1_SETTING_MASK)) {
 | 
						|
		dev_warn(dev, "Fuses are blown; ICE is unusable!\n");
 | 
						|
		return false;
 | 
						|
	}
 | 
						|
	return true;
 | 
						|
}
 | 
						|
 | 
						|
int ufs_qcom_ice_init(struct ufs_qcom_host *host)
 | 
						|
{
 | 
						|
	struct ufs_hba *hba = host->hba;
 | 
						|
	struct device *dev = hba->dev;
 | 
						|
	struct platform_device *pdev = to_platform_device(dev);
 | 
						|
	struct resource *res;
 | 
						|
	int err;
 | 
						|
 | 
						|
	if (!(ufshcd_readl(hba, REG_CONTROLLER_CAPABILITIES) &
 | 
						|
	      MASK_CRYPTO_SUPPORT))
 | 
						|
		return 0;
 | 
						|
 | 
						|
	res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "ice");
 | 
						|
	if (!res) {
 | 
						|
		dev_warn(dev, "ICE registers not found\n");
 | 
						|
		goto disable;
 | 
						|
	}
 | 
						|
 | 
						|
	if (!qcom_scm_ice_available()) {
 | 
						|
		dev_warn(dev, "ICE SCM interface not found\n");
 | 
						|
		goto disable;
 | 
						|
	}
 | 
						|
 | 
						|
	host->ice_mmio = devm_ioremap_resource(dev, res);
 | 
						|
	if (IS_ERR(host->ice_mmio)) {
 | 
						|
		err = PTR_ERR(host->ice_mmio);
 | 
						|
		dev_err(dev, "Failed to map ICE registers; err=%d\n", err);
 | 
						|
		return err;
 | 
						|
	}
 | 
						|
 | 
						|
	if (!qcom_ice_supported(host))
 | 
						|
		goto disable;
 | 
						|
 | 
						|
	return 0;
 | 
						|
 | 
						|
disable:
 | 
						|
	dev_warn(dev, "Disabling inline encryption support\n");
 | 
						|
	hba->caps &= ~UFSHCD_CAP_CRYPTO;
 | 
						|
	return 0;
 | 
						|
}
 | 
						|
 | 
						|
static void qcom_ice_low_power_mode_enable(struct ufs_qcom_host *host)
 | 
						|
{
 | 
						|
	u32 regval;
 | 
						|
 | 
						|
	regval = qcom_ice_readl(host, QCOM_ICE_REG_ADVANCED_CONTROL);
 | 
						|
	/*
 | 
						|
	 * Enable low power mode sequence
 | 
						|
	 * [0]-0, [1]-0, [2]-0, [3]-E, [4]-0, [5]-0, [6]-0, [7]-0
 | 
						|
	 */
 | 
						|
	regval |= 0x7000;
 | 
						|
	qcom_ice_writel(host, regval, QCOM_ICE_REG_ADVANCED_CONTROL);
 | 
						|
}
 | 
						|
 | 
						|
static void qcom_ice_optimization_enable(struct ufs_qcom_host *host)
 | 
						|
{
 | 
						|
	u32 regval;
 | 
						|
 | 
						|
	/* ICE Optimizations Enable Sequence */
 | 
						|
	regval = qcom_ice_readl(host, QCOM_ICE_REG_ADVANCED_CONTROL);
 | 
						|
	regval |= 0xD807100;
 | 
						|
	/* ICE HPG requires delay before writing */
 | 
						|
	udelay(5);
 | 
						|
	qcom_ice_writel(host, regval, QCOM_ICE_REG_ADVANCED_CONTROL);
 | 
						|
	udelay(5);
 | 
						|
}
 | 
						|
 | 
						|
int ufs_qcom_ice_enable(struct ufs_qcom_host *host)
 | 
						|
{
 | 
						|
	if (!(host->hba->caps & UFSHCD_CAP_CRYPTO))
 | 
						|
		return 0;
 | 
						|
	qcom_ice_low_power_mode_enable(host);
 | 
						|
	qcom_ice_optimization_enable(host);
 | 
						|
	return ufs_qcom_ice_resume(host);
 | 
						|
}
 | 
						|
 | 
						|
/* Poll until all BIST bits are reset */
 | 
						|
static int qcom_ice_wait_bist_status(struct ufs_qcom_host *host)
 | 
						|
{
 | 
						|
	int count;
 | 
						|
	u32 reg;
 | 
						|
 | 
						|
	for (count = 0; count < 100; count++) {
 | 
						|
		reg = qcom_ice_readl(host, QCOM_ICE_REG_BIST_STATUS);
 | 
						|
		if (!(reg & QCOM_ICE_BIST_STATUS_MASK))
 | 
						|
			break;
 | 
						|
		udelay(50);
 | 
						|
	}
 | 
						|
	if (reg)
 | 
						|
		return -ETIMEDOUT;
 | 
						|
	return 0;
 | 
						|
}
 | 
						|
 | 
						|
int ufs_qcom_ice_resume(struct ufs_qcom_host *host)
 | 
						|
{
 | 
						|
	int err;
 | 
						|
 | 
						|
	if (!(host->hba->caps & UFSHCD_CAP_CRYPTO))
 | 
						|
		return 0;
 | 
						|
 | 
						|
	err = qcom_ice_wait_bist_status(host);
 | 
						|
	if (err) {
 | 
						|
		dev_err(host->hba->dev, "BIST status error (%d)\n", err);
 | 
						|
		return err;
 | 
						|
	}
 | 
						|
	return 0;
 | 
						|
}
 | 
						|
 | 
						|
/*
 | 
						|
 * Program a key into a QC ICE keyslot, or evict a keyslot.  QC ICE requires
 | 
						|
 * vendor-specific SCM calls for this; it doesn't support the standard way.
 | 
						|
 */
 | 
						|
int ufs_qcom_ice_program_key(struct ufs_hba *hba,
 | 
						|
			     const union ufs_crypto_cfg_entry *cfg, int slot)
 | 
						|
{
 | 
						|
	union ufs_crypto_cap_entry cap;
 | 
						|
	union {
 | 
						|
		u8 bytes[AES_256_XTS_KEY_SIZE];
 | 
						|
		u32 words[AES_256_XTS_KEY_SIZE / sizeof(u32)];
 | 
						|
	} key;
 | 
						|
	int i;
 | 
						|
	int err;
 | 
						|
 | 
						|
	if (!(cfg->config_enable & UFS_CRYPTO_CONFIGURATION_ENABLE))
 | 
						|
		return qcom_scm_ice_invalidate_key(slot);
 | 
						|
 | 
						|
	/* Only AES-256-XTS has been tested so far. */
 | 
						|
	cap = hba->crypto_cap_array[cfg->crypto_cap_idx];
 | 
						|
	if (cap.algorithm_id != UFS_CRYPTO_ALG_AES_XTS ||
 | 
						|
	    cap.key_size != UFS_CRYPTO_KEY_SIZE_256) {
 | 
						|
		dev_err_ratelimited(hba->dev,
 | 
						|
				    "Unhandled crypto capability; algorithm_id=%d, key_size=%d\n",
 | 
						|
				    cap.algorithm_id, cap.key_size);
 | 
						|
		return -EINVAL;
 | 
						|
	}
 | 
						|
 | 
						|
	memcpy(key.bytes, cfg->crypto_key, AES_256_XTS_KEY_SIZE);
 | 
						|
 | 
						|
	/*
 | 
						|
	 * The SCM call byte-swaps the 32-bit words of the key.  So we have to
 | 
						|
	 * do the same, in order for the final key be correct.
 | 
						|
	 */
 | 
						|
	for (i = 0; i < ARRAY_SIZE(key.words); i++)
 | 
						|
		__cpu_to_be32s(&key.words[i]);
 | 
						|
 | 
						|
	err = qcom_scm_ice_set_key(slot, key.bytes, AES_256_XTS_KEY_SIZE,
 | 
						|
				   QCOM_SCM_ICE_CIPHER_AES_256_XTS,
 | 
						|
				   cfg->data_unit_size);
 | 
						|
	memzero_explicit(&key, sizeof(key));
 | 
						|
	return err;
 | 
						|
}
 |