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