system_timer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015 Wind River Systems, Inc.
 * Copyright (c) 2019 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_SYSTEM_TIMER_H_
#define ZEPHYR_INCLUDE_DRIVERS_SYSTEM_TIMER_H_
 
#include <stdbool.h>
#include <zephyr/types.h>
#include <zephyr/spinlock.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SYS_CLOCK_MAX_WAIT (IS_ENABLED(CONFIG_SYSTEM_CLOCK_SLOPPY_IDLE) \
                            ? K_TICKS_FOREVER : INT_MAX)


#if defined(CONFIG_SMP) || defined(CONFIG_SPIN_VALIDATE)
k_spinlock_key_t sys_clock_lock(void);
#else
/*
 * When actual spinlocks are not needed (UP without CONFIG_SPIN_VALIDATE),
 * k_spin_lock() reduces to arch_irq_lock() and the lock argument is
 * ignored.  Inline this to avoid the overhead of an extra function
 * call for legacy drivers using sys_clock_announce().
 */
static inline k_spinlock_key_t sys_clock_lock(void)
{
        k_spinlock_key_t key;
 
        /* If this fires, a new config grew real spinlock content and
         * the #if guard above needs updating.
         */
        BUILD_ASSERT(sizeof(struct k_spinlock) <= 1);
 
        key.key = arch_irq_lock();
        return key;
}
#endif

#if defined(CONFIG_SMP) || defined(CONFIG_SPIN_VALIDATE)
void sys_clock_unlock(k_spinlock_key_t key);
#else
static inline void sys_clock_unlock(k_spinlock_key_t key)
{
        arch_irq_unlock(key.key);
}
#endif

void sys_clock_set_timeout(int32_t ticks, bool idle);

void sys_clock_idle_exit(void);

void sys_clock_announce_locked(int32_t ticks, k_spinlock_key_t key);

static inline void sys_clock_announce(int32_t ticks)
{
        sys_clock_announce_locked(ticks, sys_clock_lock());
}

uint32_t sys_clock_elapsed(void);

void sys_clock_disable(void);

uint32_t sys_clock_cycle_get_32(void);

uint64_t sys_clock_cycle_get_64(void);
 
#if defined(CONFIG_SYSTEM_CLOCK_HW_CYCLES_PER_SEC_RUNTIME_UPDATE) || defined(__DOXYGEN__)
void z_sys_clock_hw_cycles_per_sec_update(uint32_t new_hz);
#endif /* defined(CONFIG_SYSTEM_CLOCK_HW_CYCLES_PER_SEC_RUNTIME_UPDATE) || defined(__DOXYGEN__) */

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_SYSTEM_TIMER_H_ */