]>
Commit | Line | Data |
---|---|---|
7c6c064c ED |
1 | /** @file\r |
2 | Extension Form Browser Protocol provides the services that can be used to \r | |
3 | register the different hot keys for the standard Browser actions described in UEFI specification.\r | |
4 | \r | |
7da62bc0 | 5 | Copyright (c) 2013 - 2014, Intel Corporation. All rights reserved.<BR>\r |
7c6c064c ED |
6 | This program and the accompanying materials are licensed and made available under \r |
7 | the terms and conditions of the BSD License that accompanies this distribution. \r | |
8 | 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 | |
14 | **/\r | |
15 | \r | |
16 | #ifndef __FORM_BROWSER_EXTENSION2_H__\r | |
17 | #define __FORM_BROWSER_EXTENSION2_H__\r | |
18 | \r | |
19 | #include <Protocol/FormBrowserEx.h>\r | |
20 | \r | |
21 | #define EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL_GUID \\r | |
22 | { 0xa770c357, 0xb693, 0x4e6d, { 0xa6, 0xcf, 0xd2, 0x1c, 0x72, 0x8e, 0x55, 0xb }}\r | |
23 | \r | |
24 | typedef struct _EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL;\r | |
25 | \r | |
7da62bc0 ED |
26 | #define BROWSER_EXTENSION2_VERSION_1 0x10000\r |
27 | #define BROWSER_EXTENSION2_VERSION_1_1 0x10001\r | |
7c6c064c ED |
28 | \r |
29 | /**\r | |
30 | Check whether the browser data has been modified.\r | |
31 | \r | |
32 | @retval TRUE Browser data is modified.\r | |
33 | @retval FALSE No browser data is modified.\r | |
34 | \r | |
35 | **/\r | |
36 | typedef\r | |
37 | BOOLEAN\r | |
38 | (EFIAPI *IS_BROWSER_DATA_MODIFIED) (\r | |
39 | VOID\r | |
40 | );\r | |
41 | \r | |
42 | /**\r | |
43 | Execute the action requested by the Action parameter.\r | |
44 | \r | |
45 | @param[in] Action Execute the request action.\r | |
46 | @param[in] DefaultId The default Id info when need to load default value.\r | |
47 | \r | |
48 | @retval EFI_SUCCESS Execute the request action succss.\r | |
49 | \r | |
50 | **/\r | |
51 | typedef \r | |
52 | EFI_STATUS \r | |
53 | (EFIAPI *EXECUTE_ACTION) (\r | |
54 | IN UINT32 Action,\r | |
55 | IN UINT16 DefaultId\r | |
56 | );\r | |
57 | \r | |
7da62bc0 ED |
58 | /**\r |
59 | Check whether required reset when exit the browser\r | |
60 | \r | |
61 | @retval TRUE Browser required to reset after exit.\r | |
62 | @retval FALSE Browser not need to reset after exit.\r | |
63 | \r | |
64 | **/\r | |
65 | typedef\r | |
66 | BOOLEAN\r | |
67 | (EFIAPI *IS_RESET_REQUIRED) (\r | |
68 | VOID\r | |
69 | );\r | |
70 | \r | |
7c6c064c ED |
71 | #define FORM_ENTRY_INFO_SIGNATURE SIGNATURE_32 ('f', 'e', 'i', 's')\r |
72 | \r | |
73 | typedef struct {\r | |
74 | UINTN Signature;\r | |
75 | LIST_ENTRY Link;\r | |
76 | \r | |
77 | EFI_HII_HANDLE HiiHandle;\r | |
78 | EFI_GUID FormSetGuid;\r | |
5a9f73bf ED |
79 | EFI_FORM_ID FormId;\r |
80 | EFI_QUESTION_ID QuestionId;\r | |
7c6c064c ED |
81 | } FORM_ENTRY_INFO;\r |
82 | \r | |
83 | #define FORM_ENTRY_INFO_FROM_LINK(a) CR (a, FORM_ENTRY_INFO, Link, FORM_ENTRY_INFO_SIGNATURE)\r | |
84 | \r | |
184f3a02 ED |
85 | #define FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE SIGNATURE_32 ('f', 'q', 'o', 's')\r |
86 | \r | |
87 | typedef struct {\r | |
88 | UINTN Signature;\r | |
89 | LIST_ENTRY Link;\r | |
90 | \r | |
91 | EFI_QUESTION_ID QuestionId; // Find the question\r | |
92 | EFI_FORM_ID FormId; // Find the form\r | |
93 | EFI_GUID FormSetGuid; // Find the formset.\r | |
94 | EFI_HII_HANDLE HiiHandle; // Find the HII handle\r | |
95 | UINT32 Attribute; // Hide or grayout ... \r | |
96 | } QUESTION_ATTRIBUTE_OVERRIDE;\r | |
97 | \r | |
98 | #define FORM_QUESTION_ATTRIBUTE_OVERRIDE_FROM_LINK(a) CR (a, QUESTION_ATTRIBUTE_OVERRIDE, Link, FORM_QUESTION_ATTRIBUTE_OVERRIDE_SIGNATURE)\r | |
99 | \r | |
7c6c064c ED |
100 | struct _EDKII_FORM_BROWSER_EXTENSION2_PROTOCOL {\r |
101 | ///\r | |
102 | /// Version for protocol future extension.\r | |
103 | ///\r | |
104 | UINT32 Version;\r | |
105 | SET_SCOPE SetScope;\r | |
106 | REGISTER_HOT_KEY RegisterHotKey;\r | |
107 | REGISTER_EXIT_HANDLER RegiserExitHandler;\r | |
108 | IS_BROWSER_DATA_MODIFIED IsBrowserDataModified;\r | |
109 | EXECUTE_ACTION ExecuteAction;\r | |
110 | ///\r | |
111 | /// A list of type FORMID_INFO is Browser View Form History List.\r | |
112 | ///\r | |
113 | LIST_ENTRY FormViewHistoryHead;\r | |
184f3a02 ED |
114 | ///\r |
115 | /// A list of type QUESTION_ATTRIBUTE_OVERRIDE.\r | |
116 | ///\r | |
117 | LIST_ENTRY OverrideQestListHead;\r | |
7da62bc0 ED |
118 | \r |
119 | IS_RESET_REQUIRED IsResetRequired;\r | |
7c6c064c ED |
120 | };\r |
121 | \r | |
122 | extern EFI_GUID gEdkiiFormBrowserEx2ProtocolGuid;\r | |
123 | \r | |
124 | #endif\r | |
125 | \r |