1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 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> 7 */ 8 9 #ifndef _LINUX_NVMEM_CONSUMER_H 10 #define _LINUX_NVMEM_CONSUMER_H 11 12 #include <linux/err.h> 13 #include <linux/errno.h> 14 #include <linux/notifier.h> 15 16 struct device; 17 struct device_node; 18 /* consumer cookie */ 19 struct nvmem_cell; 20 struct nvmem_device; 21 struct nvmem_cell_info; 22 23 /** 24 * struct nvmem_cell_lookup - cell lookup entry 25 * 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 30 * this cell. 31 * @con_id: Connector id for this cell lookup. 32 */ 33 struct nvmem_cell_lookup { 34 const char *nvmem_name; 35 const char *cell_name; 36 const char *dev_id; 37 const char *con_id; 38 struct list_head node; 39 }; 40 41 enum { 42 NVMEM_ADD = 1, 43 NVMEM_REMOVE, 44 NVMEM_CELL_ADD, 45 NVMEM_CELL_REMOVE, 46 NVMEM_LAYOUT_ADD, 47 NVMEM_LAYOUT_REMOVE, 48 }; 49 50 #if IS_ENABLED(CONFIG_NVMEM) 51 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, 64 u32 *val); 65 int nvmem_cell_read_variable_le_u64(struct device *dev, const char *cell_id, 66 u64 *val); 67 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, 71 const char *name); 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); 82 83 const char *nvmem_dev_name(struct nvmem_device *nvmem); 84 85 void nvmem_add_cell_lookups(struct nvmem_cell_lookup *entries, 86 size_t nentries); 87 void nvmem_del_cell_lookups(struct nvmem_cell_lookup *entries, 88 size_t nentries); 89 90 int nvmem_register_notifier(struct notifier_block *nb); 91 int nvmem_unregister_notifier(struct notifier_block *nb); 92 93 struct nvmem_device *nvmem_device_find(void *data, 94 int (*match)(struct device *dev, const void *data)); 95 96 #else 97 98 static inline struct nvmem_cell *nvmem_cell_get(struct device *dev, 99 const char *id) 100 { 101 return ERR_PTR(-EOPNOTSUPP); 102 } 103 104 static inline struct nvmem_cell *devm_nvmem_cell_get(struct device *dev, 105 const char *id) 106 { 107 return ERR_PTR(-EOPNOTSUPP); 108 } 109 110 static inline void devm_nvmem_cell_put(struct device *dev, 111 struct nvmem_cell *cell) 112 { 113 114 } 115 static inline void nvmem_cell_put(struct nvmem_cell *cell) 116 { 117 } 118 119 static inline void *nvmem_cell_read(struct nvmem_cell *cell, size_t *len) 120 { 121 return ERR_PTR(-EOPNOTSUPP); 122 } 123 124 static inline int nvmem_cell_write(struct nvmem_cell *cell, 125 void *buf, size_t len) 126 { 127 return -EOPNOTSUPP; 128 } 129 130 static inline int nvmem_cell_read_u8(struct device *dev, 131 const char *cell_id, u8 *val) 132 { 133 return -EOPNOTSUPP; 134 } 135 136 static inline int nvmem_cell_read_u16(struct device *dev, 137 const char *cell_id, u16 *val) 138 { 139 return -EOPNOTSUPP; 140 } 141 142 static inline int nvmem_cell_read_u32(struct device *dev, 143 const char *cell_id, u32 *val) 144 { 145 return -EOPNOTSUPP; 146 } 147 148 static inline int nvmem_cell_read_u64(struct device *dev, 149 const char *cell_id, u64 *val) 150 { 151 return -EOPNOTSUPP; 152 } 153 154 static inline int nvmem_cell_read_variable_le_u32(struct device *dev, 155 const char *cell_id, 156 u32 *val) 157 { 158 return -EOPNOTSUPP; 159 } 160 161 static inline int nvmem_cell_read_variable_le_u64(struct device *dev, 162 const char *cell_id, 163 u64 *val) 164 { 165 return -EOPNOTSUPP; 166 } 167 168 static inline struct nvmem_device *nvmem_device_get(struct device *dev, 169 const char *name) 170 { 171 return ERR_PTR(-EOPNOTSUPP); 172 } 173 174 static inline struct nvmem_device *devm_nvmem_device_get(struct device *dev, 175 const char *name) 176 { 177 return ERR_PTR(-EOPNOTSUPP); 178 } 179 180 static inline void nvmem_device_put(struct nvmem_device *nvmem) 181 { 182 } 183 184 static inline void devm_nvmem_device_put(struct device *dev, 185 struct nvmem_device *nvmem) 186 { 187 } 188 189 static inline ssize_t nvmem_device_cell_read(struct nvmem_device *nvmem, 190 struct nvmem_cell_info *info, 191 void *buf) 192 { 193 return -EOPNOTSUPP; 194 } 195 196 static inline int nvmem_device_cell_write(struct nvmem_device *nvmem, 197 struct nvmem_cell_info *info, 198 void *buf) 199 { 200 return -EOPNOTSUPP; 201 } 202 203 static inline int nvmem_device_read(struct nvmem_device *nvmem, 204 unsigned int offset, size_t bytes, 205 void *buf) 206 { 207 return -EOPNOTSUPP; 208 } 209 210 static inline int nvmem_device_write(struct nvmem_device *nvmem, 211 unsigned int offset, size_t bytes, 212 void *buf) 213 { 214 return -EOPNOTSUPP; 215 } 216 217 static inline const char *nvmem_dev_name(struct nvmem_device *nvmem) 218 { 219 return NULL; 220 } 221 222 static inline void 223 nvmem_add_cell_lookups(struct nvmem_cell_lookup *entries, size_t nentries) {} 224 static inline void 225 nvmem_del_cell_lookups(struct nvmem_cell_lookup *entries, size_t nentries) {} 226 227 static inline int nvmem_register_notifier(struct notifier_block *nb) 228 { 229 return -EOPNOTSUPP; 230 } 231 232 static inline int nvmem_unregister_notifier(struct notifier_block *nb) 233 { 234 return -EOPNOTSUPP; 235 } 236 237 static inline struct nvmem_device *nvmem_device_find(void *data, 238 int (*match)(struct device *dev, const void *data)) 239 { 240 return NULL; 241 } 242 243 #endif /* CONFIG_NVMEM */ 244 245 #if IS_ENABLED(CONFIG_NVMEM) && IS_ENABLED(CONFIG_OF) 246 struct nvmem_cell *of_nvmem_cell_get(struct device_node *np, 247 const char *id); 248 struct nvmem_device *of_nvmem_device_get(struct device_node *np, 249 const char *name); 250 struct device_node *of_nvmem_layout_get_container(struct nvmem_device *nvmem); 251 #else 252 static inline struct nvmem_cell *of_nvmem_cell_get(struct device_node *np, 253 const char *id) 254 { 255 return ERR_PTR(-EOPNOTSUPP); 256 } 257 258 static inline struct nvmem_device *of_nvmem_device_get(struct device_node *np, 259 const char *name) 260 { 261 return ERR_PTR(-EOPNOTSUPP); 262 } 263 264 static inline struct device_node * 265 of_nvmem_layout_get_container(struct nvmem_device *nvmem) 266 { 267 return NULL; 268 } 269 #endif /* CONFIG_NVMEM && CONFIG_OF */ 270 271 #endif /* ifndef _LINUX_NVMEM_CONSUMER_H */ 272