X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FSmbusHc.h;h=ed20a471785913c5ab6a512fb783e1409580b5bd;hp=09d51642c513ed1b30e9399c8cd68a86723d66b4;hb=344d057a2b539cf34420e2afad2351b45c65178e;hpb=842f5579c7e2a313f56c576e4c5150f7f4793079
diff --git a/MdePkg/Include/Protocol/SmbusHc.h b/MdePkg/Include/Protocol/SmbusHc.h
index 09d51642c5..ed20a47178 100644
--- a/MdePkg/Include/Protocol/SmbusHc.h
+++ b/MdePkg/Include/Protocol/SmbusHc.h
@@ -2,8 +2,8 @@
The file provides basic SMBus host controller management
and basic data transactions over the SMBus.
- Copyright (c) 2006 - 2007, Intel Corporation
- All rights reserved. This program and the accompanying materials
+ Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.
+ 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
@@ -19,7 +19,7 @@
#ifndef __SMBUS_HC_H__
#define __SMBUS_HC_H__
-#include
+#include
#define EFI_SMBUS_HC_PROTOCOL_GUID \
{0xe49d33ed, 0x513d, 0x4634, { 0xb6, 0x98, 0x6f, 0x55, 0xaa, 0x75, 0x1c, 0x1b} }
@@ -32,14 +32,14 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
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. Status Codes Returned
+ 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
- EFI_SMBUS_DEVICE_ADDRESS is defined in
- EFI_PEI_SMBUS_PPI.Execute() in the Platform
- Initialization SMBus PPI Specification.
+ @param This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
+ SlaveAddress The SMBus slave address of the device
+ with which to communicate. Type
+ EFI_SMBUS_DEVICE_ADDRESS is defined in
+ EFI_PEI_SMBUS_PPI.Execute() in the Platform
+ Initialization SMBus PPI Specification.
@param Command This command is transmitted by the SMBus host
controller to the SMBus slave device and the
@@ -51,8 +51,9 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
EFI_SMBUS_DEVICE_COMMAND is defined in
EFI_PEI_SMBUS_PPI.Execute() in the Platform
Initialization SMBus PPI Specification.
- Operation Signifies which particular SMBus
- hardware protocol instance that it will use to
+
+ @param Operation Signifies the particular SMBus
+ hardware protocol instance it will use to
execute the SMBus transactions. This SMBus
hardware protocol is defined by the SMBus
Specification and is not related to PI
@@ -61,16 +62,17 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
Platform Initialization SMBus PPI
Specification.
- @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 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
- will contain the actual number of bytes that
- are executed for this operation. Not all
- operations require this argument.
+ @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
+
+ @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
+ will contain the actual number of bytes that
+ are executed for this operation. Not all
+ operations require this argument.
@param Buffer Contains the value of data to execute to the
SMBus slave device. Not all operations require
@@ -78,28 +80,27 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
identified by Length.
- @retval EFI_SUCCESS The last data that was returned from the
- access matched the poll exit criteria.
+ @retval EFI_SUCCESS The last data that was returned from the
+ access matched the poll exit criteria.
- @retval EFI_CRC_ERROR Checksum is not correct (PEC is
- incorrect).
+ @retval EFI_CRC_ERROR 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_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 that was reflected
- in the Host Status Register bit.
- Device errors are a result of a
- transaction collision, illegal
- command field, unclaimed cycle (host
- initiated), or bus errors
- (collisions).
+ @retval EFI_DEVICE_ERROR The request was not completed
+ because a failure that was reflected
+ in the Host Status Register bit.
+ Device errors are a result of a
+ transaction collision, illegal
+ command field, unclaimed cycle (host
+ initiated), or bus errors
+ (collisions).
@retval EFI_INVALID_PARAMETER Operation is not defined in
EFI_SMBUS_OPERATION.
@@ -111,8 +112,8 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
outside the range of valid
values.
- @retval EFI_UNSUPPORTED The SMBus operation or PEC is not
- supported.
+ @retval EFI_UNSUPPORTED The SMBus operation or PEC is not
+ supported.
@retval EFI_BUFFER_TOO_SMALL Buffer is not sufficient for
this operation.
@@ -120,12 +121,12 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
**/
typedef
EFI_STATUS
-(EFIAPI *EFI_SMBUS_HC_EXECUTE_OPERATION) (
+(EFIAPI *EFI_SMBUS_HC_EXECUTE_OPERATION)(
IN CONST EFI_SMBUS_HC_PROTOCOL *This,
- IN CONST EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
- IN CONST EFI_SMBUS_DEVICE_COMMAND Command,
- IN CONST EFI_SMBUS_OPERATION Operation,
- IN CONST BOOLEAN PecCheck,
+ IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
+ IN EFI_SMBUS_DEVICE_COMMAND Command,
+ IN EFI_SMBUS_OPERATION Operation,
+ IN BOOLEAN PecCheck,
IN OUT UINTN *Length,
IN OUT VOID *Buffer
);
@@ -134,84 +135,80 @@ EFI_STATUS
/**
- The ArpDevice() function provides a standard way for a device driver to enumerate the entire
- SMBus or specific devices on the bus.
+ 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
- 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 Unique Device Identifier (UDID) that is
- associated with this device. Type
- EFI_SMBUS_UDID is defined in
- EFI_PEI_SMBUS_PPI.ArpDevice() in the
- Platform Initialization SMBus PPI
- Specification.
+ @param This A pointer to the EFI_SMBUS_HC_PROTOCOL 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 Unique Device Identifier (UDID) that is
+ associated with this device. Type
+ EFI_SMBUS_UDID is defined in
+ EFI_PEI_SMBUS_PPI.ArpDevice() in the
+ Platform Initialization SMBus PPI
+ Specification.
@param SlaveAddress The SMBus slave address that is
associated with an SMBus UDID.
+ @retval EFI_SUCCESS The last data that was returned from the
+ access matched the poll exit criteria.
+ @retval EFI_CRC_ERROR Checksum is not correct (PEC is
+ incorrect).
- @retval EFI_SUCCESS The last data that was returned from the
- access matched the poll exit criteria.
-
- @retval EFI_CRC_ERROR 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_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 was reflected in
- the Host Status Register bit. Device
- Errors are a result of a transaction
- collision, illegal command field,
- unclaimed cycle (host initiated), or
- bus errors (collisions).
+ @retval EFI_DEVICE_ERROR The request was not completed
+ because a failure was reflected in
+ the Host Status Register bit. Device
+ Errors are a result of a transaction
+ collision, illegal command field,
+ unclaimed cycle (host initiated), or
+ bus errors (collisions).
- @retval EFI_UNSUPPORTED ArpDevice, GetArpMap, and Notify are
- not implemented by this driver.
+ @retval EFI_UNSUPPORTED ArpDevice, GetArpMap, and Notify are
+ not implemented by this driver.
**/
typedef
EFI_STATUS
-(EFIAPI *EFI_SMBUS_HC_PROTOCOL_ARP_DEVICE) (
+(EFIAPI *EFI_SMBUS_HC_PROTOCOL_ARP_DEVICE)(
IN CONST EFI_SMBUS_HC_PROTOCOL *This,
- IN CONST BOOLEAN ArpAll,
- IN CONST EFI_SMBUS_UDID *SmbusUdid, OPTIONAL
+ IN BOOLEAN ArpAll,
+ IN EFI_SMBUS_UDID *SmbusUdid, OPTIONAL
IN OUT EFI_SMBUS_DEVICE_ADDRESS *SlaveAddress OPTIONAL
);
/**
- The GetArpMap() function returns the mapping of all the SMBus devices that were enumerated
- by the SMBus host driver.
+ 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 This A pointer to the EFI_SMBUS_HC_PROTOCOL instance.
- @param Length Size of the buffer that contains the SMBus
- device map.
+ @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_SUCCESS The SMBus returned the current device map.
@retval EFI_UNSUPPORTED ArpDevice, GetArpMap, and Notify are
not implemented by this driver.
@@ -219,22 +216,28 @@ EFI_STATUS
**/
typedef
EFI_STATUS
-(EFIAPI *EFI_SMBUS_HC_PROTOCOL_GET_ARP_MAP) (
+(EFIAPI *EFI_SMBUS_HC_PROTOCOL_GET_ARP_MAP)(
IN CONST EFI_SMBUS_HC_PROTOCOL *This,
IN OUT UINTN *Length,
IN OUT EFI_SMBUS_DEVICE_MAP **SmbusDeviceMap
);
+/**
+ The notify function does some actions.
+
+ @param SlaveAddress
+ The SMBUS hardware address to which the SMBUS device is preassigned or allocated.
-
-//
-// EFI_SMBUS_NOTIFY_FUNCTION
-//
+ @param Data
+ Data of the SMBus host notify command that the caller wants to be called.
+
+ @return EFI_STATUS
+**/
typedef
EFI_STATUS
-(EFIAPI *EFI_SMBUS_NOTIFY_FUNCTION) (
- IN CONST EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
- IN CONST UINTN Data
+(EFIAPI *EFI_SMBUS_NOTIFY_FUNCTION)(
+ IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
+ IN UINTN Data
);
@@ -244,20 +247,20 @@ EFI_STATUS
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 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.
+ @param SlaveAddress Address that the host controller detects
+ as sending a message and calls all the registered function.
- @param Data Data that the host controller detects as sending
- message and calls all the registered function.
+ @param Data Data that the host controller detects as sending
+ message and calls all the registered function.
@param NotifyFunction The function to call when the bus
driver detects the SlaveAddress and
Data pair.
- @retval EFI_SUCCESS NotifyFunction was registered.
+ @retval EFI_SUCCESS NotifyFunction was registered.
@retval EFI_UNSUPPORTED ArpDevice, GetArpMap, and Notify are
not implemented by this driver.
@@ -265,36 +268,19 @@ EFI_STATUS
**/
typedef
EFI_STATUS
-(EFIAPI *EFI_SMBUS_HC_PROTOCOL_NOTIFY) (
+(EFIAPI *EFI_SMBUS_HC_PROTOCOL_NOTIFY)(
IN CONST EFI_SMBUS_HC_PROTOCOL *This,
- IN CONST EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
- IN CONST UINTN Data,
- IN CONST EFI_SMBUS_NOTIFY_FUNCTION NotifyFunction
+ IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
+ IN UINTN Data,
+ IN EFI_SMBUS_NOTIFY_FUNCTION NotifyFunction
);
-/**
- The EFI_SMBUS_HC_PROTOCOL provides SMBus host controller management and basic data
- transactions over SMBus. There is one EFI_SMBUS_HC_PROTOCOL instance for each SMBus
- host controller.
-
- @param Execute Executes the SMBus operation to an SMBus slave
- device. See the Execute() function description.
-
- @param ArpDevice Allows an SMBus 2.0 device(s) to be Address
- Resolution Protocol (ARP).
-
- @param GetArpMap Allows a driver to retrieve the address that
- was allocated by the SMBus host controller
- during enumeration/ARP. See the GetArpMap()
- function description.
-
- @param Notify Allows a driver to register for a callback
- to the SMBus host controller driver when the
- bus issues a notification to the bus
- controller driver. See the Notify() function
- description.
-**/
+///
+/// The EFI_SMBUS_HC_PROTOCOL provides SMBus host controller management and basic data
+/// transactions over SMBus. There is one EFI_SMBUS_HC_PROTOCOL instance for each SMBus
+/// host controller.
+///
struct _EFI_SMBUS_HC_PROTOCOL {
EFI_SMBUS_HC_EXECUTE_OPERATION Execute;
EFI_SMBUS_HC_PROTOCOL_ARP_DEVICE ArpDevice;