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