mirror of
https://github.com/DarkFlippers/unleashed-firmware.git
synced 2024-12-24 05:48:08 +03:00
0bc400a3ae
* Remove unnecessary checks * Sublime: never insert missing headers * Cleanup furi defines use * Cleanup startup. Cleanup linker scripts. Explicitly define all interrupts hadlers, including uninmplemented one. * Startup routine in C * Drop assembler startup * Move linker defines to stm32wb55_linker.h, cleanup naming, unify usage. Mpu: protect last 32b of main stack. Document various obscure things. * Move furi_hal_switch documentation to appropriate place, use 0x0 for updater jump. * UnitTests: move all temporary test files into tmp folder --------- Co-authored-by: SG <who.just.the.doctor@gmail.com>
111 lines
2.8 KiB
C
111 lines
2.8 KiB
C
/**
|
|
* @file timer.h
|
|
* @brief Furi software Timer API.
|
|
*/
|
|
#pragma once
|
|
|
|
#include "base.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef void (*FuriTimerCallback)(void* context);
|
|
|
|
typedef enum {
|
|
FuriTimerTypeOnce = 0, ///< One-shot timer.
|
|
FuriTimerTypePeriodic = 1 ///< Repeating timer.
|
|
} FuriTimerType;
|
|
|
|
typedef struct FuriTimer FuriTimer;
|
|
|
|
/** Allocate timer
|
|
*
|
|
* @param[in] func The callback function
|
|
* @param[in] type The timer type
|
|
* @param context The callback context
|
|
*
|
|
* @return The pointer to FuriTimer instance
|
|
*/
|
|
FuriTimer* furi_timer_alloc(FuriTimerCallback func, FuriTimerType type, void* context);
|
|
|
|
/** Free timer
|
|
*
|
|
* @param instance The pointer to FuriTimer instance
|
|
*/
|
|
void furi_timer_free(FuriTimer* instance);
|
|
|
|
/** Start timer
|
|
*
|
|
* @warning This is asynchronous call, real operation will happen as soon as
|
|
* timer service process this request.
|
|
*
|
|
* @param instance The pointer to FuriTimer instance
|
|
* @param[in] ticks The interval in ticks
|
|
*
|
|
* @return The furi status.
|
|
*/
|
|
FuriStatus furi_timer_start(FuriTimer* instance, uint32_t ticks);
|
|
|
|
/** Restart timer with previous timeout value
|
|
*
|
|
* @warning This is asynchronous call, real operation will happen as soon as
|
|
* timer service process this request.
|
|
*
|
|
* @param instance The pointer to FuriTimer instance
|
|
* @param[in] ticks The interval in ticks
|
|
*
|
|
* @return The furi status.
|
|
*/
|
|
FuriStatus furi_timer_restart(FuriTimer* instance, uint32_t ticks);
|
|
|
|
/** Stop timer
|
|
*
|
|
* @warning This is asynchronous call, real operation will happen as soon as
|
|
* timer service process this request.
|
|
*
|
|
* @param instance The pointer to FuriTimer instance
|
|
*
|
|
* @return The furi status.
|
|
*/
|
|
FuriStatus furi_timer_stop(FuriTimer* instance);
|
|
|
|
/** Is timer running
|
|
*
|
|
* @warning This cal may and will return obsolete timer state if timer
|
|
* commands are still in the queue. Please read FreeRTOS timer
|
|
* documentation first.
|
|
*
|
|
* @param instance The pointer to FuriTimer instance
|
|
*
|
|
* @return 0: not running, 1: running
|
|
*/
|
|
uint32_t furi_timer_is_running(FuriTimer* instance);
|
|
|
|
/** Get timer expire time
|
|
*
|
|
* @param instance The Timer instance
|
|
*
|
|
* @return expire tick
|
|
*/
|
|
uint32_t furi_timer_get_expire_time(FuriTimer* instance);
|
|
|
|
typedef void (*FuriTimerPendigCallback)(void* context, uint32_t arg);
|
|
|
|
void furi_timer_pending_callback(FuriTimerPendigCallback callback, void* context, uint32_t arg);
|
|
|
|
typedef enum {
|
|
FuriTimerThreadPriorityNormal, /**< Lower then other threads */
|
|
FuriTimerThreadPriorityElevated, /**< Same as other threads */
|
|
} FuriTimerThreadPriority;
|
|
|
|
/** Set Timer thread priority
|
|
*
|
|
* @param[in] priority The priority
|
|
*/
|
|
void furi_timer_set_thread_priority(FuriTimerThreadPriority priority);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|