summaryrefslogtreecommitdiffstats
path: root/MdeModulePkg
diff options
context:
space:
mode:
authorGao, Liming <liming.gao@intel.com>2014-08-13 08:39:54 +0000
committerlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>2014-08-13 08:39:54 +0000
commit74a6d86079793bbd53e4d4fd67e6c3d1477f59fa (patch)
treed470bc40ef4311e0da60b46ef36b8cfb656a9ccd /MdeModulePkg
parentea5396f31a8db7344177b4dd5335ebd617861d58 (diff)
downloadedk2-74a6d86079793bbd53e4d4fd67e6c3d1477f59fa.tar.gz
edk2-74a6d86079793bbd53e4d4fd67e6c3d1477f59fa.tar.bz2
edk2-74a6d86079793bbd53e4d4fd67e6c3d1477f59fa.zip
Add the missing parameter comments for BaseSerialPortLib16550 lib. MdePkg: Fix Clang build failure
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
Diffstat (limited to 'MdeModulePkg')
-rw-r--r--MdeModulePkg/Include/Ppi/SerialPortPei.h4
-rw-r--r--MdeModulePkg/Library/BaseSerialPortLib16550/BaseSerialPortLib16550.c6
2 files changed, 7 insertions, 3 deletions
diff --git a/MdeModulePkg/Include/Ppi/SerialPortPei.h b/MdeModulePkg/Include/Ppi/SerialPortPei.h
index 88fcbf6e80..2b754f9cca 100644
--- a/MdeModulePkg/Include/Ppi/SerialPortPei.h
+++ b/MdeModulePkg/Include/Ppi/SerialPortPei.h
@@ -13,8 +13,8 @@
**/
-#ifndef _PEI_SERIAL_PORT_PPI_H
-#define _PEI_SERIAL_PORT_PPI_H
+#ifndef __PEI_SERIAL_PORT_PPI_H__
+#define __PEI_SERIAL_PORT_PPI_H__
#define PEI_SERIAL_PORT_PPI \
{ \
diff --git a/MdeModulePkg/Library/BaseSerialPortLib16550/BaseSerialPortLib16550.c b/MdeModulePkg/Library/BaseSerialPortLib16550/BaseSerialPortLib16550.c
index 190740c0bb..d21c00c5a4 100644
--- 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
by PcdSerialRegisterBase.
+ @param Base The base address register of UART device.
@param Offset The offset of the 16550 register to read.
@return The value read from the 16550 register.
@@ -87,6 +88,7 @@ SerialPortReadRegister (
parameter Offset is added to the base address of the 16550 registers that is specified
by PcdSerialRegisterBase.
+ @param Base The base address register of UART device.
@param Offset The offset of the 16550 register to write.
@param Value The value to write to the 16550 register specified by Offset.
@@ -173,7 +175,7 @@ SerialPortLibUpdatePciRegister32 (
This function assumes Root Bus Numer is Zero, and enables I/O and MMIO in PCI UART
Device if they are not already enabled.
- @return The base address register of the PCI UART device.
+ @return The base address register of the UART device.
**/
UINTN
@@ -411,6 +413,8 @@ GetSerialRegisterBase (
/**
Return whether the hardware flow control signal allows writing.
+ @param SerialRegisterBase The base address register of UART device.
+
@retval TRUE The serial port is writable.
@retval FALSE The serial port is not writable.
**/