]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/SerialPortLib.h
Fix IN OUT specifiers
[mirror_edk2.git] / MdePkg / Include / Library / SerialPortLib.h
index 1ab8e97adc5c30add67e21e03d56fefdfd20cceb..30b8aa9ccf5e5b2f44d83159a9e8ee69fcd64965 100644 (file)
@@ -1,5 +1,5 @@
 /** @file\r
-  Provides three common serial I/O port functions.\r
+  This library class provides common serial I/O port functions.\r
 \r
 Copyright (c) 2006 - 2008, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
@@ -38,9 +38,7 @@ SerialPortInitialize (
   Writes NumberOfBytes data bytes from Buffer to the serial device.  \r
   The number of bytes actually written to the serial device is returned.\r
   If the return value is less than NumberOfBytes, then the write operation failed.\r
-\r
   If Buffer is NULL, then ASSERT(). \r
-\r
   If NumberOfBytes is zero, then return 0.\r
 \r
   @param  Buffer           Pointer to the data buffer to be written.\r
@@ -54,8 +52,8 @@ SerialPortInitialize (
 UINTN\r
 EFIAPI\r
 SerialPortWrite (\r
-  IN UINT8        *Buffer,\r
-  IN UINTN        NumberOfBytes\r
+  IN UINT8     *Buffer,\r
+  IN UINTN     NumberOfBytes\r
   );\r
 \r
 \r
@@ -65,23 +63,21 @@ SerialPortWrite (
   Reads NumberOfBytes data bytes from a serial device into the buffer\r
   specified by Buffer. The number of bytes actually read is returned. \r
   If the return value is less than NumberOfBytes, then the rest operation failed.\r
-\r
   If Buffer is NULL, then ASSERT(). \r
-\r
   If NumberOfBytes is zero, then return 0.\r
 \r
   @param  Buffer           Pointer to the data buffer to store the data read from the serial device.\r
   @param  NumberOfBytes    Number of bytes which will be read.\r
 \r
   @retval 0                Read data failed, No data is to be read.\r
-  @retval !0               Aactual number of bytes read from serial device.\r
+  @retval >0               Aactual number of bytes read from serial device.\r
 \r
 **/\r
 UINTN\r
 EFIAPI\r
 SerialPortRead (\r
-  OUT UINT8    *Buffer,\r
-  IN  UINTN    NumberOfBytes\r
+  OUT UINT8   *Buffer,\r
+  IN  UINTN   NumberOfBytes\r
   );\r
 \r
 /**\r