limine/limine.h

421 lines
9.8 KiB
C
Raw Normal View History

#ifndef _LIMINE_H
#define _LIMINE_H 1
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
2022-03-26 03:31:38 +03:00
/* Misc */
2022-03-16 08:49:41 +03:00
#ifdef LIMINE_NO_POINTERS
2022-03-12 23:41:36 +03:00
# define LIMINE_PTR(TYPE) uint64_t
#else
2022-03-12 23:41:36 +03:00
# define LIMINE_PTR(TYPE) TYPE
#endif
2022-03-13 07:35:29 +03:00
#define LIMINE_COMMON_MAGIC 0xc7b1dd30df4c8b88, 0x0a82e883a194f07b
2022-03-16 08:49:41 +03:00
struct limine_uuid {
uint32_t a;
uint16_t b;
uint16_t c;
uint8_t d[8];
};
#define LIMINE_MEDIA_TYPE_GENERIC 0
#define LIMINE_MEDIA_TYPE_OPTICAL 1
#define LIMINE_MEDIA_TYPE_TFTP 2
struct limine_file {
2022-03-20 23:23:47 +03:00
uint64_t revision;
2022-03-31 10:03:06 +03:00
LIMINE_PTR(void *) address;
uint64_t size;
LIMINE_PTR(char *) path;
LIMINE_PTR(char *) cmdline;
uint32_t media_type;
uint32_t unused;
uint32_t tftp_ip;
uint32_t tftp_port;
uint32_t partition_index;
2022-03-16 08:49:41 +03:00
uint32_t mbr_disk_id;
struct limine_uuid gpt_disk_uuid;
struct limine_uuid gpt_part_uuid;
struct limine_uuid part_uuid;
};
2022-03-26 03:31:38 +03:00
/* Boot info */
#define LIMINE_BOOTLOADER_INFO_REQUEST { LIMINE_COMMON_MAGIC, 0xf55038d8e2a1202f, 0x279426fcf5f59740 }
struct limine_bootloader_info_response {
2022-03-20 02:57:10 +03:00
uint64_t revision;
LIMINE_PTR(char *) name;
LIMINE_PTR(char *) version;
};
struct limine_bootloader_info_request {
2022-03-13 07:35:29 +03:00
uint64_t id[4];
2022-03-20 02:57:10 +03:00
uint64_t revision;
LIMINE_PTR(struct limine_bootloader_info_response *) response;
};
2022-03-28 09:00:40 +03:00
/* Stack size */
#define LIMINE_STACK_SIZE_REQUEST { LIMINE_COMMON_MAGIC, 0x224ef0460a8e8926, 0xe1cb0fc25f46ea3d }
struct limine_stack_size_response {
uint64_t revision;
};
struct limine_stack_size_request {
uint64_t id[4];
uint64_t revision;
LIMINE_PTR(struct limine_stack_size_response *) response;
uint64_t stack_size;
};
2022-03-26 03:31:38 +03:00
/* HHDM */
#define LIMINE_HHDM_REQUEST { LIMINE_COMMON_MAGIC, 0x48dcf1cb8ad2b852, 0x63984e959a98244b }
struct limine_hhdm_response {
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-24 04:18:33 +03:00
uint64_t offset;
};
struct limine_hhdm_request {
uint64_t id[4];
2022-03-20 02:57:10 +03:00
uint64_t revision;
LIMINE_PTR(struct limine_hhdm_response *) response;
2022-03-13 07:35:29 +03:00
};
2022-03-26 03:31:38 +03:00
/* Framebuffer */
#define LIMINE_FRAMEBUFFER_REQUEST { LIMINE_COMMON_MAGIC, 0x9d5827dcd881dd75, 0xa3148604f6fab11b }
2022-03-14 14:05:59 +03:00
#define LIMINE_FRAMEBUFFER_RGB 1
struct limine_framebuffer {
LIMINE_PTR(void *) address;
uint64_t width;
uint64_t height;
uint64_t pitch;
uint16_t bpp;
uint8_t memory_model;
uint8_t red_mask_size;
uint8_t red_mask_shift;
uint8_t green_mask_size;
uint8_t green_mask_shift;
uint8_t blue_mask_size;
uint8_t blue_mask_shift;
uint8_t unused[7];
uint64_t edid_size;
LIMINE_PTR(void *) edid;
};
2022-03-13 07:35:29 +03:00
struct limine_framebuffer_response {
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-20 23:23:47 +03:00
uint64_t framebuffer_count;
LIMINE_PTR(struct limine_framebuffer **) framebuffers;
2022-03-14 14:05:59 +03:00
};
2022-03-13 07:35:29 +03:00
struct limine_framebuffer_request {
uint64_t id[4];
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-13 07:35:29 +03:00
LIMINE_PTR(struct limine_framebuffer_response *) response;
};
2022-03-26 03:31:38 +03:00
/* Terminal */
2022-03-21 07:15:10 +03:00
#define LIMINE_TERMINAL_REQUEST { LIMINE_COMMON_MAGIC, 0xc8ac59310c2b0844, 0xa68d0c7265d38878 }
2022-03-21 07:15:10 +03:00
2022-03-28 05:57:02 +03:00
#define LIMINE_TERMINAL_CB_DEC 10
#define LIMINE_TERMINAL_CB_BELL 20
#define LIMINE_TERMINAL_CB_PRIVATE_ID 30
#define LIMINE_TERMINAL_CB_STATUS_REPORT 40
#define LIMINE_TERMINAL_CB_POS_REPORT 50
#define LIMINE_TERMINAL_CB_KBD_LEDS 60
#define LIMINE_TERMINAL_CB_MODE 70
#define LIMINE_TERMINAL_CB_LINUX 80
#define LIMINE_TERMINAL_CTX_SIZE ((uint64_t)(-1))
#define LIMINE_TERMINAL_CTX_SAVE ((uint64_t)(-2))
#define LIMINE_TERMINAL_CTX_RESTORE ((uint64_t)(-3))
#define LIMINE_TERMINAL_FULL_REFRESH ((uint64_t)(-4))
2022-03-28 01:01:32 +03:00
struct limine_terminal;
2022-04-02 11:05:14 +03:00
typedef void (*limine_terminal_write)(struct limine_terminal *, const char *, uint64_t);
typedef void (*limine_terminal_callback)(struct limine_terminal *, uint64_t, uint64_t, uint64_t, uint64_t);
2022-03-21 07:15:10 +03:00
struct limine_terminal {
uint64_t columns;
uint64_t rows;
LIMINE_PTR(struct limine_framebuffer *) framebuffer;
};
struct limine_terminal_response {
uint64_t revision;
uint64_t terminal_count;
LIMINE_PTR(struct limine_terminal **) terminals;
2022-04-02 11:05:14 +03:00
LIMINE_PTR(limine_terminal_write) write;
2022-03-21 07:15:10 +03:00
};
struct limine_terminal_request {
uint64_t id[4];
uint64_t revision;
LIMINE_PTR(struct limine_terminal_response *) response;
LIMINE_PTR(limine_terminal_callback) callback;
};
2022-03-26 03:31:38 +03:00
/* 5-level paging */
2022-03-13 07:35:29 +03:00
#define LIMINE_5_LEVEL_PAGING_REQUEST { LIMINE_COMMON_MAGIC, 0x94469551da9b3192, 0xebe5e86db7382888 }
struct limine_5_level_paging_response {
2022-03-20 02:57:10 +03:00
uint64_t revision;
};
2022-03-13 07:35:29 +03:00
struct limine_5_level_paging_request {
uint64_t id[4];
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-13 07:35:29 +03:00
LIMINE_PTR(struct limine_5_level_paging_response *) response;
};
2022-03-12 23:41:36 +03:00
2022-03-26 03:31:38 +03:00
/* SMP */
2022-03-18 03:17:56 +03:00
#define LIMINE_SMP_REQUEST { LIMINE_COMMON_MAGIC, 0x95a67b819a1b857e, 0xa0b61b723b6a73e0 }
struct limine_smp_info;
typedef void (*limine_goto_address)(struct limine_smp_info *);
2022-03-24 04:18:33 +03:00
#if defined (__x86_64__) || defined (__i386__)
#define LIMINE_SMP_X2APIC (1 << 0)
2022-03-18 03:17:56 +03:00
struct limine_smp_info {
uint32_t processor_id;
uint32_t lapic_id;
uint64_t reserved;
2022-03-24 04:18:33 +03:00
LIMINE_PTR(limine_goto_address) goto_address;
2022-03-18 03:17:56 +03:00
uint64_t extra_argument;
};
struct limine_smp_response {
2022-03-20 02:57:10 +03:00
uint64_t revision;
uint32_t flags;
2022-03-18 03:17:56 +03:00
uint32_t bsp_lapic_id;
2022-03-20 23:23:47 +03:00
uint64_t cpu_count;
LIMINE_PTR(struct limine_smp_info **) cpus;
2022-03-18 03:17:56 +03:00
};
#elif defined (__aarch64__)
struct limine_smp_info {
uint32_t processor_id;
uint32_t gic_iface_no;
uint64_t mpidr;
uint64_t reserved;
LIMINE_PTR(limine_goto_address) goto_address;
uint64_t extra_argument;
};
struct limine_smp_response {
uint64_t revision;
uint32_t flags;
uint64_t bsp_mpidr;
uint64_t cpu_count;
LIMINE_PTR(struct limine_smp_info **) cpus;
};
#else
#error Unknown architecture
#endif
2022-03-18 03:17:56 +03:00
struct limine_smp_request {
uint64_t id[4];
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-18 03:17:56 +03:00
LIMINE_PTR(struct limine_smp_response *) response;
2022-03-20 02:57:10 +03:00
uint64_t flags;
2022-03-18 03:17:56 +03:00
};
2022-03-26 03:31:38 +03:00
/* Memory map */
2022-03-12 23:41:36 +03:00
2022-03-13 07:35:29 +03:00
#define LIMINE_MEMMAP_REQUEST { LIMINE_COMMON_MAGIC, 0x67cf3d9d378a806f, 0xe304acdfc50c3c62 }
2022-03-12 23:41:36 +03:00
#define LIMINE_MEMMAP_USABLE 0
#define LIMINE_MEMMAP_RESERVED 1
#define LIMINE_MEMMAP_ACPI_RECLAIMABLE 2
#define LIMINE_MEMMAP_ACPI_NVS 3
#define LIMINE_MEMMAP_BAD_MEMORY 4
#define LIMINE_MEMMAP_BOOTLOADER_RECLAIMABLE 5
#define LIMINE_MEMMAP_KERNEL_AND_MODULES 6
#define LIMINE_MEMMAP_FRAMEBUFFER 7
struct limine_memmap_entry {
uint64_t base;
uint64_t length;
uint64_t type;
};
2022-03-12 23:41:36 +03:00
struct limine_memmap_response {
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-20 23:23:47 +03:00
uint64_t entry_count;
LIMINE_PTR(struct limine_memmap_entry **) entries;
2022-03-12 23:41:36 +03:00
};
2022-03-13 07:35:29 +03:00
struct limine_memmap_request {
uint64_t id[4];
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-13 07:35:29 +03:00
LIMINE_PTR(struct limine_memmap_response *) response;
};
2022-03-26 03:31:38 +03:00
/* Entry point */
2022-03-13 07:35:29 +03:00
#define LIMINE_ENTRY_POINT_REQUEST { LIMINE_COMMON_MAGIC, 0x13d86c035a1cd3e1, 0x2b0caa89d8f3026a }
typedef void (*limine_entry_point)(void);
2022-03-13 07:35:29 +03:00
struct limine_entry_point_response {
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-13 07:35:29 +03:00
};
struct limine_entry_point_request {
uint64_t id[4];
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-13 07:35:29 +03:00
LIMINE_PTR(struct limine_entry_point_response *) response;
LIMINE_PTR(limine_entry_point) entry;
2022-03-13 07:35:29 +03:00
};
/* Kernel File */
2022-03-16 08:49:41 +03:00
#define LIMINE_KERNEL_FILE_REQUEST { LIMINE_COMMON_MAGIC, 0xad97e90e83f1ed67, 0x31eb5d1c5ff23b69 }
2022-03-16 08:49:41 +03:00
struct limine_kernel_file_response {
uint64_t revision;
LIMINE_PTR(struct limine_file *) kernel_file;
};
struct limine_kernel_file_request {
uint64_t id[4];
uint64_t revision;
LIMINE_PTR(struct limine_kernel_file_response *) response;
};
/* Module */
#define LIMINE_MODULE_REQUEST { LIMINE_COMMON_MAGIC, 0x3e7e279702be32af, 0xca1c4f3bd1280cee }
2022-03-16 08:49:41 +03:00
struct limine_module_response {
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-20 23:23:47 +03:00
uint64_t module_count;
LIMINE_PTR(struct limine_file **) modules;
2022-03-16 08:49:41 +03:00
};
struct limine_module_request {
uint64_t id[4];
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-16 08:49:41 +03:00
LIMINE_PTR(struct limine_module_response *) response;
};
2022-03-26 03:31:38 +03:00
/* RSDP */
2022-03-17 21:21:35 +03:00
#define LIMINE_RSDP_REQUEST { LIMINE_COMMON_MAGIC, 0xc5e77b6b397e7b43, 0x27637845accdcf3c }
struct limine_rsdp_response {
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-17 21:21:35 +03:00
LIMINE_PTR(void *) address;
};
struct limine_rsdp_request {
uint64_t id[4];
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-17 21:21:35 +03:00
LIMINE_PTR(struct limine_rsdp_response *) response;
};
2022-03-26 03:31:38 +03:00
/* SMBIOS */
2022-03-17 21:59:03 +03:00
#define LIMINE_SMBIOS_REQUEST { LIMINE_COMMON_MAGIC, 0x9e9046f11e095391, 0xaa4a520fefbde5ee }
struct limine_smbios_response {
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-17 21:59:03 +03:00
LIMINE_PTR(void *) entry_32;
LIMINE_PTR(void *) entry_64;
};
struct limine_smbios_request {
uint64_t id[4];
2022-03-20 02:57:10 +03:00
uint64_t revision;
2022-03-17 21:59:03 +03:00
LIMINE_PTR(struct limine_smbios_response *) response;
};
2022-03-26 03:31:38 +03:00
/* EFI system table */
2022-03-20 10:05:12 +03:00
#define LIMINE_EFI_SYSTEM_TABLE_REQUEST { LIMINE_COMMON_MAGIC, 0x5ceba5163eaaf6d6, 0x0a6981610cf65fcc }
struct limine_efi_system_table_response {
uint64_t revision;
LIMINE_PTR(void *) address;
};
struct limine_efi_system_table_request {
uint64_t id[4];
uint64_t revision;
LIMINE_PTR(struct limine_efi_system_table_response *) response;
};
2022-03-26 03:31:38 +03:00
/* Boot time */
2022-03-20 10:19:32 +03:00
#define LIMINE_BOOT_TIME_REQUEST { LIMINE_COMMON_MAGIC, 0x502746e184c088aa, 0xfbc5ec83e6327893 }
struct limine_boot_time_response {
uint64_t revision;
int64_t boot_time;
};
struct limine_boot_time_request {
uint64_t id[4];
uint64_t revision;
LIMINE_PTR(struct limine_boot_time_response *) response;
};
2022-03-26 03:31:38 +03:00
/* Kernel address */
2022-03-20 21:01:24 +03:00
#define LIMINE_KERNEL_ADDRESS_REQUEST { LIMINE_COMMON_MAGIC, 0x71ba76863cc55f63, 0xb2644a48c516a487 }
struct limine_kernel_address_response {
uint64_t revision;
uint64_t physical_base;
uint64_t virtual_base;
};
struct limine_kernel_address_request {
uint64_t id[4];
uint64_t revision;
LIMINE_PTR(struct limine_kernel_address_response *) response;
};
/* Device Tree Blob */
#define LIMINE_DTB_REQUEST { LIMINE_COMMON_MAGIC, 0xb40ddb48fb54bac7, 0x545081493f81ffb7 }
struct limine_dtb_response {
uint64_t revision;
LIMINE_PTR(void *) dtb_ptr;
};
struct limine_dtb_request {
uint64_t id[4];
uint64_t revision;
LIMINE_PTR(struct limine_dtb_response *) response;
};
#ifdef __cplusplus
}
#endif
#endif