mirror of
https://github.com/mytechnotalent/Embedded-Hacking.git
synced 2026-04-21 10:36:03 +02:00
Kevin Thomas
066c69f24b
Public function docstrings belong exclusively in .h headers per coding convention. Only static helper functions and static variables retain docstrings in .c files. Removed 413 duplicate docstrings across 185 files (15 CBM + 15 C SDK projects). All 30 projects rebuild with zero errors.
68 lines
2.3 KiB
C
68 lines
2.3 KiB
C
/**
|
|
* @file timer.c
|
|
* @brief Implementation of repeating timer driver
|
|
* @author Kevin Thomas
|
|
* @date 2025
|
|
*
|
|
* MIT License
|
|
*
|
|
* Copyright (c) 2025 Kevin Thomas
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
#include "timer.h"
|
|
#include "pico/time.h"
|
|
|
|
/** @brief Pico SDK repeating timer handle */
|
|
static repeating_timer_t g_timer;
|
|
/** @brief Flag indicating whether the timer is running */
|
|
static bool g_timer_active = false;
|
|
/** @brief User-provided timer callback function */
|
|
static timer_driver_callback_t g_user_callback = NULL;
|
|
|
|
/**
|
|
* @brief Internal repeating-timer callback that forwards to the user callback
|
|
*
|
|
* @param rt Unused repeating-timer handle provided by the SDK
|
|
* @return bool true to keep the timer running, false to cancel
|
|
*/
|
|
static bool _timer_shim(repeating_timer_t *rt) {
|
|
(void)rt;
|
|
if (g_user_callback)
|
|
return g_user_callback();
|
|
return false;
|
|
}
|
|
|
|
void timer_driver_start(int32_t period_ms, timer_driver_callback_t callback) {
|
|
if (g_timer_active) {
|
|
cancel_repeating_timer(&g_timer);
|
|
g_timer_active = false;
|
|
}
|
|
g_user_callback = callback;
|
|
g_timer_active = add_repeating_timer_ms(period_ms, _timer_shim, NULL, &g_timer);
|
|
}
|
|
|
|
void timer_driver_cancel(void) {
|
|
if (!g_timer_active)
|
|
return;
|
|
cancel_repeating_timer(&g_timer);
|
|
g_timer_active = false;
|
|
}
|