GNU Linux-libre 4.14.266-gnu1
[releases.git] / arch / powerpc / boot / ops.h
1 /*
2  * Global definition of all the bootwrapper operations.
3  *
4  * Author: Mark A. Greer <mgreer@mvista.com>
5  *
6  * 2006 (c) MontaVista Software, Inc.  This file is licensed under
7  * the terms of the GNU General Public License version 2.  This program
8  * is licensed "as is" without any warranty of any kind, whether express
9  * or implied.
10  */
11 #ifndef _PPC_BOOT_OPS_H_
12 #define _PPC_BOOT_OPS_H_
13
14 #include <stddef.h>
15 #include "types.h"
16 #include "string.h"
17
18 #define BOOT_COMMAND_LINE_SIZE  2048
19 #define MAX_PATH_LEN            256
20 #define MAX_PROP_LEN            256 /* What should this be? */
21
22 typedef void (*kernel_entry_t)(unsigned long r3, unsigned long r4, void *r5);
23
24 /* Platform specific operations */
25 struct platform_ops {
26         void    (*fixups)(void);
27         void    (*image_hdr)(const void *);
28         void *  (*malloc)(unsigned long size);
29         void    (*free)(void *ptr);
30         void *  (*realloc)(void *ptr, unsigned long size);
31         void    (*exit)(void);
32         void *  (*vmlinux_alloc)(unsigned long size);
33         void    (*kentry)(unsigned long fdt_addr, void *vmlinux_addr);
34 };
35 extern struct platform_ops platform_ops;
36
37 /* Device Tree operations */
38 struct dt_ops {
39         void *  (*finddevice)(const char *name);
40         int     (*getprop)(const void *phandle, const char *name, void *buf,
41                         const int buflen);
42         int     (*setprop)(const void *phandle, const char *name,
43                         const void *buf, const int buflen);
44         int (*del_node)(const void *phandle);
45         void *(*get_parent)(const void *phandle);
46         /* The node must not already exist. */
47         void *(*create_node)(const void *parent, const char *name);
48         void *(*find_node_by_prop_value)(const void *prev,
49                                          const char *propname,
50                                          const char *propval, int proplen);
51         void *(*find_node_by_compatible)(const void *prev,
52                                          const char *compat);
53         unsigned long (*finalize)(void);
54         char *(*get_path)(const void *phandle, char *buf, int len);
55 };
56 extern struct dt_ops dt_ops;
57
58 /* Console operations */
59 struct console_ops {
60         int     (*open)(void);
61         void    (*write)(const char *buf, int len);
62         void    (*edit_cmdline)(char *buf, int len, unsigned int getline_timeout);
63         void    (*close)(void);
64         void    *data;
65 };
66 extern struct console_ops console_ops;
67
68 /* Serial console operations */
69 struct serial_console_data {
70         int             (*open)(void);
71         void            (*putc)(unsigned char c);
72         unsigned char   (*getc)(void);
73         u8              (*tstc)(void);
74         void            (*close)(void);
75 };
76
77 struct loader_info {
78         void *promptr;
79         unsigned long initrd_addr, initrd_size;
80         char *cmdline;
81         int cmdline_len;
82 };
83 extern struct loader_info loader_info;
84
85 void start(void);
86 void fdt_init(void *blob);
87 int serial_console_init(void);
88 int ns16550_console_init(void *devp, struct serial_console_data *scdp);
89 int mpsc_console_init(void *devp, struct serial_console_data *scdp);
90 int cpm_console_init(void *devp, struct serial_console_data *scdp);
91 int mpc5200_psc_console_init(void *devp, struct serial_console_data *scdp);
92 int uartlite_console_init(void *devp, struct serial_console_data *scdp);
93 int opal_console_init(void *devp, struct serial_console_data *scdp);
94 void *simple_alloc_init(char *base, unsigned long heap_size,
95                         unsigned long granularity, unsigned long max_allocs);
96 extern void flush_cache(void *, unsigned long);
97 int dt_xlate_reg(void *node, int res, unsigned long *addr, unsigned long *size);
98 int dt_xlate_addr(void *node, u32 *buf, int buflen, unsigned long *xlated_addr);
99 int dt_is_compatible(void *node, const char *compat);
100 void dt_get_reg_format(void *node, u32 *naddr, u32 *nsize);
101 int dt_get_virtual_reg(void *node, void **addr, int nres);
102
103 static inline void *finddevice(const char *name)
104 {
105         return (dt_ops.finddevice) ? dt_ops.finddevice(name) : NULL;
106 }
107
108 static inline int getprop(void *devp, const char *name, void *buf, int buflen)
109 {
110         return (dt_ops.getprop) ? dt_ops.getprop(devp, name, buf, buflen) : -1;
111 }
112
113 static inline int setprop(void *devp, const char *name,
114                           const void *buf, int buflen)
115 {
116         return (dt_ops.setprop) ? dt_ops.setprop(devp, name, buf, buflen) : -1;
117 }
118 #define setprop_val(devp, name, val) \
119         do { \
120                 typeof(val) x = (val); \
121                 setprop((devp), (name), &x, sizeof(x)); \
122         } while (0)
123
124 static inline int setprop_str(void *devp, const char *name, const char *buf)
125 {
126         if (dt_ops.setprop)
127                 return dt_ops.setprop(devp, name, buf, strlen(buf) + 1);
128
129         return -1;
130 }
131
132 static inline int del_node(const void *devp)
133 {
134         return dt_ops.del_node ? dt_ops.del_node(devp) : -1;
135 }
136
137 static inline void *get_parent(const char *devp)
138 {
139         return dt_ops.get_parent ? dt_ops.get_parent(devp) : NULL;
140 }
141
142 static inline void *create_node(const void *parent, const char *name)
143 {
144         return dt_ops.create_node ? dt_ops.create_node(parent, name) : NULL;
145 }
146
147
148 static inline void *find_node_by_prop_value(const void *prev,
149                                             const char *propname,
150                                             const char *propval, int proplen)
151 {
152         if (dt_ops.find_node_by_prop_value)
153                 return dt_ops.find_node_by_prop_value(prev, propname,
154                                                       propval, proplen);
155
156         return NULL;
157 }
158
159 static inline void *find_node_by_prop_value_str(const void *prev,
160                                                 const char *propname,
161                                                 const char *propval)
162 {
163         return find_node_by_prop_value(prev, propname, propval,
164                                        strlen(propval) + 1);
165 }
166
167 static inline void *find_node_by_devtype(const void *prev,
168                                          const char *type)
169 {
170         return find_node_by_prop_value_str(prev, "device_type", type);
171 }
172
173 static inline void *find_node_by_alias(const char *alias)
174 {
175         void *devp = finddevice("/aliases");
176
177         if (devp) {
178                 char path[MAX_PATH_LEN];
179                 if (getprop(devp, alias, path, MAX_PATH_LEN) > 0)
180                         return finddevice(path);
181         }
182
183         return NULL;
184 }
185
186 static inline void *find_node_by_compatible(const void *prev,
187                                             const char *compat)
188 {
189         if (dt_ops.find_node_by_compatible)
190                 return dt_ops.find_node_by_compatible(prev, compat);
191
192         return NULL;
193 }
194
195 void dt_fixup_memory(u64 start, u64 size);
196 void dt_fixup_cpu_clocks(u32 cpufreq, u32 tbfreq, u32 busfreq);
197 void dt_fixup_clock(const char *path, u32 freq);
198 void dt_fixup_mac_address_by_alias(const char *alias, const u8 *addr);
199 void dt_fixup_mac_address(u32 index, const u8 *addr);
200 void __dt_fixup_mac_addresses(u32 startindex, ...);
201 #define dt_fixup_mac_addresses(...) \
202         __dt_fixup_mac_addresses(0, __VA_ARGS__, NULL)
203
204
205 static inline void *find_node_by_linuxphandle(const u32 linuxphandle)
206 {
207         return find_node_by_prop_value(NULL, "linux,phandle",
208                         (char *)&linuxphandle, sizeof(u32));
209 }
210
211 static inline char *get_path(const void *phandle, char *buf, int len)
212 {
213         if (dt_ops.get_path)
214                 return dt_ops.get_path(phandle, buf, len);
215
216         return NULL;
217 }
218
219 static inline void *malloc(unsigned long size)
220 {
221         return (platform_ops.malloc) ? platform_ops.malloc(size) : NULL;
222 }
223
224 static inline void free(void *ptr)
225 {
226         if (platform_ops.free)
227                 platform_ops.free(ptr);
228 }
229
230 static inline void exit(void)
231 {
232         if (platform_ops.exit)
233                 platform_ops.exit();
234         for(;;);
235 }
236 #define fatal(args...) { printf(args); exit(); }
237
238
239 #define BSS_STACK(size) \
240         static char _bss_stack[size]; \
241         void *_platform_stack_top = _bss_stack + sizeof(_bss_stack);
242
243 extern unsigned long timebase_period_ns;
244 void udelay(long delay);
245
246 extern char _start[];
247 extern char __bss_start[];
248 extern char _end[];
249 extern char _vmlinux_start[];
250 extern char _vmlinux_end[];
251 extern char _initrd_start[];
252 extern char _initrd_end[];
253 extern char _dtb_start[];
254 extern char _dtb_end[];
255
256 static inline __attribute__((const))
257 int __ilog2_u32(u32 n)
258 {
259         int bit;
260         asm ("cntlzw %0,%1" : "=r" (bit) : "r" (n));
261         return 31 - bit;
262 }
263
264 long partial_decompress(void *inbuf, unsigned long input_size, void *outbuf,
265         unsigned long output_size, unsigned long skip);
266
267 #endif /* _PPC_BOOT_OPS_H_ */