blob: b8d82332173d967dd2636c37ae0019f0f74350a0 [file] [log] [blame]
Kevin O'Connorf076a3e2008-02-25 22:25:15 -05001// Basic x86 asm functions and function defs.
2//
Kevin O'Connor5b199ac2009-05-06 23:23:01 -04003// Copyright (C) 2008,2009 Kevin O'Connor <kevin@koconnor.net>
Kevin O'Connorf076a3e2008-02-25 22:25:15 -05004//
Kevin O'Connorb1b7c2a2009-01-15 20:52:58 -05005// This file may be distributed under the terms of the GNU LGPLv3 license.
Kevin O'Connor786502d2008-02-27 10:41:41 -05006#ifndef __UTIL_H
7#define __UTIL_H
Kevin O'Connorf076a3e2008-02-25 22:25:15 -05008
Kevin O'Connor9521e262008-07-04 13:04:29 -04009#include "types.h" // u32
Kevin O'Connorf076a3e2008-02-25 22:25:15 -050010
Kevin O'Connor786502d2008-02-27 10:41:41 -050011static inline void irq_disable(void)
12{
13 asm volatile("cli": : :"memory");
Kevin O'Connorf076a3e2008-02-25 22:25:15 -050014}
15
Kevin O'Connor786502d2008-02-27 10:41:41 -050016static inline void irq_enable(void)
17{
18 asm volatile("sti": : :"memory");
Kevin O'Connorf076a3e2008-02-25 22:25:15 -050019}
20
21static inline unsigned long irq_save(void)
22{
23 unsigned long flags;
24 asm volatile("pushfl ; popl %0" : "=g" (flags));
25 irq_disable();
26 return flags;
27}
28
29static inline void irq_restore(unsigned long flags)
30{
31 asm volatile("pushl %0 ; popfl" : : "g" (flags) : "memory", "cc");
32}
33
Kevin O'Connor06ad44e2008-04-05 19:30:02 -040034static inline void cpu_relax(void)
35{
36 asm volatile("rep ; nop": : :"memory");
37}
38
Kevin O'Connor38fcbfe2008-02-25 22:30:47 -050039static inline void nop(void)
40{
41 asm volatile("nop");
42}
43
Kevin O'Connor95b2f782008-03-05 19:52:06 -050044static inline void hlt(void)
45{
46 asm volatile("hlt");
47}
48
Kevin O'Connorda4a6482008-06-08 13:48:06 -040049static inline void wbinvd(void)
50{
51 asm volatile("wbinvd");
52}
53
Kevin O'Connore97ca7b2009-06-21 09:10:28 -040054#define CPUID_MSR (1 << 5)
55#define CPUID_APIC (1 << 9)
56#define CPUID_MTRR (1 << 12)
Kevin O'Connor84ad59a2008-07-04 05:47:26 -040057static inline void cpuid(u32 index, u32 *eax, u32 *ebx, u32 *ecx, u32 *edx)
58{
59 asm("cpuid"
60 : "=a" (*eax), "=b" (*ebx), "=c" (*ecx), "=d" (*edx)
61 : "0" (index));
62}
63
Kevin O'Connore97ca7b2009-06-21 09:10:28 -040064static inline u64 rdmsr(u32 index)
65{
66 u64 ret;
67 asm ("rdmsr" : "=A"(ret) : "c"(index));
68 return ret;
69}
70
71static inline void wrmsr(u32 index, u64 val)
72{
73 asm volatile ("wrmsr" : : "c"(index), "A"(val));
74}
75
Kevin O'Connorbc2aecd2008-11-28 16:40:06 -050076static inline u64 rdtscll(void)
77{
78 u64 val;
79 asm volatile("rdtsc" : "=A" (val));
80 return val;
81}
82
Kevin O'Connor0bf92702009-08-01 11:45:37 -040083static inline u32 __ffs(u32 word)
84{
85 asm("bsf %1,%0"
86 : "=r" (word)
87 : "rm" (word));
88 return word;
89}
90
Kevin O'Connoreaa2e552009-08-10 00:03:04 -040091// GDT bit manipulation
Kevin O'Connora3855ad2009-08-16 21:59:40 -040092#define GDT_BASE(v) ((((u64)(v) & 0xff000000) << 32) \
93 | (((u64)(v) & 0x00ffffff) << 16))
94#define GDT_LIMIT(v) ((((u64)(v) & 0x000f0000) << 32) \
95 | (((u64)(v) & 0x0000ffff) << 0))
Kevin O'Connoreaa2e552009-08-10 00:03:04 -040096#define GDT_CODE (0x9bULL << 40) // Code segment - P,R,A bits also set
97#define GDT_DATA (0x93ULL << 40) // Data segment - W,A bits also set
98#define GDT_B (0x1ULL << 54) // Big flag
99#define GDT_G (0x1ULL << 55) // Granularity flag
100
Kevin O'Connor942d4952009-06-10 22:44:06 -0400101#define call16_simpint(nr, peax, pflags) do { \
Kevin O'Connor0b60a062009-06-15 23:03:05 -0400102 ASSERT16(); \
Kevin O'Connor942d4952009-06-10 22:44:06 -0400103 asm volatile( \
104 "stc\n" \
105 "int %2\n" \
106 "pushfl\n" \
107 "popl %1\n" \
108 "cli\n" \
109 "cld" \
110 : "+a"(*peax), "=r"(*pflags) \
111 : "i"(nr) \
112 : "cc", "memory"); \
113 } while (0)
114
Kevin O'Connora83ff552009-01-01 21:00:59 -0500115// util.c
116inline u32 stack_hop(u32 eax, u32 edx, u32 ecx, void *func);
Kevin O'Connor94fd47e2009-02-15 15:21:10 -0500117u8 checksum_far(u16 buf_seg, void *buf_far, u32 len);
118u8 checksum(void *buf, u32 len);
Kevin O'Connor38d1a342009-04-18 16:59:47 -0400119int memcmp(const void *s1, const void *s2, size_t n);
Kevin O'Connor67823442009-04-13 14:14:51 -0400120size_t strlen(const char *s);
Kevin O'Connor38d1a342009-04-18 16:59:47 -0400121int strcmp(const char *s1, const char *s2);
Kevin O'Connor5b199ac2009-05-06 23:23:01 -0400122inline void memset_far(u16 d_seg, void *d_far, u8 c, size_t len);
123inline void memset16_far(u16 d_seg, void *d_far, u16 c, size_t len);
Kevin O'Connor5e4235f2008-04-12 09:00:04 -0400124void *memset(void *s, int c, size_t n);
Kevin O'Connor5a1d0fc2009-06-15 23:35:30 -0400125void *memcpy(void *d1, const void *s1, size_t len);
126#if MODE16 == 0
Kevin O'Connor942d4952009-06-10 22:44:06 -0400127#define memcpy __builtin_memcpy
Kevin O'Connor5a1d0fc2009-06-15 23:35:30 -0400128#endif
Kevin O'Connor8b267cb2009-01-19 19:25:21 -0500129inline void memcpy_far(u16 d_seg, void *d_far
130 , u16 s_seg, const void *s_far, size_t len);
Kevin O'Connorc7812932008-06-08 23:08:12 -0400131void *memmove(void *d, const void *s, size_t len);
Kevin O'Connor71f036d2009-02-08 16:57:22 -0500132char *strtcpy(char *dest, const char *src, size_t len);
Kevin O'Connor9521e262008-07-04 13:04:29 -0400133struct bregs;
134inline void call16(struct bregs *callregs);
Kevin O'Connor6e5b4a42008-12-06 13:03:52 -0500135inline void call16big(struct bregs *callregs);
Kevin O'Connor9521e262008-07-04 13:04:29 -0400136inline void __call16_int(struct bregs *callregs, u16 offset);
Kevin O'Connor3a47a312008-03-01 14:46:37 -0500137#define call16_int(nr, callregs) do { \
138 extern void irq_trampoline_ ##nr (); \
Kevin O'Connor117fc212008-04-13 18:17:02 -0400139 __call16_int((callregs), (u32)&irq_trampoline_ ##nr ); \
Kevin O'Connor38fcbfe2008-02-25 22:30:47 -0500140 } while (0)
Kevin O'Connor5ca4b952009-02-15 13:45:48 -0500141void usleep(u32 usec);
Kevin O'Connor9f4e1d92009-02-08 15:44:08 -0500142int get_keystroke(int msec);
Kevin O'Connor38fcbfe2008-02-25 22:30:47 -0500143
Kevin O'Connorf076a3e2008-02-25 22:25:15 -0500144// output.c
Kevin O'Connor61d6b062008-06-21 12:15:10 -0400145void debug_serial_setup();
Kevin O'Connore07e18e2009-02-08 17:07:29 -0500146void panic(const char *fmt, ...)
Kevin O'Connor567e4e32008-04-05 11:37:51 -0400147 __attribute__ ((format (printf, 1, 2)))
148 __attribute__ ((noreturn));
Kevin O'Connor567e4e32008-04-05 11:37:51 -0400149void printf(const char *fmt, ...)
150 __attribute__ ((format (printf, 1, 2)));
Kevin O'Connorac8df8c2008-05-24 23:46:33 -0400151void __dprintf(const char *fmt, ...)
152 __attribute__ ((format (printf, 1, 2)));
153#define dprintf(lvl, fmt, args...) do { \
154 if (CONFIG_DEBUG_LEVEL && (lvl) <= CONFIG_DEBUG_LEVEL) \
155 __dprintf((fmt) , ##args ); \
156 } while (0)
Kevin O'Connor05600342009-01-02 13:10:58 -0500157void __debug_enter(struct bregs *regs, const char *fname);
158void __debug_stub(struct bregs *regs, int lineno, const char *fname);
Kevin O'Connored128492008-03-11 11:14:59 -0400159void __debug_isr(const char *fname);
Kevin O'Connor15c1f222008-06-12 22:59:43 -0400160#define debug_enter(regs, lvl) do { \
161 if ((lvl) && (lvl) <= CONFIG_DEBUG_LEVEL) \
Kevin O'Connor05600342009-01-02 13:10:58 -0500162 __debug_enter((regs), __func__); \
Kevin O'Connor15c1f222008-06-12 22:59:43 -0400163 } while (0)
164#define debug_isr(lvl) do { \
165 if ((lvl) && (lvl) <= CONFIG_DEBUG_LEVEL) \
166 __debug_isr(__func__); \
167 } while (0)
Kevin O'Connor05600342009-01-02 13:10:58 -0500168#define debug_stub(regs) \
169 __debug_stub((regs), __LINE__, __func__)
Kevin O'Connor1eba4292009-02-17 23:14:25 -0500170void hexdump(void *d, int len);
Kevin O'Connorf076a3e2008-02-25 22:25:15 -0500171
172// kbd.c
Kevin O'Connorefda97d2008-07-04 13:10:12 -0400173void kbd_setup();
Kevin O'Connorf076a3e2008-02-25 22:25:15 -0500174void handle_15c2(struct bregs *regs);
Kevin O'Connorbdce35f2008-02-26 21:33:14 -0500175
Kevin O'Connorf54c1502008-06-14 15:56:16 -0400176// mouse.c
177void mouse_setup();
178
179// system.c
Kevin O'Connore7916362008-12-28 22:03:17 -0500180extern u32 RamSize;
181extern u64 RamSizeOver4G;
Kevin O'Connorf54c1502008-06-14 15:56:16 -0400182void mathcp_setup();
183
Kevin O'Connor913cc2e2008-04-13 17:31:45 -0400184// serial.c
185void serial_setup();
186void lpt_setup();
187
Kevin O'Connorbdce35f2008-02-26 21:33:14 -0500188// clock.c
Kevin O'Connore6eb3f52008-04-13 17:37:41 -0400189void timer_setup();
Kevin O'Connorbc2aecd2008-11-28 16:40:06 -0500190void ndelay(u32 count);
191void udelay(u32 count);
192void mdelay(u32 count);
Kevin O'Connor4e6c9702008-12-13 10:45:50 -0500193u64 calc_future_tsc(u32 msecs);
Kevin O'Connorbdce35f2008-02-26 21:33:14 -0500194void handle_1583(struct bregs *regs);
Kevin O'Connor5be04902008-05-18 17:12:06 -0400195void handle_1586(struct bregs *regs);
Kevin O'Connorbdce35f2008-02-26 21:33:14 -0500196
Kevin O'Connor95b2f782008-03-05 19:52:06 -0500197// apm.c
Kevin O'Connor44d65302008-03-08 11:34:46 -0500198void VISIBLE16 handle_1553(struct bregs *regs);
Kevin O'Connor95b2f782008-03-05 19:52:06 -0500199
Kevin O'Connora0dc2962008-03-16 14:29:32 -0400200// pcibios.c
201void handle_1ab1(struct bregs *regs);
202
Kevin O'Connorda4a6482008-06-08 13:48:06 -0400203// shadow.c
204void make_bios_writable();
205void make_bios_readonly();
206
Kevin O'Connor0525d292008-07-04 06:18:30 -0400207// pciinit.c
208void pci_bios_setup(void);
Kevin O'Connora4d35762008-03-08 15:43:03 -0500209
Kevin O'Connorf7ba6d72008-07-04 05:05:54 -0400210// smm.c
211void smm_init();
212
Kevin O'Connore97ca7b2009-06-21 09:10:28 -0400213// smp.c
Kevin O'Connor603bfc32009-06-22 20:04:56 -0400214extern u32 CountCPUs;
Kevin O'Connore97ca7b2009-06-21 09:10:28 -0400215void wrmsr_smp(u32 index, u64 val);
216void smp_probe(void);
Kevin O'Connoracf13742008-11-29 11:19:19 -0500217void smp_probe_setup(void);
Kevin O'Connor84ad59a2008-07-04 05:47:26 -0400218
Kevin O'Connor0525d292008-07-04 06:18:30 -0400219// smbios.c
220void smbios_init(void);
221
Kevin O'Connorc7812932008-06-08 23:08:12 -0400222// coreboot.c
Kevin O'Connor1edc89d2009-04-30 21:50:35 -0400223struct cbfs_file;
Kevin O'Connor1f836252009-08-16 20:17:35 -0400224struct cbfs_file *cbfs_findprefix(const char *prefix, struct cbfs_file *last);
Kevin O'Connor00882592009-08-18 22:21:10 -0400225u32 cbfs_datasize(struct cbfs_file *file);
Kevin O'Connor1f836252009-08-16 20:17:35 -0400226const char *cbfs_filename(struct cbfs_file *file);
Kevin O'Connor00882592009-08-18 22:21:10 -0400227int cbfs_copyfile(struct cbfs_file *file, void *dst, u32 maxlen);
Kevin O'Connor1f836252009-08-16 20:17:35 -0400228int cbfs_copy_optionrom(void *dst, u32 maxlen, u32 vendev);
229void cbfs_run_payload(struct cbfs_file *file);
230
Kevin O'Connordf5a5fd2009-07-28 20:46:03 -0400231void coreboot_copy_biostable();
Kevin O'Connor4c0c85a2009-04-11 23:31:29 -0400232void coreboot_setup();
Kevin O'Connorc7812932008-06-08 23:08:12 -0400233
Kevin O'Connorcbffa8e2008-08-17 11:11:07 -0400234// vgahooks.c
Kevin O'Connor22e1b912009-07-19 18:52:46 -0400235extern int VGAbdf;
Kevin O'Connorcbffa8e2008-08-17 11:11:07 -0400236void handle_155f();
Kevin O'Connor22e1b912009-07-19 18:52:46 -0400237void vgahook_setup(const char *vendor, const char *part);
Kevin O'Connorcbffa8e2008-08-17 11:11:07 -0400238
Kevin O'Connor714325c2008-11-01 20:32:27 -0400239// optionroms.c
Kevin O'Connor0a924122009-02-08 19:43:47 -0500240void call_bcv(u16 seg, u16 ip);
Kevin O'Connor714325c2008-11-01 20:32:27 -0400241void optionrom_setup();
Kevin O'Connore8f00ee2009-07-04 04:04:36 -0400242void vga_setup();
Kevin O'Connord282af72009-07-04 04:10:32 -0400243void s3_resume_vga_init();
Kevin O'Connore7739302009-07-26 19:16:09 -0400244extern u32 RomEnd;
Kevin O'Connor714325c2008-11-01 20:32:27 -0400245
Kevin O'Connor18e38b22008-12-10 20:40:13 -0500246// resume.c
247void init_dma();
248
Kevin O'Connor0c3068d2008-12-21 17:51:36 -0500249// pnpbios.c
250#define PNP_SIGNATURE 0x506e5024 // $PnP
251u16 get_pnp_offset();
252void pnp_setup();
253
Kevin O'Connore54ee382009-07-26 19:33:13 -0400254// pmm.c
Kevin O'Connor0bf92702009-08-01 11:45:37 -0400255void *malloc_high(u32 size);
256void *malloc_fseg(u32 size);
257void malloc_setup();
258void malloc_finalize();
Kevin O'Connore54ee382009-07-26 19:33:13 -0400259void pmm_setup();
260void pmm_finalize();
Kevin O'Connor0bf92702009-08-01 11:45:37 -0400261// Minimum alignment of malloc'd memory
262#define MALLOC_MIN_ALIGN 16
Kevin O'Connore54ee382009-07-26 19:33:13 -0400263
Kevin O'Connor7061eb62009-01-04 21:48:22 -0500264// mtrr.c
265void mtrr_setup(void);
266
Kevin O'Connor18e38b22008-12-10 20:40:13 -0500267// romlayout.S
268void reset_vector() __attribute__ ((noreturn));
269
Kevin O'Connor30853762009-01-17 18:49:20 -0500270// misc.c
271extern u8 BiosChecksum;
272
Kevin O'Connorb64db302009-07-29 19:20:03 -0400273// mptable.c
274extern int irq0override;
275
Kevin O'Connorc95d2ce2009-07-29 20:41:39 -0400276// version (auto generated file out/version.c)
277extern const char VERSION[];
278
Kevin O'Connor786502d2008-02-27 10:41:41 -0500279#endif // util.h