xref: /qemu/include/system/device_tree.h (revision 6d79566ae6592056bbba106e6544a5746c741f15)
1 /*
2  * Header with function prototypes to help device tree manipulation using
3  * libfdt. It also provides functions to read entries from device tree proc
4  * interface.
5  *
6  * Copyright 2008 IBM Corporation.
7  * Authors: Jerone Young <jyoung5@us.ibm.com>
8  *          Hollis Blanchard <hollisb@us.ibm.com>
9  *
10  * This work is licensed under the GNU GPL license version 2 or later.
11  *
12  */
13 
14 #ifndef __DEVICE_TREE_H__
15 #define __DEVICE_TREE_H__
16 
17 void *create_device_tree(int *sizep);
18 void *load_device_tree(const char *filename_path, int *sizep);
19 #ifdef CONFIG_LINUX
20 /**
21  * load_device_tree_from_sysfs: reads the device tree information in the
22  * /proc/device-tree directory and return the corresponding binary blob
23  * buffer pointer. Asserts in case of error.
24  */
25 void *load_device_tree_from_sysfs(void);
26 #endif
27 
28 /**
29  * qemu_fdt_node_path: return the paths of nodes matching a given
30  * name and compat string
31  * @fdt: pointer to the dt blob
32  * @name: node name
33  * @compat: compatibility string
34  * @errp: handle to an error object
35  *
36  * returns a newly allocated NULL-terminated array of node paths.
37  * Use g_strfreev() to free it. If one or more nodes were found, the
38  * array contains the path of each node and the last element equals to
39  * NULL. If there is no error but no matching node was found, the
40  * returned array contains a single element equal to NULL. If an error
41  * was encountered when parsing the blob, the function returns NULL
42  */
43 char **qemu_fdt_node_path(void *fdt, const char *name, char *compat,
44                           Error **errp);
45 
46 int qemu_fdt_setprop(void *fdt, const char *node_path,
47                      const char *property, const void *val, int size);
48 int qemu_fdt_setprop_cell(void *fdt, const char *node_path,
49                           const char *property, uint32_t val);
50 int qemu_fdt_setprop_u64(void *fdt, const char *node_path,
51                          const char *property, uint64_t val);
52 int qemu_fdt_setprop_string(void *fdt, const char *node_path,
53                             const char *property, const char *string);
54 int qemu_fdt_setprop_phandle(void *fdt, const char *node_path,
55                              const char *property,
56                              const char *target_node_path);
57 const void *qemu_fdt_getprop(void *fdt, const char *node_path,
58                              const char *property, int *lenp);
59 uint32_t qemu_fdt_getprop_cell(void *fdt, const char *node_path,
60                                const char *property);
61 uint32_t qemu_fdt_get_phandle(void *fdt, const char *path);
62 uint32_t qemu_fdt_alloc_phandle(void *fdt);
63 int qemu_fdt_nop_node(void *fdt, const char *node_path);
64 int qemu_fdt_add_subnode(void *fdt, const char *name);
65 
66 #define qemu_fdt_setprop_cells(fdt, node_path, property, ...)                 \
67     do {                                                                      \
68         uint32_t qdt_tmp[] = { __VA_ARGS__ };                                 \
69         int i;                                                                \
70                                                                               \
71         for (i = 0; i < ARRAY_SIZE(qdt_tmp); i++) {                           \
72             qdt_tmp[i] = cpu_to_be32(qdt_tmp[i]);                             \
73         }                                                                     \
74         qemu_fdt_setprop(fdt, node_path, property, qdt_tmp,                   \
75                          sizeof(qdt_tmp));                                    \
76     } while (0)
77 
78 void qemu_fdt_dumpdtb(void *fdt, int size);
79 
80 /**
81  * qemu_fdt_setprop_sized_cells_from_array:
82  * @fdt: device tree blob
83  * @node_path: node to set property on
84  * @property: property to set
85  * @numvalues: number of values
86  * @values: array of number-of-cells, value pairs
87  *
88  * Set the specified property on the specified node in the device tree
89  * to be an array of cells. The values of the cells are specified via
90  * the values list, which alternates between "number of cells used by
91  * this value" and "value".
92  * number-of-cells must be either 1 or 2 (other values will result in
93  * an error being returned). If a value is too large to fit in the
94  * number of cells specified for it, an error is returned.
95  *
96  * This function is useful because device tree nodes often have cell arrays
97  * which are either lists of addresses or lists of address,size tuples, but
98  * the number of cells used for each element vary depending on the
99  * #address-cells and #size-cells properties of their parent node.
100  * If you know all your cell elements are one cell wide you can use the
101  * simpler qemu_fdt_setprop_cells(). If you're not setting up the
102  * array programmatically, qemu_fdt_setprop_sized_cells may be more
103  * convenient.
104  *
105  * Return value: 0 on success, <0 on error.
106  */
107 int qemu_fdt_setprop_sized_cells_from_array(void *fdt,
108                                             const char *node_path,
109                                             const char *property,
110                                             int numvalues,
111                                             uint64_t *values);
112 
113 /**
114  * qemu_fdt_setprop_sized_cells:
115  * @fdt: device tree blob
116  * @node_path: node to set property on
117  * @property: property to set
118  * @...: list of number-of-cells, value pairs
119  *
120  * Set the specified property on the specified node in the device tree
121  * to be an array of cells. The values of the cells are specified via
122  * the variable arguments, which alternates between "number of cells
123  * used by this value" and "value".
124  *
125  * This is a convenience wrapper for the function
126  * qemu_fdt_setprop_sized_cells_from_array().
127  *
128  * Return value: 0 on success, <0 on error.
129  */
130 #define qemu_fdt_setprop_sized_cells(fdt, node_path, property, ...)       \
131     ({                                                                    \
132         uint64_t qdt_tmp[] = { __VA_ARGS__ };                             \
133         qemu_fdt_setprop_sized_cells_from_array(fdt, node_path,           \
134                                                 property,                 \
135                                                 ARRAY_SIZE(qdt_tmp) / 2,  \
136                                                 qdt_tmp);                 \
137     })
138 
139 #define FDT_PCI_RANGE_RELOCATABLE          0x80000000
140 #define FDT_PCI_RANGE_PREFETCHABLE         0x40000000
141 #define FDT_PCI_RANGE_ALIASED              0x20000000
142 #define FDT_PCI_RANGE_TYPE_MASK            0x03000000
143 #define FDT_PCI_RANGE_MMIO_64BIT           0x03000000
144 #define FDT_PCI_RANGE_MMIO                 0x02000000
145 #define FDT_PCI_RANGE_IOPORT               0x01000000
146 #define FDT_PCI_RANGE_CONFIG               0x00000000
147 
148 #endif /* __DEVICE_TREE_H__ */
149