ProcessCapsule() and BdsMemoryTest() are implemented in the BdsDxe module, which...
[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Library / PlatformBdsLib.h
CommitLineData
ddac74d1 1/** @file\r
727fed5a 2 Platform BDS library definition. A platform can implement \r
3 instances to support platform-specific behavior.\r
ddac74d1 4\r
920d2c23 5Copyright (c) 2008 - 2009, Intel Corporation. <BR>\r
ddac74d1 6All rights reserved. This program and the accompanying materials\r
7are licensed and made available under the terms and conditions of the BSD License\r
8which accompanies this distribution. The full text of the license may be found at\r
9http://opensource.org/licenses/bsd-license.php\r
10\r
11THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#ifndef __PLATFORM_BDS_LIB_H_\r
17#define __PLATFORM_BDS_LIB_H_\r
18\r
ddac74d1 19#include <Protocol/GenericMemoryTest.h>\r
1a0e3ddc 20#include <Library/GenericBdsLib.h>\r
ddac74d1 21\r
ddac74d1 22/**\r
727fed5a 23 Platform Bds initialization. Includes the platform firmware vendor, revision\r
ddac74d1 24 and so crc check.\r
25\r
ddac74d1 26**/\r
27VOID\r
28EFIAPI\r
29PlatformBdsInit (\r
f7cdf5cd 30 VOID\r
ddac74d1 31 );\r
32\r
33/**\r
34 The function will excute with as the platform policy, current policy\r
35 is driven by boot mode. IBV/OEM can customize this code for their specific\r
36 policy action.\r
37\r
ddac74d1 38 @param DriverOptionList The header of the driver option link list\r
39 @param BootOptionList The header of the boot option link list\r
40\r
41**/\r
42VOID\r
43EFIAPI\r
44PlatformBdsPolicyBehavior (\r
ddac74d1 45 IN LIST_ENTRY *DriverOptionList,\r
46 IN LIST_ENTRY *BootOptionList\r
47 );\r
48\r
49/**\r
50 Hook point after a boot attempt fails.\r
51\r
52 @param Option Pointer to Boot Option that failed to boot.\r
53 @param Status Status returned from failed boot.\r
54 @param ExitData Exit data returned from failed boot.\r
55 @param ExitDataSize Exit data size returned from failed boot.\r
56\r
57**/\r
58VOID\r
59EFIAPI\r
60PlatformBdsBootFail (\r
61 IN BDS_COMMON_OPTION *Option,\r
62 IN EFI_STATUS Status,\r
63 IN CHAR16 *ExitData,\r
64 IN UINTN ExitDataSize\r
65 );\r
66\r
67/**\r
68 Hook point after a boot attempt succeeds. We don't expect a boot option to\r
69 return, so the UEFI 2.0 specification defines that you will default to an\r
70 interactive mode and stop processing the BootOrder list in this case. This\r
727fed5a 71 is also a platform implementation, and can be customized by an IBV/OEM.\r
ddac74d1 72\r
727fed5a 73 @param Option Pointer to Boot Option that successfully booted.\r
ddac74d1 74\r
75**/\r
76VOID\r
77EFIAPI\r
78PlatformBdsBootSuccess (\r
971d3ab1 79 IN BDS_COMMON_OPTION *Option\r
ddac74d1 80 );\r
81\r
82\r
83/**\r
84 This function locks platform flash that is not allowed to be updated during normal boot path.\r
85 The flash layout is platform specific.\r
86\r
24cdd14e
LG
87 **/\r
88VOID\r
ddac74d1 89EFIAPI\r
90PlatformBdsLockNonUpdatableFlash (\r
91 VOID\r
92 );\r
24cdd14e
LG
93\r
94/**\r
95 Lock the ConsoleIn device in system table. All key\r
96 presses will be ignored until the Password is typed in. The only way to\r
97 disable the password is to type it in to a ConIn device.\r
98\r
99 @param Password Password used to lock ConIn device.\r
100\r
101 @retval EFI_SUCCESS lock the Console In Spliter virtual handle successfully.\r
102 @retval EFI_UNSUPPORTED Password not found\r
103\r
104**/\r
105EFI_STATUS\r
106EFIAPI\r
107LockKeyboards (\r
108 IN CHAR16 *Password\r
109 );\r
110\r
ddac74d1 111#endif\r