aboutsummaryrefslogtreecommitdiffstats
path: root/MdePkg/Library/PeiSmbusLibSmbus2Ppi
diff options
context:
space:
mode:
Diffstat (limited to 'MdePkg/Library/PeiSmbusLibSmbus2Ppi')
-rw-r--r--MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h20
-rw-r--r--MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c20
-rw-r--r--MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLibSmbus2Ppi.inf13
-rw-r--r--MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLibSmbus2Ppi.uni7
-rw-r--r--MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c120
5 files changed, 76 insertions, 104 deletions
diff --git a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h
index afdcae7aac68..bca27e38dbb4 100644
--- a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h
+++ b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/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
**/
@@ -52,15 +46,15 @@ InternalGetSmbusPpi (
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
+ @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/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c
index 035c3eb88427..70af3c7806c1 100644
--- a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c
+++ b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c
@@ -1,14 +1,8 @@
/** @file
Implementation of SmBusLib class library for PEI 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
**/
@@ -46,15 +40,15 @@ InternalGetSmbusPpi (
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/PeiSmbusLibSmbus2Ppi/PeiSmbusLibSmbus2Ppi.inf b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLibSmbus2Ppi.inf
index 8618e76e6f65..3dc58bdd892a 100644
--- a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLibSmbus2Ppi.inf
+++ b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLibSmbus2Ppi.inf
@@ -1,14 +1,9 @@
## @file
# SMBUS library that layers on top of the SMBUS2 PPI.
#
-# 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
#
#
##
@@ -24,7 +19,7 @@
#
-# VALID_ARCHITECTURES = IA32 X64 IPF EBC (EBC is for build only)
+# VALID_ARCHITECTURES = IA32 X64 EBC (EBC is for build only)
#
[Sources]
@@ -46,5 +41,5 @@
gEfiPeiSmbus2PpiGuid ## CONSUMES
[Depex.common.PEIM]
- gEfiPeiSmbus2PpiGuid
+ gEfiPeiSmbus2PpiGuid
diff --git a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLibSmbus2Ppi.uni b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLibSmbus2Ppi.uni
index e783ddc5791c..0c874d04c92d 100644
--- a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLibSmbus2Ppi.uni
+++ b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLibSmbus2Ppi.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/PeiSmbusLibSmbus2Ppi/SmbusLib.c b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c
index 739d3cbd874b..d088a904aaad 100644
--- a/MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c
+++ b/MdePkg/Library/PeiSmbusLibSmbus2Ppi/SmbusLib.c
@@ -1,14 +1,8 @@
/** @file
Implementation of SmBusLib class library for PEI phase.
-Copyright (c) 2006 - 2008, 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,11 +25,11 @@ 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
+ 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,
+ 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), 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_UNSUPPORTED:: The SMBus operation is not supported.
@@ -113,11 +107,11 @@ 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
- a failure reflected in the Host Status Register bit.
- Device errors are a result of a transaction collision,
+ 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.)
@@ -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
+ 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.
@@ -209,11 +203,11 @@ 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 failure reflected in the Host Status Register bit.
- Device errors are a result of a transaction collision,
+ 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.)
@@ -256,11 +250,11 @@ 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,
+ 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.)
@@ -297,17 +291,17 @@ 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,
+ 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.)
@@ -350,11 +344,11 @@ 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
+ 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,
+ 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.)
@@ -399,11 +393,11 @@ 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,
+ 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.)
@@ -448,12 +442,12 @@ SmBusProcessCall (
@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 incorrect.)
RETURN_UNSUPPORTED: The SMBus operation is not supported.
@@ -483,7 +477,7 @@ 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().
@@ -493,12 +487,12 @@ 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
+ 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 incorrect)
RETURN_UNSUPPORTED: The SMBus operation is not supported.
@@ -545,12 +539,12 @@ 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),
+ 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.