PcAtChipsetPkg/PcRtc: Fix a Y2K bug
[mirror_edk2.git] / 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 - 2015, Intel Corporation. All rights reserved.<BR>
8 #
9 # This program and the accompanying materials
10 # are licensed and made available under the terms and conditions of the BSD License
11 # which accompanies this distribution. The full text of the license may be found at
12 # http://opensource.org/licenses/bsd-license.php
13 #
14 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #
17 ##
18
19 [Defines]
20 DEC_SPECIFICATION = 0x00010005
21 PACKAGE_NAME = PcAtChipsetPkg
22 PACKAGE_UNI_FILE = PcAtChipsetPkg.uni
23 PACKAGE_GUID = B728689A-52D3-4b8c-AE89-2CE5514CC6DC
24 PACKAGE_VERSION = 0.3
25
26 [Includes]
27 Include
28
29 [LibraryClasses]
30 ## @libraryclass Provides functions to manage I/O APIC Redirection Table Entries.
31 #
32 IoApicLib|Include/Library/IoApicLib.h
33
34 [Guids]
35 gPcAtChipsetPkgTokenSpaceGuid = { 0x326ae723, 0xae32, 0x4589, { 0x98, 0xb8, 0xca, 0xc2, 0x3c, 0xdc, 0xc1, 0xb1 } }
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 ## Pcd8259LegacyModeMask defines the default mask value for platform. This value is determined<BR><BR>
46 # 1) If platform only support pure UEFI, value should be set to 0xFFFF or 0xFFFE;
47 # Because only clock interrupt is allowed in legacy mode in pure UEFI platform.<BR>
48 # 2) If platform install CSM and use thunk module:<BR>
49 # a) If thunk call provided by CSM binary requires some legacy interrupt support, the corresponding bit
50 # should be opened as 0.<BR>
51 # For example, if keyboard interfaces provided CSM binary use legacy keyboard interrupt in 8259 bit 1, then
52 # the value should be set to 0xFFFC.<BR>
53 # b) If all thunk call provied by CSM binary do not require legacy interrupt support, value should be set
54 # to 0xFFFF or 0xFFFE.<BR>
55 #
56 # The default value of legacy mode mask could be changed by EFI_LEGACY_8259_PROTOCOL->SetMask(). But it is rarely
57 # need change it except some special cases such as when initializing the CSM binary, it should be set to 0xFFFF to
58 # mask all legacy interrupt. Please restore the original legacy mask value if changing is made for these special case.<BR>
59 # @Prompt 8259 Legacy Mode mask.
60 gPcAtChipsetPkgTokenSpaceGuid.Pcd8259LegacyModeMask|0xFFFF|UINT16|0x00000001
61
62 ## Pcd8259LegacyModeEdgeLevel defines the default edge level for legacy mode's interrrupt controller.
63 # For the corresponding bits, 0 = Edge triggered and 1 = Level triggered.
64 # @Prompt 8259 Legacy Mode edge level.
65 gPcAtChipsetPkgTokenSpaceGuid.Pcd8259LegacyModeEdgeLevel|0x0000|UINT16|0x00000002
66
67 ## Indicates if we need enable IsaAcpiCom1 device.<BR><BR>
68 # TRUE - Enables IsaAcpiCom1 device.<BR>
69 # FALSE - Doesn't enable IsaAcpiCom1 device.<BR>
70 # @Prompt Enable IsaAcpiCom1 device.
71 gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiCom1Enable|TRUE|BOOLEAN|0x00000003
72
73 ## Indicates if we need enable IsaAcpiCom2 device.<BR><BR>
74 # TRUE - Enables IsaAcpiCom2 device.<BR>
75 # FALSE - Doesn't enable IsaAcpiCom2 device.<BR>
76 # @Prompt Enable IsaAcpiCom12 device.
77 gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiCom2Enable|TRUE|BOOLEAN|0x00000004
78
79 ## Indicates if we need enable IsaAcpiPs2Keyboard device.<BR><BR>
80 # TRUE - Enables IsaAcpiPs2Keyboard device.<BR>
81 # FALSE - Doesn't enable IsaAcpiPs2Keyboard device.<BR>
82 # @Prompt Enable IsaAcpiPs2Keyboard device.
83 gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiPs2KeyboardEnable|TRUE|BOOLEAN|0x00000005
84
85 ## Indicates if we need enable IsaAcpiPs2Mouse device.<BR><BR>
86 # TRUE - Enables IsaAcpiPs2Mouse device.<BR>
87 # FALSE - Doesn't enable IsaAcpiPs2Mouse device.<BR>
88 # @Prompt Enable IsaAcpiPs2Mouse device.
89 gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiPs2MouseEnable|TRUE|BOOLEAN|0x00000006
90
91 ## Indicates if we need enable IsaAcpiFloppyA device.<BR><BR>
92 # TRUE - Enables IsaAcpiFloppyA device.<BR>
93 # FALSE - Doesn't enable IsaAcpiFloppyA device.<BR>
94 # @Prompt Enable IsaAcpiFloppyA device.
95 gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiFloppyAEnable|TRUE|BOOLEAN|0x00000007
96
97 ## Indicates if we need enable IsaAcpiFloppyB device.<BR><BR>
98 # TRUE - Enables IsaAcpiFloppyB device.<BR>
99 # FALSE - Doesn't enable IsaAcpiFloppyB device.<BR>
100 # @Prompt Enable IsaAcpiFloppyB device.
101 gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiFloppyBEnable|TRUE|BOOLEAN|0x00000008
102
103 ## This PCD specifies the base address of the HPET timer.
104 # @Prompt HPET base address.
105 gPcAtChipsetPkgTokenSpaceGuid.PcdHpetBaseAddress|0xFED00000|UINT32|0x00000009
106
107 ## This PCD specifies the Local APIC Interrupt Vector for the HPET Timer.
108 # @Prompt HPET local APIC vector.
109 gPcAtChipsetPkgTokenSpaceGuid.PcdHpetLocalApicVector|0x40|UINT8|0x0000000A
110
111 ## This PCD specifies the defaut period of the HPET Timer in 100 ns units.
112 # The default value of 100000 100 ns units is the same as 10 ms.
113 # @Prompt Default period of HPET timer.
114 gPcAtChipsetPkgTokenSpaceGuid.PcdHpetDefaultTimerPeriod|100000|UINT64|0x0000000B
115
116 ## This PCD specifies the base address of the IO APIC.
117 # @Prompt IO APIC base address.
118 gPcAtChipsetPkgTokenSpaceGuid.PcdIoApicBaseAddress|0xFEC00000|UINT32|0x0000000C
119
120 ## This PCD specifies the minimal valid year in RTC.
121 # @Prompt Minimal valid year in RTC.
122 gPcAtChipsetPkgTokenSpaceGuid.PcdMinimalValidYear|1998|UINT16|0x0000000D
123
124 ## This PCD specifies the maximal valid year in RTC.
125 # @Prompt Maximal valid year in RTC.
126 # @Expression gPcAtChipsetPkgTokenSpaceGuid.PcdMaximalValidYear < gPcAtChipsetPkgTokenSpaceGuid.PcdMinimalValidYear + 100
127 gPcAtChipsetPkgTokenSpaceGuid.PcdMaximalValidYear|2097|UINT16|0x0000000E
128
129 [PcdsFixedAtBuild, PcdsPatchableInModule]
130 ## Defines the ACPI register set base address.
131 # The invalid 0xFFFF is as its default value. It must be configured to the real value.
132 # @Prompt ACPI Timer IO Port Address
133 gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoPortBaseAddress |0xFFFF|UINT16|0x00000010
134
135 ## Defines the PCI Bus Number of the PCI device that contains the BAR and Enable for ACPI hardware registers.
136 # @Prompt ACPI Hardware PCI Bus Number
137 gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoPciBusNumber | 0x00| UINT8|0x00000011
138
139 ## Defines the PCI Device Number of the PCI device that contains the BAR and Enable for ACPI hardware registers.
140 # The invalid 0xFF is as its default value. It must be configured to the real value.
141 # @Prompt ACPI Hardware PCI Device Number
142 gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoPciDeviceNumber | 0xFF| UINT8|0x00000012
143
144 ## Defines the PCI Function Number of the PCI device that contains the BAR and Enable for ACPI hardware registers.
145 # The invalid 0xFF is as its default value. It must be configured to the real value.
146 # @Prompt ACPI Hardware PCI Function Number
147 gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoPciFunctionNumber | 0xFF| UINT8|0x00000013
148
149 ## Defines the PCI Register Offset of the PCI device that contains the Enable for ACPI hardware registers.
150 # The invalid 0xFFFF is as its default value. It must be configured to the real value.
151 # @Prompt ACPI Hardware PCI Register Offset
152 gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoPciEnableRegisterOffset |0xFFFF|UINT16|0x00000014
153
154 ## Defines the bit mask that must be set to enable the APIC hardware register BAR.
155 # @Prompt ACPI Hardware PCI Bar Enable BitMask
156 gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoBarEnableMask | 0x00| UINT8|0x00000015
157
158 ## Defines the PCI Register Offset of the PCI device that contains the BAR for ACPI hardware registers.
159 # The invalid 0xFFFF is as its default value. It must be configured to the real value.
160 # @Prompt ACPI Hardware PCI Bar Register Offset
161 gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoPciBarRegisterOffset |0xFFFF|UINT16|0x00000016
162
163 ## Defines the offset to the 32-bit Timer Value register that resides within the ACPI BAR.
164 # @Prompt Offset to 32-bit Timer register in ACPI BAR
165 gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiPm1TmrOffset |0x0008|UINT16|0x00000017
166
167 ## Defines the bit mask to retrieve ACPI IO Port Base Address
168 # @Prompt ACPI IO Port Base Address Mask
169 gPcAtChipsetPkgTokenSpaceGuid.PcdAcpiIoPortBaseAddressMask |0xFFFE|UINT16|0x00000018
170
171 [UserExtensions.TianoCore."ExtraFiles"]
172 PcAtChipsetPkgExtra.uni