MdePkg: Apply uncrustify changes

[mirror_edk2.git] / MdePkg / Include / IndustryStandard / LowPowerIdleTable.h

/** @file\r
  ACPI Low Power Idle Table (LPIT) definitions\r
\r
  Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
    - ACPI Low Power Idle Table (LPIT) Revision 001, dated July 2014\r
      http://www.uefi.org/sites/default/files/resources/ACPI_Low_Power_Idle_Table.pdf\r
\r
  @par Glossary:\r
    - GAS - Generic Address Structure\r
    - LPI - Low Power Idle\r
**/\r
\r
#ifndef _LOW_POWER_IDLE_TABLE_H_\r
#define _LOW_POWER_IDLE_TABLE_H_\r
\r
#include <IndustryStandard/Acpi.h>\r
\r
#pragma pack(1)\r
\r
///\r
/// LPI Structure Types\r
///\r
#define ACPI_LPI_STRUCTURE_TYPE_NATIVE_CSTATE  0x00\r
\r
///\r
/// Low Power Idle (LPI) State Flags\r
///\r
typedef union {\r
  struct {\r
    UINT32    Disabled           : 1; ///< If set, LPI state is not used\r
\r
    /**\r
      If set, Residency counter is not available for this LPI state and\r
      Residency Counter Frequency is invalid\r
    **/\r
    UINT32    CounterUnavailable : 1;\r
    UINT32    Reserved           : 30; ///< Reserved for future use. Must be zero\r
  } Bits;\r
  UINT32    Data32;\r
} ACPI_LPI_STATE_FLAGS;\r
\r
///\r
/// Low Power Idle (LPI) structure with Native C-state instruction entry trigger descriptor\r
///\r
typedef struct {\r
  UINT32                                    Type;   ///< LPI State descriptor Type 0\r
  UINT32                                    Length; ///< Length of LPI state Descriptor Structure\r
  ///\r
  /// Unique LPI state identifier: zero based, monotonically increasing identifier\r
  ///\r
  UINT16                                    UniqueId;\r
  UINT8                                     Reserved[2]; ///< Must be Zero\r
  ACPI_LPI_STATE_FLAGS                      Flags;       ///< LPI state flags\r
\r
  /**\r
    The LPI entry trigger, matching an existing _CST.Register object, represented as a\r
    Generic Address Structure. All processors must request this state or deeper to trigger.\r
  **/\r
  EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE    EntryTrigger;\r
  UINT32                                    Residency; ///< Minimum residency or break-even in uSec\r
  UINT32                                    Latency;   ///< Worst case exit latency in uSec\r
\r
  /**\r
    [optional] Residency counter, represented as a Generic Address Structure.\r
    If not present, Flags[1] bit should be set.\r
  **/\r
  EFI_ACPI_6_1_GENERIC_ADDRESS_STRUCTURE    ResidencyCounter;\r
\r
  /**\r
    [optional] Residency counter frequency in cycles per second. Value 0 indicates that\r
    counter runs at TSC frequency. Valid only if Residency Counter is present.\r
  **/\r
  UINT64                                    ResidencyCounterFrequency;\r
} ACPI_LPI_NATIVE_CSTATE_DESCRIPTOR;\r
\r
#pragma pack()\r
\r
#endif\r