rt-thread/bsp/k230/drivers/interdrv/wdt/drv_wdt.c

/* Copyright (c) 2023, Canaan Bright Sight Co., Ltd
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * Copyright (c) 2006-2025, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#include <rtthread.h>
#include <rtdevice.h>
#include <riscv_io.h>
#include "board.h"
#include "ioremap.h"
#include "sysctl_clk.h"
#include "drv_wdt.h"
#include <rtdbg.h>
#include <sys/ioctl.h>

struct k230_wdt_dev
{
    struct rt_watchdog_device device;
    const char *name;
    rt_ubase_t base;
    size_t size;
    sysctl_clk_node_e clk; /* clock source */
};

/* There are sixteen TOPs (timeout periods) that can be set in the watchdog. */

static const rt_uint32_t *tops;

static const rt_uint32_t k230_wdt_fix_tops[KD_WDT_NUM_TOPS] = {
    KD_WDT_FIX_TOP(0), KD_WDT_FIX_TOP(1), KD_WDT_FIX_TOP(2),
    KD_WDT_FIX_TOP(3), KD_WDT_FIX_TOP(4), KD_WDT_FIX_TOP(5),
    KD_WDT_FIX_TOP(6), KD_WDT_FIX_TOP(7), KD_WDT_FIX_TOP(8),
    KD_WDT_FIX_TOP(9), KD_WDT_FIX_TOP(10), KD_WDT_FIX_TOP(11),
    KD_WDT_FIX_TOP(12), KD_WDT_FIX_TOP(13), KD_WDT_FIX_TOP(14),
    KD_WDT_FIX_TOP(15)
};

static struct k230_wdt_timeout timeouts[KD_WDT_NUM_TOPS];
static char rmod;   /* wdt reset mode, */

static void k230_wdt_timeouts_init(struct k230_wdt_dev *dev)
{
    rt_uint32_t wdt_clk;
    rt_uint32_t time_value;
    rt_uint32_t i, t;
    rt_uint64_t msec;
    struct k230_wdt_timeout tout, *dst;
    /* caculate timeout value */
    wdt_clk = sysctl_clk_get_leaf_freq(dev->clk);

    for (i = 0; i < KD_WDT_NUM_TOPS; ++i)
    {
        tout.top_val = i;
        tout.sec = tops[i] / wdt_clk;
        msec = (rt_uint64_t)tops[i] * (rt_uint64_t)1000L;
        msec = msec / wdt_clk;
        tout.msec = msec - (rt_uint64_t)tout.sec * (rt_uint64_t)1000L;

        for (t = 0; t < i; ++t)
        {
            dst = &timeouts[t];
            if (tout.sec > dst->sec || (tout.sec == dst->sec &&
                tout.msec >= dst->msec))
                continue;
            else
                swap(*dst, tout);
        }

        timeouts[i] = tout;
    }
    rt_kprintf("watchdog timeout table init OK!\n");
}

static rt_err_t k230_wdt_feed(struct k230_wdt_dev *dev)
{
    k230_wdt_t *reg = (k230_wdt_t *)dev->base;
    reg->crr = 0x76;

    return RT_EOK;
}

static rt_err_t k230_wdt_enable(struct k230_wdt_dev *dev)
{
    k230_wdt_t *reg = (k230_wdt_t *)dev->base;
    reg->crr = 0x76;
    reg->cr |= 0x1;

    return RT_EOK;
}

static rt_err_t k230_wdt_disable(struct k230_wdt_dev *dev)
{
    k230_wdt_t *reg = (k230_wdt_t *)dev->base;
    reg->crr = 0x76;
    reg->cr &= ~0x1;

    return RT_EOK;
}

static rt_err_t k230_wdt_set_timeout(struct k230_wdt_dev *dev, rt_uint64_t timeout)
{
    k230_wdt_t *reg = (k230_wdt_t *)dev->base;
    rt_uint32_t top_val;
    rt_uint32_t i;
    rt_uint32_t time = (timeout + rmod -1) / rmod;

    for (i = 0; i < KD_WDT_NUM_TOPS; ++i)
    {
        if (timeouts[i].sec >= time)
            break;
    }

    if (i == KD_WDT_NUM_TOPS)
        --i;

    top_val = timeouts[i].top_val;

    reg->torr = (top_val << 4) | (top_val << 0);

    return RT_EOK;
}

static rt_err_t k230_wdt_get_timeout(struct k230_wdt_dev *dev, void *timeout)
{
    rt_uint64_t top_val;
    rt_uint32_t i;
    k230_wdt_t *reg = (k230_wdt_t *)dev->base;
    top_val = ((reg->torr) & 0xf);

    for (i = 0; i < KD_WDT_NUM_TOPS; ++i)
    {
        if (timeouts[i].top_val == top_val)
            break;
    }

    *((rt_uint64_t *)timeout) = timeouts[i].sec * rmod;

    return RT_EOK;
}

static rt_err_t k230_wdt_init(rt_watchdog_t *wdt)
{
    RT_ASSERT(wdt != NULL);

    struct k230_wdt_dev *dev = rt_container_of(wdt, struct k230_wdt_dev, device);
    k230_wdt_t *reg = (k230_wdt_t *)dev->base;

    reg->cr &= ~(0x01 << 1);
    reg->cr |= (0x0 << 1);      /* default set wdt reset mode */
    rmod = KD_WDT_RMOD_RESET;

    if (reg->comp_param_1 & (1 << 6))
    {
        tops = k230_wdt_fix_tops;
    }

    k230_wdt_timeouts_init(dev);

    if (!timeouts[KD_WDT_NUM_TOPS - 1].sec)
    {
        rt_kprintf("No any valid Timeout period detected\n");
        return -RT_EINVAL;
    }

    return RT_EOK;
}

static rt_err_t k230_wdt_control(rt_watchdog_t *wdt, int cmd, void *args)
{
    RT_ASSERT(wdt != NULL);

    struct k230_wdt_dev *dev = rt_container_of(wdt, struct k230_wdt_dev, device);

    switch(cmd)
    {
        case KD_DEVICE_CTRL_WDT_GET_TIMEOUT:
            k230_wdt_get_timeout(dev, args);
        break;
        case KD_DEVICE_CTRL_WDT_SET_TIMEOUT:
            k230_wdt_set_timeout(dev, *((rt_uint32_t*)args));
        break;
        case KD_DEVICE_CTRL_WDT_KEEPALIVE:
            k230_wdt_feed(dev);
        break;
        case KD_DEVICE_CTRL_WDT_START:
            k230_wdt_enable(dev);
        break;
        case RT_DEVICE_CTRL_WDT_STOP:
        case KD_DEVICE_CTRL_WDT_STOP:
            k230_wdt_disable(dev);
        break;
        default:
            return -RT_EINVAL;
    }

    return RT_EOK;
}

static struct rt_watchdog_ops k230_wdt_ops =
{
    .init = k230_wdt_init,
    .control = k230_wdt_control,
};

static struct k230_wdt_dev wdt_devices[] =
{
#ifdef BSP_USING_WDT0
    {
        .name = "wdt0",
        .base = WDT0_BASE_ADDR,
        .size = WDT0_IO_SIZE,
        .clk = SYSCTL_CLK_WDT0,
    },
#endif /* BSP_USING_WDT0 */

#ifdef BSP_USING_WDT1
    {
        .name = "wdt1",
        .base = WDT1_BASE_ADDR,
        .size = WDT1_IO_SIZE,
        .clk = SYSCTL_CLK_WDT1,
    },
#endif /* BSP_USING_WDT1 */

#if !defined(BSP_USING_WDT0) && !defined(BSP_USING_WDT1)
#error "No watchdog device defined!"
#endif
};

int rt_hw_wdt_init(void)
{
    rt_uint8_t i;
    for (i = 0; i < sizeof(wdt_devices) / sizeof(struct k230_wdt_dev); i++)
    {
        wdt_devices[i].device.ops = &k230_wdt_ops;
        wdt_devices[i].base = (rt_ubase_t)rt_ioremap((void *)wdt_devices[i].base, wdt_devices[i].size);

        if (rt_hw_watchdog_register(&wdt_devices[i].device, wdt_devices[i].name, RT_DEVICE_FLAG_RDWR, RT_NULL) != RT_EOK)
        {
            LOG_E("%s register failed!", wdt_devices[i].name);
            return -RT_ERROR;
        }
        LOG_D("%s register OK!", wdt_devices[i].name);
    }

    return RT_EOK;
}
INIT_DEVICE_EXPORT(rt_hw_wdt_init);