Add realtek rts5912 soc #75267

JasonLin-RealTek · 2024-07-01T13:02:53Z

This PR adds support for the RTS5912 EC Chip from Realtek.

The initial support for the board includes TIMER, GPIO, CLOCK_CONTROL, PINCTRL.

please help us review the pull request.

Thanks!

github-actions · 2024-07-01T13:03:34Z

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

gmarull

please, organize commit content properly, it seems that first commit contains e.g. pinctrl stuff which should not be there.

nordicjm · 2024-07-01T13:30:20Z

boards/realtek/rts5912_evb/Kconfig.defconfig

+config BOARD
+	default "rts5912_evb"


Suggested change

config BOARD

default "rts5912_evb"

this is hwmv1

nordicjm · 2024-07-01T13:30:33Z

boards/realtek/rts5912_evb/Kconfig.rts5912_evb

+#
+
+config BOARD_RTS5912_EVB
+	bool "Realtek RTS5912 Evaluation Board"


Suggested change

bool "Realtek RTS5912 Evaluation Board"

nordicjm · 2024-07-01T13:30:57Z

boards/realtek/rts5912_evb/doc/rts5912evb.png

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

nordicjm · 2024-07-01T13:31:25Z

boards/realtek/rts5912_evb/rts5912_evb.dts

+&cpu0 {
+	cpu-power-states = <&idle &suspend_to_ram>;
+};
+


non-blocking comment: should there be flash partitions here?

unaddressed

power states must not be at board level

We have put those power state to rts5912.dtsi.

nordicjm · 2024-07-01T13:31:40Z

boards/realtek/rts5912_evb/rts5912_evb_defconfig

+# Serial Driver
+CONFIG_SERIAL=y
+
+# CONSOLE


Suggested change

# CONSOLE

# Console

nordicjm · 2024-07-01T13:37:04Z

soc/realtek/ec/Kconfig.defconfig

+if SOC_FAMILY_REALTEK_EC
+rsource "*/Kconfig.defconfig.series"
+endif # SOC_FAMILY_REALTEK_EC


Suggested change

if SOC_FAMILY_REALTEK_EC

rsource "*/Kconfig.defconfig.series"

endif # SOC_FAMILY_REALTEK_EC

if SOC_FAMILY_REALTEK_EC

rsource "*/Kconfig.defconfig.series"

endif # SOC_FAMILY_REALTEK_EC

nordicjm · 2024-07-01T13:37:12Z

soc/realtek/ec/Kconfig.soc

+config SOC_FAMILY_REALTEK_EC
+	bool
+config SOC_FAMILY


add newline

soc/realtek/ec/rts5912/Kconfig

nordicjm · 2024-07-01T13:37:54Z

soc/realtek/ec/rts5912/Kconfig

+	bool "Realtek RTS5912 Series EC"
+	select ARM
+	select CPU_CORTEX_M33
+	select SOC_FAMILY_REALTEK_EC


Suggested change

select SOC_FAMILY_REALTEK_EC

nordicjm · 2024-07-01T13:39:41Z

soc/realtek/ec/rts5912/Kconfig.soc

+config SOC_SERIES
+	default "rts5912" if SOC_SERIES_RTS5912
+
+config SOC_RTS5912
+	bool
+	select SOC_SERIES_RTS5912
+
+config SOC
+	default "rts5912" if SOC_RTS5912


non-blocking comment: do you really need a soc series when the soc and soc series name as the same? Is this really a series?

There may be series and plenty of SoCs with different names in the future.

In order to maintain the consistency of the folder structure, we will use the same name for the series and SoCs for now.

JasonLin-RealTek · 2024-07-04T02:39:12Z

please, organize commit content properly, it seems that first commit contains e.g. pinctrl stuff which should not be there.

We followed the suggestions to fix the code and passed the twister testing.
Are there any further suggestions? Could you please approve the PR?

gmarull

I can't see any changes regarding my previous request

JasonLin-RealTek · 2024-07-05T11:11:20Z

I can't see any changes regarding my previous request

We misunderstood the request and moved the [pinctrl+register] files to their own commit.
Now we have committed the device tree file into a single commit.
Is that correct?

nordicjm · 2024-07-08T08:55:06Z

soc/realtek/ec/Kconfig

+if SOC_FAMILY_REALTEK_EC
+
+menuconfig REALTEK_RTS5912_IMG_HEADER
+	bool "The output binary with RTS5912 image header"


Suggested change

bool "The output binary with RTS5912 image header"

bool "Add RTS5912 image header to output binary"

nordicjm · 2024-07-08T08:55:15Z

soc/realtek/ec/Kconfig

+menuconfig REALTEK_RTS5912_IMG_HEADER
+	bool "The output binary with RTS5912 image header"
+	help
+	  the RTS5912 ROM code loads firmware image from flash to RAM by the image header setting. 


soc/realtek/ec/Kconfig

nordicjm · 2024-07-08T08:56:45Z

soc/realtek/ec/Kconfig

+choice REALTEK_RTS5912_IMG_HEADER_SPI_FREQ_MHZ_CHOICE
+	prompt "Clock frequency to use for SPI flash"
+	default REALTEK_RTS5912_IMG_HEADER_SPI_FREQ_MHZ_DIV1
+	help
+	  This selects the SPI clock frequency that will be used for loading
+	  firmware binary from flash to RAM.
+
+config REALTEK_RTS5912_IMG_HEADER_SPI_FREQ_MHZ_DIV1
+	bool "SPI flash clock frequency is SPIC engine clock divide 1"
+
+config REALTEK_RTS5912_IMG_HEADER_SPI_FREQ_MHZ_DIV2
+	bool "SPI flash clock frequency is SPIC engine clock divide 2"
+
+config REALTEK_RTS5912_IMG_HEADER_SPI_FREQ_MHZ_DIV4
+	bool "SPI flash clock frequency is SPIC engine clock divide 4"
+
+config REALTEK_RTS5912_IMG_HEADER_SPI_FREQ_MHZ_DIV8
+	bool "SPI flash clock frequency is SPIC engine clock divide 8"
+
+endchoice # REALTEK_RTS5912_IMG_HEADER_SPI_FREQ_MHZ_CHOICE
+
+config REALTEK_RTS5912_IMG_HEADER_SPI_FREQ_MHZ
+	int
+	default 0 if REALTEK_RTS5912_IMG_HEADER_SPI_FREQ_MHZ_DIV1
+	default 1 if REALTEK_RTS5912_IMG_HEADER_SPI_FREQ_MHZ_DIV2
+	default 2 if REALTEK_RTS5912_IMG_HEADER_SPI_FREQ_MHZ_DIV4
+	default 3 if REALTEK_RTS5912_IMG_HEADER_SPI_FREQ_MHZ_DIV8
+


But they should come from dts, not Kconfig

nordicjm · 2024-07-08T08:57:05Z

soc/realtek/ec/Kconfig

+
+endif # REALTEK_RTS5912_IMG_HEADER
+
+#source "soc/realtek/*/Kconfig.soc"


Suggested change

#source "soc/realtek/*/Kconfig.soc"

drivers/clock_control/clock_control_rts5912_sccon.c

drivers/timer/realtek_rts5912_rtmr.c

drivers/gpio/gpio_rts5912.c

drivers/serial/uart_realtek_rts5912.c

fabiobaltieri

Just a couple more nitpicks from me, thanks

fabiobaltieri · 2024-11-21T15:04:40Z

dts/arm/realtek/ec/rts5912.dtsi

+		pinctrl-0 = <	&jtag_tdi_gpio87 &jtag_tdo_gpio88 &jtag_rst_gpio89
+				&jtag_clk_gpio90 &jtag_tms_gpio91>;


nit, the indentation got a bit funny here, drop the leading spaces

We remove the leading spaces in next version of PR and align jtag_clk_gpio90 to the jtag_tdi_gpio87.

fabiobaltieri · 2024-11-21T15:06:18Z

dts/arm/realtek/ec/rts5912.dtsi

+				interrupts = <	0 0 1 0 2 0 3 0
+						4 0 5 0 6 0 7 0
+						8 0 9 0 10 0 11 0
+						12 0 13 0 14 0 15 0>;


same for all of these

interrupts = <0 0 1 0 2 0 3 0 4 0 5 0 6 0 7 0

etc

As the sample, we modified the interrupt numbers format.

JasonLin-RealTek · 2024-11-26T06:57:59Z

We have run ruff to format the img_gen.py.

JasonLin-RealTek · 2024-11-27T08:25:00Z

Fix merging conflicts.

Add support for Realtek RTS5912 embedded controller (EC). Signed-off-by: Lin Yu-Cheng <[email protected]>

Add Realtek RTS5912 chip and driver device tree files. Signed-off-by: Lin Yu-Cheng <[email protected]>

bjarki-andreasen

Looks good, cool to see an soc can be added without deleting a single line of code :)

drivers/clock_control/clock_control_rts5912_sccon.c

drivers/gpio/gpio_rts5912.c

drivers/serial/uart_realtek_rts5912.c

Add clock controller driver for Realtek RTS5912. Signed-off-by: Lin Yu-Cheng <[email protected]>

Add pinctrl driver for Realtek RTS5912. Signed-off-by: Lin Yu-Cheng <[email protected]>

Add swj driver for Realtek RTS5912. Signed-off-by: Lin Yu-Cheng <[email protected]>

Add timer driver for Realtek RTS5912. Signed-off-by: Lin Yu-Cheng <[email protected]>

Add gpio driver for Realtek RTS5912. Signed-off-by: Lin Yu-Cheng <[email protected]>

Add UART driver for Realtek RTS5912. Signed-off-by: Lin Yu-Cheng <[email protected]>

Add support for Realtek rts5912_evb board Signed-off-by: Lin Yu-Cheng <[email protected]>

This commit adds api and driver of Realtek EC to maintainers.yml Signed-off-by: Lin Yu-Cheng <[email protected]>

gmarull · 2024-12-03T08:09:01Z

soc/realtek/ec/rts5912/device_power.c

+
+#include <zephyr/logging/log.h>
+#include <zephyr/kernel.h>
+#include <zephyr/pm/pm.h>


why is PM involved at all here?

gmarull · 2024-12-03T08:10:25Z

dts/bindings/pinctrl/realtek,rts5912-pinctrl.yaml

+description: |
+     This binding gives a base representation of the pins configuration
+
+compatible: "realtek,rts5912-pinctrl"
+
+include: [base.yaml, pinctrl-device.yaml, pincfg-node.yaml]
+
+properties:
+  reg:
+    required: true
+
+child-binding:
+  description: |
+    This binding gives a base representation of the pins configuration
+
+  include:
+    - name: pincfg-node.yaml
+


missing docs, list of allowed properties?

gmarull · 2024-12-03T08:11:31Z

include/zephyr/dt-bindings/pinctrl/realtek-rts5912-pinctrl.h

+#define STD_GPIO_FUNC1                                                                             \
+	((REALTEK_RTS5912_FUNC1) | (REALTEK_RTS5912_GPIO_PINON) | (REALTEK_RTS5912_GPIO_SCHMITTER))
+#define STD_GPIO_FUNC2                                                                             \
+	((REALTEK_RTS5912_FUNC2) | (REALTEK_RTS5912_GPIO_PINON) | (REALTEK_RTS5912_GPIO_SCHMITTER))
+#define STD_GPIO_FUNC3                                                                             \


why is schmitt trigger configured here? there are standard properties for that

gmarull · 2024-12-03T08:11:53Z

include/zephyr/dt-bindings/pinctrl/realtek-rts5912-pinctrl.h

+#define REALTEK_RTS5912_GPIO_DRIVING   BIT(11) /* DRIVING : 0 low  1 high  */
+#define REALTEK_RTS5912_GPIO_SLEW      BIT(12) /* SLEW : 0 fast  1 slow  */
+#define REALTEK_RTS5912_GPIO_PULLDN    BIT(13) /* PULL DOWN : 0 disable 1 ebable */
+#define REALTEK_RTS5912_GPIO_PULLUP    BIT(14) /* PULL UP : 0 disable 1 ebable */
+#define REALTEK_RTS5912_GPIO_SCHMITTER BIT(15) /* Schmitter : 1 ebable 0 disable */
+#define REALTEK_RTS5912_GPIO_TYPE      BIT(16) /* TYPE : 0 PP 1 OD */
+#define REALTEK_RTS5912_GPIO_HILOW     BIT(17) /* OUTPUT : 0 low 1 high */
+
+#define REALTEK_RTS5912_INPUT_OUTPUT_POS    0
+#define REALTEK_RTS5912_INPUT_DETECTION_POS 1


same here: these are props that need to be managed using standard props.

zephyrbot added area: UART Universal Asynchronous Receiver-Transmitter area: Timer Timer area: Pinctrl area: GPIO area: Devicetree Binding PR modifies or adds a Device Tree binding area: Clock Control labels Jul 1, 2024

zephyrbot requested review from andyross, dcpleung, decsny, galak, gmarull, henrikbrixandersen, mnkp, nordic-krch and teburd July 1, 2024 13:03

zephyrbot assigned nordic-krch Jul 1, 2024

gmarull requested changes Jul 1, 2024

View reviewed changes

nordicjm requested changes Jul 1, 2024

View reviewed changes

JasonLin-RealTek force-pushed the add_realtek_rts5912_soc branch 2 times, most recently from e16ff4a to 7a10790 Compare July 3, 2024 11:08

JasonLin-RealTek requested review from gmarull and nordicjm July 5, 2024 03:10

gmarull requested changes Jul 5, 2024

View reviewed changes

JasonLin-RealTek force-pushed the add_realtek_rts5912_soc branch from 7a10790 to 7b8a3da Compare July 5, 2024 10:51

JasonLin-RealTek requested a review from gmarull July 8, 2024 02:15

nordicjm reviewed Jul 8, 2024

View reviewed changes

JasonLin-RealTek force-pushed the add_realtek_rts5912_soc branch from 7b8a3da to 2a3274a Compare July 8, 2024 11:37

JasonLin-RealTek force-pushed the add_realtek_rts5912_soc branch from 9201411 to 38a84ee Compare October 30, 2024 12:51

fabiobaltieri reviewed Nov 8, 2024

View reviewed changes

JasonLin-RealTek force-pushed the add_realtek_rts5912_soc branch from 38a84ee to c7b4bc6 Compare November 14, 2024 07:24

fabiobaltieri reviewed Nov 21, 2024

View reviewed changes

JasonLin-RealTek force-pushed the add_realtek_rts5912_soc branch 2 times, most recently from 5538070 to af9133b Compare November 26, 2024 06:51

JasonLin-RealTek force-pushed the add_realtek_rts5912_soc branch from af9133b to 905c9f5 Compare November 27, 2024 08:22

JasonLin-RealTek force-pushed the add_realtek_rts5912_soc branch from 905c9f5 to 1c008f0 Compare November 27, 2024 10:07

JasonLin-RealTek added 2 commits November 27, 2024 19:32

soc: realrek: ec: Add Realtek RTS5912 SoC

d5ac381

Add support for Realtek RTS5912 embedded controller (EC). Signed-off-by: Lin Yu-Cheng <[email protected]>

dts: realtek: Add RTS5912 device tree files

891cb52

Add Realtek RTS5912 chip and driver device tree files. Signed-off-by: Lin Yu-Cheng <[email protected]>

JasonLin-RealTek force-pushed the add_realtek_rts5912_soc branch 2 times, most recently from 737ac11 to aaa6d25 Compare November 28, 2024 03:24

fabiobaltieri previously approved these changes Nov 29, 2024

View reviewed changes

bjarki-andreasen previously approved these changes Nov 29, 2024

View reviewed changes

pdgendt reviewed Nov 29, 2024

View reviewed changes

drivers/clock_control/clock_control_rts5912_sccon.c Outdated Show resolved Hide resolved

drivers/gpio/gpio_rts5912.c Outdated Show resolved Hide resolved

drivers/serial/uart_realtek_rts5912.c Outdated Show resolved Hide resolved

JasonLin-RealTek added 8 commits December 2, 2024 11:22

driver: clock_control: Add clock controller initial version of RTS5912.

3480cc0

Add clock controller driver for Realtek RTS5912. Signed-off-by: Lin Yu-Cheng <[email protected]>

driver: pinctrl: Add pinctrl initial version of RTS5912.

5296ca6

Add pinctrl driver for Realtek RTS5912. Signed-off-by: Lin Yu-Cheng <[email protected]>

soc: realrek: ec: Add debug_swj initial version of RTS5912.

4c79cf4

Add swj driver for Realtek RTS5912. Signed-off-by: Lin Yu-Cheng <[email protected]>

driver: timer: Add timer driver initial version of RTS5912.

9fde7d1

Add timer driver for Realtek RTS5912. Signed-off-by: Lin Yu-Cheng <[email protected]>

driver: gpio: Add gpio driver initial version of RTS5912.

316d41f

Add gpio driver for Realtek RTS5912. Signed-off-by: Lin Yu-Cheng <[email protected]>

driver: serial: Add UART driver initial version of RTS5912.

c1633c3

Add UART driver for Realtek RTS5912. Signed-off-by: Lin Yu-Cheng <[email protected]>

boards: realtek: Add rts5912_evb board

9787d91

Add support for Realtek rts5912_evb board Signed-off-by: Lin Yu-Cheng <[email protected]>

MAINTAINERS: add maintainer for Realtek EC api and driver

cf5701d

This commit adds api and driver of Realtek EC to maintainers.yml Signed-off-by: Lin Yu-Cheng <[email protected]>

JasonLin-RealTek dismissed stale reviews from bjarki-andreasen and fabiobaltieri via cf5701d December 2, 2024 03:24

JasonLin-RealTek force-pushed the add_realtek_rts5912_soc branch from aaa6d25 to cf5701d Compare December 2, 2024 03:24

keith-zephyr approved these changes Dec 2, 2024

View reviewed changes

gmarull requested changes Dec 3, 2024

View reviewed changes

	bool "The output binary with RTS5912 image header"
	bool "Add RTS5912 image header to output binary"


		endif # REALTEK_RTS5912_IMG_HEADER

		#source "soc/realtek/*/Kconfig.soc"

		pinctrl-0 = < &jtag_tdi_gpio87 &jtag_tdo_gpio88 &jtag_rst_gpio89
		&jtag_clk_gpio90 &jtag_tms_gpio91>;

Add realtek rts5912 soc #75267

Are you sure you want to change the base?

Add realtek rts5912 soc #75267

Conversation

JasonLin-RealTek commented Jul 1, 2024

github-actions bot commented Jul 1, 2024

gmarull left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JasonLin-RealTek commented Jul 4, 2024 • edited Loading

gmarull left a comment

Choose a reason for hiding this comment

JasonLin-RealTek commented Jul 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fabiobaltieri left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JasonLin-RealTek commented Nov 26, 2024

JasonLin-RealTek commented Nov 27, 2024

bjarki-andreasen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JasonLin-RealTek commented Jul 4, 2024 •

edited

Loading