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 /** 58 * qemu_fdt_getprop: retrieve the value of a given property 59 * @fdt: pointer to the device tree blob 60 * @node_path: node path 61 * @property: name of the property to find 62 * @lenp: fdt error if any or length of the property on success 63 * @errp: handle to an error object 64 * 65 * returns a pointer to the property on success and NULL on failure 66 */ 67 const void *qemu_fdt_getprop(void *fdt, const char *node_path, 68 const char *property, int *lenp, 69 Error **errp); 70 uint32_t qemu_fdt_getprop_cell(void *fdt, const char *node_path, 71 const char *property); 72 uint32_t qemu_fdt_get_phandle(void *fdt, const char *path); 73 uint32_t qemu_fdt_alloc_phandle(void *fdt); 74 int qemu_fdt_nop_node(void *fdt, const char *node_path); 75 int qemu_fdt_add_subnode(void *fdt, const char *name); 76 77 #define qemu_fdt_setprop_cells(fdt, node_path, property, ...) \ 78 do { \ 79 uint32_t qdt_tmp[] = { __VA_ARGS__ }; \ 80 int i; \ 81 \ 82 for (i = 0; i < ARRAY_SIZE(qdt_tmp); i++) { \ 83 qdt_tmp[i] = cpu_to_be32(qdt_tmp[i]); \ 84 } \ 85 qemu_fdt_setprop(fdt, node_path, property, qdt_tmp, \ 86 sizeof(qdt_tmp)); \ 87 } while (0) 88 89 void qemu_fdt_dumpdtb(void *fdt, int size); 90 91 /** 92 * qemu_fdt_setprop_sized_cells_from_array: 93 * @fdt: device tree blob 94 * @node_path: node to set property on 95 * @property: property to set 96 * @numvalues: number of values 97 * @values: array of number-of-cells, value pairs 98 * 99 * Set the specified property on the specified node in the device tree 100 * to be an array of cells. The values of the cells are specified via 101 * the values list, which alternates between "number of cells used by 102 * this value" and "value". 103 * number-of-cells must be either 1 or 2 (other values will result in 104 * an error being returned). If a value is too large to fit in the 105 * number of cells specified for it, an error is returned. 106 * 107 * This function is useful because device tree nodes often have cell arrays 108 * which are either lists of addresses or lists of address,size tuples, but 109 * the number of cells used for each element vary depending on the 110 * #address-cells and #size-cells properties of their parent node. 111 * If you know all your cell elements are one cell wide you can use the 112 * simpler qemu_fdt_setprop_cells(). If you're not setting up the 113 * array programmatically, qemu_fdt_setprop_sized_cells may be more 114 * convenient. 115 * 116 * Return value: 0 on success, <0 on error. 117 */ 118 int qemu_fdt_setprop_sized_cells_from_array(void *fdt, 119 const char *node_path, 120 const char *property, 121 int numvalues, 122 uint64_t *values); 123 124 /** 125 * qemu_fdt_setprop_sized_cells: 126 * @fdt: device tree blob 127 * @node_path: node to set property on 128 * @property: property to set 129 * @...: list of number-of-cells, value pairs 130 * 131 * Set the specified property on the specified node in the device tree 132 * to be an array of cells. The values of the cells are specified via 133 * the variable arguments, which alternates between "number of cells 134 * used by this value" and "value". 135 * 136 * This is a convenience wrapper for the function 137 * qemu_fdt_setprop_sized_cells_from_array(). 138 * 139 * Return value: 0 on success, <0 on error. 140 */ 141 #define qemu_fdt_setprop_sized_cells(fdt, node_path, property, ...) \ 142 ({ \ 143 uint64_t qdt_tmp[] = { __VA_ARGS__ }; \ 144 qemu_fdt_setprop_sized_cells_from_array(fdt, node_path, \ 145 property, \ 146 ARRAY_SIZE(qdt_tmp) / 2, \ 147 qdt_tmp); \ 148 }) 149 150 #define FDT_PCI_RANGE_RELOCATABLE 0x80000000 151 #define FDT_PCI_RANGE_PREFETCHABLE 0x40000000 152 #define FDT_PCI_RANGE_ALIASED 0x20000000 153 #define FDT_PCI_RANGE_TYPE_MASK 0x03000000 154 #define FDT_PCI_RANGE_MMIO_64BIT 0x03000000 155 #define FDT_PCI_RANGE_MMIO 0x02000000 156 #define FDT_PCI_RANGE_IOPORT 0x01000000 157 #define FDT_PCI_RANGE_CONFIG 0x00000000 158 159 #endif /* __DEVICE_TREE_H__ */ 160