common: Move jumptable_init() out of common.h
[oweals/u-boot.git] / include / common.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Common header file for U-Boot
4  *
5  * This file still includes quite a bit of stuff that should be in separate
6  * headers. Please think before adding more things.
7  * Patches to remove things are welcome.
8  *
9  * (C) Copyright 2000-2009
10  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
11  */
12
13 #ifndef __COMMON_H_
14 #define __COMMON_H_     1
15
16 #ifndef __ASSEMBLY__            /* put C only stuff in this section */
17
18 typedef volatile unsigned long  vu_long;
19 typedef volatile unsigned short vu_short;
20 typedef volatile unsigned char  vu_char;
21
22 #include <config.h>
23 #include <errno.h>
24 #include <time.h>
25 #include <asm-offsets.h>
26 #include <linux/bitops.h>
27 #include <linux/bug.h>
28 #include <linux/delay.h>
29 #include <linux/types.h>
30 #include <linux/printk.h>
31 #include <linux/string.h>
32 #include <linux/stringify.h>
33 #include <asm/ptrace.h>
34 #include <stdarg.h>
35 #include <stdio.h>
36 #include <linux/kernel.h>
37
38 #include <part.h>
39 #include <flash.h>
40 #include <image.h>
41
42 #ifdef __LP64__
43 #define CONFIG_SYS_SUPPORT_64BIT_DATA
44 #endif
45
46 #include <log.h>
47
48 #include <asm/u-boot.h> /* boot information for Linux kernel */
49 #include <asm/global_data.h>    /* global data used for startup functions */
50
51 /* startup functions, used in:
52  * common/board_f.c
53  * common/init/board_init.c
54  * common/board_r.c
55  * common/board_info.c
56  */
57 #include <init.h>
58
59 /*
60  * Function Prototypes
61  */
62 void    hang            (void) __attribute__ ((noreturn));
63
64 #include <display_options.h>
65
66 /**
67  * arch_fixup_fdt() - Write arch-specific information to fdt
68  *
69  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
70  *
71  * @blob:       FDT blob to write to
72  * @return 0 if ok, or -ve FDT_ERR_... on failure
73  */
74 int arch_fixup_fdt(void *blob);
75
76 /* common/cmd_source.c */
77 int     source (ulong addr, const char *fit_uname);
78
79 extern ulong load_addr;         /* Default Load Address */
80 extern ulong save_addr;         /* Default Save Address */
81 extern ulong save_size;         /* Default Save Size */
82
83 /* common/kallsysm.c */
84 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
85
86 /* common/memsize.c */
87 long    get_ram_size  (long *, long);
88 phys_size_t get_effective_memsize(void);
89
90 /* $(BOARD)/$(BOARD).c */
91 void    reset_phy     (void);
92 void    fdc_hw_init   (void);
93
94 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) && defined(CONFIG_SYS_I2C_EEPROM_ADDR)
95 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
96 #endif
97
98 #if defined(CONFIG_SYS_DRAM_TEST)
99 int testdram(void);
100 #endif /* CONFIG_SYS_DRAM_TEST */
101
102 void s_init(void);
103
104 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
105 ulong   get_tbclk     (void);
106 void    reset_misc    (void);
107 void    reset_cpu     (ulong addr);
108 void ft_cpu_setup(void *blob, bd_t *bd);
109 void ft_pci_setup(void *blob, bd_t *bd);
110
111 /* $(CPU)/speed.c */
112 int     get_clocks (void);
113 ulong   get_bus_freq  (ulong);
114 int get_serial_clock(void);
115
116 /* lib/uuid.c */
117 #include <uuid.h>
118
119 /* lib/vsprintf.c */
120 #include <vsprintf.h>
121
122 /* lib/net_utils.c */
123 #include <net.h>
124
125 #include <bootstage.h>
126
127 #else   /* __ASSEMBLY__ */
128
129 #endif  /* __ASSEMBLY__ */
130
131 /* Put only stuff here that the assembler can digest */
132
133 #ifdef CONFIG_POST
134 #define CONFIG_HAS_POST
135 #ifndef CONFIG_POST_ALT_LIST
136 #define CONFIG_POST_STD_LIST
137 #endif
138 #endif
139
140 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
141
142 /*
143  * check_member() - Check the offset of a structure member
144  *
145  * @structure:  Name of structure (e.g. global_data)
146  * @member:     Name of member (e.g. baudrate)
147  * @offset:     Expected offset in bytes
148  */
149 #define check_member(structure, member, offset) _Static_assert( \
150         offsetof(struct structure, member) == offset, \
151         "`struct " #structure "` offset for `" #member "` is not " #offset)
152
153 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
154 #ifdef CONFIG_EFI_STUB
155 #define ll_boot_init()  false
156 #else
157 #define ll_boot_init()  true
158 #endif
159
160 /* Pull in stuff for the build system */
161 #ifdef DO_DEPS_ONLY
162 # include <env_internal.h>
163 #endif
164
165 #endif  /* __COMMON_H_ */