Subversion Repositories HelenOS

Rev

Rev 1908 | Rev 1910 | Go to most recent revision | Only display areas with differences | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 1908 Rev 1909
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
   
-
 
53
    /**
-
 
54
     * Pointer to a structure representing respective device.
-
 
55
     * Its semantics is device dependent.
-
 
56
     */
-
 
57
    void *device;
52
};
58
};
53
 
59
 
54
/** Memory representation of OpenFirmware device tree node property. */
60
/** Memory representation of OpenFirmware device tree node property. */
55
struct ofw_tree_property {
61
struct ofw_tree_property {
56
    char name[OFW_TREE_PROPERTY_MAX_NAMELEN];
62
    char name[OFW_TREE_PROPERTY_MAX_NAMELEN];
57
    size_t size;
63
    size_t size;
58
    void *value;
64
    void *value;
59
};
65
};
60
 
66
 
61
/*
67
/*
62
 * Definition of 'reg' and 'ranges' properties for various buses.
68
 * Definition of 'reg' and 'ranges' properties for various buses.
63
 */
69
 */
64
 
70
 
65
struct ofw_fhc_reg {
71
struct ofw_fhc_reg {
66
    uint64_t addr;
72
    uint64_t addr;
67
    uint32_t size;
73
    uint32_t size;
68
} __attribute__ ((packed));
74
} __attribute__ ((packed));
69
typedef struct ofw_fhc_reg ofw_fhc_reg_t;
75
typedef struct ofw_fhc_reg ofw_fhc_reg_t;
70
           
76
           
71
struct ofw_fhc_range {
77
struct ofw_fhc_range {
72
    uint64_t child_base;
78
    uint64_t child_base;
73
    uint64_t parent_base;
79
    uint64_t parent_base;
74
    uint32_t size;
80
    uint32_t size;
75
} __attribute__ ((packed));
81
} __attribute__ ((packed));
76
typedef struct ofw_fhc_range ofw_fhc_range_t;
82
typedef struct ofw_fhc_range ofw_fhc_range_t;
77
 
83
 
78
struct ofw_central_reg {
84
struct ofw_central_reg {
79
    uint64_t addr;
85
    uint64_t addr;
80
    uint32_t size;
86
    uint32_t size;
81
} __attribute__ ((packed));
87
} __attribute__ ((packed));
82
typedef struct ofw_central_reg ofw_central_reg_t;
88
typedef struct ofw_central_reg ofw_central_reg_t;
83
 
89
 
84
struct ofw_central_range {
90
struct ofw_central_range {
85
    uint64_t child_base;
91
    uint64_t child_base;
86
    uint64_t parent_base;
92
    uint64_t parent_base;
87
    uint32_t size;
93
    uint32_t size;
88
} __attribute__ ((packed));
94
} __attribute__ ((packed));
89
typedef struct ofw_central_range ofw_central_range_t;
95
typedef struct ofw_central_range ofw_central_range_t;
90
 
96
 
91
struct ofw_ebus_reg {
97
struct ofw_ebus_reg {
92
    uint32_t space;
98
    uint32_t space;
93
    uint32_t addr;
99
    uint32_t addr;
94
    uint32_t size;
100
    uint32_t size;
95
} __attribute__ ((packed));
101
} __attribute__ ((packed));
96
typedef struct ofw_ebus_reg ofw_ebus_reg_t;
102
typedef struct ofw_ebus_reg ofw_ebus_reg_t;
97
 
103
 
98
struct ofw_ebus_range {
104
struct ofw_ebus_range {
99
    uint32_t child_space;
105
    uint32_t child_space;
100
    uint32_t child_base;
106
    uint32_t child_base;
101
    uint32_t parent_space;
107
    uint32_t parent_space;
102
    uint64_t parent_base;       /* group phys.mid and phys.lo together */
108
    uint64_t parent_base;       /* group phys.mid and phys.lo together */
103
    uint32_t size;
109
    uint32_t size;
104
} __attribute__ ((packed));
110
} __attribute__ ((packed));
105
typedef struct ofw_ebus_range ofw_ebus_range_t;
111
typedef struct ofw_ebus_range ofw_ebus_range_t;
106
 
112
 
-
 
113
struct ofw_ebus_intr_map {
-
 
114
    uint32_t space;
-
 
115
    uint32_t addr;
-
 
116
    uint32_t intr;
-
 
117
    uint32_t controller_handle;
-
 
118
    uint32_t controller_ino;
-
 
119
} __attribute__ ((packed));
-
 
120
typedef struct ofw_ebus_intr_map ofw_ebus_intr_map_t;
-
 
121
 
-
 
122
struct ofw_ebus_intr_mask {
-
 
123
    uint32_t space_mask;
-
 
124
    uint32_t addr_mask;
-
 
125
    uint32_t intr_mask;
-
 
126
} __attribute__ ((packed));
-
 
127
typedef struct ofw_ebus_intr_mask ofw_ebus_intr_mask_t;
-
 
128
 
107
struct ofw_pci_reg {
129
struct ofw_pci_reg {
108
    uint32_t space;         /* needs to masked to obtain pure space id */
130
    uint32_t space;         /* needs to be masked to obtain pure space id */
109
    uint64_t addr;          /* group phys.mid and phys.lo together */
131
    uint64_t addr;          /* group phys.mid and phys.lo together */
110
    uint64_t size;
132
    uint64_t size;
111
} __attribute__ ((packed));
133
} __attribute__ ((packed));
112
typedef struct ofw_pci_reg ofw_pci_reg_t;
134
typedef struct ofw_pci_reg ofw_pci_reg_t;
113
 
135
 
114
struct ofw_pci_range {
136
struct ofw_pci_range {
115
    uint32_t space;
137
    uint32_t space;
116
    uint64_t child_base;        /* group phys.mid and phys.lo together */
138
    uint64_t child_base;        /* group phys.mid and phys.lo together */
117
    uint64_t parent_base;
139
    uint64_t parent_base;
118
    uint64_t size;
140
    uint64_t size;
119
} __attribute__ ((packed));
141
} __attribute__ ((packed));
120
typedef struct ofw_pci_range ofw_pci_range_t;
142
typedef struct ofw_pci_range ofw_pci_range_t;
121
 
143
 
122
struct ofw_upa_reg {
144
struct ofw_upa_reg {
123
    uint64_t addr;
145
    uint64_t addr;
124
    uint64_t size;
146
    uint64_t size;
125
} __attribute__ ((packed));
147
} __attribute__ ((packed));
126
typedef struct ofw_upa_reg ofw_upa_reg_t;
148
typedef struct ofw_upa_reg ofw_upa_reg_t;
127
 
149
 
128
extern void ofw_tree_init(ofw_tree_node_t *root);
150
extern void ofw_tree_init(ofw_tree_node_t *root);
129
extern void ofw_tree_print(void);
151
extern void ofw_tree_print(void);
130
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);
131
extern ofw_tree_node_t *ofw_tree_lookup(const char *path);
153
extern ofw_tree_node_t *ofw_tree_lookup(const char *path);
132
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);
133
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);
134
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);
135
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);
136
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);
137
 
159
 
138
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);
139
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);
140
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);
141
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);
142
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);
143
 
165
 
144
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);
145
 
167
 
-
 
168
extern bool ofw_fhc_map_interrupts(ofw_tree_node_t *node, ofw_fhc_reg_t *reg, uint32_t interrupt, int *ino);
-
 
169
extern bool ofw_ebus_map_interrupts(ofw_tree_node_t *node, ofw_ebus_reg_t *reg, uint32_t interrupt, int *ino);
-
 
170
 
146
#endif
171
#endif
147
 
172