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