sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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)

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10615 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
myronporter
2010-06-30 00:13:25 +00:00
parent 3b33c6d65d
commit 58380e9c61
62 changed files with 1190 additions and 979 deletions
Download Patch File Download Diff File Expand all files Collapse all files

206
MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c
View File

@@ -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.