Serial_io.getcontrol(), Getcontrol() – Intel Extensible Firmware Interface User Manual
Page 357

Protocols
— Console Support
Version 1.10
12/01/02
10-63
SERIAL_IO.GetControl()
Summary
Retrieves the status of the control bits on a serial device.
Prototype
EFI_STATUS
(EFIAPI *EFI_SERIAL_GET_CONTROL) (
IN
SERIAL_IO_INTERFACE
*This,
OUT
UINT32
*Control
);
Parameters
This
A pointer to the
instance. Type
SERIAL_IO_INTERFACE
is defined in Section 10.12.
Control
A pointer to return the current control signals from the
serial device. See “Related Definitions” below.
Related Definitions
//*******************************************************
// CONTROL BITS
//*******************************************************
#define
EFI_SERIAL_CLEAR_TO_SEND
0x0010
#define
EFI_SERIAL_DATA_SET_READY 0x0020
#define
EFI_SERIAL_RING_INDICATE
0x0040
#define
EFI_SERIAL_CARRIER_DETECT 0x0080
#define
EFI_SERIAL_REQUEST_TO_SEND
0x0002
#define EFI_SERIAL_DATA_TERMINAL_READY
0x0001
#define
EFI_SERIAL_INPUT_BUFFER_EMPTY
0x0100
#define EFI_SERIAL_OUTPUT_BUFFER_EMPTY
0x0200
#define EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE
0x1000
#define EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE
0x2000
#define EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE 0x4000
Description
The
GetControl()
function retrieves the status of the control bits on a serial device.
Status Codes Returned
EFI_SUCCESS
The control bits were read from the serial device.
EFI_DEVICE_ERROR
The serial device is not functioning correctly.