Re: [PATCH v3 01/22] nvmem: Document struct nvmem_config

From: Sean Wang
Date: Wed Feb 28 2018 - 13:35:14 EST


On Wed, 2018-01-03 at 12:00 -0800, Andrey Smirnov wrote:
> Add a simple description of struct nvmem_config and its fields.
>
> Cc: Srinivas Kandagatla <srinivas.kandagatla@xxxxxxxxxx>
> Cc: Heiko Stuebner <heiko@xxxxxxxxx>
> Cc: Masahiro Yamada <yamada.masahiro@xxxxxxxxxxxxx>
> Cc: Carlo Caione <carlo@xxxxxxxxxx>
> Cc: Kevin Hilman <khilman@xxxxxxxxxxxx>
> Cc: Matthias Brugger <matthias.bgg@xxxxxxxxx>
> Cc: cphealy@xxxxxxxxx
> Cc: linux-kernel@xxxxxxxxxxxxxxx
> Cc: linux-mediatek@xxxxxxxxxxxxxxxxxxx
> Cc: linux-rockchip@xxxxxxxxxxxxxxxxxxx
> Cc: linux-amlogic@xxxxxxxxxxxxxxxxxxx
> Cc: linux-arm-kernel@xxxxxxxxxxxxxxxxxxx
> Signed-off-by: Andrey Smirnov <andrew.smirnov@xxxxxxxxx>
> ---
> 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.

typo on 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;