From patchwork Mon Aug 7 08:24:19 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Miquel Raynal X-Patchwork-Id: 131747 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:c44e:0:b0:3f2:4152:657d with SMTP id w14csp1310636vqr; Mon, 7 Aug 2023 01:49:46 -0700 (PDT) X-Google-Smtp-Source: AGHT+IEPkNdaTOBUS679Nl7Fu78kNaReBwA0f5BU8xAElLL8z8MhQQtamBwIkcX9MpACdeIlxTsU X-Received: by 2002:a17:903:1d1:b0:1bc:ee6:7f2e with SMTP id e17-20020a17090301d100b001bc0ee67f2emr8920757plh.53.1691398185818; Mon, 07 Aug 2023 01:49:45 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1691398185; cv=none; d=google.com; s=arc-20160816; b=zir9tLC/nAVnI9uGbFVPM7PXHabw5cWgcPBJT5x6K5sHdT+s4UCAic/4Jj2AU3IRvk P4YTl4PBbq4+ywdENskjIWIVJpFga2zVVOgpO0OdQmmZBE9iiwuREXJ2U+zzpl7wsQGU AdD+qQY0HLHQpsbF8HJoxJbhmKFPElC1WBJLRi+eYFHszN7Qsk6W8Bvz+iyrrYVWGtIo qDf/DrBykSGtqGup/oubydt6NLdKD73s210vVPFWNJcx5+TSnfFZj+BSV4WNuqqcmNUA Go1E8ulorcce5Qnm84JXyfJ7MVipH7BaeZUDx7MTMcnvJNYuVdIyPF5G5j1WnJxf/3gD 0lqw== 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=rCauNFO9SrDOuExJMZI4tMGirS53XqpHUVP3XjS2zkY=; fh=OHS2tDwbcHt81zFnYeyYq8ynDfpjq+e2h9R20vebRfM=; b=a14MqTSK6Vsn5RsxkoIDv+7j1bF4zM1xl1wgl/wKBfYnWkUER3283GugYgg8REq/YL ECjJRyVdh2UC2+L4buNuy34TDgZRImI2yP3AQGutLiXaU4SLkenXehPknhBGpxTJhzD2 H0/3iKzN2CfnsO63gUuodhOmxniFKC7X4V6UZT60jNlvmjxPD3hZW7Sbu8FeLrTlDso0 LJqrnsu7xfWhPYwx+3eTvypG3Y5D/syqnHKvEFDb8EY4jFtxm5QuvkKmm6jGcsihNgnM oADWT0CJLqVECi+PWp6GTGlZsfg3rQ0TwKRtg4EXkbiEUCGuvj7t/zPrpFoVyx4l63tu h/aQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@bootlin.com header.s=gm1 header.b="O/j8Sp6X"; 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 g3-20020a170902d1c300b001bbd0358ef7si5298034plb.518.2023.08.07.01.49.32; Mon, 07 Aug 2023 01:49:45 -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="O/j8Sp6X"; 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 S231316AbjHGIYs (ORCPT + 99 others); Mon, 7 Aug 2023 04:24:48 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56142 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231217AbjHGIYe (ORCPT ); Mon, 7 Aug 2023 04:24:34 -0400 Received: from relay4-d.mail.gandi.net (relay4-d.mail.gandi.net [217.70.183.196]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 107EA172A for ; Mon, 7 Aug 2023 01:24:31 -0700 (PDT) Received: by mail.gandi.net (Postfix) with ESMTPSA id 0623EE000A; Mon, 7 Aug 2023 08:24:29 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1691396670; 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=rCauNFO9SrDOuExJMZI4tMGirS53XqpHUVP3XjS2zkY=; b=O/j8Sp6X7pH05L+rkiYwJVeg2sTnOPYzTXi7xVOVd8KwIFi3KArMVU4z3EX1BpMKjRLjWl X7Uq+CjZnRBpPPJzR/TmwrrxIBWb7eG4hH5qTm3WRWagh1jRQcnCJPFtnqVy118qO+Oc4X LaHXpi0A0i9oEyzODd90KTcnM1ldWxaWrpnF2mFE7HQTnn96l1NzfdpzTdklRMp1c1LXxY 3iQfVhVEsZdbkj92ZjnJsailsWYm/Ab0nX/97UaeKk/RGKf1NKXiJoTrgnF0U6/AxjDt86 UElHEHpRerMoMjjRogHs79xAZbeKCzt4jLLXogils+driIGk2P8cz84iRmlUPA== 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 v8 8/8] nvmem: core: Expose cells through sysfs Date: Mon, 7 Aug 2023 10:24:19 +0200 Message-Id: <20230807082419.38780-9-miquel.raynal@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230807082419.38780-1-miquel.raynal@bootlin.com> References: <20230807082419.38780-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 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: 1773559544089196857 X-GMAIL-MSGID: 1773559544089196857 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 | 113 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 113 insertions(+) diff --git a/drivers/nvmem/core.c b/drivers/nvmem/core.c index 868a6f8b3227..1f24f4e71159 100644 --- a/drivers/nvmem/core.c +++ b/drivers/nvmem/core.c @@ -330,6 +330,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 = { @@ -351,11 +388,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", @@ -411,6 +458,64 @@ 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)) { + 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); + +unlock_mutex: + mutex_unlock(&nvmem_mutex); + + return ret; +} + #else /* CONFIG_NVMEM_SYSFS */ static int nvmem_sysfs_setup_compat(struct nvmem_device *nvmem, @@ -2148,8 +2253,16 @@ static int nvmem_try_matching_available_layout(struct nvmem_device *nvmem) if (ret) goto put_layout; +#ifdef CONFIG_NVMEM_SYSFS + ret = nvmem_populate_sysfs_cells(nvmem); +#endif + if (ret) + goto del_cells; + return 0; +del_cells: + nvmem_device_remove_all_cells(nvmem); put_layout: nvmem_layout_put(nvmem->layout); return ret;