1 /* SPDX-License-Identifier: GPL-2.0 */
3 * nvmem framework consumer.
5 * Copyright (C) 2015 Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
6 * Copyright (C) 2013 Maxime Ripard <maxime.ripard@free-electrons.com>
9 #ifndef _LINUX_NVMEM_CONSUMER_H
10 #define _LINUX_NVMEM_CONSUMER_H
12 #include <linux/err.h>
13 #include <linux/errno.h>
14 #include <linux/notifier.h>
21 struct nvmem_cell_info;
24 * struct nvmem_cell_lookup - cell lookup entry
26 * @nvmem_name: Name of the provider.
27 * @cell_name: Name of the nvmem cell as defined in the name field of
28 * struct nvmem_cell_info.
29 * @dev_id: Name of the consumer device that will be associated with
31 * @con_id: Connector id for this cell lookup.
33 struct nvmem_cell_lookup {
34 const char *nvmem_name;
35 const char *cell_name;
38 struct list_head node;
50 #if IS_ENABLED(CONFIG_NVMEM)
52 /* Cell based interface */
53 struct nvmem_cell *nvmem_cell_get(struct device *dev, const char *id);
54 struct nvmem_cell *devm_nvmem_cell_get(struct device *dev, const char *id);
55 void nvmem_cell_put(struct nvmem_cell *cell);
56 void devm_nvmem_cell_put(struct device *dev, struct nvmem_cell *cell);
57 void *nvmem_cell_read(struct nvmem_cell *cell, size_t *len);
58 int nvmem_cell_write(struct nvmem_cell *cell, void *buf, size_t len);
59 int nvmem_cell_read_u8(struct device *dev, const char *cell_id, u8 *val);
60 int nvmem_cell_read_u16(struct device *dev, const char *cell_id, u16 *val);
61 int nvmem_cell_read_u32(struct device *dev, const char *cell_id, u32 *val);
62 int nvmem_cell_read_u64(struct device *dev, const char *cell_id, u64 *val);
63 int nvmem_cell_read_variable_le_u32(struct device *dev, const char *cell_id,
65 int nvmem_cell_read_variable_le_u64(struct device *dev, const char *cell_id,
68 /* direct nvmem device read/write interface */
69 struct nvmem_device *nvmem_device_get(struct device *dev, const char *name);
70 struct nvmem_device *devm_nvmem_device_get(struct device *dev,
72 void nvmem_device_put(struct nvmem_device *nvmem);
73 void devm_nvmem_device_put(struct device *dev, struct nvmem_device *nvmem);
74 int nvmem_device_read(struct nvmem_device *nvmem, unsigned int offset,
75 size_t bytes, void *buf);
76 int nvmem_device_write(struct nvmem_device *nvmem, unsigned int offset,
77 size_t bytes, void *buf);
78 ssize_t nvmem_device_cell_read(struct nvmem_device *nvmem,
79 struct nvmem_cell_info *info, void *buf);
80 int nvmem_device_cell_write(struct nvmem_device *nvmem,
81 struct nvmem_cell_info *info, void *buf);
83 const char *nvmem_dev_name(struct nvmem_device *nvmem);
85 void nvmem_add_cell_lookups(struct nvmem_cell_lookup *entries,
87 void nvmem_del_cell_lookups(struct nvmem_cell_lookup *entries,
90 int nvmem_register_notifier(struct notifier_block *nb);
91 int nvmem_unregister_notifier(struct notifier_block *nb);
93 struct nvmem_device *nvmem_device_find(void *data,
94 int (*match)(struct device *dev, const void *data));
98 static inline struct nvmem_cell *nvmem_cell_get(struct device *dev,
101 return ERR_PTR(-EOPNOTSUPP);
104 static inline struct nvmem_cell *devm_nvmem_cell_get(struct device *dev,
107 return ERR_PTR(-EOPNOTSUPP);
110 static inline void devm_nvmem_cell_put(struct device *dev,
111 struct nvmem_cell *cell)
115 static inline void nvmem_cell_put(struct nvmem_cell *cell)
119 static inline void *nvmem_cell_read(struct nvmem_cell *cell, size_t *len)
121 return ERR_PTR(-EOPNOTSUPP);
124 static inline int nvmem_cell_write(struct nvmem_cell *cell,
125 void *buf, size_t len)
130 static inline int nvmem_cell_read_u16(struct device *dev,
131 const char *cell_id, u16 *val)
136 static inline int nvmem_cell_read_u32(struct device *dev,
137 const char *cell_id, u32 *val)
142 static inline int nvmem_cell_read_u64(struct device *dev,
143 const char *cell_id, u64 *val)
148 static inline int nvmem_cell_read_variable_le_u32(struct device *dev,
155 static inline int nvmem_cell_read_variable_le_u64(struct device *dev,
162 static inline struct nvmem_device *nvmem_device_get(struct device *dev,
165 return ERR_PTR(-EOPNOTSUPP);
168 static inline struct nvmem_device *devm_nvmem_device_get(struct device *dev,
171 return ERR_PTR(-EOPNOTSUPP);
174 static inline void nvmem_device_put(struct nvmem_device *nvmem)
178 static inline void devm_nvmem_device_put(struct device *dev,
179 struct nvmem_device *nvmem)
183 static inline ssize_t nvmem_device_cell_read(struct nvmem_device *nvmem,
184 struct nvmem_cell_info *info,
190 static inline int nvmem_device_cell_write(struct nvmem_device *nvmem,
191 struct nvmem_cell_info *info,
197 static inline int nvmem_device_read(struct nvmem_device *nvmem,
198 unsigned int offset, size_t bytes,
204 static inline int nvmem_device_write(struct nvmem_device *nvmem,
205 unsigned int offset, size_t bytes,
211 static inline const char *nvmem_dev_name(struct nvmem_device *nvmem)
217 nvmem_add_cell_lookups(struct nvmem_cell_lookup *entries, size_t nentries) {}
219 nvmem_del_cell_lookups(struct nvmem_cell_lookup *entries, size_t nentries) {}
221 static inline int nvmem_register_notifier(struct notifier_block *nb)
226 static inline int nvmem_unregister_notifier(struct notifier_block *nb)
231 static inline struct nvmem_device *nvmem_device_find(void *data,
232 int (*match)(struct device *dev, const void *data))
237 #endif /* CONFIG_NVMEM */
239 #if IS_ENABLED(CONFIG_NVMEM) && IS_ENABLED(CONFIG_OF)
240 struct nvmem_cell *of_nvmem_cell_get(struct device_node *np,
242 struct nvmem_device *of_nvmem_device_get(struct device_node *np,
244 struct device_node *of_nvmem_layout_get_container(struct nvmem_device *nvmem);
246 static inline struct nvmem_cell *of_nvmem_cell_get(struct device_node *np,
249 return ERR_PTR(-EOPNOTSUPP);
252 static inline struct nvmem_device *of_nvmem_device_get(struct device_node *np,
255 return ERR_PTR(-EOPNOTSUPP);
258 static inline struct device_node *
259 of_nvmem_layout_get_container(struct nvmem_device *nvmem)
263 #endif /* CONFIG_NVMEM && CONFIG_OF */
265 #endif /* ifndef _LINUX_NVMEM_CONSUMER_H */