Skip to content

Commit 784f4b6

Browse files
nordic-seglnordic-segl
committed
[nrf fromlist] tests: boards: nrf: i2s: i2s_divider: Confirm CLK divider value
Frame rate selected by the user may not be obtained due to PCLK frequency and finite number of clock divider values. In such case, driver shall select divider that results in frame clock rate closest to the requested value. There was a bug that was discarding perfect match divider. Add test which confirms correct clock divider selection. Upstream PR #: 90720 Signed-off-by: Sebastian Głąb <[email protected]>
1 parent c3a2b10 commit 784f4b6

File tree

8 files changed

+364
-0
lines changed

8 files changed

+364
-0
lines changed

‎tests/boards/nrf/i2s/i2s_divider/CMakeLists.txt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SPDX-License-Identifier: Apache-2.0
2+
3+
cmake_minimum_required(VERSION 3.20.0)
4+
5+
find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
6+
project(i2s_divider)
7+
8+
FILE(GLOB app_sources src/*.c)
9+
target_sources(app PRIVATE ${app_sources})

‎tests/boards/nrf/i2s/i2s_divider/Kconfig‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
#
2+
# Copyright (c) 2025 Nordic Semiconductor ASA
3+
#
4+
# SPDX-License-Identifier: Apache-2.0
5+
#
6+
7+
mainmenu "I2S CLK Divider Test"
8+
9+
source "Kconfig.zephyr"
10+
11+
config I2S_TEST_SKIP_SAMPLERATE_8000
12+
bool "Skip short transfer tests at 8000 samples per socond"
13+
help
14+
When set to 'y', short transfer tests at 8000 samples per second
15+
will be skipped.
16+
17+
config I2S_TEST_SKIP_SAMPLERATE_16000
18+
bool "Skip short transfer tests at 16000 samples per socond"
19+
help
20+
When set to 'y', short transfer tests at 16000 samples per second
21+
will be skipped.
22+
23+
config I2S_TEST_SKIP_SAMPLERATE_32000
24+
bool "Skip short transfer tests at 32000 samples per socond"
25+
help
26+
When set to 'y', short transfer tests at 32000 samples per second
27+
will be skipped.
28+
29+
config I2S_TEST_SKIP_SAMPLERATE_44100
30+
bool "Skip short transfer tests at 44100 samples per socond"
31+
help
32+
When set to 'y', short transfer tests at 44100 samples per second
33+
will be skipped.
34+
35+
config I2S_TEST_SKIP_SAMPLERATE_48000
36+
bool "Skip short transfer tests at 48000 samples per socond"
37+
help
38+
When set to 'y', short transfer tests at 48000 samples per second
39+
will be skipped.
40+
41+
config I2S_TEST_SKIP_SAMPLERATE_88200
42+
bool "Skip short transfer tests at 88200 samples per socond"
43+
help
44+
When set to 'y', short transfer tests at 88200 samples per second
45+
will be skipped.
46+
47+
config I2S_TEST_SKIP_SAMPLERATE_96000
48+
bool "Skip short transfer tests at 96000 samples per socond"
49+
help
50+
When set to 'y', short transfer tests at 96000 samples per second
51+
will be skipped.

‎tests/boards/nrf/i2s/i2s_divider/boards/nrf52840dk_nrf52840.overlay‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/*
2+
* Copyright (c) 2025 Nordic Semiconductor ASA
3+
*
4+
* SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
/ {
8+
aliases {
9+
i2s-node0 = &i2s0;
10+
};
11+
};
12+
13+
&pinctrl {
14+
i2s0_default_alt: i2s0_default_alt {
15+
group1 {
16+
psels = <NRF_PSEL(I2S_SCK_M, 1, 5)>,
17+
<NRF_PSEL(I2S_LRCK_M, 1, 6)>,
18+
<NRF_PSEL(I2S_SDOUT, 1, 1)>,
19+
<NRF_PSEL(I2S_SDIN, 1, 2)>;
20+
};
21+
};
22+
};
23+
24+
&i2s0 {
25+
status = "okay";
26+
pinctrl-0 = <&i2s0_default_alt>;
27+
pinctrl-names = "default";
28+
};

‎tests/boards/nrf/i2s/i2s_divider/boards/nrf5340dk_nrf5340_cpuapp.overlay‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
/*
2+
* Copyright (c) 2025 Nordic Semiconductor ASA
3+
*
4+
* SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
/ {
8+
aliases {
9+
i2s-node0 = &i2s0;
10+
};
11+
};
12+
13+
&pinctrl {
14+
i2s0_default_alt: i2s0_default_alt {
15+
group1 {
16+
psels = <NRF_PSEL(I2S_SCK_M, 1, 6)>,
17+
<NRF_PSEL(I2S_LRCK_M, 1, 7)>,
18+
<NRF_PSEL(I2S_SDOUT, 0, 4)>,
19+
<NRF_PSEL(I2S_SDIN, 0, 5)>;
20+
};
21+
};
22+
};
23+
24+
&uart1 {
25+
status = "disabled";
26+
};
27+
28+
&i2s0 {
29+
status = "okay";
30+
pinctrl-0 = <&i2s0_default_alt>;
31+
pinctrl-names = "default";
32+
};

‎tests/boards/nrf/i2s/i2s_divider/boards/nrf54l15dk_nrf54l15_cpuapp.overlay‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/*
2+
* Copyright (c) 2025 Nordic Semiconductor ASA
3+
*
4+
* SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
/ {
8+
aliases {
9+
i2s-node0 = &i2s20;
10+
};
11+
};
12+
13+
&pinctrl {
14+
i2s20_default_alt: i2s20_default_alt {
15+
group1 {
16+
psels = <NRF_PSEL(I2S_SCK_M, 1, 11)>,
17+
<NRF_PSEL(I2S_LRCK_M, 1, 12)>,
18+
<NRF_PSEL(I2S_SDOUT, 1, 8)>,
19+
<NRF_PSEL(I2S_SDIN, 1, 9)>;
20+
};
21+
};
22+
};
23+
24+
&i2s20 {
25+
status = "okay";
26+
pinctrl-0 = <&i2s20_default_alt>;
27+
pinctrl-names = "default";
28+
};

‎tests/boards/nrf/i2s/i2s_divider/prj.conf‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
CONFIG_ZTEST=y
2+
CONFIG_I2S=y
3+
CONFIG_I2S_LOG_LEVEL_INF=y

‎tests/boards/nrf/i2s/i2s_divider/src/main.c‎

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
/*
2+
* Copyright (c) 2025 Nordic Semiconductor ASA
3+
*
4+
* SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
#include <zephyr/kernel.h>
8+
#include <zephyr/ztest.h>
9+
#include <zephyr/drivers/i2s.h>
10+
#include <zephyr/sys/iterable_sections.h>
11+
12+
#define I2S_DEV_NODE DT_ALIAS(i2s_node0)
13+
14+
#define WORD_SIZE 16U
15+
#define NUMBER_OF_CHANNELS 2
16+
#define FRAME_CLK_FREQ 44100
17+
18+
#define NUM_BLOCKS 2
19+
#define TIMEOUT 1000
20+
21+
#define SAMPLES_COUNT 4
22+
/* Each word has one bit set */
23+
static const int16_t data[SAMPLES_COUNT] = {16, 32, 64, 128};
24+
25+
#define BLOCK_SIZE (2 * sizeof(data))
26+
27+
#ifdef CONFIG_NOCACHE_MEMORY
28+
#define MEM_SLAB_CACHE_ATTR __nocache
29+
#else
30+
#define MEM_SLAB_CACHE_ATTR
31+
#endif /* CONFIG_NOCACHE_MEMORY */
32+
33+
static char MEM_SLAB_CACHE_ATTR __aligned(WB_UP(32))
34+
_k_mem_slab_buf_tx_0_mem_slab[NUM_BLOCKS * WB_UP(BLOCK_SIZE)];
35+
STRUCT_SECTION_ITERABLE(k_mem_slab, tx_0_mem_slab) =
36+
Z_MEM_SLAB_INITIALIZER(tx_0_mem_slab, _k_mem_slab_buf_tx_0_mem_slab,
37+
WB_UP(BLOCK_SIZE), NUM_BLOCKS);
38+
39+
static const struct device *dev_i2s;
40+
41+
static const struct i2s_config default_i2s_cfg = {
42+
.word_size = WORD_SIZE,
43+
.channels = NUMBER_OF_CHANNELS,
44+
.format = I2S_FMT_DATA_FORMAT_I2S,
45+
.frame_clk_freq = FRAME_CLK_FREQ,
46+
.block_size = BLOCK_SIZE,
47+
.timeout = TIMEOUT,
48+
.options = I2S_OPT_FRAME_CLK_MASTER | I2S_OPT_BIT_CLK_MASTER,
49+
.mem_slab = &tx_0_mem_slab,
50+
};
51+
52+
/** @brief Check actual PCM rate at frame_clk_freq=8000.
53+
*
54+
* - Configure I2S stream.
55+
*/
56+
ZTEST(drivers_i2s_clk_div, test_i2s_frame_clk_freq_08000)
57+
{
58+
Z_TEST_SKIP_IFDEF(CONFIG_I2S_TEST_SKIP_SAMPLERATE_8000);
59+
60+
struct i2s_config i2s_cfg = default_i2s_cfg;
61+
int ret;
62+
63+
i2s_cfg.frame_clk_freq = 8000;
64+
65+
ret = i2s_configure(dev_i2s, I2S_DIR_TX, &i2s_cfg);
66+
zassert_ok(ret, "i2s_configure() returned %d", ret);
67+
}
68+
69+
/** @brief Check actual PCM rate at frame_clk_freq=16000.
70+
*
71+
* - Configure I2S stream.
72+
*/
73+
ZTEST(drivers_i2s_clk_div, test_i2s_frame_clk_freq_16000)
74+
{
75+
Z_TEST_SKIP_IFDEF(CONFIG_I2S_TEST_SKIP_SAMPLERATE_16000);
76+
77+
struct i2s_config i2s_cfg = default_i2s_cfg;
78+
int ret;
79+
80+
i2s_cfg.frame_clk_freq = 16000;
81+
82+
ret = i2s_configure(dev_i2s, I2S_DIR_TX, &i2s_cfg);
83+
zassert_ok(ret, "i2s_configure() returned %d", ret);
84+
}
85+
86+
/** @brief Check actual PCM rate at frame_clk_freq=32000.
87+
*
88+
* - Configure I2S stream.
89+
*/
90+
ZTEST(drivers_i2s_clk_div, test_i2s_frame_clk_freq_32000)
91+
{
92+
Z_TEST_SKIP_IFDEF(CONFIG_I2S_TEST_SKIP_SAMPLERATE_32000);
93+
94+
struct i2s_config i2s_cfg = default_i2s_cfg;
95+
int ret;
96+
97+
i2s_cfg.frame_clk_freq = 32000;
98+
99+
ret = i2s_configure(dev_i2s, I2S_DIR_TX, &i2s_cfg);
100+
zassert_ok(ret, "i2s_configure() returned %d", ret);
101+
}
102+
103+
/** @brief Check actual PCM rate at frame_clk_freq=44100.
104+
*
105+
* - Configure I2S stream.
106+
*/
107+
ZTEST(drivers_i2s_clk_div, test_i2s_frame_clk_freq_44100)
108+
{
109+
Z_TEST_SKIP_IFDEF(CONFIG_I2S_TEST_SKIP_SAMPLERATE_44100);
110+
111+
struct i2s_config i2s_cfg = default_i2s_cfg;
112+
int ret;
113+
114+
i2s_cfg.frame_clk_freq = 44100;
115+
116+
ret = i2s_configure(dev_i2s, I2S_DIR_TX, &i2s_cfg);
117+
zassert_ok(ret, "i2s_configure() returned %d", ret);
118+
}
119+
120+
/** @brief Check actual PCM rate at frame_clk_freq=48000.
121+
*
122+
* - Configure I2S stream.
123+
*/
124+
ZTEST(drivers_i2s_clk_div, test_i2s_frame_clk_freq_48000)
125+
{
126+
Z_TEST_SKIP_IFDEF(CONFIG_I2S_TEST_SKIP_SAMPLERATE_48000);
127+
128+
struct i2s_config i2s_cfg = default_i2s_cfg;
129+
int ret;
130+
131+
i2s_cfg.frame_clk_freq = 48000;
132+
133+
ret = i2s_configure(dev_i2s, I2S_DIR_TX, &i2s_cfg);
134+
zassert_ok(ret, "i2s_configure() returned %d", ret);
135+
}
136+
137+
/** @brief Check actual PCM rate at frame_clk_freq=88200.
138+
*
139+
* - Configure I2S stream.
140+
*/
141+
ZTEST(drivers_i2s_clk_div, test_i2s_frame_clk_freq_88200)
142+
{
143+
Z_TEST_SKIP_IFDEF(CONFIG_I2S_TEST_SKIP_SAMPLERATE_88200);
144+
145+
struct i2s_config i2s_cfg = default_i2s_cfg;
146+
int ret;
147+
148+
i2s_cfg.frame_clk_freq = 88200;
149+
150+
ret = i2s_configure(dev_i2s, I2S_DIR_TX, &i2s_cfg);
151+
zassert_ok(ret, "i2s_configure() returned %d", ret);
152+
}
153+
154+
/** @brief Check actual PCM rate at frame_clk_freq=96000.
155+
*
156+
* - Configure I2S stream.
157+
*/
158+
ZTEST(drivers_i2s_clk_div, test_i2s_frame_clk_freq_96000)
159+
{
160+
Z_TEST_SKIP_IFDEF(CONFIG_I2S_TEST_SKIP_SAMPLERATE_96000);
161+
162+
struct i2s_config i2s_cfg = default_i2s_cfg;
163+
int ret;
164+
165+
i2s_cfg.frame_clk_freq = 96000;
166+
167+
ret = i2s_configure(dev_i2s, I2S_DIR_TX, &i2s_cfg);
168+
zassert_ok(ret, "i2s_configure() returned %d", ret);
169+
}
170+
171+
static void *suite_setup(void)
172+
{
173+
/* Check I2S Device. */
174+
dev_i2s = DEVICE_DT_GET_OR_NULL(I2S_DEV_NODE);
175+
zassert_not_null(dev_i2s, "I2S device not found");
176+
zassert(device_is_ready(dev_i2s), "I2S device not ready");
177+
178+
return 0;
179+
}
180+
181+
ZTEST_SUITE(drivers_i2s_clk_div, NULL, suite_setup, NULL, NULL, NULL);

‎tests/boards/nrf/i2s/i2s_divider/testcase.yaml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
tests:
2+
boards.nrf.i2s.i2s_divider:
3+
tags:
4+
- drivers
5+
- i2s
6+
harness: console
7+
harness_config:
8+
type: multi_line
9+
ordered: true
10+
regex:
11+
- "test_i2s_frame_clk_freq_08000"
12+
- "I2S MCK frequency: 256000, actual PCM rate: 8000"
13+
- "test_i2s_frame_clk_freq_16000"
14+
- "I2S MCK frequency: 507936, actual PCM rate: 15873"
15+
- "test_i2s_frame_clk_freq_32000"
16+
- "I2S MCK frequency: 1032258, actual PCM rate: 32258"
17+
- "test_i2s_frame_clk_freq_44100"
18+
- "I2S MCK frequency: 1391304, actual PCM rate: 43478"
19+
- "test_i2s_frame_clk_freq_48000"
20+
- "I2S MCK frequency: 1523809, actual PCM rate: 47619"
21+
- "test_i2s_frame_clk_freq_88200"
22+
- "I2S MCK frequency: 2909090, actual PCM rate: 90909"
23+
- "test_i2s_frame_clk_freq_96000"
24+
- "I2S MCK frequency: 3200000, actual PCM rate: 100000"
25+
- "PROJECT EXECUTION SUCCESSFUL"
26+
platform_allow:
27+
- nrf52840dk/nrf52840
28+
- nrf5340dk/nrf5340/cpuapp
29+
- nrf54l15dk/nrf54l15/cpuapp
30+
integration_platforms:
31+
- nrf52840dk/nrf52840
32+
- nrf54l15dk/nrf54l15/cpuapp

0 commit comments

Comments
 (0)