3 Copyright (c) 2006, Intel Corporation
4 All rights reserved. This program and the accompanying materials
5 are licensed and made available under the terms and conditions of the BSD License
6 which accompanies this distribution. The full text of the license may be found at
7 http://opensource.org/licenses/bsd-license.php
9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 The platform device manager reference implement
21 #include "DeviceManager.h"
23 STATIC UINT16 mTokenCount
;
24 EFI_FRONTPAGE_CALLBACK_INFO FPCallbackInfo
;
25 extern UINTN gCallbackKey
;
26 extern EFI_FORM_BROWSER_PROTOCOL
*gBrowser
;
27 extern EFI_GUID gBdsStringPackGuid
;
28 extern BOOLEAN gConnectAllHappened
;
30 STRING_REF gStringTokenTable
[] = {
42 DeviceManagerCallbackRoutine (
43 IN EFI_FORM_CALLBACK_PROTOCOL
*This
,
45 IN EFI_IFR_DATA_ARRAY
*DataArray
,
46 OUT EFI_HII_CALLBACK_PACKET
**Packet
52 This is the function that is called to provide results data to the driver. This data
53 consists of a unique key which is used to identify what data is either being passed back
58 KeyValue - A unique value which is sent to the original exporting driver so that it
59 can identify the type of data to expect. The format of the data tends to
60 vary based on the op-code that geerated the callback.
62 Data - A pointer to the data being sent to the original exporting driver.
69 // The KeyValue corresponds in this case to the handle which was requested to be displayed
71 EFI_FRONTPAGE_CALLBACK_INFO
*CallbackInfo
;
73 CallbackInfo
= EFI_FP_CALLBACK_DATA_FROM_THIS (This
);
76 CallbackInfo
->Data
.VideoBIOS
= (UINT8
) (UINTN
) (((EFI_IFR_DATA_ENTRY
*)(DataArray
+ 1))->Data
);
79 &gEfiGenericPlatformVariableGuid
,
80 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
| EFI_VARIABLE_NON_VOLATILE
,
82 &CallbackInfo
->Data
.VideoBIOS
90 gCallbackKey
= KeyValue
;
95 InitializeDeviceManager (
102 Initialize HII information for the FrontPage
112 EFI_HII_PACKAGES
*PackageList
;
113 EFI_HII_UPDATE_DATA
*UpdateData
;
116 // Allocate space for creation of UpdateData Buffer
118 UpdateData
= AllocateZeroPool (0x1000);
119 ASSERT (UpdateData
!= NULL
);
121 PackageList
= PreparePackages (1, &gBdsStringPackGuid
, DeviceManagerVfrBin
);
122 Status
= Hii
->NewPack (Hii
, PackageList
, &FPCallbackInfo
.DevMgrHiiHandle
);
123 gBS
->FreePool (PackageList
);
126 // This example does not implement worker functions for the NV accessor functions. Only a callback evaluator
128 FPCallbackInfo
.Signature
= EFI_FP_CALLBACK_DATA_SIGNATURE
;
129 FPCallbackInfo
.DevMgrCallback
.NvRead
= NULL
;
130 FPCallbackInfo
.DevMgrCallback
.NvWrite
= NULL
;
131 FPCallbackInfo
.DevMgrCallback
.Callback
= DeviceManagerCallbackRoutine
;
134 // Install protocol interface
136 FPCallbackInfo
.CallbackHandle
= NULL
;
138 Status
= gBS
->InstallProtocolInterface (
139 &FPCallbackInfo
.CallbackHandle
,
140 &gEfiFormCallbackProtocolGuid
,
141 EFI_NATIVE_INTERFACE
,
142 &FPCallbackInfo
.DevMgrCallback
145 ASSERT_EFI_ERROR (Status
);
148 // Flag update pending in FormSet
150 UpdateData
->FormSetUpdate
= TRUE
;
152 // Register CallbackHandle data for FormSet
154 UpdateData
->FormCallbackHandle
= (EFI_PHYSICAL_ADDRESS
) (UINTN
) FPCallbackInfo
.CallbackHandle
;
156 // Simply registering the callback handle
158 Hii
->UpdateForm (Hii
, FPCallbackInfo
.DevMgrHiiHandle
, (EFI_FORM_LABEL
) 0x0000, TRUE
, UpdateData
);
160 gBS
->FreePool (UpdateData
);
172 Call the browser and display the device manager
179 EFI_SUCCESS - Operation is successful.
180 EFI_INVALID_PARAMETER - If the inputs to SendForm function is not valid.
187 EFI_HII_HANDLE Index
;
189 EFI_IFR_FORM_SET
*FormSetData
;
192 EFI_HII_UPDATE_DATA
*UpdateData
;
194 STRING_REF TokenHelp
;
195 IFR_OPTION
*IfrOptionList
;
197 UINTN VideoOptionSize
;
198 EFI_HII_HANDLE
*HiiHandles
;
199 UINT16 HandleBufferLength
;
200 BOOLEAN BootDeviceMngrMenuResetRequired
;
202 IfrOptionList
= NULL
;
205 HandleBufferLength
= 0;
208 // Connect all prior to entering the platform setup menu.
210 if (!gConnectAllHappened
) {
211 BdsLibConnectAllDriversToAllControllers ();
212 gConnectAllHappened
= TRUE
;
215 // Allocate space for creation of UpdateData Buffer
217 UpdateData
= AllocateZeroPool (0x1000);
218 ASSERT (UpdateData
!= NULL
);
220 Status
= EFI_SUCCESS
;
224 if (mTokenCount
== 0) {
225 Hii
->NewString (Hii
, NULL
, FPCallbackInfo
.DevMgrHiiHandle
, &mTokenCount
, L
" ");
229 TokenHelp
= (UINT16
) (Token
+ 1);
234 for (Index
= 0, Count
= 1; Count
< 0x10000; Count
<<= 1, Index
++) {
236 // We will strip off all previous menu entries
238 UpdateData
->DataCount
= 0xFF;
241 // Erase entries on this label
243 Hii
->UpdateForm (Hii
, FPCallbackInfo
.DevMgrHiiHandle
, (EFI_FORM_LABEL
) Count
, FALSE
, UpdateData
);
246 // Did we reach the end of the Token Table?
248 if (gStringTokenTable
[Index
] == 0xFFFF) {
252 CreateSubTitleOpCode (gStringTokenTable
[Index
], &UpdateData
->Data
);
254 // Add a single menu item - in this case a subtitle for the device type
256 UpdateData
->DataCount
= 1;
259 // Add default title for this label
261 Hii
->UpdateForm (Hii
, FPCallbackInfo
.DevMgrHiiHandle
, (EFI_FORM_LABEL
) Count
, TRUE
, UpdateData
);
264 // Add a space and an exit string. Remember since we add things at the label and push other things beyond the
265 // label down, we add this in reverse order
267 CreateSubTitleOpCode (STRING_TOKEN (STR_EXIT_STRING
), &UpdateData
->Data
);
268 Hii
->UpdateForm (Hii
, FPCallbackInfo
.DevMgrHiiHandle
, (EFI_FORM_LABEL
) Count
, TRUE
, UpdateData
);
269 CreateSubTitleOpCode (STR_EMPTY_STRING
, &UpdateData
->Data
);
270 Hii
->UpdateForm (Hii
, FPCallbackInfo
.DevMgrHiiHandle
, (EFI_FORM_LABEL
) Count
, TRUE
, UpdateData
);
273 // Get all the Hii handles
275 Status
= BdsLibGetHiiHandles (Hii
, &HandleBufferLength
, &HiiHandles
);
276 ASSERT_EFI_ERROR (Status
);
278 for (Index
= 1, BufferSize
= 0; Index
< HandleBufferLength
; Index
++) {
280 // Am not initializing Buffer since the first thing checked is the size
281 // this way I can get the real buffersize in the smallest code size
283 Status
= Hii
->GetForms (Hii
, Index
, 0, &BufferSize
, Buffer
);
285 if (Status
!= EFI_NOT_FOUND
) {
287 // BufferSize should have the real size of the forms now
289 Buffer
= AllocateZeroPool (BufferSize
);
290 ASSERT (Buffer
!= NULL
);
293 // Am not initializing Buffer since the first thing checked is the size
294 // this way I can get the real buffersize in the smallest code size
296 Status
= Hii
->GetForms (Hii
, Index
, 0, &BufferSize
, Buffer
);
299 // Skip EFI_HII_PACK_HEADER, advance to EFI_IFR_FORM_SET data.
301 FormSetData
= (EFI_IFR_FORM_SET
*) (Buffer
+ sizeof (EFI_HII_PACK_HEADER
));
304 // If this formset belongs in the device manager, add it to the menu
306 if (FormSetData
->Class
!= EFI_NON_DEVICE_CLASS
) {
308 StringLength
= 0x1000;
309 String
= AllocateZeroPool (StringLength
);
310 ASSERT (String
!= NULL
);
312 Status
= Hii
->GetString (Hii
, Index
, FormSetData
->FormSetTitle
, TRUE
, NULL
, &StringLength
, String
);
313 Status
= Hii
->NewString (Hii
, NULL
, FPCallbackInfo
.DevMgrHiiHandle
, &Token
, String
);
316 // If token value exceeded real token value - we need to add a new token values
318 if (Status
== EFI_INVALID_PARAMETER
) {
321 Status
= Hii
->NewString (Hii
, NULL
, FPCallbackInfo
.DevMgrHiiHandle
, &Token
, String
);
324 StringLength
= 0x1000;
325 if (FormSetData
->Help
== 0) {
328 Status
= Hii
->GetString (Hii
, Index
, FormSetData
->Help
, TRUE
, NULL
, &StringLength
, String
);
329 if (StringLength
== 0x02) {
332 Status
= Hii
->NewString (Hii
, NULL
, FPCallbackInfo
.DevMgrHiiHandle
, &TokenHelp
, String
);
333 if (Status
== EFI_INVALID_PARAMETER
) {
335 Status
= Hii
->NewString (Hii
, NULL
, FPCallbackInfo
.DevMgrHiiHandle
, &TokenHelp
, String
);
340 gBS
->FreePool (String
);
343 0x1000, // Device Manager Page
344 Token
, // Description String Token
345 TokenHelp
, // Description Help String Token
346 EFI_IFR_FLAG_INTERACTIVE
| EFI_IFR_FLAG_NV_ACCESS
, // Flag designating callback is active
347 (UINT16
) Index
, // Callback key value
348 &UpdateData
->Data
// Buffer to fill with op-code
352 // In the off-chance that we have lots of extra tokens allocated to the DeviceManager
353 // this ensures we are fairly re-using the tokens instead of constantly growing the token
354 // storage for this one handle. If we incremented the token value beyond what it normally
355 // would use, we will fall back into the error path which seeds the token value with a 0
356 // so that we can correctly add a token value.
358 if (TokenHelp
== 0) {
360 // Since we didn't add help, only advance Token by 1
364 Token
= (UINT16
) (Token
+ 2);
365 TokenHelp
= (UINT16
) (TokenHelp
+ 2);
368 // This for loop basically will take the Class value which is a bitmask and
369 // update the form for every active bit. There will be a label at each bit
370 // location. So if someone had a device which a class of EFI_DISK_DEVICE_CLASS |
371 // EFI_ON_BOARD_DEVICE_CLASS, this routine will unwind that mask and drop the menu entry
372 // on each corresponding label.
374 for (Count
= 1; Count
< 0x10000; Count
<<= 1) {
376 // This is an active bit, so update the form
378 if (FormSetData
->Class
& Count
) {
381 FPCallbackInfo
.DevMgrHiiHandle
,
382 (EFI_FORM_LABEL
) (FormSetData
->Class
& Count
),
392 // Reset Buffer pointer to original location
394 gBS
->FreePool (Buffer
);
398 // Add oneof for video BIOS selection
400 VideoOption
= BdsLibGetVariableAndSize (
402 &gEfiGenericPlatformVariableGuid
,
405 if (NULL
== VideoOption
) {
406 FPCallbackInfo
.Data
.VideoBIOS
= 0;
408 FPCallbackInfo
.Data
.VideoBIOS
= VideoOption
[0];
409 gBS
->FreePool (VideoOption
);
412 ASSERT (FPCallbackInfo
.Data
.VideoBIOS
<= 1);
414 Status
= gBS
->AllocatePool (EfiBootServicesData
, 2 * sizeof (IFR_OPTION
), &IfrOptionList
);
415 if (IfrOptionList
!= NULL
) {
416 IfrOptionList
[0].Flags
= EFI_IFR_FLAG_INTERACTIVE
;
417 IfrOptionList
[0].Key
= SET_VIDEO_BIOS_TYPE_QUESTION_ID
+ 0x2000;
418 IfrOptionList
[0].StringToken
= STRING_TOKEN (STR_ONE_OF_PCI
);
419 IfrOptionList
[0].Value
= 0;
420 IfrOptionList
[0].OptionString
= NULL
;
421 IfrOptionList
[1].Flags
= EFI_IFR_FLAG_INTERACTIVE
;
422 IfrOptionList
[1].Key
= SET_VIDEO_BIOS_TYPE_QUESTION_ID
+ 0x2000;
423 IfrOptionList
[1].StringToken
= STRING_TOKEN (STR_ONE_OF_AGP
);
424 IfrOptionList
[1].Value
= 1;
425 IfrOptionList
[1].OptionString
= NULL
;
426 IfrOptionList
[FPCallbackInfo
.Data
.VideoBIOS
].Flags
|= EFI_IFR_FLAG_DEFAULT
;
429 SET_VIDEO_BIOS_TYPE_QUESTION_ID
,
431 STRING_TOKEN (STR_ONE_OF_VBIOS
),
432 STRING_TOKEN (STR_ONE_OF_VBIOS_HELP
),
438 UpdateData
->DataCount
= 4;
439 Hii
->UpdateForm (Hii
, FPCallbackInfo
.DevMgrHiiHandle
, (EFI_FORM_LABEL
) EFI_VBIOS_CLASS
, TRUE
, UpdateData
);
440 gBS
->FreePool (IfrOptionList
);
443 BootDeviceMngrMenuResetRequired
= FALSE
;
444 Status
= gBrowser
->SendForm (
446 TRUE
, // Use the database
447 &FPCallbackInfo
.DevMgrHiiHandle
, // The HII Handle
450 FPCallbackInfo
.CallbackHandle
,
451 (UINT8
*) &FPCallbackInfo
.Data
,
453 &BootDeviceMngrMenuResetRequired
456 if (BootDeviceMngrMenuResetRequired
) {
457 EnableResetRequired ();
460 Hii
->ResetStrings (Hii
, FPCallbackInfo
.DevMgrHiiHandle
);
463 // We will have returned from processing a callback - user either hit ESC to exit, or selected
464 // a target to display
466 if (gCallbackKey
!= 0 && gCallbackKey
< 0x2000) {
467 BootDeviceMngrMenuResetRequired
= FALSE
;
468 Status
= gBrowser
->SendForm (
470 TRUE
, // Use the database
471 (EFI_HII_HANDLE
*) &gCallbackKey
, // The HII Handle
474 NULL
, // This is the handle that the interface to the callback was installed on
477 &BootDeviceMngrMenuResetRequired
480 if (BootDeviceMngrMenuResetRequired
) {
481 EnableResetRequired ();
484 // Force return to Device Manager
489 if (gCallbackKey
>= 0x2000) {
493 gBS
->FreePool (UpdateData
);
494 gBS
->FreePool (HiiHandles
);