1/* SPDX-License-Identifier: GPL-2.0+ */
2/*
3 * Copyright (c) 2011 The Chromium OS Authors.
4 */
5
6#ifndef __fdtdec_h
7#define __fdtdec_h
8
9/*
10 * This file contains convenience functions for decoding useful and
11 * enlightening information from FDTs. It is intended to be used by device
12 * drivers and board-specific code within U-Boot. It aims to reduce the
13 * amount of FDT munging required within U-Boot itself, so that driver code
14 * changes to support FDT are minimized.
15 */
16
17#include <linux/libfdt.h>
18#include <pci.h>
19
20/*
21 * Support for 64bit fdt addresses.
22 * This can be used not only for 64bit SoCs, but also
23 * for large address extensions on 32bit SoCs.
24 * Note that fdt data is always big
25 * endian even on a litle endian machine.
26 */
27
28#define FDT_SIZE_T_NONE (-1U)
29
30#ifdef CONFIG_FDT_64BIT
31typedef u64 fdt_addr_t;
32typedef u64 fdt_size_t;
33#define FDT_ADDR_T_NONE ((ulong)(-1))
34
35#define fdt_addr_to_cpu(reg) be64_to_cpu(reg)
36#define fdt_size_to_cpu(reg) be64_to_cpu(reg)
37#define cpu_to_fdt_addr(reg) cpu_to_be64(reg)
38#define cpu_to_fdt_size(reg) cpu_to_be64(reg)
39typedef fdt64_t fdt_val_t;
40#else
41typedef u32 fdt_addr_t;
42typedef u32 fdt_size_t;
43#define FDT_ADDR_T_NONE (-1U)
44
45#define fdt_addr_to_cpu(reg) be32_to_cpu(reg)
46#define fdt_size_to_cpu(reg) be32_to_cpu(reg)
47#define cpu_to_fdt_addr(reg) cpu_to_be32(reg)
48#define cpu_to_fdt_size(reg) cpu_to_be32(reg)
49typedef fdt32_t fdt_val_t;
50#endif
51
52/* Information obtained about memory from the FDT */
53struct fdt_memory {
54	fdt_addr_t start;
55	fdt_addr_t end;
56};
57
58struct bd_info;
59
60/**
61 * enum fdt_source_t - indicates where the devicetree came from
62 *
63 * These are listed in approximate order of desirability after FDTSRC_NONE
64 *
65 * @FDTSRC_SEPARATE: Appended to U-Boot. This is the normal approach if U-Boot
66 *	is the only firmware being booted
67 * @FDTSRC_FIT: Found in a multi-dtb FIT. This should be used when U-Boot must
68 *	select a devicetree from many options
69 * @FDTSRC_BOARD: Located by custom board code. This should only be used when
70 *	the prior stage does not support FDTSRC_PASSAGE
71 * @FDTSRC_EMBED: Embedded into U-Boot executable. This should onyl be used when
72 *	U-Boot is packaged as an ELF file, e.g. for debugging purposes
73 * @FDTSRC_ENV: Provided by the fdtcontroladdr environment variable. This should
74 *	be used for debugging/development only
75 * @FDTSRC_BLOBLIST: Provided by a bloblist from an earlier phase
76 */
77enum fdt_source_t {
78	FDTSRC_SEPARATE,
79	FDTSRC_FIT,
80	FDTSRC_BOARD,
81	FDTSRC_EMBED,
82	FDTSRC_ENV,
83	FDTSRC_BLOBLIST,
84};
85
86/*
87 * Information about a resource. start is the first address of the resource
88 * and end is the last address (inclusive). The length of the resource will
89 * be equal to: end - start + 1.
90 */
91struct fdt_resource {
92	fdt_addr_t start;
93	fdt_addr_t end;
94};
95
96enum fdt_pci_space {
97	FDT_PCI_SPACE_CONFIG = 0,
98	FDT_PCI_SPACE_IO = 0x01000000,
99	FDT_PCI_SPACE_MEM32 = 0x02000000,
100	FDT_PCI_SPACE_MEM64 = 0x03000000,
101	FDT_PCI_SPACE_MEM32_PREF = 0x42000000,
102	FDT_PCI_SPACE_MEM64_PREF = 0x43000000,
103};
104
105#define FDT_PCI_ADDR_CELLS	3
106#define FDT_PCI_SIZE_CELLS	2
107#define FDT_PCI_REG_SIZE	\
108	((FDT_PCI_ADDR_CELLS + FDT_PCI_SIZE_CELLS) * sizeof(u32))
109
110/*
111 * The Open Firmware spec defines PCI physical address as follows:
112 *
113 *          bits# 31 .... 24 23 .... 16 15 .... 08 07 .... 00
114 *
115 * phys.hi  cell:  npt000ss   bbbbbbbb   dddddfff   rrrrrrrr
116 * phys.mid cell:  hhhhhhhh   hhhhhhhh   hhhhhhhh   hhhhhhhh
117 * phys.lo  cell:  llllllll   llllllll   llllllll   llllllll
118 *
119 * where:
120 *
121 * n:        is 0 if the address is relocatable, 1 otherwise
122 * p:        is 1 if addressable region is prefetchable, 0 otherwise
123 * t:        is 1 if the address is aliased (for non-relocatable I/O) below 1MB
124 *           (for Memory), or below 64KB (for relocatable I/O)
125 * ss:       is the space code, denoting the address space
126 * bbbbbbbb: is the 8-bit Bus Number
127 * ddddd:    is the 5-bit Device Number
128 * fff:      is the 3-bit Function Number
129 * rrrrrrrr: is the 8-bit Register Number
130 * hhhhhhhh: is a 32-bit unsigned number
131 * llllllll: is a 32-bit unsigned number
132 */
133struct fdt_pci_addr {
134	u32	phys_hi;
135	u32	phys_mid;
136	u32	phys_lo;
137};
138
139extern u8 __dtb_dt_begin[];	/* embedded device tree blob */
140extern u8 __dtb_dt_spl_begin[];	/* embedded device tree blob for SPL/TPL */
141
142/* Get a pointer to the embedded devicetree, if there is one, else NULL */
143static inline u8 *dtb_dt_embedded(void)
144{
145#ifdef CONFIG_OF_EMBED
146# ifdef CONFIG_SPL_BUILD
147	return __dtb_dt_spl_begin;
148# else
149	return __dtb_dt_begin;
150# endif
151#else
152	return NULL;
153#endif
154}
155
156/**
157 * Compute the size of a resource.
158 *
159 * @param res	the resource to operate on
160 * Return: the size of the resource
161 */
162static inline fdt_size_t fdt_resource_size(const struct fdt_resource *res)
163{
164	return res->end - res->start + 1;
165}
166
167/**
168 * Compat types that we know about and for which we might have drivers.
169 * Each is named COMPAT_<dir>_<filename> where <dir> is the directory
170 * within drivers.
171 */
172enum fdt_compat_id {
173	COMPAT_UNKNOWN,
174	COMPAT_NVIDIA_TEGRA20_EMC,	/* Tegra20 memory controller */
175	COMPAT_NVIDIA_TEGRA20_EMC_TABLE, /* Tegra20 memory timing table */
176	COMPAT_NVIDIA_TEGRA20_NAND,	/* Tegra2 NAND controller */
177	COMPAT_NVIDIA_TEGRA124_XUSB_PADCTL,
178					/* Tegra124 XUSB pad controller */
179	COMPAT_NVIDIA_TEGRA210_XUSB_PADCTL,
180					/* Tegra210 XUSB pad controller */
181	COMPAT_SAMSUNG_EXYNOS_USB_PHY,	/* Exynos phy controller for usb2.0 */
182	COMPAT_SAMSUNG_EXYNOS5_USB3_PHY,/* Exynos phy controller for usb3.0 */
183	COMPAT_SAMSUNG_EXYNOS_TMU,	/* Exynos TMU */
184	COMPAT_SAMSUNG_EXYNOS_MIPI_DSI,	/* Exynos mipi dsi */
185	COMPAT_SAMSUNG_EXYNOS_DWMMC,	/* Exynos DWMMC controller */
186	COMPAT_GENERIC_SPI_FLASH,	/* Generic SPI Flash chip */
187	COMPAT_SAMSUNG_EXYNOS_SYSMMU,	/* Exynos sysmmu */
188	COMPAT_INTEL_MICROCODE,		/* Intel microcode update */
189	COMPAT_INTEL_QRK_MRC,		/* Intel Quark MRC */
190	COMPAT_ALTERA_SOCFPGA_DWMAC,	/* SoCFPGA Ethernet controller */
191	COMPAT_ALTERA_SOCFPGA_DWMMC,	/* SoCFPGA DWMMC controller */
192	COMPAT_ALTERA_SOCFPGA_DWC2USB,	/* SoCFPGA DWC2 USB controller */
193	COMPAT_INTEL_BAYTRAIL_FSP,	/* Intel Bay Trail FSP */
194	COMPAT_INTEL_BAYTRAIL_FSP_MDP,	/* Intel FSP memory-down params */
195	COMPAT_INTEL_IVYBRIDGE_FSP,	/* Intel Ivy Bridge FSP */
196	COMPAT_ALTERA_SOCFPGA_CLK,	/* SoCFPGA Clock initialization */
197	COMPAT_ALTERA_SOCFPGA_PINCTRL_SINGLE,	/* SoCFPGA pinctrl-single */
198	COMPAT_ALTERA_SOCFPGA_H2F_BRG,          /* SoCFPGA hps2fpga bridge */
199	COMPAT_ALTERA_SOCFPGA_LWH2F_BRG,        /* SoCFPGA lwhps2fpga bridge */
200	COMPAT_ALTERA_SOCFPGA_F2H_BRG,          /* SoCFPGA fpga2hps bridge */
201	COMPAT_ALTERA_SOCFPGA_F2SDR0,           /* SoCFPGA fpga2SDRAM0 bridge */
202	COMPAT_ALTERA_SOCFPGA_F2SDR1,           /* SoCFPGA fpga2SDRAM1 bridge */
203	COMPAT_ALTERA_SOCFPGA_F2SDR2,           /* SoCFPGA fpga2SDRAM2 bridge */
204	COMPAT_ALTERA_SOCFPGA_FPGA0,		/* SOCFPGA FPGA manager */
205	COMPAT_ALTERA_SOCFPGA_NOC,		/* SOCFPGA Arria 10 NOC */
206	COMPAT_ALTERA_SOCFPGA_CLK_INIT,		/* SOCFPGA Arria 10 clk init */
207
208	COMPAT_COUNT,
209};
210
211#define MAX_PHANDLE_ARGS 16
212struct fdtdec_phandle_args {
213	int node;
214	int args_count;
215	uint32_t args[MAX_PHANDLE_ARGS];
216};
217
218/**
219 * fdtdec_parse_phandle_with_args() - Find a node pointed by phandle in a list
220 *
221 * This function is useful to parse lists of phandles and their arguments.
222 *
223 * Example:
224 *
225 * phandle1: node1 {
226 *	#list-cells = <2>;
227 * }
228 *
229 * phandle2: node2 {
230 *	#list-cells = <1>;
231 * }
232 *
233 * node3 {
234 *	list = <&phandle1 1 2 &phandle2 3>;
235 * }
236 *
237 * To get a device_node of the `node2' node you may call this:
238 * fdtdec_parse_phandle_with_args(blob, node3, "list", "#list-cells", 0, 1,
239 *				  &args);
240 *
241 * (This function is a modified version of __of_parse_phandle_with_args() from
242 * Linux 3.18)
243 *
244 * @blob:	Pointer to device tree
245 * @src_node:	Offset of device tree node containing a list
246 * @list_name:	property name that contains a list
247 * @cells_name:	property name that specifies the phandles' arguments count,
248 *		or NULL to use @cells_count
249 * @cells_count: Cell count to use if @cells_name is NULL
250 * @index:	index of a phandle to parse out
251 * @out_args:	optional pointer to output arguments structure (will be filled)
252 * Return: 0 on success (with @out_args filled out if not NULL), -ENOENT if
253 *	@list_name does not exist, a phandle was not found, @cells_name
254 *	could not be found, the arguments were truncated or there were too
255 *	many arguments.
256 *
257 */
258int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
259				   const char *list_name,
260				   const char *cells_name,
261				   int cell_count, int index,
262				   struct fdtdec_phandle_args *out_args);
263
264/**
265 * Find the next numbered alias for a peripheral. This is used to enumerate
266 * all the peripherals of a certain type.
267 *
268 * Do the first call with *upto = 0. Assuming /aliases/<name>0 exists then
269 * this function will return a pointer to the node the alias points to, and
270 * then update *upto to 1. Next time you call this function, the next node
271 * will be returned.
272 *
273 * All nodes returned will match the compatible ID, as it is assumed that
274 * all peripherals use the same driver.
275 *
276 * @param blob		FDT blob to use
277 * @param name		Root name of alias to search for
278 * @param id		Compatible ID to look for
279 * Return: offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
280 */
281int fdtdec_next_alias(const void *blob, const char *name,
282		enum fdt_compat_id id, int *upto);
283
284/**
285 * Find the compatible ID for a given node.
286 *
287 * Generally each node has at least one compatible string attached to it.
288 * This function looks through our list of known compatible strings and
289 * returns the corresponding ID which matches the compatible string.
290 *
291 * @param blob		FDT blob to use
292 * @param node		Node containing compatible string to find
293 * Return: compatible ID, or COMPAT_UNKNOWN if we cannot find a match
294 */
295enum fdt_compat_id fdtdec_lookup(const void *blob, int node);
296
297/**
298 * Find the next compatible node for a peripheral.
299 *
300 * Do the first call with node = 0. This function will return a pointer to
301 * the next compatible node. Next time you call this function, pass the
302 * value returned, and the next node will be provided.
303 *
304 * @param blob		FDT blob to use
305 * @param node		Start node for search
306 * @param id		Compatible ID to look for (enum fdt_compat_id)
307 * Return: offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
308 */
309int fdtdec_next_compatible(const void *blob, int node,
310		enum fdt_compat_id id);
311
312/**
313 * Find the next compatible subnode for a peripheral.
314 *
315 * Do the first call with node set to the parent and depth = 0. This
316 * function will return the offset of the next compatible node. Next time
317 * you call this function, pass the node value returned last time, with
318 * depth unchanged, and the next node will be provided.
319 *
320 * @param blob		FDT blob to use
321 * @param node		Start node for search
322 * @param id		Compatible ID to look for (enum fdt_compat_id)
323 * @param depthp	Current depth (set to 0 before first call)
324 * Return: offset of next compatible node, or -FDT_ERR_NOTFOUND if no more
325 */
326int fdtdec_next_compatible_subnode(const void *blob, int node,
327		enum fdt_compat_id id, int *depthp);
328
329/*
330 * Look up an address property in a node and return the parsed address, and
331 * optionally the parsed size.
332 *
333 * This variant assumes a known and fixed number of cells are used to
334 * represent the address and size.
335 *
336 * You probably don't want to use this function directly except to parse
337 * non-standard properties, and never to parse the "reg" property. Instead,
338 * use one of the "auto" variants below, which automatically honor the
339 * #address-cells and #size-cells properties in the parent node.
340 *
341 * @param blob	FDT blob
342 * @param node	node to examine
343 * @param prop_name	name of property to find
344 * @param index	which address to retrieve from a list of addresses. Often 0.
345 * @param na	the number of cells used to represent an address
346 * @param ns	the number of cells used to represent a size
347 * @param sizep	a pointer to store the size into. Use NULL if not required
348 * @param translate	Indicates whether to translate the returned value
349 *			using the parent node's ranges property.
350 * Return: address, if found, or FDT_ADDR_T_NONE if not
351 */
352fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node,
353		const char *prop_name, int index, int na, int ns,
354		fdt_size_t *sizep, bool translate);
355
356/*
357 * Look up an address property in a node and return the parsed address, and
358 * optionally the parsed size.
359 *
360 * This variant automatically determines the number of cells used to represent
361 * the address and size by parsing the provided parent node's #address-cells
362 * and #size-cells properties.
363 *
364 * @param blob	FDT blob
365 * @param parent	parent node of @node
366 * @param node	node to examine
367 * @param prop_name	name of property to find
368 * @param index	which address to retrieve from a list of addresses. Often 0.
369 * @param sizep	a pointer to store the size into. Use NULL if not required
370 * @param translate	Indicates whether to translate the returned value
371 *			using the parent node's ranges property.
372 * Return: address, if found, or FDT_ADDR_T_NONE if not
373 */
374fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent,
375		int node, const char *prop_name, int index, fdt_size_t *sizep,
376		bool translate);
377
378/*
379 * Look up an address property in a node and return the parsed address, and
380 * optionally the parsed size.
381 *
382 * This variant automatically determines the number of cells used to represent
383 * the address and size by parsing the parent node's #address-cells
384 * and #size-cells properties. The parent node is automatically found.
385 *
386 * The automatic parent lookup implemented by this function is slow.
387 * Consequently, fdtdec_get_addr_size_auto_parent() should be used where
388 * possible.
389 *
390 * @param blob	FDT blob
391 * @param parent	parent node of @node
392 * @param node	node to examine
393 * @param prop_name	name of property to find
394 * @param index	which address to retrieve from a list of addresses. Often 0.
395 * @param sizep	a pointer to store the size into. Use NULL if not required
396 * @param translate	Indicates whether to translate the returned value
397 *			using the parent node's ranges property.
398 * Return: address, if found, or FDT_ADDR_T_NONE if not
399 */
400fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node,
401		const char *prop_name, int index, fdt_size_t *sizep,
402		bool translate);
403
404/*
405 * Look up an address property in a node and return the parsed address.
406 *
407 * This variant hard-codes the number of cells used to represent the address
408 * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
409 * always returns the first address value in the property (index 0).
410 *
411 * Use of this function is not recommended due to the hard-coding of cell
412 * counts. There is no programmatic validation that these hard-coded values
413 * actually match the device tree content in any way at all. This assumption
414 * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
415 * set in the U-Boot build and exercising strict control over DT content to
416 * ensure use of matching #address-cells/#size-cells properties. However, this
417 * approach is error-prone; those familiar with DT will not expect the
418 * assumption to exist, and could easily invalidate it. If the assumption is
419 * invalidated, this function will not report the issue, and debugging will
420 * be required. Instead, use fdtdec_get_addr_size_auto_parent().
421 *
422 * @param blob	FDT blob
423 * @param node	node to examine
424 * @param prop_name	name of property to find
425 * Return: address, if found, or FDT_ADDR_T_NONE if not
426 */
427fdt_addr_t fdtdec_get_addr(const void *blob, int node,
428		const char *prop_name);
429
430/*
431 * Look up an address property in a node and return the parsed address, and
432 * optionally the parsed size.
433 *
434 * This variant hard-codes the number of cells used to represent the address
435 * and size based on sizeof(fdt_addr_t) and sizeof(fdt_size_t). It also
436 * always returns the first address value in the property (index 0).
437 *
438 * Use of this function is not recommended due to the hard-coding of cell
439 * counts. There is no programmatic validation that these hard-coded values
440 * actually match the device tree content in any way at all. This assumption
441 * can be satisfied by manually ensuring CONFIG_PHYS_64BIT is appropriately
442 * set in the U-Boot build and exercising strict control over DT content to
443 * ensure use of matching #address-cells/#size-cells properties. However, this
444 * approach is error-prone; those familiar with DT will not expect the
445 * assumption to exist, and could easily invalidate it. If the assumption is
446 * invalidated, this function will not report the issue, and debugging will
447 * be required. Instead, use fdtdec_get_addr_size_auto_parent().
448 *
449 * @param blob	FDT blob
450 * @param node	node to examine
451 * @param prop_name	name of property to find
452 * @param sizep	a pointer to store the size into. Use NULL if not required
453 * Return: address, if found, or FDT_ADDR_T_NONE if not
454 */
455fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
456		const char *prop_name, fdt_size_t *sizep);
457
458/**
459 * Look at the compatible property of a device node that represents a PCI
460 * device and extract pci vendor id and device id from it.
461 *
462 * @param blob		FDT blob
463 * @param node		node to examine
464 * @param vendor	vendor id of the pci device
465 * @param device	device id of the pci device
466 * Return: 0 if ok, negative on error
467 */
468int fdtdec_get_pci_vendev(const void *blob, int node,
469		u16 *vendor, u16 *device);
470
471/**
472 * Look at the pci address of a device node that represents a PCI device
473 * and return base address of the pci device's registers.
474 *
475 * @param dev		device to examine
476 * @param addr		pci address in the form of fdt_pci_addr
477 * @param bar		returns base address of the pci device's registers
478 * Return: 0 if ok, negative on error
479 */
480int fdtdec_get_pci_bar32(const struct udevice *dev, struct fdt_pci_addr *addr,
481			 u32 *bar);
482
483/**
484 * Look at the bus range property of a device node and return the pci bus
485 * range for this node.
486 * The property must hold one fdt_pci_addr with a length.
487 * @param blob		FDT blob
488 * @param node		node to examine
489 * @param res		the resource structure to return the bus range
490 * Return: 0 if ok, negative on error
491 */
492
493int fdtdec_get_pci_bus_range(const void *blob, int node,
494			     struct fdt_resource *res);
495
496/**
497 * Look up a 32-bit integer property in a node and return it. The property
498 * must have at least 4 bytes of data. The value of the first cell is
499 * returned.
500 *
501 * @param blob	FDT blob
502 * @param node	node to examine
503 * @param prop_name	name of property to find
504 * @param default_val	default value to return if the property is not found
505 * Return: integer value, if found, or default_val if not
506 */
507s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
508		s32 default_val);
509
510/**
511 * Unsigned version of fdtdec_get_int. The property must have at least
512 * 4 bytes of data. The value of the first cell is returned.
513 *
514 * @param blob	FDT blob
515 * @param node	node to examine
516 * @param prop_name	name of property to find
517 * @param default_val	default value to return if the property is not found
518 * Return: unsigned integer value, if found, or default_val if not
519 */
520unsigned int fdtdec_get_uint(const void *blob, int node, const char *prop_name,
521			unsigned int default_val);
522
523/**
524 * Get a variable-sized number from a property
525 *
526 * This reads a number from one or more cells.
527 *
528 * @param ptr	Pointer to property
529 * @param cells	Number of cells containing the number
530 * Return: the value in the cells
531 */
532u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells);
533
534/**
535 * Look up a 64-bit integer property in a node and return it. The property
536 * must have at least 8 bytes of data (2 cells). The first two cells are
537 * concatenated to form a 8 bytes value, where the first cell is top half and
538 * the second cell is bottom half.
539 *
540 * @param blob	FDT blob
541 * @param node	node to examine
542 * @param prop_name	name of property to find
543 * @param default_val	default value to return if the property is not found
544 * Return: integer value, if found, or default_val if not
545 */
546uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
547		uint64_t default_val);
548
549/**
550 * Checks whether a node is enabled.
551 * This looks for a 'status' property. If this exists, then returns 1 if
552 * the status is 'ok' and 0 otherwise. If there is no status property,
553 * it returns 1 on the assumption that anything mentioned should be enabled
554 * by default.
555 *
556 * @param blob	FDT blob
557 * @param node	node to examine
558 * Return: integer value 0 (not enabled) or 1 (enabled)
559 */
560int fdtdec_get_is_enabled(const void *blob, int node);
561
562/**
563 * Checks that we have a valid fdt available to control U-Boot.
564
565 * However, if not then for the moment nothing is done, since this function
566 * is called too early to panic().
567 *
568 * @returns 0
569 */
570int fdtdec_check_fdt(void);
571
572/**
573 * Find the nodes for a peripheral and return a list of them in the correct
574 * order. This is used to enumerate all the peripherals of a certain type.
575 *
576 * To use this, optionally set up a /aliases node with alias properties for
577 * a peripheral. For example, for usb you could have:
578 *
579 * aliases {
580 *		usb0 = "/ehci@c5008000";
581 *		usb1 = "/ehci@c5000000";
582 * };
583 *
584 * Pass "usb" as the name to this function and will return a list of two
585 * nodes offsets: /ehci@c5008000 and ehci@c5000000.
586 *
587 * All nodes returned will match the compatible ID, as it is assumed that
588 * all peripherals use the same driver.
589 *
590 * If no alias node is found, then the node list will be returned in the
591 * order found in the fdt. If the aliases mention a node which doesn't
592 * exist, then this will be ignored. If nodes are found with no aliases,
593 * they will be added in any order.
594 *
595 * If there is a gap in the aliases, then this function return a 0 node at
596 * that position. The return value will also count these gaps.
597 *
598 * This function checks node properties and will not return nodes which are
599 * marked disabled (status = "disabled").
600 *
601 * @param blob		FDT blob to use
602 * @param name		Root name of alias to search for
603 * @param id		Compatible ID to look for
604 * @param node_list	Place to put list of found nodes
605 * @param maxcount	Maximum number of nodes to find
606 * Return: number of nodes found on success, FDT_ERR_... on error
607 */
608int fdtdec_find_aliases_for_id(const void *blob, const char *name,
609			enum fdt_compat_id id, int *node_list, int maxcount);
610
611/*
612 * This function is similar to fdtdec_find_aliases_for_id() except that it
613 * adds to the node_list that is passed in. Any 0 elements are considered
614 * available for allocation - others are considered already used and are
615 * skipped.
616 *
617 * You can use this by calling fdtdec_find_aliases_for_id() with an
618 * uninitialised array, then setting the elements that are returned to -1,
619 * say, then calling this function, perhaps with a different compat id.
620 * Any elements you get back that are >0 are new nodes added by the call
621 * to this function.
622 *
623 * Note that if you have some nodes with aliases and some without, you are
624 * sailing close to the wind. The call to fdtdec_find_aliases_for_id() with
625 * one compat_id may fill in positions for which you have aliases defined
626 * for another compat_id. When you later call *this* function with the second
627 * compat_id, the alias positions may already be used. A debug warning may
628 * be generated in this case, but it is safest to define aliases for all
629 * nodes when you care about the ordering.
630 */
631int fdtdec_add_aliases_for_id(const void *blob, const char *name,
632			enum fdt_compat_id id, int *node_list, int maxcount);
633
634/**
635 * Get the alias sequence number of a node
636 *
637 * This works out whether a node is pointed to by an alias, and if so, the
638 * sequence number of that alias. Aliases are of the form <base><num> where
639 * <num> is the sequence number. For example spi2 would be sequence number
640 * 2.
641 *
642 * @param blob		Device tree blob (if NULL, then error is returned)
643 * @param base		Base name for alias (before the underscore)
644 * @param node		Node to look up
645 * @param seqp		This is set to the sequence number if one is found,
646 *			but otherwise the value is left alone
647 * Return: 0 if a sequence was found, -ve if not
648 */
649int fdtdec_get_alias_seq(const void *blob, const char *base, int node,
650			 int *seqp);
651
652/**
653 * Get the highest alias number for susbystem.
654 *
655 * It parses all aliases and find out highest recorded alias for subsystem.
656 * Aliases are of the form <base><num> where <num> is the sequence number.
657 *
658 * @param blob		Device tree blob (if NULL, then error is returned)
659 * @param base		Base name for alias susbystem (before the number)
660 *
661 * Return: 0 highest alias ID, -1 if not found
662 */
663int fdtdec_get_alias_highest_id(const void *blob, const char *base);
664
665/**
666 * Get a property from the /chosen node
667 *
668 * @param blob		Device tree blob (if NULL, then NULL is returned)
669 * @param name		Property name to look up
670 * Return: Value of property, or NULL if it does not exist
671 */
672const char *fdtdec_get_chosen_prop(const void *blob, const char *name);
673
674/**
675 * Get the offset of the given /chosen node
676 *
677 * This looks up a property in /chosen containing the path to another node,
678 * then finds the offset of that node.
679 *
680 * @param blob		Device tree blob (if NULL, then error is returned)
681 * @param name		Property name, e.g. "stdout-path"
682 * Return: Node offset referred to by that chosen node, or -ve FDT_ERR_...
683 */
684int fdtdec_get_chosen_node(const void *blob, const char *name);
685
686/*
687 * Get the name for a compatible ID
688 *
689 * @param id		Compatible ID to look for
690 * Return: compatible string for that id
691 */
692const char *fdtdec_get_compatible(enum fdt_compat_id id);
693
694/* Look up a phandle and follow it to its node. Then return the offset
695 * of that node.
696 *
697 * @param blob		FDT blob
698 * @param node		node to examine
699 * @param prop_name	name of property to find
700 * Return: node offset if found, -ve error code on error
701 */
702int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name);
703
704/**
705 * Look up a property in a node and return its contents in an integer
706 * array of given length. The property must have at least enough data for
707 * the array (4*count bytes). It may have more, but this will be ignored.
708 *
709 * @param blob		FDT blob
710 * @param node		node to examine
711 * @param prop_name	name of property to find
712 * @param array		array to fill with data
713 * @param count		number of array elements
714 * Return: 0 if ok, or -FDT_ERR_NOTFOUND if the property is not found,
715 *		or -FDT_ERR_BADLAYOUT if not enough data
716 */
717int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
718		u32 *array, int count);
719
720/**
721 * Look up a property in a node and return its contents in an integer
722 * array of given length. The property must exist but may have less data that
723 * expected (4*count bytes). It may have more, but this will be ignored.
724 *
725 * @param blob		FDT blob
726 * @param node		node to examine
727 * @param prop_name	name of property to find
728 * @param array		array to fill with data
729 * @param count		number of array elements
730 * Return: number of array elements if ok, or -FDT_ERR_NOTFOUND if the
731 *		property is not found
732 */
733int fdtdec_get_int_array_count(const void *blob, int node,
734			       const char *prop_name, u32 *array, int count);
735
736/**
737 * Look up a property in a node and return a pointer to its contents as a
738 * unsigned int array of given length. The property must have at least enough
739 * data for the array ('count' cells). It may have more, but this will be
740 * ignored. The data is not copied.
741 *
742 * Note that you must access elements of the array with fdt32_to_cpu(),
743 * since the elements will be big endian even on a little endian machine.
744 *
745 * @param blob		FDT blob
746 * @param node		node to examine
747 * @param prop_name	name of property to find
748 * @param count		number of array elements
749 * Return: pointer to array if found, or NULL if the property is not
750 *		found or there is not enough data
751 */
752const u32 *fdtdec_locate_array(const void *blob, int node,
753			       const char *prop_name, int count);
754
755/**
756 * Look up a boolean property in a node and return it.
757 *
758 * A boolean properly is true if present in the device tree and false if not
759 * present, regardless of its value.
760 *
761 * @param blob	FDT blob
762 * @param node	node to examine
763 * @param prop_name	name of property to find
764 * Return: 1 if the properly is present; 0 if it isn't present
765 */
766int fdtdec_get_bool(const void *blob, int node, const char *prop_name);
767
768/*
769 * Count child nodes of one parent node.
770 *
771 * @param blob	FDT blob
772 * @param node	parent node
773 * Return: number of child node; 0 if there is not child node
774 */
775int fdtdec_get_child_count(const void *blob, int node);
776
777/*
778 * Look up a property in a node and return its contents in a byte
779 * array of given length. The property must have at least enough data for
780 * the array (count bytes). It may have more, but this will be ignored.
781 *
782 * @param blob		FDT blob
783 * @param node		node to examine
784 * @param prop_name	name of property to find
785 * @param array		array to fill with data
786 * @param count		number of array elements
787 * Return: 0 if ok, or -FDT_ERR_MISSING if the property is not found,
788 *		or -FDT_ERR_BADLAYOUT if not enough data
789 */
790int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
791		u8 *array, int count);
792
793/**
794 * Look up a property in a node and return a pointer to its contents as a
795 * byte array of given length. The property must have at least enough data
796 * for the array (count bytes). It may have more, but this will be ignored.
797 * The data is not copied.
798 *
799 * @param blob		FDT blob
800 * @param node		node to examine
801 * @param prop_name	name of property to find
802 * @param count		number of array elements
803 * Return: pointer to byte array if found, or NULL if the property is not
804 *		found or there is not enough data
805 */
806const u8 *fdtdec_locate_byte_array(const void *blob, int node,
807			     const char *prop_name, int count);
808
809/**
810 * Obtain an indexed resource from a device property.
811 *
812 * @param fdt		FDT blob
813 * @param node		node to examine
814 * @param property	name of the property to parse
815 * @param index		index of the resource to retrieve
816 * @param res		returns the resource
817 * Return: 0 if ok, negative on error
818 */
819int fdt_get_resource(const void *fdt, int node, const char *property,
820		     unsigned int index, struct fdt_resource *res);
821
822/**
823 * Obtain a named resource from a device property.
824 *
825 * Look up the index of the name in a list of strings and return the resource
826 * at that index.
827 *
828 * @param fdt		FDT blob
829 * @param node		node to examine
830 * @param property	name of the property to parse
831 * @param prop_names	name of the property containing the list of names
832 * @param name		the name of the entry to look up
833 * @param res		returns the resource
834 */
835int fdt_get_named_resource(const void *fdt, int node, const char *property,
836			   const char *prop_names, const char *name,
837			   struct fdt_resource *res);
838
839/* Display timings from linux include/video/display_timing.h */
840enum display_flags {
841	DISPLAY_FLAGS_HSYNC_LOW		= 1 << 0,
842	DISPLAY_FLAGS_HSYNC_HIGH	= 1 << 1,
843	DISPLAY_FLAGS_VSYNC_LOW		= 1 << 2,
844	DISPLAY_FLAGS_VSYNC_HIGH	= 1 << 3,
845
846	/* data enable flag */
847	DISPLAY_FLAGS_DE_LOW		= 1 << 4,
848	DISPLAY_FLAGS_DE_HIGH		= 1 << 5,
849	/* drive data on pos. edge */
850	DISPLAY_FLAGS_PIXDATA_POSEDGE	= 1 << 6,
851	/* drive data on neg. edge */
852	DISPLAY_FLAGS_PIXDATA_NEGEDGE	= 1 << 7,
853	DISPLAY_FLAGS_INTERLACED	= 1 << 8,
854	DISPLAY_FLAGS_DOUBLESCAN	= 1 << 9,
855	DISPLAY_FLAGS_DOUBLECLK		= 1 << 10,
856};
857
858/*
859 * A single signal can be specified via a range of minimal and maximal values
860 * with a typical value, that lies somewhere inbetween.
861 */
862struct timing_entry {
863	u32 min;
864	u32 typ;
865	u32 max;
866};
867
868/*
869 * Single "mode" entry. This describes one set of signal timings a display can
870 * have in one setting. This struct can later be converted to struct videomode
871 * (see include/video/videomode.h). As each timing_entry can be defined as a
872 * range, one struct display_timing may become multiple struct videomodes.
873 *
874 * Example: hsync active high, vsync active low
875 *
876 *				    Active Video
877 * Video  ______________________XXXXXXXXXXXXXXXXXXXXXX_____________________
878 *	  |<- sync ->|<- back ->|<----- active ----->|<- front ->|<- sync..
879 *	  |	     |	 porch  |		     |	 porch	 |
880 *
881 * HSync _|��������������������|___________________________________________|������������������
882 *
883 * VSync ��|__________|��������������������������������������������������������������������������������������|_________
884 */
885struct display_timing {
886	struct timing_entry pixelclock;
887
888	struct timing_entry hactive;		/* hor. active video */
889	struct timing_entry hfront_porch;	/* hor. front porch */
890	struct timing_entry hback_porch;	/* hor. back porch */
891	struct timing_entry hsync_len;		/* hor. sync len */
892
893	struct timing_entry vactive;		/* ver. active video */
894	struct timing_entry vfront_porch;	/* ver. front porch */
895	struct timing_entry vback_porch;	/* ver. back porch */
896	struct timing_entry vsync_len;		/* ver. sync len */
897
898	enum display_flags flags;		/* display flags */
899	bool hdmi_monitor;			/* is hdmi monitor? */
900};
901
902/**
903 * fdtdec_decode_display_timing() - decode display timings
904 *
905 * Decode display timings from the supplied 'display-timings' node.
906 * See doc/device-tree-bindings/video/display-timing.txt for binding
907 * information.
908 *
909 * @param blob		FDT blob
910 * @param node		'display-timing' node containing the timing subnodes
911 * @param index		Index number to read (0=first timing subnode)
912 * @param config	Place to put timings
913 * Return: 0 if OK, -FDT_ERR_NOTFOUND if not found
914 */
915int fdtdec_decode_display_timing(const void *blob, int node, int index,
916				 struct display_timing *config);
917
918/**
919 * fdtdec_setup_mem_size_base() - decode and setup gd->ram_size and
920 * gd->ram_start
921 *
922 * Decode the /memory 'reg' property to determine the size and start of the
923 * first memory bank, populate the global data with the size and start of the
924 * first bank of memory.
925 *
926 * This function should be called from a boards dram_init(). This helper
927 * function allows for boards to query the device tree for DRAM size and start
928 * address instead of hard coding the value in the case where the memory size
929 * and start address cannot be detected automatically.
930 *
931 * Return: 0 if OK, -EINVAL if the /memory node or reg property is missing or
932 * invalid
933 */
934int fdtdec_setup_mem_size_base(void);
935
936/**
937 * fdtdec_setup_mem_size_base_lowest() - decode and setup gd->ram_size and
938 * gd->ram_start by lowest available memory base
939 *
940 * Decode the /memory 'reg' property to determine the lowest start of the memory
941 * bank bank and populate the global data with it.
942 *
943 * This function should be called from a boards dram_init(). This helper
944 * function allows for boards to query the device tree for DRAM size and start
945 * address instead of hard coding the value in the case where the memory size
946 * and start address cannot be detected automatically.
947 *
948 * Return: 0 if OK, -EINVAL if the /memory node or reg property is missing or
949 * invalid
950 */
951int fdtdec_setup_mem_size_base_lowest(void);
952
953/**
954 * fdtdec_setup_memory_banksize() - decode and populate gd->bd->bi_dram
955 *
956 * Decode the /memory 'reg' property to determine the address and size of the
957 * memory banks. Use this data to populate the global data board info with the
958 * phys address and size of memory banks.
959 *
960 * This function should be called from a boards dram_init_banksize(). This
961 * helper function allows for boards to query the device tree for memory bank
962 * information instead of hard coding the information in cases where it cannot
963 * be detected automatically.
964 *
965 * Return: 0 if OK, -EINVAL if the /memory node or reg property is missing or
966 * invalid
967 */
968int fdtdec_setup_memory_banksize(void);
969
970/**
971 * fdtdec_set_ethernet_mac_address() - set MAC address for default interface
972 *
973 * Looks up the default interface via the "ethernet" alias (in the /aliases
974 * node) and stores the given MAC in its "local-mac-address" property. This
975 * is useful on platforms that store the MAC address in a custom location.
976 * Board code can call this in the late init stage to make sure that the
977 * interface device tree node has the right MAC address configured for the
978 * Ethernet uclass to pick it up.
979 *
980 * Typically the FDT passed into this function will be U-Boot's control DTB.
981 * Given that a lot of code may be holding offsets to various nodes in that
982 * tree, this code will only set the "local-mac-address" property in-place,
983 * which means that it needs to exist and have space for the 6-byte address.
984 * This ensures that the operation is non-destructive and does not invalidate
985 * offsets that other drivers may be using.
986 *
987 * @param fdt FDT blob
988 * @param mac buffer containing the MAC address to set
989 * @param size size of MAC address
990 * Return: 0 on success or a negative error code on failure
991 */
992int fdtdec_set_ethernet_mac_address(void *fdt, const u8 *mac, size_t size);
993
994/**
995 * fdtdec_set_phandle() - sets the phandle of a given node
996 *
997 * @param blob		FDT blob
998 * @param node		offset in the FDT blob of the node whose phandle is to
999 *			be set
1000 * @param phandle	phandle to set for the given node
1001 * Return: 0 on success or a negative error code on failure
1002 */
1003static inline int fdtdec_set_phandle(void *blob, int node, uint32_t phandle)
1004{
1005	return fdt_setprop_u32(blob, node, "phandle", phandle);
1006}
1007
1008/* add "no-map" property */
1009#define FDTDEC_RESERVED_MEMORY_NO_MAP (1 << 0)
1010
1011/**
1012 * fdtdec_add_reserved_memory() - add or find a reserved-memory node
1013 *
1014 * If a reserved-memory node already exists for the given carveout, a phandle
1015 * for that node will be returned. Otherwise a new node will be created and a
1016 * phandle corresponding to it will be returned.
1017 *
1018 * See Documentation/devicetree/bindings/reserved-memory/reserved-memory.txt
1019 * for details on how to use reserved memory regions.
1020 *
1021 * As an example, consider the following code snippet:
1022 *
1023 *     struct fdt_memory fb = {
1024 *         .start = 0x92cb3000,
1025 *         .end = 0x934b2fff,
1026 *     };
1027 *     uint32_t phandle;
1028 *
1029 *     fdtdec_add_reserved_memory(fdt, "framebuffer", &fb, NULL, 0, &phandle,
1030 *                                0);
1031 *
1032 * This results in the following subnode being added to the top-level
1033 * /reserved-memory node:
1034 *
1035 *     reserved-memory {
1036 *         #address-cells = <0x00000002>;
1037 *         #size-cells = <0x00000002>;
1038 *         ranges;
1039 *
1040 *         framebuffer@92cb3000 {
1041 *             reg = <0x00000000 0x92cb3000 0x00000000 0x00800000>;
1042 *             phandle = <0x0000004d>;
1043 *         };
1044 *     };
1045 *
1046 * If the top-level /reserved-memory node does not exist, it will be created.
1047 * The phandle returned from the function call can be used to reference this
1048 * reserved memory region from other nodes.
1049 *
1050 * See fdtdec_set_carveout() for a more elaborate example.
1051 *
1052 * @param blob		FDT blob
1053 * @param basename	base name of the node to create
1054 * @param carveout	information about the carveout region
1055 * @param compatibles	list of compatible strings for the carveout region
1056 * @param count		number of compatible strings for the carveout region
1057 * @param phandlep	return location for the phandle of the carveout region
1058 *			can be NULL if no phandle should be added
1059 * @param flags		bitmask of flags to set for the carveout region
1060 * Return: 0 on success or a negative error code on failure
1061 */
1062int fdtdec_add_reserved_memory(void *blob, const char *basename,
1063			       const struct fdt_memory *carveout,
1064			       const char **compatibles, unsigned int count,
1065			       uint32_t *phandlep, unsigned long flags);
1066
1067/**
1068 * fdtdec_get_carveout() - reads a carveout from an FDT
1069 *
1070 * Reads information about a carveout region from an FDT. The carveout is a
1071 * referenced by its phandle that is read from a given property in a given
1072 * node.
1073 *
1074 * @param blob		FDT blob
1075 * @param node		name of a node
1076 * @param prop_name	name of the property in the given node that contains
1077 *			the phandle for the carveout
1078 * @param index		index of the phandle for which to read the carveout
1079 * @param carveout	return location for the carveout information
1080 * @param name		return location for the carveout name
1081 * @param compatiblesp	return location for compatible strings
1082 * @param countp	return location for the number of compatible strings
1083 * @param flags		return location for the flags of the carveout
1084 * Return: 0 on success or a negative error code on failure
1085 */
1086int fdtdec_get_carveout(const void *blob, const char *node,
1087			const char *prop_name, unsigned int index,
1088			struct fdt_memory *carveout, const char **name,
1089			const char ***compatiblesp, unsigned int *countp,
1090			unsigned long *flags);
1091
1092/**
1093 * fdtdec_set_carveout() - sets a carveout region for a given node
1094 *
1095 * Sets a carveout region for a given node. If a reserved-memory node already
1096 * exists for the carveout, the phandle for that node will be reused. If no
1097 * such node exists, a new one will be created and a phandle to it stored in
1098 * a specified property of the given node.
1099 *
1100 * As an example, consider the following code snippet:
1101 *
1102 *     const char *node = "/host1x@50000000/dc@54240000";
1103 *     struct fdt_memory fb = {
1104 *         .start = 0x92cb3000,
1105 *         .end = 0x934b2fff,
1106 *     };
1107 *
1108 *     fdtdec_set_carveout(fdt, node, "memory-region", 0, "framebuffer", NULL,
1109 *                         0, &fb, 0);
1110 *
1111 * dc@54200000 is a display controller and was set up by the bootloader to
1112 * scan out the framebuffer specified by "fb". This would cause the following
1113 * reserved memory region to be added:
1114 *
1115 *     reserved-memory {
1116 *         #address-cells = <0x00000002>;
1117 *         #size-cells = <0x00000002>;
1118 *         ranges;
1119 *
1120 *         framebuffer@92cb3000 {
1121 *             reg = <0x00000000 0x92cb3000 0x00000000 0x00800000>;
1122 *             phandle = <0x0000004d>;
1123 *         };
1124 *     };
1125 *
1126 * A "memory-region" property will also be added to the node referenced by the
1127 * offset parameter.
1128 *
1129 *     host1x@50000000 {
1130 *         ...
1131 *
1132 *         dc@54240000 {
1133 *             ...
1134 *             memory-region = <0x0000004d>;
1135 *             ...
1136 *         };
1137 *
1138 *         ...
1139 *     };
1140 *
1141 * @param blob		FDT blob
1142 * @param node		name of the node to add the carveout to
1143 * @param prop_name	name of the property in which to store the phandle of
1144 *			the carveout
1145 * @param index		index of the phandle to store
1146 * @param carveout	information about the carveout to add
1147 * @param name		base name of the reserved-memory node to create
1148 * @param compatibles	compatible strings to set for the carveout
1149 * @param count		number of compatible strings
1150 * @param flags		bitmask of flags to set for the carveout
1151 * Return: 0 on success or a negative error code on failure
1152 */
1153int fdtdec_set_carveout(void *blob, const char *node, const char *prop_name,
1154			unsigned int index, const struct fdt_memory *carveout,
1155			const char *name, const char **compatibles,
1156			unsigned int count, unsigned long flags);
1157
1158/**
1159 * Set up the device tree ready for use
1160 */
1161int fdtdec_setup(void);
1162
1163/**
1164 * Perform board-specific early DT adjustments
1165 */
1166int fdtdec_board_setup(const void *fdt_blob);
1167
1168/**
1169 * fdtdec_resetup()  - Set up the device tree again
1170 *
1171 * The main difference with fdtdec_setup() is that it returns if the fdt has
1172 * changed because a better match has been found.
1173 * This is typically used for boards that rely on a DM driver to detect the
1174 * board type. This function sould be called by the board code after the stuff
1175 * needed by board_fit_config_name_match() to operate porperly is available.
1176 * If this functions signals that a rescan is necessary, the board code must
1177 * unbind all the drivers using dm_uninit() and then rescan the DT with
1178 * dm_init_and_scan().
1179 *
1180 * @param rescan Returns a flag indicating that fdt has changed and rescanning
1181 *               the fdt is required
1182 *
1183 * Return: 0 if OK, -ve on error
1184 */
1185int fdtdec_resetup(int *rescan);
1186
1187/**
1188 * Board-specific FDT initialization. Returns the address to a device tree blob.
1189 *
1190 * Called when CONFIG_OF_BOARD is defined.
1191 *
1192 * The existing devicetree is available at gd->fdt_blob
1193 *
1194 * @err: 0 on success, -EEXIST if the devicetree is already correct, or other
1195 * internal error code if we fail to setup a DTB
1196 * @returns new devicetree blob pointer
1197 */
1198void *board_fdt_blob_setup(int *err);
1199
1200/*
1201 * Decode the size of memory
1202 *
1203 * RAM size is normally set in a /memory node and consists of a list of
1204 * (base, size) cells in the 'reg' property. This information is used to
1205 * determine the total available memory as well as the address and size
1206 * of each bank.
1207 *
1208 * Optionally the memory configuration can vary depending on a board id,
1209 * typically read from strapping resistors or an EEPROM on the board.
1210 *
1211 * Finally, memory size can be detected (within certain limits) by probing
1212 * the available memory. It is safe to do so within the limits provides by
1213 * the board's device tree information. This makes it possible to produce
1214 * boards with different memory sizes, where the device tree specifies the
1215 * maximum memory configuration, and the smaller memory configuration is
1216 * probed.
1217 *
1218 * This function decodes that information, returning the memory base address,
1219 * size and bank information. See the memory.txt binding for full
1220 * documentation.
1221 *
1222 * @param blob		Device tree blob
1223 * @param area		Name of node to check (NULL means "/memory")
1224 * @param board_id	Board ID to look up
1225 * @param basep		Returns base address of first memory bank (NULL to
1226 *			ignore)
1227 * @param sizep		Returns total memory size (NULL to ignore)
1228 * @param bd		Updated with the memory bank information (NULL to skip)
1229 * Return: 0 if OK, -ve on error
1230 */
1231int fdtdec_decode_ram_size(const void *blob, const char *area, int board_id,
1232			   phys_addr_t *basep, phys_size_t *sizep,
1233			   struct bd_info *bd);
1234
1235/**
1236 * fdtdec_get_srcname() - Get the name of where the devicetree comes from
1237 *
1238 * Return: source name
1239 */
1240const char *fdtdec_get_srcname(void);
1241
1242#endif
1243