ProcessCapsule() and BdsMemoryTest() are implemented in the BdsDxe module, which...
[mirror_edk2.git] / IntelFrameworkModulePkg / Library / PlatformBdsLibNull / BdsPlatform.c
CommitLineData
ddac74d1 1/** @file\r
2 This file include all platform action which can be customized by IBV/OEM.\r
3\r
4Copyright (c) 2004 - 2008, Intel Corporation. <BR>\r
5All rights reserved. This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#include "BdsPlatform.h"\r
16\r
17//\r
18// BDS Platform Functions\r
19//\r
20/**\r
21 Platform Bds init. Include the platform firmware vendor, revision\r
22 and so crc check.\r
23\r
ddac74d1 24**/\r
25VOID\r
26EFIAPI\r
27PlatformBdsInit (\r
f7cdf5cd 28 VOID\r
ddac74d1 29 )\r
30{\r
ddac74d1 31}\r
32\r
33/**\r
34 Connect the predefined platform default console device. Always try to find\r
35 and enable the vga device if have.\r
36\r
37 @param PlatformConsole Predefined platform default console device array.\r
38\r
39 @retval EFI_SUCCESS Success connect at least one ConIn and ConOut\r
40 device, there must have one ConOut device is\r
41 active vga device.\r
42 @return Return the status of BdsLibConnectAllDefaultConsoles ()\r
43\r
44**/\r
45EFI_STATUS\r
46PlatformBdsConnectConsole (\r
47 IN BDS_CONSOLE_CONNECT_ENTRY *PlatformConsole\r
48 )\r
49{\r
50 return EFI_SUCCESS;\r
51}\r
52\r
53/**\r
54 Connect with predefined platform connect sequence,\r
55 the OEM/IBV can customize with their own connect sequence.\r
56**/\r
57VOID\r
58PlatformBdsConnectSequence (\r
59 VOID\r
60 )\r
61{\r
ddac74d1 62}\r
63\r
64/**\r
65 Load the predefined driver option, OEM/IBV can customize this\r
66 to load their own drivers\r
67\r
68 @param BdsDriverLists - The header of the driver option link list.\r
69\r
70**/\r
71VOID\r
72PlatformBdsGetDriverOption (\r
73 IN OUT LIST_ENTRY *BdsDriverLists\r
74 )\r
75{\r
ddac74d1 76}\r
77\r
78/**\r
79 Perform the platform diagnostic, such like test memory. OEM/IBV also\r
80 can customize this function to support specific platform diagnostic.\r
81\r
82 @param MemoryTestLevel The memory test intensive level\r
83 @param QuietBoot Indicate if need to enable the quiet boot\r
84\r
85**/\r
86VOID\r
87PlatformBdsDiagnostics (\r
88 IN EXTENDMEM_COVERAGE_LEVEL MemoryTestLevel,\r
89 IN BOOLEAN QuietBoot\r
90 )\r
91{\r
ddac74d1 92}\r
93\r
94/**\r
95 The function will execute with as the platform policy, current policy\r
96 is driven by boot mode. IBV/OEM can customize this code for their specific\r
97 policy action.\r
98\r
ddac74d1 99 @param DriverOptionList The header of the driver option link list\r
100 @param BootOptionList The header of the boot option link list\r
101\r
102**/\r
103VOID\r
104EFIAPI\r
105PlatformBdsPolicyBehavior (\r
ddac74d1 106 IN LIST_ENTRY *DriverOptionList,\r
107 IN LIST_ENTRY *BootOptionList\r
108 )\r
109{\r
ddac74d1 110}\r
111\r
112/**\r
113 Hook point after a boot attempt succeeds. We don't expect a boot option to\r
114 return, so the UEFI 2.0 specification defines that you will default to an\r
115 interactive mode and stop processing the BootOrder list in this case. This\r
116 is also a platform implementation and can be customized by IBV/OEM.\r
117\r
118 @param Option Pointer to Boot Option that succeeded to boot.\r
119\r
120**/\r
121VOID\r
122EFIAPI\r
123PlatformBdsBootSuccess (\r
124 IN BDS_COMMON_OPTION *Option\r
125 )\r
126{\r
ddac74d1 127}\r
128\r
129/**\r
130 Hook point after a boot attempt fails.\r
131\r
132 @param Option Pointer to Boot Option that failed to boot.\r
133 @param Status Status returned from failed boot.\r
134 @param ExitData Exit data returned from failed boot.\r
135 @param ExitDataSize Exit data size returned from failed boot.\r
136\r
137**/\r
138VOID\r
139EFIAPI\r
140PlatformBdsBootFail (\r
141 IN BDS_COMMON_OPTION *Option,\r
142 IN EFI_STATUS Status,\r
143 IN CHAR16 *ExitData,\r
144 IN UINTN ExitDataSize\r
145 )\r
146{\r
ddac74d1 147}\r
148\r
149/**\r
150 This function is remained for IBV/OEM to do some platform action,\r
151 if there no console device can be connected.\r
152\r
153 @return EFI_SUCCESS Direct return success now.\r
154\r
155**/\r
156EFI_STATUS\r
157PlatformBdsNoConsoleAction (\r
158 VOID\r
159 )\r
160{\r
161 return EFI_SUCCESS;\r
162}\r
163\r
164/**\r
165 This function locks platform flash that is not allowed to be updated during normal boot path.\r
166 The flash layout is platform specific.\r
ddac74d1 167**/\r
63b67687 168VOID\r
ddac74d1 169EFIAPI\r
170PlatformBdsLockNonUpdatableFlash (\r
171 VOID\r
172 )\r
173{\r
63b67687
LG
174 return ;\r
175}\r
176\r
177\r
178/**\r
179 Lock the ConsoleIn device in system table. All key\r
180 presses will be ignored until the Password is typed in. The only way to\r
181 disable the password is to type it in to a ConIn device.\r
182\r
183 @param Password Password used to lock ConIn device.\r
184\r
185 @retval EFI_SUCCESS lock the Console In Spliter virtual handle successfully.\r
186 @retval EFI_UNSUPPORTED Password not found\r
187\r
188**/\r
189EFI_STATUS\r
190EFIAPI\r
191LockKeyboards (\r
192 IN CHAR16 *Password\r
193 )\r
194{\r
195 return EFI_UNSUPPORTED;\r
ddac74d1 196}\r