include/regmap.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright (c) 2015 Google, Inc
   4  * Written by Simon Glass <sjg@chromium.org>
   5  */
   6
   7 #ifndef __REGMAP_H
   8 #define __REGMAP_H
   9
  10 /**
  11  * struct regmap_range - a register map range
  12  *
  13  * @start:      Start address
  14  * @size:       Size in bytes
  15  */
  16 struct regmap_range {
  17         ulong start;
  18         ulong size;
  19 };
  20
  21 /**
  22  * struct regmap - a way of accessing hardware/bus registers
  23  *
  24  * @range_count:        Number of ranges available within the map
  25  * @ranges:             Array of ranges
  26  */
  27 struct regmap {
  28         int range_count;
  29         struct regmap_range ranges[0];
  30 };
  31
  32 /*
  33  * Interface to provide access to registers either through a direct memory
  34  * bus or through a peripheral bus like I2C, SPI.
  35  */
  36
  37 /**
  38  * regmap_write() - Write a 32-bit value to a regmap
  39  *
  40  * @map:        Regmap to write to
  41  * @offset:     Offset in the regmap to write to
  42  * @val:        Data to write to the regmap at the specified offset
  43  *
  44  * Return: 0 if OK, -ve on error
  45  */
  46 int regmap_write(struct regmap *map, uint offset, uint val);
  47
  48 /**
  49  * regmap_read() - Read a 32-bit value from a regmap
  50  *
  51  * @map:        Regmap to read from
  52  * @offset:     Offset in the regmap to read from
  53  * @valp:       Pointer to the buffer to receive the data read from the regmap
  54  *              at the specified offset
  55  *
  56  * Return: 0 if OK, -ve on error
  57  */
  58 int regmap_read(struct regmap *map, uint offset, uint *valp);
  59
  60 #define regmap_write32(map, ptr, member, val) \
  61         regmap_write(map, (uint32_t *)(ptr)->member - (uint32_t *)(ptr), val)
  62
  63 #define regmap_read32(map, ptr, member, valp) \
  64         regmap_read(map, (uint32_t *)(ptr)->member - (uint32_t *)(ptr), valp)
  65
  66 /**
  67  * regmap_update_bits() - Perform a read/modify/write using a mask
  68  *
  69  * @map:        The map returned by regmap_init_mem*()
  70  * @offset:     Offset of the memory
  71  * @mask:       Mask to apply to the read value
  72  * @val:        Value to apply to the value to write
  73  * Return: 0 if OK, -ve on error
  74  */
  75 int regmap_update_bits(struct regmap *map, uint offset, uint mask, uint val);
  76
  77 /**
  78  * regmap_init_mem() - Set up a new register map that uses memory access
  79  *
  80  * @node:       Device node that uses this map
  81  * @mapp:       Returns allocated map
  82  * Return: 0 if OK, -ve on error
  83  *
  84  * Use regmap_uninit() to free it.
  85  */
  86 int regmap_init_mem(ofnode node, struct regmap **mapp);
  87
  88 /**
  89  * regmap_init_mem_platdata() - Set up a new memory register map for
  90  *                              of-platdata
  91  *
  92  * @dev:        Device that uses this map
  93  * @reg:        List of address, size pairs
  94  * @count:      Number of pairs (e.g. 1 if the regmap has a single entry)
  95  * @mapp:       Returns allocated map
  96  * Return: 0 if OK, -ve on error
  97  *
  98  * This creates a new regmap with a list of regions passed in, rather than
  99  * using the device tree. It only supports 32-bit machines.
 100  *
 101  * Use regmap_uninit() to free it.
 102  *
 103  */
 104 int regmap_init_mem_platdata(struct udevice *dev, fdt_val_t *reg, int count,
 105                              struct regmap **mapp);
 106
 107 /**
 108  * regmap_get_range() - Obtain the base memory address of a regmap range
 109  *
 110  * @map:        Regmap to query
 111  * @range_num:  Range to look up
 112  * Return: Pointer to the range in question if OK, NULL on error
 113  */
 114 void *regmap_get_range(struct regmap *map, unsigned int range_num);
 115
 116 /**
 117  * regmap_uninit() - free a previously inited regmap
 118  *
 119  * @map:        Regmap to free
 120  * Return: 0 if OK, -ve on error
 121  */
 122 int regmap_uninit(struct regmap *map);
 123
 124 #endif