EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Functions

ArmPlatformPkg/Drivers/PL011Uart/PL011Uart.c File Reference

#include <Include/Uefi.h>
#include <Library/IoLib.h>
#include <Drivers/PL011Uart.h>

Go to the source code of this file.

Functions

RETURN_STATUS EFIAPI PL011UartInitialize (IN UINTN UartBase, IN UINTN BaudRate, IN UINTN LineControl)
UINTN EFIAPI PL011UartWrite (IN UINTN UartBase, IN UINT8 *Buffer, IN UINTN NumberOfBytes)
UINTN EFIAPI PL011UartRead (IN UINTN UartBase, OUT UINT8 *Buffer, IN UINTN NumberOfBytes)
BOOLEAN EFIAPI PL011UartPoll (IN UINTN UartBase)

Detailed Description

Serial I/O Port library functions with no library constructor/destructor

Copyright (c) 2008 - 2010, Apple Inc. 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.

Definition in file PL011Uart.c.


Function Documentation

RETURN_STATUS EFIAPI PL011UartInitialize ( IN UINTN  UartBase,
IN UINTN  BaudRate,
IN UINTN  LineControl 
)

Definition at line 32 of file PL011Uart.c.

BOOLEAN EFIAPI PL011UartPoll ( IN UINTN  UartBase)

Check to see if any data is available to be read from the debug device.

Return values:
EFI_SUCCESSAt least one byte of data is available to be read
EFI_NOT_READYNo data is available to be read
EFI_DEVICE_ERRORThe serial device is not functioning properly

Definition at line 132 of file PL011Uart.c.

UINTN EFIAPI PL011UartRead ( IN UINTN  UartBase,
OUT UINT8 Buffer,
IN UINTN  NumberOfBytes 
)

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

Parameters:
BufferPoint of data buffer which need to be written.
NumberOfBytesNumber of output bytes which are cached in Buffer.
Return values:
0Read data failed.
!0Actual number of bytes read from serial device.

Definition at line 106 of file PL011Uart.c.

UINTN EFIAPI PL011UartWrite ( IN UINTN  UartBase,
IN UINT8 Buffer,
IN UINTN  NumberOfBytes 
)

Write data to serial device.

Parameters:
BufferPoint of data buffer which need to be written.
NumberOfBytesNumber of output bytes which are cached in Buffer.
Return values:
0Write data failed.
!0Actual number of bytes written to serial device.

Definition at line 78 of file PL011Uart.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines