iPXE
Data Fields
_EFI_SERIAL_IO_PROTOCOL Struct Reference

The Serial I/O protocol is used to communicate with UART-style serial devices. More...

#include <SerialIo.h>

Data Fields

UINT32 Revision
 The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. More...
 
EFI_SERIAL_RESET Reset
 
EFI_SERIAL_SET_ATTRIBUTES SetAttributes
 
EFI_SERIAL_SET_CONTROL_BITS SetControl
 
EFI_SERIAL_GET_CONTROL_BITS GetControl
 
EFI_SERIAL_WRITE Write
 
EFI_SERIAL_READ Read
 
EFI_SERIAL_IO_MODEMode
 Pointer to SERIAL_IO_MODE data. More...
 
CONST EFI_GUIDDeviceTypeGuid
 Pointer to a GUID identifying the device connected to the serial port. More...
 

Detailed Description

The Serial I/O protocol is used to communicate with UART-style serial devices.

These can be standard UART serial ports in PC-AT systems, serial ports attached to a USB interface, or potentially any character-based I/O device.

Definition at line 281 of file SerialIo.h.

Field Documentation

◆ Revision

UINT32 _EFI_SERIAL_IO_PROTOCOL::Revision

The revision to which the EFI_SERIAL_IO_PROTOCOL adheres.

All future revisions must be backwards compatible. If a future version is not backwards compatible, it is not the same GUID.

Definition at line 287 of file SerialIo.h.

◆ Reset

EFI_SERIAL_RESET _EFI_SERIAL_IO_PROTOCOL::Reset

Definition at line 288 of file SerialIo.h.

◆ SetAttributes

EFI_SERIAL_SET_ATTRIBUTES _EFI_SERIAL_IO_PROTOCOL::SetAttributes

Definition at line 289 of file SerialIo.h.

◆ SetControl

EFI_SERIAL_SET_CONTROL_BITS _EFI_SERIAL_IO_PROTOCOL::SetControl

Definition at line 290 of file SerialIo.h.

◆ GetControl

EFI_SERIAL_GET_CONTROL_BITS _EFI_SERIAL_IO_PROTOCOL::GetControl

Definition at line 291 of file SerialIo.h.

◆ Write

EFI_SERIAL_WRITE _EFI_SERIAL_IO_PROTOCOL::Write

Definition at line 292 of file SerialIo.h.

◆ Read

EFI_SERIAL_READ _EFI_SERIAL_IO_PROTOCOL::Read

Definition at line 293 of file SerialIo.h.

◆ Mode

EFI_SERIAL_IO_MODE* _EFI_SERIAL_IO_PROTOCOL::Mode

Pointer to SERIAL_IO_MODE data.

Definition at line 297 of file SerialIo.h.

◆ DeviceTypeGuid

CONST EFI_GUID* _EFI_SERIAL_IO_PROTOCOL::DeviceTypeGuid

Pointer to a GUID identifying the device connected to the serial port.

This field is NULL when the protocol is installed by the serial port driver and may be populated by a platform driver for a serial port with a known device attached. The field will remain NULL if there is no platform serial device identification information available.

Definition at line 305 of file SerialIo.h.


The documentation for this struct was generated from the following file: