[mirror_qemu.git] / include / sysemu / device_tree.h

/*
 * Header with function prototypes to help device tree manipulation using
 * libfdt. It also provides functions to read entries from device tree proc
 * interface.
 *
 * Copyright 2008 IBM Corporation.
 * Authors: Jerone Young <jyoung5@us.ibm.com>
 *          Hollis Blanchard <hollisb@us.ibm.com>
 *
 * This work is licensed under the GNU GPL license version 2 or later.
 *
 */

#ifndef DEVICE_TREE_H
#define DEVICE_TREE_H

void *create_device_tree(int *sizep);
void *load_device_tree(const char *filename_path, int *sizep);
#ifdef CONFIG_LINUX
/**
 * load_device_tree_from_sysfs: reads the device tree information in the
 * /proc/device-tree directory and return the corresponding binary blob
 * buffer pointer. Asserts in case of error.
 */
void *load_device_tree_from_sysfs(void);
#endif

/**
 * qemu_fdt_node_path: return the paths of nodes matching a given
 * name and compat string
 * @fdt: pointer to the dt blob
 * @name: node name
 * @compat: compatibility string
 * @errp: handle to an error object
 *
 * returns a newly allocated NULL-terminated array of node paths.
 * Use g_strfreev() to free it. If one or more nodes were found, the
 * array contains the path of each node and the last element equals to
 * NULL. If there is no error but no matching node was found, the
 * returned array contains a single element equal to NULL. If an error
 * was encountered when parsing the blob, the function returns NULL
 *
 * @name may be NULL to wildcard names and only match compatibility
 * strings.
 */
char **qemu_fdt_node_path(void *fdt, const char *name, const char *compat,
                          Error **errp);

/**
 * qemu_fdt_node_unit_path: return the paths of nodes matching a given
 * node-name, ie. node-name and node-name@unit-address
 * @fdt: pointer to the dt blob
 * @name: node name
 * @errp: handle to an error object
 *
 * returns a newly allocated NULL-terminated array of node paths.
 * Use g_strfreev() to free it. If one or more nodes were found, the
 * array contains the path of each node and the last element equals to
 * NULL. If there is no error but no matching node was found, the
 * returned array contains a single element equal to NULL. If an error
 * was encountered when parsing the blob, the function returns NULL
 */
char **qemu_fdt_node_unit_path(void *fdt, const char *name, Error **errp);

int qemu_fdt_setprop(void *fdt, const char *node_path,
                     const char *property, const void *val, int size);
int qemu_fdt_setprop_cell(void *fdt, const char *node_path,
                          const char *property, uint32_t val);
int qemu_fdt_setprop_u64(void *fdt, const char *node_path,
                         const char *property, uint64_t val);
int qemu_fdt_setprop_string(void *fdt, const char *node_path,
                            const char *property, const char *string);

/**
 * qemu_fdt_setprop_string_array: set a string array property
 *
 * @fdt: pointer to the dt blob
 * @name: node name
 * @prop: property array
 * @array: pointer to an array of string pointers
 * @len: length of array
 *
 * assigns a string array to a property. This function converts and
 * array of strings to a sequential string with \0 separators before
 * setting the property.
 */
int qemu_fdt_setprop_string_array(void *fdt, const char *node_path,
                                  const char *prop, char **array, int len);

int qemu_fdt_setprop_phandle(void *fdt, const char *node_path,
                             const char *property,
                             const char *target_node_path);
/**
 * qemu_fdt_getprop: retrieve the value of a given property
 * @fdt: pointer to the device tree blob
 * @node_path: node path
 * @property: name of the property to find
 * @lenp: fdt error if any or length of the property on success
 * @errp: handle to an error object
 *
 * returns a pointer to the property on success and NULL on failure
 */
const void *qemu_fdt_getprop(void *fdt, const char *node_path,
                             const char *property, int *lenp,
                             Error **errp);
/**
 * qemu_fdt_getprop_cell: retrieve the value of a given 4 byte property
 * @fdt: pointer to the device tree blob
 * @node_path: node path
 * @property: name of the property to find
 * @lenp: fdt error if any or -EINVAL if the property size is different from
 *        4 bytes, or 4 (expected length of the property) upon success.
 * @errp: handle to an error object
 *
 * returns the property value on success
 */
uint32_t qemu_fdt_getprop_cell(void *fdt, const char *node_path,
                               const char *property, int *lenp,
                               Error **errp);
uint32_t qemu_fdt_get_phandle(void *fdt, const char *path);
uint32_t qemu_fdt_alloc_phandle(void *fdt);
int qemu_fdt_nop_node(void *fdt, const char *node_path);
int qemu_fdt_add_subnode(void *fdt, const char *name);
int qemu_fdt_add_path(void *fdt, const char *path);

#define qemu_fdt_setprop_cells(fdt, node_path, property, ...)                 \
    do {                                                                      \
        uint32_t qdt_tmp[] = { __VA_ARGS__ };                                 \
        int i;                                                                \
                                                                              \
        for (i = 0; i < ARRAY_SIZE(qdt_tmp); i++) {                           \
            qdt_tmp[i] = cpu_to_be32(qdt_tmp[i]);                             \
        }                                                                     \
        qemu_fdt_setprop(fdt, node_path, property, qdt_tmp,                   \
                         sizeof(qdt_tmp));                                    \
    } while (0)

void qemu_fdt_dumpdtb(void *fdt, int size);

/**
 * qemu_fdt_setprop_sized_cells_from_array:
 * @fdt: device tree blob
 * @node_path: node to set property on
 * @property: property to set
 * @numvalues: number of values
 * @values: array of number-of-cells, value pairs
 *
 * Set the specified property on the specified node in the device tree
 * to be an array of cells. The values of the cells are specified via
 * the values list, which alternates between "number of cells used by
 * this value" and "value".
 * number-of-cells must be either 1 or 2 (other values will result in
 * an error being returned). If a value is too large to fit in the
 * number of cells specified for it, an error is returned.
 *
 * This function is useful because device tree nodes often have cell arrays
 * which are either lists of addresses or lists of address,size tuples, but
 * the number of cells used for each element vary depending on the
 * #address-cells and #size-cells properties of their parent node.
 * If you know all your cell elements are one cell wide you can use the
 * simpler qemu_fdt_setprop_cells(). If you're not setting up the
 * array programmatically, qemu_fdt_setprop_sized_cells may be more
 * convenient.
 *
 * Return value: 0 on success, <0 on error.
 */
int qemu_fdt_setprop_sized_cells_from_array(void *fdt,
                                            const char *node_path,
                                            const char *property,
                                            int numvalues,
                                            uint64_t *values);

/**
 * qemu_fdt_setprop_sized_cells:
 * @fdt: device tree blob
 * @node_path: node to set property on
 * @property: property to set
 * @...: list of number-of-cells, value pairs
 *
 * Set the specified property on the specified node in the device tree
 * to be an array of cells. The values of the cells are specified via
 * the variable arguments, which alternates between "number of cells
 * used by this value" and "value".
 *
 * This is a convenience wrapper for the function
 * qemu_fdt_setprop_sized_cells_from_array().
 *
 * Return value: 0 on success, <0 on error.
 */
#define qemu_fdt_setprop_sized_cells(fdt, node_path, property, ...)       \
    ({                                                                    \
        uint64_t qdt_tmp[] = { __VA_ARGS__ };                             \
        qemu_fdt_setprop_sized_cells_from_array(fdt, node_path,           \
                                                property,                 \
                                                ARRAY_SIZE(qdt_tmp) / 2,  \
                                                qdt_tmp);                 \
    })

#define FDT_PCI_RANGE_RELOCATABLE          0x80000000
#define FDT_PCI_RANGE_PREFETCHABLE         0x40000000
#define FDT_PCI_RANGE_ALIASED              0x20000000
#define FDT_PCI_RANGE_TYPE_MASK            0x03000000
#define FDT_PCI_RANGE_MMIO_64BIT           0x03000000
#define FDT_PCI_RANGE_MMIO                 0x02000000
#define FDT_PCI_RANGE_IOPORT               0x01000000
#define FDT_PCI_RANGE_CONFIG               0x00000000

#endif /* DEVICE_TREE_H */
Commit	Line	Data
f652e6af AJ	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
2a6a4076 MA	14	#ifndef DEVICE_TREE_H
2a6a4076 MA	15	#define DEVICE_TREE_H
f652e6af	16
ce36252c	17	void create_device_tree(int sizep);
7ec632b4	18	void load_device_tree(const char filename_path, int *sizep);
60e43e98 EA	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
f652e6af	27
6d79566a EA	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
80972d3b EI	42	*
	43	* @name may be NULL to wildcard names and only match compatibility
	44	* strings.
6d79566a	45	*/
958bae18	46	char *qemu_fdt_node_path(void fdt, const char name, const char compat,
6d79566a EA	47	Error **errp);
6d79566a EA	48
f963cc26 EA	49	/**
	50	* qemu_fdt_node_unit_path: return the paths of nodes matching a given
	51	* node-name, ie. node-name and node-name@unit-address
	52	* @fdt: pointer to the dt blob
	53	* @name: node name
	54	* @errp: handle to an error object
	55	*
	56	* returns a newly allocated NULL-terminated array of node paths.
	57	* Use g_strfreev() to free it. If one or more nodes were found, the
	58	* array contains the path of each node and the last element equals to
	59	* NULL. If there is no error but no matching node was found, the
	60	* returned array contains a single element equal to NULL. If an error
	61	* was encountered when parsing the blob, the function returns NULL
	62	*/
	63	char *qemu_fdt_node_unit_path(void fdt, const char name, Error *errp);
	64
5a4348d1	65	int qemu_fdt_setprop(void fdt, const char node_path,
be5907f2	66	const char property, const void val, int size);
5a4348d1 PC	67	int qemu_fdt_setprop_cell(void fdt, const char node_path,
	68	const char *property, uint32_t val);
	69	int qemu_fdt_setprop_u64(void fdt, const char node_path,
	70	const char *property, uint64_t val);
	71	int qemu_fdt_setprop_string(void fdt, const char node_path,
	72	const char property, const char string);
78da6a1b AB	73
	74	/**
	75	* qemu_fdt_setprop_string_array: set a string array property
	76	*
	77	* @fdt: pointer to the dt blob
	78	* @name: node name
	79	* @prop: property array
	80	* @array: pointer to an array of string pointers
	81	* @len: length of array
	82	*
	83	* assigns a string array to a property. This function converts and
	84	* array of strings to a sequential string with \0 separators before
	85	* setting the property.
	86	*/
	87	int qemu_fdt_setprop_string_array(void fdt, const char node_path,
	88	const char prop, char *array, int len);
	89
5a4348d1 PC	90	int qemu_fdt_setprop_phandle(void fdt, const char node_path,
	91	const char *property,
	92	const char *target_node_path);
78e24f23 EA	93	/**
	94	* qemu_fdt_getprop: retrieve the value of a given property
	95	* @fdt: pointer to the device tree blob
	96	* @node_path: node path
	97	* @property: name of the property to find
	98	* @lenp: fdt error if any or length of the property on success
	99	* @errp: handle to an error object
	100	*
	101	* returns a pointer to the property on success and NULL on failure
	102	*/
5a4348d1	103	const void qemu_fdt_getprop(void fdt, const char *node_path,
78e24f23 EA	104	const char property, int lenp,
78e24f23 EA	105	Error **errp);
58e71097 EA	106	/**
	107	* qemu_fdt_getprop_cell: retrieve the value of a given 4 byte property
	108	* @fdt: pointer to the device tree blob
	109	* @node_path: node path
	110	* @property: name of the property to find
	111	* @lenp: fdt error if any or -EINVAL if the property size is different from
	112	* 4 bytes, or 4 (expected length of the property) upon success.
	113	* @errp: handle to an error object
	114	*
	115	* returns the property value on success
	116	*/
5a4348d1	117	uint32_t qemu_fdt_getprop_cell(void fdt, const char node_path,
58e71097 EA	118	const char property, int lenp,
58e71097 EA	119	Error **errp);
5a4348d1 PC	120	uint32_t qemu_fdt_get_phandle(void fdt, const char path);
	121	uint32_t qemu_fdt_alloc_phandle(void *fdt);
	122	int qemu_fdt_nop_node(void fdt, const char node_path);
	123	int qemu_fdt_add_subnode(void fdt, const char name);
b863f0b7	124	int qemu_fdt_add_path(void fdt, const char path);
f652e6af	125
5a4348d1	126	#define qemu_fdt_setprop_cells(fdt, node_path, property, ...) \
7ae2291e AG	127	do { \
	128	uint32_t qdt_tmp[] = { __VA_ARGS__ }; \
	129	int i; \
	130	\
	131	for (i = 0; i < ARRAY_SIZE(qdt_tmp); i++) { \
	132	qdt_tmp[i] = cpu_to_be32(qdt_tmp[i]); \
	133	} \
5a4348d1 PC	134	qemu_fdt_setprop(fdt, node_path, property, qdt_tmp, \
5a4348d1 PC	135	sizeof(qdt_tmp)); \
7ae2291e AG	136	} while (0)
7ae2291e AG	137
5a4348d1	138	void qemu_fdt_dumpdtb(void *fdt, int size);
71193433	139
97c38f8c	140	/**
5a4348d1	141	* qemu_fdt_setprop_sized_cells_from_array:
97c38f8c PM	142	* @fdt: device tree blob
	143	* @node_path: node to set property on
	144	* @property: property to set
	145	* @numvalues: number of values
	146	* @values: array of number-of-cells, value pairs
	147	*
	148	* Set the specified property on the specified node in the device tree
	149	* to be an array of cells. The values of the cells are specified via
	150	* the values list, which alternates between "number of cells used by
	151	* this value" and "value".
	152	* number-of-cells must be either 1 or 2 (other values will result in
	153	* an error being returned). If a value is too large to fit in the
	154	* number of cells specified for it, an error is returned.
	155	*
	156	* This function is useful because device tree nodes often have cell arrays
	157	* which are either lists of addresses or lists of address,size tuples, but
	158	* the number of cells used for each element vary depending on the
	159	* #address-cells and #size-cells properties of their parent node.
	160	* If you know all your cell elements are one cell wide you can use the
5a4348d1 PC	161	* simpler qemu_fdt_setprop_cells(). If you're not setting up the
5a4348d1 PC	162	* array programmatically, qemu_fdt_setprop_sized_cells may be more
97c38f8c PM	163	* convenient.
	164	*
	165	* Return value: 0 on success, <0 on error.
	166	*/
5a4348d1 PC	167	int qemu_fdt_setprop_sized_cells_from_array(void *fdt,
	168	const char *node_path,
	169	const char *property,
	170	int numvalues,
	171	uint64_t *values);
97c38f8c PM	172
97c38f8c PM	173	/**
5a4348d1	174	* qemu_fdt_setprop_sized_cells:
97c38f8c PM	175	* @fdt: device tree blob
	176	* @node_path: node to set property on
	177	* @property: property to set
	178	* @...: list of number-of-cells, value pairs
	179	*
	180	* Set the specified property on the specified node in the device tree
	181	* to be an array of cells. The values of the cells are specified via
	182	* the variable arguments, which alternates between "number of cells
	183	* used by this value" and "value".
	184	*
	185	* This is a convenience wrapper for the function
5a4348d1	186	* qemu_fdt_setprop_sized_cells_from_array().
97c38f8c PM	187	*
	188	* Return value: 0 on success, <0 on error.
	189	*/
5a4348d1 PC	190	#define qemu_fdt_setprop_sized_cells(fdt, node_path, property, ...) \
	191	({ \
	192	uint64_t qdt_tmp[] = { __VA_ARGS__ }; \
	193	qemu_fdt_setprop_sized_cells_from_array(fdt, node_path, \
	194	property, \
	195	ARRAY_SIZE(qdt_tmp) / 2, \
	196	qdt_tmp); \
97c38f8c PM	197	})
97c38f8c PM	198
4ab29b82 AG	199	#define FDT_PCI_RANGE_RELOCATABLE 0x80000000
	200	#define FDT_PCI_RANGE_PREFETCHABLE 0x40000000
	201	#define FDT_PCI_RANGE_ALIASED 0x20000000
	202	#define FDT_PCI_RANGE_TYPE_MASK 0x03000000
	203	#define FDT_PCI_RANGE_MMIO_64BIT 0x03000000
	204	#define FDT_PCI_RANGE_MMIO 0x02000000
	205	#define FDT_PCI_RANGE_IOPORT 0x01000000
	206	#define FDT_PCI_RANGE_CONFIG 0x00000000
	207
2a6a4076	208	#endif /* DEVICE_TREE_H */