RBC_GP/ab__gp__cycle__ticks_8h_source.html

#ifndef AB_GP_CYCLE_TICKS_H

#define AB_GP_CYCLE_TICKS_H


#include <stdint.h>


#include "rte/oal/mutex/rte_mutex.h"

#include "rte/utils/status/rte_status.h"

#include "rte/utils/types/rte_types.h"


#define AB_GP_CYCLE_TICKS_LOCK_TIMEOUT_MS 10U


typedef struct

{

    rte_mutex_storage_t storage;

    rte_mutex_handle_t  handle;

    uint32_t            count;

} ab_gp_cycle_ticks_t;


rte_status_t ab_gp_cycle_ticks_setup(ab_gp_cycle_ticks_t *ticks);


rte_status_t ab_gp_cycle_ticks_post(ab_gp_cycle_ticks_t *ticks);


rte_status_t ab_gp_cycle_ticks_take(ab_gp_cycle_ticks_t *ticks, uint32_t *out_pending);


rte_status_t ab_gp_cycle_ticks_teardown(ab_gp_cycle_ticks_t *ticks);


#endif /* AB_GP_CYCLE_TICKS_H */

ab_gp_cycle_ticks_take
rte_status_t ab_gp_cycle_ticks_take(ab_gp_cycle_ticks_t *ticks, uint32_t *out_pending)
Returns every pending tick and clears the count, as one critical section (cycle thread side).
Definition ab_gp_cycle_ticks.c:57

ab_gp_cycle_ticks_teardown
rte_status_t ab_gp_cycle_ticks_teardown(ab_gp_cycle_ticks_t *ticks)
Destroys the mutex. Call only when no other task can post or take any more (the posting timer is dest...
Definition ab_gp_cycle_ticks.c:83

ab_gp_cycle_ticks_setup
rte_status_t ab_gp_cycle_ticks_setup(ab_gp_cycle_ticks_t *ticks)
Creates the mutex and clears the count. Setup phase only (rte_mutex_create() is a setup-only resource...
Definition ab_gp_cycle_ticks.c:9

ab_gp_cycle_ticks_post
rte_status_t ab_gp_cycle_ticks_post(ab_gp_cycle_ticks_t *ticks)
Adds one tick (timer callback side). The count saturates at UINT32_MAX.
Definition ab_gp_cycle_ticks.c:30

ab_gp_cycle_ticks_t
Tick count and the mutex that guards it. Not volatile: every access to count holds the mutex.
Definition ab_gp_cycle_ticks.h:48

ab_gp_cycle_ticks_t::handle
rte_mutex_handle_t handle
Definition ab_gp_cycle_ticks.h:50

ab_gp_cycle_ticks_t::storage
rte_mutex_storage_t storage
Definition ab_gp_cycle_ticks.h:49

ab_gp_cycle_ticks_t::count
uint32_t count
Definition ab_gp_cycle_ticks.h:51