Skip to content

STM32: Add SPI RTIO support #91847

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
Merged
merged 13 commits into from
Oct 23, 2025
Merged

STM32: Add SPI RTIO support #91847

merged 13 commits into from
Oct 23, 2025

Conversation

@gautierg-st
Copy link
Contributor

Add SPI RTIO support for STM32. This requires interrupts (no DMA yet)

@github-actions github-actions bot added platform: STM32 ST Micro STM32 area: SPI SPI bus labels Jun 18, 2025
@gautierg-st gautierg-st added this to the v4.2.0 milestone Jun 18, 2025
@decsny
Copy link
Member

decsny commented Jun 18, 2025

is there some benchmark showing any value add over the default implementation?

@teburd
Copy link
Contributor

teburd commented Jun 18, 2025 •
edited
Loading

is there some benchmark showing any value add over the default implementation?

The main benefit is that you can simply start asynchronous transactions, at any time, from any call context. E.g. a gpio/timer ISR, even direct or zli ISRs. For sensors in particular this saves needing to use a thread per trigger with the stack cost, or the work queue with a latency cost.

Are you looking for some other particular benefit/benchmark?

@gautierg-st gautierg-st force-pushed the spi_rtio branch 2 times, most recently from f19eac6 to 4c58db2 Compare June 19, 2025 13:44
erwango
erwango requested changes Jun 19, 2025
View reviewed changes
Copy link
Member

@erwango erwango left a comment

Choose a reason for hiding this comment

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

First round of review

mathieuchopstm
mathieuchopstm reviewed Jun 20, 2025
View reviewed changes
Copy link
Contributor

@mathieuchopstm mathieuchopstm left a comment

Choose a reason for hiding this comment

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

Seems OK

@avisconti
Copy link
Contributor

Last week I tried on sensortile_box_pro and it was NOT working. I'm waiting for new commits to try out. Thanks for this effort!

@gautierg-st
Copy link
Contributor Author

I currently have failed SPI loopback tests on boards that haven't the "st,stm32h7-spi" compatible. I'm working on solving that before retesting on sensortile_box_pro.

@gautierg-st gautierg-st force-pushed the spi_rtio branch 4 times, most recently from 815925b to 54c1d6e Compare June 23, 2025 13:03
@gautierg-st
Copy link
Contributor Author

spi_loopback test is passing on all series, RTIO or not (except STM32H7, but it is not related to this PR).
@avisconti I have retested on a sensortile_box_pro and it works on my end.

teburd
teburd previously approved these changes Jun 23, 2025
View reviewed changes
@avisconti
Copy link
Contributor

spi_loopback test is passing on all series, RTIO or not (except STM32H7, but it is not related to this PR). @avisconti I have retested on a sensortile_box_pro and it works on my end.

OK Guillaume, I'll retest then. Maybe I did something wrong. But tomorrow

@avisconti
Copy link
Contributor

BTW, I tested it on a nucleo_h503rb plus a SPI-configured shield with a lsm6dsv320x on DIL24. And used the stream rtio configuration.

@etienne-lms can you possibly tell me how did you test (what build command) on sensortile_box_pro?

@etienne-lms
Copy link
Contributor

etienne-lms commented Oct 22, 2025 •
edited
Loading

I used west build -p -b sensortile_box_pro samples/sensor/stream_fifo -f flash

(edited) Last option is -t flash, not -f flash of course.

@avisconti
Copy link
Contributor

I used west build -p -b sensortile_box_pro samples/sensor/stream_fifo -f flash

OK, thx. It is the right sample!

gautierg-st and others added 10 commits October 23, 2025 11:44
@gautierg-st @etienne-lms
drivers: spi: stm32: prepare for rtio integration
bf5a6a2 
Move some code into a new function to prepare for RTIO integration.

Signed-off-by: Guillaume Gautier <[email protected]>
Signed-off-by: Etienne Carriere <[email protected]>
@etienne-lms
drivers: spi: stm32: don't include zephyr/arch/cache.h
3594906 
Remove inclusion of zephyr_arch/cache.h header file from STM32 SPI
driver. This header file is included by zephyr/cache.h if applicable
(e.g. CONFIG_ARCH_CACHE is enabled) and should not be used when
CONFIG_EXTERNAL_CACHE is enabled.

Signed-off-by: Etienne Carriere <[email protected]>
@etienne-lms
drivers: spi: stm32: reorder header inclusion
0179362 
Reorder inclusions of header files to clarify and simplify later changes.
By the way, remove #ifdef CONFIG_SPI_STM32_DMA condition to include
DMA header files as its not required.

Keep zephyr/log.h with use of LOG_MODULE_REGISTER() first since included
local spi_context.h depends on log resources to be defined.

Signed-off-by: Etienne Carriere <[email protected]>
@etienne-lms
drivers: spi: stm32: remove useless LOG_LEVEL
b0062e8 
Remove useless LOG_LEVEL in STM32 SPI RTIO driver.

Signed-off-by: Etienne Carriere <[email protected]>
@etienne-lms
drivers: spi stm32: remove bits2byte()
2843824 
Remove bits2byte() helper function than was not always used. Replace it
with a division by BITS_PER_BYTE that is explicit enough.

Signed-off-by: Etienne Carriere <[email protected]>
@etienne-lms
drivers: spi: stm32: explicit boolean test
afa2750 
Use explicit boolean tests in STM32 SPI driver.

Signed-off-by: Etienne Carriere <[email protected]>
@etienne-lms
drivers: spi: stm32: correct indentation
3809be7 
Correct some indentation issues, a few useless line escapes,
double space characters or parentheses pair in STM32 SPI driver.

Signed-off-by: Etienne Carriere <[email protected]>
@etienne-lms
drivers: spi: stm32: fix missing braces in conditioned instruction
090e78c 
Fix a missing braces pair around a conditioned instruction in
STM32 SPI driver. Fix that by aggregating the 2 if() instructions
into a single ANDed one.

Signed-off-by: Etienne Carriere <[email protected]>
@etienne-lms
drivers: spi: stm32: remove useless inline keywords
617f14c 
Remove useless inline keywords in STM32 SPI driver.

Signed-off-by: Etienne Carriere <[email protected]>
@etienne-lms
drivers: spi: stm32: replace an #if with an if() in transceive()
ffa5ef6 
Replace a #ifndef directive with a if(!IS_ENABLED()) instrcution
in transceive() function. This change makes later integration of RTIO
support in this function smoother, polluting a bit less this function
with #if based directives.

Signed-off-by: Etienne Carriere <[email protected]>
@etienne-lms etienne-lms force-pushed the spi_rtio branch 2 times, most recently from 6a8381d to 2724b27 Compare October 23, 2025 09:47
@etienne-lms
Copy link
Contributor

etienne-lms commented Oct 23, 2025 •
edited
Loading

Review comments and CI Compliance Checks complain addressed.
The diff is here.
I've then rebased to get CI doc build issues hopefully fixed.

(edited) By the way, I also restored authorship of commit "drivers: spi: stm32: add rtio support" to @gautierg-st that made all the work. I saw I mistakenly replaced it when handing over this P-R, 😕.

@gautierg-st @etienne-lms
drivers: spi: stm32: add rtio support
343450e 
Add SPI RTIO support for STM32. SPI RTIO required interrupts.
DMA is not supported yet.

Signed-off-by: Guillaume Gautier <[email protected]>
Signed-off-by: Etienne Carriere <[email protected]>
@gautierg-st @etienne-lms
tests: drivers: spi: loopback: add stm32 spi rtio test case
bfb0d91 
Add a test case for STM32 SPI RTIO.

Signed-off-by: Guillaume Gautier <[email protected]>
@gautierg-st @etienne-lms
tests: drivers: spi: loopback: boards: adjust scaling for stm32 boards
2bee18e 
Adjust transfer duration scaling config for STM32 boards

Signed-off-by: Guillaume Gautier <[email protected]>
@etienne-lms
Copy link
Contributor

etienne-lms commented Oct 23, 2025 •
edited
Loading

In the last update, I introduced build warnings and a recursion that is not really need. It's addressed now.
Tests on my side are fine. I've launched a test campaign on our HW bench to check against any regression.

@sonarqubecloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@etienne-lms
Copy link
Contributor

All good in our HW bench.

avisconti
avisconti approved these changes Oct 23, 2025
View reviewed changes
Copy link
Contributor

@avisconti avisconti left a comment

Choose a reason for hiding this comment

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

As far as I can tell, this PR looks good to me. Thanks for your effort!

@etienne-lms
Copy link
Contributor

Thanks @avisconti for ytour help and tests.
@teburd, @erwango: are you fine this the changes? It would be nice it can land in the coming release tag.

@kartben kartben merged commit 72cef9b into zephyrproject-rtos:main Oct 23, 2025
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@avisconti avisconti avisconti approved these changes

@erwango erwango erwango approved these changes

@decsny decsny Awaiting requested review from decsny

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

@FRASTM FRASTM Awaiting requested review from FRASTM

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

@tbursztyka tbursztyka Awaiting requested review from tbursztyka

@str4t0m str4t0m Awaiting requested review from str4t0m

@nashif nashif Awaiting requested review from nashif

@GeorgeCGV GeorgeCGV Awaiting requested review from GeorgeCGV

@mathieuchopstm mathieuchopstm Awaiting requested review from mathieuchopstm

@teburd teburd Awaiting requested review from teburd

@etienne-lms etienne-lms Awaiting requested review from etienne-lms

Assignees

@erwango erwango

Labels

area: SPI SPI bus area: Tests Issues related to a particular existing or missing test platform: STM32 ST Micro STM32

Projects

None yet

Milestone

v4.3.0

Development

Successfully merging this pull request may close these issues.