[mirror_edk2.git] / PcAtChipsetPkg / PcAtChipsetPkg.dec

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