sema.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 TriaGnoSys GmbH
 * SPDX-FileCopyrightText: 2015 Martine Lenders <mlenders@inf.fu-berlin.de>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
 
#include "mutex.h"
#include "ztimer.h"
 
#if IS_USED(MODULE_SEMA_DEPRECATED)
#include "ztimer64.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif

#define SEMA_CREATE(value)         { (value), SEMA_OK, MUTEX_INIT }

#define SEMA_CREATE_LOCKED()        { (0), SEMA_OK, MUTEX_INIT_LOCKED }

typedef enum {
    SEMA_OK = 0,
    SEMA_DESTROY,
} sema_state_t;

typedef struct {
    unsigned int value;             
    sema_state_t state;             
    mutex_t mutex;                  
} sema_t;

void sema_create(sema_t *sema, unsigned int value);

void sema_destroy(sema_t *sema);

static inline unsigned sema_get_value(const sema_t *sema)
{
    return sema->value;
}

int _sema_wait_ztimer(sema_t *sema, int block,
                      ztimer_clock_t *clock, uint32_t timeout);
 
#if IS_USED(MODULE_SEMA_DEPRECATED)
int _sema_wait_ztimer64(sema_t *sema, int block,
                        ztimer64_clock_t *clock, uint64_t timeout);
#endif

static inline int sema_wait(sema_t *sema)
{
    return _sema_wait_ztimer(sema, 1, NULL, 0);
}

static inline int sema_try_wait(sema_t *sema)
{
    return _sema_wait_ztimer(sema, 0, NULL, 0);
}
 
#if IS_USED(MODULE_SEMA_DEPRECATED) || defined(DOXYGEN)
static inline int sema_wait_timed(sema_t *sema, uint64_t timeout)
{
    return  _sema_wait_ztimer64(sema, (timeout != 0), ZTIMER64_USEC, timeout);
}
#endif

static inline int sema_wait_timed_ztimer(sema_t *sema,
                                         ztimer_clock_t *clock,
                                         uint32_t timeout)
{
    return _sema_wait_ztimer(sema, (timeout != 0), clock, timeout);
}

int sema_post(sema_t *sema);
 
#ifdef __cplusplus
}
#endif