api/spec/timer.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright (c) 2013-2018 Linaro Limited
 * Copyright (c) 2019-2023 Nokia
 */
 
#ifndef ODP_API_SPEC_TIMER_H_
#define ODP_API_SPEC_TIMER_H_
#include <odp/visibility_begin.h>
 
#include <odp/api/timer_types.h>
#include <odp/api/event_types.h>
#include <odp/api/pool_types.h>
#include <odp/api/queue_types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
int odp_timer_capability(odp_timer_clk_src_t clk_src, odp_timer_capability_t *capa);
 
int odp_timer_res_capability(odp_timer_clk_src_t clk_src,
                 odp_timer_res_capability_t *res_capa);
 
int odp_timer_periodic_capability(odp_timer_clk_src_t clk_src,
                  odp_timer_periodic_capability_t *capa);
 
void odp_timer_pool_param_init(odp_timer_pool_param_t *param);
 
odp_timer_pool_t odp_timer_pool_create(const char *name, const odp_timer_pool_param_t *params);
 
int odp_timer_pool_start_multi(odp_timer_pool_t timer_pool[], int num);
 
void odp_timer_pool_destroy(odp_timer_pool_t timer_pool);
 
uint64_t odp_timer_tick_to_ns(odp_timer_pool_t timer_pool, uint64_t ticks);
 
uint64_t odp_timer_ns_to_tick(odp_timer_pool_t timer_pool, uint64_t ns);
 
uint64_t odp_timer_current_tick(odp_timer_pool_t timer_pool);
 
int odp_timer_sample_ticks(odp_timer_pool_t timer_pool[], uint64_t tick[], uint64_t clk_count[],
               int num);
 
int odp_timer_pool_info(odp_timer_pool_t timer_pool,
            odp_timer_pool_info_t *info);
 
odp_timer_t odp_timer_alloc(odp_timer_pool_t timer_pool, odp_queue_t queue, const void *user_ptr);
 
int odp_timer_free(odp_timer_t timer);
 
int odp_timer_start(odp_timer_t timer, const odp_timer_start_t *start_param);
 
int odp_timer_restart(odp_timer_t timer, const odp_timer_start_t *start_param);
 
int odp_timer_periodic_start(odp_timer_t timer, const odp_timer_periodic_start_t *start_param);
 
int odp_timer_periodic_ack(odp_timer_t timer, odp_event_t tmo_ev);
 
int odp_timer_periodic_cancel(odp_timer_t timer);
 
int odp_timer_cancel(odp_timer_t timer, odp_event_t *tmo_ev);
 
odp_timeout_t odp_timeout_from_event(odp_event_t ev);
 
void odp_timeout_from_event_multi(odp_timeout_t tmo[], const odp_event_t ev[], int num);
 
odp_event_t odp_timeout_to_event(odp_timeout_t tmo);
 
odp_timer_t odp_timeout_timer(odp_timeout_t tmo);
 
uint64_t odp_timeout_tick(odp_timeout_t tmo);
 
void *odp_timeout_user_ptr(odp_timeout_t tmo);
 
void *odp_timeout_user_area(odp_timeout_t tmo);
 
odp_timeout_t odp_timeout_alloc(odp_pool_t pool);
 
int odp_timeout_alloc_multi(odp_pool_t pool, odp_timeout_t tmo[], int num);
 
void odp_timeout_free(odp_timeout_t tmo);
 
void odp_timeout_free_multi(odp_timeout_t tmo[], int num);
 
void odp_timer_pool_print(odp_timer_pool_t timer_pool);
 
void odp_timer_print(odp_timer_t timer);
 
void odp_timeout_print(odp_timeout_t tmo);
 
uint64_t odp_timer_pool_to_u64(odp_timer_pool_t timer_pool);
 
uint64_t odp_timer_to_u64(odp_timer_t timer);
 
uint64_t odp_timeout_to_u64(odp_timeout_t tmo);
 
#ifdef __cplusplus
}
#endif
 
#include <odp/visibility_end.h>
#endif