Add DxeBootScriptLibNull in IntelFrameworkPkg.
[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / FrameworkFormBrowser.h
1 /** @file
2 The EFI_FORM_BROWSER_PROTOCOL is the interface to the EFI
3 Configuration Driver. This will allow the caller to direct the
4 configuration driver to use either the HII database or use the passed
5 in packet of data. This will also allow the caller to post messages
6 into the configuration drivers internal mailbox.
7
8 Copyright (c) 2006, Intel Corporation
9 All rights reserved. This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
13
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16
17 Module Name: FrameworkFormBrowser.h
18
19 @par Revision Reference:
20 This protocol is defined in HII spec 0.92.
21
22 **/
23
24 #ifndef __FRAMEWORK_FORM_BROWSER_H__
25 #define __FRAMEWORK_FORM_BROWSER_H__
26
27
28 #define EFI_FORM_BROWSER_PROTOCOL_GUID \
29 { \
30 0xe5a1333e, 0xe1b4, 0x4d55, {0xce, 0xeb, 0x35, 0xc3, 0xef, 0x13, 0x34, 0x43 } \
31 }
32
33 typedef struct _EFI_FORM_BROWSER_PROTOCOL EFI_FORM_BROWSER_PROTOCOL;
34
35 typedef struct {
36 UINT32 Length;
37 UINT16 Type;
38 UINT8 Data[1];
39 } EFI_HII_PACKET;
40
41 typedef struct {
42 EFI_HII_IFR_PACK *IfrData;
43 EFI_HII_STRING_PACK *StringData;
44 } EFI_IFR_PACKET;
45
46 typedef struct {
47 UINTN LeftColumn;
48 UINTN RightColumn;
49 UINTN TopRow;
50 UINTN BottomRow;
51 } EFI_SCREEN_DESCRIPTOR;
52
53 /**
54 Provides direction to the configuration driver whether to use the HII
55 database or a passed-in set of data. This function also establishes a
56 pointer to the calling driver's callback interface.
57
58 @param This A pointer to the EFI_FORM_BROWSER_PROTOCOL instance.
59 @param UseDatabase Determines whether the HII database is to be
60 used to gather information. If the value is FALSE, the configuration
61 driver will get the information provided in the passed-in Packet parameters.
62 @param Handle A pointer to an array of HII handles to display. This value
63 should correspond to the value of the HII form package that is required to
64 be displayed.
65 @param HandleCount The number of handles in the array specified by Handle.
66 @param Packet A pointer to a set of data containing pointers to IFR
67 and/or string data.
68 @param CallbackHandle The handle to the driver's callback interface.
69 This parameter is used only when the UseDatabase parameter is FALSE
70 and an application wants to register a callback with the browser
71 @param NvMapOverride This buffer is used only when there is no NV variable
72 to define the current settings and the caller needs to provide to the browser
73 the current settings for the "fake" NV variable.
74 @param ScreenDimensions Allows the browser to be called so that it occupies
75 a portion of the physical screen instead of dynamically determining the
76 screen dimensions.
77 @param ResetRequired This BOOLEAN value will tell the caller if a reset
78 is required based on the data that might have been changed. The ResetRequired
79 parameter is primarily applicable for configuration applications, and is an
80 optional parameter.
81
82 @retval EFI_SUCCESS The function completed successfully
83 @retval EFI_NOT_FOUND The variable was not found.
84 @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result.
85 DataSize has been updated with the size needed to complete the request.
86 @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
87 @retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.
88
89 **/
90 typedef
91 EFI_STATUS
92 (EFIAPI *EFI_SEND_FORM) (
93 IN EFI_FORM_BROWSER_PROTOCOL *This,
94 IN BOOLEAN UseDatabase,
95 IN EFI_HII_HANDLE *Handle,
96 IN UINTN HandleCount,
97 IN EFI_IFR_PACKET *Packet, OPTIONAL
98 IN EFI_HANDLE CallbackHandle, OPTIONAL
99 IN UINT8 *NvMapOverride, OPTIONAL
100 IN EFI_SCREEN_DESCRIPTOR *ScreenDimensions, OPTIONAL
101 OUT BOOLEAN *ResetRequired OPTIONAL
102 );
103
104 /**
105 Routine used to abstract a generic dialog interface and return the selected
106 key or string.
107
108 @param NumberOfLines The number of lines for the dialog box.
109 @param HotKey Defines whether a single character is parsed (TRUE)
110 and returned in KeyValue or if a string is returned in StringBuffer.
111 @param MaximumStringSize The maximum size in bytes of a typed-in string.
112 Because each character is a CHAR16, the minimum string returned is two bytes.
113 @param StringBuffer The passed-in pointer to the buffer that will hold
114 the typed in string if HotKey is FALSE.
115 @param KeyValue The EFI_INPUT_KEY value returned if HotKey is TRUE.
116 @param String The pointer to the first string in the list of strings
117 that comprise the dialog box.
118 @param ... A series of NumberOfLines text strings that will be used
119 to construct the dialog box.
120
121 @retval EFI_SUCCESS The dialog was displayed and user interaction was received.
122 @retval EFI_DEVICE_ERROR The user typed in an ESC character to exit the routine.
123 @retval EFI_INVALID_PARAMETER One of the parameters was invalid
124
125 **/
126 typedef
127 EFI_STATUS
128 (EFIAPI *EFI_CREATE_POP_UP) (
129 IN UINTN NumberOfLines,
130 IN BOOLEAN HotKey,
131 IN UINTN MaximumStringSize,
132 OUT CHAR16 *StringBuffer,
133 OUT EFI_INPUT_KEY *KeyValue,
134 IN CHAR16 *String,
135 ...
136 );
137
138 /**
139 @par Protocol Description:
140 The EFI_FORM_BROWSER_PROTOCOL is the interface to call for drivers to
141 leverage the EFI configuration driver interface.
142
143 @param SendForm
144 Provides direction to the configuration driver whether to use the HII
145 database or to use a passed-in set of data. This functions also establishes
146 a pointer to the calling driver's callback interface.
147
148 @param CreatePopUp
149 Routine used to abstract a generic dialog interface and return the
150 selected key or string.
151
152 **/
153 struct _EFI_FORM_BROWSER_PROTOCOL {
154 EFI_SEND_FORM SendForm;
155 EFI_CREATE_POP_UP CreatePopUp;
156 };
157
158 extern EFI_GUID gEfiFormBrowserProtocolGuid;
159
160 #endif