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.

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

doc: extensions: boards: add ability to filter by hw capability #79754

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

kartben
Copy link
Collaborator

@kartben kartben commented Oct 12, 2024

WIP - board catalog is pre-computed for the sake of showing off the UI/UX early before the full CI job is in place, so don't mind the ginormous yaml file in one of the commits, it will eventually be generated on the fly (ask Twister to build hello world sample for all boards --> extract supported features from generated zephyr.dts for each board --> generate relevant metadata for enabling search by feature in catalog and generating table in board's readme --> profit).

"watchdog": nodes.Text("Watchdog"),
"wifi": nodes.Text("Wi-Fi"),
"xen": nodes.Text("Xen"),
"xspi": nodes.abbreviation("XSPI", "XSPI", explanation="Expanded Serial Peripheral Interface"),
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This large sorted list with some multiline blocks was the inspiration for #80444

Only check lines that match a regex, for example:

    # zephyr-keep-sorted-start /^    "/
    # ...
    # zephyr-keep-sorted-stop

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ahah yes, if this stays I will definitely flag it with the tags, thanks!
Right now I am actually very much interested in --although of course PR is still in draft, ... but since you're here 😄-- figuring out what makes for a "good" categorization of the supported HW feature. As you may have seen from the current implementation, this is making every directory under dts/bindings/ a category, but having ~120 categories doesn't seem right and there's probably a better way? Maybe we keep the approach but do some addition grouping? Like, dunno, off the top of my head, grouping fuel-gauge and battery ("Battery mgmt"), or usb and usb-c (USB), ... together ?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oopf, 120 is a lot, I think grouping would make sense, also to have some better names than for example mm.

@kartben kartben force-pushed the boards_filter_by_hw branch from 05dd7ba to 1103560 Compare November 22, 2024 10:52
@erwango
Copy link
Member

erwango commented Nov 22, 2024

@kartben Would it be possible to add a way to see what features are supported for a given SoC series ?

@kartben kartben force-pushed the boards_filter_by_hw branch from 1103560 to 0b97af2 Compare December 3, 2024 18:41
@kartben kartben added this to the v4.1.0 milestone Dec 4, 2024
@kartben kartben changed the title doc: extensions: boards: add abiliity to filter by hw capability doc: extensions: boards: add ability to filter by hw capability Dec 4, 2024
@kartben
Copy link
Collaborator Author

kartben commented Dec 4, 2024

@kartben Would it be possible to add a way to see what features are supported for a given SoC series ?

@erwango I think we need some kind of "board" for this to work. But if there is a way to feed a SoC DTS into this then we'd be in business

@kartben kartben force-pushed the boards_filter_by_hw branch 2 times, most recently from 612e066 to 0a61630 Compare December 12, 2024 17:54
@kartben kartben force-pushed the boards_filter_by_hw branch 2 times, most recently from 580d20a to 38cad6f Compare January 27, 2025 09:12
It is possible to fit the Hello World in 2K of RAM so update the
sample.yaml file accordingly. It might not *run*, but then the console
harness will catch that.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
PoC for now

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This is meant to be a PoC and will eventually be replaced with
`.. zephyr:board-supported-features::` or something similar.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
There is no such thing as associating a compatible to a child binding
so remove this from the nxp,dmic binding definition and devicetree files
that incorrectly set one.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
@kartben kartben force-pushed the boards_filter_by_hw branch from 38cad6f to b387ef6 Compare January 27, 2025 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants