]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/BdsDxe/Bds.h
Update the code to following EDK coding style document.
[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / Bds.h
1 /** @file
2 Head file for BDS Architectural Protocol implementation
3
4 Copyright (c) 2004 - 2008, 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 #undef EFI_SPECIFICATION_VERSION
19 #define EFI_SPECIFICATION_VERSION 0x0002000A
20 #include <PiDxe.h>
21 #include <MdeModuleHii.h>
22
23 #include <Guid/FileSystemVolumeLabelInfo.h>
24 #include <Protocol/DevicePath.h>
25 #include <Guid/BootState.h>
26 #include <Guid/DataHubRecords.h>
27 #include <Protocol/LoadFile.h>
28 #include <Protocol/CpuIo.h>
29 #include <Guid/HobList.h>
30 #include <Guid/FileInfo.h>
31 #include <Protocol/HiiConfigRouting.h>
32 #include <Protocol/Bds.h>
33 #include <Protocol/DataHub.h>
34 #include <Protocol/UgaDraw.h>
35 #include <Protocol/BlockIo.h>
36 #include <Guid/GlobalVariable.h>
37 #include <Guid/GenericPlatformVariable.h>
38 #include <Guid/CapsuleVendor.h>
39 #include <Protocol/ConsoleControl.h>
40 #include <Protocol/GenericMemoryTest.h>
41 #include <Protocol/FormBrowser2.h>
42 #include <Protocol/HiiConfigAccess.h>
43 #include <Protocol/GraphicsOutput.h>
44 #include <Protocol/SimpleFileSystem.h>
45 #include <Protocol/HiiDatabase.h>
46 #include <Protocol/HiiString.h>
47 #include <Protocol/SerialIo.h>
48 #include <Protocol/LegacyBios.h>
49 #include <Protocol/SimpleTextInEx.h>
50 #include <Protocol/Performance.h>
51
52 #include <Library/UefiDriverEntryPoint.h>
53 #include <Library/PrintLib.h>
54 #include <Library/DebugLib.h>
55 #include <Library/BaseMemoryLib.h>
56 #include <Library/UefiBootServicesTableLib.h>
57 #include <Library/UefiLib.h>
58 #include <Library/GraphicsLib.h>
59 #include <Library/MemoryAllocationLib.h>
60 #include <Library/DxeServicesTableLib.h>
61 #include <Library/PerformanceLib.h>
62 #include <Library/ReportStatusCodeLib.h>
63 #include <Library/IfrSupportLib.h>
64 #include <Library/ExtendedIfrSupportLib.h>
65 #include <Library/UefiRuntimeServicesTableLib.h>
66 #include <Library/HobLib.h>
67 #include <Library/BaseLib.h>
68 #include <Library/DevicePathLib.h>
69 #include <Library/PcdLib.h>
70 #include <Library/CapsuleLib.h>
71 #include <Library/HiiLib.h>
72 #include <Library/ExtendedHiiLib.h>
73
74
75 #include <Library/GenericBdsLib.h>
76 #include <Library/PlatformBdsLib.h>
77
78 #define EFI_BDS_ARCH_PROTOCOL_INSTANCE_FROM_THIS(_this) \
79 CR (_this, \
80 EFI_BDS_ARCH_PROTOCOL_INSTANCE, \
81 Bds, \
82 EFI_BDS_ARCH_PROTOCOL_INSTANCE_SIGNATURE \
83 )
84
85 EFI_STATUS
86 PlatformBdsShowProgress (
87 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,
88 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,
89 IN CHAR16 *Title,
90 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,
91 IN UINTN Progress,
92 IN UINTN PreviousValue
93 );
94
95 //
96 // Prototypes
97 //
98
99 /**
100
101 Install Boot Device Selection Protocol
102
103
104 @param ImageHandle The image handle.
105 @param SystemTable The system table.
106
107 @retval EFI_SUCEESS BDS has finished initializing.
108 Rerun the
109 dispatcher and recall BDS.Entry
110 @retval Other Return value from AllocatePool()
111 or gBS->InstallProtocolInterface
112
113 **/
114 EFI_STATUS
115 EFIAPI
116 BdsInitialize (
117 IN EFI_HANDLE ImageHandle,
118 IN EFI_SYSTEM_TABLE *SystemTable
119 );
120
121 /**
122
123 Service routine for BdsInstance->Entry(). Devices are connected, the
124 consoles are initialized, and the boot options are tried.
125
126
127 @param This - Protocol Instance structure.
128
129 @retval EFI_SUCEESS BDS->Entry has finished executing.
130
131 **/
132 VOID
133 EFIAPI
134 BdsEntry (
135 IN EFI_BDS_ARCH_PROTOCOL *This
136 );
137
138 #endif