IntelFrameworkModulePkg/Universal/BdsDxe/BootMngr/BootManager.h

   1 /** @file
   2   The platform boot manager reference implement
   3
   4 Copyright (c) 2004 - 2008, Intel Corporation. <BR>
   5 All rights reserved. This program and the accompanying materials
   6 are licensed and made available under the terms and conditions of the BSD License
   7 which accompanies this distribution.  The full text of the license may be found at
   8 http://opensource.org/licenses/bsd-license.php
   9
  10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _EFI_BOOT_MANAGER_H_
  16 #define _EFI_BOOT_MANAGER_H_
  17
  18 #include "Bds.h"
  19 #include "FrontPage.h"
  20
  21 //
  22 // These are defined as the same with vfr file
  23 //
  24 #define BOOT_MANAGER_FORMSET_GUID \
  25   { \
  26   0x847bc3fe, 0xb974, 0x446d, {0x94, 0x49, 0x5a, 0xd5, 0x41, 0x2e, 0x99, 0x3b} \
  27   }
  28
  29 #define BOOT_MANAGER_FORM_ID     0x1000
  30
  31 #define LABEL_BOOT_OPTION        0x00
  32
  33 //
  34 // These are the VFR compiler generated data representing our VFR data.
  35 //
  36 extern UINT8 BootManagerVfrBin[];
  37
  38 #define BOOT_MANAGER_CALLBACK_DATA_SIGNATURE  SIGNATURE_32 ('B', 'M', 'C', 'B')
  39
  40 typedef struct {
  41   UINTN                           Signature;
  42
  43   //
  44   // HII relative handles
  45   //
  46   EFI_HII_HANDLE                  HiiHandle;
  47   EFI_HANDLE                      DriverHandle;
  48
  49   //
  50   // Produced protocols
  51   //
  52   EFI_HII_CONFIG_ACCESS_PROTOCOL   ConfigAccess;
  53 } BOOT_MANAGER_CALLBACK_DATA;
  54
  55 /**
  56   This call back funtion is registered with Boot Manager formset.
  57   When user selects a boot option, this call back function will
  58   be triggered. The boot option is saved for later processing.
  59
  60
  61   @param This            Points to the EFI_HII_CONFIG_ACCESS_PROTOCOL.
  62   @param Action          Specifies the type of action taken by the browser.
  63   @param QuestionId      A unique value which is sent to the original exporting driver
  64                          so that it can identify the type of data to expect.
  65   @param Type            The type of value for the question.
  66   @param Value           A pointer to the data being sent to the original exporting driver.
  67   @param ActionRequest   On return, points to the action requested by the callback function.
  68
  69   @retval  EFI_SUCCESS           The callback successfully handled the action.
  70   @retval  EFI_INVALID_PARAMETER The setup browser call this function with invalid parameters.
  71
  72 **/
  73 EFI_STATUS
  74 EFIAPI
  75 BootManagerCallback (
  76   IN  CONST EFI_HII_CONFIG_ACCESS_PROTOCOL   *This,
  77   IN  EFI_BROWSER_ACTION                     Action,
  78   IN  EFI_QUESTION_ID                        QuestionId,
  79   IN  UINT8                                  Type,
  80   IN  EFI_IFR_TYPE_VALUE                     *Value,
  81   OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest
  82   );
  83
  84 /**
  85
  86   Registers HII packages for the Boot Manger to HII Database.
  87   It also registers the browser call back function.
  88
  89   @return Status of gBS->InstallMultipleProtocolInterfaces() and gHiiDatabase->NewPackageList()
  90 **/
  91 EFI_STATUS
  92 InitializeBootManager (
  93   VOID
  94   );
  95
  96 /**
  97   This funtion invokees Boot Manager. If all devices have not a chance to be connected,
  98   the connect all will be triggered. It then enumerate all boot options. If
  99   a boot option from the Boot Manager page is selected, Boot Manager will boot
 100   from this boot option.
 101
 102 **/
 103 VOID
 104 CallBootManager (
 105   VOID
 106   );
 107
 108 #endif