summaryrefslogtreecommitdiffstats
path: root/MdePkg
diff options
context:
space:
mode:
authoreric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524>2008-10-09 10:11:48 +0000
committereric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524>2008-10-09 10:11:48 +0000
commit07974e784acfc9f66f0713ef0bb1e2f004293493 (patch)
tree7d64ca63a4d31768cc537c6f6dc70ff3c4730603 /MdePkg
parentfc4db9b2f580e6c06748e493ed3e1b0186cca8f2 (diff)
downloadedk2-07974e784acfc9f66f0713ef0bb1e2f004293493.tar.gz
edk2-07974e784acfc9f66f0713ef0bb1e2f004293493.tar.bz2
edk2-07974e784acfc9f66f0713ef0bb1e2f004293493.zip
sync SerialPortLib.h with mde library spec0.61d-8.doc on webtop.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6089 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg')
-rw-r--r--MdePkg/Include/Library/SerialPortLib.h12
-rw-r--r--MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c11
2 files changed, 12 insertions, 11 deletions
diff --git a/MdePkg/Include/Library/SerialPortLib.h b/MdePkg/Include/Library/SerialPortLib.h
index d6eb376ff6..19d6094140 100644
--- a/MdePkg/Include/Library/SerialPortLib.h
+++ b/MdePkg/Include/Library/SerialPortLib.h
@@ -85,14 +85,14 @@ SerialPortRead (
);
/**
- Poll the serial device to see if there is any data waiting.
+ Polls a serial device to see if there is any data waiting to be read.
- If there is data waiting to be read from the serial port, then return
- TRUE. If there is no data waiting to be read from the serial port, then
- return FALSE.
+ Polls aserial device to see if there is any data waiting to be read.
+ If there is data waiting to be read from the serial device, then TRUE is returned.
+ If there is no data waiting to be read from the serial device, then FALSE is returned.
- @retval TRUE Data is waiting to be read.
- @retval FALSE There is no data waiting to be read.
+ @retval TRUE Data is waiting to be read from the serial device.
+ @retval FALSE There is no data waiting to be read from the serial device.
**/
BOOLEAN
diff --git a/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c b/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c
index e6b3c63365..ff1d14baba 100644
--- a/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c
+++ b/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c
@@ -90,13 +90,14 @@ SerialPortRead (
}
/**
- Poll the serial device to see if there is any data waiting.
+ Polls a serial device to see if there is any data waiting to be read.
- If there is data waiting to be read from the serial port, then return
- TRUE. If there is no data waiting to be read from the serial port, then
- return FALSE.
+ Polls aserial device to see if there is any data waiting to be read.
+ If there is data waiting to be read from the serial device, then TRUE is returned.
+ If there is no data waiting to be read from the serial device, then FALSE is returned.
- @retval FALSE There is no data waiting to be read.
+ @retval TRUE Data is waiting to be read from the serial device.
+ @retval FALSE There is no data waiting to be read from the serial device.
**/
BOOLEAN