[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 - 2010, 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
  Note: inconsistency with UEFI 2.3 spec that the parameter DriverHandle\r
  is optional.\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
                        If a NULL is specified, this data will not be associate\r
                        with any drivers and cannot have a callback induced.\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, OPTIONAL\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
Commit	Line	Data
d1f95000	1	/** @file\r
	2	The file provides Database manager for HII-related data\r
	3	structures.\r
	4	\r
8c6d73fb	5	Copyright (c) 2006 - 2010, Intel Corporation\r
d1f95000	6	All rights reserved. This program and the accompanying materials \r
	7	are licensed and made available under the terms and conditions of the BSD License \r
	8	which accompanies this distribution. The full text of the license may be found at \r
	9	http://opensource.org/licenses/bsd-license.php \r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	13	\r
d1f95000	14	**/\r
	15	\r
	16	#ifndef __HII_DATABASE_H__\r
	17	#define __HII_DATABASE_H__\r
	18	\r
	19	#define EFI_HII_DATABASE_PROTOCOL_GUID \\r
	20	{ 0xef9fc172, 0xa1b2, 0x4693, { 0xb3, 0x27, 0x6d, 0x32, 0xfc, 0x41, 0x60, 0x42 } }\r
	21	\r
	22	\r
	23	typedef struct _EFI_HII_DATABASE_PROTOCOL EFI_HII_DATABASE_PROTOCOL;\r
	24	\r
d1f95000	25	\r
721b16af	26	///\r
	27	/// EFI_HII_DATABASE_NOTIFY_TYPE\r
	28	/// \r
d1f95000	29	typedef UINTN EFI_HII_DATABASE_NOTIFY_TYPE;\r
721b16af	30	\r
d1f95000	31	#define EFI_HII_DATABASE_NOTIFY_NEW_PACK 0x00000001\r
	32	#define EFI_HII_DATABASE_NOTIFY_REMOVE_PACK 0x00000002\r
	33	#define EFI_HII_DATABASE_NOTIFY_EXPORT_PACK 0x00000004\r
	34	#define EFI_HII_DATABASE_NOTIFY_ADD_PACK 0x00000008\r
	35	/**\r
	36	\r
	37	Functions which are registered to receive notification of\r
	38	database events have this prototype. The actual event is encoded\r
	39	in NotifyType. The following table describes how PackageType,\r
	40	PackageGuid, Handle, and Package are used for each of the\r
	41	notification types.\r
	42	\r
	43	@param PackageType Package type of the notification.\r
	44	\r
	45	@param PackageGuid If PackageType is\r
	46	EFI_HII_PACKAGE_TYPE_GUID, then this is\r
	47	the pointer to the GUID from the Guid\r
	48	field of EFI_HII_PACKAGE_GUID_HEADER.\r
	49	Otherwise, it must be NULL.\r
	50	\r
4ca9b6c4 LG	51	@param Package Points to the package referred to by the notification. \r
	52	\r
	53	@param Handle The handle of the package\r
	54	list which contains the specified package.\r
d1f95000	55	\r
	56	@param NotifyType The type of change concerning the\r
	57	database. See\r
	58	EFI_HII_DATABASE_NOTIFY_TYPE.\r
	59	\r
	60	**/\r
	61	typedef\r
	62	EFI_STATUS\r
8b13229b	63	(EFIAPI *EFI_HII_DATABASE_NOTIFY)(\r
7d582d6b	64	IN UINT8 PackageType,\r
d1f95000	65	IN CONST EFI_GUID *PackageGuid,\r
d1f95000	66	IN CONST EFI_HII_PACKAGE_HEADER *Package,\r
7d582d6b	67	IN EFI_HII_HANDLE Handle,\r
7d582d6b	68	IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType\r
d1f95000	69	);\r
	70	\r
	71	/**\r
	72	\r
	73	This function adds the packages in the package list to the\r
	74	database and returns a handle. If there is a\r
	75	EFI_DEVICE_PATH_PROTOCOL associated with the DriverHandle, then\r
	76	this function will create a package of type\r
	77	EFI_PACKAGE_TYPE_DEVICE_PATH and add it to the package list. For\r
	78	each package in the package list, registered functions with the\r
	79	notification type NEW_PACK and having the same package type will\r
	80	be called. For each call to NewPackageList(), there should be a\r
	81	corresponding call to\r
	82	EFI_HII_DATABASE_PROTOCOL.RemovePackageList().\r
	83	\r
8c6d73fb	84	Note: inconsistency with UEFI 2.3 spec that the parameter DriverHandle\r
	85	is optional.\r
	86	\r
4ca9b6c4	87	@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
d1f95000	88	\r
4ca9b6c4	89	@param PackageList A pointer to an EFI_HII_PACKAGE_LIST_HEADER structure.\r
d1f95000	90	\r
4ca9b6c4	91	@param DriverHandle Associate the package list with this EFI handle.\r
8c6d73fb	92	If a NULL is specified, this data will not be associate\r
8c6d73fb	93	with any drivers and cannot have a callback induced.\r
4ca9b6c4 LG	94	\r
4ca9b6c4 LG	95	@param Handle A pointer to the EFI_HII_HANDLE instance.\r
d1f95000	96	\r
4ca9b6c4 LG	97	@retval EFI_SUCCESS The package list associated with the\r
4ca9b6c4 LG	98	Handle was added to the HII database.\r
d1f95000	99	\r
	100	@retval EFI_OUT_OF_RESOURCES Unable to allocate necessary\r
	101	resources for the new database\r
	102	contents.\r
	103	\r
4ca9b6c4	104	@retval EFI_INVALID_PARAMETER PackageList is NULL or Handle is NULL.\r
d1f95000	105	\r
	106	**/\r
	107	typedef\r
	108	EFI_STATUS\r
8b13229b	109	(EFIAPI *EFI_HII_DATABASE_NEW_PACK)(\r
d1f95000	110	IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
d1f95000	111	IN CONST EFI_HII_PACKAGE_LIST_HEADER *PackageList,\r
8c6d73fb	112	IN EFI_HANDLE DriverHandle, OPTIONAL\r
7d582d6b	113	OUT EFI_HII_HANDLE *Handle\r
d1f95000	114	);\r
	115	\r
	116	\r
	117	/**\r
	118	\r
	119	This function removes the package list that is associated with a\r
	120	handle Handle from the HII database. Before removing the\r
	121	package, any registered functions with the notification type\r
	122	REMOVE_PACK and the same package type will be called. For each\r
	123	call to EFI_HII_DATABASE_PROTOCOL.NewPackageList(), there should\r
	124	be a corresponding call to RemovePackageList.\r
	125	\r
4ca9b6c4	126	@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
d1f95000	127	\r
4ca9b6c4 LG	128	@param Handle The handle that was registered to the data\r
4ca9b6c4 LG	129	that is requested for removal.\r
d1f95000	130	\r
4ca9b6c4 LG	131	@retval EFI_SUCCESS The data associated with the Handle was\r
4ca9b6c4 LG	132	removed from the HII database.\r
54cf8780	133	@retval EFI_NOT_FOUND The specified Handle is not in database.\r
d1f95000	134	\r
	135	**/\r
	136	typedef\r
	137	EFI_STATUS\r
8b13229b	138	(EFIAPI *EFI_HII_DATABASE_REMOVE_PACK)(\r
d1f95000	139	IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
7d582d6b	140	IN EFI_HII_HANDLE Handle\r
d1f95000	141	);\r
	142	\r
	143	\r
	144	/**\r
	145	\r
	146	This function updates the existing package list (which has the\r
	147	specified Handle) in the HII databases, using the new package\r
	148	list specified by PackageList. The update process has the\r
	149	following steps: Collect all the package types in the package\r
	150	list specified by PackageList. A package type consists of the\r
	151	Type field of EFI_HII_PACKAGE_HEADER and, if the Type is\r
	152	EFI_HII_PACKAGE_TYPE_GUID, the Guid field, as defined in\r
	153	EFI_HII_PACKAGE_GUID_HEADER. Iterate through the packages within\r
	154	the existing package list in the HII database specified by\r
f754f721	155	Handle. If a package's type matches one of the collected types collected\r
f754f721	156	in step 1, then perform the following steps:\r
d1f95000	157	- Call any functions registered with the notification type\r
	158	REMOVE_PACK.\r
	159	- Remove the package from the package list and the HII\r
	160	database.\r
	161	Add all of the packages within the new package list specified\r
	162	by PackageList, using the following steps:\r
	163	- Add the package to the package list and the HII database.\r
	164	- Call any functions registered with the notification type\r
	165	ADD_PACK.\r
	166	\r
4ca9b6c4	167	@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
d1f95000	168	\r
4ca9b6c4 LG	169	@param Handle The handle that was registered to the data\r
4ca9b6c4 LG	170	that is requested for removal.\r
d1f95000	171	\r
	172	@param PackageList A pointer to an EFI_HII_PACKAGE_LIST\r
	173	package.\r
	174	\r
4ca9b6c4	175	@retval EFI_SUCCESS The HII database was successfully updated.\r
d1f95000	176	\r
4ca9b6c4 LG	177	@retval EFI_OUT_OF_RESOURCES Unable to allocate enough memory\r
4ca9b6c4 LG	178	for the updated database.\r
d1f95000	179	\r
54cf8780	180	@retval EFI_INVALID_PARAMETER PackageList was NULL.\r
54cf8780	181	@retval EFI_NOT_FOUND The specified Handle is not in database.\r
d1f95000	182	\r
	183	**/\r
	184	typedef\r
	185	EFI_STATUS\r
8b13229b	186	(EFIAPI *EFI_HII_DATABASE_UPDATE_PACK)(\r
d1f95000	187	IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
7d582d6b	188	IN EFI_HII_HANDLE Handle,\r
d1f95000	189	IN CONST EFI_HII_PACKAGE_LIST_HEADER *PackageList\r
	190	);\r
	191	\r
	192	\r
	193	/**\r
	194	\r
	195	This function returns a list of the package handles of the \r
	196	specified type that are currently active in the database. The \r
	197	pseudo-type EFI_HII_PACKAGE_TYPE_ALL will cause all package \r
	198	handles to be listed.\r
	199	\r
4ca9b6c4	200	@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
d1f95000	201	\r
4ca9b6c4 LG	202	@param PackageType Specifies the package type of the packages\r
	203	to list or EFI_HII_PACKAGE_TYPE_ALL for\r
	204	all packages to be listed.\r
d1f95000	205	\r
4ca9b6c4 LG	206	@param PackageGuid If PackageType is\r
	207	EFI_HII_PACKAGE_TYPE_GUID, then this is\r
	208	the pointer to the GUID which must match\r
	209	the Guid field of\r
	210	EFI_HII_PACKAGE_GUID_HEADER. Otherwise, it\r
	211	must be NULL.\r
d1f95000	212	\r
	213	@param HandleBufferLength On input, a pointer to the length\r
	214	of the handle buffer. On output,\r
	215	the length of the handle buffer\r
4ca9b6c4	216	that is required for the handles found.\r
d1f95000	217	\r
4ca9b6c4	218	@param Handle An array of EFI_HII_HANDLE instances returned.\r
d1f95000	219	\r
4ca9b6c4 LG	220	@retval EFI_SUCCESS The matching handles are outputed successfully.\r
	221	HandleBufferLength is updated with the actual length.\r
	222	@retval EFI_BUFFER_TOO_SMALL The HandleBufferLength parameter\r
d1f95000	223	indicates that Handle is too\r
	224	small to support the number of\r
	225	handles. HandleBufferLength is\r
	226	updated with a value that will\r
	227	enable the data to fit.\r
4ca9b6c4 LG	228	@retval EFI_NOT_FOUND No matching handle could not be found in database.\r
	229	@retval EFI_INVALID_PARAMETER Handle or HandleBufferLength was NULL.\r
	230	@retval EFI_INVALID_PARAMETER PackageType is not a EFI_HII_PACKAGE_TYPE_GUID but\r
	231	PackageGuid is not NULL, PackageType is a EFI_HII_\r
	232	PACKAGE_TYPE_GUID but PackageGuid is NULL.\r
d1f95000	233	**/\r
	234	typedef\r
	235	EFI_STATUS\r
8b13229b	236	(EFIAPI *EFI_HII_DATABASE_LIST_PACKS)(\r
d1f95000	237	IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
7d582d6b	238	IN UINT8 PackageType,\r
d1f95000	239	IN CONST EFI_GUID *PackageGuid,\r
d1f95000	240	IN OUT UINTN *HandleBufferLength,\r
4ca9b6c4	241	OUT EFI_HII_HANDLE *Handle\r
d1f95000	242	);\r
d1f95000	243	\r
d1f95000	244	/**\r
	245	\r
	246	This function will export one or all package lists in the\r
	247	database to a buffer. For each package list exported, this\r
	248	function will call functions registered with EXPORT_PACK and\r
	249	then copy the package list to the buffer. The registered\r
	250	functions may call EFI_HII_DATABASE_PROTOCOL.UpdatePackageList()\r
	251	to modify the package list before it is copied to the buffer. If\r
	252	the specified BufferSize is too small, then the status\r
	253	EFI_OUT_OF_RESOURCES will be returned and the actual package\r
	254	size will be returned in BufferSize.\r
	255	\r
4ca9b6c4 LG	256	@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
4ca9b6c4 LG	257	\r
d1f95000	258	\r
4ca9b6c4 LG	259	@param Handle An EFI_HII_HANDLE that corresponds to the\r
	260	desired package list in the HII database to\r
	261	export or NULL to indicate all package lists\r
	262	should be exported. \r
d1f95000	263	\r
	264	@param BufferSize On input, a pointer to the length of the\r
	265	buffer. On output, the length of the\r
	266	buffer that is required for the exported\r
	267	data.\r
	268	\r
4ca9b6c4 LG	269	@param Buffer A pointer to a buffer that will contain the\r
4ca9b6c4 LG	270	results of the export function.\r
d1f95000	271	\r
d1f95000	272	\r
4ca9b6c4	273	@retval EFI_SUCCESS Package exported.\r
d1f95000	274	\r
4ca9b6c4	275	@retval EFI_OUT_OF_RESOURCES BufferSize is too small to hold the package.\r
d1f95000	276	\r
	277	**/\r
	278	typedef\r
	279	EFI_STATUS\r
8b13229b	280	(EFIAPI *EFI_HII_DATABASE_EXPORT_PACKS)(\r
7d582d6b	281	IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
	282	IN EFI_HII_HANDLE Handle,\r
	283	IN OUT UINTN *BufferSize,\r
	284	OUT EFI_HII_PACKAGE_LIST_HEADER *Buffer\r
d1f95000	285	);\r
	286	\r
	287	\r
	288	/**\r
	289	\r
	290	\r
	291	This function registers a function which will be called when\r
	292	specified actions related to packages of the specified type\r
	293	occur in the HII database. By registering a function, other\r
	294	HII-related drivers are notified when specific package types\r
	295	are added, removed or updated in the HII database. Each driver\r
	296	or application which registers a notification should use\r
	297	EFI_HII_DATABASE_PROTOCOL.UnregisterPackageNotify() before\r
	298	exiting.\r
	299	\r
	300	\r
4ca9b6c4	301	@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
d1f95000	302	\r
4ca9b6c4 LG	303	@param PackageType The package type. See\r
4ca9b6c4 LG	304	EFI_HII_PACKAGE_TYPE_x in EFI_HII_PACKAGE_HEADER. \r
d1f95000	305	\r
4ca9b6c4 LG	306	@param PackageGuid If PackageType is\r
	307	EFI_HII_PACKAGE_TYPE_GUID, then this is\r
	308	the pointer to the GUID which must match\r
	309	the Guid field of\r
	310	EFI_HII_PACKAGE_GUID_HEADER. Otherwise, it\r
	311	must be NULL.\r
d1f95000	312	\r
	313	@param PackageNotifyFn Points to the function to be called\r
	314	when the event specified by\r
	315	NotificationType occurs. See\r
	316	EFI_HII_DATABASE_NOTIFY.\r
	317	\r
4ca9b6c4 LG	318	@param NotifyType Describes the types of notification which\r
	319	this function will be receiving. See\r
	320	EFI_HII_DATABASE_NOTIFY_TYPE for more a\r
	321	list of types.\r
d1f95000	322	\r
4ca9b6c4 LG	323	@param NotifyHandle Points to the unique handle assigned to\r
	324	the registered notification. Can be used\r
	325	in EFI_HII_DATABASE_PROTOCOL.UnregisterPack\r
	326	to stop notifications.\r
d1f95000	327	\r
d1f95000	328	\r
4ca9b6c4	329	@retval EFI_SUCCESS Notification registered successfully.\r
d1f95000	330	\r
	331	@retval EFI_OUT_OF_RESOURCES Unable to allocate necessary\r
	332	data structures.\r
	333	\r
4ca9b6c4 LG	334	@retval EFI_INVALID_PARAMETER PackageGuid is not NULL when\r
	335	PackageType is not\r
	336	EFI_HII_PACKAGE_TYPE_GUID.\r
d1f95000	337	\r
	338	**/\r
	339	typedef\r
	340	EFI_STATUS\r
8b13229b	341	(EFIAPI *EFI_HII_DATABASE_REGISTER_NOTIFY)(\r
d1f95000	342	IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
7d582d6b	343	IN UINT8 PackageType,\r
d1f95000	344	IN CONST EFI_GUID *PackageGuid,\r
7d582d6b	345	IN EFI_HII_DATABASE_NOTIFY PackageNotifyFn,\r
7d582d6b	346	IN EFI_HII_DATABASE_NOTIFY_TYPE NotifyType,\r
d1f95000	347	OUT EFI_HANDLE *NotifyHandle\r
	348	);\r
	349	\r
	350	\r
	351	/**\r
	352	\r
	353	Removes the specified HII database package-related notification.\r
	354	\r
4ca9b6c4 LG	355	@param This A pointer to the EFI_HII_DATABASE_PROTOCOL instance.\r
4ca9b6c4 LG	356	\r
d1f95000	357	@param NotificationHandle The handle of the notification\r
	358	function being unregistered.\r
	359	\r
4ca9b6c4	360	@retval EFI_SUCCESS Unregister the notification Successsfully\r
d1f95000	361	\r
54cf8780	362	@retval EFI_NOT_FOUND The incoming notification handle does not exist \r
630b4187	363	in the current hii database.\r
54cf8780	364	\r
d1f95000	365	**/\r
	366	typedef\r
	367	EFI_STATUS\r
8b13229b	368	(EFIAPI *EFI_HII_DATABASE_UNREGISTER_NOTIFY)(\r
d1f95000	369	IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
7d582d6b	370	IN EFI_HANDLE NotificationHandle\r
d1f95000	371	);\r
	372	\r
	373	\r
d1f95000	374	/**\r
	375	\r
	376	This routine retrieves an array of GUID values for each keyboard\r
	377	layout that was previously registered in the system.\r
	378	\r
4ca9b6c4	379	@param This A pointer to the EFI_HII_PROTOCOL instance.\r
d1f95000	380	\r
	381	@param KeyGuidBufferLength On input, a pointer to the length\r
	382	of the keyboard GUID buffer. On\r
	383	output, the length of the handle\r
	384	buffer that is required for the\r
4ca9b6c4 LG	385	handles found. \r
	386	\r
	387	@param KeyGuidBuffer An array of keyboard layout GUID\r
d1f95000	388	instances returned.\r
d1f95000	389	\r
4ca9b6c4	390	@retval EFI_SUCCESS KeyGuidBuffer was updated successfully.\r
d1f95000	391	\r
	392	@retval EFI_BUFFER_TOO_SMALL The KeyGuidBufferLength\r
	393	parameter indicates that\r
	394	KeyGuidBuffer is too small to\r
	395	support the number of GUIDs.\r
	396	KeyGuidBufferLength is updated\r
	397	with a value that will enable\r
	398	the data to fit.\r
	399	\r
	400	**/\r
	401	typedef\r
	402	EFI_STATUS\r
8b13229b	403	(EFIAPI *EFI_HII_FIND_KEYBOARD_LAYOUTS)(\r
d1f95000	404	IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
	405	IN OUT UINT16 *KeyGuidBufferLength,\r
	406	OUT EFI_GUID *KeyGuidBuffer\r
	407	);\r
	408	\r
	409	\r
	410	/**\r
	411	\r
	412	This routine retrieves the requested keyboard layout. The layout\r
	413	is a physical description of the keys on a keyboard and the\r
	414	character(s) that are associated with a particular set of key\r
	415	strokes.\r
	416	\r
4ca9b6c4	417	@param This A pointer to the EFI_HII_PROTOCOL instance.\r
d1f95000	418	\r
4ca9b6c4 LG	419	@param KeyGuid A pointer to the unique ID associated with a\r
	420	given keyboard layout. If KeyGuid is NULL then\r
	421	the current layout will be retrieved.\r
	422	\r
	423	@param KeyboardLayoutLength On input, a pointer to the length of the\r
	424	KeyboardLayout buffer. On output, the length of\r
	425	the data placed into KeyboardLayout.\r
d1f95000	426	\r
4ca9b6c4 LG	427	@param KeyboardLayout A pointer to a buffer containing the\r
4ca9b6c4 LG	428	retrieved keyboard layout.\r
d1f95000	429	\r
	430	@retval EFI_SUCCESS The keyboard layout was retrieved\r
	431	successfully.\r
	432	\r
4ca9b6c4	433	@retval EFI_NOT_FOUND The requested keyboard layout was not found.\r
d1f95000	434	\r
	435	**/\r
	436	typedef\r
	437	EFI_STATUS\r
8b13229b	438	(EFIAPI *EFI_HII_GET_KEYBOARD_LAYOUT)(\r
d1f95000	439	IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
d1f95000	440	IN CONST EFI_GUID *KeyGuid,\r
f620c889	441	IN OUT UINT16 *KeyboardLayoutLength,\r
d1f95000	442	OUT EFI_HII_KEYBOARD_LAYOUT *KeyboardLayout\r
	443	);\r
	444	\r
	445	/**\r
	446	\r
	447	This routine sets the default keyboard layout to the one\r
	448	referenced by KeyGuid. When this routine is called, an event\r
	449	will be signaled of the EFI_HII_SET_KEYBOARD_LAYOUT_EVENT_GUID\r
	450	group type. This is so that agents which are sensitive to the\r
	451	current keyboard layout being changed can be notified of this\r
	452	change.\r
	453	\r
4ca9b6c4	454	@param This A pointer to the EFI_HII_PROTOCOL instance.\r
d1f95000	455	\r
4ca9b6c4 LG	456	@param KeyGuid A pointer to the unique ID associated with a\r
4ca9b6c4 LG	457	given keyboard layout.\r
d1f95000	458	\r
4ca9b6c4	459	@retval EFI_SUCCESS The current keyboard layout was successfully set.\r
d1f95000	460	\r
4ca9b6c4 LG	461	@retval EFI_NOT_FOUND The referenced keyboard layout was not\r
4ca9b6c4 LG	462	found, so action was taken.\r
d1f95000	463	\r
	464	**/\r
	465	typedef\r
	466	EFI_STATUS\r
8b13229b	467	(EFIAPI *EFI_HII_SET_KEYBOARD_LAYOUT)(\r
d1f95000	468	IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
	469	IN CONST EFI_GUID *KeyGuid\r
	470	);\r
	471	\r
	472	/**\r
	473	\r
	474	Return the EFI handle associated with a package list.\r
	475	\r
4ca9b6c4	476	@param This A pointer to the EFI_HII_PROTOCOL instance.\r
d1f95000	477	\r
7d582d6b	478	@param PackageListHandle An EFI_HII_HANDLE that corresponds\r
d1f95000	479	to the desired package list in the\r
	480	HIIdatabase.\r
	481	\r
4ca9b6c4 LG	482	@param DriverHandle On return, contains the EFI_HANDLE which\r
	483	was registered with the package list in\r
	484	NewPackageList().\r
d1f95000	485	\r
4ca9b6c4	486	@retval EFI_SUCCESS The DriverHandle was returned successfully.\r
d1f95000	487	\r
4ca9b6c4	488	@retval EFI_INVALID_PARAMETER The PackageListHandle was not valid.\r
d1f95000	489	\r
	490	**/\r
	491	typedef\r
	492	EFI_STATUS\r
8b13229b	493	(EFIAPI *EFI_HII_DATABASE_GET_PACK_HANDLE)(\r
d1f95000	494	IN CONST EFI_HII_DATABASE_PROTOCOL *This,\r
7d582d6b	495	IN EFI_HII_HANDLE PackageListHandle,\r
d1f95000	496	OUT EFI_HANDLE *DriverHandle\r
	497	);\r
	498	\r
44717a39	499	///\r
	500	/// Database manager for HII-related data structures.\r
	501	///\r
d1f95000	502	struct _EFI_HII_DATABASE_PROTOCOL {\r
721b16af	503	EFI_HII_DATABASE_NEW_PACK NewPackageList;\r
721b16af	504	EFI_HII_DATABASE_REMOVE_PACK RemovePackageList;\r
7d582d6b	505	EFI_HII_DATABASE_UPDATE_PACK UpdatePackageList;\r
	506	EFI_HII_DATABASE_LIST_PACKS ListPackageLists;\r
	507	EFI_HII_DATABASE_EXPORT_PACKS ExportPackageLists;\r
	508	EFI_HII_DATABASE_REGISTER_NOTIFY RegisterPackageNotify;\r
	509	EFI_HII_DATABASE_UNREGISTER_NOTIFY UnregisterPackageNotify;\r
	510	EFI_HII_FIND_KEYBOARD_LAYOUTS FindKeyboardLayouts;\r
	511	EFI_HII_GET_KEYBOARD_LAYOUT GetKeyboardLayout;\r
	512	EFI_HII_SET_KEYBOARD_LAYOUT SetKeyboardLayout;\r
	513	EFI_HII_DATABASE_GET_PACK_HANDLE GetPackageListHandle;\r
d1f95000	514	};\r
	515	\r
	516	extern EFI_GUID gEfiHiiDatabaseProtocolGuid;\r
	517	\r
	518	#endif\r
	519	\r
7d582d6b	520	\r