documentation: convert the Documentation directory to UTF-8
[sfrench/cifs-2.6.git] / include / asm-sparc / prom.h
1 #ifndef _SPARC_PROM_H
2 #define _SPARC_PROM_H
3 #ifdef __KERNEL__
4
5
6 /*
7  * Definitions for talking to the Open Firmware PROM on
8  * Power Macintosh computers.
9  *
10  * Copyright (C) 1996-2005 Paul Mackerras.
11  *
12  * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
13  * Updates for SPARC32 by David S. Miller
14  *
15  * This program is free software; you can redistribute it and/or
16  * modify it under the terms of the GNU General Public License
17  * as published by the Free Software Foundation; either version
18  * 2 of the License, or (at your option) any later version.
19  */
20
21 #include <linux/types.h>
22 #include <linux/proc_fs.h>
23 #include <asm/atomic.h>
24
25 typedef u32 phandle;
26 typedef u32 ihandle;
27
28 struct property {
29         char    *name;
30         int     length;
31         void    *value;
32         struct property *next;
33         unsigned long _flags;
34         unsigned int unique_id;
35 };
36
37 struct device_node {
38         const char      *name;
39         const char      *type;
40         phandle node;
41         char    *path_component_name;
42         char    *full_name;
43
44         struct  property *properties;
45         struct  property *deadprops; /* removed properties */
46         struct  device_node *parent;
47         struct  device_node *child;
48         struct  device_node *sibling;
49         struct  device_node *next;      /* next device of same type */
50         struct  device_node *allnext;   /* next in list of all nodes */
51         struct  proc_dir_entry *pde;    /* this node's proc directory */
52         struct  kref kref;
53         unsigned long _flags;
54         void    *data;
55         unsigned int unique_id;
56 };
57
58 /* flag descriptions */
59 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
60
61 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
62 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
63
64 #define OF_BAD_ADDR     ((u64)-1)
65
66 static inline void set_node_proc_entry(struct device_node *dn, struct proc_dir_entry *de)
67 {
68         dn->pde = de;
69 }
70
71 extern struct device_node *of_find_node_by_name(struct device_node *from,
72         const char *name);
73 #define for_each_node_by_name(dn, name) \
74         for (dn = of_find_node_by_name(NULL, name); dn; \
75              dn = of_find_node_by_name(dn, name))
76 extern struct device_node *of_find_node_by_type(struct device_node *from,
77         const char *type);
78 #define for_each_node_by_type(dn, type) \
79         for (dn = of_find_node_by_type(NULL, type); dn; \
80              dn = of_find_node_by_type(dn, type))
81 extern struct device_node *of_find_compatible_node(struct device_node *from,
82         const char *type, const char *compat);
83 extern struct device_node *of_find_node_by_path(const char *path);
84 extern struct device_node *of_find_node_by_phandle(phandle handle);
85 extern struct device_node *of_get_parent(const struct device_node *node);
86 extern struct device_node *of_get_next_child(const struct device_node *node,
87                                              struct device_node *prev);
88 extern struct property *of_find_property(const struct device_node *np,
89                                          const char *name,
90                                          int *lenp);
91 extern int of_device_is_compatible(const struct device_node *device,
92                                    const char *);
93 extern const void *of_get_property(const struct device_node *node,
94                                    const char *name,
95                                    int *lenp);
96 #define get_property(node,name,lenp) of_get_property(node,name,lenp)
97 extern int of_set_property(struct device_node *node, const char *name, void *val, int len);
98 extern int of_getintprop_default(struct device_node *np,
99                                  const char *name,
100                                  int def);
101 extern int of_n_addr_cells(struct device_node *np);
102 extern int of_n_size_cells(struct device_node *np);
103
104 extern void prom_build_devicetree(void);
105
106 #endif /* __KERNEL__ */
107 #endif /* _SPARC_PROM_H */