/** @file
  Private Header file for PMIC Dxe Driver

  Copyright (c) 1999 - 2017, Intel Corporation. All rights reserved.<BR>

  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.

  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

**/



#ifndef _PMIC_REG_PV_H_
#define _PMIC_REG_PV_H_

#include <Uefi/UefiBaseType.h>
#include <Base.h>
#include <Library/PmicLib.h>

///
/// PMIC device object
///
struct PmicObject {
  UINT8      I2cbus;
  UINT8      I2cSlaveAddr0;     ///< page0
  UINT8      I2cSlaveAddr1;     ///< page1
  PMIC_TYPE  PmicType;
  UINT8      (EFIAPI* PmicRead8)              (IN UINT8 BaseAddress, IN UINT8 Register);
  EFI_STATUS (EFIAPI* PmicWrite8)             (IN UINT8 BaseAddress, IN UINT8 Register, IN UINT8 Value);

  BOOLEAN    (EFIAPI* PmicProbe)              (VOID);
  EFI_STATUS (EFIAPI* PmicGetDevID)           (IN OUT UINT8 *VenId, IN OUT UINT8 *DevId);
  UINT8      (EFIAPI* PmicStepping)           (VOID);
  EFI_STATUS (EFIAPI* PmicThermInit)          (VOID);
  EFI_STATUS (EFIAPI* PmicGpioInit)           (IN VOID *PlatformInfo);
  EFI_STATUS (EFIAPI* PmicIntrInit)           (VOID);
  EFI_STATUS (EFIAPI* PmicBcuInit)            (VOID);
  EFI_STATUS (EFIAPI* PmicMiscInit)           (VOID);
  EFI_STATUS (EFIAPI* PmicVbusControl)        (IN BOOLEAN Enable);
  EFI_STATUS (EFIAPI* PmicVhostControl)       (IN BOOLEAN Enable);
  EFI_STATUS (EFIAPI* PmicBatchRegisterInit)  (IN RegInit_st *RegInit, IN UINT32 length);

  ///
  /// PUPDR interfaces
  ///
  EFI_STATUS (EFIAPI* PmicGetWakeCause)       (IN OUT UINT32 *WakeCause);
  EFI_STATUS (EFIAPI* PmicGetShutdownCause)   (IN OUT UINT32 *ShutdownCause);
  EFI_STATUS (EFIAPI* PmicGetResetSrc)        (IN OUT UINT32 *ResetSrc);
  EFI_STATUS (EFIAPI* PmicGetPwrSrcIrq)       (IN OUT UINT32 *PowerSrcIrq);
  BOOLEAN    (EFIAPI* PmicIsBatOn)            (VOID);
  BOOLEAN    (EFIAPI* PmicIsACOn)             (VOID);
  BOOLEAN    (EFIAPI* PmicVbusStatus)         (VOID);
  EFI_STATUS (EFIAPI* PmicClearShutdownCause) (VOID);
  EFI_STATUS (EFIAPI* PmicClearWakeCause)     (VOID);
  EFI_STATUS (EFIAPI* PmicClearResetSrc)      (VOID);
  UINT16     (EFIAPI* PmicGetVBAT)            (VOID);
  BOOLEAN    (EFIAPI* PmicIsPwrBtnPressed)    (VOID);
  EFI_STATUS (EFIAPI* PmicDisablePowerButton) (OUT UINT8 *ButtonHoldTime);
  EFI_STATUS (EFIAPI* PmicEnablePowerButton)  (IN UINT8  ButtonHoldTime);
  UINT16     (EFIAPI* PmicGetBatteryCap)      (VOID);
  EFI_STATUS (EFIAPI* PmicSetVDDQ)            (VOID);
  EFI_STATUS (EFIAPI* PmicChargerRead)        (IN UINT8 Offset, OUT UINT8 *Value);
  EFI_STATUS (EFIAPI* PmicChargerWrite)       (IN UINT8 Offset, IN UINT8 Value);
  EFI_STATUS (EFIAPI* PmicDetectCharger)      (OUT BOOLEAN *ChargerPresent, OUT UINT8 *ChargerType);
  EFI_STATUS (EFIAPI* PmicUSBSwitchControl)   (IN BOOLEAN Enable);
  UINT8      (EFIAPI* PmicUSBIDStatus)        (VOID);
};

#define RETURN_IF_POINTER_NULL(method, value)  { if ((NULL == gPmicObj) || (NULL == gPmicObj->method)) \
                                                 {\
                                                   DEBUG ((DEBUG_ERROR, "null function pointer\n")); \
                                                   return value; \
                                                 }\
                                               }

#endif