From nobody Mon Feb 9 12:24:23 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 6454AC7EE2D for ; Mon, 5 Jun 2023 13:35:08 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234128AbjFENeu (ORCPT ); Mon, 5 Jun 2023 09:34:50 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44882 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234101AbjFENea (ORCPT ); Mon, 5 Jun 2023 09:34:30 -0400 Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [IPv6:2001:4b98:dc4:8::229]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 8A83EDA for ; Mon, 5 Jun 2023 06:34:28 -0700 (PDT) X-GND-Sasl: miquel.raynal@bootlin.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1685972067; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=ul0VaxBEo8g8rMrRqLfw/GSk/B+aKOEx/21Oio7OP10=; b=QalijX1ciJf2AhowToySXhKEEnq6CMrQWEe9uwjZZt+YlTt7oC/3IIPTXWE58twZuB9P4T 5unLopqKTsNYZDXXITVKcUOheClxnnPj6CC/uIv1SlVG7fcKscgYKRkynPj3Bmkj+L00WH vIU5Xtz154IpL4UAXmNKi3hTqbmkED0lwgrvkXA43jnclNx1R5aBs3VsxERD3pZAuJAwfJ CU92KVGReiPVRK9b+FfcwjCni6dO4GVH9puOX/URaR4YDdtxFXK0A1xvIOw78S5V03xe5F 0LOA5t6CWhKHuziokEZ8f7FR+eNK57/NNd13K1Y16UDuMyNvWop63G/Z5iiHlw== X-GND-Sasl: miquel.raynal@bootlin.com X-GND-Sasl: miquel.raynal@bootlin.com X-GND-Sasl: miquel.raynal@bootlin.com X-GND-Sasl: miquel.raynal@bootlin.com X-GND-Sasl: miquel.raynal@bootlin.com X-GND-Sasl: miquel.raynal@bootlin.com X-GND-Sasl: miquel.raynal@bootlin.com Received: by mail.gandi.net (Postfix) with ESMTPSA id 9DDA3FF810; Mon, 5 Jun 2023 13:34:26 +0000 (UTC) From: Miquel Raynal To: Greg Kroah-Hartman Cc: Luka Perkov , Robert Marko , Thomas Petazzoni , , Srinivas Kandagatla , Rafael J Wysocki , Miquel Raynal Subject: [PATCH v3 4/4] nvmem: core: Expose cells through sysfs Date: Mon, 5 Jun 2023 15:34:22 +0200 Message-Id: <20230605133422.45840-5-miquel.raynal@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230605133422.45840-1-miquel.raynal@bootlin.com> References: <20230605133422.45840-1-miquel.raynal@bootlin.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Content-Type: text/plain; charset="utf-8" The binary content of nvmem devices is available to the user so in the easiest cases, finding the content of a cell is rather easy as it is just a matter of looking at a known and fixed offset. However, nvmem layouts have been recently introduced to cope with more advanced situations, where the offset and size of the cells is not known in advance or is dynamic. When using layouts, more advanced parsers are used by the kernel in order to give direct access to the content of each cell, regardless of its position/size in the underlying device. Unfortunately, these information are not accessible by users, unless by fully re-implementing the parser logic in userland. Let's expose the cells and their content through sysfs to avoid these situations. Of course the relevant NVMEM sysfs Kconfig option must be enabled for this support to be available. Not all nvmem devices expose cells. Indeed, the .bin_attrs attribute group member will be filled at runtime only when relevant and will remain empty otherwise. In this case, as the cells attribute group will be empty, it will not lead to any additional folder/file creation. Exposed cells are read-only. There is, in practice, everything in the core to support a write path, but as I don't see any need for that, I prefer to keep the interface simple (and probably safer). The interface is documented as being in the "testing" state which means we can later add a write attribute if though relevant. There is one limitation though: if a layout is built as a module but is not properly installed in the system and loaded manually with insmod while the nvmem device driver was built-in, the cells won't appear in sysfs. But if done like that, the cells won't be usable by the built-in kernel drivers anyway. Signed-off-by: Miquel Raynal --- drivers/nvmem/core.c | 128 +++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 124 insertions(+), 4 deletions(-) diff --git a/drivers/nvmem/core.c b/drivers/nvmem/core.c index 342cd380b420..625e3de273b7 100644 --- a/drivers/nvmem/core.c +++ b/drivers/nvmem/core.c @@ -325,6 +325,61 @@ static umode_t nvmem_bin_attr_is_visible(struct kobjec= t *kobj, return nvmem_bin_attr_get_umode(nvmem); } =20 +static struct nvmem_cell *nvmem_create_cell(struct nvmem_cell_entry *entry, + const char *id, int index); + +static ssize_t nvmem_cell_attr_read(struct file *filp, struct kobject *kob= j, + struct bin_attribute *attr, char *buf, + loff_t pos, size_t count) +{ + struct nvmem_cell_entry *entry; + struct nvmem_cell *cell =3D NULL; + struct nvmem_device *nvmem; + size_t cell_sz, read_len; + struct device *dev; + void *content; + + if (attr->private) + dev =3D attr->private; + else + dev =3D kobj_to_dev(kobj); + nvmem =3D to_nvmem_device(dev); + + mutex_lock(&nvmem_mutex); + list_for_each_entry(entry, &nvmem->cells, node) { + if (strncmp(entry->name, attr->attr.name, XATTR_NAME_MAX)) + continue; + + cell =3D nvmem_create_cell(entry, entry->name, 0); + if (IS_ERR(cell)) { + mutex_unlock(&nvmem_mutex); + return PTR_ERR(cell); + } + + break; + } + mutex_unlock(&nvmem_mutex); + + if (!cell) + return -EINVAL; + + content =3D nvmem_cell_read(cell, &cell_sz); + if (IS_ERR(content)) { + read_len =3D PTR_ERR(content); + goto destroy_cell; + } + + read_len =3D min_t(unsigned int, cell_sz - pos, count); + memcpy(buf, content + pos, read_len); + kfree(content); + +destroy_cell: + kfree_const(cell->id); + kfree(cell); + + return read_len; +} + /* default read/write permissions */ static struct bin_attribute bin_attr_rw_nvmem =3D { .attr =3D { @@ -346,8 +401,14 @@ static const struct attribute_group nvmem_bin_group = =3D { .is_bin_visible =3D nvmem_bin_attr_is_visible, }; =20 +/* Cell attributes will be dynamically allocated */ +static struct attribute_group nvmem_cells_group =3D { + .name =3D "cells", +}; + static const struct attribute_group *nvmem_dev_groups[] =3D { &nvmem_bin_group, + &nvmem_cells_group, NULL, }; =20 @@ -406,6 +467,59 @@ static void nvmem_sysfs_remove_compat(struct nvmem_dev= ice *nvmem, device_remove_bin_file(nvmem->base_dev, &nvmem->eeprom); } =20 +static int nvmem_populate_sysfs_cells(struct nvmem_device *nvmem) +{ + struct bin_attribute **cells_attrs, *attrs; + struct nvmem_cell_entry *entry; + unsigned int ncells =3D 0, i =3D 0; + int ret =3D 0; + + mutex_lock(&nvmem_mutex); + + if (list_empty(&nvmem->cells)) + goto unlock_mutex; + + list_for_each_entry(entry, &nvmem->cells, node) + ncells++; + + /* Allocate an array of attributes with a sentinel */ + cells_attrs =3D devm_kcalloc(&nvmem->dev, ncells + 1, + sizeof(struct bin_attribute *), GFP_KERNEL); + if (!cells_attrs) { + ret =3D -ENOMEM; + goto unlock_mutex; + } + + attrs =3D devm_kcalloc(&nvmem->dev, ncells, sizeof(struct bin_attribute),= GFP_KERNEL); + if (!attrs) { + ret =3D -ENOMEM; + goto unlock_mutex; + } + + /* Initialize each attribute to take the name and size of the cell */ + list_for_each_entry(entry, &nvmem->cells, node) { + sysfs_bin_attr_init(&attrs[i]); + attrs[i].attr.name =3D devm_kstrdup(&nvmem->dev, entry->name, GFP_KERNEL= ); + attrs[i].attr.mode =3D 0444; + attrs[i].size =3D entry->bytes; + attrs[i].read =3D &nvmem_cell_attr_read; + if (!attrs[i].attr.name) { + ret =3D -ENOMEM; + goto unlock_mutex; + } + + cells_attrs[i] =3D &attrs[i]; + i++; + } + + nvmem_cells_group.bin_attrs =3D cells_attrs; + +unlock_mutex: + mutex_unlock(&nvmem_mutex); + + return ret; +} + #else /* CONFIG_NVMEM_SYSFS */ =20 static int nvmem_sysfs_setup_compat(struct nvmem_device *nvmem, @@ -976,16 +1090,22 @@ struct nvmem_device *nvmem_register(const struct nvm= em_config *config) if (rval) goto err_remove_cells; =20 + rval =3D nvmem_add_cells_from_layout(nvmem); + if (rval) + goto err_remove_cells; + +#ifdef CONFIG_NVMEM_SYSFS + rval =3D nvmem_populate_sysfs_cells(nvmem); + if (rval) + goto err_remove_cells; +#endif + dev_dbg(&nvmem->dev, "Registering nvmem device %s\n", config->name); =20 rval =3D device_add(&nvmem->dev); if (rval) goto err_remove_cells; =20 - rval =3D nvmem_add_cells_from_layout(nvmem); - if (rval) - goto err_remove_cells; - blocking_notifier_call_chain(&nvmem_notifier, NVMEM_ADD, nvmem); =20 return nvmem; --=20 2.34.1