From patchwork Tue Aug 8 06:29:32 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Miquel Raynal X-Patchwork-Id: 132744 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:c44e:0:b0:3f2:4152:657d with SMTP id w14csp2329898vqr; Tue, 8 Aug 2023 11:57:53 -0700 (PDT) X-Google-Smtp-Source: AGHT+IEs9js/sFGREw8k1Mq0KehVopqJecc967bXnTV2kKv3J+VV2OEOYRWCbponEM8NqqKoDFqm X-Received: by 2002:a05:6870:5ba0:b0:1b3:f370:79c7 with SMTP id em32-20020a0568705ba000b001b3f37079c7mr510288oab.37.1691521072952; Tue, 08 Aug 2023 11:57:52 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1691521072; cv=none; d=google.com; s=arc-20160816; b=p9E/o4KKQyqlTN6RVI6KWFvYy+qP44YVehsG6223XdDXOEJ8ZcpT1d9wwUNNUtN+y3 oUz7tlg788lPmPGs80aVF4+M9NF9Ed+j5DhlWdh6lip8lXFedfsccevV2DojyeX/7mU0 5oo3Fn4US7Sy9s0zJ16y3/DCJJiLCeqscngPYNYm7anBAmT88f4lRKzvZqwnv2253IgY Jrd7UgBniDNvMGfz7fR8HyyEA/+buRqI8SOmjk/PkjgkfdWa4cGnoXCc/SYIARcYDT4Q gaNjXko3uw0uY6/MI6Ymy7slR+lmK/Cr1JqgN6zkrm5hvQDECDc1uIgy3mIGOzi6I3kK PMqg== 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=0vlOW+m6/kgqn3cxpsCF/6Z4kqpXbg8aetH5L3Z+xlI=; fh=OHS2tDwbcHt81zFnYeyYq8ynDfpjq+e2h9R20vebRfM=; b=QSiHv8pzgTvM5XhWnPzbxZCrePNvccD7y/DIbfeQsUUnO4KjTNx6gufV5fT957p5lj hfkn65WqcbwpYNd+61gn4JhR8Kc0kVmRvFfjdeSIaGVpYjJ7e5QD3CcMgpDoa7hx0v8y K0bUc/6nuZ1NcbYeIIdX2VhUiAgd666fCHS0ERhuX9pys43ViQQECJka2ZNtWwODfYGQ pqXtgt9sRb9+4Wvnl99WdjOoBF8vSPhvp9TJPFNGkAiGTop6COOF5Uq3hCcyLOteM8kJ Fund9P4hobtM+6NMQ0y3doXDu26AAj7lWj+c2lqdJQ3da/TloCOYBSBB+MQOFNULzet9 SrgA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=iGc2Ymhm; 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 r185-20020a632bc2000000b0055c4c9cbfedsi7792769pgr.862.2023.08.08.11.57.39; Tue, 08 Aug 2023 11:57:52 -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=iGc2Ymhm; 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 S234502AbjHHRXR (ORCPT + 99 others); Tue, 8 Aug 2023 13:23:17 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42246 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230417AbjHHRWp (ORCPT ); Tue, 8 Aug 2023 13:22:45 -0400 Received: from mslow1.mail.gandi.net (mslow1.mail.gandi.net [217.70.178.240]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id A8E957D7A5 for ; Tue, 8 Aug 2023 09:09:28 -0700 (PDT) Received: from relay1-d.mail.gandi.net (unknown [217.70.183.193]) by mslow1.mail.gandi.net (Postfix) with ESMTP id AF130D2EBB for ; Tue, 8 Aug 2023 06:29:47 +0000 (UTC) Received: by mail.gandi.net (Postfix) with ESMTPSA id DBBD3240002; Tue, 8 Aug 2023 06:29:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1691476184; 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=0vlOW+m6/kgqn3cxpsCF/6Z4kqpXbg8aetH5L3Z+xlI=; b=iGc2YmhmqE/9pFacAlXbsSl1cEtqhFZPhTuggjUxgr/Z9u1JwecUCV+uGcyN34M3PKAkFb I07Uy10PS0y4HtlAEgonl+2DnXhN/pT8ccl2dTOSmNAtGswabVUHNVQ7wsf+nwA457WSLv s7mFrI4hml6cuTzyyJmen/Rb43kxc662ZQQcHtdsfRwqfD+kGaHH+zGJ9GLLL2o6v7Ni7w njMsZIFKjtNi8o+5aWtUWLDlvfd3VqSDDOs/k3UBFkxWVL84YtfLTQfy6rav44DHqEX/o2 Q81GfG8+gXqHTOMvMFhD73wFUFdR2VMxWd7DhKzjebQpG3zGE3LNtkoXQ5RYdw== From: Miquel Raynal To: Srinivas Kandagatla Cc: Greg Kroah-Hartman , Thomas Petazzoni , Robert Marko , Luka Perkov , Michael Walle , , Randy Dunlap , Chen-Yu Tsai , Daniel Golle , =?utf-8?b?UmFmYcWCIE1pxYJlY2tp?= , Miquel Raynal Subject: [PATCH v9 7/7] nvmem: core: Expose cells through sysfs Date: Tue, 8 Aug 2023 08:29:32 +0200 Message-Id: <20230808062932.150588-8-miquel.raynal@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230808062932.150588-1-miquel.raynal@bootlin.com> References: <20230808062932.150588-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, SPF_HELO_PASS,SPF_PASS,URIBL_BLOCKED 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: 1773688400312050544 X-GMAIL-MSGID: 1773688400312050544 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 --- drivers/nvmem/core.c | 117 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 117 insertions(+) diff --git a/drivers/nvmem/core.c b/drivers/nvmem/core.c index 32d9973df90b..11b9e5cc0b45 100644 --- a/drivers/nvmem/core.c +++ b/drivers/nvmem/core.c @@ -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; }