DebugPort.h File Reference

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(EFIAPI *	EFI_DEBUGPORT_RESET )(IN EFI_DEBUGPORT_PROTOCOL *This)
typedef EFI_STATUS(EFIAPI *	EFI_DEBUGPORT_WRITE )(IN EFI_DEBUGPORT_PROTOCOL *This, IN UINT32 Timeout, IN OUT UINTN *BufferSize, IN VOID *Buffer)
typedef EFI_STATUS(EFIAPI *	EFI_DEBUGPORT_READ )(IN EFI_DEBUGPORT_PROTOCOL *This, IN UINT32 Timeout, IN OUT UINTN *BufferSize, OUT VOID *Buffer)
typedef EFI_STATUS(EFIAPI *	EFI_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

Macro Definition Documentation

#define DEVICE_PATH_MESSAGING_DEBUGPORT   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}

#define EFI_DEBUGPORT_VARIABLE_GUID   EFI_DEBUGPORT_PROTOCOL_GUID

#define EFI_DEBUGPORT_VARIABLE_NAME   L"DEBUGPORT"

Typedef Documentation

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

This	A pointer to the EFI_DEBUGPORT_PROTOCOL instance.

Return values

EFI_SUCCESS	At least one byte of data is available to be read.
EFI_DEVICE_ERROR	The debugport device is not functioning correctly.
EFI_NOT_READY	No data is available to be read.

typedef struct _EFI_DEBUGPORT_PROTOCOL EFI_DEBUGPORT_PROTOCOL

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

This	A pointer to the EFI_DEBUGPORT_PROTOCOL instance.
Timeout	The number of microseconds to wait before timing out a read operation.
BufferSize	On 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.
Buffer	A pointer to a buffer into which the data read will be saved.

Return values

EFI_SUCCESS	The data was read.
EFI_DEVICE_ERROR	The device reported an error.
EFI_TIMEOUT	The operation was stopped due to a timeout or overrun.

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

Resets the debugport.

Parameters

This	A pointer to the EFI_DEBUGPORT_PROTOCOL instance.

Return values

EFI_SUCCESS	The debugport device was reset and is in usable state.
EFI_DEVICE_ERROR	The debugport device could not be reset and is unusable.

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

This	A pointer to the EFI_DEBUGPORT_PROTOCOL instance.
Timeout	The number of microseconds to wait before timing out a write operation.
BufferSize	On input, the requested number of bytes of data to write. On output, the number of bytes of data actually written.
Buffer	A pointer to a buffer containing the data to write.

Return values

EFI_SUCCESS	The data was written.
EFI_DEVICE_ERROR	The device reported an error.
EFI_TIMEOUT	The data write was stopped due to a timeout.

Variable Documentation

EFI_GUID gEfiDebugPortDevicePathGuid

EFI_GUID gEfiDebugPortProtocolGuid

EFI_GUID gEfiDebugPortVariableGuid