1 files changed, 403 insertions, 0 deletions
diff --git a/dev/boot/BootKit/BootKit.h b/dev/boot/BootKit/BootKit.h
new file mode 100644
index 00000000..425c6ed4
--- /dev/null
+++ b/dev/boot/BootKit/BootKit.h
@@ -0,0 +1,403 @@
+/* -------------------------------------------
+
+	Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved.
+
+------------------------------------------- */
+
+/***********************************************************************************/
+/// @file BootKit.h
+/// @brief Bootloader Application Programming Interface.
+/***********************************************************************************/
+
+#pragma once
+
+#include <BootKit/HW/ATA.h>
+#include <FirmwareKit/EPM.h>
+#include <CompilerKit/Version.h>
+#include <modules/CoreGfx/FBMgr.h>
+#include <BootKit/Rsrc/zka_disk.rsrc>
+#include <BootKit/Rsrc/zka_no_disk.rsrc>
+#include <BootKit/Rsrc/zka_has_disk.rsrc>
+
+/// include NeFS header and Support header as well.
+
+#include <FSKit/NeFS.h>
+#include <BootKit/Support.h>
+
+/***********************************************************************************/
+/// Include other APIs.
+/***********************************************************************************/
+
+#include <NewKit/Defines.h>
+#include <modules/ATA/ATA.h>
+
+#include <FirmwareKit/EFI.h>
+
+/***********************************************************************************/
+/// Framebuffer helpers.
+/***********************************************************************************/
+
+namespace EFI
+{
+	EXTERN void ThrowError(const WideChar* errorCode,
+						   const WideChar* reason) noexcept;
+} // namespace EFI
+
+namespace Boot
+{
+	class BootTextWriter;
+	class BootFileReader;
+	class BootThread;
+	class BVersionString;
+
+	typedef Char* PEFImagePtr;
+	typedef Char* PEImagePtr;
+
+	typedef WideChar CharacterTypeUTF16;
+	typedef Char	 CharacterTypeUTF8;
+
+	using namespace NeOS;
+
+	/**
+	 * @brief BootKit Text Writer class
+	 * Writes to UEFI StdOut.
+	 */
+	class BootTextWriter final
+	{
+		BootTextWriter& _Write(const Long& num);
+
+	public:
+		BootTextWriter& Write(const Long& num);
+		BootTextWriter& Write(const Char* str);
+		BootTextWriter& Write(const CharacterTypeUTF16* str);
+		BootTextWriter& WriteCharacter(CharacterTypeUTF16 c);
+		BootTextWriter& Write(const UChar* str);
+
+		template <typename T>
+		BootTextWriter& operator<<(T elem)
+		{
+			this->Write(elem);
+			return *this;
+		}
+
+	public:
+		explicit BootTextWriter() = default;
+		~BootTextWriter()		  = default;
+
+	public:
+		BootTextWriter& operator=(const BootTextWriter&) = default;
+		BootTextWriter(const BootTextWriter&)			 = default;
+	};
+
+	NeOS::SizeT BCopyMem(CharacterTypeUTF16* dest, CharacterTypeUTF16* src, const NeOS::SizeT len);
+
+	NeOS::SizeT BSetMem(CharacterTypeUTF8* src, const CharacterTypeUTF8 byte, const NeOS::SizeT len);
+
+	/// String length functions.
+
+	/// @brief get string length.
+	NeOS::SizeT BStrLen(const CharacterTypeUTF16* ptr);
+
+	/// @brief set memory with custom value.
+	NeOS::SizeT BSetMem(CharacterTypeUTF16* src, const CharacterTypeUTF16 byte, const NeOS::SizeT len);
+
+	/**
+	 * @brief BootKit File Reader class
+	 * Reads the Firmware Boot partition and filesystem.
+	 */
+	class BootFileReader final
+	{
+	public:
+		explicit BootFileReader(const CharacterTypeUTF16* path,
+								EfiHandlePtr			  ImageHandle);
+		~BootFileReader();
+
+	public:
+		Void ReadAll(SizeT until, SizeT chunk = kib_cast(4), UIntPtr out_address = 0UL);
+
+		enum
+		{
+			kOperationOkay,
+			kNotSupported,
+			kEmptyDirectory,
+			kNoSuchEntry,
+			kIsDirectory,
+			kTooSmall,
+			kCount,
+		};
+
+		/// @brief error code getter.
+		/// @return the error code.
+		Int32& Error();
+
+		/// @brief blob getter.
+		/// @return the blob.
+		VoidPtr Blob();
+
+		/// @breif Size getter.
+		/// @return the size of the file.
+		UInt64& Size();
+
+	public:
+		BootFileReader& operator=(const BootFileReader&) = default;
+		BootFileReader(const BootFileReader&)			 = default;
+
+	private:
+		Int32			   mErrorCode{kOperationOkay};
+		VoidPtr			   mBlob{nullptr};
+		CharacterTypeUTF16 mPath[kPathLen];
+		BootTextWriter	   mWriter;
+		EfiFileProtocol*   mFile{nullptr};
+		UInt64			   mSizeFile{0};
+		EfiFileProtocol*   mRootFs;
+	};
+
+	typedef UInt8* BlobType;
+
+	class BVersionString final
+	{
+	public:
+		static const CharacterTypeUTF8* The()
+		{
+			return BOOTLOADER_VERSION;
+		}
+	};
+
+	/***********************************************************************************/
+	/// Provide some useful processor features.
+	/***********************************************************************************/
+
+#ifdef __EFI_x86_64__
+
+	/***
+	 * Common processor instructions.
+	 */
+
+	EXTERN_C void	rt_out8(UInt16 port, UInt8 value);
+	EXTERN_C void	rt_out16(UInt16 port, UInt16 value);
+	EXTERN_C void	rt_out32(UInt16 port, UInt32 value);
+	EXTERN_C UInt8	rt_in8(UInt16 port);
+	EXTERN_C UInt16 In16(UInt16 port);
+	EXTERN_C UInt32 rt_in32(UInt16 port);
+
+	EXTERN_C void rt_hlt();
+	EXTERN_C void rt_cli();
+	EXTERN_C void rt_sti();
+	EXTERN_C void rt_cld();
+	EXTERN_C void rt_std();
+
+#endif // __EFI_x86_64__
+
+	static inline const UInt32 kRgbRed	 = 0x000000FF;
+	static inline const UInt32 kRgbGreen = 0x0000FF00;
+	static inline const UInt32 kRgbBlue	 = 0x00FF0000;
+	static inline const UInt32 kRgbBlack = 0x00000000;
+	static inline const UInt32 kRgbWhite = 0x00FFFFFF;
+
+#define kBKBootFileMime "boot-x/file"
+#define kBKBootDirMime	"boot-x/dir"
+
+	/// @brief BootKit Drive Formatter.
+	template <typename BootDev>
+	class BDiskFormatFactory final
+	{
+	public:
+		/// @brief File entry for **BDiskFormatFactory**.
+		struct BFileDescriptor final
+		{
+			Char  fFileName[kNeFSCatalogNameLen];
+			Int32 fKind;
+		};
+
+	public:
+		explicit BDiskFormatFactory() = default;
+		explicit BDiskFormatFactory(BootDev dev)
+			: fDiskDev(dev)
+		{
+		}
+
+		~BDiskFormatFactory() = default;
+
+		NE_COPY_DELETE(BDiskFormatFactory);
+
+		/// @brief Format disk using partition name and blob.
+		/// @param Partition part_name the target partition name.
+		/// @param blob blobs array.
+		/// @param blob_sz blobs array count.
+		/// @retval True disk has been formatted.
+		/// @retval False failed to format.
+		Boolean Format(const Char* part_name, BFileDescriptor* blob, SizeT blob_sz);
+
+		/// @brief check if partition is good.
+		Bool IsPartitionValid() noexcept
+		{
+			fDiskDev.Leak().mBase = (kNeFSRootCatalogStartAddress);
+			fDiskDev.Leak().mSize = BootDev::kSectorSize;
+
+			Char buf[BootDev::kSectorSize] = {0};
+
+			fDiskDev.Read(buf, BootDev::kSectorSize);
+
+			NEFS_ROOT_PARTITION_BLOCK* blockPart = reinterpret_cast<NEFS_ROOT_PARTITION_BLOCK*>(buf);
+
+			BootTextWriter writer;
+
+			for (SizeT indexMag = 0UL; indexMag < kNeFSIdentLen; ++indexMag)
+			{
+				if (blockPart->Ident[indexMag] != kNeFSIdent[indexMag])
+					return false;
+			}
+
+			if (blockPart->DiskSize != this->fDiskDev.GetDiskSize() ||
+				blockPart->DiskSize < 1 ||
+				blockPart->SectorSize != BootDev::kSectorSize ||
+				blockPart->Version != kNeFSVersionInteger ||
+				blockPart->StartCatalog == 0)
+			{
+				return false;
+			}
+			else if (blockPart->PartitionName[0] == 0)
+			{
+				return false;
+			}
+
+			writer.Write(L"BootZ: Partition: ").Write(blockPart->PartitionName).Write(L" is healthy.\r");
+
+			return true;
+		}
+
+	private:
+		/// @brief Write all of the requested catalogs into the filesystem.
+		/// @param blob the blobs.
+		/// @param blob_sz the number of blobs to write (n * sizeof(blob_struct)).
+		/// @param part the NeFS partition block.
+		Boolean WriteCatalogList(BFileDescriptor* blob, SizeT blob_sz, NEFS_ROOT_PARTITION_BLOCK& part)
+		{
+			if (blob_sz < sizeof(NEFS_CATALOG_STRUCT))
+				return NO;
+
+			if (!blob)
+				return NO;
+
+			Lba			   startLba = part.StartCatalog;
+			BootTextWriter writer;
+
+			NEFS_CATALOG_STRUCT catalogKind{0};
+
+			constexpr auto cNeFSCatalogPadding = 4;
+
+			catalogKind.PrevSibling = startLba;
+			catalogKind.NextSibling = (startLba + sizeof(NEFS_CATALOG_STRUCT) * cNeFSCatalogPadding);
+
+			/// Fill catalog kind.
+			catalogKind.Kind = blob->fKind;
+			catalogKind.Flags |= kNeFSFlagCreated;
+			catalogKind.CatalogFlags = kNeFSStatusUnlocked;
+
+			--part.FreeCatalog;
+			--part.FreeSectors;
+
+			CopyMem(catalogKind.Name, blob->fFileName, StrLen(blob->fFileName));
+
+			fDiskDev.Leak().mBase = startLba;
+			fDiskDev.Leak().mSize = sizeof(NEFS_CATALOG_STRUCT);
+
+			fDiskDev.Write((Char*)&catalogKind, sizeof(NEFS_CATALOG_STRUCT));
+
+			writer.Write(L"BootZ: Wrote directory: ").Write(blob->fFileName).Write(L"\r");
+
+			return true;
+		}
+
+	private:
+		BootDev fDiskDev;
+	};
+
+	/// @brief Format disk.
+	/// @param part_name partition Name
+	/// @param blob blos.
+	/// @param blob_sz n blobs (n *  sizeof(blob_struct)).
+	/// @retval True disk has been formatted.
+	/// @retval False failed to format.
+	template <typename BootDev>
+	inline Boolean BDiskFormatFactory<BootDev>::Format(const Char*							part_name,
+													   BDiskFormatFactory::BFileDescriptor* blob,
+													   SizeT								blob_sz)
+	{
+		if (!blob || !blob_sz)
+			return false; /// sanity check
+
+		/// @note A catalog roughly equal to a sector.
+
+		constexpr auto kMinimumDiskSize = kNeFSMinimumDiskSize; // at minimum.
+
+		/// @note also look at EPM headers, for free part blocks.
+
+		if (fDiskDev.GetDiskSize() < kMinimumDiskSize)
+		{
+			fb_init();
+
+			FBDrawBitMapInRegion(zka_no_disk, NE_NO_DISK_WIDTH, NE_NO_DISK_HEIGHT, (kHandoverHeader->f_GOP.f_Width - NE_NO_DISK_WIDTH) / 2, (kHandoverHeader->f_GOP.f_Height - NE_NO_DISK_HEIGHT) / 2);
+			EFI::ThrowError(L"Drive-Too-Tiny", L"Can't format a NeFS partition here.");
+			return false;
+		}
+
+		NEFS_ROOT_PARTITION_BLOCK part{0};
+
+		CopyMem(part.Ident, kNeFSIdent, kNeFSIdentLen - 1);
+		CopyMem(part.PartitionName, part_name, StrLen(part_name));
+
+		part.Version	  = kNeFSVersionInteger;
+		part.CatalogCount = blob_sz / sizeof(NEFS_CATALOG_STRUCT);
+		part.Kind		  = BootDev::kSectorSize;
+		part.SectorSize	  = kATASectorSize;
+		part.FreeCatalog  = fDiskDev.GetSectorsCount() / sizeof(NEFS_CATALOG_STRUCT);
+		part.SectorCount  = fDiskDev.GetSectorsCount();
+		part.FreeSectors  = fDiskDev.GetSectorsCount();
+		part.StartCatalog = kNeFSCatalogStartAddress;
+		part.DiskSize	  = fDiskDev.GetDiskSize();
+		part.Flags		  = kNeFSPartitionTypeBoot | kNeFSPartitionTypeStandard;
+
+		fDiskDev.Leak().mBase = kNeFSRootCatalogStartAddress;
+		fDiskDev.Leak().mSize = sizeof(NEFS_ROOT_PARTITION_BLOCK);
+
+		fDiskDev.Write((Char*)&part, sizeof(NEFS_ROOT_PARTITION_BLOCK));
+
+		BootTextWriter writer;
+
+		writer << "BootZ: Partition name: " << part.PartitionName << "\r";
+		writer << "BootZ: Start: " << part.StartCatalog << "\r";
+		writer << "BootZ: Number of catalogs: " << part.CatalogCount << "\r";
+		writer << "BootZ: Free catalog: " << part.FreeCatalog << "\r";
+		writer << "BootZ: Free sectors: " << part.FreeSectors << "\r";
+		writer << "BootZ: Sector size: " << part.SectorSize << "\r";
+
+#ifdef BOOTZ_EPM_SUPPORT
+		EPM_PART_BLOCK epm_boot{0};
+
+		const auto kFsName	  = "NeFS";
+		const auto kBlockName = "OS";
+
+		CopyMem(epm_boot.Fs, reinterpret_cast<VoidPtr>(const_cast<Char*>(kFsName)), StrLen(kFsName));
+
+		epm_boot.FsVersion = kNeFSVersionInteger;
+		epm_boot.LbaStart  = kNeFSRootCatalogStartAddress;
+		epm_boot.LbaEnd	   = fDiskDev.GetDiskSize();
+		epm_boot.SectorSz  = part.SectorSize;
+		epm_boot.Kind	   = kEPMNeOS;
+		epm_boot.NumBlocks = part.CatalogCount;
+
+		CopyMem(epm_boot.Name, reinterpret_cast<VoidPtr>(const_cast<Char*>(kBlockName)), StrLen(kBlockName));
+		CopyMem(epm_boot.Magic, reinterpret_cast<VoidPtr>(const_cast<Char*>(kEPMMagic)), StrLen(kEPMMagic));
+
+		fDiskDev.Leak().mBase = kEPMBootBlockLba; // always always resies at zero block.
+		fDiskDev.Leak().mSize = sizeof(EPM_PART_BLOCK);
+
+		fDiskDev.Write((Char*)&epm_boot, sizeof(EPM_PART_BLOCK));
+
+		writer.Write(L"BootZ: Drive has been formatted Successfully.\r");
+#endif
+
+		return YES;
+	}
+} // namespace Boot