ValidateAcpi.c

Go to the documentation of this file.

 
#include "ocvalidate.h"
#include "OcValidateLib.h"
 
STATIC
BOOLEAN
ACPIAddHasDuplication (
  IN  CONST VOID  *PrimaryEntry,
  IN  CONST VOID  *SecondaryEntry
  )
{
  CONST OC_ACPI_ADD_ENTRY  *ACPIAddPrimaryEntry;
  CONST OC_ACPI_ADD_ENTRY  *ACPIAddSecondaryEntry;
  CONST CHAR8              *ACPIAddPrimaryPathString;
  CONST CHAR8              *ACPIAddSecondaryPathString;
 
  ACPIAddPrimaryEntry        = *(CONST OC_ACPI_ADD_ENTRY **)PrimaryEntry;
  ACPIAddSecondaryEntry      = *(CONST OC_ACPI_ADD_ENTRY **)SecondaryEntry;
  ACPIAddPrimaryPathString   = OC_BLOB_GET (&ACPIAddPrimaryEntry->Path);
  ACPIAddSecondaryPathString = OC_BLOB_GET (&ACPIAddSecondaryEntry->Path);
 
  if (!ACPIAddPrimaryEntry->Enabled || !ACPIAddSecondaryEntry->Enabled) {
    return FALSE;
  }
 
  return StringIsDuplicated ("ACPI->Add", ACPIAddPrimaryPathString, ACPIAddSecondaryPathString);
}
 
STATIC
UINT32
CheckACPIAdd (
  IN  OC_GLOBAL_CONFIG  *Config
  )
{
  UINT32       ErrorCount;
  UINT32       Index;
  CONST CHAR8  *Path;
  CONST CHAR8  *Comment;
  UINTN        AcpiAddSumSize;
 
  ErrorCount = 0;
 
  for (Index = 0; Index < Config->Acpi.Add.Count; ++Index) {
    Path    = OC_BLOB_GET (&Config->Acpi.Add.Values[Index]->Path);
    Comment = OC_BLOB_GET (&Config->Acpi.Add.Values[Index]->Comment);
 
    //
    // Sanitise strings.
    //
    if (!AsciiFileSystemPathIsLegal (Path)) {
      DEBUG ((DEBUG_WARN, "ACPI->Add[%u]->Path contains illegal character!\n", Index));
      ++ErrorCount;
      continue;
    }
 
    if (!AsciiCommentIsLegal (Comment)) {
      DEBUG ((DEBUG_WARN, "ACPI->Add[%u]->Comment contains illegal character!\n", Index));
      ++ErrorCount;
    }
 
    if (!OcAsciiEndsWith (Path, ".aml", TRUE) && !OcAsciiEndsWith (Path, ".bin", TRUE)) {
      DEBUG ((DEBUG_WARN, "ACPI->Add[%u]->Path has filename suffix other than .aml and .bin!\n", Index));
      ++ErrorCount;
    }
 
    //
    // Check the length of path relative to OC directory.
    //
    AcpiAddSumSize = L_STR_LEN (OPEN_CORE_ACPI_PATH) + AsciiStrSize (Path);
    if (AcpiAddSumSize > OC_STORAGE_SAFE_PATH_MAX) {
      DEBUG ((
        DEBUG_WARN,
        "ACPI->Add[%u]->Path (length %u) is too long (should not exceed %u)!\n",
        Index,
        AsciiStrLen (Path),
        OC_STORAGE_SAFE_PATH_MAX - L_STR_LEN (OPEN_CORE_ACPI_PATH)
        ));
      ++ErrorCount;
    }
  }
 
  //
  // Check duplicated entries in ACPI->Add.
  //
  ErrorCount += FindArrayDuplication (
                  Config->Acpi.Add.Values,
                  Config->Acpi.Add.Count,
                  sizeof (Config->Acpi.Add.Values[0]),
                  ACPIAddHasDuplication
                  );
 
  return ErrorCount;
}
 
STATIC
UINT32
CheckACPIDelete (
  IN  OC_GLOBAL_CONFIG  *Config
  )
{
  UINT32       ErrorCount;
  UINT32       Index;
  CONST CHAR8  *Comment;
 
  ErrorCount = 0;
 
  for (Index = 0; Index < Config->Acpi.Delete.Count; ++Index) {
    Comment = OC_BLOB_GET (&Config->Acpi.Delete.Values[Index]->Comment);
 
    //
    // Sanitise strings.
    //
    if (!AsciiCommentIsLegal (Comment)) {
      DEBUG ((DEBUG_WARN, "ACPI->Delete[%u]->Comment contains illegal character!\n", Index));
      ++ErrorCount;
    }
 
    //
    // Size of OemTableId and TableSignature cannot be checked,
    // as serialisation kills it.
    //
  }
 
  return ErrorCount;
}
 
STATIC
UINT32
CheckACPIPatch (
  IN  OC_GLOBAL_CONFIG  *Config
  )
{
  UINT32       ErrorCount;
  UINT32       Index;
  CONST CHAR8  *Comment;
  CONST UINT8  *Find;
  UINT32       FindSize;
  CONST UINT8  *Replace;
  UINT32       ReplaceSize;
  CONST UINT8  *Mask;
  UINT32       MaskSize;
  CONST UINT8  *ReplaceMask;
  UINT32       ReplaceMaskSize;
 
  ErrorCount = 0;
 
  for (Index = 0; Index < Config->Acpi.Patch.Count; ++Index) {
    Comment         = OC_BLOB_GET (&Config->Acpi.Patch.Values[Index]->Comment);
    Find            = OC_BLOB_GET (&Config->Acpi.Patch.Values[Index]->Find);
    FindSize        = Config->Acpi.Patch.Values[Index]->Find.Size;
    Replace         = OC_BLOB_GET (&Config->Acpi.Patch.Values[Index]->Replace);
    ReplaceSize     = Config->Acpi.Patch.Values[Index]->Replace.Size;
    Mask            = OC_BLOB_GET (&Config->Acpi.Patch.Values[Index]->Mask);
    MaskSize        = Config->Acpi.Patch.Values[Index]->Mask.Size;
    ReplaceMask     = OC_BLOB_GET (&Config->Acpi.Patch.Values[Index]->ReplaceMask);
    ReplaceMaskSize = Config->Acpi.Patch.Values[Index]->ReplaceMask.Size;
 
    //
    // Sanitise strings.
    //
    if (!AsciiCommentIsLegal (Comment)) {
      DEBUG ((DEBUG_WARN, "ACPI->Patch[%u]->Comment contains illegal character!\n", Index));
      ++ErrorCount;
    }
 
    //
    // Size of OemTableId and TableSignature cannot be checked,
    // as serialisation kills it.
    //
 
    //
    // Checks for size.
    //
    ErrorCount += ValidatePatch (
                    "ACPI->Patch",
                    Index,
                    FALSE,
                    Find,
                    FindSize,
                    Replace,
                    ReplaceSize,
                    Mask,
                    MaskSize,
                    ReplaceMask,
                    ReplaceMaskSize
                    );
  }
 
  return ErrorCount;
}
 
UINT32
CheckACPI (
  IN  OC_GLOBAL_CONFIG  *Config
  )
{
  UINT32               ErrorCount;
  UINTN                Index;
  STATIC CONFIG_CHECK  ACPICheckers[] = {
    &CheckACPIAdd,
    &CheckACPIDelete,
    &CheckACPIPatch
  };
 
  DEBUG ((DEBUG_VERBOSE, "config loaded into %a!\n", __func__));
 
  ErrorCount = 0;
 
  for (Index = 0; Index < ARRAY_SIZE (ACPICheckers); ++Index) {
    ErrorCount += ACPICheckers[Index](Config);
  }
 
  return ReportError (__func__, ErrorCount);
}