mirror of https://github.com/acidanthera/audk.git
MdeModulePkg: Add Boot Logo 2 Protocol
https://bugzilla.tianocore.org/show_bug.cgi?id=799
Based on content from the following branch/commit:
https://github.com/Microsoft/MS_UEFI/tree/share/MsCapsuleSupport
33bab4031a
Add new Boot Logo 2 Protocol that adds a GetBootLogo()
service that can be used to retrieve the GOP BLT buffer,
location, and size of the boot logo that was previously
registered with the SetBootLogo() service.
The Boot Logo 2 Protocol service GetBootLogo() is amended
to return the pointer to the GOP BLT buffer previously
registered with the SetBootLogo() service.
Cc: Sean Brogan <sean.brogan@microsoft.com>
Cc: Bret Barkelew <Bret.Barkelew@microsoft.com>
Cc: Jiewen Yao <jiewen.yao@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Cc: Eric Dong <eric.dong@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Sean Brogan <sean.brogan@microsoft.com>
This commit is contained in:
Kinney, Michael D
Michael D Kinney
parent
44d2e8d7ca
commit
b7c7ec8c17
|
|
@ -0,0 +1,118 @@
|
||||||
|
/**
|
||||||
|
Boot Logo 2 Protocol is used to convey information of Logo dispayed during boot.
|
||||||
|
|
||||||
|
The Boot Logo 2 Protocol is a replacement for the Boot Logo Protocol. If a
|
||||||
|
platform produces both the Boot Logo 2 Protocol and the Boot Logo Protocol
|
||||||
|
then the Boot Logo 2 Protocol must be used instead of the Boot Logo Protocol.
|
||||||
|
|
||||||
|
Copyright (c) 2016, Microsoft Corporation
|
||||||
|
Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
|
||||||
|
|
||||||
|
All rights reserved.
|
||||||
|
Redistribution and use in source and binary forms, with or without
|
||||||
|
modification, are permitted provided that the following conditions are met:
|
||||||
|
1. Redistributions of source code must retain the above copyright notice,
|
||||||
|
this list of conditions and the following disclaimer.
|
||||||
|
2. Redistributions in binary form must reproduce the above copyright notice,
|
||||||
|
this list of conditions and the following disclaimer in the documentation
|
||||||
|
and/or other materials provided with the distribution.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||||
|
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||||
|
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
||||||
|
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
|
||||||
|
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
||||||
|
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
||||||
|
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
|
||||||
|
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
||||||
|
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
|
**/
|
||||||
|
|
||||||
|
#ifndef _BOOT_LOGO2_H_
|
||||||
|
#define _BOOT_LOGO2_H_
|
||||||
|
|
||||||
|
#include <Protocol/GraphicsOutput.h>
|
||||||
|
|
||||||
|
#define EDKII_BOOT_LOGO2_PROTOCOL_GUID \
|
||||||
|
{ \
|
||||||
|
0x4b5dc1df, 0x1eaa, 0x48b2, { 0xa7, 0xe9, 0xea, 0xc4, 0x89, 0xa0, 0xb, 0x5c } \
|
||||||
|
}
|
||||||
|
|
||||||
|
//
|
||||||
|
// Forward reference for pure ANSI compatability
|
||||||
|
//
|
||||||
|
typedef struct _EDKII_BOOT_LOGO2_PROTOCOL EDKII_BOOT_LOGO2_PROTOCOL;
|
||||||
|
|
||||||
|
/**
|
||||||
|
Update information of logo image drawn on screen.
|
||||||
|
|
||||||
|
@param[in] This The pointer to the Boot Logo protocol 2 instance.
|
||||||
|
@param[in] BltBuffer The BLT buffer for logo drawn on screen. If BltBuffer
|
||||||
|
is set to NULL, it indicates that logo image is no
|
||||||
|
longer on the screen.
|
||||||
|
@param[in] DestinationX X coordinate of destination for the BltBuffer.
|
||||||
|
@param[in] DestinationY Y coordinate of destination for the BltBuffer.
|
||||||
|
@param[in] Width Width of rectangle in BltBuffer in pixels.
|
||||||
|
@param[in] Height Hight of rectangle in BltBuffer in pixels.
|
||||||
|
|
||||||
|
@retval EFI_SUCCESS The boot logo information was updated.
|
||||||
|
@retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.
|
||||||
|
@retval EFI_OUT_OF_RESOURCES The logo information was not updated due to
|
||||||
|
insufficient memory resources.
|
||||||
|
**/
|
||||||
|
typedef
|
||||||
|
EFI_STATUS
|
||||||
|
(EFIAPI *EDKII_SET_BOOT_LOGO2)(
|
||||||
|
IN EDKII_BOOT_LOGO2_PROTOCOL *This,
|
||||||
|
IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer OPTIONAL,
|
||||||
|
IN UINTN DestinationX,
|
||||||
|
IN UINTN DestinationY,
|
||||||
|
IN UINTN Width,
|
||||||
|
IN UINTN Height
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
Get the location of the boot logo on the screen.
|
||||||
|
|
||||||
|
@param[in] This The pointer to the Boot Logo Protocol 2 instance
|
||||||
|
@param[out] BltBuffer Returns pointer to the GOP BLT buffer that was
|
||||||
|
previously registered with SetBootLogo2(). The
|
||||||
|
buffer returned must not be modified or freed.
|
||||||
|
@param[out] DestinationX Returns the X start position of the GOP BLT buffer
|
||||||
|
that was previously registered with SetBootLogo2().
|
||||||
|
@param[out] DestinationY Returns the Y start position of the GOP BLT buffer
|
||||||
|
that was previously registered with SetBootLogo2().
|
||||||
|
@param[out] Width Returns the width of the GOP BLT buffer
|
||||||
|
that was previously registered with SetBootLogo2().
|
||||||
|
@param[out] Height Returns the height of the GOP BLT buffer
|
||||||
|
that was previously registered with SetBootLogo2().
|
||||||
|
|
||||||
|
@retval EFI_SUCCESS The location of the boot logo was returned.
|
||||||
|
@retval EFI_NOT_READY The boot logo has not been set.
|
||||||
|
@retval EFI_INVALID_PARAMETER BltBuffer is NULL.
|
||||||
|
@retval EFI_INVALID_PARAMETER DestinationX is NULL.
|
||||||
|
@retval EFI_INVALID_PARAMETER DestinationY is NULL.
|
||||||
|
@retval EFI_INVALID_PARAMETER Width is NULL.
|
||||||
|
@retval EFI_INVALID_PARAMETER Height is NULL.
|
||||||
|
**/
|
||||||
|
typedef
|
||||||
|
EFI_STATUS
|
||||||
|
(EFIAPI *EDKII_GET_BOOT_LOGO2)(
|
||||||
|
IN EDKII_BOOT_LOGO2_PROTOCOL *This,
|
||||||
|
OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL **BltBuffer,
|
||||||
|
OUT UINTN *DestinationX,
|
||||||
|
OUT UINTN *DestinationY,
|
||||||
|
OUT UINTN *Width,
|
||||||
|
OUT UINTN *Height
|
||||||
|
);
|
||||||
|
|
||||||
|
struct _EDKII_BOOT_LOGO2_PROTOCOL {
|
||||||
|
EDKII_SET_BOOT_LOGO2 SetBootLogo;
|
||||||
|
EDKII_GET_BOOT_LOGO2 GetBootLogo;
|
||||||
|
};
|
||||||
|
|
||||||
|
extern EFI_GUID gEdkiiBootLogo2ProtocolGuid;
|
||||||
|
|
||||||
|
#endif
|
||||||
|
|
@ -538,6 +538,9 @@
|
||||||
## Include/Protocol/BootLogo.h
|
## Include/Protocol/BootLogo.h
|
||||||
gEfiBootLogoProtocolGuid = { 0xcdea2bd3, 0xfc25, 0x4c1c, { 0xb9, 0x7c, 0xb3, 0x11, 0x86, 0x6, 0x49, 0x90 } }
|
gEfiBootLogoProtocolGuid = { 0xcdea2bd3, 0xfc25, 0x4c1c, { 0xb9, 0x7c, 0xb3, 0x11, 0x86, 0x6, 0x49, 0x90 } }
|
||||||
|
|
||||||
|
# Include/Protocol/BootLogo2.h
|
||||||
|
gEdkiiBootLogo2ProtocolGuid = { 0x4b5dc1df, 0x1eaa, 0x48b2, { 0xa7, 0xe9, 0xea, 0xc4, 0x89, 0xa0, 0xb, 0x5c } }
|
||||||
|
|
||||||
## Include/Protocol/DisplayProtocol.h
|
## Include/Protocol/DisplayProtocol.h
|
||||||
gEdkiiFormDisplayEngineProtocolGuid = { 0x9bbe29e9, 0xfda1, 0x41ec, { 0xad, 0x52, 0x45, 0x22, 0x13, 0x74, 0x2d, 0x2e } }
|
gEdkiiFormDisplayEngineProtocolGuid = { 0x9bbe29e9, 0xfda1, 0x41ec, { 0xad, 0x52, 0x45, 0x22, 0x13, 0x74, 0x2d, 0x2e } }
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue