board: m5stack-core2 module support #61812

MrMarteng · 2023-08-23T18:46:37Z

This Pull-Request features support for the M5Stack Core2 hardware. The module features a LCD display, touchscreen, battery, USB-Port, 8MB RAM and 16MB Flash.
Basic features are working. See board documentation for details.

Signed-off-by: Martin Kiepfer mrmarteng@teleschirm.org

kartben · 2023-08-26T21:36:51Z

Very cool!
It doesn't have to be through this PR but it would be nice to have a binding for the MBUS header, as this will make it easier to start adding M5 shields that "just work" :)

MrMarteng · 2023-08-27T07:53:57Z

Very cool!
It doesn't have to be through this PR but it would be nice to have a binding for the MBUS header, as this will make it easier to start adding M5 shields that "just work" :)

Can you describe this idea on more detail? Are you referring to the Module BUS M5 is offering (https://docs.m5stack.com/en/module/bus)?

There are generally a lot of other functionalities missing yet (gauge, audio, ...). But I want to add additional functionality in future.

kartben · 2023-08-27T09:08:20Z

I mean describing the pin headers similar to how it's done for say Arduino R3 headers, grove connectors, or Raspberry Pi 40-pin headers. You should be able to find examples easily by searching the code base. Thanks to this, shield definitions for M5Stack modules would conveniently be able to reference pins from the header, with Devicetree then automagically "routing" them to the corresponding pins of the ESP32. Plus you could also define aliases like m5stack_i2c or m5stack_spi.

Here's the description of the pin mappings for the M5Stack Core2: https://static-cdn.m5stack.com/resource/docs/products/core/core2/core2_mbus_01.webp

Hope this helps clarify!

MrMarteng · 2023-08-28T06:01:07Z

I mean describing the pin headers similar to how it's done for say Arduino R3 headers, grove connectors, or Raspberry Pi 40-pin headers. You should be able to find examples easily by searching the code base. Thanks to this, shield definitions for M5Stack modules would conveniently be able to reference pins from the header, with Devicetree then automagically "routing" them to the corresponding pins of the ESP32. Plus you could also define aliases like m5stack_i2c or m5stack_spi.

Here's the description of the pin mappings for the M5Stack Core2: https://static-cdn.m5stack.com/resource/docs/products/core/core2/core2_mbus_01.webp

Hope this helps clarify!

Thank you. I've understood and like the idea. I will add this functionality in a separate PR.

boards/xtensa/m5stack_core2/Kconfig.defconfig

boards/xtensa/m5stack_core2/m5stack_core2.dts

boards/xtensa/m5stack_core2/Kconfig.board

tests/lib/devicetree/devices/testcase.yaml

kartben

I had a chance to test this PR with actual hardware (it's a very cool board!). Please see my comments.

kartben · 2023-09-07T13:02:32Z

boards/xtensa/m5stack_core2/m5stack_core2.dts

+				regulator-init-microvolt = <2800000>;
+				regulator-min-microvolt = <0>;
+				regulator-max-microvolt = <2800000>;


i would align with the min/max values from the Arduino core: min = 2500mV, max = 3300mV

https://github.com/m5stack/M5Core2/blob/master/src/AXP192.cpp#L450-L453

In any case I should say it's pretty cool to be able to tinker with the regulator shell commands to set the brightness of the LCD or disable it altogether.

fixed with laters commit

boards/xtensa/m5stack_core2/m5stack_core2.dts

boards/xtensa/m5stack_core2/Kconfig.defconfig

kartben · 2023-09-07T13:58:38Z

boards/xtensa/m5stack_core2/m5stack_core2.dts

+				regulator-init-microvolt = <2800000>;
+				regulator-min-microvolt = <0>;
+				regulator-max-microvolt = <2800000>;
+				regulator-boot-on;


not sure we want the LCD always on? Isn't the fact that a vin-supply is defined on the display node already enough to bind the status of the regulator to the status of the display? @gmarull

I am actually no longer sure if the vin-supply binding to lcd_bg regulator is correct. Is vin-supply intended to control the regulator for the control logic? ili9xx driver is not supporting brightness control. Hence I guess the vin-supply setting does not have any effect. Only a few, very specific display driver (e.v. max7219) support backlight control yet.

MrMarteng · 2023-09-08T07:39:04Z

Rebased to latest main.
Added additional fix for latest gpio get_direction unit test.

kartben

This is good to go from my perspective! Thanks @MrMarteng!
Can't wait to get I2S support on ESP32 ;-)

MrMarteng · 2023-09-08T08:25:56Z

This is good to go from my perspective! Thanks @MrMarteng!

Thanks.

Can't wait to get I2S support on ESP32 ;-)

Yes indeed ;-). And I would also love to see SMP working again to speed up graphical performance.

marekmatej · 2023-09-08T08:49:07Z

@MrMarteng please address the dtsi include and fix the incorrect m5stack-core2_defconfig as requested by the review.

MrMarteng · 2023-09-08T12:05:46Z

@MrMarteng please address the dtsi include and fix the incorrect m5stack-core2_defconfig as requested by the review.

@marekmatej Did you see my comment on the dtsi include? The m5stack does not feature the wrover module. The design is just aligned on the wrover board.
Which fix in m5stack-core2_defconfig are you referring to?

marekmatej · 2023-09-08T12:12:03Z

@MrMarteng please address the dtsi include and fix the incorrect m5stack-core2_defconfig as requested by the review.

@marekmatej Did you see my comment on the dtsi include? The m5stack does not feature the wrover module. The design is just aligned on the wrover board.

@MrMarteng sure, I did read it, but you probably missed my replies ;)
With the increasing number of comments, it is getting harder to read the conversation, so I asked for specific changes in the code. Please take a look at it.

MrMarteng · 2023-09-08T12:25:32Z

@MrMarteng please address the dtsi include and fix the incorrect m5stack-core2_defconfig as requested by the review.

@marekmatej Did you see my comment on the dtsi include? The m5stack does not feature the wrover module. The design is just aligned on the wrover board.

@MrMarteng sure, I did read it, but you probably missed my replies ;) With the increasing number of comments, it is getting harder to read the conversation, so I asked for specific changes in the code. Please take a look at it.

I am really, sorry but I don't see your reply to my question.

I also don't see any commend in the defconfig file

Anyway. I will change to the wrover_e_n16r8 include. But I would still welcome to get find the answer to my question. Maybe I am just blind.

marekmatej · 2023-09-08T12:31:55Z

kartben · 2023-09-08T12:33:26Z

@marekmatej FWIW "pending" means that you forgot to actually submit your review so only you can see this :)

boards/xtensa/m5stack_core2/m5stack_core2.dts

marekmatej · 2023-09-07T19:12:55Z

boards/xtensa/m5stack_core2/m5stack_core2.dts

+
+&flash0 {
+	status = "okay";
+	reg = <0 0x400000>;


@marekmatej Are you ok with using esp32_d0wd_v3 as the base?

Well, I cant force you to use predefined modules. But please remote the esp32s3_common.dtsi and replace it with the generic esp32s3.dtsi.

Also, please take a look at my other comments on the m5stac_core2_defconfig.

boards/xtensa/m5stack_core2/m5stack_core2.dts

marekmatej · 2023-09-08T11:10:59Z

boards/xtensa/m5stack_core2/m5stack_core2.dts

+ */
+/dts-v1/;
+
+#include <espressif/esp32/esp32_common.dtsi>


Suggested change

#include <espressif/esp32/esp32_common.dtsi>

#include <espressif/esp32/esp32_d0wd_v3.dtsi>

marekmatej · 2023-09-08T11:17:28Z

boards/xtensa/m5stack_core2/m5stack_core2_defconfig

+CONFIG_GEN_IRQ_VECTOR_TABLE=n
+
+CONFIG_MAIN_STACK_SIZE=4096
+CONFIG_HEAP_MEM_POOL_SIZE=4096


Suggested change

CONFIG_HEAP_MEM_POOL_SIZE=4096

marekmatej · 2023-09-08T11:23:07Z

boards/xtensa/m5stack_core2/m5stack_core2_defconfig

+CONFIG_GEN_ISR_TABLES=y
+CONFIG_XTENSA_USE_CORE_CRT1=n
+CONFIG_XTENSA_RESET_VECTOR=n
+CONFIG_GEN_IRQ_VECTOR_TABLE=n


Suggested change

CONFIG_GEN_ISR_TABLES=y

CONFIG_XTENSA_USE_CORE_CRT1=n

CONFIG_XTENSA_RESET_VECTOR=n

CONFIG_GEN_IRQ_VECTOR_TABLE=n

marekmatej · 2023-09-08T12:40:17Z

@marekmatej FWIW "pending" means that you forgot to actually submit your review so only you can see this :)

ok I see, my bad folks! but there was a few comments that were submitted and visible, but not replied :)

This Pull-Request enables support for the M5Stack Core2 hardware. The module features a LCD display, touchscreen, battery, USB-Port, 8MB RAM and 16MB Flash. Basic features are working. Please refere to the board documentation for details. Signed-off-by: Martin Kiepfer <mrmarteng@teleschirm.org> gpio: gpio_axp192: fix dependecy between GET_DIRECTION and GET_CONFIG configuration Latest unit gpio get_direction unit test failes, as get_direction api internally requires get_config functionality. This commit fixes this dependecy. Signed-off-by: Martin Kiepfer <m.kiepfer@teleschirm.org>

This commit resolves an internal dependecy between GET_DIRECTION and GET_CONFIG configuration. GET_CONFIG api is internally needed by GET_DIRECTION api. Signed-off-by: Martin Kiepfer <m.kiepfer@teleschirm.org>

m5stack_core2 enables i2c by default for regulator usage which conflicts with the test and is therefore excluded from the test. Signed-off-by: Martin Kiepfer <mrmarteng@teleschirm.org>

Basic pinout definition. Signed-off-by: Martin Kiepfer <m.kiepfer@teleschirm.org>

MrMarteng · 2023-09-08T16:00:03Z

@marekmatej, @kartben Thank you both for the effort you put into this PR!

MrMarteng force-pushed the m5stack_core2 branch 6 times, most recently from 0b19436 to 8e7c9a3 Compare August 24, 2023 18:03

MrMarteng marked this pull request as ready for review August 24, 2023 18:46

MrMarteng requested review from nashif and dcpleung as code owners August 24, 2023 18:46

zephyrbot added the area: Devicetree label Aug 24, 2023

zephyrbot requested review from galak and mbolivar-ampere August 24, 2023 18:46

dcpleung requested a review from sylvioalves August 24, 2023 18:49

MrMarteng changed the title ~~M5stack core2~~ board: M5stack-Core2 support Aug 24, 2023

MrMarteng changed the title ~~board: M5stack-Core2 support~~ board: m5stack-core2 module support Aug 24, 2023

MrMarteng force-pushed the m5stack_core2 branch 4 times, most recently from 9712dbe to 30ee67a Compare August 26, 2023 13:20

sylvioalves reviewed Aug 28, 2023

View reviewed changes

boards/xtensa/m5stack_core2/Kconfig.defconfig Outdated Show resolved Hide resolved

sylvioalves reviewed Aug 28, 2023

View reviewed changes

boards/xtensa/m5stack_core2/m5stack_core2.dts Outdated Show resolved Hide resolved

sylvioalves reviewed Aug 28, 2023

View reviewed changes

boards/xtensa/m5stack_core2/Kconfig.board Show resolved Hide resolved

mbolivar-ampere reviewed Aug 28, 2023

View reviewed changes

tests/lib/devicetree/devices/testcase.yaml Show resolved Hide resolved

MrMarteng force-pushed the m5stack_core2 branch from 30ee67a to e24ae3c Compare August 30, 2023 05:58

MrMarteng requested review from sylvioalves and mbolivar-ampere August 30, 2023 07:03

kartben requested changes Sep 7, 2023

View reviewed changes

MrMarteng force-pushed the m5stack_core2 branch 2 times, most recently from 17de9c0 to 87afcd0 Compare September 8, 2023 07:37

MrMarteng requested a review from mnkp as a code owner September 8, 2023 07:37

zephyrbot added the area: GPIO label Sep 8, 2023

zephyrbot requested a review from henrikbrixandersen September 8, 2023 07:38

kartben previously approved these changes Sep 8, 2023

View reviewed changes

marekmatej requested changes Sep 8, 2023

View reviewed changes

Martin Kiepfer and others added 4 commits September 8, 2023 17:19

drivers: axp192_gpio: Fix for latest get_direction unit test

d06708f

This commit resolves an internal dependecy between GET_DIRECTION and GET_CONFIG configuration. GET_CONFIG api is internally needed by GET_DIRECTION api. Signed-off-by: Martin Kiepfer <m.kiepfer@teleschirm.org>

boards: m5stack_core2: Exclude board from device tree test

e508379

m5stack_core2 enables i2c by default for regulator usage which conflicts with the test and is therefore excluded from the test. Signed-off-by: Martin Kiepfer <mrmarteng@teleschirm.org>

devicetree: Add grove connector definition for m5stack_core2

751dcc4

Basic pinout definition. Signed-off-by: Martin Kiepfer <m.kiepfer@teleschirm.org>

MrMarteng dismissed kartben’s stale review via 751dcc4 September 8, 2023 15:22

MrMarteng force-pushed the m5stack_core2 branch from 87afcd0 to 751dcc4 Compare September 8, 2023 15:22

marekmatej approved these changes Sep 8, 2023

View reviewed changes

kartben approved these changes Sep 8, 2023

View reviewed changes

sylvioalves approved these changes Sep 8, 2023

View reviewed changes

fabiobaltieri merged commit c45cab3 into zephyrproject-rtos:main Sep 11, 2023
18 checks passed

MrMarteng mentioned this pull request Jan 17, 2024

Nominate mrmarteng as zephyr contributor #67746

Closed

MrMarteng deleted the m5stack_core2 branch April 14, 2024 06:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

board: m5stack-core2 module support #61812

board: m5stack-core2 module support #61812

MrMarteng commented Aug 23, 2023 •

edited

kartben commented Aug 26, 2023

MrMarteng commented Aug 27, 2023 •

edited

kartben commented Aug 27, 2023

MrMarteng commented Aug 28, 2023

kartben left a comment

kartben Sep 7, 2023

MrMarteng Sep 7, 2023

kartben Sep 7, 2023

MrMarteng Sep 7, 2023

MrMarteng commented Sep 8, 2023

kartben left a comment

MrMarteng commented Sep 8, 2023 •

edited

marekmatej commented Sep 8, 2023

MrMarteng commented Sep 8, 2023 •

edited

marekmatej commented Sep 8, 2023

MrMarteng commented Sep 8, 2023

marekmatej commented Sep 8, 2023

kartben commented Sep 8, 2023 •

edited

marekmatej Sep 7, 2023

marekmatej Sep 8, 2023

marekmatej Sep 8, 2023

marekmatej Sep 8, 2023

marekmatej commented Sep 8, 2023

MrMarteng commented Sep 8, 2023

	#include <espressif/esp32/esp32_common.dtsi>
	#include <espressif/esp32/esp32_d0wd_v3.dtsi>

board: m5stack-core2 module support #61812

board: m5stack-core2 module support #61812

Conversation

MrMarteng commented Aug 23, 2023 • edited

kartben commented Aug 26, 2023

MrMarteng commented Aug 27, 2023 • edited

kartben commented Aug 27, 2023

MrMarteng commented Aug 28, 2023

kartben 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

MrMarteng commented Sep 8, 2023

kartben left a comment

Choose a reason for hiding this comment

MrMarteng commented Sep 8, 2023 • edited

marekmatej commented Sep 8, 2023

MrMarteng commented Sep 8, 2023 • edited

marekmatej commented Sep 8, 2023

MrMarteng commented Sep 8, 2023

marekmatej commented Sep 8, 2023

kartben commented Sep 8, 2023 • edited

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

marekmatej commented Sep 8, 2023

MrMarteng commented Sep 8, 2023

MrMarteng commented Aug 23, 2023 •

edited

MrMarteng commented Aug 27, 2023 •

edited

MrMarteng commented Sep 8, 2023 •

edited

MrMarteng commented Sep 8, 2023 •

edited

kartben commented Sep 8, 2023 •

edited