--- /dev/null
+/** @file\r
+ This file declares the EFI SMBus Host Controller protocol\r
+\r
+ Copyright (c) 2006 - 2007, Intel Corporation \r
+ All rights reserved. This program and the accompanying materials \r
+ are licensed and made available under the terms and conditions of the BSD License \r
+ which accompanies this distribution. 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
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+ Module Name: Smbus.h\r
+\r
+ @par Revision Reference:\r
+ This protocol is defined in Framework of EFI SMBus Host Controller Specification\r
+ Version 0.9\r
+\r
+**/\r
+\r
+#ifndef _EFI_SMBUS_H\r
+#define _EFI_SMBUS_H\r
+\r
+#include <IndustryStandard/SmBus.h>\r
+\r
+#define EFI_SMBUS_HC_PROTOCOL_GUID \\r
+ { \\r
+ 0xe49d33ed, 0x513d, 0x4634, {0xb6, 0x98, 0x6f, 0x55, 0xaa, 0x75, 0x1c, 0x1b } \\r
+ }\r
+\r
+typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;\r
+\r
+/**\r
+ Executes an SMBus operation to an SMBus controller.\r
+\r
+ @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.\r
+ @param SlaveAddress The SMBus slave address of the device with which to communicate.\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
+\r
+ @retval EFI_SUCCESS The last data that was returned from the access\r
+ matched the poll exit criteria.\r
+ @retval EFI_CRC_ERROR The checksum is not correct (PEC is incorrect)\r
+ @retval EFI_TIMEOUT Timeout expired before the operation was completed.\r
+ Timeout is determined by the SMBus host controller device.\r
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed\r
+ due to a lack of resources.\r
+ @retval EFI_DEVICE_ERROR The request was not completed because\r
+ a failure reflected in the Host Status Register bit.\r
+ @retval EFI_INVALID_PARAMETER Operation is not defined in EFI_SMBUS_OPERATION.\r
+ Or Length/Buffer is NULL for operations except for EfiSmbusQuickRead and\r
+ EfiSmbusQuickWrite. Length 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
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_SMBUS_HC_EXECUTE_OPERATION) (\r
+ IN EFI_SMBUS_HC_PROTOCOL *This,\r
+ IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,\r
+ IN EFI_SMBUS_DEVICE_COMMAND Command,\r
+ IN EFI_SMBUS_OPERATION Operation,\r
+ IN BOOLEAN PecCheck,\r
+ IN OUT UINTN *Length,\r
+ IN OUT VOID *Buffer\r
+ );\r
+\r
+typedef struct {\r
+ UINT32 VendorSpecificId;\r
+ UINT16 SubsystemDeviceId;\r
+ UINT16 SubsystemVendorId;\r
+ UINT16 Interface;\r
+ UINT16 DeviceId;\r
+ UINT16 VendorId;\r
+ UINT8 VendorRevision;\r
+ UINT8 DeviceCapabilities;\r
+} EFI_SMBUS_UDID;\r
+\r
+/**\r
+ CallBack function can be registered in EFI_SMBUS_HC_PROTOCOL_NOTIFY.\r
+\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
+\r
+ @return Status Code\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_SMBUS_NOTIFY_FUNCTION) (\r
+ IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,\r
+ IN UINTN Data\r
+ );\r
+\r
+/**\r
+ Sets the SMBus slave device addresses for the device with a given unique ID \r
+ or enumerates the entire bus.\r
+\r
+ @param This A pointer to the EFI_SMBUS_HC_PROTOCOL 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 Unique Device Identifier (UDID) that is associated\r
+ with this device.\r
+ @param SlaveAddress The SMBus slave address that is associated with an SMBus UDID.\r
+\r
+ @retval EFI_SUCCESS The SMBus slave device address was set.\r
+ @retval EFI_INVALID_PARAMETER SlaveAddress is NULL.\r
+ @retval EFI_OUT_OF_RESOURCES The request could not be completed\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
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_SMBUS_HC_PROTOCOL_ARP_DEVICE) (\r
+ IN EFI_SMBUS_HC_PROTOCOL *This,\r
+ IN BOOLEAN ArpAll,\r
+ IN EFI_SMBUS_UDID *SmbusUdid, OPTIONAL\r
+ IN OUT EFI_SMBUS_DEVICE_ADDRESS *SlaveAddress OPTIONAL\r
+ );\r
+\r
+typedef struct {\r
+ EFI_SMBUS_DEVICE_ADDRESS SmbusDeviceAddress;\r
+ EFI_SMBUS_UDID SmbusDeviceUdid;\r
+} EFI_SMBUS_DEVICE_MAP;\r
+\r
+/**\r
+ The GetArpMap() function returns the mapping of all the SMBus devices \r
+ that are enumerated by the SMBus host driver. \r
+\r
+ @param This A pointer to the EFI_SMBUS_HC_PROTOCOL 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
+\r
+ @retval EFI_SUCCESS The device map was returned correctly in the buffer.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_SMBUS_HC_PROTOCOL_GET_ARP_MAP) (\r
+ IN EFI_SMBUS_HC_PROTOCOL *This,\r
+ IN OUT UINTN *Length,\r
+ IN OUT EFI_SMBUS_DEVICE_MAP **SmbusDeviceMap\r
+ );\r
+\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 This A pointer to the EFI_SMBUS_HC_PROTOCOL 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
+\r
+ @retval EFI_SUCCESS NotifyFunction was registered.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EFI_SMBUS_HC_PROTOCOL_NOTIFY) (\r
+ IN EFI_SMBUS_HC_PROTOCOL *This,\r
+ IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,\r
+ IN UINTN Data,\r
+ IN EFI_SMBUS_NOTIFY_FUNCTION NotifyFunction\r
+ );\r
+\r
+/**\r
+ @par Protocol Description:\r
+ Provides basic SMBus host controller management and basic data \r
+ transactions over the SMBus.\r
+\r
+ @param Execute\r
+ Executes the SMBus operation to an SMBus slave device.\r
+\r
+ @param ArpDevice\r
+ Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP)\r
+\r
+ @param GetArpMap\r
+ Allows a driver to retrieve the address that was allocated by the SMBus \r
+ host controller during enumeration/ARP.\r
+\r
+ @param Notify\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 driver.\r
+\r
+**/\r
+struct _EFI_SMBUS_HC_PROTOCOL {\r
+ EFI_SMBUS_HC_EXECUTE_OPERATION Execute;\r
+ EFI_SMBUS_HC_PROTOCOL_ARP_DEVICE ArpDevice;\r
+ EFI_SMBUS_HC_PROTOCOL_GET_ARP_MAP GetArpMap;\r
+ EFI_SMBUS_HC_PROTOCOL_NOTIFY Notify;\r
+};\r
+\r
+extern EFI_GUID gEfiSmbusProtocolGuid;\r
+#endif\r
projects / mirror_edk2.git / blobdiff