WebSVN – HelenOS – Blame – //trunk/kernel/genarch/include/ofw/ofw_tree.h

Rev	Author	Line No.	Line
1893	jermar	1	/*
		2	* Copyright (C) 2006 Jakub Jermar
		3	* All rights reserved.
		4	*
		5	* Redistribution and use in source and binary forms, with or without
		6	* modification, are permitted provided that the following conditions
		7	* are met:
		8	*
		9	* - Redistributions of source code must retain the above copyright
		10	* notice, this list of conditions and the following disclaimer.
		11	* - Redistributions in binary form must reproduce the above copyright
		12	* notice, this list of conditions and the following disclaimer in the
		13	* documentation and/or other materials provided with the distribution.
		14	* - The name of the author may not be used to endorse or promote products
		15	* derived from this software without specific prior written permission.
		16	*
		17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
		18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
		19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
		20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
		21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
		22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
		23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
		24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
		25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
		26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
		27	*/
		28
1894	jermar	29	#ifndef KERN_OFW_TREE_H_
		30	#define KERN_OFW_TREE_H_
1893	jermar	31
1894	jermar	32	#include <arch/types.h>
1895	jermar	33	#include <typedefs.h>
1893	jermar	34
		35	#define OFW_TREE_PROPERTY_MAX_NAMELEN 32
		36
		37	typedef struct ofw_tree_node ofw_tree_node_t;
		38	typedef struct ofw_tree_property ofw_tree_property_t;
		39
1894	jermar	40	/** Memory representation of OpenFirmware device tree node. */
1893	jermar	41	struct ofw_tree_node {
		42	ofw_tree_node_t *parent;
		43	ofw_tree_node_t *peer;
		44	ofw_tree_node_t *child;
		45
1895	jermar	46	char da_name; /< Disambigued name. /
		47
		48	unsigned properties; /*< Number of properties. /
1893	jermar	49	ofw_tree_property_t *property;
		50	};
		51
1894	jermar	52	/** Memory representation of OpenFirmware device tree node property. */
1893	jermar	53	struct ofw_tree_property {
		54	char name[OFW_TREE_PROPERTY_MAX_NAMELEN];
		55	size_t size;
		56	void *value;
		57	};
		58
1896	jermar	59	/*
		60	* Definition of 'reg' and 'ranges' properties for various buses.
		61	*/
		62
		63	struct ofw_fhc_reg {
		64	uint64_t addr;
		65	uint32_t size;
		66	} __attribute__ ((packed));
		67	typedef struct ofw_fhc_reg ofw_fhc_reg_t;
		68
		69	struct ofw_fhc_range {
		70	uint64_t child_base;
		71	uint64_t parent_base;
		72	uint32_t size;
		73	} __attribute__ ((packed));
		74	typedef struct ofw_fhc_range ofw_fhc_range_t;
		75
		76	struct ofw_central_reg {
		77	uint64_t addr;
		78	uint32_t size;
		79	} __attribute__ ((packed));
		80	typedef struct ofw_central_reg ofw_central_reg_t;
		81
		82	struct ofw_central_range {
		83	uint64_t child_base;
		84	uint64_t parent_base;
		85	uint32_t size;
		86	} __attribute__ ((packed));
		87	typedef struct ofw_central_range ofw_central_range_t;
		88
		89	struct ofw_ebus_reg {
		90	uint32_t space;
		91	uint32_t addr;
		92	uint32_t size;
		93	} __attribute__ ((packed));
		94	typedef struct ofw_ebus_reg ofw_ebus_reg_t;
		95
		96	struct ofw_ebus_range {
		97	uint32_t child_space;
		98	uint32_t child_base;
		99	uint32_t parent_space;
		100	uint64_t parent_base; /* group phys.mid and phys.lo together */
		101	uint32_t size;
		102	} __attribute__ ((packed));
		103	typedef struct ofw_ebus_range ofw_ebus_range_t;
		104
		105	struct ofw_pci_reg {
		106	uint32_t space; /* needs to masked to obtain pure space id */
		107	uint64_t addr; /* group phys.mid and phys.lo together */
		108	uint64_t size;
		109	} __attribute__ ((packed));
		110	typedef struct ofw_pci_reg ofw_pci_reg_t;
		111
		112	struct ofw_pci_range {
		113	uint32_t space;
		114	uint64_t child_base; /* group phys.mid and phys.lo together */
		115	uint64_t parent_base;
		116	uint64_t size;
		117	} __attribute__ ((packed));
		118	typedef struct ofw_pci_range ofw_pci_range_t;
		119
1898	jermar	120	struct ofw_upa_reg {
		121	uint64_t addr;
		122	uint64_t size;
1896	jermar	123	} __attribute__ ((packed));
1898	jermar	124	typedef struct ofw_upa_reg ofw_upa_reg_t;
1896	jermar	125
1895	jermar	126	extern void ofw_tree_init(ofw_tree_node_t *root);
		127	extern void ofw_tree_print(void);
		128	extern const char ofw_tree_node_name(const ofw_tree_node_t node);
		129	extern ofw_tree_node_t ofw_tree_lookup(const char path);
1896	jermar	130	extern ofw_tree_property_t ofw_tree_getprop(const ofw_tree_node_t node, const char *name);
1899	jermar	131	extern ofw_tree_node_t ofw_tree_find_child(ofw_tree_node_t node, const char *name);
		132	extern ofw_tree_node_t ofw_tree_find_child_by_device_type(ofw_tree_node_t node, const char *device_type);
		133	extern ofw_tree_node_t ofw_tree_find_peer_by_device_type(ofw_tree_node_t node, const char *device_type);
1895	jermar	134
1896	jermar	135	extern bool ofw_fhc_apply_ranges(ofw_tree_node_t node, ofw_fhc_reg_t reg, uintptr_t *pa);
		136	extern bool ofw_central_apply_ranges(ofw_tree_node_t node, ofw_central_reg_t reg, uintptr_t *pa);
		137	extern bool ofw_ebus_apply_ranges(ofw_tree_node_t node, ofw_ebus_reg_t reg, uintptr_t *pa);
		138	extern bool ofw_pci_apply_ranges(ofw_tree_node_t node, ofw_pci_reg_t reg, uintptr_t *pa);
1898	jermar	139	extern bool ofw_upa_apply_ranges(ofw_tree_node_t node, ofw_upa_reg_t reg, uintptr_t *pa);
1896	jermar	140
1897	jermar	141	extern bool ofw_pci_reg_absolutize(ofw_tree_node_t node, ofw_pci_reg_t reg, ofw_pci_reg_t *out);
		142
1893	jermar	143	#endif

Subversion Repositories HelenOS

(root)//trunk/kernel/genarch/include/ofw/ofw_tree.h – Rev 1899