API.h

Go to the documentation of this file.

/* ========================================
 
  Copyright (C) 2024-2025, Amlal El Mahrouss, licensed under the Apache 2.0 license.
 
======================================== */
 
#ifndef __EFI_API__
#define __EFI_API__
 
#include <FirmwareKit/EFI/EFI.h>
#include <FirmwareKit/Handover.h>
#include <KernelKit/MSDOS.h>
#include <KernelKit/PE.h>
 
#ifdef __BOOTZ__
// forward decl.
class BootTextWriter;
 
#define __BOOTKIT_NO_INCLUDE__ 1
 
#include <BootKit/BootKit.h>
#include <modules/CoreGfx/CoreGfx.h>
#endif  // ifdef __BOOTZ__
 
inline EfiSystemTable*  ST = nullptr;
inline EfiBootServices* BS = nullptr;
 
EXTERN_C void rt_cli();
EXTERN_C void rt_halt();
 
namespace Boot {
inline Void Stop() {
  while (YES) {
    rt_cli();
    rt_halt();
  }
}

inline Void ExitBootServices(UInt64 MapKey, EfiHandlePtr ImageHandle) {
  if (!ST) return;
 
  ST->BootServices->ExitBootServices(ImageHandle, MapKey);
}
 
inline UInt32 Platform() {
  return kPeMachineAMD64;
}
 
/***
 * @brief Throw an error, stop execution as well.
 * @param ErrorCode error code to be print.
 * @param Reason reason to be print.
 */
inline void ThrowError(const EfiCharType* ErrorCode, const EfiCharType* Reason) {
  ST->ConOut->OutputString(ST->ConOut, L"\r*** STOP ***\r");
 
  ST->ConOut->OutputString(ST->ConOut, L"*** ERROR: ");
  ST->ConOut->OutputString(ST->ConOut, ErrorCode);
 
  ST->ConOut->OutputString(ST->ConOut, L" ***\r *** REASON: ");
  ST->ConOut->OutputString(ST->ConOut, Reason);
 
  ST->ConOut->OutputString(ST->ConOut, L" ***\r");
 
  Boot::Stop();
}
}  // namespace Boot
 
inline void fw_init_efi(EfiSystemTable* SystemTable) {
  if (!SystemTable) return;
 
  ST = SystemTable;
  BS = ST->BootServices;
}
 
#ifdef __BOOTZ__
 
#include <BootKit/Platform.h>
 
#endif  // ifdef __BOOTZ__
 
#endif /* ifndef __EFI_API__ */