Support QSPI Flash driver for Renesas RA6 devices #78959

thaoluonguw · 2024-09-24T19:21:30Z

Add support for QSPI Flash driver for RA6 devices

Add QSPI Flash driver support on EK_RA6M5, EK_RA6M4, EK_RA6M3 and EK_RA6E2.

zephyrbot · 2024-09-24T19:22:26Z

The following west manifest projects have been modified in this Pull Request:

Name	Old Revision	New Revision	Diff
hal_renesas	zephyrproject-rtos/hal_renesas@`3dafd03`	zephyrproject-rtos/hal_renesas@`7a6ef38`	zephyrproject-rtos/hal_renesas@3dafd030..7a6ef381

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

soburi · 2024-10-05T01:36:16Z

include/zephyr/drivers/flash/ra_flash_api_extensions.h

+enum qspi_flash_ex_op_types {
+	QSPI_FLASH_EX_OP_RESET = 0,
+	QSPI_FLASH_EX_OP_EXIT_QPI = 1,
+};


Please insert blank line.

I fixed it. Thank you for your comment.

soburi · 2024-10-15T06:02:29Z

dts/bindings/mtd/renesas,ra-qspi-nor.yaml

+  reg:
+    required: true
+
+  size:


Renesas specific property should have renesas, prefix.

@soburi : Thank you for your feedback. We decided to keep it as current because I saw that other vendors have similar declaration and as comment in #76134 (comment), we understand that it's still in Renesas specific.

de-nordic

Issue with EX_OP and mostly nits regarding other areas.

de-nordic · 2024-10-15T14:58:36Z

drivers/flash/flash_qspi_renesas_ra.h

+
+#define QSPI_CMD_RESET_EN       (0x66) /* Reset Enable */
+#define QSPI_CMD_RESET_MEM      (0x99) /* Reset Memory */
+#define Ex_SPI_CMD_READ_ID      (0x9F) /* Extended Spi Read JEDEC ID */


We fixed it. We changed to use macros in https://github.com/zephyrproject-rtos/zephyr/blob/main/drivers/flash/spi_nor.h

de-nordic · 2024-10-15T14:58:53Z

drivers/flash/flash_qspi_renesas_ra.h

+#define QSPI_CMD_RESET_EN       (0x66) /* Reset Enable */
+#define QSPI_CMD_RESET_MEM      (0x99) /* Reset Memory */
+#define Ex_SPI_CMD_READ_ID      (0x9F) /* Extended Spi Read JEDEC ID */
+#define QSPI_CMD_READ_ID        (0xAF) /* Qpi Read JEDEC ID */


This isn't typo. We mentioned QPI mode (4-4-4) here.

de-nordic · 2024-10-15T15:02:45Z

drivers/flash/flash_qspi_renesas_ra.h

+#define QSPI_CMD_RESET_MEM      (0x99) /* Reset Memory */
+#define Ex_SPI_CMD_READ_ID      (0x9F) /* Extended Spi Read JEDEC ID */
+#define QSPI_CMD_READ_ID        (0xAF) /* Qpi Read JEDEC ID */
+#define QSPI_CMD_READ_SFDP      (0x5A) /* Read SFDP */


Most of those defines are actually provided here https://github.com/zephyrproject-rtos/zephyr/blob/main/drivers/flash/spi_nor.h, I know the naming is SPI_NOR, but adding additional defines only brings new names for functionally the same things.
You could just use the SPI_NOR defines and define these that are not provided by the header.

We changed to use macros in https://github.com/zephyrproject-rtos/zephyr/blob/main/drivers/flash/spi_nor.h

de-nordic · 2024-10-15T15:06:46Z

include/zephyr/drivers/flash/ra_flash_api_extensions.h

@@ -13,6 +13,11 @@ enum ra_ex_ops {
 	FLASH_RA_EX_OP_WRITE_PROTECT = FLASH_EX_OP_VENDOR_BASE,
 };

+enum qspi_flash_ex_op_types {
+	QSPI_FLASH_EX_OP_RESET = 0,


There is already system wide id for reset
FLASH_EX_OP_RESET = 0

zephyr/include/zephyr/drivers/flash.h

Line 640 in 03959a2

FLASH_EX_OP_RESET = 0,

and if the meaning is the same, the system wide one should be used.

We fixed it as your advice.

de-nordic · 2024-10-15T15:09:18Z

include/zephyr/drivers/flash/ra_flash_api_extensions.h

@@ -13,6 +13,11 @@ enum ra_ex_ops {
 	FLASH_RA_EX_OP_WRITE_PROTECT = FLASH_EX_OP_VENDOR_BASE,
 };

+enum qspi_flash_ex_op_types {
+	QSPI_FLASH_EX_OP_RESET = 0,
+	QSPI_FLASH_EX_OP_EXIT_QPI = 1,


This define is in the same range as system wide definition for non-vendor space, and as such is not allowed.
Please refer to

zephyr/include/zephyr/drivers/flash.h

Lines 617 to 631 in 03959a2

/*

* Extended operation interface provides flexible way for supporting flash

* controller features. Code space is divided equally into Zephyr codes

* (MSb == 0) and vendor codes (MSb == 1). This way we can easily add extended

* operations to the drivers without cluttering the API or problems with API

* incompatibility. Extended operation can be promoted from vendor codes to

* Zephyr codes if the feature is available in most flash controllers and

* can be represented in the same way.

*

* It's not forbidden to have operation in Zephyr codes and vendor codes for

* the same functionality. In this case, vendor operation could provide more

* specific access when abstraction in Zephyr counterpart is insufficient.

*/

#define FLASH_EX_OP_VENDOR_BASE 0x8000

#define FLASH_EX_OP_IS_VENDOR(c) ((c) & FLASH_EX_OP_VENDOR_BASE)

for instruction on how to define vendor specific operation
and to https://github.com/zephyrproject-rtos/zephyr/blob/03959a20f7834ffe50a51df2b2e45ef87d1b610b/include/zephyr/drivers/flash/stm32_flash_api_extensions.h for an example of such definition.

I think that there is also typo and QPI should be QSPI?

We updated for "QSPI_FLASH_EX_OP_EXIT_QPI" as your advice.
And "QPI" isn't typo. We mentioned QPI mode (4-4-4).

de-nordic · 2024-10-15T15:12:57Z

drivers/flash/flash_qspi_renesas_ra.c

+	if (!qspi_flash_ra_valid(QSPI_NOR_FLASH_SIZE, offset, len)) {
+		return -EINVAL;
+	}
+
+	if (len % QSPI_ERASE_BLK_SZ != 0) {
+		return -EINVAL;
+	}


You probably want to have some logging in at least one of the ifs, otherwise you have the same error returned to user with no way to distinguish problems except for debugging.

We fixed it. We added log to distinguish for errors.

de-nordic · 2024-10-15T15:15:45Z

drivers/flash/flash_qspi_renesas_ra.c

+	switch (code) {
+	case QSPI_FLASH_EX_OP_EXIT_QPI:
+		if (SPI_FLASH_PROTOCOL_QPI != qspi_data->qspi_cfg.spi_protocol) {
+			err = 0;
+			break;
+		}
+		cmd = QSPI_CMD_EXIT_QPI_MODE;
+		err = R_QSPI_DirectWrite(&qspi_data->qspi_ctrl, &cmd, ONE_BYTE, false);
+		if (err != FSP_SUCCESS) {
+			LOG_ERR("qspi: direct write failed");
+			err = -EIO;
+		}
+		break;
+
+	case QSPI_FLASH_EX_OP_RESET:
+		cmd = QSPI_CMD_RESET_EN;
+		err = R_QSPI_DirectWrite(&qspi_data->qspi_ctrl, &cmd, ONE_BYTE, false);
+		if (err == FSP_SUCCESS) {
+			cmd = QSPI_CMD_RESET_MEM;
+			err = R_QSPI_DirectWrite(&qspi_data->qspi_ctrl, &cmd, ONE_BYTE, false);
+			if (err != FSP_SUCCESS) {
+				LOG_ERR("qspi: direct write failed");
+				err = -EIO;
+			}


You lack here userspace processing, is that desired?

Yes, it is designed without userspace processing.
It is supported to reset QPI mode and memory.

de-nordic · 2024-10-15T15:20:06Z

drivers/flash/flash_qspi_renesas_ra.c

+		return -EINVAL;
+	}
+
+	if (!len) {


Here you fail operation of -EINVAL, even if len == 0 would cause nothing happening at all,
on the other side in qspi_flash_ra_write you first check len == 0 and bypass any more checks as there is no more work to.

Consider having one flow everywhere, for example checking the len == 0 and just exit as there is no work to do and actually no possibility to failure

We fixed it. We unified one flow for both qspi_flash_ra_write() and qspi_flash_ra_read(): check "len == 0" first and just exit.

de-nordic · 2024-10-15T15:21:50Z

There is a lot of QPI in the code, shouldn't that be QSPI?

thaoluonguw · 2024-10-21T08:51:52Z

There is a lot of QPI in the code, shouldn't that be QSPI?

@de-nordic : Thank you so much for your review. We fixed issues which you pointed out.
Please check the updates at: https://github.com/zephyrproject-rtos/zephyr/compare/81878488837d751b4711ff629a61c9c098011dce..f462ce16a76f505fde14c40293db08f204f108a2

For "QPI" in the code, it isn't typo of "QSPI", this is support for QPI mode (4-4-4).

Could you please help us to recheck for the update? Thanks again.

Add support for QSPI Flash driver running on Renesas EK_RA6M5, EK_RA6M4, EK_RA6M3 and EK_RA6E2. Signed-off-by: Tri Nguyen <tri.nguyen.wj@bp.renesas.com> Signed-off-by: Thao Luong <thao.luong.uw@renesas.com>

Update hal_renesas which support for qspi on RA6 Signed-off-by: Thao Luong <thao.luong.uw@renesas.com>

thaoluonguw added the platform: Renesas RA Renesas Electronics Corporation, RA label Sep 24, 2024

zephyrbot added manifest manifest-hal_renesas DNM This PR should not be merged (Do Not Merge) labels Sep 24, 2024

soburi mentioned this pull request Oct 1, 2024

dts: renesas_ra: Changing to describe clocks with DeviceTree's standard manner #78365

Merged

thaoluonguw force-pushed the support_renesas_ra6_qspi branch from d793e21 to 96a9f25 Compare October 1, 2024 14:54

thaoluonguw marked this pull request as ready for review October 1, 2024 16:26

zephyrbot added area: Flash area: Samples Samples labels Oct 1, 2024

zephyrbot requested review from de-nordic, duynguyenxa, kartben, KhiemNguyenT, nashif and soburi October 1, 2024 16:27

zephyrbot assigned de-nordic Oct 1, 2024

soburi reviewed Oct 5, 2024

View reviewed changes

thaoluonguw force-pushed the support_renesas_ra6_qspi branch from 96a9f25 to 92e6654 Compare October 11, 2024 17:22

zephyrbot removed the DNM This PR should not be merged (Do Not Merge) label Oct 11, 2024

thaoluonguw force-pushed the support_renesas_ra6_qspi branch from 92e6654 to 8187848 Compare October 11, 2024 17:50

quytranpzz approved these changes Oct 14, 2024

View reviewed changes

KhiemNguyenT added this to the v4.0.0 milestone Oct 14, 2024

KhiemNguyenT previously approved these changes Oct 14, 2024

View reviewed changes

soburi reviewed Oct 15, 2024

View reviewed changes

de-nordic requested changes Oct 15, 2024

View reviewed changes

thaoluonguw dismissed KhiemNguyenT’s stale review via f462ce1 October 18, 2024 11:23

thaoluonguw force-pushed the support_renesas_ra6_qspi branch from 8187848 to f462ce1 Compare October 18, 2024 11:23

thaoluonguw force-pushed the support_renesas_ra6_qspi branch 2 times, most recently from 2698314 to d1216b4 Compare October 27, 2024 15:37

Tri Nguyen and others added 2 commits November 1, 2024 19:42

drivers: flash: Initial support QSPI Flash driver for Renesas RA6

4afc239

Add support for QSPI Flash driver running on Renesas EK_RA6M5, EK_RA6M4, EK_RA6M3 and EK_RA6E2. Signed-off-by: Tri Nguyen <tri.nguyen.wj@bp.renesas.com> Signed-off-by: Thao Luong <thao.luong.uw@renesas.com>

manifest: Update hal_renesas for RA qspi support

fa7f9c5

Update hal_renesas which support for qspi on RA6 Signed-off-by: Thao Luong <thao.luong.uw@renesas.com>

thaoluonguw force-pushed the support_renesas_ra6_qspi branch from d1216b4 to fa7f9c5 Compare November 3, 2024 06:11

zephyrbot requested a review from rghaddab November 3, 2024 06:11

mmahadevan108 modified the milestones: v4.0.0, v4.1.0 Nov 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support QSPI Flash driver for Renesas RA6 devices #78959

Support QSPI Flash driver for Renesas RA6 devices #78959

thaoluonguw commented Sep 24, 2024

zephyrbot commented Sep 24, 2024 •

edited

Loading

soburi Oct 5, 2024

thaoluonguw Oct 11, 2024

soburi Oct 15, 2024

thaoluonguw Oct 21, 2024

de-nordic left a comment

de-nordic Oct 15, 2024

thaoluonguw Oct 21, 2024

de-nordic Oct 15, 2024

thaoluonguw Oct 21, 2024

de-nordic Oct 15, 2024

thaoluonguw Oct 21, 2024

de-nordic Oct 15, 2024

thaoluonguw Oct 21, 2024

de-nordic Oct 15, 2024

de-nordic Oct 15, 2024

thaoluonguw Oct 21, 2024

de-nordic Oct 15, 2024

thaoluonguw Oct 21, 2024

de-nordic Oct 15, 2024

thaoluonguw Oct 21, 2024

de-nordic Oct 15, 2024

thaoluonguw Oct 21, 2024

de-nordic commented Oct 15, 2024

thaoluonguw commented Oct 21, 2024

	/*
	* Extended operation interface provides flexible way for supporting flash
	* controller features. Code space is divided equally into Zephyr codes
	* (MSb == 0) and vendor codes (MSb == 1). This way we can easily add extended
	* operations to the drivers without cluttering the API or problems with API
	* incompatibility. Extended operation can be promoted from vendor codes to
	* Zephyr codes if the feature is available in most flash controllers and
	* can be represented in the same way.
	*
	* It's not forbidden to have operation in Zephyr codes and vendor codes for
	* the same functionality. In this case, vendor operation could provide more
	* specific access when abstraction in Zephyr counterpart is insufficient.
	*/
	#define FLASH_EX_OP_VENDOR_BASE 0x8000
	#define FLASH_EX_OP_IS_VENDOR(c) ((c) & FLASH_EX_OP_VENDOR_BASE)

Support QSPI Flash driver for Renesas RA6 devices #78959

Are you sure you want to change the base?

Support QSPI Flash driver for Renesas RA6 devices #78959

Conversation

thaoluonguw commented Sep 24, 2024

zephyrbot commented Sep 24, 2024 • edited Loading

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

de-nordic 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

de-nordic commented Oct 15, 2024

thaoluonguw commented Oct 21, 2024

zephyrbot commented Sep 24, 2024 •

edited

Loading