/**\r
Executes an SMBus operation to an SMBus controller.\r
\r
- @param PeiServices A pointer to the system PEI Services Table.\r
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
- @param SlaveAddress The SMBUS hardware address to which the SMBUS\r
- device is preassigned or allocated.\r
- @param Command This command is transmitted by the SMBus host\r
- controller to the SMBus slave device and the interpretation is\r
- SMBus slave device specific.\r
- @param Operation Signifies which particular SMBus hardware protocol\r
- instance that it will use to execute the SMBus transactions.\r
- @param PecCheck Defines if Packet Error Code (PEC) checking is required\r
- for this operation.\r
- @param Length Signifies the number of bytes that this operation will do.\r
- @param Buffer Contains the value of data to execute to the SMBus slave device.\r
+ @param[in] PeiServices A pointer to the system PEI Services Table.\r
+ @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
+ @param[in] SlaveAddress The SMBUS hardware address to which the SMBUS\r
+ device is preassigned or allocated.\r
+ @param[in] Command This command is transmitted by the SMBus host\r
+ controller to the SMBus slave device and the interpretation is\r
+ SMBus slave device specific.\r
+ @param[in] Operation Signifies which particular SMBus hardware protocol\r
+ instance that it will use to execute the SMBus transactions.\r
+ @param[in] PecCheck Defines if Packet Error Code (PEC) checking is required\r
+ for this operation.\r
+ @param[in, out] Length Signifies the number of bytes that this operation will do.\r
+ @param[in, out] Buffer Contains the value of data to execute to the SMBus slave device.\r
\r
@retval EFI_SUCCESS The last data that was returned from the access\r
matched the poll exit criteria.\r
/**\r
CallBack function can be registered in EFI_PEI_SMBUS_PPI_NOTIFY.\r
\r
- @param PeiServices A pointer to the system PEI Services Table.\r
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
- @param SlaveAddress The SMBUS hardware address to which the SMBUS\r
- device is preassigned or allocated.\r
- @param Data Data of the SMBus host notify command that\r
- the caller wants to be called.\r
+ @param[in] PeiServices A pointer to the system PEI Services Table.\r
+ @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
+ @param[in] SlaveAddress The SMBUS hardware address to which the SMBUS\r
+ device is preassigned or allocated.\r
+ @param[in] Data Data of the SMBus host notify command that\r
+ the caller wants to be called.\r
\r
@return Status Code returned by callback function.\r
\r
The ArpDevice() function enumerates the entire bus or enumerates a specific\r
device that is identified by SmbusUdid.\r
\r
- @param PeiServices A pointer to the system PEI Services Table.\r
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
- @param ArpAll A Boolean expression that indicates if the host drivers need\r
- to enumerate all the devices or enumerate only the device that is identified\r
- by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.\r
- If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address\r
- will be at SlaveAddress.\r
- @param SmbusUdid The targeted SMBus Unique Device Identifier (UDID).\r
- The UDID may not exist for SMBus devices with fixed addresses.\r
- @param SlaveAddress The new SMBus address for the slave device for\r
- which the operation is targeted.\r
+ @param[in] PeiServices A pointer to the system PEI Services Table.\r
+ @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
+ @param[in] ArpAll A Boolean expression that indicates if the host drivers need\r
+ to enumerate all the devices or enumerate only the device that is identified\r
+ by SmbusUdid. If ArpAll is TRUE, SmbusUdid and SlaveAddress are optional.\r
+ If ArpAll is FALSE, ArpDevice will enumerate SmbusUdid and the address\r
+ will be at SlaveAddress.\r
+ @param[in] SmbusUdid The targeted SMBus Unique Device Identifier (UDID).\r
+ The UDID may not exist for SMBus devices with fixed addresses.\r
+ @param[in, out] SlaveAddress The new SMBus address for the slave device for\r
+ which the operation is targeted.\r
\r
@retval EFI_SUCCESS The SMBus slave device address was set.\r
@retval EFI_INVALID_PARAMETER SlaveAddress is NULL.\r
The GetArpMap() function returns the mapping of all the SMBus devices\r
that are enumerated by the SMBus host driver.\r
\r
- @param PeiServices A pointer to the system PEI Services Table.\r
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
- @param Length Size of the buffer that contains the SMBus device map.\r
- @param SmbusDeviceMap The pointer to the device map as enumerated\r
- by the SMBus controller driver.\r
+ @param[in] PeiServices A pointer to the system PEI Services Table.\r
+ @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
+ @param[in, out] Length Size of the buffer that contains the SMBus device map.\r
+ @param[in, out] SmbusDeviceMap The pointer to the device map as enumerated\r
+ by the SMBus controller driver.\r
\r
@retval EFI_SUCCESS The device map was returned correctly in the buffer.\r
\r
The Notify() function registers all the callback functions to allow the\r
bus driver to call these functions when the SlaveAddress/Data pair happens.\r
\r
- @param PeiServices A pointer to the system PEI Services Table.\r
- @param This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
- @param SlaveAddress Address that the host controller detects as\r
- sending a message and calls all the registered functions.\r
- @param Data Data that the host controller detects as sending a message\r
- and calls all the registered functions.\r
- @param NotifyFunction The function to call when the bus driver\r
- detects the SlaveAddress and Data pair.\r
+ @param[in] PeiServices A pointer to the system PEI Services Table.\r
+ @param[in] This A pointer to the EFI_PEI_SMBUS_PPI instance.\r
+ @param[in] SlaveAddress Address that the host controller detects as\r
+ sending a message and calls all the registered functions.\r
+ @param[in] Data Data that the host controller detects as sending a message\r
+ and calls all the registered functions.\r
+ @param[in] NotifyFunction The function to call when the bus driver\r
+ detects the SlaveAddress and Data pair.\r
\r
- @retval EFI_SUCCESS NotifyFunction has been registered.\r
+ @retval EFI_SUCCESS NotifyFunction has been registered.\r
\r
**/\r
typedef\r
projects / mirror_edk2.git / blobdiff