[mirror_ubuntu-eoan-kernel.git] / include / linux / nvmem-provider.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * nvmem framework provider.
 *
 * Copyright (C) 2015 Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
 * Copyright (C) 2013 Maxime Ripard <maxime.ripard@free-electrons.com>
 */

#ifndef _LINUX_NVMEM_PROVIDER_H
#define _LINUX_NVMEM_PROVIDER_H

#include <linux/err.h>
#include <linux/errno.h>

struct nvmem_device;
struct nvmem_cell_info;
typedef int (*nvmem_reg_read_t)(void *priv, unsigned int offset,
				void *val, size_t bytes);
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 stride.
 * @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.
 *
 * Note: Specifying name and setting id to -1 implies a unique device
 * whose name is provided as-is (kept unaltered).
 */
struct nvmem_config {
	struct device		*dev;
	const char		*name;
	int			id;
	struct module		*owner;
	const struct nvmem_cell_info	*cells;
	int			ncells;
	bool			read_only;
	bool			root_only;
	nvmem_reg_read_t	reg_read;
	nvmem_reg_write_t	reg_write;
	int	size;
	int	word_size;
	int	stride;
	void	*priv;
	/* To be only used by old driver/misc/eeprom drivers */
	bool			compat;
	struct device		*base_dev;
};

/**
 * struct nvmem_cell_table - NVMEM cell definitions for given provider
 *
 * @nvmem_name:		Provider name.
 * @cells:		Array of cell definitions.
 * @ncells:		Number of cell definitions in the array.
 * @node:		List node.
 *
 * This structure together with related helper functions is provided for users
 * that don't can't access the nvmem provided structure but wish to register
 * cell definitions for it e.g. board files registering an EEPROM device.
 */
struct nvmem_cell_table {
	const char		*nvmem_name;
	const struct nvmem_cell_info	*cells;
	size_t			ncells;
	struct list_head	node;
};

#if IS_ENABLED(CONFIG_NVMEM)

struct nvmem_device *nvmem_register(const struct nvmem_config *cfg);
void nvmem_unregister(struct nvmem_device *nvmem);

struct nvmem_device *devm_nvmem_register(struct device *dev,
					 const struct nvmem_config *cfg);

int devm_nvmem_unregister(struct device *dev, struct nvmem_device *nvmem);

void nvmem_add_cell_table(struct nvmem_cell_table *table);
void nvmem_del_cell_table(struct nvmem_cell_table *table);

#else

static inline struct nvmem_device *nvmem_register(const struct nvmem_config *c)
{
	return ERR_PTR(-EOPNOTSUPP);
}

static inline void nvmem_unregister(struct nvmem_device *nvmem) {}

static inline struct nvmem_device *
devm_nvmem_register(struct device *dev, const struct nvmem_config *c)
{
	return nvmem_register(c);
}

static inline int
devm_nvmem_unregister(struct device *dev, struct nvmem_device *nvmem)
{
	return -EOPNOTSUPP;
}

static inline void nvmem_add_cell_table(struct nvmem_cell_table *table) {}
static inline void nvmem_del_cell_table(struct nvmem_cell_table *table) {}

#endif /* CONFIG_NVMEM */
#endif  /* ifndef _LINUX_NVMEM_PROVIDER_H */
Commit	Line	Data
b1c1db98	1	/* SPDX-License-Identifier: GPL-2.0 */
eace75cf SK	2	/*
	3	* nvmem framework provider.
	4	*
	5	* Copyright (C) 2015 Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
	6	* Copyright (C) 2013 Maxime Ripard <maxime.ripard@free-electrons.com>
eace75cf SK	7	*/
	8
	9	#ifndef _LINUX_NVMEM_PROVIDER_H
	10	#define _LINUX_NVMEM_PROVIDER_H
	11
42a6e099 AB	12	#include <linux/err.h>
	13	#include <linux/errno.h>
	14
eace75cf SK	15	struct nvmem_device;
eace75cf SK	16	struct nvmem_cell_info;
795ddd18 SK	17	typedef int (nvmem_reg_read_t)(void priv, unsigned int offset,
	18	void *val, size_t bytes);
	19	typedef int (nvmem_reg_write_t)(void priv, unsigned int offset,
	20	void *val, size_t bytes);
eace75cf	21
0b2ed745 AS	22	/**
	23	* struct nvmem_config - NVMEM device configuration
	24	*
	25	* @dev: Parent device.
	26	* @name: Optional name.
	27	* @id: Optional device ID used in full name. Ignored if name is NULL.
	28	* @owner: Pointer to exporter module. Used for refcounting.
	29	* @cells: Optional array of pre-defined NVMEM cells.
	30	* @ncells: Number of elements in cells.
	31	* @read_only: Device is read-only.
	32	* @root_only: Device is accessibly to root only.
	33	* @reg_read: Callback to read data.
	34	* @reg_write: Callback to write data.
	35	* @size: Device size.
	36	* @word_size: Minimum read/write access granularity.
	37	* @stride: Minimum read/write access stride.
	38	* @priv: User context passed to read/write callbacks.
	39	*
	40	* Note: A default "nvmem<id>" name will be assigned to the device if
	41	* no name is specified in its configuration. In such case "<id>" is
	42	* generated with ida_simple_get() and provided id field is ignored.
fd0f4906 AS	43	*
	44	* Note: Specifying name and setting id to -1 implies a unique device
	45	* whose name is provided as-is (kept unaltered).
0b2ed745	46	*/
eace75cf SK	47	struct nvmem_config {
	48	struct device *dev;
	49	const char *name;
	50	int id;
	51	struct module *owner;
	52	const struct nvmem_cell_info *cells;
	53	int ncells;
	54	bool read_only;
811b0d65	55	bool root_only;
795ddd18 SK	56	nvmem_reg_read_t reg_read;
	57	nvmem_reg_write_t reg_write;
	58	int size;
	59	int word_size;
	60	int stride;
	61	void *priv;
b6c217ab AL	62	/* To be only used by old driver/misc/eeprom drivers */
	63	bool compat;
	64	struct device *base_dev;
eace75cf SK	65	};
eace75cf SK	66
b985f4cb BG	67	/**
	68	* struct nvmem_cell_table - NVMEM cell definitions for given provider
	69	*
	70	* @nvmem_name: Provider name.
	71	* @cells: Array of cell definitions.
	72	* @ncells: Number of cell definitions in the array.
	73	* @node: List node.
	74	*
	75	* This structure together with related helper functions is provided for users
	76	* that don't can't access the nvmem provided structure but wish to register
	77	* cell definitions for it e.g. board files registering an EEPROM device.
	78	*/
	79	struct nvmem_cell_table {
	80	const char *nvmem_name;
	81	const struct nvmem_cell_info *cells;
	82	size_t ncells;
	83	struct list_head node;
	84	};
	85
eace75cf SK	86	#if IS_ENABLED(CONFIG_NVMEM)
	87
	88	struct nvmem_device nvmem_register(const struct nvmem_config cfg);
bf58e882	89	void nvmem_unregister(struct nvmem_device *nvmem);
eace75cf	90
f1f50eca AS	91	struct nvmem_device devm_nvmem_register(struct device dev,
	92	const struct nvmem_config *cfg);
	93
	94	int devm_nvmem_unregister(struct device dev, struct nvmem_device nvmem);
	95
b985f4cb BG	96	void nvmem_add_cell_table(struct nvmem_cell_table *table);
	97	void nvmem_del_cell_table(struct nvmem_cell_table *table);
	98
eace75cf SK	99	#else
	100
	101	static inline struct nvmem_device nvmem_register(const struct nvmem_config c)
	102	{
20167b70	103	return ERR_PTR(-EOPNOTSUPP);
eace75cf SK	104	}
eace75cf SK	105
bf58e882	106	static inline void nvmem_unregister(struct nvmem_device *nvmem) {}
eace75cf	107
f1f50eca AS	108	static inline struct nvmem_device *
	109	devm_nvmem_register(struct device dev, const struct nvmem_config c)
	110	{
	111	return nvmem_register(c);
	112	}
	113
	114	static inline int
	115	devm_nvmem_unregister(struct device dev, struct nvmem_device nvmem)
	116	{
20167b70	117	return -EOPNOTSUPP;
b3db17e4 AL	118	}
b3db17e4 AL	119
b985f4cb BG	120	static inline void nvmem_add_cell_table(struct nvmem_cell_table *table) {}
b985f4cb BG	121	static inline void nvmem_del_cell_table(struct nvmem_cell_table *table) {}
f1f50eca	122
eace75cf	123	#endif /* CONFIG_NVMEM */
eace75cf	124	#endif /* ifndef _LINUX_NVMEM_PROVIDER_H */