From patchwork Mon Jul 17 07:51:47 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Miquel Raynal X-Patchwork-Id: 121128 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:c923:0:b0:3e4:2afc:c1 with SMTP id j3csp981376vqt; Mon, 17 Jul 2023 01:40:00 -0700 (PDT) X-Google-Smtp-Source: APBJJlE6VMQwvoB+jUFsvcDLuZg1HMzkBgrOSk2+vlhX4Ur+P2KriIjlhrfV1YiL5QNMyKO7jog/ X-Received: by 2002:a17:902:bc44:b0:1b8:6cae:3570 with SMTP id t4-20020a170902bc4400b001b86cae3570mr11238615plz.11.1689583199793; Mon, 17 Jul 2023 01:39:59 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1689583199; cv=none; d=google.com; s=arc-20160816; b=rO2/Uq+lfUhsujuSGxCx3sSy+cuE41+q2rvaRFV3XkXAyJM/Xf/PyNE3tZgcLmk3IS 9f1CLcQ/6g6rw4j9RU2QO9AjwU3pjHRQR2MNHlILLnLMcImduEuS/Of1+tvOluZIh0Mz +8d3GHAwkrm27Oa3/Ho4kSBoyDIs3PnRbSyHw/kedAJUccohzxhpA5Bgk6LcIRoc3zIY IQslfJzy5p9v93Ixra9coyqPfHN77gYtGJsS6LDUxUQu+ExUfskbKmKjP32r0/HPyx0R vmvQxY4gtGn5tV1HAQXJvXeXsjQsYPrq0zIP0uKiuxj/iqBKlrscoRgPalyT1EZueKA9 tUSA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=RrYa81jVjDuF0o+K2o6QuVvcpzCkZHcHCjfMG1eLeRQ=; fh=JpygR/0v0UTOXdyljMXVkuezv/HjT4xrIjOwJ6y50X0=; b=eN3QSzO3Ql4KDWa0qB4uoC1V6PweidCqIip1s38qs4h6HZjjhiXG3lsUWfJiWGqfxD uU/1bZAjDvBOxcfIFMqKhtpNsJkT/d4mG5kBpaFJShZNBhh+eAIN2HTaY/Lcw4cWI9Zx JJTNJZZ23qKniRs7yOHeOqp6gOeOBEy3KUDGcXStvAtL/kcyjDDe5F0x9th8EjMk4/oQ 6T34OcTne6yT59zUqXKNishf+jPa6baH4wjOo4qOq2W/9YOIg0Yq96m5WmRubEJ1glzU 11DJ+btPWkPuh5P3ObXEUX+l7UPYdebM7MAGHsrQEeja52eIpsVHj8BHvdZa8TAitI04 3jyw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=nQsJwRto; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=bootlin.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id a9-20020a170902ecc900b001bb21d502f0si3772025plh.76.2023.07.17.01.39.47; Mon, 17 Jul 2023 01:39:59 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=nQsJwRto; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=bootlin.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231204AbjGQHw0 (ORCPT + 99 others); Mon, 17 Jul 2023 03:52:26 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53570 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230199AbjGQHwE (ORCPT ); Mon, 17 Jul 2023 03:52:04 -0400 Received: from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net [217.70.183.195]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D51E1137 for ; Mon, 17 Jul 2023 00:51:54 -0700 (PDT) Received: by mail.gandi.net (Postfix) with ESMTPSA id 9B6B06000D; Mon, 17 Jul 2023 07:51:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1689580313; 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=RrYa81jVjDuF0o+K2o6QuVvcpzCkZHcHCjfMG1eLeRQ=; b=nQsJwRtoYotAmiu65aNlIFeLw8qkDU99mqiMm6NqYr2VGAquKTZvhPAXsn+5KaVambzyLb MI3y8tUGuwj8lo+pc5lzY5oFoth0ttRacPQFxsIVIPkzoCleiDoLNayYdAWRY/J3r4zKIe +GCqkxSpcO9HUm0nSlvICoX5zznxVJoZhE4OPPKmT8lL8R6MGjUD8k7nSC7WMPvvL5Z0+k T3QNQxvVNUiOAYdsZpieRq36ZreOUy73a/27Cu57k7XRqqT9ZDkVKvc/y6QOeh90cMWeIu JIP0EImpult9T/ONt3J8LfN4cNUhTExD9PwSrjbPa3nYY1Y1mN9JRnLMKDUYmw== From: Miquel Raynal To: Srinivas Kandagatla , Greg Kroah-Hartman , Cc: Thomas Petazzoni , Robert Marko , Luka Perkov , Michael Walle , Randy Dunlap , Miquel Raynal Subject: [PATCH v6 3/3] nvmem: core: Expose cells through sysfs Date: Mon, 17 Jul 2023 09:51:47 +0200 Message-Id: <20230717075147.43326-4-miquel.raynal@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230717075147.43326-1-miquel.raynal@bootlin.com> References: <20230717075147.43326-1-miquel.raynal@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: miquel.raynal@bootlin.com X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_BLOCKED, RCVD_IN_MSPIKE_H3,RCVD_IN_MSPIKE_WL,SPF_HELO_PASS,SPF_PASS, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1771656393777567538 X-GMAIL-MSGID: 1771656393777567538 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 Reviewed-by: Greg Kroah-Hartman --- drivers/nvmem/core.c | 101 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) diff --git a/drivers/nvmem/core.c b/drivers/nvmem/core.c index 48659106a1e2..6c04a9cf6919 100644 --- a/drivers/nvmem/core.c +++ b/drivers/nvmem/core.c @@ -325,6 +325,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 = { @@ -346,8 +383,14 @@ 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, + &nvmem_cells_group, NULL, }; @@ -406,6 +449,58 @@ static void nvmem_sysfs_remove_compat(struct nvmem_device *nvmem, device_remove_bin_file(nvmem->base_dev, &nvmem->eeprom); } +static int nvmem_populate_sysfs_cells(struct nvmem_device *nvmem) +{ + 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)) + 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_kstrdup(&nvmem->dev, entry->name, GFP_KERNEL); + 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; + +unlock_mutex: + mutex_unlock(&nvmem_mutex); + + return ret; +} + #else /* CONFIG_NVMEM_SYSFS */ static int nvmem_sysfs_setup_compat(struct nvmem_device *nvmem, @@ -1006,6 +1101,12 @@ struct nvmem_device *nvmem_register(const struct nvmem_config *config) if (rval) goto err_remove_cells; +#ifdef CONFIG_NVMEM_SYSFS + rval = nvmem_populate_sysfs_cells(nvmem); + if (rval) + goto err_remove_cells; +#endif + dev_dbg(&nvmem->dev, "Registering nvmem device %s\n", config->name); rval = device_add(&nvmem->dev);