QuarkSocPkg/QncSmmDispatcher: Fix context passed to SMI handlers

[mirror_edk2.git] / QuarkSocPkg / QuarkNorthCluster / QNCInit / Dxe / QNCSmbus.h

/** @file\r
Common definitons for SMBus PEIM/DXE driver. Smbus PEI and DXE\r
modules share the same version of this file.\r
\r
Copyright (c) 2013-2015 Intel Corporation.\r
\r
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 _QNC_SMBUS_H_\r
#define _QNC_SMBUS_H_\r
\r
#include "CommonHeader.h"\r
\r
//\r
// Minimum and maximum length for SMBus bus block protocols defined in SMBus spec 2.0.\r
//\r
#define MIN_SMBUS_BLOCK_LEN               1\r
#define MAX_SMBUS_BLOCK_LEN               32\r
#define ADD_LENGTH(SmbusAddress, Length)  ((SmbusAddress) + SMBUS_LIB_ADDRESS (0, 0, (Length), FALSE))\r
\r
/**\r
  Executes an SMBus operation to an SMBus controller. Returns when either the command has been\r
  executed or an error is encountered in doing the operation.\r
\r
  The internal worker function provides a standard way to execute an operation as defined in the\r
  System Management Bus (SMBus) Specification. The resulting transaction will be either that the\r
  SMBus slave devices accept this transaction or that this function returns with error.\r
\r
  @param  SlaveAddress            The SMBus slave address of the device with which to communicate.\r
  @param  Command                 This command is transmitted by the SMBus host controller to the\r
                                  SMBus slave device and the interpretation is SMBus slave device\r
                                  specific. It can mean the offset to a list of functions inside an\r
                                  SMBus slave device. Not all operations or slave devices support\r
                                  this command's registers.\r
  @param  Operation               Signifies which particular SMBus hardware protocol instance that\r
                                  it will use to execute the SMBus transactions. This SMBus\r
                                  hardware protocol is defined by the SMBus Specification and is\r
                                  not related to EFI.\r
  @param  PecCheck                Defines if Packet Error Code (PEC) checking is required for this\r
                                  operation.\r
  @param  Length                  Signifies the number of bytes that this operation will do. The\r
                                  maximum number of bytes can be revision specific and operation\r
                                  specific. This field will contain the actual number of bytes that\r
                                  are executed for this operation. Not all operations require this\r
                                  argument.\r
  @param  Buffer                  Contains the value of data to execute to the SMBus slave device.\r
                                  Not all operations require this argument. The length of this\r
                                  buffer is identified by Length.\r
\r
  @retval EFI_SUCCESS             The last data that was returned from the access matched the poll\r
                                  exit criteria.\r
  @retval EFI_CRC_ERROR           Checksum is not correct (PEC is incorrect).\r
  @retval EFI_TIMEOUT             Timeout expired before the operation was completed. Timeout is\r
                                  determined by the SMBus host controller device.\r
  @retval EFI_OUT_OF_RESOURCES    The request could not be completed due to a lack of resources.\r
  @retval EFI_DEVICE_ERROR        The request was not completed because a failure that was\r
                                  reflected in the Host Status Register bit. Device errors are a\r
                                  result of a transaction collision, illegal command field,\r
                                  unclaimed cycle (host initiated), or bus errors (collisions).\r
  @retval EFI_INVALID_PARAMETER   Operation is not defined in EFI_SMBUS_OPERATION.\r
  @retval EFI_INVALID_PARAMETER   Length/Buffer is NULL for operations except for EfiSmbusQuickRead\r
                                  and EfiSmbusQuickWrite. Length is outside the range of valid\r
                                  values.\r
  @retval EFI_UNSUPPORTED         The SMBus operation or PEC is not supported.\r
  @retval EFI_BUFFER_TOO_SMALL    Buffer is not sufficient for this operation.\r
\r
**/\r
EFI_STATUS\r
Execute (\r
  IN     EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,\r
  IN     EFI_SMBUS_DEVICE_COMMAND Command,\r
  IN     EFI_SMBUS_OPERATION      Operation,\r
  IN     BOOLEAN                  PecCheck,\r
  IN OUT UINTN                    *Length,\r
  IN OUT VOID                     *Buffer\r
  );\r
\r
#endif\r