wut.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_MAX32680_WUT_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_WUT_H_
 
/* **** Includes **** */
#include "mxc_device.h"
#include "wut_regs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    MXC_WUT_PRES_1 = MXC_S_WUT_CTRL_PRES_DIV1, 
    MXC_WUT_PRES_2 = MXC_S_WUT_CTRL_PRES_DIV2, 
    MXC_WUT_PRES_4 = MXC_S_WUT_CTRL_PRES_DIV4, 
    MXC_WUT_PRES_8 = MXC_S_WUT_CTRL_PRES_DIV8, 
    MXC_WUT_PRES_16 = MXC_S_WUT_CTRL_PRES_DIV16, 
    MXC_WUT_PRES_32 = MXC_S_WUT_CTRL_PRES_DIV32, 
    MXC_WUT_PRES_64 = MXC_S_WUT_CTRL_PRES_DIV64, 
    MXC_WUT_PRES_128 = MXC_S_WUT_CTRL_PRES_DIV128, 
    MXC_WUT_PRES_256 = MXC_F_WUT_CTRL_PRES3 |
                       MXC_S_WUT_CTRL_PRES_DIV1, 
    MXC_WUT_PRES_512 = MXC_F_WUT_CTRL_PRES3 |
                       MXC_S_WUT_CTRL_PRES_DIV2, 
    MXC_WUT_PRES_1024 = MXC_F_WUT_CTRL_PRES3 |
                        MXC_S_WUT_CTRL_PRES_DIV4, 
    MXC_WUT_PRES_2048 = MXC_F_WUT_CTRL_PRES3 |
                        MXC_S_WUT_CTRL_PRES_DIV8, 
    MXC_WUT_PRES_4096 = MXC_F_WUT_CTRL_PRES3 |
                        MXC_S_WUT_CTRL_PRES_DIV16 
} mxc_wut_pres_t;
 
typedef enum {
    MXC_WUT_MODE_ONESHOT = MXC_V_WUT_CTRL_TMODE_ONESHOT, 
    MXC_WUT_MODE_CONTINUOUS = MXC_V_WUT_CTRL_TMODE_CONTINUOUS, 
    MXC_WUT_MODE_COUNTER = MXC_V_WUT_CTRL_TMODE_COUNTER, 
    MXC_WUT_MODE_CAPTURE = MXC_V_WUT_CTRL_TMODE_CAPTURE, 
    MXC_WUT_MODE_COMPARE = MXC_V_WUT_CTRL_TMODE_COMPARE, 
    MXC_WUT_MODE_GATED = MXC_V_WUT_CTRL_TMODE_GATED, 
    MXC_WUT_MODE_CAPTURE_COMPARE =
        MXC_V_WUT_CTRL_TMODE_CAPTURECOMPARE 
} mxc_wut_mode_t;
 
typedef enum {
    MXC_WUT_UNIT_NANOSEC = 0, 
    MXC_WUT_UNIT_MICROSEC, 
    MXC_WUT_UNIT_MILLISEC, 
    MXC_WUT_UNIT_SEC 
} mxc_wut_unit_t;
 
typedef struct {
    mxc_wut_mode_t mode; 
    uint32_t cmp_cnt; 
} mxc_wut_cfg_t;
 
typedef void (*mxc_wut_complete_cb_t)(int result);
 
/* **** Definitions **** */
 
/* **** Function Prototypes **** */
 
void MXC_WUT_Init(mxc_wut_regs_t *wut, mxc_wut_pres_t pres);
 
void MXC_WUT_Shutdown(mxc_wut_regs_t *wut);
 
void MXC_WUT_Enable(mxc_wut_regs_t *wut);
 
void MXC_WUT_Disable(mxc_wut_regs_t *wut);
 
void MXC_WUT_Config(mxc_wut_regs_t *wut, const mxc_wut_cfg_t *cfg);
 
uint32_t MXC_WUT_GetCompare(mxc_wut_regs_t *wut);
 
uint32_t MXC_WUT_GetCount(mxc_wut_regs_t *wut);
 
void MXC_WUT_IntClear(mxc_wut_regs_t *wut);
 
uint32_t MXC_WUT_IntStatus(mxc_wut_regs_t *wut);
 
void MXC_WUT_SetCompare(mxc_wut_regs_t *wut, uint32_t cmp_cnt);
 
void MXC_WUT_SetCount(mxc_wut_regs_t *wut, uint32_t cnt);
 
int MXC_WUT_GetTicks(mxc_wut_regs_t *wut, uint32_t time, mxc_wut_unit_t units, uint32_t *ticks);
 
int MXC_WUT_GetTime(mxc_wut_regs_t *wut, uint32_t ticks, uint32_t *time, mxc_wut_unit_t *units);
 
void MXC_WUT_Edge(mxc_wut_regs_t *wut);
 
void MXC_WUT_Store(mxc_wut_regs_t *wut);
 
void MXC_WUT_RestoreBBClock(mxc_wut_regs_t *wut, uint32_t dbbFreq);
 
uint32_t MXC_WUT_GetSleepTicks(mxc_wut_regs_t *wut);
 
void MXC_WUT_Delay_MS(mxc_wut_regs_t *wut, uint32_t waitMs);
 
int MXC_WUT_TrimCrystal(mxc_wut_regs_t *wut);
 
int MXC_WUT_TrimCrystalAsync(mxc_wut_regs_t *wut, mxc_wut_complete_cb_t cb);
 
int MXC_WUT_TrimPending(mxc_wut_regs_t *wut);
 
int MXC_WUT_Handler(mxc_wut_regs_t *wut);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32680_WUT_H_