Add the missing parameter comments for BaseSerialPortLib16550 lib. MdePkg: Fix Clang...

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Gao, Liming <liming.gao@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15796 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdeModulePkg/Include/Ppi/SerialPortPei.h b/MdeModulePkg/Include/Ppi/SerialPortPei.h
index 88fcbf6e80c540b8fa06b13f85f36e673e22b245..2b754f9ccaedce5b46bbd4a2c3e6c025a281063b 100644 (file)
--- a/MdeModulePkg/Include/Ppi/SerialPortPei.h
+++ b/MdeModulePkg/Include/Ppi/SerialPortPei.h
@@ -13,8 +13,8 @@
 \r
 **/\r
 \r
 \r
 **/\r
 \r

-#ifndef _PEI_SERIAL_PORT_PPI_H\r
-#define _PEI_SERIAL_PORT_PPI_H\r
+#ifndef __PEI_SERIAL_PORT_PPI_H__\r
+#define __PEI_SERIAL_PORT_PPI_H__\r

 \r
 #define PEI_SERIAL_PORT_PPI \\r
   { \\r
 \r
 #define PEI_SERIAL_PORT_PPI \\r
   { \\r

diff --git a/MdeModulePkg/Library/BaseSerialPortLib16550/BaseSerialPortLib16550.c b/MdeModulePkg/Library/BaseSerialPortLib16550/BaseSerialPortLib16550.c
index 190740c0bb7363652525d8db1e05aac1e2e5d187..d21c00c5a4ae4fd0251cf9ee585e45abb50286ea 100644 (file)
--- a/MdeModulePkg/Library/BaseSerialPortLib16550/BaseSerialPortLib16550.c
+++ b/MdeModulePkg/Library/BaseSerialPortLib16550/BaseSerialPortLib16550.c
@@ -63,6 +63,7 @@ typedef struct {
   parameter Offset is added to the base address of the 16550 registers that is specified \r
   by PcdSerialRegisterBase. \r
   \r
   parameter Offset is added to the base address of the 16550 registers that is specified \r
   by PcdSerialRegisterBase. \r
   \r

+  @param  Base    The base address register of UART device.\r

   @param  Offset  The offset of the 16550 register to read.\r
 \r
   @return The value read from the 16550 register.\r
   @param  Offset  The offset of the 16550 register to read.\r
 \r
   @return The value read from the 16550 register.\r


@@ -87,6 +88,7 @@ SerialPortReadRegister (
   parameter Offset is added to the base address of the 16550 registers that is specified \r
   by PcdSerialRegisterBase. \r
   \r
   parameter Offset is added to the base address of the 16550 registers that is specified \r
   by PcdSerialRegisterBase. \r
   \r

+  @param  Base    The base address register of UART device.\r

   @param  Offset  The offset of the 16550 register to write.\r
   @param  Value   The value to write to the 16550 register specified by Offset.\r
 \r
   @param  Offset  The offset of the 16550 register to write.\r
   @param  Value   The value to write to the 16550 register specified by Offset.\r
 \r


@@ -173,7 +175,7 @@ SerialPortLibUpdatePciRegister32 (
   This function assumes Root Bus Numer is Zero, and enables I/O and MMIO in PCI UART \r
   Device if they are not already enabled. \r
   \r
   This function assumes Root Bus Numer is Zero, and enables I/O and MMIO in PCI UART \r
   Device if they are not already enabled. \r
   \r

-  @return  The base address register of the PCI UART device.\r
+  @return  The base address register of the UART device.\r

 \r
 **/\r
 UINTN\r
 \r
 **/\r
 UINTN\r


@@ -411,6 +413,8 @@ GetSerialRegisterBase (
 /**\r
   Return whether the hardware flow control signal allows writing.\r
 \r
 /**\r
   Return whether the hardware flow control signal allows writing.\r
 \r

+  @param  SerialRegisterBase The base address register of UART device.\r
+\r

   @retval TRUE  The serial port is writable.\r
   @retval FALSE The serial port is not writable.\r
 **/\r
   @retval TRUE  The serial port is writable.\r
   @retval FALSE The serial port is not writable.\r
 **/\r