AppleUserInterface.h File Reference

#include <Protocol/GraphicsOutput.h>

Go to the source code of this file.

Data Structures
struct	APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL_

Macros
#define	APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL_GUID
#define	APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL_REVISION   0x00000004

Typedefs
typedef struct APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL_	APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL
typedef EFI_STATUS(EFIAPI *	USER_INTERFACE_CONNECT_GOP) (VOID)
typedef EFI_STATUS(EFIAPI *	USER_INTERFACE_RETURN_SUCCESS) (VOID)
typedef EFI_STATUS(EFIAPI *	USER_INTERFACE_CREATE_DRAW_BUFFER) (OUT VOID *DrawBufferInfo, IN UINT32 BackgroundColor)
typedef VOID(EFIAPI *	USER_INTERFACE_FREE_DRAW_BUFFER) (IN VOID *DrawBufferInfo)
typedef VOID(EFIAPI *	USER_INTERFACE_COMBINE_RGBA) (OUT UINT32 *Colour OPTIONAL, IN UINT8 Red, IN UINT8 Green, IN UINT8 Blue, IN UINT8 Alpha)
typedef VOID(EFIAPI *	USER_INTERFACE_UNMAPPED) (VOID)

Variables
EFI_GUID	gAppleFirmwareUserInterfaceProtocolGuid

Detailed Description

Apple User Interface Protocol.

Copyright (C) 2022, Mike Beaton. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause

Definition in file AppleUserInterface.h.

Macro Definition Documentation

APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL_GUID

#define APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL_GUID

Value:

  { 0x691E1AF0, 0x8673, 0x4C98,           \
    { 0xA9, 0xB3, 0x04, 0x26, 0x20, 0xE9, 0x14, 0x98 }}

Apple User Interface protocol GUID.

Definition at line 16 of file AppleUserInterface.h.

APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL_REVISION

#define APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL_REVISION   0x00000004

Definition at line 21 of file AppleUserInterface.h.

Typedef Documentation

APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL

typedef struct APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL_ APPLE_FIRMWARE_USER_INTERFACE_PROTOCOL

Definition at line 23 of file AppleUserInterface.h.

USER_INTERFACE_COMBINE_RGBA

typedef VOID(EFIAPI * USER_INTERFACE_COMBINE_RGBA) (OUT UINT32 *Colour OPTIONAL, IN UINT8 Red, IN UINT8 Green, IN UINT8 Blue, IN UINT8 Alpha)

If Color is not NULL, combine specified RGBA components into Color.

Parameters

[out]	Color	Combined color.
[in]	Red	Color red value.
[in]	Green	Color green value.
[in]	Blue	Color blue value.
[in]	Alpha	Color alpha value.

Definition at line 81 of file AppleUserInterface.h.

USER_INTERFACE_CONNECT_GOP

typedef EFI_STATUS(EFIAPI * USER_INTERFACE_CONNECT_GOP) (VOID)

Connect user interface protocol to current GOP on gST->ConsoleOutHandle.

Return values

EFI_SUCCESS

GOP interface on required handle was found and stored.

Definition at line 31 of file AppleUserInterface.h.

USER_INTERFACE_CREATE_DRAW_BUFFER

typedef EFI_STATUS(EFIAPI * USER_INTERFACE_CREATE_DRAW_BUFFER) (OUT VOID *DrawBufferInfo, IN UINT32 BackgroundColor)

Allocate draw buffer and associated info buffers, and return containing info block.

Parameters

[out]	DrawBufferInfo	Draw buffer info.
[in]	BackgroundColor	Background color.

Definition at line 54 of file AppleUserInterface.h.

USER_INTERFACE_FREE_DRAW_BUFFER

typedef VOID(EFIAPI * USER_INTERFACE_FREE_DRAW_BUFFER) (IN VOID *DrawBufferInfo)

Free draw buffer info block and associated allocations.

Parameters

[in]

DrawBufferInfo

Draw buffer info.

Definition at line 66 of file AppleUserInterface.h.

USER_INTERFACE_RETURN_SUCCESS

typedef EFI_STATUS(EFIAPI * USER_INTERFACE_RETURN_SUCCESS) (VOID)

On version 4 of the protocol, always returns EFI_SUCCESS.

Return values

EFI_SUCCESS

Success.

Definition at line 42 of file AppleUserInterface.h.

USER_INTERFACE_UNMAPPED

typedef VOID(EFIAPI * USER_INTERFACE_UNMAPPED) (VOID)

Method not yet mapped.

Definition at line 94 of file AppleUserInterface.h.

Variable Documentation

gAppleFirmwareUserInterfaceProtocolGuid

EFI_GUID gAppleFirmwareUserInterfaceProtocolGuid

extern