blob: 2b77058a73351dec2842e779d35d04dafaf4c5e1 [file] [log] [blame]
Grant Likelyd8678b52009-10-15 10:57:53 -06001/*
2 * Definitions for working with the Flattened Device Tree data format
3 *
4 * Copyright 2009 Benjamin Herrenschmidt, IBM Corp
5 * benh@kernel.crashing.org
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * version 2 as published by the Free Software Foundation.
10 */
11
12#ifndef _LINUX_OF_FDT_H
13#define _LINUX_OF_FDT_H
14
Grant Likely8482f562009-10-15 10:58:04 -060015#include <linux/types.h>
16#include <linux/init.h>
17
Grant Likelyd8678b52009-10-15 10:57:53 -060018/* Definitions used by the flattened device tree */
19#define OF_DT_HEADER 0xd00dfeed /* marker */
20#define OF_DT_BEGIN_NODE 0x1 /* Start of node, full name */
21#define OF_DT_END_NODE 0x2 /* End node */
22#define OF_DT_PROP 0x3 /* Property: name off, size,
23 * content */
24#define OF_DT_NOP 0x4 /* nop */
25#define OF_DT_END 0x9
26
27#define OF_DT_VERSION 0x10
28
Grant Likelyd45d94f2009-10-15 10:57:55 -060029#ifndef __ASSEMBLY__
30/*
31 * This is what gets passed to the kernel by prom_init or kexec
32 *
33 * The dt struct contains the device tree structure, full pathes and
34 * property contents. The dt strings contain a separate block with just
35 * the strings for the property names, and is fully page aligned and
36 * self contained in a page, so that it can be kept around by the kernel,
37 * each property name appears only once in this page (cheap compression)
38 *
39 * the mem_rsvmap contains a map of reserved ranges of physical memory,
40 * passing it here instead of in the device-tree itself greatly simplifies
41 * the job of everybody. It's just a list of u64 pairs (base/size) that
42 * ends when size is 0
43 */
44struct boot_param_header {
Jeremy Kerr087f79c2010-01-30 04:14:19 -070045 __be32 magic; /* magic word OF_DT_HEADER */
46 __be32 totalsize; /* total size of DT block */
47 __be32 off_dt_struct; /* offset to structure */
48 __be32 off_dt_strings; /* offset to strings */
49 __be32 off_mem_rsvmap; /* offset to memory reserve map */
50 __be32 version; /* format version */
51 __be32 last_comp_version; /* last compatible version */
Grant Likelyd45d94f2009-10-15 10:57:55 -060052 /* version 2 fields below */
Jeremy Kerr087f79c2010-01-30 04:14:19 -070053 __be32 boot_cpuid_phys; /* Physical CPU id we're booting on */
Grant Likelyd45d94f2009-10-15 10:57:55 -060054 /* version 3 fields below */
Jeremy Kerr087f79c2010-01-30 04:14:19 -070055 __be32 dt_strings_size; /* size of the DT strings block */
Grant Likelyd45d94f2009-10-15 10:57:55 -060056 /* version 17 fields below */
Jeremy Kerr087f79c2010-01-30 04:14:19 -070057 __be32 dt_struct_size; /* size of the DT structure block */
Grant Likelyd45d94f2009-10-15 10:57:55 -060058};
59
Grant Likelycf32eb82010-04-13 16:12:25 -070060#if defined(CONFIG_OF_FLATTREE)
Stephen Neuendorffer9706a362010-11-18 15:54:59 -080061
Grant Likelya0817482011-01-08 21:42:42 -070062struct device_node;
63
Stephen Neuendorffer9706a362010-11-18 15:54:59 -080064/* For scanning an arbitrary device-tree at any time */
65extern char *of_fdt_get_string(struct boot_param_header *blob, u32 offset);
66extern void *of_fdt_get_property(struct boot_param_header *blob,
67 unsigned long node,
68 const char *name,
69 unsigned long *size);
70extern int of_fdt_is_compatible(struct boot_param_header *blob,
71 unsigned long node,
72 const char *compat);
Grant Likelya4f740c2010-10-30 11:49:09 -040073extern int of_fdt_match(struct boot_param_header *blob, unsigned long node,
Uwe Kleine-König7b482c82011-12-20 22:56:45 +010074 const char *const *compat);
Stephen Neuendorfferfe140422010-11-18 15:55:02 -080075extern void of_fdt_unflatten_tree(unsigned long *blob,
76 struct device_node **mynodes);
Stephen Neuendorffer9706a362010-11-18 15:54:59 -080077
Grant Likelye169cfb2009-11-23 14:53:09 -070078/* TBD: Temporary export of fdt globals - remove when code fully merged */
Grant Likelyf00abd92009-11-24 03:27:10 -070079extern int __initdata dt_root_addr_cells;
80extern int __initdata dt_root_size_cells;
Grant Likelye169cfb2009-11-23 14:53:09 -070081extern struct boot_param_header *initial_boot_params;
82
Grant Likely8482f562009-10-15 10:58:04 -060083/* For scanning the flat device-tree at boot time */
Grant Likelye169cfb2009-11-23 14:53:09 -070084extern char *find_flat_dt_string(u32 offset);
Grant Likely31a6a872009-11-23 19:49:38 -070085extern int of_scan_flat_dt(int (*it)(unsigned long node, const char *uname,
86 int depth, void *data),
87 void *data);
88extern void *of_get_flat_dt_prop(unsigned long node, const char *name,
89 unsigned long *size);
90extern int of_flat_dt_is_compatible(unsigned long node, const char *name);
Uwe Kleine-König7b482c82011-12-20 22:56:45 +010091extern int of_flat_dt_match(unsigned long node, const char *const *matches);
Grant Likely31a6a872009-11-23 19:49:38 -070092extern unsigned long of_get_flat_dt_root(void);
Marek Szyprowski57d74bc2013-08-26 14:41:56 +020093extern int of_scan_flat_dt_by_path(const char *path,
94 int (*it)(unsigned long node, const char *name, int depth, void *data),
95 void *data);
Grant Likely32c97682010-10-20 11:45:14 -060096
Grant Likely86e03222009-12-10 23:42:21 -070097extern int early_init_dt_scan_chosen(unsigned long node, const char *uname,
98 int depth, void *data);
Grant Likely51975db2010-02-01 21:34:14 -070099extern int early_init_dt_scan_memory(unsigned long node, const char *uname,
100 int depth, void *data);
101extern void early_init_dt_add_memory_arch(u64 base, u64 size);
Grant Likelyfe55c182011-08-04 10:27:32 +0100102extern void * early_init_dt_alloc_memory_arch(u64 size, u64 align);
Jeremy Kerr2e89e682010-01-30 01:41:49 -0700103extern u64 dt_mem_next_cell(int s, __be32 **cellp);
Grant Likely8482f562009-10-15 10:58:04 -0600104
Grant Likelyf00abd92009-11-24 03:27:10 -0700105/* Early flat tree scan hooks */
106extern int early_init_dt_scan_root(unsigned long node, const char *uname,
107 int depth, void *data);
108
Rob Herring0288ffcb2013-08-26 09:47:40 -0500109extern bool early_init_dt_scan(void *params);
110
Rob Herring6a903a22013-08-27 21:41:56 -0500111extern const char *of_flat_dt_get_machine_name(void);
112extern const void *of_flat_dt_match_machine(const void *default_match,
113 const void * (*get_next_compat)(const char * const**));
114
Grant Likely82b29282009-10-15 10:58:07 -0600115/* Other Prototypes */
Grant Likely82b29282009-10-15 10:58:07 -0600116extern void unflatten_device_tree(void);
Rob Herringa8bf7522013-08-26 11:22:45 -0500117extern void unflatten_and_copy_device_tree(void);
Grant Likely82b29282009-10-15 10:58:07 -0600118extern void early_init_devtree(void *);
Kevin Haob27652d2013-12-24 15:12:08 +0800119extern void early_get_first_memblock_info(void *, phys_addr_t *);
Grant Likely8bfe9b52010-04-13 16:12:26 -0700120#else /* CONFIG_OF_FLATTREE */
Rob Herring6a903a22013-08-27 21:41:56 -0500121static inline const char *of_flat_dt_get_machine_name(void) { return NULL; }
Grant Likely8bfe9b52010-04-13 16:12:26 -0700122static inline void unflatten_device_tree(void) {}
Rob Herringa8bf7522013-08-26 11:22:45 -0500123static inline void unflatten_and_copy_device_tree(void) {}
Grant Likelycf32eb82010-04-13 16:12:25 -0700124#endif /* CONFIG_OF_FLATTREE */
Grant Likely82b29282009-10-15 10:58:07 -0600125
Grant Likelyd45d94f2009-10-15 10:57:55 -0600126#endif /* __ASSEMBLY__ */
Grant Likelyd8678b52009-10-15 10:57:53 -0600127#endif /* _LINUX_OF_FDT_H */