arch/powerpc/boot/ops.h

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