2 Platform BDS library definition. Platform package can provide hook library
3 instances to implement platform specific behavior.
5 Copyright (c) 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
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.
16 #ifndef __PLATFORM_BDS_LIB_H_
17 #define __PLATFORM_BDS_LIB_H_
19 #include <Protocol/Bds.h>
20 #include <Protocol/GenericMemoryTest.h>
21 #include <Library/GenericBdsLib.h>
24 // Bds AP Context data
26 #define EFI_BDS_ARCH_PROTOCOL_INSTANCE_SIGNATURE SIGNATURE_32 ('B', 'd', 's', 'A')
27 typedef struct _EFI_BDS_ARCH_PROTOCOL_INSTANCE EFI_BDS_ARCH_PROTOCOL_INSTANCE
;
29 struct _EFI_BDS_ARCH_PROTOCOL_INSTANCE
{
32 EFI_BDS_ARCH_PROTOCOL Bds
;
34 /// Save the current boot mode
36 EFI_BOOT_MODE BootMode
;
38 /// Set true if boot with default settings
42 /// The system default timeout for choose the boot option
44 UINT16 TimeoutDefault
;
48 EXTENDMEM_COVERAGE_LEVEL MemoryTestLevel
;
52 Platform Bds init. Include the platform firmware vendor, revision
55 @param PrivateData The EFI_BDS_ARCH_PROTOCOL_INSTANCE instance
61 IN EFI_BDS_ARCH_PROTOCOL_INSTANCE
*PrivateData
65 The function will excute with as the platform policy, current policy
66 is driven by boot mode. IBV/OEM can customize this code for their specific
69 @param PrivateData The EFI_BDS_ARCH_PROTOCOL_INSTANCE instance
70 @param DriverOptionList The header of the driver option link list
71 @param BootOptionList The header of the boot option link list
76 PlatformBdsPolicyBehavior (
77 IN EFI_BDS_ARCH_PROTOCOL_INSTANCE
*PrivateData
,
78 IN LIST_ENTRY
*DriverOptionList
,
79 IN LIST_ENTRY
*BootOptionList
83 Hook point after a boot attempt fails.
85 @param Option Pointer to Boot Option that failed to boot.
86 @param Status Status returned from failed boot.
87 @param ExitData Exit data returned from failed boot.
88 @param ExitDataSize Exit data size returned from failed boot.
94 IN BDS_COMMON_OPTION
*Option
,
101 Hook point after a boot attempt succeeds. We don't expect a boot option to
102 return, so the UEFI 2.0 specification defines that you will default to an
103 interactive mode and stop processing the BootOrder list in this case. This
104 is alos a platform implementation and can be customized by IBV/OEM.
106 @param Option Pointer to Boot Option that succeeded to boot.
111 PlatformBdsBootSuccess (
112 IN BDS_COMMON_OPTION
*Option
117 This function locks platform flash that is not allowed to be updated during normal boot path.
118 The flash layout is platform specific.
120 @retval EFI_SUCCESS The non-updatable flash areas.
124 PlatformBdsLockNonUpdatableFlash (