EmulatorPkg[all]  0.1
 All Data Structures Files Functions Variables Typedefs Macros Pages
EmuGraphicsWindow.h File Reference

Data Structures

struct  EMU_GRAPHICS_WINDOWS__BLT_ARGS
 
struct  _EMU_GRAPHICS_WINDOW_PROTOCOL
 

Macros

#define EMU_GRAPHICS_WINDOW_PROTOCOL_GUID   { 0x30FD316A, 0x6728, 0x2E41, { 0xA6, 0x90, 0x0D, 0x13, 0x33, 0xD8, 0xCA, 0xC1 } }
 

Typedefs

typedef struct
_EMU_GRAPHICS_WINDOW_PROTOCOL 
EMU_GRAPHICS_WINDOW_PROTOCOL
 
typedef EFI_STATUS(EFIAPI * EMU_GRAPHICS_WINDOWS_CLOSE )(EMU_GRAPHICS_WINDOW_PROTOCOL *Uga)
 
typedef EFI_STATUS(EFIAPI * EMU_GRAPHICS_WINDOWS_SIZE )(EMU_GRAPHICS_WINDOW_PROTOCOL *Uga, UINT32 Width, UINT32 Height)
 
typedef EFI_STATUS(EFIAPI * EMU_GRAPHICS_WINDOWS_CHECK_KEY )(EMU_GRAPHICS_WINDOW_PROTOCOL *Uga)
 
typedef EFI_STATUS(EFIAPI * EMU_GRAPHICS_WINDOWS_GET_KEY )(EMU_GRAPHICS_WINDOW_PROTOCOL *Uga, EFI_KEY_DATA *key)
 
typedef IN EFI_KEY_TOGGLE_STATE * KeyToggleState
 
typedef IN EFI_KEY_DATA * KeyData
 
typedef IN
EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK 
MakeCallBack
 
typedef IN
EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK
IN
EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK 
BreakCallBack
 
typedef IN
EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK
IN
EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK
IN VOID
Context
 
typedef EFI_STATUS(EFIAPI * EMU_GRAPHICS_WINDOWS_BLT )(IN EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows, IN EFI_UGA_PIXEL *BltBuffer, IN EFI_UGA_BLT_OPERATION BltOperation, IN EMU_GRAPHICS_WINDOWS__BLT_ARGS *Args)
 
typedef EFI_STATUS(EFIAPI * EMU_GRAPHICS_WINDOWS_CHECK_POINTER )(EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows)
 
typedef EFI_STATUS(EFIAPI * EMU_GRAPHICS_WINDOWS_GET_POINTER_STATE )(EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows, EFI_SIMPLE_POINTER_STATE *state)
 

Functions

typedef EFI_STATUS (EFIAPI *EMU_GRAPHICS_WINDOWS_KEY_SET_STATE)(IN EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows
 
typedef VOID (EFIAPI *EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK)(IN VOID *Context
 
typedef BOOLEAN (EFIAPI *EMU_GRAPHICS_WINDOWS_IS_KEY_PRESSED)(IN EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows
 

Variables

EFI_GUID gEmuGraphicsWindowProtocolGuid
 

Macro Definition Documentation

#define EMU_GRAPHICS_WINDOW_PROTOCOL_GUID   { 0x30FD316A, 0x6728, 0x2E41, { 0xA6, 0x90, 0x0D, 0x13, 0x33, 0xD8, 0xCA, 0xC1 } }

Typedef Documentation

typedef IN EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK IN EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK BreakCallBack
typedef IN EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK IN EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK IN VOID* Context
typedef EFI_STATUS(EFIAPI * EMU_GRAPHICS_WINDOWS_BLT)(IN EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows, IN EFI_UGA_PIXEL *BltBuffer, IN EFI_UGA_BLT_OPERATION BltOperation, IN EMU_GRAPHICS_WINDOWS__BLT_ARGS *Args)
typedef EFI_STATUS(EFIAPI * EMU_GRAPHICS_WINDOWS_CHECK_KEY)(EMU_GRAPHICS_WINDOW_PROTOCOL *Uga)
typedef EFI_STATUS(EFIAPI * EMU_GRAPHICS_WINDOWS_CHECK_POINTER)(EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows)
typedef EFI_STATUS(EFIAPI * EMU_GRAPHICS_WINDOWS_CLOSE)(EMU_GRAPHICS_WINDOW_PROTOCOL *Uga)
typedef EFI_STATUS(EFIAPI * EMU_GRAPHICS_WINDOWS_GET_KEY)(EMU_GRAPHICS_WINDOW_PROTOCOL *Uga, EFI_KEY_DATA *key)
typedef EFI_STATUS(EFIAPI * EMU_GRAPHICS_WINDOWS_GET_POINTER_STATE)(EMU_GRAPHICS_WINDOW_PROTOCOL *GraphicsWindows, EFI_SIMPLE_POINTER_STATE *state)
typedef EFI_STATUS(EFIAPI * EMU_GRAPHICS_WINDOWS_SIZE)(EMU_GRAPHICS_WINDOW_PROTOCOL *Uga, UINT32 Width, UINT32 Height)
typedef IN EFI_KEY_DATA* KeyData
typedef IN EFI_KEY_TOGGLE_STATE* KeyToggleState
typedef IN EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK MakeCallBack

Function Documentation

typedef BOOLEAN ( EFIAPI *  EMU_GRAPHICS_WINDOWS_IS_KEY_PRESSED)
typedef EFI_STATUS ( EFIAPI *  EMU_GRAPHICS_WINDOWS_KEY_SET_STATE)

Enumerates the current set of protocol instances that abstract OS services from EFI.

A given protocol can have multiple instances. Usually a protocol is configured via a single PCD string. The data associated for each instance is seperated via a ! in the string. EMU_IO_THUNK_PROTOCOL_CLOSE.ConfigString will contain the information in the PCD string up to the next !. Thus each instance has a unique ConfigString.

Parameters
EmuBusDriverTRUE means only return protocol instances that need to be produced by the EmuBusDriver. FALSE means return all possible protocols
InstanceOn input the protocol to search for, or NULL to start a search of all the supported protocol instances.
NextProtocolOn output it represents the next value to be passed into Protocol.
InterfaceA pointer to the EMU_IO_THUNK_PROTOCOL_CLOSE interface.
Return values
EFI_SUCCESSThe function completed successfully.
EFI_NOT_FOUNDThe next protocol instance was not found.
EFI_INVALID_PARAMETERInstance is NULL.

Read BufferSize bytes from Lba into Buffer.

This function reads the requested number of blocks from the device. All the blocks are read, or an error is returned. If EFI_DEVICE_ERROR, EFI_NO_MEDIA,_or EFI_MEDIA_CHANGED is returned and non-blocking I/O is being used, the Event associated with this request will not be signaled.

Parameters
[in]ThisIndicates a pointer to the calling context.
[in]MediaIdId of the media, changes every time the media is replaced.
[in]LbaThe starting Logical Block Address to read from.
[in,out]TokenA pointer to the token associated with the transaction.
[in]BufferSizeSize of Buffer, must be a multiple of device block size.
[out]BufferA pointer to the destination buffer for the data. The caller is responsible for either having implicit or explicit ownership of the buffer.
Return values
EFI_SUCCESSThe read request was queued if Token->Event is not NULL.The data was read correctly from the device if the Token->Event is NULL.
EFI_DEVICE_ERRORThe device reported an error while performing the read.
EFI_NO_MEDIAThere is no media in the device.
EFI_MEDIA_CHANGEDThe MediaId is not for the current media.
EFI_BAD_BUFFER_SIZEThe BufferSize parameter is not a multiple of the intrinsic block size of the device.
EFI_INVALID_PARAMETERThe read request contains LBAs that are not valid, or the buffer is not on proper alignment.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.

Write BufferSize bytes from Lba into Buffer.

This function writes the requested number of blocks to the device. All blocks are written, or an error is returned.If EFI_DEVICE_ERROR, EFI_NO_MEDIA, EFI_WRITE_PROTECTED or EFI_MEDIA_CHANGED is returned and non-blocking I/O is being used, the Event associated with this request will not be signaled.

Parameters
[in]ThisIndicates a pointer to the calling context.
[in]MediaIdThe media ID that the write request is for.
[in]LbaThe starting logical block address to be written. The caller is responsible for writing to only legitimate locations.
[in,out]TokenA pointer to the token associated with the transaction.
[in]BufferSizeSize of Buffer, must be a multiple of device block size.
[in]BufferA pointer to the source buffer for the data.
Return values
EFI_SUCCESSThe write request was queued if Event is not NULL. The data was written correctly to the device if the Event is NULL.
EFI_WRITE_PROTECTEDThe device can not be written to.
EFI_NO_MEDIAThere is no media in the device.
EFI_MEDIA_CHNAGEDThe MediaId does not matched the current device.
EFI_DEVICE_ERRORThe device reported an error while performing the write.
EFI_BAD_BUFFER_SIZEThe Buffer was not a multiple of the block size of the device.
EFI_INVALID_PARAMETERThe write request contains LBAs that are not valid, or the buffer is not on proper alignment.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.

Flush the Block Device.

If EFI_DEVICE_ERROR, EFI_NO_MEDIA,_EFI_WRITE_PROTECTED or EFI_MEDIA_CHANGED is returned and non-blocking I/O is being used, the Event associated with this request will not be signaled.

Parameters
[in]ThisIndicates a pointer to the calling context.
[in,out]TokenA pointer to the token associated with the transaction
Return values
EFI_SUCCESSThe flush request was queued if Event is not NULL. All outstanding data was written correctly to the device if the Event is NULL.
EFI_DEVICE_ERRORThe device reported an error while writting back the data.
EFI_WRITE_PROTECTEDThe device cannot be written to.
EFI_NO_MEDIAThere is no media in the device.
EFI_MEDIA_CHANGEDThe MediaId is not for the current media.
EFI_OUT_OF_RESOURCESThe request could not be completed due to a lack of resources.
typedef VOID ( EFIAPI *  EMU_GRAPHICS_WINDOW_REGISTER_KEY_NOTIFY_CALLBACK)

Variable Documentation

EFI_GUID gEmuGraphicsWindowProtocolGuid