Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:18 as permitted sender) client-ip=2620:137:e000::1: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, Michael Walle <michael@walle.cc>,
        Srinivas Kandagatla <srinivas.kandagatla@linaro.org>,
        Sean Anderson <sean.anderson@seco.com>
Subject: [PATCH v3 2/2] doc: nvmem: Update example
Date:   Mon, 14 Feb 2022 11:35:13 -0500
Message-Id: <20220214163514.435142-2-sean.anderson@seco.com>
In-Reply-To: <20220214163514.435142-1-sean.anderson@seco.com>
References: <20220214163514.435142-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?HMMHKwBnWtKNbLPaZzh395jefc/l4DJDjuYa1yw3zVHAD3+MjuJeJGaffnak?=
 =?us-ascii?Q?G1GE/H/V6frlsTK+LRq9eUfm8HukWBsoTD85dEkRS5IOK1Cbaql7N2TmwXTv?=
 =?us-ascii?Q?EC1D92FIw5eNCuHIImVbI8OGwdJLvPjsKj4sKmQ8AlTaUA6iYSZ3SUcGV+1T?=
 =?us-ascii?Q?ADk8WwzrDpxKwCcnKVNiEm+52joaQnY/8gOnKFRVXHLcE5HWboBMU9C9cZmq?=
 =?us-ascii?Q?ThJAf7qjevF4UCGZ90AOtVGNubBqDLciNtdlUKyWK0jxosjXr4emrBRpYCbx?=
 =?us-ascii?Q?v2h9Wm7c2z4ds0HbY+4ohrErbJ93E3iRDXN7Je+LApOy4hpcjxrJTbMEPPe2?=
 =?us-ascii?Q?djwr68gOzw/fdEreITBEfRIgzjkRCTZUwdsvX83QiFBFfxj6IyegRWcXZeh+?=
 =?us-ascii?Q?dFC1rlTO6+omlHSVK4Zzg7O6sPNny2d6IYUpCOlIpBzmkvdW6VDh+fhpAklf?=
 =?us-ascii?Q?DSuWAJ9mcc7KnER+yztvx00wWcv7FM96bPOzdsCZIzSfgBu2Hq385Bo6ZVIJ?=
 =?us-ascii?Q?+zgRzWVEuObkDIAcUeba7+hU8U2g1EjyPedtRhcmUqmy0PihO9qvBpeUtZnf?=
 =?us-ascii?Q?R9x121tHkbhQoMOiNFPOHs1fHoszcPcQ+THnV3m55ncLtGMNUGkN5OcW+ZxD?=
 =?us-ascii?Q?1IdT5eVhl4oxqk8WEP1gZm/ZwUbQCJaknOwQOBDADHp1Y1ITKCNpSaTzzhhQ?=
 =?us-ascii?Q?+eAXqL+BlRAj9vkjHkkGvVUW31TMo/Ea634gQmK1l4a/+Q7F9NedXQudSx1E?=
 =?us-ascii?Q?bYTWraSlFXsVWsRfdrSudYy0yJH7hkYMZvUm2Y5Glhu6Hk5i6Fdk9fI4Q+au?=
 =?us-ascii?Q?TLMQ2f3Fwm/XKWZ7FYOUOifOmSpdb+Vym9lE4PkInm523LtcVezaqgHEpY61?=
 =?us-ascii?Q?hbxSGkEFMa1N5f7LqKwoA2LERwyR/0VZS7hAUHwG4pTQiFubLjJ0NHBr2KWO?=
 =?us-ascii?Q?rJRE1fFQJIuFk/tbqN7v1O8mUe2EcKX7+ai9mcU0d4Np4vrVzgSHyu6PFgFy?=
 =?us-ascii?Q?J38OzMrZWrqW6IXQQI/T1ENZgBAdQGZ5EcrN0VuGYB5MdSjq7+SR+LMYfpni?=
 =?us-ascii?Q?d1jfYrEc8DS7DMSuDAKXFYsNCcb5vLvWJGQ6pRxnjbs7NmkM4jvCOZzrPGGn?=
 =?us-ascii?Q?3RorrTFgCibN7AU6A/KQmOQAowQf/6X7Npo2nQK1OXG0/17UxPLxUHCN/jXx?=
 =?us-ascii?Q?gYaSE/zIFn25I4p7W30Wzn1BuWJ3rTGws32+f//id+izFrkUMvUp2PydFk2Y?=
 =?us-ascii?Q?4d2tmk+zlxOASM8/9T8NpsJO4tvf2TCpUNt/XAcfXzyYToKUCcsTkZt2W/IC?=
 =?us-ascii?Q?E8c3EbAQbqLZh7SY7tLJHVWs2Rrrb4/FRwRZq4mQRChviwvZS6Ph1x5A+3ta?=
 =?us-ascii?Q?rDTJhbGqt332AlHrTh6qHVk/ek4r0xjnmNMYFMS4fr5enGIcPf/mrs3ReosG?=
 =?us-ascii?Q?hW4Ni4QFBhnWRcrfolBPvH4MbljrVAqTI90e5g2ymEO2FyXnks3ehE5pNGoj?=
 =?us-ascii?Q?2KW/rOfhpyPtChBwX6ODyNsDUXy7ZgcA7AtuUCaW5cuGbGGJEHhjn2oR7jLn?=
 =?us-ascii?Q?CQFL/U123U9/yMkzyDA7LIAEXG0rb89WE8ugdJq2buL5CvEUimf/VihzhlgU?=
 =?us-ascii?Q?D1GAoV87Bo0em7BWvaymGAY=3D?=
X-OriginatorOrg: seco.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 021b96ce-3a0c-490a-9ac4-08d9efd8015f
X-MS-Exchange-CrossTenant-AuthSource: DB7PR03MB4523.eurprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Feb 2022 16:35:26.5590
 (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: c6UuUNgYh/xGdqKQTXkEJDBHwdCp1GHxjUQzWPk2j+UwYgoMHCG42Q4NDm3Wj+vCUS1BOVJ9NedP0KrbhIa3Gw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB7PR03MB3834
X-Spam-Status: No, score=-2.0 required=5.0 tests=BAYES_00,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,RDNS_NONE,SPF_HELO_NONE,T_SCC_BODY_TEXT_LINE
	autolearn=no 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

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 v3:
- Split into two patches as requested
- Fix one missing conversion of econfig to config

 Documentation/driver-api/nvmem.rst | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

diff --git a/Documentation/driver-api/nvmem.rst b/Documentation/driver-api/nvmem.rst
index 56352ad1b1b0..e3366322d46c 100644
--- a/Documentation/driver-api/nvmem.rst
+++ b/Documentation/driver-api/nvmem.rst
@@ -43,19 +43,20 @@ 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(&config);
   }
 
 Users of board files can define and register nvmem cells using the
-- 
2.25.1