/** @file\r
- SMBUS Functions\r
+ SMBUS Functions\r
\r
- Copyright (c) 2006, 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
+ Copyright (c) 2006, 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: SmbusLib.h\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
**/\r
\r
#ifndef __SMBUS_LIB__\r
#define __SMBUS_LIB__\r
\r
-//\r
-// PEC BIT is bit 21 in SMBUS address\r
-//\r
-#define SMBUS_LIB_PEC_BIT (1 << 21)\r
+///\r
+/// PEC BIT is bit 22 in SMBUS address\r
+///\r
+#define SMBUS_LIB_PEC_BIT (1 << 22)\r
\r
/**\r
Macro that converts SMBUS slave address, SMBUS command, SMBUS data length,\r
\r
@param SlaveAddress SMBUS Slave Address. Range 0..127.\r
@param Command SMBUS Command. Range 0..255.\r
- @param Length SMBUS Data Length. Range 0..31.\r
+ @param Length SMBUS Data Length. Range 0..32.\r
@param Pec TRUE if Packet Error Checking is enabled. Otherwise FALSE.\r
\r
**/\r
( ((Pec) ? SMBUS_LIB_PEC_BIT: 0) | \\r
(((SlaveAddress) & 0x7f) << 1) | \\r
(((Command) & 0xff) << 8) | \\r
- (((Length) & 0x1f) << 16) \\r
+ (((Length) & 0x3f) << 16) \\r
)\r
\r
/**\r
SmBusQuickRead (\r
IN UINTN SmBusAddress,\r
OUT RETURN_STATUS *Status OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
Executes an SMBUS quick write command.\r
SmBusQuickWrite (\r
IN UINTN SmBusAddress,\r
OUT RETURN_STATUS *Status OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
Executes an SMBUS receive byte command.\r
SmBusReceiveByte (\r
IN UINTN SmBusAddress,\r
OUT RETURN_STATUS *Status OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
Executes an SMBUS send byte command.\r
IN UINTN SmBusAddress,\r
IN UINT8 Value,\r
OUT RETURN_STATUS *Status OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
Executes an SMBUS read data byte command.\r
SmBusReadDataByte (\r
IN UINTN SmBusAddress,\r
OUT RETURN_STATUS *Status OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
Executes an SMBUS write data byte command.\r
IN UINTN SmBusAddress,\r
IN UINT8 Value,\r
OUT RETURN_STATUS *Status OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
Executes an SMBUS read data word command.\r
SmBusReadDataWord (\r
IN UINTN SmBusAddress,\r
OUT RETURN_STATUS *Status OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
Executes an SMBUS write data word command.\r
IN UINTN SmBusAddress,\r
IN UINT16 Value,\r
OUT RETURN_STATUS *Status OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
Executes an SMBUS process call command.\r
IN UINTN SmBusAddress,\r
IN UINT16 Value,\r
OUT RETURN_STATUS *Status OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
Executes an SMBUS read block command.\r
Bytes are read from the SMBUS and stored in Buffer.\r
The number of bytes read is returned, and will never return a value larger than 32-bytes.\r
If Status is not NULL, then the status of the executed command is returned in Status.\r
- It is the caller¡¯s responsibility to make sure Buffer is large enough for the total number of bytes read.\r
+ It is the caller's responsibility to make sure Buffer is large enough for the total number of bytes read.\r
SMBUS supports a maximum transfer size of 32 bytes, so Buffer does not need to be any larger than 32 bytes.\r
If Length in SmBusAddress is not zero, then ASSERT().\r
If Buffer is NULL, then ASSERT().\r
IN UINTN SmBusAddress,\r
OUT VOID *Buffer,\r
OUT RETURN_STATUS *Status OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
Executes an SMBUS write block command.\r
IN UINTN SmBusAddress,\r
OUT VOID *Buffer,\r
OUT RETURN_STATUS *Status OPTIONAL\r
- )\r
-;\r
+ );\r
\r
/**\r
Executes an SMBUS block process call command.\r
\r
Executes an SMBUS block process call command on the SMBUS device specified by SmBusAddress.\r
The SMBUS slave address, SMBUS command, and SMBUS length fields of SmBusAddress are required.\r
- Bytes are written to the SMBUS from OutBuffer. Bytes are then read from the SMBUS into InBuffer.\r
+ Bytes are written to the SMBUS from WriteBuffer. Bytes are then read from the SMBUS into ReadBuffer.\r
If Status is not NULL, then the status of the executed command is returned in Status.\r
- It is the caller¡¯s responsibility to make sure InBuffer is large enough for the total number of bytes read.\r
+ It is the caller's responsibility to make sure ReadBuffer is large enough for the total number of bytes read.\r
SMBUS supports a maximum transfer size of 32 bytes, so Buffer does not need to be any larger than 32 bytes.\r
- If OutBuffer is NULL, then ASSERT().\r
- If InBuffer is NULL, then ASSERT().\r
+ If Length in SmBusAddress is zero or greater than 32, then ASSERT().\r
+ If WriteBuffer is NULL, then ASSERT().\r
+ If ReadBuffer is NULL, then ASSERT().\r
If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
-\r
@param SmBusAddress Address that encodes the SMBUS Slave Address,\r
SMBUS Command, SMBUS Data Length, and PEC.\r
- @param OutBuffer Pointer to the buffer of bytes to write to the SMBUS.\r
- @param InBuffer Pointer to the buffer of bytes to read from the SMBUS.\r
+ @param WriteBuffer Pointer to the buffer of bytes to write to the SMBUS.\r
+ @param ReadBuffer Pointer to the buffer of bytes to read from the SMBUS.\r
@param Status Return status for the executed command.\r
This is an optional parameter and may be NULL.\r
\r
EFIAPI\r
SmBusBlockProcessCall (\r
IN UINTN SmBusAddress,\r
- IN VOID *OutBuffer,\r
- OUT VOID *InBuffer,\r
+ IN VOID *WriteBuffer,\r
+ OUT VOID *ReadBuffer,\r
OUT RETURN_STATUS *Status OPTIONAL\r
- )\r
-;\r
+ );\r
+\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff