CORE/SERVICES/COMMON/adf/adf_os_timer.h

/*
 * Copyright (c) 2011,2017 The Linux Foundation. All rights reserved.
 *
 * Previously licensed under the ISC license by Qualcomm Atheros, Inc.
 *
 *
 * Permission to use, copy, modify, and/or distribute this software for
 * any purpose with or without fee is hereby granted, provided that the
 * above copyright notice and this permission notice appear in all
 * copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

/*
 * This file was originally distributed by Qualcomm Atheros, Inc.
 * under proprietary terms before Copyright ownership was assigned
 * to the Linux Foundation.
 */



/**
 * @ingroup adf_os_public
 * @file adf_os_timer.h
 * This file abstracts OS timers.
 */

#ifndef _ADF_OS_TIMER_H
#define _ADF_OS_TIMER_H

#include <adf_os_types.h>
#include <adf_os_timer_pvt.h>


/**
 * @brief Platform timer object
 */
typedef __adf_os_timer_t           adf_os_timer_t;
typedef __adf_os_hrtimer_t         adf_os_hrtimer_t;
typedef __adf_os_enum_hrtimer_t    adf_os_enum_hrtimer_t;

typedef adf_os_enum_hrtimer_t (*adf_os_hrtimer_func_t) (adf_os_hrtimer_t *);

/**
 * @brief Initialize a timer
 *
 * @param[in] hdl       OS handle
 * @param[in] timer     timer object pointer
 * @param[in] func      timer function
 * @param[in] context   context of timer function
 */
static inline void
adf_os_timer_init(adf_os_handle_t      hdl,
                  adf_os_timer_t      *timer,
                  adf_os_timer_func_t  func,
                  void                *arg,
                  uint8_t              type)
{
    __adf_os_timer_init(hdl, timer, func, arg, type);
}

/**
 * @brief Initialize a high resolution timer
 *
 * @param[in] hdl       OS handle
 * @param[in] timer     timer object pointer
 * @param[in] func      timer function
 */
static inline void
adf_os_hrtimer_init(adf_os_handle_t      hdl,
                  adf_os_hrtimer_t      *timer,
                  adf_os_hrtimer_func_t  func)
{
    __adf_os_hrtimer_init(hdl, timer, (__adf_os_hrtimer_func_t)func);
}

/**
 * @brief Start a one-shot timer
 *
 * @param[in] timer     timer object pointer
 * @param[in] msec      expiration period in milliseconds
 */
static inline void
adf_os_timer_start(adf_os_timer_t *timer, int msec)
{
    __adf_os_timer_start(timer, msec);
}

/**
 * @brief Start a high resolution timer
 *
 * @param[in] timer     timer object pointer
 * @param[in] msec      expiration period in nenoseconds
 */
static inline void
adf_os_hrtimer_start(adf_os_hrtimer_t *timer, uint64_t nsec)
{
    __adf_os_hrtimer_start(timer, nsec);
}

/**
 * @brief Modify existing timer to new timeout value
 *
 * @param[in] timer     timer object pointer
 * @param[in] msec      expiration period in milliseconds
 */
static inline void
adf_os_timer_mod(adf_os_timer_t *timer, int msec)
{
    __adf_os_timer_mod(timer, msec);
}

/**
 * @brief Cancel a timer
 * The function will return after any running timer completes.
 *
 * @param[in] timer     timer object pointer
 *
 * @retval    TRUE      timer was cancelled and deactived
 * @retval    FALSE     timer was cancelled but already got fired.
 */
static inline a_bool_t
adf_os_timer_cancel(adf_os_timer_t *timer)
{
    return __adf_os_timer_cancel(timer);
}

/**
 * @brief Cancel a high resolution timer
 * The function will return after any running timer completes.
 *
 * @param[in] timer     timer object pointer
 *
 * @retval    TRUE      timer was cancelled and deactived
 */
static inline a_bool_t
adf_os_hrtimer_cancel(adf_os_hrtimer_t *timer)
{
    return __adf_os_hrtimer_cancel(timer);
}

/**
 * @brief Free a timer
 * The function will return after any running timer completes.
 *
 * @param[in] timer     timer object pointer
 *
 */
static inline void
adf_os_timer_free(adf_os_timer_t *timer)
{
    __adf_os_timer_free(timer);
}

#endif