main_ubi_sdk v 0.1.3
This is UBI4 documentation
base_soft_timer.h File Reference
#include "stdint.h"
#include "stdbool.h"
Include dependency graph for base_soft_timer.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  soft_timer_init_struct
 Структура для инициализации soft_timer. More...
 
struct  soft_timer_handler_struct
 Внутренняя структура soft_timer. More...
 
struct  soft_timer_class_struct
 Верхнеуровневая структура soft_timer, с которой предстоит работать. More...
 

Typedefs

typedef void(* soft_timer_event_handler_t) (void *soft_timer_obj, int instance, void *p)
 
typedef void(* soft_timer_finish_handler_t) (int instance)
 
typedef void(* soft_timer_handler_t) (void *timer_obj, int instance, void *p)
 

Enumerations

enum  soft_timer_mode_enum { SOFT_TIMER_EXEC_WHILE_MODE , SOFT_TIMER_EXEC_IRQ_MODE }
 enum режимов исполнения soft_timer More...
 

Functions

void soft_timer_init (soft_timer_init_struct *init_struct, soft_timer_class_struct **soft_timer_obj)
 Функция инициализции soft_timer.
 
int create_soft_timer (soft_timer_class_struct *soft_timer_obj, soft_timer_handler_t handler, void *p, bool repeat, bool delete_on_completion, soft_timer_mode_enum handler_exec_mode)
 Функция создания нового soft_timerа
 
bool remove_soft_timer (soft_timer_class_struct *soft_timer_obj, int instance)
 Функция удаления soft_timerа
 
bool stop_soft_timer (soft_timer_class_struct *soft_timer_obj, int instance)
 Функция остановки soft_timerа
 
bool start_soft_timer (soft_timer_class_struct *soft_timer_obj, int instance, uint32_t time_ms)
 Функция запуска soft_timerа
 
void soft_timer_tick_exec (soft_timer_class_struct *soft_timer_obj)
 Функция тика soft_timer. Эту функцию нужно вызывать в прерывании таймера (или SysTick()) для работы soft_timer.
 
void timer_owerflow (soft_timer_class_struct *soft_timer_obj)
 Функция переполнения таймера.
 
bool soft_timer_is_run (soft_timer_class_struct *soft_timer_obj, int instance)
 Функция получения статуса soft_timerа.
 

Typedef Documentation

◆ soft_timer_event_handler_t

typedef void(* soft_timer_event_handler_t) (void *soft_timer_obj, int instance, void *p)

◆ soft_timer_finish_handler_t

typedef void(* soft_timer_finish_handler_t) (int instance)

◆ soft_timer_handler_t

typedef void(* soft_timer_handler_t) (void *timer_obj, int instance, void *p)