diff options
Diffstat (limited to 'MdePkg/Include/Protocol/SmbusHc.h')
| -rw-r--r-- | MdePkg/Include/Protocol/SmbusHc.h | 68 |
1 files changed, 34 insertions, 34 deletions
diff --git a/MdePkg/Include/Protocol/SmbusHc.h b/MdePkg/Include/Protocol/SmbusHc.h index ed20a47178..152d40625f 100644 --- a/MdePkg/Include/Protocol/SmbusHc.h +++ b/MdePkg/Include/Protocol/SmbusHc.h @@ -1,15 +1,15 @@ /** @file
- The file provides basic SMBus host controller management
+ The file provides basic SMBus host controller management
and basic data transactions over the SMBus.
- Copyright (c) 2006 - 2011, 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
+ 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.
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@par Revision Reference: PI
Version 1.00.
@@ -27,13 +27,13 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
/**
-
+
The Execute() function provides a standard way to execute an
operation as defined in the System Management Bus (SMBus)
Specification. The resulting transaction will be either that
the SMBus slave devices accept this transaction or that this
- function returns with error.
-
+ function returns with error.
+
@param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
SlaveAddress The SMBus slave address of the device
with which to communicate. Type
@@ -65,8 +65,8 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL; @param PecCheck Defines if Packet Error Code (PEC) checking
is required for this operation. SMBus Host
Controller Code Definitions Version 1.0
- August 21, 2006 13
-
+ August 21, 2006 13
+
@param Length Signifies the number of bytes that this operation will do.
The maximum number of bytes can be revision
specific and operation specific. This field
@@ -78,8 +78,8 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL; SMBus slave device. Not all operations require
this argument. The length of this buffer is
identified by Length.
-
-
+
+
@retval EFI_SUCCESS The last data that was returned from the
access matched the poll exit criteria.
@@ -113,7 +113,7 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL; values.
@retval EFI_UNSUPPORTED The SMBus operation or PEC is not
- supported.
+ supported.
@retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for
this operation.
@@ -134,10 +134,10 @@ EFI_STATUS /**
-
- The ArpDevice() function provides a standard way for a device driver to
+
+ The ArpDevice() function provides a standard way for a device driver to
enumerate the entire SMBus or specific devices on the bus.
-
+
@param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
@param ArpAll A Boolean expression that indicates if the
@@ -183,7 +183,7 @@ EFI_STATUS @retval EFI_UNSUPPORTED ArpDevice, GetArpMap, and Notify are
not implemented by this driver.
-
+
**/
typedef
EFI_STATUS
@@ -196,23 +196,23 @@ EFI_STATUS /**
- The GetArpMap() function returns the mapping of all the SMBus devices
+ The GetArpMap() function returns the mapping of all the SMBus devices
that were enumerated by the SMBus host driver.
-
+
@param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
-
+
@param Length Size of the buffer that contains the SMBus
device map.
-
+
@param SmbusDeviceMap The pointer to the device map as
enumerated by the SMBus controller
driver.
-
+
@retval EFI_SUCCESS The SMBus returned the current device map.
-
+
@retval EFI_UNSUPPORTED ArpDevice, GetArpMap, and Notify are
not implemented by this driver.
-
+
**/
typedef
EFI_STATUS
@@ -224,13 +224,13 @@ EFI_STATUS /**
The notify function does some actions.
-
+
@param SlaveAddress
The SMBUS hardware address to which the SMBUS device is preassigned or allocated.
@param Data
Data of the SMBus host notify command that the caller wants to be called.
-
+
@return EFI_STATUS
**/
typedef
@@ -242,13 +242,13 @@ EFI_STATUS /**
-
+
The Notify() function registers all the callback functions to
- allow the bus driver to call these functions when the
+ allow the bus driver to call these functions when the
SlaveAddress/Data pair happens.
-
+
@param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
-
+
@param SlaveAddress Address that the host controller detects
as sending a message and calls all the registered function.
@@ -261,7 +261,7 @@ EFI_STATUS Data pair.
@retval EFI_SUCCESS NotifyFunction was registered.
-
+
@retval EFI_UNSUPPORTED ArpDevice, GetArpMap, and Notify are
not implemented by this driver.
|