linux-kernel - [RFC PATCH 1/3] nvmem: Document enum nvmem

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20260128182925.13225-2-linkmauve@linkmauve.fr>
Date: Wed, 28 Jan 2026 19:29:20 +0100
From: Link Mauve <linkmauve@...kmauve.fr>
To: rust-for-linux@...r.kernel.org
Cc: Link Mauve <linkmauve@...kmauve.fr>,
	Srinivas Kandagatla <srini@...nel.org>,
	Miguel Ojeda <ojeda@...nel.org>,
	Boqun Feng <boqun.feng@...il.com>,
	Gary Guo <gary@...yguo.net>,
	Björn Roy Baron <bjorn3_gh@...tonmail.com>,
	Benno Lossin <lossin@...nel.org>,
	Andreas Hindborg <a.hindborg@...nel.org>,
	Alice Ryhl <aliceryhl@...gle.com>,
	Trevor Gross <tmgross@...ch.edu>,
	Danilo Krummrich <dakr@...nel.org>,
	Daniel Almeida <daniel.almeida@...labora.com>,
	Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
	Lyude Paul <lyude@...hat.com>,
	Asahi Lina <lina+kernel@...hilina.net>,
	Viresh Kumar <viresh.kumar@...aro.org>,
	Lorenzo Stoakes <lorenzo.stoakes@...cle.com>,
	Tamir Duberstein <tamird@...nel.org>,
	linux-kernel@...r.kernel.org
Subject: [RFC PATCH 1/3] nvmem: Document enum nvmem_type and its variants

These were previously undocumented, and while it is fine in C we emit a
warning whenever an enum or its variants aren’t documented in Rust.

Signed-off-by: Link Mauve <linkmauve@...kmauve.fr>
---
 include/linux/nvmem-provider.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/include/linux/nvmem-provider.h b/include/linux/nvmem-provider.h
index f3b13da78aac..92e3d9a76137 100644
--- a/include/linux/nvmem-provider.h
+++ b/include/linux/nvmem-provider.h
@@ -25,6 +25,14 @@ typedef int (*nvmem_cell_post_process_t)(void *priv, const char *id, int index,
 					 unsigned int offset, void *buf,
 					 size_t bytes);
 
+/**
+ * The possible types for a nvmem provider.
+ * @NVMEM_TYPE_UNKNOWN: The type of memory is unknown.
+ * @NVMEM_TYPE_EEPROM: Electrically erasable programmable ROM.
+ * @NVMEM_TYPE_OTP: One-time programmable memory.
+ * @NVMEM_TYPE_BATTERY_BACKED: This memory is backed by a battery.
+ * @NVMEM_TYPE_FRAM: Ferroelectric RAM.
+ */
 enum nvmem_type {
 	NVMEM_TYPE_UNKNOWN = 0,
 	NVMEM_TYPE_EEPROM,
-- 
2.52.0