MdeModulePkg/Include/Protocol/FormBrowserEx2.h

   1 /** @file
   2   Extension Form Browser Protocol provides the services that can be used to
   3   register the different hot keys for the standard Browser actions described in UEFI specification.
   4
   5 Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>
   6 This program and the accompanying materials are licensed and made available under
   7 the terms and conditions of the BSD License that accompanies this distribution.
   8 The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php.
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __FORM_BROWSER_EXTENSION2_H__
  17 #define __FORM_BROWSER_EXTENSION2_H__
  18
  19 #include <Protocol/FormBrowserEx.h>
  20
  21 #define EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL_GUID  \
  22   { 0xa770c357, 0xb693, 0x4e6d, { 0xa6, 0xcf, 0xd2, 0x1c, 0x72, 0x8e, 0x55, 0xb }}
  23
  24 typedef struct _EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL   EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL;
  25
  26 #define BROWSER_EXTENSION2_VERSION_1  0x10000
  27
  28 /**
  29   Check whether the browser data has been modified.
  30
  31   @retval TRUE        Browser data is modified.
  32   @retval FALSE       No browser data is modified.
  33
  34 **/
  35 typedef
  36 BOOLEAN
  37 (EFIAPI *IS_BROWSER_DATA_MODIFIED) (
  38   VOID
  39   );
  40
  41 /**
  42   Execute the action requested by the Action parameter.
  43
  44   @param[in] Action     Execute the request action.
  45   @param[in] DefaultId  The default Id info when need to load default value.
  46
  47   @retval EFI_SUCCESS              Execute the request action succss.
  48
  49 **/
  50 typedef
  51 EFI_STATUS
  52 (EFIAPI *EXECUTE_ACTION) (
  53   IN UINT32        Action,
  54   IN UINT16        DefaultId
  55   );
  56
  57 #define FORM_ENTRY_INFO_SIGNATURE    SIGNATURE_32 ('f', 'e', 'i', 's')
  58
  59 typedef struct {
  60   UINTN           Signature;
  61   LIST_ENTRY      Link;
  62
  63   EFI_HII_HANDLE  HiiHandle;
  64   EFI_GUID        FormSetGuid;
  65   EFI_FORM_ID     FormId;
  66   EFI_QUESTION_ID QuestionId;
  67 } FORM_ENTRY_INFO;
  68
  69 #define FORM_ENTRY_INFO_FROM_LINK(a)  CR (a, FORM_ENTRY_INFO, Link, FORM_ENTRY_INFO_SIGNATURE)
  70
  71 #define FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE    SIGNATURE_32 ('f', 'q', 'o', 's')
  72
  73 typedef struct {
  74   UINTN            Signature;
  75   LIST_ENTRY       Link;
  76
  77   EFI_QUESTION_ID  QuestionId;           // Find the question
  78   EFI_FORM_ID      FormId;               // Find the form
  79   EFI_GUID         FormSetGuid;          // Find the formset.
  80   EFI_HII_HANDLE   HiiHandle;            // Find the HII handle
  81   UINT32           Attribute;            // Hide or grayout ...
  82 } QUESTION_ATTRIBUTE_OVERRIDE;
  83
  84 #define FORM_QUESTION_ATTRIBUTE_OVERRIDE_FROM_LINK(a)  CR (a, QUESTION_ATTRIBUTE_OVERRIDE, Link, FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE)
  85
  86 struct _EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL {
  87   ///
  88   /// Version for protocol future extension.
  89   ///
  90   UINT32                    Version;
  91   SET_SCOPE                 SetScope;
  92   REGISTER_HOT_KEY          RegisterHotKey;
  93   REGISTER_EXIT_HANDLER     RegiserExitHandler;
  94   IS_BROWSER_DATA_MODIFIED  IsBrowserDataModified;
  95   EXECUTE_ACTION            ExecuteAction;
  96   ///
  97   /// A list of type FORMID_INFO is Browser View Form History List.
  98   ///
  99   LIST_ENTRY                FormViewHistoryHead;
 100   ///
 101   /// A list of type QUESTION_ATTRIBUTE_OVERRIDE.
 102   ///
 103   LIST_ENTRY                OverrideQestListHead;
 104 };
 105
 106 extern EFI_GUID gEdkiiFormBrowserEx2ProtocolGuid;
 107
 108 #endif
 109