EdkGenericPlatformBdsLib added

[mirror_edk2.git] / EdkModulePkg / Include / Library / EdkGenericPlatformBdsLib.h

/*++\r
\r
Copyright (c) 2006, 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
  BdsPlatform.h\r
\r
Abstract:\r
\r
  Head file for BDS Platform specific code\r
\r
--*/\r
\r
#ifndef _BDS_PLATFORM_LIB_H\r
#define _BDS_PLATFORM_LIB_H\r
\r
extern BDS_CONSOLE_CONNECT_ENTRY  gPlatformConsole[];\r
extern EFI_DEVICE_PATH_PROTOCOL   *gPlatformConnectSequence[];\r
extern EFI_DEVICE_PATH_PROTOCOL   *gPlatformDriverOption[];\r
//\r
// Bds AP Context data\r
//\r
#define EFI_BDS_ARCH_PROTOCOL_INSTANCE_SIGNATURE  EFI_SIGNATURE_32 ('B', 'd', 's', 'A')\r
typedef struct {\r
  UINTN                     Signature;\r
\r
  EFI_HANDLE                Handle;\r
\r
  EFI_BDS_ARCH_PROTOCOL     Bds;\r
\r
  //\r
  // Save the current boot mode\r
  //\r
  EFI_BOOT_MODE             BootMode;\r
\r
  //\r
  // Set true if boot with default settings\r
  //\r
  BOOLEAN                   DefaultBoot;\r
\r
  //\r
  // The system default timeout for choose the boot option\r
  //\r
  UINT16                    TimeoutDefault;\r
\r
  //\r
  // Memory Test Level\r
  //\r
  EXTENDMEM_COVERAGE_LEVEL  MemoryTestLevel;\r
\r
} EFI_BDS_ARCH_PROTOCOL_INSTANCE;\r
\r
#define EFI_BDS_ARCH_PROTOCOL_INSTANCE_FROM_THIS(_this) \\r
  CR (_this, \\r
      EFI_BDS_ARCH_PROTOCOL_INSTANCE, \\r
      Bds, \\r
      EFI_BDS_ARCH_PROTOCOL_INSTANCE_SIGNATURE \\r
      )\r

\r
#define gEndEntire \\r
  { \\r
    END_DEVICE_PATH_TYPE,\\r
    END_ENTIRE_DEVICE_PATH_SUBTYPE,\\r
    {\\r
      END_DEVICE_PATH_LENGTH,\\r
      0\\r
    }\\r
  }\r
\r
//\r
// Platform BDS Functions\r
//\r
VOID\r
PlatformBdsInit (\r
  IN EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData\r
  )\r
;\r
\r
VOID\r
PlatformBdsPolicyBehavior (\r
  IN EFI_BDS_ARCH_PROTOCOL_INSTANCE  *PrivateData,\r
  IN LIST_ENTRY                      *DriverOptionList,\r
  IN LIST_ENTRY                      *BootOptionList\r
  )\r
;\r
\r
EFI_STATUS\r
BdsMemoryTest (\r
  EXTENDMEM_COVERAGE_LEVEL Level\r
  )\r
;\r
\r
EFI_STATUS\r
PlatformBdsShowProgress (\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleBackground,\r
  CHAR16                        *Title,\r
  EFI_GRAPHICS_OUTPUT_BLT_PIXEL ProgressColor,\r
  UINTN                         Progress,\r
  UINTN                         PreviousValue\r
  )\r
;\r
\r
VOID\r
PlatformBdsBootFail (\r
  IN  BDS_COMMON_OPTION  *Option,\r
  IN  EFI_STATUS         Status,\r
  IN  CHAR16             *ExitData,\r
  IN  UINTN              ExitDataSize\r
  )\r
;\r
\r
VOID\r
PlatformBdsBootSuccess (\r
  IN  BDS_COMMON_OPTION *Option\r
  )\r
;\r
\r
EFI_STATUS\r
ProcessCapsules (\r
  EFI_BOOT_MODE BootMode\r
  )\r
;\r
\r
VOID\r
PlatformBdsEnterFrontPage (\r
  IN UINT16                 TimeoutDefault,\r
  IN BOOLEAN                ConnectAllHappened\r
  );\r
\r
#endif // _BDS_PLATFORM_LIB_H\r