MdeModulePkg/Include/Protocol/FirmwareManagementProgress.h

   1 /** @file
   2   EDK II Firmware Management Progress Protocol.
   3
   4   Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials are licensed and made available under
   6   the terms and conditions of the BSD License that accompanies this distribution.
   7   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 __EDKII_FIRMWARE_MANAGEMENT_PROGRESS_PROTOCOL_H__
  16 #define __EDKII_FIRMWARE_MANAGEMENT_PROGRESS_PROTOCOL_H__
  17
  18 #include <Protocol/GraphicsOutput.h>
  19
  20 ///
  21 /// EDK II Firmware Management Progress Protocol GUID value
  22 ///
  23 #define EDKII_FIRMWARE_MANAGEMENT_PROGRESS_PROTOCOL_GUID \
  24   { \
  25     0x1849bda2, 0x6952, 0x4e86, { 0xa1, 0xdb, 0x55, 0x9a, 0x3c, 0x47, 0x9d, 0xf1 } \
  26   }
  27
  28 ///
  29 /// EDK II Firmware Management Progress Protocol structure
  30 ///
  31 typedef struct {
  32   ///
  33   /// The version of this structure.  Initial version value is 0x00000001.
  34   ///
  35   UINT32                               Version;
  36   ///
  37   /// The foreground color of a progress bar that is used by the Progress()
  38   /// function that is passed into the Firmware Management Protocol SetImage()
  39   /// service is called.
  40   ///
  41   EFI_GRAPHICS_OUTPUT_BLT_PIXEL_UNION  ProgressBarForegroundColor;
  42   ///
  43   /// The time in seconds to arm the watchdog timer each time the Progress()
  44   /// function passed into the  Firmware Management Protocol SetImage() service
  45   /// is called.
  46   ///
  47   UINTN                                WatchdogSeconds;
  48 } EDKII_FIRMWARE_MANAGEMENT_PROGRESS_PROTOCOL;
  49
  50 ///
  51 /// EDK II Firmware Management Progress Protocol GUID variable.
  52 ///
  53 extern EFI_GUID gEdkiiFirmwareManagementProgressProtocolGuid;
  54
  55 #endif