]> git.proxmox.com Git - mirror_edk2.git/blob - IntelFrameworkModulePkg/Universal/BdsDxe/Bds.h
Remove unnecessary reference to CPU I/O Protocol.
[mirror_edk2.git] / IntelFrameworkModulePkg / Universal / BdsDxe / Bds.h
1 /** @file
2 Head file for BDS Architectural Protocol implementation
3
4 Copyright (c) 2004 - 2009, Intel Corporation. <BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #ifndef _BDS_MODULE_H_
16 #define _BDS_MODULE_H_
17
18 #include <FrameworkDxe.h>
19 #include <IndustryStandard/PeImage.h>
20 #include <Guid/MdeModuleHii.h>
21 #include <Guid/FileSystemVolumeLabelInfo.h>
22 #include <Guid/HiiPlatformSetupFormset.h>
23 #include <Protocol/DevicePath.h>
24 #include <IndustryStandard/SmBios.h>
25 #include <Protocol/LoadFile.h>
26 #include <Guid/FileInfo.h>
27 #include <Protocol/HiiConfigRouting.h>
28 #include <Protocol/Bds.h>
29 #include <Protocol/Smbios.h>
30 #include <Protocol/UgaDraw.h>
31 #include <Protocol/BlockIo.h>
32 #include <Guid/GlobalVariable.h>
33 #include <Guid/CapsuleVendor.h>
34 #include <Guid/StatusCodeDataTypeId.h>
35 #include <Protocol/GenericMemoryTest.h>
36 #include <Protocol/FormBrowser2.h>
37 #include <Protocol/HiiConfigAccess.h>
38 #include <Protocol/GraphicsOutput.h>
39 #include <Protocol/SimpleFileSystem.h>
40 #include <Protocol/HiiDatabase.h>
41 #include <Protocol/HiiString.h>
42 #include <Protocol/SerialIo.h>
43 #include <Protocol/LegacyBios.h>
44 #include <Protocol/SimpleTextInEx.h>
45 #include <Protocol/DriverHealth.h>
46
47 #include <Library/UefiDriverEntryPoint.h>
48 #include <Library/PrintLib.h>
49 #include <Library/DebugLib.h>
50 #include <Library/BaseMemoryLib.h>
51 #include <Library/UefiBootServicesTableLib.h>
52 #include <Library/UefiLib.h>
53 #include <Library/MemoryAllocationLib.h>
54 #include <Library/PerformanceLib.h>
55 #include <Library/ReportStatusCodeLib.h>
56 #include <Library/UefiRuntimeServicesTableLib.h>
57 #include <Library/HobLib.h>
58 #include <Library/BaseLib.h>
59 #include <Library/DevicePathLib.h>
60 #include <Library/PcdLib.h>
61 #include <Library/CapsuleLib.h>
62 #include <Library/HiiLib.h>
63 #include <Library/DevicePathLib.h>
64 #include <Library/PcdLib.h>
65 #include <Library/UefiHiiServicesLib.h>
66
67 #include <Library/GenericBdsLib.h>
68 #include <Library/PlatformBdsLib.h>
69
70 #pragma pack(1)
71
72 ///
73 /// HII specific Vendor Device Path definition.
74 ///
75 typedef struct {
76 VENDOR_DEVICE_PATH VendorDevicePath;
77 EFI_DEVICE_PATH_PROTOCOL End;
78 } HII_VENDOR_DEVICE_PATH;
79
80 #pragma pack()
81
82 /**
83
84 Show progress bar with title above it. It only works in Graphics mode.
85
86 @param TitleForeground Foreground color for Title.
87 @param TitleBackground Background color for Title.
88 @param Title Title above progress bar.
89 @param ProgressColor Progress bar color.
90 @param Progress Progress (0-100)
91 @param PreviousValue The previous value of the progress.
92
93 @retval EFI_STATUS Success update the progress bar
94
95 **/
96 EFI_STATUS
97 PlatformBdsShowProgress (
98 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,
99 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,
100 IN CHAR16 *Title,
101 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,
102 IN UINTN Progress,
103 IN UINTN PreviousValue
104 );
105
106 //
107 // Prototypes
108 //
109
110 /**
111
112 Install Boot Device Selection Protocol
113
114 @param ImageHandle The image handle.
115 @param SystemTable The system table.
116
117 @retval EFI_SUCEESS BDS has finished initializing.
118 Return the dispatcher and recall BDS.Entry
119 @retval Other Return status from AllocatePool() or gBS->InstallProtocolInterface
120
121 **/
122 EFI_STATUS
123 EFIAPI
124 BdsInitialize (
125 IN EFI_HANDLE ImageHandle,
126 IN EFI_SYSTEM_TABLE *SystemTable
127 );
128
129 /**
130
131 Service routine for BdsInstance->Entry(). Devices are connected, the
132 consoles are initialized, and the boot options are tried.
133
134 @param This Protocol Instance structure.
135
136 **/
137 VOID
138 EFIAPI
139 BdsEntry (
140 IN EFI_BDS_ARCH_PROTOCOL *This
141 );
142
143
144 /**
145 Perform the memory test base on the memory test intensive level,
146 and update the memory resource.
147
148 @param Level The memory test intensive level.
149
150 @retval EFI_STATUS Success test all the system memory and update
151 the memory resource
152
153 **/
154 EFI_STATUS
155 BdsMemoryTest (
156 IN EXTENDMEM_COVERAGE_LEVEL Level
157 );
158
159 /**
160
161 This routine is called to see if there are any capsules we need to process.
162 If the boot mode is not UPDATE, then we do nothing. Otherwise find the
163 capsule HOBS and produce firmware volumes for them via the DXE service.
164 Then call the dispatcher to dispatch drivers from them. Finally, check
165 the status of the updates.
166
167 This function should be called by BDS in case we need to do some
168 sort of processing even if there is no capsule to process. We
169 need to do this if an earlier update went away and we need to
170 clear the capsule variable so on the next reset PEI does not see it and
171 think there is a capsule available.
172
173 @param BootMode the current boot mode
174
175 @retval EFI_INVALID_PARAMETER boot mode is not correct for an update
176 @retval EFI_SUCCESS There is no error when processing capsule
177
178 **/
179 EFI_STATUS
180 BdsProcessCapsules (
181 EFI_BOOT_MODE BootMode
182 );
183
184 #endif