Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DNM][WIP][do not review yet]Service and Device initialization: automatic priorities #79340

Open
wants to merge 31 commits into
base: main
Choose a base branch
from
Open

[DNM][WIP][do not review yet]Service and Device initialization: automatic priorities #79340

wants to merge 31 commits into from
+4,635 −4,061

Conversation

tbursztyka
Copy link
Collaborator

DO NOT REVIEW YET (I just need to see first what CI will find out, my potato PC cannot run the whole test suites)

This is a fix for #76937 after discussing on the RFC #73836

I applied most comments made during these discussion.

  • Keeping current macros unchanged and able to live with the new ones
  • Adding new macros: both for device and service (not init, SYS_INIT() will be deprecated as well anyway). Taking the opportunity to reduce the number of macros. Basically merging DT/non-DT based macros, so removing manually introduced device name. This is a legacy thing that needs to disappear. Explicit device name is coming from the time DTS was not used, and during the process of switching to DTS we had to keep it. Now it's not true anymore. The new macros still can instantiate a non-DT device, but it will take the unique token as a name and that's it.
  • Declaring the explicit dependency resolution file to cmake via cmake functions and not by looking up on pre-determined places (only on the application side, I could not use such cmake function, so there it has to be a specific file, unless I misunderstood something with the build process)
  • The new service API is extremely minimal as it is meant to just replace SYS_INIT where relevant (like, say: net_init, and not all the places where SYS_INIT should not have been used). BUT: it will grow, there are plenty of rooms for improvements. We could start/stop/pause a service if needed, etc etc...

Added to this I (tried to) switch most device macro calls to new ones. Which make this PR a huge one in files touched and modified lines. There are few corner cases which prevent changes: PTP and ethernet's DSA. These needs to switch to DTS.

Last but not least: brace for impact /o\

@tbursztyka
cmake: Add a gen_init_priorties module
3e81ad2 
Run after Kconfig and DTS, so it can build up on top of the edt object.
Thus filling in any gap left by Kconfig and DTS.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
CMakeLists.txt: call zephyr_generate_init_priorities() where relevant
887d433 
All service or device init files added to any valid CMakeLists.txt will
now be used to generate include/zephyr/generated/zinit.h header file,
with computed priorities.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
include: Add init utility macro specific header
e5889e2 
It provides useful macros to manipulate generated ZINIT_ macros from
gen_init_priorities.py script.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
init: Adapt init entry section generation
22644b3 
The sub-prio is entirely removed, as the new macros will bring uniquely
computed priorities.

This is seamless: none of this is of public API, so no deprecation and
macro replacement is necessary at this stage.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
linker: Add an extra number to check for sorting levels sections
fd5d802 
Now that priorities are automatically computed, and mostly coming from
DTS, it can easily go beyond 99.

Actually, this arbitrary limit of 99 in level sections has no real
meaning anymore (if it ever had any).

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
init: Add an extra '_' between level names and priority in sections
0460552 
This is an optional commit, but it makes things slightly easier to read
in zephyr.map.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
service: Introduce software service instanciation macros
6098c0f 
SERVICE_INSTANCE_INIT_ONCE is a direct replacement for SYS_INIT_NAMED,
removing the priority parameter as it is now provided by
gen_init_priorities.py script.

No alias will be created for SYS_INIT as we seek to limit the usage of
SERVICE_INSTANCE_INIT_ONCE, on the contrary to SYS_INIT which got widely
abused in the past.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
device: Add new macros to instanciate device objects
82a94b2 
In order to get rid of the manually inserted initialization priority,
device object generation need new macros.

Until now, 2 set of macros have co-existed because of legacy support.
Indeed, devices used to be created fully manually before devicetree
introduction. Once devicetree appeared, DT based macros were added.
Now is the time to get rid of such difference, and have a unique macro
for creating device objects.

So instead of DEVICE_DEFINE() and DEVICE_DT_DEFINE() there will be
DEVICE_INSTANCE(). Instead of DEVICE_DT_INST_DEFINE() there will be
DEVICE_INSTANCE_FROM_DT_INST(). Instead of DEVICE_GET() and
DEVICE_DT_GET(), there will be DEVICE_INSTANCE_GET().
Same for DEVICE_INIT_DT_GET() and DEVICE_INIT_GET(), there will be
DEVICE_INIT_ENTRY_GET()

In the future step of deprecating old macros, these are then identified:
- DEVICE_DEFINE
- DEVICE_DT_DEFINE
- DEVICE_GET
- DEVICE_DT_GET
- DEVICE_INIT_DT_GET
- DEVICE_INIT_GET
- DEVICE_NAME_GET() could be replaced by DEVICE_INSTANCE_NAME())
- DEVICE_DT_NAME_GET() could be replaced by DEVICE_INSTANCE_NAME())
- DEVICE_DECLARE() could be replaced as well

And probably some more, thus reducing the amount of macros which would
help to clean-up the header and have a more concise set.

The difference is now that priority parameter is removed, as well as the
name parameter (originaly from DEVICE_DEFINE legacy macro). In this case
it is just simpler to reuse the "unique token" dev_id.

Because of the dependency being fully computed _prior_ to building
zephyr, these new macros do not support CONFIG_DEVICE_DEPS anymore. This
feature was never really used anywhere and is a legacy thing. So new
macros do not accept variable arguments.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
tests: Switching DEVICE_<DT/DT_INST>_DEFINE macros to new ones
ac134ba 
Switching to DEVICE_INSTANCE and DEVICE_INSTANCE_FROM_DT_INST, thus
merging former DEVICE_DEFINE and DEVICE_DT_DEFINE into one, so removing
the name parameter from the earier and finally removing the prio
parameter on all.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
subsys: Switching DEVICE_<DT/DT_INST>_DEFINE macros to new ones
c280a9c 
Switching to DEVICE_INSTANCE and DEVICE_INSTANCE_FROM_DT_INST, thus
merging former DEVICE_DEFINE and DEVICE_DT_DEFINE into one, so removing
the name parameter from the earier and finally removing the prio
parameter on all.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
boards: Switching DEVICE_<DT/DT_INST>_DEFINE macros to new ones
dbb4d17 
Switching to DEVICE_INSTANCE and DEVICE_INSTANCE_FROM_DT_INST, thus
merging former DEVICE_DEFINE and DEVICE_DT_DEFINE into one, so removing
the name parameter from the earier and finally removing the prio
parameter on all.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
sensor: Provide new device instantiation macros
9fd64ca 
In order to get rid of the manually inserted initialization priority,
device object generation need new macros.

Again removing the prio parameter.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
sensors: Switching SENSOR_DEVICE_<DT/DT_INST>_DEFINE macros to new ones
c2c0bfd 
Switching to SENSOR_DEVICE_INSTANCE and
SENSOR_DEVICE_INSTANCE_FROM_DT_INST, thus removing the prio parameter
on all.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
net: Provide new device instantiation macros
1f0d042 
Again removing the prio parameter.

Managing the ident as a DT node-id or dev_id helps to reduce the number
from 12 to 7 macros.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
drivers: Switching NET_DEVICE_<INIT/DT_DEFINE>... macros to new ones
c1da4e1 
Switching to NET_DEVICE_INSTANCE, NET_DEVICE_INSTANCE_FROM_DT_INST,
NET_DEVICE_INSTANCE_MULTI, NET_DEVICE_INSTANCE_MULT_FROM_DT_INST,
NET_DEVICE_OFFLOAD_INSTANCE and
NET_DEVICE_OFFLOAD_INSTANCE_FROM_DT_INST.

Thus removing prio and name parameters on all.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
net/ethernet: Provide new device instantiation macro
e950a45 
Again removing the prio and name parameters.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
ethernet: Switching ETH_NET_DEVICE_<INIT/DT_INSTANCE>... to new ones
5417073 
Switching to ETH_NET_DEVICE_INSTANCE,
ETH_NET_DEVICE_INSTANCE_FROM_DT_INST and ETH_NET_DEVICE_INSTANCE_MULTI.

Thus removing prio and name parameters on all.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
tests: Switching NET_DEVICE_<INIT/DT_DEFINE>... macros to new ones
77d1905 
Switching to NET_DEVICE_INSTANCE, NET_DEVICE_INSTANCE_FROM_DT_INST,
NET_DEVICE_INSTANCE_MULTI, NET_DEVICE_INSTANCE_MULT_FROM_DT_INST,
NET_DEVICE_OFFLOAD_INSTANCE and
NET_DEVICE_OFFLOAD_INSTANCE_FROM_DT_INST.

Thus removing prio and name parameters on all.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
can: Provide new device instantiation macro
64869e3 
Again removing the prio parameter.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
drivers/can: Switching CAN_DEVICE_DT_DEFINE macros to new ones
778f07e 
Switching to CAN_DEVICE_INSTANCE and CAN_DEVICE_INSTANCE_FROM_DT_INST
relevantly.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
smbus: Provide new device instantiation macro
a8ec0c4 
Again removing the prio parameter.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
drivers/smbus: Switching SMBUS_DEVICE_DT_DEFINE macros to new ones
397140c 
Switching to SMBUS_DEVICE_INSTANCE and
SMBUS_DEVICE_INSTANCE_FROM_DT_INST relevantly.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
include/drivers: Switching specific headers to new device macros
97b5122 
Lone files that define their own wrapper macro on top of formely
DEVICE_DT_DEFINE macros.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
i2c: Provide new device instantiation macro
f31342c 
Again removing the prio parameter.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
drivers/i2c: Switching I2C_DEVICE_DT_DEFINE macros to new ones
213522b 
Switching to I2C_DEVICE_INSTANCE and I2C_DEVICE_INSTANCE_FROM_DT_INST
relevantly.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
spi: Provide new device instantiation macro
4b2e3bd 
Again removing the prio parameter.

However, original macro does not seem to be used anywhere...

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
firmware: Provide new device instantiation macro
bac8763 
Again removing the prio parameter.

And switching the unique macro call in drivers.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
drivers: Switching DEVICE_<DT/DT_INST>_DEFINE macros to new ones
4f3db92 
Switching to DEVICE_INSTANCE and DEVICE_INSTANCE_FROM_DT_INST, thus
merging former DEVICE_DEFINE and DEVICE_DT_DEFINE into one, so removing
the name parameter from the earier and finally removing the prio
parameter on all.

Signed-off-by: Tomasz Bursztyka <[email protected]>
@tbursztyka
tests and samples: Add relevant service and device init modifiers
2892bda 
A few test and samples require explicit dependency resolution as the
devices they introduce do not have any DTS counter-part.

Signed-off-by: Tomasz Bursztyka <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Kludentwo Kludentwo Awaiting requested review from Kludentwo Kludentwo is a code owner

@loicpoulain loicpoulain Awaiting requested review from loicpoulain loicpoulain is a code owner

@nandojve nandojve Awaiting requested review from nandojve nandojve is a code owner

@mniestroj mniestroj Awaiting requested review from mniestroj mniestroj is a code owner

@softwarecki softwarecki Awaiting requested review from softwarecki softwarecki is a code owner

@thedjnK thedjnK Awaiting requested review from thedjnK thedjnK is a code owner

@nordic-krch nordic-krch Awaiting requested review from nordic-krch nordic-krch is a code owner

@katsuster katsuster Awaiting requested review from katsuster katsuster is a code owner

@albertofloyd albertofloyd Awaiting requested review from albertofloyd albertofloyd is a code owner

@dcpleung dcpleung Awaiting requested review from dcpleung dcpleung is a code owner

@henrikbrixandersen henrikbrixandersen Awaiting requested review from henrikbrixandersen henrikbrixandersen is a code owner

@ydamigos ydamigos Awaiting requested review from ydamigos ydamigos is a code owner

@andy-liu-telink andy-liu-telink Awaiting requested review from andy-liu-telink andy-liu-telink is a code owner

@danieldegrasse danieldegrasse Awaiting requested review from danieldegrasse danieldegrasse is a code owner

@soburi soburi Awaiting requested review from soburi soburi is a code owner

@sylvioalves sylvioalves Awaiting requested review from sylvioalves sylvioalves is a code owner

@karstenkoenig karstenkoenig Awaiting requested review from karstenkoenig karstenkoenig is a code owner

@jukkar jukkar Awaiting requested review from jukkar jukkar is a code owner

@GTLin08 GTLin08 Awaiting requested review from GTLin08 GTLin08 is a code owner

@lorc lorc Awaiting requested review from lorc lorc is a code owner

@firscity firscity Awaiting requested review from firscity firscity is a code owner

@aaillet aaillet Awaiting requested review from aaillet aaillet is a code owner

@julius-barendt julius-barendt Awaiting requested review from julius-barendt julius-barendt is a code owner

@ssekar15 ssekar15 Awaiting requested review from ssekar15 ssekar15 is a code owner

@parthitce parthitce Awaiting requested review from parthitce parthitce is a code owner

@yonsch yonsch Awaiting requested review from yonsch yonsch is a code owner

@carlescufi carlescufi Awaiting requested review from carlescufi carlescufi is a code owner

@Mani-Sadhasivam Mani-Sadhasivam Awaiting requested review from Mani-Sadhasivam Mani-Sadhasivam is a code owner

@anangl anangl Awaiting requested review from anangl anangl is a code owner

@nashif nashif Awaiting requested review from nashif nashif is a code owner

@gdengi gdengi Awaiting requested review from gdengi gdengi is a code owner

@jeppenodgaard jeppenodgaard Awaiting requested review from jeppenodgaard jeppenodgaard is a code owner

@MaureenHelm MaureenHelm Awaiting requested review from MaureenHelm MaureenHelm is a code owner

@avisconti avisconti Awaiting requested review from avisconti avisconti is a code owner

@bbilas bbilas Awaiting requested review from bbilas bbilas is a code owner

@gmarull gmarull Awaiting requested review from gmarull gmarull is a code owner

@LucasTambor LucasTambor Awaiting requested review from LucasTambor LucasTambor is a code owner

@JordanYates JordanYates Awaiting requested review from JordanYates JordanYates is a code owner

@MulinChao MulinChao Awaiting requested review from MulinChao MulinChao is a code owner

@ChiHuaL ChiHuaL Awaiting requested review from ChiHuaL ChiHuaL is a code owner

@ceolin ceolin Awaiting requested review from ceolin ceolin is a code owner

@rerickson1 rerickson1 Awaiting requested review from rerickson1 rerickson1 is a code owner

@hubertmis hubertmis Awaiting requested review from hubertmis hubertmis is a code owner

@mbolivar-ampere mbolivar-ampere Awaiting requested review from mbolivar-ampere mbolivar-ampere is a code owner

@uLipe uLipe Awaiting requested review from uLipe uLipe is a code owner

@cameled cameled Awaiting requested review from cameled cameled is a code owner

@arnopo arnopo Awaiting requested review from arnopo arnopo is a code owner

@masz-nordic masz-nordic Awaiting requested review from masz-nordic masz-nordic is a code owner

@andyross andyross Awaiting requested review from andyross andyross is a code owner

@stephanosio stephanosio Awaiting requested review from stephanosio stephanosio is a code owner

@cfriedt cfriedt Awaiting requested review from cfriedt cfriedt is a code owner

@vaishnavachath vaishnavachath Awaiting requested review from vaishnavachath vaishnavachath is a code owner

@ankuns ankuns Awaiting requested review from ankuns ankuns is a code owner

@rlubos rlubos Awaiting requested review from rlubos rlubos is a code owner

@fgrandel fgrandel Awaiting requested review from fgrandel fgrandel is a code owner

@XenuIsWatching XenuIsWatching Awaiting requested review from XenuIsWatching XenuIsWatching is a code owner

@sjg20 sjg20 Awaiting requested review from sjg20 sjg20 is a code owner

@ibirnbaum ibirnbaum Awaiting requested review from ibirnbaum ibirnbaum is a code owner

@fkokosinski fkokosinski Awaiting requested review from fkokosinski fkokosinski is a code owner

@kgugala kgugala Awaiting requested review from kgugala kgugala is a code owner

@de-nordic de-nordic Awaiting requested review from de-nordic de-nordic is a code owner

@GeorgeCGV GeorgeCGV Awaiting requested review from GeorgeCGV GeorgeCGV is a code owner

@SgrrZhf SgrrZhf Awaiting requested review from SgrrZhf SgrrZhf is a code owner

@npitre npitre Awaiting requested review from npitre npitre is a code owner

@dleach02 dleach02 Awaiting requested review from dleach02 dleach02 is a code owner

@talih0 talih0 Awaiting requested review from talih0 talih0 is a code owner

@teburd teburd Awaiting requested review from teburd teburd is a code owner

@abonislawski abonislawski Awaiting requested review from abonislawski abonislawski is a code owner

@marcinszkudlinski marcinszkudlinski Awaiting requested review from marcinszkudlinski marcinszkudlinski is a code owner

@kv2019i kv2019i Awaiting requested review from kv2019i kv2019i is a code owner

@mmahadevan108 mmahadevan108 Awaiting requested review from mmahadevan108 mmahadevan108 is a code owner

@alwa-nordic alwa-nordic Awaiting requested review from alwa-nordic alwa-nordic is a code owner

@jhedberg jhedberg Awaiting requested review from jhedberg jhedberg is a code owner

@Vudentz Vudentz Awaiting requested review from Vudentz Vudentz is a code owner

@yperess yperess Awaiting requested review from yperess yperess is a code owner

@jackrosenthal jackrosenthal Awaiting requested review from jackrosenthal jackrosenthal is a code owner

@manuargue manuargue Awaiting requested review from manuargue manuargue is a code owner

@ifyall ifyall Awaiting requested review from ifyall ifyall is a code owner

@npal-cy npal-cy Awaiting requested review from npal-cy npal-cy is a code owner

@jimmyzhe jimmyzhe Awaiting requested review from jimmyzhe jimmyzhe is a code owner

@simonguinot simonguinot Awaiting requested review from simonguinot simonguinot is a code owner

@aescolar aescolar Awaiting requested review from aescolar aescolar is a code owner

@daor-oti daor-oti Awaiting requested review from daor-oti daor-oti is a code owner

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
area: Device Management area: Device Model DNM This PR should not be merged (Do Not Merge)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@tbursztyka