blob: d2c1994291698ab811d28625b3df6f30c3e910a8 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Simon Glassaadfaf02017-05-17 17:18:04 -06002/*
3 * Copyright (c) 2017 Google, Inc
4 *
5 * (C) Copyright 2012
6 * Pavel Herrmann <morpheus.ibis@gmail.com>
7 * Marek Vasut <marex@denx.de>
Simon Glassaadfaf02017-05-17 17:18:04 -06008 */
9
Simon Glass6fe43a32017-05-18 20:08:59 -060010#ifndef _DM_FDTADDR_H
11#define _DM_FDTADDR_H
Simon Glassaadfaf02017-05-17 17:18:04 -060012
13#include <fdtdec.h>
14
15struct udevice;
16
17/**
Simon Glassba1dea42017-05-17 17:18:05 -060018 * devfdt_get_addr() - Get the reg property of a device
Simon Glassaadfaf02017-05-17 17:18:04 -060019 *
20 * @dev: Pointer to a device
21 *
22 * @return addr
23 */
Simon Glassc6548b82020-01-27 08:49:39 -070024fdt_addr_t devfdt_get_addr(const struct udevice *dev);
Simon Glassaadfaf02017-05-17 17:18:04 -060025
26/**
Simon Glassba1dea42017-05-17 17:18:05 -060027 * devfdt_get_addr_ptr() - Return pointer to the address of the reg property
Simon Glassaadfaf02017-05-17 17:18:04 -060028 * of a device
29 *
30 * @dev: Pointer to a device
31 *
32 * @return Pointer to addr, or NULL if there is no such property
33 */
Simon Glassc6548b82020-01-27 08:49:39 -070034void *devfdt_get_addr_ptr(const struct udevice *dev);
Simon Glassaadfaf02017-05-17 17:18:04 -060035
36/**
Álvaro Fernández Rojas670361292018-04-29 21:56:54 +020037 * devfdt_remap_addr() - Return pointer to the memory-mapped I/O address
38 * of the reg property of a device
39 *
40 * @dev: Pointer to a device
41 *
42 * @return Pointer to addr, or NULL if there is no such property
43 */
Simon Glassc6548b82020-01-27 08:49:39 -070044void *devfdt_remap_addr(const struct udevice *dev);
Álvaro Fernández Rojas670361292018-04-29 21:56:54 +020045
46/**
47 * devfdt_remap_addr_index() - Return indexed pointer to the memory-mapped
48 * I/O address of the reg property of a device
49 * @index: the 'reg' property can hold a list of <addr, size> pairs
50 * and @index is used to select which one is required
51 *
52 * @dev: Pointer to a device
53 *
54 * @return Pointer to addr, or NULL if there is no such property
55 */
Simon Glassc6548b82020-01-27 08:49:39 -070056void *devfdt_remap_addr_index(const struct udevice *dev, int index);
Álvaro Fernández Rojas670361292018-04-29 21:56:54 +020057
58/**
Álvaro Fernández Rojasa3181152018-12-03 19:37:09 +010059 * devfdt_remap_addr_name() - Get the reg property of a device, indexed by
60 * name, as a memory-mapped I/O pointer
61 * @name: the 'reg' property can hold a list of <addr, size> pairs, with the
62 * 'reg-names' property providing named-based identification. @index
63 * indicates the value to search for in 'reg-names'.
64 *
65 * @dev: Pointer to a device
66 *
67 * @return Pointer to addr, or NULL if there is no such property
68 */
Simon Glassc6548b82020-01-27 08:49:39 -070069void *devfdt_remap_addr_name(const struct udevice *dev, const char *name);
Álvaro Fernández Rojasa3181152018-12-03 19:37:09 +010070
71/**
Simon Glassba1dea42017-05-17 17:18:05 -060072 * devfdt_map_physmem() - Read device address from reg property of the
Simon Glassaadfaf02017-05-17 17:18:04 -060073 * device node and map the address into CPU address
74 * space.
75 *
76 * @dev: Pointer to device
77 * @size: size of the memory to map
78 *
79 * @return mapped address, or NULL if the device does not have reg
80 * property.
81 */
Simon Glassc6548b82020-01-27 08:49:39 -070082void *devfdt_map_physmem(const struct udevice *dev, unsigned long size);
Simon Glassaadfaf02017-05-17 17:18:04 -060083
84/**
Simon Glassba1dea42017-05-17 17:18:05 -060085 * devfdt_get_addr_index() - Get the indexed reg property of a device
Simon Glassaadfaf02017-05-17 17:18:04 -060086 *
87 * @dev: Pointer to a device
88 * @index: the 'reg' property can hold a list of <addr, size> pairs
89 * and @index is used to select which one is required
90 *
91 * @return addr
92 */
Simon Glassc6548b82020-01-27 08:49:39 -070093fdt_addr_t devfdt_get_addr_index(const struct udevice *dev, int index);
Simon Glassaadfaf02017-05-17 17:18:04 -060094
95/**
Bin Menga44397f2021-09-12 11:15:12 +080096 * devfdt_get_addr_index_ptr() - Return indexed pointer to the address of the
97 * reg property of a device
98 *
99 * @dev: Pointer to a device
100 * @index: the 'reg' property can hold a list of <addr, size> pairs
101 * and @index is used to select which one is required
102 *
103 * @return Pointer to addr, or NULL if there is no such property
104 */
105void *devfdt_get_addr_index_ptr(const struct udevice *dev, int index);
106
107/**
Simon Glassba1dea42017-05-17 17:18:05 -0600108 * devfdt_get_addr_size_index() - Get the indexed reg property of a device
Simon Glassaadfaf02017-05-17 17:18:04 -0600109 *
110 * Returns the address and size specified in the 'reg' property of a device.
111 *
112 * @dev: Pointer to a device
113 * @index: the 'reg' property can hold a list of <addr, size> pairs
114 * and @index is used to select which one is required
115 * @size: Pointer to size varible - this function returns the size
116 * specified in the 'reg' property here
117 *
118 * @return addr
119 */
Simon Glassc6548b82020-01-27 08:49:39 -0700120fdt_addr_t devfdt_get_addr_size_index(const struct udevice *dev, int index,
121 fdt_size_t *size);
Simon Glassaadfaf02017-05-17 17:18:04 -0600122
123/**
Simon Glassba1dea42017-05-17 17:18:05 -0600124 * devfdt_get_addr_name() - Get the reg property of a device, indexed by name
Simon Glassaadfaf02017-05-17 17:18:04 -0600125 *
126 * @dev: Pointer to a device
127 * @name: the 'reg' property can hold a list of <addr, size> pairs, with the
128 * 'reg-names' property providing named-based identification. @index
129 * indicates the value to search for in 'reg-names'.
130 *
131 * @return addr
132 */
Simon Glassc6548b82020-01-27 08:49:39 -0700133fdt_addr_t devfdt_get_addr_name(const struct udevice *dev, const char *name);
Simon Glassaadfaf02017-05-17 17:18:04 -0600134
Sekhar Norif677c6f2019-08-01 19:12:56 +0530135/**
136 * devfdt_get_addr_size_name() - Get the reg property and its size for a device,
137 * indexed by name
138 *
139 * Returns the address and size specified in the 'reg' property of a device.
140 *
141 * @dev: Pointer to a device
142 * @name: the 'reg' property can hold a list of <addr, size> pairs, with the
143 * 'reg-names' property providing named-based identification. @index
144 * indicates the value to search for in 'reg-names'.
145 * @size: Pointer to size variable - this function returns the size
146 * specified in the 'reg' property here
147 *
148 * @return addr
149 */
Simon Glassc6548b82020-01-27 08:49:39 -0700150fdt_addr_t devfdt_get_addr_size_name(const struct udevice *dev,
151 const char *name, fdt_size_t *size);
Sekhar Norif677c6f2019-08-01 19:12:56 +0530152
Simon Glass23b27592019-09-15 12:08:58 -0600153/**
154 * devfdt_get_addr_pci() - Read an address and handle PCI address translation
155 *
156 * @dev: Device to read from
157 * @return address or FDT_ADDR_T_NONE if not found
158 */
Simon Glassc6548b82020-01-27 08:49:39 -0700159fdt_addr_t devfdt_get_addr_pci(const struct udevice *dev);
Simon Glass23b27592019-09-15 12:08:58 -0600160
Simon Glassaadfaf02017-05-17 17:18:04 -0600161#endif