.. zephyr:board:: m5stack_core2

Overview
********

M5Stack Core2 is an ESP32-based development board from M5Stack. It is the successor for the Core module.

Hardware
********

M5Stack Core2 features the following integrated components:

- ESP32-D0WDQ6-V3 chip (240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi)
- PSRAM 8MB
- Flash 16MB
- LCD IPS TFT 2", 320x240 px screen (ILI9342C)
- Touch screen (FT6336U)
- PMU AXP192
- Audio NS4168 amplifier (1W-092 speaker)
- Vibration motor
- RTC BM8563
- USB CP2104
- SD-Card slot
- Grove connector
- IMO 6-axis IMU MPU6886
- MIC SPM1423
- Battery 390mAh 3,7V

.. include:: ../../../espressif/common/soc-esp32-features.rst
   :start-after: espressif-soc-esp32-features

Supported Features
==================

.. zephyr:board-supported-hw::

Functional Description
======================

The following table below describes the key components, interfaces, and controls
of the M5Stack Core2 board.

.. _M5Core2 Schematic: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/schematic/Core/CORE2_V1.0_SCH.pdf
.. _MPU-ESP32: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/esp32_datasheet_en_v3.9.pdf
.. _TOUCH-FT6336U: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/Ft6336GU_Firmware%20外部寄存器_20151112-%20EN.xlsx
.. _SND-NS4168: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/NS4168_CN_datasheet.pdf
.. _MPU-6886: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/MPU-6886-000193%2Bv1.1_GHIC_en.pdf
.. _LCD-ILI9342C: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/ILI9342C-ILITEK.pdf
.. _SPM-1423: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/SPM1423HM4H-B_datasheet_en.pdf
.. _RTC-BM8563: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/BM8563_V1.1_cn.pdf
.. _SY7088: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/SY7088-Silergy.pdf
.. _PMU-AXP192: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/AXP192_datasheet_en.pdf
.. _VIB-1072_RFN01: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/1027RFN01-33d.pdf

+------------------+--------------------------------------------------------------------------+-----------+
| Key Component    | Description                                                              | Status    |
+==================+==========================================================================+===========+
| ESP32-D0WDQ6-V2  | This `MPU-ESP32`_ module provides complete Wi-Fi and Bluetooth           | supported |
| module           | functionalities and integrates a 16-MB SPI flash.                        |           |
+------------------+--------------------------------------------------------------------------+-----------+
| 32.768 kHz RTC   | External precision 32.768 kHz crystal oscillator serves as a clock with  | supported |
|                  | low-power consumption while the chip is in Deep-sleep mode.              |           |
+------------------+--------------------------------------------------------------------------+-----------+
| Status LED       | One user LED connected to the GPIO pin.                                  | supported |
+------------------+--------------------------------------------------------------------------+-----------+
| USB Port         | USB interface. Power supply for the board as well as the                 | supported |
|                  | communication interface between a computer and the board.                |           |
|                  | Contains: TypeC x 1, GROVE(I2C+I/O+UART) x 1                             |           |
+------------------+--------------------------------------------------------------------------+-----------+
| Reset button     | Reset button                                                             | supported |
+------------------+--------------------------------------------------------------------------+-----------+
| Power Switch     | Power on/off button.                                                     | supported |
+------------------+--------------------------------------------------------------------------+-----------+
| LCD screen       | Built-in LCD TFT display \(`LCD-ILI9342C`_, 2", 320x240 px\)             | supported |
|                  | controlled via SPI interface                                             |           |
+------------------+--------------------------------------------------------------------------+-----------+
| SD-Card slot     | SD-Card connection via SPI-mode.                                         | supported |
+------------------+--------------------------------------------------------------------------+-----------+
| 6-axis IMU       | The `MPU-6886`_ is a 6-axis motion tracker (6DOF IMU) device that        | supported |
| MPU6886          | combines a 3-axis gyroscope and a 3-axis accelerometer.                  |           |
|                  | For details please refer to :ref:`m5stack_core2_ext`                     |           |
+------------------+--------------------------------------------------------------------------+-----------+
| Grove port       | Note: Grove port requires 5V to be enabled via ``bus_5v`` regulator      | supported |
+------------------+--------------------------------------------------------------------------+-----------+
| Built-in         | The `SPM-1423`_ I2S driven microphone.                                   | todo      |
| microphone       |                                                                          |           |
+------------------+--------------------------------------------------------------------------+-----------+
| Built-in speaker | 1W speaker for audio output via I2S interface.                           | todo      |
+------------------+--------------------------------------------------------------------------+-----------+
| Battery-support  | Power supply via battery is supported automatically. But there is no     | todo      |
|                  | possibility to query current battery status.                             |           |
+------------------+--------------------------------------------------------------------------+-----------+

Power supply
============

M5Stack Core2 module is equipped with the feature-rich power management IC
(:dtcompatible:`x-powers,axp192-regulator`).
Following regulators are utilized on this module:

- **vdd_mcu**:
  Main power supply for the MCU.
- **lcd_bg**:
  Display backlight voltage.
- **v_peri**:
  Periphal supply. This regulator controls supply for the display, SD-Card.
- **vib_motor**:
  Vibration motor regulator.
- **bus_5v**
  BUS_5V supply for Grove port.
  Note: This fixed regulator supply is disabled by default.

These voltages can be controlled via regulator api.

System Requirements
*******************

.. include:: ../../../espressif/common/system-requirements.rst
   :start-after: espressif-system-requirements

Programming and Debugging
*************************

.. zephyr:board-supported-runners::

.. include:: ../../../espressif/common/building-flashing.rst
   :start-after: espressif-building-flashing

.. include:: ../../../espressif/common/board-variants.rst
   :start-after: espressif-board-variants

Debugging
=========

M5Stack Core2 debugging is not supported due to pinout limitations.

Related Documents
*****************

.. _`M5Stack-Core2 schematic`: https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/schematic/Core/CORE2_V1.0_SCH.pdf
.. _`ESP32-PICO-D4 Datasheet`: https://www.espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf
.. _`M5Stack-Core2 docs`: https://docs.m5stack.com/en/core/core2
.. _`ESP32 Hardware Reference`: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/hw-reference/index.html
