From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.3 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_SANE_1 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id D4B46C3A5A6 for ; Thu, 29 Aug 2019 10:47:28 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id A19522189D for ; Thu, 29 Aug 2019 10:47:28 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="ujq6GyFv" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727097AbfH2Kr1 (ORCPT ); Thu, 29 Aug 2019 06:47:27 -0400 Received: from mail-wm1-f68.google.com ([209.85.128.68]:56037 "EHLO mail-wm1-f68.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727005AbfH2Kr1 (ORCPT ); Thu, 29 Aug 2019 06:47:27 -0400 Received: by mail-wm1-f68.google.com with SMTP id f72so3175283wmf.5 for ; Thu, 29 Aug 2019 03:47:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=r8fQGv3lXbyX03VrYN4sU3Aa0bAhNWZMyeYWAwjfJK0=; b=ujq6GyFvfTde0M3eI3a4xHcSTeuzRPqARVoXKPNqidP60d7vBjnoLjAdABHke5IhXg WzNJ6uapVfZO0uE4JSZl17SDZpP502i774h5GpKfqH2P3Ujn2hN/eBNyPlBol6WWve3V 2zORGfeBO0H4B6SSx7nBc7S2QTR4v2XVvzdju8HjMz4U4NMnwwGpG4XREb+8MRVMEb2X Fe+1OG+pwCgKPlcAwufo1XKQkfSo8kY0LtYCoovLfOZS5PRsU3xD5VkX+Yz5VEEJtsA3 MPhTOX23t31/ZgDSpCdTh3Uunqoh1S6RyvhkeLC4uNH7tWAxHlWsiAaYEwW3QDvrx5Zc JQPw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=r8fQGv3lXbyX03VrYN4sU3Aa0bAhNWZMyeYWAwjfJK0=; b=uieD8IndNw7MOWN0OBGnfkq8VQmxNMMrD5krzWeI54Tcgqk5HMa68cuzRvJ+Y0qcPg 4fW50mGB3gjdJ6aNtnM12LbRvDmjQ5BW8iG04t8qM+IefaMZg4EdPUDYPmfaNieeRNCU ilQn4JW2Y+ql/2sZALuNC75fRCaufVZBAQQzL9O26T5ld6Mrkjq3aLp2/URwAck0qVhr BpI/dron2wQ4DpfEvj8gTb1KwrufjlB+7tbH5X7IPOoIDx+C1nahVc0/1xNZ/+0sURW5 XYt58ZG/+i+rlGaqhQfftKd1ZsJwB5MXipUf/eNK2BhNN64+fFPuB6gF2Snw7UX3nvhg xb1A== X-Gm-Message-State: APjAAAVHmCDHyP/K8NKk7+yYKWf5PEEUqTM3aVgIVBtlTNJ8PQrq4hbE hOwsYPKqcGalkFxugE0dFJUjKw== X-Google-Smtp-Source: APXvYqwiWudWqOOsq64Z8PQ/BME2907mWgNUa9JrmfQnq3ajTP3vzTfto/fJQlFg2YjqcSZpI9W0RQ== X-Received: by 2002:a7b:cb0f:: with SMTP id u15mr9939875wmj.173.1567075644045; Thu, 29 Aug 2019 03:47:24 -0700 (PDT) Received: from holly.lan (cpc141214-aztw34-2-0-cust773.18-1.cable.virginm.net. [86.9.19.6]) by smtp.gmail.com with ESMTPSA id d17sm3012115wrm.52.2019.08.29.03.47.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 29 Aug 2019 03:47:23 -0700 (PDT) Date: Thu, 29 Aug 2019 11:47:21 +0100 From: Daniel Thompson To: Tomer Maimon Cc: mpm@selenic.com, herbert@gondor.apana.org.au, arnd@arndb.de, gregkh@linuxfoundation.org, robh+dt@kernel.org, mark.rutland@arm.com, avifishman70@gmail.com, tali.perry1@gmail.com, venture@google.com, yuenn@google.com, benjaminfair@google.com, sumit.garg@linaro.org, jens.wiklander@linaro.org, vkoul@kernel.org, tglx@linutronix.de, joel@jms.id.au, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-crypto@vger.kernel.org, openbmc@lists.ozlabs.org Subject: Re: [PATCH v1 2/2] hwrng: npcm: add NPCM RNG driver Message-ID: <20190829104721.tnjk3bqt3cq6iagr@holly.lan> References: <20190828162617.237398-1-tmaimon77@gmail.com> <20190828162617.237398-3-tmaimon77@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20190828162617.237398-3-tmaimon77@gmail.com> User-Agent: NeoMutt/20180716 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Wed, Aug 28, 2019 at 07:26:17PM +0300, Tomer Maimon wrote: > Add Nuvoton NPCM BMC Random Number Generator(RNG) driver. > > Signed-off-by: Tomer Maimon > --- > drivers/char/hw_random/Kconfig | 13 ++ > drivers/char/hw_random/Makefile | 1 + > drivers/char/hw_random/npcm-rng.c | 207 ++++++++++++++++++++++++++++++ > 3 files changed, 221 insertions(+) > create mode 100644 drivers/char/hw_random/npcm-rng.c > > diff --git a/drivers/char/hw_random/npcm-rng.c b/drivers/char/hw_random/npcm-rng.c > new file mode 100644 > index 000000000000..5b4b1b6cb362 > --- /dev/null > +++ b/drivers/char/hw_random/npcm-rng.c > @@ -0,0 +1,207 @@ > +// SPDX-License-Identifier: GPL-2.0 > +// Copyright (c) 2019 Nuvoton Technology corporation. > + > +#include > +#include > +#include > +#include > +#include > +#include > +#include > +#include > +#include > +#include > +#include > +#include > + > +#define NPCM_RNGCS_REG 0x00 /* Control and status register */ > +#define NPCM_RNGD_REG 0x04 /* Data register */ > +#define NPCM_RNGMODE_REG 0x08 /* Mode register */ > + > +#define NPCM_RNG_CLK_SET_25MHZ GENMASK(4, 3) /* 20-25 MHz */ > +#define NPCM_RNG_DATA_VALID BIT(1) > +#define NPCM_RNG_ENABLE BIT(0) > +#define NPCM_RNG_M1ROSEL BIT(1) > + > +#define NPCM_RNG_TIMEOUT_POLL 20 Might be better to define this in real-world units (such as milliseconds) since the timeout is effectively the longest time the hardware can take to generate 4 bytes. > + > +#define to_npcm_rng(p) container_of(p, struct npcm_rng, rng) > + > +struct npcm_rng { > + void __iomem *base; > + struct hwrng rng; > +}; > + > +static int npcm_rng_init(struct hwrng *rng) > +{ > + struct npcm_rng *priv = to_npcm_rng(rng); > + u32 val; > + > + val = readl(priv->base + NPCM_RNGCS_REG); > + val |= NPCM_RNG_ENABLE; > + writel(val, priv->base + NPCM_RNGCS_REG); > + > + return 0; > +} > + > +static void npcm_rng_cleanup(struct hwrng *rng) > +{ > + struct npcm_rng *priv = to_npcm_rng(rng); > + u32 val; > + > + val = readl(priv->base + NPCM_RNGCS_REG); > + val &= ~NPCM_RNG_ENABLE; > + writel(val, priv->base + NPCM_RNGCS_REG); > +} > + > +static bool npcm_rng_wait_ready(struct hwrng *rng, bool wait) > +{ > + struct npcm_rng *priv = to_npcm_rng(rng); > + int timeout_cnt = 0; > + int ready; > + > + ready = readl(priv->base + NPCM_RNGCS_REG) & NPCM_RNG_DATA_VALID; > + while ((ready == 0) && (timeout_cnt < NPCM_RNG_TIMEOUT_POLL)) { > + usleep_range(500, 1000); > + ready = readl(priv->base + NPCM_RNGCS_REG) & > + NPCM_RNG_DATA_VALID; > + timeout_cnt++; > + } > + > + return !!ready; > +} This looks like an open-coded version of readl_poll_timeout()... better to use the library function. Also the sleep looks a bit long to me. What is the generation rate of the peripheral? Most RNG drivers have short intervals between data generation so they use delays rather than sleeps (a.k.a. readl_poll_timeout_atomic() ). > + > +static int npcm_rng_read(struct hwrng *rng, void *buf, size_t max, bool wait) > +{ > + struct npcm_rng *priv = to_npcm_rng(rng); > + int retval = 0; > + > + pm_runtime_get_sync((struct device *)priv->rng.priv); > + > + while (max >= sizeof(u32)) { > + if (!npcm_rng_wait_ready(rng, wait)) > + break; The code as currently written does not honour the wait parameter (e.g. it sleeps even when wait is false). > + > + *(u32 *)buf = readl(priv->base + NPCM_RNGD_REG); > + retval += sizeof(u32); > + buf += sizeof(u32); > + max -= sizeof(u32); > + } > + > + pm_runtime_mark_last_busy((struct device *)priv->rng.priv); > + pm_runtime_put_sync_autosuspend((struct device *)priv->rng.priv); > + > + return retval || !wait ? retval : -EIO; > +} > + > +static int npcm_rng_probe(struct platform_device *pdev) > +{ > + struct npcm_rng *priv; > + struct resource *res; > + u32 quality; > + int ret; > + > + priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL); > + if (!priv) > + return -ENOMEM; > + > + res = platform_get_resource(pdev, IORESOURCE_MEM, 0); > + priv->base = devm_ioremap_resource(&pdev->dev, res); > + if (IS_ERR(priv->base)) > + return PTR_ERR(priv->base); > + > + priv->rng.name = pdev->name; > +#ifndef CONFIG_PM > + priv->rng.init = npcm_rng_init; > + priv->rng.cleanup = npcm_rng_cleanup; > +#endif > + priv->rng.read = npcm_rng_read; > + priv->rng.priv = (unsigned long)&pdev->dev; > + if (of_property_read_u32(pdev->dev.of_node, "quality", &quality)) > + priv->rng.quality = 1000; > + else > + priv->rng.quality = quality; > + > + writel(NPCM_RNG_M1ROSEL, priv->base + NPCM_RNGMODE_REG); > +#ifndef CONFIG_PM > + writel(NPCM_RNG_CLK_SET_25MHZ, priv->base + NPCM_RNGCS_REG); > +#else > + writel(NPCM_RNG_CLK_SET_25MHZ | NPCM_RNG_ENABLE, > + priv->base + NPCM_RNGCS_REG); > +#endif If this initialization was moved to npcm_rng_init() then there would be no need for the additional ifdefing. It would also get rid of the (potentially slow) readl calls on the PM wakeup path. > + > + ret = devm_hwrng_register(&pdev->dev, &priv->rng); > + if (ret) { > + dev_err(&pdev->dev, "Failed to register rng device: %d\n", > + ret); > + return ret; > + } > + > + dev_set_drvdata(&pdev->dev, priv); > + pm_runtime_set_autosuspend_delay(&pdev->dev, 100); > + pm_runtime_use_autosuspend(&pdev->dev); > + pm_runtime_enable(&pdev->dev); > + > + dev_info(&pdev->dev, "Random Number Generator Probed\n"); Does the user need to know this every time we boot? There are lots of debug tools we can bring to bear if they are worried the device isn't probing. Daniel. > + > + return 0; > +} > + > +static int npcm_rng_remove(struct platform_device *pdev) > +{ > + struct npcm_rng *priv = platform_get_drvdata(pdev); > + > + hwrng_unregister(&priv->rng); > + pm_runtime_disable(&pdev->dev); > + pm_runtime_set_suspended(&pdev->dev); > + > + return 0; > +} > + > +#ifdef CONFIG_PM > +static int npcm_rng_runtime_suspend(struct device *dev) > +{ > + struct npcm_rng *priv = dev_get_drvdata(dev); > + > + npcm_rng_cleanup(&priv->rng); > + > + return 0; > +} > + > +static int npcm_rng_runtime_resume(struct device *dev) > +{ > + struct npcm_rng *priv = dev_get_drvdata(dev); > + > + return npcm_rng_init(&priv->rng); > +} > +#endif > + > +static const struct dev_pm_ops npcm_rng_pm_ops = { > + SET_RUNTIME_PM_OPS(npcm_rng_runtime_suspend, > + npcm_rng_runtime_resume, NULL) > + SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend, > + pm_runtime_force_resume) > +}; > + > +static const struct of_device_id rng_dt_id[] = { > + { .compatible = "nuvoton,npcm750-rng", }, > + {}, > +}; > +MODULE_DEVICE_TABLE(of, rng_dt_id); > + > +static struct platform_driver npcm_rng_driver = { > + .driver = { > + .name = "npcm-rng", > + .pm = &npcm_rng_pm_ops, > + .owner = THIS_MODULE, > + .of_match_table = of_match_ptr(rng_dt_id), > + }, > + .probe = npcm_rng_probe, > + .remove = npcm_rng_remove, > +}; > + > +module_platform_driver(npcm_rng_driver); > + > +MODULE_DESCRIPTION("Nuvoton NPCM Random Number Generator Driver"); > +MODULE_AUTHOR("Tomer Maimon "); > +MODULE_LICENSE("GPL v2"); > -- > 2.18.0 >