eaw/esp-idf
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

esp8684: rename target to esp32c2

Browse Source
This commit is contained in:
laokaiyao
2022-01-18 10:32:56 +08:00
parent 6e00f10fd4
commit cf049e15ed
354 changed files with 894 additions and 897 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
docs/docs_not_updated/esp8684.txt → docs/docs_not_updated/esp32c2.txt
View File

0
docs/doxygen/Doxyfile_esp8684 → docs/doxygen/Doxyfile_esp32c2
View File

2
docs/en/COPYRIGHT.rst
View File

@@ -84,7 +84,7 @@ Documentation
ROM Source Code Copyrights
==========================
ESP32, ESP8684, ESP32-S and ESP32-C Series SoCs 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>`.

2
docs/en/about.rst
View File

@@ -23,7 +23,7 @@ About
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 or esp8684
.. only:: esp32c3 or esp32c2
This is documentation of `ESP-IDF <https://github.com/espressif/esp-idf>`_, the framework to develop applications for {IDF_TARGET_NAME}.

2
docs/en/api-guides/index.rst
View File

@@ -31,7 +31,7 @@ API Guides
OpenThread <openthread>
Partition Tables <partition-tables>
Performance <performance/index>
:not esp8684: RF Calibration <RF_calibration>
:not esp32c2: RF Calibration <RF_calibration>
:esp32: Secure Boot <../security/secure-boot-v1>
Secure Boot V2 <../security/secure-boot-v2>
Thread Local Storage <thread-local-storage>

28
docs/en/api-guides/jtag-debugging/esp8684.inc → docs/en/api-guides/jtag-debugging/esp32c2.inc
View File

@@ -11,9 +11,9 @@
::
openocd -f board/esp8684-BOARD_NAME.cfg
openocd -f board/esp32c2-BOARD_NAME.cfg
.. |run-openocd-device-name| replace:: ESP8684
.. |run-openocd-device-name| replace:: ESP32C2
---
@@ -23,7 +23,7 @@
CHIP SPECIFIC LOG OUTPUT
.. |run-openocd-cfg-file-err| replace:: ``Can't find board/esp8684-BOARD_NAME.cfg``
.. |run-openocd-cfg-file-err| replace:: ``Can't find board/esp32c2-BOARD_NAME.cfg``
---
@@ -31,7 +31,7 @@
::
openocd -f board/esp8684-BOARD_NAME.cfg -c "program_esp filename.bin 0x10000 verify exit"
openocd -f board/esp32c2-BOARD_NAME.cfg -c "program_esp filename.bin 0x10000 verify exit"
---
@@ -39,7 +39,7 @@
.. code-block:: bash
src/openocd -f board/esp8684-BOARD_NAME.cfg
src/openocd -f board/esp32c2-BOARD_NAME.cfg
---
@@ -47,13 +47,13 @@
.. code-block:: batch
src\openocd -f board/esp8684-BOARD_NAME.cfg
src\openocd -f board/esp32c2-BOARD_NAME.cfg
---
.. idf-py-openocd-default-cfg
.. |idf-py-def-cfg| replace:: ``-f board/esp8684-BOARD_NAME.cfg``
.. |idf-py-def-cfg| replace:: ``-f board/esp32c2-BOARD_NAME.cfg``
---
@@ -61,13 +61,13 @@
::
openocd -f board/esp8684-BOARD_NAME.cfg -c "init; halt; esp appimage_offset 0x210000"
openocd -f board/esp32c2-BOARD_NAME.cfg -c "init; halt; esp appimage_offset 0x210000"
---
.. openocd-cfg-files
.. list-table:: OpenOCD configuration files for ESP8684
.. list-table:: OpenOCD configuration files for ESP32C2
:widths: 25 75
:header-rows: 1
@@ -86,11 +86,11 @@
.. jtag-pins
.. list-table:: ESP8684 pins and JTAG signals
.. list-table:: ESP32C2 pins and JTAG signals
:widths: 25 75
:header-rows: 1
* - ESP8684 Pin
* - ESP32C2 Pin
- JTAG Signal
* - MTDO / GPIOX
- TDO
@@ -110,7 +110,7 @@
::
openocd -l openocd_log.txt -d3 -f board/esp8684-BOARD_NAME.cfg
openocd -l openocd_log.txt -d3 -f board/esp32c2-BOARD_NAME.cfg
---
@@ -118,7 +118,7 @@
::
openocd -d3 -f board/esp8684-BOARD_NAME.cfg 2>&1 | tee openocd.log
openocd -d3 -f board/esp32c2-BOARD_NAME.cfg 2>&1 | tee openocd.log
---
@@ -132,7 +132,7 @@
.. devkit-defs
.. |devkit-name| replace:: ESP8684
.. |devkit-name| replace:: ESP32C2
.. |devkit-name-with-link| replace:: LINK TO DEVKIT
---

2
docs/en/api-guides/memory-types.rst
View File

@@ -134,7 +134,7 @@ The same region of RTC FAST memory can be accessed as both instruction and data
In single core mode, remaining RTC FAST memory is added to the heap unless the option :ref:`CONFIG_ESP_SYSTEM_ALLOW_RTC_FAST_MEM_AS_HEAP` is disabled. This memory can be used interchangeably with :ref:`DRAM`, but is slightly slower to access and not DMA capable.
.. only:: not esp32 and not esp8684
.. only:: not esp32 and not esp32c2
Remaining RTC FAST memory is added to the heap unless the option :ref:`CONFIG_ESP_SYSTEM_ALLOW_RTC_FAST_MEM_AS_HEAP` is disabled. This memory can be used interchangeably with :ref:`DRAM`, but is slightly slower to access.

2
docs/en/api-guides/partition-tables.rst
View File

@@ -88,7 +88,7 @@ The ESP-IDF bootloader ignores any partition types other than ``app`` (0x00) and
SubType
~~~~~~~
{IDF_TARGET_ESP_PHY_REF:default = ":ref:`CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION`", esp8684 = "(not updated yet)"}
{IDF_TARGET_ESP_PHY_REF:default = ":ref:`CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION`", esp32c2 = "(not updated yet)"}
The 8-bit subtype field is specific to a given partition type. ESP-IDF currently only specifies the meaning of the subtype field for ``app`` and ``data`` partition types.

4
docs/en/api-guides/unit-tests.rst
View File

@@ -300,7 +300,7 @@ Refer to :component_file:`cmock/CMock/docs/CMock_Summary.md` for more details on
Requirements
^^^^^^^^^^^^
The following requirements are necessary to generate the mocks:
The following requirements are necessary to generate the mocks:
.. list::
- Installed ESP-IDF with all its requirements
@@ -316,7 +316,7 @@ In the component mock, the following parts are specified:
.. list::
- The headers providing the functions to generate mocks for
- Include paths of the aforementioned headers
- Include paths of the aforementioned headers
- Dependencies of the mock component (this is necessary e.g. if the headers include files from other components)
All these parts have to be specified using the IDF build system function ``idf_component_mock``. You can use the IDF build system function ``idf_component_get_property`` with the tag ``COMPONENT_OVERRIDEN_DIR`` to access the component directory of the original component and then register the mock component parts using ``idf_component_mock``:

14
docs/en/api-reference/peripherals/spi_master.rst
View File

@@ -7,7 +7,7 @@ SPI Master driver is a program that controls {IDF_TARGET_NAME}'s SPI peripherals
Overview of {IDF_TARGET_NAME}'s SPI peripherals
-----------------------------------------------
{IDF_TARGET_MAX_PERIPH_NUM:default="4", esp32c3="3", esp8684="3"}
{IDF_TARGET_MAX_PERIPH_NUM:default="4", esp32c3="3", esp32c2="3"}
{IDF_TARGET_SPI2_CS_NUM:default="6", esp32="3"}
{IDF_TARGET_SPI3_CS_NUM:default="3"}
@@ -32,7 +32,7 @@ Overview of {IDF_TARGET_NAME}'s SPI peripherals
- SPI2 and SPI3 are general purpose SPI controllers. They are open to users. SPI2 and SPI3 have independent signal buses with the same respective names. SPI2 has {IDF_TARGET_SPI2_CS_NUM} CS lines. SPI3 has {IDF_TARGET_SPI3_CS_NUM} CS lines. Each CS line can be used to drive one SPI slave.
.. only:: esp32c3 or esp8684
.. only:: esp32c3 or esp32c2
- SPI2 is a general purpose SPI controller. It has an independent signal bus with the same name. The bus has {IDF_TARGET_SPI2_CS_NUM} CS lines to drive up to {IDF_TARGET_SPI2_CS_NUM} SPI slaves.
@@ -230,7 +230,7 @@ If using more than one data lines to transmit, please set `SPI_DEVICE_HALFDUPLEX
Half-duplex transactions with both read and write phases are not supported when using DMA. For details and workarounds, see :ref:`spi_known_issues`.
.. only:: esp32s3 or esp32c3 or esp8684
.. only:: esp32s3 or esp32c3 or esp32c2
.. note::
@@ -439,10 +439,10 @@ The main parameter that determines the transfer speed for large transactions is
Transaction Duration
^^^^^^^^^^^^^^^^^^^^
{IDF_TARGET_TRANS_TIME_INTR_DMA:default="28", esp32="28", esp32s2="23", esp32c3="28", esp32s3="26", esp8684="42"}
{IDF_TARGET_TRANS_TIME_POLL_DMA:default="10", esp32="10", esp32s2="9", esp32c3="10", esp32s3="11", esp8684="17"}
{IDF_TARGET_TRANS_TIME_INTR_CPU:default="25", esp32="25", esp32s2="22", esp32c3="27", esp32s3="24", esp8684="40"}
{IDF_TARGET_TRANS_TIME_POLL_CPU:default="8", esp32="8", esp32s2="8", esp32c3="9", esp32s3="9", esp8684="15"}
{IDF_TARGET_TRANS_TIME_INTR_DMA:default="28", esp32="28", esp32s2="23", esp32c3="28", esp32s3="26", esp32c2="42"}
{IDF_TARGET_TRANS_TIME_POLL_DMA:default="10", esp32="10", esp32s2="9", esp32c3="10", esp32s3="11", esp32c2="17"}
{IDF_TARGET_TRANS_TIME_INTR_CPU:default="25", esp32="25", esp32s2="22", esp32c3="27", esp32s3="24", esp32c2="40"}
{IDF_TARGET_TRANS_TIME_POLL_CPU:default="8", esp32="8", esp32s2="8", esp32c3="9", esp32s3="9", esp32c2="15"}
Transaction duration includes setting up SPI peripheral registers, copying data to FIFOs or setting up DMA links, and the time for SPI transaction.

2
docs/en/api-reference/peripherals/spi_slave.rst
View File

@@ -18,7 +18,7 @@ Overview of {IDF_TARGET_NAME}'s SPI peripherals
SPI2 and SPI3 have independent signal buses with the same respective names.
.. only:: esp32c3 or esp8684
.. only:: esp32c3 or esp32c2
{IDF_TARGET_NAME} integrates one general purpose SPI controller which can be used as slave node driven by an off-chip SPI master. The controller is called SPI2 and has an independent signal bus with the same name.

0
docs/en/api-reference/system/inc/espefuse_summary_ESP8684.rst → docs/en/api-reference/system/inc/espefuse_summary_ESP32-C2.rst
View File

2
docs/en/hw-reference/index.rst
View File

@@ -6,7 +6,7 @@
.. toctree::
:maxdepth: 3
:not esp8684: Technical Reference Manual (PDF) <{IDF_TARGET_TRM_EN_URL}>
:not esp32c2: Technical Reference Manual (PDF) <{IDF_TARGET_TRM_EN_URL}>
:esp32: ESP32 Datasheet (PDF) <https://espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf>
:esp32s2: ESP32-S2 Datasheet (PDF) <https://espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf>
:esp32c3: ESP32-C3 Datasheet (PDF) <https://espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf>

2
docs/en/index.rst
View File

@@ -8,7 +8,7 @@ ESP-IDF Programming Guide
The function API documentation is excluded from the preview. Add docs_full label to the MR to generate the complete documentation.
This is the documentation for Espressif IoT Development Framework (`esp-idf <https://github.com/espressif/esp-idf>`_). ESP-IDF is the official development framework for the `ESP32, ESP8684, ESP32-S and ESP32-C Series SoCs <https://www.espressif.com/en/products/hardware/socs>`_.
This is the documentation for Espressif IoT Development Framework (`esp-idf <https://github.com/espressif/esp-idf>`_). ESP-IDF is the official development framework for the `ESP32, ESP32-S and ESP32-C Series SoCs <https://www.espressif.com/en/products/hardware/socs>`_.
.. only:: html

4
docs/en/security/esp8684_log.inc → docs/en/security/esp32c2_log.inc
View File

@@ -3,7 +3,7 @@
.. code-block:: none
Update with ESP8684 specific info IDF-4208
Update with ESP32C2 specific info IDF-4208
------
@@ -12,7 +12,7 @@
.. code-block:: none
Update with ESP8684 specific info IDF-4208
Update with ESP32C2 specific info IDF-4208
------

2
docs/zh_CN/api-guides/index.rst
View File

@@ -31,7 +31,7 @@ API 指南
Memory Types <memory-types>
分区表 <partition-tables>
Performance <performance/index>
:not esp8684: 射频校准 <RF_calibration>
:not esp32c2: 射频校准 <RF_calibration>
:esp32: 安全启动 <../security/secure-boot-v1>
安全启动 V2 <../security/secure-boot-v2>
线程本地存储 <thread-local-storage>

28
docs/zh_CN/api-guides/jtag-debugging/esp8684.inc → docs/zh_CN/api-guides/jtag-debugging/esp32c2.inc
View File

@@ -11,9 +11,9 @@
::
openocd -f board/esp8684-BOARD_NAME.cfg
openocd -f board/esp32c2-BOARD_NAME.cfg
.. |run-openocd-device-name| replace:: ESP8684
.. |run-openocd-device-name| replace:: ESP32C2
---
@@ -23,7 +23,7 @@
CHIP SPECIFIC LOG OUTPUT
.. |run-openocd-cfg-file-err| replace:: ``Can't find board/esp8684-BOARD_NAME.cfg``
.. |run-openocd-cfg-file-err| replace:: ``Can't find board/esp32c2-BOARD_NAME.cfg``
---
@@ -31,7 +31,7 @@
::
openocd -f board/esp8684-BOARD_NAME.cfg -c "program_esp filename.bin 0x10000 verify exit"
openocd -f board/esp32c2-BOARD_NAME.cfg -c "program_esp filename.bin 0x10000 verify exit"
---
@@ -39,7 +39,7 @@
.. code-block:: bash
src/openocd -f board/esp8684-BOARD_NAME.cfg
src/openocd -f board/esp32c2-BOARD_NAME.cfg
---
@@ -47,13 +47,13 @@
.. code-block:: batch
src\openocd -f board/esp8684-BOARD_NAME.cfg
src\openocd -f board/esp32c2-BOARD_NAME.cfg
---
.. idf-py-openocd-default-cfg
.. |idf-py-def-cfg| replace:: ``-f board/esp8684-BOARD_NAME.cfg``
.. |idf-py-def-cfg| replace:: ``-f board/esp32c2-BOARD_NAME.cfg``
---
@@ -61,13 +61,13 @@
::
openocd -f board/esp8684-BOARD_NAME.cfg -c "init; halt; esp appimage_offset 0x210000"
openocd -f board/esp32c2-BOARD_NAME.cfg -c "init; halt; esp appimage_offset 0x210000"
---
.. openocd-cfg-files
.. list-table:: OpenOCD configuration files for ESP8684
.. list-table:: OpenOCD configuration files for ESP32C2
:widths: 25 75
:header-rows: 1
@@ -86,11 +86,11 @@
.. jtag-pins
.. list-table:: ESP8684 pins and JTAG signals
.. list-table:: ESP32C2 pins and JTAG signals
:widths: 25 75
:header-rows: 1
* - ESP8684 Pin
* - ESP32C2 Pin
- JTAG Signal
* - MTDO / GPIOX
- TDO
@@ -110,7 +110,7 @@
::
openocd -l openocd_log.txt -d3 -f board/esp8684-BOARD_NAME.cfg
openocd -l openocd_log.txt -d3 -f board/esp32c2-BOARD_NAME.cfg
---
@@ -118,7 +118,7 @@
::
openocd -d3 -f board/esp8684-BOARD_NAME.cfg 2>&1 | tee openocd.log
openocd -d3 -f board/esp32c2-BOARD_NAME.cfg 2>&1 | tee openocd.log
---
@@ -132,7 +132,7 @@
.. devkit-defs
.. |devkit-name| replace:: ESP8684
.. |devkit-name| replace:: ESP32C2
.. |devkit-name-with-link| replace:: LINK TO DEVKIT
---

2
docs/zh_CN/api-guides/memory-types.rst
View File

@@ -134,7 +134,7 @@ RTC FAST memory 的同一区域既可以作为指令存储器也可以作为数
在单核模式下，除非禁用 :ref:`CONFIG_ESP_SYSTEM_ALLOW_RTC_FAST_MEM_AS_HEAP` 选项，否则剩余的 RTC FAST memory 会被添加到堆中。该部分内存可以和 :ref:`DRAM` 互换使用，但是访问速度稍慢，且不具备 DMA 功能。
.. only:: not esp32 and not esp8684
.. only:: not esp32 and not esp32c2
除非禁用 :ref:`CONFIG_ESP_SYSTEM_ALLOW_RTC_FAST_MEM_AS_HEAP` 选项，否则剩余的 RTC FAST memory 会被添加到堆中。该部分内存可以和 :ref:`DRAM` 互换使用，但是访问速度稍慢一点。

2
docs/zh_CN/api-guides/partition-tables.rst
View File

@@ -88,7 +88,7 @@ Type 字段可以指定为 app (0x00) 或者 data (0x01)，也可以直接使用
SubType 字段
~~~~~~~~~~~~
{IDF_TARGET_ESP_PHY_REF:default = ":ref:`CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION`", esp8684 = "(not updated yet)"}
{IDF_TARGET_ESP_PHY_REF:default = ":ref:`CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION`", esp32c2 = "(not updated yet)"}
SubType 字段长度为 8 bit，内容与具体分区 Type 有关。目前，esp-idf 仅仅规定了 “app” 和 “data” 两种分区类型的子类型含义。

0
docs/zh_CN/api-reference/system/inc/espefuse_summary_ESP8684.rst → docs/zh_CN/api-reference/system/inc/espefuse_summary_ESP32-C2.rst
View File

2
docs/zh_CN/hw-reference/index.rst
View File

@@ -6,7 +6,7 @@
.. toctree::
:maxdepth: 3
:not esp8684: {IDF_TARGET_NAME} 技术参考手册 (PDF) <{IDF_TARGET_TRM_CN_URL}>
:not esp32c2: {IDF_TARGET_NAME} 技术参考手册 (PDF) <{IDF_TARGET_TRM_CN_URL}>
:esp32: ESP32 技术规格书 (PDF) <https://espressif.com/sites/default/files/documentation/esp32_datasheet_cn.pdf>
:esp32s2: ESP32-S2 技术规格书 (PDF) <https://espressif.com/sites/default/files/documentation/esp32-s2_datasheet_cn.pdf>
:esp32c3: ESP32-C3 技术规格书 (PDF) <https://espressif.com/sites/default/files/documentation/esp32-c3_datasheet_cn.pdf>

4
docs/zh_CN/security/esp8684_log.inc → docs/zh_CN/security/esp32c2_log.inc
View File

@@ -3,7 +3,7 @@
.. code-block:: none
Update with ESP8684 specific info IDF-4208
Update with ESP32C2 specific info IDF-4208
------
@@ -12,7 +12,7 @@
.. code-block:: none
Update with ESP8684 specific info IDF-4208
Update with ESP32C2 specific info IDF-4208
------