647fa63f9c
This adds support for making static (ie not on the Python GC heap) soft timers. This can be useful for a board to define a custom background handler, or eventually for BLE/network processing to use instead of systick slots; it will be more efficient using soft timer for this. The main issue with using the existing code for static soft timers is that it would combine heap allocated and statically allocated soft_timer_entry_t instances in the same pairing-heap data structure. This would prevent the GC from tracing some of the heap allocated entries (because the GC won't follow pointers outside the heap). This commit makes it so that soft timer entries are explicitly marked, instead of relying on implicit marking by having the root of the pairing heap in the root pointer section. Also, on soft reset only the heap- allocated soft timers are deleted from the pairing heap, leaving the statically allocated ones. Signed-off-by: Damien George <damien@micropython.org>
60 lines
2.2 KiB
C
60 lines
2.2 KiB
C
/*
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2019 Damien P. George
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
#ifndef MICROPY_INCLUDED_STM32_SOFTTIMER_H
|
|
#define MICROPY_INCLUDED_STM32_SOFTTIMER_H
|
|
|
|
#include "py/pairheap.h"
|
|
|
|
#define SOFT_TIMER_FLAG_PY_CALLBACK (1)
|
|
#define SOFT_TIMER_FLAG_GC_ALLOCATED (2)
|
|
|
|
#define SOFT_TIMER_MODE_ONE_SHOT (1)
|
|
#define SOFT_TIMER_MODE_PERIODIC (2)
|
|
|
|
typedef struct _soft_timer_entry_t {
|
|
mp_pairheap_t pairheap;
|
|
uint16_t flags;
|
|
uint16_t mode;
|
|
uint32_t expiry_ms;
|
|
uint32_t delta_ms; // for periodic mode
|
|
union {
|
|
void (*c_callback)(struct _soft_timer_entry_t *);
|
|
mp_obj_t py_callback;
|
|
};
|
|
} soft_timer_entry_t;
|
|
|
|
extern volatile uint32_t soft_timer_next;
|
|
|
|
void soft_timer_deinit(void);
|
|
void soft_timer_handler(void);
|
|
void soft_timer_gc_mark_all(void);
|
|
|
|
void soft_timer_static_init(soft_timer_entry_t *entry, uint16_t mode, uint32_t delta_ms, void (*cb)(soft_timer_entry_t *));
|
|
void soft_timer_insert(soft_timer_entry_t *entry, uint32_t initial_delta_ms);
|
|
void soft_timer_remove(soft_timer_entry_t *entry);
|
|
|
|
#endif // MICROPY_INCLUDED_STM32_SOFTTIMER_H
|