IntelFrameworkModulePkg: 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: Zeng, Star <star.zeng@intel.com>
Reviewed-by: Gao, Liming <liming.gao@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15966 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Zeng, Star
2014-08-28 06:58:44 +00:00
committed by lgao4
parent f3ae2bcfef
commit f9841f04ad
40 changed files with 588 additions and 425 deletions

View File

@ -1,12 +1,12 @@
## @file
# Component description file for IsaBus module.
# Generates ISA I/O Protocols based on the ISA ACPI Protocol instances.
#
# Discovers all the ISA Controllers and their resources by using the ISA ACPI
# Protocol, produces an instance of the ISA I/O Protocol for every ISA
# Discovers all the ISA Controllers and their resources by using the ISA ACPI
# Protocol, produces an instance of the ISA I/O Protocol for every ISA
# Controller found. This driver is designed to manage a PCI-to-ISA bridge Device
# such as LPC bridge.
# such as an LPC bridge.
#
# Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2007 - 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
@ -20,6 +20,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = IsaBusDxe
MODULE_UNI_FILE = IsaBusDxe.uni
FILE_GUID = 240612B5-A063-11d4-9A3A-0090273FC14D
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@ -58,13 +59,15 @@
DebugLib
[Protocols]
gEfiIsaIoProtocolGuid # PROTOCOL BY_START
gEfiIsaAcpiProtocolGuid # PROTOCOL TO_START
gEfiPciIoProtocolGuid # PROTOCOL TO_START
gEfiDevicePathProtocolGuid # PROTOCOL TO_START
gEfiGenericMemTestProtocolGuid # PROTOCOL TO_START
gEfiIsaIoProtocolGuid ## BY_START
gEfiDevicePathProtocolGuid ## BY_START
gEfiIsaAcpiProtocolGuid ## TO_START
gEfiPciIoProtocolGuid ## TO_START
gEfiDevicePathProtocolGuid ## TO_START
gEfiGenericMemTestProtocolGuid ## TO_START
[Pcd]
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSupportedFeatures
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSupportedFeatures ## CONSUMES
[UserExtensions.TianoCore."ExtraFiles"]
IsaBusDxeExtra.uni

View File

@ -1,16 +1,11 @@
## @file
# Component description file for IsaFloppy module.
# Provides ISA Floppy Disk support.
#
# ISA Floppy Disk UEFI Driver conforming to the UEFI driver model
# Provides ISA Floppy Disk UEFI Driver conforming to the UEFI driver model. The
# driver provides support for two drives per controller, DMA channel 2, diskette
# change line and write protect. Currently only 1.44MB drives are supported.
#
# 1. Support two types diskette drive
# 1.44M drive and 2.88M drive (and now only support 1.44M)
# 2. Support two diskette drives per floppy disk controller
# 3. Use DMA channel 2 to transfer data
# 4. Do not use interrupt
# 5. Support diskette change line signal and write protect
#
# Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
# Copyright (c) 2007 - 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
@ -25,6 +20,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = IsaFloppyDxe
MODULE_UNI_FILE = IsaFloppyDxe.uni
FILE_GUID = 0abd8284-6da3-4616-971a-83a5148067ba
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@ -62,10 +58,21 @@
PcdLib
[Protocols]
gEfiIsaIoProtocolGuid # PROTOCOL TO_START
gEfiBlockIoProtocolGuid # PROTOCOL BY_START
gEfiDevicePathProtocolGuid # PROTOCOL TO_START
gEfiIsaIoProtocolGuid ## TO_START
gEfiBlockIoProtocolGuid ## BY_START
gEfiDevicePathProtocolGuid ## TO_START
[FeaturePcd]
gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable # CONSUMES
gEfiMdePkgTokenSpaceGuid.PcdComponentName2Disable # CONSUMES
gEfiMdePkgTokenSpaceGuid.PcdComponentNameDisable ## CONSUMES
gEfiMdePkgTokenSpaceGuid.PcdComponentName2Disable ## CONSUMES
#
# [Event]
# ##
# # Floppy motor control timer event.
# #
# EVENT_TYPE_PERIODIC_TIMER ## CONSUMES
#
[UserExtensions.TianoCore."ExtraFiles"]
IsaFloppyDxeExtra.uni

View File

@ -1,10 +1,11 @@
## @file
# ISA Floppy PEIM to support recovery boot via floppy disk.
#
# This module detects Floppy devices. If found, it will install BlockIo PPI.
# This module is only dispatched in Recovery Boot mode.
# This module detects and supports ISA Floppy drives. If a drive is discovered
# the PEIM will install the BlockIo PPI. This module is only dispatched if it
# is in the Recovery Boot mode.
#
# Copyright (c) 2006 - 2011, 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
@ -25,6 +26,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = IsaFloppyPei
MODULE_UNI_FILE = IsaFloppyPei.uni
FILE_GUID = 7F6E0A24-DBFD-43df-9755-0292D7D3DD48
MODULE_TYPE = PEIM
VERSION_STRING = 1.0
@ -43,8 +45,9 @@
Fdc.h
[Packages]
IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec
MdePkg/MdePkg.dec
IntelFrameworkPkg/IntelFrameworkPkg.dec
IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec
[LibraryClasses]
IoLib
@ -58,11 +61,13 @@
PcdLib
[Ppis]
gEfiPeiVirtualBlockIoPpiGuid # PPI ALWAYS_PRODUCED
gEfiPeiVirtualBlockIoPpiGuid ## PRODUCES
[Pcd]
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdFdcBaseAddress
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdFdcBaseAddress ## CONSUMES
[Depex]
gEfiPeiMemoryDiscoveredPpiGuid AND gEfiPeiBootInRecoveryModePpiGuid
[UserExtensions.TianoCore."ExtraFiles"]
IsaFloppyPeiExtra.uni

View File

@ -1,9 +1,11 @@
## @file
# Component description file for IsaIoDxe module.
#
# Produces an instance of the ISA I/O Protocol for every SIO controller.
#
# Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
# Produces an instance of the ISA I/O Protocol for every SIO controller. The ISA
# I/O protocols are installed based off of the information provided by each
# instance of the SIO Protocol found.
#
# Copyright (c) 2010 - 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
@ -17,6 +19,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = IsaIoDxe
MODULE_UNI_FILE = IsaIoDxe.uni
FILE_GUID = 61AD3083-DCAD-4850-A50C-73B23B3B14F9
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@ -55,13 +58,14 @@
DebugLib
[Protocols]
gEfiIsaIoProtocolGuid # PROTOCOL BY_START
gEfiSioProtocolGuid # PROTOCOL TO_START
gEfiPciIoProtocolGuid # PROTOCOL TO_START
gEfiDevicePathProtocolGuid # PROTOCOL TO_START
gEfiGenericMemTestProtocolGuid # PROTOCOL TO_START
gEfiIsaIoProtocolGuid ## BY_START
gEfiSioProtocolGuid ## TO_START
gEfiPciIoProtocolGuid ## TO_START
gEfiDevicePathProtocolGuid ## TO_START
gEfiGenericMemTestProtocolGuid ## TO_START
[Pcd]
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSupportedFeatures
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSupportedFeatures ## CONSUMES
[UserExtensions.TianoCore."ExtraFiles"]
IsaIoDxeExtra.uni

View File

@ -1,6 +1,9 @@
## @file
# Serial driver for standard UARTS on an ISA bus.
#
# Produces the Serial I/O protocol for standard UARTS using ISA I/O. This driver
# supports the 8250, 16450, 16550 and 16550A UART types.
#
# Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>
#
# This program and the accompanying materials
@ -16,6 +19,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = IsaSerialDxe
MODULE_UNI_FILE = IsaSerialDxe.uni
FILE_GUID = 93B80003-9FB3-11d4-9A3A-0090273FC14D
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@ -53,19 +57,22 @@
DebugLib
[Guids]
gEfiUartDevicePathGuid
gEfiUartDevicePathGuid ## SOMETIMES_CONSUMES ## GUID
[Protocols]
gEfiIsaIoProtocolGuid ## TO_START
gEfiDevicePathProtocolGuid ## TO_START
gEfiSerialIoProtocolGuid ## BY_START
gEfiDevicePathProtocolGuid ## BY_START
[FeaturePcd]
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSerialUseHalfHandshake|FALSE
[Pcd]
gEfiMdePkgTokenSpaceGuid.PcdUartDefaultBaudRate|115200
gEfiMdePkgTokenSpaceGuid.PcdUartDefaultDataBits|8
gEfiMdePkgTokenSpaceGuid.PcdUartDefaultParity|1
gEfiMdePkgTokenSpaceGuid.PcdUartDefaultStopBits|1
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdIsaBusSerialUseHalfHandshake|FALSE ## CONSUMES
[Pcd]
gEfiMdePkgTokenSpaceGuid.PcdUartDefaultBaudRate|115200 ## CONSUMES
gEfiMdePkgTokenSpaceGuid.PcdUartDefaultDataBits|8 ## CONSUMES
gEfiMdePkgTokenSpaceGuid.PcdUartDefaultParity|1 ## CONSUMES
gEfiMdePkgTokenSpaceGuid.PcdUartDefaultStopBits|1 ## CONSUMES
[UserExtensions.TianoCore."ExtraFiles"]
IsaSerialDxeExtra.uni

View File

@ -1,10 +1,10 @@
## @file
# Ps2 Keyboard UEFI Driver which produce gEfiSimpleTextInProtocolGuid and gEfiSimpleTextInputExProtocolGuid
# protocol.
# The keyboard type implemented follows IBM compatible PS2 protocol, with Scan Codes Set 1.
# Ps2 Keyboard Driver.
#
# This dirver directly uses IsaIo protocol service to support KeyBoard work.
# Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
# Ps2 Keyboard Driver for UEFI. The keyboard type implemented follows IBM
# compatible PS2 protocol using Scan Code Set 1.
#
# 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
@ -20,6 +20,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = Ps2KeyboardDxe
MODULE_UNI_FILE = Ps2KeyboardDxe.uni
FILE_GUID = 3DC82376-637B-40a6-A8FC-A565417F2C38
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@ -59,25 +60,26 @@
PcdLib
[Protocols]
gEfiPs2PolicyProtocolGuid # PROTOCOL TO_START
gEfiIsaIoProtocolGuid # PROTOCOL TO_START
gEfiSimpleTextInProtocolGuid # PROTOCOL BY_START
gEfiSimpleTextInputExProtocolGuid # PROTOCOL BY_START
gEfiDevicePathProtocolGuid # PROTOCOL TO_START
gEfiSimpleTextInProtocolGuid ## BY_START
gEfiSimpleTextInputExProtocolGuid ## BY_START
gEfiPs2PolicyProtocolGuid ## SOMETIMES_CONSUMES
gEfiIsaIoProtocolGuid ## TO_START
gEfiDevicePathProtocolGuid ## TO_START
[FeaturePcd]
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPs2KbdExtendedVerification
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPs2KbdExtendedVerification ## CONSUMES
[Pcd]
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdFastPS2Detection
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdFastPS2Detection ## SOMETIMES_CONSUMES
#
# [Event]
# ##
# # Event will be signaled for WaitForKey event.
# #
# EVT_NOTIFY_WAIT ## PRODUCES
#
# ##
# # Event will be used to poll mouse state.
# # Timer event used to read key strokes at a regular interval.
# #
# EVT_NOTIFY_SIGNAL ## PRODUCES
# EVENT_TYPE_PERIODIC_TIMER ## CONSUMES
#
[UserExtensions.TianoCore."ExtraFiles"]
Ps2KeyboardDxeExtra.uni

View File

@ -1,8 +1,10 @@
## @file
# Ps2 Mouse Simulate TouchPad Driver
# PS2 Mouse driver providing absolute (touch pad) pointer support.
#
# This dirver directly uses IsaIo protocol service to support a faked Ps2 TouchPad work.
# Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
# This driver simulates a touch pad absolute pointing device using a standard
# PS2 mouse as the input hardware.
#
# 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
@ -18,6 +20,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = Ps2MouseAbsolutePointerDxe
MODULE_UNI_FILE = Ps2MouseAbsolutePointerDxe.uni
FILE_GUID = 2899C94A-1FB6-4b1a-B96B-8364975303E0
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@ -59,15 +62,16 @@
gEfiDevicePathProtocolGuid ## TO_START
[FeaturePcd]
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPs2MouseExtendedVerification
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPs2MouseExtendedVerification ## CONSUMES
# [Event]
# ##
# # Event for EFI_SIMPLE_POINTER_PROTOCOL.WaitForInput.
# #
# EVENT_TYPE_NOTIFY_WAIT ## PRODUCES
#
# # Periodic timer event to poll the fake Ps2 mouse device and get its packet data.
# [Event]
#
# ##
# # Timer event used to check the mouse state at a regular interval.
# #
# EVENT_TYPE_PERIODIC_TIMER ## PRODUCES
# EVENT_TYPE_PERIODIC_TIMER ## CONSUMES
#
[UserExtensions.TianoCore."ExtraFiles"]
Ps2MouseAbsolutePointerDxeExtra.uni

View File

@ -1,8 +1,9 @@
## @file
# Ps2 Mouse Driver.
# PS2 Mouse Driver.
#
# This dirver directly uses IsaIo protocol service to support Ps2 mouse work.
# Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
# This dirver provides support for PS2 based mice.
#
# 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
@ -18,6 +19,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = Ps2MouseDxe
MODULE_UNI_FILE = Ps2MouseDxe.uni
FILE_GUID = 202A2B0E-9A31-4812-B291-8747DF152439
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@ -59,14 +61,16 @@
gEfiDevicePathProtocolGuid ## TO_START
[FeaturePcd]
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPs2MouseExtendedVerification
gEfiIntelFrameworkModulePkgTokenSpaceGuid.PcdPs2MouseExtendedVerification ## CONSUMES
# [Event]
# ##
# # Event for EFI_SIMPLE_POINTER_PROTOCOL.WaitForInput.
# #
# EVENT_TYPE_NOTIFY_WAIT ## PRODUCES
#
# # Periodic timer event to poll the Ps2 mouse device and get its packet data.
# [Event]
#
# ##
# # Timer event used to check the mouse state at a regular interval.
# #
# EVENT_TYPE_PERIODIC_TIMER ## PRODUCES
# EVENT_TYPE_PERIODIC_TIMER ## CONSUMES
#
[UserExtensions.TianoCore."ExtraFiles"]
Ps2MouseDxeExtra.uni

View File

@ -1,9 +1,9 @@
## @file
# Component description file for IdeBus module.
# IDE bus driver.
#
# IDE bus driver. This driver will enumerate IDE device and export the blockIo
# protocol for every device.
# Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
# This driver will enumerate IDE device and export the blockIo protocol for every device.
#
# 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
@ -18,6 +18,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = IdeBusDxe
MODULE_UNI_FILE = IdeBusDxe.uni
FILE_GUID = 69FD8E47-A161-4550-B01A-5594CEB2B2B2
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@ -70,15 +71,18 @@
[Guids]
gEfiDiskInfoIdeInterfaceGuid # CONSUMES ## GUID
gEfiEventExitBootServicesGuid # CONSUMES ## Event
gEfiDiskInfoIdeInterfaceGuid ## SOMETIMES_PRODUCES ## UNDEFINED # DiskInfo Interface Guid
gEfiEventExitBootServicesGuid ## CONSUMES ## Event
[Protocols]
gEfiDiskInfoProtocolGuid # BY_START
gEfiBlockIoProtocolGuid # BY_START
gEfiIdeControllerInitProtocolGuid # TO_START
gEfiPciIoProtocolGuid # TO_START
gEfiDevicePathProtocolGuid # TO_START
gEfiDiskInfoProtocolGuid ## BY_START
gEfiBlockIoProtocolGuid ## BY_START
gEfiIdeControllerInitProtocolGuid ## TO_START
gEfiPciIoProtocolGuid ## TO_START
## TO_START
## BY_START
gEfiDevicePathProtocolGuid
[UserExtensions.TianoCore."ExtraFiles"]
IdeBusDxeExtra.uni

View File

@ -1,7 +1,7 @@
## @file
# VGA Mini Port Driver that manages VGA device and produces VGA Mini Port Protocol.
#
# 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
@ -17,6 +17,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = VgaMiniPort
MODULE_UNI_FILE = VgaMiniPort.uni
FILE_GUID = 15C5E761-58D8-461a-9173-CAB020916264
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@ -52,4 +53,5 @@
gEfiPciIoProtocolGuid ## TO_START
gEfiVgaMiniPortProtocolGuid ## BY_START
[UserExtensions.TianoCore."ExtraFiles"]
VgaMiniPortExtra.uni