linux/arch/x86/boot/boot.h

/* SPDX-License-Identifier: GPL-2.0-only */
/* -*- linux-c -*- ------------------------------------------------------- *
 *
 *   Copyright (C) 1991, 1992 Linus Torvalds
 *   Copyright 2007 rPath, Inc. - All Rights Reserved
 *   Copyright 2009 Intel Corporation; author H. Peter Anvin
 *
 * ----------------------------------------------------------------------- */

/*
 * Header file for the real-mode kernel code
 */

#ifndef BOOT_BOOT_H
#define BOOT_BOOT_H

#define STACK_SIZE …

#ifndef __ASSEMBLY__

#include <linux/stdarg.h>
#include <linux/types.h>
#include <linux/edd.h>
#include <asm/setup.h>
#include <asm/asm.h>
#include "bitops.h"
#include "ctype.h"
#include "cpuflags.h"
#include "io.h"

/* Useful macros */
#define ARRAY_SIZE(x) …

extern struct setup_header hdr;
extern struct boot_params boot_params;

#define cpu_relax() …

static inline void io_delay(void)
{ … }

/* These functions are used to reference data in other segments. */

static inline u16 ds(void)
{ … }

static inline void set_fs(u16 seg)
{ … }
static inline u16 fs(void)
{ … }

static inline void set_gs(u16 seg)
{ … }
static inline u16 gs(void)
{ … }

addr_t;

static inline u8 rdfs8(addr_t addr)
{ … }
static inline u16 rdfs16(addr_t addr)
{ … }
static inline u32 rdfs32(addr_t addr)
{ … }

static inline void wrfs8(u8 v, addr_t addr)
{ … }
static inline void wrfs16(u16 v, addr_t addr)
{ … }
static inline void wrfs32(u32 v, addr_t addr)
{ … }

static inline u8 rdgs8(addr_t addr)
{ … }
static inline u16 rdgs16(addr_t addr)
{ … }
static inline u32 rdgs32(addr_t addr)
{ … }

static inline void wrgs8(u8 v, addr_t addr)
{ … }
static inline void wrgs16(u16 v, addr_t addr)
{ … }
static inline void wrgs32(u32 v, addr_t addr)
{ … }

/* Note: these only return true/false, not a signed return value! */
static inline bool memcmp_fs(const void *s1, addr_t s2, size_t len)
{ … }
static inline bool memcmp_gs(const void *s1, addr_t s2, size_t len)
{ … }

/* Heap -- available for dynamic lists. */
extern char _end[];
extern char *HEAP;
extern char *heap_end;
#define RESET_HEAP() …
static inline char *__get_heap(size_t s, size_t a, size_t n)
{ … }
#define GET_HEAP(type, n) …

static inline bool heap_free(size_t n)
{ … }

/* copy.S */

void copy_to_fs(addr_t dst, void *src, size_t len);
void *copy_from_fs(void *dst, addr_t src, size_t len);
void copy_to_gs(addr_t dst, void *src, size_t len);
void *copy_from_gs(void *dst, addr_t src, size_t len);

/* a20.c */
int enable_a20(void);

/* apm.c */
int query_apm_bios(void);

/* bioscall.c */
struct biosregs { … };
void intcall(u8 int_no, const struct biosregs *ireg, struct biosregs *oreg);

/* cmdline.c */
int __cmdline_find_option(unsigned long cmdline_ptr, const char *option, char *buffer, int bufsize);
int __cmdline_find_option_bool(unsigned long cmdline_ptr, const char *option);
static inline int cmdline_find_option(const char *option, char *buffer, int bufsize)
{ … }

static inline int cmdline_find_option_bool(const char *option)
{ … }

/* cpu.c, cpucheck.c */
int check_cpu(int *cpu_level_ptr, int *req_level_ptr, u32 **err_flags_ptr);
int check_knl_erratum(void);
int validate_cpu(void);

/* early_serial_console.c */
extern int early_serial_base;
void console_init(void);

/* edd.c */
void query_edd(void);

/* header.S */
void __attribute__((noreturn)) die(void);

/* memory.c */
void detect_memory(void);

/* pm.c */
void __attribute__((noreturn)) go_to_protected_mode(void);

/* pmjump.S */
void __attribute__((noreturn))
	protected_mode_jump(u32 entrypoint, u32 bootparams);

/* printf.c */
int sprintf(char *buf, const char *fmt, ...);
int vsprintf(char *buf, const char *fmt, va_list args);
int printf(const char *fmt, ...);

/* regs.c */
void initregs(struct biosregs *regs);

/* string.c */
int strcmp(const char *str1, const char *str2);
int strncmp(const char *cs, const char *ct, size_t count);
size_t strnlen(const char *s, size_t maxlen);
unsigned int atou(const char *s);
unsigned long long simple_strtoull(const char *cp, char **endp, unsigned int base);
size_t strlen(const char *s);
char *strchr(const char *s, int c);

/* tty.c */
void puts(const char *);
void putchar(int);
int getchar(void);
void kbd_flush(void);
int getchar_timeout(void);

/* video.c */
void set_video(void);

/* video-mode.c */
int set_mode(u16 mode);
int mode_defined(u16 mode);
void probe_cards(int unsafe);

/* video-vesa.c */
void vesa_store_edid(void);

#endif /* __ASSEMBLY__ */

#endif /* BOOT_BOOT_H */