xref: /hal_adi-latest/MAX/Libraries/PeriphDrivers/Source/WUT/wut_reva.c

/******************************************************************************
 *
 * 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.
 *
 ******************************************************************************/

/* **** Includes **** */
#include "mxc_device.h"
#include "mxc_assert.h"
#include "wut.h"
#include "wut_reva.h"

/* **** Definitions **** */

/* **** Globals **** */

/* **** Local Variables **** */
static uint32_t wut_count;
static uint32_t wut_snapshot;

/* **** Functions **** */

/* ************************************************************************** */
void MXC_WUT_RevA_Init(mxc_wut_reva_regs_t *wut, mxc_wut_reva_pres_t pres)
{
    // Disable timer and clear settings
    wut->ctrl = 0;

    // Clear interrupt flag
    wut->intfl = MXC_F_WUT_REVA_INTFL_IRQ_CLR;

    // Set the prescaler
    wut->ctrl |= pres;

    // Initialize the compare register
    wut->cmp = 0xFFFFFFFF;

    // Initialize the local variables
    wut_count = 0;
    wut_snapshot = 0;
}

void MXC_WUT_RevA_Shutdown(mxc_wut_reva_regs_t *wut)
{
    // Disable timer and clear settings
    wut->ctrl = 0;
}

/* ************************************************************************** */
void MXC_WUT_RevA_Enable(mxc_wut_reva_regs_t *wut)
{
    wut->ctrl |= MXC_F_WUT_REVA_CTRL_TEN;
}

/* ************************************************************************** */
void MXC_WUT_RevA_Disable(mxc_wut_reva_regs_t *wut)
{
    wut->ctrl &= ~(MXC_F_WUT_REVA_CTRL_TEN);
}

/* ************************************************************************** */
void MXC_WUT_RevA_Config(mxc_wut_reva_regs_t *wut, const mxc_wut_reva_cfg_t *cfg)
{
    // Configure the timer
    uint32_t wut_ctrl = wut->ctrl;
    wut->ctrl |= (wut_ctrl & ~(MXC_F_WUT_REVA_CTRL_TMODE | MXC_F_WUT_REVA_CTRL_TPOL)) |
                 ((cfg->mode << MXC_F_WUT_REVA_CTRL_TMODE_POS) & MXC_F_WUT_REVA_CTRL_TMODE);

    wut->cnt = 0x1;

    wut->cmp = cfg->cmp_cnt;
}

/* ************************************************************************** */
uint32_t MXC_WUT_RevA_GetCompare(mxc_wut_reva_regs_t *wut)
{
    return wut->cmp;
}

/* ************************************************************************** */
uint32_t MXC_WUT_RevA_GetCapture(mxc_wut_reva_regs_t *wut)
{
    return wut->pwm;
}

/* ************************************************************************* */
uint32_t MXC_WUT_RevA_GetCount(mxc_wut_reva_regs_t *wut)
{
    return wut->cnt;
}

/* ************************************************************************* */
void MXC_WUT_RevA_IntClear(mxc_wut_reva_regs_t *wut)
{
    wut->intfl = MXC_F_WUT_REVA_INTFL_IRQ_CLR;
}

/* ************************************************************************* */
uint32_t MXC_WUT_RevA_IntStatus(mxc_wut_reva_regs_t *wut)
{
    return wut->intfl;
}

/* ************************************************************************* */
void MXC_WUT_RevA_SetCompare(mxc_wut_reva_regs_t *wut, uint32_t cmp_cnt)
{
    wut->cmp = cmp_cnt;
}

/* ************************************************************************* */
void MXC_WUT_RevA_SetCount(mxc_wut_reva_regs_t *wut, uint32_t cnt)
{
    wut->cnt = cnt;
}

/* ************************************************************************* */
int MXC_WUT_RevA_GetTicks(mxc_wut_reva_regs_t *wut, uint32_t timerClock, uint32_t time,
                          mxc_wut_reva_unit_t units, uint32_t *ticks)
{
    uint32_t unit_div0, unit_div1;
    uint32_t prescale;
    uint64_t temp_ticks;

    uint32_t wut_ctrl = wut->ctrl;

    prescale = ((wut_ctrl & MXC_F_WUT_REVA_CTRL_PRES) >> MXC_F_WUT_REVA_CTRL_PRES_POS) |
               (((wut_ctrl & MXC_F_WUT_REVA_CTRL_PRES3) >> (MXC_F_WUT_REVA_CTRL_PRES3_POS)) << 3);

    switch (units) {
    case MXC_WUT_REVA_UNIT_NANOSEC:
        unit_div0 = 1000000;
        unit_div1 = 1000;
        break;

    case MXC_WUT_REVA_UNIT_MICROSEC:
        unit_div0 = 1000;
        unit_div1 = 1000;
        break;

    case MXC_WUT_REVA_UNIT_MILLISEC:
        unit_div0 = 1;
        unit_div1 = 1000;
        break;

    case MXC_WUT_REVA_UNIT_SEC:
        unit_div0 = 1;
        unit_div1 = 1;
        break;

    default:
        return E_BAD_PARAM;
    }

    temp_ticks = (uint64_t)time * (timerClock / unit_div0) / (unit_div1 * (1 << (prescale & 0xF)));

    //make sure ticks is within a 32 bit value
    if (!(temp_ticks & 0xffffffff00000000) && (temp_ticks & 0xffffffff)) {
        *ticks = temp_ticks;
        return E_NO_ERROR;
    }

    return E_INVALID;
}

/* ************************************************************************* */
int MXC_WUT_RevA_GetTime(mxc_wut_reva_regs_t *wut, uint32_t timerClock, uint32_t ticks,
                         uint32_t *time, mxc_wut_reva_unit_t *units)
{
    uint64_t temp_time = 0;
    uint32_t wut_ctrl = wut->ctrl;
    uint32_t prescale =
        ((wut_ctrl & MXC_F_WUT_REVA_CTRL_PRES) >> MXC_F_WUT_REVA_CTRL_PRES_POS) |
        (((wut_ctrl & MXC_F_WUT_REVA_CTRL_PRES3) >> (MXC_F_WUT_REVA_CTRL_PRES3_POS)) << 3);

    temp_time = (uint64_t)ticks * 1000 * (1 << (prescale & 0xF)) / (timerClock / 1000000);

    if (!(temp_time & 0xffffffff00000000)) {
        *time = temp_time;
        *units = MXC_WUT_REVA_UNIT_NANOSEC;
        return E_NO_ERROR;
    }

    temp_time = (uint64_t)ticks * 1000 * (1 << (prescale & 0xF)) / (timerClock / 1000);

    if (!(temp_time & 0xffffffff00000000)) {
        *time = temp_time;
        *units = MXC_WUT_REVA_UNIT_MICROSEC;
        return E_NO_ERROR;
    }

    temp_time = (uint64_t)ticks * 1000 * (1 << (prescale & 0xF)) / timerClock;

    if (!(temp_time & 0xffffffff00000000)) {
        *time = temp_time;
        *units = MXC_WUT_REVA_UNIT_MILLISEC;
        return E_NO_ERROR;
    }

    temp_time = (uint64_t)ticks * (1 << (prescale & 0xF)) / timerClock;

    if (!(temp_time & 0xffffffff00000000)) {
        *time = temp_time;
        *units = MXC_WUT_REVA_UNIT_SEC;
        return E_NO_ERROR;
    }

    return E_INVALID;
}

/* ************************************************************************** */
void MXC_WUT_RevA_Edge(mxc_wut_reva_regs_t *wut)
{
    // Wait for a WUT edge
    uint32_t tmp = wut->cnt;

    while (tmp == wut->cnt) {}
}

/* ************************************************************************** */
uint32_t MXC_WUT_RevA_GetSleepTicks(mxc_wut_reva_regs_t *wut)
{
    return (wut->cnt - wut_count);
}

/* ************************************************************************** */
void MXC_WUT_RevA_Store(mxc_wut_reva_regs_t *wut)
{
    MXC_WUT_RevA_Edge(wut);
    wut_count = wut->cnt;
    wut_snapshot = wut->snapshot;
}

/* ************************************************************************** */
void MXC_WUT_RevA_RestoreBBClock(mxc_wut_reva_regs_t *wut, uint32_t dbbFreq, uint32_t timerClock)
{
    /* restore DBB clock from WUT */
    MXC_WUT_RevA_Edge(wut);
    wut->preset = wut_snapshot + (uint64_t)(wut->cnt - wut_count + 1) * dbbFreq / timerClock;
    wut->reload = 1; // arm DBB_CNT update on the next rising WUT clock
    MXC_WUT_RevA_Edge(wut);
}

/* ************************************************************************** */
void MXC_WUT_RevA_Delay_MS(mxc_wut_reva_regs_t *wut, uint32_t waitMs, uint32_t timerClock)
{
    /* assume WUT is already running */
    uint32_t tmp = wut->cnt;

    tmp += (waitMs * (timerClock / (0x1 << ((wut->ctrl & MXC_F_WUT_REVA_CTRL_PRES) >>
                                            MXC_F_WUT_REVA_CTRL_PRES_POS))) +
            500) /
           1000;

    while (wut->cnt < tmp) {}
}