PcAtChipsetPkg: INF/DEC file updates to EDK II packages
authorQiu, Shumin <shumin.qiu@intel.com>
Thu, 28 Aug 2014 05:17:22 +0000 (05:17 +0000)
committerlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 28 Aug 2014 05:17:22 +0000 (05:17 +0000)
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

PcAtChipsetPkg/8254TimerDxe/8254Timer.inf
PcAtChipsetPkg/8259InterruptControllerDxe/8259.inf
PcAtChipsetPkg/Bus/Pci/IdeControllerDxe/IdeControllerDxe.inf
PcAtChipsetPkg/HpetTimerDxe/HpetTimerDxe.inf
PcAtChipsetPkg/IsaAcpiDxe/IsaAcpi.inf
PcAtChipsetPkg/KbcResetDxe/Reset.inf
PcAtChipsetPkg/Library/BaseIoApicLib/BaseIoApicLib.inf
PcAtChipsetPkg/Library/ResetSystemLib/ResetSystemLib.inf
PcAtChipsetPkg/Library/SerialIoLib/SerialIoLib.inf
PcAtChipsetPkg/PcatRealTimeClockRuntimeDxe/PcatRealTimeClockRuntimeDxe.inf
PcAtChipsetPkg/PciHostBridgeDxe/PciHostBridgeDxe.inf

index 140baaa..67493d1 100644 (file)
@@ -1,6 +1,7 @@
 ## @file\r
-# \r
-# Copyright (c) 2005 - 2010, Intel Corporation. All rights reserved.<BR>\r
+# 8254 timer driver that provides Timer Arch protocol.\r
+#\r
+# Copyright (c) 2005 - 2014, Intel Corporation. All rights reserved.<BR>\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
@@ -14,6 +15,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = Timer\r
+  MODULE_UNI_FILE                = Timer.uni\r
   FILE_GUID                      = f2765dec-6b41-11d5-8e71-00902707b35e\r
   MODULE_TYPE                    = DXE_DRIVER\r
   VERSION_STRING                 = 1.0\r
   Timer.c\r
 \r
 [Protocols]\r
-  gEfiCpuArchProtocolGuid\r
-  gEfiLegacy8259ProtocolGuid\r
-  gEfiTimerArchProtocolGuid\r
+  gEfiCpuArchProtocolGuid       ## CONSUMES \r
+  gEfiLegacy8259ProtocolGuid    ## CONSUMES\r
+  gEfiTimerArchProtocolGuid     ## PRODUCES\r
 \r
 [Depex]\r
-  gEfiCpuArchProtocolGuid AND gEfiLegacy8259ProtocolGuid
\ No newline at end of file
+  gEfiCpuArchProtocolGuid AND gEfiLegacy8259ProtocolGuid\r
+[UserExtensions.TianoCore."ExtraFiles"]\r
+  TimerExtra.uni\r
index 22aeeb3..2b4a06b 100644 (file)
@@ -1,7 +1,7 @@
 ## @file\r
-# 8259 Interrupt Controller driver\r
+# 8259 Interrupt Controller driver that provides Legacy 8259 protocol.\r
 #\r
-# Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2005 - 2014, Intel Corporation. All rights reserved.<BR>\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
@@ -15,6 +15,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = Legacy8259\r
+  MODULE_UNI_FILE                = Legacy8259.uni\r
   FILE_GUID                      = 79CA4208-BBA1-4a9a-8456-E1E66A81484E\r
   MODULE_TYPE                    = DXE_DRIVER\r
   VERSION_STRING                 = 1.0\r
   \r
 [Protocols]\r
   gEfiLegacy8259ProtocolGuid                    # PROTOCOL ALWAYS_PRODUCED\r
-  gEfiPciIoProtocolGuid\r
+  gEfiPciIoProtocolGuid                         ## SOMETIMES_CONSUMES\r
 \r
 [Pcd]\r
-  gPcAtChipsetPkgTokenSpaceGuid.Pcd8259LegacyModeMask\r
-  gPcAtChipsetPkgTokenSpaceGuid.Pcd8259LegacyModeEdgeLevel\r
+  gPcAtChipsetPkgTokenSpaceGuid.Pcd8259LegacyModeMask      ## CONSUMES\r
+  gPcAtChipsetPkgTokenSpaceGuid.Pcd8259LegacyModeEdgeLevel ## CONSUMES\r
   \r
 [Depex]\r
   TRUE\r
 \r
+[UserExtensions.TianoCore."ExtraFiles"]\r
+  Legacy8259Extra.uni\r
index 4b67356..30bfd97 100644 (file)
@@ -2,20 +2,21 @@
 #  \r
 #    Component description file for the IDE Controller Init module.\r
 #\r
-#  Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>\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
+#\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
 \r
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = IdeController\r
+  MODULE_UNI_FILE                = IdeController.uni\r
   FILE_GUID                      = 99549F44-49BB-4820-B9D2-901329412D67\r
   MODULE_TYPE                    = UEFI_DRIVER\r
   VERSION_STRING                 = 1.0\r
@@ -45,5 +46,7 @@
   UefiBootServicesTableLib\r
 \r
 [Protocols]\r
-  gEfiPciIoProtocolGuid  \r
-  gEfiIdeControllerInitProtocolGuid\r
+  gEfiPciIoProtocolGuid             ## BY_START\r
+  gEfiIdeControllerInitProtocolGuid ## TO_START\r
+[UserExtensions.TianoCore."ExtraFiles"]\r
+  IdeControllerExtra.uni\r
index c22c381..c40e333 100644 (file)
@@ -1,6 +1,7 @@
 ## @file\r
-# \r
-# Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>\r
+# Timer Architectural Protocol module using High Precesion Event Timer (HPET).\r
+#\r
+# Copyright (c) 2011 - 2014, Intel Corporation. All rights reserved.<BR>\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
@@ -14,6 +15,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = HpetTimerDxe\r
+  MODULE_UNI_FILE                = HpetTimerDxe.uni\r
   FILE_GUID                      = 6CE6B0DE-781C-4f6c-B42D-98346C614BEC\r
   MODULE_TYPE                    = DXE_DRIVER\r
   VERSION_STRING                 = 1.0\r
   gEfiCpuArchProtocolGuid                       # PROTOCOL ALWAYS_CONSUMED\r
 \r
 [FeaturePcd]\r
-  gPcAtChipsetPkgTokenSpaceGuid.PcdHpetMsiEnable\r
-  \r
+  gPcAtChipsetPkgTokenSpaceGuid.PcdHpetMsiEnable    ## CONSUMES\r
+\r
 [Pcd]\r
-  gPcAtChipsetPkgTokenSpaceGuid.PcdHpetBaseAddress\r
-  gPcAtChipsetPkgTokenSpaceGuid.PcdHpetLocalApicVector\r
-  gPcAtChipsetPkgTokenSpaceGuid.PcdHpetDefaultTimerPeriod\r
+  gPcAtChipsetPkgTokenSpaceGuid.PcdHpetBaseAddress          ## CONSUMES\r
+  gPcAtChipsetPkgTokenSpaceGuid.PcdHpetLocalApicVector      ## CONSUMES\r
+  gPcAtChipsetPkgTokenSpaceGuid.PcdHpetDefaultTimerPeriod   ## CONSUMES\r
 \r
 [Depex]\r
   gEfiCpuArchProtocolGuid\r
+[UserExtensions.TianoCore."ExtraFiles"]\r
+  HpetTimerDxeExtra.uni\r
index 2edd39a..8fb8e4b 100644 (file)
@@ -1,14 +1,14 @@
 ## @file\r
 #   Component description file for PCAT ISA ACPI driver\r
 #\r
-# Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>\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
+# Copyright (c) 2005 - 2014, Intel Corporation. All rights reserved.<BR>\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
@@ -16,6 +16,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = IsaAcpi\r
+  MODULE_UNI_FILE                = IsaAcpi.uni\r
   FILE_GUID                      = 38A0EC22-FBE7-4911-8BC1-176E0D6C1DBD\r
   MODULE_TYPE                    = UEFI_DRIVER\r
   VERSION_STRING                 = 1.0\r
@@ -33,7 +34,7 @@
   UefiLib\r
   BaseMemoryLib\r
   PcdLib\r
-  \r
+\r
 [Sources]\r
   PcatIsaAcpi.h\r
   PcatIsaAcpi.c\r
   ComponentName.c\r
 \r
 [Protocols]\r
-  gEfiPciIoProtocolGuid\r
-  gEfiIsaAcpiProtocolGuid\r
+  gEfiPciIoProtocolGuid     ## TO_START\r
+  gEfiIsaAcpiProtocolGuid   ## BY_START\r
 \r
 [Pcd]\r
-  gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiCom1Enable\r
-  gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiCom2Enable\r
-  gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiPs2KeyboardEnable\r
-  gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiPs2MouseEnable\r
-  gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiFloppyAEnable\r
-  gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiFloppyBEnable\r
+  gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiCom1Enable        ## SOMETIMES_CONSUMES\r
+  gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiCom2Enable        ## SOMETIMES_CONSUMES\r
+  gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiPs2KeyboardEnable ## SOMETIMES_CONSUMES\r
+  gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiPs2MouseEnable    ## SOMETIMES_CONSUMES\r
+  gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiFloppyAEnable     ## SOMETIMES_CONSUMES\r
+  gPcAtChipsetPkgTokenSpaceGuid.PcdIsaAcpiFloppyBEnable     ## SOMETIMES_CONSUMES\r
+[UserExtensions.TianoCore."ExtraFiles"]\r
+  IsaAcpiExtra.uni\r
index 15620ae..b54b08c 100644 (file)
@@ -1,6 +1,9 @@
 ## @file\r
-# \r
-# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+# This driver implements Reset Architectural Protocol.\r
+#\r
+# It should depend on the ResetSystemLib instance that is implemented based on KBC.\r
+#\r
+# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\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
@@ -18,6 +21,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = KbcReset\r
+  MODULE_UNI_FILE                = KbcReset.uni\r
   FILE_GUID                      = 6F0198AA-1F1D-426D-AE3E-39AB633FCC28\r
   MODULE_TYPE                    = DXE_RUNTIME_DRIVER\r
   VERSION_STRING                 = 1.0\r
   ResetEntry.c\r
 \r
 [Protocols]\r
-  gEfiResetArchProtocolGuid\r
+  gEfiResetArchProtocolGuid ## PRODUCES\r
 \r
 [Depex]\r
   TRUE\r
+\r
+[UserExtensions.TianoCore."ExtraFiles"]\r
+  KbcResetExtra.uni\r
index 10d3977..f549f74 100644 (file)
@@ -1,7 +1,7 @@
 ## @file\r
-#   Library instance for I/O APIC library class\r
+#  Library instance for I/O APIC library class\r
 #\r
-#  Copyright (c) 2011, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2011 - 2014, Intel Corporation. All rights reserved.<BR>\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
@@ -15,6 +15,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = BaseIoApicLib\r
+  MODULE_UNI_FILE                = BaseIoApicLib.uni\r
   FILE_GUID                      = 58ED6E5A-E36A-462a-9ED6-6E62C9A26DF8\r
   MODULE_TYPE                    = BASE\r
   VERSION_STRING                 = 1.0\r
@@ -35,4 +36,5 @@
   IoApicLib.c\r
 \r
 [Pcd]\r
-  gPcAtChipsetPkgTokenSpaceGuid.PcdIoApicBaseAddress\r
+  gPcAtChipsetPkgTokenSpaceGuid.PcdIoApicBaseAddress    ## CONSUMES\r
+\r
index 26aebc1..c994827 100644 (file)
@@ -1,7 +1,7 @@
 ## @file\r
-#   Library instance for ResetSystem library class fort PCAT systems\r
+#   Library instance for ResetSystem library class for PCAT systems\r
 #\r
-#  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\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
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = ResetSystemLib\r
+  MODULE_UNI_FILE                = ResetSystemLib.uni\r
   FILE_GUID                      = EC4F3E59-F879-418b-9E4C-7D6F434714A0\r
   MODULE_TYPE                    = BASE\r
   VERSION_STRING                 = 1.0\r
-  LIBRARY_CLASS                  = ResetSystemLib \r
+  LIBRARY_CLASS                  = ResetSystemLib\r
 \r
 #\r
 # The following information is for reference only and not required by the build tools.\r
index f285875..959d6e2 100644 (file)
@@ -1,7 +1,7 @@
 ## @file\r
 #   Library instance for SerialIo library class\r
 #\r
-#  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\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
@@ -15,6 +15,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = PcAtSerialPortLib\r
+  MODULE_UNI_FILE                = PcAtSerialPortLib.uni\r
   FILE_GUID                      = 1B25AF84-1EA8-4b52-894E-BFA6880B97FF\r
   MODULE_TYPE                    = BASE\r
   VERSION_STRING                 = 1.0\r
index 926f6da..da4a9f5 100644 (file)
@@ -5,7 +5,7 @@
 #  This driver provides GetTime, SetTime, GetWakeupTime, SetWakeupTime services to Runtime Service Table.\r
 #  It will install a tagging protocol with gEfiRealTimeClockArchProtocolGuid.\r
 #\r
-#  Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\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
@@ -19,6 +19,7 @@
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = PcRtc\r
+  MODULE_UNI_FILE                = PcRtc.uni\r
   FILE_GUID                      = 378D7B65-8DA9-4773-B6E4-A47826A833E1\r
   MODULE_TYPE                    = DXE_RUNTIME_DRIVER\r
   VERSION_STRING                 = 1.0\r
@@ -60,4 +61,6 @@
   gEfiVariableArchProtocolGuid AND gEfiVariableWriteArchProtocolGuid\r
   \r
 [Pcd]\r
-  gEfiMdeModulePkgTokenSpaceGuid.PcdRealTimeClockUpdateTimeout         ## CONSUMES
\ No newline at end of file
+  gEfiMdeModulePkgTokenSpaceGuid.PcdRealTimeClockUpdateTimeout  ## CONSUMES\r
+[UserExtensions.TianoCore."ExtraFiles"]\r
+  PcRtcExtra.uni\r
index bed1d37..613c29f 100644 (file)
@@ -1,21 +1,21 @@
 ## @file\r
+#  The basic interfaces implementation to a single segment PCI Host Bridge driver.\r
 #\r
-#    Component description file a sinngle segment PCI Host Bridge driver.\r
-#\r
-#  Copyright (c) 2008 - 2010, Intel Corporation. All rights reserved.<BR>\r
+#  Copyright (c) 2008 - 2014, Intel Corporation. All rights reserved.<BR>\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
+#\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
 \r
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
   BASE_NAME                      = PciHostBridge\r
+  MODULE_UNI_FILE                = PciHostBridge.uni\r
   FILE_GUID                      = 2383608E-C6D0-4e3e-858D-45DFAC3543D5\r
   MODULE_TYPE                    = DXE_DRIVER\r
   VERSION_STRING                 = 1.0\r
   X64/IoFifo.S\r
 \r
 [Protocols]\r
-  gEfiPciHostBridgeResourceAllocationProtocolGuid\r
-  gEfiPciRootBridgeIoProtocolGuid\r
-  gEfiMetronomeArchProtocolGuid\r
-  gEfiDevicePathProtocolGuid\r
+  gEfiPciHostBridgeResourceAllocationProtocolGuid       ## PRODUCES\r
+  gEfiPciRootBridgeIoProtocolGuid                       ## PRODUCES\r
+  gEfiMetronomeArchProtocolGuid                         ## CONSUMES\r
+  gEfiDevicePathProtocolGuid                            ## PRODUCES\r
 \r
 [depex]\r
   gEfiMetronomeArchProtocolGuid\r
 \r
+[UserExtensions.TianoCore."ExtraFiles"]\r
+  PciHostBridgeExtra.uni\r