From nobody Wed Apr 8 08:36:20 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 86572ECAAD3 for ; Thu, 1 Sep 2022 22:23:04 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235365AbiIAWXC (ORCPT ); Thu, 1 Sep 2022 18:23:02 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48064 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235307AbiIAWWL (ORCPT ); Thu, 1 Sep 2022 18:22:11 -0400 Received: from mail.3ffe.de (0001.3ffe.de [159.69.201.130]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8D60F760FE; Thu, 1 Sep 2022 15:19:33 -0700 (PDT) Received: from mwalle01.kontron.local. (unknown [213.135.10.150]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mail.3ffe.de (Postfix) with ESMTPSA id 52DD6221D; Fri, 2 Sep 2022 00:19:15 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=walle.cc; s=mail2022082101; t=1662070755; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=dvogu54sPs6QPCKANcY0mgosO6bEnmTG0povuOwZvVw=; b=I6/BcILOAarYS2kGM/wJ7ZDi8f7Rn1Btp5BDUeLxXUpAUN/upY4Eg38eMTk8vaPOugfJ8Y 9TAahXx2ZLuTm1GS+FrRhAcGQA3gYwbdh9mm/a3qZazWx+W9UY0O1WTr1RC6EnR0VM87Zh 4PjtEEISElCEsAXSAcFY+aVK8CPXRUPGjBB0OqDiYHlOTS/EMKnVJ2pU4HGJ28ldmgAjB3 eC0JfaRqnfCe8nACErXZSI22rSVlrVlK98FOecFEF9GNO2s2v9PAkUFtJ9GJpz5p0Axo3a Biay/26ysGzE/38Gbq4+QqtNWH9jyAvYWQeShZTgWrxp27B/SGqVeWDQsT7/UQ== From: Michael Walle To: Miquel Raynal , Richard Weinberger , Vignesh Raghavendra , Rob Herring , Krzysztof Kozlowski , Srinivas Kandagatla , Shawn Guo , Li Yang , =?UTF-8?q?Rafa=C5=82=20Mi=C5=82ecki?= , Frank Rowand Cc: linux-mtd@lists.infradead.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, Ahmad Fatoum , Philipp Zabel , Michael Walle Subject: [RFC PATCH v2 19/20] nvmem: layouts: rewrite the u-boot-env driver as a NVMEM layout Date: Fri, 2 Sep 2022 00:18:56 +0200 Message-Id: <20220901221857.2600340-20-michael@walle.cc> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220901221857.2600340-1-michael@walle.cc> References: <20220901221857.2600340-1-michael@walle.cc> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Instead of hardcoding the underlying access method mtd_read() and duplicating all the error handling, rewrite the driver as a nvmem layout which just uses nvmem_device_read() and thus works with any NVMEM device. But because this is now not a device anymore, the compatible string will have to be changed so the device will still be probed: compatible =3D "u-boot,env"; to compatible =3D "u-boot,env", "nvmem-cells"; "nvmem-cells" will tell the mtd layer to register a nvmem_device(). "u-boot,env" will tell the NVMEM that it should apply the u-boot environment layout to the NVMEM device. Signed-off-by: Michael Walle --- changes since v1: - none drivers/nvmem/layouts/Kconfig | 8 ++ drivers/nvmem/layouts/Makefile | 1 + drivers/nvmem/layouts/u-boot-env.c | 144 +++++++++++++++++++ drivers/nvmem/u-boot-env.c | 218 ----------------------------- 4 files changed, 153 insertions(+), 218 deletions(-) create mode 100644 drivers/nvmem/layouts/u-boot-env.c delete mode 100644 drivers/nvmem/u-boot-env.c diff --git a/drivers/nvmem/layouts/Kconfig b/drivers/nvmem/layouts/Kconfig index 75082f6b471d..3db0c139a8b7 100644 --- a/drivers/nvmem/layouts/Kconfig +++ b/drivers/nvmem/layouts/Kconfig @@ -11,4 +11,12 @@ config NVMEM_LAYOUT_SL28_VPD =20 If unsure, say N. =20 +config NVMEM_LAYOUT_U_BOOT_ENV + bool "U-Boot environment support" + select CRC32 + help + Say Y here if you want to support u-boot's environment. + + If unsure, say N. + endmenu diff --git a/drivers/nvmem/layouts/Makefile b/drivers/nvmem/layouts/Makefile index fc617b9e87d0..dae93fff2b85 100644 --- a/drivers/nvmem/layouts/Makefile +++ b/drivers/nvmem/layouts/Makefile @@ -4,3 +4,4 @@ # =20 obj-$(CONFIG_NVMEM_LAYOUT_SL28_VPD) +=3D sl28vpd.o +obj-$(CONFIG_NVMEM_LAYOUT_U_BOOT_ENV) +=3D u-boot-env.o diff --git a/drivers/nvmem/layouts/u-boot-env.c b/drivers/nvmem/layouts/u-b= oot-env.c new file mode 100644 index 000000000000..f184d1424b1e --- /dev/null +++ b/drivers/nvmem/layouts/u-boot-env.c @@ -0,0 +1,144 @@ +// SPDX-License-Identifier: GPL-2.0-only +/* + * Copyright (C) 2022 Rafa=C5=82 Mi=C5=82ecki + */ + +#include +#include +#include +#include +#include +#include + +enum u_boot_env_format { + U_BOOT_FORMAT_SINGLE, + U_BOOT_FORMAT_REDUNDANT, +}; + +struct u_boot_env_image_single { + __le32 crc32; + u8 data[]; +} __packed; + +struct u_boot_env_image_redundant { + __le32 crc32; + u8 mark; + u8 data[]; +} __packed; + +static int u_boot_env_add_cells(struct device *dev, + struct nvmem_device *nvmem, uint8_t *buf, + size_t data_offset, size_t data_len) +{ + struct nvmem_cell_info info =3D {0}; + char *data =3D buf + data_offset; + char *var, *value, *eq; + int err; + + for (var =3D data; + var < data + data_len && *var; + var =3D value + strlen(value) + 1) { + eq =3D strchr(var, '=3D'); + if (!eq) + break; + *eq =3D '\0'; + value =3D eq + 1; + + info.name =3D var; + info.offset =3D data_offset + value - data; + info.bytes =3D strlen(value); + + err =3D nvmem_add_one_cell(nvmem, &info); + if (err) + return err; + } + + return 0; +} + +static int u_boot_add_cells(struct device *dev, struct nvmem_device *nvmem, + struct nvmem_layout *layout) +{ + size_t size =3D nvmem_device_size(nvmem); + enum u_boot_env_format format; + size_t crc32_data_offset; + size_t crc32_data_len; + size_t crc32_offset; + size_t data_offset; + size_t data_len; + u32 crc32; + u32 calc; + u8 *buf; + int err; + + format =3D (uintptr_t)nvmem_layout_get_match_data(nvmem, layout); + + buf =3D kzalloc(size, GFP_KERNEL); + if (!buf) { + err =3D -ENOMEM; + goto err_out; + } + + err =3D nvmem_device_read(nvmem, 0, size, buf); + if (err < 0) { + dev_err(dev, "Failed to read from nvmem device (%pe)\n", + ERR_PTR(err)); + goto err_kfree; + } else if (err !=3D size) { + dev_err(dev, "Short read from nvmem device.\n"); + err =3D -EIO; + goto err_kfree; + } + + switch (format) { + case U_BOOT_FORMAT_SINGLE: + crc32_offset =3D offsetof(struct u_boot_env_image_single, crc32); + crc32_data_offset =3D offsetof(struct u_boot_env_image_single, data); + data_offset =3D offsetof(struct u_boot_env_image_single, data); + break; + case U_BOOT_FORMAT_REDUNDANT: + crc32_offset =3D offsetof(struct u_boot_env_image_redundant, crc32); + crc32_data_offset =3D offsetof(struct u_boot_env_image_redundant, mark); + data_offset =3D offsetof(struct u_boot_env_image_redundant, data); + break; + } + crc32 =3D le32_to_cpu(*(u32 *)(buf + crc32_offset)); + crc32_data_len =3D size - crc32_data_offset; + data_len =3D size - data_offset; + + calc =3D crc32(~0, buf + crc32_data_offset, crc32_data_len) ^ ~0L; + if (calc !=3D crc32) { + dev_err(dev, "Invalid calculated CRC32: 0x%08x (expected: 0x%08x)\n", ca= lc, crc32); + err =3D -EINVAL; + goto err_kfree; + } + + buf[size - 1] =3D '\0'; + err =3D u_boot_env_add_cells(dev, nvmem, buf, data_offset, data_len); + if (err) + dev_err(dev, "Failed to add cells: %d\n", err); + +err_kfree: + kfree(buf); +err_out: + return err; +} + +static const struct of_device_id u_boot_env_of_match_table[] =3D { + { .compatible =3D "u-boot,env", .data =3D (void *)U_BOOT_FORMAT_SINGLE, }, + { .compatible =3D "u-boot,env-redundant-bool", .data =3D (void *)U_BOOT_F= ORMAT_REDUNDANT, }, + { .compatible =3D "u-boot,env-redundant-count", .data =3D (void *)U_BOOT_= FORMAT_REDUNDANT, }, + {}, +}; + +static struct nvmem_layout u_boot_env_layout =3D { + .name =3D "u_boot_env", + .of_match_table =3D u_boot_env_of_match_table, + .add_cells =3D u_boot_add_cells, +}; + +static int __init u_boot_env_init(void) +{ + return nvmem_layout_register(&u_boot_env_layout); +} +subsys_initcall(u_boot_env_init); diff --git a/drivers/nvmem/u-boot-env.c b/drivers/nvmem/u-boot-env.c deleted file mode 100644 index 9b9abfb8f187..000000000000 --- a/drivers/nvmem/u-boot-env.c +++ /dev/null @@ -1,218 +0,0 @@ -// SPDX-License-Identifier: GPL-2.0-only -/* - * Copyright (C) 2022 Rafa=C5=82 Mi=C5=82ecki - */ - -#include -#include -#include -#include -#include -#include -#include -#include -#include - -enum u_boot_env_format { - U_BOOT_FORMAT_SINGLE, - U_BOOT_FORMAT_REDUNDANT, -}; - -struct u_boot_env { - struct device *dev; - enum u_boot_env_format format; - - struct mtd_info *mtd; - - /* Cells */ - struct nvmem_cell_info *cells; - int ncells; -}; - -struct u_boot_env_image_single { - __le32 crc32; - uint8_t data[]; -} __packed; - -struct u_boot_env_image_redundant { - __le32 crc32; - u8 mark; - uint8_t data[]; -} __packed; - -static int u_boot_env_read(void *context, unsigned int offset, void *val, - size_t bytes) -{ - struct u_boot_env *priv =3D context; - struct device *dev =3D priv->dev; - size_t bytes_read; - int err; - - err =3D mtd_read(priv->mtd, offset, bytes, &bytes_read, val); - if (err && !mtd_is_bitflip(err)) { - dev_err(dev, "Failed to read from mtd: %d\n", err); - return err; - } - - if (bytes_read !=3D bytes) { - dev_err(dev, "Failed to read %zu bytes\n", bytes); - return -EIO; - } - - return 0; -} - -static int u_boot_env_add_cells(struct u_boot_env *priv, uint8_t *buf, - size_t data_offset, size_t data_len) -{ - struct device *dev =3D priv->dev; - char *data =3D buf + data_offset; - char *var, *value, *eq; - int idx; - - priv->ncells =3D 0; - for (var =3D data; var < data + data_len && *var; var +=3D strlen(var) + = 1) - priv->ncells++; - - priv->cells =3D devm_kcalloc(dev, priv->ncells, sizeof(*priv->cells), GFP= _KERNEL); - if (!priv->cells) - return -ENOMEM; - - for (var =3D data, idx =3D 0; - var < data + data_len && *var; - var =3D value + strlen(value) + 1, idx++) { - eq =3D strchr(var, '=3D'); - if (!eq) - break; - *eq =3D '\0'; - value =3D eq + 1; - - priv->cells[idx].name =3D devm_kstrdup(dev, var, GFP_KERNEL); - if (!priv->cells[idx].name) - return -ENOMEM; - priv->cells[idx].offset =3D data_offset + value - data; - priv->cells[idx].bytes =3D strlen(value); - } - - if (WARN_ON(idx !=3D priv->ncells)) - priv->ncells =3D idx; - - return 0; -} - -static int u_boot_env_parse(struct u_boot_env *priv) -{ - struct device *dev =3D priv->dev; - size_t crc32_data_offset; - size_t crc32_data_len; - size_t crc32_offset; - size_t data_offset; - size_t data_len; - uint32_t crc32; - uint32_t calc; - size_t bytes; - uint8_t *buf; - int err; - - buf =3D kcalloc(1, priv->mtd->size, GFP_KERNEL); - if (!buf) { - err =3D -ENOMEM; - goto err_out; - } - - err =3D mtd_read(priv->mtd, 0, priv->mtd->size, &bytes, buf); - if ((err && !mtd_is_bitflip(err)) || bytes !=3D priv->mtd->size) { - dev_err(dev, "Failed to read from mtd: %d\n", err); - goto err_kfree; - } - - switch (priv->format) { - case U_BOOT_FORMAT_SINGLE: - crc32_offset =3D offsetof(struct u_boot_env_image_single, crc32); - crc32_data_offset =3D offsetof(struct u_boot_env_image_single, data); - data_offset =3D offsetof(struct u_boot_env_image_single, data); - break; - case U_BOOT_FORMAT_REDUNDANT: - crc32_offset =3D offsetof(struct u_boot_env_image_redundant, crc32); - crc32_data_offset =3D offsetof(struct u_boot_env_image_redundant, mark); - data_offset =3D offsetof(struct u_boot_env_image_redundant, data); - break; - } - crc32 =3D le32_to_cpu(*(uint32_t *)(buf + crc32_offset)); - crc32_data_len =3D priv->mtd->size - crc32_data_offset; - data_len =3D priv->mtd->size - data_offset; - - calc =3D crc32(~0, buf + crc32_data_offset, crc32_data_len) ^ ~0L; - if (calc !=3D crc32) { - dev_err(dev, "Invalid calculated CRC32: 0x%08x (expected: 0x%08x)\n", ca= lc, crc32); - err =3D -EINVAL; - goto err_kfree; - } - - buf[priv->mtd->size - 1] =3D '\0'; - err =3D u_boot_env_add_cells(priv, buf, data_offset, data_len); - if (err) - dev_err(dev, "Failed to add cells: %d\n", err); - -err_kfree: - kfree(buf); -err_out: - return err; -} - -static int u_boot_env_probe(struct platform_device *pdev) -{ - struct nvmem_config config =3D { - .name =3D "u-boot-env", - .reg_read =3D u_boot_env_read, - }; - struct device *dev =3D &pdev->dev; - struct device_node *np =3D dev->of_node; - struct u_boot_env *priv; - int err; - - priv =3D devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL); - if (!priv) - return -ENOMEM; - priv->dev =3D dev; - - priv->format =3D (uintptr_t)of_device_get_match_data(dev); - - priv->mtd =3D of_get_mtd_device_by_node(np); - if (IS_ERR(priv->mtd)) { - dev_err_probe(dev, PTR_ERR(priv->mtd), "Failed to get %pOF MTD\n", np); - return PTR_ERR(priv->mtd); - } - - err =3D u_boot_env_parse(priv); - if (err) - return err; - - config.dev =3D dev; - config.cells =3D priv->cells; - config.ncells =3D priv->ncells; - config.priv =3D priv; - config.size =3D priv->mtd->size; - - return PTR_ERR_OR_ZERO(devm_nvmem_register(dev, &config)); -} - -static const struct of_device_id u_boot_env_of_match_table[] =3D { - { .compatible =3D "u-boot,env", .data =3D (void *)U_BOOT_FORMAT_SINGLE, }, - { .compatible =3D "u-boot,env-redundant-bool", .data =3D (void *)U_BOOT_F= ORMAT_REDUNDANT, }, - { .compatible =3D "u-boot,env-redundant-count", .data =3D (void *)U_BOOT_= FORMAT_REDUNDANT, }, - {}, -}; - -static struct platform_driver u_boot_env_driver =3D { - .probe =3D u_boot_env_probe, - .driver =3D { - .name =3D "u_boot_env", - .of_match_table =3D u_boot_env_of_match_table, - }, -}; -module_platform_driver(u_boot_env_driver); - -MODULE_AUTHOR("Rafa=C5=82 Mi=C5=82ecki"); -MODULE_LICENSE("GPL"); -MODULE_DEVICE_TABLE(of, u_boot_env_of_match_table); --=20 2.30.2