1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* -*- linux-c -*- ------------------------------------------------------- * 3 * 4 * Copyright (C) 1991, 1992 Linus Torvalds 5 * Copyright 2007 rPath, Inc. - All Rights Reserved 6 * Copyright 2009 Intel Corporation; author H. Peter Anvin 7 * 8 * ----------------------------------------------------------------------- */ 9 10 /* 11 * Header file for the real-mode kernel code 12 */ 13 14 #ifndef BOOT_BOOT_H 15 #define BOOT_BOOT_H 16 17 #define STACK_SIZE 1024 /* Minimum number of bytes for stack */ 18 19 #ifndef __ASSEMBLY__ 20 21 #include <stdarg.h> 22 #include <linux/types.h> 23 #include <linux/edd.h> 24 #include <asm/setup.h> 25 #include <asm/asm.h> 26 #include "bitops.h" 27 #include "ctype.h" 28 #include "cpuflags.h" 29 30 /* Useful macros */ 31 #define BUILD_BUG_ON(condition) ((void)sizeof(char[1 - 2*!!(condition)])) 32 33 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(*(x))) 34 35 extern struct setup_header hdr; 36 extern struct boot_params boot_params; 37 38 #define cpu_relax() asm volatile("rep; nop") 39 40 /* Basic port I/O */ 41 static inline void outb(u8 v, u16 port) 42 { 43 asm volatile("outb %0,%1" : : "a" (v), "dN" (port)); 44 } 45 static inline u8 inb(u16 port) 46 { 47 u8 v; 48 asm volatile("inb %1,%0" : "=a" (v) : "dN" (port)); 49 return v; 50 } 51 52 static inline void outw(u16 v, u16 port) 53 { 54 asm volatile("outw %0,%1" : : "a" (v), "dN" (port)); 55 } 56 static inline u16 inw(u16 port) 57 { 58 u16 v; 59 asm volatile("inw %1,%0" : "=a" (v) : "dN" (port)); 60 return v; 61 } 62 63 static inline void outl(u32 v, u16 port) 64 { 65 asm volatile("outl %0,%1" : : "a" (v), "dN" (port)); 66 } 67 static inline u32 inl(u16 port) 68 { 69 u32 v; 70 asm volatile("inl %1,%0" : "=a" (v) : "dN" (port)); 71 return v; 72 } 73 74 static inline void io_delay(void) 75 { 76 const u16 DELAY_PORT = 0x80; 77 asm volatile("outb %%al,%0" : : "dN" (DELAY_PORT)); 78 } 79 80 /* These functions are used to reference data in other segments. */ 81 82 static inline u16 ds(void) 83 { 84 u16 seg; 85 asm("movw %%ds,%0" : "=rm" (seg)); 86 return seg; 87 } 88 89 static inline void set_fs(u16 seg) 90 { 91 asm volatile("movw %0,%%fs" : : "rm" (seg)); 92 } 93 static inline u16 fs(void) 94 { 95 u16 seg; 96 asm volatile("movw %%fs,%0" : "=rm" (seg)); 97 return seg; 98 } 99 100 static inline void set_gs(u16 seg) 101 { 102 asm volatile("movw %0,%%gs" : : "rm" (seg)); 103 } 104 static inline u16 gs(void) 105 { 106 u16 seg; 107 asm volatile("movw %%gs,%0" : "=rm" (seg)); 108 return seg; 109 } 110 111 typedef unsigned int addr_t; 112 113 static inline u8 rdfs8(addr_t addr) 114 { 115 u8 v; 116 asm volatile("movb %%fs:%1,%0" : "=q" (v) : "m" (*(u8 *)addr)); 117 return v; 118 } 119 static inline u16 rdfs16(addr_t addr) 120 { 121 u16 v; 122 asm volatile("movw %%fs:%1,%0" : "=r" (v) : "m" (*(u16 *)addr)); 123 return v; 124 } 125 static inline u32 rdfs32(addr_t addr) 126 { 127 u32 v; 128 asm volatile("movl %%fs:%1,%0" : "=r" (v) : "m" (*(u32 *)addr)); 129 return v; 130 } 131 132 static inline void wrfs8(u8 v, addr_t addr) 133 { 134 asm volatile("movb %1,%%fs:%0" : "+m" (*(u8 *)addr) : "qi" (v)); 135 } 136 static inline void wrfs16(u16 v, addr_t addr) 137 { 138 asm volatile("movw %1,%%fs:%0" : "+m" (*(u16 *)addr) : "ri" (v)); 139 } 140 static inline void wrfs32(u32 v, addr_t addr) 141 { 142 asm volatile("movl %1,%%fs:%0" : "+m" (*(u32 *)addr) : "ri" (v)); 143 } 144 145 static inline u8 rdgs8(addr_t addr) 146 { 147 u8 v; 148 asm volatile("movb %%gs:%1,%0" : "=q" (v) : "m" (*(u8 *)addr)); 149 return v; 150 } 151 static inline u16 rdgs16(addr_t addr) 152 { 153 u16 v; 154 asm volatile("movw %%gs:%1,%0" : "=r" (v) : "m" (*(u16 *)addr)); 155 return v; 156 } 157 static inline u32 rdgs32(addr_t addr) 158 { 159 u32 v; 160 asm volatile("movl %%gs:%1,%0" : "=r" (v) : "m" (*(u32 *)addr)); 161 return v; 162 } 163 164 static inline void wrgs8(u8 v, addr_t addr) 165 { 166 asm volatile("movb %1,%%gs:%0" : "+m" (*(u8 *)addr) : "qi" (v)); 167 } 168 static inline void wrgs16(u16 v, addr_t addr) 169 { 170 asm volatile("movw %1,%%gs:%0" : "+m" (*(u16 *)addr) : "ri" (v)); 171 } 172 static inline void wrgs32(u32 v, addr_t addr) 173 { 174 asm volatile("movl %1,%%gs:%0" : "+m" (*(u32 *)addr) : "ri" (v)); 175 } 176 177 /* Note: these only return true/false, not a signed return value! */ 178 static inline bool memcmp_fs(const void *s1, addr_t s2, size_t len) 179 { 180 bool diff; 181 asm volatile("fs; repe; cmpsb" CC_SET(nz) 182 : CC_OUT(nz) (diff), "+D" (s1), "+S" (s2), "+c" (len)); 183 return diff; 184 } 185 static inline bool memcmp_gs(const void *s1, addr_t s2, size_t len) 186 { 187 bool diff; 188 asm volatile("gs; repe; cmpsb" CC_SET(nz) 189 : CC_OUT(nz) (diff), "+D" (s1), "+S" (s2), "+c" (len)); 190 return diff; 191 } 192 193 /* Heap -- available for dynamic lists. */ 194 extern char _end[]; 195 extern char *HEAP; 196 extern char *heap_end; 197 #define RESET_HEAP() ((void *)( HEAP = _end )) 198 static inline char *__get_heap(size_t s, size_t a, size_t n) 199 { 200 char *tmp; 201 202 HEAP = (char *)(((size_t)HEAP+(a-1)) & ~(a-1)); 203 tmp = HEAP; 204 HEAP += s*n; 205 return tmp; 206 } 207 #define GET_HEAP(type, n) \ 208 ((type *)__get_heap(sizeof(type),__alignof__(type),(n))) 209 210 static inline bool heap_free(size_t n) 211 { 212 return (int)(heap_end-HEAP) >= (int)n; 213 } 214 215 /* copy.S */ 216 217 void copy_to_fs(addr_t dst, void *src, size_t len); 218 void *copy_from_fs(void *dst, addr_t src, size_t len); 219 void copy_to_gs(addr_t dst, void *src, size_t len); 220 void *copy_from_gs(void *dst, addr_t src, size_t len); 221 222 /* a20.c */ 223 int enable_a20(void); 224 225 /* apm.c */ 226 int query_apm_bios(void); 227 228 /* bioscall.c */ 229 struct biosregs { 230 union { 231 struct { 232 u32 edi; 233 u32 esi; 234 u32 ebp; 235 u32 _esp; 236 u32 ebx; 237 u32 edx; 238 u32 ecx; 239 u32 eax; 240 u32 _fsgs; 241 u32 _dses; 242 u32 eflags; 243 }; 244 struct { 245 u16 di, hdi; 246 u16 si, hsi; 247 u16 bp, hbp; 248 u16 _sp, _hsp; 249 u16 bx, hbx; 250 u16 dx, hdx; 251 u16 cx, hcx; 252 u16 ax, hax; 253 u16 gs, fs; 254 u16 es, ds; 255 u16 flags, hflags; 256 }; 257 struct { 258 u8 dil, dih, edi2, edi3; 259 u8 sil, sih, esi2, esi3; 260 u8 bpl, bph, ebp2, ebp3; 261 u8 _spl, _sph, _esp2, _esp3; 262 u8 bl, bh, ebx2, ebx3; 263 u8 dl, dh, edx2, edx3; 264 u8 cl, ch, ecx2, ecx3; 265 u8 al, ah, eax2, eax3; 266 }; 267 }; 268 }; 269 void intcall(u8 int_no, const struct biosregs *ireg, struct biosregs *oreg); 270 271 /* cmdline.c */ 272 int __cmdline_find_option(unsigned long cmdline_ptr, const char *option, char *buffer, int bufsize); 273 int __cmdline_find_option_bool(unsigned long cmdline_ptr, const char *option); 274 static inline int cmdline_find_option(const char *option, char *buffer, int bufsize) 275 { 276 unsigned long cmd_line_ptr = boot_params.hdr.cmd_line_ptr; 277 278 if (cmd_line_ptr >= 0x100000) 279 return -1; /* inaccessible */ 280 281 return __cmdline_find_option(cmd_line_ptr, option, buffer, bufsize); 282 } 283 284 static inline int cmdline_find_option_bool(const char *option) 285 { 286 unsigned long cmd_line_ptr = boot_params.hdr.cmd_line_ptr; 287 288 if (cmd_line_ptr >= 0x100000) 289 return -1; /* inaccessible */ 290 291 return __cmdline_find_option_bool(cmd_line_ptr, option); 292 } 293 294 /* cpu.c, cpucheck.c */ 295 int check_cpu(int *cpu_level_ptr, int *req_level_ptr, u32 **err_flags_ptr); 296 int check_knl_erratum(void); 297 int validate_cpu(void); 298 299 /* early_serial_console.c */ 300 extern int early_serial_base; 301 void console_init(void); 302 303 /* edd.c */ 304 void query_edd(void); 305 306 /* header.S */ 307 void __attribute__((noreturn)) die(void); 308 309 /* memory.c */ 310 void detect_memory(void); 311 312 /* pm.c */ 313 void __attribute__((noreturn)) go_to_protected_mode(void); 314 315 /* pmjump.S */ 316 void __attribute__((noreturn)) 317 protected_mode_jump(u32 entrypoint, u32 bootparams); 318 319 /* printf.c */ 320 int sprintf(char *buf, const char *fmt, ...); 321 int vsprintf(char *buf, const char *fmt, va_list args); 322 int printf(const char *fmt, ...); 323 324 /* regs.c */ 325 void initregs(struct biosregs *regs); 326 327 /* string.c */ 328 int strcmp(const char *str1, const char *str2); 329 int strncmp(const char *cs, const char *ct, size_t count); 330 size_t strnlen(const char *s, size_t maxlen); 331 unsigned int atou(const char *s); 332 unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base); 333 size_t strlen(const char *s); 334 char *strchr(const char *s, int c); 335 336 /* tty.c */ 337 void puts(const char *); 338 void putchar(int); 339 int getchar(void); 340 void kbd_flush(void); 341 int getchar_timeout(void); 342 343 /* video.c */ 344 void set_video(void); 345 346 /* video-mode.c */ 347 int set_mode(u16 mode); 348 int mode_defined(u16 mode); 349 void probe_cards(int unsafe); 350 351 /* video-vesa.c */ 352 void vesa_store_edid(void); 353 354 #endif /* __ASSEMBLY__ */ 355 356 #endif /* BOOT_BOOT_H */ 357