Fix a bug that process received data twice, it will cause serial work incorrect.
[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
19#include <Protocol/Bds.h>\r
20#include <Protocol/GenericMemoryTest.h>\r
1a0e3ddc 21#include <Library/GenericBdsLib.h>\r
ddac74d1 22\r
ddac74d1 23/**\r
727fed5a 24 Platform Bds initialization. Includes the platform firmware vendor, revision\r
ddac74d1 25 and so crc check.\r
26\r
ddac74d1 27**/\r
28VOID\r
29EFIAPI\r
30PlatformBdsInit (\r
f7cdf5cd 31 VOID\r
ddac74d1 32 );\r
33\r
34/**\r
35 The function will excute with as the platform policy, current policy\r
36 is driven by boot mode. IBV/OEM can customize this code for their specific\r
37 policy action.\r
38\r
ddac74d1 39 @param DriverOptionList The header of the driver option link list\r
40 @param BootOptionList The header of the boot option link list\r
41\r
42**/\r
43VOID\r
44EFIAPI\r
45PlatformBdsPolicyBehavior (\r
ddac74d1 46 IN LIST_ENTRY *DriverOptionList,\r
47 IN LIST_ENTRY *BootOptionList\r
48 );\r
49\r
50/**\r
51 Hook point after a boot attempt fails.\r
52\r
53 @param Option Pointer to Boot Option that failed to boot.\r
54 @param Status Status returned from failed boot.\r
55 @param ExitData Exit data returned from failed boot.\r
56 @param ExitDataSize Exit data size returned from failed boot.\r
57\r
58**/\r
59VOID\r
60EFIAPI\r
61PlatformBdsBootFail (\r
62 IN BDS_COMMON_OPTION *Option,\r
63 IN EFI_STATUS Status,\r
64 IN CHAR16 *ExitData,\r
65 IN UINTN ExitDataSize\r
66 );\r
67\r
68/**\r
69 Hook point after a boot attempt succeeds. We don't expect a boot option to\r
70 return, so the UEFI 2.0 specification defines that you will default to an\r
71 interactive mode and stop processing the BootOrder list in this case. This\r
727fed5a 72 is also a platform implementation, and can be customized by an IBV/OEM.\r
ddac74d1 73\r
727fed5a 74 @param Option Pointer to Boot Option that successfully booted.\r
ddac74d1 75\r
76**/\r
77VOID\r
78EFIAPI\r
79PlatformBdsBootSuccess (\r
80 IN BDS_COMMON_OPTION *Option\r
81 );\r
82\r
83\r
84/**\r
85 This function locks platform flash that is not allowed to be updated during normal boot path.\r
86 The flash layout is platform specific.\r
87\r
88 @retval EFI_SUCCESS The non-updatable flash areas.\r
89**/\r
90EFI_STATUS\r
91EFIAPI\r
92PlatformBdsLockNonUpdatableFlash (\r
93 VOID\r
94 );\r
95#endif\r