MdeModulePkg/Library/PlatformBdsLibNull/BdsPlatform.c

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