MdeModulePkg/Include/Protocol/BootLogo2.h

   1 /** @file
   2 Boot Logo 2 Protocol is used to convey information of Logo dispayed during boot.
   3
   4 The Boot Logo 2 Protocol is a replacement for the Boot Logo Protocol.  If a
   5 platform produces both the Boot Logo 2 Protocol and the Boot Logo Protocol
   6 then the Boot Logo 2 Protocol must be used instead of the Boot Logo Protocol.
   7
   8 Copyright (c) 2016, Microsoft Corporation
   9 Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
  10
  11 All rights reserved.
  12 Redistribution and use in source and binary forms, with or without
  13 modification, are permitted provided that the following conditions are met:
  14 1. Redistributions of source code must retain the above copyright notice,
  15 this list of conditions and the following disclaimer.
  16 2. Redistributions in binary form must reproduce the above copyright notice,
  17 this list of conditions and the following disclaimer in the documentation
  18  and/or other materials provided with the distribution.
  19
  20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  21 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  22 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  23 IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  24 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  25 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  27 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  28 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  29 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31 **/
  32
  33 #ifndef _BOOT_LOGO2_H_
  34 #define _BOOT_LOGO2_H_
  35
  36 #include <Protocol/GraphicsOutput.h>
  37
  38 #define EDKII_BOOT_LOGO2_PROTOCOL_GUID \
  39   { \
  40     0x4b5dc1df, 0x1eaa, 0x48b2, { 0xa7, 0xe9, 0xea, 0xc4, 0x89, 0xa0, 0xb, 0x5c } \
  41   }
  42
  43 //
  44 // Forward reference for pure ANSI compatability
  45 //
  46 typedef struct _EDKII_BOOT_LOGO2_PROTOCOL EDKII_BOOT_LOGO2_PROTOCOL;
  47
  48 /**
  49   Update information of logo image drawn on screen.
  50
  51   @param[in] This          The pointer to the Boot Logo protocol 2 instance.
  52   @param[in] BltBuffer     The BLT buffer for logo drawn on screen. If BltBuffer
  53                            is set to NULL, it indicates that logo image is no
  54                            longer on the screen.
  55   @param[in] DestinationX  X coordinate of destination for the BltBuffer.
  56   @param[in] DestinationY  Y coordinate of destination for the BltBuffer.
  57   @param[in] Width         Width of rectangle in BltBuffer in pixels.
  58   @param[in] Height        Hight of rectangle in BltBuffer in pixels.
  59
  60   @retval EFI_SUCCESS            The boot logo information was updated.
  61   @retval EFI_INVALID_PARAMETER  One of the parameters has an invalid value.
  62   @retval EFI_OUT_OF_RESOURCES   The logo information was not updated due to
  63                                  insufficient memory resources.
  64 **/
  65 typedef
  66 EFI_STATUS
  67 (EFIAPI *EDKII_SET_BOOT_LOGO2)(
  68   IN EDKII_BOOT_LOGO2_PROTOCOL      *This,
  69   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL  *BltBuffer       OPTIONAL,
  70   IN UINTN                          DestinationX,
  71   IN UINTN                          DestinationY,
  72   IN UINTN                          Width,
  73   IN UINTN                          Height
  74   );
  75
  76 /**
  77   Get the location of the boot logo on the screen.
  78
  79   @param[in]  This          The pointer to the Boot Logo Protocol 2 instance
  80   @param[out] BltBuffer     Returns pointer to the GOP BLT buffer that was
  81                             previously registered with SetBootLogo2(). The
  82                             buffer returned must not be modified or freed.
  83   @param[out] DestinationX  Returns the X start position of the GOP BLT buffer
  84                             that was previously registered with SetBootLogo2().
  85   @param[out] DestinationY  Returns the Y start position of the GOP BLT buffer
  86                             that was previously registered with SetBootLogo2().
  87   @param[out] Width         Returns the width of the GOP BLT buffer
  88                             that was previously registered with SetBootLogo2().
  89   @param[out] Height        Returns the height of the GOP BLT buffer
  90                             that was previously registered with SetBootLogo2().
  91
  92   @retval EFI_SUCCESS            The location of the boot logo was returned.
  93   @retval EFI_NOT_READY          The boot logo has not been set.
  94   @retval EFI_INVALID_PARAMETER  BltBuffer is NULL.
  95   @retval EFI_INVALID_PARAMETER  DestinationX is NULL.
  96   @retval EFI_INVALID_PARAMETER  DestinationY is NULL.
  97   @retval EFI_INVALID_PARAMETER  Width is NULL.
  98   @retval EFI_INVALID_PARAMETER  Height is NULL.
  99 **/
 100 typedef
 101 EFI_STATUS
 102 (EFIAPI *EDKII_GET_BOOT_LOGO2)(
 103   IN  EDKII_BOOT_LOGO2_PROTOCOL      *This,
 104   OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL  **BltBuffer,
 105   OUT UINTN                          *DestinationX,
 106   OUT UINTN                          *DestinationY,
 107   OUT UINTN                          *Width,
 108   OUT UINTN                          *Height
 109   );
 110
 111 struct _EDKII_BOOT_LOGO2_PROTOCOL {
 112   EDKII_SET_BOOT_LOGO2  SetBootLogo;
 113   EDKII_GET_BOOT_LOGO2  GetBootLogo;
 114 };
 115
 116 extern EFI_GUID  gEdkiiBootLogo2ProtocolGuid;
 117
 118 #endif