blob: 6a574eaa41294a740a688f3bc717c0ba68afcf8f [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glass6f98b752015-06-23 15:38:42 -06002/*
3 * Copyright (c) 2015 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
Simon Glass6f98b752015-06-23 15:38:42 -06005 */
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 */
16struct regmap_range {
17 ulong start;
18 ulong size;
19};
20
21/**
22 * struct regmap - a way of accessing hardware/bus registers
23 *
Simon Glass6f98b752015-06-23 15:38:42 -060024 * @range_count: Number of ranges available within the map
Masahiro Yamada8c1de5e2018-04-19 12:14:01 +090025 * @ranges: Array of ranges
Simon Glass6f98b752015-06-23 15:38:42 -060026 */
27struct regmap {
Simon Glass6f98b752015-06-23 15:38:42 -060028 int range_count;
Masahiro Yamada8c1de5e2018-04-19 12:14:01 +090029 struct regmap_range ranges[0];
Simon Glass6f98b752015-06-23 15:38:42 -060030};
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 */
36int regmap_write(struct regmap *map, uint offset, uint val);
37int regmap_read(struct regmap *map, uint offset, uint *valp);
38
39#define regmap_write32(map, ptr, member, val) \
40 regmap_write(map, (uint32_t *)(ptr)->member - (uint32_t *)(ptr), val)
41
42#define regmap_read32(map, ptr, member, valp) \
43 regmap_read(map, (uint32_t *)(ptr)->member - (uint32_t *)(ptr), valp)
44
45/**
Neil Armstrong285cbcf2018-04-27 11:56:14 +020046 * regmap_update_bits() - Perform a read/modify/write using a mask
47 *
48 * @map: The map returned by regmap_init_mem*()
49 * @offset: Offset of the memory
50 * @mask: Mask to apply to the read value
51 * @val: Value to apply to the value to write
52 */
53int regmap_update_bits(struct regmap *map, uint offset, uint mask, uint val);
54
55/**
Simon Glass6f98b752015-06-23 15:38:42 -060056 * regmap_init_mem() - Set up a new register map that uses memory access
57 *
58 * Use regmap_uninit() to free it.
59 *
Masahiro Yamadad3581232018-04-19 12:14:03 +090060 * @node: Device node that uses this map
Simon Glass6f98b752015-06-23 15:38:42 -060061 * @mapp: Returns allocated map
62 */
Masahiro Yamadad3581232018-04-19 12:14:03 +090063int regmap_init_mem(ofnode node, struct regmap **mapp);
Simon Glass6f98b752015-06-23 15:38:42 -060064
Simon Glass1e6ca1a2016-07-04 11:58:22 -060065/**
66 * regmap_init_mem_platdata() - Set up a new memory register map for of-platdata
67 *
68 * This creates a new regmap with a list of regions passed in, rather than
69 * using the device tree. It only supports 32-bit machines.
70 *
71 * Use regmap_uninit() to free it.
72 *
73 * @dev: Device that uses this map
74 * @reg: List of address, size pairs
75 * @count: Number of pairs (e.g. 1 if the regmap has a single entry)
76 * @mapp: Returns allocated map
77 */
Simon Glassc20ee0e2017-08-29 14:15:50 -060078int regmap_init_mem_platdata(struct udevice *dev, fdt_val_t *reg, int count,
Simon Glass3b2a29e2016-07-04 11:57:59 -060079 struct regmap **mapp);
80
Simon Glass6f98b752015-06-23 15:38:42 -060081/**
82 * regmap_get_range() - Obtain the base memory address of a regmap range
83 *
84 * @map: Regmap to query
85 * @range_num: Range to look up
86 */
87void *regmap_get_range(struct regmap *map, unsigned int range_num);
88
89/**
90 * regmap_uninit() - free a previously inited regmap
91 */
92int regmap_uninit(struct regmap *map);
93
94#endif