linux-arm-kernel.lists.infradead.org archive mirror
 help / color / mirror / Atom feed
From: brgl@bgdev.pl (Bartosz Golaszewski)
To: linux-arm-kernel@lists.infradead.org
Subject: [PATCH 12/13] Documentation: nvmem: document cell tables and lookup entries
Date: Wed,  5 Sep 2018 11:57:37 +0200	[thread overview]
Message-ID: <20180905095738.26406-13-brgl@bgdev.pl> (raw)
In-Reply-To: <20180905095738.26406-1-brgl@bgdev.pl>

From: Bartosz Golaszewski <bgolaszewski@baylibre.com>

Document the new nvmem kernel APIs.

Signed-off-by: Bartosz Golaszewski <bgolaszewski@baylibre.com>
---
 Documentation/nvmem/nvmem.txt | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/Documentation/nvmem/nvmem.txt b/Documentation/nvmem/nvmem.txt
index 8d8d8f58f96f..2cb01cdf87c8 100644
--- a/Documentation/nvmem/nvmem.txt
+++ b/Documentation/nvmem/nvmem.txt
@@ -58,6 +58,36 @@ static int qfprom_probe(struct platform_device *pdev)
 It is mandatory that the NVMEM provider has a regmap associated with its
 struct device. Failure to do would return error code from nvmem_register().
 
+Users of board files can define and register nvmem cells using the
+nvmem_cell_table struct:
+
+static struct nvmem_cell_info foo_nvmem_cells[] = {
+	{
+		.name		= "mac-address",
+		.offset		= 0x7f00,
+		.bytes		= ETH_ALEN,
+	}
+};
+
+static struct nvmem_cell_table foo_nvmem_cell_table = {
+	.nvmem_name		= "i2c-eeprom",
+	.cells			= foo_nvmem_cells,
+	.ncells			= ARRAY_SIZE(foo_nvmem_cells),
+};
+
+nvmem_add_cell_table(&foo_nvmem_cell_table);
+
+Additionally it is possible to create nvmem cell lookup entries and register
+them with the nvmem framework from machine code as shown in the example below:
+
+static struct nvmem_cell_lookup foo_nvmem_lookup = {
+	.nvmem_name		= "i2c-eeprom",
+	.dev_id			= "foo_mac.0",
+	.cell_id		= "mac-address",
+};
+
+nvmem_add_cell_lookups(&foo_nvmem_lookup, 1);
+
 NVMEM Consumers
 +++++++++++++++
 
-- 
2.18.0

  parent reply	other threads:[~2018-09-05  9:57 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-09-05  9:57 [PATCH 00/13] nvmem: rework of the subsystem for non-DT users Bartosz Golaszewski
2018-09-05  9:57 ` [PATCH 01/13] nvmem: remove unused APIs Bartosz Golaszewski
2018-09-05  9:57 ` [PATCH 02/13] nvmem: remove the global cell list Bartosz Golaszewski
2018-09-05  9:57 ` [PATCH 03/13] nvmem: use kref Bartosz Golaszewski
2018-09-05  9:57 ` [PATCH 04/13] nvmem: lpc18xx_eeprom: use devm_nvmem_register() Bartosz Golaszewski
2018-09-05  9:57 ` [PATCH 05/13] nvmem: change the signature of nvmem_unregister() Bartosz Golaszewski
2018-09-07  4:48   ` kbuild test robot
2018-09-07  4:57   ` kbuild test robot
2018-09-05  9:57 ` [PATCH 06/13] nvmem: provide nvmem_dev_name() Bartosz Golaszewski
2018-09-05  9:57 ` [PATCH 07/13] nvmem: remove the name field from struct nvmem_device Bartosz Golaszewski
2018-09-05  9:57 ` [PATCH 08/13] nvmem: add a notifier chain Bartosz Golaszewski
2018-09-07  5:11   ` kbuild test robot
2018-09-05  9:57 ` [PATCH 09/13] nvmem: add support for cell info Bartosz Golaszewski
2018-09-05  9:57 ` [PATCH 10/13] nvmem: resolve cells from DT at registration time Bartosz Golaszewski
2018-09-05  9:57 ` [PATCH 11/13] nvmem: add support for cell lookups from machine code Bartosz Golaszewski
2018-09-05 13:57   ` Boris Brezillon
2018-09-05 14:00     ` Bartosz Golaszewski
2018-09-05 14:21       ` Boris Brezillon
2018-09-05 14:47         ` Bartosz Golaszewski
2018-09-05 14:59           ` Boris Brezillon
2018-09-05  9:57 ` Bartosz Golaszewski [this message]
2018-09-05  9:57 ` [PATCH 13/13] nvmem: use SPDX license identifiers Bartosz Golaszewski

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180905095738.26406-13-brgl@bgdev.pl \
    --to=brgl@bgdev.pl \
    --cc=linux-arm-kernel@lists.infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).