libplatsupport/src/plat/hifive/ltimer.c

/*
 * Copyright 2019, Data61
 * Commonwealth Scientific and Industrial Research Organisation (CSIRO)
 * ABN 41 687 119 230.
 *
 * This software may be distributed and modified according to the terms of
 * the BSD 2-Clause license. Note that NO WARRANTY is provided.
 * See "LICENSE_BSD2.txt" for details.
 *
 * @TAG(DATA61_BSD)
 */
/* Implementation of a logical timer for HiFive Unleashed platform.
 *
 * We use two pwms: one for the time and the other for timeouts.
 */
#include <platsupport/timer.h>
#include <platsupport/ltimer.h>
#include <platsupport/plat/pwm.h>
#include <platsupport/pmem.h>
#include <utils/util.h>

#include "../../ltimer.h"

enum {
    COUNTER_TIMER,
    TIMEOUT_TIMER,
    NUM_TIMERS
};

typedef struct {
    pwm_t pwm;
    void *vaddr;
} pwm_ltimer_t;

typedef struct {
    pwm_ltimer_t pwm_ltimers[NUM_TIMERS];
    irq_id_t timer_irq_ids[NUM_TIMERS];
    timer_callback_data_t callback_datas[NUM_TIMERS];
    ltimer_callback_fn_t user_callback;
    void *user_callback_token;
    ps_io_ops_t ops;
} hifive_timers_t;

static ps_irq_t irqs[] = {
    {
        .type = PS_INTERRUPT,
        .irq.number = PWM0_INTERRUPT0

    },
    {
        .type = PS_INTERRUPT,
        .irq.number = PWM1_INTERRUPT0
    },
};

static pmem_region_t pmems[] = {
    {
        .type = PMEM_TYPE_DEVICE,
        .base_addr = PWM0_PADDR,
        .length = PAGE_SIZE_4K
    },
    {
        .type = PMEM_TYPE_DEVICE,
        .base_addr = PWM1_PADDR,
        .length = PAGE_SIZE_4K
    }
};

#define N_IRQS ARRAY_SIZE(irqs)
#define N_PMEMS ARRAY_SIZE(pmems)

 size_t get_num_irqs(void *data)
{
    return N_IRQS;
}

static int get_nth_irq(void *data, size_t n, ps_irq_t *irq)
{
    assert(n < N_IRQS);

    *irq = irqs[n];
    return 0;
}

static size_t get_num_pmems(void *data)
{
    return N_PMEMS;
}

static int get_nth_pmem(void *data, size_t n, pmem_region_t *paddr)
{
    assert(n < N_PMEMS);
    *paddr = pmems[n];
    return 0;
}

static int ltimer_handle_irq(void *data, ps_irq_t *irq)
{
    assert(data != NULL);
    hifive_timers_t *timers = data;
    long irq_number = irq->irq.number;
    ltimer_event_t event;
    if (irq_number == PWM0_INTERRUPT0) {
        pwm_handle_irq(&timers->pwm_ltimers[COUNTER_TIMER].pwm, irq->irq.number);
        event = LTIMER_OVERFLOW_EVENT;
    } else if (irq_number == PWM1_INTERRUPT0) {
        pwm_handle_irq(&timers->pwm_ltimers[TIMEOUT_TIMER].pwm, irq->irq.number);
        event = LTIMER_TIMEOUT_EVENT;
    } else {
        ZF_LOGE("Invalid IRQ number: %d received.\n", irq_number);
    }

    if (timers->user_callback) {
        timers->user_callback(timers->user_callback_token, event);
    }

    return 0;
}

static int get_time(void *data, uint64_t *time)
{
    assert(data != NULL);
    assert(time != NULL);
    hifive_timers_t *timers = data;

    *time = pwm_get_time(&timers->pwm_ltimers[COUNTER_TIMER].pwm);
    return 0;
}

static int get_resolution(void *data, uint64_t *resolution)
{
    return ENOSYS;
}

static int set_timeout(void *data, uint64_t ns, timeout_type_t type)
{
    assert(data != NULL);
    hifive_timers_t *timers = data;

    switch (type) {
    case TIMEOUT_ABSOLUTE: {
        uint64_t time = pwm_get_time(&timers->pwm_ltimers[COUNTER_TIMER].pwm);
        if (time >= ns) {
            return ETIME;
        }
        return pwm_set_timeout(&timers->pwm_ltimers[TIMEOUT_TIMER].pwm, ns - time, false);
    }
    case TIMEOUT_RELATIVE:
        return pwm_set_timeout(&timers->pwm_ltimers[TIMEOUT_TIMER].pwm, ns, false);
    case TIMEOUT_PERIODIC:
        return pwm_set_timeout(&timers->pwm_ltimers[TIMEOUT_TIMER].pwm, ns, true);
    }

    return EINVAL;
}

static int reset(void *data)
{
    assert(data != NULL);
    hifive_timers_t *timers = data;
    pwm_stop(&timers->pwm_ltimers[COUNTER_TIMER].pwm);
    pwm_start(&timers->pwm_ltimers[COUNTER_TIMER].pwm);
    pwm_stop(&timers->pwm_ltimers[TIMEOUT_TIMER].pwm);
    pwm_start(&timers->pwm_ltimers[TIMEOUT_TIMER].pwm);
    return 0;
}

static void destroy(void *data)
{
    assert(data);
    hifive_timers_t *timers = data;
    for (int i = 0; i < NUM_TIMERS; i++) {
        if (timers->pwm_ltimers[i].vaddr) {
            pwm_stop(&timers->pwm_ltimers[i].pwm);
            ps_pmem_unmap(&timers->ops, pmems[i], timers->pwm_ltimers[i].vaddr);
        }
        if (timers->timer_irq_ids[i] > PS_INVALID_IRQ_ID) {
            int error = ps_irq_unregister(&timers->ops.irq_ops, timers->timer_irq_ids[i]);
            ZF_LOGF_IF(error, "Failed to unregister IRQ");
        }
    }
    ps_free(&timers->ops.malloc_ops, sizeof(timers), timers);
}

static int create_ltimer(ltimer_t *ltimer, ps_io_ops_t ops)
{
    assert(ltimer != NULL);
    ltimer->get_time = get_time;
    ltimer->get_resolution = get_resolution;
    ltimer->set_timeout = set_timeout;
    ltimer->reset = reset;
    ltimer->destroy = destroy;

    int error = ps_calloc(&ops.malloc_ops, 1, sizeof(hifive_timers_t), &ltimer->data);
    if (error) {
        return error;
    }
    assert(ltimer->data != NULL);

    return 0;
}

static int init_ltimer(ltimer_t *ltimer)
{
    assert(ltimer != NULL);
    hifive_timers_t *timers = ltimer->data;

    /* setup pwm */
    pwm_config_t config_counter = {
        .vaddr = timers->pwm_ltimers[COUNTER_TIMER].vaddr,
        .mode = UPCOUNTER,
    };
    pwm_config_t config_timeout = {
        .vaddr = timers->pwm_ltimers[TIMEOUT_TIMER].vaddr,
        .mode = TIMEOUT,
    };

    pwm_init(&timers->pwm_ltimers[COUNTER_TIMER].pwm, config_counter);
    pwm_init(&timers->pwm_ltimers[TIMEOUT_TIMER].pwm, config_timeout);
    pwm_start(&timers->pwm_ltimers[COUNTER_TIMER].pwm);
    return 0;
}

int ltimer_default_init(ltimer_t *ltimer, ps_io_ops_t ops, ltimer_callback_fn_t callback, void *callback_token)
{

    int error = ltimer_default_describe(ltimer, ops);
    if (error) {
        return error;
    }

    error = create_ltimer(ltimer, ops);
    if (error) {
        return error;
    }

    hifive_timers_t *timers = ltimer->data;
    timers->ops = ops;
    timers->user_callback = callback;
    timers->user_callback_token = callback_token;
    for (int i = 0; i < NUM_TIMERS; i++) {
        timers->timer_irq_ids[i] = PS_INVALID_IRQ_ID;
    }

    for (int i = 0; i < NUM_TIMERS; i++) {
        /* map the registers we need */
        timers->pwm_ltimers[i].vaddr = ps_pmem_map(&ops, pmems[i], false, PS_MEM_NORMAL);
        if (timers->pwm_ltimers[i].vaddr == NULL) {
            destroy(ltimer->data);
            return ENOMEM;
        }

        /* register the IRQs we need */
        timers->callback_datas[i].ltimer = ltimer;
        timers->callback_datas[i].irq = &irqs[i];
        timers->callback_datas[i].irq_handler = ltimer_handle_irq;
        timers->timer_irq_ids[i] = ps_irq_register(&ops.irq_ops, irqs[i], handle_irq_wrapper,
                                                   &timers->callback_datas[i]);
        if (timers->timer_irq_ids[i] < 0) {
            destroy(ltimer->data);
            return EIO;
        }
    }

    error = init_ltimer(ltimer);
    if (error) {
        destroy(ltimer->data);
        return error;
    }

    /* success! */
    return 0;
}

int ltimer_default_describe(ltimer_t *ltimer, ps_io_ops_t ops)
{
    if (ltimer == NULL) {
        ZF_LOGE("Timer is NULL!");
        return EINVAL;
    }

    ltimer->get_num_irqs = get_num_irqs;
    ltimer->get_nth_irq = get_nth_irq;
    ltimer->get_num_pmems = get_num_pmems;
    ltimer->get_nth_pmem = get_nth_pmem;
    return 0;
}