ArmPlatformPkg: reorganize PL011 code
authorArd Biesheuvel <ard.biesheuvel@linaro.org>
Thu, 16 Nov 2017 17:08:08 +0000 (17:08 +0000)
committerArd Biesheuvel <ard.biesheuvel@linaro.org>
Fri, 17 Nov 2017 10:01:29 +0000 (10:01 +0000)
The PL011 code in ArmPlatformPkg is organized in a weird way: there is
a single PL011Uart.h header file under Include/Drivers containing both
register definitions and function entry points. The PL011Uart library
itself is in Drivers/ but it is actually a library.

So let's clean this up: add a new PL011UartLib library class and associated
header file containing only the library prototypes, and move the library
itself under Library/ using a new GUID, with the register definitions moved
into a local header file.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>
ArmPlatformPkg/ArmPlatformPkg.dec
ArmPlatformPkg/Include/Library/PL011UartLib.h [new file with mode: 0644]
ArmPlatformPkg/Library/PL011SerialPortLib/PL011SerialPortLib.c
ArmPlatformPkg/Library/PL011UartLib/PL011Uart.h [new file with mode: 0644]
ArmPlatformPkg/Library/PL011UartLib/PL011UartLib.c [new file with mode: 0644]
ArmPlatformPkg/Library/PL011UartLib/PL011UartLib.inf [new file with mode: 0644]

index 2d82ead..e282e76 100644 (file)
@@ -31,6 +31,9 @@
 [Includes.common]\r
   Include                        # Root include for the package\r
 \r
+[LibraryClasses]\r
+  PL011UartLib|Include/Library/PL011UartLib.h\r
+\r
 [Guids.common]\r
   gArmPlatformTokenSpaceGuid   = { 0x9c0aaed4, 0x74c5, 0x4043, { 0xb4, 0x17, 0xa3, 0x22, 0x38, 0x14, 0xce, 0x76 } }\r
   #\r
diff --git a/ArmPlatformPkg/Include/Library/PL011UartLib.h b/ArmPlatformPkg/Include/Library/PL011UartLib.h
new file mode 100644 (file)
index 0000000..8cfc3d1
--- /dev/null
@@ -0,0 +1,189 @@
+/** @file\r
+*\r
+*  Copyright (c) 2011-2016, ARM Limited. All rights reserved.\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
+#ifndef __PL011_UART_LIB_H__\r
+#define __PL011_UART_LIB_H__\r
+\r
+#include <Uefi/UefiBaseType.h>\r
+\r
+#include <Protocol/SerialIo.h>\r
+\r
+/**\r
+\r
+  Initialise the serial port to the specified settings.\r
+  All unspecified settings will be set to the default values.\r
+\r
+  @param[in]  UartBase            The base address of the serial device.\r
+  @param[in]  UartClkInHz         The clock in Hz for the serial device.\r
+                                  Ignored if the PCD PL011UartInteger is not 0\r
+  @param[in out] BaudRate         The baud rate of the serial device. If the\r
+                                  baud rate is not supported, the speed will be\r
+                                  reduced to the nearest supported one and the\r
+                                  variable's value will be updated accordingly.\r
+  @param[in out] ReceiveFifoDepth The number of characters the device will\r
+                                  buffer on input.  Value of 0 will use the\r
+                                  device's default FIFO depth.\r
+  @param[in out]  Parity          If applicable, this is the EFI_PARITY_TYPE\r
+                                  that is computed or checked as each character\r
+                                  is transmitted or received. If the device\r
+                                  does not support parity, the value is the\r
+                                  default parity value.\r
+  @param[in out]  DataBits        The number of data bits in each character.\r
+  @param[in out]  StopBits        If applicable, the EFI_STOP_BITS_TYPE number\r
+                                  of stop bits per character.\r
+                                  If the device does not support stop bits, the\r
+                                  value is the default stop bit value.\r
+\r
+  @retval RETURN_SUCCESS            All attributes were set correctly on the\r
+                                    serial device.\r
+  @retval RETURN_INVALID_PARAMETER  One or more of the attributes has an\r
+                                    unsupported value.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+PL011UartInitializePort (\r
+  IN     UINTN               UartBase,\r
+  IN     UINT32              UartClkInHz,\r
+  IN OUT UINT64              *BaudRate,\r
+  IN OUT UINT32              *ReceiveFifoDepth,\r
+  IN OUT EFI_PARITY_TYPE     *Parity,\r
+  IN OUT UINT8               *DataBits,\r
+  IN OUT EFI_STOP_BITS_TYPE  *StopBits\r
+  );\r
+\r
+/**\r
+\r
+  Assert or deassert the control signals on a serial port.\r
+  The following control signals are set according their bit settings :\r
+  . Request to Send\r
+  . Data Terminal Ready\r
+\r
+  @param[in]  UartBase  UART registers base address\r
+  @param[in]  Control   The following bits are taken into account :\r
+                        . EFI_SERIAL_REQUEST_TO_SEND : assert/deassert the\r
+                          "Request To Send" control signal if this bit is\r
+                          equal to one/zero.\r
+                        . EFI_SERIAL_DATA_TERMINAL_READY : assert/deassert\r
+                          the "Data Terminal Ready" control signal if this\r
+                          bit is equal to one/zero.\r
+                        . EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE : enable/disable\r
+                          the hardware loopback if this bit is equal to\r
+                          one/zero.\r
+                        . EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE : not supported.\r
+                        . EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE : enable/\r
+                          disable the hardware flow control based on CTS (Clear\r
+                          To Send) and RTS (Ready To Send) control signals.\r
+\r
+  @retval  RETURN_SUCCESS      The new control bits were set on the device.\r
+  @retval  RETURN_UNSUPPORTED  The device does not support this operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+PL011UartSetControl (\r
+  IN UINTN   UartBase,\r
+  IN UINT32  Control\r
+  );\r
+\r
+/**\r
+\r
+  Retrieve the status of the control bits on a serial device.\r
+\r
+  @param[in]   UartBase  UART registers base address\r
+  @param[out]  Control   Status of the control bits on a serial device :\r
+\r
+                         . EFI_SERIAL_DATA_CLEAR_TO_SEND,\r
+                           EFI_SERIAL_DATA_SET_READY,\r
+                           EFI_SERIAL_RING_INDICATE,\r
+                           EFI_SERIAL_CARRIER_DETECT,\r
+                           EFI_SERIAL_REQUEST_TO_SEND,\r
+                           EFI_SERIAL_DATA_TERMINAL_READY\r
+                           are all related to the DTE (Data Terminal Equipment)\r
+                           and DCE (Data Communication Equipment) modes of\r
+                           operation of the serial device.\r
+                         . EFI_SERIAL_INPUT_BUFFER_EMPTY : equal to one if the\r
+                           receive buffer is empty, 0 otherwise.\r
+                         . EFI_SERIAL_OUTPUT_BUFFER_EMPTY : equal to one if the\r
+                           transmit buffer is empty, 0 otherwise.\r
+                         . EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE : equal to one if\r
+                           the hardware loopback is enabled (the ouput feeds the\r
+                           receive buffer), 0 otherwise.\r
+                         . EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE : equal to one if\r
+                           a loopback is accomplished by software, 0 otherwise.\r
+                         . EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE : equal to\r
+                           one if the hardware flow control based on CTS (Clear\r
+                           To Send) and RTS (Ready To Send) control signals is\r
+                           enabled, 0 otherwise.\r
+\r
+  @retval RETURN_SUCCESS  The control bits were read from the serial device.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+PL011UartGetControl (\r
+  IN UINTN     UartBase,\r
+  OUT UINT32  *Control\r
+  );\r
+\r
+/**\r
+  Write data to serial device.\r
+\r
+  @param  Buffer           Point of data buffer which need to be written.\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 written to serial device.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+PL011UartWrite (\r
+  IN  UINTN       UartBase,\r
+  IN  UINT8       *Buffer,\r
+  IN  UINTN       NumberOfBytes\r
+  );\r
+\r
+/**\r
+  Read data from serial device and save the data in buffer.\r
+\r
+  @param  Buffer           Point of data buffer which need to be written.\r
+  @param  NumberOfBytes    Number of output bytes which are cached in Buffer.\r
+\r
+  @retval 0                Read data failed.\r
+  @retval !0               Actual number of bytes read from serial device.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+PL011UartRead (\r
+  IN  UINTN       UartBase,\r
+  OUT UINT8       *Buffer,\r
+  IN  UINTN       NumberOfBytes\r
+  );\r
+\r
+/**\r
+  Check to see if any data is available to be read from the debug device.\r
+\r
+  @retval TRUE       At least one byte of data is available to be read\r
+  @retval FALSE      No data is available to be read\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+PL011UartPoll (\r
+  IN  UINTN       UartBase\r
+  );\r
+\r
+#endif\r
index 571d061..6aa8063 100644 (file)
 \r
 #include <Library/IoLib.h>\r
 #include <Library/PcdLib.h>\r
+#include <Library/PL011UartLib.h>\r
 #include <Library/SerialPortLib.h>\r
 \r
-#include <Drivers/PL011Uart.h>\r
-\r
 /** Initialise the serial device hardware with default settings.\r
 \r
   @retval RETURN_SUCCESS            The serial device was initialised.\r
diff --git a/ArmPlatformPkg/Library/PL011UartLib/PL011Uart.h b/ArmPlatformPkg/Library/PL011UartLib/PL011Uart.h
new file mode 100644 (file)
index 0000000..0ea3855
--- /dev/null
@@ -0,0 +1,120 @@
+/** @file\r
+*\r
+*  Copyright (c) 2011-2016, ARM Limited. All rights reserved.\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
+#ifndef __PL011_UART_H__\r
+#define __PL011_UART_H__\r
+\r
+#define PL011_VARIANT_ZTE 1\r
+\r
+// PL011 Registers\r
+#if FixedPcdGet8 (PL011UartRegOffsetVariant) == PL011_VARIANT_ZTE\r
+#define UARTDR                    0x004\r
+#define UARTRSR                   0x010\r
+#define UARTECR                   0x010\r
+#define UARTFR                    0x014\r
+#define UARTIBRD                  0x024\r
+#define UARTFBRD                  0x028\r
+#define UARTLCR_H                 0x030\r
+#define UARTCR                    0x034\r
+#define UARTIFLS                  0x038\r
+#define UARTIMSC                  0x040\r
+#define UARTRIS                   0x044\r
+#define UARTMIS                   0x048\r
+#define UARTICR                   0x04c\r
+#define UARTDMACR                 0x050\r
+#else\r
+#define UARTDR                    0x000\r
+#define UARTRSR                   0x004\r
+#define UARTECR                   0x004\r
+#define UARTFR                    0x018\r
+#define UARTILPR                  0x020\r
+#define UARTIBRD                  0x024\r
+#define UARTFBRD                  0x028\r
+#define UARTLCR_H                 0x02C\r
+#define UARTCR                    0x030\r
+#define UARTIFLS                  0x034\r
+#define UARTIMSC                  0x038\r
+#define UARTRIS                   0x03C\r
+#define UARTMIS                   0x040\r
+#define UARTICR                   0x044\r
+#define UARTDMACR                 0x048\r
+#endif\r
+\r
+#define UARTPID0                  0xFE0\r
+#define UARTPID1                  0xFE4\r
+#define UARTPID2                  0xFE8\r
+#define UARTPID3                  0xFEC\r
+\r
+// Data status bits\r
+#define UART_DATA_ERROR_MASK      0x0F00\r
+\r
+// Status reg bits\r
+#define UART_STATUS_ERROR_MASK    0x0F\r
+\r
+// Flag reg bits\r
+#if FixedPcdGet8 (PL011UartRegOffsetVariant) == PL011_VARIANT_ZTE\r
+#define PL011_UARTFR_RI           (1 << 0)  // Ring indicator\r
+#define PL011_UARTFR_TXFE         (1 << 7)  // Transmit FIFO empty\r
+#define PL011_UARTFR_RXFF         (1 << 6)  // Receive  FIFO full\r
+#define PL011_UARTFR_TXFF         (1 << 5)  // Transmit FIFO full\r
+#define PL011_UARTFR_RXFE         (1 << 4)  // Receive  FIFO empty\r
+#define PL011_UARTFR_BUSY         (1 << 8)  // UART busy\r
+#define PL011_UARTFR_DCD          (1 << 2)  // Data carrier detect\r
+#define PL011_UARTFR_DSR          (1 << 3)  // Data set ready\r
+#define PL011_UARTFR_CTS          (1 << 1)  // Clear to send\r
+#else\r
+#define PL011_UARTFR_RI           (1 << 8)  // Ring indicator\r
+#define PL011_UARTFR_TXFE         (1 << 7)  // Transmit FIFO empty\r
+#define PL011_UARTFR_RXFF         (1 << 6)  // Receive  FIFO full\r
+#define PL011_UARTFR_TXFF         (1 << 5)  // Transmit FIFO full\r
+#define PL011_UARTFR_RXFE         (1 << 4)  // Receive  FIFO empty\r
+#define PL011_UARTFR_BUSY         (1 << 3)  // UART busy\r
+#define PL011_UARTFR_DCD          (1 << 2)  // Data carrier detect\r
+#define PL011_UARTFR_DSR          (1 << 1)  // Data set ready\r
+#define PL011_UARTFR_CTS          (1 << 0)  // Clear to send\r
+#endif\r
+\r
+// Flag reg bits - alternative names\r
+#define UART_TX_EMPTY_FLAG_MASK   PL011_UARTFR_TXFE\r
+#define UART_RX_FULL_FLAG_MASK    PL011_UARTFR_RXFF\r
+#define UART_TX_FULL_FLAG_MASK    PL011_UARTFR_TXFF\r
+#define UART_RX_EMPTY_FLAG_MASK   PL011_UARTFR_RXFE\r
+#define UART_BUSY_FLAG_MASK       PL011_UARTFR_BUSY\r
+\r
+// Control reg bits\r
+#define PL011_UARTCR_CTSEN        (1 << 15) // CTS hardware flow control enable\r
+#define PL011_UARTCR_RTSEN        (1 << 14) // RTS hardware flow control enable\r
+#define PL011_UARTCR_RTS          (1 << 11) // Request to send\r
+#define PL011_UARTCR_DTR          (1 << 10) // Data transmit ready.\r
+#define PL011_UARTCR_RXE          (1 << 9)  // Receive enable\r
+#define PL011_UARTCR_TXE          (1 << 8)  // Transmit enable\r
+#define PL011_UARTCR_LBE          (1 << 7)  // Loopback enable\r
+#define PL011_UARTCR_UARTEN       (1 << 0)  // UART Enable\r
+\r
+// Line Control Register Bits\r
+#define PL011_UARTLCR_H_SPS       (1 << 7)  // Stick parity select\r
+#define PL011_UARTLCR_H_WLEN_8    (3 << 5)\r
+#define PL011_UARTLCR_H_WLEN_7    (2 << 5)\r
+#define PL011_UARTLCR_H_WLEN_6    (1 << 5)\r
+#define PL011_UARTLCR_H_WLEN_5    (0 << 5)\r
+#define PL011_UARTLCR_H_FEN       (1 << 4)  // FIFOs Enable\r
+#define PL011_UARTLCR_H_STP2      (1 << 3)  // Two stop bits select\r
+#define PL011_UARTLCR_H_EPS       (1 << 2)  // Even parity select\r
+#define PL011_UARTLCR_H_PEN       (1 << 1)  // Parity Enable\r
+#define PL011_UARTLCR_H_BRK       (1 << 0)  // Send break\r
+\r
+#define PL011_UARTPID2_VER(X)     (((X) >> 4) & 0xF)\r
+#define PL011_VER_R1P4            0x2\r
+\r
+#endif\r
diff --git a/ArmPlatformPkg/Library/PL011UartLib/PL011UartLib.c b/ArmPlatformPkg/Library/PL011UartLib/PL011UartLib.c
new file mode 100644 (file)
index 0000000..61a34fd
--- /dev/null
@@ -0,0 +1,474 @@
+/** @file\r
+  Serial I/O Port library functions with no library constructor/destructor\r
+\r
+  Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>\r
+  Copyright (c) 2011 - 2016, ARM Ltd. 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 <Uefi.h>\r
+\r
+#include <Library/DebugLib.h>\r
+#include <Library/IoLib.h>\r
+#include <Library/PcdLib.h>\r
+\r
+#include <Protocol/SerialIo.h>\r
+\r
+#include "PL011Uart.h"\r
+\r
+#define FRACTION_PART_SIZE_IN_BITS  6\r
+#define FRACTION_PART_MASK          ((1 << FRACTION_PART_SIZE_IN_BITS) - 1)\r
+\r
+//\r
+// EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE is the only\r
+// control bit that is not supported.\r
+//\r
+STATIC CONST UINT32 mInvalidControlBits = EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE;\r
+\r
+/**\r
+\r
+  Initialise the serial port to the specified settings.\r
+  The serial port is re-configured only if the specified settings\r
+  are different from the current settings.\r
+  All unspecified settings will be set to the default values.\r
+\r
+  @param  UartBase                The base address of the serial device.\r
+  @param  UartClkInHz             The clock in Hz for the serial device.\r
+                                  Ignored if the PCD PL011UartInteger is not 0\r
+  @param  BaudRate                The baud rate of the serial device. If the\r
+                                  baud rate is not supported, the speed will be\r
+                                  reduced to the nearest supported one and the\r
+                                  variable's value will be updated accordingly.\r
+  @param  ReceiveFifoDepth        The number of characters the device will\r
+                                  buffer on input.  Value of 0 will use the\r
+                                  device's default FIFO depth.\r
+  @param  Parity                  If applicable, this is the EFI_PARITY_TYPE\r
+                                  that is computed or checked as each character\r
+                                  is transmitted or received. If the device\r
+                                  does not support parity, the value is the\r
+                                  default parity value.\r
+  @param  DataBits                The number of data bits in each character.\r
+  @param  StopBits                If applicable, the EFI_STOP_BITS_TYPE number\r
+                                  of stop bits per character.\r
+                                  If the device does not support stop bits, the\r
+                                  value is the default stop bit value.\r
+\r
+  @retval RETURN_SUCCESS            All attributes were set correctly on the\r
+                                    serial device.\r
+  @retval RETURN_INVALID_PARAMETER  One or more of the attributes has an\r
+                                    unsupported value.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+PL011UartInitializePort (\r
+  IN     UINTN               UartBase,\r
+  IN     UINT32              UartClkInHz,\r
+  IN OUT UINT64              *BaudRate,\r
+  IN OUT UINT32              *ReceiveFifoDepth,\r
+  IN OUT EFI_PARITY_TYPE     *Parity,\r
+  IN OUT UINT8               *DataBits,\r
+  IN OUT EFI_STOP_BITS_TYPE  *StopBits\r
+  )\r
+{\r
+  UINT32      LineControl;\r
+  UINT32      Divisor;\r
+  UINT32      Integer;\r
+  UINT32      Fractional;\r
+  UINT32      HardwareFifoDepth;\r
+\r
+  HardwareFifoDepth = (PL011_UARTPID2_VER (MmioRead32 (UartBase + UARTPID2)) \\r
+                       > PL011_VER_R1P4) \\r
+                      ? 32 : 16 ;\r
+  // The PL011 supports a buffer of 1, 16 or 32 chars. Therefore we can accept\r
+  // 1 char buffer as the minimum FIFO size. Because everything can be rounded\r
+  // down, there is no maximum FIFO size.\r
+  if ((*ReceiveFifoDepth == 0) || (*ReceiveFifoDepth >= HardwareFifoDepth)) {\r
+    // Enable FIFO\r
+    LineControl = PL011_UARTLCR_H_FEN;\r
+    *ReceiveFifoDepth = HardwareFifoDepth;\r
+  } else {\r
+    // Disable FIFO\r
+    LineControl = 0;\r
+    // Nothing else to do. 1 byte FIFO is default.\r
+    *ReceiveFifoDepth = 1;\r
+  }\r
+\r
+  //\r
+  // Parity\r
+  //\r
+  switch (*Parity) {\r
+  case DefaultParity:\r
+    *Parity = NoParity;\r
+  case NoParity:\r
+    // Nothing to do. Parity is disabled by default.\r
+    break;\r
+  case EvenParity:\r
+    LineControl |= (PL011_UARTLCR_H_PEN | PL011_UARTLCR_H_EPS);\r
+    break;\r
+  case OddParity:\r
+    LineControl |= PL011_UARTLCR_H_PEN;\r
+    break;\r
+  case MarkParity:\r
+    LineControl |= (  PL011_UARTLCR_H_PEN \\r
+                    | PL011_UARTLCR_H_SPS \\r
+                    | PL011_UARTLCR_H_EPS);\r
+    break;\r
+  case SpaceParity:\r
+    LineControl |= (PL011_UARTLCR_H_PEN | PL011_UARTLCR_H_SPS);\r
+    break;\r
+  default:\r
+    return RETURN_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // Data Bits\r
+  //\r
+  switch (*DataBits) {\r
+  case 0:\r
+    *DataBits = 8;\r
+  case 8:\r
+    LineControl |= PL011_UARTLCR_H_WLEN_8;\r
+    break;\r
+  case 7:\r
+    LineControl |= PL011_UARTLCR_H_WLEN_7;\r
+    break;\r
+  case 6:\r
+    LineControl |= PL011_UARTLCR_H_WLEN_6;\r
+    break;\r
+  case 5:\r
+    LineControl |= PL011_UARTLCR_H_WLEN_5;\r
+    break;\r
+  default:\r
+    return RETURN_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // Stop Bits\r
+  //\r
+  switch (*StopBits) {\r
+  case DefaultStopBits:\r
+    *StopBits = OneStopBit;\r
+  case OneStopBit:\r
+    // Nothing to do. One stop bit is enabled by default.\r
+    break;\r
+  case TwoStopBits:\r
+    LineControl |= PL011_UARTLCR_H_STP2;\r
+    break;\r
+  case OneFiveStopBits:\r
+    // Only 1 or 2 stop bits are supported\r
+  default:\r
+    return RETURN_INVALID_PARAMETER;\r
+  }\r
+\r
+  // Don't send the LineControl value to the PL011 yet,\r
+  // wait until after the Baud Rate setting.\r
+  // This ensures we do not mess up the UART settings halfway through\r
+  // in the rare case when there is an error with the Baud Rate.\r
+\r
+  //\r
+  // Baud Rate\r
+  //\r
+\r
+  // If PL011 Integer value has been defined then always ignore the BAUD rate\r
+  if (FixedPcdGet32 (PL011UartInteger) != 0) {\r
+    Integer = FixedPcdGet32 (PL011UartInteger);\r
+    Fractional = FixedPcdGet32 (PL011UartFractional);\r
+  } else {\r
+    // If BAUD rate is zero then replace it with the system default value\r
+    if (*BaudRate == 0) {\r
+      *BaudRate = FixedPcdGet32 (PcdSerialBaudRate);\r
+      if (*BaudRate == 0) {\r
+        return RETURN_INVALID_PARAMETER;\r
+      }\r
+    }\r
+    if (0 == UartClkInHz) {\r
+      return RETURN_INVALID_PARAMETER;\r
+    }\r
+\r
+    Divisor = (UartClkInHz * 4) / *BaudRate;\r
+    Integer = Divisor >> FRACTION_PART_SIZE_IN_BITS;\r
+    Fractional = Divisor & FRACTION_PART_MASK;\r
+  }\r
+\r
+  //\r
+  // If PL011 is already initialized, check the current settings\r
+  // and re-initialize only if the settings are different.\r
+  //\r
+  if (((MmioRead32 (UartBase + UARTCR) & PL011_UARTCR_UARTEN) != 0) &&\r
+       (MmioRead32 (UartBase + UARTLCR_H) == LineControl) &&\r
+       (MmioRead32 (UartBase + UARTIBRD) == Integer) &&\r
+       (MmioRead32 (UartBase + UARTFBRD) == Fractional)) {\r
+    // Nothing to do - already initialized with correct attributes\r
+    return RETURN_SUCCESS;\r
+  }\r
+\r
+  // Wait for the end of transmission\r
+  while ((MmioRead32 (UartBase + UARTFR) & PL011_UARTFR_TXFE) == 0);\r
+\r
+  // Disable UART: "The UARTLCR_H, UARTIBRD, and UARTFBRD registers must not be changed\r
+  // when the UART is enabled"\r
+  MmioWrite32 (UartBase + UARTCR, 0);\r
+\r
+  // Set Baud Rate Registers\r
+  MmioWrite32 (UartBase + UARTIBRD, Integer);\r
+  MmioWrite32 (UartBase + UARTFBRD, Fractional);\r
+\r
+  // No parity, 1 stop, no fifo, 8 data bits\r
+  MmioWrite32 (UartBase + UARTLCR_H, LineControl);\r
+\r
+  // Clear any pending errors\r
+  MmioWrite32 (UartBase + UARTECR, 0);\r
+\r
+  // Enable Tx, Rx, and UART overall\r
+  MmioWrite32 (UartBase + UARTCR,\r
+               PL011_UARTCR_RXE | PL011_UARTCR_TXE | PL011_UARTCR_UARTEN);\r
+\r
+  return RETURN_SUCCESS;\r
+}\r
+\r
+/**\r
+\r
+  Assert or deassert the control signals on a serial port.\r
+  The following control signals are set according their bit settings :\r
+  . Request to Send\r
+  . Data Terminal Ready\r
+\r
+  @param[in]  UartBase  UART registers base address\r
+  @param[in]  Control   The following bits are taken into account :\r
+                        . EFI_SERIAL_REQUEST_TO_SEND : assert/deassert the\r
+                          "Request To Send" control signal if this bit is\r
+                          equal to one/zero.\r
+                        . EFI_SERIAL_DATA_TERMINAL_READY : assert/deassert\r
+                          the "Data Terminal Ready" control signal if this\r
+                          bit is equal to one/zero.\r
+                        . EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE : enable/disable\r
+                          the hardware loopback if this bit is equal to\r
+                          one/zero.\r
+                        . EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE : not supported.\r
+                        . EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE : enable/\r
+                          disable the hardware flow control based on CTS (Clear\r
+                          To Send) and RTS (Ready To Send) control signals.\r
+\r
+  @retval  RETURN_SUCCESS      The new control bits were set on the device.\r
+  @retval  RETURN_UNSUPPORTED  The device does not support this operation.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+PL011UartSetControl (\r
+    IN UINTN   UartBase,\r
+    IN UINT32  Control\r
+  )\r
+{\r
+  UINT32  Bits;\r
+\r
+  if (Control & (mInvalidControlBits)) {\r
+    return RETURN_UNSUPPORTED;\r
+  }\r
+\r
+  Bits = MmioRead32 (UartBase + UARTCR);\r
+\r
+  if (Control & EFI_SERIAL_REQUEST_TO_SEND) {\r
+    Bits |= PL011_UARTCR_RTS;\r
+  } else {\r
+    Bits &= ~PL011_UARTCR_RTS;\r
+  }\r
+\r
+  if (Control & EFI_SERIAL_DATA_TERMINAL_READY) {\r
+    Bits |= PL011_UARTCR_DTR;\r
+  } else {\r
+    Bits &= ~PL011_UARTCR_DTR;\r
+  }\r
+\r
+  if (Control & EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE) {\r
+    Bits |= PL011_UARTCR_LBE;\r
+  } else {\r
+    Bits &= ~PL011_UARTCR_LBE;\r
+  }\r
+\r
+  if (Control & EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE) {\r
+    Bits |= (PL011_UARTCR_CTSEN | PL011_UARTCR_RTSEN);\r
+  } else {\r
+    Bits &= ~(PL011_UARTCR_CTSEN | PL011_UARTCR_RTSEN);\r
+  }\r
+\r
+  MmioWrite32 (UartBase + UARTCR, Bits);\r
+\r
+  return RETURN_SUCCESS;\r
+}\r
+\r
+/**\r
+\r
+  Retrieve the status of the control bits on a serial device.\r
+\r
+  @param[in]   UartBase  UART registers base address\r
+  @param[out]  Control   Status of the control bits on a serial device :\r
+\r
+                         . EFI_SERIAL_DATA_CLEAR_TO_SEND,\r
+                           EFI_SERIAL_DATA_SET_READY,\r
+                           EFI_SERIAL_RING_INDICATE,\r
+                           EFI_SERIAL_CARRIER_DETECT,\r
+                           EFI_SERIAL_REQUEST_TO_SEND,\r
+                           EFI_SERIAL_DATA_TERMINAL_READY\r
+                           are all related to the DTE (Data Terminal Equipment)\r
+                           and DCE (Data Communication Equipment) modes of\r
+                           operation of the serial device.\r
+                         . EFI_SERIAL_INPUT_BUFFER_EMPTY : equal to one if the\r
+                           receive buffer is empty, 0 otherwise.\r
+                         . EFI_SERIAL_OUTPUT_BUFFER_EMPTY : equal to one if the\r
+                           transmit buffer is empty, 0 otherwise.\r
+                         . EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE : equal to one if\r
+                           the hardware loopback is enabled (the ouput feeds the\r
+                           receive buffer), 0 otherwise.\r
+                         . EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE : equal to one if\r
+                           a loopback is accomplished by software, 0 otherwise.\r
+                         . EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE : equal to\r
+                           one if the hardware flow control based on CTS (Clear\r
+                           To Send) and RTS (Ready To Send) control signals is\r
+                           enabled, 0 otherwise.\r
+\r
+  @retval RETURN_SUCCESS  The control bits were read from the serial device.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+PL011UartGetControl (\r
+    IN UINTN     UartBase,\r
+    OUT UINT32  *Control\r
+  )\r
+{\r
+  UINT32      FlagRegister;\r
+  UINT32      ControlRegister;\r
+\r
+\r
+  FlagRegister = MmioRead32 (UartBase + UARTFR);\r
+  ControlRegister = MmioRead32 (UartBase + UARTCR);\r
+\r
+  *Control = 0;\r
+\r
+  if ((FlagRegister & PL011_UARTFR_CTS) == PL011_UARTFR_CTS) {\r
+    *Control |= EFI_SERIAL_CLEAR_TO_SEND;\r
+  }\r
+\r
+  if ((FlagRegister & PL011_UARTFR_DSR) == PL011_UARTFR_DSR) {\r
+    *Control |= EFI_SERIAL_DATA_SET_READY;\r
+  }\r
+\r
+  if ((FlagRegister & PL011_UARTFR_RI) == PL011_UARTFR_RI) {\r
+    *Control |= EFI_SERIAL_RING_INDICATE;\r
+  }\r
+\r
+  if ((FlagRegister & PL011_UARTFR_DCD) == PL011_UARTFR_DCD) {\r
+    *Control |= EFI_SERIAL_CARRIER_DETECT;\r
+  }\r
+\r
+  if ((ControlRegister & PL011_UARTCR_RTS) == PL011_UARTCR_RTS) {\r
+    *Control |= EFI_SERIAL_REQUEST_TO_SEND;\r
+  }\r
+\r
+  if ((ControlRegister & PL011_UARTCR_DTR) == PL011_UARTCR_DTR) {\r
+    *Control |= EFI_SERIAL_DATA_TERMINAL_READY;\r
+  }\r
+\r
+  if ((FlagRegister & PL011_UARTFR_RXFE) == PL011_UARTFR_RXFE) {\r
+    *Control |= EFI_SERIAL_INPUT_BUFFER_EMPTY;\r
+  }\r
+\r
+  if ((FlagRegister & PL011_UARTFR_TXFE) == PL011_UARTFR_TXFE) {\r
+    *Control |= EFI_SERIAL_OUTPUT_BUFFER_EMPTY;\r
+  }\r
+\r
+  if ((ControlRegister & (PL011_UARTCR_CTSEN | PL011_UARTCR_RTSEN))\r
+       == (PL011_UARTCR_CTSEN | PL011_UARTCR_RTSEN)) {\r
+    *Control |= EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE;\r
+  }\r
+\r
+  if ((ControlRegister & PL011_UARTCR_LBE) == PL011_UARTCR_LBE) {\r
+    *Control |= EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE;\r
+  }\r
+\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 written.\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 written to serial device.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+PL011UartWrite (\r
+  IN  UINTN    UartBase,\r
+  IN UINT8     *Buffer,\r
+  IN UINTN     NumberOfBytes\r
+  )\r
+{\r
+  UINT8* CONST Final = &Buffer[NumberOfBytes];\r
+\r
+  while (Buffer < Final) {\r
+    // Wait until UART able to accept another char\r
+    while ((MmioRead32 (UartBase + UARTFR) & UART_TX_FULL_FLAG_MASK));\r
+\r
+    MmioWrite8 (UartBase + UARTDR, *Buffer++);\r
+  }\r
+\r
+  return NumberOfBytes;\r
+}\r
+\r
+/**\r
+  Read data from serial device and save the data in buffer.\r
+\r
+  @param  Buffer           Point of data buffer which need to be written.\r
+  @param  NumberOfBytes    Number of output bytes which are cached in Buffer.\r
+\r
+  @retval 0                Read data failed.\r
+  @retval !0               Actual number of bytes read from serial device.\r
+\r
+**/\r
+UINTN\r
+EFIAPI\r
+PL011UartRead (\r
+  IN  UINTN     UartBase,\r
+  OUT UINT8     *Buffer,\r
+  IN  UINTN     NumberOfBytes\r
+  )\r
+{\r
+  UINTN   Count;\r
+\r
+  for (Count = 0; Count < NumberOfBytes; Count++, Buffer++) {\r
+    while ((MmioRead32 (UartBase + UARTFR) & UART_RX_EMPTY_FLAG_MASK) != 0);\r
+    *Buffer = MmioRead8 (UartBase + UARTDR);\r
+  }\r
+\r
+  return NumberOfBytes;\r
+}\r
+\r
+/**\r
+  Check to see if any data is available to be read from the debug device.\r
+\r
+  @retval TRUE       At least one byte of data is available to be read\r
+  @retval FALSE      No data is available to be read\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+PL011UartPoll (\r
+  IN  UINTN     UartBase\r
+  )\r
+{\r
+  return ((MmioRead32 (UartBase + UARTFR) & UART_RX_EMPTY_FLAG_MASK) == 0);\r
+}\r
diff --git a/ArmPlatformPkg/Library/PL011UartLib/PL011UartLib.inf b/ArmPlatformPkg/Library/PL011UartLib/PL011UartLib.inf
new file mode 100644 (file)
index 0000000..4fc9744
--- /dev/null
@@ -0,0 +1,43 @@
+#/** @file\r
+#\r
+#  Component description file for PL011Uart module\r
+#\r
+#  Copyright (c) 2011-2016, ARM Ltd. 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
+[Defines]\r
+  INF_VERSION                    = 0x00010005\r
+  BASE_NAME                      = PL011UartLib\r
+  FILE_GUID                      = 6a2c5714-8910-44f0-861f-804abc18ce39\r
+  MODULE_TYPE                    = BASE\r
+  VERSION_STRING                 = 1.0\r
+  LIBRARY_CLASS                  = PL011UartLib\r
+\r
+[Sources.common]\r
+  PL011Uart.h\r
+  PL011UartLib.c\r
+\r
+[LibraryClasses]\r
+  DebugLib\r
+  IoLib\r
+\r
+[Packages]\r
+  MdePkg/MdePkg.dec\r
+  MdeModulePkg/MdeModulePkg.dec\r
+  ArmPlatformPkg/ArmPlatformPkg.dec\r
+\r
+[FixedPcd]\r
+  gEfiMdeModulePkgTokenSpaceGuid.PcdSerialBaudRate\r
+\r
+  gArmPlatformTokenSpaceGuid.PL011UartInteger\r
+  gArmPlatformTokenSpaceGuid.PL011UartFractional\r
+  gArmPlatformTokenSpaceGuid.PL011UartRegOffsetVariant\r