ArmPlatformPkg: Add support to configure PL011 UART clock

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

diff --git a/ArmPlatformPkg/Include/Drivers/PL011Uart.h b/ArmPlatformPkg/Include/Drivers/PL011Uart.h
index a4a6b4c0c0349eddaab2afab838bcd43b091aa16..36ea9d62696162460567d91f9c1ba245d830db71 100644 (file)
--- a/ArmPlatformPkg/Include/Drivers/PL011Uart.h
+++ b/ArmPlatformPkg/Include/Drivers/PL011Uart.h
@@ -89,26 +89,28 @@
 #define PL011_UARTPID2_VER(X)     (((X) >> 4) & 0xF)\r
 #define PL011_VER_R1P4            0x2\r
 \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  UartBase                The base address of the serial device.\r
-  @param  BaudRate                The baud rate of the serial device. If the\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  ReceiveFifoDepth        The number of characters the device will\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  Parity                  If applicable, this is the EFI_PARITY_TYPE\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  DataBits                The number of data bits in each character.\r
-  @param  StopBits                If applicable, the EFI_STOP_BITS_TYPE number\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
@@ -123,6 +125,7 @@ RETURN_STATUS
 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