MdePkg: Clean up source files
1. Do not use tab characters 2. No trailing white space in one line 3. All files must end with CRLF Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
/** @file
|
||||
Implementation of SmBusLib class library for DXE phase.
|
||||
|
||||
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
|
||||
Copyright (c) 2006 - 2018, 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
|
||||
@@ -31,13 +31,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||
@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_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.
|
||||
|
||||
**/
|
||||
@@ -72,12 +72,12 @@ SmBusQuickRead (
|
||||
@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
|
||||
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),
|
||||
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.
|
||||
|
||||
@@ -113,12 +113,12 @@ SmBusQuickWrite (
|
||||
@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
|
||||
RETURN_TIMEOUT: A timeout occurred while executing the
|
||||
SMBUS command.
|
||||
RETURN_DEVICE_ERROR: The request was not completed because
|
||||
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 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.
|
||||
@@ -161,12 +161,12 @@ SmBusReceiveByte (
|
||||
@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
|
||||
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
|
||||
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.
|
||||
@@ -209,12 +209,12 @@ SmBusSendByte (
|
||||
@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
|
||||
RETURN_TIMEOUT: A timeout occurred while executing the
|
||||
SMBUS command.
|
||||
RETURN_DEVICE_ERROR: The request was not completed because
|
||||
a failurereflected in the Host Status Register bit. Device
|
||||
errors are a result of a transaction collision, illegal
|
||||
command field, unclaimed cycle (host initiated), or bus
|
||||
RETURN_DEVICE_ERROR: The request was not completed because
|
||||
a failurereflected 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.
|
||||
@@ -256,12 +256,12 @@ SmBusReadDataByte (
|
||||
@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
|
||||
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
|
||||
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.
|
||||
@@ -297,20 +297,20 @@ SmBusWriteDataByte (
|
||||
If Status is not NULL, then the status of the executed command is returned in Status.
|
||||
If Length in SmBusAddress is not zero, then ASSERT().
|
||||
If any reserved bits of SmBusAddress are set, then ASSERT().
|
||||
|
||||
|
||||
@param SmBusAddress The address that encodes the SMBUS Slave Address,
|
||||
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
|
||||
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),
|
||||
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
|
||||
RETURN_CRC_ERROR: The checksum is not correct. (PEC is
|
||||
incorrect.)
|
||||
RETURN_UNSUPPORTED: The SMBus operation is not supported.
|
||||
|
||||
@@ -351,14 +351,14 @@ SmBusReadDataWord (
|
||||
@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
|
||||
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),
|
||||
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.
|
||||
RETURN_CRC_ERROR: The checksum is not correct.
|
||||
(PEC is incorrect.)
|
||||
RETURN_UNSUPPORTED: The SMBus operation is not supported.
|
||||
|
||||
@@ -401,14 +401,14 @@ SmBusWriteDataWord (
|
||||
@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
|
||||
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),
|
||||
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
|
||||
RETURN_CRC_ERROR: The checksum is not correct. (PEC is
|
||||
incorrect.)
|
||||
RETURN_UNSUPPORTED: The SMBus operation is not supported.
|
||||
|
||||
@@ -447,19 +447,19 @@ SmBusProcessCall (
|
||||
|
||||
@param SmBusAddress The address that encodes the SMBUS Slave Address,
|
||||
SMBUS Command, SMBUS Data Length, and PEC.
|
||||
@param Buffer The pointer to the buffer to store the bytes read from
|
||||
@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
|
||||
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
|
||||
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
|
||||
RETURN_CRC_ERROR: The checksum is not correct. (PEC is
|
||||
incorrect.)
|
||||
RETURN_UNSUPPORTED: The SMBus operation is not supported.
|
||||
|
||||
@@ -488,25 +488,25 @@ SmBusReadBlock (
|
||||
The SMBUS slave address, SMBUS command, and SMBUS length fields of SmBusAddress are required.
|
||||
Bytes are written to the SMBUS from Buffer.
|
||||
The number of bytes written is returned, and will never return a value larger than 32-bytes.
|
||||
If Status is not NULL, then the status of the executed command is returned in Status.
|
||||
If Status is not NULL, then the status of the executed command is returned in Status.
|
||||
If Length in SmBusAddress is zero or greater than 32, then ASSERT().
|
||||
If Buffer is NULL, then ASSERT().
|
||||
If any reserved bits of SmBusAddress are set, then ASSERT().
|
||||
|
||||
@param SmBusAddress The address that encodes the SMBUS Slave Address,
|
||||
MBUS Command, SMBUS Data Length, and PEC.
|
||||
@param Buffer The pointer to the buffer to store the bytes read from
|
||||
@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
|
||||
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
|
||||
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
|
||||
RETURN_CRC_ERROR: The checksum is not correct. (PEC is
|
||||
incorrect.)
|
||||
RETURN_UNSUPPORTED: The SMBus operation is not supported.
|
||||
|
||||
@@ -552,14 +552,14 @@ 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
|
||||
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
|
||||
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
|
||||
RETURN_CRC_ERROR: The checksum is not correct. (PEC is
|
||||
incorrect.)
|
||||
RETURN_UNSUPPORTED: The SMBus operation is not supported.
|
||||
|
||||
|
Reference in New Issue
Block a user