doc: replace @return by Return:
[platform/kernel/u-boot.git] / arch / x86 / include / asm / u-boot-x86.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * (C) Copyright 2002
4  * Daniel Engström, Omicron Ceti AB, daniel@omicron.se.
5  */
6
7 #ifndef _U_BOOT_I386_H_
8 #define _U_BOOT_I386_H_ 1
9
10 struct global_data;
11
12 extern char gdt_rom[];
13
14 /* cpu/.../cpu.c */
15 int arch_cpu_init(void);
16
17 /**
18  * x86_cpu_init_f() - Set up basic features of the x86 CPU
19  *
20  * 0 on success, -ve on error
21  */
22 int x86_cpu_init_f(void);
23
24 /**
25  * x86_cpu_reinit_f() - Set up the CPU a second time
26  *
27  * Once cpu_init_f() has been called (e.g. in SPL) we should not call it
28  * again (e.g. in U-Boot proper) since it sets up the state from scratch.
29  * Call this function in later phases of U-Boot instead. It reads the CPU
30  * identify so that CPU functions can be used correctly, but does not change
31  * anything.
32  *
33  * Return: 0 (indicating success, to mimic cpu_init_f())
34  */
35 int x86_cpu_reinit_f(void);
36
37 /**
38  * x86_cpu_init_tpl() - Do the minimum possible CPU init
39  *
40  * This just sets up the CPU features and figured out the identity
41  *
42  * Return: 0 (indicating success, to mimic cpu_init_f())
43  */
44 int x86_cpu_init_tpl(void);
45
46 /**
47  * cpu_reinit_fpu() - Reinit the FPU if something is wrong with it
48  *
49  * The FSP-M code can leave registers in use in the FPU. This functions reinits
50  * it so that the FPU can be used safely
51  */
52 void cpu_reinit_fpu(void);
53
54 int cpu_init_f(void);
55 void setup_gdt(struct global_data *id, u64 *gdt_addr);
56 /*
57  * Setup FSP execution environment GDT to use the one we used in
58  * arch/x86/cpu/start16.S and reload the segment registers.
59  */
60 void setup_fsp_gdt(void);
61 int init_cache(void);
62 int cleanup_before_linux(void);
63
64 /* cpu/.../timer.c */
65 void timer_isr(void *);
66 typedef void (timer_fnc_t) (void);
67 int register_timer_isr (timer_fnc_t *isr_func);
68 unsigned long get_tbclk_mhz(void);
69 void timer_set_base(uint64_t base);
70 int i8254_init(void);
71
72 /* cpu/.../interrupts.c */
73 int cpu_init_interrupts(void);
74
75 int cleanup_before_linux(void);
76 int x86_cleanup_before_linux(void);
77 void x86_enable_caches(void);
78 void x86_disable_caches(void);
79 int x86_init_cache(void);
80 ulong board_get_usable_ram_top(ulong total_size);
81 int default_print_cpuinfo(void);
82
83 /* Set up a UART which can be used with printch(), printhex8(), etc. */
84 int setup_internal_uart(int enable);
85
86 void isa_unmap_rom(u32 addr);
87 u32 isa_map_rom(u32 bus_addr, int size);
88
89 /* arch/x86/lib/... */
90 int video_bios_init(void);
91
92 /* arch/x86/lib/fsp1,2/... */
93
94 /**
95  * fsp_save_s3_stack() - save stack address to CMOS for next S3 boot
96  *
97  * At the end of pre-relocation phase, save the new stack address
98  * to CMOS and use it as the stack on next S3 boot for fsp_init()
99  * continuation function.
100  *
101  * @return:     0 if OK, -ve on error
102  */
103 int fsp_save_s3_stack(void);
104
105 void    board_init_f_r_trampoline(ulong) __attribute__ ((noreturn));
106 void    board_init_f_r(void) __attribute__ ((noreturn));
107
108 int arch_misc_init(void);
109
110 /* Read the time stamp counter */
111 static inline __attribute__((no_instrument_function)) uint64_t rdtsc(void)
112 {
113         uint32_t high, low;
114         __asm__ __volatile__("rdtsc" : "=a" (low), "=d" (high));
115         return (((uint64_t)high) << 32) | low;
116 }
117
118 /* board/... */
119 void timer_set_tsc_base(uint64_t new_base);
120 uint64_t timer_get_tsc(void);
121
122 void quick_ram_check(void);
123
124 #define PCI_VGA_RAM_IMAGE_START         0xc0000
125
126 #endif  /* _U_BOOT_I386_H_ */