Add Basic support for Microchip SAM D5X/E5X Family devices #93450

ArunMCHP · 2025-07-21T14:07:08Z

This PR adds initial support for Microchip’s SAM D5x/E5x family of SoCs, along with board support for the SAM E54 Xplained Pro development kit (ATSAME54-XPRO). It includes the basic SoC integration, devicetree files, and minimal configuration needed to bring up the board with a working UART console.

Associated pull request for the addition of the SAM D5x/E5x devices to hal_microchip:
zephyrproject-rtos/hal_microchip#33

The naming convention of driver files and device organization is as per the RFC : #92168

github-actions · 2025-07-21T14:07:59Z

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

github-actions · 2025-07-21T14:08:58Z

The following west manifest projects have changed revision in this Pull Request:

Name	Old Revision	New Revision	Diff
hal_microchip	zephyrproject-rtos/hal_microchip@`32a79d4`	zephyrproject-rtos/hal_microchip@`97485f8` (`master`)	zephyrproject-rtos/hal_microchip@32a79d48..97485f8d

✅ All manifest checks OK

Note: This message is automatically posted and updated by the Manifest GitHub Action.

nordicjm · 2025-07-22T06:24:34Z

soc/microchip/sam/sam_d5x_e5x/Kconfig.soc

+config SOC_FAMILY
+	default "microchip_sam_d5x_e5x" if SOC_FAMILY_MCHP_SAM_D5X_E5X


names do not match

Renamed to mchp_sam_d5x_e5x

Hi @nordicjm ,

It is not clear what naming you are referring for:

Is the default "microchip_sam_d5x_e5x" that should match with the folder structure ?

soc/microchip/sam/sam_d5x_e5x or soc/microchip/sam/d5x_e5x
or even

SOC_FAMILY_MCHP_SAM_D5X_E5X should be SOC_FAMILY_MICROCHIP_SAM_D5X_E5X ?

soc.yml values e.g family must match the string here and Kconfig name for the family

nordicjm · 2025-07-22T06:26:56Z

soc/microchip/sam/sam_d5x_e5x/Kconfig.soc

+config SOC_SERIES_REVISION_N
+	bool
+	depends on SOC_FAMILY_MCHP_SAM_D5X_E5X
+
+config SOC_SERIES_REVISION
+	string
+	default "n" if SOC_SERIES_REVISION_N
+	default ""
+	depends on SOC_FAMILY_MCHP_SAM_D5X_E5X


do not think this should be here @tejlmand

Removed this.

nordicjm · 2025-07-22T06:27:09Z

soc/microchip/sam/sam_d5x_e5x/samd51/Kconfig.soc

+config SOC_SERIES
+	default "samd51" if SOC_SERIES_MCHP_SAMD51


does not match

Renamed to mchp_samd51.

nordicjm · 2025-07-22T06:27:14Z

soc/microchip/sam/sam_d5x_e5x/samd51/Kconfig.soc

+
+config SOC_SERIES
+	default "samd51" if SOC_SERIES_MCHP_SAMD51
+


Suggested change

nordicjm · 2025-07-22T06:27:22Z

soc/microchip/sam/sam_d5x_e5x/samd51/Kconfig.soc

+config SOC_ATSAMD51P20A
+	bool
+	select SOC_SERIES_MCHP_SAMD51
+


Suggested change

nordicjm · 2025-07-22T06:29:48Z

drivers/pinctrl/Kconfig.mchp

+config PINCTRL_MCHP_PORT_ID_U2210_2_2_0
+	bool
+	default n
+	help
+	  Internal flag to enable PORT ID U2210_2_2_0 support.


put this in an if so it's not bleeding into other devices

We moved this symbol to family kconfig.soc, and kept inside if SOC_FAMILY_MCHP_SAM_D5X_E5X.
path : soc/microchip/sam/sam_d5x_e5x/Kconfig.soc

nordicjm · 2025-07-22T06:29:56Z

drivers/pinctrl/Kconfig.mchp

+
+config PINCTRL_MCHP_PORT_ID_U2210_2_2_0
+	bool
+	default n


Suggested change

default n

fix in whole PR

moved to family kconfig.soc and fixed.

nordicjm · 2025-07-22T06:30:21Z

drivers/serial/Kconfig.mchp

+	select PINCTRL
+	select UART_MCHP_SERCOM_ID_U2201_5_0_0 if SOC_FAMILY_MCHP_SAM_D5X_E5X
+	help
+		This option enables the USART driver for Microchip sercom-g1 IPs.


help text indent in 1x tab followed by 2x spaces

nordicjm · 2025-07-22T06:30:46Z

boards/microchip/sam/sam_e54_xpro/doc/img/atsam_e54_xpro.webp

reduce resolution and put through https://tinypng.com/

Reduced resolution using https://tinypng.com/ and updated.

nordicjm · 2025-07-22T06:30:49Z

boards/microchip/sam/sam_e54_xpro/doc/img/atsam_e54_xpro_pinout.webp

reduce resolution and put through https://tinypng.com/

Reduced resolution using https://tinypng.com/ and updated.

parthitce

Please re-order the commits.

parthitce · 2025-07-23T07:18:54Z

soc/microchip/sam/sam_d5x_e5x/Kconfig.soc

+# List of Peripheral IPs available in SOC_FAMILY_MCHP_SAM_D5X_E5X family
+if SOC_FAMILY_MCHP_SAM_D5X_E5X
+
+config UART_MCHP_SERCOM_U2201_5_0_0


this shall be part of board IMO

Here, we define peripheral IP versions as Kconfig symbols at the SoC family level, since these IPs are shared across multiple SoCs in the SAM D5X/E5X family. Keeping them here avoids duplication when supporting multiple boards, for example, if we later add support for the SAME54 Curiosity board, we won’t need to redefine the same IP symbols again.

parthitce · 2025-07-23T07:18:59Z

soc/microchip/sam/sam_d5x_e5x/Kconfig.soc

+	help
+	  Enable SERCOM UART peripheral IP version 5.0.0 (U2201).
+
+config PINCTRL_MCHP_PORT_U2210_2_2_0


Refer the response to previous comment.

parthitce · 2025-07-23T07:19:40Z

soc/microchip/sam/sam_d5x_e5x/common/CMakeLists.txt

+
+zephyr_sources(soc.c)
+
+zephyr_include_directories(.)


no header inside common

Removed zephyr_include_directories(.)

parthitce · 2025-07-23T07:20:01Z

soc/microchip/sam/sam_d5x_e5x/common/CMakeLists.txt

+
+zephyr_include_directories(.)
+
+zephyr_include_directories(${ZEPHYR_BASE}/drivers)


There is no header under drivers

Removed zephyr_include_directories(${ZEPHYR_BASE}/drivers)

parthitce · 2025-07-23T07:20:21Z

soc/microchip/sam/sam_d5x_e5x/common/soc.c

+
+void soc_reset_hook(void)
+{
+	/* Intentionally empty */


then it's not required

The soc_reset_hook has been included to maintain a consistent structure. Although this file is currently empty, it serves as a placeholder for future peripheral driver additions and enables users to add custom code to execute during reset.

@parthitce Yes, removed this file. Thanks.

parthitce · 2025-07-23T07:28:36Z

drivers/clock_control/clock_mchp_sam_d5x_e5x.c

+		/* Validate subsystem. */
+		if (CLOCK_SUCCESS != clock_check_subsys(subsys)) {
+			ret_val = -ENOTSUP;
+			break;


Refer the response to previous comment

parthitce · 2025-07-23T07:29:22Z

drivers/clock_control/Kconfig.mchp

+# Common features for all SOC families
+if CLOCK_CONTROL_MCHP
+
+config CLOCK_CONTROL_MCHP_GET_RATE


why is this special ?

Since the clock rates for multiple levels of clock sources need to be calculated, this feature increases the program size. Therefore, it has been made optional, allowing the user to decide whether to enable it.

parthitce · 2025-07-23T07:29:35Z

drivers/clock_control/clock_mchp_sam_d5x_e5x.c

+	do {
+		/* Check if turning on all clocks is requested. */
+		if (subsys.val == (uint32_t)CLOCK_CONTROL_SUBSYS_ALL) {
+			break;


Please refer the response to previous comment

parthitce · 2025-07-23T07:30:03Z

drivers/clock_control/clock_mchp_sam_d5x_e5x.c

+	default:
+		LOG_ERR("Unsupported mclkbus");
+		break;
+	}


new line, applies everywhere

New line provided.

parthitce · 2025-07-23T07:30:49Z

drivers/clock_control/clock_mchp_sam_d5x_e5x.c

+	bool is_wait = false;
+	uint32_t on_timeout_ms = 0;
+
+	subsys.val = (uint32_t)sys;


move to declaration + init form

Update west.yml for SAM_D5X_E5X Device family pack Signed-off-by: Arunprasath P <arunprasath.p@microchip.com>

parthitce · 2025-07-24T04:14:18Z

drivers/clock_control/clock_mchp_sam_d5x_e5x.c

+		gclkgen_src = (gclk_regs->GCLK_GENCTRL[gclkgen_id] & GCLK_GENCTRL_SRC_Msk) >>
+			      GCLK_GENCTRL_SRC_Pos;
+		if (gclkgen_called_src == gclkgen_src) {
+			ret_val = -ELOOP;


ELOOP? Have you read clock_control_get_rate ?

Hi @parthitce, do You suggest to use -ENOTSUP here?
-ELOOP was used to show circular clock dependency error.
Is it not allowed to use a different error code from those mentioned in API header, to show a specific error cause, which can make debug easier?.

Adds initial SoC-level support for the Microchip SAM D5x and E5x series, including SoC definition files. Signed-off-by: Arunprasath P <arunprasath.p@microchip.com>

Add minimal set of binding parameters for clock_control driver. Signed-off-by: Sunil Abraham <sunil.abraham@microchip.com>

Add clock control driver with minimal functionality. Implement basic on, off, get_status and get_rate API. Signed-off-by: Sunil Abraham <sunil.abraham@microchip.com>

Add binding parameters for Microchip Pinctrl Port G1 IP Signed-off-by: Mohamed Azhar <mohamed.azhar@microchip.com>

Add pinctrl driver for Microchip Port G1 Peripheral IPs Signed-off-by: Mohamed Azhar <mohamed.azhar@microchip.com>

Add minimal set of binding parameters for sercom uart driver. Signed-off-by: Sunil Abraham <sunil.abraham@microchip.com>

Add uart driver with minimal features. Implement polling receive and transmit functionality. Signed-off-by: Sunil Abraham <sunil.abraham@microchip.com>

Adds common and SoC-specific .dtsi files for the Microchip SAM D5x/E5x family. These files define core peripherals, address maps, and interrupt controller structure shared across the SAM D5x/E5x variants. Signed-off-by: Arunprasath P <arunprasath.p@microchip.com>

Add initial support for the Microchip SAM E54 Xplained Pro board (ATSAME54-XPRO). Product page: https://www.microchip.com/en-us/development-tool/atsame54-xpro Signed-off-by: Arunprasath P <arunprasath.p@microchip.com>

ArunMCHP · 2025-07-24T12:24:03Z

@parthitce Thanks for your valuable comments and suggestions.

Updated the PR as per your comments :

Reordered the commits as per your suggestion.
Removed empty files.
Corrected CMakeLists.txt.
Fixed camel case issues in DTS files.
Updated clock source files based on your comments.
Moved DTSI files into a single commit.
And provided comments for do-while usage, ELOOP and IP version Kconfig symbols.

sonarqubecloud · 2025-07-24T12:27:36Z

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

nandojve · 2025-07-25T12:14:22Z

dts/arm/microchip/sam/sam_d5x_e5x/common/samd5xe5x.dtsi

The SoC DTS must be before SoC. Why ? There is usually a dependency order that must be take in consideration.
BTW, keep the dts with only the nodes that are really necessary. Let nodes from the drivers in their own commit together with the bindings.

We need to establish the correct order to avoid bisect issues in the future.

zephyrbot added platform: Microchip SAM Microchip SAM Platform (formerly Atmel SAM) area: Pinctrl area: Flash area: UART Universal Asynchronous Receiver-Transmitter labels Jul 21, 2025

zephyrbot added area: Clock Control platform: Microchip MEC Microchip MEC Platform labels Jul 21, 2025

zephyrbot requested review from albertofloyd, dcpleung, de-nordic, gmarull, jvasanth1, mnkp, nandojve, nordic-krch, pdgendt, rghaddab, stephanosio and VenkatKotakonda July 21, 2025 14:08

zephyrbot assigned nordic-krch Jul 21, 2025

github-actions bot added manifest manifest-hal_microchip DNM (manifest) This PR should not be merged (controlled by action-manifest) labels Jul 21, 2025

nordicjm requested changes Jul 22, 2025

View reviewed changes

ArunMCHP force-pushed the sam_d5x_e5x_minimal_support branch from 5e8b12a to 4981667 Compare July 22, 2025 14:19

ArunMCHP requested a review from nordicjm July 22, 2025 14:37

parthitce requested changes Jul 23, 2025

View reviewed changes

ArunMCHP force-pushed the sam_d5x_e5x_minimal_support branch from 4981667 to 5b8d763 Compare July 23, 2025 15:06

west.yml: Update west.yml for SAM_D5X_E5X dfp

4983255

Update west.yml for SAM_D5X_E5X Device family pack Signed-off-by: Arunprasath P <arunprasath.p@microchip.com>

ArunMCHP force-pushed the sam_d5x_e5x_minimal_support branch from 5b8d763 to eac3759 Compare July 23, 2025 18:04

github-actions bot removed the DNM (manifest) This PR should not be merged (controlled by action-manifest) label Jul 23, 2025

ArunMCHP requested a review from parthitce July 23, 2025 18:15

parthitce requested changes Jul 24, 2025

View reviewed changes

ArunMCHP and others added 9 commits July 24, 2025 16:35

soc: microchip: add support for SAM D5x/E5x SoC series

b599cf5

Adds initial SoC-level support for the Microchip SAM D5x and E5x series, including SoC definition files. Signed-off-by: Arunprasath P <arunprasath.p@microchip.com>

bindings: clock_control: microchip: clock bindings for SAM D5x/E5x

706bf4d

Add minimal set of binding parameters for clock_control driver. Signed-off-by: Sunil Abraham <sunil.abraham@microchip.com>

drivers: clock_control: microchip: clock support for SAM D5x/E5x

c8e775c

Add clock control driver with minimal functionality. Implement basic on, off, get_status and get_rate API. Signed-off-by: Sunil Abraham <sunil.abraham@microchip.com>

bindings: pinctrl: microchip: pinctrl bindings for Port G1 IP

810b4a0

Add binding parameters for Microchip Pinctrl Port G1 IP Signed-off-by: Mohamed Azhar <mohamed.azhar@microchip.com>

drivers: pinctrl: microchip: add pinctrl driver for Port G1 IP

b50c1d8

Add pinctrl driver for Microchip Port G1 Peripheral IPs Signed-off-by: Mohamed Azhar <mohamed.azhar@microchip.com>

bindings: sercom_g1_uart: microchip: uart bindings for sercom g1 IPs

a61b785

Add minimal set of binding parameters for sercom uart driver. Signed-off-by: Sunil Abraham <sunil.abraham@microchip.com>

drivers: uart: microchip: add minimal support for sercom uart g1 IPs

846c966

Add uart driver with minimal features. Implement polling receive and transmit functionality. Signed-off-by: Sunil Abraham <sunil.abraham@microchip.com>

boards: microchip: add SAM E54 Xplained Pro board support

ee7f4ff

Add initial support for the Microchip SAM E54 Xplained Pro board (ATSAME54-XPRO). Product page: https://www.microchip.com/en-us/development-tool/atsame54-xpro Signed-off-by: Arunprasath P <arunprasath.p@microchip.com>

ArunMCHP force-pushed the sam_d5x_e5x_minimal_support branch from eac3759 to ee7f4ff Compare July 24, 2025 11:59

ArunMCHP requested a review from parthitce July 24, 2025 12:06

nandojve requested changes Jul 25, 2025

View reviewed changes

		config SOC_FAMILY
		default "microchip_sam_d5x_e5x" if SOC_FAMILY_MCHP_SAM_D5X_E5X


		zephyr_include_directories(.)

		zephyr_include_directories(${ZEPHYR_BASE}/drivers)


		zephyr_sources(soc.c)

		zephyr_include_directories(.)

Add Basic support for Microchip SAM D5X/E5X Family devices #93450

Are you sure you want to change the base?

Add Basic support for Microchip SAM D5X/E5X Family devices #93450

Conversation

ArunMCHP commented Jul 21, 2025

Uh oh!

github-actions bot commented Jul 21, 2025

Uh oh!

github-actions bot commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

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!

ArunMCHP Jul 22, 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!

parthitce 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!

Choose a reason for hiding this comment

Uh oh!

ArunMCHP Jul 23, 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!

github-actions bot commented Jul 21, 2025 •

edited

Loading

ArunMCHP Jul 22, 2025 •

edited

Loading

ArunMCHP Jul 23, 2025 •

edited

Loading