[v10,3/3] nvmem: core: Expose cells through sysfs
Commit Message
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.
Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
---
drivers/nvmem/core.c | 117 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 117 insertions(+)
Comments
On 2023-09-22 19:48, Miquel Raynal wrote:
> 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.
>
> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
Tested-by: Rafał Miłecki <rafal@milecki.pl>
# hexdump -C /sys/bus/nvmem/devices/u-boot-env0/cells/ipaddr@15c
00000000 31 39 32 2e 31 36 38 2e 31 2e 31
|192.168.1.1|
0000000b
On 2023-09-28 17:31, Rafał Miłecki wrote:
> On 2023-09-22 19:48, Miquel Raynal wrote:
>> 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.
>>
>> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
>
> Tested-by: Rafał Miłecki <rafal@milecki.pl>
>
> # hexdump -C /sys/bus/nvmem/devices/u-boot-env0/cells/ipaddr@15c
> 00000000 31 39 32 2e 31 36 38 2e 31 2e 31
> |192.168.1.1|
> 0000000b
The same test after converting U-Boot env into layout driver:
# hexdump -C /sys/bus/nvmem/devices/mtd1/cells/ipaddr@15c
00000000 31 39 32 2e 31 36 38 2e 31 2e 31
|192.168.1.1|
0000000b
Looks good!
Hi Rafał,
rafal@milecki.pl wrote on Fri, 29 Sep 2023 07:18:32 +0200:
> On 2023-09-28 17:31, Rafał Miłecki wrote:
> > On 2023-09-22 19:48, Miquel Raynal wrote:
> >> 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.
> >> >> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
> >
> > Tested-by: Rafał Miłecki <rafal@milecki.pl>
> >
> > # hexdump -C /sys/bus/nvmem/devices/u-boot-env0/cells/ipaddr@15c
> > 00000000 31 39 32 2e 31 36 38 2e 31 2e 31 > |192.168.1.1|
> > 0000000b
>
> The same test after converting U-Boot env into layout driver:
>
> # hexdump -C /sys/bus/nvmem/devices/mtd1/cells/ipaddr@15c
> 00000000 31 39 32 2e 31 36 38 2e 31 2e 31 |192.168.1.1|
> 0000000b
>
> Looks good!
>
Great! Thanks a lot for testing!
Miquèl
@@ -43,6 +43,7 @@ struct nvmem_device {
struct gpio_desc *wp_gpio;
struct nvmem_layout *layout;
void *priv;
+ bool sysfs_cells_populated;
};
#define to_nvmem_device(d) container_of(d, struct nvmem_device, dev)
@@ -327,6 +328,43 @@ static umode_t nvmem_bin_attr_is_visible(struct kobject *kobj,
return nvmem_bin_attr_get_umode(nvmem);
}
+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 *kobj,
+ struct bin_attribute *attr, char *buf,
+ loff_t pos, size_t count)
+{
+ struct nvmem_cell_entry *entry;
+ struct nvmem_cell *cell = NULL;
+ size_t cell_sz, read_len;
+ void *content;
+
+ entry = attr->private;
+ cell = nvmem_create_cell(entry, entry->name, 0);
+ if (IS_ERR(cell))
+ return PTR_ERR(cell);
+
+ if (!cell)
+ return -EINVAL;
+
+ content = nvmem_cell_read(cell, &cell_sz);
+ if (IS_ERR(content)) {
+ read_len = PTR_ERR(content);
+ goto destroy_cell;
+ }
+
+ read_len = 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 = {
.attr = {
@@ -348,11 +386,21 @@ static const struct attribute_group nvmem_bin_group = {
.is_bin_visible = nvmem_bin_attr_is_visible,
};
+/* Cell attributes will be dynamically allocated */
+static struct attribute_group nvmem_cells_group = {
+ .name = "cells",
+};
+
static const struct attribute_group *nvmem_dev_groups[] = {
&nvmem_bin_group,
NULL,
};
+static const struct attribute_group *nvmem_cells_groups[] = {
+ &nvmem_cells_group,
+ NULL,
+};
+
static struct bin_attribute bin_attr_nvmem_eeprom_compat = {
.attr = {
.name = "eeprom",
@@ -408,6 +456,69 @@ static void nvmem_sysfs_remove_compat(struct nvmem_device *nvmem,
device_remove_bin_file(nvmem->base_dev, &nvmem->eeprom);
}
+static int nvmem_dev_populate_sysfs_cells(struct device *dev, void *data)
+{
+ struct nvmem_device *nvmem = to_nvmem_device(dev);
+ struct bin_attribute **cells_attrs, *attrs;
+ struct nvmem_cell_entry *entry;
+ unsigned int ncells = 0, i = 0;
+ int ret = 0;
+
+ mutex_lock(&nvmem_mutex);
+
+ if (list_empty(&nvmem->cells) || nvmem->sysfs_cells_populated) {
+ nvmem_cells_group.bin_attrs = NULL;
+ goto unlock_mutex;
+ }
+
+ /* Allocate an array of attributes with a sentinel */
+ ncells = list_count_nodes(&nvmem->cells);
+ cells_attrs = devm_kcalloc(&nvmem->dev, ncells + 1,
+ sizeof(struct bin_attribute *), GFP_KERNEL);
+ if (!cells_attrs) {
+ ret = -ENOMEM;
+ goto unlock_mutex;
+ }
+
+ attrs = devm_kcalloc(&nvmem->dev, ncells, sizeof(struct bin_attribute), GFP_KERNEL);
+ if (!attrs) {
+ ret = -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 = devm_kasprintf(&nvmem->dev, GFP_KERNEL,
+ "%s@%x", entry->name,
+ entry->offset);
+ attrs[i].attr.mode = 0444;
+ attrs[i].size = entry->bytes;
+ attrs[i].read = &nvmem_cell_attr_read;
+ attrs[i].private = entry;
+ if (!attrs[i].attr.name) {
+ ret = -ENOMEM;
+ goto unlock_mutex;
+ }
+
+ cells_attrs[i] = &attrs[i];
+ i++;
+ }
+
+ nvmem_cells_group.bin_attrs = cells_attrs;
+
+ ret = devm_device_add_groups(&nvmem->dev, nvmem_cells_groups);
+ if (ret)
+ goto unlock_mutex;
+
+ nvmem->sysfs_cells_populated = true;
+
+unlock_mutex:
+ mutex_unlock(&nvmem_mutex);
+
+ return ret;
+}
+
#else /* CONFIG_NVMEM_SYSFS */
static int nvmem_sysfs_setup_compat(struct nvmem_device *nvmem,
@@ -2193,6 +2304,12 @@ static int nvmem_notifier_call(struct notifier_block *notifier,
if (ret)
return notifier_from_errno(ret);
+#ifdef CONFIG_NVMEM_SYSFS
+ ret = nvmem_for_each_dev(nvmem_dev_populate_sysfs_cells);
+ if (ret)
+ return notifier_from_errno(ret);
+#endif
+
return NOTIFY_OK;
}