4ee14f78d0ab5a3dc4aaf59411ee3432301f8aff
[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 #include <config.h>
19 #include <errno.h>
20 #include <time.h>
21 #include <asm-offsets.h>
22 #include <linux/bitops.h>
23 #include <linux/bug.h>
24 #include <linux/delay.h>
25 #include <linux/types.h>
26 #include <linux/printk.h>
27 #include <linux/string.h>
28 #include <linux/stringify.h>
29 #include <asm/ptrace.h>
30 #include <stdarg.h>
31 #include <stdio.h>
32 #include <linux/kernel.h>
33
34 #include <part.h>
35 #include <flash.h>
36 #include <image.h>
37
38 #ifdef __LP64__
39 #define CONFIG_SYS_SUPPORT_64BIT_DATA
40 #endif
41
42 #include <log.h>
43
44 #include <asm/u-boot.h> /* boot information for Linux kernel */
45 #include <asm/global_data.h>    /* global data used for startup functions */
46
47 /* startup functions, used in:
48  * common/board_f.c
49  * common/init/board_init.c
50  * common/board_r.c
51  * common/board_info.c
52  */
53 #include <init.h>
54
55 /*
56  * Function Prototypes
57  */
58 void    hang            (void) __attribute__ ((noreturn));
59
60 #include <display_options.h>
61
62 /**
63  * arch_fixup_fdt() - Write arch-specific information to fdt
64  *
65  * Defined in arch/$(ARCH)/lib/bootm-fdt.c
66  *
67  * @blob:       FDT blob to write to
68  * @return 0 if ok, or -ve FDT_ERR_... on failure
69  */
70 int arch_fixup_fdt(void *blob);
71
72 /* common/cmd_source.c */
73 int     source (ulong addr, const char *fit_uname);
74
75 extern ulong load_addr;         /* Default Load Address */
76 extern ulong save_addr;         /* Default Save Address */
77 extern ulong save_size;         /* Default Save Size */
78
79 /* common/memsize.c */
80 long    get_ram_size  (long *, long);
81 phys_size_t get_effective_memsize(void);
82
83 #if defined(CONFIG_SYS_DRAM_TEST)
84 int testdram(void);
85 #endif /* CONFIG_SYS_DRAM_TEST */
86
87 void s_init(void);
88
89 void    upmconfig     (unsigned int, unsigned int *, unsigned int);
90 ulong   get_tbclk     (void);
91 void    reset_misc    (void);
92 void    reset_cpu     (ulong addr);
93 void ft_cpu_setup(void *blob, bd_t *bd);
94 void ft_pci_setup(void *blob, bd_t *bd);
95
96 /* $(CPU)/speed.c */
97 int     get_clocks (void);
98 ulong   get_bus_freq  (ulong);
99 int get_serial_clock(void);
100
101 /* lib/uuid.c */
102 #include <uuid.h>
103
104 /* lib/vsprintf.c */
105 #include <vsprintf.h>
106
107 /* lib/net_utils.c */
108 #include <net.h>
109
110 #include <bootstage.h>
111
112 #else   /* __ASSEMBLY__ */
113
114 #endif  /* __ASSEMBLY__ */
115
116 /* Put only stuff here that the assembler can digest */
117
118 #define ROUND(a,b)              (((a) + (b) - 1) & ~((b) - 1))
119
120 /*
121  * check_member() - Check the offset of a structure member
122  *
123  * @structure:  Name of structure (e.g. global_data)
124  * @member:     Name of member (e.g. baudrate)
125  * @offset:     Expected offset in bytes
126  */
127 #define check_member(structure, member, offset) _Static_assert( \
128         offsetof(struct structure, member) == offset, \
129         "`struct " #structure "` offset for `" #member "` is not " #offset)
130
131 /* Avoid using CONFIG_EFI_STUB directly as we may boot from other loaders */
132 #ifdef CONFIG_EFI_STUB
133 #define ll_boot_init()  false
134 #else
135 #define ll_boot_init()  true
136 #endif
137
138 /* Pull in stuff for the build system */
139 #ifdef DO_DEPS_ONLY
140 # include <env_internal.h>
141 #endif
142
143 #endif  /* __COMMON_H_ */