blob: fad1862f4b2d3904360aa68431177dbc79621f99 [file] [log] [blame]
Mark A. Greerb2c5f612006-09-19 14:05:08 +10001/*
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
Scott Woodce3edb32007-03-12 14:41:38 -060014#include <stddef.h>
Mark A. Greerb2c5f612006-09-19 14:05:08 +100015#include "types.h"
Scott Wooda07940b2007-03-16 12:27:54 -050016#include "string.h"
Mark A. Greerb2c5f612006-09-19 14:05:08 +100017
Anton Blanchard579a53c2014-04-14 21:55:25 +100018#define BOOT_COMMAND_LINE_SIZE 2048
Mark A. Greerb2c5f612006-09-19 14:05:08 +100019#define MAX_PATH_LEN 256
20#define MAX_PROP_LEN 256 /* What should this be? */
21
Geoff Levand62cf6a92007-06-16 08:06:44 +100022typedef void (*kernel_entry_t)(unsigned long r3, unsigned long r4, void *r5);
23
Mark A. Greerb2c5f612006-09-19 14:05:08 +100024/* Platform specific operations */
25struct platform_ops {
26 void (*fixups)(void);
27 void (*image_hdr)(const void *);
Geert Uytterhoeven4ca478e2007-04-18 19:24:12 +100028 void * (*malloc)(unsigned long size);
Mark A. Greerc8885542006-10-16 13:49:27 -070029 void (*free)(void *ptr);
30 void * (*realloc)(void *ptr, unsigned long size);
Mark A. Greerb2c5f612006-09-19 14:05:08 +100031 void (*exit)(void);
David Gibson79c85412007-03-05 14:24:52 +110032 void * (*vmlinux_alloc)(unsigned long size);
Oliver O'Hallorana1ff5742016-11-23 13:55:13 +110033 void (*kentry)(unsigned long fdt_addr, void *vmlinux_addr);
Mark A. Greerb2c5f612006-09-19 14:05:08 +100034};
35extern struct platform_ops platform_ops;
36
37/* Device Tree operations */
38struct dt_ops {
39 void * (*finddevice)(const char *name);
Mark A. Greerc8885542006-10-16 13:49:27 -070040 int (*getprop)(const void *phandle, const char *name, void *buf,
Mark A. Greerb2c5f612006-09-19 14:05:08 +100041 const int buflen);
Mark A. Greerc8885542006-10-16 13:49:27 -070042 int (*setprop)(const void *phandle, const char *name,
Mark A. Greerb2c5f612006-09-19 14:05:08 +100043 const void *buf, const int buflen);
Mike Ditto71773f02008-10-21 11:32:29 +000044 int (*del_node)(const void *phandle);
Scott Wooda07940b2007-03-16 12:27:54 -050045 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);
Kumar Galab3bea152008-01-24 22:41:05 -060051 void *(*find_node_by_compatible)(const void *prev,
52 const char *compat);
David Gibson35af89e2006-11-21 11:37:37 +110053 unsigned long (*finalize)(void);
Scott Wood21f3fe22007-09-06 05:21:12 +100054 char *(*get_path)(const void *phandle, char *buf, int len);
Mark A. Greerb2c5f612006-09-19 14:05:08 +100055};
56extern struct dt_ops dt_ops;
57
58/* Console operations */
59struct console_ops {
60 int (*open)(void);
Geoff Levandb96fbb62007-06-16 08:06:40 +100061 void (*write)(const char *buf, int len);
Simon Kagstrom4b4b13d2014-10-28 12:19:00 +010062 void (*edit_cmdline)(char *buf, int len, unsigned int getline_timeout);
Mark A. Greerb2c5f612006-09-19 14:05:08 +100063 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
David Gibsoncd197ff2007-03-05 14:24:52 +110077struct loader_info {
78 void *promptr;
79 unsigned long initrd_addr, initrd_size;
David Gibson3af82a82007-03-22 17:02:21 +110080 char *cmdline;
81 int cmdline_len;
David Gibsoncd197ff2007-03-05 14:24:52 +110082};
83extern struct loader_info loader_info;
84
David Gibsone5a2072b2007-03-22 17:02:21 +110085void start(void);
David Gibson2f0dfea2007-12-10 14:28:39 +110086void fdt_init(void *blob);
Mark A. Greerc8885542006-10-16 13:49:27 -070087int serial_console_init(void);
88int ns16550_console_init(void *devp, struct serial_console_data *scdp);
Mark A. Greere12deb82007-05-12 10:54:31 +100089int mpsc_console_init(void *devp, struct serial_console_data *scdp);
Scott Woodd0f53fa2007-08-21 03:39:57 +100090int cpm_console_init(void *devp, struct serial_console_data *scdp);
Grant Likely85498ae2007-09-01 03:34:37 +100091int mpc5200_psc_console_init(void *devp, struct serial_console_data *scdp);
Grant Likely7ddc5f92007-10-02 12:15:13 +100092int uartlite_console_init(void *devp, struct serial_console_data *scdp);
Oliver O'Halloran656ad582016-07-01 00:34:37 +100093int opal_console_init(void *devp, struct serial_console_data *scdp);
Geert Uytterhoeven4ca478e2007-04-18 19:24:12 +100094void *simple_alloc_init(char *base, unsigned long heap_size,
95 unsigned long granularity, unsigned long max_allocs);
Milton Miller0e680672007-03-19 14:58:06 -060096extern void flush_cache(void *, unsigned long);
Mark A. Greer8895ea42007-04-28 06:48:24 +100097int 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);
Scott Wooda73ac502007-08-21 03:39:48 +100099int dt_is_compatible(void *node, const char *compat);
Scott Woode5d8d542007-08-21 03:40:02 +1000100void dt_get_reg_format(void *node, u32 *naddr, u32 *nsize);
Laurent Pinchartda0a5f02008-04-10 17:03:04 +0200101int dt_get_virtual_reg(void *node, void **addr, int nres);
Mark A. Greerb2c5f612006-09-19 14:05:08 +1000102
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
Scott Woodf61e7cd2007-03-16 12:28:49 -0500113static inline int setprop(void *devp, const char *name,
114 const void *buf, int buflen)
Mark A. Greerb2c5f612006-09-19 14:05:08 +1000115{
116 return (dt_ops.setprop) ? dt_ops.setprop(devp, name, buf, buflen) : -1;
117}
David Gibson27fbaa92007-03-22 17:02:21 +1100118#define setprop_val(devp, name, val) \
119 do { \
120 typeof(val) x = (val); \
121 setprop((devp), (name), &x, sizeof(x)); \
122 } while (0)
Mark A. Greerb2c5f612006-09-19 14:05:08 +1000123
Scott Wooda07940b2007-03-16 12:27:54 -0500124static 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
Mike Ditto71773f02008-10-21 11:32:29 +0000132static inline int del_node(const void *devp)
133{
134 return dt_ops.del_node ? dt_ops.del_node(devp) : -1;
135}
136
Scott Wooda07940b2007-03-16 12:27:54 -0500137static 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
Kumar Galaad160682008-01-15 09:30:32 -0600173static 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
Kumar Galab3bea152008-01-24 22:41:05 -0600186static 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
David Gibson27fbaa92007-03-22 17:02:21 +1100195void 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);
Kumar Galaad160682008-01-15 09:30:32 -0600198void dt_fixup_mac_address_by_alias(const char *alias, const u8 *addr);
Scott Wood27ff35d2007-09-25 06:09:11 +1000199void dt_fixup_mac_address(u32 index, const u8 *addr);
David Gibson27fbaa92007-03-22 17:02:21 +1100200void __dt_fixup_mac_addresses(u32 startindex, ...);
201#define dt_fixup_mac_addresses(...) \
202 __dt_fixup_mac_addresses(0, __VA_ARGS__, NULL)
203
204
Mark A. Greerd6f1d2a2007-03-27 15:31:41 -0700205static 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
Scott Wood21f3fe22007-09-06 05:21:12 +1000211static 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
Geert Uytterhoeven4ca478e2007-04-18 19:24:12 +1000219static inline void *malloc(unsigned long size)
Mark A. Greerb2c5f612006-09-19 14:05:08 +1000220{
221 return (platform_ops.malloc) ? platform_ops.malloc(size) : NULL;
222}
223
Mark A. Greerc8885542006-10-16 13:49:27 -0700224static inline void free(void *ptr)
Mark A. Greerb2c5f612006-09-19 14:05:08 +1000225{
226 if (platform_ops.free)
Mark A. Greerc8885542006-10-16 13:49:27 -0700227 platform_ops.free(ptr);
Mark A. Greerb2c5f612006-09-19 14:05:08 +1000228}
229
230static inline void exit(void)
231{
232 if (platform_ops.exit)
233 platform_ops.exit();
234 for(;;);
235}
Milton Miller6a923212007-03-21 09:02:44 -0600236#define fatal(args...) { printf(args); exit(); }
237
Mark A. Greerb2c5f612006-09-19 14:05:08 +1000238
David Gibsoncd197ff2007-03-05 14:24:52 +1100239#define BSS_STACK(size) \
240 static char _bss_stack[size]; \
241 void *_platform_stack_top = _bss_stack + sizeof(_bss_stack);
242
Scott Wood643d3c12007-08-21 03:39:45 +1000243extern unsigned long timebase_period_ns;
Scott Wood3ee9b7a2007-08-21 03:39:55 +1000244void udelay(long delay);
Scott Wood643d3c12007-08-21 03:39:45 +1000245
Scott Wood2f1d4892007-08-21 03:39:58 +1000246extern 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
Scott Woode5d8d542007-08-21 03:40:02 +1000256static 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
Oliver O'Halloran1b7898e2016-09-22 16:54:31 +1000264long partial_decompress(void *inbuf, unsigned long input_size, void *outbuf,
265 unsigned long output_size, unsigned long skip);
266
Mark A. Greerb2c5f612006-09-19 14:05:08 +1000267#endif /* _PPC_BOOT_OPS_H_ */