[RFC PATCH 1/3] nvmem: Document enum nvmem_type and its variants

Link Mauve posted 3 patches 1 week, 5 days ago
There is a newer version of this series
[RFC PATCH 1/3] nvmem: Document enum nvmem_type and its variants
Posted by Link Mauve 1 week, 5 days ago
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@linkmauve.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