TianoCore EDK2 master
DebugPort.h File Reference

Go to the source code of this file.

Data Structures

struct  _EFI_DEBUGPORT_PROTOCOL
 
struct  DEBUGPORT_DEVICE_PATH
 

Macros

#define EFI_DEBUGPORT_PROTOCOL_GUID
 
#define EFI_DEBUGPORT_VARIABLE_NAME   L"DEBUGPORT"
 
#define EFI_DEBUGPORT_VARIABLE_GUID   EFI_DEBUGPORT_PROTOCOL_GUID
 
#define DEVICE_PATH_MESSAGING_DEBUGPORT   EFI_DEBUGPORT_PROTOCOL_GUID
 

Typedefs

typedef struct _EFI_DEBUGPORT_PROTOCOL EFI_DEBUGPORT_PROTOCOL
 
typedef EFI_STATUS(EFIAPIEFI_DEBUGPORT_RESET) (IN EFI_DEBUGPORT_PROTOCOL *This)
 
typedef EFI_STATUS(EFIAPIEFI_DEBUGPORT_WRITE) (IN EFI_DEBUGPORT_PROTOCOL *This, IN UINT32 Timeout, IN OUT UINTN *BufferSize, IN VOID *Buffer)
 
typedef EFI_STATUS(EFIAPIEFI_DEBUGPORT_READ) (IN EFI_DEBUGPORT_PROTOCOL *This, IN UINT32 Timeout, IN OUT UINTN *BufferSize, OUT VOID *Buffer)
 
typedef EFI_STATUS(EFIAPIEFI_DEBUGPORT_POLL) (IN EFI_DEBUGPORT_PROTOCOL *This)
 

Variables

EFI_GUID gEfiDebugPortProtocolGuid
 
EFI_GUID gEfiDebugPortVariableGuid
 
EFI_GUID gEfiDebugPortDevicePathGuid
 

Detailed Description

The file defines the EFI Debugport protocol. This protocol is used by debug agent to communicate with the remote debug host.

Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file DebugPort.h.

Macro Definition Documentation

◆ DEVICE_PATH_MESSAGING_DEBUGPORT

#define DEVICE_PATH_MESSAGING_DEBUGPORT   EFI_DEBUGPORT_PROTOCOL_GUID

Definition at line 130 of file DebugPort.h.

◆ EFI_DEBUGPORT_PROTOCOL_GUID

#define EFI_DEBUGPORT_PROTOCOL_GUID
Value:
{ \
0xEBA4E8D2, 0x3858, 0x41EC, {0xA2, 0x81, 0x26, 0x47, 0xBA, 0x96, 0x60, 0xD0 } \
}

DebugPortIo protocol {EBA4E8D2-3858-41EC-A281-2647BA9660D0}

Definition at line 18 of file DebugPort.h.

◆ EFI_DEBUGPORT_VARIABLE_GUID

#define EFI_DEBUGPORT_VARIABLE_GUID   EFI_DEBUGPORT_PROTOCOL_GUID

Definition at line 123 of file DebugPort.h.

◆ EFI_DEBUGPORT_VARIABLE_NAME

#define EFI_DEBUGPORT_VARIABLE_NAME   L"DEBUGPORT"

Definition at line 122 of file DebugPort.h.

Typedef Documentation

◆ EFI_DEBUGPORT_POLL

typedef EFI_STATUS(EFIAPI * EFI_DEBUGPORT_POLL) (IN EFI_DEBUGPORT_PROTOCOL *This)

Checks to see if any data is available to be read from the debugport device.

Parameters
ThisA pointer to the EFI_DEBUGPORT_PROTOCOL instance.
Return values
EFI_SUCCESSAt least one byte of data is available to be read.
EFI_DEVICE_ERRORThe debugport device is not functioning correctly.
EFI_NOT_READYNo data is available to be read.

Definition at line 104 of file DebugPort.h.

◆ EFI_DEBUGPORT_PROTOCOL

Definition at line 25 of file DebugPort.h.

◆ EFI_DEBUGPORT_READ

typedef EFI_STATUS(EFIAPI * EFI_DEBUGPORT_READ) (IN EFI_DEBUGPORT_PROTOCOL *This, IN UINT32 Timeout, IN OUT UINTN *BufferSize, OUT VOID *Buffer)

Reads data from the debugport.

Parameters
ThisA pointer to the EFI_DEBUGPORT_PROTOCOL instance.
TimeoutThe number of microseconds to wait before timing out a read operation.
BufferSizeOn input, the requested number of bytes of data to read. On output, the number of bytes of data actually number of bytes of data read and returned in Buffer.
BufferA pointer to a buffer into which the data read will be saved.
Return values
EFI_SUCCESSThe data was read.
EFI_DEVICE_ERRORThe device reported an error.
EFI_TIMEOUTThe operation was stopped due to a timeout or overrun.

Definition at line 85 of file DebugPort.h.

◆ EFI_DEBUGPORT_RESET

typedef EFI_STATUS(EFIAPI * EFI_DEBUGPORT_RESET) (IN EFI_DEBUGPORT_PROTOCOL *This)

Resets the debugport.

Parameters
ThisA pointer to the EFI_DEBUGPORT_PROTOCOL instance.
Return values
EFI_SUCCESSThe debugport device was reset and is in usable state.
EFI_DEVICE_ERRORThe debugport device could not be reset and is unusable.

Definition at line 41 of file DebugPort.h.

◆ EFI_DEBUGPORT_WRITE

typedef EFI_STATUS(EFIAPI * EFI_DEBUGPORT_WRITE) (IN EFI_DEBUGPORT_PROTOCOL *This, IN UINT32 Timeout, IN OUT UINTN *BufferSize, IN VOID *Buffer)

Writes data to the debugport.

Parameters
ThisA pointer to the EFI_DEBUGPORT_PROTOCOL instance.
TimeoutThe number of microseconds to wait before timing out a write operation.
BufferSizeOn input, the requested number of bytes of data to write. On output, the number of bytes of data actually written.
BufferA pointer to a buffer containing the data to write.
Return values
EFI_SUCCESSThe data was written.
EFI_DEVICE_ERRORThe device reported an error.
EFI_TIMEOUTThe data write was stopped due to a timeout.

Definition at line 61 of file DebugPort.h.