]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
4ca9b6c4 LG |
2 | This protocol is defined in UEFI spec.\r |
3 | \r | |
4 | The EFI_FORM_BROWSER2_PROTOCOL is the interface to call for drivers to \r | |
5 | leverage the EFI configuration driver interface.\r | |
d1f95000 | 6 | \r |
ed95ad4e | 7 | Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r |
af2dc6a7 | 8 | This program and the accompanying materials are licensed and made available under \r |
9 | the terms and conditions of the BSD License that accompanies this distribution. \r | |
10 | The full text of the license may be found at\r | |
11 | http://opensource.org/licenses/bsd-license.php. \r | |
12 | \r | |
13 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
14 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
d1f95000 | 15 | \r |
d1f95000 | 16 | **/\r |
17 | \r | |
4ca9b6c4 LG |
18 | #ifndef __EFI_FORM_BROWSER2_H__\r |
19 | #define __EFI_FORM_BROWSER2_H__\r | |
d1f95000 | 20 | \r |
0cd118f7 LG |
21 | #include <Guid/HiiPlatformSetupFormset.h>\r |
22 | \r | |
5a1fc221 | 23 | #define EFI_FORM_BROWSER2_PROTOCOL_GUID \\r |
7d582d6b | 24 | {0xb9d4c360, 0xbcfb, 0x4f9b, {0x92, 0x98, 0x53, 0xc1, 0x36, 0x98, 0x22, 0x58 }}\r |
d1f95000 | 25 | \r |
26 | \r | |
5a1fc221 | 27 | typedef struct _EFI_FORM_BROWSER2_PROTOCOL EFI_FORM_BROWSER2_PROTOCOL;\r |
d1f95000 | 28 | \r |
29 | \r | |
30 | \r | |
31 | /**\r | |
32 | \r | |
af2dc6a7 | 33 | @param LeftColumn The value that designates the text column\r |
f754f721 | 34 | where the browser window will begin from\r |
35 | the left-hand side of the screen\r | |
4ca9b6c4 | 36 | \r |
af2dc6a7 | 37 | @param RightColumn The value that designates the text\r |
f754f721 | 38 | column where the browser window will end\r |
39 | on the right-hand side of the screen.\r | |
d1f95000 | 40 | \r |
af2dc6a7 | 41 | @param TopRow The value that designates the text row from the\r |
4ca9b6c4 LG |
42 | top of the screen where the browser window\r |
43 | will start.\r | |
d1f95000 | 44 | \r |
af2dc6a7 | 45 | @param BottomRow The value that designates the text row from the\r |
4ca9b6c4 LG |
46 | bottom of the screen where the browser\r |
47 | window will end. \r | |
d1f95000 | 48 | **/\r |
49 | typedef struct {\r | |
50 | UINTN LeftColumn;\r | |
51 | UINTN RightColumn;\r | |
52 | UINTN TopRow;\r | |
53 | UINTN BottomRow;\r | |
54 | } EFI_SCREEN_DESCRIPTOR;\r | |
55 | \r | |
5a1fc221 | 56 | typedef UINTN EFI_BROWSER_ACTION_REQUEST;\r |
57 | \r | |
7d582d6b | 58 | #define EFI_BROWSER_ACTION_REQUEST_NONE 0\r |
59 | #define EFI_BROWSER_ACTION_REQUEST_RESET 1\r | |
60 | #define EFI_BROWSER_ACTION_REQUEST_SUBMIT 2\r | |
61 | #define EFI_BROWSER_ACTION_REQUEST_EXIT 3\r | |
d4cb06e1 ED |
62 | #define EFI_BROWSER_ACTION_REQUEST_FORM_SUBMIT_EXIT 4\r |
63 | #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD_EXIT 5\r | |
64 | #define EFI_BROWSER_ACTION_REQUEST_FORM_APPLY 6\r | |
65 | #define EFI_BROWSER_ACTION_REQUEST_FORM_DISCARD 7\r | |
5a1fc221 | 66 | \r |
67 | \r | |
d1f95000 | 68 | /**\r |
eecd469b LG |
69 | Initialize the browser to display the specified configuration forms.\r |
70 | \r | |
4ca9b6c4 LG |
71 | This function is the primary interface to the internal forms-based browser. \r |
72 | The forms browser will display forms associated with the specified Handles. \r | |
73 | The browser will select all forms in packages which have the specified Type \r | |
74 | and (for EFI_HII_PACKAGE_TYPE_GUID) the specified PackageGuid.\r | |
75 | \r | |
76 | @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL instance\r | |
77 | \r | |
78 | @param Handles A pointer to an array of Handles. This value should correspond \r | |
eecd469b | 79 | to the value of the HII form package that is required to be displayed.\r |
4ca9b6c4 LG |
80 | \r |
81 | @param HandleCount The number of Handles specified in Handle.\r | |
82 | \r | |
25a0aa5d | 83 | @param FormSetGuid This field points to the EFI_GUID which must match the Guid field or one of the\r |
84 | elements of the ClassId field in the EFI_IFR_FORM_SET op-code. If\r | |
ed95ad4e | 85 | FormsetGuid is NULL, then this function will display the form set class\r |
25a0aa5d | 86 | EFI_HII_PLATFORM_SETUP_FORMSET_GUID.\r |
4ca9b6c4 | 87 | \r |
25a0aa5d | 88 | @param FormId This field specifies the identifier of the form within the form set to render as the first\r |
89 | displayable page. If this field has a value of 0x0000, then the Forms Browser will\r | |
90 | render the first enabled form in the form set.\r | |
4ca9b6c4 LG |
91 | \r |
92 | @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in \r | |
93 | characters.\r | |
94 | \r | |
95 | @param ActionRequest Points to the action recommended by the form.\r | |
96 | \r | |
97 | @retval EFI_SUCCESS The function completed successfully\r | |
d1f95000 | 98 | \r |
4ca9b6c4 | 99 | @retval EFI_NOT_FOUND The variable was not found.\r |
d1f95000 | 100 | \r |
4ca9b6c4 LG |
101 | @retval EFI_INVALID_PARAMETER One of the parameters has an\r |
102 | invalid value. \r | |
d1f95000 | 103 | **/\r |
104 | typedef\r | |
105 | EFI_STATUS\r | |
8b13229b | 106 | (EFIAPI *EFI_SEND_FORM2)(\r |
7d582d6b | 107 | IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,\r |
108 | IN EFI_HII_HANDLE *Handle,\r | |
109 | IN UINTN HandleCount,\r | |
110 | IN EFI_GUID *FormSetGuid, OPTIONAL\r | |
111 | IN EFI_FORM_ID FormId, OPTIONAL\r | |
5a1fc221 | 112 | IN CONST EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL\r |
5a1fc221 | 113 | OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest OPTIONAL\r |
d1f95000 | 114 | );\r |
115 | \r | |
116 | \r | |
117 | /**\r | |
eecd469b LG |
118 | This function is called by a callback handler to retrieve uncommitted state data from the browser.\r |
119 | \r | |
d1f95000 | 120 | This routine is called by a routine which was called by the\r |
121 | browser. This routine called this service in the browser to\r | |
122 | retrieve or set certain uncommitted state information.\r | |
123 | \r | |
4ca9b6c4 | 124 | @param This A pointer to the EFI_FORM_BROWSER2_PROTOCOL instance.\r |
d1f95000 | 125 | \r |
126 | @param ResultsDataSize A pointer to the size of the buffer\r | |
4ca9b6c4 | 127 | associated with ResultsData. On input, the size in\r |
af2dc6a7 | 128 | bytes of ResultsData. On output, the size of data \r |
129 | returned in ResultsData.\r | |
d1f95000 | 130 | \r |
4ca9b6c4 LG |
131 | @param ResultsData A string returned from an IFR browser or\r |
132 | equivalent. The results string will have\r | |
133 | no routing information in them.\r | |
d1f95000 | 134 | \r |
135 | @param RetrieveData A BOOLEAN field which allows an agent to\r | |
136 | retrieve (if RetrieveData = TRUE) data\r | |
137 | from the uncommitted browser state\r | |
138 | information or set (if RetrieveData =\r | |
139 | FALSE) data in the uncommitted browser\r | |
140 | state information.\r | |
141 | \r | |
142 | @param VariableGuid An optional field to indicate the target\r | |
143 | variable GUID name to use.\r | |
144 | \r | |
145 | @param VariableName An optional field to indicate the target\r | |
146 | human-readable variable name.\r | |
147 | \r | |
4ca9b6c4 LG |
148 | @retval EFI_SUCCESS The results have been distributed or are\r |
149 | awaiting distribution.\r | |
d1f95000 | 150 | \r |
151 | @retval EFI_OUT_OF_RESOURCES The ResultsDataSize specified\r | |
152 | was too small to contain the\r | |
153 | results data.\r | |
154 | \r | |
155 | **/\r | |
156 | typedef\r | |
157 | EFI_STATUS\r | |
8b13229b | 158 | (EFIAPI *EFI_BROWSER_CALLBACK2)(\r |
7d582d6b | 159 | IN CONST EFI_FORM_BROWSER2_PROTOCOL *This,\r |
d1f95000 | 160 | IN OUT UINTN *ResultsDataSize,\r |
161 | IN OUT EFI_STRING ResultsData,\r | |
162 | IN CONST BOOLEAN RetrieveData,\r | |
163 | IN CONST EFI_GUID *VariableGuid, OPTIONAL\r | |
164 | IN CONST CHAR16 *VariableName OPTIONAL\r | |
165 | );\r | |
166 | \r | |
44717a39 | 167 | ///\r |
168 | /// This interface will allow the caller to direct the configuration \r | |
169 | /// driver to use either the HII database or use the passed-in packet of data.\r | |
170 | ///\r | |
5a1fc221 | 171 | struct _EFI_FORM_BROWSER2_PROTOCOL {\r |
172 | EFI_SEND_FORM2 SendForm;\r | |
173 | EFI_BROWSER_CALLBACK2 BrowserCallback;\r | |
d1f95000 | 174 | } ;\r |
175 | \r | |
5a1fc221 | 176 | extern EFI_GUID gEfiFormBrowser2ProtocolGuid;\r |
d1f95000 | 177 | \r |
178 | #endif\r | |
179 | \r |