[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 <[email protected]>
 *          Hollis Blanchard <[email protected]>
 *
 * 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
 */
char **qemu_fdt_node_path(void *fdt, const char *name, char *compat,
                          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);
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);

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