PeiEmuSerialPortLib.c File Reference

#include <PiPei.h>
#include <Library/SerialPortLib.h>
#include <Library/PeiServicesLib.h>
#include <Ppi/EmuThunk.h>
#include <Protocol/EmuThunk.h>

Go to the source code of this file.

Functions
RETURN_STATUS EFIAPI	SerialPortInitialize (VOID)
UINTN EFIAPI	SerialPortWrite (IN UINT8 *Buffer, IN UINTN NumberOfBytes)
UINTN EFIAPI	SerialPortRead (OUT UINT8 *Buffer, IN UINTN NumberOfBytes)
BOOLEAN EFIAPI	SerialPortPoll (VOID)

Detailed Description

Serial Port Lib that thunks back to Emulator services to write to StdErr. All read functions are stubed out. There is no constructor so this lib can be linked with PEI Core.

Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
Portions copyright (c) 2011, Apple Inc. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file PeiEmuSerialPortLib.c.

Function Documentation

SerialPortInitialize()

RETURN_STATUS EFIAPI SerialPortInitialize

(

VOID

)

Initialize the serial device hardware.

If no initialization is required, then return RETURN_SUCCESS. If the serial device was successfully initialized, then return RETURN_SUCCESS. If the serial device could not be initialized, then return RETURN_DEVICE_ERROR.

Return values

RETURN_SUCCESS	The serial device was initialized.
RETURN_DEVICE_ERROR	The serial device could not be initialized.

Definition at line 32 of file PeiEmuSerialPortLib.c.

SerialPortPoll()

BOOLEAN EFIAPI SerialPortPoll

(

VOID

)

Polls a serial device to see if there is any data waiting to be read.

Polls a serial device to see if there is any data waiting to be read. If there is data waiting to be read from the serial device, then TRUE is returned. If there is no data waiting to be read from the serial device, then FALSE is returned.

Return values

TRUE	Data is waiting to be read from the serial device.
FALSE	There is no data waiting to be read from the serial device.

Definition at line 123 of file PeiEmuSerialPortLib.c.

SerialPortRead()

UINTN EFIAPI SerialPortRead	(	OUT UINT8 *	Buffer,
		IN UINTN	NumberOfBytes
	)

Read data from serial device and save the datas in buffer.

Reads NumberOfBytes data bytes from a serial device into the buffer specified by Buffer. The number of bytes actually read is returned. If the return value is less than NumberOfBytes, then the rest operation failed. If Buffer is NULL, then ASSERT(). If NumberOfBytes is zero, then return 0.

Parameters

Buffer	The pointer to the data buffer to store the data read from the serial device.
NumberOfBytes	The number of bytes which will be read.

Return values

0	Read data failed; No data is to be read.
>0	The actual number of bytes read from serial device.

Definition at line 102 of file PeiEmuSerialPortLib.c.

SerialPortWrite()

UINTN EFIAPI SerialPortWrite	(	IN UINT8 *	Buffer,
		IN UINTN	NumberOfBytes
	)

Write data from buffer to serial device.

Writes NumberOfBytes data bytes from Buffer to the serial device. The number of bytes actually written to the serial device is returned. If the return value is less than NumberOfBytes, then the write operation failed. If Buffer is NULL, then ASSERT(). If NumberOfBytes is zero, then return 0.

Parameters

Buffer	The pointer to the data buffer to be written.
NumberOfBytes	The number of bytes to written to the serial device.

Return values

0	NumberOfBytes is 0.
>0	The number of bytes written to the serial device. If this value is less than NumberOfBytes, then the read operation failed.

Definition at line 58 of file PeiEmuSerialPortLib.c.