Add realtek rts5817 soc #91486

RtkFP · 2025-06-12T05:49:48Z

This PR adds support for the RTS5817 fingerprint chip from Reatek, which is specially designed for fingerprint applications.

This PR includes initial support for the RTS5817 MAA evaluation board, with drivers as follows:

clock_control
reset
pinctrl
watchdog

Please review these commits.
Thanks!

github-actions · 2025-06-12T05:50:26Z

Hello @RtkFP, 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. 😊

nordicjm · 2025-06-12T12:50:33Z

soc/realtek/fingerprint/soc.yml

+  series:
+  - name: rts5817


(non blocking comment) note you don't need a series, you can just have soc, or family and soc

We change it to family and soc

family: - name: fingerprint socs: - name: rts5817

nordicjm · 2025-06-12T12:52:20Z

boards/realtek/rts5817_maa_evb/Kconfig.defconfig

+
+if BOARD_RTS5817_MAA_EVB
+
+config BOARD


I delete the BOARD config, is it right?

nordicjm · 2025-06-12T12:52:32Z

boards/realtek/rts5817_maa_evb/doc/img/rts5817_maa_evb.jpg

convert to webp, put through https://tinypng.com/

nordicjm · 2025-06-12T12:52:42Z

boards/realtek/rts5817_maa_evb/doc/index.rst

+For now, the following board hardware features are supported by implemented drivers:
+
+-------------------+------------+----------------------+
+| Interface         | Controller | Driver/Component     |
+===================+============+======================+
+| CLOCK             | on-chip    | clock_control        |
+-------------------+------------+----------------------+
+| FLASH             | on-chip    | flash                |
+-------------------+------------+----------------------+
+| GPIO              | on-chip    | gpio                 |
+-------------------+------------+----------------------+
+| SPI(M/S)          | on-chip    | spi                  |
+-------------------+------------+----------------------+
+| UART              | on-chip    | serial               |
+-------------------+------------+----------------------+
+| USB               | on-chip    | USB device           |
+-------------------+------------+----------------------+
+| WDT               | on-chip    | watchdog             |
+-------------------+------------+----------------------+
+| PUF               | on-chip    | puf                  |
+-------------------+------------+----------------------+
+| Temperature sensor| on-chip    | sensor               |
+-------------------+------------+----------------------+


replace with hw directive block

I have replaced it

boards/realtek/rts5817_maa_evb/rts5817_maa_evb-pinctrl.dtsi

nordicjm · 2025-06-12T12:53:23Z

boards/realtek/rts5817_maa_evb/rts5817_maa_evb_defconfig

+# Copyright (c) 2024 Realtek Semiconductor, Inc.
+# SPDX-License-Identifier: Apache-2.0
+
+# enable clocks


capitalise first letter of comments

nordicjm · 2025-06-12T12:53:31Z

boards/realtek/rts5817_maa_evb/rts5817_maa_evb_defconfig

+# enable reset
+CONFIG_RESET=y
+
+# enable serial console
+CONFIG_SERIAL=y
+CONFIG_CONSOLE=y
+CONFIG_UART_CONSOLE=y
+
+# enable watchdog
+CONFIG_WATCHDOG=y
+CONFIG_WDT_DISABLE_AT_BOOT=y


why is reset and watchdog needed?

Becase the watchdog is enabled by default, we have to disable it if we don`t use it, or the system will be reset by the watchdog.
And the reset driver is needed by uart, because it needs to be released from reset state before using it.

RtkFP · 2025-06-16T06:45:12Z

Hi, @nordicjm sorry to bother you.
I have modified some code and force pushed 3 days ago, but some CI checks are still pending. Do you know why?
Thanks!

nordicjm · 2025-06-16T07:43:09Z

Hi, @nordicjm sorry to bother you. I have modified some code and force pushed 3 days ago, but some CI checks are still pending. Do you know why? Thanks!

Needs to be manually approved, have approved it and results should available soon

nordicjm · 2025-06-20T10:47:13Z

soc/realtek/fingerprint/common/CMakeLists.txt

+  set(VERSION ${APPVERSION})
+else()
+  set(VERSION 0)


use a lowercase variable for this, uppercase is global

nordicjm · 2025-06-20T10:47:37Z

boards/realtek/rts5817_maa_evb/Kconfig.defconfig

+# Copyright (c) 2024 Realtek Semiconductor, Inc.
+# SPDX-License-Identifier: Apache-2.0


delete file

RtkFP · 2025-06-23T02:16:45Z

Hi, @nordicjm , this PR is failed at the Maintainer file check[https://github.com/zephyrproject-rtos/zephyr/actions/runs/15776606080/job/44474298748?pr=91486], and I notice that this check is recently added. What can I do to pass the check?
Thanks!

nordicjm · 2025-06-23T06:23:32Z

Hi, @nordicjm , this PR is failed at the Maintainer file check[https://github.com/zephyrproject-rtos/zephyr/actions/runs/15776606080/job/44474298748?pr=91486], and I notice that this check is recently added. What can I do to pass the check? Thanks!

You have added yourself to the file but you are not part of the zephyr organisation, you would need to request access under issues

keith-zephyr · 2025-06-25T21:48:36Z

@nashif - here is an instance matching the discussion at the Process WG. A new SoC added by a brand new contributor.

This PR won't make the 4.2 release cutoff, so we can potentially decide on the new process and use this PR as a proof of concept.

nordicjm

changes OK after update to use soc hook

nordicjm · 2025-07-14T10:56:12Z

soc/realtek/fingerprint/rts5817/soc.c

+static int realtek_rts5817_init(void)
+{
+	cache_init();
+
+	return 0;
+}
+
+SYS_INIT(realtek_rts5817_init, PRE_KERNEL_1, 0);


use soc hooks

Add support for the rts5817 MCU Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

Add clock/interrupt/pinctrl/reset dt-bindings headers for RTS5817 Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

Add Device Tree include files for RTS5817. Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

Add tool to genarate images of RTS5817 after post build stage Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

Add flash runner script to support west flash for rts5817 Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

Add clock control driver for RTS5817 Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

Add reset driver for RTS5817 Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

Add pin controller driver for RTS5817 Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

Add watchdog driver for RTS5817 Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

Add support for rts5817_maa_evb board Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

This commit adds maintainer of Realtek fingerprint SoC to maintainers.yml Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

sonarqubecloud · 2025-07-15T06:50:58Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

RtkFP force-pushed the add_rts5817_soc branch 2 times, most recently from a20c396 to 124c8a0 Compare June 12, 2025 11:08

nordicjm requested changes Jun 12, 2025

View reviewed changes

RtkFP force-pushed the add_rts5817_soc branch from 124c8a0 to 3f509a9 Compare June 13, 2025 02:35

RtkFP marked this pull request as ready for review June 13, 2025 03:03

github-actions bot added area: West West utility area: Clock Control platform: Realtek EC area: Interrupt Controller area: Process area: Watchdog Watchdog area: Pinctrl labels Jun 13, 2025

github-actions bot requested review from carlescufi, decsny, gmarull, JasonLin-RealTek, katsuster, martinjaeger, MaureenHelm, nashif, nordic-krch, pdgendt, stephanosio, swinslow and ycsin June 13, 2025 03:04

github-actions bot assigned nordic-krch Jun 13, 2025

RtkFP force-pushed the add_rts5817_soc branch from 3f509a9 to 84adb48 Compare June 13, 2025 06:04

nordicjm self-requested a review June 16, 2025 07:43

decsny removed their request for review June 17, 2025 14:35

RtkFP force-pushed the add_rts5817_soc branch from 84adb48 to 85e6e29 Compare June 18, 2025 09:14

github-actions bot added the area: UART Universal Asynchronous Receiver-Transmitter label Jun 18, 2025

github-actions bot requested a review from dcpleung June 18, 2025 09:15

RtkFP force-pushed the add_rts5817_soc branch 2 times, most recently from c09a47e to 34f320d Compare June 20, 2025 10:11

nordicjm reviewed Jun 20, 2025

View reviewed changes

RtkFP mentioned this pull request Jun 23, 2025

Collaborator nomination for RtkFP #92004

Open

RtkFP force-pushed the add_rts5817_soc branch from 34f320d to 1112726 Compare July 10, 2025 02:21

RtkFP requested a review from nordicjm July 10, 2025 02:22

nordicjm requested changes Jul 14, 2025

View reviewed changes

RtkFP added 11 commits July 15, 2025 14:23

soc: add realtek RTS5817

41c6483

Add support for the rts5817 MCU Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

include: dt-bindings: add headers for RTS5817

6fc2eab

Add clock/interrupt/pinctrl/reset dt-bindings headers for RTS5817 Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

dts: arm: add dtsi for RTS5817

7716ff0

Add Device Tree include files for RTS5817. Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

soc: realtek: Add image generate tool for RTS5817

be0faaf

Add tool to genarate images of RTS5817 after post build stage Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

script: Add flash runner for rts5817

5a613ec

Add flash runner script to support west flash for rts5817 Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

drivers: clock_control: add clock control for RTS5817

f456c15

Add clock control driver for RTS5817 Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

drivers: reset: add reset driver for RTS5817

cd52378

Add reset driver for RTS5817 Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

drivers: pinctrl: add pinctrl driver for RTS5817

7c9c007

Add pin controller driver for RTS5817 Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

drivers: watchdog: add watchdog driver for RTS5817

b8270de

Add watchdog driver for RTS5817 Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

boards: realtek: add rts5817_maa_evb board

ffe4567

Add support for rts5817_maa_evb board Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

MAINTAINERS: add maintainer for Realtek fingerprint SoC

867caa7

This commit adds maintainer of Realtek fingerprint SoC to maintainers.yml Signed-off-by: Darcy Lu <darcy_lu@realsil.com.cn>

RtkFP force-pushed the add_rts5817_soc branch from 1112726 to 867caa7 Compare July 15, 2025 06:25

		# Copyright (c) 2024 Realtek Semiconductor, Inc.
		# SPDX-License-Identifier: Apache-2.0

Add realtek rts5817 soc #91486

Are you sure you want to change the base?

Add realtek rts5817 soc #91486

Conversation

RtkFP commented Jun 12, 2025

Uh oh!

github-actions bot commented Jun 12, 2025

Uh oh!

nordicjm Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RtkFP commented Jun 16, 2025

Uh oh!

nordicjm commented Jun 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RtkFP commented Jun 23, 2025

Uh oh!

nordicjm commented Jun 23, 2025

Uh oh!

keith-zephyr commented Jun 25, 2025

Uh oh!

nordicjm left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Jul 15, 2025

Quality Gate passed

Uh oh!

Uh oh!

nordicjm Jun 12, 2025 •

edited

Loading