lp.h

 
/******************************************************************************
 *
 * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
 * Analog Devices, Inc.),
 * Copyright (C) 2023-2024 Analog Devices, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/
 
/* Define to prevent redundant inclusion */
#ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX78002_LP_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX78002_LP_H_
 
/* **** Includes **** */
#include <stdint.h>
#include "pwrseq_regs.h"
#include "mcr_regs.h"
#include "gcr_regs.h"
#include "lpcmp.h"
#include "gpio.h"
#include "tmr.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum { MXC_LP_V0_9 = 0, MXC_LP_V1_0, MXC_LP_V1_1 } mxc_lp_ovr_t;
 
typedef enum {
    MXC_LP_IPO = MXC_F_GCR_PM_IPO_PD,
    MXC_LP_IBRO = MXC_F_GCR_PM_IBRO_PD,
} mxc_lp_cfg_ds_pd_t;
 
void MXC_LP_EnterSleepMode(void);
 
void MXC_LP_EnterLowPowerMode(void);
 
void MXC_LP_EnterMicroPowerMode(void);
 
void MXC_LP_EnterStandbyMode(void);
 
void MXC_LP_EnterBackupMode(void);
 
void MXC_LP_EnterPowerDownMode(void);
 
void MXC_LP_SetOVR(mxc_lp_ovr_t ovr);
 
void MXC_LP_RetentionRegEnable(void);
 
void MXC_LP_RetentionRegDisable(void);
 
int MXC_LP_RetentionRegIsEnabled(void);
 
void MXC_LP_BandgapOn(void);
 
void MXC_LP_BandgapOff(void);
 
int MXC_LP_BandgapIsOn(void);
 
void MXC_LP_PORVCOREoreMonitorEnable(void);
 
void MXC_LP_PORVCOREoreMonitorDisable(void);
 
int MXC_LP_PORVCOREoreMonitorIsEnabled(void);
 
void MXC_LP_LDOEnable(void);
 
void MXC_LP_LDODisable(void);
 
int MXC_LP_LDOIsEnabled(void);
 
void MXC_LP_FastWakeupEnable(void);
 
void MXC_LP_FastWakeupDisable(void);
 
int MXC_LP_FastWakeupIsEnabled(void);
 
void MXC_LP_ClearWakeStatus(void);
 
void MXC_LP_EnableGPIOWakeup(mxc_gpio_cfg_t *wu_pins);
 
void MXC_LP_DisableGPIOWakeup(mxc_gpio_cfg_t *wu_pins);
 
void MXC_LP_EnableRTCAlarmWakeup(void);
 
void MXC_LP_DisableRTCAlarmWakeup(void);
 
void MXC_LP_EnableTimerWakeup(mxc_tmr_regs_t *tmr);
 
void MXC_LP_DisableTimerWakeup(mxc_tmr_regs_t *tmr);
 
void MXC_LP_EnableWUTAlarmWakeup(void);
 
void MXC_LP_DisableWUTAlarmWakeup(void);
 
void MXC_LP_EnableLPCMPWakeup(mxc_lpcmp_cmpsel_t cmp);
 
void MXC_LP_DisableLPCMPWakeup(mxc_lpcmp_cmpsel_t cmp);
 
int MXC_LP_ConfigDeepSleepClocks(uint32_t mask);
 
void MXC_LP_SysRam0Shutdown(void);
 
void MXC_LP_SysRam0PowerUp(void);
 
void MXC_LP_SysRam1Shutdown(void);
 
void MXC_LP_SysRam1PowerUp(void);
 
void MXC_LP_SysRam2Shutdown(void);
 
void MXC_LP_SysRam2PowerUp(void);
 
void MXC_LP_SysRam3Shutdown(void);
 
void MXC_LP_SysRam3PowerUp(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX78002_LP_H_