xref: /openbmc/linux/arch/powerpc/boot/ops.h (revision 96de0e252cedffad61b3cb5e05662c591898e69a)
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	COMMAND_LINE_SIZE	512
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 };
34 extern struct platform_ops platform_ops;
35 
36 /* Device Tree operations */
37 struct dt_ops {
38 	void *	(*finddevice)(const char *name);
39 	int	(*getprop)(const void *phandle, const char *name, void *buf,
40 			const int buflen);
41 	int	(*setprop)(const void *phandle, const char *name,
42 			const void *buf, const int buflen);
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 	unsigned long (*finalize)(void);
50 	char *(*get_path)(const void *phandle, char *buf, int len);
51 };
52 extern struct dt_ops dt_ops;
53 
54 /* Console operations */
55 struct console_ops {
56 	int	(*open)(void);
57 	void	(*write)(const char *buf, int len);
58 	void	(*edit_cmdline)(char *buf, int len);
59 	void	(*close)(void);
60 	void	*data;
61 };
62 extern struct console_ops console_ops;
63 
64 /* Serial console operations */
65 struct serial_console_data {
66 	int		(*open)(void);
67 	void		(*putc)(unsigned char c);
68 	unsigned char	(*getc)(void);
69 	u8		(*tstc)(void);
70 	void		(*close)(void);
71 };
72 
73 struct loader_info {
74 	void *promptr;
75 	unsigned long initrd_addr, initrd_size;
76 	char *cmdline;
77 	int cmdline_len;
78 };
79 extern struct loader_info loader_info;
80 
81 void start(void);
82 int ft_init(void *dt_blob, unsigned int max_size, unsigned int max_find_device);
83 int serial_console_init(void);
84 int ns16550_console_init(void *devp, struct serial_console_data *scdp);
85 int mpsc_console_init(void *devp, struct serial_console_data *scdp);
86 int cpm_console_init(void *devp, struct serial_console_data *scdp);
87 int mpc5200_psc_console_init(void *devp, struct serial_console_data *scdp);
88 int uartlite_console_init(void *devp, struct serial_console_data *scdp);
89 void *simple_alloc_init(char *base, unsigned long heap_size,
90 			unsigned long granularity, unsigned long max_allocs);
91 extern void flush_cache(void *, unsigned long);
92 int dt_xlate_reg(void *node, int res, unsigned long *addr, unsigned long *size);
93 int dt_xlate_addr(void *node, u32 *buf, int buflen, unsigned long *xlated_addr);
94 int dt_is_compatible(void *node, const char *compat);
95 void dt_get_reg_format(void *node, u32 *naddr, u32 *nsize);
96 
97 static inline void *finddevice(const char *name)
98 {
99 	return (dt_ops.finddevice) ? dt_ops.finddevice(name) : NULL;
100 }
101 
102 static inline int getprop(void *devp, const char *name, void *buf, int buflen)
103 {
104 	return (dt_ops.getprop) ? dt_ops.getprop(devp, name, buf, buflen) : -1;
105 }
106 
107 static inline int setprop(void *devp, const char *name,
108                           const void *buf, int buflen)
109 {
110 	return (dt_ops.setprop) ? dt_ops.setprop(devp, name, buf, buflen) : -1;
111 }
112 #define setprop_val(devp, name, val) \
113 	do { \
114 		typeof(val) x = (val); \
115 		setprop((devp), (name), &x, sizeof(x)); \
116 	} while (0)
117 
118 static inline int setprop_str(void *devp, const char *name, const char *buf)
119 {
120 	if (dt_ops.setprop)
121 		return dt_ops.setprop(devp, name, buf, strlen(buf) + 1);
122 
123 	return -1;
124 }
125 
126 static inline void *get_parent(const char *devp)
127 {
128 	return dt_ops.get_parent ? dt_ops.get_parent(devp) : NULL;
129 }
130 
131 static inline void *create_node(const void *parent, const char *name)
132 {
133 	return dt_ops.create_node ? dt_ops.create_node(parent, name) : NULL;
134 }
135 
136 
137 static inline void *find_node_by_prop_value(const void *prev,
138                                             const char *propname,
139                                             const char *propval, int proplen)
140 {
141 	if (dt_ops.find_node_by_prop_value)
142 		return dt_ops.find_node_by_prop_value(prev, propname,
143 		                                      propval, proplen);
144 
145 	return NULL;
146 }
147 
148 static inline void *find_node_by_prop_value_str(const void *prev,
149                                                 const char *propname,
150                                                 const char *propval)
151 {
152 	return find_node_by_prop_value(prev, propname, propval,
153 	                               strlen(propval) + 1);
154 }
155 
156 static inline void *find_node_by_devtype(const void *prev,
157                                          const char *type)
158 {
159 	return find_node_by_prop_value_str(prev, "device_type", type);
160 }
161 
162 void dt_fixup_memory(u64 start, u64 size);
163 void dt_fixup_cpu_clocks(u32 cpufreq, u32 tbfreq, u32 busfreq);
164 void dt_fixup_clock(const char *path, u32 freq);
165 void dt_fixup_mac_address(u32 index, const u8 *addr);
166 void __dt_fixup_mac_addresses(u32 startindex, ...);
167 #define dt_fixup_mac_addresses(...) \
168 	__dt_fixup_mac_addresses(0, __VA_ARGS__, NULL)
169 
170 
171 static inline void *find_node_by_linuxphandle(const u32 linuxphandle)
172 {
173 	return find_node_by_prop_value(NULL, "linux,phandle",
174 			(char *)&linuxphandle, sizeof(u32));
175 }
176 
177 static inline char *get_path(const void *phandle, char *buf, int len)
178 {
179 	if (dt_ops.get_path)
180 		return dt_ops.get_path(phandle, buf, len);
181 
182 	return NULL;
183 }
184 
185 static inline void *malloc(unsigned long size)
186 {
187 	return (platform_ops.malloc) ? platform_ops.malloc(size) : NULL;
188 }
189 
190 static inline void free(void *ptr)
191 {
192 	if (platform_ops.free)
193 		platform_ops.free(ptr);
194 }
195 
196 static inline void exit(void)
197 {
198 	if (platform_ops.exit)
199 		platform_ops.exit();
200 	for(;;);
201 }
202 #define fatal(args...) { printf(args); exit(); }
203 
204 
205 #define BSS_STACK(size) \
206 	static char _bss_stack[size]; \
207 	void *_platform_stack_top = _bss_stack + sizeof(_bss_stack);
208 
209 extern unsigned long timebase_period_ns;
210 void udelay(long delay);
211 
212 extern char _start[];
213 extern char __bss_start[];
214 extern char _end[];
215 extern char _vmlinux_start[];
216 extern char _vmlinux_end[];
217 extern char _initrd_start[];
218 extern char _initrd_end[];
219 extern char _dtb_start[];
220 extern char _dtb_end[];
221 
222 static inline __attribute__((const))
223 int __ilog2_u32(u32 n)
224 {
225 	int bit;
226 	asm ("cntlzw %0,%1" : "=r" (bit) : "r" (n));
227 	return 31 - bit;
228 }
229 
230 #endif /* _PPC_BOOT_OPS_H_ */
231