]> git.dujemihanovic.xyz Git - u-boot.git/commit
cyclic: make clients embed a struct cyclic_info in their own data structure
authorRasmus Villemoes <rasmus.villemoes@prevas.dk>
Tue, 21 May 2024 08:46:52 +0000 (10:46 +0200)
committerStefan Roese <sr@denx.de>
Sun, 16 Jun 2024 10:13:44 +0000 (12:13 +0200)
commit008c4b3c3115f7f95467773f12bad0db7649e786
treeeb39bb2b3f43c6ff4c4f43f87a9e338aa7cd6aa6
parentdf2b3829c67fc059fb4b6d8d7dfdc5946d199674
cyclic: make clients embed a struct cyclic_info in their own data structure

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>
board/Marvell/octeon_nic23/board.c
cmd/cyclic.c
common/cyclic.c
doc/develop/cyclic.rst
drivers/watchdog/wdt-uclass.c
include/cyclic.h
test/common/cyclic.c