os_eventq.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2020 Inria
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <os/os_types.h>
 
#include "event/callback.h"
 
#ifdef __cplusplus
extern "C" {
#endif

struct os_event
{
    event_callback_t e; 
    void *arg;          
};

struct os_eventq
{
    event_queue_t q;    
};

typedef void os_event_fn(struct os_event *ev);

static inline void os_event_init(struct os_event *ev, os_event_fn * fn,
                                 void *arg)
{
    /*
     * Need to clear list_node manually since init function below does not do
     * this.
     */
    ev->e.super.list_node.next = NULL;
    event_callback_init(&ev->e, (void(*)(void *))fn, ev);
    ev->arg = arg;
}

static inline bool os_event_is_queued(struct os_event *ev)
{
    return (ev->e.super.list_node.next != NULL);
}

static inline void *os_event_get_arg(struct os_event *ev)
{
    return ev->arg;
}

static inline void os_event_set_arg(struct os_event *ev, void *arg)
{
    ev->arg = arg;
}

static inline void os_event_run(struct os_event *ev)
{
    ev->e.super.handler(&ev->e.super);
}

static inline void os_eventq_init(struct os_eventq *evq)
{
    event_queue_init_detached(&evq->q);
}

static inline int os_eventq_inited(struct os_eventq *evq)
{
    return evq->q.waiter != NULL;
}

static inline void os_eventq_deinit(struct os_eventq *evq)
{
    (void) evq;
    /* Can't deinit an eventq in RIOT */
}

static inline struct os_event * os_eventq_get(struct os_eventq *evq, os_time_t tmo)
{
    if (evq->q.waiter == NULL) {
        event_queue_claim(&evq->q);
    }
 
    if (tmo == 0) {
        return (struct os_event *)event_get(&evq->q);
    } else if (tmo == OS_WAIT_FOREVER) {
        return (struct os_event *)event_wait(&evq->q);
    } else {
        return (struct os_event *)event_wait_timeout_ztimer(&evq->q,
                                                            ZTIMER_MSEC,
                                                            (uint32_t)tmo);
    }
}

static inline struct os_event * os_eventq_get_no_wait(struct os_eventq *evq)
{
    if (evq->q.waiter == NULL) {
        event_queue_claim(&evq->q);
    }
 
    return (struct os_event *) event_get(&evq->q);
}

static inline void os_eventq_put(struct os_eventq *evq, struct os_event *ev)
{
    event_post(&evq->q, &ev->e.super);
}

static inline void os_eventq_remove(struct os_eventq *evq, struct os_event *ev)
{
    event_cancel(&evq->q, &ev->e.super);
}

static inline void os_eventq_run(struct os_eventq *evq)
{
    struct os_event *ev = os_eventq_get(evq, OS_WAIT_FOREVER);
    os_event_run(ev);
}

static inline bool os_eventq_is_empty(struct os_eventq *evq)
{
    return clist_count(&(evq->q.event_list)) == 0;
}
 
#ifdef __cplusplus
}
#endif