sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Code Scrub for Protocol and Ppi Definition

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5564 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lgao4
2008-07-25 10:37:15 +00:00
parent bb80e3b213
commit 4ca9b6c4e7
105 changed files with 3354 additions and 1680 deletions
Download Patch File Download Diff File Expand all files Collapse all files

260
MdePkg/Include/Protocol/HiiDatabase.h
View File

@@ -47,9 +47,10 @@ typedef UINTN EFI_HII_DATABASE_NOTIFY_TYPE;
field of EFI_HII_PACKAGE_GUID_HEADER.
Otherwise, it must be NULL.
@param Package Points to the package referred to by the
notification Handle The handle of the package
list which contains the specified package.
@param Package Points to the package referred to by the notification.
@param Handle The handle of the package
list which contains the specified package.
@param NotifyType The type of change concerning the
database. See
@@ -79,25 +80,22 @@ EFI_STATUS
corresponding call to
EFI_HII_DATABASE_PROTOCOL.RemovePackageList().
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL
instance.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
@param PackageList A pointer to an
EFI_HII_PACKAGE_LIST_HEADER structure.
@param PackageList A pointer to an EFI_HII_PACKAGE_LIST_HEADER structure.
@param DriverHandle Associate the package list with this EFI
handle Handle A pointer to the
EFI_HII_HANDLE instance.
@param DriverHandle Associate the package list with this EFI handle.
@param Handle A pointer to the EFI_HII_HANDLE instance.
@retval EFI_SUCCESS The package list associated with the
Handle was added to the HII database.
@retval EFI_SUCCESS The package list associated with the
Handle was added to the HII database.
@retval EFI_OUT_OF_RESOURCES Unable to allocate necessary
resources for the new database
contents.
@retval EFI_INVALID_PARAMETER PackageList is NULL or Handle
is NULL.
@retval EFI_INVALID_PARAMETER PackageList is NULL or Handle is NULL.
**/
typedef
@@ -119,14 +117,13 @@ EFI_STATUS
call to EFI_HII_DATABASE_PROTOCOL.NewPackageList(), there should
be a corresponding call to RemovePackageList.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL
instance.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
@param Handle The handle that was registered to the data
that is requested for removal.
@param Handle The handle that was registered to the data
that is requested for removal.
@retval EFI_SUCCESS The data associated with the Handle was
removed from the HII database.
@retval EFI_SUCCESS The data associated with the Handle was
removed from the HII database.
@retval EFI_NOT_FOUND The specified Handle is not in database.
**/
@@ -161,20 +158,18 @@ EFI_STATUS
- Call any functions registered with the notification type
ADD_PACK.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL
instance.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
@param Handle The handle that was registered to the data
that is requested for removal.
@param Handle The handle that was registered to the data
that is requested for removal.
@param PackageList A pointer to an EFI_HII_PACKAGE_LIST
package.
@retval EFI_SUCCESS The HII database was successfully
updated.
@retval EFI_SUCCESS The HII database was successfully updated.
@retval EFI_OUT_OF_RESOURCES Unable to allocate enough memory
for the updated database.
@retval EFI_OUT_OF_RESOURCES Unable to allocate enough memory
for the updated database.
@retval EFI_INVALID_PARAMETER PackageList was NULL.
@retval EFI_NOT_FOUND The specified Handle is not in database.
@@ -196,45 +191,39 @@ EFI_STATUS
pseudo-type EFI_HII_PACKAGE_TYPE_ALL will cause all package
handles to be listed.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL
instance.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
@param PackageType Specifies the package type of the packages
to list or EFI_HII_PACKAGE_TYPE_ALL for
all packages to be listed.
@param PackageType Specifies the package type of the packages
to list or EFI_HII_PACKAGE_TYPE_ALL for
all packages to be listed.
@param PackageGuid If PackageType is
EFI_HII_PACKAGE_TYPE_GUID, then this is
the pointer to the GUID which must match
the Guid field of
EFI_HII_PACKAGE_GUID_HEADER. Otherwise, it
must be NULL.
@param PackageGuid If PackageType is
EFI_HII_PACKAGE_TYPE_GUID, then this is
the pointer to the GUID which must match
the Guid field of
EFI_HII_PACKAGE_GUID_HEADER. Otherwise, it
must be NULL.
@param HandleBufferLength On input, a pointer to the length
of the handle buffer. On output,
the length of the handle buffer
that is required for the handles
found.
that is required for the handles found.
@param Handle An array of EFI_HII_HANDLE instances returned.
@param Handle An array of EFI_HII_HANDLE instances returned.
@retval EFI_SUCCESS The matching handles are outputed successfully.
HandleBufferLength is updated with the actual length.
@retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter
@retval EFI_SUCCESS The matching handles are outputed successfully.
HandleBufferLength is updated with the actual length.
@retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter
indicates that Handle is too
small to support the number of
handles. HandleBufferLength is
updated with a value that will
enable the data to fit.
@retval EFI_NOT_FOUND No matching handle could not be found in database.
@retval EFI_INVALID_PARAMETER Handle or HandleBufferLength was NULL.
@retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but
PackageGuid is not NULL, PackageType is a EFI_HII_
PACKAGE_TYPE_GUID but PackageGuid is NULL.
@retval EFI_NOT_FOUND No matching handle could not be found in database.
@retval EFI_INVALID_PARAMETER Handle or HandleBufferLength was NULL.
@retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but
PackageGuid is not NULL, PackageType is a EFI_HII_
PACKAGE_TYPE_GUID but PackageGuid is NULL.
**/
typedef
EFI_STATUS
@@ -243,14 +232,9 @@ EFI_STATUS
IN UINT8 PackageType,
IN CONST EFI_GUID *PackageGuid,
IN OUT UINTN *HandleBufferLength,
OUT EFI_HII_HANDLE *Handle
OUT EFI_HII_HANDLE *Handle
);
/**
This function will export one or all package lists in the
@@ -263,27 +247,26 @@ EFI_STATUS
EFI_OUT_OF_RESOURCES will be returned and the actual package
size will be returned in BufferSize.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL
instance.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
@param Handle An EFI_HII_HANDLE that corresponds to the
desired package list in the HII database to
export or NULL to indicate all package lists
should be exported.
@param Handle An EFI_HII_HANDLE that corresponds to the
desired package list in the HII database to
export or NULL to indicate all package lists
should be exported.
@param BufferSize On input, a pointer to the length of the
buffer. On output, the length of the
buffer that is required for the exported
data.
@param Buffer A pointer to a buffer that will contain the
results of the export function.
@param Buffer A pointer to a buffer that will contain the
results of the export function.
@retval EFI_SUCCESS Package exported.
@retval EFI_SUCCESS Package exported.
@retval EFI_OUT_OF_RESOURCES BufferSize is too small to hold
the package.
@retval EFI_OUT_OF_RESOURCES BufferSize is too small to hold the package.
**/
typedef
@@ -309,44 +292,42 @@ EFI_STATUS
exiting.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL
instance.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
@param PackageType The package type. See
EFI_HII_PACKAGE_TYPE_x in EFI_HII_PACKAGE_HEADER.
@param PackageType The package type. See
EFI_HII_PACKAGE_TYPE_x in EFI_HII_PACKAGE_HEADER.
@param PackageGuid If PackageType is
EFI_HII_PACKAGE_TYPE_GUID, then this is
the pointer to the GUID which must match
the Guid field of
EFI_HII_PACKAGE_GUID_HEADER. Otherwise, it
must be NULL.
@param PackageGuid If PackageType is
EFI_HII_PACKAGE_TYPE_GUID, then this is
the pointer to the GUID which must match
the Guid field of
EFI_HII_PACKAGE_GUID_HEADER. Otherwise, it
must be NULL.
@param PackageNotifyFn Points to the function to be called
when the event specified by
NotificationType occurs. See
EFI_HII_DATABASE_NOTIFY.
@param NotifyType Describes the types of notification which
this function will be receiving. See
EFI_HII_DATABASE_NOTIFY_TYPE for more a
list of types.
@param NotifyType Describes the types of notification which
this function will be receiving. See
EFI_HII_DATABASE_NOTIFY_TYPE for more a
list of types.
@param NotifyHandle Points to the unique handle assigned to
the registered notification. Can be used
in
EFI_HII_DATABASE_PROTOCOL.UnregisterPack
to stop notifications.
@param NotifyHandle Points to the unique handle assigned to
the registered notification. Can be used
in EFI_HII_DATABASE_PROTOCOL.UnregisterPack
to stop notifications.
@retval EFI_SUCCESS Notification registered successfully.
@retval EFI_SUCCESS Notification registered successfully.
@retval EFI_OUT_OF_RESOURCES Unable to allocate necessary
data structures.
@retval EFI_INVALID_PARAMETER PackageGuid is not NULL when
PackageType is not
EFI_HII_PACKAGE_TYPE_GUID.
@retval EFI_INVALID_PARAMETER PackageGuid is not NULL when
PackageType is not
EFI_HII_PACKAGE_TYPE_GUID.
**/
typedef
@@ -365,17 +346,15 @@ EFI_STATUS
Removes the specified HII database package-related notification.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL
instance.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.
@param NotificationHandle The handle of the notification
function being unregistered.
@retval EFI_SUCCESS Unregister the notification
Successsfully
@retval EFI_SUCCESS Unregister the notification Successsfully
@retval EFI_NOT_FOUND The incoming notification handle does not exist
in current hii database.
in current hii database.
**/
typedef
@@ -391,17 +370,18 @@ EFI_STATUS
This routine retrieves an array of GUID values for each keyboard
layout that was previously registered in the system.
@param This A pointer to the EFI_HII_PROTOCOL instance.
@param This A pointer to the EFI_HII_PROTOCOL instance.
@param KeyGuidBufferLength On input, a pointer to the length
of the keyboard GUID buffer. On
output, the length of the handle
buffer that is required for the
handles found. KeyGuidBuffer An
array of keyboard layout GUID
handles found.
@param KeyGuidBuffer An array of keyboard layout GUID
instances returned.
@retval EFI_SUCCESS KeyGuidBuffer was updated successfully.
@retval EFI_SUCCESS KeyGuidBuffer was updated successfully.
@retval EFI_BUFFER_TOO_SMALL The KeyGuidBufferLength
parameter indicates that
@@ -428,20 +408,23 @@ EFI_STATUS
character(s) that are associated with a particular set of key
strokes.
@param This A pointer to the EFI_HII_PROTOCOL instance.
@param This A pointer to the EFI_HII_PROTOCOL instance.
@param KeyGuid A pointer to the unique ID associated with a
given keyboard layout. If KeyGuid is NULL then
the current layout will be retrieved.
@param KeyGuid A pointer to the unique ID associated with a
given keyboard layout. If KeyGuid is NULL then
the current layout will be retrieved.
@param KeyboardLayoutLength On input, a pointer to the length of the
KeyboardLayout buffer. On output, the length of
the data placed into KeyboardLayout.
@param KeyboardLayout A pointer to a buffer containing the
retrieved keyboard layout. below.
@param KeyboardLayout A pointer to a buffer containing the
retrieved keyboard layout.
@retval EFI_SUCCESS The keyboard layout was retrieved
successfully.
@retval EFI_NOT_FOUND The requested keyboard layout was not
found.
@retval EFI_NOT_FOUND The requested keyboard layout was not found.
**/
typedef
@@ -462,18 +445,15 @@ EFI_STATUS
current keyboard layout being changed can be notified of this
change.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL
instance.
@param This A pointer to the EFI_HII_PROTOCOL instance.
@param KeyGuid A pointer to the unique ID associated with a
given keyboard layout.
@param KeyGuid A pointer to the unique ID associated with a
given keyboard layout.
@retval EFI_SUCCESS The current keyboard layout was successfully set.
@retval EFI_SUCCESS The current keyboard layout was
successfully set.
@retval EFI_NOT_FOUND The referenced keyboard layout was not
found, so action was taken.
@retval EFI_NOT_FOUND The referenced keyboard layout was not
found, so action was taken.
**/
typedef
@@ -487,22 +467,19 @@ EFI_STATUS
Return the EFI handle associated with a package list.
@param This A pointer to the EFI_HII_DATABASE_PROTOCOL
instance.
@param This A pointer to the EFI_HII_PROTOCOL instance.
@param PackageListHandle An EFI_HII_HANDLE that corresponds
to the desired package list in the
HIIdatabase.
@param DriverHandle On return, contains the EFI_HANDLE which
was registered with the package list in
NewPackageList().
@param DriverHandle On return, contains the EFI_HANDLE which
was registered with the package list in
NewPackageList().
@retval EFI_SUCCESS The DriverHandle was returned
successfully.
@retval EFI_SUCCESS The DriverHandle was returned successfully.
@retval EFI_INVALID_PARAMETER The PackageListHandle was not
valid.
@retval EFI_INVALID_PARAMETER The PackageListHandle was not valid.
**/
typedef
@@ -514,9 +491,10 @@ EFI_STATUS
);
/**
@param NewPackageList Add a new package list to the HII
database.
@par Protocol Description:
Database manager for HII-related data structures.
@param NewPackageList Add a new package list to the HII database.
@param RemovePackageList Remove a package list from the HII
database.
@@ -530,15 +508,17 @@ EFI_STATUS
@param ExportPackageLists Export package lists from the HII
database.
@param RegisterPackageNotify Register notification when
packages of a certain type are
installed.
@param RegisterPackageNotify
Register notification when
packages of a certain type are
installed.
@param UnregisterPackageNotify Unregister notification of
packages.
@param UnregisterPackageNotify
Unregister notification of packages.
@param FindKeyboardLayouts Retrieves a list of the keyboard
layouts in the system.
@param FindKeyboardLayouts
Retrieves a list of the keyboard
layouts in the system.
@param GetKeyboardLayout Allows a program to extract the
current keyboard layout. See the