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_u16(struct device *dev, const char *cell_id, u16 *val); 65 int nvmem_cell_read_u32(struct device *dev, const char *cell_id, u32 *val); 66 int nvmem_cell_read_u64(struct device *dev, const char *cell_id, 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_u16(struct device *dev, 131 const char *cell_id, u16 *val) 132 { 133 return -EOPNOTSUPP; 134 } 135 136 static inline int nvmem_cell_read_u32(struct device *dev, 137 const char *cell_id, u32 *val) 138 { 139 return -EOPNOTSUPP; 140 } 141 142 static inline int nvmem_cell_read_u64(struct device *dev, 143 const char *cell_id, u64 *val) 144 { 145 return -EOPNOTSUPP; 146 } 147 148 static inline struct nvmem_device *nvmem_device_get(struct device *dev, 149 const char *name) 150 { 151 return ERR_PTR(-EOPNOTSUPP); 152 } 153 154 static inline struct nvmem_device *devm_nvmem_device_get(struct device *dev, 155 const char *name) 156 { 157 return ERR_PTR(-EOPNOTSUPP); 158 } 159 160 static inline void nvmem_device_put(struct nvmem_device *nvmem) 161 { 162 } 163 164 static inline void devm_nvmem_device_put(struct device *dev, 165 struct nvmem_device *nvmem) 166 { 167 } 168 169 static inline ssize_t nvmem_device_cell_read(struct nvmem_device *nvmem, 170 struct nvmem_cell_info *info, 171 void *buf) 172 { 173 return -EOPNOTSUPP; 174 } 175 176 static inline int nvmem_device_cell_write(struct nvmem_device *nvmem, 177 struct nvmem_cell_info *info, 178 void *buf) 179 { 180 return -EOPNOTSUPP; 181 } 182 183 static inline int nvmem_device_read(struct nvmem_device *nvmem, 184 unsigned int offset, size_t bytes, 185 void *buf) 186 { 187 return -EOPNOTSUPP; 188 } 189 190 static inline int nvmem_device_write(struct nvmem_device *nvmem, 191 unsigned int offset, size_t bytes, 192 void *buf) 193 { 194 return -EOPNOTSUPP; 195 } 196 197 static inline const char *nvmem_dev_name(struct nvmem_device *nvmem) 198 { 199 return NULL; 200 } 201 202 static inline void 203 nvmem_add_cell_lookups(struct nvmem_cell_lookup *entries, size_t nentries) {} 204 static inline void 205 nvmem_del_cell_lookups(struct nvmem_cell_lookup *entries, size_t nentries) {} 206 207 static inline int nvmem_register_notifier(struct notifier_block *nb) 208 { 209 return -EOPNOTSUPP; 210 } 211 212 static inline int nvmem_unregister_notifier(struct notifier_block *nb) 213 { 214 return -EOPNOTSUPP; 215 } 216 217 static inline struct nvmem_device *nvmem_device_find(void *data, 218 int (*match)(struct device *dev, const void *data)) 219 { 220 return NULL; 221 } 222 223 #endif /* CONFIG_NVMEM */ 224 225 #if IS_ENABLED(CONFIG_NVMEM) && IS_ENABLED(CONFIG_OF) 226 struct nvmem_cell *of_nvmem_cell_get(struct device_node *np, 227 const char *id); 228 struct nvmem_device *of_nvmem_device_get(struct device_node *np, 229 const char *name); 230 #else 231 static inline struct nvmem_cell *of_nvmem_cell_get(struct device_node *np, 232 const char *id) 233 { 234 return ERR_PTR(-EOPNOTSUPP); 235 } 236 237 static inline struct nvmem_device *of_nvmem_device_get(struct device_node *np, 238 const char *name) 239 { 240 return ERR_PTR(-EOPNOTSUPP); 241 } 242 #endif /* CONFIG_NVMEM && CONFIG_OF */ 243 244 #endif /* ifndef _LINUX_NVMEM_CONSUMER_H */ 245