[PATCH v4 01/22] nvmem: Document struct nvmem_config
From: Andrey Smirnov <hidden>
Date: 2018-02-28 14:48:40
Also in:
linux-amlogic, linux-mediatek, linux-rockchip, lkml
Subsystem:
nvmem framework, the rest · Maintainers:
Srinivas Kandagatla, Linus Torvalds
Add a simple description of struct nvmem_config and its fields. Cc: Srinivas Kandagatla <redacted> Cc: Heiko Stuebner <heiko@sntech.de> Cc: Masahiro Yamada <redacted> Cc: Carlo Caione <redacted> Cc: Kevin Hilman <khilman@baylibre.com> Cc: Matthias Brugger <matthias.bgg@gmail.com> Cc: cphealy at gmail.com Cc: linux-kernel at vger.kernel.org Cc: linux-mediatek at lists.infradead.org Cc: linux-rockchip at lists.infradead.org Cc: linux-amlogic at lists.infradead.org Cc: linux-arm-kernel at lists.infradead.org Signed-off-by: Andrey Smirnov <redacted> --- include/linux/nvmem-provider.h | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+)
diff --git a/include/linux/nvmem-provider.h b/include/linux/nvmem-provider.h
index 497706f5adca..27e599222ec1 100644
--- a/include/linux/nvmem-provider.h
+++ b/include/linux/nvmem-provider.h@@ -22,6 +22,28 @@ typedef int (*nvmem_reg_read_t)(void *priv, unsigned int offset, typedef int (*nvmem_reg_write_t)(void *priv, unsigned int offset, void *val, size_t bytes); +/** + * struct nvmem_config - NVMEM device configuration + * + * @dev: Parent device. + * @name: Optional name. + * @id: Optional device ID used in full name. Ignored if name is NULL. + * @owner: Pointer to exporter module. Used for refcounting. + * @cells: Optional array of pre-defined NVMEM cells. + * @ncells: Number of elements in cells. + * @read_only: Device is read-only. + * @root_only: Device is accessibly to root only. + * @reg_read: Callback to read data. + * @reg_write: Callback to write data. + * @size: Device size. + * @word_size: Minimum read/write access granularity. + * @stride: Minimum read/write access stide. + * @priv: User context passed to read/write callbacks. + * + * Note: A default "nvmem<id>" name will be assigned to the device if + * no name is specified in its configuration. In such case "<id>" is + * generated with ida_simple_get() and provided id field is ignored. + */ struct nvmem_config { struct device *dev; const char *name;
--
2.14.3