//=======================================================================
// Copyright Baptiste Wicht 2013-2018.
// Distributed under the terms of the MIT License.
// (See accompanying file LICENSE or copy at
//  http://www.opensource.org/licenses/MIT)
//=======================================================================

#ifndef TIMER_H
#define TIMER_H

#include <types.hpp>

namespace timer {

/*!
 * \brief Install the system timer
 */
void install();

/*!
 * \brief Returns a up-counter in seconds
 */
uint64_t seconds();

/*!
 * \brief Returns a up-counter in milliseconds
 */
uint64_t milliseconds();

/*!
 * \brief Let the timer know of a new tick
 */
void tick();

/*!
 * \brief Return the frequency in Hz of the current timer system.
 */
uint64_t timer_frequency();

/*!
 * \brief Sets the frequency in Hz of the current timer system.
 */
void timer_frequency(uint64_t freq);

/*!
 * \brief Returns a up-counter based on the counter frequency
 */
uint64_t counter();

/*!
 * \brief Return the frequency in Hz of the current counter system.
 */
uint64_t counter_frequency();

/*!
 * \brief Sets the frequency in Hz of the current counter system.
 */
void counter_frequency(uint64_t freq);

/*!
 * \brief Sets the function to use to get the counter value;
 */
void counter_fun(uint64_t (*fun)());

} //end of timer namespace

#endif