Migrate XTLDR modules to C++

2025-09-17 22:30:48 +02:00
parent 57fbbf820c
commit dcae0cbb91
56 changed files with 1259 additions and 1297 deletions
--- a/xtldr/modules/acpi/CMakeLists.txt
+++ b/xtldr/modules/acpi/CMakeLists.txt
@@ -8,8 +8,8 @@ include_directories(

 # Specify list of source code files
 list(APPEND XTLDR_ACPI_SOURCE
-    ${XTLDR_ACPI_SOURCE_DIR}/acpi.c
-    ${XTLDR_ACPI_SOURCE_DIR}/globals.c)
+    ${XTLDR_ACPI_SOURCE_DIR}/acpi.cc
+    ${XTLDR_ACPI_SOURCE_DIR}/data.cc)

 # Link module executable
 add_executable(acpi ${XTLDR_ACPI_SOURCE})
--- a/xtldr/modules/acpi/acpi.cc
+++ b/xtldr/modules/acpi/acpi.cc
@@ -1,20 +1,21 @@
 /**
 * PROJECT:         ExectOS
 * COPYRIGHT:       See COPYING.md in the top level directory
- * FILE:            xtldr/modules/acpi/acpi.c
+ * FILE:            xtldr/modules/acpi/acpi.cc
 * DESCRIPTION:     XTLDR ACPI Support Module
 * DEVELOPERS:      Rafal Kupiec <belliash@codingworkshop.eu.org>
 */

-#include <acpi.h>
+#include <acpi.hh>


-/* Dummy module information */
+/* ACPI module information */
 MODULE_AUTHOR(L"Rafal Kupiec <belliash@codingworkshop.eu.org>");
 MODULE_DESCRIPTION(L"ACPI support");
 MODULE_LICENSE(L"GPLv3");
 MODULE_VERSION(L"0.1");

+
 /**
 * Attempts to get XSDP. If it is not found or checksum mismatch, it will try to get RSDP instead.
 *
@@ -27,12 +28,12 @@ MODULE_VERSION(L"0.1");
 */
 XTCDECL
 EFI_STATUS
-AcGetAcpiDescriptionPointer(OUT PVOID *AcpiTable)
+Acpi::GetAcpiDescriptionPointer(OUT PVOID *AcpiTable)
 {
    PVOID Rsdp;

    /* Try to get XSDP (ACPI 2.0) from system configuration tables */
-    if(AcGetXsdpTable(&Rsdp) == STATUS_EFI_SUCCESS)
+    if(GetXsdpTable(&Rsdp) == STATUS_EFI_SUCCESS)
    {
        /* XSDP found, return success */
        *AcpiTable = Rsdp;
@@ -40,7 +41,7 @@ AcGetAcpiDescriptionPointer(OUT PVOID *AcpiTable)
    }

    /* Try to get RSDP (ACPI 1.0) from system configuration tables */
-    if(AcGetRsdpTable(&Rsdp) == STATUS_EFI_SUCCESS)
+    if(GetRsdpTable(&Rsdp) == STATUS_EFI_SUCCESS)
    {
        /* RSDP found, return success */
        *AcpiTable = Rsdp;
@@ -69,9 +70,9 @@ AcGetAcpiDescriptionPointer(OUT PVOID *AcpiTable)
 */
 XTCDECL
 EFI_STATUS
-AcGetAcpiTable(IN CONST UINT Signature,
-               IN PVOID PreviousTable,
-               OUT PVOID *AcpiTable)
+Acpi::GetAcpiTable(IN CONST UINT Signature,
+                   IN PVOID PreviousTable,
+                   OUT PVOID *AcpiTable)
 {
    PACPI_DESCRIPTION_HEADER TableHeader;
    SIZE_T RsdtIndex, TableIndex;
@@ -85,7 +86,7 @@ AcGetAcpiTable(IN CONST UINT Signature,
    *AcpiTable = NULLPTR;

    /* Get Root System Description Table Pointer */
-    Status = AcGetAcpiDescriptionPointer((PVOID)&Rsdp);
+    Status = GetAcpiDescriptionPointer((PVOID*)&Rsdp);
    if(Status != STATUS_EFI_SUCCESS)
    {
        /* ACPI tables not found, return error */
@@ -159,7 +160,7 @@ AcGetAcpiTable(IN CONST UINT Signature,
    if(TableHeader->Signature != ACPI_FADT_SIGNATURE || TableHeader->Revision > 2)
    {
        /* Validate table checksum */
-        if(!AcpValidateAcpiTable(TableHeader, TableHeader->Length))
+        if(!ValidateAcpiTable(TableHeader, TableHeader->Length))
        {
            /* Checksum mismatch, return error */
            return STATUS_EFI_CRC_ERROR;
@@ -183,7 +184,7 @@ AcGetAcpiTable(IN CONST UINT Signature,
 */
 XTCDECL
 EFI_STATUS
-AcGetApicBase(OUT PVOID *ApicBase)
+Acpi::GetApicBase(OUT PVOID *ApicBase)
 {
    CPUID_REGISTERS CpuRegisters;

@@ -220,7 +221,7 @@ AcGetApicBase(OUT PVOID *ApicBase)
 */
 XTCDECL
 EFI_STATUS
-AcGetRsdpTable(OUT PVOID *AcpiTable)
+Acpi::GetRsdpTable(OUT PVOID *AcpiTable)
 {
    EFI_GUID AcpiGuid = EFI_CONFIG_TABLE_ACPI_TABLE_GUID;
    EFI_STATUS Status;
@@ -228,7 +229,7 @@ AcGetRsdpTable(OUT PVOID *AcpiTable)

    /* Get RSDP (ACPI 1.0) table from system configuration tables */
    Status = XtLdrProtocol->Util.GetConfigurationTable(&AcpiGuid, &RsdpTable);
-    if(Status != STATUS_EFI_SUCCESS || !AcpValidateAcpiTable(RsdpTable, 20))
+    if(Status != STATUS_EFI_SUCCESS || !ValidateAcpiTable(RsdpTable, 20))
    {
        /* RSDP not found or checksum mismatch */
        *AcpiTable = NULLPTR;
@@ -252,15 +253,15 @@ AcGetRsdpTable(OUT PVOID *AcpiTable)
 */
 XTCDECL
 EFI_STATUS
-AcGetSMBiosTable(OUT PVOID *SmBiosTable)
+Acpi::GetSMBiosTable(OUT PVOID *SmBiosTable)
 {
    EFI_GUID SmBiosGuid = EFI_CONFIG_TABLE_SMBIOS_TABLE_GUID;
    PSMBIOS_TABLE_HEADER SmBios;
    EFI_STATUS Status;

    /* Get SMBIOS table from system configuration tables */
-    Status = XtLdrProtocol->Util.GetConfigurationTable(&SmBiosGuid, (PVOID)&SmBios);
-    if(Status != STATUS_EFI_SUCCESS || !AcpValidateAcpiTable(SmBios, SmBios->Length))
+    Status = XtLdrProtocol->Util.GetConfigurationTable(&SmBiosGuid, (PVOID*)&SmBios);
+    if(Status != STATUS_EFI_SUCCESS || !ValidateAcpiTable(SmBios, SmBios->Length))
    {
        /* SMBIOS not found or checksum mismatch */
        *SmBiosTable = NULLPTR;
@@ -284,15 +285,15 @@ AcGetSMBiosTable(OUT PVOID *SmBiosTable)
 */
 XTCDECL
 EFI_STATUS
-AcGetSMBios3Table(OUT PVOID *SmBiosTable)
+Acpi::GetSMBios3Table(OUT PVOID *SmBiosTable)
 {
    EFI_GUID SmBios3Guid = EFI_CONFIG_TABLE_SMBIOS3_TABLE_GUID;
    PSMBIOS3_TABLE_HEADER SmBios;
    EFI_STATUS Status;

    /* Get SMBIOS3 table from system configuration tables */
-    Status = XtLdrProtocol->Util.GetConfigurationTable(&SmBios3Guid, (PVOID)&SmBios);
-    if(Status != STATUS_EFI_SUCCESS || !AcpValidateAcpiTable(SmBios, SmBios->Length))
+    Status = XtLdrProtocol->Util.GetConfigurationTable(&SmBios3Guid, (PVOID*)&SmBios);
+    if(Status != STATUS_EFI_SUCCESS || !ValidateAcpiTable(SmBios, SmBios->Length))
    {
        /* SMBIOS3 not found or checksum mismatch */
        *SmBiosTable = NULLPTR;
@@ -316,7 +317,7 @@ AcGetSMBios3Table(OUT PVOID *SmBiosTable)
 */
 XTCDECL
 EFI_STATUS
-AcGetXsdpTable(OUT PVOID *AcpiTable)
+Acpi::GetXsdpTable(OUT PVOID *AcpiTable)
 {
    EFI_GUID AcpiGuid = EFI_CONFIG_TABLE_ACPI20_TABLE_GUID;
    EFI_STATUS Status;
@@ -324,7 +325,7 @@ AcGetXsdpTable(OUT PVOID *AcpiTable)

    /* Get XSDP (ACPI 2.0) from system configuration tables */
    Status = XtLdrProtocol->Util.GetConfigurationTable(&AcpiGuid, &XsdpTable);
-    if(Status != STATUS_EFI_SUCCESS || !AcpValidateAcpiTable(XsdpTable, 36))
+    if(Status != STATUS_EFI_SUCCESS || !ValidateAcpiTable(XsdpTable, 36))
    {
        /* XSDP not found or checksum mismatch */
        *AcpiTable = NULLPTR;
@@ -336,6 +337,48 @@ AcGetXsdpTable(OUT PVOID *AcpiTable)
    return STATUS_EFI_SUCCESS;
 }

+/**
+ * Initializes ACPI module by opening XTLDR protocol and installing ACPI protocol.
+ *
+ * @param ImageHandle
+ *        Firmware-allocated handle that identifies the image.
+ *
+ * @param SystemTable
+ *        Provides the EFI system table.
+ *
+ * @return This routine returns status code.
+ *
+ * @since XT 1.0
+ */
+XTCDECL
+EFI_STATUS
+Acpi::InitializeModule(IN EFI_HANDLE ImageHandle,
+                       IN PEFI_SYSTEM_TABLE SystemTable)
+{
+    EFI_GUID Guid = XT_ACPI_PROTOCOL_GUID;
+    EFI_STATUS Status;
+
+    /* Open the XTLDR protocol */
+    Status = BlGetXtLdrProtocol(SystemTable, ImageHandle, &XtLdrProtocol);
+    if(Status != STATUS_EFI_SUCCESS)
+    {
+        /* Failed to open the protocol, return error */
+        return STATUS_EFI_PROTOCOL_ERROR;
+    }
+
+    /* Set routines available via ACPI protocol */
+    AcpiProtocol.GetAcpiDescriptionPointer = GetAcpiDescriptionPointer;
+    AcpiProtocol.GetAcpiTable = GetAcpiTable;
+    AcpiProtocol.GetApicBase = GetApicBase;
+    AcpiProtocol.GetRsdpTable = GetRsdpTable;
+    AcpiProtocol.GetSMBiosTable = GetSMBiosTable;
+    AcpiProtocol.GetSMBios3Table = GetSMBios3Table;
+    AcpiProtocol.GetXsdpTable = GetXsdpTable;
+
+    /* Install ACPI protocol */
+    return XtLdrProtocol->Protocol.Install(&AcpiProtocol, &Guid);
+}
+
 /**
 * Validates given ACPI table by calculating its checksum.
 *
@@ -351,15 +394,15 @@ AcGetXsdpTable(OUT PVOID *AcpiTable)
 */
 XTCDECL
 BOOLEAN
-AcpValidateAcpiTable(IN PVOID Buffer,
-                     IN UINT_PTR Size)
+Acpi::ValidateAcpiTable(IN PVOID Buffer,
+                        IN UINT_PTR Size)
 {
    PUCHAR Pointer;
    UCHAR Sum;

    /* Initialize variables */
    Sum = 0;
-    Pointer = Buffer;
+    Pointer = (PUCHAR)Buffer;

    /* Calculate checksum of given table */
    while(Size != 0)
@@ -391,26 +434,6 @@ EFI_STATUS
 XtLdrModuleMain(IN EFI_HANDLE ImageHandle,
                IN PEFI_SYSTEM_TABLE SystemTable)
 {
-    EFI_GUID Guid = XT_ACPI_PROTOCOL_GUID;
-    EFI_STATUS Status;
-
-    /* Open the XTLDR protocol */
-    Status = BlGetXtLdrProtocol(SystemTable, ImageHandle, &XtLdrProtocol);
-    if(Status != STATUS_EFI_SUCCESS)
-    {
-        /* Failed to open the protocol, return error */
-        return STATUS_EFI_PROTOCOL_ERROR;
-    }
-
-    /* Set routines available via ACPI protocol */
-    AcpAcpiProtocol.GetAcpiDescriptionPointer = AcGetAcpiDescriptionPointer;
-    AcpAcpiProtocol.GetAcpiTable = AcGetAcpiTable;
-    AcpAcpiProtocol.GetApicBase = AcGetApicBase;
-    AcpAcpiProtocol.GetRsdpTable = AcGetRsdpTable;
-    AcpAcpiProtocol.GetSMBiosTable = AcGetSMBiosTable;
-    AcpAcpiProtocol.GetSMBios3Table = AcGetSMBios3Table;
-    AcpAcpiProtocol.GetXsdpTable = AcGetXsdpTable;
-
-    /* Install ACPI protocol */
-    return XtLdrProtocol->Protocol.Install(&AcpAcpiProtocol, &Guid);
+    /* Initialize ACPI module */
+    return Acpi::InitializeModule(ImageHandle, SystemTable);
 }
--- a/xtldr/modules/acpi/globals.c
+++ b/xtldr/modules/acpi/globals.c
@@ -1,16 +1,16 @@
 /**
 * PROJECT:         ExectOS
 * COPYRIGHT:       See COPYING.md in the top level directory
- * FILE:            xtldr/modules/acpi/globals.c
- * DESCRIPTION:     ACPI module global variables
+ * FILE:            xtldr/modules/acpi/data.cc
+ * DESCRIPTION:     ACPI module global and static data
 * DEVELOPERS:      Rafal Kupiec <belliash@codingworkshop.eu.org>
 */

-#include <xtblapi.h>
+#include <acpi.hh>


 /* ACPI Protocol */
-XTBL_ACPI_PROTOCOL AcpAcpiProtocol;
+XTBL_ACPI_PROTOCOL Acpi::AcpiProtocol;

 /* XTLDR protocol handler */
-PXTBL_LOADER_PROTOCOL XtLdrProtocol;
+PXTBL_LOADER_PROTOCOL Acpi::XtLdrProtocol;
--- a/xtldr/modules/acpi/includes/acpi.h
+++ b/xtldr/modules/acpi/includes/acpi.h
@@ -1,57 +0,0 @@
-/**
- * PROJECT:         ExectOS
- * COPYRIGHT:       See COPYING.md in the top level directory
- * FILE:            xtldr/modules/acpi/includes/acpi.h
- * DESCRIPTION:     XTLDR ACPI module header file
- * DEVELOPERS:      Rafal Kupiec <belliash@codingworkshop.eu.org>
- */
-
-#ifndef __XTLDR_ACPI_ACPI_H
-#define __XTLDR_ACPI_ACPI_H
-
-#include <xtblapi.h>
-#include <globals.h>
-
-
-/* ACPI module routines forward references */
-XTCDECL
-EFI_STATUS
-AcGetAcpiDescriptionPointer(OUT PVOID *AcpiTable);
-
-XTCDECL
-EFI_STATUS
-AcGetAcpiTable(IN CONST UINT Signature,
-               IN PVOID PreviousTable,
-               OUT PVOID *AcpiTable);
-
-XTCDECL
-EFI_STATUS
-AcGetApicBase(OUT PVOID *ApicBase);
-
-XTCDECL
-EFI_STATUS
-AcGetRsdpTable(OUT PVOID *AcpiTable);
-
-XTCDECL
-EFI_STATUS
-AcGetSMBiosTable(OUT PVOID *SmBiosTable);
-
-XTCDECL
-EFI_STATUS
-AcGetSMBios3Table(OUT PVOID *SmBiosTable);
-
-XTCDECL
-EFI_STATUS
-AcGetXsdpTable(OUT PVOID *AcpiTable);
-
-XTCDECL
-BOOLEAN
-AcpValidateAcpiTable(IN PVOID Buffer,
-                     IN UINT_PTR Size);
-
-XTCDECL
-EFI_STATUS
-XtLdrModuleMain(IN EFI_HANDLE ImageHandle,
-                IN PEFI_SYSTEM_TABLE SystemTable);
-
-#endif/* __XTLDR_ACPI_ACPI_H */
--- a/xtldr/modules/acpi/includes/acpi.hh
+++ b/xtldr/modules/acpi/includes/acpi.hh
@@ -0,0 +1,40 @@
+/**
+ * PROJECT:         ExectOS
+ * COPYRIGHT:       See COPYING.md in the top level directory
+ * FILE:            xtldr/modules/acpi/includes/acpi.hh
+ * DESCRIPTION:     XTLDR ACPI module header file
+ * DEVELOPERS:      Rafal Kupiec <belliash@codingworkshop.eu.org>
+ */
+
+#ifndef __XTLDR_ACPI_ACPI_HH
+#define __XTLDR_ACPI_ACPI_HH
+
+#include <xtblapi.h>
+
+
+/* ACPI module for XTLDR */
+class Acpi
+{
+    private:
+        STATIC XTBL_ACPI_PROTOCOL AcpiProtocol;
+        STATIC PXTBL_LOADER_PROTOCOL XtLdrProtocol;
+
+    public:
+        STATIC XTCDECL EFI_STATUS GetAcpiDescriptionPointer(OUT PVOID *AcpiTable);
+        STATIC XTCDECL EFI_STATUS GetAcpiTable(IN CONST UINT Signature,
+                                               IN PVOID PreviousTable,
+                                               OUT PVOID *AcpiTable);
+        STATIC XTCDECL EFI_STATUS GetApicBase(OUT PVOID *ApicBase);
+        STATIC XTCDECL EFI_STATUS GetRsdpTable(OUT PVOID *AcpiTable);
+        STATIC XTCDECL EFI_STATUS GetSMBiosTable(OUT PVOID *SmBiosTable);
+        STATIC XTCDECL EFI_STATUS GetSMBios3Table(OUT PVOID *SmBiosTable);
+        STATIC XTCDECL EFI_STATUS GetXsdpTable(OUT PVOID *AcpiTable);
+        STATIC XTCDECL EFI_STATUS InitializeModule(IN EFI_HANDLE ImageHandle,
+                                                   IN PEFI_SYSTEM_TABLE SystemTable);
+
+    private:
+        STATIC XTCDECL BOOLEAN ValidateAcpiTable(IN PVOID Buffer,
+                                                 IN UINT_PTR Size);
+};
+
+#endif /* __XTLDR_ACPI_ACPI_HH */
--- a/xtldr/modules/acpi/includes/globals.h
+++ b/xtldr/modules/acpi/includes/globals.h
@@ -1,21 +0,0 @@
-/**
- * PROJECT:         ExectOS
- * COPYRIGHT:       See COPYING.md in the top level directory
- * FILE:            xtldr/modules/acpi/includes/globals.h
- * DESCRIPTION:     ACPI Module global variables
- * DEVELOPERS:      Rafal Kupiec <belliash@codingworkshop.eu.org>
- */
-
-#ifndef __XTLDR_ACPI_GLOBALS_H
-#define __XTLDR_ACPI_GLOBALS_H
-
-#include <acpi.h>
-
-
-/* ACPI Protocol */
-EXTERN XTBL_ACPI_PROTOCOL AcpAcpiProtocol;
-
-/* XTLDR protocol handler */
-EXTERN PXTBL_LOADER_PROTOCOL XtLdrProtocol;
-
-#endif/* __XTLDR_ACPI_GLOBALS_H */