From 1241e5e7e525b22a28151880cb9e78ac23766055 Mon Sep 17 00:00:00 2001 From: sigsegv7 Date: Wed, 20 Sep 2023 00:59:40 -0400 Subject: kernel: Add timer abstraction This commit introduces a new timer abstraction that is architecture-independent. It enables the registration and request of timers in a consistent and uniform manner abstracting away architectural details. Signed-off-by: sigsegv7 --- sys/include/sys/timer.h | 78 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 sys/include/sys/timer.h (limited to 'sys/include') diff --git a/sys/include/sys/timer.h b/sys/include/sys/timer.h new file mode 100644 index 0000000..0e10e05 --- /dev/null +++ b/sys/include/sys/timer.h @@ -0,0 +1,78 @@ +/* + * Copyright (c) 2023 Ian Marco Moffett and the VegaOS team. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of VegaOS nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +#ifndef _SYS_TIMER_H_ +#define _SYS_TIMER_H_ + +#include + +/* Timer IDs */ +#define TIMER_SCHED 0x00000001U /* Scheduler reserved timer */ +#define TIMER_GP 0x00000002U /* General purpose timer */ + +/* Number of timer IDs, adjust when adding timer IDs */ +#define TIMER_ID_COUNT 2 + +/* Timer registry status */ +#define TMRR_SUCCESS 0x00000000U /* Successful */ +#define TMRR_HAS_ENTRY 0x00000001U /* Already has an entry */ +#define TMRR_INVALID_TYPE 0x00000002U /* Invalid timer id */ +#define TMRR_EMPTY_ENTRY 0x00000003U /* Entry is empty */ +#define TMRR_INVALID_ARG 0x00000004U /* Invalid iface arg */ + +/* See timer ID defines */ +typedef uint8_t timer_id_t; + +/* See timer registry status */ +typedef int tmrr_status_t; + +/* + * Represents a timer, pointer fields + * are optional and may be set to NULL, therefore + * it is paramount to verify any function or general + * pointer field within this struct is checked for + * a NULL value. Fields should be NULL if the timer + * driver implementation doesn't implement support + * for a functionality. + */ +struct timer { + const char *name; /* e.g "HPET" */ + void(*msleep)(size_t ms); + void(*usleep)(size_t us); + void(*nsleep)(size_t ns); + void(*periodic_ms)(size_t ms); + void(*oneshot_ms)(size_t ms); + void(*stop)(void); +}; + +tmrr_status_t register_timer(timer_id_t id, const struct timer *tmr); +tmrr_status_t tmr_registry_overwrite(timer_id_t, const struct timer *tmr); +tmrr_status_t req_timer(timer_id_t id, struct timer *tmr_out); + +#endif /* !_SYS_TIMER_H_ */ -- cgit v1.2.3