PcAtChipsetPkg: INF/DEC file updates to EDK II packages

1. Usage information in INF file comment blocks are either incomplete or incorrect.  
This includes usage information for Protocols/PPIs/GUIDs/PCDs/HOBs/Events/BootModes.  
The syntax for usage information in comment blocks is defined in the EDK II Module Information (INF) Specification

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Qiu, Shumin <shumin.qiu@intel.com>
Reviewed-by: Gao, Liming <liming.gao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15942 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Qiu, Shumin 2014-08-28 05:17:22 +00:00 committed by lgao4
parent d4bf50f999
commit 546f14bf7a
11 changed files with 94 additions and 61 deletions

View File

@ -1,6 +1,7 @@
## @file
#
# Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>
# 8254 timer driver that provides Timer Arch protocol.
#
# Copyright (c) 2005 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
@ -14,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = Timer
MODULE_UNI_FILE = Timer.uni
FILE_GUID = f2765dec-6b41-11d5-8e71-00902707b35e
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
@ -36,9 +38,11 @@
Timer.c
[Protocols]
gEfiCpuArchProtocolGuid
gEfiLegacy8259ProtocolGuid
gEfiTimerArchProtocolGuid
gEfiCpuArchProtocolGuid ## CONSUMES
gEfiLegacy8259ProtocolGuid ## CONSUMES
gEfiTimerArchProtocolGuid ## PRODUCES
[Depex]
gEfiCpuArchProtocolGuid AND gEfiLegacy8259ProtocolGuid
gEfiCpuArchProtocolGuid AND gEfiLegacy8259ProtocolGuid
[UserExtensions.TianoCore."ExtraFiles"]
TimerExtra.uni

View File

@ -1,7 +1,7 @@
## @file
# 8259 Interrupt Controller driver
# 8259 Interrupt Controller driver that provides Legacy 8259 protocol.
#
# Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2005 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
@ -15,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = Legacy8259
MODULE_UNI_FILE = Legacy8259.uni
FILE_GUID = 79CA4208-BBA1-4a9a-8456-E1E66A81484E
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
@ -38,12 +39,14 @@
[Protocols]
gEfiLegacy8259ProtocolGuid # PROTOCOL ALWAYS_PRODUCED
gEfiPciIoProtocolGuid
gEfiPciIoProtocolGuid ## SOMETIMES_CONSUMES
[Pcd]
gPcAtChipsetPkgTokenSpaceGuid.Pcd8259LegacyModeMask
gPcAtChipsetPkgTokenSpaceGuid.Pcd8259LegacyModeEdgeLevel
gPcAtChipsetPkgTokenSpaceGuid.Pcd8259LegacyModeMask ## CONSUMES
gPcAtChipsetPkgTokenSpaceGuid.Pcd8259LegacyModeEdgeLevel ## CONSUMES
[Depex]
TRUE
[UserExtensions.TianoCore."ExtraFiles"]
Legacy8259Extra.uni

View File

@ -2,20 +2,21 @@
#
# Component description file for the IDE Controller Init module.
#
# Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
# http://opensource.org/licenses/bsd-license.php
#
#
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#
#
##
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = IdeController
MODULE_UNI_FILE = IdeController.uni
FILE_GUID = 99549F44-49BB-4820-B9D2-901329412D67
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@ -45,5 +46,7 @@
UefiBootServicesTableLib
[Protocols]
gEfiPciIoProtocolGuid
gEfiIdeControllerInitProtocolGuid
gEfiPciIoProtocolGuid ## BY_START
gEfiIdeControllerInitProtocolGuid ## TO_START
[UserExtensions.TianoCore."ExtraFiles"]
IdeControllerExtra.uni

View File

@ -1,6 +1,7 @@
## @file
#
# Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
# Timer Architectural Protocol module using High Precesion Event Timer (HPET).
#
# Copyright (c) 2011 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
@ -14,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = HpetTimerDxe
MODULE_UNI_FILE = HpetTimerDxe.uni
FILE_GUID = 6CE6B0DE-781C-4f6c-B42D-98346C614BEC
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
@ -49,12 +51,14 @@
gEfiCpuArchProtocolGuid # PROTOCOL ALWAYS_CONSUMED
[FeaturePcd]
gPcAtChipsetPkgTokenSpaceGuid.PcdHpetMsiEnable
gPcAtChipsetPkgTokenSpaceGuid.PcdHpetMsiEnable ## CONSUMES
[Pcd]
gPcAtChipsetPkgTokenSpaceGuid.PcdHpetBaseAddress
gPcAtChipsetPkgTokenSpaceGuid.PcdHpetLocalApicVector
gPcAtChipsetPkgTokenSpaceGuid.PcdHpetDefaultTimerPeriod
gPcAtChipsetPkgTokenSpaceGuid.PcdHpetBaseAddress ## CONSUMES
gPcAtChipsetPkgTokenSpaceGuid.PcdHpetLocalApicVector ## CONSUMES
gPcAtChipsetPkgTokenSpaceGuid.PcdHpetDefaultTimerPeriod ## CONSUMES
[Depex]
gEfiCpuArchProtocolGuid
[UserExtensions.TianoCore."ExtraFiles"]
HpetTimerDxeExtra.uni

View File

@ -1,14 +1,14 @@
## @file
# Component description file for PCAT ISA ACPI driver
#
# Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
# http://opensource.org/licenses/bsd-license.php
#
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
# Copyright (c) 2005 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
# http://opensource.org/licenses/bsd-license.php
#
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#
#
##
@ -16,6 +16,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = IsaAcpi
MODULE_UNI_FILE = IsaAcpi.uni
FILE_GUID = 38A0EC22-FBE7-4911-8BC1-176E0D6C1DBD
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@ -33,7 +34,7 @@
UefiLib
BaseMemoryLib
PcdLib
[Sources]
PcatIsaAcpi.h
PcatIsaAcpi.c
@ -41,13 +42,15 @@
ComponentName.c
[Protocols]
gEfiPciIoProtocolGuid
gEfiIsaAcpiProtocolGuid
gEfiPciIoProtocolGuid ## TO_START
gEfiIsaAcpiProtocolGuid ## BY_START
[Pcd]
gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiCom1Enable
gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiCom2Enable
gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiPs2KeyboardEnable
gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiPs2MouseEnable
gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiFloppyAEnable
gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiFloppyBEnable
gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiCom1Enable ## SOMETIMES_CONSUMES
gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiCom2Enable ## SOMETIMES_CONSUMES
gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiPs2KeyboardEnable ## SOMETIMES_CONSUMES
gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiPs2MouseEnable ## SOMETIMES_CONSUMES
gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiFloppyAEnable ## SOMETIMES_CONSUMES
gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiFloppyBEnable ## SOMETIMES_CONSUMES
[UserExtensions.TianoCore."ExtraFiles"]
IsaAcpiExtra.uni

View File

@ -1,6 +1,9 @@
## @file
#
# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
# This driver implements Reset Architectural Protocol.
#
# It should depend on the ResetSystemLib instance that is implemented based on KBC.
#
# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
@ -18,6 +21,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = KbcReset
MODULE_UNI_FILE = KbcReset.uni
FILE_GUID = 6F0198AA-1F1D-426D-AE3E-39AB633FCC28
MODULE_TYPE = DXE_RUNTIME_DRIVER
VERSION_STRING = 1.0
@ -37,7 +41,10 @@
ResetEntry.c
[Protocols]
gEfiResetArchProtocolGuid
gEfiResetArchProtocolGuid ## PRODUCES
[Depex]
TRUE
[UserExtensions.TianoCore."ExtraFiles"]
KbcResetExtra.uni

View File

@ -1,7 +1,7 @@
## @file
# Library instance for I/O APIC library class
# Library instance for I/O APIC library class
#
# Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2011 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
@ -15,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = BaseIoApicLib
MODULE_UNI_FILE = BaseIoApicLib.uni
FILE_GUID = 58ED6E5A-E36A-462a-9ED6-6E62C9A26DF8
MODULE_TYPE = BASE
VERSION_STRING = 1.0
@ -35,4 +36,5 @@
IoApicLib.c
[Pcd]
gPcAtChipsetPkgTokenSpaceGuid.PcdIoApicBaseAddress
gPcAtChipsetPkgTokenSpaceGuid.PcdIoApicBaseAddress ## CONSUMES

View File

@ -1,7 +1,7 @@
## @file
# Library instance for ResetSystem library class fort PCAT systems
# Library instance for ResetSystem library class for PCAT systems
#
# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
@ -15,10 +15,11 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = ResetSystemLib
MODULE_UNI_FILE = ResetSystemLib.uni
FILE_GUID = EC4F3E59-F879-418b-9E4C-7D6F434714A0
MODULE_TYPE = BASE
VERSION_STRING = 1.0
LIBRARY_CLASS = ResetSystemLib
LIBRARY_CLASS = ResetSystemLib
#
# The following information is for reference only and not required by the build tools.

View File

@ -1,7 +1,7 @@
## @file
# Library instance for SerialIo library class
#
# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
@ -15,6 +15,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = PcAtSerialPortLib
MODULE_UNI_FILE = PcAtSerialPortLib.uni
FILE_GUID = 1B25AF84-1EA8-4b52-894E-BFA6880B97FF
MODULE_TYPE = BASE
VERSION_STRING = 1.0

View File

@ -5,7 +5,7 @@
# This driver provides GetTime, SetTime, GetWakeupTime, SetWakeupTime services to Runtime Service Table.
# It will install a tagging protocol with gEfiRealTimeClockArchProtocolGuid.
#
# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
@ -19,6 +19,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = PcRtc
MODULE_UNI_FILE = PcRtc.uni
FILE_GUID = 378D7B65-8DA9-4773-B6E4-A47826A833E1
MODULE_TYPE = DXE_RUNTIME_DRIVER
VERSION_STRING = 1.0
@ -60,4 +61,6 @@
gEfiVariableArchProtocolGuid AND gEfiVariableWriteArchProtocolGuid
[Pcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdRealTimeClockUpdateTimeout ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdRealTimeClockUpdateTimeout ## CONSUMES
[UserExtensions.TianoCore."ExtraFiles"]
PcRtcExtra.uni

View File

@ -1,21 +1,21 @@
## @file
# The basic interfaces implementation to a single segment PCI Host Bridge driver.
#
# Component description file a sinngle segment PCI Host Bridge driver.
#
# Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
# http://opensource.org/licenses/bsd-license.php
#
#
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#
#
##
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = PciHostBridge
MODULE_UNI_FILE = PciHostBridge.uni
FILE_GUID = 2383608E-C6D0-4e3e-858D-45DFAC3543D5
MODULE_TYPE = DXE_DRIVER
VERSION_STRING = 1.0
@ -53,11 +53,13 @@
X64/IoFifo.S
[Protocols]
gEfiPciHostBridgeResourceAllocationProtocolGuid
gEfiPciRootBridgeIoProtocolGuid
gEfiMetronomeArchProtocolGuid
gEfiDevicePathProtocolGuid
gEfiPciHostBridgeResourceAllocationProtocolGuid ## PRODUCES
gEfiPciRootBridgeIoProtocolGuid ## PRODUCES
gEfiMetronomeArchProtocolGuid ## CONSUMES
gEfiDevicePathProtocolGuid ## PRODUCES
[depex]
gEfiMetronomeArchProtocolGuid
[UserExtensions.TianoCore."ExtraFiles"]
PciHostBridgeExtra.uni