api/spec/timer_types.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2013-2018 Linaro Limited
 * Copyright (c) 2019-2026 Nokia
 */
 
#ifndef ODP_API_SPEC_TIMER_TYPES_H_
#define ODP_API_SPEC_TIMER_TYPES_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/event_types.h>
#include <odp/api/queue_types.h>
#include <odp/api/std_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum {
    ODP_TIMER_TYPE_SINGLE = 0,
 
    ODP_TIMER_TYPE_PERIODIC_BASE_MUL,
 
    ODP_TIMER_TYPE_PERIODIC_FREQ
 
} odp_timer_type_t;
 
typedef struct {
    uint64_t res_ns;
 
    uint64_t res_hz;
 
    uint64_t min_tmo;
 
    uint64_t max_tmo;
 
} odp_timer_res_capability_t;
 
typedef struct {
    odp_timer_type_t type;
 
    union {
        struct {
            odp_fract_u64_t base_freq_hz;
 
            uint64_t max_multiplier;
 
        } base_mul;
 
        struct {
            odp_fract_u64_t *freq_hz;
 
            uint32_t num;
 
        } freq;
 
    };
 
    uint64_t res_ns;
 
} odp_timer_periodic_capability_t;
 
typedef struct {
    uint32_t max_pools_combined;
 
    uint32_t max_pools;
 
    uint16_t max_priority;
 
    uint32_t max_timers;
 
    uint64_t highest_res_ns;
 
    odp_timer_res_capability_t max_res;
 
    odp_timer_res_capability_t max_tmo;
 
    odp_bool_t queue_type_sched;
 
    odp_bool_t queue_type_plain;
 
    struct {
        struct {
            uint32_t base_mul : 1;
 
            uint32_t freq : 1;
 
        } support;
 
        uint32_t max_pools;
 
        uint16_t max_priority;
 
        uint32_t max_timers;
 
        odp_fract_u64_t min_base_freq_hz;
 
        odp_fract_u64_t max_base_freq_hz;
 
        odp_fract_u64_t min_freq_hz;
 
        odp_fract_u64_t max_freq_hz;
 
        uint32_t min_pending_tmo;
 
        uint32_t max_pending_tmo;
 
    } periodic;
 
} odp_timer_capability_t;
 
typedef enum {
    ODP_CLOCK_SRC_0,
 
    ODP_CLOCK_SRC_1,
 
    ODP_CLOCK_SRC_2,
 
    ODP_CLOCK_SRC_3,
 
    ODP_CLOCK_SRC_4,
 
    ODP_CLOCK_SRC_5,
 
    ODP_CLOCK_NUM_SRC
 
} odp_timer_clk_src_t;
 
#define ODP_CLOCK_DEFAULT ODP_CLOCK_SRC_0
 
typedef enum {
    ODP_TIMER_EXP_AFTER = 0,
 
    ODP_TIMER_EXP_RELAXED
 
} odp_timer_exp_mode_t;
 
typedef struct {
    odp_timer_type_t timer_type;
 
    odp_timer_clk_src_t clk_src;
 
    odp_timer_exp_mode_t exp_mode;
 
    uint64_t res_ns;
 
    uint64_t res_hz;
 
    uint64_t min_tmo;
 
    uint64_t max_tmo;
 
    struct {
        struct {
            odp_fract_u64_t base_freq_hz;
 
            uint64_t max_multiplier;
 
        } base_mul;
 
        struct {
            const odp_fract_u64_t *freq_hz;
 
            uint32_t num;
 
        } freq;
 
        uint32_t uarea_size;
 
        uint32_t max_pending_tmo;
 
    } periodic;
 
    uint32_t num_timers;
 
    uint16_t priority;
 
    int priv;
 
} odp_timer_pool_param_t;
 
typedef struct {
    odp_queue_t queue;
 
    const void *user_ptr;
 
    struct {
        uint64_t multiplier;
 
    } base_mul;
 
    struct {
        odp_fract_u64_t freq_hz;
 
    } freq;
 
    struct {
        void (*init_fn)(void *uarea, uint32_t size, void *args, uint32_t index,
                uint32_t max_num);
 
        void *args;
 
    } uarea_init;
 
} odp_timer_periodic_param_t;
 
typedef enum {
    ODP_TIMER_TICK_REL = 0,
 
    ODP_TIMER_TICK_ABS
 
} odp_timer_tick_type_t;
 
typedef struct odp_timer_start_t {
    odp_timer_tick_type_t tick_type;
 
    uint64_t tick;
 
    odp_event_t tmo_ev;
 
} odp_timer_start_t;
 
typedef struct odp_timer_periodic_start_t {
    uint64_t first_tick;
 
} odp_timer_periodic_start_t;
 
typedef enum {
    ODP_TIMER_SUCCESS = 0,
 
    ODP_TIMER_TOO_NEAR = -1,
 
    ODP_TIMER_TOO_FAR = -2,
 
    ODP_TIMER_BUSY = -3,
 
    ODP_TIMER_FAIL = -4
 
} odp_timer_retval_t;
 
typedef struct odp_timer_tick_info_t {
    odp_fract_u64_t freq;
 
    odp_fract_u64_t nsec;
 
    odp_fract_u64_t clk_cycle;
 
} odp_timer_tick_info_t;
 
typedef struct {
    odp_timer_pool_param_t param;
 
    uint32_t cur_timers;
 
    uint32_t hwm_timers;
 
    const char *name;
 
    odp_timer_tick_info_t tick_info;
 
} odp_timer_pool_info_t;
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif