DXE DEBUGPORT EXT PROTOCOL

From PhoenixWiki

Jump to: navigation, search

Extensions for supporting the debug port protocol.

Contents

GUID

#define DXE_DEBUGPORT_EXT_PROTOCOL_GUID \
  { 0x31a4878f, 0x230d, 0x4fc2, \
  { 0x90,0xbb,0xda,0x5f,0x41,0xa4,0x4b,0x1b } }

Prototype

typedef struct _DXE_DEBUGPORT_EXT_PROTOCOL {
  DXE_DEBUGPORT_GET_MODE GetMode;
  DXE_DEBUGPORT_SET_MODE SetMode;
} DXE_DEBUGPORT_EXT_PROTOCOL;

Members

Member Description
GetMode Return the mode of the debug port device.
SetMode Change the mode of the debug port device.

Description

The DXE debug port extension protocol is used to describe additional debug port capabilities beyond those in the UEFI 2.0 specification.

GetMode()

Return the mode of the debug port device.

Prototype

typedef 
EFI_STATUS
(EFIAPI *DXE_DEBUGPORT_GET_MODE) (
  IN     CONST DXE_DEBUGPORT_EXT_PROTOTOL *This,
  IN     DEBUGPORT_MODE                   ModeType,
  IN OUT DEBUGPORT_MODE_INFO              *ModeValue
  );

Parameters

Parameter Description
This A pointer to the DXE_DEBUGPORT_EXT_PPI instance.
ModeType The type of debug port mode information to be changed.
ModeValue The returned value for the debug port mode information.

Description
The GetMode() function returns the operating mode of the debug port. Different debug ports may support different optional features.

These optional features are standardized but may not be supported on all debug ports.

If a debug port device does not support a particular feature or cannot return the mode information, then it will return EFI_UNSUPPORTED. If a debug port supports a particular feature, but that feature cannot be set, then it will return EFI_DEVICE_ERROR or EFI_NOT_READY.

See EFI_DEBUGPORT_MODE for more information.

Status Codes Returns

Status Code Description
EFI_SUCCESS At least one byte of data is available to be read.
EFI_UNSUPPORTED Debug port doesn’t suppor t the specified ModeType.
EFI_NOT_READY Debug port can’t do the specified action at this time.
EFI_DEVICE_ERROR Debug port device is not functioning correctly.

SetMode()

Change the mode of the debug port device.

Prototype

typedef 
EFI_STATUS
(EFIAPI *DXE_DEBUGPORT_SET_MODE) (
  IN CONST DXE_DEBUGPORT_EXT_PROTOCOL  *This,
  IN DEBUGPORT_MODE                    ModeType,
  IN CONST DEBUGPORT_MODE_INFO         *ModeValue
  );

Parameters

Parameter Description
This A pointer to the DXE_DEBUGPORT_EXT_PROTOCOL instance.
ModeType The type of target mode information to be changed.
ModeValue The new value for the target mode information.

Description
The SetMode() function changes the operating mode of the debug port. Different debug ports may support different optional features.

These optional features are standardized but may not be supported on all debug ports.

If a debug port device does not support a particular feature, then it will return EFI_UNSUPPORTED. If a target platform supports a particular feature, but the values specified by ModeValue are wrong, then it will return EFI_INVALID_PARAMETER. If a debug port supports a particular feature, but that feature cannot be set, then it will return EFI_DEVICE_ERROR or EFI_NOT_READY.

Status Codes Returns

Status Code Description
EFI_SUCCESS At least one byte of data is available to be read.
EFI_UNSUPPORTED Debug port doesn’t suppor t the specified ModeType.
EFI_NOT_READY Debug port can’t do the specified action at this time.
EFI_DEVICE_ERROR Debug port device is not functioning correctly.

Copyright (C) 2008 Phoenix Technologies Ltd. All Rights Reserved.

Personal tools