mirror
/
esp-idf
kopia lustrzana https://github.com/espressif/esp-idf
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

docs: updated getting started and other misc. guides for S3

pull/7307/head
Marius Vikhammer 2021-06-28 16:37:03 +08:00
rodzic afc2bc94b3
commit 638485b222
5 zmienionych plików z 79 dodań i 14 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

2
components/esp_hw_support/port/esp32s3/chip_info.c
Wyświetl plik

@ -20,5 +20,5 @@ void esp_chip_info(esp_chip_info_t *out_info)
memset(out_info, 0, sizeof(*out_info));
out_info->model = CHIP_ESP32S3;
out_info->cores = 2;
out_info->features = CHIP_FEATURE_WIFI_BGN;
out_info->features = CHIP_FEATURE_WIFI_BGN | CHIP_FEATURE_BLE;
}

8
docs/en/COPYRIGHT.rst
Wyświetl plik

@ -4,7 +4,7 @@ Copyrights and Licenses
Software Copyrights
===================
All original source code in this repository is Copyright (C) 2015-2019 Espressif Systems. This source code is licensed under the Apache License 2.0 as described in the file LICENSE.
All original source code in this repository is Copyright (C) 2015-2021 Espressif Systems. This source code is licensed under the Apache License 2.0 as described in the file LICENSE.
Additional third party copyrighted code is included under the following licenses.
@ -65,13 +65,13 @@ These third party libraries can be included into the application (firmware) prod
* `cryptoauthlib`_ Microchip CryptoAuthentication Library - Copyright (c) 2015 - 2018 Microchip Technology Inc, is licensed under common Microchip software License as described in :example_file:`LICENSE file <peripherals/secure_element/atecc608_ecdsa/components/esp-cryptoauthlib/cryptoauthlib/LICENSE>`
* :component_file:` TLSF allocator <heap/heap_tlsf.c>` Two Level Segregated Fit memory allocator, Copyright (c) 2006-2016, Matthew Conte, and licensed under the BSD license.
* :component_file:`TLSF allocator <heap/heap_tlsf.c>` Two Level Segregated Fit memory allocator, Copyright (c) 2006-2016, Matthew Conte, and licensed under the BSD license.
* `qrcode`_ QR Code generator library Copyright (c) Project Nayuki, is licensed under MIT license.
* :component:`openthread`, Copyright (c) The OpenThread Authors, is licensed under Apache License 2.0 as described in :component_file:`LICENSE file<openthread/openthread/LICENSE>`.
* :component_file:` UBSAN runtime <esp_system/ubsan.c>` — Copyright (c) 2016, Linaro Limited and Jiří Zárevúcky, licensed under the BSD 2-clause license.
* :component_file:`UBSAN runtime <esp_system/ubsan.c>` — Copyright (c) 2016, Linaro Limited and Jiří Zárevúcky, licensed under the BSD 2-clause license.
Build Tools
-----------
@ -90,7 +90,7 @@ Documentation
ROM Source Code Copyrights
==========================
ESP32 mask ROM hardware includes binaries compiled from portions of the following third party software:
ESP32, ESP32-S and ESP32-C Series SoCs mask ROM hardware includes binaries compiled from portions of the following third party software:
* :component:`Newlib <newlib>`, licensed under the BSD License and is Copyright of various parties, as described in :component_file:`COPYING.NEWLIB<newlib/COPYING.NEWLIB>`.

12
docs/en/about.rst
Wyświetl plik

@ -13,13 +13,21 @@ About
This is documentation of `ESP-IDF <https://github.com/espressif/esp-idf>`_, the framework to develop applications for {IDF_TARGET_NAME}.
The {IDF_TARGET_NAME} is a 2.4 GHz Wi-Fi module, which integrates a Xtensa® 32-bit LX7 CPU, with up to 600 DMIPS processing power.
The {IDF_TARGET_NAME} is a 2.4 GHz Wi-Fi SoC, which integrates a Xtensa® 32-bit LX7 CPU.
.. only:: esp32s3
This is documentation of `ESP-IDF <https://github.com/espressif/esp-idf>`_, the framework to develop applications for {IDF_TARGET_NAME}.
The {IDF_TARGET_NAME} is a 2.4 GHz Wi-Fi Bluetooth Low Energy combo SoC, which integrates a Xtensa® 32-bit LX7 CPU.
.. only:: esp32c3
This is documentation of `ESP-IDF <https://github.com/espressif/esp-idf>`_, the framework to develop applications for {IDF_TARGET_NAME}.
The {IDF_TARGET_NAME} is a 2.4 GHz Wi-Fi Bluetooth Low Energy combo, which integrates a 32-bit RISC-V RV32IMC single-core processor.
The {IDF_TARGET_NAME} is a 2.4 GHz Wi-Fi Bluetooth Low Energy combo SoC, which integrates a 32-bit RISC-V RV32IMC single-core processor.
.. figure:: ../_static/about-doc.png
:align: center

4
docs/en/contribute/contributor-agreement.rst
Wyświetl plik

@ -12,7 +12,7 @@ Framework (esp-idf) ("We" or "Us").
The purpose of this contributor agreement ("Agreement") is to clarify
and document the rights granted by contributors to Us. To make this
document effective, please follow the instructions at
document effective, please follow the instructions at
:idf_file:`CONTRIBUTING.rst`
1. DEFINITIONS
@ -27,7 +27,7 @@ Agreement or sign the Entity version of this document.
and/or documentation) including any modifications or additions to an
existing work, Submitted by You to Us, in which You own the Copyright.
If You do not own the Copyright in the entire work of authorship, please
contact Us at angus@espressif.com.
contact Us at marius.vikhammer@espressif.com.
**"Copyright"** means all rights protecting works of authorship owned or
controlled by You, including copyright, moral and neighboring rights, as

67
docs/en/get-started/index.rst
Wyświetl plik

@ -2,11 +2,11 @@
Get Started
***********
{IDF_TARGET_CORE_NUM:default="2", esp32="2", esp32s2="1", esp32c3="1"}
{IDF_TARGET_CORE_NUM:default="2", esp32s2="1", esp32c3="1"}
{IDF_TARGET_FEATURES:default="WiFi/BT/BLE, silicon revision 1, 2MB external flash", esp32="WiFi/BT/BLE, silicon revision 1, 2MB external flash", esp32s2="WiFi, silicon revision 0, 2MB external flash", esp32c3="WiFi/BLE, silicon revision 0, 2MB external flash"}
{IDF_TARGET_FEATURES:default="WiFi/BT/BLE, silicon revision 1, 2MB external flash", esp32="WiFi/BT/BLE, silicon revision 1, 2MB external flash", esp32s2="WiFi, silicon revision 0, 2MB external flash", esp32s3="This is esp32s3 chip with 2 CPU core(s), WiFi/BLE, silicon revision 0, 2MB external flash", esp32c3="WiFi/BLE, silicon revision 0, 2MB external flash"}
{IDF_TARGET_HEAP_SIZE:default="298968", esp32="298968", esp32s2="253900", esp32c3="337332"}
{IDF_TARGET_HEAP_SIZE:default="298968", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c3="337332"}
:link_to_translation:`zh_CN:[中文]`
@ -42,6 +42,17 @@ Introduction
* Built-in security hardware
* USB OTG interface
.. only:: esp32s3
* Wi-Fi (2.4 GHz band)
* Bluetooth Low Energy
* Dual high performance core Xtensa® 32-bit LX7 CPU cores
* Ultra Low Power co-processor running either RISC-V or FSM core
* Multiple peripherals
* Built-in security hardware
* USB OTG interface
* USB Serial/JTAG Controller
.. only:: esp32c3
* Wi-Fi (2.4 GHz band)
@ -119,7 +130,8 @@ If you have one of {IDF_TARGET_NAME} development boards listed below, you can cl
ESP32-C3-DevKitM-1 <../hw-reference/esp32c3/user-guide-devkitm-1>
ESP32-C3-DevKitC-02 <../hw-reference/esp32c3/user-guide-devkitc-02>
.. _get-started-step-by-step:
Installation Step by Step
@ -503,7 +515,7 @@ For more information on idf.py arguments, see :ref:`idf.py`.
Encountered Issues While Flashing?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
{IDF_TARGET_STRAP_GPIO:default="GPIO0", esp32="GPIO0", esp32s2="GPIO0", esp32c3="GPIO9"}
{IDF_TARGET_STRAP_GPIO:default="GPIO0", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c3="GPIO9"}
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 manual reset described below, and if it does not help you can find more details about possible issues in `Troubleshooting <https://github.com/espressif/esptool#bootloader-wont-respond>`_.
@ -606,6 +618,51 @@ When flashing, you will see the output log similar to the following:
Hard resetting via RTS pin...
Done
.. only:: esp32s3
.. code-block:: none
...
esptool.py esp32s3 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset write_flash --flash_mode dio --flash_freq 80m --flash_size 2MB 0x0 bootloader/bootloader.bin 0x10000 hello-world.bin 0x8000 partition_table/partition-table.bin
esptool.py v3.2-dev
Serial port /dev/ttyUSB0
Connecting....
Chip is ESP32-S3
Features: WiFi, BLE
Crystal is 40MHz
MAC: 7c:df:a1:e0:00:64
Uploading stub...
Running stub...
Stub running...
Changing baud rate to 460800
Changed.
Configuring flash size...
Flash will be erased from 0x00000000 to 0x00004fff...
Flash will be erased from 0x00010000 to 0x00039fff...
Flash will be erased from 0x00008000 to 0x00008fff...
Compressed 18896 bytes to 11758...
Writing at 0x00000000... (100 %)
Wrote 18896 bytes (11758 compressed) at 0x00000000 in 0.5 seconds (effective 279.9 kbit/s)...
Hash of data verified.
Compressed 168208 bytes to 88178...
Writing at 0x00010000... (16 %)
Writing at 0x0001a80f... (33 %)
Writing at 0x000201f1... (50 %)
Writing at 0x00025dcf... (66 %)
Writing at 0x0002d0be... (83 %)
Writing at 0x00036c07... (100 %)
Wrote 168208 bytes (88178 compressed) at 0x00010000 in 2.4 seconds (effective 569.2 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 478.9 kbit/s)...
Hash of data verified.
Leaving...
Hard resetting via RTS pin...
Done
.. only:: esp32c3
.. code-block:: none