1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * nvmem framework consumer. 4 * 5 * Copyright (C) 2015 Srinivas Kandagatla <[email protected]> 6 * Copyright (C) 2013 Maxime Ripard <[email protected]> 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 22 struct 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 30 /** 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 */ 40 struct 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 48 enum { 49 NVMEM_ADD = 1, 50 NVMEM_REMOVE, 51 NVMEM_CELL_ADD, 52 NVMEM_CELL_REMOVE, 53 }; 54 55 #if IS_ENABLED(CONFIG_NVMEM) 56 57 /* Cell based interface */ 58 struct nvmem_cell *nvmem_cell_get(struct device *dev, const char *id); 59 struct nvmem_cell *devm_nvmem_cell_get(struct device *dev, const char *id); 60 void nvmem_cell_put(struct nvmem_cell *cell); 61 void devm_nvmem_cell_put(struct device *dev, struct nvmem_cell *cell); 62 void *nvmem_cell_read(struct nvmem_cell *cell, size_t *len); 63 int nvmem_cell_write(struct nvmem_cell *cell, void *buf, size_t len); 64 int nvmem_cell_read_u8(struct device *dev, const char *cell_id, u8 *val); 65 int nvmem_cell_read_u16(struct device *dev, const char *cell_id, u16 *val); 66 int nvmem_cell_read_u32(struct device *dev, const char *cell_id, u32 *val); 67 int nvmem_cell_read_u64(struct device *dev, const char *cell_id, u64 *val); 68 int nvmem_cell_read_variable_le_u32(struct device *dev, const char *cell_id, 69 u32 *val); 70 int nvmem_cell_read_variable_le_u64(struct device *dev, const char *cell_id, 71 u64 *val); 72 73 /* direct nvmem device read/write interface */ 74 struct nvmem_device *nvmem_device_get(struct device *dev, const char *name); 75 struct nvmem_device *devm_nvmem_device_get(struct device *dev, 76 const char *name); 77 void nvmem_device_put(struct nvmem_device *nvmem); 78 void devm_nvmem_device_put(struct device *dev, struct nvmem_device *nvmem); 79 int nvmem_device_read(struct nvmem_device *nvmem, unsigned int offset, 80 size_t bytes, void *buf); 81 int nvmem_device_write(struct nvmem_device *nvmem, unsigned int offset, 82 size_t bytes, void *buf); 83 ssize_t nvmem_device_cell_read(struct nvmem_device *nvmem, 84 struct nvmem_cell_info *info, void *buf); 85 int nvmem_device_cell_write(struct nvmem_device *nvmem, 86 struct nvmem_cell_info *info, void *buf); 87 88 const char *nvmem_dev_name(struct nvmem_device *nvmem); 89 90 void nvmem_add_cell_lookups(struct nvmem_cell_lookup *entries, 91 size_t nentries); 92 void nvmem_del_cell_lookups(struct nvmem_cell_lookup *entries, 93 size_t nentries); 94 95 int nvmem_register_notifier(struct notifier_block *nb); 96 int nvmem_unregister_notifier(struct notifier_block *nb); 97 98 struct nvmem_device *nvmem_device_find(void *data, 99 int (*match)(struct device *dev, const void *data)); 100 101 #else 102 103 static inline struct nvmem_cell *nvmem_cell_get(struct device *dev, 104 const char *id) 105 { 106 return ERR_PTR(-EOPNOTSUPP); 107 } 108 109 static inline struct nvmem_cell *devm_nvmem_cell_get(struct device *dev, 110 const char *id) 111 { 112 return ERR_PTR(-EOPNOTSUPP); 113 } 114 115 static inline void devm_nvmem_cell_put(struct device *dev, 116 struct nvmem_cell *cell) 117 { 118 119 } 120 static inline void nvmem_cell_put(struct nvmem_cell *cell) 121 { 122 } 123 124 static inline void *nvmem_cell_read(struct nvmem_cell *cell, size_t *len) 125 { 126 return ERR_PTR(-EOPNOTSUPP); 127 } 128 129 static inline int nvmem_cell_write(struct nvmem_cell *cell, 130 void *buf, size_t len) 131 { 132 return -EOPNOTSUPP; 133 } 134 135 static inline int nvmem_cell_read_u16(struct device *dev, 136 const char *cell_id, u16 *val) 137 { 138 return -EOPNOTSUPP; 139 } 140 141 static inline int nvmem_cell_read_u32(struct device *dev, 142 const char *cell_id, u32 *val) 143 { 144 return -EOPNOTSUPP; 145 } 146 147 static inline int nvmem_cell_read_u64(struct device *dev, 148 const char *cell_id, u64 *val) 149 { 150 return -EOPNOTSUPP; 151 } 152 153 static inline struct nvmem_device *nvmem_device_get(struct device *dev, 154 const char *name) 155 { 156 return ERR_PTR(-EOPNOTSUPP); 157 } 158 159 static inline struct nvmem_device *devm_nvmem_device_get(struct device *dev, 160 const char *name) 161 { 162 return ERR_PTR(-EOPNOTSUPP); 163 } 164 165 static inline void nvmem_device_put(struct nvmem_device *nvmem) 166 { 167 } 168 169 static inline void devm_nvmem_device_put(struct device *dev, 170 struct nvmem_device *nvmem) 171 { 172 } 173 174 static inline ssize_t nvmem_device_cell_read(struct nvmem_device *nvmem, 175 struct nvmem_cell_info *info, 176 void *buf) 177 { 178 return -EOPNOTSUPP; 179 } 180 181 static inline int nvmem_device_cell_write(struct nvmem_device *nvmem, 182 struct nvmem_cell_info *info, 183 void *buf) 184 { 185 return -EOPNOTSUPP; 186 } 187 188 static inline int nvmem_device_read(struct nvmem_device *nvmem, 189 unsigned int offset, size_t bytes, 190 void *buf) 191 { 192 return -EOPNOTSUPP; 193 } 194 195 static inline int nvmem_device_write(struct nvmem_device *nvmem, 196 unsigned int offset, size_t bytes, 197 void *buf) 198 { 199 return -EOPNOTSUPP; 200 } 201 202 static inline const char *nvmem_dev_name(struct nvmem_device *nvmem) 203 { 204 return NULL; 205 } 206 207 static inline void 208 nvmem_add_cell_lookups(struct nvmem_cell_lookup *entries, size_t nentries) {} 209 static inline void 210 nvmem_del_cell_lookups(struct nvmem_cell_lookup *entries, size_t nentries) {} 211 212 static inline int nvmem_register_notifier(struct notifier_block *nb) 213 { 214 return -EOPNOTSUPP; 215 } 216 217 static inline int nvmem_unregister_notifier(struct notifier_block *nb) 218 { 219 return -EOPNOTSUPP; 220 } 221 222 static inline struct nvmem_device *nvmem_device_find(void *data, 223 int (*match)(struct device *dev, const void *data)) 224 { 225 return NULL; 226 } 227 228 #endif /* CONFIG_NVMEM */ 229 230 #if IS_ENABLED(CONFIG_NVMEM) && IS_ENABLED(CONFIG_OF) 231 struct nvmem_cell *of_nvmem_cell_get(struct device_node *np, 232 const char *id); 233 struct nvmem_device *of_nvmem_device_get(struct device_node *np, 234 const char *name); 235 #else 236 static inline struct nvmem_cell *of_nvmem_cell_get(struct device_node *np, 237 const char *id) 238 { 239 return ERR_PTR(-EOPNOTSUPP); 240 } 241 242 static inline struct nvmem_device *of_nvmem_device_get(struct device_node *np, 243 const char *name) 244 { 245 return ERR_PTR(-EOPNOTSUPP); 246 } 247 #endif /* CONFIG_NVMEM && CONFIG_OF */ 248 249 #endif /* ifndef _LINUX_NVMEM_CONSUMER_H */ 250