/* Copyright (c) 2021 Qualcomm Technologies, Inc.
 * All Rights Reserved.
 * Confidential and Proprietary - Qualcomm Technologies, Inc.
 */

/** @file IPmPon.idl */

/** @cond */
interface IPmPon {
/** @endcond */

    /**
     * @addtogroup IPmPon
     * @{
     */

    /** @cond */
    // IPmPon error codes
    error ERROR_RESET_CFG_INVALID_PARAM;
    error ERROR_RESET_CFG_ILLEGAL_WARM_RESET;
    /** @endcond */

    /**
    Configures the PowerON (PON) reset source, reset time, s1 timer, and s2 timer
    for all applicable PMICs.

    @param[in] ponResetSource Reset source type
    @param[in] ponResetTypeCfg PS_HOLD reset configure type
    @param[in] s1TimerMs S1 timer in ms for PMIC bark
    @param[in] s2TimerMs S2 timer in ms for PMIC bite

    @return
    Object_OK -- Success.\n
    ERROR_RESET_CFG_INVALID_PARAM -- Invalid parameter(s) encountered.\n
    ERROR_RESET_CFG_ILLEGAL_WARM_RESET -- Rejected warm reset cfg because
                                          debug policy disallows dumps.\n
    Object_ERROR -- Any other error encountered.
    */

    method ponResetCfg (in uint32 ponResetSource,
                        in uint32 ponResetTypeCfg,
                        in uint32 s1TimerMs,
                        in uint32 s2TimerMs);
    /** @} */ /* end_addtogroup IPmPon */
};
