MdeModulePkg: 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@15962 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Zeng, Star
2014-08-28 06:34:06 +00:00
committed by lgao4
parent f7acc87241
commit 6036e94dc9
149 changed files with 1838 additions and 1221 deletions

View File

@@ -1,8 +1,10 @@
## @file
# Platform console driver manages console devices.
#
# Console Platfrom DXE Driver that specifies whether device can be used as console
# input/output device or error output device and update global variables accordingly.
#
# 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 +19,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = ConPlatformDxe
MODULE_UNI_FILE = ConPlatformDxe.uni
FILE_GUID = 51ccf399-4fdf-4e55-a45b-e123f84d456a
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -55,37 +58,41 @@
DebugLib
[Guids]
##
#
# This is the VendorGuid of all architecturally defined variables in UEFI spec.
#
gEfiGlobalVariableGuid ## CONSUMES ## Variable:L"ConIn"
gEfiGlobalVariableGuid ## CONSUMES ## Variable:L"ConOut"
gEfiGlobalVariableGuid ## CONSUMES ## Variable:L"ErrOut"
gEfiGlobalVariableGuid ## CONSUMES ## Variable:L"ConInDev"
gEfiGlobalVariableGuid ## CONSUMES ## Variable:L"ConOutDev"
gEfiGlobalVariableGuid ## CONSUMES ## Variable:L"ErrOutDev"
##
## SOMETIMES_CONSUMES ## Variable:L"ConIn"
## SOMETIMES_CONSUMES ## Variable:L"ConOut"
## SOMETIMES_CONSUMES ## Variable:L"ErrOut"
## SOMETIMES_PRODUCES ## Variable:L"ConInDev"
## SOMETIMES_PRODUCES ## Variable:L"ConOutDev"
## SOMETIMES_PRODUCES ## Variable:L"ErrOutDev"
gEfiGlobalVariableGuid
#
# This GUID is used to specify the device is the standard error device.
# If the device is a standard error device, this GUID as the protocol GUID will be installed
# onto this device handle.
#
gEfiStandardErrorDeviceGuid ## PROTOCOL
##
gEfiStandardErrorDeviceGuid ## SOMETIMES_PRODUCES ## UNDEFINED # protocol GUID installed on device handle
#
# This GUID is used to specify the device is the console output device.
# If the device is a console output device, this GUID as the protocol GUID will be installed
# onto this device handle.
#
gEfiConsoleOutDeviceGuid ## PROTOCOL
##
gEfiConsoleOutDeviceGuid ## SOMETIMES_PRODUCES ## UNDEFINED # protocol GUID installed on device handle
#
# This GUID is used to specify the device is the console input device.
# If the device is a console input device, this GUID as the protocol GUID will be installed
# onto this device handle.
#
gEfiConsoleInDeviceGuid ## PROTOCOL
gEfiConsoleInDeviceGuid ## SOMETIMES_PRODUCES ## UNDEFINED # protocol GUID installed on device handle
[Protocols]
gEfiDevicePathProtocolGuid ## TO_START
gEfiSimpleTextInProtocolGuid ## TO_START
gEfiSimpleTextOutProtocolGuid ## TO_START
gEfiPciIoProtocolGuid ## TO_START
gEfiGraphicsOutputProtocolGuid ## TO_START
gEfiPciIoProtocolGuid ## SOMETIMES_CONSUMES
gEfiGraphicsOutputProtocolGuid ## SOMETIMES_CONSUMES
[UserExtensions.TianoCore."ExtraFiles"]
ConPlatformDxeExtra.uni

View File

@@ -7,10 +7,10 @@
# table according PCD settings(PcdConOutGopSupport, and PcdConOutUgaSupport). It always
# consumes Graphics Output protocol which is produced by display device, and consumes UGA Draw
# protocol which is produced by display device according to PcdUgaConsumeSupport value.
# Note: If only UGA Draw protocol is installed in system table, PcdUgaConsumeSupport
# should be set to TRUE.
# Note: If only UGA Draw protocol is installed in system, PcdUgaConsumeSupport should be
# set to TRUE.
#
# Copyright (c) 2006 - 2012, 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
@@ -25,6 +25,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = ConSplitterDxe
MODULE_UNI_FILE = ConSplitterDxe.uni
FILE_GUID = 408edcec-cf6d-477c-a5a8-b4844e3de281
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -70,27 +71,49 @@
PcdLib
[Guids]
gEfiConsoleInDeviceGuid ## SOMETIMES_CONSUMES
gEfiStandardErrorDeviceGuid ## SOMETIMES_CONSUMES
gEfiConsoleOutDeviceGuid ## SOMETIMES_CONSUMES
gConnectConInEventGuid ## ALWAYS_CONSUMES
gEfiConsoleInDeviceGuid ## SOMETIMES_CONSUMES ## UNDEFINED # protocol GUID installed on device handle
gEfiStandardErrorDeviceGuid ## SOMETIMES_CONSUMES ## UNDEFINED # protocol GUID installed on device handle
gEfiConsoleOutDeviceGuid ## SOMETIMES_CONSUMES ## UNDEFINED # protocol GUID installed on device handle
## SOMETIMES_PRODUCES ## Event
## SOMETIMES_CONSUMES ## Event
gConnectConInEventGuid
[Protocols]
gEfiSimplePointerProtocolGuid ## BY_START
gEfiAbsolutePointerProtocolGuid ## BY_START
gEfiSimpleTextInProtocolGuid ## BY_START
gEfiSimpleTextInputExProtocolGuid ## BY_START
gEfiSimpleTextOutProtocolGuid ## BY_START
gEfiGraphicsOutputProtocolGuid ## BY_START
gEfiUgaDrawProtocolGuid ## BY_START
## PRODUCES
## TO_START
gEfiSimplePointerProtocolGuid
## PRODUCES
## TO_START
gEfiAbsolutePointerProtocolGuid
## PRODUCES
## TO_START
gEfiSimpleTextInProtocolGuid
## PRODUCES
## TO_START
gEfiSimpleTextInputExProtocolGuid
## PRODUCES
## TO_START
gEfiSimpleTextOutProtocolGuid
## SOMETIMES_PRODUCES
## SOMETIMES_CONSUMES
gEfiGraphicsOutputProtocolGuid
## SOMETIMES_PRODUCES
## SOMETIMES_CONSUMES
gEfiUgaDrawProtocolGuid
[FeaturePcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdConOutGopSupport
gEfiMdeModulePkgTokenSpaceGuid.PcdConOutUgaSupport
gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport
gEfiMdeModulePkgTokenSpaceGuid.PcdConOutGopSupport ## CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdConOutUgaSupport ## CONSUMES
gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport ## CONSUMES
[Pcd]
## SOMETIMES_PRODUCES
## SOMETIMES_CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdConOutRow
## SOMETIMES_PRODUCES
## SOMETIMES_CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdConOutColumn
gEfiMdeModulePkgTokenSpaceGuid.PcdConInConnectOnDemand
gEfiMdeModulePkgTokenSpaceGuid.PcdConInConnectOnDemand ## SOMETIMES_CONSUMES
[UserExtensions.TianoCore."ExtraFiles"]
ConSplitterDxeExtra.uni

View File

@@ -1,10 +1,10 @@
## @file
#
# Component description file for GraphicsConsole module
# Console support on graphic devices.
#
# This is the main routine for initializing the Graphics Console support routines.
# This driver will install Simple Text Output protocol by consuming Graphices Output
# protocol or UGA Draw protocol on graphic devices.
#
# 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 of the BSD License
# which accompanies this distribution. The full text of the license may be found at
@@ -18,6 +18,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = GraphicsConsoleDxe
MODULE_UNI_FILE = GraphicsConsoleDxe.uni
FILE_GUID = CCCB0C28-4B24-11d5-9A5A-0090273FC14D
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -54,17 +55,21 @@
PcdLib
[Protocols]
gEfiDevicePathProtocolGuid ## CONSUMES
gEfiDevicePathProtocolGuid ## TO_START
gEfiSimpleTextOutProtocolGuid ## BY_START
gEfiGraphicsOutputProtocolGuid ## TO_START
gEfiUgaDrawProtocolGuid ## TO_START
gEfiHiiFontProtocolGuid ## TO_START
gEfiHiiDatabaseProtocolGuid ## TO_START
## TO_START
## NOTIFY
gEfiHiiDatabaseProtocolGuid
[FeaturePcd]
gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport
gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport ## CONSUMES
[Pcd]
gEfiMdeModulePkgTokenSpaceGuid.PcdVideoHorizontalResolution
gEfiMdeModulePkgTokenSpaceGuid.PcdVideoVerticalResolution
gEfiMdeModulePkgTokenSpaceGuid.PcdVideoHorizontalResolution ## SOMETIMES_CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdVideoVerticalResolution ## SOMETIMES_CONSUMES
[UserExtensions.TianoCore."ExtraFiles"]
GraphicsConsoleDxeExtra.uni

View File

@@ -1,8 +1,9 @@
## @file
# Terminal module installs Simple Text Input(ex)/Out protocols for serial devices.
#
# Component description file for Terminal module.
#
# This driver installs Simple Text In/Out protocol for terminal devices (serial devices or hotplug devices).
# This module will install Simple Text Input (Ex) protocol and Simple Test Output
# protocols based on Serial I/O protocol for serial devices including hotplug serial
# devices.
#
# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
@@ -18,6 +19,7 @@
[Defines]
INF_VERSION = 0x00010005
BASE_NAME = TerminalDxe
MODULE_UNI_FILE = TerminalDxe.uni
FILE_GUID = 9E863906-A40F-4875-977F-5B93FF237FC6
MODULE_TYPE = UEFI_DRIVER
VERSION_STRING = 1.0
@@ -60,29 +62,37 @@
BaseLib
[Guids]
gEfiGlobalVariableGuid ## SOMETIMES_CONSUMES ## Variable:L"ErrOutDev"
gEfiVTUTF8Guid ## SOMETIMES_CONSUMES ## GUID
gEfiVT100Guid ## SOMETIMES_CONSUMES ## GUID
gEfiVT100PlusGuid ## SOMETIMES_CONSUMES ## GUID
gEfiPcAnsiGuid ## SOMETIMES_CONSUMES ## GUID
## SOMETIMES_PRODUCES ## Variable:L"ConInDev"
## SOMETIMES_CONSUMES ## Variable:L"ConInDev"
## SOMETIMES_PRODUCES ## Variable:L"ConOutDev"
## SOMETIMES_CONSUMES ## Variable:L"ConOutDev"
## SOMETIMES_PRODUCES ## Variable:L"ErrOutDev"
## SOMETIMES_CONSUMES ## Variable:L"ErrOutDev"
gEfiGlobalVariableGuid
gEfiVTUTF8Guid ## SOMETIMES_CONSUMES ## GUID # used with a Vendor-Defined Messaging Device Path
gEfiVT100Guid ## SOMETIMES_CONSUMES ## GUID # used with a Vendor-Defined Messaging Device Path
gEfiVT100PlusGuid ## SOMETIMES_CONSUMES ## GUID # used with a Vendor-Defined Messaging Device Path
gEfiPcAnsiGuid ## SOMETIMES_CONSUMES ## GUID # used with a Vendor-Defined Messaging Device Path
gEdkiiStatusCodeDataTypeVariableGuid ## SOMETIMES_CONSUMES ## GUID
[Protocols]
gEfiSerialIoProtocolGuid ## TO_START
gEfiDevicePathProtocolGuid ## TO_START
## BY_START
## TO_START
gEfiDevicePathProtocolGuid
gEfiSimpleTextInProtocolGuid ## BY_START
gEfiSimpleTextInputExProtocolGuid ## BY_START
gEfiSimpleTextOutProtocolGuid ## BY_START
[Pcd]
gEfiMdePkgTokenSpaceGuid.PcdDefaultTerminalType
gEfiMdeModulePkgTokenSpaceGuid.PcdErrorCodeSetVariable
gEfiMdePkgTokenSpaceGuid.PcdDefaultTerminalType ## SOMETIMES_CONSUMES
gEfiMdeModulePkgTokenSpaceGuid.PcdErrorCodeSetVariable ## CONSUMES
# [Event]
# ##
# # Relative timer event set by UnicodeToEfiKey(), used to one 2 seconds input timeout.
# #
# EVENT_TYPE_RELATIVE_TIMER ## PRODUCES
#
#
# # Relative timer event set by UnicodeToEfiKey(), used to be one 2 seconds input timeout.
# EVENT_TYPE_RELATIVE_TIMER ## CONSUMES
# # Period timer event to invoke TerminalConInTimerHandler(), period value is KEYBOARD_TIMER_INTERVAL and used to poll the key from serial
# EVENT_TYPE_PERIODIC_TIMER ## CONSUMES
[UserExtensions.TianoCore."ExtraFiles"]
TerminalDxeExtra.uni