PcAtChipsetPkg/PcAtChipsetPkg.dec

   1 ## @file
   2 # Public definitions for PcAtChipset package.
   3 #
   4 # This package is designed to public interfaces and implementation which follows
   5 # PcAt defacto standard.
   6 #
   7 # Copyright (c) 2009 - 2019, Intel Corporation. All rights reserved.<BR>
   8 # Copyright (c) 2017, AMD Inc. All rights reserved.<BR>
   9 #
  10 # SPDX-License-Identifier: BSD-2-Clause-Patent
  11 #
  12 ##
  13
  14 [Defines]
  15   DEC_SPECIFICATION              = 0x00010005
  16   PACKAGE_NAME                   = PcAtChipsetPkg
  17   PACKAGE_UNI_FILE               = PcAtChipsetPkg.uni
  18   PACKAGE_GUID                   = B728689A-52D3-4b8c-AE89-2CE5514CC6DC
  19   PACKAGE_VERSION                = 0.3
  20
  21 [Includes]
  22   Include
  23
  24 [LibraryClasses]
  25   ##  @libraryclass  Provides functions to manage I/O APIC Redirection Table Entries.
  26   #
  27   IoApicLib|Include/Library/IoApicLib.h
  28
  29 [Guids]
  30   gPcAtChipsetPkgTokenSpaceGuid = { 0x326ae723, 0xae32, 0x4589, { 0x98, 0xb8, 0xca, 0xc2, 0x3c, 0xdc, 0xc1, 0xb1 } }
  31
  32 #
  33 # [Error.gPcAtChipsetPkgTokenSpaceGuid]
  34 #   0x80000001 | Invalid value provided.
  35 #
  36
  37 [PcdsFeatureFlag]
  38   ## Indicates the HPET Timer will be configured to use MSI interrupts if the HPET timer supports them, or use I/O APIC interrupts.<BR><BR>
  39   #   TRUE  - Configures the HPET Timer to use MSI interrupts if the HPET Timer supports them.<BR>
  40   #   FALSE - Configures the HPET Timer to use I/O APIC interrupts.<BR>
  41   # @Prompt Configure HPET to use MSI.
  42   gPcAtChipsetPkgTokenSpaceGuid.PcdHpetMsiEnable|TRUE|BOOLEAN|0x00001000
  43
  44 [PcdsFixedAtBuild, PcdsDynamic, PcdsDynamicEx, PcdsPatchableInModule]
  45   ## This PCD specifies the base address of the HPET timer.
  46   # @Prompt HPET base address.
  47   gPcAtChipsetPkgTokenSpaceGuid.PcdHpetBaseAddress|0xFED00000|UINT32|0x00000009
  48
  49   ## This PCD specifies the Local APIC Interrupt Vector for the HPET Timer.
  50   # @Prompt HPET local APIC vector.
  51   gPcAtChipsetPkgTokenSpaceGuid.PcdHpetLocalApicVector|0x40|UINT8|0x0000000A
  52
  53   ## This PCD specifies the defaut period of the HPET Timer in 100 ns units.
  54   #  The default value of 100000 100 ns units is the same as 10 ms.
  55   # @Prompt Default period of HPET timer.
  56   gPcAtChipsetPkgTokenSpaceGuid.PcdHpetDefaultTimerPeriod|100000|UINT64|0x0000000B
  57
  58   ## This PCD specifies the base address of the IO APIC.
  59   # @Prompt IO APIC base address.
  60   gPcAtChipsetPkgTokenSpaceGuid.PcdIoApicBaseAddress|0xFEC00000|UINT32|0x0000000C
  61
  62   ## This PCD specifies the minimal valid year in RTC.
  63   # @Prompt Minimal valid year in RTC.
  64   gPcAtChipsetPkgTokenSpaceGuid.PcdMinimalValidYear|1998|UINT16|0x0000000D
  65
  66   ## This PCD specifies the maximal valid year in RTC.
  67   # @Prompt Maximal valid year in RTC.
  68   # @Expression 0x80000001 | gPcAtChipsetPkgTokenSpaceGuid.PcdMaximalValidYear < gPcAtChipsetPkgTokenSpaceGuid.PcdMinimalValidYear + 100
  69   gPcAtChipsetPkgTokenSpaceGuid.PcdMaximalValidYear|2097|UINT16|0x0000000E
  70
  71 [PcdsFixedAtBuild, PcdsPatchableInModule]
  72   ## Defines the ACPI register set base address.
  73   #  The invalid 0xFFFF is as its default value. It must be configured to the real value.
  74   # @Prompt ACPI Timer IO Port Address
  75   gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoPortBaseAddress         |0xFFFF|UINT16|0x00000010
  76
  77   ## Defines the PCI Bus Number of the PCI device that contains the BAR and Enable for ACPI hardware registers.
  78   # @Prompt ACPI Hardware PCI Bus Number
  79   gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoPciBusNumber            |  0x00| UINT8|0x00000011
  80
  81   ## Defines the PCI Device Number of the PCI device that contains the BAR and Enable for ACPI hardware registers.
  82   #  The invalid 0xFF is as its default value. It must be configured to the real value.
  83   # @Prompt ACPI Hardware PCI Device Number
  84   gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoPciDeviceNumber         |  0xFF| UINT8|0x00000012
  85
  86   ## Defines the PCI Function Number of the PCI device that contains the BAR and Enable for ACPI hardware registers.
  87   #  The invalid 0xFF is as its default value. It must be configured to the real value.
  88   # @Prompt ACPI Hardware PCI Function Number
  89   gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoPciFunctionNumber       |  0xFF| UINT8|0x00000013
  90
  91   ## Defines the PCI Register Offset of the PCI device that contains the Enable for ACPI hardware registers.
  92   #  The invalid 0xFFFF is as its default value. It must be configured to the real value.
  93   # @Prompt ACPI Hardware PCI Register Offset
  94   gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoPciEnableRegisterOffset |0xFFFF|UINT16|0x00000014
  95
  96   ## Defines the bit mask that must be set to enable the APIC hardware register BAR.
  97   # @Prompt ACPI Hardware PCI Bar Enable BitMask
  98   gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoBarEnableMask           |  0x00| UINT8|0x00000015
  99
 100   ## Defines the PCI Register Offset of the PCI device that contains the BAR for ACPI hardware registers.
 101   #  The invalid 0xFFFF is as its default value. It must be configured to the real value.
 102   # @Prompt ACPI Hardware PCI Bar Register Offset
 103   gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoPciBarRegisterOffset    |0xFFFF|UINT16|0x00000016
 104
 105   ## Defines the offset to the 32-bit Timer Value register that resides within the ACPI BAR.
 106   # @Prompt Offset to 32-bit Timer register in ACPI BAR
 107   gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiPm1TmrOffset              |0x0008|UINT16|0x00000017
 108
 109   ## Defines the bit mask to retrieve ACPI IO Port Base Address
 110   # @Prompt ACPI IO Port Base Address Mask
 111   gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoPortBaseAddressMask     |0xFFFE|UINT16|0x00000018
 112
 113   ## Reset Control Register address in I/O space.
 114   # @Prompt Reset Control Register address
 115   gPcAtChipsetPkgTokenSpaceGuid.PcdResetControlRegister|0x64|UINT64|0x00000019
 116
 117   ## 8bit Reset Control Register value for cold reset.
 118   # @Prompt Reset Control Register value for cold reset
 119   gPcAtChipsetPkgTokenSpaceGuid.PcdResetControlValueColdReset|0xFE|UINT8|0x0000001A
 120
 121   ## Specifies the initial value for Register_A in RTC.
 122   # @Prompt Initial value for Register_A in RTC.
 123   gPcAtChipsetPkgTokenSpaceGuid.PcdInitialValueRtcRegisterA|0x26|UINT8|0x0000001B
 124
 125   ## Specifies the initial value for Register_B in RTC.
 126   # @Prompt Initial value for Register_B in RTC.
 127   gPcAtChipsetPkgTokenSpaceGuid.PcdInitialValueRtcRegisterB|0x02|UINT8|0x0000001C
 128
 129   ## Specifies the initial value for Register_D in RTC.
 130   # @Prompt Initial value for Register_D in RTC.
 131   gPcAtChipsetPkgTokenSpaceGuid.PcdInitialValueRtcRegisterD|0x00|UINT8|0x0000001D
 132
 133   ## Specifies RTC Index Register address in I/O space.
 134   # @Prompt RTC Index Register address
 135   gPcAtChipsetPkgTokenSpaceGuid.PcdRtcIndexRegister|0x70|UINT8|0x0000001E
 136
 137   ## Specifies RTC Target Register address in I/O space.
 138   # @Prompt RTC Target Register address
 139   gPcAtChipsetPkgTokenSpaceGuid.PcdRtcTargetRegister|0x71|UINT8|0x0000001F
 140
 141   ## RTC Update Timeout Value(microsecond).
 142   # @Prompt RTC Update Timeout Value.
 143   gPcAtChipsetPkgTokenSpaceGuid.PcdRealTimeClockUpdateTimeout|100000|UINT32|0x00000020
 144
 145 [UserExtensions.TianoCore."ExtraFiles"]
 146   PcAtChipsetPkgExtra.uni