common: Move interrupt functions into a new header
[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 like command.h. 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 unsigned char           uchar;
19 typedef volatile unsigned long  vu_long;
20 typedef volatile unsigned short vu_short;
21 typedef volatile unsigned char  vu_char;
22
23 #include <config.h>
24 #include <errno.h>
25 #include <time.h>
26 #include <asm-offsets.h>
27 #include <linux/bitops.h>
28 #include <linux/bug.h>
29 #include <linux/delay.h>
30 #include <linux/types.h>
31 #include <linux/printk.h>
32 #include <linux/string.h>
33 #include <linux/stringify.h>
34 #include <asm/ptrace.h>
35 #include <stdarg.h>
36 #include <stdio.h>
37 #include <linux/kernel.h>
38
39 #include <part.h>
40 #include <flash.h>
41 #include <image.h>
42
43 #ifdef __LP64__
44 #define CONFIG_SYS_SUPPORT_64BIT_DATA
45 #endif
46
47 #include <log.h>
48
49 typedef void (interrupt_handler_t)(void *);
50
51 #include <asm/u-boot.h> /* boot information for Linux kernel */
52 #include <asm/global_data.h>    /* global data used for startup functions */
53
54 /* startup functions, used in:
55  * common/board_f.c
56  * common/init/board_init.c
57  * common/board_r.c
58  * common/board_info.c
59  */
60 #include <init.h>
61
62 /*
63  * Function Prototypes
64  */
65 void    hang            (void) __attribute__ ((noreturn));
66
67 #include <display_options.h>
68
69 /* common/main.c */
70 void    main_loop       (void);
71 int run_command(const char *cmd, int flag);
72 int run_command_repeatable(const char *cmd, int flag);
73
74 /**
75  * Run a list of commands separated by ; or even \0
76  *
77  * Note that if 'len' is not -1, then the command does not need to be nul
78  * terminated, Memory will be allocated for the command in that case.
79  *
80  * @param cmd   List of commands to run, each separated bu semicolon
81  * @param len   Length of commands excluding terminator if known (-1 if not)
82  * @param flag  Execution flags (CMD_FLAG_...)
83  * @return 0 on success, or != 0 on error.
84  */
85 int run_command_list(const char *cmd, int len, int flag);
86
87 int checkflash(void);
88 int checkdram(void);
89 extern u8 __dtb_dt_begin[];     /* embedded device tree blob */
90 extern u8 __dtb_dt_spl_begin[]; /* embedded device tree blob for SPL/TPL */
91 int mdm_init(void);
92
93 /**
94  * Show the DRAM size in a board-specific way
95  *
96  * This is used by boards to display DRAM information in their own way.
97  *
98  * @param size  Size of DRAM (which should be displayed along with other info)
99  */
100 void board_show_dram(phys_size_t size);
101
102 /**
103  * Get the uppermost pointer that is valid to access
104  *
105  * Some systems may not map all of their address space. This function allows
106  * boards to indicate what their highest support pointer value is for DRAM
107  * access.
108  *
109  * @param total_size    Size of U-Boot (unused?)
110  */
111 ulong board_get_usable_ram_top(ulong total_size);
112
113 /**
114  * arch_fixup_fdt() - Write arch-specific information to fdt
115  *
116  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
117  *
118  * @blob:       FDT blob to write to
119  * @return 0 if ok, or -ve FDT_ERR_... on failure
120  */
121 int arch_fixup_fdt(void *blob);
122
123 /* common/flash.c */
124 void flash_perror (int);
125
126 /* common/cmd_source.c */
127 int     source (ulong addr, const char *fit_uname);
128
129 extern ulong load_addr;         /* Default Load Address */
130 extern ulong save_addr;         /* Default Save Address */
131 extern ulong save_size;         /* Default Save Size */
132
133 /* common/cmd_net.c */
134 int do_tftpb(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
135
136 /* common/cmd_fat.c */
137 int do_fat_fsload(cmd_tbl_t *, int, int, char * const []);
138
139 /* common/cmd_ext2.c */
140 int do_ext2load(cmd_tbl_t *, int, int, char * const []);
141
142 void    pci_init_board(void);
143
144 /* common/exports.c */
145 void    jumptable_init(void);
146
147 /* common/kallsysm.c */
148 const char *symbol_lookup(unsigned long addr, unsigned long *caddr);
149
150 /* common/memsize.c */
151 long    get_ram_size  (long *, long);
152 phys_size_t get_effective_memsize(void);
153
154 /* $(BOARD)/$(BOARD).c */
155 void    reset_phy     (void);
156 void    fdc_hw_init   (void);
157
158 /* $(BOARD)/eeprom.c */
159 #ifdef CONFIG_CMD_EEPROM
160 void eeprom_init  (int bus);
161 int  eeprom_read  (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
162 int  eeprom_write (unsigned dev_addr, unsigned offset, uchar *buffer, unsigned cnt);
163 #else
164 /*
165  * Some EEPROM code is depecated because it used the legacy I2C interface. Add
166  * some macros here so we don't have to touch every one of those uses
167  */
168 #define eeprom_init(bus)
169 #define eeprom_read(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
170 #define eeprom_write(dev_addr, offset, buffer, cnt) ((void)-ENOSYS)
171 #endif
172
173 #if !defined(CONFIG_ENV_EEPROM_IS_ON_I2C) && defined(CONFIG_SYS_I2C_EEPROM_ADDR)
174 # define CONFIG_SYS_DEF_EEPROM_ADDR CONFIG_SYS_I2C_EEPROM_ADDR
175 #endif
176
177 /* $(BOARD)/$(BOARD).c */
178 int board_early_init_f (void);
179 int board_fix_fdt (void *rw_fdt_blob); /* manipulate the U-Boot fdt before its relocation */
180 int board_late_init (void);
181 int board_postclk_init (void); /* after clocks/timebase, before env/serial */
182 int board_early_init_r (void);
183
184 #if defined(CONFIG_SYS_DRAM_TEST)
185 int testdram(void);
186 #endif /* CONFIG_SYS_DRAM_TEST */
187
188 #if defined(CONFIG_ARM)
189 void    relocate_code(ulong);
190 #else
191 void    relocate_code(ulong, gd_t *, ulong) __attribute__ ((noreturn));
192 #endif
193 ulong   get_endaddr   (void);
194 void    trap_init     (ulong);
195
196 void s_init(void);
197
198 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
199 ulong   get_tbclk     (void);
200 void    reset_misc    (void);
201 void    reset_cpu     (ulong addr);
202 void ft_cpu_setup(void *blob, bd_t *bd);
203 void ft_pci_setup(void *blob, bd_t *bd);
204
205 /* $(CPU)/speed.c */
206 int     get_clocks (void);
207 ulong   get_bus_freq  (ulong);
208 int get_serial_clock(void);
209
210 /* $(CPU)/interrupts.c */
211 void    enable_interrupts  (void);
212 int     disable_interrupts (void);
213
214 /* lib/uuid.c */
215 #include <uuid.h>
216
217 /* lib/vsprintf.c */
218 #include <vsprintf.h>
219
220 /* lib/net_utils.c */
221 #include <net.h>
222
223 #include <bootstage.h>
224
225 #else   /* __ASSEMBLY__ */
226
227 #endif  /* __ASSEMBLY__ */
228
229 /* Put only stuff here that the assembler can digest */
230
231 #ifdef CONFIG_POST
232 #define CONFIG_HAS_POST
233 #ifndef CONFIG_POST_ALT_LIST
234 #define CONFIG_POST_STD_LIST
235 #endif
236 #endif
237
238 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
239
240 /*
241  * check_member() - Check the offset of a structure member
242  *
243  * @structure:  Name of structure (e.g. global_data)
244  * @member:     Name of member (e.g. baudrate)
245  * @offset:     Expected offset in bytes
246  */
247 #define check_member(structure, member, offset) _Static_assert( \
248         offsetof(struct structure, member) == offset, \
249         "`struct " #structure "` offset for `" #member "` is not " #offset)
250
251 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
252 #ifdef CONFIG_EFI_STUB
253 #define ll_boot_init()  false
254 #else
255 #define ll_boot_init()  true
256 #endif
257
258 /* Pull in stuff for the build system */
259 #ifdef DO_DEPS_ONLY
260 # include <env_internal.h>
261 #endif
262
263 #endif  /* __COMMON_H_ */