]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/S3SmbusLib.h
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Include / Library / S3SmbusLib.h
index f7a1e248f798c1b32409d75b85b861926871a3b8..fdb67241f9c9fad791b594883cc8f7feac757511 100644 (file)
@@ -3,7 +3,7 @@
   to be replayed during an S3 resume. This library class maps directly on top\r
   of the SmbusLib class.\r
 \r
-  Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
 \r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions\r
                              SMBUS Command, SMBUS Data Length, and PEC.\r
   @param[out] Status         The 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_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
                               was recorded 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 error (collision).\r
-                             RETURN_UNSUPPORTED        The SMBus operation is not supported.\r
+                             RETURN_UNSUPPORTED    The SMBus operation is not supported.\r
 \r
 **/\r
 VOID\r
@@ -67,13 +67,13 @@ S3SmBusQuickRead (
                              SMBUS Command, SMBUS Data Length, and PEC.\r
   @param[out] Status         The 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_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
                              was recorded 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 error (collision).\r
-                             RETURN_UNSUPPORTED        The SMBus operation is not supported.\r
+                             RETURN_UNSUPPORTED    The SMBus operation is not supported.\r
 \r
 **/\r
 VOID\r
@@ -99,14 +99,14 @@ S3SmBusQuickWrite (
                              SMBUS Command, SMBUS Data Length, and PEC.\r
   @param[out] Status         The 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_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
                              was recorded 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 error (collision).\r
                              RETURN_CRC_ERROR  The checksum is not correct (PEC is incorrect).\r
-                             RETURN_UNSUPPORTED        The SMBus operation is not supported.\r
+                             RETURN_UNSUPPORTED    The SMBus operation is not supported.\r
 \r
   @return   The byte received from the SMBUS.\r
 \r