X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FLibrary%2FS3SmbusLib.h;h=fdb67241f9c9fad791b594883cc8f7feac757511;hp=f7a1e248f798c1b32409d75b85b861926871a3b8;hb=9095d37b8fe5bfc3d02adad6ba7fd7359ebc0107;hpb=fe69ac847a984abf0307ae8706dcabbb928a5a48 diff --git a/MdePkg/Include/Library/S3SmbusLib.h b/MdePkg/Include/Library/S3SmbusLib.h index f7a1e248f7..fdb67241f9 100644 --- a/MdePkg/Include/Library/S3SmbusLib.h +++ b/MdePkg/Include/Library/S3SmbusLib.h @@ -3,7 +3,7 @@ to be replayed during an S3 resume. This library class maps directly on top of the SmbusLib class. - Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.
+ Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions @@ -35,13 +35,13 @@ SMBUS Command, SMBUS Data Length, and PEC. @param[out] Status The 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_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 was recorded in the Host Status Register bit. Device errors are a result of a transaction collision, illegal command field, unclaimed cycle (host initiated), or bus error (collision). - RETURN_UNSUPPORTED The SMBus operation is not supported. + RETURN_UNSUPPORTED The SMBus operation is not supported. **/ VOID @@ -67,13 +67,13 @@ S3SmBusQuickRead ( SMBUS Command, SMBUS Data Length, and PEC. @param[out] Status The 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_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 was recorded in the Host Status Register bit. Device errors are a result of a transaction collision, illegal command field, unclaimed cycle (host initiated), or bus error (collision). - RETURN_UNSUPPORTED The SMBus operation is not supported. + RETURN_UNSUPPORTED The SMBus operation is not supported. **/ VOID @@ -99,14 +99,14 @@ S3SmBusQuickWrite ( SMBUS Command, SMBUS Data Length, and PEC. @param[out] Status The 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_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 was recorded in the Host Status Register bit. Device errors are a result of a transaction collision, illegal command field, unclaimed cycle (host initiated), or bus error (collision). RETURN_CRC_ERROR The checksum is not correct (PEC is incorrect). - RETURN_UNSUPPORTED The SMBus operation is not supported. + RETURN_UNSUPPORTED The SMBus operation is not supported. @return The byte received from the SMBUS.