diff options
Diffstat (limited to 'MdePkg/Include/Ppi/Smbus.h')
| -rw-r--r-- | MdePkg/Include/Ppi/Smbus.h | 164 |
1 files changed, 66 insertions, 98 deletions
diff --git a/MdePkg/Include/Ppi/Smbus.h b/MdePkg/Include/Ppi/Smbus.h index 7360e5b12f..c0e1d9022d 100644 --- a/MdePkg/Include/Ppi/Smbus.h +++ b/MdePkg/Include/Ppi/Smbus.h @@ -31,48 +31,34 @@ typedef struct _EFI_PEI_SMBUS_PPI EFI_PEI_SMBUS_PPI; /**
Executes an SMBus operation to an SMBus controller.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
-
- @param SlaveAddress The SMBUS hardware address to which the SMBUS
- device is preassigned or allocated.
-
- @param Command This command is transmitted by the SMBus host
- controller to the SMBus slave device and the interpretation is
- SMBus slave device specific.
-
- @param Operation Signifies which particular SMBus hardware protocol
- instance that it will use to execute the SMBus transactions.
-
- @param PecCheck Defines if Packet Error Code (PEC) checking is required
- for this operation.
-
- @param Length Signifies the number of bytes that this operation will do.
-
- @param Buffer Contains the value of data to execute to the SMBus slave device.
-
- @retval EFI_SUCCESS The last data that was returned from the access
- matched the poll exit criteria.
-
- @retval EFI_CRC_ERROR The checksum is not correct (PEC is incorrect)
-
- @retval EFI_TIMEOUT Timeout expired before the operation was completed.
- Timeout is determined by the SMBus host controller device.
-
- @retval EFI_OUT_OF_RESOURCES The request could not be completed
- due to a lack of resources.
-
- @retval EFI_DEVICE_ERROR The request was not completed because
- a failure reflected in the Host Status Register bit.
-
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
+ @param SlaveAddress The SMBUS hardware address to which the SMBUS
+ device is preassigned or allocated.
+ @param Command This command is transmitted by the SMBus host
+ controller to the SMBus slave device and the interpretation is
+ SMBus slave device specific.
+ @param Operation Signifies which particular SMBus hardware protocol
+ instance that it will use to execute the SMBus transactions.
+ @param PecCheck Defines if Packet Error Code (PEC) checking is required
+ for this operation.
+ @param Length Signifies the number of bytes that this operation will do.
+ @param Buffer Contains the value of data to execute to the SMBus slave device.
+
+ @retval EFI_SUCCESS The last data that was returned from the access
+ matched the poll exit criteria.
+ @retval EFI_CRC_ERROR The checksum is not correct (PEC is incorrect)
+ @retval EFI_TIMEOUT Timeout expired before the operation was completed.
+ Timeout is determined by the SMBus host controller device.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed
+ due to a lack of resources.
+ @retval EFI_DEVICE_ERROR The request was not completed because
+ a failure reflected in the Host Status Register bit.
@retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.
- Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and
- EfiSmbusQuickWrite. Length is outside the range of valid values.
-
- @retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.
-
- @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.
+ Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and
+ EfiSmbusQuickWrite. Length is outside the range of valid values.
+ @retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.
+ @retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.
**/
typedef
@@ -102,15 +88,12 @@ typedef struct { /**
CallBack function can be registered in EFI_PEI_SMBUS_PPI_NOTIFY.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
-
- @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.
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
+ @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 Status Code
@@ -128,32 +111,24 @@ EFI_STATUS The ArpDevice() function enumerates the entire bus or enumerates a specific
device that is identified by SmbusUdid.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
-
- @param ArpAll A Boolean expression that indicates if the host drivers need
- to enumerate all the devices or enumerate only the device that is identified
- by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.
- If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address
- will be at SlaveAddress.
-
- @param SmbusUdid The targeted SMBus Unique Device Identifier (UDID).
- The UDID may not exist for SMBus devices with fixed addresses.
-
- @param SlaveAddress The new SMBus address for the slave device for
- which the operation is targeted.
-
- @retval EFI_SUCCESS The SMBus slave device address was set.
-
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
+ @param ArpAll A Boolean expression that indicates if the host drivers need
+ to enumerate all the devices or enumerate only the device that is identified
+ by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.
+ If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address
+ will be at SlaveAddress.
+ @param SmbusUdid The targeted SMBus Unique Device Identifier (UDID).
+ The UDID may not exist for SMBus devices with fixed addresses.
+ @param SlaveAddress The new SMBus address for the slave device for
+ which the operation is targeted.
+
+ @retval EFI_SUCCESS The SMBus slave device address was set.
@retval EFI_INVALID_PARAMETER SlaveAddress is NULL.
-
- @retval EFI_OUT_OF_RESOURCES The request could not be completed
- due to a lack of resources.
-
- @retval EFI_TIMEOUT The SMBus slave device did not respond.
-
- @retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed
+ due to a lack of resources.
+ @retval EFI_TIMEOUT The SMBus slave device did not respond.
+ @retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.
**/
typedef
@@ -175,16 +150,13 @@ typedef struct { The GetArpMap() function returns the mapping of all the SMBus devices
that are enumerated by the SMBus host driver.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI 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.
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI 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 device map was returned correctly in the buffer.
+ @retval EFI_SUCCESS The device map was returned correctly in the buffer.
**/
typedef
@@ -200,20 +172,16 @@ EFI_STATUS The Notify() function registers all the callback functions to allow the
bus driver to call these functions when the SlaveAddress/Data pair happens.
- @param PeiServices A pointer to the system PEI Services Table.
-
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
-
- @param SlaveAddress Address that the host controller detects as
- sending a message and calls all the registered functions.
-
- @param Data Data that the host controller detects as sending a message
- and calls all the registered functions.
-
- @param NotifyFunction The function to call when the bus driver
- detects the SlaveAddress and Data pair.
-
- @retval EFI_SUCCESS NotifyFunction has been registered.
+ @param PeiServices A pointer to the system PEI Services Table.
+ @param This A pointer to the EFI_PEI_SMBUS_PPI instance.
+ @param SlaveAddress Address that the host controller detects as
+ sending a message and calls all the registered functions.
+ @param Data Data that the host controller detects as sending a message
+ and calls all the registered functions.
+ @param NotifyFunction The function to call when the bus driver
+ detects the SlaveAddress and Data pair.
+
+ @retval EFI_SUCCESS NotifyFunction has been registered.
**/
typedef
|