Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 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 | |
Scott Wood | ce3edb3 | 2007-03-12 14:41:38 -0600 | [diff] [blame] | 14 | #include <stddef.h> |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 15 | #include "types.h" |
Scott Wood | a07940b | 2007-03-16 12:27:54 -0500 | [diff] [blame] | 16 | #include "string.h" |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 17 | |
Anton Blanchard | 579a53c | 2014-04-14 21:55:25 +1000 | [diff] [blame] | 18 | #define BOOT_COMMAND_LINE_SIZE 2048 |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 19 | #define MAX_PATH_LEN 256 |
| 20 | #define MAX_PROP_LEN 256 /* What should this be? */ |
| 21 | |
Geoff Levand | 62cf6a9 | 2007-06-16 08:06:44 +1000 | [diff] [blame] | 22 | typedef void (*kernel_entry_t)(unsigned long r3, unsigned long r4, void *r5); |
| 23 | |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 24 | /* Platform specific operations */ |
| 25 | struct platform_ops { |
| 26 | void (*fixups)(void); |
| 27 | void (*image_hdr)(const void *); |
Geert Uytterhoeven | 4ca478e | 2007-04-18 19:24:12 +1000 | [diff] [blame] | 28 | void * (*malloc)(unsigned long size); |
Mark A. Greer | c888554 | 2006-10-16 13:49:27 -0700 | [diff] [blame] | 29 | void (*free)(void *ptr); |
| 30 | void * (*realloc)(void *ptr, unsigned long size); |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 31 | void (*exit)(void); |
David Gibson | 79c8541 | 2007-03-05 14:24:52 +1100 | [diff] [blame] | 32 | void * (*vmlinux_alloc)(unsigned long size); |
Oliver O'Halloran | a1ff574 | 2016-11-23 13:55:13 +1100 | [diff] [blame] | 33 | void (*kentry)(unsigned long fdt_addr, void *vmlinux_addr); |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 34 | }; |
| 35 | extern struct platform_ops platform_ops; |
| 36 | |
| 37 | /* Device Tree operations */ |
| 38 | struct dt_ops { |
| 39 | void * (*finddevice)(const char *name); |
Mark A. Greer | c888554 | 2006-10-16 13:49:27 -0700 | [diff] [blame] | 40 | int (*getprop)(const void *phandle, const char *name, void *buf, |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 41 | const int buflen); |
Mark A. Greer | c888554 | 2006-10-16 13:49:27 -0700 | [diff] [blame] | 42 | int (*setprop)(const void *phandle, const char *name, |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 43 | const void *buf, const int buflen); |
Mike Ditto | 71773f0 | 2008-10-21 11:32:29 +0000 | [diff] [blame] | 44 | int (*del_node)(const void *phandle); |
Scott Wood | a07940b | 2007-03-16 12:27:54 -0500 | [diff] [blame] | 45 | 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 Gala | b3bea15 | 2008-01-24 22:41:05 -0600 | [diff] [blame] | 51 | void *(*find_node_by_compatible)(const void *prev, |
| 52 | const char *compat); |
David Gibson | 35af89e | 2006-11-21 11:37:37 +1100 | [diff] [blame] | 53 | unsigned long (*finalize)(void); |
Scott Wood | 21f3fe2 | 2007-09-06 05:21:12 +1000 | [diff] [blame] | 54 | char *(*get_path)(const void *phandle, char *buf, int len); |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 55 | }; |
| 56 | extern struct dt_ops dt_ops; |
| 57 | |
| 58 | /* Console operations */ |
| 59 | struct console_ops { |
| 60 | int (*open)(void); |
Geoff Levand | b96fbb6 | 2007-06-16 08:06:40 +1000 | [diff] [blame] | 61 | void (*write)(const char *buf, int len); |
Simon Kagstrom | 4b4b13d | 2014-10-28 12:19:00 +0100 | [diff] [blame] | 62 | void (*edit_cmdline)(char *buf, int len, unsigned int getline_timeout); |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 63 | void (*close)(void); |
| 64 | void *data; |
| 65 | }; |
| 66 | extern struct console_ops console_ops; |
| 67 | |
| 68 | /* Serial console operations */ |
| 69 | struct 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 Gibson | cd197ff | 2007-03-05 14:24:52 +1100 | [diff] [blame] | 77 | struct loader_info { |
| 78 | void *promptr; |
| 79 | unsigned long initrd_addr, initrd_size; |
David Gibson | 3af82a8 | 2007-03-22 17:02:21 +1100 | [diff] [blame] | 80 | char *cmdline; |
| 81 | int cmdline_len; |
David Gibson | cd197ff | 2007-03-05 14:24:52 +1100 | [diff] [blame] | 82 | }; |
| 83 | extern struct loader_info loader_info; |
| 84 | |
David Gibson | e5a2072b | 2007-03-22 17:02:21 +1100 | [diff] [blame] | 85 | void start(void); |
David Gibson | 2f0dfea | 2007-12-10 14:28:39 +1100 | [diff] [blame] | 86 | void fdt_init(void *blob); |
Mark A. Greer | c888554 | 2006-10-16 13:49:27 -0700 | [diff] [blame] | 87 | int serial_console_init(void); |
| 88 | int ns16550_console_init(void *devp, struct serial_console_data *scdp); |
Mark A. Greer | e12deb8 | 2007-05-12 10:54:31 +1000 | [diff] [blame] | 89 | int mpsc_console_init(void *devp, struct serial_console_data *scdp); |
Scott Wood | d0f53fa | 2007-08-21 03:39:57 +1000 | [diff] [blame] | 90 | int cpm_console_init(void *devp, struct serial_console_data *scdp); |
Grant Likely | 85498ae | 2007-09-01 03:34:37 +1000 | [diff] [blame] | 91 | int mpc5200_psc_console_init(void *devp, struct serial_console_data *scdp); |
Grant Likely | 7ddc5f9 | 2007-10-02 12:15:13 +1000 | [diff] [blame] | 92 | int uartlite_console_init(void *devp, struct serial_console_data *scdp); |
Oliver O'Halloran | 656ad58 | 2016-07-01 00:34:37 +1000 | [diff] [blame] | 93 | int opal_console_init(void *devp, struct serial_console_data *scdp); |
Geert Uytterhoeven | 4ca478e | 2007-04-18 19:24:12 +1000 | [diff] [blame] | 94 | void *simple_alloc_init(char *base, unsigned long heap_size, |
| 95 | unsigned long granularity, unsigned long max_allocs); |
Milton Miller | 0e68067 | 2007-03-19 14:58:06 -0600 | [diff] [blame] | 96 | extern void flush_cache(void *, unsigned long); |
Mark A. Greer | 8895ea4 | 2007-04-28 06:48:24 +1000 | [diff] [blame] | 97 | int dt_xlate_reg(void *node, int res, unsigned long *addr, unsigned long *size); |
| 98 | int dt_xlate_addr(void *node, u32 *buf, int buflen, unsigned long *xlated_addr); |
Scott Wood | a73ac50 | 2007-08-21 03:39:48 +1000 | [diff] [blame] | 99 | int dt_is_compatible(void *node, const char *compat); |
Scott Wood | e5d8d54 | 2007-08-21 03:40:02 +1000 | [diff] [blame] | 100 | void dt_get_reg_format(void *node, u32 *naddr, u32 *nsize); |
Laurent Pinchart | da0a5f0 | 2008-04-10 17:03:04 +0200 | [diff] [blame] | 101 | int dt_get_virtual_reg(void *node, void **addr, int nres); |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 102 | |
| 103 | static inline void *finddevice(const char *name) |
| 104 | { |
| 105 | return (dt_ops.finddevice) ? dt_ops.finddevice(name) : NULL; |
| 106 | } |
| 107 | |
| 108 | static 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 Wood | f61e7cd | 2007-03-16 12:28:49 -0500 | [diff] [blame] | 113 | static inline int setprop(void *devp, const char *name, |
| 114 | const void *buf, int buflen) |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 115 | { |
| 116 | return (dt_ops.setprop) ? dt_ops.setprop(devp, name, buf, buflen) : -1; |
| 117 | } |
David Gibson | 27fbaa9 | 2007-03-22 17:02:21 +1100 | [diff] [blame] | 118 | #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. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 123 | |
Scott Wood | a07940b | 2007-03-16 12:27:54 -0500 | [diff] [blame] | 124 | static 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 Ditto | 71773f0 | 2008-10-21 11:32:29 +0000 | [diff] [blame] | 132 | static inline int del_node(const void *devp) |
| 133 | { |
| 134 | return dt_ops.del_node ? dt_ops.del_node(devp) : -1; |
| 135 | } |
| 136 | |
Scott Wood | a07940b | 2007-03-16 12:27:54 -0500 | [diff] [blame] | 137 | static inline void *get_parent(const char *devp) |
| 138 | { |
| 139 | return dt_ops.get_parent ? dt_ops.get_parent(devp) : NULL; |
| 140 | } |
| 141 | |
| 142 | static 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 | |
| 148 | static 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 | |
| 159 | static 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 | |
| 167 | static 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 Gala | ad16068 | 2008-01-15 09:30:32 -0600 | [diff] [blame] | 173 | static 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 Gala | b3bea15 | 2008-01-24 22:41:05 -0600 | [diff] [blame] | 186 | static 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 Gibson | 27fbaa9 | 2007-03-22 17:02:21 +1100 | [diff] [blame] | 195 | void dt_fixup_memory(u64 start, u64 size); |
| 196 | void dt_fixup_cpu_clocks(u32 cpufreq, u32 tbfreq, u32 busfreq); |
| 197 | void dt_fixup_clock(const char *path, u32 freq); |
Kumar Gala | ad16068 | 2008-01-15 09:30:32 -0600 | [diff] [blame] | 198 | void dt_fixup_mac_address_by_alias(const char *alias, const u8 *addr); |
Scott Wood | 27ff35d | 2007-09-25 06:09:11 +1000 | [diff] [blame] | 199 | void dt_fixup_mac_address(u32 index, const u8 *addr); |
David Gibson | 27fbaa9 | 2007-03-22 17:02:21 +1100 | [diff] [blame] | 200 | void __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. Greer | d6f1d2a | 2007-03-27 15:31:41 -0700 | [diff] [blame] | 205 | static 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 Wood | 21f3fe2 | 2007-09-06 05:21:12 +1000 | [diff] [blame] | 211 | static 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 Uytterhoeven | 4ca478e | 2007-04-18 19:24:12 +1000 | [diff] [blame] | 219 | static inline void *malloc(unsigned long size) |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 220 | { |
| 221 | return (platform_ops.malloc) ? platform_ops.malloc(size) : NULL; |
| 222 | } |
| 223 | |
Mark A. Greer | c888554 | 2006-10-16 13:49:27 -0700 | [diff] [blame] | 224 | static inline void free(void *ptr) |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 225 | { |
| 226 | if (platform_ops.free) |
Mark A. Greer | c888554 | 2006-10-16 13:49:27 -0700 | [diff] [blame] | 227 | platform_ops.free(ptr); |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 228 | } |
| 229 | |
| 230 | static inline void exit(void) |
| 231 | { |
| 232 | if (platform_ops.exit) |
| 233 | platform_ops.exit(); |
| 234 | for(;;); |
| 235 | } |
Milton Miller | 6a92321 | 2007-03-21 09:02:44 -0600 | [diff] [blame] | 236 | #define fatal(args...) { printf(args); exit(); } |
| 237 | |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 238 | |
David Gibson | cd197ff | 2007-03-05 14:24:52 +1100 | [diff] [blame] | 239 | #define BSS_STACK(size) \ |
| 240 | static char _bss_stack[size]; \ |
| 241 | void *_platform_stack_top = _bss_stack + sizeof(_bss_stack); |
| 242 | |
Scott Wood | 643d3c1 | 2007-08-21 03:39:45 +1000 | [diff] [blame] | 243 | extern unsigned long timebase_period_ns; |
Scott Wood | 3ee9b7a | 2007-08-21 03:39:55 +1000 | [diff] [blame] | 244 | void udelay(long delay); |
Scott Wood | 643d3c1 | 2007-08-21 03:39:45 +1000 | [diff] [blame] | 245 | |
Scott Wood | 2f1d489 | 2007-08-21 03:39:58 +1000 | [diff] [blame] | 246 | extern char _start[]; |
| 247 | extern char __bss_start[]; |
| 248 | extern char _end[]; |
| 249 | extern char _vmlinux_start[]; |
| 250 | extern char _vmlinux_end[]; |
| 251 | extern char _initrd_start[]; |
| 252 | extern char _initrd_end[]; |
| 253 | extern char _dtb_start[]; |
| 254 | extern char _dtb_end[]; |
| 255 | |
Scott Wood | e5d8d54 | 2007-08-21 03:40:02 +1000 | [diff] [blame] | 256 | static inline __attribute__((const)) |
| 257 | int __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'Halloran | 1b7898e | 2016-09-22 16:54:31 +1000 | [diff] [blame] | 264 | long partial_decompress(void *inbuf, unsigned long input_size, void *outbuf, |
| 265 | unsigned long output_size, unsigned long skip); |
| 266 | |
Mark A. Greer | b2c5f61 | 2006-09-19 14:05:08 +1000 | [diff] [blame] | 267 | #endif /* _PPC_BOOT_OPS_H_ */ |