xref: /openbmc/linux/arch/powerpc/boot/ops.h (revision c21b37f6)
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 };
51 extern struct dt_ops dt_ops;
52 
53 /* Console operations */
54 struct console_ops {
55 	int	(*open)(void);
56 	void	(*write)(const char *buf, int len);
57 	void	(*edit_cmdline)(char *buf, int len);
58 	void	(*close)(void);
59 	void	*data;
60 };
61 extern struct console_ops console_ops;
62 
63 /* Serial console operations */
64 struct serial_console_data {
65 	int		(*open)(void);
66 	void		(*putc)(unsigned char c);
67 	unsigned char	(*getc)(void);
68 	u8		(*tstc)(void);
69 	void		(*close)(void);
70 };
71 
72 struct loader_info {
73 	void *promptr;
74 	unsigned long initrd_addr, initrd_size;
75 	char *cmdline;
76 	int cmdline_len;
77 };
78 extern struct loader_info loader_info;
79 
80 void start(void);
81 int ft_init(void *dt_blob, unsigned int max_size, unsigned int max_find_device);
82 int serial_console_init(void);
83 int ns16550_console_init(void *devp, struct serial_console_data *scdp);
84 int mpsc_console_init(void *devp, struct serial_console_data *scdp);
85 void *simple_alloc_init(char *base, unsigned long heap_size,
86 			unsigned long granularity, unsigned long max_allocs);
87 extern void flush_cache(void *, unsigned long);
88 int dt_xlate_reg(void *node, int res, unsigned long *addr, unsigned long *size);
89 int dt_xlate_addr(void *node, u32 *buf, int buflen, unsigned long *xlated_addr);
90 
91 static inline void *finddevice(const char *name)
92 {
93 	return (dt_ops.finddevice) ? dt_ops.finddevice(name) : NULL;
94 }
95 
96 static inline int getprop(void *devp, const char *name, void *buf, int buflen)
97 {
98 	return (dt_ops.getprop) ? dt_ops.getprop(devp, name, buf, buflen) : -1;
99 }
100 
101 static inline int setprop(void *devp, const char *name,
102                           const void *buf, int buflen)
103 {
104 	return (dt_ops.setprop) ? dt_ops.setprop(devp, name, buf, buflen) : -1;
105 }
106 #define setprop_val(devp, name, val) \
107 	do { \
108 		typeof(val) x = (val); \
109 		setprop((devp), (name), &x, sizeof(x)); \
110 	} while (0)
111 
112 static inline int setprop_str(void *devp, const char *name, const char *buf)
113 {
114 	if (dt_ops.setprop)
115 		return dt_ops.setprop(devp, name, buf, strlen(buf) + 1);
116 
117 	return -1;
118 }
119 
120 static inline void *get_parent(const char *devp)
121 {
122 	return dt_ops.get_parent ? dt_ops.get_parent(devp) : NULL;
123 }
124 
125 static inline void *create_node(const void *parent, const char *name)
126 {
127 	return dt_ops.create_node ? dt_ops.create_node(parent, name) : NULL;
128 }
129 
130 
131 static inline void *find_node_by_prop_value(const void *prev,
132                                             const char *propname,
133                                             const char *propval, int proplen)
134 {
135 	if (dt_ops.find_node_by_prop_value)
136 		return dt_ops.find_node_by_prop_value(prev, propname,
137 		                                      propval, proplen);
138 
139 	return NULL;
140 }
141 
142 static inline void *find_node_by_prop_value_str(const void *prev,
143                                                 const char *propname,
144                                                 const char *propval)
145 {
146 	return find_node_by_prop_value(prev, propname, propval,
147 	                               strlen(propval) + 1);
148 }
149 
150 static inline void *find_node_by_devtype(const void *prev,
151                                          const char *type)
152 {
153 	return find_node_by_prop_value_str(prev, "device_type", type);
154 }
155 
156 void dt_fixup_memory(u64 start, u64 size);
157 void dt_fixup_cpu_clocks(u32 cpufreq, u32 tbfreq, u32 busfreq);
158 void dt_fixup_clock(const char *path, u32 freq);
159 void __dt_fixup_mac_addresses(u32 startindex, ...);
160 #define dt_fixup_mac_addresses(...) \
161 	__dt_fixup_mac_addresses(0, __VA_ARGS__, NULL)
162 
163 
164 static inline void *find_node_by_linuxphandle(const u32 linuxphandle)
165 {
166 	return find_node_by_prop_value(NULL, "linux,phandle",
167 			(char *)&linuxphandle, sizeof(u32));
168 }
169 
170 static inline void *malloc(unsigned long size)
171 {
172 	return (platform_ops.malloc) ? platform_ops.malloc(size) : NULL;
173 }
174 
175 static inline void free(void *ptr)
176 {
177 	if (platform_ops.free)
178 		platform_ops.free(ptr);
179 }
180 
181 static inline void exit(void)
182 {
183 	if (platform_ops.exit)
184 		platform_ops.exit();
185 	for(;;);
186 }
187 #define fatal(args...) { printf(args); exit(); }
188 
189 
190 #define BSS_STACK(size) \
191 	static char _bss_stack[size]; \
192 	void *_platform_stack_top = _bss_stack + sizeof(_bss_stack);
193 
194 #endif /* _PPC_BOOT_OPS_H_ */
195