Use doxygen comment style for document entity such as struct, enum, variable that...

[mirror_edk2.git] / MdePkg / Include / Library / SmbusLib.h

/** @file\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
\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 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
  and PEC to a value that can be passed to the SMBUS Library functions.\r
\r
  Computes an address that is compatible with the SMBUS Library functions.\r
  The unused upper bits of SlaveAddress, Command, and Length are stripped\r
  prior to the generation of the address.\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..32.\r
  @param  Pec             TRUE if Packet Error Checking is enabled.  Otherwise FALSE.\r
\r
**/\r
#define SMBUS_LIB_ADDRESS(SlaveAddress,Command,Length,Pec)  \\r
  ( ((Pec) ? SMBUS_LIB_PEC_BIT: 0)      | \\r
    (((SlaveAddress) & 0x7f) << 1)      | \\r
    (((Command)      & 0xff) << 8)      | \\r
    (((Length)       & 0x3f) << 16)       \\r
  )\r
\r
/**\r
  Executes an SMBUS quick read command.\r
\r
  Executes an SMBUS quick read command on the SMBUS device specified by SmBusAddress.\r
  Only the SMBUS slave address field of SmBusAddress is required.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If PEC is set in SmBusAddress, then ASSERT().\r
  If Command in SmBusAddress is not zero, then ASSERT().\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
**/\r
VOID\r
EFIAPI\r
SmBusQuickRead (\r
  IN  UINTN                     SmBusAddress,\r
  OUT RETURN_STATUS             *Status       OPTIONAL\r
  );\r
\r
/**\r
  Executes an SMBUS quick write command.\r
\r
  Executes an SMBUS quick write command on the SMBUS device specified by SmBusAddress.\r
  Only the SMBUS slave address field of SmBusAddress is required.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If PEC is set in SmBusAddress, then ASSERT().\r
  If Command in SmBusAddress is not zero, then ASSERT().\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
**/\r
VOID\r
EFIAPI\r
SmBusQuickWrite (\r
  IN  UINTN                     SmBusAddress,\r
  OUT RETURN_STATUS             *Status       OPTIONAL\r
  );\r
\r
/**\r
  Executes an SMBUS receive byte command.\r
\r
  Executes an SMBUS receive byte command on the SMBUS device specified by SmBusAddress.\r
  Only the SMBUS slave address field of SmBusAddress is required.\r
  The byte received from the SMBUS is returned.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Command in SmBusAddress is not zero, then ASSERT().\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The byte received from the SMBUS.\r
\r
**/\r
UINT8\r
EFIAPI\r
SmBusReceiveByte (\r
  IN  UINTN          SmBusAddress,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  );\r
\r
/**\r
  Executes an SMBUS send byte command.\r
\r
  Executes an SMBUS send byte command on the SMBUS device specified by SmBusAddress.\r
  The byte specified by Value is sent.\r
  Only the SMBUS slave address field of SmBusAddress is required.  Value is returned.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Command in SmBusAddress is not zero, then ASSERT().\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Value           The 8-bit value to send.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The parameter of Value.\r
\r
**/\r
UINT8\r
EFIAPI\r
SmBusSendByte (\r
  IN  UINTN          SmBusAddress,\r
  IN  UINT8          Value,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  );\r
\r
/**\r
  Executes an SMBUS read data byte command.\r
\r
  Executes an SMBUS read data byte command on the SMBUS device specified by SmBusAddress.\r
  Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.\r
  The 8-bit value read from the SMBUS is returned.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The byte read from the SMBUS.\r
\r
**/\r
UINT8\r
EFIAPI\r
SmBusReadDataByte (\r
  IN  UINTN          SmBusAddress,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  );\r
\r
/**\r
  Executes an SMBUS write data byte command.\r
\r
  Executes an SMBUS write data byte command on the SMBUS device specified by SmBusAddress.\r
  The 8-bit value specified by Value is written.\r
  Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.\r
  Value is returned.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Value           The 8-bit value to write.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The parameter of Value.\r
\r
**/\r
UINT8\r
EFIAPI\r
SmBusWriteDataByte (\r
  IN  UINTN          SmBusAddress,\r
  IN  UINT8          Value,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  );\r
\r
/**\r
  Executes an SMBUS read data word command.\r
\r
  Executes an SMBUS read data word command on the SMBUS device specified by SmBusAddress.\r
  Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.\r
  The 16-bit value read from the SMBUS is returned.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
  \r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The byte read from the SMBUS.\r
\r
**/\r
UINT16\r
EFIAPI\r
SmBusReadDataWord (\r
  IN  UINTN          SmBusAddress,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  );\r
\r
/**\r
  Executes an SMBUS write data word command.\r
\r
  Executes an SMBUS write data word command on the SMBUS device specified by SmBusAddress.\r
  The 16-bit value specified by Value is written.\r
  Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.\r
  Value is returned.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Value           The 16-bit value to write.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The parameter of Value.\r
\r
**/\r
UINT16\r
EFIAPI\r
SmBusWriteDataWord (\r
  IN  UINTN          SmBusAddress,\r
  IN  UINT16         Value,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  );\r
\r
/**\r
  Executes an SMBUS process call command.\r
\r
  Executes an SMBUS process call command on the SMBUS device specified by SmBusAddress.\r
  The 16-bit value specified by Value is written.\r
  Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.\r
  The 16-bit value returned by the process call command is returned.\r
  If Status is not NULL, then the status of the executed command is returned in Status.\r
  If Length in SmBusAddress is not zero, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Value           The 16-bit value to write.\r
  @param  Status          Return status for the executed command.\r
                          This is an optional parameter and may be NULL.\r
\r
  @return The 16-bit value returned by the process call command.\r
\r
**/\r
UINT16\r
EFIAPI\r
SmBusProcessCall (\r
  IN  UINTN          SmBusAddress,\r
  IN  UINT16         Value,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  );\r
\r
/**\r
  Executes an SMBUS read block command.\r
\r
  Executes an SMBUS read block command on the SMBUS device specified by SmBusAddress.\r
  Only the SMBUS slave address and SMBUS command fields of SmBusAddress are required.\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
  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
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Buffer          Pointer to the buffer to store the bytes 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
  @return The number of bytes read.\r
\r
**/\r
UINTN\r
EFIAPI\r
SmBusReadBlock (\r
  IN  UINTN          SmBusAddress,\r
  OUT VOID           *Buffer,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  );\r
\r
/**\r
  Executes an SMBUS write block command.\r
\r
  Executes an SMBUS write block 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 Buffer.\r
  The number of bytes written 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
  If Length in SmBusAddress is zero or greater than 32, then ASSERT().\r
  If Buffer is NULL, then ASSERT().\r
  If any reserved bits of SmBusAddress are set, then ASSERT().\r
\r
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\r
  @param  Buffer          Pointer to the buffer to store the bytes 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
  @return The number of bytes written.\r
\r
**/\r
UINTN\r
EFIAPI\r
SmBusWriteBlock (\r
  IN  UINTN          SmBusAddress,\r
  OUT VOID           *Buffer,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\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 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 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 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
  @param  SmBusAddress    Address that encodes the SMBUS Slave Address,\r
                          SMBUS Command, SMBUS Data Length, and PEC.\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
  @return The number of bytes written.\r
\r
**/\r
UINTN\r
EFIAPI\r
SmBusBlockProcessCall (\r
  IN  UINTN          SmBusAddress,\r
  IN  VOID           *WriteBuffer,\r
  OUT VOID           *ReadBuffer,\r
  OUT RETURN_STATUS  *Status        OPTIONAL\r
  );\r
\r
\r
#endif\r