/** @file\r
- This file declares the Smbus PPI, which provides the basic I/O interfaces that a PEIM \r
+ This file declares the Smbus PPI, which provides the basic I/O interfaces that a PEIM\r
uses to access its SMBus controller and the slave devices attached to it.\r
\r
-Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php. \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
+http://opensource.org/licenses/bsd-license.php.\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
@par Revision Reference:\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 \r
+ controller to the SMBus slave device, and the\r
interpretation is SMBus slave device specific.\r
@param[in] Operation Signifies which particular SMBus hardware protocol\r
instance to use to execute the SMBus transactions.\r
- @param[in] PecCheck Defines if Packet Error Code (PEC) checking is \r
+ @param[in] PecCheck Defines if Packet Error Code (PEC) checking is\r
required for this operation.\r
@param[in, out] Length The number of bytes for this operation.\r
- @param[in, out] Buffer Contains the value of data to execute to the SMBus \r
+ @param[in, out] Buffer Contains the value of data to execute to the SMBus\r
slave device.\r
\r
@retval EFI_SUCCESS The last data that was returned from the access\r
@retval EFI_DEVICE_ERROR The request was not completed because a failure\r
was recorded in the Host Status Register bit.\r
@retval EFI_INVALID_PARAMETER The operation is not defined in EFI_SMBUS_OPERATION.\r
- @retval EFI_INVALID_PARAMETER Length/Buffer is NULL for operations except for \r
- EfiSmbusQuickRead and EfiSmbusQuickWrite. Length \r
+ @retval EFI_INVALID_PARAMETER Length/Buffer is NULL for operations except for\r
+ EfiSmbusQuickRead and EfiSmbusQuickWrite. Length\r
is outside the range of valid values.\r
@retval EFI_UNSUPPORTED The SMBus operation or PEC is not supported.\r
@retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for this operation.\r
\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 \r
- drivers need to enumerate all the devices or to \r
+ @param[in] ArpAll A Boolean expression that indicates if the host\r
+ drivers need to enumerate all the devices or to\r
enumerate only the device that is identified\r
- by SmbusUdid. If ArpAll is TRUE, SmbusUdid and \r
+ by SmbusUdid. If ArpAll is TRUE, SmbusUdid and\r
SlaveAddress are optional and ignored if entered.\r
- If ArpAll is FALSE, ArpDevice will enumerate \r
+ If ArpAll is FALSE, ArpDevice will enumerate\r
SmbusUdid, and the address 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 \r
+ The UDID may not exist for SMBus devices with fixed\r
addresses.\r
@param[in, out] SlaveAddress The new SMBus address for the slave device for\r
which the operation is targeted.\r
due to a lack of resources.\r
@retval EFI_TIMEOUT The SMBus slave device did not respond.\r
@retval EFI_DEVICE_ERROR The request was not completed because the transaction failed.\r
- @retval EFI_UNSUPPORTED ArpDevice() is not implemented by this PEIM. \r
+ @retval EFI_UNSUPPORTED ArpDevice() is not implemented by this PEIM.\r
This return value is not defined in the Framework Specification.\r
This return value was introduced in the PI Specification.\r
\r
by the SMBus controller driver.\r
\r
@retval EFI_SUCCESS The device map was returned correctly in the buffer.\r
- @retval EFI_UNSUPPORTED GetArpMap() are not implemented by this PEIM. \r
+ @retval EFI_UNSUPPORTED GetArpMap() are not implemented by this PEIM.\r
This return value was not defined in the Framework Specification.\r
This return value was introduced in the PI Specification.\r
\r
);\r
\r
/**\r
- Allows a device driver to register for a callback when the bus driver detects a state that it needs to \r
+ Allows a device driver to register for a callback when the bus driver detects a state that it needs to\r
propagate to other PEIMs that are registered for a callback.\r
\r
The Notify() function registers all the callback functions to allow the\r
detects the SlaveAddress and Data pair.\r
\r
@retval EFI_SUCCESS NotifyFunction has been registered.\r
- @retval EFI_UNSUPPORTED Notify() are not implemented by this PEIM. \r
+ @retval EFI_UNSUPPORTED Notify() are not implemented by this PEIM.\r
This return value is not defined in the Framework Specification.\r
This return value was introduced in the PI Specification.\r
\r
/// Executes the SMBus operation to an SMBus slave device.\r
///\r
EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION Execute;\r
- \r
+\r
///\r
/// Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP)\r
///\r
EFI_PEI_SMBUS_PPI_ARP_DEVICE ArpDevice;\r
- \r
+\r
///\r
/// Allows a PEIM to retrieve the address that was allocated by the SMBus\r
- /// host controller during enumeration/ARP. \r
+ /// host controller during enumeration/ARP.\r
///\r
EFI_PEI_SMBUS_PPI_GET_ARP_MAP GetArpMap;\r
- \r
+\r
///\r
/// Allows a driver to register for a callback to the SMBus host\r
- /// controller driver when the bus issues a notification to the bus controller PEIM. \r
+ /// controller driver when the bus issues a notification to the bus controller PEIM.\r
///\r
EFI_PEI_SMBUS_PPI_NOTIFY Notify;\r
};\r
projects / mirror_edk2.git / blobdiff