xref: /hal_adi-latest/MAX/Libraries/PeriphDrivers/Source/PT/pt_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.
 *
 ******************************************************************************/

#include "pt.h"
#include "gcr_regs.h"
#include "pt_reva_regs.h"
#include "ptg_reva_regs.h"
#include "pt_reva.h"

void MXC_PT_RevA_Init(mxc_ptg_reva_regs_t *ptg, mxc_clk_scale_t clk_scale)
{
    //disable all pulse trains
    ptg->enable = 0;

    //clear all interrupts
    ptg->stop_intfl = ptg->stop_intfl;
    ptg->ready_intfl = ptg->ready_intfl;
}

int MXC_PT_RevA_Shutdown(mxc_ptg_reva_regs_t *ptg, uint32_t pts)
{
    MXC_PT_RevA_Stop(ptg, pts);
    return (!(MXC_PT_RevA_IsActive(ptg, ptg->enable)));
}

int MXC_PT_RevA_Config(mxc_ptg_reva_regs_t *ptg, mxc_pt_cfg_t *cfg)
{
    uint32_t ptClock, rate;

    if (cfg == NULL || cfg->bps == 0) {
        return E_BAD_PARAM;
    }

    ptClock = PeripheralClock;

    if (ptClock == 0) {
        return E_UNINITIALIZED;
    }

    if (ptClock < (cfg->bps)) {
        return E_BAD_STATE;
    }

    //disable pulse train
    MXC_PT_RevA_Stop(ptg, 1 << cfg->channel);

    rate = (ptClock / (cfg->bps));

    if (cfg->bps > 1000000) { //To lessen the delta between generated and expected clock
        rate += 2;
    }

    mxc_pt_reva_regs_t *temp = (mxc_pt_reva_regs_t *)MXC_PT_GET_PT(cfg->channel);

    MXC_ASSERT(temp != NULL);

    temp->rate_length =
        ((rate << MXC_F_PT_REVA_RATE_LENGTH_RATE_CONTROL_POS) &
         MXC_F_PT_REVA_RATE_LENGTH_RATE_CONTROL) |
        ((cfg->ptLength << MXC_F_PT_REVA_RATE_LENGTH_MODE_POS) & MXC_F_PT_REVA_RATE_LENGTH_MODE);

    temp->train = cfg->pattern;
    temp->loop = ((cfg->loop << MXC_F_PT_REVA_LOOP_COUNT_POS) & MXC_F_PT_REVA_LOOP_COUNT) |
                 ((cfg->loopDelay << MXC_F_PT_REVA_LOOP_DELAY_POS) & MXC_F_PT_REVA_LOOP_DELAY);

    return E_NO_ERROR;
}

int MXC_PT_RevA_SqrWaveConfig(mxc_ptg_reva_regs_t *ptg, mxc_pt_cfg_t *sqwcfg, unsigned channel,
                              uint32_t freq)
{
    uint32_t rate;

    rate = 2 * freq;

    sqwcfg->channel = channel;
    sqwcfg->bps = rate;
    sqwcfg->pattern = 0;
    sqwcfg->ptLength = MXC_V_PT_REVA_RATE_LENGTH_MODE_SQUARE_WAVE;
    sqwcfg->loop = 0;
    sqwcfg->loopDelay = 0;

    return E_NO_ERROR;
}

void MXC_PT_RevA_Start(mxc_ptg_reva_regs_t *ptg, unsigned pts)
{
    ptg->enable |= pts;

    //wait for PT to start
    while ((ptg->enable & (pts)) != pts) {}
}

void MXC_PT_RevA_Stop(mxc_ptg_reva_regs_t *ptg, unsigned pts)
{
    ptg->enable &= ~pts;
}

uint32_t MXC_PT_RevA_IsActive(mxc_ptg_reva_regs_t *ptg, uint32_t pts)
{
    return !!(ptg->enable & pts);
}

void MXC_PT_RevA_SetPattern(unsigned pts, uint32_t pattern)
{
    mxc_pt_reva_regs_t *temp;
    uint32_t pt;

    for (uint8_t i = 0; i < 32 && (pts >> i) > 0; i++) {
        pt = 1 << i;

        if (pts & pt) {
            temp = (mxc_pt_reva_regs_t *)MXC_PT_GET_PT(i);
            MXC_ASSERT(temp);
            temp->train = pattern;
        }
    }
}

void MXC_PT_RevA_EnableInt(mxc_ptg_reva_regs_t *ptg, uint32_t pts)
{
    MXC_PT_RevA_EnableStopInt(ptg, pts);
}

void MXC_PT_RevA_DisableInt(mxc_ptg_reva_regs_t *ptg, uint32_t pts)
{
    MXC_PT_RevA_DisableStopInt(ptg, pts);
}

uint32_t MXC_PT_RevA_GetFlags(mxc_ptg_reva_regs_t *ptg)
{
    return MXC_PT_RevA_GetStopFlags(ptg);
}

void MXC_PT_RevA_ClearFlags(mxc_ptg_reva_regs_t *ptg, uint32_t flags)
{
    MXC_PT_RevA_ClearStopFlags(ptg, flags);
}

void MXC_PT_RevA_EnableStopInt(mxc_ptg_reva_regs_t *ptg, uint32_t pts)
{
    ptg->stop_inten |= pts;
}

void MXC_PT_RevA_DisableStopInt(mxc_ptg_reva_regs_t *ptg, uint32_t pts)
{
    ptg->stop_inten &= ~pts;
}

uint32_t MXC_PT_RevA_GetStopFlags(mxc_ptg_reva_regs_t *ptg)
{
    return ptg->stop_intfl;
}

void MXC_PT_RevA_ClearStopFlags(mxc_ptg_reva_regs_t *ptg, uint32_t flags)
{
    ptg->stop_intfl = flags;
}

void MXC_PT_RevA_EnableReadyInt(mxc_ptg_reva_regs_t *ptg, uint32_t pts)
{
    ptg->ready_inten |= pts;
}

void MXC_PT_RevA_DisableReadyInt(mxc_ptg_reva_regs_t *ptg, uint32_t pts)
{
    ptg->ready_inten &= ~pts;
}

uint32_t MXC_PT_RevA_GetReadyFlags(mxc_ptg_reva_regs_t *ptg)
{
    return ptg->ready_intfl;
}

void MXC_PT_RevA_ClearReadyFlags(mxc_ptg_reva_regs_t *ptg, uint32_t flags)
{
    ptg->ready_intfl = flags;
}

void MXC_PT_RevA_EnableRestart(unsigned start, unsigned stop, uint8_t restartIndex)
{
    mxc_pt_reva_regs_t *temp = (mxc_pt_reva_regs_t *)MXC_PT_GET_PT(start);
    MXC_ASSERT(temp);

    if (restartIndex) {
        temp->restart |= (stop << MXC_F_PT_REVA_RESTART_PT_Y_SELECT_POS) |
                         MXC_F_PT_REVA_RESTART_ON_PT_Y_LOOP_EXIT;
    } else {
        temp->restart |= (stop << MXC_F_PT_REVA_RESTART_PT_X_SELECT_POS) |
                         MXC_F_PT_REVA_RESTART_ON_PT_X_LOOP_EXIT;
    }
}

void MXC_PT_RevA_DisableRestart(unsigned channel, uint8_t restartIndex)
{
    mxc_pt_reva_regs_t *temp = (mxc_pt_reva_regs_t *)MXC_PT_GET_PT(channel);
    MXC_ASSERT(temp);

    if (restartIndex) {
        temp->restart &= ~MXC_F_PT_REVA_RESTART_ON_PT_Y_LOOP_EXIT;
    } else {
        temp->restart &= ~MXC_F_PT_REVA_RESTART_ON_PT_X_LOOP_EXIT;
    }
}

void MXC_PT_RevA_Resync(mxc_ptg_reva_regs_t *ptg, uint32_t pts)
{
    // Set the PT to be synced
    ptg->resync |= pts;

    // Wait for them to sync
    while (ptg->resync & pts) {}
}