MdeModulePkg/Library/PlatformBdsLibNull/BdsPlatform.c

   1 /** @file
   2   This file include all platform action which can be customized
   3   by IBV/OEM.
   4
   5 Copyright (c) 2004 - 2008, Intel Corporation. <BR>
   6 All rights reserved. This program and the accompanying materials
   7 are licensed and made available under the terms and conditions of the BSD License
   8 which accompanies this distribution.  The full text of the license may be found at
   9 http://opensource.org/licenses/bsd-license.php
  10
  11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #include "BdsPlatform.h"
  17
  18 //
  19 // BDS Platform Functions
  20 //
  21 VOID
  22 PlatformBdsInit (
  23   IN EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData
  24   )
  25 /*++
  26
  27 Routine Description:
  28
  29   Platform Bds init. Incude the platform firmware vendor, revision
  30   and so crc check.
  31
  32 Arguments:
  33
  34   PrivateData  - The EFI_BDS_ARCH_PROTOCOL_INSTANCE instance
  35
  36 Returns:
  37
  38   None.
  39
  40 --*/
  41 {
  42   return;
  43 }
  44
  45 EFI_STATUS
  46 PlatformBdsConnectConsole (
  47   IN BDS_CONSOLE_CONNECT_ENTRY   *PlatformConsole
  48   )
  49 /*++
  50
  51 Routine Description:
  52
  53   Connect the predefined platform default console device. Always try to find
  54   and enable the vga device if have.
  55
  56 Arguments:
  57
  58   PlatformConsole         - Predfined platform default console device array.
  59
  60 Returns:
  61
  62   EFI_SUCCESS             - Success connect at least one ConIn and ConOut
  63                             device, there must have one ConOut device is
  64                             active vga device.
  65
  66   EFI_STATUS              - Return the status of
  67                             BdsLibConnectAllDefaultConsoles ()
  68
  69 --*/
  70 {
  71   return EFI_SUCCESS;
  72 }
  73
  74 VOID
  75 PlatformBdsConnectSequence (
  76   VOID
  77   )
  78 /*++
  79
  80 Routine Description:
  81
  82   Connect with predeined platform connect sequence,
  83   the OEM/IBV can customize with their own connect sequence.
  84
  85 Arguments:
  86
  87   None.
  88
  89 Returns:
  90
  91   None.
  92
  93 --*/
  94 {
  95   return;
  96 }
  97
  98 VOID
  99 PlatformBdsGetDriverOption (
 100   IN OUT LIST_ENTRY              *BdsDriverLists
 101   )
 102 /*++
 103
 104 Routine Description:
 105
 106   Load the predefined driver option, OEM/IBV can customize this
 107   to load their own drivers
 108
 109 Arguments:
 110
 111   BdsDriverLists  - The header of the driver option link list.
 112
 113 Returns:
 114
 115   None.
 116
 117 --*/
 118 {
 119   return;
 120 }
 121
 122 VOID
 123 PlatformBdsDiagnostics (
 124   IN EXTENDMEM_COVERAGE_LEVEL    MemoryTestLevel,
 125   IN BOOLEAN                     QuietBoot
 126   )
 127 /*++
 128
 129 Routine Description:
 130
 131   Perform the platform diagnostic, such like test memory. OEM/IBV also
 132   can customize this fuction to support specific platform diagnostic.
 133
 134 Arguments:
 135
 136   MemoryTestLevel  - The memory test intensive level
 137
 138   QuietBoot        - Indicate if need to enable the quiet boot
 139
 140 Returns:
 141
 142   None.
 143
 144 --*/
 145 {
 146   return;
 147 }
 148
 149 VOID
 150 PlatformBdsPolicyBehavior (
 151   IN EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData,
 152   IN OUT LIST_ENTRY                  *DriverOptionList,
 153   IN OUT LIST_ENTRY                  *BootOptionList
 154   )
 155 /*++
 156
 157 Routine Description:
 158
 159   The function will excute with as the platform policy, current policy
 160   is driven by boot mode. IBV/OEM can customize this code for their specific
 161   policy action.
 162
 163 Arguments:
 164
 165   PrivateData      - The EFI_BDS_ARCH_PROTOCOL_INSTANCE instance
 166
 167   DriverOptionList - The header of the driver option link list
 168
 169   BootOptionList   - The header of the boot option link list
 170
 171 Returns:
 172
 173   None.
 174
 175 --*/
 176 {
 177   return ;
 178 }
 179
 180 VOID
 181 PlatformBdsBootSuccess (
 182   IN  BDS_COMMON_OPTION   *Option
 183   )
 184 /*++
 185
 186 Routine Description:
 187
 188   Hook point after a boot attempt succeeds. We don't expect a boot option to
 189   return, so the EFI 1.0 specification defines that you will default to an
 190   interactive mode and stop processing the BootOrder list in this case. This
 191   is alos a platform implementation and can be customized by IBV/OEM.
 192
 193 Arguments:
 194
 195   Option - Pointer to Boot Option that succeeded to boot.
 196
 197 Returns:
 198
 199   None.
 200
 201 --*/
 202 {
 203   return;
 204 }
 205
 206 VOID
 207 PlatformBdsBootFail (
 208   IN  BDS_COMMON_OPTION  *Option,
 209   IN  EFI_STATUS         Status,
 210   IN  CHAR16             *ExitData,
 211   IN  UINTN              ExitDataSize
 212   )
 213 /*++
 214
 215 Routine Description:
 216
 217   Hook point after a boot attempt fails.
 218
 219 Arguments:
 220
 221   Option - Pointer to Boot Option that failed to boot.
 222
 223   Status - Status returned from failed boot.
 224
 225   ExitData - Exit data returned from failed boot.
 226
 227   ExitDataSize - Exit data size returned from failed boot.
 228
 229 Returns:
 230
 231   None.
 232
 233 --*/
 234 {
 235   return;
 236 }
 237
 238 EFI_STATUS
 239 PlatformBdsNoConsoleAction (
 240   VOID
 241   )
 242 /*++
 243
 244 Routine Description:
 245
 246   This function is remained for IBV/OEM to do some platform action,
 247   if there no console device can be connected.
 248
 249 Arguments:
 250
 251   None.
 252
 253 Returns:
 254
 255   EFI_SUCCESS      - Direct return success now.
 256
 257 --*/
 258 {
 259   return EFI_SUCCESS;
 260 }
 261
 262 EFI_STATUS
 263 EFIAPI
 264 PlatformBdsLockNonUpdatableFlash (
 265   VOID
 266   )
 267 {
 268   return EFI_SUCCESS;
 269 }