Code Scrub for Protocol and Ppi Definition
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5564 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
lgao4
@@ -2,7 +2,7 @@
|
||||
The file provides basic SMBus host controller management
|
||||
and basic data transactions over the SMBus.
|
||||
|
||||
Copyright (c) 2006 - 2007, Intel Corporation
|
||||
Copyright (c) 2006 - 2008, 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
|
||||
@@ -34,12 +34,12 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
|
||||
the SMBus slave devices accept this transaction or that this
|
||||
function returns with error. Status Codes Returned
|
||||
|
||||
@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
|
||||
@@ -61,16 +61,16 @@ 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 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 +78,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 +110,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.
|
||||
@@ -134,57 +133,54 @@ 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 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 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 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
|
||||
@@ -198,20 +194,19 @@ EFI_STATUS
|
||||
|
||||
|
||||
/**
|
||||
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.
|
||||
@@ -225,11 +220,17 @@ EFI_STATUS
|
||||
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)(
|
||||
@@ -244,20 +245,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.
|
||||
@@ -274,12 +275,13 @@ EFI_STATUS
|
||||
|
||||
|
||||
/**
|
||||
@par Protocol 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.
|
||||
|
||||
@param Execute Executes the SMBus operation to an SMBus slave
|
||||
device. See the Execute() function description.
|
||||
@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).
|
||||
|
||||
Reference in New Issue
Block a user