freeldr.h File Reference

#include <ntsup.h>
#include <arcname.h>
#include <arcsupp.h>
#include <bytesex.h>
#include <cache.h>
#include <comm.h>
#include <disk.h>
#include <fs.h>
#include <inifile.h>
#include <keycodes.h>
#include <linux.h>
#include <custom.h>
#include <miscboot.h>
#include <machine.h>
#include <mm.h>
#include <multiboot.h>
#include <options.h>
#include <oslist.h>
#include <ramdisk.h>
#include <settings.h>
#include <ver.h>
#include <include/ntldr/winldr.h>
#include <conversion.h>
#include <peloader.h>
#include <fs/ext.h>
#include <fs/fat.h>
#include <fs/ntfs.h>
#include <fs/iso.h>
#include <fs/pxe.h>
#include <fs/btrfs.h>
#include <ui.h>
#include <ui/video.h>
#include <arch/archwsup.h>

Include dependency graph for freeldr.h:

Go to the source code of this file.

Macros
#define	HAS_DEPRECATED_OPTIONS
#define	FLDRAPI   DECLSPEC_IMPORT
#define	UINT64_C(val)   val##ULL
#define	RVA(m, b)   ((PVOID)((ULONG_PTR)(b) + (ULONG_PTR)(m)))
#define	ROUND_DOWN(n, align)    (((ULONG)n) & ~((align) - 1l))
#define	ROUND_UP(n, align)    ROUND_DOWN(((ULONG)n) + (align) - 1, (align))
#define	printf   TuiPrintf

Functions
VOID __cdecl	BootMain (IN PCCH CmdLine)
VOID	WarnDeprecated (_In_ PCSTR MsgFmt,...)
VOID	LoadOperatingSystem (_In_ OperatingSystemItem *OperatingSystem)
VOID	RunLoader (VOID)
VOID	FrLdrCheckCpuCompatibility (VOID)

Macro Definition Documentation

FLDRAPI

#define FLDRAPI   DECLSPEC_IMPORT

Definition at line 28 of file freeldr.h.

HAS_DEPRECATED_OPTIONS

#define HAS_DEPRECATED_OPTIONS

Definition at line 25 of file freeldr.h.

printf

#define printf   TuiPrintf

Definition at line 103 of file freeldr.h.

ROUND_DOWN

#define ROUND_DOWN	(		n,
			align
	)		(((ULONG)n) & ~((align) - 1l))

Definition at line 37 of file freeldr.h.

ROUND_UP

#define ROUND_UP	(		n,
			align
	)		ROUND_DOWN(((ULONG)n) + (align) - 1, (align))

Definition at line 40 of file freeldr.h.

RVA

#define RVA	(		m,
			b
	)		((PVOID)((ULONG_PTR)(b) + (ULONG_PTR)(m)))

Definition at line 35 of file freeldr.h.

UINT64_C

#define UINT64_C

(

val

)

val##ULL

Definition at line 34 of file freeldr.h.

Function Documentation

BootMain()

VOID __cdecl BootMain

(

IN PCCH

CmdLine

)

Definition at line 92 of file freeldr.c.

{
    /* Load the default settings from the command-line */
    LoadSettings(CmdLine);
 
    /* Debugger pre-initialization */
    DebugInit(BootMgrInfo.DebugString);
 
    MachInit(CmdLine);
 
    TRACE("BootMain() called.\n");
 
#ifndef UEFIBOOT
    /* Check if the CPU is new enough */
    FrLdrCheckCpuCompatibility(); // FIXME: Should be done inside MachInit!
#endif
 
    /* UI pre-initialization */
    if (!UiInitialize(FALSE))
    {
        UiMessageBoxCritical("Unable to initialize UI.");
        goto Quit;
    }
 
    /* Initialize memory manager */
    if (!MmInitializeMemoryManager())
    {
        UiMessageBoxCritical("Unable to initialize memory manager.");
        goto Quit;
    }
 
    /* Initialize I/O subsystem */
    FsInit();
 
    /* Initialize the module list */
    if (!PeLdrInitializeModuleList())
    {
        UiMessageBoxCritical("Unable to initialize module list.");
        goto Quit;
    }
 
    if (!MachInitializeBootDevices())
    {
        UiMessageBoxCritical("Error when detecting hardware.");
        goto Quit;
    }
 
    /* Launch second stage loader */
    if (LaunchSecondStageLoader() != ESUCCESS)
    {
        UiMessageBoxCritical("Unable to load second stage loader.");
    }
 
Quit:
    /* If we reach this point, something went wrong before, therefore reboot */
    Reboot();
}

Referenced by ArmInit(), and RealEntryPoint().

FrLdrCheckCpuCompatibility()

VOID FrLdrCheckCpuCompatibility

(

VOID

)

Definition at line 65 of file macharm.c.

{
    /* Nothing for now */
}

Referenced by BootMain().

LoadOperatingSystem()

VOID LoadOperatingSystem

(

_In_ OperatingSystemItem *

OperatingSystem

)

Definition at line 287 of file bootmgr.c.

{
    ULONG_PTR SectionId = OperatingSystem->SectionId;
    const OS_LOADING_METHOD* OSLoadingMethod;
    ULONG Argc;
    PCHAR* Argv;
 
    /* Find the suitable OS loader to start */
    OSLoadingMethod = GetOSLoadingMethod(SectionId);
    if (!OSLoadingMethod)
        return;
    ASSERT(OSLoadingMethod->OsLoader);
 
    /* Build the ARC-compatible argument vector */
    Argv = BuildArgvForOsLoader(OperatingSystem->LoadIdentifier, SectionId, &Argc);
    if (!Argv)
        return; // Unexpected failure.
 
#ifdef _M_IX86
#ifndef UEFIBOOT
    /* Install the drive mapper according to this section drive mappings */
    DriveMapMapDrivesInSection(SectionId);
#endif
#endif
 
    /* Start the OS loader */
    OSLoadingMethod->OsLoader(Argc, Argv, NULL);
    FrLdrHeapFree(Argv, TAG_STRING);
}

Referenced by RunLoader().

RunLoader()

VOID RunLoader

(

VOID

)

Definition at line 386 of file bootmgr.c.

{
    OperatingSystemItem* OperatingSystemList;
    PCSTR* OperatingSystemDisplayNames;
    ULONG OperatingSystemCount;
    ULONG SelectedOperatingSystem;
    ULONG i;
 
#ifdef _M_IX86
#ifndef UEFIBOOT
    /* Load additional SCSI driver (if any) */
    if (LoadBootDeviceDriver() != ESUCCESS)
        UiMessageBoxCritical("Unable to load additional boot device drivers.");
#endif
#endif
 
    /* Open FREELDR.INI and load the global FreeLoader settings */
    if (!IniFileInitialize())
        UiMessageBoxCritical("Error initializing .ini file.");
    LoadSettings(NULL);
#if 0
    if (FALSE)
        UiMessageBoxCritical("Could not load global FreeLoader settings.");
#endif
 
    /* Debugger main initialization */
    DebugInit(GetBootMgrInfo()->DebugString);
 
    /* UI main initialization. If it fails, fall back to default UI. */
    if (!UiInitialize(TRUE))
        UiMessageBoxCritical("Unable to initialize UI.");
 
    /* If no FREELDR.INI, skip everything else and fall back to the FreeLdr setup menu */
    if (IsListEmpty(IniGetFileSectionListHead()))
        goto Fallback;
 
    /* Find all the message box settings and run them */
    UiShowMessageBoxesInSection(GetBootMgrInfo()->FrLdrSection);
 
    /* Retrieve the list of boot entries */
    OperatingSystemList = InitOperatingSystemList(&OperatingSystemCount,
                                                  &SelectedOperatingSystem);
    if (!OperatingSystemList)
    {
        UiMessageBox("There are no operating systems listed in freeldr.ini.");
        goto Fallback;
    }
    ASSERT(OperatingSystemCount != 0);
 
    /* Create list of display names */
    OperatingSystemDisplayNames = FrLdrTempAlloc(sizeof(PCSTR) * OperatingSystemCount, 'mNSO');
    if (!OperatingSystemDisplayNames)
        goto Fallback;
 
    for (i = 0; i < OperatingSystemCount; i++)
    {
        OperatingSystemDisplayNames[i] = OperatingSystemList[i].LoadIdentifier;
    }
 
    for (;;)
    {
        /* Redraw the backdrop, but don't overwrite boot options */
        UiDrawBackdrop(UiGetScreenHeight() - 2);
        DisplayBootTimeOptions(&OperatingSystemList[SelectedOperatingSystem]);
 
        /* Show the operating system list menu */
        if (!UiDisplayMenu("Please select the operating system to start:",
                           /* The string is 80 characters long; don't make it longer! */
                           "Press F8 for troubleshooting and advanced startup options."
                           "     F2: FreeLdr SETUP",
                           OperatingSystemDisplayNames,
                           OperatingSystemCount,
                           SelectedOperatingSystem,
                           GetBootMgrInfo()->TimeOut,
                           &SelectedOperatingSystem,
                           FALSE,
                           MainBootMenuKeyPressFilter,
                           OperatingSystemList))
        {
            UiMessageBox("Press ENTER to reboot.");
            goto Reboot;
        }
 
        /* Load the chosen operating system */
        LoadOperatingSystem(&OperatingSystemList[SelectedOperatingSystem]);
 
        GetBootMgrInfo()->TimeOut = -1;
 
        /* If we get there, the OS loader failed. As it may have
         * messed up the display, re-initialize the UI. */
#ifndef _M_ARM
        UiUnInitialize("");
#endif
        UiInitialize(TRUE);
    }
 
Fallback:
    /* Fall back to the FreeLdr setup menu */
    FreeLdrSetupMenu(NULL);
    UiMessageBox("The system will now reboot.");
 
Reboot:
    UiUnInitialize("Rebooting...");
    IniCleanup();
    return;
}

Referenced by ExecuteLoaderCleanly().

WarnDeprecated()

VOID WarnDeprecated	(	_In_ PCSTR	MsgFmt,
			...
	)

Referenced by GetOSLoadingMethod().