nimble_npl_os.h

Go to the documentation of this file.

/*
 * Copyright (C) 2020 Inria
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef NIMBLE_NIMBLE_NPL_OS_H
#define NIMBLE_NIMBLE_NPL_OS_H
 
#include <stdint.h>
#include <stdbool.h>
#include "os/os.h"
#include "mcu/mcu.h"
 
#if defined(CPU_FAM_NRF51) || defined(CPU_FAM_NRF52)
#include "nrf_clock.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BLE_NPL_OS_ALIGNMENT    (OS_ALIGNMENT)
#define BLE_NPL_TIME_FOREVER    (OS_WAIT_FOREVER)
typedef uint32_t ble_npl_time_t;
typedef int32_t ble_npl_stime_t;
 
struct ble_npl_event {
    struct os_event ev;     
};
 
struct ble_npl_eventq {
    struct os_eventq evq;   
};
 
struct ble_npl_callout {
    uint32_t ticks;         
    struct os_callout co;   
};
 
struct ble_npl_mutex {
    struct os_mutex mu;     
};
 
struct ble_npl_sem {
    struct os_sem sem;      
};
 
static inline bool ble_npl_os_started(void)
{
    return true;
}
 
static inline void ble_npl_event_init(struct ble_npl_event *ev, ble_npl_event_fn *fn,
                                      void *arg)
{
    os_event_init(&ev->ev, (os_event_fn *)fn, arg);
}
 
static inline bool ble_npl_event_is_queued(struct ble_npl_event *ev)
{
    return os_event_is_queued(&ev->ev);
}
 
static inline void *ble_npl_event_get_arg(struct ble_npl_event *ev)
{
    return os_event_get_arg(&ev->ev);
}
 
static inline void ble_npl_event_set_arg(struct ble_npl_event *ev, void *arg)
{
    os_event_set_arg(&ev->ev, arg);
}
 
static inline void ble_npl_event_run(struct ble_npl_event *ev)
{
    os_event_run(&ev->ev);
}
 
static inline void ble_npl_eventq_init(struct ble_npl_eventq *evq)
{
    os_eventq_init(&evq->evq);
}
 
static inline int ble_npl_eventq_inited(struct ble_npl_eventq *evq)
{
    return os_eventq_inited(&evq->evq);
}
 
static inline void ble_npl_eventq_deinit(struct ble_npl_eventq *evq)
{
    (void)evq;
    /* Can't deinit an eventq in RIOT */
}
 
static inline struct ble_npl_event *ble_npl_eventq_get(struct ble_npl_eventq *evq,
                                                       ble_npl_time_t tmo)
{
    return (struct ble_npl_event *)os_eventq_get(&evq->evq, tmo);
}
 
static inline struct ble_npl_event *ble_npl_eventq_get_no_wait(struct ble_npl_eventq *evq)
{
    return (struct ble_npl_event *)os_eventq_get_no_wait(&evq->evq);
}
 
static inline void ble_npl_eventq_put(struct ble_npl_eventq *evq, struct ble_npl_event *ev)
{
    os_eventq_put(&evq->evq, &ev->ev);
}
 
static inline void ble_npl_eventq_remove(struct ble_npl_eventq *evq, struct ble_npl_event *ev)
{
    os_eventq_remove(&evq->evq, &ev->ev);
}
 
static inline void ble_npl_eventq_run(struct ble_npl_eventq *evq)
{
    os_eventq_run(&evq->evq);
}
 
static inline bool ble_npl_eventq_is_empty(struct ble_npl_eventq *evq)
{
    return os_eventq_is_empty(&evq->evq);
}
 
static inline ble_npl_error_t ble_npl_mutex_init(struct ble_npl_mutex *mu)
{
    return (ble_npl_error_t)os_mutex_init(&mu->mu);
}
 
static inline ble_npl_error_t ble_npl_mutex_pend(struct ble_npl_mutex *mu, ble_npl_time_t timeout)
{
    return (ble_npl_error_t)os_mutex_pend(&mu->mu, timeout);
}
 
static inline ble_npl_error_t ble_npl_mutex_release(struct ble_npl_mutex *mu)
{
    return (ble_npl_error_t)os_mutex_release(&mu->mu);
}
 
static inline ble_npl_error_t ble_npl_sem_init(struct ble_npl_sem *sem, uint16_t tokens)
{
    return (ble_npl_error_t)os_sem_init(&sem->sem, tokens);
}
 
static inline ble_npl_error_t ble_npl_sem_pend(struct ble_npl_sem *sem, ble_npl_time_t timeout)
{
    return (ble_npl_error_t)os_sem_pend(&sem->sem, timeout);
}
 
static inline ble_npl_error_t ble_npl_sem_release(struct ble_npl_sem *sem)
{
    return (ble_npl_error_t)os_sem_release(&sem->sem);
}
 
static inline uint16_t ble_npl_sem_get_count(struct ble_npl_sem *sem)
{
    return os_sem_get_count(&sem->sem);
}
 
static inline void ble_npl_callout_init(struct ble_npl_callout *c, struct ble_npl_eventq *q,
                                        ble_npl_event_fn *e_cb, void *e_arg)
{
    os_callout_init(&c->co, &q->evq, (os_event_fn *)e_cb, e_arg);
}
 
static inline ble_npl_error_t ble_npl_callout_reset(struct ble_npl_callout *c, ble_npl_time_t ticks)
{
    uint32_t state = os_hw_enter_critical();
 
    c->ticks = ztimer_now(ZTIMER_MSEC) + ticks;
    os_callout_reset(&c->co, ticks);
    os_hw_exit_critical(state);
    return BLE_NPL_OK;
}
 
static inline void ble_npl_callout_stop(struct ble_npl_callout *c)
{
    os_callout_stop(&c->co);
}
 
static inline bool ble_npl_callout_is_active(struct ble_npl_callout *c)
{
    return ztimer_is_set(ZTIMER_MSEC, &c->co.timer);
}
 
static inline ble_npl_time_t ble_npl_callout_get_ticks(struct ble_npl_callout *co)
{
    return co->ticks;
}
 
static inline ble_npl_time_t ble_npl_callout_remaining_ticks(struct ble_npl_callout *co,
                                                             ble_npl_time_t time)
{
    (void)time;
    ztimer_now_t now = ztimer_now(ZTIMER_MSEC);
    return (ble_npl_time_t)(co->ticks - now);
}
 
static inline void ble_npl_callout_set_arg(struct ble_npl_callout *co, void *arg)
{
    co->co.c_ev.arg = arg;
}
 
static inline ble_npl_time_t ble_npl_time_get(void)
{
    return os_time_get();
}
 
static inline ble_npl_error_t ble_npl_time_ms_to_ticks(uint32_t ms, ble_npl_time_t *out_ticks)
{
    return (ble_npl_error_t)os_time_ms_to_ticks(ms, out_ticks);
}
 
static inline ble_npl_error_t  ble_npl_time_ticks_to_ms(ble_npl_time_t ticks, uint32_t *out_ms)
{
    return (ble_npl_error_t)os_time_ticks_to_ms(ticks, out_ms);
}
 
static inline ble_npl_time_t ble_npl_time_ms_to_ticks32(uint32_t ms)
{
    return os_time_ms_to_ticks32(ms);
}
 
static inline ble_npl_time_t ble_npl_time_ticks_to_ms32(ble_npl_time_t ticks)
{
    return os_time_ticks_to_ms32(ticks);
}
static inline void ble_npl_time_delay(ble_npl_time_t ticks)
{
    return os_time_delay(ticks);
}
 
static inline uint32_t ble_npl_hw_enter_critical(void)
{
    return os_hw_enter_critical();
}
 
static inline void ble_npl_hw_exit_critical(uint32_t ctx)
{
    os_hw_exit_critical(ctx);
}
 
static inline bool ble_npl_hw_is_in_critical(void)
{
    return os_hw_is_in_critical();
}
 
static inline void *ble_npl_get_current_task_id(void)
{
    return (void *)(uint32_t)thread_getpid();
}
 
static inline void ble_npl_hw_set_isr(int irqn, void (*addr)(void))
{
    nrf5x_hw_set_isr(irqn, addr);
}
 
/* XXX: these functions are required to build hal_timer.c, however with the
*       default configuration they are never used... */
#if defined(CPU_FAM_NRF51) || defined(CPU_FAM_NRF52)
static inline void
nrf52_clock_hfxo_request(void)
{
    clock_hfxo_request();
}
 
static inline void
nrf52_clock_hfxo_release(void)
{
    clock_hfxo_release();
}
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* NIMBLE_NIMBLE_NPL_OS_H */