2018-09-21 13:40:20 +00:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2015-07-27 11:13:19 +00:00
|
|
|
/*
|
|
|
|
* nvmem framework consumer.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2015 Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
|
|
|
|
* Copyright (C) 2013 Maxime Ripard <maxime.ripard@free-electrons.com>
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _LINUX_NVMEM_CONSUMER_H
|
|
|
|
#define _LINUX_NVMEM_CONSUMER_H
|
|
|
|
|
2017-07-26 09:34:48 +00:00
|
|
|
#include <linux/err.h>
|
|
|
|
#include <linux/errno.h>
|
2018-09-21 13:40:19 +00:00
|
|
|
#include <linux/notifier.h>
|
2017-07-26 09:34:48 +00:00
|
|
|
|
2015-07-27 11:13:34 +00:00
|
|
|
struct device;
|
|
|
|
struct device_node;
|
|
|
|
/* consumer cookie */
|
|
|
|
struct nvmem_cell;
|
2015-07-27 11:13:45 +00:00
|
|
|
struct nvmem_device;
|
2023-02-06 13:43:47 +00:00
|
|
|
struct nvmem_cell_info;
|
2015-07-27 11:13:19 +00:00
|
|
|
|
2018-09-21 13:40:17 +00:00
|
|
|
/**
|
|
|
|
* struct nvmem_cell_lookup - cell lookup entry
|
|
|
|
*
|
|
|
|
* @nvmem_name: Name of the provider.
|
|
|
|
* @cell_name: Name of the nvmem cell as defined in the name field of
|
|
|
|
* struct nvmem_cell_info.
|
|
|
|
* @dev_id: Name of the consumer device that will be associated with
|
|
|
|
* this cell.
|
|
|
|
* @con_id: Connector id for this cell lookup.
|
|
|
|
*/
|
|
|
|
struct nvmem_cell_lookup {
|
|
|
|
const char *nvmem_name;
|
|
|
|
const char *cell_name;
|
|
|
|
const char *dev_id;
|
|
|
|
const char *con_id;
|
|
|
|
struct list_head node;
|
|
|
|
};
|
|
|
|
|
2018-09-21 13:40:19 +00:00
|
|
|
enum {
|
|
|
|
NVMEM_ADD = 1,
|
|
|
|
NVMEM_REMOVE,
|
|
|
|
NVMEM_CELL_ADD,
|
|
|
|
NVMEM_CELL_REMOVE,
|
2023-08-23 13:27:44 +00:00
|
|
|
NVMEM_LAYOUT_ADD,
|
|
|
|
NVMEM_LAYOUT_REMOVE,
|
2018-09-21 13:40:19 +00:00
|
|
|
};
|
|
|
|
|
2015-07-27 11:13:34 +00:00
|
|
|
#if IS_ENABLED(CONFIG_NVMEM)
|
|
|
|
|
|
|
|
/* Cell based interface */
|
2018-09-21 13:40:21 +00:00
|
|
|
struct nvmem_cell *nvmem_cell_get(struct device *dev, const char *id);
|
|
|
|
struct nvmem_cell *devm_nvmem_cell_get(struct device *dev, const char *id);
|
2015-07-27 11:13:34 +00:00
|
|
|
void nvmem_cell_put(struct nvmem_cell *cell);
|
|
|
|
void devm_nvmem_cell_put(struct device *dev, struct nvmem_cell *cell);
|
|
|
|
void *nvmem_cell_read(struct nvmem_cell *cell, size_t *len);
|
|
|
|
int nvmem_cell_write(struct nvmem_cell *cell, void *buf, size_t len);
|
2020-07-22 10:06:57 +00:00
|
|
|
int nvmem_cell_read_u8(struct device *dev, const char *cell_id, u8 *val);
|
2019-04-13 10:32:57 +00:00
|
|
|
int nvmem_cell_read_u16(struct device *dev, const char *cell_id, u16 *val);
|
2017-07-26 09:34:46 +00:00
|
|
|
int nvmem_cell_read_u32(struct device *dev, const char *cell_id, u32 *val);
|
2020-03-10 13:22:46 +00:00
|
|
|
int nvmem_cell_read_u64(struct device *dev, const char *cell_id, u64 *val);
|
2021-03-30 11:12:37 +00:00
|
|
|
int nvmem_cell_read_variable_le_u32(struct device *dev, const char *cell_id,
|
|
|
|
u32 *val);
|
|
|
|
int nvmem_cell_read_variable_le_u64(struct device *dev, const char *cell_id,
|
|
|
|
u64 *val);
|
2015-07-27 11:13:34 +00:00
|
|
|
|
2015-07-27 11:13:45 +00:00
|
|
|
/* direct nvmem device read/write interface */
|
|
|
|
struct nvmem_device *nvmem_device_get(struct device *dev, const char *name);
|
|
|
|
struct nvmem_device *devm_nvmem_device_get(struct device *dev,
|
|
|
|
const char *name);
|
|
|
|
void nvmem_device_put(struct nvmem_device *nvmem);
|
|
|
|
void devm_nvmem_device_put(struct device *dev, struct nvmem_device *nvmem);
|
|
|
|
int nvmem_device_read(struct nvmem_device *nvmem, unsigned int offset,
|
|
|
|
size_t bytes, void *buf);
|
|
|
|
int nvmem_device_write(struct nvmem_device *nvmem, unsigned int offset,
|
|
|
|
size_t bytes, void *buf);
|
|
|
|
ssize_t nvmem_device_cell_read(struct nvmem_device *nvmem,
|
|
|
|
struct nvmem_cell_info *info, void *buf);
|
|
|
|
int nvmem_device_cell_write(struct nvmem_device *nvmem,
|
|
|
|
struct nvmem_cell_info *info, void *buf);
|
|
|
|
|
2018-09-21 13:40:03 +00:00
|
|
|
const char *nvmem_dev_name(struct nvmem_device *nvmem);
|
|
|
|
|
2018-09-21 13:40:17 +00:00
|
|
|
void nvmem_add_cell_lookups(struct nvmem_cell_lookup *entries,
|
|
|
|
size_t nentries);
|
|
|
|
void nvmem_del_cell_lookups(struct nvmem_cell_lookup *entries,
|
|
|
|
size_t nentries);
|
|
|
|
|
2018-09-21 13:40:19 +00:00
|
|
|
int nvmem_register_notifier(struct notifier_block *nb);
|
|
|
|
int nvmem_unregister_notifier(struct notifier_block *nb);
|
|
|
|
|
2019-10-03 09:52:29 +00:00
|
|
|
struct nvmem_device *nvmem_device_find(void *data,
|
|
|
|
int (*match)(struct device *dev, const void *data));
|
|
|
|
|
2015-07-27 11:13:34 +00:00
|
|
|
#else
|
|
|
|
|
|
|
|
static inline struct nvmem_cell *nvmem_cell_get(struct device *dev,
|
2018-09-21 13:40:21 +00:00
|
|
|
const char *id)
|
2015-07-27 11:13:34 +00:00
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return ERR_PTR(-EOPNOTSUPP);
|
2015-07-27 11:13:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline struct nvmem_cell *devm_nvmem_cell_get(struct device *dev,
|
2018-09-21 13:40:21 +00:00
|
|
|
const char *id)
|
2015-07-27 11:13:34 +00:00
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return ERR_PTR(-EOPNOTSUPP);
|
2015-07-27 11:13:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline void devm_nvmem_cell_put(struct device *dev,
|
|
|
|
struct nvmem_cell *cell)
|
|
|
|
{
|
|
|
|
|
|
|
|
}
|
|
|
|
static inline void nvmem_cell_put(struct nvmem_cell *cell)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2016-06-02 11:05:12 +00:00
|
|
|
static inline void *nvmem_cell_read(struct nvmem_cell *cell, size_t *len)
|
2015-07-27 11:13:34 +00:00
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return ERR_PTR(-EOPNOTSUPP);
|
2015-07-27 11:13:34 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline int nvmem_cell_write(struct nvmem_cell *cell,
|
2019-10-29 11:42:31 +00:00
|
|
|
void *buf, size_t len)
|
2015-07-27 11:13:34 +00:00
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return -EOPNOTSUPP;
|
2015-07-27 11:13:34 +00:00
|
|
|
}
|
2015-07-27 11:13:45 +00:00
|
|
|
|
2019-04-13 10:32:57 +00:00
|
|
|
static inline int nvmem_cell_read_u16(struct device *dev,
|
|
|
|
const char *cell_id, u16 *val)
|
|
|
|
{
|
|
|
|
return -EOPNOTSUPP;
|
|
|
|
}
|
|
|
|
|
2017-07-26 09:34:46 +00:00
|
|
|
static inline int nvmem_cell_read_u32(struct device *dev,
|
|
|
|
const char *cell_id, u32 *val)
|
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return -EOPNOTSUPP;
|
2017-07-26 09:34:46 +00:00
|
|
|
}
|
|
|
|
|
2020-03-10 13:22:46 +00:00
|
|
|
static inline int nvmem_cell_read_u64(struct device *dev,
|
|
|
|
const char *cell_id, u64 *val)
|
|
|
|
{
|
|
|
|
return -EOPNOTSUPP;
|
|
|
|
}
|
|
|
|
|
2021-09-13 16:05:51 +00:00
|
|
|
static inline int nvmem_cell_read_variable_le_u32(struct device *dev,
|
|
|
|
const char *cell_id,
|
|
|
|
u32 *val)
|
|
|
|
{
|
|
|
|
return -EOPNOTSUPP;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline int nvmem_cell_read_variable_le_u64(struct device *dev,
|
|
|
|
const char *cell_id,
|
|
|
|
u64 *val)
|
|
|
|
{
|
|
|
|
return -EOPNOTSUPP;
|
|
|
|
}
|
|
|
|
|
2015-07-27 11:13:45 +00:00
|
|
|
static inline struct nvmem_device *nvmem_device_get(struct device *dev,
|
|
|
|
const char *name)
|
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return ERR_PTR(-EOPNOTSUPP);
|
2015-07-27 11:13:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline struct nvmem_device *devm_nvmem_device_get(struct device *dev,
|
|
|
|
const char *name)
|
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return ERR_PTR(-EOPNOTSUPP);
|
2015-07-27 11:13:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline void nvmem_device_put(struct nvmem_device *nvmem)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void devm_nvmem_device_put(struct device *dev,
|
|
|
|
struct nvmem_device *nvmem)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline ssize_t nvmem_device_cell_read(struct nvmem_device *nvmem,
|
|
|
|
struct nvmem_cell_info *info,
|
|
|
|
void *buf)
|
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return -EOPNOTSUPP;
|
2015-07-27 11:13:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline int nvmem_device_cell_write(struct nvmem_device *nvmem,
|
|
|
|
struct nvmem_cell_info *info,
|
|
|
|
void *buf)
|
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return -EOPNOTSUPP;
|
2015-07-27 11:13:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline int nvmem_device_read(struct nvmem_device *nvmem,
|
|
|
|
unsigned int offset, size_t bytes,
|
|
|
|
void *buf)
|
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return -EOPNOTSUPP;
|
2015-07-27 11:13:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline int nvmem_device_write(struct nvmem_device *nvmem,
|
|
|
|
unsigned int offset, size_t bytes,
|
|
|
|
void *buf)
|
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return -EOPNOTSUPP;
|
2015-07-27 11:13:45 +00:00
|
|
|
}
|
2018-09-21 13:40:03 +00:00
|
|
|
|
|
|
|
static inline const char *nvmem_dev_name(struct nvmem_device *nvmem)
|
|
|
|
{
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2018-09-21 13:40:17 +00:00
|
|
|
static inline void
|
|
|
|
nvmem_add_cell_lookups(struct nvmem_cell_lookup *entries, size_t nentries) {}
|
|
|
|
static inline void
|
|
|
|
nvmem_del_cell_lookups(struct nvmem_cell_lookup *entries, size_t nentries) {}
|
|
|
|
|
2018-09-21 13:40:19 +00:00
|
|
|
static inline int nvmem_register_notifier(struct notifier_block *nb)
|
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return -EOPNOTSUPP;
|
2018-09-21 13:40:19 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
static inline int nvmem_unregister_notifier(struct notifier_block *nb)
|
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return -EOPNOTSUPP;
|
2018-09-21 13:40:19 +00:00
|
|
|
}
|
|
|
|
|
2019-10-03 09:52:29 +00:00
|
|
|
static inline struct nvmem_device *nvmem_device_find(void *data,
|
|
|
|
int (*match)(struct device *dev, const void *data))
|
|
|
|
{
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2015-07-27 11:13:34 +00:00
|
|
|
#endif /* CONFIG_NVMEM */
|
|
|
|
|
|
|
|
#if IS_ENABLED(CONFIG_NVMEM) && IS_ENABLED(CONFIG_OF)
|
|
|
|
struct nvmem_cell *of_nvmem_cell_get(struct device_node *np,
|
2018-09-21 13:40:21 +00:00
|
|
|
const char *id);
|
2015-07-27 11:13:45 +00:00
|
|
|
struct nvmem_device *of_nvmem_device_get(struct device_node *np,
|
|
|
|
const char *name);
|
2023-04-04 17:21:21 +00:00
|
|
|
struct device_node *of_nvmem_layout_get_container(struct nvmem_device *nvmem);
|
2015-07-27 11:13:34 +00:00
|
|
|
#else
|
|
|
|
static inline struct nvmem_cell *of_nvmem_cell_get(struct device_node *np,
|
2018-09-21 13:40:21 +00:00
|
|
|
const char *id)
|
2015-07-27 11:13:34 +00:00
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return ERR_PTR(-EOPNOTSUPP);
|
2015-07-27 11:13:34 +00:00
|
|
|
}
|
2015-07-27 11:13:45 +00:00
|
|
|
|
|
|
|
static inline struct nvmem_device *of_nvmem_device_get(struct device_node *np,
|
|
|
|
const char *name)
|
|
|
|
{
|
2018-09-21 13:40:22 +00:00
|
|
|
return ERR_PTR(-EOPNOTSUPP);
|
2015-07-27 11:13:45 +00:00
|
|
|
}
|
2023-04-04 17:21:21 +00:00
|
|
|
|
|
|
|
static inline struct device_node *
|
|
|
|
of_nvmem_layout_get_container(struct nvmem_device *nvmem)
|
|
|
|
{
|
2023-08-23 13:27:42 +00:00
|
|
|
return NULL;
|
2023-04-04 17:21:21 +00:00
|
|
|
}
|
2015-07-27 11:13:34 +00:00
|
|
|
#endif /* CONFIG_NVMEM && CONFIG_OF */
|
|
|
|
|
2015-07-27 11:13:19 +00:00
|
|
|
#endif /* ifndef _LINUX_NVMEM_CONSUMER_H */
|