From patchwork Wed Jun 14 06:30:14 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Miquel Raynal X-Patchwork-Id: 10746 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:994d:0:b0:3d9:f83d:47d9 with SMTP id k13csp1043000vqr; Tue, 13 Jun 2023 23:51:17 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ4/9+Q0jMihM6pcNkr5ogm/EavJbakw3zb5S1P8FKdmxkjVW7PQ+elWXWwNHDPnoU2mXw5N X-Received: by 2002:a17:907:7207:b0:974:5487:6054 with SMTP id dr7-20020a170907720700b0097454876054mr12834158ejc.71.1686725477131; Tue, 13 Jun 2023 23:51:17 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1686725477; cv=none; d=google.com; s=arc-20160816; b=KFEbqHgWRaNJkVF+mARj1KEZgyjp7delkBvWlKvXo4eL46rUzyRsFVWHxedjUIxQXt zQtfF1MkpPDKWEnVts+q+wWl5Bs3RdKK4tZEEB6ehjgG3UinNAIHbSwPxDlSiG9o/2GB gJsE43JAe5AdrwxOYOUw9mDIy09AjhcJjn5MGavoDsLUyPcj7kGWOdi8e9UsAgsTAh4b GvHX73Gb67Ts5zVcpCXAofAvzbkJU5KBCnXKararr8dW+tDVojNcL0h4U+9+Ay0PpyfY 9y5zxPeMmSJ/DIOYTRQyPd8fPTwVUskeGHbTt2c9vMBHgPnLipUaqCTEAcXtee6coBG7 C8dg== 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 :message-id:date:subject:cc:to:from:dkim-signature; bh=Y2OuhDj1NdFr9peXfe98BwicWxINCKJxkr8a1fw8vco=; b=cd7pZEsYpiGg5hqIkdOX3iI3xRSS0uHl/2YB5M1QVNU/06s4LFyYsn/nXDJv5QU9GV EX8EYo/drU9O3/nRyjF+rlQlC53cI04jxySDPbDKPExgRLcFOYjuMOgbctnHcSQkskLs 74giAshQtY7f986vbpchwE9okuUe1QIKmnYCNBpZU1dhbVyecwv8qt4qtnzJhhGTVzDa VuZ2kH3Du9K5Ev3dSAUOAu4/O1K9LTs/QcIT7WVwFb7tT71L2DiiA1LKS91kvxitI7rN 4JKghnW/5rxvYh5aGbKRxNO87kIxnmalqrPiM7Mn+vq+IgPIYBDGLTkZCWLxc/mKT3uG kcTA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=jglUgtqs; 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 l2-20020a1709060e0200b009746371719esi7782571eji.571.2023.06.13.23.50.50; Tue, 13 Jun 2023 23:51:17 -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=jglUgtqs; 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 S242548AbjFNGbH (ORCPT + 99 others); Wed, 14 Jun 2023 02:31:07 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44580 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S243211AbjFNGaj (ORCPT ); Wed, 14 Jun 2023 02:30:39 -0400 Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [IPv6:2001:4b98:dc4:8::229]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 747B82133 for ; Tue, 13 Jun 2023 23:30:21 -0700 (PDT) X-GND-Sasl: miquel.raynal@bootlin.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1686724219; 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; bh=Y2OuhDj1NdFr9peXfe98BwicWxINCKJxkr8a1fw8vco=; b=jglUgtqslOyl9VavezWbF5Uq73aVK6d4D90xE8K2dLDSeEPuTCey41MU5EqwQXz3qoXSJ8 T5mspGFXB5AO/sXLQDxFaix55rm/pjOJsHG4M/h1fOfHUau9Aad7mAOrvSA3K7ffHc1RZr w+Q4RV+Grp56P0os8W+drHQ8J6ZShYWUilD1Tyyp/9t9J9pKmKWk+8xN0ctKlPhOYApWrr Qh8F7ArzvVZMzwRMZRWcBtAo0xC2MkmcZmfz6YYO9lDdNm6uCUbDdB3XavXrPoffPXBwrx wGQWphusFZ8FLqWX29Vv1Abyti7SnvVfvjdbVSKWkje0C7PCUNC59+b4y9f4xA== X-GND-Sasl: miquel.raynal@bootlin.com X-GND-Sasl: miquel.raynal@bootlin.com X-GND-Sasl: miquel.raynal@bootlin.com X-GND-Sasl: miquel.raynal@bootlin.com X-GND-Sasl: miquel.raynal@bootlin.com X-GND-Sasl: miquel.raynal@bootlin.com X-GND-Sasl: miquel.raynal@bootlin.com Received: by mail.gandi.net (Postfix) with ESMTPSA id 4668EFF809; Wed, 14 Jun 2023 06:30:19 +0000 (UTC) From: Miquel Raynal To: Srinivas Kandagatla Cc: Greg Kroah-Hartman , "Rafael J . Wysocki" , , Thomas Petazzoni , Luka Perkov , Robert Marko , Miquel Raynal Subject: [PATCH v4 0/4] NVMEM cells in sysfs Date: Wed, 14 Jun 2023 08:30:14 +0200 Message-Id: <20230614063018.2419043-1-miquel.raynal@bootlin.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_LOW,SPF_HELO_NONE, 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: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1768659854154174843?= X-GMAIL-MSGID: =?utf-8?q?1768659854154174843?= Hello, As part of a previous effort, support for dynamic NVMEM layouts was brought into mainline, helping a lot in getting information from NVMEM devices at non-static locations. One common example of NVMEM cell is the MAC address that must be used. Sometimes the cell content is mainly (or only) useful to the kernel, and sometimes it is not. Users might also want to know the content of cells such as: the manufacturing place and date, the hardware version, the unique ID, etc. Two possibilities in this case: either the users re-implement their own parser to go through the whole device and search for the information they want, or the kernel can expose the content of the cells if deemed relevant. This second approach sounds way more relevant than the first one to avoid useless code duplication, so here is a series bringing NVMEM cells content to the user through sysfs. Here is a real life example with a Marvell Armada 7040 TN48m switch: $ nvmem=/sys/bus/nvmem/devices/1-00563/ $ for i in `ls -1 $nvmem/cells/*`; do basename $i; hexdump -C $i | head -n1; done country-code 00000000 54 57 |TW| crc32 00000000 bb cd 51 98 |..Q.| device-version 00000000 02 |.| diag-version 00000000 56 31 2e 30 2e 30 |V1.0.0| label-revision 00000000 44 31 |D1| mac-address 00000000 18 be 92 13 9a 00 |......| manufacture-date 00000000 30 32 2f 32 34 2f 32 30 32 31 20 31 38 3a 35 39 |02/24/2021 18:59| manufacturer 00000000 44 4e 49 |DNI| num-macs 00000000 00 40 |.@| onie-version 00000000 32 30 32 30 2e 31 31 2d 56 30 31 |2020.11-V01| platform-name 00000000 38 38 46 37 30 34 30 2f 38 38 46 36 38 32 30 |88F7040/88F6820| product-name 00000000 54 4e 34 38 4d 2d 50 2d 44 4e |TN48M-P-DN| serial-number 00000000 54 4e 34 38 31 50 32 54 57 32 30 34 32 30 33 32 |TN481P2TW2042032| vendor 00000000 44 4e 49 |DNI| Here is a list of known limitations though: * It is currently not possible to know whether the cell contains ASCII or binary data, so by default all cells are exposed in binary form. * For now the implementation focuses on the read aspect. Technically speaking, in some cases, it could be acceptable to write the cells, I guess, but for now read-only files sound more than enough. A writable path can be added later anyway. * The sysfs entries are created when the device probes, not when the NVMEM driver does. This means, if an NVMEM layout is used *and* compiled as a module *and* not installed properly in the system (a usermode helper tries to load the module otherwise), then the sysfs cells won't appear when the layout is actually insmod'ed because the sysfs folders/files have already been populated. Changes in v4: * Use a core helper to count the number of cells in a list. * Provide sysfs attributes a private member which is the entry itself to avoid the need for looking up the nvmem device and then looping over all the cells to find the right one. Changes in v3: * Patch 1 is new: fix a style issue which bothered me when reading the core. * Patch 2 is new: Don't error out when an attribute group does not contain any attributes, it's easier for developers to handle "empty" directories this way. It avoids strange/bad solutions to be implemented and does not cost much. * Drop the is_visible hook as it is no longer needed. * Stop allocating an empty attribute array to comply with the sysfs core checks (this check has been altered in the first commits). * Fix a missing tab in the ABI doc. Changes in v2: * Do not mention the cells might become writable in the future in the ABI documentation. * Fix a wrong return value reported by Dan and kernel test robot. * Implement .is_bin_visible(). * Avoid overwriting the list of attribute groups, but keep the cells attribute group writable as we need to populate it at run time. * Improve the commit messages. * Give a real life example in the cover letter. Miquel Raynal (4): sysfs: Improve readability by following the kernel coding style sysfs: Skip empty folders creation ABI: sysfs-nvmem-cells: Expose cells through sysfs nvmem: core: Expose cells through sysfs Documentation/ABI/testing/sysfs-nvmem-cells | 19 ++++ drivers/nvmem/core.c | 109 +++++++++++++++++++- fs/sysfs/group.c | 12 ++- 3 files changed, 132 insertions(+), 8 deletions(-) create mode 100644 Documentation/ABI/testing/sysfs-nvmem-cells Reviewed-by: Greg Kroah-Hartman