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


/*
 * Copyright (c) 2006 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef KERN_OFW_TREE_H_
#define KERN_OFW_TREE_H_
 
#include <arch/types.h>
#include <typedefs.h>
 
#define OFW_TREE_PROPERTY_MAX_NAMELEN   32
 
typedef struct ofw_tree_node ofw_tree_node_t;
typedef struct ofw_tree_property ofw_tree_property_t;
 
/** Memory representation of OpenFirmware device tree node. */
struct ofw_tree_node {
    ofw_tree_node_t *parent;
    ofw_tree_node_t *peer;
    ofw_tree_node_t *child;
 
    uint32_t node_handle;           /**< Old OpenFirmware node handle. */
 
    char *da_name;              /**< Disambigued name. */
 
    unsigned properties;            /**< Number of properties. */
    ofw_tree_property_t *property;
   
    /**
     * Pointer to a structure representing respective device.
     * Its semantics is device dependent.
     */
    void *device;
};
 
/** Memory representation of OpenFirmware device tree node property. */
struct ofw_tree_property {
    char name[OFW_TREE_PROPERTY_MAX_NAMELEN];
    size_t size;
    void *value;
};
 
/*
 * Definition of 'reg' and 'ranges' properties for various buses.
 */
 
struct ofw_fhc_reg {
    uint64_t addr;
    uint32_t size;
} __attribute__ ((packed));
typedef struct ofw_fhc_reg ofw_fhc_reg_t;
           
struct ofw_fhc_range {
    uint64_t child_base;
    uint64_t parent_base;
    uint32_t size;
} __attribute__ ((packed));
typedef struct ofw_fhc_range ofw_fhc_range_t;
 
struct ofw_central_reg {
    uint64_t addr;
    uint32_t size;
} __attribute__ ((packed));
typedef struct ofw_central_reg ofw_central_reg_t;
 
struct ofw_central_range {
    uint64_t child_base;
    uint64_t parent_base;
    uint32_t size;
} __attribute__ ((packed));
typedef struct ofw_central_range ofw_central_range_t;
 
struct ofw_ebus_reg {
    uint32_t space;
    uint32_t addr;
    uint32_t size;
} __attribute__ ((packed));
typedef struct ofw_ebus_reg ofw_ebus_reg_t;
 
struct ofw_ebus_range {
    uint32_t child_space;
    uint32_t child_base;
    uint32_t parent_space;
    uint64_t parent_base;       /* group phys.mid and phys.lo together */
    uint32_t size;
} __attribute__ ((packed));
typedef struct ofw_ebus_range ofw_ebus_range_t;
 
struct ofw_ebus_intr_map {
    uint32_t space;
    uint32_t addr;
    uint32_t intr;
    uint32_t controller_handle;
    uint32_t controller_ino;
} __attribute__ ((packed));
typedef struct ofw_ebus_intr_map ofw_ebus_intr_map_t;
 
struct ofw_ebus_intr_mask {
    uint32_t space_mask;
    uint32_t addr_mask;
    uint32_t intr_mask;
} __attribute__ ((packed));
typedef struct ofw_ebus_intr_mask ofw_ebus_intr_mask_t;
 
struct ofw_pci_reg {
    uint32_t space;         /* needs to be masked to obtain pure space id */
    uint64_t addr;          /* group phys.mid and phys.lo together */
    uint64_t size;
} __attribute__ ((packed));
typedef struct ofw_pci_reg ofw_pci_reg_t;
 
struct ofw_pci_range {
    uint32_t space;
    uint64_t child_base;        /* group phys.mid and phys.lo together */
    uint64_t parent_base;
    uint64_t size;
} __attribute__ ((packed));
typedef struct ofw_pci_range ofw_pci_range_t;
 
struct ofw_upa_reg {
    uint64_t addr;
    uint64_t size;
} __attribute__ ((packed));
typedef struct ofw_upa_reg ofw_upa_reg_t;
 
extern void ofw_tree_init(ofw_tree_node_t *root);
extern void ofw_tree_print(void);
extern const char *ofw_tree_node_name(const ofw_tree_node_t *node);
extern ofw_tree_node_t *ofw_tree_lookup(const char *path);
extern ofw_tree_property_t *ofw_tree_getprop(const ofw_tree_node_t *node, const char *name);
extern ofw_tree_node_t *ofw_tree_find_child(ofw_tree_node_t *node, const char *name);
extern ofw_tree_node_t *ofw_tree_find_child_by_device_type(ofw_tree_node_t *node, const char *device_type);
extern ofw_tree_node_t *ofw_tree_find_peer_by_device_type(ofw_tree_node_t *node, const char *device_type);
extern ofw_tree_node_t *ofw_tree_find_node_by_handle(ofw_tree_node_t *root, uint32_t handle);
 
extern bool ofw_fhc_apply_ranges(ofw_tree_node_t *node, ofw_fhc_reg_t *reg, uintptr_t *pa);
extern bool ofw_central_apply_ranges(ofw_tree_node_t *node, ofw_central_reg_t *reg, uintptr_t *pa);
extern bool ofw_ebus_apply_ranges(ofw_tree_node_t *node, ofw_ebus_reg_t *reg, uintptr_t *pa);
extern bool ofw_pci_apply_ranges(ofw_tree_node_t *node, ofw_pci_reg_t *reg, uintptr_t *pa);
extern bool ofw_upa_apply_ranges(ofw_tree_node_t *node, ofw_upa_reg_t *reg, uintptr_t *pa);
 
extern bool ofw_pci_reg_absolutize(ofw_tree_node_t *node, ofw_pci_reg_t *reg, ofw_pci_reg_t *out);
 
extern bool ofw_fhc_map_interrupt(ofw_tree_node_t *node, ofw_fhc_reg_t *reg, uint32_t interrupt, int *inr);
extern bool ofw_ebus_map_interrupt(ofw_tree_node_t *node, ofw_ebus_reg_t *reg, uint32_t interrupt, int *inr);
extern bool ofw_pci_map_interrupt(ofw_tree_node_t *node, ofw_pci_reg_t *reg, int ino, int *inr);
 
#endif
 

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

Subversion Repositories HelenOS

(root)/trunk/kernel/genarch/include/ofw/ofw_tree.h – Rev 1912 → 2071