blob: 8f8be5b00060285b61f57abe008026ede9303ff3 [file] [log] [blame]
David Brazdil0f672f62019-12-10 10:32:29 +00001/* SPDX-License-Identifier: GPL-2.0 */
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00002/*
3 * nvmem framework consumer.
4 *
5 * Copyright (C) 2015 Srinivas Kandagatla <srinivas.kandagatla@linaro.org>
6 * Copyright (C) 2013 Maxime Ripard <maxime.ripard@free-electrons.com>
Andrew Scullb4b6d4a2019-01-02 15:54:55 +00007 */
8
9#ifndef _LINUX_NVMEM_CONSUMER_H
10#define _LINUX_NVMEM_CONSUMER_H
11
12#include <linux/err.h>
13#include <linux/errno.h>
David Brazdil0f672f62019-12-10 10:32:29 +000014#include <linux/notifier.h>
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000015
16struct device;
17struct device_node;
18/* consumer cookie */
19struct nvmem_cell;
20struct nvmem_device;
21
22struct nvmem_cell_info {
23 const char *name;
24 unsigned int offset;
25 unsigned int bytes;
26 unsigned int bit_offset;
27 unsigned int nbits;
28};
29
David Brazdil0f672f62019-12-10 10:32:29 +000030/**
31 * struct nvmem_cell_lookup - cell lookup entry
32 *
33 * @nvmem_name: Name of the provider.
34 * @cell_name: Name of the nvmem cell as defined in the name field of
35 * struct nvmem_cell_info.
36 * @dev_id: Name of the consumer device that will be associated with
37 * this cell.
38 * @con_id: Connector id for this cell lookup.
39 */
40struct nvmem_cell_lookup {
41 const char *nvmem_name;
42 const char *cell_name;
43 const char *dev_id;
44 const char *con_id;
45 struct list_head node;
46};
47
48enum {
49 NVMEM_ADD = 1,
50 NVMEM_REMOVE,
51 NVMEM_CELL_ADD,
52 NVMEM_CELL_REMOVE,
53};
54
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000055#if IS_ENABLED(CONFIG_NVMEM)
56
57/* Cell based interface */
David Brazdil0f672f62019-12-10 10:32:29 +000058struct nvmem_cell *nvmem_cell_get(struct device *dev, const char *id);
59struct nvmem_cell *devm_nvmem_cell_get(struct device *dev, const char *id);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000060void nvmem_cell_put(struct nvmem_cell *cell);
61void devm_nvmem_cell_put(struct device *dev, struct nvmem_cell *cell);
62void *nvmem_cell_read(struct nvmem_cell *cell, size_t *len);
63int nvmem_cell_write(struct nvmem_cell *cell, void *buf, size_t len);
David Brazdil0f672f62019-12-10 10:32:29 +000064int nvmem_cell_read_u16(struct device *dev, const char *cell_id, u16 *val);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000065int nvmem_cell_read_u32(struct device *dev, const char *cell_id, u32 *val);
66
67/* direct nvmem device read/write interface */
68struct nvmem_device *nvmem_device_get(struct device *dev, const char *name);
69struct nvmem_device *devm_nvmem_device_get(struct device *dev,
70 const char *name);
71void nvmem_device_put(struct nvmem_device *nvmem);
72void devm_nvmem_device_put(struct device *dev, struct nvmem_device *nvmem);
73int nvmem_device_read(struct nvmem_device *nvmem, unsigned int offset,
74 size_t bytes, void *buf);
75int nvmem_device_write(struct nvmem_device *nvmem, unsigned int offset,
76 size_t bytes, void *buf);
77ssize_t nvmem_device_cell_read(struct nvmem_device *nvmem,
78 struct nvmem_cell_info *info, void *buf);
79int nvmem_device_cell_write(struct nvmem_device *nvmem,
80 struct nvmem_cell_info *info, void *buf);
81
David Brazdil0f672f62019-12-10 10:32:29 +000082const char *nvmem_dev_name(struct nvmem_device *nvmem);
83
84void nvmem_add_cell_lookups(struct nvmem_cell_lookup *entries,
85 size_t nentries);
86void nvmem_del_cell_lookups(struct nvmem_cell_lookup *entries,
87 size_t nentries);
88
89int nvmem_register_notifier(struct notifier_block *nb);
90int nvmem_unregister_notifier(struct notifier_block *nb);
91
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000092#else
93
94static inline struct nvmem_cell *nvmem_cell_get(struct device *dev,
David Brazdil0f672f62019-12-10 10:32:29 +000095 const char *id)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000096{
David Brazdil0f672f62019-12-10 10:32:29 +000097 return ERR_PTR(-EOPNOTSUPP);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +000098}
99
100static inline struct nvmem_cell *devm_nvmem_cell_get(struct device *dev,
David Brazdil0f672f62019-12-10 10:32:29 +0000101 const char *id)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000102{
David Brazdil0f672f62019-12-10 10:32:29 +0000103 return ERR_PTR(-EOPNOTSUPP);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000104}
105
106static inline void devm_nvmem_cell_put(struct device *dev,
107 struct nvmem_cell *cell)
108{
109
110}
111static inline void nvmem_cell_put(struct nvmem_cell *cell)
112{
113}
114
115static inline void *nvmem_cell_read(struct nvmem_cell *cell, size_t *len)
116{
David Brazdil0f672f62019-12-10 10:32:29 +0000117 return ERR_PTR(-EOPNOTSUPP);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000118}
119
120static inline int nvmem_cell_write(struct nvmem_cell *cell,
121 const char *buf, size_t len)
122{
David Brazdil0f672f62019-12-10 10:32:29 +0000123 return -EOPNOTSUPP;
124}
125
126static inline int nvmem_cell_read_u16(struct device *dev,
127 const char *cell_id, u16 *val)
128{
129 return -EOPNOTSUPP;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000130}
131
132static inline int nvmem_cell_read_u32(struct device *dev,
133 const char *cell_id, u32 *val)
134{
David Brazdil0f672f62019-12-10 10:32:29 +0000135 return -EOPNOTSUPP;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000136}
137
138static inline struct nvmem_device *nvmem_device_get(struct device *dev,
139 const char *name)
140{
David Brazdil0f672f62019-12-10 10:32:29 +0000141 return ERR_PTR(-EOPNOTSUPP);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000142}
143
144static inline struct nvmem_device *devm_nvmem_device_get(struct device *dev,
145 const char *name)
146{
David Brazdil0f672f62019-12-10 10:32:29 +0000147 return ERR_PTR(-EOPNOTSUPP);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000148}
149
150static inline void nvmem_device_put(struct nvmem_device *nvmem)
151{
152}
153
154static inline void devm_nvmem_device_put(struct device *dev,
155 struct nvmem_device *nvmem)
156{
157}
158
159static inline ssize_t nvmem_device_cell_read(struct nvmem_device *nvmem,
160 struct nvmem_cell_info *info,
161 void *buf)
162{
David Brazdil0f672f62019-12-10 10:32:29 +0000163 return -EOPNOTSUPP;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000164}
165
166static inline int nvmem_device_cell_write(struct nvmem_device *nvmem,
167 struct nvmem_cell_info *info,
168 void *buf)
169{
David Brazdil0f672f62019-12-10 10:32:29 +0000170 return -EOPNOTSUPP;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000171}
172
173static inline int nvmem_device_read(struct nvmem_device *nvmem,
174 unsigned int offset, size_t bytes,
175 void *buf)
176{
David Brazdil0f672f62019-12-10 10:32:29 +0000177 return -EOPNOTSUPP;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000178}
179
180static inline int nvmem_device_write(struct nvmem_device *nvmem,
181 unsigned int offset, size_t bytes,
182 void *buf)
183{
David Brazdil0f672f62019-12-10 10:32:29 +0000184 return -EOPNOTSUPP;
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000185}
David Brazdil0f672f62019-12-10 10:32:29 +0000186
187static inline const char *nvmem_dev_name(struct nvmem_device *nvmem)
188{
189 return NULL;
190}
191
192static inline void
193nvmem_add_cell_lookups(struct nvmem_cell_lookup *entries, size_t nentries) {}
194static inline void
195nvmem_del_cell_lookups(struct nvmem_cell_lookup *entries, size_t nentries) {}
196
197static inline int nvmem_register_notifier(struct notifier_block *nb)
198{
199 return -EOPNOTSUPP;
200}
201
202static inline int nvmem_unregister_notifier(struct notifier_block *nb)
203{
204 return -EOPNOTSUPP;
205}
206
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000207#endif /* CONFIG_NVMEM */
208
209#if IS_ENABLED(CONFIG_NVMEM) && IS_ENABLED(CONFIG_OF)
210struct nvmem_cell *of_nvmem_cell_get(struct device_node *np,
David Brazdil0f672f62019-12-10 10:32:29 +0000211 const char *id);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000212struct nvmem_device *of_nvmem_device_get(struct device_node *np,
213 const char *name);
214#else
215static inline struct nvmem_cell *of_nvmem_cell_get(struct device_node *np,
David Brazdil0f672f62019-12-10 10:32:29 +0000216 const char *id)
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000217{
David Brazdil0f672f62019-12-10 10:32:29 +0000218 return ERR_PTR(-EOPNOTSUPP);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000219}
220
221static inline struct nvmem_device *of_nvmem_device_get(struct device_node *np,
222 const char *name)
223{
David Brazdil0f672f62019-12-10 10:32:29 +0000224 return ERR_PTR(-EOPNOTSUPP);
Andrew Scullb4b6d4a2019-01-02 15:54:55 +0000225}
226#endif /* CONFIG_NVMEM && CONFIG_OF */
227
228#endif /* ifndef _LINUX_NVMEM_CONSUMER_H */