MdePkg/Library/BaseSerialPortLibNull/BaseSerialPortLibNull.c File Reference


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

Null Serial Port library instance with empty functions.

Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Function Documentation

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.

References RETURN_SUCCESS.

Referenced by BaseDebugLibSerialPortConstructor().

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.

References FALSE.

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.

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.

Referenced by DebugAssert(), and DebugPrint().


Generated on Thu Sep 24 23:14:24 2015 for MdePkg[ALL] by  doxygen 1.5.7.1