IntelFrameworkModulePkg/Library/PlatformBdsLibNull/BdsPlatform.c

   1 /** @file
   2   This file include all platform action which can be customized by IBV/OEM.
   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 #include "BdsPlatform.h"
  16
  17 //
  18 // BDS Platform Functions
  19 //
  20 /**
  21   Platform Bds init. Include the platform firmware vendor, revision
  22   and so crc check.
  23
  24 **/
  25 VOID
  26 EFIAPI
  27 PlatformBdsInit (
  28   VOID
  29   )
  30 {
  31 }
  32
  33 /**
  34   Connect the predefined platform default console device. Always try to find
  35   and enable the vga device if have.
  36
  37   @param PlatformConsole          Predefined platform default console device array.
  38
  39   @retval EFI_SUCCESS             Success connect at least one ConIn and ConOut
  40                                   device, there must have one ConOut device is
  41                                   active vga device.
  42   @return Return the status of BdsLibConnectAllDefaultConsoles ()
  43
  44 **/
  45 EFI_STATUS
  46 PlatformBdsConnectConsole (
  47   IN BDS_CONSOLE_CONNECT_ENTRY   *PlatformConsole
  48   )
  49 {
  50   return EFI_SUCCESS;
  51 }
  52
  53 /**
  54   Connect with predefined platform connect sequence,
  55   the OEM/IBV can customize with their own connect sequence.
  56 **/
  57 VOID
  58 PlatformBdsConnectSequence (
  59   VOID
  60   )
  61 {
  62 }
  63
  64 /**
  65   Load the predefined driver option, OEM/IBV can customize this
  66   to load their own drivers
  67
  68   @param BdsDriverLists  - The header of the driver option link list.
  69
  70 **/
  71 VOID
  72 PlatformBdsGetDriverOption (
  73   IN OUT LIST_ENTRY              *BdsDriverLists
  74   )
  75 {
  76 }
  77
  78 /**
  79   Perform the platform diagnostic, such like test memory. OEM/IBV also
  80   can customize this function to support specific platform diagnostic.
  81
  82   @param MemoryTestLevel  The memory test intensive level
  83   @param QuietBoot        Indicate if need to enable the quiet boot
  84
  85 **/
  86 VOID
  87 PlatformBdsDiagnostics (
  88   IN EXTENDMEM_COVERAGE_LEVEL    MemoryTestLevel,
  89   IN BOOLEAN                     QuietBoot
  90   )
  91 {
  92 }
  93
  94 /**
  95   The function will execute with as the platform policy, current policy
  96   is driven by boot mode. IBV/OEM can customize this code for their specific
  97   policy action.
  98
  99   @param  DriverOptionList        The header of the driver option link list
 100   @param  BootOptionList          The header of the boot option link list
 101
 102 **/
 103 VOID
 104 EFIAPI
 105 PlatformBdsPolicyBehavior (
 106   IN LIST_ENTRY                      *DriverOptionList,
 107   IN LIST_ENTRY                      *BootOptionList
 108   )
 109 {
 110 }
 111
 112 /**
 113   Hook point after a boot attempt succeeds. We don't expect a boot option to
 114   return, so the UEFI 2.0 specification defines that you will default to an
 115   interactive mode and stop processing the BootOrder list in this case. This
 116   is also a platform implementation and can be customized by IBV/OEM.
 117
 118   @param  Option                  Pointer to Boot Option that succeeded to boot.
 119
 120 **/
 121 VOID
 122 EFIAPI
 123 PlatformBdsBootSuccess (
 124   IN  BDS_COMMON_OPTION *Option
 125   )
 126 {
 127 }
 128
 129 /**
 130   Hook point after a boot attempt fails.
 131
 132   @param  Option                  Pointer to Boot Option that failed to boot.
 133   @param  Status                  Status returned from failed boot.
 134   @param  ExitData                Exit data returned from failed boot.
 135   @param  ExitDataSize            Exit data size returned from failed boot.
 136
 137 **/
 138 VOID
 139 EFIAPI
 140 PlatformBdsBootFail (
 141   IN  BDS_COMMON_OPTION  *Option,
 142   IN  EFI_STATUS         Status,
 143   IN  CHAR16             *ExitData,
 144   IN  UINTN              ExitDataSize
 145   )
 146 {
 147 }
 148
 149 /**
 150   This function is remained for IBV/OEM to do some platform action,
 151   if there no console device can be connected.
 152
 153   @return EFI_SUCCESS      Direct return success now.
 154
 155 **/
 156 EFI_STATUS
 157 PlatformBdsNoConsoleAction (
 158   VOID
 159   )
 160 {
 161   return EFI_SUCCESS;
 162 }
 163
 164 /**
 165   This function locks platform flash that is not allowed to be updated during normal boot path.
 166   The flash layout is platform specific.
 167
 168   @retval EFI_SUCCESS             The non-updatable flash areas.
 169 **/
 170 EFI_STATUS
 171 EFIAPI
 172 PlatformBdsLockNonUpdatableFlash (
 173   VOID
 174   )
 175 {
 176   return EFI_SUCCESS;
 177 }