[linux-2.6-block.git] / include / linux / nvmem-provider.h

/*
 * nvmem framework provider.
 *
 * Copyright (C) 2015 Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
 * Copyright (C) 2013 Maxime Ripard <maxime.ripard@free-electrons.com>
 *
 * This file is licensed under the terms of the GNU General Public
 * License version 2.  This program is licensed "as is" without any
 * warranty of any kind, whether express or implied.
 */

#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;
};

#if IS_ENABLED(CONFIG_NVMEM)

struct nvmem_device *nvmem_register(const struct nvmem_config *cfg);
int 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);

int nvmem_add_cells(struct nvmem_device *nvmem,
		    const struct nvmem_cell_info *info,
		    int ncells);
#else

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

static inline int nvmem_unregister(struct nvmem_device *nvmem)
{
	return -ENOSYS;
}

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 nvmem_unregister(nvmem);

}

static inline int nvmem_add_cells(struct nvmem_device *nvmem,
				  const struct nvmem_cell_info *info,
				  int ncells)
{
	return -ENOSYS;
}

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