timing.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_TIMING_TIMING_H_
#define ZEPHYR_INCLUDE_TIMING_TIMING_H_
 
#include <zephyr/arch/arch_interface.h>
#include <zephyr/timing/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
void soc_timing_init(void);
 
void soc_timing_start(void);
 
void soc_timing_stop(void);
 
timing_t soc_timing_counter_get(void);
 
uint64_t soc_timing_cycles_get(volatile timing_t *const start,
                               volatile timing_t *const end);
 
uint64_t soc_timing_freq_get(void);
 
uint64_t soc_timing_cycles_to_ns(uint64_t cycles);
 
uint64_t soc_timing_cycles_to_ns_avg(uint64_t cycles, uint32_t count);
 
uint32_t soc_timing_freq_get_mhz(void);
 
void board_timing_init(void);
 
void board_timing_start(void);
 
void board_timing_stop(void);
 
timing_t board_timing_counter_get(void);
 
uint64_t board_timing_cycles_get(volatile timing_t *const start,
                                 volatile timing_t *const end);
 
uint64_t board_timing_freq_get(void);
 
uint64_t board_timing_cycles_to_ns(uint64_t cycles);
 
uint64_t board_timing_cycles_to_ns_avg(uint64_t cycles, uint32_t count);
 
uint32_t board_timing_freq_get_mhz(void);
 
#ifdef CONFIG_TIMING_FUNCTIONS
 
void timing_init(void);
 
void timing_start(void);
 
void timing_stop(void);
 
static inline timing_t timing_counter_get(void)
{
#if defined(CONFIG_BOARD_HAS_TIMING_FUNCTIONS)
        return board_timing_counter_get();
#elif defined(CONFIG_SOC_HAS_TIMING_FUNCTIONS)
        return soc_timing_counter_get();
#else
        return arch_timing_counter_get();
#endif
}
 
static inline uint64_t timing_cycles_get(volatile timing_t *const start,
                                         volatile timing_t *const end)
{
#if defined(CONFIG_BOARD_HAS_TIMING_FUNCTIONS)
        return board_timing_cycles_get(start, end);
#elif defined(CONFIG_SOC_HAS_TIMING_FUNCTIONS)
        return soc_timing_cycles_get(start, end);
#else
        return arch_timing_cycles_get(start, end);
#endif
}
 
static inline uint64_t timing_freq_get(void)
{
#if defined(CONFIG_BOARD_HAS_TIMING_FUNCTIONS)
        return board_timing_freq_get();
#elif defined(CONFIG_SOC_HAS_TIMING_FUNCTIONS)
        return soc_timing_freq_get();
#else
        return arch_timing_freq_get();
#endif
}
 
static inline uint64_t timing_cycles_to_ns(uint64_t cycles)
{
#if defined(CONFIG_BOARD_HAS_TIMING_FUNCTIONS)
        return board_timing_cycles_to_ns(cycles);
#elif defined(CONFIG_SOC_HAS_TIMING_FUNCTIONS)
        return soc_timing_cycles_to_ns(cycles);
#else
        return arch_timing_cycles_to_ns(cycles);
#endif
}
 
static inline uint64_t timing_cycles_to_ns_avg(uint64_t cycles, uint32_t count)
{
#if defined(CONFIG_BOARD_HAS_TIMING_FUNCTIONS)
        return board_timing_cycles_to_ns_avg(cycles, count);
#elif defined(CONFIG_SOC_HAS_TIMING_FUNCTIONS)
        return soc_timing_cycles_to_ns_avg(cycles, count);
#else
        return arch_timing_cycles_to_ns_avg(cycles, count);
#endif
}
 
static inline uint32_t timing_freq_get_mhz(void)
{
#if defined(CONFIG_BOARD_HAS_TIMING_FUNCTIONS)
        return board_timing_freq_get_mhz();
#elif defined(CONFIG_SOC_HAS_TIMING_FUNCTIONS)
        return soc_timing_freq_get_mhz();
#else
        return arch_timing_freq_get_mhz();
#endif
}
 
#endif /* CONFIG_TIMING_FUNCTIONS */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_TIMING_TIMING_H_ */