MdePkg/Library/UefiLib/Acpi.c

   1 /** @file
   2   This module provides help function for finding ACPI table.
   3
   4   Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
   5   SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7 **/
   8
   9 #include "UefiLibInternal.h"
  10 #include <IndustryStandard/Acpi.h>
  11 #include <Guid/Acpi.h>
  12
  13 /**
  14   This function scans ACPI table in XSDT/RSDT.
  15
  16   @param Sdt                    ACPI XSDT/RSDT.
  17   @param TablePointerSize       Size of table pointer: 8(XSDT) or 4(RSDT).
  18   @param Signature              ACPI table signature.
  19   @param PreviousTable          Pointer to previous returned table to locate
  20                                 next table, or NULL to locate first table.
  21   @param PreviousTableLocated   Pointer to the indicator about whether the
  22                                 previous returned table could be located, or
  23                                 NULL if PreviousTable is NULL.
  24
  25   If PreviousTable is NULL and PreviousTableLocated is not NULL, then ASSERT().
  26   If PreviousTable is not NULL and PreviousTableLocated is NULL, then ASSERT().
  27
  28   @return ACPI table or NULL if not found.
  29
  30 **/
  31 EFI_ACPI_COMMON_HEADER *
  32 ScanTableInSDT (
  33   IN  EFI_ACPI_DESCRIPTION_HEADER  *Sdt,
  34   IN  UINTN                        TablePointerSize,
  35   IN  UINT32                       Signature,
  36   IN  EFI_ACPI_COMMON_HEADER       *PreviousTable  OPTIONAL,
  37   OUT BOOLEAN                      *PreviousTableLocated OPTIONAL
  38   )
  39 {
  40   UINTN                   Index;
  41   UINTN                   EntryCount;
  42   UINT64                  EntryPtr;
  43   UINTN                   BasePtr;
  44   EFI_ACPI_COMMON_HEADER  *Table;
  45
  46   if (PreviousTableLocated != NULL) {
  47     ASSERT (PreviousTable != NULL);
  48     *PreviousTableLocated = FALSE;
  49   } else {
  50     ASSERT (PreviousTable == NULL);
  51   }
  52
  53   if (Sdt == NULL) {
  54     return NULL;
  55   }
  56
  57   EntryCount = (Sdt->Length - sizeof (EFI_ACPI_DESCRIPTION_HEADER)) / TablePointerSize;
  58
  59   BasePtr = (UINTN)(Sdt + 1);
  60   for (Index = 0; Index < EntryCount; Index++) {
  61     EntryPtr = 0;
  62     CopyMem (&EntryPtr, (VOID *)(BasePtr + Index * TablePointerSize), TablePointerSize);
  63     Table = (EFI_ACPI_COMMON_HEADER *)((UINTN)(EntryPtr));
  64     if ((Table != NULL) && (Table->Signature == Signature)) {
  65       if (PreviousTable != NULL) {
  66         if (Table == PreviousTable) {
  67           *PreviousTableLocated = TRUE;
  68         } else if (*PreviousTableLocated) {
  69           //
  70           // Return next table.
  71           //
  72           return Table;
  73         }
  74       } else {
  75         //
  76         // Return first table.
  77         //
  78         return Table;
  79       }
  80     }
  81   }
  82
  83   return NULL;
  84 }
  85
  86 /**
  87   To locate FACS in FADT.
  88
  89   @param Fadt   FADT table pointer.
  90
  91   @return FACS table pointer or NULL if not found.
  92
  93 **/
  94 EFI_ACPI_COMMON_HEADER *
  95 LocateAcpiFacsFromFadt (
  96   IN EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE  *Fadt
  97   )
  98 {
  99   EFI_ACPI_COMMON_HEADER  *Facs;
 100   UINT64                  Data64;
 101
 102   if (Fadt == NULL) {
 103     return NULL;
 104   }
 105
 106   if (Fadt->Header.Revision < EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION) {
 107     Facs = (EFI_ACPI_COMMON_HEADER *)(UINTN)Fadt->FirmwareCtrl;
 108   } else {
 109     CopyMem (&Data64, &Fadt->XFirmwareCtrl, sizeof (UINT64));
 110     if (Data64 != 0) {
 111       Facs = (EFI_ACPI_COMMON_HEADER *)(UINTN)Data64;
 112     } else {
 113       Facs = (EFI_ACPI_COMMON_HEADER *)(UINTN)Fadt->FirmwareCtrl;
 114     }
 115   }
 116
 117   return Facs;
 118 }
 119
 120 /**
 121   To locate DSDT in FADT.
 122
 123   @param Fadt   FADT table pointer.
 124
 125   @return DSDT table pointer or NULL if not found.
 126
 127 **/
 128 EFI_ACPI_COMMON_HEADER *
 129 LocateAcpiDsdtFromFadt (
 130   IN EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE  *Fadt
 131   )
 132 {
 133   EFI_ACPI_COMMON_HEADER  *Dsdt;
 134   UINT64                  Data64;
 135
 136   if (Fadt == NULL) {
 137     return NULL;
 138   }
 139
 140   if (Fadt->Header.Revision < EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_REVISION) {
 141     Dsdt = (EFI_ACPI_COMMON_HEADER *)(UINTN)Fadt->Dsdt;
 142   } else {
 143     CopyMem (&Data64, &Fadt->XDsdt, sizeof (UINT64));
 144     if (Data64 != 0) {
 145       Dsdt = (EFI_ACPI_COMMON_HEADER *)(UINTN)Data64;
 146     } else {
 147       Dsdt = (EFI_ACPI_COMMON_HEADER *)(UINTN)Fadt->Dsdt;
 148     }
 149   }
 150
 151   return Dsdt;
 152 }
 153
 154 /**
 155   To locate ACPI table in ACPI ConfigurationTable.
 156
 157   @param AcpiGuid               The GUID used to get ACPI ConfigurationTable.
 158   @param Signature              ACPI table signature.
 159   @param PreviousTable          Pointer to previous returned table to locate
 160                                 next table, or NULL to locate first table.
 161   @param PreviousTableLocated   Pointer to the indicator to return whether the
 162                                 previous returned table could be located or not,
 163                                 or NULL if PreviousTable is NULL.
 164
 165   If PreviousTable is NULL and PreviousTableLocated is not NULL, then ASSERT().
 166   If PreviousTable is not NULL and PreviousTableLocated is NULL, then ASSERT().
 167   If AcpiGuid is NULL, then ASSERT().
 168
 169   @return ACPI table or NULL if not found.
 170
 171 **/
 172 EFI_ACPI_COMMON_HEADER *
 173 LocateAcpiTableInAcpiConfigurationTable (
 174   IN  EFI_GUID                *AcpiGuid,
 175   IN  UINT32                  Signature,
 176   IN  EFI_ACPI_COMMON_HEADER  *PreviousTable  OPTIONAL,
 177   OUT BOOLEAN                 *PreviousTableLocated OPTIONAL
 178   )
 179 {
 180   EFI_STATUS                                    Status;
 181   EFI_ACPI_COMMON_HEADER                        *Table;
 182   EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER  *Rsdp;
 183   EFI_ACPI_DESCRIPTION_HEADER                   *Rsdt;
 184   EFI_ACPI_DESCRIPTION_HEADER                   *Xsdt;
 185   EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE     *Fadt;
 186
 187   if (PreviousTableLocated != NULL) {
 188     ASSERT (PreviousTable != NULL);
 189     *PreviousTableLocated = FALSE;
 190   } else {
 191     ASSERT (PreviousTable == NULL);
 192   }
 193
 194   Rsdp = NULL;
 195   //
 196   // Get ACPI ConfigurationTable (RSD_PTR)
 197   //
 198   Status = EfiGetSystemConfigurationTable (AcpiGuid, (VOID **)&Rsdp);
 199   if (EFI_ERROR (Status) || (Rsdp == NULL)) {
 200     return NULL;
 201   }
 202
 203   Table = NULL;
 204
 205   //
 206   // Search XSDT
 207   //
 208   if (Rsdp->Revision >= EFI_ACPI_2_0_ROOT_SYSTEM_DESCRIPTION_POINTER_REVISION) {
 209     Xsdt = (EFI_ACPI_DESCRIPTION_HEADER *)(UINTN)Rsdp->XsdtAddress;
 210     if (Signature == EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE) {
 211       ASSERT (PreviousTable == NULL);
 212       //
 213       // It is to locate DSDT,
 214       // need to locate FADT first.
 215       //
 216       Fadt = (EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE *)ScanTableInSDT (
 217                                                             Xsdt,
 218                                                             sizeof (UINT64),
 219                                                             EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE,
 220                                                             NULL,
 221                                                             NULL
 222                                                             );
 223       Table = LocateAcpiDsdtFromFadt (Fadt);
 224     } else if (Signature == EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) {
 225       ASSERT (PreviousTable == NULL);
 226       //
 227       // It is to locate FACS,
 228       // need to locate FADT first.
 229       //
 230       Fadt = (EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE *)ScanTableInSDT (
 231                                                             Xsdt,
 232                                                             sizeof (UINT64),
 233                                                             EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE,
 234                                                             NULL,
 235                                                             NULL
 236                                                             );
 237       Table = LocateAcpiFacsFromFadt (Fadt);
 238     } else {
 239       Table = ScanTableInSDT (
 240                 Xsdt,
 241                 sizeof (UINT64),
 242                 Signature,
 243                 PreviousTable,
 244                 PreviousTableLocated
 245                 );
 246     }
 247   }
 248
 249   if (Table != NULL) {
 250     return Table;
 251   } else if ((PreviousTableLocated != NULL) &&
 252              *PreviousTableLocated)
 253   {
 254     //
 255     // PreviousTable could be located in XSDT,
 256     // but next table could not be located in XSDT.
 257     //
 258     return NULL;
 259   }
 260
 261   //
 262   // Search RSDT
 263   //
 264   Rsdt = (EFI_ACPI_DESCRIPTION_HEADER *)(UINTN)Rsdp->RsdtAddress;
 265   if (Signature == EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE) {
 266     ASSERT (PreviousTable == NULL);
 267     //
 268     // It is to locate DSDT,
 269     // need to locate FADT first.
 270     //
 271     Fadt = (EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE *)ScanTableInSDT (
 272                                                           Rsdt,
 273                                                           sizeof (UINT32),
 274                                                           EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE,
 275                                                           NULL,
 276                                                           NULL
 277                                                           );
 278     Table = LocateAcpiDsdtFromFadt (Fadt);
 279   } else if (Signature == EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE) {
 280     ASSERT (PreviousTable == NULL);
 281     //
 282     // It is to locate FACS,
 283     // need to locate FADT first.
 284     //
 285     Fadt = (EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE *)ScanTableInSDT (
 286                                                           Rsdt,
 287                                                           sizeof (UINT32),
 288                                                           EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE,
 289                                                           NULL,
 290                                                           NULL
 291                                                           );
 292     Table = LocateAcpiFacsFromFadt (Fadt);
 293   } else {
 294     Table = ScanTableInSDT (
 295               Rsdt,
 296               sizeof (UINT32),
 297               Signature,
 298               PreviousTable,
 299               PreviousTableLocated
 300               );
 301   }
 302
 303   return Table;
 304 }
 305
 306 /**
 307   This function locates next ACPI table in XSDT/RSDT based on Signature and
 308   previous returned Table.
 309
 310   If PreviousTable is NULL:
 311   This function will locate the first ACPI table in XSDT/RSDT based on
 312   Signature in gEfiAcpi20TableGuid system configuration table first, and then
 313   gEfiAcpi10TableGuid system configuration table.
 314   This function will locate in XSDT first, and then RSDT.
 315   For DSDT, this function will locate XDsdt in FADT first, and then Dsdt in
 316   FADT.
 317   For FACS, this function will locate XFirmwareCtrl in FADT first, and then
 318   FirmwareCtrl in FADT.
 319
 320   If PreviousTable is not NULL:
 321   1. If it could be located in XSDT in gEfiAcpi20TableGuid system configuration
 322      table, then this function will just locate next table in XSDT in
 323      gEfiAcpi20TableGuid system configuration table.
 324   2. If it could be located in RSDT in gEfiAcpi20TableGuid system configuration
 325      table, then this function will just locate next table in RSDT in
 326      gEfiAcpi20TableGuid system configuration table.
 327   3. If it could be located in RSDT in gEfiAcpi10TableGuid system configuration
 328      table, then this function will just locate next table in RSDT in
 329      gEfiAcpi10TableGuid system configuration table.
 330
 331   It's not supported that PreviousTable is not NULL but PreviousTable->Signature
 332   is not same with Signature, NULL will be returned.
 333
 334   @param Signature          ACPI table signature.
 335   @param PreviousTable      Pointer to previous returned table to locate next
 336                             table, or NULL to locate first table.
 337
 338   @return Next ACPI table or NULL if not found.
 339
 340 **/
 341 EFI_ACPI_COMMON_HEADER *
 342 EFIAPI
 343 EfiLocateNextAcpiTable (
 344   IN UINT32                  Signature,
 345   IN EFI_ACPI_COMMON_HEADER  *PreviousTable OPTIONAL
 346   )
 347 {
 348   EFI_ACPI_COMMON_HEADER  *Table;
 349   BOOLEAN                 TempPreviousTableLocated;
 350   BOOLEAN                 *PreviousTableLocated;
 351
 352   if (PreviousTable != NULL) {
 353     if (PreviousTable->Signature != Signature) {
 354       //
 355       // PreviousTable->Signature is not same with Signature.
 356       //
 357       return NULL;
 358     } else if ((Signature == EFI_ACPI_2_0_FIXED_ACPI_DESCRIPTION_TABLE_SIGNATURE) ||
 359                (Signature == EFI_ACPI_2_0_DIFFERENTIATED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE) ||
 360                (Signature == EFI_ACPI_2_0_FIRMWARE_ACPI_CONTROL_STRUCTURE_SIGNATURE))
 361     {
 362       //
 363       // There is only one FADT/DSDT/FACS table,
 364       // so don't try to locate next one.
 365       //
 366       return NULL;
 367     }
 368
 369     PreviousTableLocated  = &TempPreviousTableLocated;
 370     *PreviousTableLocated = FALSE;
 371   } else {
 372     PreviousTableLocated = NULL;
 373   }
 374
 375   Table = LocateAcpiTableInAcpiConfigurationTable (
 376             &gEfiAcpi20TableGuid,
 377             Signature,
 378             PreviousTable,
 379             PreviousTableLocated
 380             );
 381   if (Table != NULL) {
 382     return Table;
 383   } else if ((PreviousTableLocated != NULL) &&
 384              *PreviousTableLocated)
 385   {
 386     //
 387     // PreviousTable could be located in gEfiAcpi20TableGuid system
 388     // configuration table, but next table could not be located in
 389     // gEfiAcpi20TableGuid system configuration table.
 390     //
 391     return NULL;
 392   }
 393
 394   return LocateAcpiTableInAcpiConfigurationTable (
 395            &gEfiAcpi10TableGuid,
 396            Signature,
 397            PreviousTable,
 398            PreviousTableLocated
 399            );
 400 }
 401
 402 /**
 403   This function locates first ACPI table in XSDT/RSDT based on Signature.
 404
 405   This function will locate the first ACPI table in XSDT/RSDT based on
 406   Signature in gEfiAcpi20TableGuid system configuration table first, and then
 407   gEfiAcpi10TableGuid system configuration table.
 408   This function will locate in XSDT first, and then RSDT.
 409   For DSDT, this function will locate XDsdt in FADT first, and then Dsdt in
 410   FADT.
 411   For FACS, this function will locate XFirmwareCtrl in FADT first, and then
 412   FirmwareCtrl in FADT.
 413
 414   @param Signature          ACPI table signature.
 415
 416   @return First ACPI table or NULL if not found.
 417
 418 **/
 419 EFI_ACPI_COMMON_HEADER *
 420 EFIAPI
 421 EfiLocateFirstAcpiTable (
 422   IN UINT32  Signature
 423   )
 424 {
 425   return EfiLocateNextAcpiTable (Signature, NULL);
 426 }