162 lines
5.3 KiB
C
Executable File
162 lines
5.3 KiB
C
Executable File
/**
|
|
* @file os_timer.h
|
|
* @author XRADIO IOT WLAN Team
|
|
*/
|
|
|
|
/*
|
|
* Copyright (C) 2017 XRADIO TECHNOLOGY CO., LTD. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the
|
|
* distribution.
|
|
* 3. Neither the name of XRADIO TECHNOLOGY CO., LTD. nor the names of
|
|
* its contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef _KERNEL_OS_OS_TIMER_H_
|
|
#define _KERNEL_OS_OS_TIMER_H_
|
|
|
|
#include "kernel/os/os_common.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** @brief Timer handle definition */
|
|
typedef OS_Handle_t OS_TimerHandle_t;
|
|
|
|
/**
|
|
* @brief Timer object definition
|
|
*/
|
|
typedef struct OS_Timer {
|
|
OS_TimerHandle_t handle;
|
|
} OS_Timer_t;
|
|
|
|
/**
|
|
* @brief Timer type definition
|
|
* - one shot timer: Timer will be in the dormant state after it expires.
|
|
* - periodic timer: Timer will auto-reload after it expires.
|
|
*/
|
|
typedef enum {
|
|
OS_TIMER_ONCE = 0, /* one shot timer */
|
|
OS_TIMER_PERIODIC = 1 /* periodic timer */
|
|
} OS_TimerType;
|
|
|
|
/** @brief Timer expire callback function definition */
|
|
typedef void (*OS_TimerCallback_t)(void *arg);
|
|
|
|
/**
|
|
* @brief Create and initialize a timer object
|
|
*
|
|
* @note Creating a timer does not start the timer running. The OS_TimerStart()
|
|
* and OS_TimerChangePeriod() API functions can all be used to start the
|
|
* timer running.
|
|
*
|
|
* @param[in] timer Pointer to the timer object
|
|
* @param[in] type Timer type
|
|
* @param[in] cb Timer expire callback function
|
|
* @param[in] arg Argument of timer expire callback function
|
|
* @param[in] periodMS Timer period in milliseconds
|
|
* @retval OS_Status, OS_OK on success
|
|
*/
|
|
OS_Status OS_TimerCreate(OS_Timer_t *timer, OS_TimerType type,
|
|
OS_TimerCallback_t cb, void *arg, OS_Time_t periodMS);
|
|
|
|
/**
|
|
* @brief Delete the timer object
|
|
* @param[in] timer Pointer to the timer object
|
|
* @retval OS_Status, OS_OK on success
|
|
*/
|
|
OS_Status OS_TimerDelete(OS_Timer_t *timer);
|
|
|
|
/**
|
|
* @brief Start a timer running.
|
|
* @note If the timer is already running, this function will re-start the timer.
|
|
* @param[in] timer Pointer to the timer object
|
|
* @retval OS_Status, OS_OK on success
|
|
*/
|
|
OS_Status OS_TimerStart(OS_Timer_t *timer);
|
|
|
|
/**
|
|
* @brief Change the period of a timer
|
|
*
|
|
* If OS_TimerChangePeriod() is used to change the period of a timer that is
|
|
* already running, then the timer will use the new period value to recalculate
|
|
* its expiry time. The recalculated expiry time will then be relative to when
|
|
* OS_TimerChangePeriod() was called, and not relative to when the timer was
|
|
* originally started.
|
|
|
|
* If OS_TimerChangePeriod() is used to change the period of a timer that is
|
|
* not already running, then the timer will use the new period value to
|
|
* calculate an expiry time, and the timer will start running.
|
|
*
|
|
* @param[in] timer Pointer to the timer object
|
|
* @retval OS_Status, OS_OK on success
|
|
*/
|
|
OS_Status OS_TimerChangePeriod(OS_Timer_t *timer, OS_Time_t periodMS);
|
|
|
|
/**
|
|
* @brief Stop a timer running.
|
|
* @param[in] timer Pointer to the timer object
|
|
* @retval OS_Status, OS_OK on success
|
|
*/
|
|
OS_Status OS_TimerStop(OS_Timer_t *timer);
|
|
|
|
/**
|
|
* @brief Check whether the timer is active or not
|
|
*
|
|
* A timer is inactive when it is in one of the following cases:
|
|
* - The timer has been created, but not started.
|
|
* - The timer is a one shot timer that has not been restarted since it
|
|
* expired.
|
|
*
|
|
* @param[in] timer Pointer to the timer object
|
|
* @return 1 on active, 0 on inactive
|
|
*/
|
|
int OS_TimerIsActive(OS_Timer_t *timer);
|
|
|
|
/**
|
|
* @brief Check whether the timer object is valid or not
|
|
* @param[in] timer Pointer to the timer object
|
|
* @return 1 on valid, 0 on invalid
|
|
*/
|
|
static __always_inline int OS_TimerIsValid(OS_Timer_t *timer)
|
|
{
|
|
return (timer->handle != OS_INVALID_HANDLE);
|
|
}
|
|
|
|
/**
|
|
* @brief Set the timer object to invalid state
|
|
* @param[in] timer Pointer to the timer object
|
|
* @return None
|
|
*/
|
|
static __always_inline void OS_TimerSetInvalid(OS_Timer_t *timer)
|
|
{
|
|
timer->handle = OS_INVALID_HANDLE;
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _KERNEL_OS_OS_TIMER_H_ */
|