Formalize comments for Protocols and PPIs.

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

/** @file\r
  This protocol is defined in UEFI spec.\r
  \r
  The EFI_FORM_BROWSER2_PROTOCOL is the interface to call for drivers to \r
  leverage the EFI configuration driver interface.\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 __EFI_FORM_BROWSER2_H__\r
#define __EFI_FORM_BROWSER2_H__\r
\r
#define EFI_FORM_BROWSER2_PROTOCOL_GUID \\r
  {0xb9d4c360, 0xbcfb, 0x4f9b, {0x92, 0x98, 0x53, 0xc1, 0x36, 0x98, 0x22, 0x58 }}\r
\r
\r
typedef struct _EFI_FORM_BROWSER2_PROTOCOL   EFI_FORM_BROWSER2_PROTOCOL;\r
\r
\r
\r
/**\r
   \r
  @param LeftColumn   Value that designates the text column\r
                      where the browser window will begin from\r
                      the left-hand side of the screen\r
                      \r
  @param RightColumn  Value that designates the text\r
                      column where the browser window will end\r
                      on the right-hand side of the screen.\r
\r
  @param TopRow       Value that designates the text row from the\r
                      top of the screen where the browser window\r
                      will start.\r
\r
  @param BottomRow    Value that designates the text row from the\r
                      bottom of the screen where the browser\r
                      window will end. \r
**/\r
typedef struct {\r
  UINTN   LeftColumn;\r
  UINTN   RightColumn;\r
  UINTN   TopRow;\r
  UINTN   BottomRow;\r
} EFI_SCREEN_DESCRIPTOR;\r
\r
typedef UINTN EFI_BROWSER_ACTION_REQUEST;\r
\r
#define EFI_BROWSER_ACTION_REQUEST_NONE   0\r
#define EFI_BROWSER_ACTION_REQUEST_RESET  1\r
#define EFI_BROWSER_ACTION_REQUEST_SUBMIT 2\r
#define EFI_BROWSER_ACTION_REQUEST_EXIT   3\r
\r
\r
/**\r
  Initialize the browser to display the specified configuration forms.\r
\r
  This function is the primary interface to the internal forms-based browser. \r
  The forms browser will display forms associated with the specified Handles. \r
  The browser will select all forms in packages which have the specified Type \r
  and (for EFI_HII_PACKAGE_TYPE_GUID) the specified PackageGuid.\r
\r
  @param This            A pointer to the EFI_FORM_BROWSER2_PROTOCOL instance\r
\r
  @param Handles         A pointer to an array of Handles. This value should correspond \r
                         to the value of the HII form package that is required to be displayed.\r
\r
  @param HandleCount     The number of Handles specified in Handle.\r
\r
  @param FormSetGuid     This field points to the EFI_GUID which must match the Guid\r
                         field in the EFI_IFR_FORM_SET op-code for the specified\r
                         forms-based package. If FormSetGuid is NULL, then this\r
                         function will display the first found forms package.\r
\r
  @param FormId          This field specifies which EFI_IFR_FORM to render as the first\r
                         displayable page. If this field has a value of 0x0000, then\r
                         the forms browser will render the specified forms in their encoded order.\r
\r
  @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in \r
                          characters.\r
\r
  @param ActionRequest   Points to the action recommended by the form.\r
\r
  @retval EFI_SUCCESS           The function completed successfully\r
  \r
  @retval EFI_NOT_FOUND         The variable was not found.\r
  \r
  @retval EFI_INVALID_PARAMETER One of the parameters has an\r
                                invalid value.  \r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_SEND_FORM2)(\r
  IN CONST  EFI_FORM_BROWSER2_PROTOCOL  *This,\r
  IN        EFI_HII_HANDLE              *Handle,\r
  IN        UINTN                      HandleCount,\r
  IN        EFI_GUID                   *FormSetGuid, OPTIONAL\r
  IN        EFI_FORM_ID                FormId, OPTIONAL\r
  IN CONST  EFI_SCREEN_DESCRIPTOR      *ScreenDimensions, OPTIONAL\r
  OUT       EFI_BROWSER_ACTION_REQUEST *ActionRequest  OPTIONAL\r
);\r
\r
\r
/**\r
  This function is called by a callback handler to retrieve uncommitted state data from the browser.\r
\r
  This routine is called by a routine which was called by the\r
  browser. This routine called this service in the browser to\r
  retrieve or set certain uncommitted state information.\r
\r
  @param This           A pointer to the EFI_FORM_BROWSER2_PROTOCOL instance.\r
\r
  @param ResultsDataSize  A pointer to the size of the buffer\r
                          associated with ResultsData. On input, the size in\r
                          bytes of ResultsData. On output, the size of data returned in ResultsData.\r
\r
  @param ResultsData    A string returned from an IFR browser or\r
                        equivalent. The results string will have\r
                        no routing information in them.\r
\r
  @param RetrieveData   A BOOLEAN field which allows an agent to\r
                        retrieve (if RetrieveData = TRUE) data\r
                        from the uncommitted browser state\r
                        information or set (if RetrieveData =\r
                        FALSE) data in the uncommitted browser\r
                        state information.\r
\r
  @param VariableGuid   An optional field to indicate the target\r
                        variable GUID name to use.\r
\r
  @param VariableName   An optional field to indicate the target\r
                        human-readable variable name.\r
\r
  @retval EFI_SUCCESS           The results have been distributed or are\r
                                awaiting distribution.\r
  \r
  @retval EFI_OUT_OF_RESOURCES  The ResultsDataSize specified\r
                                was too small to contain the\r
                                results data.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_BROWSER_CALLBACK2)(\r
  IN CONST  EFI_FORM_BROWSER2_PROTOCOL *This,\r
  IN OUT    UINTN                     *ResultsDataSize,\r
  IN OUT    EFI_STRING                ResultsData,\r
  IN CONST  BOOLEAN                   RetrieveData,\r
  IN CONST  EFI_GUID                  *VariableGuid, OPTIONAL\r
  IN CONST  CHAR16                    *VariableName OPTIONAL\r
);\r
\r
///\r
/// This interface will allow the caller to direct the configuration \r
/// driver to use either the HII database or use the passed-in packet of data.\r
///\r
struct _EFI_FORM_BROWSER2_PROTOCOL {\r
  EFI_SEND_FORM2         SendForm;\r
  EFI_BROWSER_CALLBACK2  BrowserCallback;\r
} ;\r
\r
extern EFI_GUID gEfiFormBrowser2ProtocolGuid;\r
\r
#endif\r
\r