Subversion Repositories HelenOS

Rev

Rev 3022 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 3022 Rev 4055
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 <ddi/irq.h>
-
 
34
#include <typedefs.h>
33
 
35
 
34
#define OFW_TREE_PROPERTY_MAX_NAMELEN   32
36
#define OFW_TREE_PROPERTY_MAX_NAMELEN   32
35
 
37
 
36
typedef struct ofw_tree_node ofw_tree_node_t;
38
typedef struct ofw_tree_node ofw_tree_node_t;
37
typedef struct ofw_tree_property ofw_tree_property_t;
39
typedef struct ofw_tree_property ofw_tree_property_t;
38
 
40
 
39
/** Memory representation of OpenFirmware device tree node. */
41
/** Memory representation of OpenFirmware device tree node. */
40
struct ofw_tree_node {
42
struct ofw_tree_node {
41
    ofw_tree_node_t *parent;
43
    ofw_tree_node_t *parent;
42
    ofw_tree_node_t *peer;
44
    ofw_tree_node_t *peer;
43
    ofw_tree_node_t *child;
45
    ofw_tree_node_t *child;
44
 
46
 
45
    uint32_t node_handle;           /**< Old OpenFirmware node handle. */
47
    uint32_t node_handle;       /**< Old OpenFirmware node handle. */
46
 
48
 
47
    char *da_name;              /**< Disambigued name. */
49
    char *da_name;          /**< Disambigued name. */
48
 
50
 
49
    unsigned properties;            /**< Number of properties. */
51
    unsigned properties;        /**< Number of properties. */
50
    ofw_tree_property_t *property;
52
    ofw_tree_property_t *property;
51
   
53
   
52
    /**
54
    /**
53
     * Pointer to a structure representing respective device.
55
     * Pointer to a structure representing respective device.
54
     * Its semantics is device dependent.
56
     * Its semantics is device dependent.
55
     */
57
     */
56
    void *device;
58
    void *device;
57
};
59
};
58
 
60
 
59
/** Memory representation of OpenFirmware device tree node property. */
61
/** Memory representation of OpenFirmware device tree node property. */
60
struct ofw_tree_property {
62
struct ofw_tree_property {
61
    char name[OFW_TREE_PROPERTY_MAX_NAMELEN];
63
    char name[OFW_TREE_PROPERTY_MAX_NAMELEN];
62
    size_t size;
64
    size_t size;
63
    void *value;
65
    void *value;
64
};
66
};
65
 
67
 
66
/*
68
/*
67
 * Definition of 'reg' and 'ranges' properties for various buses.
69
 * Definition of 'reg' and 'ranges' properties for various buses.
68
 */
70
 */
69
 
71
 
70
struct ofw_fhc_reg {
72
struct ofw_fhc_reg {
71
    uint64_t addr;
73
    uint64_t addr;
72
    uint32_t size;
74
    uint32_t size;
73
} __attribute__ ((packed));
75
} __attribute__ ((packed));
74
typedef struct ofw_fhc_reg ofw_fhc_reg_t;
76
typedef struct ofw_fhc_reg ofw_fhc_reg_t;
75
           
77
           
76
struct ofw_fhc_range {
78
struct ofw_fhc_range {
77
    uint64_t child_base;
79
    uint64_t child_base;
78
    uint64_t parent_base;
80
    uint64_t parent_base;
79
    uint32_t size;
81
    uint32_t size;
80
} __attribute__ ((packed));
82
} __attribute__ ((packed));
81
typedef struct ofw_fhc_range ofw_fhc_range_t;
83
typedef struct ofw_fhc_range ofw_fhc_range_t;
82
 
84
 
83
struct ofw_central_reg {
85
struct ofw_central_reg {
84
    uint64_t addr;
86
    uint64_t addr;
85
    uint32_t size;
87
    uint32_t size;
86
} __attribute__ ((packed));
88
} __attribute__ ((packed));
87
typedef struct ofw_central_reg ofw_central_reg_t;
89
typedef struct ofw_central_reg ofw_central_reg_t;
88
 
90
 
89
struct ofw_central_range {
91
struct ofw_central_range {
90
    uint64_t child_base;
92
    uint64_t child_base;
91
    uint64_t parent_base;
93
    uint64_t parent_base;
92
    uint32_t size;
94
    uint32_t size;
93
} __attribute__ ((packed));
95
} __attribute__ ((packed));
94
typedef struct ofw_central_range ofw_central_range_t;
96
typedef struct ofw_central_range ofw_central_range_t;
95
 
97
 
96
struct ofw_ebus_reg {
98
struct ofw_ebus_reg {
97
    uint32_t space;
99
    uint32_t space;
98
    uint32_t addr;
100
    uint32_t addr;
99
    uint32_t size;
101
    uint32_t size;
100
} __attribute__ ((packed));
102
} __attribute__ ((packed));
101
typedef struct ofw_ebus_reg ofw_ebus_reg_t;
103
typedef struct ofw_ebus_reg ofw_ebus_reg_t;
102
 
104
 
103
struct ofw_ebus_range {
105
struct ofw_ebus_range {
104
    uint32_t child_space;
106
    uint32_t child_space;
105
    uint32_t child_base;
107
    uint32_t child_base;
106
    uint32_t parent_space;
108
    uint32_t parent_space;
107
    uint64_t parent_base;       /* group phys.mid and phys.lo together */
109
    uint64_t parent_base;   /* group phys.mid and phys.lo together */
108
    uint32_t size;
110
    uint32_t size;
109
} __attribute__ ((packed));
111
} __attribute__ ((packed));
110
typedef struct ofw_ebus_range ofw_ebus_range_t;
112
typedef struct ofw_ebus_range ofw_ebus_range_t;
111
 
113
 
112
struct ofw_ebus_intr_map {
114
struct ofw_ebus_intr_map {
113
    uint32_t space;
115
    uint32_t space;
114
    uint32_t addr;
116
    uint32_t addr;
115
    uint32_t intr;
117
    uint32_t intr;
116
    uint32_t controller_handle;
118
    uint32_t controller_handle;
117
    uint32_t controller_ino;
119
    uint32_t controller_ino;
118
} __attribute__ ((packed));
120
} __attribute__ ((packed));
119
typedef struct ofw_ebus_intr_map ofw_ebus_intr_map_t;
121
typedef struct ofw_ebus_intr_map ofw_ebus_intr_map_t;
120
 
122
 
121
struct ofw_ebus_intr_mask {
123
struct ofw_ebus_intr_mask {
122
    uint32_t space_mask;
124
    uint32_t space_mask;
123
    uint32_t addr_mask;
125
    uint32_t addr_mask;
124
    uint32_t intr_mask;
126
    uint32_t intr_mask;
125
} __attribute__ ((packed));
127
} __attribute__ ((packed));
126
typedef struct ofw_ebus_intr_mask ofw_ebus_intr_mask_t;
128
typedef struct ofw_ebus_intr_mask ofw_ebus_intr_mask_t;
127
 
129
 
128
struct ofw_pci_reg {
130
struct ofw_pci_reg {
129
    uint32_t space;         /* needs to be masked to obtain pure space id */
131
    uint32_t space;     /* needs to be masked to obtain pure space id */
130
    uint64_t addr;          /* group phys.mid and phys.lo together */
132
    uint64_t addr;      /* group phys.mid and phys.lo together */
131
    uint64_t size;
133
    uint64_t size;
132
} __attribute__ ((packed));
134
} __attribute__ ((packed));
133
typedef struct ofw_pci_reg ofw_pci_reg_t;
135
typedef struct ofw_pci_reg ofw_pci_reg_t;
134
 
136
 
135
struct ofw_pci_range {
137
struct ofw_pci_range {
136
    uint32_t space;
138
    uint32_t space;
137
    uint64_t child_base;        /* group phys.mid and phys.lo together */
139
    uint64_t child_base;    /* group phys.mid and phys.lo together */
138
    uint64_t parent_base;
140
    uint64_t parent_base;
139
    uint64_t size;
141
    uint64_t size;
140
} __attribute__ ((packed));
142
} __attribute__ ((packed));
141
typedef struct ofw_pci_range ofw_pci_range_t;
143
typedef struct ofw_pci_range ofw_pci_range_t;
142
 
144
 
143
struct ofw_sbus_reg {
145
struct ofw_sbus_reg {
144
    uint64_t addr;
146
    uint64_t addr;
145
    uint32_t size;
147
    uint32_t size;
146
} __attribute__ ((packed));
148
} __attribute__ ((packed));
147
typedef struct ofw_sbus_reg ofw_sbus_reg_t;
149
typedef struct ofw_sbus_reg ofw_sbus_reg_t;
148
 
150
 
149
struct ofw_sbus_range {
151
struct ofw_sbus_range {
150
    uint64_t child_base;
152
    uint64_t child_base;
151
    uint64_t parent_base;
153
    uint64_t parent_base;
152
    uint32_t size;
154
    uint32_t size;
153
} __attribute__ ((packed));
155
} __attribute__ ((packed));
154
typedef struct ofw_sbus_range ofw_sbus_range_t;
156
typedef struct ofw_sbus_range ofw_sbus_range_t;
155
 
157
 
156
struct ofw_upa_reg {
158
struct ofw_upa_reg {
157
    uint64_t addr;
159
    uint64_t addr;
158
    uint64_t size;
160
    uint64_t size;
159
} __attribute__ ((packed));
161
} __attribute__ ((packed));
160
typedef struct ofw_upa_reg ofw_upa_reg_t;
162
typedef struct ofw_upa_reg ofw_upa_reg_t;
161
 
163
 
162
extern void ofw_tree_init(ofw_tree_node_t *root);
164
extern void ofw_tree_init(ofw_tree_node_t *);
163
extern void ofw_tree_print(void);
165
extern void ofw_tree_print(void);
164
extern const char *ofw_tree_node_name(const ofw_tree_node_t *node);
166
extern const char *ofw_tree_node_name(const ofw_tree_node_t *);
165
extern ofw_tree_node_t *ofw_tree_lookup(const char *path);
167
extern ofw_tree_node_t *ofw_tree_lookup(const char *);
166
extern ofw_tree_property_t *ofw_tree_getprop(const ofw_tree_node_t *node, const char *name);
168
extern ofw_tree_property_t *ofw_tree_getprop(const ofw_tree_node_t *,
-
 
169
    const char *);
167
extern ofw_tree_node_t *ofw_tree_find_child(ofw_tree_node_t *node, const char *name);
170
extern ofw_tree_node_t *ofw_tree_find_child(ofw_tree_node_t *, const char *);
168
extern ofw_tree_node_t *ofw_tree_find_child_by_device_type(ofw_tree_node_t *node, const char *device_type);
171
extern ofw_tree_node_t *ofw_tree_find_child_by_device_type(ofw_tree_node_t *,
-
 
172
    const char *);
169
extern ofw_tree_node_t *ofw_tree_find_peer_by_device_type(ofw_tree_node_t *node, const char *device_type);
173
extern ofw_tree_node_t *ofw_tree_find_peer_by_device_type(ofw_tree_node_t *,
-
 
174
    const char *);
-
 
175
extern ofw_tree_node_t *ofw_tree_find_peer_by_name(ofw_tree_node_t *node,
-
 
176
    const char *name);
170
extern ofw_tree_node_t *ofw_tree_find_node_by_handle(ofw_tree_node_t *root, uint32_t handle);
177
extern ofw_tree_node_t *ofw_tree_find_node_by_handle(ofw_tree_node_t *,
-
 
178
    uint32_t);
171
 
179
 
172
extern bool ofw_fhc_apply_ranges(ofw_tree_node_t *node, ofw_fhc_reg_t *reg, uintptr_t *pa);
180
extern bool ofw_fhc_apply_ranges(ofw_tree_node_t *, ofw_fhc_reg_t *,
-
 
181
    uintptr_t *);
173
extern bool ofw_central_apply_ranges(ofw_tree_node_t *node, ofw_central_reg_t *reg, uintptr_t *pa);
182
extern bool ofw_central_apply_ranges(ofw_tree_node_t *, ofw_central_reg_t *,
-
 
183
    uintptr_t *);
174
extern bool ofw_ebus_apply_ranges(ofw_tree_node_t *node, ofw_ebus_reg_t *reg, uintptr_t *pa);
184
extern bool ofw_ebus_apply_ranges(ofw_tree_node_t *, ofw_ebus_reg_t *,
-
 
185
    uintptr_t *);
175
extern bool ofw_pci_apply_ranges(ofw_tree_node_t *node, ofw_pci_reg_t *reg, uintptr_t *pa);
186
extern bool ofw_pci_apply_ranges(ofw_tree_node_t *, ofw_pci_reg_t *,
-
 
187
    uintptr_t *);
176
extern bool ofw_sbus_apply_ranges(ofw_tree_node_t *node, ofw_sbus_reg_t *reg, uintptr_t *pa);
188
extern bool ofw_sbus_apply_ranges(ofw_tree_node_t *, ofw_sbus_reg_t *,
-
 
189
    uintptr_t *);
177
extern bool ofw_upa_apply_ranges(ofw_tree_node_t *node, ofw_upa_reg_t *reg, uintptr_t *pa);
190
extern bool ofw_upa_apply_ranges(ofw_tree_node_t *, ofw_upa_reg_t *,
-
 
191
    uintptr_t *);
178
 
192
 
179
extern bool ofw_pci_reg_absolutize(ofw_tree_node_t *node, ofw_pci_reg_t *reg, ofw_pci_reg_t *out);
193
extern bool ofw_pci_reg_absolutize(ofw_tree_node_t *, ofw_pci_reg_t *,
-
 
194
    ofw_pci_reg_t *);
180
 
195
 
181
extern bool ofw_fhc_map_interrupt(ofw_tree_node_t *node, ofw_fhc_reg_t *reg, uint32_t interrupt, int *inr);
196
extern bool ofw_fhc_map_interrupt(ofw_tree_node_t *, ofw_fhc_reg_t *,
-
 
197
    uint32_t, int *, cir_t *, void **);
182
extern bool ofw_ebus_map_interrupt(ofw_tree_node_t *node, ofw_ebus_reg_t *reg, uint32_t interrupt, int *inr);
198
extern bool ofw_ebus_map_interrupt(ofw_tree_node_t *, ofw_ebus_reg_t *,
-
 
199
    uint32_t, int *, cir_t *, void **);
183
extern bool ofw_pci_map_interrupt(ofw_tree_node_t *node, ofw_pci_reg_t *reg, int ino, int *inr);
200
extern bool ofw_pci_map_interrupt(ofw_tree_node_t *, ofw_pci_reg_t *,
-
 
201
    int, int *, cir_t *, void **);
184
 
202
 
185
#endif
203
#endif
186
 
204