Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Sean Anderson <sean.anderson@seco.com>
To:     Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org
Cc:     linux-kernel@vger.kernel.org,
        Srinivas Kandagatla <srinivas.kandagatla@linaro.org>,
        Michael Walle <michael@walle.cc>,
        Sean Anderson <sean.anderson@seco.com>
Subject: [PATCH v2] doc: nvmem: Remove references to regmap
Date:   Tue,  8 Feb 2022 11:26:57 -0500
Message-Id: <20220208162657.724119-1-sean.anderson@seco.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?csMY0wF0vsPIGU8arqj5YqWcsvC/OvwxSWSfOgGHqqSsdCS6ysQdZ+MSmawP?=
 =?us-ascii?Q?Pd+Lv/pnUH9PES02nbJovMDaKKu45NsKBZbSGCptu3GeCrn8p8NQO1GibFGZ?=
 =?us-ascii?Q?v795GmAnic9znZiWL/c7QEeapsw4gC1ELl9b24AizIHx2kWD8buSvoO3zJuo?=
 =?us-ascii?Q?dg0TUeZy1m73rNnZb118GWYW4/JumuAiPCsaHFy/NX6UB0jRnIA3YWfk9dpd?=
 =?us-ascii?Q?1ItjcV233EYruKbMXFG0C49a9D3RpB3JdiAEE6MBz1p7K1OhiL1KzrMGCYWH?=
 =?us-ascii?Q?OqcxzCQH6/tnXGJwGY2hfxlGF3VA7B57RkvdvXZuxeuFLYPpf1qhe46D+8AG?=
 =?us-ascii?Q?+OGml6HLt1MM9OB0KHXEBgs5wSrOwguM1ozUpTfhalcw15voOz48s4035x2X?=
 =?us-ascii?Q?dvTryNHLKgGoHIceTPphr9dBrtSMGleXtvGO7v7uGm0e+P8xX3aC+c7/anfb?=
 =?us-ascii?Q?M87gC3tHIOt4oEENsbfWmDCKqrV136lFRnqxKvdDjpV6OfQK55Kvln0H3asN?=
 =?us-ascii?Q?fwDq+UYgPsSIyZjM0tv7OXcbIGhmzfHY7mm5WjI/acdvUspo0tYZwbvkuFEp?=
 =?us-ascii?Q?WFNSOVVn27WF+ZyGe+S7Kfs7mTnTFeCiOu6AhdlIGvlDBEwaFcGcVKsbSLJS?=
 =?us-ascii?Q?SgwsuIfrxcmyKZcqpR9jZ2GOoN0X2ZwN3qyH3oCfoGl1QjlB4QAwLalLFE0Z?=
 =?us-ascii?Q?+nrCimMW5v0l4YFPBebNmSkBvcsx4V15VJsMSkUYVXVDQLOwFSVG9wtN9fkk?=
 =?us-ascii?Q?7bIysh+yhVruf/KP5vxoyokkTCoyJ9sG/fFdw4oiv0/mpvDar6g7ChR0kWgL?=
 =?us-ascii?Q?FtmVwyEXzLPFS1yU36Ezn2KCAyZ98tzpVnJpzHgOKwqK3whoFLrb2+Ll6rSV?=
 =?us-ascii?Q?J6pW0InNHor+k6MXJEHnQDTZPOV/kc4+mW74B50pKKELTudIZW8GSwnve9IN?=
 =?us-ascii?Q?XrIzZpqnI0S4D1PSP0P2vfO6B01QFUdIKTaCVCE+k58RJagatv2HPBWfNcjf?=
 =?us-ascii?Q?yJ7dlXJQtY4+pS1tqeCnRIMy9IaEql0t0+22GU8eXbDOH44HTnNRgH69CGR/?=
 =?us-ascii?Q?AFndNtK55MDB04Ry/7T35vErCEN7jKw4iKMgK/NKzph21d8Rs2v0tcRjJu0u?=
 =?us-ascii?Q?WPeOs+iq8YMendmOBVXSdU/liQEHCdSZeqPZn39Vt95YkpUPDRWShC9oZV1F?=
 =?us-ascii?Q?Ac9zhlA4GZSRg9DUEeaW4RX7JFL2zZq7b1KH4BYOy1uXpPPIl8Ia6MB99/OG?=
 =?us-ascii?Q?AZZ9mz3WC2jYy5THZHZ0byLc+7C4gDRzEpb73EJHn4VJKS+3XyUJg8gzsjFY?=
 =?us-ascii?Q?wRLWCd6XQAPRaQWZoNEG4Bf+LTCb140eB/tBHgqBG6H1+RldNHt0Cd7bgo23?=
 =?us-ascii?Q?Y+a4RWrR/QHjmCGkWQErXROIYD+oi7EKUQ5muf4LwINnzuKk3UsqL+7ah8j2?=
 =?us-ascii?Q?hcuIF2a18Lw6amz6TD4WU/EodHvmsh8m+JamaUN7LpKRF7LJr2hUTb715qDp?=
 =?us-ascii?Q?hxehjaAt/sE6QFt8SwOEiekRSWRbXR8zTUjhDLlU5EiDirC+Oue/MSLo1fLI?=
 =?us-ascii?Q?Y9XaZgJPgs6JzP+ESyQFN5elpb7ORff8bHJHYK9g/EvQyeFY9EOXDf+qrxQD?=
 =?us-ascii?Q?rX8OHsRA8TA81rny8lKQDEo=3D?=
X-OriginatorOrg: seco.com
X-MS-Exchange-CrossTenant-Network-Message-Id: fed9347a-465c-4994-9dc4-08d9eb1fda60
X-MS-Exchange-CrossTenant-AuthSource: DB7PR03MB4523.eurprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 08 Feb 2022 16:27:09.1320
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: bebe97c3-6438-442e-ade3-ff17aa50e733
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: DdX6QzPIo1CeZEzPclIUqIpOr+GIB7m2+hJhkPFNZ2p9YjI8EULQND9L3ayBHJopeCoTGqRHdp9IIShavyPwRA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR03MB3133
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_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS,T_SCC_BODY_TEXT_LINE
        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: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Since commit 795ddd18d38f ("nvmem: core: remove regmap dependency"),
nvmem devices do not use the regmap API. Remove references to it from
the documentation. Additionally, update the example to reflect the new
API.  I have chosen the brcm-nvram driver since it seems to be simpler
than the qfprom driver.

Signed-off-by: Sean Anderson <sean.anderson@seco.com>
---

Changes in v2:
- Replace spaces with tabs

 Documentation/driver-api/nvmem.rst | 28 ++++++++++++----------------
 1 file changed, 12 insertions(+), 16 deletions(-)

diff --git a/Documentation/driver-api/nvmem.rst b/Documentation/driver-api/nvmem.rst
index 287e86819640..a8a58b61709b 100644
--- a/Documentation/driver-api/nvmem.rst
+++ b/Documentation/driver-api/nvmem.rst
@@ -26,9 +26,7 @@ was a rather big abstraction leak.
 
 This framework aims at solve these problems. It also introduces DT
 representation for consumer devices to go get the data they require (MAC
-Addresses, SoC/Revision ID, part numbers, and so on) from the NVMEMs. This
-framework is based on regmap, so that most of the abstraction available in
-regmap can be reused, across multiple types of buses.
+Addresses, SoC/Revision ID, part numbers, and so on) from the NVMEMs.
 
 NVMEM Providers
 +++++++++++++++
@@ -45,24 +43,22 @@ nvmem_device pointer.
 
 nvmem_unregister(nvmem) is used to unregister a previously registered provider.
 
-For example, a simple qfprom case::
+For example, a simple nvram case::
 
-  static struct nvmem_config econfig = {
-	.name = "qfprom",
-	.owner = THIS_MODULE,
-  };
-
-  static int qfprom_probe(struct platform_device *pdev)
+  static int brcm_nvram_probe(struct platform_device *pdev)
   {
+	struct nvmem_config config = {
+		.name = "brcm-nvram",
+		.reg_read = brcm_nvram_read,
+	};
 	...
-	econfig.dev = &pdev->dev;
-	nvmem = nvmem_register(&econfig);
-	...
+	config.dev = &pdev->dev;
+	config.priv = priv;
+	config.size = resource_size(res);
+
+	devm_nvmem_register(&econfig);
   }
 
-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::
 
-- 
2.25.1