X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FInclude%2FProtocol%2FSmbusHc.h;h=ed20a471785913c5ab6a512fb783e1409580b5bd;hp=4ba5b9ead527c8a37a62e2d03258f4bd762bdb7b;hb=344d057a2b539cf34420e2afad2351b45c65178e;hpb=1f08a159034549216eccfd533b50b712d944d844
diff --git a/MdePkg/Include/Protocol/SmbusHc.h b/MdePkg/Include/Protocol/SmbusHc.h
index 4ba5b9ead5..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 - 2008, 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,7 +32,7 @@ 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
@@ -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
@@ -64,8 +65,9 @@ typedef struct _EFI_SMBUS_HC_PROTOCOL EFI_SMBUS_HC_PROTOCOL;
@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.
+ 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
@@ -121,10 +123,10 @@ typedef
EFI_STATUS
(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
);
@@ -187,8 +189,8 @@ typedef
EFI_STATUS
(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
);
@@ -234,8 +236,8 @@ EFI_STATUS
typedef
EFI_STATUS
(EFIAPI *EFI_SMBUS_NOTIFY_FUNCTION)(
- IN CONST EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
- IN CONST UINTN Data
+ IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
+ IN UINTN Data
);
@@ -268,18 +270,17 @@ typedef
EFI_STATUS
(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
);
-/**
- @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.
-**/
+///
+/// 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;