[mirror_edk2.git] / MdeModulePkg / Include / Library / GenericBdsLib.h

/*++\r
\r
Copyright (c) 2004 - 2007, Intel Corporation                                                         \r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
Module Name:\r
\r
  GenericBdsLib.h\r
\r
Abstract:\r
\r
  Generic BDS library definition, include the file and data structure\r
\r
--*/\r
\r
#ifndef _GENERIC_BDS_LIB_H_\r
#define _GENERIC_BDS_LIB_H_\r
\r
//\r
// WQBugBug: These Macro will be handled properly later.\r
//\r
//#undef EFI_SPECIFICATION_VERSION\r
//#define EFI_SPECIFICATION_VERSION 0x0002000A\r
\r
#define PI_SPECIFICATION_VERSION 0x00010000\r
\r
#include <PiDxe.h>\r
#include <Protocol/HiiDatabase.h>\r
#include <IndustryStandard/PeImage.h>\r
\r
\r
extern EFI_HANDLE mBdsImageHandle;\r
\r
//\r
// Constants which are variable names used to access variables\r
//\r
#define VarLegacyDevOrder L"LegacyDevOrder"\r
\r
//\r
// Data structures and defines\r
//\r
#define FRONT_PAGE_QUESTION_ID  0x0000\r
#define FRONT_PAGE_DATA_WIDTH   0x01\r
\r
//\r
// ConnectType\r
//\r
#define CONSOLE_OUT 0x00000001\r
#define STD_ERROR   0x00000002\r
#define CONSOLE_IN  0x00000004\r
#define CONSOLE_ALL (CONSOLE_OUT | CONSOLE_IN | STD_ERROR)\r
\r
//\r
// Load Option Attributes defined in EFI Specification\r
//\r
#define LOAD_OPTION_ACTIVE              0x00000001\r
#define LOAD_OPTION_FORCE_RECONNECT     0x00000002\r
\r
#if (EFI_SPECIFICATION_VERSION >= 0x0002000A)\r
#define LOAD_OPTION_HIDDEN              0x00000008\r
#define LOAD_OPTION_CATEGORY            0x00001F00\r
\r
#define LOAD_OPTION_CATEGORY_BOOT       0x00000000\r
#define LOAD_OPTION_CATEGORY_APP        0x00000100\r
\r
#define EFI_BOOT_OPTION_SUPPORT_KEY     0x00000001\r
#define EFI_BOOT_OPTION_SUPPORT_APP     0x00000002\r
#endif\r
\r
#define IS_LOAD_OPTION_TYPE(_c, _Mask)  (BOOLEAN) (((_c) & (_Mask)) != 0)\r
\r
//\r
// Define Maxmim characters that will be accepted\r
//\r
#define MAX_CHAR            480\r
#define MAX_CHAR_SIZE       (MAX_CHAR * 2)\r
\r
#define MIN_ALIGNMENT_SIZE  4\r
#define ALIGN_SIZE(a)       ((a % MIN_ALIGNMENT_SIZE) ? MIN_ALIGNMENT_SIZE - (a % MIN_ALIGNMENT_SIZE) : 0)\r
\r
//\r
// Define maximum characters for boot option variable "BootXXXX"\r
//\r
#define BOOT_OPTION_MAX_CHAR 10\r
\r
//\r
// This data structure is the part of BDS_CONNECT_ENTRY that we can hard code.\r
//\r
#define BDS_LOAD_OPTION_SIGNATURE EFI_SIGNATURE_32 ('B', 'd', 'C', 'O')\r
\r
typedef struct {\r
\r
  UINTN                     Signature;\r
  LIST_ENTRY                Link;\r
\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
\r
  CHAR16                    *OptionName;\r
  UINTN                     OptionNumber;\r
  UINT16                    BootCurrent;\r
  UINT32                    Attribute;\r
  CHAR16                    *Description;\r
  VOID                      *LoadOptions;\r
  UINT32                    LoadOptionsSize;\r
  CHAR16                    *StatusString;\r
\r
} BDS_COMMON_OPTION;\r
\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL  *DevicePath;\r
  UINTN                     ConnectType;\r
} BDS_CONSOLE_CONNECT_ENTRY;\r
\r
//\r
// Lib Functions\r
//\r
\r
//\r
// Bds boot relate lib functions\r
//\r
EFI_STATUS\r
BdsLibUpdateBootOrderList (\r
  IN  LIST_ENTRY                 *BdsOptionList,\r
  IN  CHAR16                         *VariableName\r
  );\r
\r
VOID\r
BdsLibBootNext (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
BdsLibBootViaBootOption (\r
  IN  BDS_COMMON_OPTION             * Option,\r
  IN  EFI_DEVICE_PATH_PROTOCOL      * DevicePath,\r
  OUT UINTN                         *ExitDataSize,\r
  OUT CHAR16                        **ExitData OPTIONAL\r
  );\r
\r
EFI_STATUS\r
BdsLibEnumerateAllBootOption (\r
  IN OUT LIST_ENTRY    *BdsBootOptionList\r
  );\r
\r
VOID\r
BdsLibBuildOptionFromHandle (\r
  IN  EFI_HANDLE          Handle,\r
  IN  LIST_ENTRY      *BdsBootOptionList,\r
  IN  CHAR16              *String\r
  );\r
\r
VOID\r
BdsLibBuildOptionFromShell (\r
  IN  EFI_HANDLE                     Handle,\r
  IN  LIST_ENTRY                 *BdsBootOptionList\r
  );\r
\r
//\r
// Bds misc lib functions\r
//\r
UINT16\r
BdsLibGetTimeout (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
BdsLibGetBootMode (\r
  OUT EFI_BOOT_MODE       *BootMode\r
  );\r
\r
VOID\r
BdsLibLoadDrivers (\r
  IN  LIST_ENTRY              *BdsDriverLists\r
  );\r
\r
EFI_STATUS\r
BdsLibBuildOptionFromVar (\r
  IN  LIST_ENTRY              *BdsCommonOptionList,\r
  IN  CHAR16                      *VariableName\r
  );\r
\r
VOID                      *\r
BdsLibGetVariableAndSize (\r
  IN  CHAR16              *Name,\r
  IN  EFI_GUID            *VendorGuid,\r
  OUT UINTN               *VariableSize\r
  );\r
\r
EFI_STATUS\r
BdsLibOutputStrings (\r
  IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   *ConOut,\r
  ...\r
  );\r
\r
BDS_COMMON_OPTION         *\r
BdsLibVariableToOption (\r
  IN OUT LIST_ENTRY               *BdsCommonOptionList,\r
  IN CHAR16                           *VariableName\r
  );\r
\r
EFI_STATUS\r
BdsLibRegisterNewOption (\r
  IN  LIST_ENTRY                 *BdsOptionList,\r
  IN  EFI_DEVICE_PATH_PROTOCOL       *DevicePath,\r
  IN  CHAR16                         *String,\r
  IN  CHAR16                         *VariableName\r
  );\r
\r
//\r
// Bds connect or disconnect driver lib funcion\r
//\r
VOID\r
BdsLibConnectAllDriversToAllControllers (\r
  VOID\r
  );\r
\r
VOID\r
BdsLibConnectAll (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
BdsLibConnectDevicePath (\r
  IN EFI_DEVICE_PATH_PROTOCOL  *DevicePathToConnect\r
  );\r
\r
EFI_STATUS\r
BdsLibConnectAllEfi (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
BdsLibDisconnectAllEfi (\r
  VOID\r
  );\r
\r
//\r
// Bds console relate lib functions\r
//\r
VOID\r
BdsLibConnectAllConsoles (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
BdsLibConnectAllDefaultConsoles (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
BdsLibUpdateConsoleVariable (\r
  IN  CHAR16                    *ConVarName,\r
  IN  EFI_DEVICE_PATH_PROTOCOL  *CustomizedConDevicePath,\r
  IN  EFI_DEVICE_PATH_PROTOCOL  *ExclusiveDevicePath\r
  );\r
\r
EFI_STATUS\r
BdsLibConnectConsoleVariable (\r
  IN  CHAR16                 *ConVarName\r
  );\r
\r
//\r
// Bds device path relate lib functions\r
//\r
EFI_DEVICE_PATH_PROTOCOL  *\r
BdsLibUnpackDevicePath (\r
  IN EFI_DEVICE_PATH_PROTOCOL  *DevPath\r
  );\r
\r
EFI_DEVICE_PATH_PROTOCOL *\r
BdsLibDelPartMatchInstance (\r
  IN     EFI_DEVICE_PATH_PROTOCOL  *Multi,\r
  IN     EFI_DEVICE_PATH_PROTOCOL  *Single\r
  );\r
\r
BOOLEAN\r
BdsLibMatchDevicePaths (\r
  IN  EFI_DEVICE_PATH_PROTOCOL  *Multi,\r
  IN  EFI_DEVICE_PATH_PROTOCOL  *Single\r
  );\r
\r
CHAR16                    *\r
DevicePathToStr (\r
  EFI_DEVICE_PATH_PROTOCOL     *DevPath\r
  );\r
\r
VOID                      *\r
EfiLibGetVariable (\r
  IN CHAR16               *Name,\r
  IN EFI_GUID             *VendorGuid\r
  );\r
\r
//\r
// Internal definitions\r
//\r
typedef struct {\r
  CHAR16  *str;\r
  UINTN   len;\r
  UINTN   maxlen;\r
} POOL_PRINT;\r
\r
typedef struct {\r
  UINT8 Type;\r
  UINT8 SubType;\r
  VOID (*Function) (POOL_PRINT *, VOID *);\r
} DEVICE_PATH_STRING_TABLE;\r
\r
extern EFI_GUID mEfiDevicePathMessagingUartFlowControlGuid;\r
\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL  Header;\r
  EFI_GUID                  Guid;\r
  UINT8                     VendorDefinedData[1];\r
} VENDOR_DEVICE_PATH_WITH_DATA;\r
\r
#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
\r
extern EFI_GUID mEfiDevicePathMessagingSASGuid;\r
\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL  Header;\r
  UINT16                    NetworkProtocol;\r
  UINT16                    LoginOption;\r
  UINT64                    Lun;\r
  UINT16                    TargetPortalGroupTag;\r
  CHAR16                    iSCSITargetName[1];\r
} ISCSI_DEVICE_PATH_WITH_NAME;\r
\r
#endif\r
\r
//\r
// Internal functions\r
//\r
EFI_STATUS\r
BdsBootByDiskSignatureAndPartition (\r
  IN  BDS_COMMON_OPTION          * Option,\r
  IN  HARDDRIVE_DEVICE_PATH      * HardDriveDevicePath,\r
  IN  UINT32                     LoadOptionsSize,\r
  IN  VOID                       *LoadOptions,\r
  OUT UINTN                      *ExitDataSize,\r
  OUT CHAR16                     **ExitData OPTIONAL\r
  );\r
\r
//\r
// Notes: EFI 64 shadow all option rom\r
//\r
#if defined (MDE_CPU_IPF)\r
#define EFI64_SHADOW_ALL_LEGACY_ROM() ShadowAllOptionRom ();\r
VOID\r
ShadowAllOptionRom();\r
#else\r
#define EFI64_SHADOW_ALL_LEGACY_ROM()\r
#endif\r
\r
//\r
// BBS support macros and functions\r
//\r
\r
#if defined(MDE_CPU_IA32) || defined(MDE_CPU_X64)\r
#define REFRESH_LEGACY_BOOT_OPTIONS \\r
        BdsDeleteAllInvalidLegacyBootOptions ();\\r
        BdsAddNonExistingLegacyBootOptions (); \\r
        BdsUpdateLegacyDevOrder ()\r
#else\r
#define REFRESH_LEGACY_BOOT_OPTIONS\r
#endif\r
\r
EFI_STATUS\r
BdsDeleteAllInvalidLegacyBootOptions (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
BdsAddNonExistingLegacyBootOptions (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
BdsUpdateLegacyDevOrder (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
BdsRefreshBbsTableForBoot (\r
  IN BDS_COMMON_OPTION        *Entry\r
  );\r
\r
EFI_STATUS\r
BdsDeleteBootOption (\r
  IN UINTN                       OptionNumber,\r
  IN OUT UINT16                  *BootOrder,\r
  IN OUT UINTN                   *BootOrderSize\r
  );\r
\r
//\r
//The interface functions relate with Setup Browser Reset Reminder feature\r
//\r
VOID\r
EnableResetReminderFeature (\r
  VOID\r
  );\r
\r
VOID\r
DisableResetReminderFeature (\r
  VOID\r
  );\r
\r
VOID\r
EnableResetRequired (\r
  VOID\r
  );\r
\r
VOID\r
DisableResetRequired (\r
  VOID\r
  );\r
\r
BOOLEAN\r
IsResetReminderFeatureEnable (\r
  VOID\r
  );\r
\r
BOOLEAN\r
IsResetRequired (\r
  VOID\r
  );\r
\r
VOID\r
SetupResetReminder (\r
  VOID\r
  );\r
\r
EFI_STATUS\r
BdsLibGetImageHeader (\r
  IN  EFI_HANDLE                  Device,\r
  IN  CHAR16                      *FileName,\r
  OUT EFI_IMAGE_DOS_HEADER        *DosHeader,\r
  OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION   Hdr\r
  )\r
;\r
\r
EFI_STATUS\r
BdsLibGetHiiHandles (\r
#if (EFI_SPECIFICATION_VERSION >= 0x0002000A)\r
  IN     EFI_HII_DATABASE_PROTOCOL *HiiDatabase,\r
#else\r
  IN     EFI_HII_PROTOCOL          *Hii,\r
#endif\r
  IN OUT UINT16                    *HandleBufferLength,\r
  OUT    EFI_HII_HANDLE            **HiiHandleBuffer\r
  );\r
  \r
//\r
// Define the boot type which to classify the boot option type\r
// Different boot option type could have different boot behavior\r
// Use their device path node (Type + SubType) as type value\r
// The boot type here can be added according to requirement\r
//\r
//\r
// ACPI boot type. For ACPI device, cannot use sub-type to distinguish device, so hardcode their value\r
//\r
#define  BDS_EFI_ACPI_FLOPPY_BOOT         0x0201\r
//\r
// Message boot type\r
// If a device path of boot option only point to a message node, the boot option is message boot type\r
//\r
#define  BDS_EFI_MESSAGE_ATAPI_BOOT       0x0301 // Type 03; Sub-Type 01\r
#define  BDS_EFI_MESSAGE_SCSI_BOOT        0x0302 // Type 03; Sub-Type 02\r
#define  BDS_EFI_MESSAGE_USB_DEVICE_BOOT  0x0305 // Type 03; Sub-Type 05\r
#define  BDS_EFI_MESSAGE_MISC_BOOT        0x03FF\r
//\r
// Media boot type\r
// If a device path of boot option contain a media node, the boot option is media boot type\r
//\r
#define  BDS_EFI_MEDIA_HD_BOOT            0x0401 // Type 04; Sub-Type 01\r
#define  BDS_EFI_MEDIA_CDROM_BOOT         0x0402 // Type 04; Sub-Type 02\r
//\r
// BBS boot type\r
// If a device path of boot option contain a BBS node, the boot option is BBS boot type\r
//\r
#define  BDS_LEGACY_BBS_BOOT              0x0501 //  Type 05; Sub-Type 01\r
\r
#define  BDS_EFI_UNSUPPORT                0xFFFF\r
\r
//\r
// USB host controller Programming Interface.\r
//\r
#define  PCI_CLASSC_PI_UHCI               0x00\r
#define  PCI_CLASSC_PI_EHCI               0x20\r
\r
BOOLEAN\r
MatchPartitionDevicePathNode (\r
  IN  EFI_DEVICE_PATH_PROTOCOL   *BlockIoDevicePath,\r
  IN  HARDDRIVE_DEVICE_PATH      *HardDriveDevicePath\r
  );\r
  \r
EFI_DEVICE_PATH_PROTOCOL *\r
BdsExpandPartitionPartialDevicePathToFull (\r
  IN  HARDDRIVE_DEVICE_PATH      *HardDriveDevicePath\r
  );\r
  \r
EFI_HANDLE\r
BdsLibGetBootableHandle (\r
  IN  EFI_DEVICE_PATH_PROTOCOL      *DevicePath\r
  );\r
  \r
BOOLEAN\r
BdsLibIsValidEFIBootOptDevicePath (\r
  IN EFI_DEVICE_PATH_PROTOCOL     *DevPath,\r
  IN BOOLEAN                      CheckMedia\r
  );\r
  \r
UINT32\r
BdsGetBootTypeFromDevicePath (\r
  IN  EFI_DEVICE_PATH_PROTOCOL     *DevicePath\r
  );\r
  \r
VOID\r
EFIAPI\r
BdsLibSaveMemoryTypeInformation (\r
  VOID \r
  );\r
  \r
EFI_STATUS\r
EFIAPI\r
BdsLibUpdateFvFileDevicePath (\r
  IN  OUT EFI_DEVICE_PATH_PROTOCOL      ** DevicePath,\r
  IN  EFI_GUID                          *FileGuid\r
  );\r
\r
EFI_STATUS\r
BdsLibConnectUsbDevByShortFormDP (\r
  IN CHAR8                      HostControllerPI,\r
  IN EFI_DEVICE_PATH_PROTOCOL   *RemainingDevicePath\r
  );\r
  \r
EFI_TPL\r
BdsLibGetCurrentTpl (\r
  VOID\r
  );\r
\r
//\r
// The implementation of this function is provided by Platform code.\r
//\r
VOID\r
DevPathVendor (\r
  IN OUT POOL_PRINT       *Str,\r
  IN VOID                 *DevPath\r
  )\r
;\r
\r
CHAR16 *\r
CatPrint (\r
  IN OUT POOL_PRINT   *Str,\r
  IN CHAR16           *fmt,\r
  ...\r
  )\r
;\r
#endif // _BDS_LIB_H_\r
Commit	Line	Data
93e3992d	1	/*++\r
	2	\r
	3	Copyright (c) 2004 - 2007, Intel Corporation \r
	4	All rights reserved. This program and the accompanying materials \r
	5	are licensed and made available under the terms and conditions of the BSD License \r
	6	which accompanies this distribution. The full text of the license may be found at \r
	7	http://opensource.org/licenses/bsd-license.php \r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	11	\r
	12	Module Name:\r
	13	\r
	14	GenericBdsLib.h\r
	15	\r
	16	Abstract:\r
	17	\r
	18	Generic BDS library definition, include the file and data structure\r
	19	\r
	20	--*/\r
	21	\r
	22	#ifndef _GENERIC_BDS_LIB_H_\r
	23	#define _GENERIC_BDS_LIB_H_\r
	24	\r
	25	//\r
	26	// WQBugBug: These Macro will be handled properly later.\r
	27	//\r
	28	//#undef EFI_SPECIFICATION_VERSION\r
	29	//#define EFI_SPECIFICATION_VERSION 0x0002000A\r
	30	\r
	31	#define PI_SPECIFICATION_VERSION 0x00010000\r
	32	\r
	33	#include <PiDxe.h>\r
	34	#include <Protocol/HiiDatabase.h>\r
	35	#include <IndustryStandard/PeImage.h>\r
	36	\r
	37	\r
	38	extern EFI_HANDLE mBdsImageHandle;\r
	39	\r
	40	//\r
	41	// Constants which are variable names used to access variables\r
	42	//\r
	43	#define VarLegacyDevOrder L"LegacyDevOrder"\r
	44	\r
	45	//\r
	46	// Data structures and defines\r
	47	//\r
	48	#define FRONT_PAGE_QUESTION_ID 0x0000\r
	49	#define FRONT_PAGE_DATA_WIDTH 0x01\r
	50	\r
	51	//\r
	52	// ConnectType\r
	53	//\r
	54	#define CONSOLE_OUT 0x00000001\r
	55	#define STD_ERROR 0x00000002\r
	56	#define CONSOLE_IN 0x00000004\r
	57	#define CONSOLE_ALL (CONSOLE_OUT \| CONSOLE_IN \| STD_ERROR)\r
	58	\r
	59	//\r
	60	// Load Option Attributes defined in EFI Specification\r
	61	//\r
	62	#define LOAD_OPTION_ACTIVE 0x00000001\r
	63	#define LOAD_OPTION_FORCE_RECONNECT 0x00000002\r
	64	\r
65	#if (EFI_SPECIFICATION_VERSION >= 0x0002000A)\r
66	#define LOAD_OPTION_HIDDEN 0x00000008\r
67	#define LOAD_OPTION_CATEGORY 0x00001F00\r
68	\r
69	#define LOAD_OPTION_CATEGORY_BOOT 0x00000000\r
70	#define LOAD_OPTION_CATEGORY_APP 0x00000100\r
71	\r
72	#define EFI_BOOT_OPTION_SUPPORT_KEY 0x00000001\r
73	#define EFI_BOOT_OPTION_SUPPORT_APP 0x00000002\r
74	#endif\r
75	\r
76	#define IS_LOAD_OPTION_TYPE(_c, _Mask) (BOOLEAN) (((_c) & (_Mask)) != 0)\r
77	\r
78	//\r
79	// Define Maxmim characters that will be accepted\r
80	//\r
81	#define MAX_CHAR 480\r
82	#define MAX_CHAR_SIZE (MAX_CHAR * 2)\r
83	\r
84	#define MIN_ALIGNMENT_SIZE 4\r
85	#define ALIGN_SIZE(a) ((a % MIN_ALIGNMENT_SIZE) ? MIN_ALIGNMENT_SIZE - (a % MIN_ALIGNMENT_SIZE) : 0)\r
86	\r
87	//\r
88	// Define maximum characters for boot option variable "BootXXXX"\r
89	//\r
90	#define BOOT_OPTION_MAX_CHAR 10\r
91	\r
92	//\r
93	// This data structure is the part of BDS_CONNECT_ENTRY that we can hard code.\r
94	//\r
95	#define BDS_LOAD_OPTION_SIGNATURE EFI_SIGNATURE_32 ('B', 'd', 'C', 'O')\r
96	\r
97	typedef struct {\r
98	\r
99	UINTN Signature;\r
100	LIST_ENTRY Link;\r
101	\r
102	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
103	\r
104	CHAR16 *OptionName;\r
105	UINTN OptionNumber;\r
106	UINT16 BootCurrent;\r
107	UINT32 Attribute;\r
108	CHAR16 *Description;\r
109	VOID *LoadOptions;\r
110	UINT32 LoadOptionsSize;\r
111	CHAR16 *StatusString;\r
112	\r
113	} BDS_COMMON_OPTION;\r
114	\r
115	typedef struct {\r
116	EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
117	UINTN ConnectType;\r
118	} BDS_CONSOLE_CONNECT_ENTRY;\r
119	\r
120	//\r
121	// Lib Functions\r
122	//\r
123	\r
124	//\r
125	// Bds boot relate lib functions\r
126	//\r
127	EFI_STATUS\r
128	BdsLibUpdateBootOrderList (\r
129	IN LIST_ENTRY *BdsOptionList,\r
130	IN CHAR16 *VariableName\r
131	);\r
132	\r
133	VOID\r
134	BdsLibBootNext (\r
135	VOID\r
136	);\r
137	\r
138	EFI_STATUS\r
139	BdsLibBootViaBootOption (\r
140	IN BDS_COMMON_OPTION * Option,\r
141	IN EFI_DEVICE_PATH_PROTOCOL * DevicePath,\r
142	OUT UINTN *ExitDataSize,\r
143	OUT CHAR16 **ExitData OPTIONAL\r
144	);\r
145	\r
146	EFI_STATUS\r
147	BdsLibEnumerateAllBootOption (\r
148	IN OUT LIST_ENTRY *BdsBootOptionList\r
149	);\r
150	\r
151	VOID\r
152	BdsLibBuildOptionFromHandle (\r
153	IN EFI_HANDLE Handle,\r
154	IN LIST_ENTRY *BdsBootOptionList,\r
155	IN CHAR16 *String\r
156	);\r
157	\r
158	VOID\r
159	BdsLibBuildOptionFromShell (\r
160	IN EFI_HANDLE Handle,\r
161	IN LIST_ENTRY *BdsBootOptionList\r
162	);\r
163	\r
164	//\r
165	// Bds misc lib functions\r
166	//\r
167	UINT16\r
168	BdsLibGetTimeout (\r
169	VOID\r
170	);\r
171	\r
172	EFI_STATUS\r
173	BdsLibGetBootMode (\r
174	OUT EFI_BOOT_MODE *BootMode\r
175	);\r
176	\r
177	VOID\r
178	BdsLibLoadDrivers (\r
179	IN LIST_ENTRY *BdsDriverLists\r
180	);\r
181	\r
182	EFI_STATUS\r
183	BdsLibBuildOptionFromVar (\r
184	IN LIST_ENTRY *BdsCommonOptionList,\r
185	IN CHAR16 *VariableName\r
186	);\r
187	\r
188	VOID *\r
189	BdsLibGetVariableAndSize (\r
190	IN CHAR16 *Name,\r
191	IN EFI_GUID *VendorGuid,\r
192	OUT UINTN *VariableSize\r
193	);\r
194	\r
195	EFI_STATUS\r
196	BdsLibOutputStrings (\r
197	IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *ConOut,\r
198	...\r
199	);\r
200	\r
201	BDS_COMMON_OPTION *\r
202	BdsLibVariableToOption (\r
203	IN OUT LIST_ENTRY *BdsCommonOptionList,\r
204	IN CHAR16 *VariableName\r
205	);\r
206	\r
207	EFI_STATUS\r
208	BdsLibRegisterNewOption (\r
209	IN LIST_ENTRY *BdsOptionList,\r
210	IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
211	IN CHAR16 *String,\r
212	IN CHAR16 *VariableName\r
213	);\r
214	\r
215	//\r
216	// Bds connect or disconnect driver lib funcion\r
217	//\r
218	VOID\r
219	BdsLibConnectAllDriversToAllControllers (\r
220	VOID\r
221	);\r
222	\r
223	VOID\r
224	BdsLibConnectAll (\r
225	VOID\r
226	);\r
227	\r
228	EFI_STATUS\r
229	BdsLibConnectDevicePath (\r
230	IN EFI_DEVICE_PATH_PROTOCOL *DevicePathToConnect\r
231	);\r
232	\r
233	EFI_STATUS\r
234	BdsLibConnectAllEfi (\r
235	VOID\r
236	);\r
237	\r
238	EFI_STATUS\r
239	BdsLibDisconnectAllEfi (\r
240	VOID\r
241	);\r
242	\r
243	//\r
244	// Bds console relate lib functions\r
245	//\r
246	VOID\r
247	BdsLibConnectAllConsoles (\r
248	VOID\r
249	);\r
250	\r
251	EFI_STATUS\r
252	BdsLibConnectAllDefaultConsoles (\r
253	VOID\r
254	);\r
255	\r
256	EFI_STATUS\r
257	BdsLibUpdateConsoleVariable (\r
258	IN CHAR16 *ConVarName,\r
259	IN EFI_DEVICE_PATH_PROTOCOL *CustomizedConDevicePath,\r
260	IN EFI_DEVICE_PATH_PROTOCOL *ExclusiveDevicePath\r
261	);\r
262	\r
263	EFI_STATUS\r
264	BdsLibConnectConsoleVariable (\r
265	IN CHAR16 *ConVarName\r
266	);\r
267	\r
268	//\r
269	// Bds device path relate lib functions\r
270	//\r
271	EFI_DEVICE_PATH_PROTOCOL *\r
272	BdsLibUnpackDevicePath (\r
273	IN EFI_DEVICE_PATH_PROTOCOL *DevPath\r
274	);\r
275	\r
276	EFI_DEVICE_PATH_PROTOCOL *\r
277	BdsLibDelPartMatchInstance (\r
278	IN EFI_DEVICE_PATH_PROTOCOL *Multi,\r
279	IN EFI_DEVICE_PATH_PROTOCOL *Single\r
280	);\r
281	\r
282	BOOLEAN\r
283	BdsLibMatchDevicePaths (\r
284	IN EFI_DEVICE_PATH_PROTOCOL *Multi,\r
285	IN EFI_DEVICE_PATH_PROTOCOL *Single\r
286	);\r
287	\r
288	CHAR16 *\r
289	DevicePathToStr (\r
290	EFI_DEVICE_PATH_PROTOCOL *DevPath\r
291	);\r
292	\r
293	VOID *\r
294	EfiLibGetVariable (\r
295	IN CHAR16 *Name,\r
296	IN EFI_GUID *VendorGuid\r
297	);\r
298	\r
299	//\r
300	// Internal definitions\r
301	//\r
302	typedef struct {\r
303	CHAR16 *str;\r
304	UINTN len;\r
305	UINTN maxlen;\r
306	} POOL_PRINT;\r
307	\r
308	typedef struct {\r
309	UINT8 Type;\r
310	UINT8 SubType;\r
311	VOID (Function) (POOL_PRINT , VOID *);\r
312	} DEVICE_PATH_STRING_TABLE;\r
313	\r
314	extern EFI_GUID mEfiDevicePathMessagingUartFlowControlGuid;\r
315	\r
316	typedef struct {\r
317	EFI_DEVICE_PATH_PROTOCOL Header;\r
318	EFI_GUID Guid;\r
319	UINT8 VendorDefinedData[1];\r
320	} VENDOR_DEVICE_PATH_WITH_DATA;\r
321	\r
322	#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
323	\r
324	extern EFI_GUID mEfiDevicePathMessagingSASGuid;\r
325	\r
326	typedef struct {\r
327	EFI_DEVICE_PATH_PROTOCOL Header;\r
328	UINT16 NetworkProtocol;\r
329	UINT16 LoginOption;\r
330	UINT64 Lun;\r
331	UINT16 TargetPortalGroupTag;\r
332	CHAR16 iSCSITargetName[1];\r
333	} ISCSI_DEVICE_PATH_WITH_NAME;\r
334	\r
335	#endif\r
336	\r
337	//\r
338	// Internal functions\r
339	//\r
340	EFI_STATUS\r
341	BdsBootByDiskSignatureAndPartition (\r
342	IN BDS_COMMON_OPTION * Option,\r
343	IN HARDDRIVE_DEVICE_PATH * HardDriveDevicePath,\r
344	IN UINT32 LoadOptionsSize,\r
345	IN VOID *LoadOptions,\r
346	OUT UINTN *ExitDataSize,\r
347	OUT CHAR16 **ExitData OPTIONAL\r
348	);\r
349	\r
350	//\r
351	// Notes: EFI 64 shadow all option rom\r
352	//\r
353	#if defined (MDE_CPU_IPF)\r
354	#define EFI64_SHADOW_ALL_LEGACY_ROM() ShadowAllOptionRom ();\r
355	VOID\r
356	ShadowAllOptionRom();\r
357	#else\r
358	#define EFI64_SHADOW_ALL_LEGACY_ROM()\r
359	#endif\r
360	\r
361	//\r
362	// BBS support macros and functions\r
363	//\r
364	\r
365	#if defined(MDE_CPU_IA32) \|\| defined(MDE_CPU_X64)\r
366	#define REFRESH_LEGACY_BOOT_OPTIONS \\r
367	BdsDeleteAllInvalidLegacyBootOptions ();\\r
368	BdsAddNonExistingLegacyBootOptions (); \\r
369	BdsUpdateLegacyDevOrder ()\r
370	#else\r
371	#define REFRESH_LEGACY_BOOT_OPTIONS\r
372	#endif\r
373	\r
374	EFI_STATUS\r
375	BdsDeleteAllInvalidLegacyBootOptions (\r
376	VOID\r
377	);\r
378	\r
379	EFI_STATUS\r
380	BdsAddNonExistingLegacyBootOptions (\r
381	VOID\r
382	);\r
383	\r
384	EFI_STATUS\r
385	BdsUpdateLegacyDevOrder (\r
386	VOID\r
387	);\r
388	\r
389	EFI_STATUS\r
390	BdsRefreshBbsTableForBoot (\r
391	IN BDS_COMMON_OPTION *Entry\r
392	);\r
393	\r
394	EFI_STATUS\r
395	BdsDeleteBootOption (\r
396	IN UINTN OptionNumber,\r
397	IN OUT UINT16 *BootOrder,\r
398	IN OUT UINTN *BootOrderSize\r
399	);\r
400	\r
401	//\r
402	//The interface functions relate with Setup Browser Reset Reminder feature\r
403	//\r
404	VOID\r
405	EnableResetReminderFeature (\r
406	VOID\r
407	);\r
408	\r
409	VOID\r
410	DisableResetReminderFeature (\r
411	VOID\r
412	);\r
413	\r
414	VOID\r
415	EnableResetRequired (\r
416	VOID\r
417	);\r
418	\r
419	VOID\r
420	DisableResetRequired (\r
421	VOID\r
422	);\r
423	\r
424	BOOLEAN\r
425	IsResetReminderFeatureEnable (\r
426	VOID\r
427	);\r
428	\r
429	BOOLEAN\r
430	IsResetRequired (\r
431	VOID\r
432	);\r
433	\r
434	VOID\r
435	SetupResetReminder (\r
436	VOID\r
437	);\r
438	\r
439	EFI_STATUS\r
440	BdsLibGetImageHeader (\r
441	IN EFI_HANDLE Device,\r
442	IN CHAR16 *FileName,\r
443	OUT EFI_IMAGE_DOS_HEADER *DosHeader,\r
444	OUT EFI_IMAGE_OPTIONAL_HEADER_PTR_UNION Hdr\r
445	)\r
446	;\r
447	\r
448	EFI_STATUS\r
449	BdsLibGetHiiHandles (\r
450	#if (EFI_SPECIFICATION_VERSION >= 0x0002000A)\r
451	IN EFI_HII_DATABASE_PROTOCOL *HiiDatabase,\r
452	#else\r
453	IN EFI_HII_PROTOCOL *Hii,\r
454	#endif\r
455	IN OUT UINT16 *HandleBufferLength,\r
456	OUT EFI_HII_HANDLE **HiiHandleBuffer\r
457	);\r
458	\r
459	//\r
460	// Define the boot type which to classify the boot option type\r
461	// Different boot option type could have different boot behavior\r
462	// Use their device path node (Type + SubType) as type value\r
463	// The boot type here can be added according to requirement\r
464	//\r
465	//\r
466	// ACPI boot type. For ACPI device, cannot use sub-type to distinguish device, so hardcode their value\r
467	//\r
468	#define BDS_EFI_ACPI_FLOPPY_BOOT 0x0201\r
469	//\r
470	// Message boot type\r
471	// If a device path of boot option only point to a message node, the boot option is message boot type\r
472	//\r
473	#define BDS_EFI_MESSAGE_ATAPI_BOOT 0x0301 // Type 03; Sub-Type 01\r
474	#define BDS_EFI_MESSAGE_SCSI_BOOT 0x0302 // Type 03; Sub-Type 02\r
475	#define BDS_EFI_MESSAGE_USB_DEVICE_BOOT 0x0305 // Type 03; Sub-Type 05\r
476	#define BDS_EFI_MESSAGE_MISC_BOOT 0x03FF\r
477	//\r
478	// Media boot type\r
479	// If a device path of boot option contain a media node, the boot option is media boot type\r
480	//\r
481	#define BDS_EFI_MEDIA_HD_BOOT 0x0401 // Type 04; Sub-Type 01\r
482	#define BDS_EFI_MEDIA_CDROM_BOOT 0x0402 // Type 04; Sub-Type 02\r
483	//\r
484	// BBS boot type\r
485	// If a device path of boot option contain a BBS node, the boot option is BBS boot type\r
486	//\r
487	#define BDS_LEGACY_BBS_BOOT 0x0501 // Type 05; Sub-Type 01\r
488	\r
489	#define BDS_EFI_UNSUPPORT 0xFFFF\r
490	\r
491	//\r
492	// USB host controller Programming Interface.\r
493	//\r
494	#define PCI_CLASSC_PI_UHCI 0x00\r
495	#define PCI_CLASSC_PI_EHCI 0x20\r
496	\r
497	BOOLEAN\r
498	MatchPartitionDevicePathNode (\r
499	IN EFI_DEVICE_PATH_PROTOCOL *BlockIoDevicePath,\r
500	IN HARDDRIVE_DEVICE_PATH *HardDriveDevicePath\r
501	);\r
502	\r
503	EFI_DEVICE_PATH_PROTOCOL *\r
504	BdsExpandPartitionPartialDevicePathToFull (\r
505	IN HARDDRIVE_DEVICE_PATH *HardDriveDevicePath\r
506	);\r
507	\r
508	EFI_HANDLE\r
509	BdsLibGetBootableHandle (\r
510	IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
511	);\r
512	\r
513	BOOLEAN\r
514	BdsLibIsValidEFIBootOptDevicePath (\r
515	IN EFI_DEVICE_PATH_PROTOCOL *DevPath,\r
516	IN BOOLEAN CheckMedia\r
517	);\r
518	\r
519	UINT32\r
520	BdsGetBootTypeFromDevicePath (\r
521	IN EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
522	);\r
523	\r
524	VOID\r
525	EFIAPI\r
526	BdsLibSaveMemoryTypeInformation (\r
527	VOID \r
528	);\r
529	\r
530	EFI_STATUS\r
531	EFIAPI\r
532	BdsLibUpdateFvFileDevicePath (\r
533	IN OUT EFI_DEVICE_PATH_PROTOCOL ** DevicePath,\r
534	IN EFI_GUID *FileGuid\r
535	);\r
536	\r
537	EFI_STATUS\r
538	BdsLibConnectUsbDevByShortFormDP (\r
539	IN CHAR8 HostControllerPI,\r
540	IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
541	);\r
542	\r
543	EFI_TPL\r
544	BdsLibGetCurrentTpl (\r
545	VOID\r
546	);\r
547	\r
548	//\r
549	// The implementation of this function is provided by Platform code.\r
550	//\r
551	VOID\r
552	DevPathVendor (\r
553	IN OUT POOL_PRINT *Str,\r
554	IN VOID *DevPath\r
555	)\r
556	;\r
557	\r
558	CHAR16 *\r
559	CatPrint (\r
560	IN OUT POOL_PRINT *Str,\r
561	IN CHAR16 *fmt,\r
562	...\r
563	)\r
564	;\r
565	#endif // _BDS_LIB_H_\r