source: mainline/kernel/genarch/include/ofw/ofw_tree.h@ 72c4ed4

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 72c4ed4 was b3f8fb7, checked in by Martin Decky <martin@…>, 19 years ago

huge type system cleanup
remove cyclical type dependencies across multiple header files
many minor coding style fixes
  • Property mode set to 100644
File size: 5.8 KB
Line 
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
29#ifndef KERN_OFW_TREE_H_
30#define KERN_OFW_TREE_H_
31
32#include <arch/types.h>
33
34#define OFW_TREE_PROPERTY_MAX_NAMELEN 32
35
36typedef struct ofw_tree_node ofw_tree_node_t;
37typedef struct ofw_tree_property ofw_tree_property_t;
38
39/** Memory representation of OpenFirmware device tree node. */
40struct ofw_tree_node {
41 ofw_tree_node_t *parent;
42 ofw_tree_node_t *peer;
43 ofw_tree_node_t *child;
44
45 uint32_t node_handle; /**< Old OpenFirmware node handle. */
46
47 char *da_name; /**< Disambigued name. */
48
49 unsigned properties; /**< Number of properties. */
50 ofw_tree_property_t *property;
51
52 /**
53 * Pointer to a structure representing respective device.
54 * Its semantics is device dependent.
55 */
56 void *device;
57};
58
59/** Memory representation of OpenFirmware device tree node property. */
60struct ofw_tree_property {
61 char name[OFW_TREE_PROPERTY_MAX_NAMELEN];
62 size_t size;
63 void *value;
64};
65
66/*
67 * Definition of 'reg' and 'ranges' properties for various buses.
68 */
69
70struct ofw_fhc_reg {
71 uint64_t addr;
72 uint32_t size;
73} __attribute__ ((packed));
74typedef struct ofw_fhc_reg ofw_fhc_reg_t;
75
76struct ofw_fhc_range {
77 uint64_t child_base;
78 uint64_t parent_base;
79 uint32_t size;
80} __attribute__ ((packed));
81typedef struct ofw_fhc_range ofw_fhc_range_t;
82
83struct ofw_central_reg {
84 uint64_t addr;
85 uint32_t size;
86} __attribute__ ((packed));
87typedef struct ofw_central_reg ofw_central_reg_t;
88
89struct ofw_central_range {
90 uint64_t child_base;
91 uint64_t parent_base;
92 uint32_t size;
93} __attribute__ ((packed));
94typedef struct ofw_central_range ofw_central_range_t;
95
96struct ofw_ebus_reg {
97 uint32_t space;
98 uint32_t addr;
99 uint32_t size;
100} __attribute__ ((packed));
101typedef struct ofw_ebus_reg ofw_ebus_reg_t;
102
103struct ofw_ebus_range {
104 uint32_t child_space;
105 uint32_t child_base;
106 uint32_t parent_space;
107 uint64_t parent_base; /* group phys.mid and phys.lo together */
108 uint32_t size;
109} __attribute__ ((packed));
110typedef struct ofw_ebus_range ofw_ebus_range_t;
111
112struct ofw_ebus_intr_map {
113 uint32_t space;
114 uint32_t addr;
115 uint32_t intr;
116 uint32_t controller_handle;
117 uint32_t controller_ino;
118} __attribute__ ((packed));
119typedef struct ofw_ebus_intr_map ofw_ebus_intr_map_t;
120
121struct ofw_ebus_intr_mask {
122 uint32_t space_mask;
123 uint32_t addr_mask;
124 uint32_t intr_mask;
125} __attribute__ ((packed));
126typedef struct ofw_ebus_intr_mask ofw_ebus_intr_mask_t;
127
128struct ofw_pci_reg {
129 uint32_t space; /* needs to be masked to obtain pure space id */
130 uint64_t addr; /* group phys.mid and phys.lo together */
131 uint64_t size;
132} __attribute__ ((packed));
133typedef struct ofw_pci_reg ofw_pci_reg_t;
134
135struct ofw_pci_range {
136 uint32_t space;
137 uint64_t child_base; /* group phys.mid and phys.lo together */
138 uint64_t parent_base;
139 uint64_t size;
140} __attribute__ ((packed));
141typedef struct ofw_pci_range ofw_pci_range_t;
142
143struct ofw_upa_reg {
144 uint64_t addr;
145 uint64_t size;
146} __attribute__ ((packed));
147typedef struct ofw_upa_reg ofw_upa_reg_t;
148
149extern void ofw_tree_init(ofw_tree_node_t *root);
150extern void ofw_tree_print(void);
151extern const char *ofw_tree_node_name(const ofw_tree_node_t *node);
152extern ofw_tree_node_t *ofw_tree_lookup(const char *path);
153extern ofw_tree_property_t *ofw_tree_getprop(const ofw_tree_node_t *node, const char *name);
154extern ofw_tree_node_t *ofw_tree_find_child(ofw_tree_node_t *node, const char *name);
155extern ofw_tree_node_t *ofw_tree_find_child_by_device_type(ofw_tree_node_t *node, const char *device_type);
156extern ofw_tree_node_t *ofw_tree_find_peer_by_device_type(ofw_tree_node_t *node, const char *device_type);
157extern ofw_tree_node_t *ofw_tree_find_node_by_handle(ofw_tree_node_t *root, uint32_t handle);
158
159extern bool ofw_fhc_apply_ranges(ofw_tree_node_t *node, ofw_fhc_reg_t *reg, uintptr_t *pa);
160extern bool ofw_central_apply_ranges(ofw_tree_node_t *node, ofw_central_reg_t *reg, uintptr_t *pa);
161extern bool ofw_ebus_apply_ranges(ofw_tree_node_t *node, ofw_ebus_reg_t *reg, uintptr_t *pa);
162extern bool ofw_pci_apply_ranges(ofw_tree_node_t *node, ofw_pci_reg_t *reg, uintptr_t *pa);
163extern bool ofw_upa_apply_ranges(ofw_tree_node_t *node, ofw_upa_reg_t *reg, uintptr_t *pa);
164
165extern bool ofw_pci_reg_absolutize(ofw_tree_node_t *node, ofw_pci_reg_t *reg, ofw_pci_reg_t *out);
166
167extern bool ofw_fhc_map_interrupt(ofw_tree_node_t *node, ofw_fhc_reg_t *reg, uint32_t interrupt, int *inr);
168extern bool ofw_ebus_map_interrupt(ofw_tree_node_t *node, ofw_ebus_reg_t *reg, uint32_t interrupt, int *inr);
169extern bool ofw_pci_map_interrupt(ofw_tree_node_t *node, ofw_pci_reg_t *reg, int ino, int *inr);
170
171#endif
Note: See TracBrowser for help on using the repository browser.