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.
5 Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>
6 SPDX-License-Identifier: BSD-2-Clause-Patent
10 #ifndef __FORM_BROWSER_EXTENSION2_H__
11 #define __FORM_BROWSER_EXTENSION2_H__
13 #include <Protocol/FormBrowserEx.h>
15 #define EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL_GUID \
16 { 0xa770c357, 0xb693, 0x4e6d, { 0xa6, 0xcf, 0xd2, 0x1c, 0x72, 0x8e, 0x55, 0xb }}
18 typedef struct _EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL
;
20 #define BROWSER_EXTENSION2_VERSION_1 0x10000
21 #define BROWSER_EXTENSION2_VERSION_1_1 0x10001
24 Check whether the browser data has been modified.
26 @retval TRUE Browser data is modified.
27 @retval FALSE No browser data is modified.
32 (EFIAPI
*IS_BROWSER_DATA_MODIFIED
)(
37 Execute the action requested by the Action parameter.
39 @param[in] Action Execute the request action.
40 @param[in] DefaultId The default Id info when need to load default value.
42 @retval EFI_SUCCESS Execute the request action succss.
47 (EFIAPI
*EXECUTE_ACTION
)(
53 Check whether required reset when exit the browser
55 @retval TRUE Browser required to reset after exit.
56 @retval FALSE Browser not need to reset after exit.
61 (EFIAPI
*IS_RESET_REQUIRED
)(
65 #define FORM_ENTRY_INFO_SIGNATURE SIGNATURE_32 ('f', 'e', 'i', 's')
71 EFI_HII_HANDLE HiiHandle
;
74 EFI_QUESTION_ID QuestionId
;
77 #define FORM_ENTRY_INFO_FROM_LINK(a) CR (a, FORM_ENTRY_INFO, Link, FORM_ENTRY_INFO_SIGNATURE)
79 #define FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE SIGNATURE_32 ('f', 'q', 'o', 's')
85 EFI_QUESTION_ID QuestionId
; // Find the question
86 EFI_FORM_ID FormId
; // Find the form
87 EFI_GUID FormSetGuid
; // Find the formset.
88 EFI_HII_HANDLE HiiHandle
; // Find the HII handle
89 UINT32 Attribute
; // Hide or grayout ...
90 } QUESTION_ATTRIBUTE_OVERRIDE
;
92 #define FORM_QUESTION_ATTRIBUTE_OVERRIDE_FROM_LINK(a) CR (a, QUESTION_ATTRIBUTE_OVERRIDE, Link, FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE)
94 struct _EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL
{
96 /// Version for protocol future extension.
100 REGISTER_HOT_KEY RegisterHotKey
;
101 REGISTER_EXIT_HANDLER RegiserExitHandler
;
102 IS_BROWSER_DATA_MODIFIED IsBrowserDataModified
;
103 EXECUTE_ACTION ExecuteAction
;
105 /// A list of type FORMID_INFO is Browser View Form History List.
107 LIST_ENTRY FormViewHistoryHead
;
109 /// A list of type QUESTION_ATTRIBUTE_OVERRIDE.
111 LIST_ENTRY OverrideQestListHead
;
113 IS_RESET_REQUIRED IsResetRequired
;
116 extern EFI_GUID gEdkiiFormBrowserEx2ProtocolGuid
;