ArmPlatformPkg: Tidy PL011 UART driver

[mirror_edk2.git] / ArmPlatformPkg / Include / Drivers / PL011Uart.h

diff --git a/ArmPlatformPkg/Include/Drivers/PL011Uart.h b/ArmPlatformPkg/Include/Drivers/PL011Uart.h
index 2fe796f9e42e663ae838a9559c16e237bf3db28b..a4a6b4c0c0349eddaab2afab838bcd43b091aa16 100644 (file)
--- a/ArmPlatformPkg/Include/Drivers/PL011Uart.h
+++ b/ArmPlatformPkg/Include/Drivers/PL011Uart.h
@@ -1,6 +1,6 @@
 /** @file\r
 *\r
-*  Copyright (c) 2011-2014, ARM Limited. All rights reserved.\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
@@ -91,15 +91,38 @@
 \r
 /*\r
 \r
-  Programmed hardware of Serial port.\r
-\r
-  @return    Always return EFI_UNSUPPORTED.\r
+  Initialise the serial port to the specified 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  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 OUT UINTN               UartBase,\r
+  IN     UINTN               UartBase,\r
   IN OUT UINT64              *BaudRate,\r
   IN OUT UINT32              *ReceiveFifoDepth,\r
   IN OUT EFI_PARITY_TYPE     *Parity,\r
@@ -130,8 +153,8 @@ PL011UartInitializePort (
                           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 serial device.\r
-  @retval  RETURN_UNSUPPORTED  The serial device does not support this operation.\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
@@ -148,25 +171,28 @@ PL011UartSetControl (
   @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, EFI_SERIAL_DATA_SET_READY,\r
-                           EFI_SERIAL_RING_INDICATE, EFI_SERIAL_CARRIER_DETECT,\r
-                           EFI_SERIAL_REQUEST_TO_SEND, EFI_SERIAL_DATA_TERMINAL_READY\r
-                           are all related to the DTE (Data Terminal Equipment) and\r
-                           DCE (Data Communication Equipment) modes of operation of\r
-                           the serial device.\r
-                         . EFI_SERIAL_INPUT_BUFFER_EMPTY : equal to one if the receive\r
-                           buffer is empty, 0 otherwise.\r
-                         . EFI_SERIAL_OUTPUT_BUFFER_EMPTY : equal to one if the transmit\r
-                           buffer is empty, 0 otherwise.\r
-                         . EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE : equal to one if the\r
-                           hardware loopback is enabled (the ouput feeds the receive\r
-                           buffer), 0 otherwise.\r
-                         . EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE : equal to one if a\r
-                           loopback is accomplished by software, 0 otherwise.\r
-                         . EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE : equal to one if the\r
-                           hardware flow control based on CTS (Clear To Send) and RTS\r
-                           (Ready To Send) control signals is enabled, 0 otherwise.\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