1) Add Doxygen Comments

[mirror_edk2.git] / EdkCompatibilityPkg / Compatibility / FrameworkHiiToUefiHiiThunk / ConfigAccess.h

/**@file\r
  This file contains functions related to Config Access Protocols installed by\r
  by HII Thunk Modules which is used to thunk UEFI Config Access Callback to \r
  Framework HII Callback.\r
  \r
Copyright (c) 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_THUNK_CONFIG_ACCESS_H\r
#define _HII_THUNK_CONFIG_ACCESS_H\r
\r
/**\r
  This function installs a EFI_CONFIG_ACCESS_PROTOCOL instance for a form package registered\r
  by a module using Framework HII Protocol Interfaces.\r
\r
   UEFI HII require EFI_HII_CONFIG_ACCESS_PROTOCOL to be installed on a EFI_HANDLE, so\r
   that Setup Utility can load the Buffer Storage using this protocol.\r
   \r
   @param Packages          The framework package list.\r
   @param MapEntry          The Thunk Layer Handle Mapping Database Entry.\r
   \r
   @retval  EFI_SUCCESS             The Config Access Protocol is installed successfully.\r
   @retval  EFI_OUT_RESOURCE    There is not enough memory.\r
   \r
**/\r
EFI_STATUS\r
InstallDefaultUefiConfigAccessProtocol (\r
  IN  CONST EFI_HII_PACKAGES                         *Packages,\r
  IN  OUT   HII_TRHUNK_HANDLE_MAPPING_DATABASE_ENTRY *MapEntry\r
  )\r
;\r
\r
/**\r
\r
  This function implement the EFI_HII_CONFIG_ACCESS_PROTOCOL.ExtractConfig\r
  so that data can be read from the data storage such as UEFI Variable or module's\r
  customized storage exposed by EFI_FRAMEWORK_CALLBACK.\r
\r
   @param This          Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL\r
   @param Request     A null-terminated Unicode string in <ConfigRequest> format. Note that this\r
                                includes the routing information as well as the configurable name / value pairs. It is\r
                                invalid for this string to be in <MultiConfigRequest> format.\r
\r