2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2010-2013 Alexander Motin <mav@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer,
12 * without modification, immediately at the beginning of the file.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/kernel.h>
35 #include <sys/sysctl.h>
36 #include <sys/systm.h>
37 #include <sys/queue.h>
38 #include <sys/timeet.h>
40 #include "opt_timer.h"
42 SLIST_HEAD(et_eventtimers_list, eventtimer);
43 static struct et_eventtimers_list eventtimers = SLIST_HEAD_INITIALIZER(et_eventtimers);
45 struct mtx et_eventtimers_mtx;
46 MTX_SYSINIT(et_eventtimers_init, &et_eventtimers_mtx, "et_mtx", MTX_DEF);
48 SYSCTL_NODE(_kern, OID_AUTO, eventtimer, CTLFLAG_RW, 0, "Event timers");
49 static SYSCTL_NODE(_kern_eventtimer, OID_AUTO, et, CTLFLAG_RW, 0, "");
52 * Register a new event timer hardware.
55 et_register(struct eventtimer *et)
57 struct eventtimer *tmp, *next;
59 if (et->et_quality >= 0 || bootverbose) {
60 if (et->et_frequency == 0) {
61 printf("Event timer \"%s\" quality %d\n",
62 et->et_name, et->et_quality);
64 printf("Event timer \"%s\" "
65 "frequency %ju Hz quality %d\n",
66 et->et_name, (uintmax_t)et->et_frequency,
70 KASSERT(et->et_start, ("et_register: timer has no start function"));
71 et->et_sysctl = SYSCTL_ADD_NODE_WITH_LABEL(NULL,
72 SYSCTL_STATIC_CHILDREN(_kern_eventtimer_et), OID_AUTO, et->et_name,
73 CTLFLAG_RW, 0, "event timer description", "eventtimer");
74 SYSCTL_ADD_INT(NULL, SYSCTL_CHILDREN(et->et_sysctl), OID_AUTO,
75 "flags", CTLFLAG_RD, &(et->et_flags), 0,
76 "Event timer capabilities");
77 SYSCTL_ADD_UQUAD(NULL, SYSCTL_CHILDREN(et->et_sysctl), OID_AUTO,
78 "frequency", CTLFLAG_RD, &(et->et_frequency),
79 "Event timer base frequency");
80 SYSCTL_ADD_INT(NULL, SYSCTL_CHILDREN(et->et_sysctl), OID_AUTO,
81 "quality", CTLFLAG_RD, &(et->et_quality), 0,
82 "Goodness of event timer");
84 if (SLIST_EMPTY(&eventtimers) ||
85 SLIST_FIRST(&eventtimers)->et_quality < et->et_quality) {
86 SLIST_INSERT_HEAD(&eventtimers, et, et_all);
88 SLIST_FOREACH(tmp, &eventtimers, et_all) {
89 next = SLIST_NEXT(tmp, et_all);
90 if (next == NULL || next->et_quality < et->et_quality) {
91 SLIST_INSERT_AFTER(tmp, et, et_all);
101 * Deregister event timer hardware.
104 et_deregister(struct eventtimer *et)
108 if (et->et_deregister_cb != NULL) {
109 if ((err = et->et_deregister_cb(et, et->et_arg)) != 0)
114 SLIST_REMOVE(&eventtimers, et, eventtimer, et_all);
116 sysctl_remove_oid(et->et_sysctl, 1, 1);
121 * Change the frequency of the given timer. If it is the active timer,
122 * reconfigure it on all CPUs (reschedules all current events based on the new
126 et_change_frequency(struct eventtimer *et, uint64_t newfreq)
129 #ifndef NO_EVENTTIMERS
130 cpu_et_frequency(et, newfreq);
135 * Find free event timer hardware with specified parameters.
138 et_find(const char *name, int check, int want)
140 struct eventtimer *et = NULL;
142 SLIST_FOREACH(et, &eventtimers, et_all) {
145 if (name != NULL && strcasecmp(et->et_name, name) != 0)
147 if (name == NULL && et->et_quality < 0)
149 if ((et->et_flags & check) != want)
157 * Initialize event timer hardware. Set callbacks.
160 et_init(struct eventtimer *et, et_event_cb_t *event,
161 et_deregister_cb_t *deregister, void *arg)
170 et->et_event_cb = event;
171 et->et_deregister_cb = deregister;
177 * Start event timer hardware.
178 * first - delay before first tick.
179 * period - period of subsequent periodic ticks.
182 et_start(struct eventtimer *et, sbintime_t first, sbintime_t period)
187 KASSERT(period >= 0, ("et_start: negative period"));
188 KASSERT((et->et_flags & ET_FLAGS_PERIODIC) || period == 0,
189 ("et_start: period specified for oneshot-only timer"));
190 KASSERT((et->et_flags & ET_FLAGS_ONESHOT) || period != 0,
191 ("et_start: period not specified for periodic-only timer"));
193 if (period < et->et_min_period)
194 period = et->et_min_period;
195 else if (period > et->et_max_period)
196 period = et->et_max_period;
198 if (period == 0 || first != 0) {
199 if (first < et->et_min_period)
200 first = et->et_min_period;
201 else if (first > et->et_max_period)
202 first = et->et_max_period;
204 return (et->et_start(et, first, period));
207 /* Stop event timer hardware. */
209 et_stop(struct eventtimer *et)
215 return (et->et_stop(et));
219 /* Mark event timer hardware as broken. */
221 et_ban(struct eventtimer *et)
224 et->et_flags &= ~(ET_FLAGS_PERIODIC | ET_FLAGS_ONESHOT);
228 /* Free event timer hardware. */
230 et_free(struct eventtimer *et)
240 /* Report list of supported event timer hardware via sysctl. */
242 sysctl_kern_eventtimer_choice(SYSCTL_HANDLER_ARGS)
245 struct eventtimer *et;
248 sbuf_new(&sb, NULL, 256, SBUF_AUTOEXTEND | SBUF_INCLUDENUL);
251 SLIST_FOREACH(et, &eventtimers, et_all) {
252 if (et != SLIST_FIRST(&eventtimers))
254 sbuf_printf(&sb, "%s(%d)", et->et_name, et->et_quality);
258 error = sbuf_finish(&sb);
260 error = SYSCTL_OUT(req, sbuf_data(&sb), sbuf_len(&sb));
264 SYSCTL_PROC(_kern_eventtimer, OID_AUTO, choice,
265 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
266 0, 0, sysctl_kern_eventtimer_choice, "A", "Present event timers");