EmbeddedPkg: Introduced 'SerialPortExtLib.h'

[mirror_edk2.git] / Omap35xxPkg / Library / SerialPortLib / SerialPortLib.c

/** @file\r
  Serial I/O Port library functions with no library constructor/destructor\r
\r
\r
  Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
  \r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include <Base.h>\r
#include <Library/DebugLib.h>\r
#include <Library/SerialPortLib.h>\r
#include <Library/SerialPortExtLib.h>\r
#include <Library/PcdLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/OmapLib.h>\r
#include <Omap3530/Omap3530.h>\r
\r
/*\r
\r
  Programmed hardware of Serial port.\r
\r
  @return    Always return EFI_UNSUPPORTED.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
SerialPortInitialize (\r
  VOID\r
  )\r
{\r
  // assume assembly code at reset vector has setup UART\r
  return RETURN_SUCCESS;\r
}\r
\r
/**\r
  Write data to serial device.\r
\r
  @param  Buffer           Point of data buffer which need to be writed.\r
  @param  NumberOfBytes    Number of output bytes which are cached in Buffer.\r
\r
  @retval 0                Write data failed.\r
  @retval !0               Actual number of bytes writed to serial device.\r
\r
**/\r
UINTN\r
EFIAPI\r
SerialPortWrite (\r
  IN UINT8     *Buffer,\r
  IN UINTN     NumberOfBytes\r
)\r
{\r
  UINT32  LSR = UartBase(PcdGet32(PcdOmap35xxConsoleUart)) + UART_LSR_REG;\r
  UINT32  THR = UartBase(PcdGet32(PcdOmap35xxConsoleUart)) + UART_THR_REG;\r
  UINTN   Count;\r
    \r
  for (Count = 0; Count < NumberOfBytes; Count++, Buffer++) {\r
    while ((MmioRead8(LSR) & UART_LSR_TX_FIFO_E_MASK) == UART_LSR_TX_FIFO_E_NOT_EMPTY);\r
    MmioWrite8(THR, *Buffer);\r
  }\r
\r
  return NumberOfBytes;\r
}\r
\r
\r
/**\r
  Read data from serial device and save the datas in buffer.\r
\r
  @param  Buffer           Point of data buffer which need to be writed.\r
  @param  NumberOfBytes    Number of output bytes which are cached in Buffer.\r
\r
  @retval 0                Read data failed.\r
  @retval !0               Aactual number of bytes read from serial device.\r
\r
**/\r
UINTN\r
EFIAPI\r
SerialPortRead (\r
  OUT UINT8     *Buffer,\r
  IN  UINTN     NumberOfBytes\r
)\r
{\r
  UINT32  LSR = UartBase(PcdGet32(PcdOmap35xxConsoleUart)) + UART_LSR_REG;\r
  UINT32  RBR = UartBase(PcdGet32(PcdOmap35xxConsoleUart)) + UART_RBR_REG;\r
  UINTN   Count;\r
    \r
  for (Count = 0; Count < NumberOfBytes; Count++, Buffer++) {\r
    while ((MmioRead8(LSR) & UART_LSR_RX_FIFO_E_MASK) == UART_LSR_RX_FIFO_E_EMPTY);\r
    *Buffer = MmioRead8(RBR);\r
  }\r
\r
  return NumberOfBytes;\r
}\r
\r
\r
/**\r
  Check to see if any data is avaiable to be read from the debug device.\r
\r
  @retval EFI_SUCCESS       At least one byte of data is avaiable to be read\r
  @retval EFI_NOT_READY     No data is avaiable to be read\r
  @retval EFI_DEVICE_ERROR  The serial device is not functioning properly\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
SerialPortPoll (\r
  VOID\r
  )\r
{\r
  UINT32 LSR = UartBase(PcdGet32(PcdOmap35xxConsoleUart)) + UART_LSR_REG;\r
\r
  if ((MmioRead8(LSR) & UART_LSR_RX_FIFO_E_MASK) == UART_LSR_RX_FIFO_E_NOT_EMPTY) {\r
    return TRUE;\r
  } else {\r
    return FALSE;\r
  }\r
}\r
\r
/**\r
  Set the serial device control bits.\r
\r
  @return    Always return EFI_UNSUPPORTED.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
SerialPortSetControl (\r
  IN UINT32                   Control\r
  )\r
{\r
  return RETURN_SUCCESS;\r
}\r
\r
/**\r
  Get the serial device control bits.\r
\r
  @param  Control                 Control signals read from the serial device.\r
\r
  @retval EFI_SUCCESS             The control bits were read from the serial device.\r
  @retval EFI_DEVICE_ERROR        The serial device is not functioning correctly.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
SerialPortGetControl (\r
  OUT UINT32                  *Control\r
  )\r
{\r
  return RETURN_SUCCESS;\r
}\r
\r
\r
/**\r
  Set the serial device attributes.\r
\r
  @return    Always return EFI_UNSUPPORTED.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
SerialPortSetAttributes (\r
  IN UINT64              BaudRate,\r
  IN UINT32              ReceiveFifoDepth,\r
  IN UINT32              Timeout,\r
  IN EFI_PARITY_TYPE     Parity,\r
  IN UINT8               DataBits,\r
  IN EFI_STOP_BITS_TYPE  StopBits\r
  )\r
{\r
  return RETURN_SUCCESS;\r
}\r
\r