Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
DMARC-Filter: OpenDMARC Filter v1.3.2 smtp.codeaurora.org 29D99C433CB
Subject: Re: [PATCH v4 3/4] nvmem: qfprom: Add fuse blowing support
To:     Douglas Anderson <dianders@chromium.org>,
        Srinivas Kandagatla <srinivas.kandagatla@linaro.org>,
        Rob Herring <robh+dt@kernel.org>,
        Bjorn Andersson <bjorn.andersson@linaro.org>,
        Andy Gross <agross@kernel.org>
Cc:     mturney@codeaurora.org, Jeffrey Hugo <jhugo@codeaurora.org>,
        rnayak@codeaurora.org, dhavalp@codeaurora.org,
        saiprakash.ranjan@codeaurora.org, sparate@codeaurora.org,
        linux-arm-msm@vger.kernel.org, mkurumel@codeaurora.org,
        linux-kernel@vger.kernel.org
References: <20200622144929.230498-1-dianders@chromium.org>
 <20200622074845.v4.3.I68222d0b5966f652f29dd3a73ab33551a6e3b7e0@changeid>
From:   "Ravi Kumar Bokka (Temp)" <rbokka@codeaurora.org>
Message-ID: <850240a0-a8c2-9bca-b17e-5452ce2f9c10@codeaurora.org>
Date:   Wed, 1 Jul 2020 20:39:07 +0530
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:68.0) Gecko/20100101
 Thunderbird/68.9.0
MIME-Version: 1.0
In-Reply-To: <20200622074845.v4.3.I68222d0b5966f652f29dd3a73ab33551a6e3b7e0@changeid>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

Hi Doug,
I have tested v4 changes internally on target, if i am giving input as 
unaligned address, it's not throwing any error message.


On 6/22/2020 8:19 PM, Douglas Anderson wrote:
> From: Ravi Kumar Bokka <rbokka@codeaurora.org>
> 
> This patch adds support for blowing fuses to the qfprom driver if the
> required properties are defined in the device tree.
> 
> Signed-off-by: Ravi Kumar Bokka <rbokka@codeaurora.org>
> Signed-off-by: Douglas Anderson <dianders@chromium.org>
> ---
> 
> Changes in v4:
> - Only get clock/regulator if all address ranges are provided.
> - Don't use optional version of clk_get now.
> - Clock name is "core", not "sec".
> - Cleaned up error message if couldn't get clock.
> - Fixed up minor version mask.
> - Use GENMASK to generate masks.
> 
> Changes in v3:
> - Don't provide "reset" value for things; just save/restore.
> - Use the major/minor version read from 0x6000.
> - Reading should still read "corrected", not "raw".
> - Added a sysfs knob to allow you to read "raw" instead of "corrected"
> - Simplified the SoC data structure.
> - No need for quite so many levels of abstraction for clocks/regulator.
> - Don't set regulator voltage.  Rely on device tree to make sure it's right.
> - Properly undo things in the case of failure.
> - Don't just keep enabling the regulator over and over again.
> - Enable / disable the clock each time
> - Polling every 100 us but timing out in 10 us didn't make sense; swap.
> - No reason for 100 us to be SoC specific.
> - No need for reg-names.
> - We shouldn't be creating two separate nvmem devices.
> 
>   drivers/nvmem/qfprom.c | 314 +++++++++++++++++++++++++++++++++++++++--
>   1 file changed, 303 insertions(+), 11 deletions(-)
> 
> diff --git a/drivers/nvmem/qfprom.c b/drivers/nvmem/qfprom.c
> index 8a91717600be..0a8576f2d4c6 100644
> --- a/drivers/nvmem/qfprom.c
> +++ b/drivers/nvmem/qfprom.c
> @@ -3,57 +3,349 @@
>    * Copyright (C) 2015 Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
>    */
>   
> +#include <linux/clk.h>
>   #include <linux/device.h>
> +#include <linux/io.h>
> +#include <linux/iopoll.h>
> +#include <linux/kernel.h>
>   #include <linux/module.h>
>   #include <linux/mod_devicetable.h>
> -#include <linux/io.h>
>   #include <linux/nvmem-provider.h>
>   #include <linux/platform_device.h>
> +#include <linux/regulator/consumer.h>
> +
> +/* Blow timer clock frequency in Mhz */
> +#define QFPROM_BLOW_TIMER_OFFSET 0x03c
> +
> +/* Amount of time required to hold charge to blow fuse in micro-seconds */
> +#define QFPROM_FUSE_BLOW_POLL_US	10
> +#define QFPROM_FUSE_BLOW_TIMEOUT_US	100
> +
> +#define QFPROM_BLOW_STATUS_OFFSET	0x048
> +#define QFPROM_BLOW_STATUS_BUSY		0x1
> +#define QFPROM_BLOW_STATUS_READY	0x0
> +
> +#define QFPROM_ACCEL_OFFSET		0x044
> +
> +#define QFPROM_VERSION_OFFSET		0x0
> +#define QFPROM_MAJOR_VERSION_SHIFT	28
> +#define QFPROM_MAJOR_VERSION_MASK	GENMASK(31, QFPROM_MAJOR_VERSION_SHIFT)
> +#define QFPROM_MINOR_VERSION_SHIFT	16
> +#define QFPROM_MINOR_VERSION_MASK	GENMASK(27, QFPROM_MINOR_VERSION_SHIFT)
> +
> +static bool read_raw_data;
> +module_param(read_raw_data, bool, 0644);
> +MODULE_PARM_DESC(read_raw_data, "Read raw instead of corrected data");
>   
> +/**
> + * struct qfprom_soc_data - config that varies from SoC to SoC.
> + *
> + * @accel_value:             Should contain qfprom accel value.
> + * @qfprom_blow_timer_value: The timer value of qfprom when doing efuse blow.
> + * @qfprom_blow_set_freq:    The frequency required to set when we start the
> + *                           fuse blowing.
> + */
> +struct qfprom_soc_data {
> +	u32 accel_value;
> +	u32 qfprom_blow_timer_value;
> +	u32 qfprom_blow_set_freq;
> +};
> +
> +/**
> + * struct qfprom_priv - structure holding qfprom attributes
> + *
> + * @qfpraw:       iomapped memory space for qfprom-efuse raw address space.
> + * @qfpconf:      iomapped memory space for qfprom-efuse configuration address
> + *                space.
> + * @qfpcorrected: iomapped memory space for qfprom corrected address space.
> + * @qfpsecurity:  iomapped memory space for qfprom security control space.
> + * @dev:          qfprom device structure.
> + * @secclk:       Clock supply.
> + * @vcc:          Regulator supply.
> + * @soc_data:     Data that for things that varies from SoC to SoC.
> + */
>   struct qfprom_priv {
> -	void __iomem *base;
> +	void __iomem *qfpraw;
> +	void __iomem *qfpconf;
> +	void __iomem *qfpcorrected;
> +	void __iomem *qfpsecurity;
> +	struct device *dev;
> +	struct clk *secclk;
> +	struct regulator *vcc;
> +	const struct qfprom_soc_data *soc_data;
> +};
> +
> +/**
> + * struct qfprom_touched_values - saved values to restore after blowing
> + *
> + * @clk_rate: The rate the clock was at before blowing.
> + * @accel_val: The value of the accel reg before blowing.
> + * @timer_val: The value of the timer before blowing.
> + */
> +struct qfprom_touched_values {
> +	unsigned long clk_rate;
> +	u32 accel_val;
> +	u32 timer_val;
>   };
>   
> +/**
> + * qfprom_disable_fuse_blowing() - Undo enabling of fuse blowing.
> + * @priv: Our driver data.
> + * @old:  The data that was stashed from before fuse blowing.
> + *
> + * Resets the value of the blow timer, accel register and the clock
> + * and voltage settings.
> + *
> + * Prints messages if there are errors but doesn't return an error code
> + * since there's not much we can do upon failure.
> + */
> +static void qfprom_disable_fuse_blowing(const struct qfprom_priv *priv,
> +					const struct qfprom_touched_values *old)
> +{
> +	int ret;
> +
> +	ret = regulator_disable(priv->vcc);
> +	if (ret)
> +		dev_warn(priv->dev, "Failed to disable regulator (ignoring)\n");
> +
> +	ret = clk_set_rate(priv->secclk, old->clk_rate);
> +	if (ret)
> +		dev_warn(priv->dev,
> +			 "Failed to set clock rate for disable (ignoring)\n");
> +
> +	clk_disable_unprepare(priv->secclk);
> +
> +	writel(old->timer_val, priv->qfpconf + QFPROM_BLOW_TIMER_OFFSET);
> +	writel(old->accel_val, priv->qfpconf + QFPROM_ACCEL_OFFSET);
> +}
> +
> +/**
> + * qfprom_enable_fuse_blowing() - Enable fuse blowing.
> + * @priv: Our driver data.
> + * @old:  We'll stash stuff here to use when disabling.
> + *
> + * Sets the value of the blow timer, accel register and the clock
> + * and voltage settings.
> + *
> + * Prints messages if there are errors so caller doesn't need to.
> + *
> + * Return: 0 or -err.
> + */
> +static int qfprom_enable_fuse_blowing(const struct qfprom_priv *priv,
> +				      struct qfprom_touched_values *old)
> +{
> +	int ret;
> +
> +	ret = clk_prepare_enable(priv->secclk);
> +	if (ret) {
> +		dev_err(priv->dev, "Failed to enable clock\n");
> +		return ret;
> +	}
> +
> +	old->clk_rate = clk_get_rate(priv->secclk);
> +	ret = clk_set_rate(priv->secclk, priv->soc_data->qfprom_blow_set_freq);
> +	if (ret) {
> +		dev_err(priv->dev, "Failed to set clock rate for enable\n");
> +		goto err_clk_prepared;
> +	}
> +
> +	ret = regulator_enable(priv->vcc);
> +	if (ret) {
> +		dev_err(priv->dev, "Failed to enable regulator\n");
> +		goto err_clk_rate_set;
> +	}
> +
> +	old->timer_val = readl(priv->qfpconf + QFPROM_BLOW_TIMER_OFFSET);
> +	old->accel_val = readl(priv->qfpconf + QFPROM_ACCEL_OFFSET);
> +	writel(priv->soc_data->qfprom_blow_timer_value,
> +	       priv->qfpconf + QFPROM_BLOW_TIMER_OFFSET);
> +	writel(priv->soc_data->accel_value,
> +	       priv->qfpconf + QFPROM_ACCEL_OFFSET);
> +
> +	return 0;
> +
> +err_clk_rate_set:
> +	clk_set_rate(priv->secclk, old->clk_rate);
> +err_clk_prepared:
> +	clk_disable_unprepare(priv->secclk);
> +	return ret;
> +}
> +
> +/**
> + * qfprom_efuse_reg_write() - Write to fuses.
> + * @context: Our driver data.
> + * @reg:     The offset to write at.
> + * @_val:    Pointer to data to write.
> + * @bytes:   The number of bytes to write.
> + *
> + * Writes to fuses.  WARNING: THIS IS PERMANENT.
> + *
> + * Return: 0 or -err.
> + */
> +static int qfprom_reg_write(void *context, unsigned int reg, void *_val,
> +			    size_t bytes)
> +{
> +	struct qfprom_priv *priv = context;
> +	struct qfprom_touched_values old;
> +	int words = bytes / 4;
> +	u32 *value = _val;
> +	u32 blow_status;
> +	int ret;
> +	int i;
> +
> +	dev_dbg(priv->dev,
> +		"Writing to raw qfprom region : %#010x of size: %zu\n",
> +		reg, bytes);
> +
> +	/*
> +	 * The hardware only allows us to write word at a time, but we can
> +	 * read byte at a time.  Until the nvmem framework allows a separate
> +	 * word_size and stride for reading vs. writing, we'll enforce here.
> +	 */
> +	if (bytes % 4) {
> +		dev_err(priv->dev,
> +			"%zu is not an integral number of words\n", bytes);
> +		return -EINVAL;
> +	}
> +	if (reg % 4) {
> +		dev_err(priv->dev,
> +			"Invalid offset: %#x.  Must be word aligned\n", reg);
> +		return -EINVAL;
> +	}
> +
> +	ret = qfprom_enable_fuse_blowing(priv, &old);
> +	if (ret)
> +		return ret;
> +
> +	ret = readl_relaxed_poll_timeout(
> +		priv->qfpconf + QFPROM_BLOW_STATUS_OFFSET,
> +		blow_status, blow_status == QFPROM_BLOW_STATUS_READY,
> +		QFPROM_FUSE_BLOW_POLL_US, QFPROM_FUSE_BLOW_TIMEOUT_US);
> +
> +	if (ret) {
> +		dev_err(priv->dev,
> +			"Timeout waiting for initial ready; aborting.\n");
> +		goto exit_enabled_fuse_blowing;
> +	}
> +
> +	for (i = 0; i < words; i++)
> +		writel(value[i], priv->qfpraw + reg + (i * 4));
> +
> +	ret = readl_relaxed_poll_timeout(
> +		priv->qfpconf + QFPROM_BLOW_STATUS_OFFSET,
> +		blow_status, blow_status == QFPROM_BLOW_STATUS_READY,
> +		QFPROM_FUSE_BLOW_POLL_US, QFPROM_FUSE_BLOW_TIMEOUT_US);
> +
> +	/* Give an error, but not much we can do in this case */
> +	if (ret)
> +		dev_err(priv->dev, "Timeout waiting for finish.\n");
> +
> +exit_enabled_fuse_blowing:
> +	qfprom_disable_fuse_blowing(priv, &old);
> +
> +	return ret;
> +}
> +
>   static int qfprom_reg_read(void *context,
>   			unsigned int reg, void *_val, size_t bytes)
>   {
>   	struct qfprom_priv *priv = context;
>   	u8 *val = _val;
>   	int i = 0, words = bytes;
> +	void __iomem *base = priv->qfpcorrected;
> +
> +	if (read_raw_data && priv->qfpraw)
> +		base = priv->qfpraw;
>   
>   	while (words--)
> -		*val++ = readb(priv->base + reg + i++);
> +		*val++ = readb(base + reg + i++);
>   
>   	return 0;
>   }
>   
> -static struct nvmem_config econfig = {
> -	.name = "qfprom",
> -	.stride = 1,
> -	.word_size = 1,
> -	.reg_read = qfprom_reg_read,
> +static const struct qfprom_soc_data qfprom_7_8_data = {
> +	.accel_value = 0xD10,
> +	.qfprom_blow_timer_value = 25,
> +	.qfprom_blow_set_freq = 4800000,
>   };
>   
>   static int qfprom_probe(struct platform_device *pdev)
>   {
> +	struct nvmem_config econfig = {
> +		.name = "qfprom",
> +		.stride = 1,
> +		.word_size = 1,
> +		.reg_read = qfprom_reg_read,
> +	};
>   	struct device *dev = &pdev->dev;
>   	struct resource *res;
>   	struct nvmem_device *nvmem;
>   	struct qfprom_priv *priv;
> +	int ret;
>   
>   	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
>   	if (!priv)
>   		return -ENOMEM;
>   
> +	/* The corrected section is always provided */
>   	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
> -	priv->base = devm_ioremap_resource(dev, res);
> -	if (IS_ERR(priv->base))
> -		return PTR_ERR(priv->base);
> +	priv->qfpcorrected = devm_ioremap_resource(dev, res);
> +	if (IS_ERR(priv->qfpcorrected))
> +		return PTR_ERR(priv->qfpcorrected);
>   
>   	econfig.size = resource_size(res);
>   	econfig.dev = dev;
>   	econfig.priv = priv;
>   
> +	priv->dev = dev;
> +
> +	/*
> +	 * If more than one region is provided then the OS has the ability
> +	 * to write.
> +	 */
> +	res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
> +	if (res) {
> +		u32 version;
> +		int major_version, minor_version;
> +
> +		priv->qfpraw = devm_ioremap_resource(dev, res);
> +		if (IS_ERR(priv->qfpraw))
> +			return PTR_ERR(priv->qfpraw);
> +		res = platform_get_resource(pdev, IORESOURCE_MEM, 2);
> +		priv->qfpconf = devm_ioremap_resource(dev, res);
> +		if (IS_ERR(priv->qfpconf))
> +			return PTR_ERR(priv->qfpconf);
> +		res = platform_get_resource(pdev, IORESOURCE_MEM, 3);
> +		priv->qfpsecurity = devm_ioremap_resource(dev, res);
> +		if (IS_ERR(priv->qfpsecurity))
> +			return PTR_ERR(priv->qfpsecurity);
> +
> +		version = readl(priv->qfpsecurity + QFPROM_VERSION_OFFSET);
> +		major_version = (version & QFPROM_MAJOR_VERSION_MASK) >>
> +				QFPROM_MAJOR_VERSION_SHIFT;
> +		minor_version = (version & QFPROM_MINOR_VERSION_MASK) >>
> +				QFPROM_MINOR_VERSION_SHIFT;
> +
> +		if (major_version == 7 && minor_version == 8)
> +			priv->soc_data = &qfprom_7_8_data;
> +
> +		priv->vcc = devm_regulator_get(&pdev->dev, "vcc");
> +		if (IS_ERR(priv->vcc))
> +			return PTR_ERR(priv->vcc);
> +
> +		priv->secclk = devm_clk_get(dev, "core");
> +		if (IS_ERR(priv->secclk)) {
> +			ret = PTR_ERR(priv->secclk);
> +			if (ret != -EPROBE_DEFER)
> +				dev_err(dev, "Error getting clock: %d\n", ret);
> +			return ret;
> +		}
> +
> +		/* Only enable writing if we have SoC data. */
> +		if (priv->soc_data)
> +			econfig.reg_write = qfprom_reg_write;
> +	}
> +
>   	nvmem = devm_nvmem_register(dev, &econfig);
>   
>   	return PTR_ERR_OR_ZERO(nvmem);
> 

-- 
Qualcomm INDIA, on behalf of Qualcomm Innovation Center, Inc. is a 
member of the Code Aurora Forum, hosted by the Linux Foundation.