diff options
| author | eric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-10-07 09:01:12 +0000 |
|---|---|---|
| committer | eric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-10-07 09:01:12 +0000 |
| commit | d69107aadc8f3d9fd186544b17e02603e3fd5627 (patch) | |
| tree | 625704b1ce87765fde044c05b1ed4898cb68c22b /MdePkg/Library | |
| parent | 1b88ce8644ee13fadd46746a85f9f6cdfb50831e (diff) | |
| download | edk2-d69107aadc8f3d9fd186544b17e02603e3fd5627.tar.gz edk2-d69107aadc8f3d9fd186544b17e02603e3fd5627.tar.bz2 edk2-d69107aadc8f3d9fd186544b17e02603e3fd5627.zip | |
sync the comments of serialportlib library class with Mde Library Spec.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6080 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Library')
| -rw-r--r-- | MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c | 40 |
1 files changed, 28 insertions, 12 deletions
diff --git a/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c b/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c index 79b4e925ed..e6b3c63365 100644 --- a/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c +++ b/MdePkg/Library/SerialPortLibNull/SerialPortLibNull.c @@ -19,9 +19,14 @@ #include <Library/SerialPortLib.h>
/**
- Programmed hardware of Serial port.
-
- @return Always return RETURN_UNSUPPORTED.
+ Initialize the serial device hardware.
+
+ If no initialization is required, then return RETURN_SUCCESS.
+ If the serial device was successfuly initialized, then return RETURN_SUCCESS.
+ If the serial device could not be initialized, then return RETURN_DEVICE_ERROR.
+
+ @retval RETURN_SUCCESS The serial device was initialized.
+ @retval RETURN_DEVICE_ERROR The serail device could not be initialized.
**/
RETURN_STATUS
@@ -34,12 +39,22 @@ SerialPortInitialize ( }
/**
- Write data to serial device.
+ Write data from buffer to serial device.
+
+ Writes NumberOfBytes data bytes from Buffer to the serial device.
+ The number of bytes actually written to the serial device is returned.
+ If the return value is less than NumberOfBytes, then the write operation failed.
+
+ If Buffer is NULL, then ASSERT().
+
+ If NumberOfBytes is zero, then return 0.
- @param Buffer Point of data buffer which need to be writed.
- @param NumberOfBytes Number of output bytes which are cached in Buffer.
+ @param Buffer Pointer to the data buffer to be written.
+ @param NumberOfBytes Number of bytes to written to the serial device.
- @retval 0 No data is to be written.
+ @retval 0 NumberOfBytes is 0.
+ @retval >0 The number of bytes written to the serial device.
+ If this value is less than NumberOfBytes, then the read operation failed.
**/
UINTN
@@ -54,13 +69,14 @@ SerialPortWrite ( /**
- Read data from serial device and save the datas in buffer.
+ Reads data from a serial device into a buffer.
- @param Buffer Point of data buffer, which contains the data
- returned from the serial device.
- @param NumberOfBytes Number of bytes which will be read.
+ @param Buffer Pointer to the data buffer to store the data read from the serial device.
+ @param NumberOfBytes Number of bytes to read from the serial device.
- @retval 0 No data is to be read.
+ @retval 0 NumberOfBytes is 0.
+ @retval >0 The number of bytes read from the serial device.
+ If this value is less than NumberOfBytes, then the read operation failed.
**/
UINTN
|