V1.0

2026-06-09 16:39:17 +08:00
commit 41a602f89c
3057 changed files with 771495 additions and 0 deletions
@@ -0,0 +1,105 @@
+/**
+ ****************************************************************************************
+ *
+ * @file ke_timer.h
+ *
+ * @brief This file contains the definitions used for timer management
+ *
+ * Copyright (C) RivieraWaves 2009-2015
+ *
+ *
+ ****************************************************************************************
+ */
+
+#ifndef _KE_TIMER_H_
+#define _KE_TIMER_H_
+
+/**
+ ****************************************************************************************
+ * @defgroup TIMER BT Time
+ * @ingroup KERNEL
+ * @brief Timer management module.
+ *
+ * This module implements the functions used for managing kernel timers.
+ *
+ ****************************************************************************************
+ */
+
+#include "rwip.h"                 // RW definitions
+#include "rwip_config.h"          // stack configuration
+#include "ke_msg.h"               // messaging definition
+
+
+/*
+ * DEFINITIONS
+ ****************************************************************************************
+ */
+
+
+/*
+ * TYPE DEFINITIONS
+ ****************************************************************************************
+ */
+
+
+/*
+ * FUNCTION PROTOTYPES
+ ****************************************************************************************
+ */
+
+/**
+ ****************************************************************************************
+ * @brief This function flushes all timers pending in the kernel.
+ *
+ ****************************************************************************************
+ */
+void ke_timer_flush(void);
+
+/**
+ ****************************************************************************************
+ * @brief Set a timer.
+ *
+ * The function first cancel the timer if it is already existing, then
+ * it creates a new one. The timer can be one-shot or periodic, i.e. it
+ * will be automatically set again after each trigger.
+ *
+ * When the timer expires, a message is sent to the task provided as
+ * argument, with the timer id as message id.
+ *
+ *
+ * @param[in] timer_id      Timer identifier (message identifier type).
+ * @param[in] task_id       Task identifier which will be notified
+ * @param[in] delay         Delay in time milliseconds.
+ ****************************************************************************************
+ */
+void ke_timer_set(ke_msg_id_t const timer_id, ke_task_id_t const task, uint32_t delay_ms);
+
+/**
+ ****************************************************************************************
+ * @brief Remove an registered timer.
+ *
+ * This function search for the timer identified by its id and its task id.
+ * If found it is stopped and freed, otherwise an error message is returned.
+ *
+ * @param[in] timer_id  Timer identifier.
+ * @param[in] task      Task identifier.
+ ****************************************************************************************
+ */
+void ke_timer_clear(ke_msg_id_t const timerid, ke_task_id_t const task);
+
+/**
+ ****************************************************************************************
+ * @brief Checks if a requested timer is active.
+ *
+ * This function pops the first timer from the timer queue and notifies the appropriate
+ * task by sending a kernel message. If the timer is periodic, it is set again;
+ * if it is one-shot, the timer is freed. The function checks also the next timers
+ * and process them if they have expired or are about to expire.
+ ****************************************************************************************
+ */
+bool ke_timer_active(ke_msg_id_t const timer_id, ke_task_id_t const task_id);
+
+
+/// @} TIMER
+
+#endif // _KE_TIMER_H_