1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2015 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
7 #define LOG_CATEGORY LOGC_DM
13 #include <asm/global_data.h>
14 #include <linux/libfdt.h>
19 #include <dm/of_addr.h>
20 #include <dm/devres.h>
21 #include <linux/ioport.h>
22 #include <linux/compat.h>
23 #include <linux/err.h>
24 #include <linux/bitops.h>
27 * Internal representation of a regmap field. Instead of storing the MSB and
28 * LSB, store the shift and mask. This makes the code a bit cleaner and faster
29 * because the shift and mask don't have to be calculated every time.
32 struct regmap *regmap;
39 DECLARE_GLOBAL_DATA_PTR;
42 * do_range_check() - Control whether range checks are done
44 * Returns: true to do range checks, false to skip
46 * This is used to reduce code size on SPL where range checks are known not to
49 * Add this to the top of the file to enable them: #define LOG_DEBUG
51 static inline bool do_range_check(void)
53 return _LOG_DEBUG || !IS_ENABLED(CONFIG_SPL);
58 * regmap_alloc() - Allocate a regmap with a given number of ranges.
60 * @count: Number of ranges to be allocated for the regmap.
62 * The default regmap width is set to REGMAP_SIZE_32. Callers can override it
65 * Return: A pointer to the newly allocated regmap, or NULL on error.
67 static struct regmap *regmap_alloc(int count)
70 size_t size = sizeof(*map) + sizeof(map->ranges[0]) * count;
72 map = calloc(1, size);
75 map->range_count = count;
76 map->width = REGMAP_SIZE_32;
81 #if CONFIG_IS_ENABLED(OF_PLATDATA)
82 int regmap_init_mem_plat(struct udevice *dev, void *reg, int size, int count,
85 struct regmap_range *range;
88 map = regmap_alloc(count);
92 if (size == sizeof(fdt32_t)) {
93 fdt32_t *ptr = (fdt32_t *)reg;
95 for (range = map->ranges; count > 0;
96 ptr += 2, range++, count--) {
100 } else if (size == sizeof(fdt64_t)) {
101 fdt64_t *ptr = (fdt64_t *)reg;
103 for (range = map->ranges; count > 0;
104 ptr += 2, range++, count--) {
106 range->size = ptr[1];
118 * init_range() - Initialize a single range of a regmap
119 * @node: Device node that will use the map in question
120 * @range: Pointer to a regmap_range structure that will be initialized
121 * @addr_len: The length of the addr parts of the reg property
122 * @size_len: The length of the size parts of the reg property
123 * @index: The index of the range to initialize
125 * This function will read the necessary 'reg' information from the device tree
126 * (the 'addr' part, and the 'length' part), and initialize the range in
129 * Return: 0 if OK, -ve on error
131 static int init_range(ofnode node, struct regmap_range *range, int addr_len,
132 int size_len, int index)
137 if (of_live_active()) {
140 ret = of_address_to_resource(ofnode_to_np(node),
143 debug("%s: Could not read resource of range %d (ret = %d)\n",
144 ofnode_get_name(node), index, ret);
148 range->start = r.start;
149 range->size = r.end - r.start + 1;
151 int offset = ofnode_to_offset(node);
153 range->start = fdtdec_get_addr_size_fixed(gd->fdt_blob, offset,
157 if (range->start == FDT_ADDR_T_NONE) {
158 debug("%s: Could not read start of range %d\n",
159 ofnode_get_name(node), index);
169 int regmap_init_mem_index(ofnode node, struct regmap **mapp, int index)
172 int addr_len, size_len;
175 addr_len = ofnode_read_simple_addr_cells(ofnode_get_parent(node));
177 debug("%s: Error while reading the addr length (ret = %d)\n",
178 ofnode_get_name(node), addr_len);
182 size_len = ofnode_read_simple_size_cells(ofnode_get_parent(node));
184 debug("%s: Error while reading the size length: (ret = %d)\n",
185 ofnode_get_name(node), size_len);
189 map = regmap_alloc(1);
193 ret = init_range(node, map->ranges, addr_len, size_len, index);
197 if (ofnode_read_bool(node, "little-endian"))
198 map->endianness = REGMAP_LITTLE_ENDIAN;
199 else if (ofnode_read_bool(node, "big-endian"))
200 map->endianness = REGMAP_BIG_ENDIAN;
201 else if (ofnode_read_bool(node, "native-endian"))
202 map->endianness = REGMAP_NATIVE_ENDIAN;
203 else /* Default: native endianness */
204 map->endianness = REGMAP_NATIVE_ENDIAN;
215 int regmap_init_mem_range(ofnode node, ulong r_start, ulong r_size,
216 struct regmap **mapp)
219 struct regmap_range *range;
221 map = regmap_alloc(1);
225 range = &map->ranges[0];
226 range->start = r_start;
227 range->size = r_size;
229 if (ofnode_read_bool(node, "little-endian"))
230 map->endianness = REGMAP_LITTLE_ENDIAN;
231 else if (ofnode_read_bool(node, "big-endian"))
232 map->endianness = REGMAP_BIG_ENDIAN;
233 else if (ofnode_read_bool(node, "native-endian"))
234 map->endianness = REGMAP_NATIVE_ENDIAN;
235 else /* Default: native endianness */
236 map->endianness = REGMAP_NATIVE_ENDIAN;
242 int regmap_init_mem(ofnode node, struct regmap **mapp)
244 struct regmap_range *range;
247 int addr_len, size_len, both_len;
252 addr_len = ofnode_read_simple_addr_cells(ofnode_get_parent(node));
254 debug("%s: Error while reading the addr length (ret = %d)\n",
255 ofnode_get_name(node), addr_len);
259 size_len = ofnode_read_simple_size_cells(ofnode_get_parent(node));
261 debug("%s: Error while reading the size length: (ret = %d)\n",
262 ofnode_get_name(node), size_len);
266 both_len = addr_len + size_len;
268 debug("%s: Both addr and size length are zero\n",
269 ofnode_get_name(node));
273 len = ofnode_read_size(node, "reg");
275 debug("%s: Error while reading reg size (ret = %d)\n",
276 ofnode_get_name(node), len);
279 len /= sizeof(fdt32_t);
280 count = len / both_len;
282 debug("%s: Not enough data in reg property\n",
283 ofnode_get_name(node));
287 map = regmap_alloc(count);
291 for (range = map->ranges, index = 0; count > 0;
292 count--, range++, index++) {
293 ret = init_range(node, range, addr_len, size_len, index);
298 if (ofnode_read_bool(node, "little-endian"))
299 map->endianness = REGMAP_LITTLE_ENDIAN;
300 else if (ofnode_read_bool(node, "big-endian"))
301 map->endianness = REGMAP_BIG_ENDIAN;
302 else if (ofnode_read_bool(node, "native-endian"))
303 map->endianness = REGMAP_NATIVE_ENDIAN;
304 else /* Default: native endianness */
305 map->endianness = REGMAP_NATIVE_ENDIAN;
316 static void devm_regmap_release(struct udevice *dev, void *res)
318 regmap_uninit(*(struct regmap **)res);
321 struct regmap *devm_regmap_init(struct udevice *dev,
322 const struct regmap_bus *bus,
324 const struct regmap_config *config)
327 struct regmap **mapp, *map;
329 /* this looks like a leak, but devres takes care of it */
330 mapp = devres_alloc(devm_regmap_release, sizeof(struct regmap *),
333 return ERR_PTR(-ENOMEM);
335 if (config && config->r_size != 0)
336 rc = regmap_init_mem_range(dev_ofnode(dev), config->r_start,
337 config->r_size, mapp);
339 rc = regmap_init_mem(dev_ofnode(dev), mapp);
345 map->width = config->width;
346 map->reg_offset_shift = config->reg_offset_shift;
349 devres_add(dev, mapp);
354 void *regmap_get_range(struct regmap *map, unsigned int range_num)
356 struct regmap_range *range;
358 if (range_num >= map->range_count)
360 range = &map->ranges[range_num];
362 return map_sysmem(range->start, range->size);
365 int regmap_uninit(struct regmap *map)
372 static inline u8 __read_8(u8 *addr, enum regmap_endianness_t endianness)
377 static inline u16 __read_16(u16 *addr, enum regmap_endianness_t endianness)
379 switch (endianness) {
380 case REGMAP_LITTLE_ENDIAN:
381 return in_le16(addr);
382 case REGMAP_BIG_ENDIAN:
383 return in_be16(addr);
384 case REGMAP_NATIVE_ENDIAN:
391 static inline u32 __read_32(u32 *addr, enum regmap_endianness_t endianness)
393 switch (endianness) {
394 case REGMAP_LITTLE_ENDIAN:
395 return in_le32(addr);
396 case REGMAP_BIG_ENDIAN:
397 return in_be32(addr);
398 case REGMAP_NATIVE_ENDIAN:
405 #if defined(in_le64) && defined(in_be64) && defined(readq)
406 static inline u64 __read_64(u64 *addr, enum regmap_endianness_t endianness)
408 switch (endianness) {
409 case REGMAP_LITTLE_ENDIAN:
410 return in_le64(addr);
411 case REGMAP_BIG_ENDIAN:
412 return in_be64(addr);
413 case REGMAP_NATIVE_ENDIAN:
421 int regmap_raw_read_range(struct regmap *map, uint range_num, uint offset,
422 void *valp, size_t val_len)
424 struct regmap_range *range;
427 if (do_range_check() && range_num >= map->range_count) {
428 debug("%s: range index %d larger than range count\n",
429 __func__, range_num);
432 range = &map->ranges[range_num];
434 offset <<= map->reg_offset_shift;
435 if (do_range_check() &&
436 (offset + val_len > range->size || offset + val_len < offset)) {
437 debug("%s: offset/size combination invalid\n", __func__);
441 ptr = map_physmem(range->start + offset, val_len, MAP_NOCACHE);
445 *((u8 *)valp) = __read_8(ptr, map->endianness);
448 *((u16 *)valp) = __read_16(ptr, map->endianness);
451 *((u32 *)valp) = __read_32(ptr, map->endianness);
453 #if defined(in_le64) && defined(in_be64) && defined(readq)
455 *((u64 *)valp) = __read_64(ptr, map->endianness);
459 debug("%s: regmap size %zu unknown\n", __func__, val_len);
466 int regmap_raw_read(struct regmap *map, uint offset, void *valp, size_t val_len)
468 return regmap_raw_read_range(map, 0, offset, valp, val_len);
471 int regmap_read(struct regmap *map, uint offset, uint *valp)
481 res = regmap_raw_read(map, offset, &u, map->width);
485 switch (map->width) {
505 static inline void __write_8(u8 *addr, const u8 *val,
506 enum regmap_endianness_t endianness)
511 static inline void __write_16(u16 *addr, const u16 *val,
512 enum regmap_endianness_t endianness)
514 switch (endianness) {
515 case REGMAP_NATIVE_ENDIAN:
518 case REGMAP_LITTLE_ENDIAN:
519 out_le16(addr, *val);
521 case REGMAP_BIG_ENDIAN:
522 out_be16(addr, *val);
527 static inline void __write_32(u32 *addr, const u32 *val,
528 enum regmap_endianness_t endianness)
530 switch (endianness) {
531 case REGMAP_NATIVE_ENDIAN:
534 case REGMAP_LITTLE_ENDIAN:
535 out_le32(addr, *val);
537 case REGMAP_BIG_ENDIAN:
538 out_be32(addr, *val);
543 #if defined(out_le64) && defined(out_be64) && defined(writeq)
544 static inline void __write_64(u64 *addr, const u64 *val,
545 enum regmap_endianness_t endianness)
547 switch (endianness) {
548 case REGMAP_NATIVE_ENDIAN:
551 case REGMAP_LITTLE_ENDIAN:
552 out_le64(addr, *val);
554 case REGMAP_BIG_ENDIAN:
555 out_be64(addr, *val);
561 int regmap_raw_write_range(struct regmap *map, uint range_num, uint offset,
562 const void *val, size_t val_len)
564 struct regmap_range *range;
567 if (range_num >= map->range_count) {
568 debug("%s: range index %d larger than range count\n",
569 __func__, range_num);
572 range = &map->ranges[range_num];
574 offset <<= map->reg_offset_shift;
575 if (offset + val_len > range->size || offset + val_len < offset) {
576 debug("%s: offset/size combination invalid\n", __func__);
580 ptr = map_physmem(range->start + offset, val_len, MAP_NOCACHE);
584 __write_8(ptr, val, map->endianness);
587 __write_16(ptr, val, map->endianness);
590 __write_32(ptr, val, map->endianness);
592 #if defined(out_le64) && defined(out_be64) && defined(writeq)
594 __write_64(ptr, val, map->endianness);
598 debug("%s: regmap size %zu unknown\n", __func__, val_len);
605 int regmap_raw_write(struct regmap *map, uint offset, const void *val,
608 return regmap_raw_write_range(map, 0, offset, val, val_len);
611 int regmap_write(struct regmap *map, uint offset, uint val)
620 switch (map->width) {
634 debug("%s: regmap size %zu unknown\n", __func__,
639 return regmap_raw_write(map, offset, &u, map->width);
642 int regmap_update_bits(struct regmap *map, uint offset, uint mask, uint val)
647 ret = regmap_read(map, offset, ®);
653 return regmap_write(map, offset, reg | (val & mask));
656 int regmap_field_read(struct regmap_field *field, unsigned int *val)
659 unsigned int reg_val;
661 ret = regmap_read(field->regmap, field->reg, ®_val);
665 reg_val &= field->mask;
666 reg_val >>= field->shift;
672 int regmap_field_write(struct regmap_field *field, unsigned int val)
674 return regmap_update_bits(field->regmap, field->reg, field->mask,
675 val << field->shift);
678 static void regmap_field_init(struct regmap_field *rm_field,
679 struct regmap *regmap,
680 struct reg_field reg_field)
682 rm_field->regmap = regmap;
683 rm_field->reg = reg_field.reg;
684 rm_field->shift = reg_field.lsb;
685 rm_field->mask = GENMASK(reg_field.msb, reg_field.lsb);
688 struct regmap_field *devm_regmap_field_alloc(struct udevice *dev,
689 struct regmap *regmap,
690 struct reg_field reg_field)
692 struct regmap_field *rm_field = devm_kzalloc(dev, sizeof(*rm_field),
695 return ERR_PTR(-ENOMEM);
697 regmap_field_init(rm_field, regmap, reg_field);
702 void devm_regmap_field_free(struct udevice *dev, struct regmap_field *field)
704 devm_kfree(dev, field);
707 struct regmap_field *regmap_field_alloc(struct regmap *regmap,
708 struct reg_field reg_field)
710 struct regmap_field *rm_field = kzalloc(sizeof(*rm_field), GFP_KERNEL);
713 return ERR_PTR(-ENOMEM);
715 regmap_field_init(rm_field, regmap, reg_field);
720 void regmap_field_free(struct regmap_field *field)