1 /*
2 * This file is part of the MicroPython project, http://micropython.org/
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (c) 2019 Damien P. George
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 */
26 #ifndef MICROPY_INCLUDED_STM32_SOFTTIMER_H
27 #define MICROPY_INCLUDED_STM32_SOFTTIMER_H
28
29 #include "py/pairheap.h"
30
31 #define SOFT_TIMER_FLAG_PY_CALLBACK (1)
32 #define SOFT_TIMER_FLAG_GC_ALLOCATED (2)
33
34 #define SOFT_TIMER_MODE_ONE_SHOT (1)
35 #define SOFT_TIMER_MODE_PERIODIC (2)
36
37 typedef struct _soft_timer_entry_t {
38 mp_pairheap_t pairheap;
39 uint16_t flags;
40 uint16_t mode;
41 uint32_t expiry_ms;
42 uint32_t delta_ms; // for periodic mode
43 union {
44 void (*c_callback)(struct _soft_timer_entry_t *);
45 mp_obj_t py_callback;
46 };
47 } soft_timer_entry_t;
48
49 extern volatile uint32_t soft_timer_next;
50
51 void soft_timer_deinit(void);
52 void soft_timer_handler(void);
53 void soft_timer_gc_mark_all(void);
54
55 void soft_timer_static_init(soft_timer_entry_t *entry, uint16_t mode, uint32_t delta_ms, void (*cb)(soft_timer_entry_t *));
56 void soft_timer_insert(soft_timer_entry_t *entry, uint32_t initial_delta_ms);
57 void soft_timer_remove(soft_timer_entry_t *entry);
58
59 // The timer will be reinserted into the heap so that it is called after initial_delta_ms milliseconds.
60 // After that, if it's periodic, it will continue to be called every entry->delta_ms milliseconds.
soft_timer_reinsert(soft_timer_entry_t * entry,uint32_t initial_delta_ms)61 static inline void soft_timer_reinsert(soft_timer_entry_t *entry, uint32_t initial_delta_ms) {
62 soft_timer_remove(entry);
63 soft_timer_insert(entry, initial_delta_ms);
64 }
65
66 #endif // MICROPY_INCLUDED_STM32_SOFTTIMER_H
67