Minor grammatical work--mostly adding periods. Items with ONLY period added did not have the heading date changed, but Items with content changes had heading copyright dates updated. Sending separately a list of files missing Doxygen @param and @return information. (PENDING)

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10615 6f19259b-4bc3-4df7-8a09-765794883524

3 files changed, 133 insertions, 105 deletions

diff --git a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h
index 158b1a0f15..00f8078f76 100644
--- a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h
+++ b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h
@@ -1,7 +1,7 @@
 /** @file

 Internal header file for Smbus library.

 

-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -52,14 +52,16 @@ InternalGetSmbusPpi (
   as defined in the SmBus Specification. The data can either be of

   the Length byte, word, or a block of data.

 

-  @param  SmbusOperation  Signifies which particular SMBus hardware protocol instance that it will use to

-                          execute the SMBus transactions.

+  @param  SmbusOperation  Signifies which particular SMBus hardware protocol 

+                          instance that it will use to execute the SMBus transactions.

   @param  SmBusAddress    The address that encodes the SMBUS Slave Address,

                           SMBUS Command, SMBUS Data Length, and PEC.

-  @param  Length          Signifies the number of bytes that this operation will do. The maximum number of

-                          bytes can be revision specific and operation specific.

-  @param  Buffer          Contains the value of data to execute to the SMBus slave device. Not all operations

-                          require this argument. The length of this buffer is identified by Length.

+  @param  Length          Signifies the number of bytes that this operation will 

+                          do. The maximum number of bytes can be revision specific 

+                          and operation specific.

+  @param  Buffer          Contains the value of data to execute to the SMBus slave 

+                          device. Not all operations require this argument. The 

+                          length of this buffer is identified by Length.

   @param  Status          Return status for the executed command.

                           This is an optional parameter and may be NULL.

 

diff --git a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c
index 330ba45975..5821e9bb6d 100644
--- a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c
+++ b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c
@@ -1,7 +1,7 @@
 /** @file

 Implementation of SmBusLib class library for PEI phase.

 

-Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>

+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>

 This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -46,14 +46,16 @@ InternalGetSmbusPpi (
   as defined in the SmBus Specification. The data can either be of

   the Length byte, word, or a block of data.

 

-  @param  SmbusOperation  Signifies which particular SMBus hardware protocol instance that it will use to

-                          execute the SMBus transactions.

+  @param  SmbusOperation  Signifies which particular SMBus hardware protocol instance 

+                          that it will use to execute the SMBus transactions.

   @param  SmBusAddress    The address that encodes the SMBUS Slave Address,

                           SMBUS Command, SMBUS Data Length, and PEC.

-  @param  Length          Signifies the number of bytes that this operation will do. The maximum number of

-                          bytes can be revision specific and operation specific.

-  @param  Buffer          Contains the value of data to execute to the SMBus slave device. Not all operations

-                          require this argument. The length of this buffer is identified by Length.

+  @param  Length          Signifies the number of bytes that this operation will 

+                          do. The maximum number of bytes can be revision specific 

+                          and operation specific.

+  @param  Buffer          Contains the value of data to execute to the SMBus slave 

+                          device. Not all operations require this argument. The 

+                          length of this buffer is identified by Length.

   @param  Status          Return status for the executed command.

                           This is an optional parameter and may be NULL.

 

diff --git a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c
index 2d070ec544..42e9513f57 100644
--- 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.

   @param  Status        Return status for the executed command.

                         This is an optional parameter and may be NULL.

-                        RETURN_SUCCESS  The SMBUS command was executed.

-                        RETURN_TIMEOUT  A timeout occurred while executing the SMBUS command.

-                        RETURN_DEVICE_ERROR The request was not completed because a failure

-                        reflected in the Host Status Register bit.  Device errors are a result

-                        of a transaction collision, illegal command field, unclaimed cycle

+                        RETURN_SUCCESS:  The SMBUS command was executed.

+                        RETURN_TIMEOUT:  A timeout occurred while executing the 

+                        SMBUS command.

+                        RETURN_DEVICE_ERROR: The request was not completed because 

+                        a failure reflected in the Host Status Register bit.  

+                        Device errors are a result of a transaction collision, 

+                        illegal command field, unclaimed cycle

                         (host initiated), or bus errors (collisions).

-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.

+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.

 

 **/

 VOID

@@ -69,13 +71,15 @@ SmBusQuickRead (
                         SMBUS Command, SMBUS Data Length, and PEC.

   @param  Status        Return status for the executed command.

                         This is an optional parameter and may be NULL.

-                        RETURN_SUCCESS The SMBUS command was executed.

-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.

-                        RETURN_DEVICE_ERROR  The request was not completed because a failure

-                        reflected in the Host Status Register bit.  Device errors are a result

-                        of a transaction collision, illegal command field, unclaimed cycle

-                        (host initiated), or bus errors (collisions).

-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.

+                        RETURN_SUCCESS: The SMBUS command was executed.

+                        RETURN_TIMEOUT: A timeout occurred while executing the 

+                        SMBUS command.

+                        RETURN_DEVICE_ERROR:  The request was not completed because 

+                        a failure reflected in the Host Status Register bit.  Device 

+                        errors are a result of a transaction collision, illegal 

+                        command field, unclaimed cycle (host initiated), or bus 

+                        errors (collisions).

+                        RETURN_UNSUPPORTED::  The SMBus operation is not supported.

 

 **/

 VOID

@@ -108,14 +112,16 @@ SmBusQuickWrite (
                         SMBUS Command, SMBUS Data Length, and PEC.

   @param  Status        Return status for the executed command.

                         This is an optional parameter and may be NULL.

-                        RETURN_SUCCESS The SMBUS command was executed.

-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.

-                        RETURN_DEVICE_ERROR  The request was not completed because a failure

-                        reflected in the Host Status Register bit.  Device errors are a result

-                        of a transaction collision, illegal command field, unclaimed cycle

-                        (host initiated), or bus errors (collisions).

-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)

-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.

+                        RETURN_SUCCESS: The SMBUS command was executed.

+                        RETURN_TIMEOUT: A timeout occurred while executing the 

+                        SMBUS command.

+                        RETURN_DEVICE_ERROR:  The request was not completed because 

+                        a failure reflected in the Host Status Register bit.  

+                        Device errors are a result of a transaction collision, 

+                        illegal command field, unclaimed cycle (host initiated),

+                        or bus errors (collisions).

+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)

+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.

 

   @return The byte received from the SMBUS.

 

@@ -154,14 +160,16 @@ SmBusReceiveByte (
   @param  Value         The 8-bit value to send.

   @param  Status        Return status for the executed command.

                         This is an optional parameter and may be NULL.

-                        RETURN_SUCCESS The SMBUS command was executed.

-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.

-                        RETURN_DEVICE_ERROR  The request was not completed because a failure

-                        reflected in the Host Status Register bit.  Device errors are a result

-                        of a transaction collision, illegal command field, unclaimed cycle

-                        (host initiated), or bus errors (collisions).

-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)

-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.

+                        RETURN_SUCCESS: The SMBUS command was executed.

+                        RETURN_TIMEOUT: A timeout occurred while executing the 

+                        SMBUS command.

+                        RETURN_DEVICE_ERROR:  The request was not completed because 

+                        a failure reflected in the Host Status Register bit.  Device 

+                        errors are a result of a transaction collision, illegal 

+                        command field, unclaimed cycle (host initiated), or bus 

+                        errors (collisions).

+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)

+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.

 

   @return The parameter of Value.

 

@@ -200,14 +208,16 @@ SmBusSendByte (
                           SMBUS Command, SMBUS Data Length, and PEC.

   @param  Status        Return status for the executed command.

                         This is an optional parameter and may be NULL.

-                        RETURN_SUCCESS The SMBUS command was executed.

-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.

-                        RETURN_DEVICE_ERROR  The request was not completed because a failure

-                        reflected in the Host Status Register bit.  Device errors are a result

-                        of a transaction collision, illegal command field, unclaimed cycle

-                        (host initiated), or bus errors (collisions).

-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)

-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.

+                        RETURN_SUCCESS: The SMBUS command was executed.

+                        RETURN_TIMEOUT: A timeout occurred while executing the 

+                        SMBUS command.

+                        RETURN_DEVICE_ERROR:  The request was not completed because 

+                        a failure reflected in the Host Status Register bit.  

+                        Device errors are a result of a transaction collision, 

+                        illegal command field, unclaimed cycle (host initiated),

+                       or bus errors (collisions).

+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)

+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.

 

   @return The byte read from the SMBUS.

 

@@ -245,14 +255,16 @@ SmBusReadDataByte (
   @param  Value         The 8-bit value to write.

   @param  Status        Return status for the executed command.

                         This is an optional parameter and may be NULL.

-                        RETURN_SUCCESS The SMBUS command was executed.

-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.

-                        RETURN_DEVICE_ERROR  The request was not completed because a failure

-                        reflected in the Host Status Register bit.  Device errors are a result

-                        of a transaction collision, illegal command field, unclaimed cycle

-                        (host initiated), or bus errors (collisions).

-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)

-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.

+                        RETURN_SUCCESS: The SMBUS command was executed.

+                        RETURN_TIMEOUT: A timeout occurred while executing the 

+                        SMBUS command.

+                        RETURN_DEVICE_ERROR:  The request was not completed because 

+                        a failure reflected in the Host Status Register bit.  

+                        Device errors are a result of a transaction collision, 

+                        illegal command field, unclaimed cycle (host initiated),

+                        or bus errors (collisions).

+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)

+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.

 

   @return The parameter of Value.

 

@@ -290,14 +302,16 @@ SmBusWriteDataByte (
                         SMBUS Command, SMBUS Data Length, and PEC.

   @param  Status        Return status for the executed command.

                         This is an optional parameter and may be NULL.

-                        RETURN_SUCCESS The SMBUS command was executed.

-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.

-                        RETURN_DEVICE_ERROR  The request was not completed because a failure

-                        reflected in the Host Status Register bit.  Device errors are a result

-                        of a transaction collision, illegal command field, unclaimed cycle

-                        (host initiated), or bus errors (collisions).

-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)

-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.

+                        RETURN_SUCCESS: The SMBUS command was executed.

+                        RETURN_TIMEOUT: A timeout occurred while executing the 

+                        SMBUS command.

+                        RETURN_DEVICE_ERROR:  The request was not completed because 

+                        a failure reflected in the Host Status Register bit.  

+                        Device errors are a result of a transaction collision, 

+                        illegal command field, unclaimed cycle (host initiated),

+                        or bus errors (collisions).

+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)

+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.

 

   @return The byte read from the SMBUS.

 

@@ -335,14 +349,16 @@ SmBusReadDataWord (
   @param  Value         The 16-bit value to write.

   @param  Status        Return status for the executed command.

                         This is an optional parameter and may be NULL.

-                        RETURN_SUCCESS The SMBUS command was executed.

-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.

-                        RETURN_DEVICE_ERROR  The request was not completed because a failure

-                        reflected in the Host Status Register bit.  Device errors are a result

-                        of a transaction collision, illegal command field, unclaimed cycle

-                        (host initiated), or bus errors (collisions).

-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)

-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.

+                        RETURN_SUCCESS: The SMBUS command was executed.

+                        RETURN_TIMEOUT: A timeout occurred while executing the 

+                        SMBUS command.

+                        RETURN_DEVICE_ERROR:  The request was not completed because 

+                        a failure reflected in the Host Status Register bit.  

+                        Device errors are a result of a transaction collision, 

+                        illegal command field, unclaimed cycle (host initiated),

+                        or bus errors (collisions).

+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)

+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.

 

   @return The parameter of Value.

 

@@ -382,14 +398,16 @@ SmBusWriteDataWord (
   @param  Value         The 16-bit value to write.

   @param  Status        Return status for the executed command.

                         This is an optional parameter and may be NULL.

-                        RETURN_SUCCESS The SMBUS command was executed.

-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.

-                        RETURN_DEVICE_ERROR  The request was not completed because a failure

-                        reflected in the Host Status Register bit.  Device errors are a result

-                        of a transaction collision, illegal command field, unclaimed cycle

-                        (host initiated), or bus errors (collisions).

-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)

-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.

+                        RETURN_SUCCESS: The SMBUS command was executed.

+                        RETURN_TIMEOUT: A timeout occurred while executing the 

+                        SMBUS command.

+                        RETURN_DEVICE_ERROR:  The request was not completed because 

+                        a failure reflected in the Host Status Register bit.  

+                        Device errors are a result of a transaction collision, 

+                        illegal command field, unclaimed cycle (host initiated),

+                        or bus errors (collisions).

+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)

+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.

 

   @return The 16-bit value returned by the process call command.

 

@@ -429,14 +447,16 @@ SmBusProcessCall (
   @param  Buffer        The pointer to the buffer to store the bytes read from the SMBUS.

   @param  Status        Return status for the executed command.

                         This is an optional parameter and may be NULL.

-                        RETURN_SUCCESS The SMBUS command was executed.

-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.

-                        RETURN_DEVICE_ERROR  The request was not completed because a failure

-                        reflected in the Host Status Register bit.  Device errors are a result

-                        of a transaction collision, illegal command field, unclaimed cycle

-                        (host initiated), or bus errors (collisions).

-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)

-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.

+                        RETURN_SUCCESS: The SMBUS command was executed.

+                        RETURN_TIMEOUT: A timeout occurred while executing the 

+                        SMBUS command.

+                        RETURN_DEVICE_ERROR:  The request was not completed because 

+                        a failure reflected in the Host Status Register bit.  

+                        Device errors are a result of a transaction collision, 

+                        illegal command field, unclaimed cycle (host initiated), 

+                        or bus errors (collisions).

+                        RETURN_CRC_ERROR:  The checksum is not correct. (PEC is incorrect.)

+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.

 

   @return The number of bytes read.

 

@@ -473,13 +493,15 @@ SmBusReadBlock (
   @param  Buffer        The pointer to the buffer to store the bytes read from the SMBUS.

   @param  Status        Return status for the executed command.

                         This is an optional parameter and may be NULL.

-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.

-                        RETURN_DEVICE_ERROR  The request was not completed because a failure

-                        reflected in the Host Status Register bit.  Device errors are a result

-                        of a transaction collision, illegal command field, unclaimed cycle

-                        (host initiated), or bus errors (collisions).

-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)

-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.

+                        RETURN_TIMEOUT: A timeout occurred while executing the 

+                        SMBUS command.

+                        RETURN_DEVICE_ERROR:  The request was not completed because 

+                        a failure reflected in the Host Status Register bit.  

+                        Device errors are a result of a transaction collision, 

+                        illegal command field, unclaimed cycle (host initiated), 

+                        or bus errors (collisions).

+                        RETURN_CRC_ERROR:  The checksum is not correct (PEC is incorrect)

+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.

 

   @return The number of bytes written.

 

@@ -523,13 +545,15 @@ SmBusWriteBlock (
   @param  ReadBuffer    The pointer to the buffer of bytes to read from the SMBUS.

   @param  Status        Return status for the executed command.

                         This is an optional parameter and may be NULL.

-                        RETURN_TIMEOUT A timeout occurred while executing the SMBUS command.

-                        RETURN_DEVICE_ERROR  The request was not completed because a failure

-                        reflected in the Host Status Register bit.  Device errors are a result

-                        of a transaction collision, illegal command field, unclaimed cycle

-                        (host initiated), or bus errors (collisions).

-                        RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect)

-                        RETURN_UNSUPPORTED  The SMBus operation is not supported.

+                        RETURN_TIMEOUT: A timeout occurred while executing the 

+                        SMBUS command.

+                        RETURN_DEVICE_ERROR:  The request was not completed because 

+                        a failure reflected in the Host Status Register bit.  

+                        Device errors are a result of a transaction collision, 

+                        illegal command field, unclaimed cycle (host initiated), 

+                        or bus errors (collisions).

+                        RETURN_CRC_ERROR  The checksum is not correct. (PEC is incorrect.)

+                        RETURN_UNSUPPORTED:  The SMBus operation is not supported.

 

   @return The number of bytes written.