From patchwork Tue Aug 1 18:21: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: 129440 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:918b:0:b0:3e4:2afc:c1 with SMTP id s11csp2880026vqg; Tue, 1 Aug 2023 12:15:59 -0700 (PDT) X-Google-Smtp-Source: APBJJlHuzRHQeXGZTZ5ADbPHxD3RJZYCUVnCuddOUWWBxlQIqsIGygChvvhDmUKMyjrxhozd4jV1 X-Received: by 2002:a05:6a21:3e02:b0:11f:4707:7365 with SMTP id bk2-20020a056a213e0200b0011f47077365mr12945342pzc.38.1690917359108; Tue, 01 Aug 2023 12:15:59 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1690917359; cv=none; d=google.com; s=arc-20160816; b=gI/Tdac0EMI5utZdEFpL+88TUC81mawmE3byARkx2ohvhFZlgr7TBuAlpOqXpw7kHv +S3dLJURQPnqcr2Rni8A08XVCoWhtG5tKK0WoR1a7HosH+X1D7D63RpWJGUAkxvoa51K jB/lzH1NQQSmJtdcHkc0CNMGgvrdo0ffyx5n5kB9sM21UvcC4dptTQyFN+9lFpZ2owON 0Nd0/uHdaEM2Fm6MzpXmB4c2b1gafwoIXNzsG7WpRFGic1+GZKBjSzRY2iIHz9zsKaD+ rqDMGnen+4Nt14EYE7iMj7q6d4ZCv84ZwUi2yQ1RBj6Mb6DvEaYnQqqLiq4IzJZizPZz Y9Yg== 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=wZXUbb+s305f0R0d6PSBqvTxl9Ubms9zy8HvCNQc7YE=; fh=OHS2tDwbcHt81zFnYeyYq8ynDfpjq+e2h9R20vebRfM=; b=GOZHo5G4U40gXLHOOiZRkX5PX2mkhsZ6mr7HiUNKpwrRUdYpUkc8TfAKzMWHTm4xgY WafKYcudvsyctQyiSleTLVMRsWxMZzqImf3s9oOlNVHG5ncoQ5NbzTrpndr+/vz1Yehi qacQJnvkXyq6oP0vL002bu/3cqbl6xwHc0pCf+RSvBjwRY1Zicyv7wHvyODE5CVVMnTf f35BPkKIMGz/cuMbQuHKk3+muSklped7OSoJ4csqIuMMcqCIgengNFf1aNTlIlU+tnZ3 5T0cBYXRfLs1YrAh92pIrth3kdnBV3SPTgTaWjyXsHwzVZIXVVkoRVEYbOojP5L+aqNi EQvA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=nOLMpLd4; 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 z8-20020a633308000000b00563fe2f03edsi9226098pgz.93.2023.08.01.12.15.45; Tue, 01 Aug 2023 12:15: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=nOLMpLd4; 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 S232406AbjHASWO (ORCPT + 99 others); Tue, 1 Aug 2023 14:22:14 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:37504 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231994AbjHASVv (ORCPT ); Tue, 1 Aug 2023 14:21:51 -0400 Received: from relay4-d.mail.gandi.net (relay4-d.mail.gandi.net [IPv6:2001:4b98:dc4:8::224]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id DC8AF269A for ; Tue, 1 Aug 2023 11:21:49 -0700 (PDT) Received: by mail.gandi.net (Postfix) with ESMTPSA id F359FE0005; Tue, 1 Aug 2023 18:21:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1690914108; 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=wZXUbb+s305f0R0d6PSBqvTxl9Ubms9zy8HvCNQc7YE=; b=nOLMpLd4UInlbOOe3sFtYzpGem4yyavZiwBoz/6dbG4a60Njd723o1505zRpf2hWpTMcVb zg15v8iyqGn7ktDGmZw6tCI4ci1ILSP/0huHmt62q2mA/e1Wn+UNB1v5KRwK5GTSHbJmtP 2vIPc7RUgXBa5XtSrzqrG4Op/HzAyyedPXtNblcYej90xCSfnHg2UkLrQZOkiqzz5sefr0 IgQBGNUI9ut0dA5k3Zks2HDScjRV3V9fn0G3bH/aOblr87Dpivu2YMMIo5ThMNM06FPnp8 Moqn9kLD1MpIRWV+acaGQpgAeqlM1HCHdTzlIjWquR6poU4siWbMI1BpZnWDUA== 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 v7 7/7] nvmem: core: Expose cells through sysfs Date: Tue, 1 Aug 2023 20:21:32 +0200 Message-Id: <20230801182132.1058707-8-miquel.raynal@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230801182132.1058707-1-miquel.raynal@bootlin.com> References: <20230801182132.1058707-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,T_SCC_BODY_TEXT_LINE,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: 1773055360576997439 X-GMAIL-MSGID: 1773055360576997439 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..beecb30a1642 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); + if (ret) + goto del_cells; +#endif + return 0; +del_cells: + nvmem_device_remove_all_cells(nvmem); put_layout: nvmem_layout_put(nvmem->layout); return ret;