diff options
Diffstat (limited to 'MdePkg/Library/DxeSmbusLib')
| -rw-r--r-- | MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c | 22 | ||||
| -rw-r--r-- | MdePkg/Library/DxeSmbusLib/DxeSmbusLib.inf | 13 | ||||
| -rw-r--r-- | MdePkg/Library/DxeSmbusLib/DxeSmbusLib.uni | 7 | ||||
| -rw-r--r-- | MdePkg/Library/DxeSmbusLib/InternalSmbusLib.h | 18 | ||||
| -rw-r--r-- | MdePkg/Library/DxeSmbusLib/SmbusLib.c | 150 |
5 files changed, 91 insertions, 119 deletions
diff --git a/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c b/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c index 5c2c9dbf0d40..8d40a08467a3 100644 --- a/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c +++ b/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.c @@ -1,14 +1,8 @@ /** @file Implementation of SmBusLib class library for DXE phase. -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 -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> +SPDX-License-Identifier: BSD-2-Clause-Patent **/ @@ -18,7 +12,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. // -// Globle varible to cache pointer to Smbus protocol. +// Global variable to cache pointer to Smbus protocol. // EFI_SMBUS_HC_PROTOCOL *mSmbus = NULL; @@ -57,15 +51,15 @@ SmbusLibConstructor ( 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 + @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 + @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 + @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/DxeSmbusLib/DxeSmbusLib.inf b/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.inf index edbbc064a907..d5daac5f466a 100644 --- a/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.inf +++ b/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.inf @@ -1,14 +1,9 @@ ## @file # SMBUS Library that layers on top of the SMBUS Protocol. # -# Copyright (c) 2006 - 2014, 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 -# http://opensource.org/licenses/bsd-license.php. -# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +# SPDX-License-Identifier: BSD-2-Clause-Patent # # ## @@ -20,12 +15,12 @@ FILE_GUID = 4F369FB1-31A7-423c-960E-B3EFD337894F MODULE_TYPE = DXE_DRIVER VERSION_STRING = 1.0 - LIBRARY_CLASS = SmbusLib|DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SAL_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER + LIBRARY_CLASS = SmbusLib|DXE_DRIVER DXE_RUNTIME_DRIVER DXE_SMM_DRIVER UEFI_APPLICATION UEFI_DRIVER CONSTRUCTOR = SmbusLibConstructor # -# VALID_ARCHITECTURES = IA32 X64 IPF EBC +# VALID_ARCHITECTURES = IA32 X64 EBC # [Sources] diff --git a/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.uni b/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.uni index 30adce80644d..9a57c135cf92 100644 --- a/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.uni +++ b/MdePkg/Library/DxeSmbusLib/DxeSmbusLib.uni @@ -5,12 +5,7 @@ // // Copyright (c) 2006 - 2014, 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 -// http://opensource.org/licenses/bsd-license.php. -// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +// SPDX-License-Identifier: BSD-2-Clause-Patent // // **/ diff --git a/MdePkg/Library/DxeSmbusLib/InternalSmbusLib.h b/MdePkg/Library/DxeSmbusLib/InternalSmbusLib.h index b9a190b98ec9..bf4bb4062f3a 100644 --- a/MdePkg/Library/DxeSmbusLib/InternalSmbusLib.h +++ b/MdePkg/Library/DxeSmbusLib/InternalSmbusLib.h @@ -1,14 +1,8 @@ /** @file Internal header file for Smbus library. -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 -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> +SPDX-License-Identifier: BSD-2-Clause-Patent **/ @@ -38,15 +32,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. 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 + @param SmbusOperation Signifies which particular SMBus hardware protocol instance that it will use toexecute 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 + @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 + 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/DxeSmbusLib/SmbusLib.c b/MdePkg/Library/DxeSmbusLib/SmbusLib.c index f1c058d09168..1cd9780774c0 100644 --- a/MdePkg/Library/DxeSmbusLib/SmbusLib.c +++ b/MdePkg/Library/DxeSmbusLib/SmbusLib.c @@ -1,14 +1,8 @@ /** @file Implementation of SmBusLib class library for DXE phase. -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 -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR> +SPDX-License-Identifier: BSD-2-Clause-Patent **/ @@ -31,13 +25,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 +66,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 +107,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 +155,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 +203,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 +250,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 +291,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 +345,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 +395,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 +441,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 +482,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 +546,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. |