mirror of
https://github.com/smaeul/u-boot.git
synced 2025-10-31 03:58:17 +00:00
008c4b3c31
There are of course not a whole lot of examples in-tree yet, but
before they appear, let's make this API change: Instead of separately
allocating a 'struct cyclic_info', make the users embed such an
instance in their own structure, and make the convention that the
callback simply receives the 'struct cyclic_info *', from which the
clients can get their own data using the container_of() macro.
This has a number of advantages.
First, it means cyclic_register() simply cannot fail, simplifying the
code. The necessary storage will simply be allocated automatically
when the client's own structure is allocated (often via
uclass_priv_auto or similar).
Second, code for which CONFIG_CYCLIC is just an option can more easily
be written without #ifdefs, if we just provide an empty struct
cyclic_info {}. For example, the nested CONFIG_IS_ENABLED()s in
https://lore.kernel.org/u-boot/20240316201416.211480-1-marek.vasut+renesas@mailbox.org/
are mostly due to the existence of the 'struct cyclic_info *' member
being guarded by #ifdef CONFIG_CYCLIC.
And we do probably want to avoid the extra memory overhead of that
member when !CONFIG_CYCLIC. But that is automatic if, instead of a
'struct cyclic_info *', one simply embeds a 'struct cyclic_info',
which will have size 0 when !CONFIG_CYCLIC. Also, the no-op
cyclic_register() function can just unconditionally be called, and the
compiler will see that (1) the callback is referenced, so not emit a
warning for a maybe-unused function and (2) see that it can actually
never be reached, so not emit any code for it.
Reviewed-by: Stefan Roese <sr@denx.de>
Signed-off-by: Rasmus Villemoes <rasmus.villemoes@prevas.dk>
85 lines
2.2 KiB
C
85 lines
2.2 KiB
C
// SPDX-License-Identifier: GPL-2.0+
|
|
/*
|
|
* A general-purpose cyclic execution infrastructure, to allow "small"
|
|
* (run-time wise) functions to be executed at a specified frequency.
|
|
* Things like LED blinking or watchdog triggering are examples for such
|
|
* tasks.
|
|
*
|
|
* Copyright (C) 2022 Stefan Roese <sr@denx.de>
|
|
*/
|
|
|
|
#include <command.h>
|
|
#include <cyclic.h>
|
|
#include <div64.h>
|
|
#include <malloc.h>
|
|
#include <time.h>
|
|
#include <vsprintf.h>
|
|
#include <linux/delay.h>
|
|
#include <linux/kernel.h>
|
|
|
|
struct cyclic_demo_info {
|
|
struct cyclic_info cyclic;
|
|
uint delay_us;
|
|
};
|
|
|
|
static void cyclic_demo(struct cyclic_info *c)
|
|
{
|
|
struct cyclic_demo_info *info = container_of(c, struct cyclic_demo_info, cyclic);
|
|
|
|
/* Just a small dummy delay here */
|
|
udelay(info->delay_us);
|
|
}
|
|
|
|
static int do_cyclic_demo(struct cmd_tbl *cmdtp, int flag, int argc,
|
|
char *const argv[])
|
|
{
|
|
struct cyclic_demo_info *info;
|
|
uint time_ms;
|
|
|
|
if (argc < 3)
|
|
return CMD_RET_USAGE;
|
|
|
|
info = malloc(sizeof(struct cyclic_demo_info));
|
|
if (!info) {
|
|
printf("out of memory\n");
|
|
return CMD_RET_FAILURE;
|
|
}
|
|
|
|
time_ms = simple_strtoul(argv[1], NULL, 0);
|
|
info->delay_us = simple_strtoul(argv[2], NULL, 0);
|
|
|
|
/* Register demo cyclic function */
|
|
cyclic_register(&info->cyclic, cyclic_demo, time_ms * 1000, "cyclic_demo");
|
|
|
|
printf("Registered function \"%s\" to be executed all %dms\n",
|
|
"cyclic_demo", time_ms);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int do_cyclic_list(struct cmd_tbl *cmdtp, int flag, int argc,
|
|
char *const argv[])
|
|
{
|
|
struct cyclic_info *cyclic;
|
|
struct hlist_node *tmp;
|
|
u64 cnt, freq;
|
|
|
|
hlist_for_each_entry_safe(cyclic, tmp, cyclic_get_list(), list) {
|
|
cnt = cyclic->run_cnt * 1000000ULL * 100ULL;
|
|
freq = lldiv(cnt, timer_get_us() - cyclic->start_time_us);
|
|
printf("function: %s, cpu-time: %lld us, frequency: %lld.%02d times/s\n",
|
|
cyclic->name, cyclic->cpu_time_us,
|
|
lldiv(freq, 100), do_div(freq, 100));
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
U_BOOT_LONGHELP(cyclic,
|
|
"demo <cycletime_ms> <delay_us> - register cyclic demo function\n"
|
|
"cyclic list - list cyclic functions\n");
|
|
|
|
U_BOOT_CMD_WITH_SUBCMDS(cyclic, "Cyclic", cyclic_help_text,
|
|
U_BOOT_SUBCMD_MKENT(demo, 3, 1, do_cyclic_demo),
|
|
U_BOOT_SUBCMD_MKENT(list, 1, 1, do_cyclic_list));
|