xref: /rk3399_rockchip-uboot/include/dm/fdtaddr.h (revision 8f7de5145da2de88e169e58343cceeee233362d4)
1d6ffb00aSSimon Glass /*
2d6ffb00aSSimon Glass  * Copyright (c) 2017 Google, Inc
3d6ffb00aSSimon Glass  *
4d6ffb00aSSimon Glass  * (C) Copyright 2012
5d6ffb00aSSimon Glass  * Pavel Herrmann <morpheus.ibis@gmail.com>
6d6ffb00aSSimon Glass  * Marek Vasut <marex@denx.de>
7d6ffb00aSSimon Glass  *
8d6ffb00aSSimon Glass  * SPDX-License-Identifier:	GPL-2.0+
9d6ffb00aSSimon Glass  */
10d6ffb00aSSimon Glass 
1138d21b41SSimon Glass #ifndef _DM_FDTADDR_H
1238d21b41SSimon Glass #define _DM_FDTADDR_H
13d6ffb00aSSimon Glass 
14d6ffb00aSSimon Glass #include <fdtdec.h>
15d6ffb00aSSimon Glass 
16d6ffb00aSSimon Glass struct udevice;
17d6ffb00aSSimon Glass 
18d6ffb00aSSimon Glass /**
19a821c4afSSimon Glass  * devfdt_get_addr() - Get the reg property of a device
20d6ffb00aSSimon Glass  *
21d6ffb00aSSimon Glass  * @dev: Pointer to a device
22d6ffb00aSSimon Glass  *
23d6ffb00aSSimon Glass  * @return addr
24d6ffb00aSSimon Glass  */
25a821c4afSSimon Glass fdt_addr_t devfdt_get_addr(struct udevice *dev);
26d6ffb00aSSimon Glass 
27d6ffb00aSSimon Glass /**
28a821c4afSSimon Glass  * devfdt_get_addr_ptr() - Return pointer to the address of the reg property
29d6ffb00aSSimon Glass  *                      of a device
30d6ffb00aSSimon Glass  *
31d6ffb00aSSimon Glass  * @dev: Pointer to a device
32d6ffb00aSSimon Glass  *
33d6ffb00aSSimon Glass  * @return Pointer to addr, or NULL if there is no such property
34d6ffb00aSSimon Glass  */
35a821c4afSSimon Glass void *devfdt_get_addr_ptr(struct udevice *dev);
36d6ffb00aSSimon Glass 
37d6ffb00aSSimon Glass /**
38*8f7de514SShawn Lin  * devfdt_remap_addr_index() - Return indexed pointer to the memory-mapped
39*8f7de514SShawn Lin  *                                 I/O address of the reg property of a device
40*8f7de514SShawn Lin  * @index: the 'reg' property can hold a list of <addr, size> pairs
41*8f7de514SShawn Lin  *         and @index is used to select which one is required
42*8f7de514SShawn Lin  *
43*8f7de514SShawn Lin  * @dev: Pointer to a device
44*8f7de514SShawn Lin  *
45*8f7de514SShawn Lin  * Return: Pointer to addr, or NULL if there is no such property
46*8f7de514SShawn Lin  */
47*8f7de514SShawn Lin void *devfdt_remap_addr_index(struct udevice *dev, int index);
48*8f7de514SShawn Lin 
49*8f7de514SShawn Lin /**
50a821c4afSSimon Glass  * devfdt_map_physmem() - Read device address from reg property of the
51d6ffb00aSSimon Glass  *                     device node and map the address into CPU address
52d6ffb00aSSimon Glass  *                     space.
53d6ffb00aSSimon Glass  *
54d6ffb00aSSimon Glass  * @dev: Pointer to device
55d6ffb00aSSimon Glass  * @size: size of the memory to map
56d6ffb00aSSimon Glass  *
57d6ffb00aSSimon Glass  * @return  mapped address, or NULL if the device does not have reg
58d6ffb00aSSimon Glass  *          property.
59d6ffb00aSSimon Glass  */
60a821c4afSSimon Glass void *devfdt_map_physmem(struct udevice *dev, unsigned long size);
61d6ffb00aSSimon Glass 
62d6ffb00aSSimon Glass /**
63a821c4afSSimon Glass  * devfdt_get_addr_index() - Get the indexed reg property of a device
64d6ffb00aSSimon Glass  *
65d6ffb00aSSimon Glass  * @dev: Pointer to a device
66d6ffb00aSSimon Glass  * @index: the 'reg' property can hold a list of <addr, size> pairs
67d6ffb00aSSimon Glass  *	   and @index is used to select which one is required
68d6ffb00aSSimon Glass  *
69d6ffb00aSSimon Glass  * @return addr
70d6ffb00aSSimon Glass  */
71a821c4afSSimon Glass fdt_addr_t devfdt_get_addr_index(struct udevice *dev, int index);
72d6ffb00aSSimon Glass 
73d6ffb00aSSimon Glass /**
74a821c4afSSimon Glass  * devfdt_get_addr_size_index() - Get the indexed reg property of a device
75d6ffb00aSSimon Glass  *
76d6ffb00aSSimon Glass  * Returns the address and size specified in the 'reg' property of a device.
77d6ffb00aSSimon Glass  *
78d6ffb00aSSimon Glass  * @dev: Pointer to a device
79d6ffb00aSSimon Glass  * @index: the 'reg' property can hold a list of <addr, size> pairs
80d6ffb00aSSimon Glass  *	   and @index is used to select which one is required
81d6ffb00aSSimon Glass  * @size: Pointer to size varible - this function returns the size
82d6ffb00aSSimon Glass  *        specified in the 'reg' property here
83d6ffb00aSSimon Glass  *
84d6ffb00aSSimon Glass  * @return addr
85d6ffb00aSSimon Glass  */
86a821c4afSSimon Glass fdt_addr_t devfdt_get_addr_size_index(struct udevice *dev, int index,
87d6ffb00aSSimon Glass 				   fdt_size_t *size);
88d6ffb00aSSimon Glass 
89d6ffb00aSSimon Glass /**
90a821c4afSSimon Glass  * devfdt_get_addr_name() - Get the reg property of a device, indexed by name
91d6ffb00aSSimon Glass  *
92d6ffb00aSSimon Glass  * @dev: Pointer to a device
93d6ffb00aSSimon Glass  * @name: the 'reg' property can hold a list of <addr, size> pairs, with the
94d6ffb00aSSimon Glass  *	  'reg-names' property providing named-based identification. @index
95d6ffb00aSSimon Glass  *	  indicates the value to search for in 'reg-names'.
96d6ffb00aSSimon Glass  *
97d6ffb00aSSimon Glass  * @return addr
98d6ffb00aSSimon Glass  */
99a821c4afSSimon Glass fdt_addr_t devfdt_get_addr_name(struct udevice *dev, const char *name);
100d6ffb00aSSimon Glass 
101d6ffb00aSSimon Glass /**
102d6ffb00aSSimon Glass  * dm_set_translation_offset() - Set translation offset
103d6ffb00aSSimon Glass  * @offs: Translation offset
104d6ffb00aSSimon Glass  *
105d6ffb00aSSimon Glass  * Some platforms need a special address translation. Those
106d6ffb00aSSimon Glass  * platforms (e.g. mvebu in SPL) can configure a translation
107d6ffb00aSSimon Glass  * offset in the DM by calling this function. It will be
108a821c4afSSimon Glass  * added to all addresses returned in devfdt_get_addr().
109d6ffb00aSSimon Glass  */
110d6ffb00aSSimon Glass void dm_set_translation_offset(fdt_addr_t offs);
111d6ffb00aSSimon Glass 
112d6ffb00aSSimon Glass /**
113d6ffb00aSSimon Glass  * dm_get_translation_offset() - Get translation offset
114d6ffb00aSSimon Glass  *
115d6ffb00aSSimon Glass  * This function returns the translation offset that can
116d6ffb00aSSimon Glass  * be configured by calling dm_set_translation_offset().
117d6ffb00aSSimon Glass  *
118d6ffb00aSSimon Glass  * @return translation offset for the device address (0 as default).
119d6ffb00aSSimon Glass  */
120d6ffb00aSSimon Glass fdt_addr_t dm_get_translation_offset(void);
121d6ffb00aSSimon Glass 
122d6ffb00aSSimon Glass #endif
123