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=-9.9 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH, MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS 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 3CF8DC433E0 for ; Mon, 27 Jul 2020 03:14:01 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 0C84E2076C for ; Mon, 27 Jul 2020 03:14:01 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=linaro.org header.i=@linaro.org header.b="SGJ595p1" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726835AbgG0DOA (ORCPT ); Sun, 26 Jul 2020 23:14:00 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46460 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726044AbgG0DOA (ORCPT ); Sun, 26 Jul 2020 23:14:00 -0400 Received: from mail-lj1-x242.google.com (mail-lj1-x242.google.com [IPv6:2a00:1450:4864:20::242]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C258EC0619D4 for ; Sun, 26 Jul 2020 20:13:57 -0700 (PDT) Received: by mail-lj1-x242.google.com with SMTP id 185so5358207ljj.7 for ; Sun, 26 Jul 2020 20:13:57 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=AYtY7Du0SSIBmGOFfAIhObGrFtoQCfrN9p7cr9Hx2EE=; b=SGJ595p10ldocrUFdXMnvf+IivoBgRjRAqRx/O3+1J5K5em/gqTC/vk84QVYxDkfVJ jX9MYW3DBkQBh5uUSQnFYyGJPElfcJ0kZHm6nNEsGRgtgZd8Wlb1nfR3PPZhu54JsTgM a2bNzb8ETDlx9NXTw0JSu4BiKgef5bG/tkoWS1tv5C2TYs2JbLyb/jjiqx9TwqVerAQt pHuPjuaHKpiLgnZmQSrr0robfz9UyoIPyIIg6n88HFJmQWLYR2GMtd4ZDAdS0tcLHma8 lDcwavluHp48w0nAaJ9uemHksRiHN+G9bfdqN+QuLZ7L2EmMFKxecPLGAVPscw2n8PB+ yYPg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=AYtY7Du0SSIBmGOFfAIhObGrFtoQCfrN9p7cr9Hx2EE=; b=dUprnkeDyLuHFw1LlQcjkltZUvr+fjSl8JRDy2lPQwed8iJVH2Hbsw4+Ga1xmP90uL Q1frruCCwM0mD+X023ODa/j2T4SzU1uHqYMuRPqYmACQsAv56+7l+8zxeOCNu4a4SeBP BlkiGImSrQK8/A8eS6ZNmmZZliSlu0soOFfHUnnG77gmHBzuXDQT9O/q2jPSxcMQlgA4 7/22Hc7ICNVhV5cxfTHdr3MOH9S8q1/VDxj/EYA4VnhKxwVlmQ4HDhvchgMify4/OBO7 6k2bZDN6+3MzI4jS5wvUQblTSZAlrrZZrGQqL9gDiYXZ4ROulZLm4P+I5g8ssmiH8meY vAMg== X-Gm-Message-State: AOAM531DqLGP507qQ2PsouJPrEGZi+cTGODw1ihZBNZ/Cw4CU6D26zz7 nM/hqNQkQ6cSVBLQdWs0yeP8X0yJzIlyK19SkOMROg== X-Google-Smtp-Source: ABdhPJzjtxkHRQCOFbkzlTIoLleatG34kzs0z8sUrAYkt2zi0x5dSofrSESRDq4cEut8WAvF0ObtJCx6dIShD+aSofE= X-Received: by 2002:a05:651c:1106:: with SMTP id d6mr8654740ljo.214.1595819636012; Sun, 26 Jul 2020 20:13:56 -0700 (PDT) MIME-Version: 1.0 References: <20200717084932.3449-1-masahisa.kojima@linaro.org> <20200717084932.3449-2-masahisa.kojima@linaro.org> <20200723023634.GI45081@linux.intel.com> In-Reply-To: <20200723023634.GI45081@linux.intel.com> From: Masahisa Kojima Date: Mon, 27 Jul 2020 12:13:44 +0900 Message-ID: Subject: Re: [PATCH v4 1/2] tpm: tis: add support for MMIO TPM on SynQuacer To: Jarkko Sakkinen Cc: linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, ardb@kernel.org, devicetree , linux-integrity@vger.kernel.org, peterhuewe@gmx.de, jgg@ziepe.ca Content-Type: text/plain; charset="UTF-8" Sender: linux-integrity-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-integrity@vger.kernel.org Hi Jarkko, Thank you for your comments. On Thu, 23 Jul 2020 at 11:36, Jarkko Sakkinen wrote: > > On Fri, Jul 17, 2020 at 05:49:31PM +0900, Masahisa Kojima wrote: > > When fitted, the SynQuacer platform exposes its SPI TPM via a MMIO > > window that is backed by the SPI command sequencer in the SPI bus > > controller. This arrangement has the limitation that only byte size > > accesses are supported, and so we'll need to provide a separate module > > that take this into account. > > > > Signed-off-by: Ard Biesheuvel > > Signed-off-by: Masahisa Kojima > > --- > > drivers/char/tpm/Kconfig | 12 ++ > > drivers/char/tpm/Makefile | 1 + > > drivers/char/tpm/tpm_tis_synquacer.c | 209 +++++++++++++++++++++++++++ > > 3 files changed, 222 insertions(+) > > create mode 100644 drivers/char/tpm/tpm_tis_synquacer.c > > > > diff --git a/drivers/char/tpm/Kconfig b/drivers/char/tpm/Kconfig > > index 58b4c573d176..a18c314da211 100644 > > --- a/drivers/char/tpm/Kconfig > > +++ b/drivers/char/tpm/Kconfig > > @@ -74,6 +74,18 @@ config TCG_TIS_SPI_CR50 > > If you have a H1 secure module running Cr50 firmware on SPI bus, > > say Yes and it will be accessible from within Linux. > > > > +config TCG_TIS_SYNQUACER > > + tristate "TPM Interface Specification 1.2 Interface / TPM 2.0 FIFO Interface (MMIO - SynQuacer)" > > + depends on ARCH_SYNQUACER > > + select TCG_TIS_CORE > > + help > > + If you have a TPM security chip that is compliant with the > > + TCG TIS 1.2 TPM specification (TPM1.2) or the TCG PTP FIFO > > + specification (TPM2.0) say Yes and it will be accessible from > > + within Linux on Socionext SynQuacer platform. > > + To compile this driver as a module, choose M here; > > + the module will be called tpm_tis_synquacer. > > + > > config TCG_TIS_I2C_ATMEL > > tristate "TPM Interface Specification 1.2 Interface (I2C - Atmel)" > > depends on I2C > > diff --git a/drivers/char/tpm/Makefile b/drivers/char/tpm/Makefile > > index 9567e5197f74..84db4fb3a9c9 100644 > > --- a/drivers/char/tpm/Makefile > > +++ b/drivers/char/tpm/Makefile > > @@ -21,6 +21,7 @@ tpm-$(CONFIG_EFI) += eventlog/efi.o > > tpm-$(CONFIG_OF) += eventlog/of.o > > obj-$(CONFIG_TCG_TIS_CORE) += tpm_tis_core.o > > obj-$(CONFIG_TCG_TIS) += tpm_tis.o > > +obj-$(CONFIG_TCG_TIS_SYNQUACER) += tpm_tis_synquacer.o > > > > obj-$(CONFIG_TCG_TIS_SPI) += tpm_tis_spi.o > > tpm_tis_spi-y := tpm_tis_spi_main.o > > diff --git a/drivers/char/tpm/tpm_tis_synquacer.c b/drivers/char/tpm/tpm_tis_synquacer.c > > new file mode 100644 > > index 000000000000..ac2a1d2a5001 > > --- /dev/null > > +++ b/drivers/char/tpm/tpm_tis_synquacer.c > > @@ -0,0 +1,209 @@ > > +// SPDX-License-Identifier: GPL-2.0 > > +/* > > + * Copyright (C) 2020 Linaro Ltd. > > + * > > + * This device driver implements MMIO TPM on SynQuacer Platform. > > + */ > > +#include > > +#include > > +#include > > +#include > > +#include > > +#include > > +#include > > +#include "tpm.h" > > +#include "tpm_tis_core.h" > > + > > +struct tpm_tis_synquacer_info { > > + struct resource res; > > + /* irq > 0 means: use irq $irq; > > + * irq = 0 means: autoprobe for an irq; > > + * irq = -1 means: no irq support > > + */ > > + int irq; > > +}; > > According to the coding style, multi-line comments must begin with an > empty line. > > Also it would be preferable to have the comment prepending the struct > for easier read: > > /* > * irq > 0 means: use irq $irq; > * irq = 0 means: autoprobe for an irq; > * irq = -1 means: no irq support > */ > struct tpm_tis_synquacer_info { I will modify. > > > + > > +struct tpm_tis_synquacer_phy { > > + struct tpm_tis_data priv; > > + void __iomem *iobase; > > +}; > > + > > +static inline struct tpm_tis_synquacer_phy *to_tpm_tis_tcg_phy(struct tpm_tis_data *data) > > +{ > > + return container_of(data, struct tpm_tis_synquacer_phy, priv); > > +} > > + > > +static int tpm_tis_synquacer_read_bytes(struct tpm_tis_data *data, u32 addr, > > + u16 len, u8 *result) > > +{ > > + struct tpm_tis_synquacer_phy *phy = to_tpm_tis_tcg_phy(data); > > + > > + while (len--) > > + *result++ = ioread8(phy->iobase + addr); > > + > > + return 0; > > +} > > + > > +static int tpm_tis_synquacer_write_bytes(struct tpm_tis_data *data, u32 addr, > > + u16 len, const u8 *value) > > +{ > > + struct tpm_tis_synquacer_phy *phy = to_tpm_tis_tcg_phy(data); > > + > > + while (len--) > > + iowrite8(*value++, phy->iobase + addr); > > + > > + return 0; > > +} > > + > > +static int tpm_tis_synquacer_read16_bw(struct tpm_tis_data *data, > > + u32 addr, u16 *result) > > +{ > > + struct tpm_tis_synquacer_phy *phy = to_tpm_tis_tcg_phy(data); > > + > > + /* > > + * Due to the limitation of SPI controller on SynQuacer, > > + * 16/32 bits access must be done in byte-wise and descending order. > > + */ > > + *result = (ioread8(phy->iobase + addr + 1) << 8) | > > + (ioread8(phy->iobase + addr)); > > + > > + return 0; > > +} > > + > > +static int tpm_tis_synquacer_read32_bw(struct tpm_tis_data *data, > > + u32 addr, u32 *result) > > +{ > > + struct tpm_tis_synquacer_phy *phy = to_tpm_tis_tcg_phy(data); > > + > > + /* > > + * Due to the limitation of SPI controller on SynQuacer, > > + * 16/32 bits access must be done in byte-wise and descending order. > > + */ > > + *result = (ioread8(phy->iobase + addr + 3) << 24) | > > + (ioread8(phy->iobase + addr + 2) << 16) | > > + (ioread8(phy->iobase + addr + 1) << 8) | > > + (ioread8(phy->iobase + addr)); > > + > > + return 0; > > +} > > + > > +static int tpm_tis_synquacer_write32_bw(struct tpm_tis_data *data, > > + u32 addr, u32 value) > > +{ > > + struct tpm_tis_synquacer_phy *phy = to_tpm_tis_tcg_phy(data); > > + > > + /* > > + * Due to the limitation of SPI controller on SynQuacer, > > + * 16/32 bits access must be done in byte-wise and descending order. > > + */ > > + iowrite8(value >> 24, phy->iobase + addr + 3); > > + iowrite8(value >> 16, phy->iobase + addr + 2); > > + iowrite8(value >> 8, phy->iobase + addr + 1); > > + iowrite8(value, phy->iobase + addr); > > + > > + return 0; > > +} > > + > > +static const struct tpm_tis_phy_ops tpm_tcg_bw = { > > + .read_bytes = tpm_tis_synquacer_read_bytes, > > + .write_bytes = tpm_tis_synquacer_write_bytes, > > + .read16 = tpm_tis_synquacer_read16_bw, > > + .read32 = tpm_tis_synquacer_read32_bw, > > + .write32 = tpm_tis_synquacer_write32_bw, > > +}; > > + > > +static int tpm_tis_synquacer_init(struct device *dev, > > + struct tpm_tis_synquacer_info *tpm_info) > > +{ > > + struct tpm_tis_synquacer_phy *phy; > > + > > + phy = devm_kzalloc(dev, sizeof(struct tpm_tis_synquacer_phy), GFP_KERNEL); > > + if (phy == NULL) > > + return -ENOMEM; > > + > > + phy->iobase = devm_ioremap_resource(dev, &tpm_info->res); > > + if (IS_ERR(phy->iobase)) > > + return PTR_ERR(phy->iobase); > > + > > + return tpm_tis_core_init(dev, &phy->priv, tpm_info->irq, &tpm_tcg_bw, > > + ACPI_HANDLE(dev)); > > +} > > + > > +static SIMPLE_DEV_PM_OPS(tpm_tis_synquacer_pm, tpm_pm_suspend, tpm_tis_resume); > > + > > +static int tpm_tis_synquacer_probe(struct platform_device *pdev) > > +{ > > + struct tpm_tis_synquacer_info tpm_info = {}; > > + struct resource *res; > > + > > + res = platform_get_resource(pdev, IORESOURCE_MEM, 0); > > + if (res == NULL) { > > + dev_err(&pdev->dev, "no memory resource defined\n"); > > + return -ENODEV; > > + } > > + tpm_info.res = *res; > > + > > + tpm_info.irq = -1; > > + > > + return tpm_tis_synquacer_init(&pdev->dev, &tpm_info); > > +} > > + > > +static int tpm_tis_synquacer_remove(struct platform_device *pdev) > > +{ > > + struct tpm_chip *chip = dev_get_drvdata(&pdev->dev); > > + > > + tpm_chip_unregister(chip); > > + tpm_tis_remove(chip); > > + > > + return 0; > > +} > > + > > +#ifdef CONFIG_OF > > +static const struct of_device_id tis_synquacer_of_platform_match[] = { > > + {.compatible = "socionext,synquacer-tpm-mmio"}, > > + {}, > > +}; > > +MODULE_DEVICE_TABLE(of, tis_synquacer_of_platform_match); > > +#endif > > + > > +#ifdef CONFIG_ACPI > > +static const struct acpi_device_id tpm_synquacer_acpi_tbl[] = { > > + { "SCX0009" }, > > + {}, > > +}; > > +MODULE_DEVICE_TABLE(acpi, tpm_synquacer_acpi_tbl); > > +#endif > > + > > +static struct platform_driver tis_synquacer_drv = { > > + .probe = tpm_tis_synquacer_probe, > > + .remove = tpm_tis_synquacer_remove, > > + .driver = { > > + .name = "tpm_tis_synquacer", > > + .pm = &tpm_tis_synquacer_pm, > > + .of_match_table = of_match_ptr(tis_synquacer_of_platform_match), > > + .acpi_match_table = ACPI_PTR(tpm_synquacer_acpi_tbl), > > + }, > > +}; > > + > > +static int __init tpm_tis_synquacer_module_init(void) > > +{ > > + int rc; > > + > > + rc = platform_driver_register(&tis_synquacer_drv); > > + if (rc) > > + return rc; > > + > > + return 0; > > +} > > + > > +static void __exit tpm_tis_synquacer_module_exit(void) > > +{ > > + platform_driver_unregister(&tis_synquacer_drv); > > +} > > + > > +module_init(tpm_tis_synquacer_module_init); > > +module_exit(tpm_tis_synquacer_module_exit); > > +MODULE_AUTHOR("Masahisa Kojima (masahisa.kojima@linaro.org)"); > > It is completely redundant field because authorship is part of the > commit object itself. And it does not tell the truth after a while > anyway. MODULE_AUTHOR() made more sense before there was any sort of > legit versio control in place. > > I think it would be better not to have it as we don't have any use > for this data. It is just cruft hanging there. OK, I will remove MODULE_AUTHOR() line. I will also plan to remove MODULE_VERSION("2.0"). tpm_tis_spi_main.c only has MODULE_DESCRIPTION() and MODULE_LICENSE(), I plan to follow this example. Regards, Masahisa > > > +MODULE_DESCRIPTION("TPM MMIO Driver for Socionext SynQuacer platform"); > > +MODULE_VERSION("2.0"); > > +MODULE_LICENSE("GPL"); > > -- > > 2.20.1 > > > > /Jarkko