mirror of
https://github.com/espressif/esp-idf.git
synced 2026-10-01 18:50:34 +03:00
Merge branch 'docs/update_getting_started_for_esp32p4_support_v5.3' into 'release/v5.3'
Docs/update getting started for esp32p4 support (v5.3) See merge request espressif/esp-idf!31114
This commit is contained in:
Marius Vikhammer
@@ -1 +1,39 @@
|
||||
.. output_log
|
||||
.. output_log
|
||||
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
...
|
||||
esptool.py v4.8.dev3
|
||||
Serial port /dev/cu.SLAB_USBtoUART
|
||||
Connecting....
|
||||
Chip is ESP32-P4 (revision v0.0)
|
||||
Features: High-Performance MCU
|
||||
Crystal is 40MHz
|
||||
MAC: 00:00:00:00:00:00
|
||||
Uploading stub...
|
||||
Running stub...
|
||||
Stub running...
|
||||
Changing baud rate to 460800
|
||||
Changed.
|
||||
Configuring flash size...
|
||||
Flash will be erased from 0x00002000 to 0x00007fff...
|
||||
Flash will be erased from 0x00010000 to 0x0003bfff...
|
||||
Flash will be erased from 0x00008000 to 0x00008fff...
|
||||
SHA digest in image updated
|
||||
Compressed 20960 bytes to 12653...
|
||||
Writing at 0x00002000... (100 %)
|
||||
Wrote 20960 bytes (12653 compressed) at 0x00002000 in 0.6 seconds (effective 277.1 kbit/s)...
|
||||
Hash of data verified.
|
||||
Compressed 179584 bytes to 94528...
|
||||
Writing at 0x00035efb... (100 %)
|
||||
Wrote 179584 bytes (94528 compressed) at 0x00010000 in 2.6 seconds (effective 549.9 kbit/s)...
|
||||
Hash of data verified.
|
||||
Compressed 3072 bytes to 103...
|
||||
Writing at 0x00008000... (100 %)
|
||||
Wrote 3072 bytes (103 compressed) at 0x00008000 in 0.1 seconds (effective 420.7 kbit/s)...
|
||||
Hash of data verified.
|
||||
|
||||
Leaving...
|
||||
Hard resetting via RTS pin...
|
||||
Done
|
||||
|
||||
@@ -141,12 +141,12 @@ Sometimes the USB-to-UART bridge is external. This is often used in small develo
|
||||
|
||||
For the {IDF_TARGET_NAME}, the USB peripheral is available, allowing you to flash the binaries without the need for an external USB-to-UART bridge.
|
||||
|
||||
{IDF_TARGET_USB_PIN_DM:default="Not Updated!", esp32c3="GPIO18", esp32s3="GPIO19", esp32s2="GPIO19", esp32c6="GPIO12", esp32h2="GPIO26"}
|
||||
{IDF_TARGET_USB_PIN_DP:default="Not Updated!", esp32c3="GPIO19", esp32s3="GPIO20", esp32s2="GPIO20", esp32c6="GPIO13", esp32h2="GPIO27"}
|
||||
{IDF_TARGET_USB_PIN_DM:default="Not Updated!", esp32c3="GPIO18", esp32s3="GPIO19", esp32s2="GPIO19", esp32c6="GPIO12", esp32h2="GPIO26", esp32p4="GPIO24/26"}
|
||||
{IDF_TARGET_USB_PIN_DP:default="Not Updated!", esp32c3="GPIO19", esp32s3="GPIO20", esp32s2="GPIO20", esp32c6="GPIO13", esp32h2="GPIO27", esp32p4="GPIO25/27"}
|
||||
|
||||
The USB on the {IDF_TARGET_NAME} uses the **{IDF_TARGET_USB_PIN_DP}** for **D+** and **{IDF_TARGET_USB_PIN_DM}** for **D-**.
|
||||
|
||||
.. only:: SOC_USB_SERIAL_JTAG_SUPPORTED
|
||||
.. only:: SOC_USB_SERIAL_JTAG_SUPPORTED and not esp32s3 and not esp32p4
|
||||
|
||||
.. only:: not SOC_USB_OTG_SUPPORTED
|
||||
|
||||
@@ -348,6 +348,8 @@ To spare you the trouble of installing a serial terminal program, macOS offers t
|
||||
Example Output
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9", esp32c6="GPIO9", esp32h2="GPIO9", esp32p4="GPIO35"}
|
||||
|
||||
An example log is shown below. Reset the board if you do not see anything.
|
||||
|
||||
.. highlight:: none
|
||||
@@ -376,7 +378,7 @@ If you can see readable log output, it means serial connection is working and yo
|
||||
|
||||
.. note::
|
||||
|
||||
For some serial port wiring configurations, the serial RTS & DTR pins need to be disabled in the terminal program before the {IDF_TARGET_NAME} booting and producing serial output. This depends on the hardware itself, most development boards (including all Espressif boards) *do not* have this issue. The issue is present if RTS & DTR are wired directly to the EN & GPIO0 pins. See the `esptool documentation`_ for more details.
|
||||
For some serial port wiring configurations, the serial RTS & DTR pins need to be disabled in the terminal program before the {IDF_TARGET_NAME} booting and producing serial output. This depends on the hardware itself, most development boards (including all Espressif boards) *do not* have this issue. The issue is present if RTS & DTR are wired directly to the EN & {IDF_TARGET_STRAP_GPIO} pins. See the `esptool documentation`_ for more details.
|
||||
|
||||
If you got here from :ref:`get-started-connect` when installing s/w for {IDF_TARGET_NAME} development, then you can continue with :ref:`get-started-configure`.
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ Flashing Troubleshooting
|
||||
Failed to Connect
|
||||
-----------------
|
||||
|
||||
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9", esp32c6="GPIO9", esp32h2="GPIO9"}
|
||||
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9", esp32c6="GPIO9", esp32h2="GPIO9", esp32p4="GPIO35"}
|
||||
|
||||
If you run the given command and see errors such as "Failed to connect", there might be several reasons for this. One of the reasons might be issues encountered by ``esptool.py``, the utility that is called by the build system to reset the chip, interact with the ROM bootloader, and flash firmware. One simple solution to try is to manually reset as described below. If it does not help, you can find more details about possible issues in the `esptool troubleshooting <https://docs.espressif.com/projects/esptool/en/latest/esp32/troubleshooting.html>`_ page.
|
||||
|
||||
|
||||
@@ -76,6 +76,14 @@ Introduction
|
||||
* Multiple peripherals
|
||||
* Built-in security hardware
|
||||
|
||||
.. only:: esp32p4
|
||||
|
||||
* High performance MCU with RISC-V dual-core processors
|
||||
* Powerful image and voice processing capability
|
||||
* Single-precision FPU and AI extensions
|
||||
* Rich set of peripherals including MIPI, USB, SDIO, and Ethernet
|
||||
* Built-in security hardware
|
||||
|
||||
Powered by 40 nm technology, {IDF_TARGET_NAME} provides a robust, highly integrated platform, which helps meet the continuous demands for efficient power usage, compact design, security, high performance, and reliability.
|
||||
|
||||
Espressif provides basic hardware and software resources to help application developers realize their ideas using the {IDF_TARGET_NAME} series hardware. The software development framework by Espressif is intended for development of Internet-of-Things (IoT) applications with Wi-Fi, Bluetooth, power management and several other system features.
|
||||
@@ -150,6 +158,10 @@ If you have one of {IDF_TARGET_NAME} official development boards listed below, y
|
||||
ESP32-C6-DevKitC-1 <https://docs.espressif.com/projects/espressif-esp-dev-kits/en/latest/esp32c6/esp32-c6-devkitc-1/index.html>
|
||||
ESP32-C6-DevKitM-1 <https://docs.espressif.com/projects/espressif-esp-dev-kits/en/latest/esp32c6/esp32-c6-devkitm-1/index.html>
|
||||
|
||||
.. only:: esp32p4
|
||||
|
||||
To be announced.
|
||||
|
||||
.. _get-started-get-prerequisites:
|
||||
|
||||
Software
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{IDF_TARGET_FEATURES:default="[NEEDS TO BE UPDATED]", esp32="WiFi/BT/BLE, silicon revision 1, 2 MB external flash", esp32s2="WiFi, silicon revision 0, 2 MB external flash", esp32s3="This is esp32s3 chip with 2 CPU core(s), WiFi/BLE, silicon revision 0, 2 MB external flash", esp32c2="WiFi/BLE, silicon revision 0, 2 MB embedded flash", esp32c3="WiFi/BLE, silicon revision 0, 2 MB external flash", esp32c6="WiFi/BLE, 802.15.4 (Zigbee/Thread), silicon revision v0.0, 2 MB external flash", esp32h2="BLE, 802.15.4 (Zigbee/Thread), silicon revision v0.1, 2 MB external flash"}
|
||||
{IDF_TARGET_FEATURES:default="[NEEDS TO BE UPDATED]", esp32="WiFi/BT/BLE, silicon revision 1, 2 MB external flash", esp32s2="WiFi, silicon revision 0, 2 MB external flash", esp32s3="This is esp32s3 chip with 2 CPU core(s), WiFi/BLE, silicon revision 0, 2 MB external flash", esp32c2="WiFi/BLE, silicon revision 0, 2 MB embedded flash", esp32c3="WiFi/BLE, silicon revision 0, 2 MB external flash", esp32c6="WiFi/BLE, 802.15.4 (Zigbee/Thread), silicon revision v0.0, 2 MB external flash", esp32h2="BLE, 802.15.4 (Zigbee/Thread), silicon revision v0.1, 2 MB external flash", esp32p4="silicon revision v0.0, 2 MB external flash"}
|
||||
|
||||
{IDF_TARGET_HEAP_SIZE:default="[NEEDS TO BE UPDATED]", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c2="203888", esp32c3="337332", esp32c6="473816", esp32h2="268256"}
|
||||
{IDF_TARGET_HEAP_SIZE:default="[NEEDS TO BE UPDATED]", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c2="203888", esp32c3="337332", esp32c6="473816", esp32h2="268256", esp32p4="618848"}
|
||||
|
||||
Build the Project
|
||||
=================
|
||||
@@ -72,7 +72,9 @@ Monitor the Output
|
||||
|
||||
To check if "hello_world" is indeed running, type ``idf.py -p PORT monitor`` (Do not forget to replace PORT with your serial port name).
|
||||
|
||||
This command launches the :doc:`IDF Monitor <../api-guides/tools/idf-monitor>` application::
|
||||
This command launches the :doc:`IDF Monitor <../api-guides/tools/idf-monitor>` application.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ idf.py -p <PORT> monitor
|
||||
Running idf_monitor in directory [...]/esp/hello_world/build
|
||||
|
||||
@@ -12,7 +12,9 @@ ESP-IDF requires some prerequisite tools to be installed so you can build firmwa
|
||||
For this Getting Started we are going to use the Command Prompt, but after ESP-IDF is installed you can use `Eclipse Plugin <https://github.com/espressif/idf-eclipse-plugin/blob/master/README.md>`_ or another graphical IDE with CMake support instead.
|
||||
|
||||
.. note::
|
||||
|
||||
Limitations:
|
||||
|
||||
- The installation path of ESP-IDF and ESP-IDF Tools must not be longer than 90 characters. Too long installation paths might result in a failed build.
|
||||
- The installation path of Python or ESP-IDF must not contain white spaces or parentheses.
|
||||
- The installation path of Python or ESP-IDF should not contain special characters (non-ASCII) unless the operating system is configured with "Unicode UTF-8" support.
|
||||
@@ -41,7 +43,7 @@ What Is the Usecase for Online and Offline Installer
|
||||
|
||||
Online Installer is very small and allows the installation of all available releases of ESP-IDF. The installer downloads only necessary dependencies including `Git For Windows`_ during the installation process. The installer stores downloaded files in the cache directory ``%userprofile%\.espressif``
|
||||
|
||||
Offline Installer does not require any network connection. The installer contains all required dependencies including `Git For Windows`_ .
|
||||
Offline Installer does not require any network connection. The installer contains all required dependencies including `Git For Windows`_.
|
||||
|
||||
Components of the Installation
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Reference in New Issue
Block a user