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

boards: st: Make use of the newly generated features tables #86485

Merged
merged 1 commit into from
Mar 4, 2025
Merged

boards: st: Make use of the newly generated features tables #86485

merged 1 commit into from
Mar 4, 2025

Conversation

erwango
Copy link
Member

@erwango erwango commented Feb 28, 2025

Replace the maunaly maintained features table by the tables generated from device tree boards description.

@zephyrbot zephyrbot added the platform: STM32 ST Micro STM32 label Feb 28, 2025
@erwango erwango force-pushed the doc_boards_table branch 2 times, most recently from 814d6e4 to c228015 Compare February 28, 2025 16:04
@erwango erwango requested a review from kartben March 3, 2025 08:21
kartben
kartben previously approved these changes Mar 3, 2025
View reviewed changes
Copy link
Collaborator

@kartben kartben left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Awesome! For the record, nucleo_l011k4 needs #86453 so that Hello World sample is actually built and not filtered due to limited flash ; but this doesn't prevent this PR to go in as-is.

Note that you may want to do some housekeeping the descriptions of some of the stm32 bindings that are not necessarily well-worded. E.g.:

  • zephyr/dts/bindings/timer/st,stm32-lptim.yaml

    Lines 4 to 10 in d8edd78

    description: |
    STM32 lptim : low power timer
    The lptim node to be used for counting ticks during lowpower modes
    must be named stm32_lp_tick_source in the DTS, as follows:
    stm32_lp_tick_source: &lptim1 {
    status = "okay";
    }
    ---> "STM32 Low-power timer (LPTIM)."

  • zephyr/dts/bindings/interrupt-controller/st,stm32g0-exti.yaml

    Lines 6 to 8 in d8edd78

    STM32 controller
    This compatible stands for all interrupt-controller blocks with two
    dedicated Rising and Falling interrupt pending registers.
    . ---> should say interrupt controller, not just "controller"?

  • prob quite a few others but generally looks pretty good from a quick check I did after building this PR locally

fabiobaltieri
fabiobaltieri previously approved these changes Mar 3, 2025
View reviewed changes
@fabiobaltieri
Copy link
Member

+134 −3,825 <- ah yeah!

gautierg-st
gautierg-st reviewed Mar 3, 2025
View reviewed changes
Copy link
Contributor

@gautierg-st gautierg-st left a comment

Choose a reason for hiding this comment

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

Nice work. Some boards indicate that more information can be found in the RefMan. For consistency, this could be removed (or added for all boards, but I don't think it is necessary).
Besides, some notes are being removed that should probably not be.

boards/st/stm32h747i_disco/doc/index.rst Outdated
Comment on lines 78 to 81
(*) From UM2411 Rev 4:
With the default setting, the Ethernet feature is not working because of
a conflict between ETH_MDC and SAI4_D1 of the MEMs digital microphone.
Make sure you have SB8 closed and SB21 open to get Ethernet working.
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't we keep this warning as a ..note?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, we should keep those notes

@erwango erwango dismissed stale reviews from fabiobaltieri and kartben via b23bbcb March 3, 2025 10:29
@erwango erwango force-pushed the doc_boards_table branch from c228015 to b23bbcb Compare March 3, 2025 10:29
@erwango
Copy link
Member Author

erwango commented Mar 3, 2025

Updated the batch to limit changes to the table edition (keep notes as is).

@kartben
Copy link
Collaborator

kartben commented Mar 3, 2025

@erwango please check compliance failure (nucleo_f072rb doc page doesn't define the link you're trying to link to)

@nashif
Copy link
Member

nashif commented Mar 3, 2025

+134 −3,825 <- ah yeah!

that is removing years of hard work creating awkward markdown tables.

@erwango erwango force-pushed the doc_boards_table branch from b23bbcb to 9c4fecd Compare March 3, 2025 13:14
fabiobaltieri
fabiobaltieri previously approved these changes Mar 3, 2025
View reviewed changes
@kartben
Copy link
Collaborator

kartben commented Mar 3, 2025

+134 −3,825 <- ah yeah!

that is removing years of hard work creating awkward markdown tables.

sorry not sorry :)

kartben
kartben previously approved these changes Mar 3, 2025
View reviewed changes
gautierg-st
gautierg-st reviewed Mar 3, 2025
View reviewed changes
Copy link
Contributor

@gautierg-st gautierg-st left a comment

Choose a reason for hiding this comment

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

There are still two notes that should not be removed

@fabiobaltieri fabiobaltieri added this to the v4.1.0 milestone Mar 3, 2025
@erwango erwango dismissed stale reviews from kartben and fabiobaltieri via b1f82e8 March 3, 2025 14:58
@erwango erwango force-pushed the doc_boards_table branch from 9c4fecd to b1f82e8 Compare March 3, 2025 14:58
fabiobaltieri
fabiobaltieri previously approved these changes Mar 3, 2025
View reviewed changes
@erwango erwango force-pushed the doc_boards_table branch from ddc009b to b1f82e8 Compare March 3, 2025 16:13
@erwango
Copy link
Member Author

erwango commented Mar 3, 2025

Sorry for this last push which was really unintentional.

kartben
kartben previously approved these changes Mar 3, 2025
View reviewed changes
fabiobaltieri
fabiobaltieri previously approved these changes Mar 3, 2025
View reviewed changes
gautierg-st
gautierg-st previously approved these changes Mar 4, 2025
View reviewed changes
@man-gc man-gc mentioned this pull request Mar 4, 2025
Open
@erwango
boards: st: Make use of the newly generated features tables
57ac30f 
Replace the manually maintained features table by the tables generated from
device tree boards description.

Signed-off-by: Erwan Gouriou <erwan.gouriou@st.com>
@erwango erwango dismissed stale reviews from gautierg-st, fabiobaltieri, and kartben via 57ac30f March 4, 2025 09:39
@erwango erwango force-pushed the doc_boards_table branch from b1f82e8 to 57ac30f Compare March 4, 2025 09:39
@erwango
Copy link
Member Author

erwango commented Mar 4, 2025

Fixed rebase conflict

@fabiobaltieri fabiobaltieri merged commit e5db751 into zephyrproject-rtos:main Mar 4, 2025
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kartben kartben kartben approved these changes

@gautierg-st gautierg-st gautierg-st approved these changes

@fabiobaltieri fabiobaltieri fabiobaltieri left review comments

@asm5878 asm5878 Awaiting requested review from asm5878

@benothmn-st benothmn-st Awaiting requested review from benothmn-st

@djiatsaf-st djiatsaf-st Awaiting requested review from djiatsaf-st

@FRASTM FRASTM Awaiting requested review from FRASTM

@GeorgeCGV GeorgeCGV Awaiting requested review from GeorgeCGV

@HoZHel HoZHel Awaiting requested review from HoZHel

@marwaiehm-st marwaiehm-st Awaiting requested review from marwaiehm-st

@mathieuchopstm mathieuchopstm Awaiting requested review from mathieuchopstm

Assignees

@erwango erwango

Labels
platform: STM32 ST Micro STM32
Projects
None yet
Milestone
v4.1.0
Development

Successfully merging this pull request may close these issues.
6 participants
@erwango @fabiobaltieri @kartben @nashif @gautierg-st @zephyrbot