Skip to content

drivers: i2s: stm32_sai fix drain and stop of tx stream #94696

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 1 commit into from
Aug 22, 2025
Merged

drivers: i2s: stm32_sai fix drain and stop of tx stream #94696

merged 1 commit into from
Aug 22, 2025

Conversation

@mariopaja
Copy link
Contributor

@mariopaja mariopaja commented Aug 20, 2025 •
edited
Loading

This change fixes two issues with the SAI TX Stream (Issue: #94561)

  1. Drain command does not release the last memory buffer
  2. TX Stream status does not change to READY after STOPPING

Application: samples/drivers/i2s/output

DRAIN:
Add the following code at the end of the application:

ret = i2s_trigger(dev_i2s, I2S_DIR_TX, I2S_TRIGGER_DRAIN);
if (ret < 0) {
printf("Could not trigger I2S tx\n");
return ret;
}

Before:

*** Booting Zephyr OS build v4.2.0-1295-g93620efc8d23 ***
[00:00:00.001,000] <wrn> i2s_stm32_sai: Free mem slabs: 1
[00:00:00.002,000] <wrn> i2s_stm32_sai: Free mem slabs: 2
[00:00:00.004,000] <wrn> i2s_stm32_sai: Free mem slabs: 3
[00:00:00.005,000] <wrn> i2s_stm32_sai: Free mem slabs: 4
[00:00:00.007,000] <wrn> i2s_stm32_sai: Free mem slabs: 5
[00:00:00.008,000] <wrn> i2s_stm32_sai: Free mem slabs: 6
[00:00:00.010,000] <wrn> i2s_stm32_sai: Free mem slabs: 7
[00:00:00.011,000] <wrn> i2s_stm32_sai: Free mem slabs: 8
[00:00:00.013,000] <wrn> i2s_stm32_sai: Free mem slabs: 9
[00:00:00.014,000] <wrn> i2s_stm32_sai: Free mem slabs: 10
[00:00:00.015,000] <wrn> i2s_stm32_sai: Free mem slabs: 11
[00:00:00.017,000] <wrn> i2s_stm32_sai: Free mem slabs: 12
[00:00:00.018,000] <wrn> i2s_stm32_sai: Free mem slabs: 13
[00:00:00.020,000] <wrn> i2s_stm32_sai: Free mem slabs: 14
[00:00:00.021,000] <wrn> i2s_stm32_sai: Free mem slabs: 15
[00:00:00.023,000] <wrn> i2s_stm32_sai: Free mem slabs: 16
[00:00:00.024,000] <wrn> i2s_stm32_sai: Free mem slabs: 17
[00:00:00.025,000] <wrn> i2s_stm32_sai: Free mem slabs: 18
[00:00:00.027,000] <wrn> i2s_stm32_sai: Free mem slabs: 19
[00:00:00.028,000] <wrn> i2s_stm32_sai: Free mem slabs: 19

After:

*** Booting Zephyr OS build v4.2.0-1296-g4009810cb5c7 ***
[00:00:00.001,000] <wrn> i2s_stm32_sai: Free mem slabs: 1
[00:00:00.002,000] <wrn> i2s_stm32_sai: Free mem slabs: 2
[00:00:00.004,000] <wrn> i2s_stm32_sai: Free mem slabs: 3
[00:00:00.005,000] <wrn> i2s_stm32_sai: Free mem slabs: 4
[00:00:00.007,000] <wrn> i2s_stm32_sai: Free mem slabs: 5
[00:00:00.008,000] <wrn> i2s_stm32_sai: Free mem slabs: 6
[00:00:00.010,000] <wrn> i2s_stm32_sai: Free mem slabs: 7
[00:00:00.011,000] <wrn> i2s_stm32_sai: Free mem slabs: 8
[00:00:00.013,000] <wrn> i2s_stm32_sai: Free mem slabs: 9
[00:00:00.014,000] <wrn> i2s_stm32_sai: Free mem slabs: 10
[00:00:00.015,000] <wrn> i2s_stm32_sai: Free mem slabs: 11
[00:00:00.017,000] <wrn> i2s_stm32_sai: Free mem slabs: 12
[00:00:00.018,000] <wrn> i2s_stm32_sai: Free mem slabs: 13
[00:00:00.020,000] <wrn> i2s_stm32_sai: Free mem slabs: 14
[00:00:00.021,000] <wrn> i2s_stm32_sai: Free mem slabs: 15
[00:00:00.023,000] <wrn> i2s_stm32_sai: Free mem slabs: 16
[00:00:00.024,000] <wrn> i2s_stm32_sai: Free mem slabs: 17
[00:00:00.025,000] <wrn> i2s_stm32_sai: Free mem slabs: 18
[00:00:00.027,000] <wrn> i2s_stm32_sai: Free mem slabs: 19
[00:00:00.028,000] <wrn> i2s_stm32_sai: Free mem slabs: 20

STOP/START:
Add the following code at the end of the application:

ret = i2s_trigger(dev_i2s, I2S_DIR_TX, I2S_TRIGGER_STOP);
if (ret < 0) {
printf("Could not trigger I2S tx\n");
return ret;
}

k_msleep(5000);

ret = i2s_trigger(dev_i2s, I2S_DIR_TX, I2S_TRIGGER_START);
if (ret < 0) {
printf("Could not trigger I2S tx\n");
return ret;
}

Before:

*** Booting Zephyr OS build v4.2.0-1295-g93620efc8d23 ***
[00:00:00.001,000] <wrn> i2s_stm32_sai: Free mem slabs: 1
[00:00:00.002,000] <wrn> i2s_stm32_sai: Free mem slabs: 2
[00:00:00.004,000] <wrn> i2s_stm32_sai: Free mem slabs: 3
[00:00:00.005,000] <wrn> i2s_stm32_sai: Free mem slabs: 4
[00:00:00.007,000] <wrn> i2s_stm32_sai: Free mem slabs: 5
[00:00:00.008,000] <wrn> i2s_stm32_sai: Free mem slabs: 6
[00:00:00.010,000] <wrn> i2s_stm32_sai: Free mem slabs: 7
[00:00:00.011,000] <wrn> i2s_stm32_sai: Free mem slabs: 8
[00:00:00.013,000] <wrn> i2s_stm32_sai: Free mem slabs: 9
[00:00:00.014,000] <wrn> i2s_stm32_sai: Free mem slabs: 10
[00:00:00.015,000] <wrn> i2s_stm32_sai: Free mem slabs: 11
[00:00:00.017,000] <wrn> i2s_stm32_sai: Free mem slabs: 12
[00:00:00.018,000] <wrn> i2s_stm32_sai: Free mem slabs: 13
[00:00:00.020,000] <wrn> i2s_stm32_sai: Free mem slabs: 14
[00:00:00.021,000] <wrn> i2s_stm32_sai: Free mem slabs: 15
[00:00:00.023,000] <wrn> i2s_stm32_sai: TX Stopped ...
[00:00:00.023,000] <wrn> i2s_stm32_sai: Free mem slabs: 15
Could not trigger I2S tx
[00:00:05.021,000] <err> i2s_stm32_sai: START trigger: invalid state 3

After:

*** Booting Zephyr OS build v4.2.0-1296-g4009810cb5c7 ***
[00:00:00.001,000] <wrn> i2s_stm32_sai: Free mem slabs: 1
[00:00:00.002,000] <wrn> i2s_stm32_sai: Free mem slabs: 2
[00:00:00.004,000] <wrn> i2s_stm32_sai: Free mem slabs: 3
[00:00:00.005,000] <wrn> i2s_stm32_sai: Free mem slabs: 4
[00:00:00.007,000] <wrn> i2s_stm32_sai: Free mem slabs: 5
[00:00:00.008,000] <wrn> i2s_stm32_sai: Free mem slabs: 6
[00:00:00.010,000] <wrn> i2s_stm32_sai: Free mem slabs: 7
[00:00:00.011,000] <wrn> i2s_stm32_sai: Free mem slabs: 8
[00:00:00.013,000] <wrn> i2s_stm32_sai: Free mem slabs: 9
[00:00:00.014,000] <wrn> i2s_stm32_sai: Free mem slabs: 10
[00:00:00.015,000] <wrn> i2s_stm32_sai: Free mem slabs: 11
[00:00:00.017,000] <wrn> i2s_stm32_sai: Free mem slabs: 12
[00:00:00.018,000] <wrn> i2s_stm32_sai: Free mem slabs: 13
[00:00:00.020,000] <wrn> i2s_stm32_sai: Free mem slabs: 14
[00:00:00.021,000] <wrn> i2s_stm32_sai: Free mem slabs: 15
[00:00:00.023,000] <wrn> i2s_stm32_sai: TX Stopped ...
[00:00:00.023,000] <wrn> i2s_stm32_sai: Free mem slabs: 16
[00:00:05.023,000] <wrn> i2s_stm32_sai: Free mem slabs: 17
[00:00:05.024,000] <wrn> i2s_stm32_sai: Free mem slabs: 18
[00:00:05.026,000] <wrn> i2s_stm32_sai: Free mem slabs: 19
[00:00:05.027,000] <wrn> i2s_stm32_sai: Free mem slabs: 20

@mariopaja mariopaja mentioned this pull request Aug 20, 2025
Open
21 tasks
etienne-lms
etienne-lms reviewed Aug 21, 2025
View reviewed changes
Copy link
Contributor

@etienne-lms etienne-lms left a comment

Choose a reason for hiding this comment

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

Could you replace "PR" with "change" in the commit log. In the end, what will remains is a commit in the Git history rather that a Github P-R. Note also that imperative mode is usually preferred. Suggestion:

This PR fixes two issues with the SAI TX Stream.
Fix two issues with the SAI TX Stream:

Last, it's usually better to have 1 fix per commit (unless there are related), but that's not a strong opinion since your 2 fixes are rather small.
Otherwise LGTM.

@mariopaja
drivers: i2s: stm32_sai fix drain and stop of tx stream
aa83f09 
Fix two issues with the SAI TX Stream.

1. Drain command does not release the last memory buffer
2. TX Stream status does not change to READY after STOPPING

Signed-off-by: Mario Paja <mariopaja@hotmail.com>
@mariopaja mariopaja force-pushed the stm32_sai_tx_drain_stop_fix branch from 4009810 to aa83f09 Compare August 21, 2025 09:15
@mariopaja
Copy link
Contributor Author

hi @etienne-lms,

I changed the commit log. Is it better now?

it's usually better to have 1 fix per commit

I know but the changes are small and are related to each other. I could not fix one and let the other one

@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

@kartben kartben merged commit c70aaee into zephyrproject-rtos:main Aug 22, 2025
28 checks passed
mariopaja added a commit to mariopaja/zephyr that referenced this pull request Aug 30, 2025
@mariopaja
drivers: i2s: stm32_sai fix tx callback mem_block release
daf0737 
This change fixes a wrong buffer release on tx callback which
was not correctly fixed by
zephyrproject-rtos#94696.

Signed-off-by: Mario Paja <mariopaja@hotmail.com>
mariopaja added a commit to mariopaja/zephyr that referenced this pull request Aug 30, 2025
@mariopaja
drivers: i2s: stm32_sai fix tx callback mem_block release
845efcf 
This change fixes a wrong buffer release on tx callback which
was not correctly fixed by
zephyrproject-rtos#94696.

Signed-off-by: Mario Paja <mariopaja@hotmail.com>
mariopaja added a commit to mariopaja/zephyr that referenced this pull request Aug 30, 2025
@mariopaja
drivers: i2s: stm32_sai fix tx callback mem_block release
069a55c 
This change fixes a wrong buffer release on tx callback which
was not correctly fixed by
zephyrproject-rtos#94696.

Signed-off-by: Mario Paja <mariopaja@hotmail.com>
@mariopaja mariopaja mentioned this pull request Aug 30, 2025
Merged
kartben pushed a commit that referenced this pull request Sep 2, 2025
@mariopaja @kartben
drivers: i2s: stm32_sai fix tx callback mem_block release
abb3c2a 
This change fixes a wrong buffer release on tx callback which
was not correctly fixed by
#94696.

Signed-off-by: Mario Paja <mariopaja@hotmail.com>
ExaltZephyr pushed a commit to ExaltZephyr/zephyr that referenced this pull request Sep 16, 2025
@mariopaja
drivers: i2s: stm32_sai fix tx callback mem_block release
339ea04 
This change fixes a wrong buffer release on tx callback which
was not correctly fixed by
zephyrproject-rtos#94696.

Signed-off-by: Mario Paja <mariopaja@hotmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erwango erwango erwango approved these changes

@etienne-lms etienne-lms etienne-lms approved these changes

@anangl anangl Awaiting requested review from anangl

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

@FRASTM FRASTM Awaiting requested review from FRASTM

@gautierg-st gautierg-st Awaiting requested review from gautierg-st

@GeorgeCGV GeorgeCGV Awaiting requested review from GeorgeCGV

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

@mathieuchopstm mathieuchopstm Awaiting requested review from mathieuchopstm

Assignees

@erwango erwango

Labels

area: I2S platform: STM32 ST Micro STM32

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@mariopaja @erwango @etienne-lms @kartben @zephyrbot