Subversion Repositories HelenOS

Rev

Rev 3071 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1893 jermar 1
/*
2071 jermar 2
 * Copyright (c) 2006 Jakub Jermar
1893 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>
3071 decky 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
 
1907 jermar 46
    uint32_t node_handle;           /**< Old OpenFirmware node handle. */
1895 jermar 47
 
1907 jermar 48
    char *da_name;              /**< Disambigued name. */
49
 
50
    unsigned properties;            /**< Number of properties. */
1893 jermar 51
    ofw_tree_property_t *property;
1909 jermar 52
 
53
    /**
54
     * Pointer to a structure representing respective device.
55
     * Its semantics is device dependent.
56
     */
57
    void *device;
1893 jermar 58
};
59
 
1894 jermar 60
/** Memory representation of OpenFirmware device tree node property. */
1893 jermar 61
struct ofw_tree_property {
62
    char name[OFW_TREE_PROPERTY_MAX_NAMELEN];
63
    size_t size;
64
    void *value;
65
};
66
 
1896 jermar 67
/*
68
 * Definition of 'reg' and 'ranges' properties for various buses.
69
 */
70
 
71
struct ofw_fhc_reg {
72
    uint64_t addr;
73
    uint32_t size;
74
} __attribute__ ((packed));
75
typedef struct ofw_fhc_reg ofw_fhc_reg_t;
76
 
77
struct ofw_fhc_range {
78
    uint64_t child_base;
79
    uint64_t parent_base;
80
    uint32_t size;
81
} __attribute__ ((packed));
82
typedef struct ofw_fhc_range ofw_fhc_range_t;
83
 
84
struct ofw_central_reg {
85
    uint64_t addr;
86
    uint32_t size;
87
} __attribute__ ((packed));
88
typedef struct ofw_central_reg ofw_central_reg_t;
89
 
90
struct ofw_central_range {
91
    uint64_t child_base;
92
    uint64_t parent_base;
93
    uint32_t size;
94
} __attribute__ ((packed));
95
typedef struct ofw_central_range ofw_central_range_t;
96
 
97
struct ofw_ebus_reg {
98
    uint32_t space;
99
    uint32_t addr;
100
    uint32_t size;
101
} __attribute__ ((packed));
102
typedef struct ofw_ebus_reg ofw_ebus_reg_t;
103
 
104
struct ofw_ebus_range {
105
    uint32_t child_space;
106
    uint32_t child_base;
107
    uint32_t parent_space;
108
    uint64_t parent_base;       /* group phys.mid and phys.lo together */
109
    uint32_t size;
110
} __attribute__ ((packed));
111
typedef struct ofw_ebus_range ofw_ebus_range_t;
112
 
1909 jermar 113
struct ofw_ebus_intr_map {
114
    uint32_t space;
115
    uint32_t addr;
116
    uint32_t intr;
117
    uint32_t controller_handle;
1912 jermar 118
    uint32_t controller_ino;
1909 jermar 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
 
1896 jermar 129
struct ofw_pci_reg {
1909 jermar 130
    uint32_t space;         /* needs to be masked to obtain pure space id */
1896 jermar 131
    uint64_t addr;          /* group phys.mid and phys.lo together */
132
    uint64_t size;
133
} __attribute__ ((packed));
134
typedef struct ofw_pci_reg ofw_pci_reg_t;
135
 
136
struct ofw_pci_range {
137
    uint32_t space;
138
    uint64_t child_base;        /* group phys.mid and phys.lo together */
139
    uint64_t parent_base;
140
    uint64_t size;
141
} __attribute__ ((packed));
142
typedef struct ofw_pci_range ofw_pci_range_t;
143
 
2510 jermar 144
struct ofw_sbus_reg {
145
    uint64_t addr;
146
    uint32_t size;
147
} __attribute__ ((packed));
148
typedef struct ofw_sbus_reg ofw_sbus_reg_t;
149
 
150
struct ofw_sbus_range {
151
    uint64_t child_base;
152
    uint64_t parent_base;
153
    uint32_t size;
154
} __attribute__ ((packed));
155
typedef struct ofw_sbus_range ofw_sbus_range_t;
156
 
1898 jermar 157
struct ofw_upa_reg {
158
    uint64_t addr;
159
    uint64_t size;
1896 jermar 160
} __attribute__ ((packed));
1898 jermar 161
typedef struct ofw_upa_reg ofw_upa_reg_t;
1896 jermar 162
 
1895 jermar 163
extern void ofw_tree_init(ofw_tree_node_t *root);
164
extern void ofw_tree_print(void);
165
extern const char *ofw_tree_node_name(const ofw_tree_node_t *node);
166
extern ofw_tree_node_t *ofw_tree_lookup(const char *path);
1896 jermar 167
extern ofw_tree_property_t *ofw_tree_getprop(const ofw_tree_node_t *node, const char *name);
1899 jermar 168
extern ofw_tree_node_t *ofw_tree_find_child(ofw_tree_node_t *node, const char *name);
169
extern ofw_tree_node_t *ofw_tree_find_child_by_device_type(ofw_tree_node_t *node, const char *device_type);
170
extern ofw_tree_node_t *ofw_tree_find_peer_by_device_type(ofw_tree_node_t *node, const char *device_type);
1908 jermar 171
extern ofw_tree_node_t *ofw_tree_find_node_by_handle(ofw_tree_node_t *root, uint32_t handle);
1895 jermar 172
 
1896 jermar 173
extern bool ofw_fhc_apply_ranges(ofw_tree_node_t *node, ofw_fhc_reg_t *reg, uintptr_t *pa);
174
extern bool ofw_central_apply_ranges(ofw_tree_node_t *node, ofw_central_reg_t *reg, uintptr_t *pa);
175
extern bool ofw_ebus_apply_ranges(ofw_tree_node_t *node, ofw_ebus_reg_t *reg, uintptr_t *pa);
176
extern bool ofw_pci_apply_ranges(ofw_tree_node_t *node, ofw_pci_reg_t *reg, uintptr_t *pa);
2510 jermar 177
extern bool ofw_sbus_apply_ranges(ofw_tree_node_t *node, ofw_sbus_reg_t *reg, uintptr_t *pa);
1898 jermar 178
extern bool ofw_upa_apply_ranges(ofw_tree_node_t *node, ofw_upa_reg_t *reg, uintptr_t *pa);
1896 jermar 179
 
1897 jermar 180
extern bool ofw_pci_reg_absolutize(ofw_tree_node_t *node, ofw_pci_reg_t *reg, ofw_pci_reg_t *out);
181
 
1912 jermar 182
extern bool ofw_fhc_map_interrupt(ofw_tree_node_t *node, ofw_fhc_reg_t *reg, uint32_t interrupt, int *inr);
183
extern bool ofw_ebus_map_interrupt(ofw_tree_node_t *node, ofw_ebus_reg_t *reg, uint32_t interrupt, int *inr);
184
extern bool ofw_pci_map_interrupt(ofw_tree_node_t *node, ofw_pci_reg_t *reg, int ino, int *inr);
1909 jermar 185
 
1893 jermar 186
#endif