Minor grammatical work--mostly adding periods. Items with ONLY period added did...

[mirror_edk2.git] / MdePkg / Library / PeiSmbusLibSmbus2Ppi / SmbusLib.c

diff --git a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c
index 2d070ec5447356e3f6fba50ac8c685915b00076e..42e9513f5788c9c2469069b60b1e2509f75e4183 100644 (file)
--- a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c
+++ b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c
@@ -30,13 +30,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
-                        RETURN_SUCCESS  The SMBUS command was executed.\r
-                        RETURN_TIMEOUT  A timeout occurred while executing the SMBUS command.\r
-                        RETURN_DEVICE_ERROR The request was not completed because a failure\r
-                        reflected in the Host Status Register bit.  Device errors are a result\r
-                        of a transaction collision, illegal command field, unclaimed cycle\r
+                        RETURN_SUCCESS:  The SMBUS command was executed.\r
+                        RETURN_TIMEOUT:  A timeout occurred while executing the \r
+                        SMBUS command.\r
+                        RETURN_DEVICE_ERROR: The request was not completed because \r
+                        a failure reflected in the Host Status Register bit.  \r
+                        Device errors are a result of a transaction collision, \r
+                        illegal command field, unclaimed cycle\r
                         (host initiated), or bus errors (collisions).\r
-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.\r
+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.\r
 \r
 **/\r
 VOID\r
@@ -69,13 +71,15 @@ SmBusQuickRead (
                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
-                        RETURN_SUCCESS The SMBUS command was executed.\r
-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r
-                        RETURN_DEVICE_ERROR  The request was not completed because a failure\r
-                        reflected in the Host Status Register bit.  Device errors are a result\r
-                        of a transaction collision, illegal command field, unclaimed cycle\r
-                        (host initiated), or bus errors (collisions).\r
-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.\r
+                        RETURN_SUCCESS: The SMBUS command was executed.\r
+                        RETURN_TIMEOUT: A timeout occurred while executing the \r
+                        SMBUS command.\r
+                        RETURN_DEVICE_ERROR:  The request was not completed because \r
+                        a failure reflected in the Host Status Register bit.  Device \r
+                        errors are a result of a transaction collision, illegal \r
+                        command field, unclaimed cycle (host initiated), or bus \r
+                        errors (collisions).\r
+                        RETURN_UNSUPPORTED::  The SMBus operation is not supported.\r
 \r
 **/\r
 VOID\r
@@ -108,14 +112,16 @@ SmBusQuickWrite (
                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
-                        RETURN_SUCCESS The SMBUS command was executed.\r
-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r
-                        RETURN_DEVICE_ERROR  The request was not completed because a failure\r
-                        reflected in the Host Status Register bit.  Device errors are a result\r
-                        of a transaction collision, illegal command field, unclaimed cycle\r
-                        (host initiated), or bus errors (collisions).\r
-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)\r
-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.\r
+                        RETURN_SUCCESS: The SMBUS command was executed.\r
+                        RETURN_TIMEOUT: A timeout occurred while executing the \r
+                        SMBUS command.\r
+                        RETURN_DEVICE_ERROR:  The request was not completed because \r
+                        a failure reflected in the Host Status Register bit.  \r
+                        Device errors are a result of a transaction collision, \r
+                        illegal command field, unclaimed cycle (host initiated),\r
+                        or bus errors (collisions).\r
+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)\r
+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.\r
 \r
   @return The byte received from the SMBUS.\r
 \r
@@ -154,14 +160,16 @@ SmBusReceiveByte (
   @param  Value         The 8-bit value to send.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
-                        RETURN_SUCCESS The SMBUS command was executed.\r
-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r
-                        RETURN_DEVICE_ERROR  The request was not completed because a failure\r
-                        reflected in the Host Status Register bit.  Device errors are a result\r
-                        of a transaction collision, illegal command field, unclaimed cycle\r
-                        (host initiated), or bus errors (collisions).\r
-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)\r
-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.\r
+                        RETURN_SUCCESS: The SMBUS command was executed.\r
+                        RETURN_TIMEOUT: A timeout occurred while executing the \r
+                        SMBUS command.\r
+                        RETURN_DEVICE_ERROR:  The request was not completed because \r
+                        a failure reflected in the Host Status Register bit.  Device \r
+                        errors are a result of a transaction collision, illegal \r
+                        command field, unclaimed cycle (host initiated), or bus \r
+                        errors (collisions).\r
+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)\r
+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.\r
 \r
   @return The parameter of Value.\r
 \r
@@ -200,14 +208,16 @@ SmBusSendByte (
                           SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
-                        RETURN_SUCCESS The SMBUS command was executed.\r
-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r
-                        RETURN_DEVICE_ERROR  The request was not completed because a failure\r
-                        reflected in the Host Status Register bit.  Device errors are a result\r
-                        of a transaction collision, illegal command field, unclaimed cycle\r
-                        (host initiated), or bus errors (collisions).\r
-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)\r
-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.\r
+                        RETURN_SUCCESS: The SMBUS command was executed.\r
+                        RETURN_TIMEOUT: A timeout occurred while executing the \r
+                        SMBUS command.\r
+                        RETURN_DEVICE_ERROR:  The request was not completed because \r
+                        a failure reflected in the Host Status Register bit.  \r
+                        Device errors are a result of a transaction collision, \r
+                        illegal command field, unclaimed cycle (host initiated),\r
+                       or bus errors (collisions).\r
+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)\r
+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.\r
 \r
   @return The byte read from the SMBUS.\r
 \r
@@ -245,14 +255,16 @@ SmBusReadDataByte (
   @param  Value         The 8-bit value to write.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
-                        RETURN_SUCCESS The SMBUS command was executed.\r
-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r
-                        RETURN_DEVICE_ERROR  The request was not completed because a failure\r
-                        reflected in the Host Status Register bit.  Device errors are a result\r
-                        of a transaction collision, illegal command field, unclaimed cycle\r
-                        (host initiated), or bus errors (collisions).\r
-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)\r
-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.\r
+                        RETURN_SUCCESS: The SMBUS command was executed.\r
+                        RETURN_TIMEOUT: A timeout occurred while executing the \r
+                        SMBUS command.\r
+                        RETURN_DEVICE_ERROR:  The request was not completed because \r
+                        a failure reflected in the Host Status Register bit.  \r
+                        Device errors are a result of a transaction collision, \r
+                        illegal command field, unclaimed cycle (host initiated),\r
+                        or bus errors (collisions).\r
+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)\r
+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.\r
 \r
   @return The parameter of Value.\r
 \r
@@ -290,14 +302,16 @@ SmBusWriteDataByte (
                         SMBUS Command, SMBUS Data Length, and PEC.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
-                        RETURN_SUCCESS The SMBUS command was executed.\r
-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r
-                        RETURN_DEVICE_ERROR  The request was not completed because a failure\r
-                        reflected in the Host Status Register bit.  Device errors are a result\r
-                        of a transaction collision, illegal command field, unclaimed cycle\r
-                        (host initiated), or bus errors (collisions).\r
-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)\r
-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.\r
+                        RETURN_SUCCESS: The SMBUS command was executed.\r
+                        RETURN_TIMEOUT: A timeout occurred while executing the \r
+                        SMBUS command.\r
+                        RETURN_DEVICE_ERROR:  The request was not completed because \r
+                        a failure reflected in the Host Status Register bit.  \r
+                        Device errors are a result of a transaction collision, \r
+                        illegal command field, unclaimed cycle (host initiated),\r
+                        or bus errors (collisions).\r
+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)\r
+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.\r
 \r
   @return The byte read from the SMBUS.\r
 \r
@@ -335,14 +349,16 @@ SmBusReadDataWord (
   @param  Value         The 16-bit value to write.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
-                        RETURN_SUCCESS The SMBUS command was executed.\r
-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r
-                        RETURN_DEVICE_ERROR  The request was not completed because a failure\r
-                        reflected in the Host Status Register bit.  Device errors are a result\r
-                        of a transaction collision, illegal command field, unclaimed cycle\r
-                        (host initiated), or bus errors (collisions).\r
-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)\r
-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.\r
+                        RETURN_SUCCESS: The SMBUS command was executed.\r
+                        RETURN_TIMEOUT: A timeout occurred while executing the \r
+                        SMBUS command.\r
+                        RETURN_DEVICE_ERROR:  The request was not completed because \r
+                        a failure reflected in the Host Status Register bit.  \r
+                        Device errors are a result of a transaction collision, \r
+                        illegal command field, unclaimed cycle (host initiated),\r
+                        or bus errors (collisions).\r
+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)\r
+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.\r
 \r
   @return The parameter of Value.\r
 \r
@@ -382,14 +398,16 @@ SmBusWriteDataWord (
   @param  Value         The 16-bit value to write.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
-                        RETURN_SUCCESS The SMBUS command was executed.\r
-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r
-                        RETURN_DEVICE_ERROR  The request was not completed because a failure\r
-                        reflected in the Host Status Register bit.  Device errors are a result\r
-                        of a transaction collision, illegal command field, unclaimed cycle\r
-                        (host initiated), or bus errors (collisions).\r
-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)\r
-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.\r
+                        RETURN_SUCCESS: The SMBUS command was executed.\r
+                        RETURN_TIMEOUT: A timeout occurred while executing the \r
+                        SMBUS command.\r
+                        RETURN_DEVICE_ERROR:  The request was not completed because \r
+                        a failure reflected in the Host Status Register bit.  \r
+                        Device errors are a result of a transaction collision, \r
+                        illegal command field, unclaimed cycle (host initiated),\r
+                        or bus errors (collisions).\r
+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)\r
+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.\r
 \r
   @return The 16-bit value returned by the process call command.\r
 \r
@@ -429,14 +447,16 @@ SmBusProcessCall (
   @param  Buffer        The pointer to the buffer to store the bytes read from the SMBUS.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
-                        RETURN_SUCCESS The SMBUS command was executed.\r
-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r
-                        RETURN_DEVICE_ERROR  The request was not completed because a failure\r
-                        reflected in the Host Status Register bit.  Device errors are a result\r
-                        of a transaction collision, illegal command field, unclaimed cycle\r
-                        (host initiated), or bus errors (collisions).\r
-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)\r
-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.\r
+                        RETURN_SUCCESS: The SMBUS command was executed.\r
+                        RETURN_TIMEOUT: A timeout occurred while executing the \r
+                        SMBUS command.\r
+                        RETURN_DEVICE_ERROR:  The request was not completed because \r
+                        a failure reflected in the Host Status Register bit.  \r
+                        Device errors are a result of a transaction collision, \r
+                        illegal command field, unclaimed cycle (host initiated), \r
+                        or bus errors (collisions).\r
+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)\r
+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.\r
 \r
   @return The number of bytes read.\r
 \r
@@ -473,13 +493,15 @@ SmBusReadBlock (
   @param  Buffer        The pointer to the buffer to store the bytes read from the SMBUS.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r
-                        RETURN_DEVICE_ERROR  The request was not completed because a failure\r
-                        reflected in the Host Status Register bit.  Device errors are a result\r
-                        of a transaction collision, illegal command field, unclaimed cycle\r
-                        (host initiated), or bus errors (collisions).\r
-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)\r
-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.\r
+                        RETURN_TIMEOUT: A timeout occurred while executing the \r
+                        SMBUS command.\r
+                        RETURN_DEVICE_ERROR:  The request was not completed because \r
+                        a failure reflected in the Host Status Register bit.  \r
+                        Device errors are a result of a transaction collision, \r
+                        illegal command field, unclaimed cycle (host initiated), \r
+                        or bus errors (collisions).\r
+                        RETURN_CRC_ERROR:  The checksum is not correct (PEC is incorrect)\r
+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.\r
 \r
   @return The number of bytes written.\r
 \r
@@ -523,13 +545,15 @@ SmBusWriteBlock (
   @param  ReadBuffer    The pointer to the buffer of bytes to read from the SMBUS.\r
   @param  Status        Return status for the executed command.\r
                         This is an optional parameter and may be NULL.\r
-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.\r
-                        RETURN_DEVICE_ERROR  The request was not completed because a failure\r
-                        reflected in the Host Status Register bit.  Device errors are a result\r
-                        of a transaction collision, illegal command field, unclaimed cycle\r
-                        (host initiated), or bus errors (collisions).\r
-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)\r
-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.\r
+                        RETURN_TIMEOUT: A timeout occurred while executing the \r
+                        SMBUS command.\r
+                        RETURN_DEVICE_ERROR:  The request was not completed because \r
+                        a failure reflected in the Host Status Register bit.  \r
+                        Device errors are a result of a transaction collision, \r
+                        illegal command field, unclaimed cycle (host initiated), \r
+                        or bus errors (collisions).\r
+                        RETURN_CRC_ERROR  The checksum is not correct. (PEC is incorrect.)\r
+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.\r
 \r
   @return The number of bytes written.\r
 \r