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