From 9034d32c7b60dedbdbdb66f42d9b147cb2aa9a60 Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Fri, 28 Mar 2025 05:17:08 +0100 Subject: bootz: rename NetBoot module to BootNet MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Rename the NetBoot module to BootNet to avoid confusion with Apple's NetBoot and better reflect the module's role within BootZ. Updates include: - Renamed module directory: NetBoot/ → BootNet/ - Renamed files and headers: NetBoot.cc → BootNet.cc, etc. - Updated build output: netboot.sys → bootnet.sys - Replaced all references in build scripts, source includes, and user-visible strings - Fixed typo in SysChk.cc copyright This unifies naming across modules and reinforces BootZ's modular identity. Signed-off-by: Amlal El Mahrouss --- dev/boot/amd64-desktop.make | 4 +-- dev/boot/modules/BootNet/.hgkeep | 0 dev/boot/modules/BootNet/Boot.S | 22 ++++++++++++++++ dev/boot/modules/BootNet/BootNet.cc | 50 ++++++++++++++++++++++++++++++++++++ dev/boot/modules/BootNet/BootNet.h | 33 ++++++++++++++++++++++++ dev/boot/modules/BootNet/amd64.json | 24 +++++++++++++++++ dev/boot/modules/NetBoot/.hgkeep | 0 dev/boot/modules/NetBoot/Boot.S | 22 ---------------- dev/boot/modules/NetBoot/NetBoot.cc | 50 ------------------------------------ dev/boot/modules/NetBoot/NetBoot.h | 33 ------------------------ dev/boot/modules/NetBoot/amd64.json | 24 ----------------- dev/boot/modules/SysChk/SysChk.cc | 2 +- dev/boot/src/HEL/AMD64/BootEFI.cc | 6 ++--- dev/kernel/FirmwareKit/CoreBoot/NS.h | 2 +- 14 files changed, 136 insertions(+), 136 deletions(-) create mode 100644 dev/boot/modules/BootNet/.hgkeep create mode 100644 dev/boot/modules/BootNet/Boot.S create mode 100644 dev/boot/modules/BootNet/BootNet.cc create mode 100644 dev/boot/modules/BootNet/BootNet.h create mode 100644 dev/boot/modules/BootNet/amd64.json delete mode 100644 dev/boot/modules/NetBoot/.hgkeep delete mode 100644 dev/boot/modules/NetBoot/Boot.S delete mode 100644 dev/boot/modules/NetBoot/NetBoot.cc delete mode 100644 dev/boot/modules/NetBoot/NetBoot.h delete mode 100644 dev/boot/modules/NetBoot/amd64.json (limited to 'dev') diff --git a/dev/boot/amd64-desktop.make b/dev/boot/amd64-desktop.make index 9e47788c..8494a2b3 100644 --- a/dev/boot/amd64-desktop.make +++ b/dev/boot/amd64-desktop.make @@ -74,7 +74,7 @@ FLAG_GNU=-fshort-wchar -D__EFI_x86_64__ -mno-red-zone -D__NEOSKRNL__ -D__BOOTZ__ BOOTLOADER=bootz.exe KERNEL=neoskrnl.exe SYSCHK=syschk.sys -NETBOOT=netboot.sys +NETBOOT=bootnet.sys SCIKIT=libuser.dylib .PHONY: invalid-recipe @@ -90,7 +90,7 @@ all: compile-amd64 $(COPY) src/$(BOOTLOADER) src/Root/EFI/BOOT/BOOTZ.EFI $(COPY) ../kernel/$(KERNEL) src/Root/$(KERNEL) $(COPY) ./modules/SysChk/$(SYSCHK) src/Root/$(SYSCHK) - $(COPY) ./modules/NetBoot/$(NETBOOT) src/Root/$(NETBOOT) + $(COPY) ./modules/BootNet/$(NETBOOT) src/Root/$(NETBOOT) $(COPY) ../user/$(SCIKIT) src/Root/$(SCIKIT) $(COPY) src/$(BOOTLOADER) src/Root/$(BOOTLOADER) diff --git a/dev/boot/modules/BootNet/.hgkeep b/dev/boot/modules/BootNet/.hgkeep new file mode 100644 index 00000000..e69de29b diff --git a/dev/boot/modules/BootNet/Boot.S b/dev/boot/modules/BootNet/Boot.S new file mode 100644 index 00000000..8ebfb352 --- /dev/null +++ b/dev/boot/modules/BootNet/Boot.S @@ -0,0 +1,22 @@ +;; /* +;; * ======================================================== +;; * +;; * BootZ +;; * Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved. +;; * +;; * ======================================================== +;; */ + +#ifdef __NE_AMD64__ +.code64 +.intel_syntax noprefix +#endif + +#define kTypeDriver 101 +#define kArchAmd64 122 +#define kHandoverMagic 0xBADCC + +.section .ldr + +.quad kHandoverMagic +.word kTypeDriver diff --git a/dev/boot/modules/BootNet/BootNet.cc b/dev/boot/modules/BootNet/BootNet.cc new file mode 100644 index 00000000..b4c1408f --- /dev/null +++ b/dev/boot/modules/BootNet/BootNet.cc @@ -0,0 +1,50 @@ +/* + * ======================================================== + * + * BootNet + * Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved. + * + * ======================================================== + */ + +#include +#include +#include + +EXTERN_C Int32 ModuleMain(NeOS::HEL::BootInfoHeader* handover) +{ + NETBOOT_INTERNET_HEADER inet{}; + + memset(&inet, 0, sizeof(NETBOOT_INTERNET_HEADER)); + + /// TODO: Read packet from JSON file 'bootnet.json' + + if (inet.PatchLength < 1) + { + Boot::BootTextWriter writer; + writer.Write("NetBootLauncher: No executable attached to the packet, aborting.\r"); + + return kEfiFail; + } + + if (!inet.EEPROM) + { + Boot::BootThread thread(inet.PatchData); + + if (thread.IsValid()) + return thread.Start(handover, YES); + + return kEfiFail; + } + else + { + Boot::BootTextWriter writer; + writer.Write("NetBootLauncher: EEPROM flash is not available as of right now.\r"); + + /// TODO: Program new firmware to EEPROM (if crc and size matches) + + return kEfiFail; // TODO: Add support for EEPROM firmware update. + } + + return kEfiFail; +} diff --git a/dev/boot/modules/BootNet/BootNet.h b/dev/boot/modules/BootNet/BootNet.h new file mode 100644 index 00000000..cde30658 --- /dev/null +++ b/dev/boot/modules/BootNet/BootNet.h @@ -0,0 +1,33 @@ +/* + * ======================================================== + * + * BootNet + * Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved. + * + * ======================================================== + */ + +#pragma once + +#include + +#define kNetBootINetMagic "NETB" +#define kNetBootINetMagicLength (4) + +#define kNetBootNameLen (256U) + +/// @brief the internet header is used to download updates OTA. +typedef struct NETBOOT_INTERNET_HEADER +{ + NeOS::Char NB1; /// magic char 1 'N' + NeOS::Char NB2; /// magic char 2 'E' + NeOS::Char NB3; /// magic char 3 'T' + NeOS::Char NB4; /// magic char 4 'B' + + NeOS::Char PatchName[kNetBootNameLen]; /// example: Modjo + NeOS::Int32 PatchLength; /// the patch length. + NeOS::Char PatchTarget[kNetBootNameLen]; /// the target file. + NeOS::Boolean EEPROM : 1; /// does it imply an EEPROM reprogram? + NeOS::Boolean Preflight : 1; /// is it a preflight packet. + NeOS::Char PatchData[]; /// non preflight packet has a patch blob for a **PatchTarget** +} ATTRIBUTE(packed) NETBOOT_INTERNET_HEADER; diff --git a/dev/boot/modules/BootNet/amd64.json b/dev/boot/modules/BootNet/amd64.json new file mode 100644 index 00000000..95124574 --- /dev/null +++ b/dev/boot/modules/BootNet/amd64.json @@ -0,0 +1,24 @@ +{ + "compiler_path": "x86_64-w64-mingw32-g++", + "compiler_std": "c++20", + "headers_path": ["../", "../../", "../../../kernel", "../../../", "./"], + "sources_path": ["*.cc", "*.S", "../../src/HEL/AMD64/*.cc", "../../src/HEL/AMD64/*.S", "../../src/*.cc"], + "output_name": "bootnet.sys", + "compiler_flags": [ + "-nostdlib", + "-std=c++20", + "-fPIC", + "-fno-rtti", + "-fno-exceptions", + "-Wl,--subsystem=17,--image-base,0x1000000,-e,ModuleMain" + ], + "cpp_macros": [ + "__NEOSKRNL__", + "__BOOTZ__", + "__BOOTZ_STANDALONE__", + "__NE_AMD64__", + "kNetBootVersionHighest=0x0100", + "kNetBootVersionLowest=0x0100", + "kNetBootVersion=0x0100" + ] +} diff --git a/dev/boot/modules/NetBoot/.hgkeep b/dev/boot/modules/NetBoot/.hgkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/dev/boot/modules/NetBoot/Boot.S b/dev/boot/modules/NetBoot/Boot.S deleted file mode 100644 index 8ebfb352..00000000 --- a/dev/boot/modules/NetBoot/Boot.S +++ /dev/null @@ -1,22 +0,0 @@ -;; /* -;; * ======================================================== -;; * -;; * BootZ -;; * Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved. -;; * -;; * ======================================================== -;; */ - -#ifdef __NE_AMD64__ -.code64 -.intel_syntax noprefix -#endif - -#define kTypeDriver 101 -#define kArchAmd64 122 -#define kHandoverMagic 0xBADCC - -.section .ldr - -.quad kHandoverMagic -.word kTypeDriver diff --git a/dev/boot/modules/NetBoot/NetBoot.cc b/dev/boot/modules/NetBoot/NetBoot.cc deleted file mode 100644 index 4a169d33..00000000 --- a/dev/boot/modules/NetBoot/NetBoot.cc +++ /dev/null @@ -1,50 +0,0 @@ -/* - * ======================================================== - * - * NetBoot - * Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved. - * - * ======================================================== - */ - -#include -#include -#include - -EXTERN_C Int32 ModuleMain(NeOS::HEL::BootInfoHeader* handover) -{ - NETBOOT_INTERNET_HEADER inet{}; - - memset(&inet, 0, sizeof(NETBOOT_INTERNET_HEADER)); - - /// TODO: Read packet from JSON file 'netboot.json' - - if (inet.PatchLength < 1) - { - Boot::BootTextWriter writer; - writer.Write("NetBootLauncher: No executable attached to the packet, aborting.\r"); - - return kEfiFail; - } - - if (!inet.EEPROM) - { - Boot::BootThread thread(inet.PatchData); - - if (thread.IsValid()) - return thread.Start(handover, YES); - - return kEfiFail; - } - else - { - Boot::BootTextWriter writer; - writer.Write("NetBootLauncher: EEPROM flash is not available as of right now.\r"); - - /// TODO: Program new firmware to EEPROM (if crc and size matches) - - return kEfiFail; // TODO: Add support for EEPROM firmware update. - } - - return kEfiFail; -} diff --git a/dev/boot/modules/NetBoot/NetBoot.h b/dev/boot/modules/NetBoot/NetBoot.h deleted file mode 100644 index e250ef27..00000000 --- a/dev/boot/modules/NetBoot/NetBoot.h +++ /dev/null @@ -1,33 +0,0 @@ -/* - * ======================================================== - * - * NetBoot - * Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved. - * - * ======================================================== - */ - -#pragma once - -#include - -#define kNetBootINetMagic "NETB" -#define kNetBootINetMagicLength (4) - -#define kNetBootNameLen (256U) - -/// @brief the internet header is used to download updates OTA. -typedef struct NETBOOT_INTERNET_HEADER -{ - NeOS::Char NB1; /// magic char 1 'N' - NeOS::Char NB2; /// magic char 2 'E' - NeOS::Char NB3; /// magic char 3 'T' - NeOS::Char NB4; /// magic char 4 'B' - - NeOS::Char PatchName[kNetBootNameLen]; /// example: Modjo - NeOS::Int32 PatchLength; /// the patch length. - NeOS::Char PatchTarget[kNetBootNameLen]; /// the target file. - NeOS::Boolean EEPROM : 1; /// does it imply an EEPROM reprogram? - NeOS::Boolean Preflight : 1; /// is it a preflight packet. - NeOS::Char PatchData[]; /// non preflight packet has a patch blob for a **PatchTarget** -} ATTRIBUTE(packed) NETBOOT_INTERNET_HEADER; diff --git a/dev/boot/modules/NetBoot/amd64.json b/dev/boot/modules/NetBoot/amd64.json deleted file mode 100644 index db39cced..00000000 --- a/dev/boot/modules/NetBoot/amd64.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "compiler_path": "x86_64-w64-mingw32-g++", - "compiler_std": "c++20", - "headers_path": ["../", "../../", "../../../kernel", "../../../", "./"], - "sources_path": ["*.cc", "*.S", "../../src/HEL/AMD64/*.cc", "../../src/HEL/AMD64/*.S", "../../src/*.cc"], - "output_name": "netboot.sys", - "compiler_flags": [ - "-nostdlib", - "-std=c++20", - "-fPIC", - "-fno-rtti", - "-fno-exceptions", - "-Wl,--subsystem=17,--image-base,0x1000000,-e,ModuleMain" - ], - "cpp_macros": [ - "__NEOSKRNL__", - "__BOOTZ__", - "__BOOTZ_STANDALONE__", - "__NE_AMD64__", - "kNetBootVersionHighest=0x0100", - "kNetBootVersionLowest=0x0100", - "kNetBootVersion=0x0100" - ] -} diff --git a/dev/boot/modules/SysChk/SysChk.cc b/dev/boot/modules/SysChk/SysChk.cc index c22e183b..e9a740bd 100644 --- a/dev/boot/modules/SysChk/SysChk.cc +++ b/dev/boot/modules/SysChk/SysChk.cc @@ -1,7 +1,7 @@ /* * ======================================================== * - * NetBoot + * SysChk * Copyright (C) 2024-2025, Amlal EL Mahrouss, all rights reserved. * * ======================================================== diff --git a/dev/boot/src/HEL/AMD64/BootEFI.cc b/dev/boot/src/HEL/AMD64/BootEFI.cc index a6af4235..fe976ebd 100644 --- a/dev/boot/src/HEL/AMD64/BootEFI.cc +++ b/dev/boot/src/HEL/AMD64/BootEFI.cc @@ -310,7 +310,7 @@ EFI_EXTERN_C EFI_API Int32 Main(EfiHandlePtr image_handle, Boot::Stop(); } - Boot::BootFileReader reader_netboot(L"netboot.sys", image_handle); + Boot::BootFileReader reader_netboot(L"bootnet.sys", image_handle); reader_netboot.ReadAll(0); Boot::BootThread* netboot_thread = nullptr; @@ -324,13 +324,13 @@ EFI_EXTERN_C EFI_API Int32 Main(EfiHandlePtr image_handle, if (kernel_thread->Start(handover_hdr, YES) != kEfiOk) { // ------------------------------------------ // - // If we fail into booting the kernel, then run NetBoot. + // If we fail into booting the kernel, then run BootNet. // ------------------------------------------ // if (reader_netboot.Blob()) { netboot_thread = new Boot::BootThread(reader_netboot.Blob()); - netboot_thread->SetName("BootZ: NetBoot"); + netboot_thread->SetName("BootZ: BootNet"); netboot_thread->Start(handover_hdr, YES); } } diff --git a/dev/kernel/FirmwareKit/CoreBoot/NS.h b/dev/kernel/FirmwareKit/CoreBoot/NS.h index 95576de8..6cac6ac3 100644 --- a/dev/kernel/FirmwareKit/CoreBoot/NS.h +++ b/dev/kernel/FirmwareKit/CoreBoot/NS.h @@ -7,4 +7,4 @@ #pragma once #include -#include \ No newline at end of file +#include \ No newline at end of file -- cgit v1.2.3