update codes per MdePkg doxgen review comments.

[mirror_edk2.git] / MdePkg / Include / Protocol / HiiDatabase.h

/** @file\r
  The file provides Database manager for HII-related data\r
  structures.\r
  \r
  Copyright (c) 2006 - 2008, Intel Corporation\r
  All rights reserved. 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
#ifndef __HII_DATABASE_H__\r
#define __HII_DATABASE_H__\r
\r
#define EFI_HII_DATABASE_PROTOCOL_GUID \\r
  { 0xef9fc172, 0xa1b2, 0x4693, { 0xb3, 0x27, 0x6d, 0x32, 0xfc, 0x41, 0x60, 0x42 } }\r
\r
\r
typedef struct _EFI_HII_DATABASE_PROTOCOL EFI_HII_DATABASE_PROTOCOL;\r
\r
\r
///\r
/// EFI_HII_DATABASE_NOTIFY_TYPE\r
/// \r
typedef UINTN   EFI_HII_DATABASE_NOTIFY_TYPE;\r
\r
#define EFI_HII_DATABASE_NOTIFY_NEW_PACK    0x00000001\r
#define EFI_HII_DATABASE_NOTIFY_REMOVE_PACK 0x00000002\r
#define EFI_HII_DATABASE_NOTIFY_EXPORT_PACK 0x00000004\r
#define EFI_HII_DATABASE_NOTIFY_ADD_PACK    0x00000008\r
/**\r
   \r
  Functions which are registered to receive notification of\r
  database events have this prototype. The actual event is encoded\r
  in NotifyType. The following table describes how PackageType,\r
  PackageGuid, Handle, and Package are used for each of the\r
  notification types.\r
\r
  @param PackageType  Package type of the notification.\r
\r
  @param PackageGuid  If PackageType is\r
                      EFI_HII_PACKAGE_TYPE_GUID, then this is\r
                      the pointer to the GUID from the Guid\r
                      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 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
                      EFI_HII_DATABASE_NOTIFY_TYPE.\r
\r
**/\r
typedef\r
EFI_STATUS\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
  IN        EFI_HII_HANDLE                 Handle,\r
  IN        EFI_HII_DATABASE_NOTIFY_TYPE  NotifyType\r
);\r
\r
/**\r
\r
  This function adds the packages in the package list to the\r
  database and returns a handle. If there is a\r
  EFI_DEVICE_PATH_PROTOCOL associated with the DriverHandle, then\r
  this function will create a package of type\r
  EFI_PACKAGE_TYPE_DEVICE_PATH and add it to the package list. For\r
  each package in the package list, registered functions with the\r
  notification type NEW_PACK and having the same package type will\r
  be called. For each call to NewPackageList(), there should be a\r
  corresponding call to\r
  EFI_HII_DATABASE_PROTOCOL.RemovePackageList().\r
\r
  @param This           A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
\r
  @param PackageList    A pointer to an EFI_HII_PACKAGE_LIST_HEADER structure.\r
\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
\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 is NULL.\r
\r
**/\r
typedef\r
EFI_STATUS\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
  OUT       EFI_HII_HANDLE               *Handle\r
);\r
\r
\r
/**\r
\r
  This function removes the package list that is associated with a\r
  handle Handle from the HII database. Before removing the\r
  package, any registered functions with the notification type\r
  REMOVE_PACK and the same package type will be called. For each\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 instance.\r
  \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_NOT_FOUND   The specified Handle is not in database.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HII_DATABASE_REMOVE_PACK)(\r
  IN CONST  EFI_HII_DATABASE_PROTOCOL *This,\r
  IN        EFI_HII_HANDLE             Handle\r
);\r
\r
\r
/**\r
   \r
  This function updates the existing package list (which has the\r
  specified Handle) in the HII databases, using the new package\r
  list specified by PackageList. The update process has the\r
  following steps: Collect all the package types in the package\r
  list specified by PackageList. A package type consists of the\r
  Type field of EFI_HII_PACKAGE_HEADER and, if the Type is\r
  EFI_HII_PACKAGE_TYPE_GUID, the Guid field, as defined in\r
  EFI_HII_PACKAGE_GUID_HEADER. Iterate through the packages within\r
  the existing package list in the HII database specified by\r
  Handle. If a package's type matches one of the collected types collected\r
  in step 1, then perform the following steps:\r
  - Call any functions registered with the notification type\r
  REMOVE_PACK.\r
  - Remove the package from the package list and the HII\r
  database.\r
  Add all of the packages within the new package list specified\r
  by PackageList, using the following steps:\r
  - Add the package to the package list and the HII database.\r
  - Call any functions registered with the notification type\r
  ADD_PACK.\r
\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
  \r
  @param PackageList  A pointer to an EFI_HII_PACKAGE_LIST\r
                      package.\r
  \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
  \r
  @retval EFI_INVALID_PARAMETER  PackageList was NULL.\r
  @retval EFI_NOT_FOUND          The specified Handle is not in database.\r
\r
**/\r
typedef\r
EFI_STATUS\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
);\r
\r
\r
/**\r
  \r
  This function returns a list of the package handles of the   \r
  specified type that are currently active in the database. The   \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 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
  \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 found.\r
\r
  @param Handle               An array of EFI_HII_HANDLE  instances returned.\r
\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
typedef\r
EFI_STATUS\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
);\r
\r
/**\r
\r
  This function will export one or all package lists in the\r
  database to a buffer. For each package list exported, this\r
  function will call functions registered with EXPORT_PACK and\r
  then copy the package list to the buffer. The registered\r
  functions may call EFI_HII_DATABASE_PROTOCOL.UpdatePackageList()\r
  to modify the package list before it is copied to the buffer. If\r
  the specified BufferSize is too small, then the status\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 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
\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
  \r
  \r
  @retval EFI_SUCCESS           Package exported.\r
  \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
  IN CONST  EFI_HII_DATABASE_PROTOCOL      *This,\r
  IN        EFI_HII_HANDLE                 Handle,\r
  IN OUT    UINTN                          *BufferSize,\r
  OUT       EFI_HII_PACKAGE_LIST_HEADER    *Buffer\r
);\r
\r
\r
/**\r
   \r
  \r
  This function registers a function which will be called when\r
  specified actions related to packages of the specified type\r
  occur in the HII database. By registering a function, other\r
  HII-related drivers are notified when specific package types\r
  are added, removed or updated in the HII database. Each driver\r
  or application which registers a notification should use\r
  EFI_HII_DATABASE_PROTOCOL.UnregisterPackageNotify() before\r
  exiting.\r
  \r
  \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
\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
\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
\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
\r
**/\r
typedef\r
EFI_STATUS\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
  IN        EFI_HII_DATABASE_NOTIFY       PackageNotifyFn,\r
  IN        EFI_HII_DATABASE_NOTIFY_TYPE  NotifyType,\r
  OUT       EFI_HANDLE                    *NotifyHandle\r
);\r
\r
\r
/**\r
   \r
  Removes the specified HII database package-related notification.\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 Successsfully\r
  \r
  @retval EFI_NOT_FOUND The incoming notification handle does not exist \r
                        in the current hii database.\r
  \r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_HII_DATABASE_UNREGISTER_NOTIFY)(\r
  IN CONST  EFI_HII_DATABASE_PROTOCOL *This,\r
  IN        EFI_HANDLE                NotificationHandle\r
);\r
\r
\r
/**\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
\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. \r
  \r
  @param KeyGuidBuffer        An array of keyboard layout GUID\r
                              instances returned.\r
\r
  @retval EFI_SUCCESS           KeyGuidBuffer was updated successfully.\r
  \r
  @retval EFI_BUFFER_TOO_SMALL  The KeyGuidBufferLength\r
                                parameter indicates that\r
                                KeyGuidBuffer is too small to\r
                                support the number of GUIDs.\r
                                KeyGuidBufferLength is updated\r
                                with a value that will enable\r
                                the data to fit.\r
\r
**/\r
typedef\r
EFI_STATUS\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
);\r
\r
\r
/**\r
   \r
  This routine retrieves the requested keyboard layout. The layout\r
  is a physical description of the keys on a keyboard and the\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
  \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.\r
  \r
  @retval EFI_SUCCESS   The keyboard layout was retrieved\r
                        successfully.\r
  \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
  IN CONST  EFI_HII_DATABASE_PROTOCOL *This,\r
  IN CONST  EFI_GUID                  *KeyGuid,\r
  IN OUT UINT16                        *KeyboardLayoutLength,\r
  OUT       EFI_HII_KEYBOARD_LAYOUT   *KeyboardLayout\r
);\r
\r
/**\r
   \r
  This routine sets the default keyboard layout to the one\r
  referenced by KeyGuid. When this routine is called, an event\r
  will be signaled of the EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID\r
  group type. This is so that agents which are sensitive to the\r
  current keyboard layout being changed can be notified of this\r
  change.\r
\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
\r
  @retval EFI_SUCCESS    The current keyboard layout was successfully set.\r
\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
  IN CONST  EFI_HII_DATABASE_PROTOCOL *This,\r
  IN CONST  EFI_GUID                  *KeyGuid\r
);\r
\r
/**\r
   \r
  Return the EFI handle associated with a package list.\r
  \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
  \r
  @retval EFI_SUCCESS            The DriverHandle was returned successfully.\r
  \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
  IN CONST  EFI_HII_DATABASE_PROTOCOL *This,\r
  IN        EFI_HII_HANDLE             PackageListHandle,\r
  OUT       EFI_HANDLE                *DriverHandle\r
);\r
\r
///\r
/// Database manager for HII-related data structures.\r
///\r
struct _EFI_HII_DATABASE_PROTOCOL {\r
  EFI_HII_DATABASE_NEW_PACK           NewPackageList;\r
  EFI_HII_DATABASE_REMOVE_PACK        RemovePackageList;\r
  EFI_HII_DATABASE_UPDATE_PACK        UpdatePackageList;\r
  EFI_HII_DATABASE_LIST_PACKS         ListPackageLists;\r
  EFI_HII_DATABASE_EXPORT_PACKS       ExportPackageLists;\r
  EFI_HII_DATABASE_REGISTER_NOTIFY    RegisterPackageNotify;\r
  EFI_HII_DATABASE_UNREGISTER_NOTIFY  UnregisterPackageNotify;\r
  EFI_HII_FIND_KEYBOARD_LAYOUTS       FindKeyboardLayouts;\r
  EFI_HII_GET_KEYBOARD_LAYOUT         GetKeyboardLayout;\r
  EFI_HII_SET_KEYBOARD_LAYOUT         SetKeyboardLayout;\r
  EFI_HII_DATABASE_GET_PACK_HANDLE    GetPackageListHandle;\r
};\r
\r
extern EFI_GUID gEfiHiiDatabaseProtocolGuid;\r
\r
#endif\r
\r
\r