/*
|
* Copyright (c) 2019-2025 Beijing Hanwei Innovation Technology Ltd. Co. and
|
* its subsidiaries and affiliates (collectly called MKSEMI).
|
*
|
* 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, except as embedded into an MKSEMI
|
* integrated circuit in a product or a software update for such product,
|
* 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 MKSEMI nor the names of its contributors may be used
|
* to endorse or promote products derived from this software without
|
* specific prior written permission.
|
*
|
* 4. This software, with or without modification, must only be used with a
|
* MKSEMI integrated circuit.
|
*
|
* 5. Any software provided in binary form under this license must not be
|
* reverse engineered, decompiled, modified and/or disassembled.
|
*
|
* THIS SOFTWARE IS PROVIDED BY MKSEMI "AS IS" AND ANY EXPRESS OR IMPLIED
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
* MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
* DISCLAIMED. IN NO EVENT SHALL MKSEMI 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 MK_TIMER_LIST_H
|
#define MK_TIMER_LIST_H
|
#include "mk_common.h"
|
#ifdef WSF_EN
|
#include "wsf_os.h"
|
#endif
|
|
#define MK_TIMER_ONE_SHOT 0
|
#define MK_TIMER_PERIODIC 1
|
|
typedef struct mk_timer_tt
|
{
|
struct mk_timer_tt *p_next; /* @brief pointer to next timer in queue */
|
#ifdef WSF_EN
|
wsfHandlerId_t handlerId; /* @brief event handler for this timer */
|
wsfMsgHdr_t msg; /* @brief application-defined timer event parameters */
|
#endif
|
void (*fast_cb)(void); /* @brief fast callback that will be exceuted in rtc interrupt's
|
critical region, and the msg above will not be sent */
|
uint32_t ticks; /* @brief number of ticks until expiration */
|
uint32_t count; /* @brief backup initial tick count for periodic timers */
|
uint8_t mode; /* @brief one shot or periodic */
|
bool active; /* @brief true if timer has been started */
|
} mk_timer_t;
|
|
#ifdef __cplusplus
|
extern "C" {
|
#endif
|
|
void mk_timer_list_start_timer(mk_timer_t *p, uint32_t ms, uint8_t mode);
|
|
/**
|
* @brief Stop and remove a timer from timer list.
|
*
|
* @param[in] p Pointer to timer instance to stop.
|
*/
|
void mk_timer_list_stop_timer(mk_timer_t *p);
|
|
/**
|
* @brief pick the first expired timer.
|
*
|
* @param[in] Pointer to next expired timer or NULL if there are no expired timers.
|
*/
|
mk_timer_t *mk_timer_list_pick_expired(void);
|
|
/**
|
* @brief Initialize the timer list manager.
|
*/
|
void mk_timer_list_init(void);
|
|
/**
|
* @brief This function can return zero even if a timer is running, indicating a
|
* timer has expired but has not yet been serviced.
|
*
|
* @param[in] The number of ticks until the next timer expiration.
|
*/
|
uint32_t mk_timer_list_tick_left(void);
|
|
#ifdef __cplusplus
|
}
|
#endif
|
|
#endif /* MK_TIMER_LIST_H */
|
