drivers: i3c: npcx: introduce I3C driver #71366

alvsun · 2024-04-11T06:33:26Z

This implements basic driver to utilize the I3C IP block on NPCX.

I3C mode: Main controller mode only.
Transfer: Support SDR only.
IBI: Support Hot-Join, IBI(MDB). Controller request is not supported.
Support 3 I3C modules: I3C1(3.3V), I3C2(1.8V, espi mode), (I3C3 1.8V or 3.3V)

github-actions · 2024-04-11T06:34:04Z

Hello @alvsun, and thank you very much for your first pull request to the Zephyr project!
Our Continuous Integration pipeline will execute a series of checks on your Pull Request commit messages and code, and you are expected to address any failures by updating the PR. Please take a look at our commit message guidelines to find out how to format your commit messages, and at our contribution workflow to understand how to update your Pull Request. If you haven't already, please make sure to review the project's Contributor Expectations and update (by amending and force-pushing the commits) your pull request if necessary.
If you are stuck or need help please join us on Discord and ask your question there. Additionally, you can escalate the review when applicable. 😊

alvsun · 2024-04-11T08:25:01Z

This PR depends on #70932.
After #70932 is merged into ToT, will begin the review.

dcpleung · 2024-04-16T16:56:49Z

Could you split this into separate commits? I can see the I3C driver change, clock control change, and SoC/board change.

alvsun · 2024-04-17T05:10:02Z

Could you split this into separate commits? I can see the I3C driver change, clock control change, and SoC/board change.

Done

drivers/i3c/i3c_common.c

drivers/i3c/i3c_npcx.c

XenuIsWatching · 2024-04-21T16:16:42Z

With #70773 now merged... you'll need to add the compat macro to

zephyr/drivers/i3c/i3c_shell.c

Line 88 in 45205f8

DT_FOREACH_STATUS_OKAY(nxp_mcux_i3c, I3C_CTRL_FN)

and

zephyr/drivers/i3c/i3c_shell.c

Line 99 in 45205f8

DT_FOREACH_STATUS_OKAY(cdns_i3c, I3C_CTRL_LIST_ENTRY)

in a separate commit

drivers/i3c/i3c_npcx.c

1. The only valid values of MCLKD clock frequency are between 40Mhz to 50Mhz. 2. If DMA is used, the APB4_CLK clock frequency must be equal to or higher than 20Mhz. Signed-off-by: Alvis Sun <yfsun@nuvoton.com>

Add I3C device nodes. Signed-off-by: Alvis Sun <yfsun@nuvoton.com>

Add I3C pinmux configuration. Signed-off-by: Alvis Sun <yfsun@nuvoton.com>

During DAA, the responding device might not be in the device list. This CL adds target device descriptor's pointer checking to prevent getting unexpected results. Signed-off-by: Alvis Sun <yfsun@nuvoton.com>

alvsun · 2024-04-23T09:18:12Z

With #70773 now merged... you'll need to add the compat macro to

zephyr/drivers/i3c/i3c_shell.c

Line 88 in 45205f8

DT_FOREACH_STATUS_OKAY(nxp_mcux_i3c, I3C_CTRL_FN)

and

zephyr/drivers/i3c/i3c_shell.c

Line 99 in 45205f8

DT_FOREACH_STATUS_OKAY(cdns_i3c, I3C_CTRL_LIST_ENTRY)

in a separate commit

Done (6dd550f)

dts/arm/nuvoton/npcx/npcx4.dtsi

drivers/i3c/i3c_npcx.c

This implements basic driver to utilize the I3C IP block on NPCX. 1. I3C mode: Main controller mode only. 2. Transfer: Support SDR only. 3. IBI: Support Hot-Join, IBI(MDB). Controller request is not supported. 4. Support 3 I3C modules: I3C1(3.3V), I3C2(1.8V, espi mode), (I3C3 1.8V or 3.3V) Signed-off-by: Alvis Sun <yfsun@nuvoton.com>

drivers/i3c/i3c_shell.c

As titile. Signed-off-by: Alvis Sun <yfsun@nuvoton.com>

Add /* zephyr-keep-sorted-start */ around DT_FOREACH_STATUS_OKAY. Signed-off-by: Alvis Sun <yfsun@nuvoton.com>

MulinChao

LGTM.

XenuIsWatching · 2024-04-24T15:23:13Z

drivers/i3c/i3c_npcx.c

+	/* Write data (defining byte or data bytes) for CCC if needed */
+	if (payload->ccc.data_len > 0) {
+		npcx_i3c_status_clear_all(inst);
+		npcx_i3c_errwarn_clear_all(inst);
+		xfered_len = npcx_i3c_xfer_write_fifo(inst, payload->ccc.data,
+						      payload->ccc.data_len, false);
+		if (xfered_len < 0) {
+			LOG_ERR("CCC[0x%02x] %s command payload error (%d)", payload->ccc.id,
+				i3c_ccc_is_payload_broadcast(payload) ? "broadcast" : "direct",
+				ret);
+			ret = xfered_len;
+
+			goto out_do_ccc;
+		}
+
+		/* Write back the transferred bytes */
+		payload->ccc.num_xfer = xfered_len;
+	}


How does this distinguish the difference between the defining byte and payload for the direct CCC in I3C v1.1?

Only the i3c_ccc APIs can tell the difference (e.g., i3c_ccc_do_getstatus()).
This part handles both broadcast and direct CCC write data operations in the earlier stage (marked with red color in the picture below).

github-actions · 2024-04-24T19:41:06Z

Hi @alvsun!
Congratulations on getting your very first Zephyr pull request merged 🎉🥳. This is a fantastic achievement, and we're thrilled to have you as part of our community!

To celebrate this milestone and showcase your contribution, we'd love to award you the Zephyr Technical Contributor badge. If you're interested, please claim your badge by filling out this form: Claim Your Zephyr Badge.

Thank you for your valuable input, and we look forward to seeing more of your contributions in the future! 🪁

alvsun force-pushed the npcx_i3c branch from 76929bc to 602f6a7 Compare April 11, 2024 07:15

alvsun force-pushed the npcx_i3c branch 3 times, most recently from ea170db to 42c5fad Compare April 16, 2024 07:57

alvsun marked this pull request as ready for review April 16, 2024 09:28

alvsun requested review from dcpleung, ssekar15, MulinChao and ChiHuaL as code owners April 16, 2024 09:28

zephyrbot added platform: Nuvoton NPCX Nuvoton NPCX platform: Nuvoton Numicro Numaker Nuvoton Technology Corporation, Numicro Numaker area: I3C area: Devicetree Binding PR modifies or adds a Device Tree binding area: Clock Control labels Apr 16, 2024

zephyrbot requested review from cyliangtw, decsny, fabiobaltieri, galak, jackrosenthal, keith-zephyr, nordic-krch, sjg20 and XenuIsWatching April 16, 2024 09:29

zephyrbot assigned dcpleung Apr 16, 2024

alvsun force-pushed the npcx_i3c branch from 42c5fad to 81a9019 Compare April 17, 2024 05:08

dcpleung previously approved these changes Apr 17, 2024

View reviewed changes

alvsun dismissed dcpleung’s stale review via 450086a April 19, 2024 01:37

alvsun force-pushed the npcx_i3c branch from 81a9019 to 450086a Compare April 19, 2024 01:37

fabiobaltieri reviewed Apr 19, 2024

View reviewed changes

XenuIsWatching reviewed Apr 22, 2024

View reviewed changes

drivers/i3c/i3c_npcx.c Outdated Show resolved Hide resolved

dcpleung assigned MulinChao and ChiHuaL and unassigned dcpleung Apr 22, 2024

alvsun added 4 commits April 23, 2024 16:40

drivers: clock_control: npcx: add MCLKD as i3c source clock

8512919

1. The only valid values of MCLKD clock frequency are between 40Mhz to 50Mhz. 2. If DMA is used, the APB4_CLK clock frequency must be equal to or higher than 20Mhz. Signed-off-by: Alvis Sun <yfsun@nuvoton.com>

dts: arm: nuvoton: add I3C device nodes

145a749

Add I3C device nodes. Signed-off-by: Alvis Sun <yfsun@nuvoton.com>

boards: nuvoton: npcx4m8f_evb: add i3c pinctrl

29ac772

Add I3C pinmux configuration. Signed-off-by: Alvis Sun <yfsun@nuvoton.com>

drivers: i3c: update i3c_dev_list_daa_addr_helper()

ef4d2ec

During DAA, the responding device might not be in the device list. This CL adds target device descriptor's pointer checking to prevent getting unexpected results. Signed-off-by: Alvis Sun <yfsun@nuvoton.com>

alvsun force-pushed the npcx_i3c branch 2 times, most recently from f3fe722 to 6dd550f Compare April 23, 2024 09:12

fabiobaltieri reviewed Apr 23, 2024

View reviewed changes

dts/arm/nuvoton/npcx/npcx4.dtsi Outdated Show resolved Hide resolved

drivers/i3c/i3c_npcx.c Outdated Show resolved Hide resolved

alvsun force-pushed the npcx_i3c branch from 6dd550f to 8d23439 Compare April 24, 2024 02:40

XenuIsWatching reviewed Apr 24, 2024

View reviewed changes

drivers/i3c/i3c_shell.c Show resolved Hide resolved

drivers: i3c: i3c_shell: add nuvoton_npcx_i3c compat macro to i3c_shell.

cc3cc55

As titile. Signed-off-by: Alvis Sun <yfsun@nuvoton.com>

alvsun force-pushed the npcx_i3c branch from 8d23439 to cc3cc55 Compare April 24, 2024 03:18

XenuIsWatching approved these changes Apr 24, 2024

View reviewed changes

drivers: i3c: i3c_shell: add alphabetical order constraint

2fe0f39

Add /* zephyr-keep-sorted-start */ around DT_FOREACH_STATUS_OKAY. Signed-off-by: Alvis Sun <yfsun@nuvoton.com>

alvsun force-pushed the npcx_i3c branch from dde6e07 to 2fe0f39 Compare April 24, 2024 06:01

fabiobaltieri approved these changes Apr 24, 2024

View reviewed changes

MulinChao approved these changes Apr 24, 2024

View reviewed changes

ChiHuaL approved these changes Apr 24, 2024

View reviewed changes

XenuIsWatching reviewed Apr 24, 2024

View reviewed changes

fabiobaltieri merged commit 629bfd9 into zephyrproject-rtos:main Apr 24, 2024
21 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

drivers: i3c: npcx: introduce I3C driver #71366

drivers: i3c: npcx: introduce I3C driver #71366

alvsun commented Apr 11, 2024

github-actions bot commented Apr 11, 2024

alvsun commented Apr 11, 2024 •

edited

dcpleung commented Apr 16, 2024

alvsun commented Apr 17, 2024

XenuIsWatching commented Apr 21, 2024 •

edited

alvsun commented Apr 23, 2024 •

edited

MulinChao left a comment

XenuIsWatching Apr 24, 2024

alvsun Apr 25, 2024 •

edited

github-actions bot commented Apr 24, 2024

drivers: i3c: npcx: introduce I3C driver #71366

drivers: i3c: npcx: introduce I3C driver #71366

Conversation

alvsun commented Apr 11, 2024

github-actions bot commented Apr 11, 2024

alvsun commented Apr 11, 2024 • edited

dcpleung commented Apr 16, 2024

alvsun commented Apr 17, 2024

XenuIsWatching commented Apr 21, 2024 • edited

alvsun commented Apr 23, 2024 • edited

MulinChao left a comment

Choose a reason for hiding this comment

XenuIsWatching Apr 24, 2024

Choose a reason for hiding this comment

alvsun Apr 25, 2024 • edited

Choose a reason for hiding this comment

github-actions bot commented Apr 24, 2024

alvsun commented Apr 11, 2024 •

edited

XenuIsWatching commented Apr 21, 2024 •

edited

alvsun commented Apr 23, 2024 •

edited

alvsun Apr 25, 2024 •

edited