os-k/include/init/boot.h

//----------------------------------------------------------------------------//
//                           GNU GPL OS/K                                     //
//                                                                            //
//  Desc:       Kaleid kernel base include file                               //
//                                                                            //
//                                                                            //
//  Copyright © 2018-2019 The OS/K Team                                       //
//                                                                            //
//  This file is part of OS/K.                                                //
//                                                                            //
//  OS/K is free software: you can redistribute it and/or modify              //
//  it under the terms of the GNU General Public License as published by      //
//  the Free Software Foundation, either version 3 of the License, or         //
//  any later version.                                                        //
//                                                                            //
//  OS/K is distributed in the hope that it will be useful,                   //
//  but WITHOUT ANY WARRANTY//without even the implied warranty of            //
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the             //
//  GNU General Public License for more details.                              //
//                                                                            //
//  You should have received a copy of the GNU General Public License         //
//  along with OS/K.  If not, see <https://www.gnu.org/licenses/>.            //
//----------------------------------------------------------------------------//

#ifndef _KERNEL_H
#include <kernel.h>
#endif

#ifndef MULTIBOOT_HEADER
#include <init/mboot.h>
#endif

#ifndef _INIT_BOOT_H
#define _INIT_BOOT_H

//----------------------------------------------------------------------------//

#define FB_EGA_TEXT 2
#define FB_INDEXED 0
#define FB_RGB 1
#define BINFO_SIZE 4096

struct BootInfo_t
{
    // The Bootloader infos
    struct {
        ushort valid;
        uint grubFlags;         //flags
        uint modulesCount;      //mods_count
        void *modulesAddr;      //mods_addr
        char *grubName;         //boot_loader_name
        void *kernelAddr;
        void *codeSegment;
        void *kernelEndAddr;
        void *stackEndAddr;     // stack begins 16B after kernelEndAddr
    } btldr;

    // Informations about drives
    struct {
        ushort drvValid;
        ushort bufferValid;
        uint bootDrv;           //boot_device
        uint bufferLength;      //drives_length
        void *bufferAddr;       //drives_addr
    } drives;

    // Informations about memory
    struct {
        ushort memValid;
        ushort mapValid;

        //BIOS provided low and up memory
        uint lowMemory;         //mem_lower
        uint upMemory;          //mem_upper

        //GRUB provided memory map
        uint mapLength;         //mmap_length
        void *mapAddr;          //mmap_addr

        uint ramSize;           //The ram (init by map.c)
    } memory;

     // Informations about the video drive
    struct {
        ushort vbeValid;
        ushort fbuValid;
        void *vbeControl;       //vbe_control_info
        void *vbeModeInfo;      //vbe_mode_info
        ushort vbeMode;         //vbe_mode
        ushort vbeInterfaceSeg; //vbe_interface_seg
        ushort vbeInterfaceOff; //vbe_interface_off
        ushort vbeInterfaceLen; //vbe_interface_len
        void *framebufferAddr;  //framebuffer_addr
        uint framebufferPitch;  //framebuffer_pitch
        uint framebufferWidth;  //framebuffer_width
        uint framebufferHeight; //framebuffer_height
        uchar framebufferBpp;   //framebuffer_bpp
        uchar framebufferType;  //framebuffer_type
    } video;

     // Informations about the microcode firmware (BIOS/EFI)
    struct {
        ushort apmValid;
        ushort romValid;
        uint apmTable;          //apm_table
        uint romTable;          //config_table
    } firmware;
};

//----------------------------------------------------------------------------//

extern volatile BootInfo_t       BtBootTab;

#define BtLoaderInfo    (BtBootTab.btldr)
#define BtDrivesInfo    (BtBootTab.drives)
#define BtMemoryInfo    (BtBootTab.memory)
#define BtVideoInfo     (BtBootTab.video)
#define BtFirmwareInfo  (BtBootTab.firmware)

//----------------------------------------------------------------------------//

void BtDoSanityChecks(uint);
void BtInitBootInfo(multiboot_info_t *, void *);

//----------------------------------------------------------------------------//

#endif