Files
linux-nv-oot/drivers/crypto/tegra-se-nvrng.c
Jon Hunter 74c0a6d16d drivers: Drop inline from driver remove wrapper
The driver remove function is a function pointer and therefore, it does
not make sense to define the function as an 'inline'. Update the
coccinelle script and drivers to remove the inline statement.

Bug 4749580

Change-Id: Ia03691b75c4edffe609f27468b911a92a5ddbd68
Signed-off-by: Jon Hunter <jonathanh@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nv-oot/+/3233980
(cherry picked from commit 2c3a31c9b72785ee35ad079422b624f59a35f622)
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nv-oot/+/3276870
Reviewed-by: Brad Griffis <bgriffis@nvidia.com>
GVS: buildbot_gerritrpt <buildbot_gerritrpt@nvidia.com>
2025-01-06 06:09:10 -08:00

405 lines
10 KiB
C

// SPDX-License-Identifier: GPL-2.0-only
/*
* SPDX-FileCopyrightText: Copyright (c) 2020-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
*
* Support for Tegra NVRNG Engine Error Handling.
*/
#include <nvidia/conftest.h>
#include <asm/io.h>
#include <linux/acpi.h>
#include <linux/clk.h>
#include <linux/init.h>
#include <linux/interrupt.h>
#include <linux/irqreturn.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/iopoll.h>
#include <linux/platform_device.h>
/* RNG1 offsets */
#define NV_NVRNG_R_IE_0 0x80
#define NV_NVRNG_R_ISTAT_0 0x84
#define NV_NVRNG_R_CTRL0_0 0x90
#define SW_ENGINE_ENABLED (1 << 2)
#define NV_NVRNG_R_CTRL1_0 0x90
/* SAP offsets */
#define SE0_SOFTRESET_0 0x60
#define SE0_INT_ENABLE_0 0x88
#define SC7_CTX_INTEGRITY_ERROR (1 << 7)
#define SC7_CTX_START_ERROR (1 << 6)
#define SE0_INT_STATUS_0 0x8c
#define SE0_SC7_CTRL_0 0xbc
#define SC7_CTX_SAVE 0
#define SC7_CTX_RESTORE 1
#define SE0_SC7_STATUS_0 0xc0
#define IDLE 0
#define BUSY 1
#define SE0_FEATURES_0 0x114
#define CAP_RNG1 (1 << 1)
#define CAP_HOST1X (1 << 0)
#define SC7_IDLE_TIMEOUT_2000MS 2000000 /* 2sec */
#define SC7_IDLE_TIMEOUT_200MS 200000 /* 200 MS */
#define RESET_TIMEOUT_100MS 100000
#define HALTED 0x4
#define STARTUP_DONE 0x2
#define ERROR 0x1
#define HALT 0x10
#define SOFT_RST 0x1
#define CLK_RATE 38400
struct tegra_se_nvrng_dev {
void __iomem *rng1_base;
void __iomem *sap_base;
int irq;
struct clk *clk;
};
static unsigned int tegra_se_nvrng_readl(struct tegra_se_nvrng_dev *nvrng_dev,
unsigned int offset)
{
return readl(nvrng_dev->rng1_base + offset);
}
static void tegra_se_nvrng_writel(struct tegra_se_nvrng_dev *nvrng_dev,
unsigned int offset, unsigned int value)
{
writel(value, nvrng_dev->rng1_base + offset);
}
#ifdef CONFIG_PM_SLEEP
static unsigned int tegra_se_sap_readl(struct tegra_se_nvrng_dev *nvrng_dev,
unsigned int offset)
{
return readl(nvrng_dev->sap_base + offset);
}
static void tegra_se_sap_writel(struct tegra_se_nvrng_dev *nvrng_dev,
unsigned int offset, unsigned int value)
{
writel(value, nvrng_dev->sap_base + offset);
}
#endif
static irqreturn_t tegra_se_nvrng_isr(int irq, void *dev_id)
{
int handled = 0;
unsigned int mask, status;
struct tegra_se_nvrng_dev *nvrng_dev = dev_id;
/* Handle the interrupt if issued for an error condition.
* Ignore the interrupt otherwise.
*/
status = tegra_se_nvrng_readl(nvrng_dev, NV_NVRNG_R_ISTAT_0);
if (status & ERROR) {
mask = tegra_se_nvrng_readl(nvrng_dev, NV_NVRNG_R_IE_0);
/* Disable STARTUP_DONE & ERROR interrupts. */
mask &= ~(STARTUP_DONE | ERROR);
tegra_se_nvrng_writel(nvrng_dev, NV_NVRNG_R_IE_0, mask);
/* Halt NVRNG and enable HALT interrupt. */
tegra_se_nvrng_writel(nvrng_dev, NV_NVRNG_R_CTRL1_0, HALT);
tegra_se_nvrng_writel(nvrng_dev, NV_NVRNG_R_IE_0, HALTED);
handled = 1;
} else if (status & HALTED) {
mask = tegra_se_nvrng_readl(nvrng_dev, NV_NVRNG_R_IE_0);
/* Disable HALT interrupt. */
mask &= ~HALTED;
tegra_se_nvrng_writel(nvrng_dev, NV_NVRNG_R_IE_0, mask);
/* Soft reset NVRNG and enable STARTUP_DONE interrupt. */
mask |= STARTUP_DONE;
tegra_se_nvrng_writel(nvrng_dev, NV_NVRNG_R_CTRL1_0, SOFT_RST);
tegra_se_nvrng_writel(nvrng_dev, NV_NVRNG_R_IE_0, STARTUP_DONE);
handled = 1;
} else {
/* Soft reset complete, enable ERROR interrupt*/
tegra_se_nvrng_writel(nvrng_dev, NV_NVRNG_R_IE_0, ERROR);
handled = 1;
}
return IRQ_RETVAL(handled);
}
static int tegra_se_nvrng_request_irq(struct tegra_se_nvrng_dev *nvrng_dev)
{
int ret;
unsigned int mask;
ret = request_irq(nvrng_dev->irq, tegra_se_nvrng_isr, 0,
"tegra-se-nvrng", nvrng_dev);
/* Set NV_NVRNG_R_IE_0.ERROR = Enabled.
* This will enable interrupts for errors.
*/
mask = tegra_se_nvrng_readl(nvrng_dev, NV_NVRNG_R_IE_0);
tegra_se_nvrng_writel(nvrng_dev, NV_NVRNG_R_IE_0,
mask | ERROR);
return ret;
}
static int tegra_se_nvrng_probe(struct platform_device *pdev)
{
struct tegra_se_nvrng_dev *nvrng_dev;
int ret;
nvrng_dev = devm_kzalloc(&pdev->dev, sizeof(struct tegra_se_nvrng_dev),
GFP_KERNEL);
if (!nvrng_dev)
return -ENOMEM;
nvrng_dev->rng1_base = devm_platform_ioremap_resource_byname(pdev,
"rng1");
if (IS_ERR(nvrng_dev->rng1_base))
return PTR_ERR(nvrng_dev->rng1_base);
nvrng_dev->sap_base = devm_platform_ioremap_resource_byname(pdev,
"sap");
if (IS_ERR(nvrng_dev->sap_base))
return PTR_ERR(nvrng_dev->sap_base);
nvrng_dev->irq = platform_get_irq(pdev, 0);
if (nvrng_dev->irq < 0) {
if (nvrng_dev->irq != -EPROBE_DEFER)
dev_err(&pdev->dev, "cannot obtain irq\n");
return nvrng_dev->irq;
}
nvrng_dev->clk = devm_clk_get(&pdev->dev, "se");
if (IS_ERR(nvrng_dev->clk))
return PTR_ERR(nvrng_dev->clk);
ret = clk_prepare_enable(nvrng_dev->clk);
if (ret) {
dev_err(&pdev->dev, "failed to initialize clocks\n");
return ret;
}
clk_set_rate(nvrng_dev->clk, CLK_RATE);
platform_set_drvdata(pdev, nvrng_dev);
return tegra_se_nvrng_request_irq(nvrng_dev);
}
static int tegra_se_nvrng_remove(struct platform_device *pdev)
{
struct tegra_se_nvrng_dev *nvrng_dev =
(struct tegra_se_nvrng_dev *)platform_get_drvdata(pdev);
free_irq(nvrng_dev->irq, nvrng_dev);
clk_disable_unprepare(nvrng_dev->clk);
devm_clk_put(&pdev->dev, nvrng_dev->clk);
return 0;
}
#ifdef CONFIG_PM_SLEEP
static int tegra_se_sc7_check_idle(struct tegra_se_nvrng_dev *nvrng_dev,
u32 timeout_us)
{
u32 val;
return readl_poll_timeout(nvrng_dev->sap_base + SE0_SC7_STATUS_0, val,
(val & 0x5f) == 0x5f, 10, timeout_us);
}
static int tegra_se_softreset(struct tegra_se_nvrng_dev *nvrng_dev)
{
u32 val;
tegra_se_sap_writel(nvrng_dev, SE0_SOFTRESET_0, TRUE);
return readl_poll_timeout(nvrng_dev->sap_base + SE0_SOFTRESET_0, val,
val == FALSE, 10, RESET_TIMEOUT_100MS);
}
static int tegra_se_sc7_check_error(struct tegra_se_nvrng_dev *nvrng_dev,
bool resume)
{
u32 val;
int ret;
ret = tegra_se_sc7_check_idle(nvrng_dev, SC7_IDLE_TIMEOUT_200MS);
if (ret == -ETIMEDOUT) {
pr_err("%s:%d SE HW is not idle, timeout\n",
__func__, __LINE__);
return ret;
}
val = tegra_se_sap_readl(nvrng_dev, SE0_INT_STATUS_0);
if (val & SC7_CTX_START_ERROR) {
/* Write 1 to clear */
tegra_se_sap_writel(nvrng_dev, SE0_INT_STATUS_0,
SC7_CTX_START_ERROR);
pr_err("%s:%d SC7 start error\n", __func__, __LINE__);
ret = -EIO;
}
if (resume && !ret) {
val = tegra_se_sap_readl(nvrng_dev, SE0_FEATURES_0);
if (val != (CAP_RNG1 | CAP_HOST1X)) {
pr_err("%s:%d SC7 SE features fail disable engine\n",
__func__, __LINE__);
ret = -EIO;
}
}
return ret;
}
static int tegra_se_nvrng_suspend(struct device *dev)
{
struct tegra_se_nvrng_dev *nvrng_dev = dev_get_drvdata(dev);
int ret = 0;
/* 1. Enable clock */
ret = clk_prepare_enable(nvrng_dev->clk);
if (ret) {
dev_err(dev, "failed to enable clocks during suspend\n");
return ret;
}
/* 2. Program NV_NVRNG_R_CTRL0_0.SW_ENGINE_ENABLED to true */
tegra_se_nvrng_writel(nvrng_dev, NV_NVRNG_R_CTRL0_0, SW_ENGINE_ENABLED);
/* WAR for bug 200735620 */
ret = tegra_se_softreset(nvrng_dev);
if (ret) {
pr_err("%s:%d SE softreset failed\n", __func__, __LINE__);
clk_disable_unprepare(nvrng_dev->clk);
return ret;
}
/* 3. Check SE0_SC7_STATUS_0 is 0x5f for HW to be IDLE */
ret = tegra_se_sc7_check_idle(nvrng_dev, SC7_IDLE_TIMEOUT_2000MS);
if (ret == -ETIMEDOUT) {
pr_err("%s:%d SE HW is not idle couldn't suspend\n",
__func__, __LINE__);
clk_disable_unprepare(nvrng_dev->clk);
return ret;
}
/* 4. Trigger SC7 context save */
tegra_se_sap_writel(nvrng_dev, SE0_SC7_CTRL_0, SC7_CTX_SAVE);
/* 5. Check for SC7 start errors */
ret = tegra_se_sc7_check_error(nvrng_dev, false);
/* 6. Disable clock */
clk_disable_unprepare(nvrng_dev->clk);
pr_debug("%s:%d resume complete\n", __func__, __LINE__);
return ret;
}
static int tegra_se_nvrng_resume(struct device *dev)
{
struct tegra_se_nvrng_dev *nvrng_dev = dev_get_drvdata(dev);
int ret = 0;
/* 1. Enable clock */
ret = clk_prepare_enable(nvrng_dev->clk);
if (ret) {
dev_err(dev, "failed to enable clocks during resume\n");
return ret;
}
/* 2. Program NV_NVRNG_R_CTRL0_0.SW_ENGINE_ENABLED to true */
tegra_se_nvrng_writel(nvrng_dev, NV_NVRNG_R_CTRL0_0, SW_ENGINE_ENABLED);
/* 3. Check SE0_SC7_STATUS_0 is 0x5f for HW to be IDLE */
ret = tegra_se_sc7_check_idle(nvrng_dev, SC7_IDLE_TIMEOUT_2000MS);
if (ret == -ETIMEDOUT) {
pr_err("%s:%d SE HW is not idle couldn't resume\n",
__func__, __LINE__);
clk_disable_unprepare(nvrng_dev->clk);
return ret;
}
/* 4. Trigger SC7 context restore */
tegra_se_sap_writel(nvrng_dev, SE0_SC7_CTRL_0, SC7_CTX_RESTORE);
/* 5. Check for SC7 start errors */
ret = tegra_se_sc7_check_error(nvrng_dev, true);
/* 6. Disable clock */
clk_disable_unprepare(nvrng_dev->clk);
pr_debug("%s:%d resume complete\n", __func__, __LINE__);
return ret;
}
#endif
static const struct dev_pm_ops tegra_se_nvrng_pm_ops = {
SET_SYSTEM_SLEEP_PM_OPS(tegra_se_nvrng_suspend, tegra_se_nvrng_resume)
};
#ifdef CONFIG_ACPI
static const struct acpi_device_id tegra_se_nvrng_acpi_match[] = {
{}
};
MODULE_DEVICE_TABLE(acpi, tegra_se_nvrng_acpi_match);
#endif /* CONFIG_ACPI */
static const struct of_device_id tegra_se_nvrng_of_match[] = {
{ .compatible = "nvidia,tegra234-se-nvrng" },
{}
};
MODULE_DEVICE_TABLE(of, tegra_se_nvrng_of_match);
#if defined(NV_PLATFORM_DRIVER_STRUCT_REMOVE_RETURNS_VOID) /* Linux v6.11 */
static void tegra_se_nvrng_remove_wrapper(struct platform_device *pdev)
{
tegra_se_nvrng_remove(pdev);
}
#else
static int tegra_se_nvrng_remove_wrapper(struct platform_device *pdev)
{
return tegra_se_nvrng_remove(pdev);
}
#endif
static struct platform_driver tegra_se_nvrng_driver = {
.probe = tegra_se_nvrng_probe,
.remove = tegra_se_nvrng_remove_wrapper,
.driver = {
.name = "tegra-se-nvrng",
.owner = THIS_MODULE,
.of_match_table = of_match_ptr(tegra_se_nvrng_of_match),
.pm = &tegra_se_nvrng_pm_ops,
#ifdef CONFIG_ACPI
.acpi_match_table = ACPI_PTR(tegra_se_nvrng_acpi_match),
#endif /* CONFIG_ACPI */
},
};
static int __init tegra_se_nvrng_module_init(void)
{
return platform_driver_register(&tegra_se_nvrng_driver);
}
static void __exit tegra_se_nvrng_module_exit(void)
{
platform_driver_unregister(&tegra_se_nvrng_driver);
}
module_init(tegra_se_nvrng_module_init);
module_exit(tegra_se_nvrng_module_exit);
MODULE_AUTHOR("Kartik <kkartik@nvidia.com>");
MODULE_DESCRIPTION("Tegra Crypto NVRNG error handling support");
MODULE_LICENSE("GPL");
MODULE_ALIAS("tegra-se-nvrng");