Merge branch 'bugfix/btdm_security_vulnerability_on_encryption_key_size_v3.3' into 'release/v3.3'

components/bt: set the minimum encryption key size to be 7 octects for BR/EDR link

See merge request espressif/esp-idf!5872

.editorconfig

@@ -37,7 +37,3 @@ max_line_length = 119
 indent_style = space
 indent_size = 4
 max_line_length = 120
-
-[{*.sh,*.yml}]
-indent_style = space
-indent_size = 2

.flake8

@@ -140,19 +140,17 @@ exclude =
     .git,
     __pycache__,
     # submodules
-        components/bootloader/subproject/components/micro-ecc/micro-ecc,
-        components/bt/host/nimble/nimble,
-        components/cmock/CMock,
         components/esptool_py/esptool,
-        components/expat/expat,
-        components/json/cJSON,
-        components/libsodium/libsodium,
-        components/mbedtls/mbedtls,
+        components/micro-ecc/micro-ecc,
         components/nghttp/nghttp2,
-        components/tinyusb,
+        components/libsodium/libsodium,
+        components/json/cJSON,
+        components/mbedtls/mbedtls,
+        components/expat/expat,
         components/unity/unity,
-        examples/build_system/cmake/import_lib/main/lib/tinyxml2,
-        examples/peripherals/secure_element/atecc608_ecdsa/components/esp-cryptoauthlib,
+        examples/build_system/cmake/import_lib/main/lib/tinyxml2
+    # other third-party libraries
+        tools/kconfig_new/kconfiglib.py,
     # autogenerated scripts
         components/protocomm/python/constants_pb2.py,
         components/protocomm/python/sec0_pb2.py,
@@ -161,5 +159,7 @@ exclude =
         components/wifi_provisioning/python/wifi_scan_pb2.py,
         components/wifi_provisioning/python/wifi_config_pb2.py,
         components/wifi_provisioning/python/wifi_constants_pb2.py,
-        components/esp_local_ctrl/python/esp_local_ctrl_pb2.py,
-        examples/provisioning/legacy/custom_config/components/custom_provisioning/python/custom_config_pb2.py,
+        examples/provisioning/custom_config/components/custom_provisioning/python/custom_config_pb2.py,
+    # temporary list (should be empty)
+        tools/esp_app_trace/pylibelf,
+        tools/mass_mfg/mfg_gen.py,

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,92 +0,0 @@
----
-name: Bug report
-about: ESP-IDF crashes, produces incorrect output, or has incorrect behavior
-title: ''
-labels: ''
-assignees: ''
-
----
-
------------------------------ Delete below -----------------------------
-
-**Reminder: If your issue is a general question, starts similar to "How do I..", or is related to 3rd party development kits/libs, please discuss this on our community forum at https://esp32.com instead.**
-
-INSTRUCTIONS
-============
-
-Before submitting a new issue, please follow the checklist and try to find the answer.
-
-- [ ] I have read the documentation [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/) and the issue is not addressed there.
-- [ ] I have updated my IDF branch (master or release) to the latest version and checked that the issue is present there.
-- [ ] I have searched the issue tracker for a similar issue and not found a similar issue.
-
-If the issue cannot be solved after the steps before, please follow these instructions so we can get the needed information to help you in a quick and effective fashion.
-
-1. Fill in all the fields under **Environment** marked with [ ] by picking the correct option for you in each case and deleting the others.
-2. Describe your problem.
-3. Include [debug logs from the "monitor" tool](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/idf-monitor.html#automatically-decoding-addresses), or [coredumps](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/core_dump.html).
-4. Providing as much information as possible under **Other items if possible** will help us locate and fix the problem.
-5. Use [Markdown](https://guides.github.com/features/mastering-markdown/) (see formatting buttons above) and the Preview tab to check what the issue will look like.
-6. Delete these instructions from the above to the below marker lines before submitting this issue.
-
-**IMPORTANT: If you do not follow these instructions and provide the necessary details, your issue may not be resolved.**
-
------------------------------ Delete above -----------------------------
-
-## Environment
-
-- Development Kit:      [ESP32-Wrover-Kit|ESP32-DevKitC|ESP32-PICO-Kit|ESP32-LyraT|ESP32-LyraTD-MSC|none]
-- Kit version (for WroverKit/PicoKit/DevKitC): [v1|v2|v3|v4]
-- Module or chip used:  [ESP32-WROOM-32|ESP32-WROOM-32D|ESP32-WROOM-32U|ESP32-WROVER|ESP32-WROVER-I|ESP32-WROVER-B|ESP32-WROVER-IB|ESP32-SOLO-1|ESP32-PICO-D4|ESP32]
-- IDF version (run ``git describe --tags`` to find it):
-    // v3.2-dev-1148-g96cd3b75c
-- Build System:         [Make|CMake|idf.py]
-- Compiler version (run ``xtensa-esp32-elf-gcc --version`` to find it):
-    // 1.22.0-80-g6c4433a
-- Operating System:     [Windows|Linux|macOS]
-- (Windows only) environment type: [MSYS2 mingw32|ESP Command Prompt|Plain Command Prompt|PowerShell].
-- Using an IDE?: [No|Yes (please give details)]
-- Power Supply:         [USB|external 5V|external 3.3V|Battery]
-
-## Problem Description
-
-//Detailed problem description goes here.
-
-### Expected Behavior
-
-### Actual Behavior
-
-### Steps to reproduce
-
-1. step1
-2. ...
-
-// If possible, attach a picture of your setup/wiring here.
-
-
-### Code to reproduce this issue
-
-```cpp
-// the code should be wrapped in the ```cpp tag so that it will be displayed better.
-#include "esp_log.h"
-
-void app_main()
-{
-
-}
-
-```
-// If your code is longer than 30 lines, [GIST](https://gist.github.com) is preferred.
-
-## Debug Logs
-
-```
-Debug log goes here, should contain the backtrace, as well as the reset source if it is a crash.
-Please copy the plain text here for us to search the error log. Or attach the complete logs but leave the main part here if the log is *too* long.
-```
-
-## Other items if possible
-
-- [ ] sdkconfig file (attach the sdkconfig file from your project folder)
-- [ ] elf file in the ``build`` folder (**note this may contain all the code details and symbols of your project.**)
-- [ ] coredump (This provides stacks of tasks.)

.github/ISSUE_TEMPLATE/config.yml

@@ -1,14 +0,0 @@
-blank_issues_enabled: false
-contact_links:
-  - name: ESP-IDF Programming Guide
-    url: https://docs.espressif.com/projects/esp-idf/en/latest/
-    about: Documentation for configuring and using ESP-IDF
-  - name: Espressif documentation page
-    url: https://www.espressif.com/en/support/download/documents
-    about: Hardware documentation (datasheets, Technical Reference Manual, etc)
-  - name: Forum
-    url: https://esp32.com
-    about: For questions about using ESP-IDF and/or ESP32 series chips. Please submit all questions starting "How do I..." here.
-  - name: Hardware-related services
-    url: https://www.espressif.com/en/products/hardware-services
-    about: Espressif service providing hardware design and certification support

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,26 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for ESP-IDF
-title: ''
-labels: 'Type: Feature Request'
-assignees: ''
-
----
-
-**Is your feature request related to a problem? Please describe.**
-
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-
-A clear and concise description of any alternative solutions or features you've considered.
-
-Please give as many details as you can. Include suggestions for useful APIs or interfaces if relevant.
-
-**Additional context**
-
-Add any other context or screenshots about the feature request here.

.github/main.workflow

@@ -0,0 +1,17 @@
+workflow "Sync issues to JIRA" {
+  on = "issues"
+  resolves = ["Sync to JIRA"]
+}
+
+workflow "Sync issue comments to JIRA" {
+  on = "issue_comment"
+  resolves = ["Sync to JIRA"]
+}
+
+action "Sync to JIRA" {
+  uses = "espressif/github-actions/sync_issues_to_jira@master"
+  secrets = ["GITHUB_TOKEN", "JIRA_URL", "JIRA_USER", "JIRA_PASS"]
+  env = {
+    JIRA_PROJECT = "IDFGH"
+  }
+}

.github/workflows/docker.yml

@@ -1,75 +0,0 @@
-name: docker
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-
-on:
-  push:
-    branches:
-      - "master"
-      - "release/*"
-    tags:
-      - "v*.*"
-
-env:
-  # Platforms to build the image for
-  BUILD_PLATFORMS: linux/amd64
-  DOCKERHUB_REPO: ${{ github.repository_owner }}/idf
-
-jobs:
-  docker:
-    # Disable the job in forks
-    if: ${{ github.repository_owner == 'espressif' }}
-
-    runs-on: ubuntu-latest
-    steps:
-      # Depending on the branch/tag, set CLONE_BRANCH_OR_TAG variable (used in the Dockerfile
-      # as a build arg) and TAG_NAME (used when tagging the image).
-      #
-      # The following 3 steps cover the alternatives (tag, release branch, master branch):
-      - name: Set variables (tags)
-        if: ${{ github.ref_type == 'tag' }}
-        run: |
-          echo "CLONE_BRANCH_OR_TAG=$GITHUB_REF_NAME" >> $GITHUB_ENV
-          echo "TAG_NAME=$GITHUB_REF_NAME" >> $GITHUB_ENV
-      - name: Set variables (release branches)
-        if: ${{ github.ref_type == 'branch' && startsWith(github.ref_name, 'release/') }}
-        run: |
-          echo "CLONE_BRANCH_OR_TAG=$GITHUB_REF_NAME" >> $GITHUB_ENV
-          echo "TAG_NAME=release-${GITHUB_REF_NAME##release/}" >> $GITHUB_ENV
-      - name: Set variables (main branch)
-        if: ${{ github.ref_type == 'branch' && github.ref_name == 'master' }}
-        run: |
-          echo "CLONE_BRANCH_OR_TAG=master" >> $GITHUB_ENV
-          echo "TAG_NAME=latest" >> $GITHUB_ENV
-
-      # Display the variables set above, just in case.
-      - name: Check variables
-        run: |
-          echo "CLONE_BRANCH_OR_TAG: $CLONE_BRANCH_OR_TAG"
-          echo "CHECKOUT_REF: $CHECKOUT_REF"
-          echo "TAG_NAME: $TAG_NAME"
-
-      # The following steps are the standard boilerplate from
-      # https://github.com/marketplace/actions/build-and-push-docker-images
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-      - name: Set up QEMU for multiarch builds
-        uses: docker/setup-qemu-action@v2
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-      - name: Build and push
-        uses: docker/build-push-action@v3
-        with:
-          context: tools/docker
-          push: true
-          tags: ${{ env.DOCKERHUB_REPO }}:${{ env.TAG_NAME }}
-          platforms: ${{ env.BUILD_PLATFORMS }}
-          build-args: |
-            IDF_CLONE_URL=${{ github.server_url }}/${{ github.repository }}.git
-            IDF_CLONE_BRANCH_OR_TAG=${{ env.CLONE_BRANCH_OR_TAG }}

.github/workflows/issue_comment.yml

@@ -1,19 +0,0 @@
-name: Sync issue comments to JIRA
-
-# This workflow will be triggered when new issue comment is created (including PR comments)
-on: issue_comment
-
-jobs:
-  sync_issue_comments_to_jira:
-    name: Sync Issue Comments to Jira
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@master
-      - name: Sync issue comments to JIRA
-        uses: espressif/github-actions/sync_issues_to_jira@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          JIRA_PASS: ${{ secrets.JIRA_PASS }}
-          JIRA_PROJECT: IDFGH
-          JIRA_URL: ${{ secrets.JIRA_URL }}
-          JIRA_USER: ${{ secrets.JIRA_USER }}

.github/workflows/new_issues.yml

@@ -1,19 +0,0 @@
-name: Sync issues to Jira
-
-# This workflow will be triggered when a new issue is opened
-on: issues
-
-jobs:
-  sync_issues_to_jira:
-    name: Sync issues to Jira
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@master
-      - name: Sync GitHub issues to Jira project
-        uses: espressif/github-actions/sync_issues_to_jira@master
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          JIRA_PASS: ${{ secrets.JIRA_PASS }}
-          JIRA_PROJECT: IDFGH
-          JIRA_URL: ${{ secrets.JIRA_URL }}
-          JIRA_USER: ${{ secrets.JIRA_USER }}

.github/workflows/new_prs.yml

@@ -1,24 +0,0 @@
-name: Sync remain PRs to Jira
-
-# This workflow will be triggered every hour, to sync remaining PRs (i.e. PRs with zero comment) to Jira project
-# Note that, PRs can also get synced when new PR comment is created
-on:
-  schedule:
-    - cron: "0 * * * *"
-
-jobs:
-  sync_prs_to_jira:
-    name: Sync PRs to Jira
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@master
-      - name: Sync PRs to Jira project
-        uses: espressif/github-actions/sync_issues_to_jira@master
-        with:
-          cron_job: true
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          JIRA_PASS: ${{ secrets.JIRA_PASS }}
-          JIRA_PROJECT: IDFGH
-          JIRA_URL: ${{ secrets.JIRA_URL }}
-          JIRA_USER: ${{ secrets.JIRA_USER }}

.github/workflows/python_lint.yml

@@ -1,33 +0,0 @@
-name: Python CI
-
-# This workflow will be triggered when a PR modifies some python relevant files
-on:
-  pull_request:
-    paths:
-      - "**.py"
-      - "requirements.txt"
-
-jobs:
-  python_lint:
-    name: python lint
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: [2.7, 3.5, 3.6, 3.7, 3.8]
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@master
-      - name: Set up Python environment
-        uses: actions/setup-python@master
-        with:
-          python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          export IDF_PATH=${GITHUB_WORKSPACE}
-          pip install --upgrade pip
-          pip install -r requirements.txt
-      - name: Lint with flake8
-        run: |
-          pip install flake8
-          flake8 . --config=.flake8 --benchmark

.github/workflows/release_zips.yml

@@ -1,17 +0,0 @@
-name: Create zip file with recursive source clone for release
-
-on:
-  push:
-    tags:
-      - v*
-
-jobs:
-  release_zips:
-    name: Create release zip file
-    runs-on: ubuntu-20.04
-    steps:
-      - name: Create a recursive clone source zip
-        uses: espressif/github-actions/release_zips@master
-        env:
-            RELEASE_PROJECT_NAME: ESP-IDF
-            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -21,73 +21,56 @@ GPATH
 # MacOS directory files
 .DS_Store
 
-# Components Unit Test Apps files
-components/**/build
-components/**/sdkconfig
-components/**/sdkconfig.old
-
 # Example project files
 examples/**/sdkconfig
 examples/**/sdkconfig.old
 examples/**/build
 
 # Doc build artifacts
-docs/_build/
+docs/*/_build/
+docs/*/doxygen-warning-log.txt
+docs/*/sphinx-warning-log.txt
+docs/*/sphinx-warning-log-sanitized.txt
+docs/*/xml/
+docs/*/xml_in/
+docs/*/man/
 docs/doxygen_sqlite3.db
 
-# Downloaded font files
-docs/_static/DejaVuSans.ttf
-docs/_static/NotoSansSC-Regular.otf
-
 # Unit test app files
 tools/unit-test-app/sdkconfig
 tools/unit-test-app/sdkconfig.old
 tools/unit-test-app/build
 tools/unit-test-app/builds
 tools/unit-test-app/output
-tools/unit-test-app/test_configs
-
-# Unit Test CMake compile log folder
-log_ut_cmake
-
-# test application build files
-tools/test_apps/**/build
-tools/test_apps/**/sdkconfig
-tools/test_apps/**/sdkconfig.old
 
 # IDF monitor test
 tools/test_idf_monitor/outputs
 
 TEST_LOGS
 
+# AWS IoT Examples require device-specific certs/keys
+examples/protocols/aws_iot/*/main/certs/*.pem.*
+
 # gcov coverage reports
 *.gcda
 *.gcno
 coverage.info
 coverage_report/
 
+# Windows tools installer build
+tools/windows/tool_setup/.*
+tools/windows/tool_setup/input
+tools/windows/tool_setup/dl
+tools/windows/tool_setup/keys
+tools/windows/tool_setup/Output
+
 test_multi_heap_host
 
 # VS Code Settings
 .vscode/
 
-# VIM files
-*.swp
-*.swo
-
-# Clion IDE CMake build & config
-.idea/
-cmake-build-*/
-
-# Results for the checking of the Python coding style and static analysis
-.mypy_cache
+# Results for the checking of the Python coding style
 flake8_output.txt
 
-# ESP-IDF default build directory name
+# ESP-IDF library 
 build
-
-# lock files for examples and components
-dependencies.lock
-
-# managed_components for examples
-managed_components

.gitlab/CODEOWNERS

@@ -1,6 +0,0 @@
-# For the syntax of this file, see:
-#
-#    https://docs.gitlab.com/ee/user/project/code_owners.html#the-syntax-of-code-owners-files
-#
-
-* @esp-idf-codeowners/all-maintainers

.gitlab/merge_request_templates/Mixed Template.md

@@ -1,64 +0,0 @@
-_All texts in italics are instructional and should be replaced by contents or removed._
-
-## Checklist
-
-_This entire section can be deleted if all items are checked._
-
-* [ ] Enough information to help reviewers understand the issue, its root cause, impact, and the proposed solution
-* [ ] Enough information to help reviewers understand the feature, its functional description, example, documentation, test cases, test results, feature TODO list
-* [ ] The MR Title describes the change, including the component name, ie "lwip: Add support for IP over Pigeon"
-* [ ] All related links, including JIRA, backport, submodule MR, are mentioned in the `Related` subsection.
-* [ ] Any GitHub issues are linked inside the git commit message and corresponding release notes
-* [ ] Add label for the area this MR is part of
-* [ ] For documentation updates, check if label `Docs` and `needs translation:CN` or `needs translation:EN`  have been added when the other language version still needs the update. Skip adding the label if the document is not yet translated.
-* [ ] Check if documents requiring translation fall under get-started section. If yes, add the labels mentioned above. Then the documentation team will assign a translator for you. Please inform the translator to prepare translation once your MR is ready to merge. The translation should be included in your MR to get it merged. For more information, see documentation workflow in Wiki.
-* [ ] Any necessary "needs backport" labels are added
-* [ ] Check if this is a breaking change. If it is, add notes to the `Breaking change notes` subsection below
-* [ ] Release note entry if this is a new public feature, or a fix for an issue introduced in the previous release.
-* [ ] The commit log is clean and ready to merge.
-* [ ] All relevant CI jobs have been run, i.e. jobs which cover the code changed by the MR.
-* [ ] Pipeline with Python 3 has been successfully run, i.e. `@bot ...; with Python3`, if the MR adds or changes Python code.
-
----
-
-_For issues, put enough information here to help reviewers understand the issue, its root cause, impact, and the proposed solution._
-
-_If this issue is a regression, specify in the `Related` subsection below, in which commit or MR it was introduced. This helps reviewers to check if the backport labels are set correctly._
-
----
-
-_For features, put enough information here to help reviewers understand the feature, its functional description, example, documentation, test cases, test results, feature TODO list._
-
----
-
-_For other small/non-public changes, which are not expected to be in the release notes, can be mentioned here, include:_
-
- * changes that don't apply to customers, e.g. some CI fixes, test only MR and etc
-
-## Related
-
-* Mention or related JIRA tasks (e.g. IDF-0000), to make sure they get updated.
-* Mention submodule MR, if there is
-* Mention backport(ed) MR, if there is
-
-_Don't touch the subsection titles below, they will be parsed by scripts._
-
-## Release notes (Mandatory)
-
-_Changes made in this MR that should go into the **Release Notes** should be listed here. Please use **past tense** and *specify the area (see maintainers page of IDF internal wiki)*. If there is a subscope, include it and separate with slash (`/`). Minor changes can go to the descriptions above without a release notes entry._
-
-_Write all the changes in a **list** (Start at the beginning of the line with `-` or `*`). If multiple changes are made, each of them should take a single line. If there is only one change to list, it should still be the only line of a list. If this MR does not need any release notes, write "No release notes" here without the `-` or `*`. e.g._
-
-* [WiFi] Changed/fixed/updated xxx
-* [WiFi] Added support of xxx
-* [Peripheral Drivers/I2S] Fixed xxx (https://github.com/espressif/esp-idf/issues/xxxx)
-
-## Breaking change notes
-
-_Remove this subsection if not used._
-
-_If there are any breaking changes, please mention it here. Talking about (1) what is not accepted any more, (2) the alternative solution and (3) the benefits/reason. e.g._
-
-_Please strictly follow the breaking change restriction, which means, if there is a breaking change but you are merging to non-major versions, you have to separate the breaking part out to another MR for a major version. The breaking change subsection is only accepted in MRs merging to major versions._
-
-* [VFS/UART] Now vfs_uart_set_rts_cts accept one more instance argument, to support configuration to different ports.

.gitmodules

@@ -1,96 +1,71 @@
-#
-# All the relative URL paths are intended to be GitHub ones
-# For Espressif's public projects please use '../../espressif/proj', not a '../proj'
-#
+[submodule "components/esp32/lib"]
+	path = components/esp32/lib
+	url = https://github.com/espressif/esp32-wifi-lib.git
 
 [submodule "components/esptool_py/esptool"]
 	path = components/esptool_py/esptool
-	url = ../../espressif/esptool.git
+	url = https://github.com/espressif/esptool.git
 
-[submodule "components/bt/controller/lib_esp32"]
-	path = components/bt/controller/lib_esp32
-	url = ../../espressif/esp32-bt-lib.git
+[submodule "components/bt/lib"]
+	path = components/bt/lib
+	url = https://github.com/espressif/esp32-bt-lib.git
 
-[submodule "components/bootloader/subproject/components/micro-ecc/micro-ecc"]
-	path = components/bootloader/subproject/components/micro-ecc/micro-ecc
-	url = ../../kmackay/micro-ecc.git
+[submodule "components/micro-ecc/micro-ecc"]
+	path = components/micro-ecc/micro-ecc
+	url = https://github.com/kmackay/micro-ecc.git
 
 [submodule "components/coap/libcoap"]
 	path = components/coap/libcoap
-	url = ../../obgm/libcoap.git
+	url = https://github.com/obgm/libcoap.git
+
+[submodule "components/aws_iot/aws-iot-device-sdk-embedded-C"]
+	path = components/aws_iot/aws-iot-device-sdk-embedded-C
+	url = https://github.com/espressif/aws-iot-device-sdk-embedded-C.git
 
 [submodule "components/nghttp/nghttp2"]
 	path = components/nghttp/nghttp2
-	url = ../../nghttp2/nghttp2.git
+	url = https://github.com/nghttp2/nghttp2.git
 
 [submodule "components/libsodium/libsodium"]
 	path = components/libsodium/libsodium
-	url = ../../jedisct1/libsodium.git
+	url = https://github.com/jedisct1/libsodium.git
 
 [submodule "components/spiffs/spiffs"]
 	path = components/spiffs/spiffs
-	url = ../../pellepl/spiffs.git
+	url = https://github.com/pellepl/spiffs.git
 
 [submodule "components/json/cJSON"]
 	path = components/json/cJSON
-	url = ../../DaveGamble/cJSON.git
+	url = https://github.com/DaveGamble/cJSON.git
 
 [submodule "components/mbedtls/mbedtls"]
 	path = components/mbedtls/mbedtls
-	url = ../../espressif/mbedtls.git
+	url = https://github.com/espressif/mbedtls.git
 
 [submodule "components/asio/asio"]
 	path = components/asio/asio
-	url = ../../espressif/asio.git
+	url = https://github.com/espressif/asio.git
 
 [submodule "components/expat/expat"]
 	path = components/expat/expat
-	url = ../../libexpat/libexpat.git
+	url = https://github.com/libexpat/libexpat.git
 
 [submodule "components/lwip/lwip"]
 	path = components/lwip/lwip
-	url = ../../espressif/esp-lwip.git
+	url = https://github.com/espressif/esp-lwip.git
 
 [submodule "components/mqtt/esp-mqtt"]
 	path = components/mqtt/esp-mqtt
-	url = ../../espressif/esp-mqtt.git
+	url = https://github.com/espressif/esp-mqtt.git
 
 [submodule "components/protobuf-c/protobuf-c"]
 	path = components/protobuf-c/protobuf-c
-	url = ../../protobuf-c/protobuf-c.git
+	url = https://github.com/protobuf-c/protobuf-c
 
 [submodule "components/unity/unity"]
 	path = components/unity/unity
-	url = ../../ThrowTheSwitch/Unity.git
+	url = https://github.com/ThrowTheSwitch/Unity
 
 [submodule "examples/build_system/cmake/import_lib/main/lib/tinyxml2"]
 	path = examples/build_system/cmake/import_lib/main/lib/tinyxml2
-	url = ../../leethomason/tinyxml2.git
-
-[submodule "components/bt/host/nimble/nimble"]
-	path = components/bt/host/nimble/nimble
-	url = ../../espressif/esp-nimble.git
-
-[submodule "components/cbor/tinycbor"]
-	path = components/cbor/tinycbor
-	url = ../../intel/tinycbor.git
-
-[submodule "components/esp_wifi/lib"]
-	path = components/esp_wifi/lib
-	url = ../../espressif/esp32-wifi-lib.git
-
-[submodule "components/tinyusb/tinyusb"]
-	path = components/tinyusb/tinyusb
-	url = ../../espressif/tinyusb.git
-
-[submodule "examples/peripherals/secure_element/atecc608_ecdsa/components/esp-cryptoauthlib"]
-	path = examples/peripherals/secure_element/atecc608_ecdsa/components/esp-cryptoauthlib
-	url = ../../espressif/esp-cryptoauthlib.git
-
-[submodule "components/cmock/CMock"]
-	path = components/cmock/CMock
-	url = ../../ThrowTheSwitch/CMock.git
-
-[submodule "components/bt/controller/lib_esp32c3_family"]
-	path = components/bt/controller/lib_esp32c3_family
-	url = ../../espressif/esp32c3-bt-lib.git
+	url = https://github.com/leethomason/tinyxml2

.pre-commit-config.yaml

@@ -1,80 +0,0 @@
-# See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
-
-repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
-    hooks:
-      - id: trailing-whitespace
-        # note: whitespace exclusions use multiline regex, see https://pre-commit.com/#regular-expressions
-        # items are:
-        # 1 - some file extensions
-        # 2 - any file matching *test*/*expected* (for host tests, if possible use this naming pattern always)
-        # 3 - any directory named 'testdata'
-        # 4 - IDF monitor test data
-        exclude: &whitespace_excludes |
-            (?x)^(
-                .+\.(md|rst|map|bin)|
-                .+test.*\/.*expected.*|
-                .+\/testdata\/.+|
-                .+test_idf_monitor\/tests\/.+
-            )$
-      - id: end-of-file-fixer
-        exclude: *whitespace_excludes
-      - id: check-executables-have-shebangs
-      - id: mixed-line-ending
-        args: ['-f=lf']
-      - id: double-quote-string-fixer
-  - repo: https://github.com/PyCQA/flake8
-    rev: 3.8.4
-    hooks:
-      - id: flake8
-        args: ['--config=.flake8', '--tee', '--benchmark']
-  - repo: https://github.com/pycqa/isort
-    rev: 5.11.5  # python 3.7 compatible
-    hooks:
-      - id: isort
-        name: isort (python)
-  - repo: local
-    hooks:
-      - id: check-executables
-        name: Check File Permissions
-        entry: tools/ci/check_executables.py --action executables
-        language: python
-        types: [executable]
-        exclude: '\.pre-commit/.+'
-      - id: check-executable-list
-        name: Validate executable-list.txt
-        entry: tools/ci/check_executables.py --action list
-        language: python
-        pass_filenames: false
-        always_run: true
-      - id: check-kconfigs
-        name: Validate Kconfig files
-        entry: tools/ci/check_kconfigs.py
-        language: python
-        files: '^Kconfig$|Kconfig.*$'
-      - id: check-deprecated-kconfigs-options
-        name: Check if any Kconfig Options Deprecated
-        entry: tools/ci/check_deprecated_kconfigs.py
-        language: python
-        files: 'sdkconfig\.ci$|sdkconfig\.rename$|sdkconfig.*$'
-      - id: cmake-lint
-        name: Check CMake Files Format
-        entry: cmakelint --linelength=120 --spaces=4 --filter=-whitespace/indent
-        language: python
-        additional_dependencies:
-          - cmakelint==1.4.1
-        files: 'CMakeLists.txt$|\.cmake$'
-        exclude: '\/third_party\/'
-      - id: check-codeowners
-        name: Validate Codeowner File
-        entry: tools/ci/check_codeowners.py ci-check
-        language: python
-        files: '\.gitlab/CODEOWNERS'
-        pass_filenames: false
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
-    hooks:
-      - id: file-contents-sorter
-        files: 'tools/ci/executable-list.txt'

.pylintrc

@@ -1,603 +0,0 @@
-[MASTER]
-
-# A comma-separated list of package or module names from where C extensions may
-# be loaded. Extensions are loading into the active Python interpreter and may
-# run arbitrary code.
-extension-pkg-whitelist=
-
-# Specify a score threshold to be exceeded before program exits with error.
-fail-under=10
-
-# Add files or directories to the blacklist. They should be base names, not
-# paths.
-ignore=CVS
-
-# Add files or directories matching the regex patterns to the blacklist. The
-# regex matches against base names, not paths.
-ignore-patterns=
-
-# Python code to execute, usually for sys.path manipulation such as
-# pygtk.require().
-#init-hook=
-
-# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
-# number of processors available to use.
-jobs=1
-
-# Control the amount of potential inferred values when inferring a single
-# object. This can help the performance when dealing with large functions or
-# complex, nested conditions.
-limit-inference-results=100
-
-# List of plugins (as comma separated values of python module names) to load,
-# usually to register additional checkers.
-load-plugins=
-
-# Pickle collected data for later comparisons.
-persistent=yes
-
-# When enabled, pylint would attempt to guess common misconfiguration and emit
-# user-friendly hints instead of false-positive error messages.
-suggestion-mode=yes
-
-# Allow loading of arbitrary C extensions. Extensions are imported into the
-# active Python interpreter and may run arbitrary code.
-unsafe-load-any-extension=no
-
-
-[MESSAGES CONTROL]
-
-# Only show warnings with the listed confidence levels. Leave empty to show
-# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
-confidence=
-
-# Disable the message, report, category or checker with the given id(s). You
-# can either give multiple identifiers separated by comma (,) or put this
-# option multiple times (only on the command line, not in the configuration
-# file where it should appear only once). You can also use "--disable=all" to
-# disable everything first and then reenable specific checks. For example, if
-# you want to run only the similarities checker, you can use "--disable=all
-# --enable=similarities". If you want to run only the classes checker, but have
-# no Warning level messages displayed, use "--disable=all --enable=classes
-# --disable=W".
-disable=print-statement,
-        parameter-unpacking,
-        unpacking-in-except,
-        old-raise-syntax,
-        backtick,
-        long-suffix,
-        old-ne-operator,
-        old-octal-literal,
-        import-star-module-level,
-        non-ascii-bytes-literal,
-        raw-checker-failed,
-        bad-inline-option,
-        locally-disabled,
-        file-ignored,
-        suppressed-message,
-        useless-suppression,
-        deprecated-pragma,
-        use-symbolic-message-instead,
-        apply-builtin,
-        basestring-builtin,
-        buffer-builtin,
-        cmp-builtin,
-        coerce-builtin,
-        execfile-builtin,
-        file-builtin,
-        long-builtin,
-        raw_input-builtin,
-        reduce-builtin,
-        standarderror-builtin,
-        unicode-builtin,
-        xrange-builtin,
-        coerce-method,
-        delslice-method,
-        getslice-method,
-        setslice-method,
-        no-absolute-import,
-        old-division,
-        dict-iter-method,
-        dict-view-method,
-        next-method-called,
-        metaclass-assignment,
-        indexing-exception,
-        raising-string,
-        reload-builtin,
-        oct-method,
-        hex-method,
-        nonzero-method,
-        cmp-method,
-        input-builtin,
-        round-builtin,
-        intern-builtin,
-        unichr-builtin,
-        map-builtin-not-iterating,
-        zip-builtin-not-iterating,
-        range-builtin-not-iterating,
-        filter-builtin-not-iterating,
-        using-cmp-argument,
-        eq-without-hash,
-        div-method,
-        idiv-method,
-        rdiv-method,
-        exception-message-attribute,
-        invalid-str-codec,
-        sys-max-int,
-        bad-python3-import,
-        deprecated-string-function,
-        deprecated-str-translate-call,
-        deprecated-itertools-function,
-        deprecated-types-field,
-        next-method-defined,
-        dict-items-not-iterating,
-        dict-keys-not-iterating,
-        dict-values-not-iterating,
-        deprecated-operator-function,
-        deprecated-urllib-function,
-        xreadlines-attribute,
-        deprecated-sys-function,
-        exception-escape,
-        comprehension-escape,
-        missing-function-docstring, # Modified since here, include this line
-        missing-class-docstring,
-        missing-module-docstring,
-        wrong-import-order,
-        invalid-name,
-        too-few-public-methods,
-        too-many-locals,
-        bad-super-call,  # since we still haven't drop python2 support
-
-# Enable the message, report, category or checker with the given id(s). You can
-# either give multiple identifier separated by comma (,) or put this option
-# multiple time (only on the command line, not in the configuration file where
-# it should appear only once). See also the "--disable" option for examples.
-enable=c-extension-no-member
-
-
-[REPORTS]
-
-# Python expression which should return a score less than or equal to 10. You
-# have access to the variables 'error', 'warning', 'refactor', and 'convention'
-# which contain the number of messages in each category, as well as 'statement'
-# which is the total number of statements analyzed. This score is used by the
-# global evaluation report (RP0004).
-evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
-
-# Template used to display messages. This is a python new-style format string
-# used to format the message information. See doc for all details.
-#msg-template=
-
-# Set the output format. Available formats are text, parseable, colorized, json
-# and msvs (visual studio). You can also give a reporter class, e.g.
-# mypackage.mymodule.MyReporterClass.
-output-format=text
-
-# Tells whether to display a full report or only the messages.
-reports=no
-
-# Activate the evaluation score.
-score=yes
-
-
-[REFACTORING]
-
-# Maximum number of nested blocks for function / method body
-max-nested-blocks=5
-
-# Complete name of functions that never returns. When checking for
-# inconsistent-return-statements if a never returning function is called then
-# it will be considered as an explicit return statement and no message will be
-# printed.
-never-returning-functions=sys.exit
-
-
-[TYPECHECK]
-
-# List of decorators that produce context managers, such as
-# contextlib.contextmanager. Add to this list to register other decorators that
-# produce valid context managers.
-contextmanager-decorators=contextlib.contextmanager
-
-# List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E1101 when accessed. Python regular
-# expressions are accepted.
-generated-members=
-
-# Tells whether missing members accessed in mixin class should be ignored. A
-# mixin class is detected if its name ends with "mixin" (case insensitive).
-ignore-mixin-members=yes
-
-# Tells whether to warn about missing members when the owner of the attribute
-# is inferred to be None.
-ignore-none=yes
-
-# This flag controls whether pylint should warn about no-member and similar
-# checks whenever an opaque object is returned when inferring. The inference
-# can return multiple potential results while evaluating a Python object, but
-# some branches might not be evaluated, which results in partial inference. In
-# that case, it might be useful to still emit no-member and other checks for
-# the rest of the inferred objects.
-ignore-on-opaque-inference=yes
-
-# List of class names for which member attributes should not be checked (useful
-# for classes with dynamically set attributes). This supports the use of
-# qualified names.
-ignored-classes=optparse.Values,thread._local,_thread._local
-
-# List of module names for which member attributes should not be checked
-# (useful for modules/projects where namespaces are manipulated during runtime
-# and thus existing member attributes cannot be deduced by static analysis). It
-# supports qualified module names, as well as Unix pattern matching.
-ignored-modules=
-
-# Show a hint with possible names when a member name was not found. The aspect
-# of finding the hint is based on edit distance.
-missing-member-hint=yes
-
-# The minimum edit distance a name should have in order to be considered a
-# similar match for a missing member name.
-missing-member-hint-distance=1
-
-# The total number of similar names that should be taken in consideration when
-# showing a hint for a missing member.
-missing-member-max-choices=1
-
-# List of decorators that change the signature of a decorated function.
-signature-mutators=
-
-
-[SPELLING]
-
-# Limits count of emitted suggestions for spelling mistakes.
-max-spelling-suggestions=4
-
-# Spelling dictionary name. Available dictionaries: none. To make it work,
-# install the python-enchant package.
-spelling-dict=
-
-# List of comma separated words that should not be checked.
-spelling-ignore-words=
-
-# A path to a file that contains the private dictionary; one word per line.
-spelling-private-dict-file=
-
-# Tells whether to store unknown words to the private dictionary (see the
-# --spelling-private-dict-file option) instead of raising a message.
-spelling-store-unknown-words=no
-
-
-[FORMAT]
-
-# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
-expected-line-ending-format=
-
-# Regexp for a line that is allowed to be longer than the limit.
-ignore-long-lines=^\s*(# )?<?https?://\S+>?$
-
-# Number of spaces of indent required inside a hanging or continued line.
-indent-after-paren=4
-
-# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
-# tab).
-indent-string='    '
-
-# Maximum number of characters on a single line.
-max-line-length=160
-
-# Maximum number of lines in a module.
-max-module-lines=1000
-
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=trailing-comma,
-               dict-separator
-
-# Allow the body of a class to be on the same line as the declaration if body
-# contains single statement.
-single-line-class-stmt=no
-
-# Allow the body of an if to be on the same line as the test if there is no
-# else.
-single-line-if-stmt=no
-
-
-[STRING]
-
-# This flag controls whether inconsistent-quotes generates a warning when the
-# character used as a quote delimiter is used inconsistently within a module.
-check-quote-consistency=no
-
-# This flag controls whether the implicit-str-concat should generate a warning
-# on implicit string concatenation in sequences defined over several lines.
-check-str-concat-over-line-jumps=no
-
-
-[LOGGING]
-
-# The type of string formatting that logging methods do. `old` means using %
-# formatting, `new` is for `{}` formatting.
-logging-format-style=old
-
-# Logging modules to check that the string format arguments are in logging
-# function parameter format.
-logging-modules=logging
-
-
-[MISCELLANEOUS]
-
-# List of note tags to take in consideration, separated by a comma.
-notes=FIXME,
-      XXX,
-      TODO
-
-# Regular expression of note tags to take in consideration.
-#notes-rgx=
-
-
-[SIMILARITIES]
-
-# Ignore comments when computing similarities.
-ignore-comments=yes
-
-# Ignore docstrings when computing similarities.
-ignore-docstrings=yes
-
-# Ignore imports when computing similarities.
-ignore-imports=no
-
-# Minimum lines number of a similarity.
-min-similarity-lines=4
-
-
-[VARIABLES]
-
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid defining new builtins when possible.
-additional-builtins=
-
-# Tells whether unused global variables should be treated as a violation.
-allow-global-unused-variables=yes
-
-# List of strings which can identify a callback function by name. A callback
-# name must start or end with one of those strings.
-callbacks=cb_,
-          _cb
-
-# A regular expression matching the name of dummy variables (i.e. expected to
-# not be used).
-dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
-
-# Argument names that match this expression will be ignored. Default to name
-# with leading underscore.
-ignored-argument-names=_.*|^ignored_|^unused_
-
-# Tells whether we should check for unused import in __init__ files.
-init-import=no
-
-# List of qualified module names which can have objects that can redefine
-# builtins.
-redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
-
-
-[BASIC]
-
-# Naming style matching correct argument names.
-argument-naming-style=snake_case
-
-# Regular expression matching correct argument names. Overrides argument-
-# naming-style.
-#argument-rgx=
-
-# Naming style matching correct attribute names.
-attr-naming-style=snake_case
-
-# Regular expression matching correct attribute names. Overrides attr-naming-
-# style.
-#attr-rgx=
-
-# Bad variable names which should always be refused, separated by a comma.
-bad-names=foo,
-          bar,
-          baz,
-          toto,
-          tutu,
-          tata
-
-# Bad variable names regexes, separated by a comma. If names match any regex,
-# they will always be refused
-bad-names-rgxs=
-
-# Naming style matching correct class attribute names.
-class-attribute-naming-style=any
-
-# Regular expression matching correct class attribute names. Overrides class-
-# attribute-naming-style.
-#class-attribute-rgx=
-
-# Naming style matching correct class names.
-class-naming-style=PascalCase
-
-# Regular expression matching correct class names. Overrides class-naming-
-# style.
-#class-rgx=
-
-# Naming style matching correct constant names.
-const-naming-style=UPPER_CASE
-
-# Regular expression matching correct constant names. Overrides const-naming-
-# style.
-#const-rgx=
-
-# Minimum line length for functions/classes that require docstrings, shorter
-# ones are exempt.
-docstring-min-length=-1
-
-# Naming style matching correct function names.
-function-naming-style=snake_case
-
-# Regular expression matching correct function names. Overrides function-
-# naming-style.
-#function-rgx=
-
-# Good variable names which should always be accepted, separated by a comma.
-good-names=i,
-           j,
-           k,
-           ex,
-           Run,
-           _
-
-# Good variable names regexes, separated by a comma. If names match any regex,
-# they will always be accepted
-good-names-rgxs=
-
-# Include a hint for the correct naming format with invalid-name.
-include-naming-hint=no
-
-# Naming style matching correct inline iteration names.
-inlinevar-naming-style=any
-
-# Regular expression matching correct inline iteration names. Overrides
-# inlinevar-naming-style.
-#inlinevar-rgx=
-
-# Naming style matching correct method names.
-method-naming-style=snake_case
-
-# Regular expression matching correct method names. Overrides method-naming-
-# style.
-#method-rgx=
-
-# Naming style matching correct module names.
-module-naming-style=snake_case
-
-# Regular expression matching correct module names. Overrides module-naming-
-# style.
-#module-rgx=
-
-# Colon-delimited sets of names that determine each other's naming style when
-# the name regexes allow several styles.
-name-group=
-
-# Regular expression which should only match function or class names that do
-# not require a docstring.
-no-docstring-rgx=^_
-
-# List of decorators that produce properties, such as abc.abstractproperty. Add
-# to this list to register other decorators that produce valid properties.
-# These decorators are taken in consideration only for invalid-name.
-property-classes=abc.abstractproperty
-
-# Naming style matching correct variable names.
-variable-naming-style=snake_case
-
-# Regular expression matching correct variable names. Overrides variable-
-# naming-style.
-#variable-rgx=
-
-
-[DESIGN]
-
-# Maximum number of arguments for function / method.
-max-args=5
-
-# Maximum number of attributes for a class (see R0902).
-max-attributes=12
-
-# Maximum number of boolean expressions in an if statement (see R0916).
-max-bool-expr=5
-
-# Maximum number of branch for function / method body.
-max-branches=12
-
-# Maximum number of locals for function / method body.
-max-locals=15
-
-# Maximum number of parents for a class (see R0901).
-max-parents=7
-
-# Maximum number of public methods for a class (see R0904).
-max-public-methods=20
-
-# Maximum number of return / yield for function / method body.
-max-returns=6
-
-# Maximum number of statements in function / method body.
-max-statements=50
-
-# Minimum number of public methods for a class (see R0903).
-min-public-methods=2
-
-
-[CLASSES]
-
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,
-                      __new__,
-                      setUp,
-                      __post_init__
-
-# List of member names, which should be excluded from the protected access
-# warning.
-exclude-protected=_asdict,
-                  _fields,
-                  _replace,
-                  _source,
-                  _make
-
-# List of valid names for the first argument in a class method.
-valid-classmethod-first-arg=cls
-
-# List of valid names for the first argument in a metaclass class method.
-valid-metaclass-classmethod-first-arg=cls
-
-
-[IMPORTS]
-
-# List of modules that can be imported at any level, not just the top level
-# one.
-allow-any-import-level=
-
-# Allow wildcard imports from modules that define __all__.
-allow-wildcard-with-all=no
-
-# Analyse import fallback blocks. This can be used to support both Python 2 and
-# 3 compatible code, which means that the block might have code that exists
-# only in one or another interpreter, leading to false positives when analysed.
-analyse-fallback-blocks=no
-
-# Deprecated modules which should not be used, separated by a comma.
-deprecated-modules=optparse,tkinter.tix
-
-# Create a graph of external dependencies in the given file (report RP0402 must
-# not be disabled).
-ext-import-graph=
-
-# Create a graph of every (i.e. internal and external) dependencies in the
-# given file (report RP0402 must not be disabled).
-import-graph=
-
-# Create a graph of internal dependencies in the given file (report RP0402 must
-# not be disabled).
-int-import-graph=
-
-# Force import order to recognize a module as part of the standard
-# compatibility libraries.
-known-standard-library=
-
-# Force import order to recognize a module as part of a third party library.
-known-third-party=enchant
-
-# Couples of modules and preferred modules, separated by a comma.
-preferred-modules=
-
-
-[EXCEPTIONS]
-
-# Exceptions that will emit a warning when being caught. Defaults to
-# "BaseException, Exception".
-overgeneral-exceptions=BaseException,
-                       Exception

.readthedocs.yml

@@ -15,7 +15,7 @@ python:
   install:
     - requirements: docs/requirements.txt
 
-# We need to list all the submodules included in documenation build by DOxygen
-submodules:
+# We need to list all the submodules included in documentation build by Doxygen
+submodules: 
   include:
-    - components/mqtt/esp-mqtt
+    - components/mqtt/esp-mqtt

.travis.yml

@@ -0,0 +1,7 @@
+language: python
+sudo: false
+python:
+  - "3.4"
+script:
+  - pip install flake8
+  - travis_wait 20 python -m flake8 --config=.flake8 .

CMakeLists.txt

@@ -1,139 +1,161 @@
 cmake_minimum_required(VERSION 3.5)
 project(esp-idf C CXX ASM)
 
-if(CMAKE_CURRENT_LIST_DIR STREQUAL CMAKE_SOURCE_DIR)
-    message(FATAL_ERROR "Current directory '${CMAKE_CURRENT_LIST_DIR}' is not buildable. "
-    "Change directories to one of the example projects in '${CMAKE_CURRENT_LIST_DIR}/examples' and try "
-    "again.")
+if(NOT IDF_PATH)
+    set(IDF_PATH ${CMAKE_CURRENT_LIST_DIR})
 endif()
 
-unset(compile_options)
-unset(c_compile_options)
-unset(cxx_compile_options)
-unset(compile_definitions)
-unset(link_options)
+include(tools/cmake/idf_functions.cmake)
 
-# Add the following build specifications here, since these seem to be dependent
-# on config values on the root Kconfig.
+#
+# Set variables that control the build configuration and the build itself
+#
+idf_set_variables()
 
+kconfig_set_variables()
+
+#
+# Generate a component dependencies file, enumerating components to be included in the build
+# as well as their dependencies.
+#
+execute_process(COMMAND "${CMAKE_COMMAND}"
+    -D "COMPONENTS=${IDF_COMPONENTS}"
+    -D "COMPONENT_REQUIRES_COMMON=${IDF_COMPONENT_REQUIRES_COMMON}"
+    -D "EXCLUDE_COMPONENTS=${IDF_EXCLUDE_COMPONENTS}"
+    -D "TEST_COMPONENTS=${IDF_TEST_COMPONENTS}"
+    -D "TEST_EXCLUDE_COMPONENTS=${IDF_TEST_EXCLUDE_COMPONENTS}"
+    -D "BUILD_TESTS=${IDF_BUILD_TESTS}"
+    -D "DEPENDENCIES_FILE=${CMAKE_BINARY_DIR}/component_depends.cmake"
+    -D "COMPONENT_DIRS=${IDF_COMPONENT_DIRS}"
+    -D "BOOTLOADER_BUILD=${BOOTLOADER_BUILD}"
+    -D "IDF_TARGET=${IDF_TARGET}"
+    -D "IDF_PATH=${IDF_PATH}"
+    -D "DEBUG=${DEBUG}"
+    -P "${IDF_PATH}/tools/cmake/scripts/expand_requirements.cmake"
+    WORKING_DIRECTORY "${PROJECT_PATH}"
+    RESULT_VARIABLE expand_requirements_result)
+
+if(expand_requirements_result)
+    message(FATAL_ERROR "Failed to expand component requirements")
+endif()
+
+include("${CMAKE_BINARY_DIR}/component_depends.cmake")
+
+#
+# We now have the following component-related variables:
+#
+# IDF_COMPONENTS is the list of initial components set by the user
+# (or empty to include all components in the build).
+# BUILD_COMPONENTS is the list of components to include in the build.
+# BUILD_COMPONENT_PATHS is the paths to all of these components, obtained from the component dependencies file.
+#
+# Print the list of found components and test components
+#
+string(REPLACE ";" " " BUILD_COMPONENTS_SPACES "${BUILD_COMPONENTS}")
+message(STATUS "Component names: ${BUILD_COMPONENTS_SPACES}")
+unset(BUILD_COMPONENTS_SPACES)
+message(STATUS "Component paths: ${BUILD_COMPONENT_PATHS}")
+
+# Print list of test components
+if(TESTS_ALL EQUAL 1 OR TEST_COMPONENTS)
+    string(REPLACE ";" " " BUILD_TEST_COMPONENTS_SPACES "${BUILD_TEST_COMPONENTS}")
+    message(STATUS "Test component names: ${BUILD_TEST_COMPONENTS_SPACES}")
+    unset(BUILD_TEST_COMPONENTS_SPACES)
+    message(STATUS "Test component paths: ${BUILD_TEST_COMPONENT_PATHS}")
+endif()
+
+# Generate project configuration
+kconfig_process_config()
+
+# Include sdkconfig.cmake so rest of the build knows the configuration
+include(${SDKCONFIG_CMAKE})
+
+# Verify the environment is configured correctly
+idf_verify_environment()
+
+# Check git revision (may trigger reruns of cmake)
+##  sets IDF_VER to IDF git revision
+idf_get_git_revision()
+
+# Check that the targets set in cache, sdkconfig, and in environment all match
+idf_check_config_target()
+
+## get PROJECT_VER
 if(NOT BOOTLOADER_BUILD)
-
-    if(CONFIG_COMPILER_OPTIMIZATION_SIZE)
-        list(APPEND compile_options "-Os")
-        list(APPEND compile_options "-freorder-blocks")
-    elseif(CONFIG_COMPILER_OPTIMIZATION_DEFAULT)
-        list(APPEND compile_options "-Og")
-    elseif(CONFIG_COMPILER_OPTIMIZATION_NONE)
-        list(APPEND compile_options "-O0")
-    elseif(CONFIG_COMPILER_OPTIMIZATION_PERF)
-        list(APPEND compile_options "-O2")
-    endif()
-
-else()  # BOOTLOADER_BUILD
-
-    if(CONFIG_BOOTLOADER_COMPILER_OPTIMIZATION_SIZE)
-        list(APPEND compile_options "-Os")
-        list(APPEND compile_options "-freorder-blocks")
-    elseif(CONFIG_BOOTLOADER_COMPILER_OPTIMIZATION_DEBUG)
-        list(APPEND compile_options "-Og")
-    elseif(CONFIG_BOOTLOADER_COMPILER_OPTIMIZATION_NONE)
-        list(APPEND compile_options "-O0")
-    elseif(CONFIG_BOOTLOADER_COMPILER_OPTIMIZATION_PERF)
-        list(APPEND compile_options "-O2")
-    endif()
-
+    app_get_revision("${CMAKE_SOURCE_DIR}")
 endif()
 
-if(CONFIG_COMPILER_CXX_EXCEPTIONS)
-    list(APPEND cxx_compile_options "-fexceptions")
-else()
-    list(APPEND cxx_compile_options "-fno-exceptions")
-endif()
+# Add some idf-wide definitions
+idf_set_global_compile_options()
 
-if(CONFIG_COMPILER_CXX_RTTI)
-    list(APPEND cxx_compile_options "-frtti")
-else()
-    list(APPEND cxx_compile_options "-fno-rtti")
-    list(APPEND link_options "-fno-rtti")           # used to invoke correct multilib variant (no-rtti) during linking
-endif()
+# generate compile_commands.json (needs to come after project)
+set(CMAKE_EXPORT_COMPILE_COMMANDS 1)
 
-if(CONFIG_COMPILER_DISABLE_GCC8_WARNINGS)
-    list(APPEND compile_options "-Wno-parentheses"
-                                "-Wno-sizeof-pointer-memaccess"
-                                "-Wno-clobbered")
+#
+# Setup variables for linker script generation
+#
+ldgen_set_variables()
 
-    list(APPEND compile_options "-Wno-format-overflow"
-                                "-Wno-stringop-truncation"
-                                "-Wno-misleading-indentation"
-                                "-Wno-cast-function-type"
-                                "-Wno-implicit-fallthrough"
-                                "-Wno-unused-const-variable"
-                                "-Wno-switch-unreachable"
-                                "-Wno-format-truncation"
-                                "-Wno-memset-elt-size"
-                                "-Wno-int-in-bool-context")
-endif()
-
-if(CONFIG_COMPILER_WARN_WRITE_STRINGS)
-    list(APPEND compile_options "-Wwrite-strings")
-endif()
-
-if(CONFIG_COMPILER_OPTIMIZATION_ASSERTIONS_DISABLE)
-    list(APPEND compile_definitions "-DNDEBUG")
-endif()
-
-if(CONFIG_COMPILER_STACK_CHECK_MODE_NORM)
-    list(APPEND compile_options "-fstack-protector")
-elseif(CONFIG_COMPILER_STACK_CHECK_MODE_STRONG)
-    list(APPEND compile_options "-fstack-protector-strong")
-elseif(CONFIG_COMPILER_STACK_CHECK_MODE_ALL)
-    list(APPEND compile_options "-fstack-protector-all")
-endif()
-
-if(CONFIG_COMPILER_DUMP_RTL_FILES)
-    list(APPEND compile_options "-fdump-rtl-expand")
-endif()
-
-if(NOT ${CMAKE_C_COMPILER_VERSION} VERSION_LESS 8.0.0)
-    if(CONFIG_COMPILER_HIDE_PATHS_MACROS)
-        list(APPEND compile_options "-fmacro-prefix-map=${CMAKE_SOURCE_DIR}=.")
-        list(APPEND compile_options "-fmacro-prefix-map=${IDF_PATH}=IDF")
-    endif()
-endif()
-
-# GCC-specific options
-if(CMAKE_C_COMPILER_ID STREQUAL "GNU")
-    list(APPEND compile_options "-fstrict-volatile-bitfields"
-                                "-Wno-error=unused-but-set-variable"
-                                )
-endif()
-
-list(APPEND link_options "-fno-lto")
-
-idf_build_set_property(COMPILE_OPTIONS "${compile_options}" APPEND)
-idf_build_set_property(C_COMPILE_OPTIONS "${c_compile_options}" APPEND)
-idf_build_set_property(CXX_COMPILE_OPTIONS "${cxx_compile_options}" APPEND)
-idf_build_set_property(COMPILE_DEFINITIONS "${compile_definitions}" APPEND)
-idf_build_set_property(LINK_OPTIONS "${link_options}" APPEND)
-
-idf_build_get_property(build_component_targets __BUILD_COMPONENT_TARGETS)
-
-# Add each component as a subdirectory, processing each component's CMakeLists.txt
-foreach(component_target ${build_component_targets})
-    __component_get_property(dir ${component_target} COMPONENT_DIR)
-    __component_get_property(_name ${component_target} COMPONENT_NAME)
-    __component_get_property(prefix ${component_target} __PREFIX)
-    __component_get_property(alias ${component_target} COMPONENT_ALIAS)
-    set(COMPONENT_NAME ${_name})
-    set(COMPONENT_DIR ${dir})
-    set(COMPONENT_ALIAS ${alias})
-    set(COMPONENT_PATH ${dir}) # for backward compatibility only, COMPONENT_DIR is preferred
-    idf_build_get_property(build_prefix __PREFIX)
-    set(__idf_component_context 1)
-    if(NOT prefix STREQUAL build_prefix)
-        add_subdirectory(${dir} ${prefix}_${_name})
-    else()
-        add_subdirectory(${dir} ${_name})
-    endif()
-    set(__idf_component_context 0)
+# Include any top-level project_include.cmake files from components
+foreach(component ${BUILD_COMPONENT_PATHS})
+    set(COMPONENT_PATH "${component}")
+    include_if_exists("${component}/project_include.cmake")
+    unset(COMPONENT_PATH)
 endforeach()
+
+#
+# Add each component to the build as a library
+#
+foreach(COMPONENT_PATH ${BUILD_COMPONENT_PATHS})
+    get_filename_component(COMPONENT_NAME ${COMPONENT_PATH} NAME)
+
+    list(FIND BUILD_TEST_COMPONENT_PATHS ${COMPONENT_PATH} idx)
+
+    if(NOT idx EQUAL -1)
+        list(GET BUILD_TEST_COMPONENTS ${idx} test_component)
+        set(COMPONENT_NAME ${test_component})
+    endif()
+
+    component_get_target(COMPONENT_TARGET ${COMPONENT_NAME})
+
+    add_subdirectory(${COMPONENT_PATH} ${COMPONENT_NAME})
+endforeach()
+unset(COMPONENT_NAME)
+unset(COMPONENT_PATH)
+
+# each component should see the include directories of its requirements
+#
+# (we can't do this until all components are registered and targets exist in cmake, as we have
+# a circular requirements graph...)
+foreach(component ${BUILD_COMPONENTS})
+    component_get_target(component_target ${component})
+    if(TARGET ${component_target})
+        get_component_requirements(${component} deps priv_deps)
+
+        list(APPEND priv_deps ${IDF_COMPONENT_REQUIRES_COMMON})
+
+        foreach(dep ${deps})
+            component_get_target(dep_target ${dep})
+            add_component_dependencies(${component_target} ${dep_target} PUBLIC)
+        endforeach()
+
+        foreach(dep ${priv_deps})
+            component_get_target(dep_target ${dep})
+            add_component_dependencies(${component_target} ${dep_target} PRIVATE)
+        endforeach()
+    endif()
+endforeach()
+
+if(IDF_BUILD_ARTIFACTS)
+    # Write project description JSON file
+    make_json_list("${BUILD_COMPONENTS}" build_components_json)
+    make_json_list("${BUILD_COMPONENT_PATHS}" build_component_paths_json)
+    configure_file("${IDF_PATH}/tools/cmake/project_description.json.in"
+        "${IDF_BUILD_ARTIFACTS_DIR}/project_description.json")
+    unset(build_components_json)
+    unset(build_component_paths_json)
+endif()
+
+set(BUILD_COMPONENTS ${BUILD_COMPONENTS} PARENT_SCOPE)
+
+ldgen_add_dependencies()

CONTRIBUTING.rst

@@ -6,7 +6,7 @@ We welcome contributions to the esp-idf project!
 How to Contribute
 -----------------
 
-Contributions to esp-idf - fixing bugs, adding features, adding documentation - are welcome. We accept contributions via `Github Pull Requests <https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests>`_.
+Contributions to esp-idf - fixing bugs, adding features, adding documentation - are welcome. We accept contributions via `Github Pull Requests <https://help.github.com/articles/about-pull-requests/>`_.
 
 Before Contributing
 -------------------
@@ -17,8 +17,6 @@ Before sending us a Pull Request, please consider this list of points:
 
 * Does any new code conform to the esp-idf :doc:`Style Guide <style-guide>`?
 
-* Have you installed the :doc:`pre-commit hook <install-pre-commit-hook>` for esp-idf project?
-
 * Does the code documentation follow requirements in :doc:`documenting-code`?
 
 * Is the code adequately commented for people to understand how it is structured?
@@ -29,7 +27,7 @@ Before sending us a Pull Request, please consider this list of points:
 
 * Example contributions are also welcome. Please check the :doc:`creating-examples` guide for these.
 
-* If the contribution contains multiple commits, are they grouped together into logical changes (one major change per pull request)? Are any commits with names like "fixed typo" `squashed into previous commits <https://eli.thegreenplace.net/2014/02/19/squashing-github-pull-requests-into-a-single-commit/>`_?
+* If the contribution contains multiple commits, are they grouped together into logical changes (one major change per pull request)? Are any commits with names like "fixed typo" `squashed into previous commits <http://eli.thegreenplace.net/2014/02/19/squashing-github-pull-requests-into-a-single-commit/>`_?
 
 * If you're unsure about any of these points, please open the Pull Request anyhow and then ask us for feedback.
 
@@ -54,7 +52,6 @@ Related Documents
     :maxdepth: 1
 
     style-guide
-    install-pre-commit-hook
     documenting-code
     add-ons-reference
     creating-examples

Kconfig

@@ -8,18 +8,11 @@ mainmenu "Espressif IoT Development Framework Configuration"
         bool
         option env="IDF_CMAKE"
 
-    config IDF_ENV_FPGA
-        # This option is for internal use only
-        bool
-        option env="IDF_ENV_FPGA"
 
-    config IDF_TARGET_ARCH_RISCV
-        bool
-        default "n"
-
-    config IDF_TARGET_ARCH_XTENSA
-        bool
-        default "n"
+    config IDF_TARGET_ENV
+        # A proxy to get environment variable $IDF_TARGET
+        string
+        option env="IDF_TARGET"
 
     config IDF_TARGET
         # This option records the IDF target when sdkconfig is generated the first time.
@@ -27,75 +20,31 @@ mainmenu "Espressif IoT Development Framework Configuration"
         # the build system is responsible for detecting the mismatch between
         # CONFIG_IDF_TARGET and $IDF_TARGET.
         string
-        default "$IDF_TARGET"
+        default "IDF_TARGET_NOT_SET" if IDF_TARGET_ENV=""
+        default IDF_TARGET_ENV
 
-    config IDF_TARGET_ESP32
-        bool
-        default "y" if IDF_TARGET="esp32"
-        select IDF_TARGET_ARCH_XTENSA
-
-    config IDF_TARGET_ESP32S2
-        bool
-        default "y" if IDF_TARGET="esp32s2"
-        select FREERTOS_UNICORE
-        select IDF_TARGET_ARCH_XTENSA
-
-    config IDF_TARGET_ESP32S3
-        bool
-        default "y" if IDF_TARGET="esp32s3"
-        select IDF_TARGET_ARCH_XTENSA
-
-    choice IDF_TARGET_ESP32S3_BETA_VERSION
-        prompt "ESP32-S3 beta version"
-        depends on IDF_TARGET_ESP32S3
-        default IDF_TARGET_ESP32S3_BETA_VERSION_2
-        help
-            Currently ESP32-S3 has several beta versions for internal use only.
-            Select the one that matches your chip model.
-
-        config IDF_TARGET_ESP32S3_BETA_VERSION_2
-            bool
-            prompt "ESP32-S3 beta2"
-    endchoice
-
-    config IDF_TARGET_ESP32C3
-        bool
-        default "y" if IDF_TARGET="esp32c3"
-        select FREERTOS_UNICORE
-        select IDF_TARGET_ARCH_RISCV
-
-    config IDF_FIRMWARE_CHIP_ID
-        hex
-        default 0x0000 if IDF_TARGET_ESP32
-        default 0x0002 if IDF_TARGET_ESP32S2
-        default 0x0004 if IDF_TARGET_ESP32S3
-        default 0x0005 if IDF_TARGET_ESP32C3
-        default 0xFFFF
 
     menu "SDK tool configuration"
-        config SDK_TOOLPREFIX
+        config TOOLPREFIX
             string "Compiler toolchain path/prefix"
-            default "xtensa-esp32-elf-" if IDF_TARGET_ESP32
-            default "xtensa-esp32s2-elf-" if IDF_TARGET_ESP32S2
-            default "xtensa-esp32s3-elf-" if IDF_TARGET_ESP32S3
-            default "riscv32-esp-elf-" if IDF_TARGET_ESP32C3
-
+            default "xtensa-esp32-elf-"
             help
                 The prefix/path that is used to call the toolchain. The default setting assumes
                 a crosstool-ng gcc setup that is in your PATH.
 
-        config SDK_PYTHON
-            string "Python interpreter"
+        config PYTHON
+            string "Python 2 interpreter"
             depends on !IDF_CMAKE
             default "python"
             help
-                The executable name/path that is used to run python.
+                The executable name/path that is used to run python. On some systems Python 2.x
+                may need to be invoked as python2.
 
-                (Note: This option is used with the legacy GNU Make build system only.)
+                (Note: This option is used with the GNU Make build system only, not idf.py
+                or CMake-based builds.)
 
-        config SDK_MAKE_WARN_UNDEFINED_VARIABLES
+        config MAKE_WARN_UNDEFINED_VARIABLES
             bool "'make' warns on undefined variables"
-            depends on !IDF_CMAKE
             default "y"
             help
                 Adds --warn-undefined-variables to MAKEFLAGS. This causes make to
@@ -105,148 +54,37 @@ mainmenu "Espressif IoT Development Framework Configuration"
                 or otherwise missing, but it can be unwanted if you have Makefiles which
                 depend on undefined variables expanding to an empty string.
 
-                (Note: this option is used with the legacy GNU Make build system only.)
-
-        config SDK_TOOLCHAIN_SUPPORTS_TIME_WIDE_64_BITS
-            bool "Toolchain supports time_t wide 64-bits"
-            default n
-            help
-                Enable this option in case you have a custom toolchain which supports time_t wide 64-bits.
-                This option checks time_t is 64-bits and disables ROM time functions
-                to use the time functions from the toolchain instead.
-                This option allows resolving the Y2K38 problem.
-                See "Setup Linux Toolchain from Scratch" to build
-                a custom toolchain which supports 64-bits time_t.
-
-                Note: ESP-IDF does not currently come with any pre-compiled toolchain
-                that supports 64-bit wide time_t.
-                This will change in a future major release,
-                but currently 64-bit time_t requires a custom built toolchain.
-
     endmenu  # SDK tool configuration
 
-    menu "Build type"
-
-        choice APP_BUILD_TYPE
-            prompt "Application build type"
-            default APP_BUILD_TYPE_APP_2NDBOOT
-            help
-                Select the way the application is built.
-
-                By default, the application is built as a binary file in a format compatible with
-                the ESP-IDF bootloader. In addition to this application, 2nd stage bootloader is
-                also built. Application and bootloader binaries can be written into flash and
-                loaded/executed from there.
-
-                Another option, useful for only very small and limited applications, is to only link
-                the .elf file of the application, such that it can be loaded directly into RAM over
-                JTAG. Note that since IRAM and DRAM sizes are very limited, it is not possible to
-                build any complex application this way. However for kinds of testing and debugging,
-                this option may provide faster iterations, since the application does not need to be
-                written into flash.
-                Note that at the moment, ESP-IDF does not contain all the startup code required to
-                initialize the CPUs and ROM memory (data/bss). Therefore it is necessary to execute
-                a bit of ROM code prior to executing the application. A gdbinit file may look as follows (for ESP32):
-
-                    # Connect to a running instance of OpenOCD
-                    target remote :3333
-                    # Reset and halt the target
-                    mon reset halt
-                    # Run to a specific point in ROM code,
-                    #  where most of initialization is complete.
-                    thb *0x40007d54
-                    c
-                    # Load the application into RAM
-                    load
-                    # Run till app_main
-                    tb app_main
-                    c
-
-                Execute this gdbinit file as follows:
-
-                    xtensa-esp32-elf-gdb build/app-name.elf -x gdbinit
-
-                Example gdbinit files for other targets can be found in tools/test_apps/system/gdb_loadable_elf/
-
-                Recommended sdkconfig.defaults for building loadable ELF files is as follows.
-                CONFIG_APP_BUILD_TYPE_ELF_RAM is required, other options help reduce application
-                memory footprint.
-
-                    CONFIG_APP_BUILD_TYPE_ELF_RAM=y
-                    CONFIG_VFS_SUPPORT_TERMIOS=
-                    CONFIG_NEWLIB_NANO_FORMAT=y
-                    CONFIG_ESP_SYSTEM_PANIC_PRINT_HALT=y
-                    CONFIG_ESP_DEBUG_STUBS_ENABLE=
-                    CONFIG_ESP_ERR_TO_NAME_LOOKUP=
-
-
-            config APP_BUILD_TYPE_APP_2NDBOOT
-                bool
-                prompt "Default (binary application + 2nd stage bootloader)"
-                select APP_BUILD_GENERATE_BINARIES
-                select APP_BUILD_BOOTLOADER
-                select APP_BUILD_USE_FLASH_SECTIONS
-
-            config APP_BUILD_TYPE_ELF_RAM
-                bool
-                prompt "ELF file, loadable into RAM (EXPERIMENTAL))"
-        endchoice # APP_BUILD_TYPE
-
-        # Hidden options, set according to the choice above
-        config APP_BUILD_GENERATE_BINARIES
-            bool # Whether to generate .bin files or not
-
-        config APP_BUILD_BOOTLOADER
-            bool # Whether to build the bootloader
-
-        config APP_BUILD_USE_FLASH_SECTIONS
-            bool # Whether to place code/data into memory-mapped flash sections
-
-    endmenu # Build type
-
-    source "$COMPONENT_KCONFIGS_PROJBUILD_SOURCE_FILE"
+    source "$COMPONENT_KCONFIGS_PROJBUILD"
 
     menu "Compiler options"
 
-        choice COMPILER_OPTIMIZATION
+        choice OPTIMIZATION_COMPILER
             prompt "Optimization Level"
-            default COMPILER_OPTIMIZATION_DEFAULT
+            default OPTIMIZATION_LEVEL_DEBUG
             help
-                This option sets compiler optimization level (gcc -O argument) for the app.
+                This option sets compiler optimization level (gcc -O argument).
 
-                - The "Default" setting will add the -0g flag to CFLAGS.
-                - The "Size" setting will add the -0s flag to CFLAGS.
-                - The "Performance" setting will add the -O2 flag to CFLAGS.
-                - The "None" setting will add the -O0 flag to CFLAGS.
+                - for "Release" setting, -Os flag is added to CFLAGS.
+                - for "Debug" setting, -Og flag is added to CFLAGS.
 
-                The "Size" setting cause the compiled code to be smaller and faster, but
-                may lead to difficulties of correlating code addresses to source file
-                lines when debugging.
+                "Release" with -Os produces smaller & faster compiled code but it
+                may be harder to correlated code addresses to source files when debugging.
 
-                The "Performance" setting causes the compiled code to be larger and faster,
-                but will be easier to correlated code addresses to source file lines.
+                To add custom optimization settings, set CFLAGS and/or CPPFLAGS
+                in project makefile, before including $(IDF_PATH)/make/project.mk. Note that
+                custom optimization levels may be unsupported.
 
-                "None" with -O0 produces compiled code without optimization.
-
-                Note that custom optimization levels may be unsupported.
-
-                Compiler optimization for the IDF bootloader is set separately,
-                see the BOOTLOADER_COMPILER_OPTIMIZATION setting.
-
-            config COMPILER_OPTIMIZATION_DEFAULT
+            config OPTIMIZATION_LEVEL_DEBUG
                 bool "Debug (-Og)"
-            config COMPILER_OPTIMIZATION_SIZE
-                bool "Optimize for size (-Os)"
-            config COMPILER_OPTIMIZATION_PERF
-                bool "Optimize for performance (-O2)"
-            config COMPILER_OPTIMIZATION_NONE
-                bool "Debug without optimization (-O0)"
-
+            config OPTIMIZATION_LEVEL_RELEASE
+                bool "Release (-Os)"
         endchoice
 
-        choice COMPILER_OPTIMIZATION_ASSERTION_LEVEL
+        choice OPTIMIZATION_ASSERTION_LEVEL
             prompt "Assertion level"
-            default COMPILER_OPTIMIZATION_ASSERTIONS_ENABLE
+            default OPTIMIZATION_ASSERTIONS_ENABLED
             help
                 Assertions can be:
 
@@ -258,20 +96,20 @@ mainmenu "Espressif IoT Development Framework Configuration"
                 - Disabled entirely (not recommended for most configurations.) -DNDEBUG is added
                   to CPPFLAGS in this case.
 
-            config COMPILER_OPTIMIZATION_ASSERTIONS_ENABLE
+            config OPTIMIZATION_ASSERTIONS_ENABLED
                 prompt "Enabled"
                 bool
                 help
                     Enable assertions. Assertion content and line number will be printed on failure.
 
-            config COMPILER_OPTIMIZATION_ASSERTIONS_SILENT
+            config OPTIMIZATION_ASSERTIONS_SILENT
                 prompt "Silent (saves code size)"
                 bool
                 help
                     Enable silent assertions. Failed assertions will abort(), user needs to
                     use the aborting address to find the line number with the failed assertion.
 
-            config COMPILER_OPTIMIZATION_ASSERTIONS_DISABLE
+            config OPTIMIZATION_ASSERTIONS_DISABLED
                 prompt "Disabled (sets -DNDEBUG)"
                 bool
                 help
@@ -279,7 +117,7 @@ mainmenu "Espressif IoT Development Framework Configuration"
 
         endchoice # assertions
 
-        menuconfig COMPILER_CXX_EXCEPTIONS
+        menuconfig CXX_EXCEPTIONS
             bool "Enable C++ exceptions"
             default n
             help
@@ -291,25 +129,17 @@ mainmenu "Espressif IoT Development Framework Configuration"
                 Enabling this option currently adds an additional ~500 bytes of heap overhead
                 when an exception is thrown in user code for the first time.
 
-        config COMPILER_CXX_EXCEPTIONS_EMG_POOL_SIZE
+        config CXX_EXCEPTIONS_EMG_POOL_SIZE
             int "Emergency Pool Size"
             default 0
-            depends on COMPILER_CXX_EXCEPTIONS
+            depends on CXX_EXCEPTIONS
             help
                 Size (in bytes) of the emergency memory pool for C++ exceptions. This pool will be used to allocate
                 memory for thrown exceptions when there is not enough memory on the heap.
 
-        config COMPILER_CXX_RTTI
-            bool "Enable C++ run-time type info (RTTI)"
-            default n
-            help
-                Enabling this option compiles all C++ files with RTTI support enabled.
-                This increases binary size (typically by tens of kB) but allows using
-                dynamic_cast conversion and typeid operator.
-
-        choice COMPILER_STACK_CHECK_MODE
+        choice STACK_CHECK_MODE
             prompt "Stack smashing protection mode"
-            default COMPILER_STACK_CHECK_MODE_NONE
+            default STACK_CHECK_NONE
             help
                 Stack smashing protection mode. Emit extra code to check for buffer overflows, such as stack
                 smashing attacks. This is done by adding a guard variable to functions with vulnerable objects.
@@ -332,23 +162,23 @@ mainmenu "Espressif IoT Development Framework Configuration"
                 - coverage: NORMAL < STRONG < OVERALL
 
 
-            config COMPILER_STACK_CHECK_MODE_NONE
+            config STACK_CHECK_NONE
                 bool "None"
-            config COMPILER_STACK_CHECK_MODE_NORM
+            config STACK_CHECK_NORM
                 bool "Normal"
-            config COMPILER_STACK_CHECK_MODE_STRONG
+            config STACK_CHECK_STRONG
                 bool "Strong"
-            config COMPILER_STACK_CHECK_MODE_ALL
+            config STACK_CHECK_ALL
                 bool "Overall"
         endchoice
 
-        config COMPILER_STACK_CHECK
+        config STACK_CHECK
             bool
-            default !COMPILER_STACK_CHECK_MODE_NONE
+            default !STACK_CHECK_NONE
             help
                 Stack smashing protection.
 
-        config COMPILER_WARN_WRITE_STRINGS
+        config WARN_WRITE_STRINGS
             bool "Enable -Wwrite-strings warning flag"
             default "n"
             help
@@ -362,41 +192,16 @@ mainmenu "Espressif IoT Development Framework Configuration"
                 For C++, this warns about the deprecated conversion from string
                 literals to ``char *``.
 
-        config COMPILER_DISABLE_GCC8_WARNINGS
+        config DISABLE_GCC8_WARNINGS
             bool "Disable new warnings introduced in GCC 6 - 8"
             default "n"
             help
                 Enable this option if using GCC 6 or newer, and wanting to disable warnings which don't appear with
                 GCC 5.
 
-        config COMPILER_DUMP_RTL_FILES
-            bool "Dump RTL files during compilation"
-            help
-                If enabled, RTL files will be produced during compilation. These files
-                can be used by other tools, for example to calculate call graphs.
-
 
     endmenu # Compiler Options
 
     menu "Component config"
-        source "$COMPONENT_KCONFIGS_SOURCE_FILE"
+        source "$COMPONENT_KCONFIGS"
     endmenu
-
-    menu "Compatibility options"
-        config LEGACY_INCLUDE_COMMON_HEADERS
-            bool "Include headers across components as before IDF v4.0"
-            default n
-            help
-                Soc, esp32, and driver components, the most common
-                components. Some header of these components are included
-                implicitly by headers of other components before IDF v4.0.
-                It's not required for high-level components, but still
-                included through long header chain everywhere.
-
-                This is harmful to the modularity. So it's changed in IDF
-                v4.0.
-
-                You can still include these headers in a legacy way until it
-                is totally deprecated by enable this option.
-
-    endmenu #Compatibility options

README.md

@@ -1,24 +1,17 @@
 # Espressif IoT Development Framework
 
-* [中文版](./README_CN.md)
+[![Documentation Status](https://readthedocs.com/projects/espressif-esp-idf/badge/?version=latest)](https://docs.espressif.com/projects/esp-idf/en/latest/?badge=latest)
 
-ESP-IDF is the development framework for Espressif SoCs (released after 2016<sup>[1](#fn1)</sup>) provided for Windows, Linux and macOS.
+ESP-IDF is the official development framework for the [ESP32](https://espressif.com/en/products/hardware/esp32/overview) chip.
 
 # Developing With ESP-IDF
 
 ## Setting Up ESP-IDF
 
-See https://idf.espressif.com/ for links to detailed instructions on how to set up the ESP-IDF depending on chip you use.
+See setup guides for detailed instructions to set up the ESP-IDF:
 
-**Note:** Each SoC series and each ESP-IDF release has its own documentation. Please see Section [Versions](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/versions.html) on how to find documentation and how to checkout specific release of ESP-IDF.
-
-### Non-GitHub forks
-
-ESP-IDF uses relative locations as its submodules URLs ([.gitmodules](.gitmodules)). So they link to GitHub.
-If ESP-IDF is forked to a Git repository which is not on GitHub, you will need to run the script
-[tools/set-submodules-to-github.sh](tools/set-submodules-to-github.sh) after git clone.
-The script sets absolute URLs for all submodules, allowing `git submodule update --init --recursive` to complete.
-If cloning ESP-IDF from GitHub, this step is not needed.
+* [Getting Started Guide for the stable ESP-IDF version](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/)
+* [Getting Started Guide for the latest (master branch) ESP-IDF version](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/)
 
 ## Finding a Project
 
@@ -32,63 +25,92 @@ To start your own project based on an example, copy the example project director
 
 See the Getting Started guide links above for a detailed setup guide. This is a quick reference for common commands when working with ESP-IDF projects:
 
-## Setup Build Environment
-
-(See the Getting Started guide listed above for a full list of required steps with more details.)
-
-* Install host build dependencies mentioned in the Getting Started guide.
-* Run the install script to set up the build environment. The options include `install.bat` or `install.ps1` for Windows, and `install.sh` or `install.fish` for Unix shells.
-* Run the export script on Windows (`export.bat`) or source it on Unix (`source export.sh`) in every shell environment before using ESP-IDF.
-
 ## Configuring the Project
 
-* `idf.py set-target <chip_name>` sets the target of the project to `<chip_name>`. Run `idf.py set-target` without any arguments to see a list of supported targets.
-* `idf.py menuconfig` opens a text-based configuration menu where you can configure the project.
+`make menuconfig`
+
+* Opens a text-based configuration menu for the project.
+* Use up & down arrow keys to navigate the menu.
+* Use Enter key to go into a submenu, Escape key to go out or to exit.
+* Type `?` to see a help screen. Enter key exits the help screen.
+* Use Space key, or `Y` and `N` keys to enable (Yes) and disable (No) configuration items with checkboxes "`[*]`"
+* Pressing `?` while highlighting a configuration item displays help about that item.
+* Type `/` to search the configuration items.
+
+Once done configuring, press Escape multiple times to exit and say "Yes" to save the new configuration when prompted.
 
 ## Compiling the Project
 
-`idf.py build`
+`make -j4 all`
 
 ... will compile app, bootloader and generate a partition table based on the config.
 
+NOTE: The `-j4` option causes `make` to run 4 parallel jobs. This is much faster than the default single job. The recommended number to pass to this option is `-j(number of CPUs + 1)`.
+
 ## Flashing the Project
 
 When the build finishes, it will print a command line to use esptool.py to flash the chip. However you can also do this automatically by running:
 
-`idf.py -p PORT flash`
+`make -j4 flash`
 
-Replace PORT with the name of your serial port (like `COM3` on Windows, `/dev/ttyUSB0` on Linux, or `/dev/cu.usbserial-X` on MacOS. If the `-p` option is left out, `idf.py flash` will try to flash the first available serial port.
+This will flash the entire project (app, bootloader and partition table) to a new chip. The settings for serial port flashing can be configured with `make menuconfig`.
 
-This will flash the entire project (app, bootloader and partition table) to a new chip. The settings for serial port flashing can be configured with `idf.py menuconfig`.
-
-You don't need to run `idf.py build` before running `idf.py flash`, `idf.py flash` will automatically rebuild anything which needs it.
+You don't need to run `make all` before running `make flash`, `make flash` will automatically rebuild anything which needs it.
 
 ## Viewing Serial Output
 
-The `idf.py monitor` target uses the [idf_monitor tool](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/idf-monitor.html) to display serial output from Espressif SoCs. idf_monitor also has a range of features to decode crash output and interact with the device. [Check the documentation page for details](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/idf-monitor.html).
+The `make monitor` target uses the [idf_monitor tool](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/idf-monitor.html) to display serial output from the ESP32. idf_monitor also has a range of features to decode crash output and interact with the device. [Check the documentation page for details](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/idf-monitor.html).
 
 Exit the monitor by typing Ctrl-].
 
 To build, flash and monitor output in one pass, you can run:
 
-`idf.py flash monitor`
+`make -j4 flash monitor`
 
 ## Compiling & Flashing Only the App
 
 After the initial flash, you may just want to build and flash just your app, not the bootloader and partition table:
 
-* `idf.py app` - build just the app.
-* `idf.py app-flash` - flash just the app.
+* `make app` - build just the app.
+* `make app-flash` - flash just the app.
 
-`idf.py app-flash` will automatically rebuild the app if any source files have changed.
+`make app-flash` will automatically rebuild the app if any source files have changed.
 
 (In normal development there's no downside to reflashing the bootloader and partition table each time, if they haven't changed.)
 
+## Parallel Builds
+
+ESP-IDF supports compiling multiple files in parallel, so all of the above commands can be run as `make -jN` where `N` is the number of parallel make processes to run (generally N should be equal to the number of CPU cores in your system, plus one.)
+
+Multiple make functions can be combined into one. For example: to build the app & bootloader using 5 jobs in parallel, then flash everything, and then display serial output from the ESP32 run:
+
+```
+make -j5 flash monitor
+```
+
+
+## The Partition Table
+
+Once you've compiled your project, the "build" directory will contain a binary file with a name like "my_app.bin". This is an ESP32 image binary that can be loaded by the bootloader.
+
+A single ESP32's flash can contain multiple apps, as well as many different kinds of data (calibration data, filesystems, parameter storage, etc). For this reason a partition table is flashed to offset 0x8000 in the flash.
+
+Each entry in the partition table has a name (label), type (app, data, or something else), subtype and the offset in flash where the partition is loaded.
+
+The simplest way to use the partition table is to `make menuconfig` and choose one of the simple predefined partition tables:
+
+* "Single factory app, no OTA"
+* "Factory app, two OTA definitions"
+
+In both cases the factory app is flashed at offset 0x10000. If you `make partition_table` then it will print a summary of the partition table.
+
+For more details about partition tables and how to create custom variations, view the [`docs/en/api-guides/partition-tables.rst`](docs/en/api-guides/partition-tables.rst) file.
+
 ## Erasing Flash
 
-The `idf.py flash` target does not erase the entire flash contents. However it is sometimes useful to set the device back to a totally erased state, particularly when making partition table changes or OTA app updates. To erase the entire flash, run `idf.py erase_flash`.
+The `make flash` target does not erase the entire flash contents. However it is sometimes useful to set the device back to a totally erased state, particularly when making partition table changes or OTA app updates. To erase the entire flash, run `make erase_flash`.
 
-This can be combined with other targets, ie `idf.py -p PORT erase_flash flash` will erase everything and then re-flash the new app, bootloader and partition table.
+This can be combined with other targets, ie `make erase_flash flash` will erase everything and then re-flash the new app, bootloader and partition table.
 
 # Resources
 
@@ -101,6 +123,3 @@ This can be combined with other targets, ie `idf.py -p PORT erase_flash flash` w
 * If you're interested in contributing to ESP-IDF, please check the [Contributions Guide](https://docs.espressif.com/projects/esp-idf/en/latest/contribute/index.html).
 
 
-________
-
-<a name="fn1">1</a>: ESP8266 and ESP8285 are not supported in ESP-IDF. See [RTOS SDK](https://github.com/espressif/ESP8266_RTOS_SDK) instead.

README_CN.md

@@ -1,106 +0,0 @@
-# Espressif 物联网开发框架
-
-* [English Version](./README.md)
-
-ESP-IDF 是由乐鑫官方针对乐鑫各系列芯片产品（发布于 2016 年后<sup>[1](#fn1)</sup>）推出的开发框架，支持 Windows、Linux 和 macOS 操作系统。
-
-# 使用 ESP-IDF 进行开发
-
-## 搭建 ESP-IDF 开发环境
-
-关于不同芯片如何搭建 ESP-IDF 的开发环境，请参考 https://idf.espressif.com/。
-
-**注意：** 不同系列芯片和不同 ESP-IDF 版本都有其对应的文档。请参阅[版本](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/versions.html)部分，获得关于如何查找文档以及如何检出 ESP-IDF 的特定发行版的详细信息。
-
-### 非 GitHub 分叉的 ESP-IDF 项目
-
-ESP-IDF 中的子模块采用相对路径（[详见 .gitmodules 文件](.gitmodules)），所以它们会指向 GitHub。
-如果 ESP-IDF 被分叉到的仓库不在 GitHub 上，那么你需要在克隆结束后运行该脚本 [tools/set-submodules-to-github.sh](tools/set-submodules-to-github.sh)。
-
-这个脚本会为所有的子模块设置绝对路径，接着可以通过 `git submodule update --init --recursive` 完成子模块的更新。
-如果 ESP-IDF 是从 GitHub 上克隆得到，则不需要此步骤。
-
-## 寻找项目
-
-除了入门指南中提到的 [esp-idf 模板项目](https://github.com/espressif/esp-idf-template)，ESP-IDF 的 [examples](examples) 目录下还带有很多其它示例项目。
-
-一旦找到了需要的项目，便可以进入该目录，执行配置和构建操作。
-
-如果要基于示例工程开始你自己的项目，请将示例工程复制到 ESP-IDF 目录之外。
-
-# 快速参考
-
-详细的使用方法请参考上面入门指南的链接，这里仅仅列举一些 ESP-IDF 项目开发中常用的命令：
-
-## 设置构建环境
-
-请参考入门指南中列出的详细步骤。
-
-* 在主机中安装入门指南中提到的构建所依赖的工具。
-* 运行安装脚本来设置构建环境。可为 Windows shell 选择 `install.bat` 或 `install.ps1`，为 Unix shell 选择 `install.sh` 和 `install.fish`。
-* 在使用 ESP-IDF 之前，需要在 shell 中运行导出脚本。Windows 下可运行 `export.bat`，Unix 下可运行 `source export.sh`。
-  
-## 配置项目
-
-* `idf.py set-target <chip_name>` 可将项目的目标芯片设置为 `<chip_name>`。运行 `idf.py set-target`，不用带任何参数，可查看所有支持的目标芯片列表。
-* `idf.py menuconfig` 可打开一个基于文本的配置菜单，可以用来对项目进行配置。
-
-## 编译项目
-
-`idf.py build`
-
-编译应用程序，引导程序，并根据配置生成分区表。
-
-## 烧写项目
-
-当构建结束，终端会打印出一条命令行，告知如何使用 esptool.py 工具烧写项目到芯片中。但你也可以运行下面这条命令来自动烧写：
-
-`idf.py -p PORT flash`
-
-将其中的 PORT 替换为系统中实际串口的名字（比如 Windows 下的 `COM3`，Linux 下的 `/dev/ttyUSB0`，或者 macOS 下的 `/dev/cu.usbserial-X`。如果省略 `-p` 选项，`idf.py flash` 会尝试使用第一个可用的串口进行烧写。
-
-这会烧写整个项目（包括应用程序，引导程序和分区表）到芯片中，此外还可以使用 `idf.py menuconfig` 来调整串口烧写相关的配置。
-
-不必先运行 `idf.py build` 再运行 `idf.py flash`，`idf.py flash` 会根据需要自动重新构建项目。
-
-## 观察串口输入
-
-`idf.py monitor` 会调用 [idf_monitor 工具](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/idf-monitor.html)来显示乐鑫芯片的串口输出。`idf_monitor` 还包含一系列的功能来解析程序崩溃后的输出结果并与设备进行交互。更多详细内容，请参阅[文档](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/idf-monitor.html).
-
-输入 `Ctrl-]` 可退出监视器。
-
-想要一次性执行构建、烧写和监视，可以运行如下命令：
-
-`idf.py flash monitor`
-
-## 仅编译并烧写应用程序
-
-在第一次烧写过后，你可能只想构建并烧写你的应用程序，不包括引导程序和分区表：
-
-* `idf.py app` - 仅构建应用程序。
-* `idf.py app-flash` - 仅烧写应用程序。
-
-`idf.py app-flash` 会自动判断是否有源文件发生了改变然后重新构建应用程序。
-
-（在正常的开发中，即使引导程序和分区表没有发生变化，每次都重新烧写它们并不会带来什么危害。）
-
-## 擦除 Flash
-
-`idf.py flash` 并不会擦除 flash 上所有的内容，但是有时候我们需要设备恢复到完全擦除的状态，尤其是分区表发生了变化或者 OTA 应用升级时。要擦除整块 flash 请运行 `idf.py erase_flash`。
-
-这条命令还可以和其余命令整合在一起，`idf.py -p PORT erase_flash flash` 会擦除一切然后重新烧写新的应用程序、引导程序和分区表。
-
-# 其它参考资源
-
-* 最新版的文档：https://docs.espressif.com/projects/esp-idf/，该文档是由本仓库 [docs 目录](docs) 构建得到。
-
-* 可以前往 [esp32.com 论坛](https://esp32.com/) 提问，挖掘社区资源。
-
-* 如果你在使用中发现了错误或者需要新的功能，请先[查看 GitHub Issues](https://github.com/espressif/esp-idf/issues)，确保该问题没有重复提交。
-
-* 如果你有兴趣为 ESP-IDF 作贡献，请先阅读[贡献指南](https://docs.espressif.com/projects/esp-idf/en/latest/contribute/index.html)。
-
-
-__________
-
-<a name="fn1">1</a>: ESP-IDF 不支持 ESP8266 和 ESP8285。如有需要，请参考 [RTOS SDK](https://github.com/espressif/ESP8266_RTOS_SDK)。

SUPPORT_POLICY.md

@@ -1,83 +0,0 @@
-The latest support policy for ESP-IDF can be found at [https://github.com/espressif/esp-idf/blob/master/SUPPORT_POLICY.md](https://github.com/espressif/esp-idf/blob/master/SUPPORT_POLICY.md)
-
-Support Period Policy
-=====================
-
-* [中文版](./SUPPORT_POLICY_CN.md)
-
-Each ESP-IDF major and minor release (V4.1, V4.2, etc) is supported for
-30 months after the initial stable release date.
-
-Supported means that the ESP-IDF team will continue to apply bug fixes,
-security fixes, etc to the release branch on GitHub, and periodically
-make new bugfix releases as needed.
-
-Support period is divided into "Service" and "Maintenance" period:
-
-| Period      | Duration     | Recommended for new projects?         |
-| -------     | ------------ | ------------------------------------- |
-| Service     | 12 months    | Yes                                   |
-| Maintenance | 18 months    | No                                    |
-
-During the Service period, bugfixes releases are more frequent. In some cases,
-support for new features may be added during the Service period (this is
-reserved for features which are needed to meet particular regulatory
-requirements or standards for new products, and which carry a very low risk of
-introducing regressions.)
-
-During the Maintenance period, the version is still supported but only bugfixes
-for high severity issues or security issues will be applied.
-
-Using an “In Service” version is recommended when starting a new project.
-
-Users are encouraged to upgrade all projects to a newer ESP-IDF release before
-the support period finishes and the release becomes End of Life (EOL). It is our
-policy to not continue fixing bugs in End of Life releases.
-
-Pre-release versions (betas, previews, `-rc` and `-dev` versions, etc)
-are not covered by any support period. Sometimes a particular feature is
-marked as "Preview" in a release, which means it is also not covered
-by the support period.
-
-The ESP-IDF Programming Guide has information about the
-[different versions of ESP-IDF](https://docs.espressif.com/projects/esp-idf/en/latest/versions.html)
-(major, minor, bugfix, etc).
-
-Example
--------
-
-ESP-IDF V3.3 was released in September 2019. It will be supported for 30 months
-until February 2022.
-
-- The first V3.3 release was `v3.3` in September 2019.
-- The ESP-IDF team continues to backport bug fixes, security fixes,
-  etc to the release branch `release/v3.3`.
-- Periodically stable bugfix releases are created from the release
-  branch. For example `v3.3.1`, `v3.3.2`, etc. Users are encouraged to
-  always update to the latest bugfix release.
-- V3.3 bugfix releases continue until February 2022, when all V3.3.x
-  releases become End of Life.
-
-Existing Releases
------------------
-
-ESP-IDF release V4.1 and all newer releases will follow this support period
-policy. The support period for each release will be announced when the release
-is made.
-
-For releases made before the current support period policy was announced, the
-original support periods apply:
-
-* ESP-IDF V4.0.x will be supported until October 2021
-* ESP-IDF V3.3.x will be supported until February 2022
-* ESP-IDF V3.1.x and V3.2.x will both be supported until October 2020.
-* ESP-IDF versions before V3.1 are already End of Life.
-
-Policy History
---------------
-
-* September 2019. This policy split ESP-IDF releases into Standard and Long Term
-  Support.
-* July 2020. All releases from now will have the same support period, which is
-  equal to the previous Long Term Support period. Added “In Service” period,
-  during which versions will receive more updates.

SUPPORT_POLICY_CN.md

@@ -1,55 +0,0 @@
-有关 ESP-IDF 的最新支持政策，详见 [支持期限政策](https://github.com/espressif/esp-idf/blob/master/SUPPORT_POLICY_CN.md)
-
-支持期限政策
-=====================
-
-ESP-IDF 的每个主要版本和次要版本（如 V4.1、V4.2 等）自其首次稳定版本发布之日起将支持 30 个月。
-
-支持意味着 ESP-IDF 团队将会对 GitHub 上的发布分支继续进行 bug 修复、安全修补等，并根据需求定期发布新的 bugfix 版本。
-
-支持周期包括“服务周期“和“维护周期”：
-
-| 周期      | 期限     | 是否建议新项目使用？         |
-| -------     | ------------ | ------------------------------------- |
-| 服务周期     | 12 个月    | 是                                   |
-| 维护周期 | 18 个月    | 否                                    |
-
-在版本的服务周期内，bug 修复版本会较为频繁发布。某些情况下，版本在其服务周期内可能会增加对新功能的支持（这仅适用于需要达到新产品特定规管标准或要求的功能，并且引入新问题的风险极低。）
-
-在版本的维护周期内，版本仍然会继续支持，但仅会对严重问题或安全问题进行 bug 修复。
-
-建议在开始新项目的时候使用处于服务周期的版本。 
-
-在某一版本支持期限结束，停止更新维护 (EOL) 前，建议用户升级所有项目至较新的 ESP-IDF 版本。根据《支持期限政策》，我们将停止对 EOL 版本进行 bug 修复。
-
-《支持期限政策》不适用于预发布版本（包括 beta、preview、-rc 和 -dev 版本等）。有时，在发布的版本中存在被标记为 "Preview" 的特定功能，则该功能也不在支持期限内。
-
-有关 [ESP-IDF 不同版本](https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/versions.html)（主要版本、次要版本、bugfix 版本等）信息，可参阅《ESP-IDF 编程指南》。
-
-示例
--------
-
-ESP-IDF V3.3 于 2019 年 9 月发布，将支持 30 个月至 2022 年 2 月停止。
-
-- V3.3 的首个发布版本为 2019 年 9 月发布的 v3.3。
-- ESP-IDF 团队将持续进行 bug 修复、安全修补等更新，并 backport 至分支 release/v3.3。
-- 定期从 release 分支创建稳定的 bugfix 版本，比如，v3.3.1、v3.3.2 等，并建议用户保持使用最新的 bugfix 版本。
-- V3.3 的 bugfix 版本发布将持续至 2022 年 2 月，届时所有 V3.3.x 将停止更新维护。
-
-现有版本
------------------
-
-ESP-IDF V4.1 及所有后续更新版本都将遵守该《支持期限政策》。每一版本发布时将同时公布其支持期限。
-
-对于该政策公布之日前发布的版本，应适用下述支持期限：
-
-* ESP-IDF V4.0.x 将支持至 2021 年 10 月。
-* ESP-IDF V3.3.x 将支持至 2022 年 2 月。
-* ESP-IDF V3.1.x 和 V3.2.x 都将在 2020 年 10 月停止支持。
-* ESP-IDF v3.1.x 之前的版本已经停止支持。
-  
-政策历史
---------------
-
-* 2019 年 9 月。该政策将 ESP-IDF 版本发布分为标准支持版本和长期支持版本。 
-* 2020 年 7 月。从现在开始，所有发布的版本都将有相同的支持周期，等同于之前的长期支持周期。新增了”服务周期“，期间版本的更新将较为频繁。

add_path.sh

@@ -9,10 +9,13 @@
 if [ -z ${IDF_PATH} ]; then
 	echo "IDF_PATH must be set before including this script."
 else
-	IDF_ADD_PATHS_EXTRAS="${IDF_PATH}/components/esptool_py/esptool"
+	IDF_ADD_PATHS_EXTRAS=
+	IDF_ADD_PATHS_EXTRAS="${IDF_ADD_PATHS_EXTRAS}:${IDF_PATH}/components/esptool_py/esptool"
 	IDF_ADD_PATHS_EXTRAS="${IDF_ADD_PATHS_EXTRAS}:${IDF_PATH}/components/espcoredump"
 	IDF_ADD_PATHS_EXTRAS="${IDF_ADD_PATHS_EXTRAS}:${IDF_PATH}/components/partition_table/"
 	IDF_ADD_PATHS_EXTRAS="${IDF_ADD_PATHS_EXTRAS}:${IDF_PATH}/tools/"
 	export PATH="${IDF_ADD_PATHS_EXTRAS}:${PATH}"
 	echo "Added to PATH: ${IDF_ADD_PATHS_EXTRAS}"
 fi
+
+

components/app_trace/CMakeLists.txt

@@ -1,63 +1,29 @@
-set(srcs
-    "app_trace.c"
-    "app_trace_util.c"
-    "host_file_io.c"
-    "gcov/gcov_rtio.c")
+set(COMPONENT_SRCS "app_trace.c"
+                   "app_trace_util.c"
+                   "host_file_io.c"
+                   "gcov/gcov_rtio.c")
+set(COMPONENT_ADD_INCLUDEDIRS "include")
 
-set(include_dirs "include")
-
-set(priv_include_dirs "private_include" "port/include")
-
-if(CONFIG_APPTRACE_MEMBUFS_APPTRACE_PROTO_ENABLE)
-    list(APPEND srcs
-        "app_trace_membufs_proto.c")
-
-    if(CONFIG_IDF_TARGET_ARCH_XTENSA)
-        list(APPEND srcs
-            "port/xtensa/port.c")
-    endif()
-    if(CONFIG_IDF_TARGET_ARCH_RISCV)
-        list(APPEND srcs
-            "port/riscv/port.c")
-    endif()
-endif()
-
-if(CONFIG_APPTRACE_SV_ENABLE)
-    list(APPEND include_dirs
+if(CONFIG_SYSVIEW_ENABLE)
+    list(APPEND COMPONENT_ADD_INCLUDEDIRS
         sys_view/Config
         sys_view/SEGGER
         sys_view/Sample/OS)
 
-    list(APPEND srcs
-        "sys_view/SEGGER/SEGGER_SYSVIEW.c"
-        "sys_view/Sample/Config/SEGGER_SYSVIEW_Config_FreeRTOS.c"
-        "sys_view/Sample/OS/SEGGER_SYSVIEW_FreeRTOS.c"
-        "sys_view/esp/SEGGER_RTT_esp.c"
-        "sys_view/ext/heap_trace_module.c"
-        "sys_view/ext/logging.c")
+    list(APPEND COMPONENT_SRCS "sys_view/SEGGER/SEGGER_SYSVIEW.c"
+                   "sys_view/Sample/Config/SEGGER_SYSVIEW_Config_FreeRTOS.c"
+                   "sys_view/Sample/OS/SEGGER_SYSVIEW_FreeRTOS.c"
+                   "sys_view/esp32/SEGGER_RTT_esp32.c")
 endif()
 
-if(CONFIG_HEAP_TRACING_TOHOST)
-    list(APPEND srcs "heap_trace_tohost.c")
-    set_source_files_properties(heap_trace_tohost.c
-        PROPERTIES COMPILE_FLAGS
-        -Wno-frame-address)
-endif()
+set(COMPONENT_REQUIRES)
+set(COMPONENT_PRIV_REQUIRES xtensa-debug-module)
+set(COMPONENT_ADD_LDFRAGMENTS linker.lf)
 
-idf_component_register(SRCS "${srcs}"
-                       INCLUDE_DIRS "${include_dirs}"
-                       PRIV_INCLUDE_DIRS "${priv_include_dirs}"
-                       PRIV_REQUIRES soc
-                       LDFRAGMENTS linker.lf)
+register_component()
 
+# disable --coverage for this component, as it is used as transport
+# for gcov
+component_compile_options("-fno-profile-arcs" "-fno-test-coverage")
 
-if(CONFIG_APPTRACE_GCOV_ENABLE)
-    # disable --coverage for this component, as it is used as transport
-    # for gcov
-    target_compile_options(${COMPONENT_LIB} PRIVATE "-fno-profile-arcs" "-fno-test-coverage")
-
-    # Force app_trace to also appear later than gcov in link line
-    idf_component_get_property(app_trace app_trace COMPONENT_LIB)
-    target_link_libraries(${COMPONENT_LIB} INTERFACE
-        "-Wl,--undefined=gcov_rtio_atexit" $<TARGET_FILE:${app_trace}> gcov $<TARGET_FILE:${app_trace}> c)
-endif()
+target_link_libraries(${COMPONENT_TARGET} gcov)

components/app_trace/Kconfig

@@ -1,78 +1,54 @@
 menu "Application Level Tracing"
 
-    choice APPTRACE_DESTINATION
+    choice ESP32_APPTRACE_DESTINATION
         prompt "Data Destination"
-        default APPTRACE_DEST_NONE
+        default ESP32_APPTRACE_DEST_NONE
         help
-            Select destination for application trace: JTAG or none (to disable).
+            Select destination for application trace: trace memory or none (to disable).
 
-        config APPTRACE_DEST_JTAG
-            bool "JTAG"
-            select APPTRACE_DEST_TRAX if IDF_TARGET_ARCH_XTENSA
-            select APPTRACE_MEMBUFS_APPTRACE_PROTO_ENABLE
-            select APPTRACE_ENABLE
-
-        config APPTRACE_DEST_NONE
+        config ESP32_APPTRACE_DEST_TRAX
+            bool "Trace memory"
+            select ESP32_APPTRACE_ENABLE
+        config ESP32_APPTRACE_DEST_NONE
             bool "None"
     endchoice
 
-    config APPTRACE_DEST_TRAX
-        bool
-        depends on IDF_TARGET_ARCH_XTENSA && !ESP32_TRAX && !ESP32S2_TRAX
-        select ESP32_MEMMAP_TRACEMEM
-        select ESP32S2_MEMMAP_TRACEMEM
-        select ESP32_MEMMAP_TRACEMEM_TWOBANKS
-        select ESP32S2_MEMMAP_TRACEMEM_TWOBANKS
-        default n
-        help
-            Enables/disable TRAX tracing HW.
-
-    config APPTRACE_MEMBUFS_APPTRACE_PROTO_ENABLE
-        bool
-        default n
-        help
-            Enables/disable swapping memory buffers tracing protocol.
-
-    config APPTRACE_ENABLE
+    config ESP32_APPTRACE_ENABLE
         bool
+        depends on !ESP32_TRAX
+        select MEMMAP_TRACEMEM
+        select MEMMAP_TRACEMEM_TWOBANKS
         default n
         help
             Enables/disable application tracing module.
 
-    config APPTRACE_LOCK_ENABLE
+    config ESP32_APPTRACE_LOCK_ENABLE
         bool
-        default !APPTRACE_SV_ENABLE
+        default !SYSVIEW_ENABLE
         help
             Enables/disable application tracing module internal sync lock.
 
-    config APPTRACE_ONPANIC_HOST_FLUSH_TMO
+    config ESP32_APPTRACE_ONPANIC_HOST_FLUSH_TMO
         int "Timeout for flushing last trace data to host on panic"
-        depends on APPTRACE_ENABLE
+        depends on ESP32_APPTRACE_ENABLE
         range -1 5000
         default -1
         help
             Timeout for flushing last trace data to host in case of panic. In ms.
             Use -1 to disable timeout and wait forever.
 
-    config APPTRACE_POSTMORTEM_FLUSH_THRESH
+    config ESP32_APPTRACE_POSTMORTEM_FLUSH_TRAX_THRESH
         int "Threshold for flushing last trace data to host on panic"
-        depends on APPTRACE_ENABLE
+        depends on ESP32_APPTRACE_DEST_TRAX
         range 0 16384
         default 0
         help
             Threshold for flushing last trace data to host on panic in post-mortem mode.
             This is minimal amount of data needed to perform flush. In bytes.
 
-    config APPTRACE_BUF_SIZE
-        int "Size of the apptrace buffer"
-        depends on APPTRACE_MEMBUFS_APPTRACE_PROTO_ENABLE && !APPTRACE_DEST_TRAX
-        default 16384
-        help
-            Size of the memory buffer for trace data in bytes.
-
-    config APPTRACE_PENDING_DATA_SIZE_MAX
+    config ESP32_APPTRACE_PENDING_DATA_SIZE_MAX
         int "Size of the pending data buffer"
-        depends on APPTRACE_MEMBUFS_APPTRACE_PROTO_ENABLE
+        depends on ESP32_APPTRACE_DEST_TRAX
         default 0
         help
             Size of the buffer for events in bytes. It is useful for buffering events from
@@ -80,163 +56,154 @@ menu "Application Level Tracing"
             events will be discarded when main HW buffer is full.
 
     menu "FreeRTOS SystemView Tracing"
-        depends on APPTRACE_ENABLE
-        config APPTRACE_SV_ENABLE
+        depends on ESP32_APPTRACE_ENABLE
+        config SYSVIEW_ENABLE
             bool "SystemView Tracing Enable"
-            depends on APPTRACE_ENABLE
+            depends on ESP32_APPTRACE_ENABLE
             default n
             help
                 Enables supporrt for SEGGER SystemView tracing functionality.
 
-        choice APPTRACE_SV_TS_SOURCE
+        choice SYSVIEW_TS_SOURCE
             prompt "Timer to use as timestamp source"
-            depends on APPTRACE_SV_ENABLE
-            default APPTRACE_SV_TS_SOURCE_CCOUNT if FREERTOS_UNICORE && !PM_ENABLE && !IDF_TARGET_ESP32C3
-            default APPTRACE_SV_TS_SOURCE_TIMER_00 if !FREERTOS_UNICORE && !PM_ENABLE && !IDF_TARGET_ESP32C3
-            default APPTRACE_SV_TS_SOURCE_ESP_TIMER if PM_ENABLE || IDF_TARGET_ESP32C3
+            depends on SYSVIEW_ENABLE
+            default SYSVIEW_TS_SOURCE_CCOUNT if FREERTOS_UNICORE && !PM_ENABLE
+            default SYSVIEW_TS_SOURCE_TIMER_00 if !FREERTOS_UNICORE && !PM_ENABLE
+            default SYSVIEW_TS_SOURCE_ESP_TIMER if PM_ENABLE
             help
                 SystemView needs to use a hardware timer as the source of timestamps
                 when tracing. This option selects the timer for it.
 
-            config APPTRACE_SV_TS_SOURCE_CCOUNT
+            config SYSVIEW_TS_SOURCE_CCOUNT
                 bool "CPU cycle counter (CCOUNT)"
-                depends on FREERTOS_UNICORE && !PM_ENABLE && !IDF_TARGET_ESP32C3
+                depends on FREERTOS_UNICORE && !PM_ENABLE
 
-            config APPTRACE_SV_TS_SOURCE_TIMER_00
+            config SYSVIEW_TS_SOURCE_TIMER_00
                 bool "Timer 0, Group 0"
-                depends on !PM_ENABLE && !IDF_TARGET_ESP32C3
+                depends on !PM_ENABLE
 
-            config APPTRACE_SV_TS_SOURCE_TIMER_01
+            config SYSVIEW_TS_SOURCE_TIMER_01
                 bool "Timer 1, Group 0"
-                depends on !PM_ENABLE && !IDF_TARGET_ESP32C3
+                depends on !PM_ENABLE
 
-            config APPTRACE_SV_TS_SOURCE_TIMER_10
+            config SYSVIEW_TS_SOURCE_TIMER_10
                 bool "Timer 0, Group 1"
-                depends on !PM_ENABLE && !IDF_TARGET_ESP32C3
+                depends on !PM_ENABLE
 
-            config APPTRACE_SV_TS_SOURCE_TIMER_11
+            config SYSVIEW_TS_SOURCE_TIMER_11
                 bool "Timer 1, Group 1"
-                depends on !PM_ENABLE && !IDF_TARGET_ESP32C3
+                depends on !PM_ENABLE
 
-            config APPTRACE_SV_TS_SOURCE_ESP_TIMER
+            config SYSVIEW_TS_SOURCE_ESP_TIMER
                 bool "esp_timer high resolution timer"
 
         endchoice
 
-        config APPTRACE_SV_MAX_TASKS
+        config SYSVIEW_MAX_TASKS
             int "Maximum supported tasks"
-            depends on APPTRACE_SV_ENABLE
+            depends on SYSVIEW_ENABLE
             range 1 64
             default 16
             help
                 Configures maximum supported tasks in sysview debug
 
-        config APPTRACE_SV_BUF_WAIT_TMO
-            int "Trace buffer wait timeout"
-            depends on APPTRACE_SV_ENABLE
-            default 500
-            help
-                Configures timeout (in us) to wait for free space in trace buffer.
-                Set to -1 to wait forever and avoid lost events.
-
-        config APPTRACE_SV_EVT_OVERFLOW_ENABLE
+        config SYSVIEW_EVT_OVERFLOW_ENABLE
             bool "Trace Buffer Overflow Event"
-            depends on APPTRACE_SV_ENABLE
+            depends on SYSVIEW_ENABLE
             default y
             help
                 Enables "Trace Buffer Overflow" event.
 
-        config APPTRACE_SV_EVT_ISR_ENTER_ENABLE
+        config SYSVIEW_EVT_ISR_ENTER_ENABLE
             bool "ISR Enter Event"
-            depends on APPTRACE_SV_ENABLE
+            depends on SYSVIEW_ENABLE
             default y
             help
                 Enables "ISR Enter" event.
 
-        config APPTRACE_SV_EVT_ISR_EXIT_ENABLE
+        config SYSVIEW_EVT_ISR_EXIT_ENABLE
             bool "ISR Exit Event"
-            depends on APPTRACE_SV_ENABLE
+            depends on SYSVIEW_ENABLE
             default y
             help
                 Enables "ISR Exit" event.
 
-        config APPTRACE_SV_EVT_ISR_TO_SCHED_ENABLE
+        config SYSVIEW_EVT_ISR_TO_SCHEDULER_ENABLE
             bool "ISR Exit to Scheduler Event"
-            depends on APPTRACE_SV_ENABLE
+            depends on SYSVIEW_ENABLE
             default y
             help
                 Enables "ISR to Scheduler" event.
 
-        config APPTRACE_SV_EVT_TASK_START_EXEC_ENABLE
+        config SYSVIEW_EVT_TASK_START_EXEC_ENABLE
             bool "Task Start Execution Event"
-            depends on APPTRACE_SV_ENABLE
+            depends on SYSVIEW_ENABLE
             default y
             help
                 Enables "Task Start Execution" event.
 
-        config APPTRACE_SV_EVT_TASK_STOP_EXEC_ENABLE
+        config SYSVIEW_EVT_TASK_STOP_EXEC_ENABLE
             bool "Task Stop Execution Event"
-            depends on APPTRACE_SV_ENABLE
+            depends on SYSVIEW_ENABLE
             default y
             help
                 Enables "Task Stop Execution" event.
 
-        config APPTRACE_SV_EVT_TASK_START_READY_ENABLE
+        config SYSVIEW_EVT_TASK_START_READY_ENABLE
             bool "Task Start Ready State Event"
-            depends on APPTRACE_SV_ENABLE
+            depends on SYSVIEW_ENABLE
             default y
             help
                 Enables "Task Start Ready State" event.
 
-        config APPTRACE_SV_EVT_TASK_STOP_READY_ENABLE
+        config SYSVIEW_EVT_TASK_STOP_READY_ENABLE
             bool "Task Stop Ready State Event"
-            depends on APPTRACE_SV_ENABLE
+            depends on SYSVIEW_ENABLE
             default y
             help
                 Enables "Task Stop Ready State" event.
 
-        config APPTRACE_SV_EVT_TASK_CREATE_ENABLE
+        config SYSVIEW_EVT_TASK_CREATE_ENABLE
             bool "Task Create Event"
-            depends on APPTRACE_SV_ENABLE
+            depends on SYSVIEW_ENABLE
             default y
             help
                 Enables "Task Create" event.
 
-        config APPTRACE_SV_EVT_TASK_TERMINATE_ENABLE
+        config SYSVIEW_EVT_TASK_TERMINATE_ENABLE
             bool "Task Terminate Event"
-            depends on APPTRACE_SV_ENABLE
+            depends on SYSVIEW_ENABLE
             default y
             help
                 Enables "Task Terminate" event.
 
-        config APPTRACE_SV_EVT_IDLE_ENABLE
+        config SYSVIEW_EVT_IDLE_ENABLE
             bool "System Idle Event"
-            depends on APPTRACE_SV_ENABLE
+            depends on SYSVIEW_ENABLE
             default y
             help
                 Enables "System Idle" event.
 
-        config APPTRACE_SV_EVT_TIMER_ENTER_ENABLE
+        config SYSVIEW_EVT_TIMER_ENTER_ENABLE
             bool "Timer Enter Event"
-            depends on APPTRACE_SV_ENABLE
+            depends on SYSVIEW_ENABLE
             default y
             help
                 Enables "Timer Enter" event.
 
-        config APPTRACE_SV_EVT_TIMER_EXIT_ENABLE
+        config SYSVIEW_EVT_TIMER_EXIT_ENABLE
             bool "Timer Exit Event"
-            depends on APPTRACE_SV_ENABLE
+            depends on SYSVIEW_ENABLE
             default y
             help
                 Enables "Timer Exit" event.
 
     endmenu
 
-    config APPTRACE_GCOV_ENABLE
+    config ESP32_GCOV_ENABLE
         bool "GCOV to Host Enable"
-        depends on APPTRACE_ENABLE && !APPTRACE_SV_ENABLE
-        select ESP_DEBUG_STUBS_ENABLE
-        default n
+        depends on ESP32_DEBUG_STUBS_ENABLE && ESP32_APPTRACE_ENABLE && !SYSVIEW_ENABLE
+        default y
         help
             Enables support for GCOV data transfer to host.
 

components/app_trace/app_trace_membufs_proto.c

@@ -1,364 +0,0 @@
-#include <sys/param.h>
-#include <string.h>
-#include "sdkconfig.h"
-#include "esp_log.h"
-#include "esp_app_trace_membufs_proto.h"
-
-/** Trace data header. Every user data chunk is prepended with this header.
- * User allocates block with esp_apptrace_buffer_get and then fills it with data,
- * in multithreading environment it can happen that tasks gets buffer and then gets interrupted,
- * so it is possible that user data are incomplete when  memory block is exposed to the host.
- * In this case host SW will see that wr_sz < block_sz and will report error.
- */
-typedef struct {
-#if CONFIG_APPTRACE_SV_ENABLE
-    uint8_t   block_sz; // size of allocated block for user data
-    uint8_t   wr_sz;    // size of actually written data
-#else
-    uint16_t   block_sz; // size of allocated block for user data
-    uint16_t   wr_sz;    // size of actually written data
-#endif
-} esp_tracedata_hdr_t;
-
-/** TODO: docs
- */
-typedef struct {
-    uint16_t   block_sz; // size of allocated block for user data
-} esp_hostdata_hdr_t;
-
-#if CONFIG_APPTRACE_SV_ENABLE
-#define ESP_APPTRACE_USR_BLOCK_CORE(_cid_)          (0)
-#define ESP_APPTRACE_USR_BLOCK_LEN(_v_)             (_v_)
-#define ESP_APPTRACE_USR_DATA_LEN_MAX(_hw_data_)    255UL
-#else
-#define ESP_APPTRACE_USR_BLOCK_CORE(_cid_)      ((_cid_) << 15)
-#define ESP_APPTRACE_USR_BLOCK_LEN(_v_)         (~(1 << 15) & (_v_))
-#define ESP_APPTRACE_USR_DATA_LEN_MAX(_hw_data_)       (ESP_APPTRACE_INBLOCK(_hw_data_)->sz - sizeof(esp_tracedata_hdr_t))
-#endif
-#define ESP_APPTRACE_USR_BLOCK_RAW_SZ(_s_)     ((_s_) + sizeof(esp_tracedata_hdr_t))
-
-#define ESP_APPTRACE_INBLOCK_MARKER(_hw_data_)          ((_hw_data_)->state.markers[(_hw_data_)->state.in_block % 2])
-#define ESP_APPTRACE_INBLOCK_MARKER_UPD(_hw_data_, _v_)   do {(_hw_data_)->state.markers[(_hw_data_)->state.in_block % 2] += (_v_);}while(0)
-#define ESP_APPTRACE_INBLOCK(_hw_data_)             (&(_hw_data_)->blocks[(_hw_data_)->state.in_block % 2])
-
-const static char *TAG = "esp_apptrace";
-
-static uint32_t esp_apptrace_membufs_down_buffer_write_nolock(esp_apptrace_membufs_proto_data_t *proto, uint8_t *data, uint32_t size);
-
-
-esp_err_t esp_apptrace_membufs_init(esp_apptrace_membufs_proto_data_t *proto, const esp_apptrace_mem_block_t blocks_cfg[2])
-{
-    // disabled by default
-    esp_apptrace_rb_init(&proto->rb_down, NULL, 0);
-    // membufs proto init
-    for (unsigned i = 0; i < 2; i++) {
-        proto->blocks[i].start = blocks_cfg[i].start;
-        proto->blocks[i].sz = blocks_cfg[i].sz;
-        proto->state.markers[i] = 0;
-    }
-    proto->state.in_block = 0;
-#if CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX > 0
-    esp_apptrace_rb_init(&proto->rb_pend, proto->pending_data,
-                        sizeof(proto->pending_data));
-#endif
-    return ESP_OK;
-}
-
-void esp_apptrace_membufs_down_buffer_config(esp_apptrace_membufs_proto_data_t *data, uint8_t *buf, uint32_t size)
-{
-    esp_apptrace_rb_init(&data->rb_down, buf, size);
-}
-
-// assumed to be protected by caller from multi-core/thread access
-static esp_err_t esp_apptrace_membufs_swap(esp_apptrace_membufs_proto_data_t *proto)
-{
-    int prev_block_num = proto->state.in_block % 2;
-    int new_block_num = prev_block_num ? (0) : (1);
-    esp_err_t res = ESP_OK;
-
-    res = proto->hw->swap_start(proto->state.in_block);
-    if (res != ESP_OK) {
-        return res;
-    }
-
-    proto->state.markers[new_block_num] = 0;
-    // switch to new block
-    proto->state.in_block++;
-
-    proto->hw->swap(new_block_num);
-
-    // handle data from host
-    esp_hostdata_hdr_t *hdr = (esp_hostdata_hdr_t *)proto->blocks[new_block_num].start;
-    // ESP_APPTRACE_LOGV("Host data %d, sz %d @ %p", proto->hw->host_data_pending(), hdr->block_sz, hdr);
-    if (proto->hw->host_data_pending() && hdr->block_sz > 0) {
-        // TODO: add support for multiple blocks from host, currently there is no need for that
-        uint8_t *p = proto->blocks[new_block_num].start + proto->blocks[new_block_num].sz;
-        ESP_APPTRACE_LOGD("Recvd %d bytes from host [%x %x %x %x %x %x %x %x .. %x %x %x %x %x %x %x %x]", hdr->block_sz,
-            *(proto->blocks[new_block_num].start+0), *(proto->blocks[new_block_num].start+1),
-            *(proto->blocks[new_block_num].start+2), *(proto->blocks[new_block_num].start+3),
-            *(proto->blocks[new_block_num].start+4), *(proto->blocks[new_block_num].start+5),
-            *(proto->blocks[new_block_num].start+6), *(proto->blocks[new_block_num].start+7),
-            *(p-8), *(p-7), *(p-6), *(p-5), *(p-4), *(p-3), *(p-2), *(p-1));
-        uint32_t sz = esp_apptrace_membufs_down_buffer_write_nolock(proto, (uint8_t *)(hdr+1), hdr->block_sz);
-        if (sz != hdr->block_sz) {
-            ESP_APPTRACE_LOGE("Failed to write %d bytes to down buffer (%d %d)!", hdr->block_sz - sz, hdr->block_sz, sz);
-        }
-        hdr->block_sz = 0;
-    }
-#if CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX > 0
-    // copy pending data to  block if any
-    while (proto->state.markers[new_block_num] < proto->blocks[new_block_num].sz) {
-        uint32_t read_sz = esp_apptrace_rb_read_size_get(&proto->rb_pend);
-        if (read_sz == 0) {
-            break; // no more data in pending buffer
-        }
-        if (read_sz > proto->blocks[new_block_num].sz - proto->state.markers[new_block_num]) {
-            read_sz = proto->blocks[new_block_num].sz - proto->state.markers[new_block_num];
-        }
-        uint8_t *ptr = esp_apptrace_rb_consume(&proto->rb_pend, read_sz);
-        if (!ptr) {
-            assert(false && "Failed to consume pended bytes!!");
-            break;
-        }
-        ESP_APPTRACE_LOGD("Pump %d pend bytes [%x %x %x %x : %x %x %x %x : %x %x %x %x : %x %x...%x %x]",
-            read_sz, *(ptr+0), *(ptr+1), *(ptr+2), *(ptr+3), *(ptr+4),
-            *(ptr+5), *(ptr+6), *(ptr+7), *(ptr+8), *(ptr+9), *(ptr+10), *(ptr+11), *(ptr+12), *(ptr+13), *(ptr+read_sz-2), *(ptr+read_sz-1));
-        memcpy(proto->blocks[new_block_num].start + proto->state.markers[new_block_num], ptr, read_sz);
-        proto->state.markers[new_block_num] += read_sz;
-    }
-#endif
-    proto->hw->swap_end(proto->state.in_block, proto->state.markers[prev_block_num]);
-    return res;
-}
-
-static esp_err_t esp_apptrace_membufs_swap_waitus(esp_apptrace_membufs_proto_data_t *proto, esp_apptrace_tmo_t *tmo)
-{
-    int res;
-
-    while ((res = esp_apptrace_membufs_swap(proto)) != ESP_OK) {
-        res = esp_apptrace_tmo_check(tmo);
-        if (res != ESP_OK) {
-            break;
-        }
-    }
-    return res;
-}
-
-uint8_t *esp_apptrace_membufs_down_buffer_get(esp_apptrace_membufs_proto_data_t *proto, uint32_t *size, esp_apptrace_tmo_t *tmo)
-{
-    uint8_t *ptr = NULL;
-
-    while (1) {
-        uint32_t sz = esp_apptrace_rb_read_size_get(&proto->rb_down);
-        if (sz != 0) {
-            *size = MIN(*size, sz);
-            ptr = esp_apptrace_rb_consume(&proto->rb_down, *size);
-            if (!ptr) {
-                assert(false && "Failed to consume bytes from down buffer!");
-            }
-            break;
-        }
-        // may need to flush
-        if (proto->hw->host_data_pending()) {
-            ESP_APPTRACE_LOGD("force flush");
-            int res = esp_apptrace_membufs_swap_waitus(proto, tmo);
-            if (res != ESP_OK) {
-                ESP_APPTRACE_LOGE("Failed to switch to another block to recv data from host!");
-                /*do not return error because data can be in down buffer already*/
-            }
-        } else {
-            // check tmo only if there is no data from host
-            int res = esp_apptrace_tmo_check(tmo);
-            if (res != ESP_OK) {
-                return NULL;
-            }
-        }
-    }
-    return ptr;
-}
-
-esp_err_t esp_apptrace_membufs_down_buffer_put(esp_apptrace_membufs_proto_data_t *proto, uint8_t *ptr, esp_apptrace_tmo_t *tmo)
-{
-    /* nothing todo */
-    return ESP_OK;
-}
-
-static uint32_t esp_apptrace_membufs_down_buffer_write_nolock(esp_apptrace_membufs_proto_data_t *proto, uint8_t *data, uint32_t size)
-{
-    uint32_t total_sz = 0;
-
-    while (total_sz < size) {
-        ESP_APPTRACE_LOGD("esp_apptrace_trax_down_buffer_write_nolock WRS %d-%d-%d %d", proto->rb_down.wr, proto->rb_down.rd,
-            proto->rb_down.cur_size, size);
-        uint32_t wr_sz = esp_apptrace_rb_write_size_get(&proto->rb_down);
-        if (wr_sz == 0) {
-            break;
-        }
-
-        if (wr_sz > size - total_sz) {
-            wr_sz = size - total_sz;
-        }
-        ESP_APPTRACE_LOGD("esp_apptrace_trax_down_buffer_write_nolock wr %d", wr_sz);
-        uint8_t *ptr = esp_apptrace_rb_produce(&proto->rb_down, wr_sz);
-        if (!ptr) {
-            assert(false && "Failed to produce bytes to down buffer!");
-        }
-        ESP_APPTRACE_LOGD("esp_apptrace_trax_down_buffer_write_nolock wr %d to 0x%x from 0x%x", wr_sz, ptr, data + total_sz + wr_sz);
-        memcpy(ptr, data + total_sz, wr_sz);
-        total_sz += wr_sz;
-        ESP_APPTRACE_LOGD("esp_apptrace_trax_down_buffer_write_nolock wr %d/%d", wr_sz, total_sz);
-    }
-    return total_sz;
-}
-
-static inline uint8_t *esp_apptrace_membufs_wait4buf(esp_apptrace_membufs_proto_data_t *proto, uint16_t size, esp_apptrace_tmo_t *tmo, int *pended)
-{
-    uint8_t *ptr = NULL;
-
-    int res = esp_apptrace_membufs_swap_waitus(proto, tmo);
-    if (res != ESP_OK) {
-        return NULL;
-    }
-#if CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX > 0
-    // check if we still have pending data
-    if (esp_apptrace_rb_read_size_get(&proto->rb_pend) > 0) {
-        // if after block switch we still have pending data (not all pending data have been pumped to block)
-        // alloc new pending buffer
-        *pended = 1;
-        ptr = esp_apptrace_rb_produce(&proto->rb_pend, size);
-        if (!ptr) {
-            ESP_APPTRACE_LOGE("Failed to alloc pend buf 1: w-r-s %d-%d-%d!", proto->rb_pend.wr, proto->rb_pend.rd, proto->rb_pend.cur_size);
-        }
-    } else
-#endif
-    {
-        // update block pointers
-        if (ESP_APPTRACE_INBLOCK_MARKER(proto) + size > ESP_APPTRACE_INBLOCK(proto)->sz) {
-#if CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX > 0
-            *pended = 1;
-            ptr = esp_apptrace_rb_produce(&proto->rb_pend, size);
-            if (ptr == NULL) {
-                ESP_APPTRACE_LOGE("Failed to alloc pend buf 2: w-r-s %d-%d-%d!", proto->rb_pend.wr, proto->rb_pend.rd, proto->rb_pend.cur_size);
-            }
-#endif
-        } else {
-            *pended = 0;
-            ptr = ESP_APPTRACE_INBLOCK(proto)->start + ESP_APPTRACE_INBLOCK_MARKER(proto);
-        }
-    }
-
-    return ptr;
-}
-
-static inline uint8_t *esp_apptrace_membufs_pkt_start(uint8_t *ptr, uint16_t size)
-{
-    // it is safe to use cpu_hal_get_core_id() in macro call because arg is used only once inside it
-    ((esp_tracedata_hdr_t *)ptr)->block_sz = ESP_APPTRACE_USR_BLOCK_CORE(cpu_hal_get_core_id()) | size;
-    ((esp_tracedata_hdr_t *)ptr)->wr_sz = 0;
-    return ptr + sizeof(esp_tracedata_hdr_t);
-}
-
-static inline void esp_apptrace_membufs_pkt_end(uint8_t *ptr)
-{
-    esp_tracedata_hdr_t *hdr = (esp_tracedata_hdr_t *)(ptr - sizeof(esp_tracedata_hdr_t));
-    // update written size
-    hdr->wr_sz = hdr->block_sz;
-}
-
-uint8_t *esp_apptrace_membufs_up_buffer_get(esp_apptrace_membufs_proto_data_t *proto, uint32_t size, esp_apptrace_tmo_t *tmo)
-{
-    uint8_t *buf_ptr = NULL;
-
-    if (size > ESP_APPTRACE_USR_DATA_LEN_MAX(proto)) {
-        ESP_APPTRACE_LOGE("Too large user data size %d!", size);
-        return NULL;
-    }
-
-    // check for data in the pending buffer
-#if CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX > 0
-    if (esp_apptrace_rb_read_size_get(&proto->rb_pend) > 0) {
-        // if we have buffered data try to switch  block
-        esp_apptrace_membufs_swap(proto);
-        // if switch was successful, part or all pended data have been copied to  block
-    }
-    if (esp_apptrace_rb_read_size_get(&proto->rb_pend) > 0) {
-        // if we have buffered data alloc new pending buffer
-        ESP_APPTRACE_LOGD("Get %d bytes from PEND buffer", size);
-        buf_ptr = esp_apptrace_rb_produce(&proto->rb_pend, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size));
-        if (buf_ptr == NULL) {
-            int pended_buf;
-            buf_ptr = esp_apptrace_membufs_wait4buf(proto, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size), tmo, &pended_buf);
-            if (buf_ptr && !pended_buf) {
-                ESP_APPTRACE_LOGD("Get %d bytes from block", size);
-                // update cur block marker
-                ESP_APPTRACE_INBLOCK_MARKER_UPD(proto, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size));
-            }
-        }
-    } else {
-#else
-    if (1) {
-#endif
-        if (ESP_APPTRACE_INBLOCK_MARKER(proto) + ESP_APPTRACE_USR_BLOCK_RAW_SZ(size) > ESP_APPTRACE_INBLOCK(proto)->sz) {
-            #if CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX > 0
-            ESP_APPTRACE_LOGD("Block full. Get %d bytes from PEND buffer", size);
-            buf_ptr = esp_apptrace_rb_produce(&proto->rb_pend, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size));
-            #endif
-            if (buf_ptr == NULL) {
-                int pended_buf;
-                ESP_APPTRACE_LOGD(" full. Get %d bytes from pend buffer", size);
-                buf_ptr = esp_apptrace_membufs_wait4buf(proto, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size), tmo, &pended_buf);
-                if (buf_ptr && !pended_buf) {
-                    ESP_APPTRACE_LOGD("Got %d bytes from block", size);
-                    // update cur block marker
-                    ESP_APPTRACE_INBLOCK_MARKER_UPD(proto, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size));
-                }
-            }
-        } else {
-            ESP_APPTRACE_LOGD("Get %d bytes from  buffer", size);
-            // fit to curr  nlock
-            buf_ptr = ESP_APPTRACE_INBLOCK(proto)->start + ESP_APPTRACE_INBLOCK_MARKER(proto);
-            // update cur block marker
-            ESP_APPTRACE_INBLOCK_MARKER_UPD(proto, ESP_APPTRACE_USR_BLOCK_RAW_SZ(size));
-        }
-    }
-    if (buf_ptr) {
-        buf_ptr = esp_apptrace_membufs_pkt_start(buf_ptr, size);
-    }
-
-    return buf_ptr;
-}
-
-esp_err_t esp_apptrace_membufs_up_buffer_put(esp_apptrace_membufs_proto_data_t *proto, uint8_t *ptr, esp_apptrace_tmo_t *tmo)
-{
-    esp_apptrace_membufs_pkt_end(ptr);
-    // TODO: mark block as busy in order not to re-use it for other tracing calls until it is completely written
-    // TODO: avoid potential situation when all memory is consumed by low prio tasks which can not complete writing due to
-    // higher prio tasks and the latter can not allocate buffers at all
-    // this is abnormal situation can be detected on host which will receive only uncompleted buffers
-    // workaround: use own memcpy which will kick-off dead tracing calls
-    return ESP_OK;
-}
-
-esp_err_t esp_apptrace_membufs_flush_nolock(esp_apptrace_membufs_proto_data_t *proto, uint32_t min_sz, esp_apptrace_tmo_t *tmo)
-{
-    int res = ESP_OK;
-
-    if (ESP_APPTRACE_INBLOCK_MARKER(proto) < min_sz) {
-        ESP_APPTRACE_LOGI("Ignore flush request for min %d bytes. Bytes in  block: %d.", min_sz, ESP_APPTRACE_INBLOCK_MARKER(proto));
-        return ESP_OK;
-    }
-    // switch  block while size of data (including that in pending buffer) is more than min size
-    while (ESP_APPTRACE_INBLOCK_MARKER(proto) > min_sz) {
-        ESP_APPTRACE_LOGD("Try to flush %d bytes. Wait until block switch for %lld us", ESP_APPTRACE_INBLOCK_MARKER(proto), tmo->tmo);
-        res = esp_apptrace_membufs_swap_waitus(proto, tmo);
-        if (res != ESP_OK) {
-            if (tmo->tmo != ESP_APPTRACE_TMO_INFINITE)
-                ESP_APPTRACE_LOGW("Failed to switch to another block in %lld us!", tmo->tmo);
-            else
-                ESP_APPTRACE_LOGE("Failed to switch to another block in %lld us!", tmo->tmo);
-            return res;
-        }
-    }
-
-    return res;
-}

components/app_trace/app_trace_util.c

@@ -15,43 +15,25 @@
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
 #include "esp_app_trace_util.h"
-#include "sdkconfig.h"
-
-///////////////////////////////////////////////////////////////////////////////
-///////////////////////////////// Locks /////////////////////////////////////
-///////////////////////////////////////////////////////////////////////////////
-
-#if ESP_APPTRACE_PRINT_LOCK
-static esp_apptrace_lock_t s_log_lock = {.irq_stat = 0, .portmux = portMUX_INITIALIZER_UNLOCKED};
-#endif
-
-int esp_apptrace_log_lock(void)
-{
-#if ESP_APPTRACE_PRINT_LOCK
-    esp_apptrace_tmo_t tmo;
-    esp_apptrace_tmo_init(&tmo, ESP_APPTRACE_TMO_INFINITE);
-    int ret = esp_apptrace_lock_take(&s_log_lock, &tmo);
-    return ret;
-#else
-    return 0;
-#endif
-}
-
-void esp_apptrace_log_unlock(void)
-{
- #if ESP_APPTRACE_PRINT_LOCK
-    esp_apptrace_lock_give(&s_log_lock);
-#endif
-}
+#include "esp_clk.h"
 
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////// TIMEOUT /////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////
 
+#define ESP_APPTRACE_CPUTICKS2US(_t_, _cpu_freq_)       ((_t_)/(_cpu_freq_/1000000))
+#define ESP_APPTRACE_US2CPUTICKS(_t_, _cpu_freq_)       ((_t_)*(_cpu_freq_/1000000))
+
 esp_err_t esp_apptrace_tmo_check(esp_apptrace_tmo_t *tmo)
 {
-    if (tmo->tmo != (int64_t)-1) {
-        tmo->elapsed = esp_timer_get_time() - tmo->start;
+    int cpu_freq = esp_clk_cpu_freq();
+    if (tmo->tmo != ESP_APPTRACE_TMO_INFINITE) {
+        unsigned cur = portGET_RUN_TIME_COUNTER_VALUE();
+        if (tmo->start <= cur) {
+            tmo->elapsed = ESP_APPTRACE_CPUTICKS2US(cur - tmo->start, cpu_freq);
+        } else {
+            tmo->elapsed = ESP_APPTRACE_CPUTICKS2US(0xFFFFFFFF - tmo->start + cur, cpu_freq);
+        }
         if (tmo->elapsed >= tmo->tmo) {
             return ESP_ERR_TIMEOUT;
         }

components/app_trace/component.mk

@@ -4,18 +4,14 @@
 
 COMPONENT_SRCDIRS := .
 
-ifdef CONFIG_APPTRACE_MEMBUFS_APPTRACE_PROTO_ENABLE
-COMPONENT_SRCDIRS += port/xtensa
-endif
-
 COMPONENT_ADD_INCLUDEDIRS = include
 
-COMPONENT_PRIV_INCLUDEDIRS = private_include \
-	port/include
-
 COMPONENT_ADD_LDFLAGS = -lapp_trace
 
-ifdef CONFIG_APPTRACE_SV_ENABLE
+# do not produce gcov info for this module, it is used as transport for gcov
+CFLAGS := $(subst --coverage,,$(CFLAGS))
+
+ifdef CONFIG_SYSVIEW_ENABLE
 
 COMPONENT_ADD_INCLUDEDIRS += \
 	sys_view/Config \
@@ -27,15 +23,9 @@ COMPONENT_SRCDIRS += \
 	sys_view/SEGGER \
 	sys_view/Sample/OS \
 	sys_view/Sample/Config \
-	sys_view/esp \
-	sys_view/ext
+	sys_view/esp32
 else
-ifdef CONFIG_APPTRACE_GCOV_ENABLE
-# do not produce gcov info for this module, it is used as transport for gcov
-CFLAGS := $(subst --coverage,,$(CFLAGS))
-COMPONENT_ADD_LDFLAGS += -Wl,--undefined=gcov_rtio_atexit
 COMPONENT_SRCDIRS += gcov
 endif
-endif
 
 COMPONENT_ADD_LDFRAGMENTS += linker.lf

components/app_trace/gcov/gcov_rtio.c

@@ -14,146 +14,149 @@
 
 // This module implements runtime file I/O API for GCOV.
 
-#include <string.h>
 #include "esp_task_wdt.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
-#include "freertos/semphr.h"
 #include "soc/cpu.h"
-#include "soc/timer_periph.h"
+#include "soc/timer_group_struct.h"
+#include "soc/timer_group_reg.h"
 #include "esp_app_trace.h"
-#include "esp_freertos_hooks.h"
-#include "esp_private/dbg_stubs.h"
-#include "esp_ipc.h"
-#include "hal/wdt_hal.h"
-#if CONFIG_IDF_TARGET_ESP32
-#include "esp32/rom/libc_stubs.h"
-#elif CONFIG_IDF_TARGET_ESP32S2
-#include "esp32s2/rom/libc_stubs.h"
-#endif
+#include "esp_dbg_stubs.h"
 
-#if CONFIG_APPTRACE_GCOV_ENABLE
+#if CONFIG_ESP32_GCOV_ENABLE
 
 #define ESP_GCOV_DOWN_BUF_SIZE  4200
 
 #define LOG_LOCAL_LEVEL CONFIG_LOG_DEFAULT_LEVEL
 #include "esp_log.h"
 const static char *TAG = "esp_gcov_rtio";
-static volatile bool s_create_gcov_task = false;
-static volatile bool s_gcov_task_running = false;
 
-extern void __gcov_dump(void);
-extern void __gcov_reset(void);
+#if GCC_NOT_5_2_0
+void __gcov_dump(void);
+void __gcov_reset(void);
+#else
+/* The next code for old GCC */
 
-void gcov_dump_task(void *pvParameter)
+static void (*s_gcov_exit)(void);
+/* Root of a program/shared-object state */
+struct gcov_root
 {
-    int dump_result = 0;
-    bool *running = (bool *)pvParameter;
+  void *list;
+  unsigned dumped : 1;  /* counts have been dumped.  */
+  unsigned run_counted : 1;  /* run has been accounted for.  */
+  struct gcov_root *next;
+  struct gcov_root *prev;
+};
 
-    ESP_EARLY_LOGV(TAG, "%s stack use in %d", __FUNCTION__, uxTaskGetStackHighWaterMark(NULL));
+/* Per-dynamic-object gcov state.  */
+extern struct gcov_root __gcov_root;
+
+static void esp_gcov_reset_status(void)
+{
+  __gcov_root.dumped = 0;
+  __gcov_root.run_counted = 0;
+}
+#endif
+
+
+static int esp_dbg_stub_gcov_dump_do(void)
+{
+    int ret = ESP_OK;
 
     ESP_EARLY_LOGV(TAG, "Alloc apptrace down buf %d bytes", ESP_GCOV_DOWN_BUF_SIZE);
     void *down_buf = malloc(ESP_GCOV_DOWN_BUF_SIZE);
     if (down_buf == NULL) {
         ESP_EARLY_LOGE(TAG, "Could not allocate memory for the buffer");
-        dump_result = ESP_ERR_NO_MEM;
-        goto gcov_exit;
+        return ESP_ERR_NO_MEM;
     }
     ESP_EARLY_LOGV(TAG, "Config apptrace down buf");
     esp_apptrace_down_buffer_config(down_buf, ESP_GCOV_DOWN_BUF_SIZE);
-    /* we are directing the std outputs to the fake ones in order to reduce stack usage */
-    FILE *old_stderr = stderr;
-    FILE *old_stdout = stdout;
-    stderr = (FILE *) &__sf_fake_stderr;
-    stdout = (FILE *) &__sf_fake_stdout;
     ESP_EARLY_LOGV(TAG, "Dump data...");
+#if GCC_NOT_5_2_0
     __gcov_dump();
     // reset dump status to allow incremental data accumulation
     __gcov_reset();
+#else
+    ESP_EARLY_LOGV(TAG, "Check for dump handler %p", s_gcov_exit);
+    if (s_gcov_exit) {
+        s_gcov_exit();
+        // reset dump status to allow incremental data accumulation
+        esp_gcov_reset_status();
+    }
+#endif
+    ESP_EARLY_LOGV(TAG, "Free apptrace down buf");
     free(down_buf);
-    stderr = old_stderr;
-    stdout = old_stdout;
     ESP_EARLY_LOGV(TAG, "Finish file transfer session");
-    dump_result = esp_apptrace_fstop(ESP_APPTRACE_DEST_TRAX);
-    if (dump_result != ESP_OK) {
-        ESP_EARLY_LOGE(TAG, "Failed to send files transfer stop cmd (%d)!", dump_result);
-    }
-
-gcov_exit:
-    ESP_EARLY_LOGV(TAG, "dump_result %d", dump_result);
-    if (running) {
-        *running = false;
-    }
-
-    ESP_EARLY_LOGV(TAG, "%s stack use out %d", __FUNCTION__, uxTaskGetStackHighWaterMark(NULL));
-
-    vTaskDelete(NULL);
-}
-
-void gcov_create_task(void *arg)
-{
-    ESP_EARLY_LOGV(TAG, "%s", __FUNCTION__);
-    xTaskCreatePinnedToCore(&gcov_dump_task, "gcov_dump_task", 2048, (void *)&s_gcov_task_running, configMAX_PRIORITIES - 1, NULL, 0);
-}
-
-void gcov_create_task_tick_hook(void)
-{
-    extern esp_err_t esp_ipc_start_gcov_from_isr(uint32_t cpu_id, esp_ipc_func_t func, void* arg);
-    if (s_create_gcov_task) {
-        if (esp_ipc_start_gcov_from_isr(xPortGetCoreID(), &gcov_create_task, NULL) == ESP_OK) {
-            s_create_gcov_task = false;
-        }
+    ret = esp_apptrace_fstop(ESP_APPTRACE_DEST_TRAX);
+    if (ret != ESP_OK) {
+        ESP_EARLY_LOGE(TAG, "Failed to send files transfer stop cmd (%d)!", ret);
     }
+    return ret;
 }
 
 /**
- * @brief Triggers gcov info dump task
+ * @brief Triggers gcov info dump.
  *        This function is to be called by OpenOCD, not by normal user code.
- * TODO: what about interrupted flash access (when cache disabled)
+ * TODO: what about interrupted flash access (when cache disabled)???
  *
  * @return ESP_OK on success, otherwise see esp_err_t
  */
 static int esp_dbg_stub_gcov_entry(void)
 {
-    /* we are in isr context here */
-    s_create_gcov_task = true;
-    return ESP_OK;
+#if GCC_NOT_5_2_0
+    return esp_dbg_stub_gcov_dump_do();
+#else
+    int ret = ESP_OK;
+    // disable IRQs on this CPU, other CPU is halted by OpenOCD
+    unsigned irq_state = portENTER_CRITICAL_NESTED();
+    ret = esp_dbg_stub_gcov_dump_do();
+    portEXIT_CRITICAL_NESTED(irq_state);
+    return ret;
+#endif
+}
+
+void esp_gcov_dump()
+{
+    // disable IRQs on this CPU, other CPU is halted by OpenOCD
+    unsigned irq_state = portENTER_CRITICAL_NESTED();
+#if !CONFIG_FREERTOS_UNICORE
+    int other_core = xPortGetCoreID() ? 0 : 1;
+    esp_cpu_stall(other_core);
+#endif
+    while (!esp_apptrace_host_is_connected(ESP_APPTRACE_DEST_TRAX)) {
+        // to avoid complains that task watchdog got triggered for other tasks
+        TIMERG0.wdt_wprotect=TIMG_WDT_WKEY_VALUE;
+        TIMERG0.wdt_feed=1;
+        TIMERG0.wdt_wprotect=0;
+        // to avoid reboot on INT_WDT
+        TIMERG1.wdt_wprotect=TIMG_WDT_WKEY_VALUE;
+        TIMERG1.wdt_feed=1;
+        TIMERG1.wdt_wprotect=0;
+    }
+
+    esp_dbg_stub_gcov_dump_do();
+#if !CONFIG_FREERTOS_UNICORE
+    esp_cpu_unstall(other_core);
+#endif
+    portEXIT_CRITICAL_NESTED(irq_state);
 }
 
 int gcov_rtio_atexit(void (*function)(void) __attribute__ ((unused)))
 {
-    uint32_t capabilities = 0;
+#if GCC_NOT_5_2_0
     ESP_EARLY_LOGV(TAG, "%s", __FUNCTION__);
+#else
+    ESP_EARLY_LOGV(TAG, "%s %p", __FUNCTION__, function);
+    s_gcov_exit = function;
+#endif
     esp_dbg_stub_entry_set(ESP_DBG_STUB_ENTRY_GCOV, (uint32_t)&esp_dbg_stub_gcov_entry);
-    if (esp_dbg_stub_entry_get(ESP_DBG_STUB_ENTRY_CAPABILITIES, &capabilities) == ESP_OK) {
-        esp_dbg_stub_entry_set(ESP_DBG_STUB_ENTRY_CAPABILITIES, capabilities | ESP_DBG_STUB_CAP_GCOV_TASK);
-    }
-    esp_register_freertos_tick_hook(gcov_create_task_tick_hook);
-    return ESP_OK;
-}
-
-void esp_gcov_dump(void)
-{
-    ESP_EARLY_LOGV(TAG, "%s", __FUNCTION__);
-
-    while (!esp_apptrace_host_is_connected(ESP_APPTRACE_DEST_TRAX)) {
-        vTaskDelay(pdMS_TO_TICKS(10));
-    }
-
-    /* We are not in isr context here. Waiting for the completion is safe */
-    s_gcov_task_running = true;
-    s_create_gcov_task = true;
-    while (s_gcov_task_running) {
-        vTaskDelay(pdMS_TO_TICKS(10));
-    }
+    return 0;
 }
 
 void *gcov_rtio_fopen(const char *path, const char *mode)
 {
     ESP_EARLY_LOGV(TAG, "%s '%s' '%s'", __FUNCTION__, path, mode);
-    void *f = esp_apptrace_fopen(ESP_APPTRACE_DEST_TRAX, path, mode);
-    ESP_EARLY_LOGV(TAG, "%s ret %p", __FUNCTION__, f);
-    return f;
+    return esp_apptrace_fopen(ESP_APPTRACE_DEST_TRAX, path, mode);
 }
 
 int gcov_rtio_fclose(void *stream)
@@ -164,7 +167,7 @@ int gcov_rtio_fclose(void *stream)
 
 size_t gcov_rtio_fread(void *ptr, size_t size, size_t nmemb, void *stream)
 {
-    ESP_EARLY_LOGV(TAG, "%s read %u", __FUNCTION__, size * nmemb);
+    ESP_EARLY_LOGV(TAG, "%s read %u", __FUNCTION__, size*nmemb);
     size_t sz = esp_apptrace_fread(ESP_APPTRACE_DEST_TRAX, ptr, size, nmemb, stream);
     ESP_EARLY_LOGV(TAG, "%s actually read %u", __FUNCTION__, sz);
     return sz;

components/app_trace/heap_trace_tohost.c

@@ -1,113 +0,0 @@
-// Copyright 2018 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-#include <sdkconfig.h>
-
-#define HEAP_TRACE_SRCFILE /* don't warn on inclusion here */
-#include "esp_heap_trace.h"
-#undef HEAP_TRACE_SRCFILE
-
-#if CONFIG_APPTRACE_SV_ENABLE
-#include "esp_app_trace.h"
-#include "esp_sysview_trace.h"
-#endif
-
-#define STACK_DEPTH CONFIG_HEAP_TRACING_STACK_DEPTH
-
-#ifdef CONFIG_HEAP_TRACING_TOHOST
-
-#if !CONFIG_APPTRACE_SV_ENABLE
-#error None of the heap tracing backends is enabled! You must enable SystemView compatible tracing to use this feature.
-#endif
-
-static bool s_tracing;
-
-esp_err_t heap_trace_init_tohost(void)
-{
-    if (s_tracing) {
-        return ESP_ERR_INVALID_STATE;
-    }
-    return ESP_OK;
-}
-
-esp_err_t heap_trace_start(heap_trace_mode_t mode_param)
-{
-#if CONFIG_APPTRACE_SV_ENABLE
-    esp_err_t ret = esp_sysview_heap_trace_start((uint32_t)-1);
-    if (ret != ESP_OK) {
-        return ret;
-    }
-#endif
-    s_tracing = true;
-    return ESP_OK;
-}
-
-esp_err_t heap_trace_stop(void)
-{
-    esp_err_t ret = ESP_ERR_NOT_SUPPORTED;
-#if CONFIG_APPTRACE_SV_ENABLE
-    ret = esp_sysview_heap_trace_stop();
-#endif
-    s_tracing = false;
-    return ret;
-}
-
-esp_err_t heap_trace_resume(void)
-{
-    return heap_trace_start(HEAP_TRACE_ALL);
-}
-
-size_t heap_trace_get_count(void)
-{
-    return 0;
-}
-
-esp_err_t heap_trace_get(size_t index, heap_trace_record_t *record)
-{
-    return ESP_ERR_NOT_SUPPORTED;
-}
-
-void heap_trace_dump(void)
-{
-    return;
-}
-
-/* Add a new allocation to the heap trace records */
-static IRAM_ATTR void record_allocation(const heap_trace_record_t *record)
-{
-    if (!s_tracing) {
-        return;
-    }
-#if CONFIG_APPTRACE_SV_ENABLE
-    esp_sysview_heap_trace_alloc(record->address, record->size, record->alloced_by);
-#endif
-}
-
-/* record a free event in the heap trace log
-
-   For HEAP_TRACE_ALL, this means filling in the freed_by pointer.
-   For HEAP_TRACE_LEAKS, this means removing the record from the log.
-*/
-static IRAM_ATTR void record_free(void *p, void **callers)
-{
-    if (!s_tracing) {
-        return;
-    }
-#if CONFIG_APPTRACE_SV_ENABLE
-    esp_sysview_heap_trace_free(p, callers);
-#endif
-}
-
-#include "heap_trace.inc"
-
-#endif /*CONFIG_HEAP_TRACING_TOHOST*/

components/app_trace/host_file_io.c

@@ -25,7 +25,7 @@
 #include <string.h>
 #include "esp_app_trace.h"
 
-#if CONFIG_APPTRACE_ENABLE
+#if CONFIG_ESP32_APPTRACE_ENABLE
 
 #define LOG_LOCAL_LEVEL CONFIG_LOG_DEFAULT_LEVEL
 #include "esp_log.h"
@@ -145,9 +145,6 @@ void *esp_apptrace_fopen(esp_apptrace_dest_t dest, const char *path, const char
     esp_apptrace_fopen_args_t cmd_args;
 
     ESP_EARLY_LOGV(TAG, "esp_apptrace_fopen '%s' '%s'", path, mode);
-    if (path == NULL || mode == NULL) {
-        return 0;
-    }
 
     cmd_args.path = path;
     cmd_args.path_len = strlen(path) + 1;
@@ -216,10 +213,6 @@ size_t esp_apptrace_fwrite(esp_apptrace_dest_t dest, const void *ptr, size_t siz
 
     ESP_EARLY_LOGV(TAG, "esp_apptrace_fwrite f %p l %d", stream, size*nmemb);
 
-    if (ptr == NULL) {
-        return 0;
-    }
-
     cmd_args.buf = (void *)ptr;
     cmd_args.size = size * nmemb;
     cmd_args.file = stream;
@@ -255,10 +248,6 @@ size_t esp_apptrace_fread(esp_apptrace_dest_t dest, void *ptr, size_t size, size
 
     ESP_EARLY_LOGV(TAG, "esp_apptrace_fread f %p l %d", stream, size*nmemb);
 
-    if (ptr == NULL) {
-        return 0;
-    }
-
     cmd_args.size = size * nmemb;
     cmd_args.file = stream;
     esp_err_t ret = esp_apptrace_file_cmd_send(dest, ESP_APPTRACE_FILE_CMD_FREAD, esp_apptrace_fread_args_prepare,

components/app_trace/include/esp_app_trace.h

@@ -18,19 +18,12 @@
 #include "esp_err.h"
 #include "esp_app_trace_util.h" // ESP_APPTRACE_TMO_INFINITE
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
 /**
  * Application trace data destinations bits.
  */
 typedef enum {
-    ESP_APPTRACE_DEST_JTAG = 1,                         ///< JTAG destination
-    ESP_APPTRACE_DEST_TRAX = ESP_APPTRACE_DEST_JTAG, 	///< xxx_TRAX name is obsolete, use more common xxx_JTAG
-    ESP_APPTRACE_DEST_UART0,	                        ///< UART0 destination
-    ESP_APPTRACE_DEST_MAX = ESP_APPTRACE_DEST_UART0,
-    ESP_APPTRACE_DEST_NUM
+    ESP_APPTRACE_DEST_TRAX = 0x1,	///< JTAG destination
+    ESP_APPTRACE_DEST_UART0 = 0x2,	///< UART destination
 } esp_apptrace_dest_t;
 
 /**
@@ -40,7 +33,7 @@ typedef enum {
  *
  * @return ESP_OK on success, otherwise see esp_err_t
  */
-esp_err_t esp_apptrace_init(void);
+esp_err_t esp_apptrace_init();
 
 /**
  * @brief Configures down buffer.
@@ -269,8 +262,4 @@ int esp_apptrace_fstop(esp_apptrace_dest_t dest);
  */
 void esp_gcov_dump(void);
 
-#ifdef __cplusplus
-}
-#endif
-
 #endif

components/app_trace/include/esp_app_trace_util.h

@@ -14,26 +14,21 @@
 #ifndef ESP_APP_TRACE_UTIL_H_
 #define ESP_APP_TRACE_UTIL_H_
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
 #include "freertos/FreeRTOS.h"
 #include "esp_err.h"
-#include "esp_timer.h"
 
 /** Infinite waiting timeout */
 #define ESP_APPTRACE_TMO_INFINITE               ((uint32_t)-1)
 
-/** Structure which holds data necessary for measuring time intervals.
+/** Structure which holds data necessary for measuring time intervals. 
  *
  *  After initialization via esp_apptrace_tmo_init() user needs to call esp_apptrace_tmo_check()
  *  periodically to check timeout for expiration.
  */
 typedef struct {
-    int64_t   start;   ///< time interval start (in us)
-    int64_t   tmo;     ///< timeout value (in us)
-    int64_t   elapsed; ///< elapsed time (in us)
+    uint32_t   start;   ///< time interval start (in CPU ticks)
+    uint32_t   tmo;     ///< timeout value (in us)
+    uint32_t   elapsed; ///< elapsed time (in us)
 } esp_apptrace_tmo_t;
 
 /**
@@ -44,23 +39,23 @@ typedef struct {
 */
 static inline void esp_apptrace_tmo_init(esp_apptrace_tmo_t *tmo, uint32_t user_tmo)
 {
-    tmo->start = esp_timer_get_time();
-    tmo->tmo = user_tmo == ESP_APPTRACE_TMO_INFINITE ? (int64_t)-1 : (int64_t)user_tmo;
+    tmo->start = portGET_RUN_TIME_COUNTER_VALUE();
+    tmo->tmo = user_tmo;
     tmo->elapsed = 0;
 }
 
 /**
  * @brief Checks timeout for expiration.
  *
- * @param tmo Pointer to timeout structure.
+ * @param tmo Pointer to timeout structure to be initialized.
  *
- * @return number of remaining us till tmo.
+ * @return ESP_OK on success, otherwise \see esp_err_t
  */
 esp_err_t esp_apptrace_tmo_check(esp_apptrace_tmo_t *tmo);
 
 static inline uint32_t esp_apptrace_tmo_remaining_us(esp_apptrace_tmo_t *tmo)
 {
-    return tmo->tmo != (int64_t)-1 ? (tmo->elapsed - tmo->tmo) : ESP_APPTRACE_TMO_INFINITE;
+    return tmo->tmo != ESP_APPTRACE_TMO_INFINITE ? (tmo->elapsed - tmo->tmo) : ESP_APPTRACE_TMO_INFINITE;
 }
 
 /** Tracing module synchronization lock */
@@ -101,7 +96,7 @@ esp_err_t esp_apptrace_lock_give(esp_apptrace_lock_t *lock);
 
 /** Ring buffer control structure.
  *
- * @note For purposes of application tracing module if there is no enough space for user data and write pointer can be wrapped
+ * @note For purposes of application tracing module if there is no enough space for user data and write pointer can be wrapped 
  *       current ring buffer size can be temporarily shrinked in order to provide buffer with requested size.
  */
 typedef struct {
@@ -169,32 +164,4 @@ uint32_t esp_apptrace_rb_read_size_get(esp_apptrace_rb_t *rb);
  */
 uint32_t esp_apptrace_rb_write_size_get(esp_apptrace_rb_t *rb);
 
-int esp_apptrace_log_lock(void);
-void esp_apptrace_log_unlock(void);
-
-#define ESP_APPTRACE_LOG( format, ... )   \
-    do { \
-        esp_apptrace_log_lock(); \
-        esp_rom_printf(format, ##__VA_ARGS__); \
-        esp_apptrace_log_unlock(); \
-    } while(0)
-
-#define ESP_APPTRACE_LOG_LEV( _L_, level, format, ... )   \
-    do { \
-        if (LOG_LOCAL_LEVEL >= level) { \
-            ESP_APPTRACE_LOG(LOG_FORMAT(_L_, format), esp_log_early_timestamp(), TAG, ##__VA_ARGS__); \
-        } \
-    } while(0)
-
-#define ESP_APPTRACE_LOGE( format, ... )  ESP_APPTRACE_LOG_LEV(E, ESP_LOG_ERROR, format, ##__VA_ARGS__)
-#define ESP_APPTRACE_LOGW( format, ... )  ESP_APPTRACE_LOG_LEV(W, ESP_LOG_WARN, format, ##__VA_ARGS__)
-#define ESP_APPTRACE_LOGI( format, ... )  ESP_APPTRACE_LOG_LEV(I, ESP_LOG_INFO, format, ##__VA_ARGS__)
-#define ESP_APPTRACE_LOGD( format, ... )  ESP_APPTRACE_LOG_LEV(D, ESP_LOG_DEBUG, format, ##__VA_ARGS__)
-#define ESP_APPTRACE_LOGV( format, ... )  ESP_APPTRACE_LOG_LEV(V, ESP_LOG_VERBOSE, format, ##__VA_ARGS__)
-#define ESP_APPTRACE_LOGO( format, ... )  ESP_APPTRACE_LOG_LEV(E, ESP_LOG_NONE, format, ##__VA_ARGS__)
-
-#ifdef __cplusplus
-}
-#endif
-
 #endif //ESP_APP_TRACE_UTIL_H_

components/app_trace/include/esp_sysview_trace.h

@@ -1,88 +0,0 @@
-// Copyright 2018 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-#ifndef ESP_SYSVIEW_TRACE_H_
-#define ESP_SYSVIEW_TRACE_H_
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#include <stdarg.h>
-#include "esp_err.h"
-#include "SEGGER_RTT.h" // SEGGER_RTT_ESP_Flush
-#include "esp_app_trace_util.h" // ESP_APPTRACE_TMO_INFINITE
-
-/**
- * @brief Flushes remaining data in SystemView trace buffer to host.
- *
- * @param tmo  Timeout for operation (in us). Use ESP_APPTRACE_TMO_INFINITE to wait indefinetly.
- *
- * @return ESP_OK.
- */
-static inline esp_err_t esp_sysview_flush(uint32_t tmo)
-{
-    SEGGER_RTT_ESP_Flush(0, tmo);
-    return ESP_OK;
-}
-
-/**
- * @brief vprintf-like function to sent log messages to the host.
- *
- * @param format  Address of format string.
- * @param args    List of arguments.
- *
- * @return Number of bytes written.
- */
-int esp_sysview_vprintf(const char * format, va_list args);
-
-/**
- * @brief  Starts SystemView heap tracing.
- *
- * @param tmo Timeout (in us) to wait for the host to be connected. Use -1 to wait forever.
- *
- * @return ESP_OK on success, ESP_ERR_TIMEOUT if operation has been timed out.
- */
-esp_err_t esp_sysview_heap_trace_start(uint32_t tmo);
-
-/**
- * @brief  Stops SystemView heap tracing.
- *
- * @return ESP_OK.
- */
-esp_err_t esp_sysview_heap_trace_stop(void);
-
-/**
- * @brief Sends heap allocation event to the host.
- *
- * @param addr      Address of allocated block.
- * @param size      Size of allocated block.
- * @param callers   Pointer to array with callstack addresses.
- *                  Array size must be CONFIG_HEAP_TRACING_STACK_DEPTH.
- */
-void esp_sysview_heap_trace_alloc(void *addr, uint32_t size, const void *callers);
-
-/**
- * @brief Sends heap de-allocation event to the host.
- *
- * @param addr      Address of de-allocated block.
- * @param callers   Pointer to array with callstack addresses.
- *                  Array size must be CONFIG_HEAP_TRACING_STACK_DEPTH.
- */
-void esp_sysview_heap_trace_free(void *addr, const void *callers);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif //ESP_SYSVIEW_TRACE_H_

components/app_trace/linker.lf

@@ -1,23 +1,12 @@
-[mapping:app_trace]
+[mapping]
 archive: libapp_trace.a
-entries:
-    app_trace (noflash)
-    app_trace_util (noflash)
-    if APPTRACE_MEMBUFS_APPTRACE_PROTO_ENABLE:
-      app_trace_membufs_proto (noflash)
-    if APPTRACE_DEST_JTAG = y:
-      port (noflash)
-    if APPTRACE_SV_ENABLE = y:
-      SEGGER_SYSVIEW (noflash)
-      SEGGER_RTT_esp (noflash)
-      SEGGER_SYSVIEW_Config_FreeRTOS (noflash)
-      SEGGER_SYSVIEW_FreeRTOS (noflash)
+entries: 
+    * (noflash)
 
-[mapping:app_trace_driver]
+[mapping]
 archive: libdriver.a
 entries:
-    if APPTRACE_SV_TS_SOURCE_TIMER_00 = y || APPTRACE_SV_TS_SOURCE_TIMER_01 = y
-       || APPTRACE_SV_TS_SOURCE_TIMER_10 = y || APPTRACE_SV_TS_SOURCE_TIMER_11 = y:
-      timer (noflash)
-    else:
-      * (default)
+    : SYSVIEW_TS_SOURCE_TIMER_00 = y || SYSVIEW_TS_SOURCE_TIMER_01 = y 
+      || SYSVIEW_TS_SOURCE_TIMER_10 = y || SYSVIEW_TS_SOURCE_TIMER_11 = y
+    timer (noflash)
+

components/app_trace/port/include/esp_app_trace_port.h

@@ -1,43 +0,0 @@
-// Copyright 2020 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-#ifndef ESP_APP_TRACE_PORT_H_
-#define ESP_APP_TRACE_PORT_H_
-
-#include "esp_app_trace_util.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/** Apptrace HW interface. */
-typedef struct {
-    esp_err_t (*init)(void *hw_data);
-    uint8_t *(*get_up_buffer)(void *hw_data, uint32_t, esp_apptrace_tmo_t *);
-    esp_err_t (*put_up_buffer)(void *hw_data, uint8_t *, esp_apptrace_tmo_t *);
-    esp_err_t (*flush_up_buffer_nolock)(void *hw_data, uint32_t, esp_apptrace_tmo_t *);
-    esp_err_t (*flush_up_buffer)(void *hw_data, esp_apptrace_tmo_t *);
-    void (*down_buffer_config)(void *hw_data, uint8_t *buf, uint32_t size);
-    uint8_t *(*get_down_buffer)(void *hw_data, uint32_t *, esp_apptrace_tmo_t *);
-    esp_err_t (*put_down_buffer)(void *hw_data, uint8_t *, esp_apptrace_tmo_t *);
-    bool (*host_is_connected)(void *hw_data);
-} esp_apptrace_hw_t;
-
-esp_apptrace_hw_t *esp_apptrace_jtag_hw_get(void **data);
-esp_apptrace_hw_t *esp_apptrace_uart_hw_get(int num, void **data);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif

components/app_trace/port/riscv/port.c

@@ -1,374 +0,0 @@
-#include "esp_log.h"
-#include "esp_app_trace_membufs_proto.h"
-#include "esp_app_trace_port.h"
-
-/** RISCV HW transport data */
-typedef struct {
-    uint8_t                             inited; // initialization state flags for every core
-#if CONFIG_APPTRACE_LOCK_ENABLE
-    esp_apptrace_lock_t                 lock;   // sync lock
-#endif
-    esp_apptrace_membufs_proto_data_t   membufs;
-} esp_apptrace_riscv_data_t;
-
-/** RISCV memory host iface control block */
-typedef struct {
-    uint32_t                    ctrl;
-    // - Guard field. If this register is not zero then CPU is changing this struct and
-    //   this guard field holds address of the instruction which application will execute when CPU finishes with those modifications.
-    uint32_t                    stat;
-    esp_apptrace_mem_block_t *  mem_blocks;
-} esp_apptrace_riscv_ctrl_block_t;
-
-#define RISCV_APPTRACE_SYSNR    0x64
-
-#define ESP_APPTRACE_RISCV_BLOCK_LEN_MSK         0x7FFFUL
-#define ESP_APPTRACE_RISCV_BLOCK_LEN(_l_)        ((_l_) & ESP_APPTRACE_RISCV_BLOCK_LEN_MSK)
-#define ESP_APPTRACE_RISCV_BLOCK_LEN_GET(_v_)    ((_v_) & ESP_APPTRACE_RISCV_BLOCK_LEN_MSK)
-#define ESP_APPTRACE_RISCV_BLOCK_ID_MSK          0x7FUL
-#define ESP_APPTRACE_RISCV_BLOCK_ID(_id_)        (((_id_) & ESP_APPTRACE_RISCV_BLOCK_ID_MSK) << 15)
-#define ESP_APPTRACE_RISCV_BLOCK_ID_GET(_v_)     (((_v_) >> 15) & ESP_APPTRACE_RISCV_BLOCK_ID_MSK)
-#define ESP_APPTRACE_RISCV_HOST_DATA             (1 << 22)
-#define ESP_APPTRACE_RISCV_HOST_CONNECT          (1 << 23)
-
-#define ESP_APPTRACE_RISCV_INITED(_hw_)          ((_hw_)->inited & (1 << 0/*cpu_hal_get_core_id()*/))
-
-static esp_err_t esp_apptrace_riscv_init(esp_apptrace_riscv_data_t *hw_data);
-static esp_err_t esp_apptrace_riscv_flush(esp_apptrace_riscv_data_t *hw_data, esp_apptrace_tmo_t *tmo);
-static esp_err_t esp_apptrace_riscv_flush_nolock(esp_apptrace_riscv_data_t *hw_data, uint32_t min_sz, esp_apptrace_tmo_t *tmo);
-static uint8_t *esp_apptrace_riscv_up_buffer_get(esp_apptrace_riscv_data_t *hw_data, uint32_t size, esp_apptrace_tmo_t *tmo);
-static esp_err_t esp_apptrace_riscv_up_buffer_put(esp_apptrace_riscv_data_t *hw_data, uint8_t *ptr, esp_apptrace_tmo_t *tmo);
-static void esp_apptrace_riscv_down_buffer_config(esp_apptrace_riscv_data_t *hw_data, uint8_t *buf, uint32_t size);
-static uint8_t *esp_apptrace_riscv_down_buffer_get(esp_apptrace_riscv_data_t *hw_data, uint32_t *size, esp_apptrace_tmo_t *tmo);
-static esp_err_t esp_apptrace_riscv_down_buffer_put(esp_apptrace_riscv_data_t *hw_data, uint8_t *ptr, esp_apptrace_tmo_t *tmo);
-static bool esp_apptrace_riscv_host_is_connected(esp_apptrace_riscv_data_t *hw_data);
-static esp_err_t esp_apptrace_riscv_buffer_swap_start(uint32_t curr_block_id);
-static esp_err_t esp_apptrace_riscv_buffer_swap(uint32_t new_block_id);
-static esp_err_t esp_apptrace_riscv_buffer_swap_end(uint32_t new_block_id, uint32_t prev_block_len);
-static bool esp_apptrace_riscv_host_data_pending(void);
-
-
-const static char *TAG = "esp_apptrace";
-
-static esp_apptrace_riscv_ctrl_block_t s_tracing_ctrl[portNUM_PROCESSORS];
-
-esp_apptrace_hw_t *esp_apptrace_uart_hw_get(int num, void **data)
-{
-    return NULL;
-}
-
-esp_apptrace_hw_t *esp_apptrace_jtag_hw_get(void **data)
-{
-#if CONFIG_APPTRACE_DEST_JTAG
-    static esp_apptrace_membufs_proto_hw_t s_trace_proto_hw = {
-        .swap_start = esp_apptrace_riscv_buffer_swap_start,
-        .swap = esp_apptrace_riscv_buffer_swap,
-        .swap_end = esp_apptrace_riscv_buffer_swap_end,
-        .host_data_pending = esp_apptrace_riscv_host_data_pending,
-    };
-    static esp_apptrace_riscv_data_t s_trace_hw_data = {
-        .membufs = {
-            .hw = &s_trace_proto_hw,
-        },
-    };
-    static esp_apptrace_hw_t s_trace_hw = {
-        .init = (esp_err_t (*)(void *))esp_apptrace_riscv_init,
-        .get_up_buffer = (uint8_t *(*)(void *, uint32_t, esp_apptrace_tmo_t *))esp_apptrace_riscv_up_buffer_get,
-        .put_up_buffer = (esp_err_t (*)(void *, uint8_t *, esp_apptrace_tmo_t *))esp_apptrace_riscv_up_buffer_put,
-        .flush_up_buffer_nolock = (esp_err_t (*)(void *, uint32_t, esp_apptrace_tmo_t *))esp_apptrace_riscv_flush_nolock,
-        .flush_up_buffer = (esp_err_t (*)(void *, esp_apptrace_tmo_t *))esp_apptrace_riscv_flush,
-        .down_buffer_config = (void (*)(void *, uint8_t *, uint32_t ))esp_apptrace_riscv_down_buffer_config,
-        .get_down_buffer = (uint8_t *(*)(void *, uint32_t *, esp_apptrace_tmo_t *))esp_apptrace_riscv_down_buffer_get,
-        .put_down_buffer = (esp_err_t (*)(void *, uint8_t *, esp_apptrace_tmo_t *))esp_apptrace_riscv_down_buffer_put,
-        .host_is_connected = (bool (*)(void *))esp_apptrace_riscv_host_is_connected,
-    };
-    *data = &s_trace_hw_data;
-    return &s_trace_hw;
-#else
-    return NULL;
-#endif
-}
-
-/* Advertises apptrace control block address to host.
-   This function can be overriden with custom implementation,
-   e.g. OpenOCD flasher stub use own implementation of it. */
-__attribute__((weak)) int esp_apptrace_advertise_ctrl_block(void *ctrl_block_addr)
-{
-    register int sys_nr = RISCV_APPTRACE_SYSNR;
-    register int host_ret = 0;
-
-    if (!esp_cpu_in_ocd_debug_mode()) {
-        return 0;
-    }
-    __asm__ volatile ( \
-        ".option push\n" \
-        ".option norvc\n" \
-        "mv a0, %[sys_nr]\n" \
-        "mv a1, %[arg1]\n" \
-        "slli    zero,zero,0x1f\n" \
-        "ebreak\n" \
-        "srai    zero,zero,0x7\n" \
-        "mv %[host_ret], a0\n" \
-    	".option pop\n" \
-        :[host_ret]"=r"(host_ret)
-        :[sys_nr]"r"(sys_nr),[arg1]"r"(ctrl_block_addr):"a0","a1");
-    return host_ret;
-}
-
-/* Returns up buffers config.
-   This function can be overriden with custom implementation,
-   e.g. OpenOCD flasher stub use own implementation of it. */
-__attribute__((weak)) void esp_apptrace_get_up_buffers(esp_apptrace_mem_block_t mem_blocks_cfg[2])
-{
-    static uint8_t s_mem_blocks[2][CONFIG_APPTRACE_BUF_SIZE];
-
-    mem_blocks_cfg[0].start = s_mem_blocks[0];
-    mem_blocks_cfg[0].sz = CONFIG_APPTRACE_BUF_SIZE;
-    mem_blocks_cfg[1].start = s_mem_blocks[1];
-    mem_blocks_cfg[1].sz = CONFIG_APPTRACE_BUF_SIZE;
-}
-
-static esp_err_t esp_apptrace_riscv_lock(esp_apptrace_riscv_data_t *hw_data, esp_apptrace_tmo_t *tmo)
-{
-#if CONFIG_APPTRACE_LOCK_ENABLE
-    esp_err_t ret = esp_apptrace_lock_take(&hw_data->lock, tmo);
-    if (ret != ESP_OK) {
-        return ESP_FAIL;
-    }
-#endif
-    return ESP_OK;
-}
-
-static esp_err_t esp_apptrace_riscv_unlock(esp_apptrace_riscv_data_t *hw_data)
-{
-    esp_err_t ret = ESP_OK;
-#if CONFIG_APPTRACE_LOCK_ENABLE
-    ret = esp_apptrace_lock_give(&hw_data->lock);
-#endif
-    return ret;
-}
-
-/*****************************************************************************************/
-/***************************** Apptrace HW iface *****************************************/
-/*****************************************************************************************/
-
-static esp_err_t esp_apptrace_riscv_init(esp_apptrace_riscv_data_t *hw_data)
-{
-    int core_id = cpu_hal_get_core_id();
-
-    if (hw_data->inited == 0) {
-        esp_apptrace_mem_block_t mem_blocks_cfg[2];
-        esp_apptrace_get_up_buffers(mem_blocks_cfg);
-        esp_err_t res = esp_apptrace_membufs_init(&hw_data->membufs, mem_blocks_cfg);
-        if (res != ESP_OK) {
-            ESP_APPTRACE_LOGE("Failed to init membufs proto (%d)!", res);
-            return res;
-        }
-#if CONFIG_APPTRACE_LOCK_ENABLE
-        esp_apptrace_lock_init(&hw_data->lock);
-#endif
-    }
-    hw_data->inited |= 1 << core_id;
-    ESP_APPTRACE_LOGI("Apptrace initialized on CPU%d. Tracing control block @ %p.", core_id, &s_tracing_ctrl[core_id]);
-    s_tracing_ctrl[core_id].mem_blocks = hw_data->membufs.blocks;
-    for (int i = 0; i < 2; i++) {
-        ESP_APPTRACE_LOGD("Mem buf[%d] %d bytes @ %p (%p/%p)", i,
-            s_tracing_ctrl[core_id].mem_blocks[i].sz, s_tracing_ctrl[core_id].mem_blocks[i].start,
-            &(s_tracing_ctrl[core_id].mem_blocks[i].start), &(s_tracing_ctrl[core_id].mem_blocks[i].sz));
-    }
-    // notify host about control block address
-    int res = esp_apptrace_advertise_ctrl_block(&s_tracing_ctrl[core_id]);
-    assert(res == 0 && "Falied to send config to host!");
-
-    return ESP_OK;
-}
-
-static uint8_t *esp_apptrace_riscv_up_buffer_get(esp_apptrace_riscv_data_t *hw_data, uint32_t size, esp_apptrace_tmo_t *tmo)
-{
-    uint8_t *ptr;
-
-    if (!ESP_APPTRACE_RISCV_INITED(hw_data)) {
-        return NULL;
-    }
-    esp_err_t res = esp_apptrace_riscv_lock(hw_data, tmo);
-    if (res != ESP_OK) {
-        return NULL;
-    }
-
-    ptr = esp_apptrace_membufs_up_buffer_get(&hw_data->membufs, size, tmo);
-
-    // now we can safely unlock apptrace to allow other tasks/ISRs to get other buffers and write their data
-    if (esp_apptrace_riscv_unlock(hw_data) != ESP_OK) {
-        assert(false && "Failed to unlock apptrace data!");
-    }
-    return ptr;
-}
-
-static esp_err_t esp_apptrace_riscv_up_buffer_put(esp_apptrace_riscv_data_t *hw_data, uint8_t *ptr, esp_apptrace_tmo_t *tmo)
-{
-    if (!ESP_APPTRACE_RISCV_INITED(hw_data)) {
-        return ESP_ERR_INVALID_STATE;
-    }
-    // Can avoid locking because esp_apptrace_membufs_up_buffer_put() just modifies buffer's header
-    esp_err_t res = esp_apptrace_membufs_up_buffer_put(&hw_data->membufs, ptr, tmo);
-    return res;
-}
-
-static void esp_apptrace_riscv_down_buffer_config(esp_apptrace_riscv_data_t *hw_data, uint8_t *buf, uint32_t size)
-{
-    if (!ESP_APPTRACE_RISCV_INITED(hw_data)) {
-        return;
-    }
-    esp_apptrace_membufs_down_buffer_config(&hw_data->membufs, buf, size);
-}
-
-static uint8_t *esp_apptrace_riscv_down_buffer_get(esp_apptrace_riscv_data_t *hw_data, uint32_t *size, esp_apptrace_tmo_t *tmo)
-{
-    uint8_t *ptr;
-
-    if (!ESP_APPTRACE_RISCV_INITED(hw_data)) {
-        return NULL;
-    }
-    esp_err_t res = esp_apptrace_riscv_lock(hw_data, tmo);
-    if (res != ESP_OK) {
-        return NULL;
-    }
-
-    ptr = esp_apptrace_membufs_down_buffer_get(&hw_data->membufs, size, tmo);
-
-    // now we can safely unlock apptrace to allow other tasks/ISRs to get other buffers and write their data
-    if (esp_apptrace_riscv_unlock(hw_data) != ESP_OK) {
-        assert(false && "Failed to unlock apptrace data!");
-    }
-    return ptr;
-}
-
-static esp_err_t esp_apptrace_riscv_down_buffer_put(esp_apptrace_riscv_data_t *hw_data, uint8_t *ptr, esp_apptrace_tmo_t *tmo)
-{
-    if (!ESP_APPTRACE_RISCV_INITED(hw_data)) {
-        return ESP_ERR_INVALID_STATE;
-    }
-    // Can avoid locking because esp_apptrace_membufs_down_buffer_put() does nothing
-    /*esp_err_t res = esp_apptrace_riscv_lock(hw_data, tmo);
-    if (res != ESP_OK) {
-        return res;
-    }*/
-
-    esp_err_t res = esp_apptrace_membufs_down_buffer_put(&hw_data->membufs, ptr, tmo);
-
-    // now we can safely unlock apptrace to allow other tasks/ISRs to get other buffers and write their data
-    /*if (esp_apptrace_riscv_unlock(hw_data) != ESP_OK) {
-        assert(false && "Failed to unlock apptrace data!");
-    }*/
-    return res;
-}
-
-static bool esp_apptrace_riscv_host_is_connected(esp_apptrace_riscv_data_t *hw_data)
-{
-    if (!ESP_APPTRACE_RISCV_INITED(hw_data)) {
-        return false;
-    }
-    return s_tracing_ctrl[cpu_hal_get_core_id()].ctrl & ESP_APPTRACE_RISCV_HOST_CONNECT ? true : false;
-}
-
-static esp_err_t esp_apptrace_riscv_flush_nolock(esp_apptrace_riscv_data_t *hw_data, uint32_t min_sz, esp_apptrace_tmo_t *tmo)
-{
-    if (!ESP_APPTRACE_RISCV_INITED(hw_data)) {
-        return ESP_ERR_INVALID_STATE;
-    }
-    return esp_apptrace_membufs_flush_nolock(&hw_data->membufs, min_sz, tmo);
-}
-
-static esp_err_t esp_apptrace_riscv_flush(esp_apptrace_riscv_data_t *hw_data, esp_apptrace_tmo_t *tmo)
-{
-    if (!ESP_APPTRACE_RISCV_INITED(hw_data)) {
-        return ESP_ERR_INVALID_STATE;
-    }
-    esp_err_t res = esp_apptrace_riscv_lock(hw_data, tmo);
-    if (res != ESP_OK) {
-        return res;
-    }
-
-    res = esp_apptrace_membufs_flush_nolock(&hw_data->membufs, 0, tmo);
-
-    // now we can safely unlock apptrace to allow other tasks/ISRs to get other buffers and write their data
-    if (esp_apptrace_riscv_unlock(hw_data) != ESP_OK) {
-        assert(false && "Failed to unlock apptrace data!");
-    }
-    return res;
-}
-
-/*****************************************************************************************/
-/************************** Membufs proto HW iface ***************************************/
-/*****************************************************************************************/
-
-static inline void esp_apptrace_riscv_buffer_swap_lock(void)
-{
-    extern uint32_t __esp_apptrace_riscv_updated;
-
-    // indicate to host that we are about to update.
-    // this is used only to place CPU into streaming mode at tracing startup
-    // before starting streaming host can halt us after we read  ESP_APPTRACE_RISCV_CTRL_REG and before we updated it
-    // HACK: in this case host will set breakpoint just after ESP_APPTRACE_RISCV_CTRL_REG update,
-    // here we set address to set bp at
-    // enter ERI update critical section
-    s_tracing_ctrl[cpu_hal_get_core_id()].stat = (uint32_t)&__esp_apptrace_riscv_updated;
-}
-
-static __attribute__((noinline)) void esp_apptrace_riscv_buffer_swap_unlock(void)
-{
-    // exit ERI update critical section
-    s_tracing_ctrl[cpu_hal_get_core_id()].stat = 0;
-    // TODO: currently host sets breakpoint, use break instruction to stop;
-    // it will allow to use ESP_APPTRACE_RISCV_STAT_REG for other purposes
-    asm volatile (
-        "    .global     __esp_apptrace_riscv_updated\n"
-        "__esp_apptrace_riscv_updated:\n"); // host will set bp here to resolve collision at streaming start
-}
-
-static esp_err_t esp_apptrace_riscv_buffer_swap_start(uint32_t curr_block_id)
-{
-    esp_err_t res = ESP_OK;
-
-    esp_apptrace_riscv_buffer_swap_lock();
-
-    uint32_t ctrl_reg = s_tracing_ctrl[cpu_hal_get_core_id()].ctrl;
-    uint32_t host_connected = ESP_APPTRACE_RISCV_HOST_CONNECT & ctrl_reg;
-    if (host_connected) {
-        uint32_t acked_block = ESP_APPTRACE_RISCV_BLOCK_ID_GET(ctrl_reg);
-        uint32_t host_to_read = ESP_APPTRACE_RISCV_BLOCK_LEN_GET(ctrl_reg);
-        if (host_to_read != 0 || acked_block != (curr_block_id & ESP_APPTRACE_RISCV_BLOCK_ID_MSK)) {
-            ESP_APPTRACE_LOGD("[%d]: Can not switch %x %d %x %x/%lx", cpu_hal_get_core_id(), ctrl_reg, host_to_read, acked_block,
-                curr_block_id & ESP_APPTRACE_RISCV_BLOCK_ID_MSK, curr_block_id);
-            res = ESP_ERR_NO_MEM;
-            goto _on_err;
-        }
-    }
-    return ESP_OK;
-_on_err:
-    esp_apptrace_riscv_buffer_swap_unlock();
-    return res;
-}
-
-static esp_err_t esp_apptrace_riscv_buffer_swap_end(uint32_t new_block_id, uint32_t prev_block_len)
-{
-    uint32_t ctrl_reg = s_tracing_ctrl[cpu_hal_get_core_id()].ctrl;
-    uint32_t host_connected = ESP_APPTRACE_RISCV_HOST_CONNECT & ctrl_reg;
-    s_tracing_ctrl[cpu_hal_get_core_id()].ctrl = ESP_APPTRACE_RISCV_BLOCK_ID(new_block_id) |
-              host_connected | ESP_APPTRACE_RISCV_BLOCK_LEN(prev_block_len);
-    esp_apptrace_riscv_buffer_swap_unlock();
-    return ESP_OK;
-}
-
-static esp_err_t esp_apptrace_riscv_buffer_swap(uint32_t new_block_id)
-{
-    /* do nothing */
-    return ESP_OK;
-}
-
-static bool esp_apptrace_riscv_host_data_pending(void)
-{
-    uint32_t ctrl_reg = s_tracing_ctrl[cpu_hal_get_core_id()].ctrl;
-    // ESP_APPTRACE_LOGV("%s() 0x%x", __func__, ctrl_reg);
-    return (ctrl_reg & ESP_APPTRACE_RISCV_HOST_DATA) ? true : false;
-}

components/app_trace/port/xtensa/port.c

@@ -1,543 +0,0 @@
-//
-// How It Works
-// ************
-
-// 1. Components Overview
-// ======================
-
-// Xtensa has useful feature: TRAX debug module. It allows recording program execution flow at run-time without disturbing CPU.
-// Exectution flow data are written to configurable Trace RAM block. Besides accessing Trace RAM itself TRAX module also allows to read/write
-// trace memory via its registers by means of JTAG, APB or ERI transactions.
-// ESP32 has two Xtensa cores with separate TRAX modules on them and provides two special memory regions to be used as trace memory.
-// Chip allows muxing access to those trace memory blocks in such a way that while one block is accessed by CPUs another one can be accessed by host
-// by means of reading/writing TRAX registers via JTAG. Blocks muxing is configurable at run-time and allows switching trace memory blocks between
-// accessors in round-robin fashion so they can read/write separate memory blocks without disturbing each other.
-// This module implements application tracing feature based on above mechanisms. It allows to transfer arbitrary user data to/from
-// host via JTAG with minimal impact on system performance. This module is implied to be used in the following tracing scheme.
-
-//                                                        ------>------                                         ----- (host components) -----
-//                                                        |           |                                         |                           |
-// -------------------   -----------------------     -----------------------     ----------------    ------     ---------   -----------------
-// |trace data source|-->|target tracing module|<--->|TRAX_MEM0 | TRAX_MEM1|---->|TRAX_DATA_REGS|<-->|JTAG|<--->|OpenOCD|-->|trace data sink|
-// -------------------   -----------------------     -----------------------     ----------------    ------     ---------   -----------------
-//                                 |                      |           |                                |
-//                                 |                      ------<------          ----------------      |
-//                                 |<------------------------------------------->|TRAX_CTRL_REGS|<---->|
-//                                                                               ----------------
-
-// In general tracing goes in the following way. User application requests tracing module to send some data by calling esp_apptrace_buffer_get(),
-// module allocates necessary buffer in current input trace block. Then user fills received buffer with data and calls esp_apptrace_buffer_put().
-// When current input trace block is filled with app data it is exposed to host and the second block becomes input one and buffer filling restarts.
-// While target application fills one TRAX block host reads another one via JTAG.
-// This module also allows communication in the opposite direction: from host to target. As it was said ESP32 and host can access different TRAX blocks
-// simultaneously, so while target writes trace data to one block host can write its own data (e.g. tracing commands) to another one then when
-// blocks are switched host receives trace data and target receives data written by host application. Target user application can read host data
-// by calling esp_apptrace_read() API.
-// To control buffer switching and for other communication purposes this implementation uses some TRAX registers. It is safe since HW TRAX tracing
-// can not be used along with application tracing feature so these registers are freely readable/writeable via JTAG from host and via ERI from ESP32 cores.
-// Overhead of this implementation on target CPU is produced only by allocating/managing buffers and copying of data.
-// On the host side special OpenOCD command must be used to read trace data.
-
-// 2. TRAX Registers layout
-// ========================
-
-// This module uses two TRAX HW registers to communicate with host SW (OpenOCD).
-//  - Control register uses TRAX_DELAYCNT as storage. Only lower 24 bits of TRAX_DELAYCNT are writable. Control register has the following bitfields:
-//   | 31..XXXXXX..24 | 23 .(host_connect). 23| 22..(block_id)..15 | 14..(block_len)..0 |
-//    14..0  bits - actual length of user data in trace memory block. Target updates it every time it fills memory block and exposes it to host.
-//                  Host writes zero to this field when it finishes reading exposed block;
-//    21..15 bits - trace memory block transfer ID. Block counter. It can overflow. Updated by target, host should not modify it. Actually can be 2 bits;
-//    22     bit  - 'host data present' flag. If set to one there is data from host, otherwise - no host data;
-//    23     bit  - 'host connected' flag. If zero then host is not connected and tracing module works in post-mortem mode, otherwise in streaming mode;
-// - Status register uses TRAX_TRIGGERPC as storage. If this register is not zero then current CPU is changing TRAX registers and
-//   this register holds address of the instruction which application will execute when it finishes with those registers modifications.
-//   See 'Targets Connection' setion for details.
-
-// 3. Modes of operation
-// =====================
-
-// This module supports two modes of operation:
-//  - Post-mortem mode. This is the default mode. In this mode application tracing module does not check whether host has read all the data from block
-//    exposed to it and switches block in any case. The mode does not need host interaction for operation and so can be useful when only the latest
-//    trace data are necessary, e.g. for analyzing crashes. On panic the latest data from current input block are exposed to host and host can read them.
-//    It can happen that system panic occurs when there are very small amount of data which are not exposed to host yet (e.g. crash just after the
-//    TRAX block switch). In this case the previous 16KB of collected data will be dropped and host will see the latest, but very small piece of trace.
-//    It can be insufficient to diagnose the problem. To avoid such situations there is menuconfig option
-//    CONFIG_APPTRACE_POSTMORTEM_FLUSH_THRESH
-//    which controls the threshold for flushing data in case of panic.
-//  - Streaming mode. Tracing module enters this mode when host connects to target and sets respective bits in control registers (per core).
-//    In this mode before switching the block tracing module waits for the host to read all the data from the previously exposed block.
-//    On panic tracing module also waits (timeout is configured via menuconfig via CONFIG_APPTRACE_ONPANIC_HOST_FLUSH_TMO) for the host to read all data.
-
-// 4. Communication Protocol
-// =========================
-
-// 4.1 Trace Memory Blocks
-// -----------------------
-
-// Communication is controlled via special register. Host periodically polls control register on each core to find out if there are any data available.
-// When current input memory block is filled it is exposed to host and 'block_len' and 'block_id' fields are updated in the control register.
-// Host reads new register value and according to it's value starts reading data from exposed block. Meanwhile target starts filling another trace block.
-// When host finishes reading the block it clears 'block_len' field in control register indicating to the target that it is ready to accept the next one.
-// If the host has some data to transfer to the target it writes them to trace memory block before clearing 'block_len' field. Then it sets
-// 'host_data_present' bit and clears 'block_len' field in control register. Upon every block switch target checks 'host_data_present' bit and if it is set
-// reads them to down buffer before writing any trace data to switched TRAX block.
-
-// 4.2 User Data Chunks Level
-// --------------------------
-
-// Since trace memory block is shared between user data chunks and data copying is performed on behalf of the API user (in its normal context) in
-// multithreading environment it can happen that task/ISR which copies data is preempted by another high prio task/ISR. So it is possible situation
-// that task/ISR will fail to complete filling its data chunk before the whole trace block is exposed to the host. To handle such conditions tracing
-// module prepends all user data chunks with header which contains allocated buffer size and actual data length within it. OpenOCD command
-// which reads application traces reports error when it reads incomplete user data block.
-// Data which are transffered from host to target are also prepended with a header. Down channel data header is simple and consists of one two bytes field
-// containing length of host data following the header.
-
-// 4.3 Data Buffering
-// ------------------
-
-// It takes some time for the host to read TRAX memory block via JTAG. In streaming mode it can happen that target has filled its TRAX block, but host
-// has not completed reading of the previous one yet. So in this case time critical tracing calls (which can not be delayed for too long time due to
-// the lack of free memory in TRAX block) can be dropped. To avoid such scenarios tracing module implements data buffering. Buffered data will be sent
-// to the host later when TRAX block switch occurs. The maximum size of the buffered data is controlled by menuconfig option
-// CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX.
-
-// 4.4 Target Connection/Disconnection
-// -----------------------------------
-
-// When host is going to start tracing in streaming mode it needs to put both ESP32 cores into initial state when 'host connected' bit is set
-// on both cores. To accomplish this host halts both cores and sets this bit in TRAX registers. But target code can be halted in state when it has read control
-// register but has not updated its value. To handle such situations target code indicates to the host that it is updating control register by writing
-// non-zero value to status register. Actually it writes address of the instruction which it will execute when it finishes with
-// the registers update. When target is halted during control register update host sets breakpoint at the address from status register and resumes CPU.
-// After target code finishes with register update it is halted on breakpoint, host detects it and safely sets 'host connected' bit. When both cores
-// are set up they are resumed. Tracing starts without further intrusion into CPUs work.
-// When host is going to stop tracing in streaming mode it needs to disconnect targets. Disconnection process is done using the same algorithm
-// as for connecting, but 'host connected' bits are cleared on ESP32 cores.
-
-// 5. Module Access Synchronization
-// ================================
-
-// Access to internal module's data is synchronized with custom mutex. Mutex is a wrapper for portMUX_TYPE and uses almost the same sync mechanism as in
-// vPortCPUAcquireMutex/vPortCPUReleaseMutex. The mechanism uses S32C1I Xtensa instruction to implement exclusive access to module's data from tasks and
-// ISRs running on both cores. Also custom mutex allows specifying timeout for locking operation. Locking routine checks underlaying mutex in cycle until
-// it gets its ownership or timeout expires. The differences of application tracing module's mutex implementation from vPortCPUAcquireMutex/vPortCPUReleaseMutex are:
-// - Support for timeouts.
-// - Local IRQs for CPU which owns the mutex are disabled till the call to unlocking routine. This is made to avoid possible task's prio inversion.
-//   When low prio task takes mutex and enables local IRQs gets preempted by high prio task which in its turn can try to acquire mutex using infinite timeout.
-//   So no local task switch occurs when mutex is locked. But this does not apply to tasks on another CPU.
-//   WARNING: Priority inversion can happen when low prio task works on one CPU and medium and high prio tasks work on another.
-// WARNING: Care must be taken when selecting timeout values for trace calls from ISRs. Tracing module does not care about watchdogs when waiting
-// on internal locks and for host to complete previous block reading, so if timeout value exceeds watchdog's one it can lead to the system reboot.
-
-// 6. Timeouts
-// ===========
-
-// Timeout mechanism is based on xthal_get_ccount() routine and supports timeout values in microseconds.
-// There are two situations when task/ISR can be delayed by tracing API call. Timeout mechanism takes into account both conditions:
-// - Trace data are locked by another task/ISR. When wating on trace data lock.
-// - Current TRAX memory input block is full when working in streaming mode (host is connected). When waiting for host to complete previous block reading.
-// When wating for any of above conditions xthal_get_ccount() is called periodically to calculate time elapsed from trace API routine entry. When elapsed
-// time exceeds specified timeout value operation is canceled and ESP_ERR_TIMEOUT code is returned.
-#include "sdkconfig.h"
-#include "soc/soc.h"
-#include "soc/dport_access.h"
-#if CONFIG_IDF_TARGET_ESP32
-#include "soc/dport_reg.h"
-#elif CONFIG_IDF_TARGET_ESP32S2
-#include "soc/sensitive_reg.h"
-#endif
-#include "eri.h"
-#include "trax.h"
-#include "esp_log.h"
-#include "esp_app_trace_membufs_proto.h"
-#include "esp_app_trace_port.h"
-
-// TODO: move these (and same definitions in trax.c to dport_reg.h)
-#if CONFIG_IDF_TARGET_ESP32
-#define TRACEMEM_MUX_PROBLK0_APPBLK1            0
-#define TRACEMEM_MUX_BLK0_ONLY                  1
-#define TRACEMEM_MUX_BLK1_ONLY                  2
-#define TRACEMEM_MUX_PROBLK1_APPBLK0            3
-#elif CONFIG_IDF_TARGET_ESP32S2
-#define TRACEMEM_MUX_BLK0_NUM                   19
-#define TRACEMEM_MUX_BLK1_NUM                   20
-#define TRACEMEM_BLK_NUM2ADDR(_n_)              (0x3FFB8000UL + 0x4000UL*((_n_)-4))
-#endif
-
-// TRAX is disabled, so we use its registers for our own purposes
-// | 31..XXXXXX..24 | 23 .(host_connect). 23 | 22 .(host_data). 22| 21..(block_id)..15 | 14..(block_len)..0 |
-#define ESP_APPTRACE_TRAX_CTRL_REG              ERI_TRAX_DELAYCNT
-#define ESP_APPTRACE_TRAX_STAT_REG              ERI_TRAX_TRIGGERPC
-
-#define ESP_APPTRACE_TRAX_BLOCK_LEN_MSK         0x7FFFUL
-#define ESP_APPTRACE_TRAX_BLOCK_LEN(_l_)        ((_l_) & ESP_APPTRACE_TRAX_BLOCK_LEN_MSK)
-#define ESP_APPTRACE_TRAX_BLOCK_LEN_GET(_v_)    ((_v_) & ESP_APPTRACE_TRAX_BLOCK_LEN_MSK)
-#define ESP_APPTRACE_TRAX_BLOCK_ID_MSK          0x7FUL
-#define ESP_APPTRACE_TRAX_BLOCK_ID(_id_)        (((_id_) & ESP_APPTRACE_TRAX_BLOCK_ID_MSK) << 15)
-#define ESP_APPTRACE_TRAX_BLOCK_ID_GET(_v_)     (((_v_) >> 15) & ESP_APPTRACE_TRAX_BLOCK_ID_MSK)
-#define ESP_APPTRACE_TRAX_HOST_DATA             (1 << 22)
-#define ESP_APPTRACE_TRAX_HOST_CONNECT          (1 << 23)
-
-#define ESP_APPTRACE_TRAX_INITED(_hw_)          ((_hw_)->inited & (1 << cpu_hal_get_core_id()))
-
-#if CONFIG_IDF_TARGET_ESP32
-static uint8_t * const s_trax_blocks[] = {
-    (uint8_t *) 0x3FFFC000,
-    (uint8_t *) 0x3FFF8000
-};
-#elif CONFIG_IDF_TARGET_ESP32S2
-static uint8_t * const s_trax_blocks[] = {
-    (uint8_t *)TRACEMEM_BLK_NUM2ADDR(TRACEMEM_MUX_BLK0_NUM),
-    (uint8_t *)TRACEMEM_BLK_NUM2ADDR(TRACEMEM_MUX_BLK1_NUM)
-};
-#endif
-
-#define ESP_APPTRACE_TRAX_BLOCK_SIZE            (0x4000UL)
-
-/** TRAX HW transport data */
-typedef struct {
-    uint8_t                             inited;
-#if CONFIG_APPTRACE_LOCK_ENABLE
-    esp_apptrace_lock_t                 lock;   // sync lock
-#endif
-    esp_apptrace_membufs_proto_data_t   membufs;
-} esp_apptrace_trax_data_t;
-
-
-static esp_err_t esp_apptrace_trax_init(esp_apptrace_trax_data_t *hw_data);
-static esp_err_t esp_apptrace_trax_flush(esp_apptrace_trax_data_t *hw_data, esp_apptrace_tmo_t *tmo);
-static esp_err_t esp_apptrace_trax_flush_nolock(esp_apptrace_trax_data_t *hw_data, uint32_t min_sz, esp_apptrace_tmo_t *tmo);
-static uint8_t *esp_apptrace_trax_up_buffer_get(esp_apptrace_trax_data_t *hw_data, uint32_t size, esp_apptrace_tmo_t *tmo);
-static esp_err_t esp_apptrace_trax_up_buffer_put(esp_apptrace_trax_data_t *hw_data, uint8_t *ptr, esp_apptrace_tmo_t *tmo);
-static void esp_apptrace_trax_down_buffer_config(esp_apptrace_trax_data_t *hw_data, uint8_t *buf, uint32_t size);
-static uint8_t *esp_apptrace_trax_down_buffer_get(esp_apptrace_trax_data_t *hw_data, uint32_t *size, esp_apptrace_tmo_t *tmo);
-static esp_err_t esp_apptrace_trax_down_buffer_put(esp_apptrace_trax_data_t *hw_data, uint8_t *ptr, esp_apptrace_tmo_t *tmo);
-static bool esp_apptrace_trax_host_is_connected(esp_apptrace_trax_data_t *hw_data);
-static esp_err_t esp_apptrace_trax_buffer_swap_start(uint32_t curr_block_id);
-static esp_err_t esp_apptrace_trax_buffer_swap(uint32_t new_block_id);
-static esp_err_t esp_apptrace_trax_buffer_swap_end(uint32_t new_block_id, uint32_t prev_block_len);
-static bool esp_apptrace_trax_host_data_pending(void);
-
-
-const static char *TAG = "esp_apptrace";
-
-esp_apptrace_hw_t *esp_apptrace_uart_hw_get(int num, void **data)
-{
-    return NULL;
-}
-
-esp_apptrace_hw_t *esp_apptrace_jtag_hw_get(void **data)
-{
-#if CONFIG_APPTRACE_DEST_JTAG
-    static esp_apptrace_membufs_proto_hw_t s_trax_proto_hw = {
-        .swap_start = esp_apptrace_trax_buffer_swap_start,
-        .swap = esp_apptrace_trax_buffer_swap,
-        .swap_end = esp_apptrace_trax_buffer_swap_end,
-        .host_data_pending = esp_apptrace_trax_host_data_pending,
-    };
-    static esp_apptrace_trax_data_t s_trax_hw_data = {
-        .membufs = {
-            .hw = &s_trax_proto_hw,
-        },
-    };
-    static esp_apptrace_hw_t s_trax_hw = {
-        .init = (esp_err_t (*)(void *))esp_apptrace_trax_init,
-        .get_up_buffer = (uint8_t *(*)(void *, uint32_t, esp_apptrace_tmo_t *))esp_apptrace_trax_up_buffer_get,
-        .put_up_buffer = (esp_err_t (*)(void *, uint8_t *, esp_apptrace_tmo_t *))esp_apptrace_trax_up_buffer_put,
-        .flush_up_buffer_nolock = (esp_err_t (*)(void *, uint32_t, esp_apptrace_tmo_t *))esp_apptrace_trax_flush_nolock,
-        .flush_up_buffer = (esp_err_t (*)(void *, esp_apptrace_tmo_t *))esp_apptrace_trax_flush,
-        .down_buffer_config = (void (*)(void *, uint8_t *, uint32_t ))esp_apptrace_trax_down_buffer_config,
-        .get_down_buffer = (uint8_t *(*)(void *, uint32_t *, esp_apptrace_tmo_t *))esp_apptrace_trax_down_buffer_get,
-        .put_down_buffer = (esp_err_t (*)(void *, uint8_t *, esp_apptrace_tmo_t *))esp_apptrace_trax_down_buffer_put,
-        .host_is_connected = (bool (*)(void *))esp_apptrace_trax_host_is_connected,
-    };
-    *data = &s_trax_hw_data;
-    return &s_trax_hw;
-#else
-    return NULL;
-#endif
-}
-
-static esp_err_t esp_apptrace_trax_lock(esp_apptrace_trax_data_t *hw_data, esp_apptrace_tmo_t *tmo)
-{
-#if CONFIG_APPTRACE_LOCK_ENABLE
-    esp_err_t ret = esp_apptrace_lock_take(&hw_data->lock, tmo);
-    if (ret != ESP_OK) {
-        return ESP_FAIL;
-    }
-#endif
-    return ESP_OK;
-}
-
-static esp_err_t esp_apptrace_trax_unlock(esp_apptrace_trax_data_t *hw_data)
-{
-    esp_err_t ret = ESP_OK;
-#if CONFIG_APPTRACE_LOCK_ENABLE
-    ret = esp_apptrace_lock_give(&hw_data->lock);
-#endif
-    return ret;
-}
-
-static inline void esp_apptrace_trax_hw_init(void)
-{
-    // Stop trace, if any (on the current CPU)
-    eri_write(ERI_TRAX_TRAXCTRL, TRAXCTRL_TRSTP);
-    eri_write(ERI_TRAX_TRAXCTRL, TRAXCTRL_TMEN);
-    eri_write(ESP_APPTRACE_TRAX_CTRL_REG, ESP_APPTRACE_TRAX_BLOCK_ID(0));
-    // this is for OpenOCD to let him know where stub entries vector is resided
-    // must be read by host before any transfer using TRAX
-    eri_write(ESP_APPTRACE_TRAX_STAT_REG, 0);
-
-    ESP_APPTRACE_LOGI("Initialized TRAX on CPU%d", cpu_hal_get_core_id());
-}
-
-static inline void esp_apptrace_trax_select_memory_block(int block_num)
-{
-    // select memory block to be exposed to the TRAX module (accessed by host)
-#if CONFIG_IDF_TARGET_ESP32
-    DPORT_WRITE_PERI_REG(DPORT_TRACEMEM_MUX_MODE_REG, block_num ? TRACEMEM_MUX_BLK0_ONLY : TRACEMEM_MUX_BLK1_ONLY);
-#elif CONFIG_IDF_TARGET_ESP32S2
-    WRITE_PERI_REG(DPORT_PMS_OCCUPY_3_REG, block_num ? BIT(TRACEMEM_MUX_BLK0_NUM-4) : BIT(TRACEMEM_MUX_BLK1_NUM-4));
-#endif
-}
-
-static inline void esp_apptrace_trax_memory_enable(void)
-{
-#if CONFIG_IDF_TARGET_ESP32
-        /* Enable trace memory on PRO CPU */
-        DPORT_WRITE_PERI_REG(DPORT_PRO_TRACEMEM_ENA_REG, DPORT_PRO_TRACEMEM_ENA_M);
-#if CONFIG_FREERTOS_UNICORE == 0
-        /* Enable trace memory on APP CPU */
-        DPORT_WRITE_PERI_REG(DPORT_APP_TRACEMEM_ENA_REG, DPORT_APP_TRACEMEM_ENA_M);
-#endif
-#endif
-}
-
-/*****************************************************************************************/
-/***************************** Apptrace HW iface *****************************************/
-/*****************************************************************************************/
-
-static esp_err_t esp_apptrace_trax_init(esp_apptrace_trax_data_t *hw_data)
-{
-    int core_id = cpu_hal_get_core_id();
-
-    // 'esp_apptrace_trax_init()' is called on every core, so ensure to do main initialization only once
-    if (core_id == 0) {
-        esp_apptrace_mem_block_t mem_blocks_cfg[2] = {
-            {
-                .start = s_trax_blocks[0],
-                .sz = ESP_APPTRACE_TRAX_BLOCK_SIZE
-            },
-            {
-                .start = s_trax_blocks[1],
-                .sz = ESP_APPTRACE_TRAX_BLOCK_SIZE
-            },
-        };
-        esp_err_t res = esp_apptrace_membufs_init(&hw_data->membufs, mem_blocks_cfg);
-        if (res != ESP_OK) {
-            ESP_APPTRACE_LOGE("Failed to init membufs proto (%d)!", res);
-            return res;
-        }
-#if CONFIG_APPTRACE_LOCK_ENABLE
-        esp_apptrace_lock_init(&hw_data->lock);
-#endif
-        esp_apptrace_trax_memory_enable();
-        esp_apptrace_trax_select_memory_block(0);
-    }
-    // init TRAX on this CPU
-    esp_apptrace_trax_hw_init();
-    hw_data->inited |= 1 << core_id;
-
-    return ESP_OK;
-}
-
-static uint8_t *esp_apptrace_trax_up_buffer_get(esp_apptrace_trax_data_t *hw_data, uint32_t size, esp_apptrace_tmo_t *tmo)
-{
-    uint8_t *ptr;
-
-    if (!ESP_APPTRACE_TRAX_INITED(hw_data)) {
-        return NULL;
-    }
-    esp_err_t res = esp_apptrace_trax_lock(hw_data, tmo);
-    if (res != ESP_OK) {
-        return NULL;
-    }
-
-    ptr = esp_apptrace_membufs_up_buffer_get(&hw_data->membufs, size, tmo);
-
-    // now we can safely unlock apptrace to allow other tasks/ISRs to get other buffers and write their data
-    if (esp_apptrace_trax_unlock(hw_data) != ESP_OK) {
-        assert(false && "Failed to unlock apptrace data!");
-    }
-    return ptr;
-}
-
-static esp_err_t esp_apptrace_trax_up_buffer_put(esp_apptrace_trax_data_t *hw_data, uint8_t *ptr, esp_apptrace_tmo_t *tmo)
-{
-    if (!ESP_APPTRACE_TRAX_INITED(hw_data)) {
-        return ESP_ERR_INVALID_STATE;
-    }
-    // Can avoid locking because esp_apptrace_membufs_up_buffer_put() just modifies buffer's header
-    esp_err_t res = esp_apptrace_membufs_up_buffer_put(&hw_data->membufs, ptr, tmo);
-    return res;
-}
-
-static void esp_apptrace_trax_down_buffer_config(esp_apptrace_trax_data_t *hw_data, uint8_t *buf, uint32_t size)
-{
-    if (!ESP_APPTRACE_TRAX_INITED(hw_data)) {
-        return;
-    }
-    esp_apptrace_membufs_down_buffer_config(&hw_data->membufs, buf, size);
-}
-
-static uint8_t *esp_apptrace_trax_down_buffer_get(esp_apptrace_trax_data_t *hw_data, uint32_t *size, esp_apptrace_tmo_t *tmo)
-{
-    uint8_t *ptr;
-
-    if (!ESP_APPTRACE_TRAX_INITED(hw_data)) {
-        return NULL;
-    }
-    esp_err_t res = esp_apptrace_trax_lock(hw_data, tmo);
-    if (res != ESP_OK) {
-        return NULL;
-    }
-
-    ptr = esp_apptrace_membufs_down_buffer_get(&hw_data->membufs, size, tmo);
-
-    // now we can safely unlock apptrace to allow other tasks/ISRs to get other buffers and write their data
-    if (esp_apptrace_trax_unlock(hw_data) != ESP_OK) {
-        assert(false && "Failed to unlock apptrace data!");
-    }
-    return ptr;
-}
-
-static esp_err_t esp_apptrace_trax_down_buffer_put(esp_apptrace_trax_data_t *hw_data, uint8_t *ptr, esp_apptrace_tmo_t *tmo)
-{
-    if (!ESP_APPTRACE_TRAX_INITED(hw_data)) {
-        return ESP_ERR_INVALID_STATE;
-    }
-    // Can avoid locking because esp_apptrace_membufs_down_buffer_put() does nothing
-    /*esp_err_t res = esp_apptrace_trax_lock(hw_data, tmo);
-    if (res != ESP_OK) {
-        return res;
-    }*/
-
-    esp_err_t res = esp_apptrace_membufs_down_buffer_put(&hw_data->membufs, ptr, tmo);
-
-    // now we can safely unlock apptrace to allow other tasks/ISRs to get other buffers and write their data
-    /*if (esp_apptrace_trax_unlock(hw_data) != ESP_OK) {
-        assert(false && "Failed to unlock apptrace data!");
-    }*/
-    return res;
-}
-
-static bool esp_apptrace_trax_host_is_connected(esp_apptrace_trax_data_t *hw_data)
-{
-    if (!ESP_APPTRACE_TRAX_INITED(hw_data)) {
-        return false;
-    }
-    return eri_read(ESP_APPTRACE_TRAX_CTRL_REG) & ESP_APPTRACE_TRAX_HOST_CONNECT ? true : false;
-}
-
-static esp_err_t esp_apptrace_trax_flush_nolock(esp_apptrace_trax_data_t *hw_data, uint32_t min_sz, esp_apptrace_tmo_t *tmo)
-{
-    if (!ESP_APPTRACE_TRAX_INITED(hw_data)) {
-        return ESP_ERR_INVALID_STATE;
-    }
-    return esp_apptrace_membufs_flush_nolock(&hw_data->membufs, min_sz, tmo);
-}
-
-static esp_err_t esp_apptrace_trax_flush(esp_apptrace_trax_data_t *hw_data, esp_apptrace_tmo_t *tmo)
-{
-    if (!ESP_APPTRACE_TRAX_INITED(hw_data)) {
-        return ESP_ERR_INVALID_STATE;
-    }
-    esp_err_t res = esp_apptrace_trax_lock(hw_data, tmo);
-    if (res != ESP_OK) {
-        return res;
-    }
-
-    res = esp_apptrace_membufs_flush_nolock(&hw_data->membufs, 0, tmo);
-
-    // now we can safely unlock apptrace to allow other tasks/ISRs to get other buffers and write their data
-    if (esp_apptrace_trax_unlock(hw_data) != ESP_OK) {
-        assert(false && "Failed to unlock apptrace data!");
-    }
-    return res;
-}
-
-/*****************************************************************************************/
-/************************** Membufs proto HW iface ***************************************/
-/*****************************************************************************************/
-
-static inline void esp_apptrace_trax_buffer_swap_lock(void)
-{
-    extern uint32_t __esp_apptrace_trax_eri_updated;
-
-    // indicate to host that we are about to update.
-    // this is used only to place CPU into streaming mode at tracing startup
-    // before starting streaming host can halt us after we read  ESP_APPTRACE_TRAX_CTRL_REG and before we updated it
-    // HACK: in this case host will set breakpoint just after ESP_APPTRACE_TRAX_CTRL_REG update,
-    // here we set address to set bp at
-    // enter ERI update critical section
-    eri_write(ESP_APPTRACE_TRAX_STAT_REG, (uint32_t)&__esp_apptrace_trax_eri_updated);
-}
-
-static __attribute__((noinline)) void esp_apptrace_trax_buffer_swap_unlock(void)
-{
-    // exit ERI update critical section
-    eri_write(ESP_APPTRACE_TRAX_STAT_REG, 0x0);
-    // TODO: currently host sets breakpoint, use break instruction to stop;
-    // it will allow to use ESP_APPTRACE_TRAX_STAT_REG for other purposes
-    asm volatile (
-        "    .global     __esp_apptrace_trax_eri_updated\n"
-        "__esp_apptrace_trax_eri_updated:\n"); // host will set bp here to resolve collision at streaming start
-}
-
-static esp_err_t esp_apptrace_trax_buffer_swap_start(uint32_t curr_block_id)
-{
-    esp_err_t res = ESP_OK;
-
-    esp_apptrace_trax_buffer_swap_lock();
-
-    uint32_t ctrl_reg = eri_read(ESP_APPTRACE_TRAX_CTRL_REG);
-    uint32_t host_connected = ESP_APPTRACE_TRAX_HOST_CONNECT & ctrl_reg;
-    if (host_connected) {
-        uint32_t acked_block = ESP_APPTRACE_TRAX_BLOCK_ID_GET(ctrl_reg);
-        uint32_t host_to_read = ESP_APPTRACE_TRAX_BLOCK_LEN_GET(ctrl_reg);
-        if (host_to_read != 0 || acked_block != (curr_block_id & ESP_APPTRACE_TRAX_BLOCK_ID_MSK)) {
-            ESP_APPTRACE_LOGD("HC[%d]: Can not switch %x %d %x %x/%lx", cpu_hal_get_core_id(), ctrl_reg, host_to_read, acked_block,
-                curr_block_id & ESP_APPTRACE_TRAX_BLOCK_ID_MSK, curr_block_id);
-            res = ESP_ERR_NO_MEM;
-            goto _on_err;
-        }
-    }
-    return ESP_OK;
-_on_err:
-    esp_apptrace_trax_buffer_swap_unlock();
-    return res;
-}
-
-static esp_err_t esp_apptrace_trax_buffer_swap_end(uint32_t new_block_id, uint32_t prev_block_len)
-{
-    uint32_t ctrl_reg = eri_read(ESP_APPTRACE_TRAX_CTRL_REG);
-    uint32_t host_connected = ESP_APPTRACE_TRAX_HOST_CONNECT & ctrl_reg;
-    eri_write(ESP_APPTRACE_TRAX_CTRL_REG, ESP_APPTRACE_TRAX_BLOCK_ID(new_block_id) |
-              host_connected | ESP_APPTRACE_TRAX_BLOCK_LEN(prev_block_len));
-    esp_apptrace_trax_buffer_swap_unlock();
-    return ESP_OK;
-}
-
-static esp_err_t esp_apptrace_trax_buffer_swap(uint32_t new_block_id)
-{
-    esp_apptrace_trax_select_memory_block(new_block_id);
-    return ESP_OK;
-}
-
-static bool esp_apptrace_trax_host_data_pending(void)
-{
-    uint32_t ctrl_reg = eri_read(ESP_APPTRACE_TRAX_CTRL_REG);
-    return (ctrl_reg & ESP_APPTRACE_TRAX_HOST_DATA) ? true : false;
-}

components/app_trace/private_include/esp_app_trace_membufs_proto.h

@@ -1,70 +0,0 @@
-// Copyright 2020 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-#ifndef ESP_APP_TRACE_MEMBUFS_PROTO_H_
-#define ESP_APP_TRACE_MEMBUFS_PROTO_H_
-
-#include "esp_app_trace_util.h"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/** TRAX HW transport state */
-typedef struct {
-    uint32_t                   in_block;     // input block ID
-    // TODO: change to uint16_t
-    uint32_t                   markers[2];   // block filling level markers
-} esp_apptrace_membufs_state_t;
-
-/** memory block parameters,
- * should be packed, because it is read from the host */
-typedef struct {
-    uint8_t   *start;   // start address
-    uint32_t   sz;      // size
-} esp_apptrace_mem_block_t;
-
-typedef struct {
-    esp_err_t (*swap_start)(uint32_t curr_block_id);
-    esp_err_t (*swap)(uint32_t new_block_id);
-    esp_err_t (*swap_end)(uint32_t new_block_id, uint32_t prev_block_len);
-    bool (*host_data_pending)(void);
-} esp_apptrace_membufs_proto_hw_t;
-
-typedef struct {
-    esp_apptrace_membufs_proto_hw_t *       hw;
-    volatile esp_apptrace_membufs_state_t   state;       // state
-    esp_apptrace_mem_block_t                blocks[2];   // memory blocks
-#if CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX > 0
-    // ring buffer control struct for pending user blocks
-    esp_apptrace_rb_t                   rb_pend;
-    // storage for pending user blocks
-    uint8_t                             pending_data[CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX + 1];
-#endif
-    // ring buffer control struct for data from host (down buffer)
-    esp_apptrace_rb_t                       rb_down;
-} esp_apptrace_membufs_proto_data_t;
-
-esp_err_t esp_apptrace_membufs_init(esp_apptrace_membufs_proto_data_t *proto, const esp_apptrace_mem_block_t blocks_cfg[2]);
-void esp_apptrace_membufs_down_buffer_config(esp_apptrace_membufs_proto_data_t *data, uint8_t *buf, uint32_t size);
-uint8_t *esp_apptrace_membufs_down_buffer_get(esp_apptrace_membufs_proto_data_t *proto, uint32_t *size, esp_apptrace_tmo_t *tmo);
-esp_err_t esp_apptrace_membufs_down_buffer_put(esp_apptrace_membufs_proto_data_t *proto, uint8_t *ptr, esp_apptrace_tmo_t *tmo);
-uint8_t *esp_apptrace_membufs_up_buffer_get(esp_apptrace_membufs_proto_data_t *proto, uint32_t size, esp_apptrace_tmo_t *tmo);
-esp_err_t esp_apptrace_membufs_up_buffer_put(esp_apptrace_membufs_proto_data_t *proto, uint8_t *ptr, esp_apptrace_tmo_t *tmo);
-esp_err_t esp_apptrace_membufs_flush_nolock(esp_apptrace_membufs_proto_data_t *proto, uint32_t min_sz, esp_apptrace_tmo_t *tmo);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif

components/app_trace/project_include.cmake

@@ -1,35 +0,0 @@
-# idf_create_lcov_report
-#
-# Create coverage report.
-function(idf_create_coverage_report report_dir)
-    set(gcov_tool ${CONFIG_SDK_TOOLPREFIX}gcov)
-    idf_build_get_property(project_name PROJECT_NAME)
-
-    add_custom_target(pre-cov-report
-        COMMENT "Generating coverage report in: ${report_dir}"
-        COMMAND ${CMAKE_COMMAND} -E echo "Using gcov: ${gcov_tool}"
-        COMMAND ${CMAKE_COMMAND} -E make_directory ${report_dir}/html
-        )
-
-    add_custom_target(lcov-report
-        COMMENT "WARNING: lcov-report is deprecated. Please use gcovr-report instead."
-        COMMAND lcov --gcov-tool ${gcov_tool} -c -d ${CMAKE_CURRENT_BINARY_DIR} -o ${report_dir}/${project_name}.info
-        COMMAND genhtml -o ${report_dir}/html ${report_dir}/${project_name}.info
-        DEPENDS pre-cov-report
-        )
-
-    add_custom_target(gcovr-report
-        COMMAND gcovr -r ${project_dir} --gcov-executable ${gcov_tool} -s --html-details ${report_dir}/html/index.html
-        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-        DEPENDS pre-cov-report
-        )
-endfunction()
-
-# idf_clean_coverage_report
-#
-# Clean coverage report.
-function(idf_clean_coverage_report report_dir)
-    add_custom_target(cov-data-clean
-        COMMENT "Clean coverage report in: ${report_dir}"
-        COMMAND ${CMAKE_COMMAND} -E remove_directory ${report_dir})
-endfunction()

components/app_trace/sdkconfig.rename

@@ -1,36 +0,0 @@
-# sdkconfig replacement configurations for deprecated options formatted as
-# CONFIG_DEPRECATED_OPTION CONFIG_NEW_OPTION
-
-CONFIG_ESP32_APPTRACE_DESTINATION      					CONFIG_APPTRACE_DESTINATION
-CONFIG_ESP32_APPTRACE_DEST_NONE							CONFIG_APPTRACE_DEST_NONE
-CONFIG_ESP32_APPTRACE_DEST_TRAX							CONFIG_APPTRACE_DEST_JTAG
-CONFIG_ESP32_APPTRACE_ENABLE							CONFIG_APPTRACE_ENABLE
-CONFIG_ESP32_APPTRACE_LOCK_ENABLE						CONFIG_APPTRACE_LOCK_ENABLE
-CONFIG_ESP32_APPTRACE_ONPANIC_HOST_FLUSH_TMO			CONFIG_APPTRACE_ONPANIC_HOST_FLUSH_TMO
-CONFIG_ESP32_APPTRACE_POSTMORTEM_FLUSH_TRAX_THRESH      CONFIG_APPTRACE_POSTMORTEM_FLUSH_THRESH
-CONFIG_ESP32_APPTRACE_PENDING_DATA_SIZE_MAX				CONFIG_APPTRACE_PENDING_DATA_SIZE_MAX
-CONFIG_ESP32_GCOV_ENABLE								CONFIG_APPTRACE_GCOV_ENABLE
-
-CONFIG_SYSVIEW_ENABLE							        CONFIG_APPTRACE_SV_ENABLE
-CONFIG_SYSVIEW_TS_SOURCE							    CONFIG_APPTRACE_SV_TS_SOURCE
-CONFIG_SYSVIEW_TS_SOURCE_CCOUNT							CONFIG_APPTRACE_SV_TS_SOURCE_CCOUNT
-CONFIG_SYSVIEW_TS_SOURCE_TIMER_00						CONFIG_APPTRACE_SV_TS_SOURCE_TIMER_00
-CONFIG_SYSVIEW_TS_SOURCE_TIMER_01						CONFIG_APPTRACE_SV_TS_SOURCE_TIMER_01
-CONFIG_SYSVIEW_TS_SOURCE_TIMER_10						CONFIG_APPTRACE_SV_TS_SOURCE_TIMER_10
-CONFIG_SYSVIEW_TS_SOURCE_TIMER_11						CONFIG_APPTRACE_SV_TS_SOURCE_TIMER_11
-CONFIG_SYSVIEW_TS_SOURCE_ESP_TIMER						CONFIG_APPTRACE_SV_TS_SOURCE_ESP_TIMER
-CONFIG_SYSVIEW_MAX_TASKS							    CONFIG_APPTRACE_SV_MAX_TASKS
-CONFIG_SYSVIEW_BUF_WAIT_TMO							    CONFIG_APPTRACE_SV_BUF_WAIT_TMO
-CONFIG_SYSVIEW_EVT_OVERFLOW_ENABLE						CONFIG_APPTRACE_SV_EVT_OVERFLOW_ENABLE
-CONFIG_SYSVIEW_EVT_ISR_ENTER_ENABLE						CONFIG_APPTRACE_SV_EVT_ISR_ENTER_ENABLE
-CONFIG_SYSVIEW_EVT_ISR_EXIT_ENABLE						CONFIG_APPTRACE_SV_EVT_ISR_EXIT_ENABLE
-CONFIG_SYSVIEW_EVT_ISR_TO_SCHEDULER_ENABLE				CONFIG_APPTRACE_SV_EVT_ISR_TO_SCHED_ENABLE
-CONFIG_SYSVIEW_EVT_TASK_START_EXEC_ENABLE				CONFIG_APPTRACE_SV_EVT_TASK_START_EXEC_ENABLE
-CONFIG_SYSVIEW_EVT_TASK_STOP_EXEC_ENABLE				CONFIG_APPTRACE_SV_EVT_TASK_STOP_EXEC_ENABLE
-CONFIG_SYSVIEW_EVT_TASK_START_READY_ENABLE				CONFIG_APPTRACE_SV_EVT_TASK_START_READY_ENABLE
-CONFIG_SYSVIEW_EVT_TASK_STOP_READY_ENABLE				CONFIG_APPTRACE_SV_EVT_TASK_STOP_READY_ENABLE
-CONFIG_SYSVIEW_EVT_TASK_CREATE_ENABLE					CONFIG_APPTRACE_SV_EVT_TASK_CREATE_ENABLE
-CONFIG_SYSVIEW_EVT_TASK_TERMINATE_ENABLE				CONFIG_APPTRACE_SV_EVT_TASK_TERMINATE_ENABLE
-CONFIG_SYSVIEW_EVT_IDLE_ENABLE							CONFIG_APPTRACE_SV_EVT_IDLE_ENABLE
-CONFIG_SYSVIEW_EVT_TIMER_ENTER_ENABLE					CONFIG_APPTRACE_SV_EVT_TIMER_ENTER_ENABLE
-CONFIG_SYSVIEW_EVT_TIMER_EXIT_ENABLE					CONFIG_APPTRACE_SV_EVT_TIMER_EXIT_ENABLE

components/app_trace/sys_view/Config/Global.h

@@ -88,7 +88,7 @@ Purpose : Global types
   #else
     #define U64_C(x) x##ULL
   #endif
-#else
+#else 
   //
   // C99 compliant compiler
   //

components/app_trace/sys_view/Config/SEGGER_RTT_Conf.h

@@ -285,12 +285,12 @@ Revision: $Rev: 5626 $
 *       RTT lock configuration fallback
 */
 #ifndef   SEGGER_RTT_LOCK
-  void SEGGER_SYSVIEW_X_RTT_Lock(void);
+  void SEGGER_SYSVIEW_X_RTT_Lock();
   #define SEGGER_RTT_LOCK()                SEGGER_SYSVIEW_X_RTT_Lock() // Lock RTT (nestable)   (i.e. disable interrupts)
 #endif
 
 #ifndef   SEGGER_RTT_UNLOCK
-  void SEGGER_SYSVIEW_X_RTT_Unlock(void);
+  void SEGGER_SYSVIEW_X_RTT_Unlock();
   #define SEGGER_RTT_UNLOCK()              SEGGER_SYSVIEW_X_RTT_Unlock() // Unlock RTT (nestable) (i.e. enable previous interrupt lock state)
 #endif
 

components/app_trace/sys_view/Config/SEGGER_SYSVIEW_Conf.h

@@ -65,8 +65,6 @@ Revision: $Rev: 5927 $
 #ifndef SEGGER_SYSVIEW_CONF_H
 #define SEGGER_SYSVIEW_CONF_H
 
-#include "soc/soc.h"
-
 /*********************************************************************
 *
 *       Defines, fixed
@@ -149,7 +147,7 @@ Revision: $Rev: 5927 $
 *       SystemView Id configuration
 */
 //TODO: optimise it
-#define SEGGER_SYSVIEW_ID_BASE         SOC_DROM_LOW                             // Default value for the lowest Id reported by the application. Can be overridden by the application via SEGGER_SYSVIEW_SetRAMBase(). (i.e. 0x20000000 when all Ids are an address in this RAM)
+#define SEGGER_SYSVIEW_ID_BASE         0x3F400000                               // Default value for the lowest Id reported by the application. Can be overridden by the application via SEGGER_SYSVIEW_SetRAMBase(). (i.e. 0x20000000 when all Ids are an address in this RAM)
 #define SEGGER_SYSVIEW_ID_SHIFT        0                                        // Number of bits to shift the Id to save bandwidth. (i.e. 2 when Ids are 4 byte aligned)
 
 /*********************************************************************
@@ -168,7 +166,7 @@ Revision: $Rev: 5927 $
   #define SEGGER_SYSVIEW_GET_INTERRUPT_ID()   SEGGER_SYSVIEW_X_GetInterruptId() // Get the currently active interrupt Id from the user-provided function.
 #endif
 
-unsigned SEGGER_SYSVIEW_X_SysView_Lock(void);
+unsigned SEGGER_SYSVIEW_X_SysView_Lock();
 void SEGGER_SYSVIEW_X_SysView_Unlock(unsigned int_state);
 // to be recursive save IRQ status on the stack of the caller
 #define SEGGER_SYSVIEW_LOCK()   unsigned _SYSVIEW_int_state = SEGGER_SYSVIEW_X_SysView_Lock()

components/app_trace/sys_view/SEGGER/SEGGER_RTT.h

@@ -58,7 +58,7 @@
 ---------------------------END-OF-HEADER------------------------------
 File    : SEGGER_RTT.h
 Purpose : Implementation of SEGGER real-time transfer which allows
-          real-time communication on targets which support debugger
+          real-time communication on targets which support debugger 
           memory accesses while the CPU is running.
 Revision: $Rev: 5626 $
 ----------------------------------------------------------------------
@@ -159,8 +159,7 @@ unsigned     SEGGER_RTT_WriteNoLock             (unsigned BufferIndex, const voi
 unsigned     SEGGER_RTT_WriteSkipNoLock         (unsigned BufferIndex, const void* pBuffer, unsigned NumBytes);
 unsigned     SEGGER_RTT_WriteString             (unsigned BufferIndex, const char* s);
 void         SEGGER_RTT_WriteWithOverwriteNoLock(unsigned BufferIndex, const void* pBuffer, unsigned NumBytes);
-void         SEGGER_RTT_ESP_FlushNoLock       (unsigned long min_sz, unsigned long tmo);
-void         SEGGER_RTT_ESP_Flush             (unsigned long min_sz, unsigned long tmo);
+void         SEGGER_RTT_ESP32_FlushNoLock       (unsigned long min_sz, unsigned long tmo);
 //
 // Function macro for performance optimization
 //

components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.c

@@ -402,7 +402,7 @@ static U8 *_EncodeStr(U8 *pPayload, const char *pText, unsigned int Limit) {
   // Write Len
   //
   if (Len < 255)  {
-    *pPayload++ = Len;
+    *pPayload++ = Len; 
   } else {
     *pPayload++ = 255;
     *pPayload++ = (Len & 255);
@@ -556,7 +556,7 @@ static int _TrySendOverflowPacket(void) {
 *       _SendSyncInfo()
 *
 *  Function description
-*    Send SystemView sync packet and system information in
+*    Send SystemView sync packet and system information in 
 *    post mortem mode.
 *
 *  Additional information
@@ -792,7 +792,7 @@ static void _VPrintHost(const char* s, U32 Options, va_list* pParamList) {
   U32 aParas[SEGGER_SYSVIEW_MAX_ARGUMENTS];
   U32 NumArguments;
   const char* p;
-
+  
   p = s;
   NumArguments = 0;
   while (*p) {
@@ -1689,10 +1689,6 @@ void SEGGER_SYSVIEW_Stop(void) {
   RECORD_END();
 }
 
-U8 SEGGER_SYSVIEW_Started(void) {
-    return _SYSVIEW_Globals.EnableState;
-}
-
 /*********************************************************************
 *
 *       SEGGER_SYSVIEW_GetSysDesc()
@@ -2682,7 +2678,7 @@ void SEGGER_SYSVIEW_ErrorfTarget(const char* s, ...) {
 void SEGGER_SYSVIEW_Print(const char* s) {
   U8* pPayload;
   U8* pPayloadStart;
-  RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + 2 * SEGGER_SYSVIEW_QUANTA_U32 + SEGGER_SYSVIEW_MAX_STRING_LEN + 3/*1 or 3 bytes for string length*/);
+  RECORD_START(SEGGER_SYSVIEW_INFO_SIZE + 2 * SEGGER_SYSVIEW_QUANTA_U32 + SEGGER_SYSVIEW_MAX_STRING_LEN);
   //
   pPayload = _EncodeStr(pPayloadStart, s, SEGGER_SYSVIEW_MAX_STRING_LEN);
   ENCODE_U32(pPayload, SEGGER_SYSVIEW_LOG);

components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW.h

@@ -230,8 +230,6 @@ void SEGGER_SYSVIEW_GetSysDesc                    (void);
 void SEGGER_SYSVIEW_SendTaskList                  (void);
 void SEGGER_SYSVIEW_SendTaskInfo                  (const SEGGER_SYSVIEW_TASKINFO* pInfo);
 void SEGGER_SYSVIEW_SendSysDesc                   (const char* sSysDesc);
-// Checks whether tracing has been started
-U8 SEGGER_SYSVIEW_Started(void);
 
 /*********************************************************************
 *

components/app_trace/sys_view/SEGGER/SEGGER_SYSVIEW_ConfDefaults.h

@@ -118,7 +118,7 @@ extern "C" {
 #endif
 
 // Lowest Id reported by the Application.
-#ifndef   SEGGER_SYSVIEW_ID_BASE
+#ifndef   SEGGER_SYSVIEW_ID_BASE 
   #define SEGGER_SYSVIEW_ID_BASE            0
 #endif
 

components/app_trace/sys_view/Sample/Config/SEGGER_SYSVIEW_Config_FreeRTOS.c

@@ -61,22 +61,13 @@ File    : SEGGER_SYSVIEW_Config_FreeRTOS.c
 Purpose : Sample setup configuration of SystemView with FreeRTOS.
 Revision: $Rev: 3734 $
 */
-#include "sdkconfig.h"
 #include "freertos/FreeRTOS.h"
 #include "SEGGER_SYSVIEW.h"
+#include "rom/ets_sys.h"
 #include "esp_app_trace.h"
 #include "esp_app_trace_util.h"
 #include "esp_intr_alloc.h"
-#include "soc/soc.h"
-#include "soc/interrupts.h"
-#if CONFIG_IDF_TARGET_ESP32
-#include "esp32/clk.h"
-#elif CONFIG_IDF_TARGET_ESP32S2
-#include "esp32s2/clk.h"
-#elif CONFIG_IDF_TARGET_ESP32C3
-#include "esp32c3/clk.h"
-#endif
-
+#include "esp_clk.h"
 
 extern const SEGGER_SYSVIEW_OS_API SYSVIEW_X_OS_TraceAPI;
 
@@ -90,18 +81,12 @@ extern const SEGGER_SYSVIEW_OS_API SYSVIEW_X_OS_TraceAPI;
 #define SYSVIEW_APP_NAME        "FreeRTOS Application"
 
 // The target device name
-#define SYSVIEW_DEVICE_NAME     CONFIG_IDF_TARGET
-// The target core name
-#if CONFIG_IDF_TARGET_ARCH_XTENSA
-#define SYSVIEW_CORE_NAME       "xtensa"
-#elif CONFIG_IDF_TARGET_ARCH_RISCV
-#define SYSVIEW_CORE_NAME       "riscv"
-#endif
+#define SYSVIEW_DEVICE_NAME     "ESP32"
 
 // Determine which timer to use as timestamp source
-#if CONFIG_APPTRACE_SV_TS_SOURCE_CCOUNT
+#if CONFIG_SYSVIEW_TS_SOURCE_CCOUNT
 #define TS_USE_CCOUNT 1
-#elif CONFIG_APPTRACE_SV_TS_SOURCE_ESP_TIMER
+#elif CONFIG_SYSVIEW_TS_SOURCE_ESP_TIMER
 #define TS_USE_ESP_TIMER 1
 #else
 #define TS_USE_TIMERGROUP 1
@@ -117,13 +102,13 @@ extern const SEGGER_SYSVIEW_OS_API SYSVIEW_X_OS_TraceAPI;
 #define SYSVIEW_TIMESTAMP_FREQ  (esp_clk_apb_freq() / SYSVIEW_TIMER_DIV)
 
 // Timer ID and group ID
-#if defined(CONFIG_APPTRACE_SV_TS_SOURCE_TIMER_00) || defined(CONFIG_APPTRACE_SV_TS_SOURCE_TIMER_01)
+#if defined(CONFIG_SYSVIEW_TS_SOURCE_TIMER_00) || defined(CONFIG_SYSVIEW_TS_SOURCE_TIMER_01)
 #define TS_TIMER_ID 0
 #else
 #define TS_TIMER_ID 1
 #endif // TIMER_00 || TIMER_01
 
-#if defined(CONFIG_APPTRACE_SV_TS_SOURCE_TIMER_00) || defined(CONFIG_APPTRACE_SV_TS_SOURCE_TIMER_10)
+#if defined(CONFIG_SYSVIEW_TS_SOURCE_TIMER_00) || defined(CONFIG_SYSVIEW_TS_SOURCE_TIMER_10)
 #define TS_TIMER_GROUP 0
 #else
 #define TS_TIMER_GROUP 1
@@ -138,29 +123,21 @@ extern const SEGGER_SYSVIEW_OS_API SYSVIEW_X_OS_TraceAPI;
 
 #if TS_USE_CCOUNT
 // CCOUNT is incremented at CPU frequency
-#if CONFIG_IDF_TARGET_ESP32
 #define SYSVIEW_TIMESTAMP_FREQ  (CONFIG_ESP32_DEFAULT_CPU_FREQ_MHZ * 1000000)
-#elif CONFIG_IDF_TARGET_ESP32S2
-#define SYSVIEW_TIMESTAMP_FREQ  (CONFIG_ESP32S2_DEFAULT_CPU_FREQ_MHZ * 1000000)
-#endif
 #endif // TS_USE_CCOUNT
 
 // System Frequency.
 #define SYSVIEW_CPU_FREQ        (esp_clk_cpu_freq())
 
 // The lowest RAM address used for IDs (pointers)
-#define SYSVIEW_RAM_BASE        (SOC_DROM_LOW)
+#define SYSVIEW_RAM_BASE        (0x3F400000)
 
-#if CONFIG_IDF_TARGET_ESP32 || CONFIG_IDF_TARGET_ESP32S2
 #if CONFIG_FREERTOS_CORETIMER_0
     #define SYSTICK_INTR_ID (ETS_INTERNAL_TIMER0_INTR_SOURCE+ETS_INTERNAL_INTR_SOURCE_OFF)
 #endif
 #if CONFIG_FREERTOS_CORETIMER_1
     #define SYSTICK_INTR_ID (ETS_INTERNAL_TIMER1_INTR_SOURCE+ETS_INTERNAL_INTR_SOURCE_OFF)
 #endif
-#elif CONFIG_IDF_TARGET_ESP32C3
-    #define SYSTICK_INTR_ID (ETS_SYSTIMER_TARGET0_EDGE_INTR_SOURCE+ETS_INTERNAL_INTR_SOURCE_OFF)
-#endif
 
 // SystemView is single core specific: it implies that SEGGER_SYSVIEW_LOCK()
 // disables IRQs (disables rescheduling globally). So we can not use finite timeouts for locks and return error
@@ -170,6 +147,78 @@ extern const SEGGER_SYSVIEW_OS_API SYSVIEW_X_OS_TraceAPI;
 
 static esp_apptrace_lock_t s_sys_view_lock = {.mux = portMUX_INITIALIZER_UNLOCKED, .int_state = 0};
 
+static const char * const s_isr_names[] = {
+    [0] = "WIFI_MAC",
+    [1] = "WIFI_NMI",
+    [2] = "WIFI_BB",
+    [3] = "BT_MAC",
+    [4] = "BT_BB",
+    [5] = "BT_BB_NMI",
+    [6] = "RWBT",
+    [7] = "RWBLE",
+    [8] = "RWBT_NMI",
+    [9] = "RWBLE_NMI",
+    [10] = "SLC0",
+    [11] = "SLC1",
+    [12] = "UHCI0",
+    [13] = "UHCI1",
+    [14] = "TG0_T0_LEVEL",
+    [15] = "TG0_T1_LEVEL",
+    [16] = "TG0_WDT_LEVEL",
+    [17] = "TG0_LACT_LEVEL",
+    [18] = "TG1_T0_LEVEL",
+    [19] = "TG1_T1_LEVEL",
+    [20] = "TG1_WDT_LEVEL",
+    [21] = "TG1_LACT_LEVEL",
+    [22] = "GPIO",
+    [23] = "GPIO_NMI",
+    [24] = "FROM_CPU0",
+    [25] = "FROM_CPU1",
+    [26] = "FROM_CPU2",
+    [27] = "FROM_CPU3",
+    [28] = "SPI0",
+    [29] = "SPI1",
+    [30] = "SPI2",
+    [31] = "SPI3",
+    [32] = "I2S0",
+    [33] = "I2S1",
+    [34] = "UART0",
+    [35] = "UART1",
+    [36] = "UART2",
+    [37] = "SDIO_HOST",
+    [38] = "ETH_MAC",
+    [39] = "PWM0",
+    [40] = "PWM1",
+    [41] = "PWM2",
+    [42] = "PWM3",
+    [43] = "LEDC",
+    [44] = "EFUSE",
+    [45] = "CAN",
+    [46] = "RTC_CORE",
+    [47] = "RMT",
+    [48] = "PCNT",
+    [49] = "I2C_EXT0",
+    [50] = "I2C_EXT1",
+    [51] = "RSA",
+    [52] = "SPI1_DMA",
+    [53] = "SPI2_DMA",
+    [54] = "SPI3_DMA",
+    [55] = "WDT",
+    [56] = "TIMER1",
+    [57] = "TIMER2",
+    [58] = "TG0_T0_EDGE",
+    [59] = "TG0_T1_EDGE",
+    [60] = "TG0_WDT_EDGE",
+    [61] = "TG0_LACT_EDGE",
+    [62] = "TG1_T0_EDGE",
+    [63] = "TG1_T1_EDGE",
+    [64] = "TG1_WDT_EDGE",
+    [65] = "TG1_LACT_EDGE",
+    [66] = "MMU_IA",
+    [67] = "MPU_IA",
+    [68] = "CACHE_IA",
+};
+
 /*********************************************************************
 *
 *       _cbSendSystemDesc()
@@ -179,14 +228,12 @@ static esp_apptrace_lock_t s_sys_view_lock = {.mux = portMUX_INITIALIZER_UNLOCKE
 */
 static void _cbSendSystemDesc(void) {
     char irq_str[32];
-    SEGGER_SYSVIEW_SendSysDesc("N="SYSVIEW_APP_NAME",D="SYSVIEW_DEVICE_NAME",C="SYSVIEW_CORE_NAME",O=FreeRTOS");
+    SEGGER_SYSVIEW_SendSysDesc("N="SYSVIEW_APP_NAME",D="SYSVIEW_DEVICE_NAME",C=Xtensa,O=FreeRTOS");
     snprintf(irq_str, sizeof(irq_str), "I#%d=SysTick", SYSTICK_INTR_ID);
     SEGGER_SYSVIEW_SendSysDesc(irq_str);
-    size_t isr_count = sizeof(esp_isr_names)/sizeof(esp_isr_names[0]);
+    size_t isr_count = sizeof(s_isr_names)/sizeof(s_isr_names[0]);
     for (size_t i = 0; i < isr_count; ++i) {
-        if (esp_isr_names[i] == NULL || (ETS_INTERNAL_INTR_SOURCE_OFF + i) == SYSTICK_INTR_ID)
-            continue;
-        snprintf(irq_str, sizeof(irq_str), "I#%d=%s", ETS_INTERNAL_INTR_SOURCE_OFF + i, esp_isr_names[i]);
+        snprintf(irq_str, sizeof(irq_str), "I#%d=%s", ETS_INTERNAL_INTR_SOURCE_OFF + i, s_isr_names[i]);
         SEGGER_SYSVIEW_SendSysDesc(irq_str);
     }
 }
@@ -197,7 +244,7 @@ static void _cbSendSystemDesc(void) {
 *
 **********************************************************************
 */
-static void SEGGER_SYSVIEW_TS_Init(void)
+static void SEGGER_SYSVIEW_TS_Init()
 {
     /* We only need to initialize something if we use Timer Group.
      * esp_timer and ccount can be used as is.
@@ -227,49 +274,49 @@ void SEGGER_SYSVIEW_Conf(void) {
                         &SYSVIEW_X_OS_TraceAPI, _cbSendSystemDesc);
     SEGGER_SYSVIEW_SetRAMBase(SYSVIEW_RAM_BASE);
 
-#if !CONFIG_APPTRACE_SV_EVT_OVERFLOW_ENABLE
+#if !CONFIG_SYSVIEW_EVT_OVERFLOW_ENABLE
     disable_evts |= SYSVIEW_EVTMASK_OVERFLOW;
 #endif
-#if !CONFIG_APPTRACE_SV_EVT_ISR_ENTER_ENABLE
+#if !CONFIG_SYSVIEW_EVT_ISR_ENTER_ENABLE
     disable_evts |= SYSVIEW_EVTMASK_ISR_ENTER;
 #endif
-#if !CONFIG_APPTRACE_SV_EVT_ISR_EXIT_ENABLE
+#if !CONFIG_SYSVIEW_EVT_ISR_EXIT_ENABLE
     disable_evts |= SYSVIEW_EVTMASK_ISR_EXIT;
 #endif
-#if !CONFIG_APPTRACE_SV_EVT_TASK_START_EXEC_ENABLE
+#if !CONFIG_SYSVIEW_EVT_TASK_START_EXEC_ENABLE
     disable_evts |= SYSVIEW_EVTMASK_TASK_START_EXEC;
 #endif
-#if !CONFIG_APPTRACE_SV_EVT_TASK_STOP_EXEC_ENABLE
+#if !CONFIG_SYSVIEW_EVT_TASK_STOP_EXEC_ENABLE
     disable_evts |= SYSVIEW_EVTMASK_TASK_STOP_EXEC;
 #endif
-#if !CONFIG_APPTRACE_SV_EVT_TASK_START_READY_ENABLE
+#if !CONFIG_SYSVIEW_EVT_TASK_START_READY_ENABLE
     disable_evts |= SYSVIEW_EVTMASK_TASK_START_READY;
 #endif
-#if !CONFIG_APPTRACE_SV_EVT_TASK_STOP_READY_ENABLE
+#if !CONFIG_SYSVIEW_EVT_TASK_STOP_READY_ENABLE
     disable_evts |= SYSVIEW_EVTMASK_TASK_STOP_READY;
 #endif
-#if !CONFIG_APPTRACE_SV_EVT_TASK_CREATE_ENABLE
+#if !CONFIG_SYSVIEW_EVT_TASK_CREATE_ENABLE
     disable_evts |= SYSVIEW_EVTMASK_TASK_CREATE;
 #endif
-#if !CONFIG_APPTRACE_SV_EVT_TASK_TERMINATE_ENABLE
+#if !CONFIG_SYSVIEW_EVT_TASK_TERMINATE_ENABLE
     disable_evts |= SYSVIEW_EVTMASK_TASK_TERMINATE;
 #endif
-#if !CONFIG_APPTRACE_SV_EVT_IDLE_ENABLE
+#if !CONFIG_SYSVIEW_EVT_IDLE_ENABLE
     disable_evts |= SYSVIEW_EVTMASK_IDLE;
 #endif
-#if !CONFIG_APPTRACE_SV_EVT_ISR_TO_SCHED_ENABLE
+#if !CONFIG_SYSVIEW_EVT_ISR_TO_SCHEDULER_ENABLE
     disable_evts |= SYSVIEW_EVTMASK_ISR_TO_SCHEDULER;
 #endif
-#if !CONFIG_APPTRACE_SV_EVT_TIMER_ENTER_ENABLE
+#if !CONFIG_SYSVIEW_EVT_TIMER_ENTER_ENABLE
     disable_evts |= SYSVIEW_EVTMASK_TIMER_ENTER;
 #endif
-#if !CONFIG_APPTRACE_SV_EVT_TIMER_EXIT_ENABLE
+#if !CONFIG_SYSVIEW_EVT_TIMER_EXIT_ENABLE
     disable_evts |= SYSVIEW_EVTMASK_TIMER_EXIT;
 #endif
   SEGGER_SYSVIEW_DisableEvents(disable_evts);
 }
 
-U32 SEGGER_SYSVIEW_X_GetTimestamp(void)
+U32 SEGGER_SYSVIEW_X_GetTimestamp()
 {
 #if TS_USE_TIMERGROUP
     uint64_t ts = 0;
@@ -282,15 +329,15 @@ U32 SEGGER_SYSVIEW_X_GetTimestamp(void)
 #endif
 }
 
-void SEGGER_SYSVIEW_X_RTT_Lock(void)
+void SEGGER_SYSVIEW_X_RTT_Lock()
 {
 }
 
-void SEGGER_SYSVIEW_X_RTT_Unlock(void)
+void SEGGER_SYSVIEW_X_RTT_Unlock()
 {
 }
 
-unsigned SEGGER_SYSVIEW_X_SysView_Lock(void)
+unsigned SEGGER_SYSVIEW_X_SysView_Lock()
 {
     esp_apptrace_tmo_t tmo;
     esp_apptrace_tmo_init(&tmo, SEGGER_LOCK_WAIT_TMO);

components/app_trace/sys_view/Sample/OS/SEGGER_SYSVIEW_FreeRTOS.c

@@ -136,11 +136,11 @@ static U64 _cbGetTime(void) {
 */
 void SYSVIEW_AddTask(U32 xHandle, const char* pcTaskName, unsigned uxCurrentPriority, U32  pxStack, unsigned uStackHighWaterMark) {
   unsigned n;
-
+  
   if (memcmp(pcTaskName, "IDLE", 5) == 0) {
     return;
   }
-
+  
   for (n = 0; n < SYSVIEW_FREERTOS_MAX_NOF_TASKS; n++) {
     if (_aTasks[n].xHandle == 0) {
       break;
@@ -170,7 +170,7 @@ void SYSVIEW_AddTask(U32 xHandle, const char* pcTaskName, unsigned uxCurrentPrio
 */
 void SYSVIEW_UpdateTask(U32 xHandle, const char* pcTaskName, unsigned uxCurrentPriority, U32 pxStack, unsigned uStackHighWaterMark) {
   unsigned n;
-
+  
   if (memcmp(pcTaskName, "IDLE", 5) == 0) {
     return;
   }

components/app_trace/sys_view/Sample/OS/SEGGER_SYSVIEW_FreeRTOS.h

@@ -80,7 +80,7 @@ Notes:
   #define portSTACK_GROWTH              ( -1 )
 #endif
 
-#define SYSVIEW_FREERTOS_MAX_NOF_TASKS  CONFIG_APPTRACE_SV_MAX_TASKS
+#define SYSVIEW_FREERTOS_MAX_NOF_TASKS  CONFIG_SYSVIEW_MAX_TASKS
 
 /*********************************************************************
 *
@@ -230,12 +230,11 @@ Notes:
 
 #define traceQUEUE_CREATE( pxNewQueue )                               SEGGER_SYSVIEW_RecordU32x3(apiFastID_OFFSET + apiID_XQUEUEGENERICCREATE, uxQueueLength, uxItemSize, ucQueueType)
 #define traceQUEUE_DELETE( pxQueue )                                  SEGGER_SYSVIEW_RecordU32(apiFastID_OFFSET + apiID_VQUEUEDELETE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue))
-#define traceQUEUE_PEEK( pxQueue )                                    SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer), xTicksToWait, 0)
+#define traceQUEUE_PEEK( pxQueue )                                    SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer), xTicksToWait, xJustPeeking)
 #define traceQUEUE_PEEK_FROM_ISR( pxQueue )                           SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_XQUEUEPEEKFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer))
 #define traceQUEUE_PEEK_FROM_ISR_FAILED( pxQueue )                    SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_XQUEUEPEEKFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer))
-#define traceQUEUE_RECEIVE( pxQueue )                                 SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)0), xTicksToWait, 1)
-#define traceQUEUE_RECEIVE_FAILED( pxQueue )                          SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)0), xTicksToWait, 1)
-#define traceQUEUE_SEMAPHORE_RECEIVE( pxQueue )                       SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)0), xTicksToWait, 0)
+#define traceQUEUE_RECEIVE( pxQueue )                                 SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer), xTicksToWait, xJustPeeking)
+#define traceQUEUE_RECEIVE_FAILED( pxQueue )                          SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICRECEIVE, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer), xTicksToWait, xJustPeeking)
 #define traceQUEUE_RECEIVE_FROM_ISR( pxQueue )                        SEGGER_SYSVIEW_RecordU32x3(apiFastID_OFFSET + apiID_XQUEUERECEIVEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer), (U32)pxHigherPriorityTaskWoken)
 #define traceQUEUE_RECEIVE_FROM_ISR_FAILED( pxQueue )                 SEGGER_SYSVIEW_RecordU32x3(apiFastID_OFFSET + apiID_XQUEUERECEIVEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), SEGGER_SYSVIEW_ShrinkId((U32)pvBuffer), (U32)pxHigherPriorityTaskWoken)
 #define traceQUEUE_REGISTRY_ADD( xQueue, pcQueueName )                SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_VQUEUEADDTOREGISTRY, SEGGER_SYSVIEW_ShrinkId((U32)xQueue), (U32)pcQueueName)
@@ -245,10 +244,8 @@ Notes:
   #define traceQUEUE_SEND( pxQueue )                                    SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSEND, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), 0, 0, xCopyPosition)
 #endif
 #define traceQUEUE_SEND_FAILED( pxQueue )                             SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSEND, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pvItemToQueue, xTicksToWait, xCopyPosition)
-#define traceQUEUE_SEND_FROM_ISR( pxQueue )                           SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSENDFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pvItemToQueue, (U32)pxHigherPriorityTaskWoken, xCopyPosition)
-#define traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue )                    SEGGER_SYSVIEW_RecordU32x4(apiFastID_OFFSET + apiID_XQUEUEGENERICSENDFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pvItemToQueue, (U32)pxHigherPriorityTaskWoken, xCopyPosition)
-#define traceQUEUE_GIVE_FROM_ISR( pxQueue )                           SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_XQUEUEGIVEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pxHigherPriorityTaskWoken)
-#define traceQUEUE_GIVE_FROM_ISR_FAILED( pxQueue )                    SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_XQUEUEGIVEFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pxHigherPriorityTaskWoken)
+#define traceQUEUE_SEND_FROM_ISR( pxQueue )                           SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_XQUEUEGENERICSENDFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pxHigherPriorityTaskWoken)
+#define traceQUEUE_SEND_FROM_ISR_FAILED( pxQueue )                    SEGGER_SYSVIEW_RecordU32x2(apiFastID_OFFSET + apiID_XQUEUEGENERICSENDFROMISR, SEGGER_SYSVIEW_ShrinkId((U32)pxQueue), (U32)pxHigherPriorityTaskWoken)
 
 #if( portSTACK_GROWTH < 0 )
 #define traceTASK_CREATE(pxNewTCB)                  if (pxNewTCB != NULL) {                                             \
@@ -290,12 +287,12 @@ Notes:
   #define traceTASK_SWITCHED_IN()                   if(prvGetTCBFromHandle(NULL) == xTaskGetIdleTaskHandle()) {           \
                                                       SEGGER_SYSVIEW_OnIdle();                                          \
                                                     } else {                                                            \
-                                                      SEGGER_SYSVIEW_OnTaskStartExec((U32)pxCurrentTCB[cpu_hal_get_core_id()]); \
+                                                      SEGGER_SYSVIEW_OnTaskStartExec((U32)pxCurrentTCB[xPortGetCoreID()]); \
                                                     }
 #else
   #define traceTASK_SWITCHED_IN()                   {                                                                   \
-                                                      if (memcmp(pxCurrentTCB[cpu_hal_get_core_id()]->pcTaskName, "IDLE", 5) != 0) { \
-                                                        SEGGER_SYSVIEW_OnTaskStartExec((U32)pxCurrentTCB[cpu_hal_get_core_id()]);    \
+                                                      if (memcmp(pxCurrentTCB[xPortGetCoreID()]->pcTaskName, "IDLE", 5) != 0) { \
+                                                        SEGGER_SYSVIEW_OnTaskStartExec((U32)pxCurrentTCB[xPortGetCoreID()]);    \
                                                       } else {                                                          \
                                                         SEGGER_SYSVIEW_OnIdle();                                        \
                                                       }                                                                 \
@@ -305,15 +302,14 @@ Notes:
 #define traceMOVED_TASK_TO_READY_STATE(pxTCB)       SEGGER_SYSVIEW_OnTaskStartReady((U32)pxTCB)
 #define traceREADDED_TASK_TO_READY_STATE(pxTCB)
 
-#define traceMOVED_TASK_TO_DELAYED_LIST()           SEGGER_SYSVIEW_OnTaskStopReady((U32)pxCurrentTCB[cpu_hal_get_core_id()],  (1u << 2))
-#define traceMOVED_TASK_TO_OVERFLOW_DELAYED_LIST()  SEGGER_SYSVIEW_OnTaskStopReady((U32)pxCurrentTCB[cpu_hal_get_core_id()],  (1u << 2))
+#define traceMOVED_TASK_TO_DELAYED_LIST()           SEGGER_SYSVIEW_OnTaskStopReady((U32)pxCurrentTCB[xPortGetCoreID()],  (1u << 2))
+#define traceMOVED_TASK_TO_OVERFLOW_DELAYED_LIST()  SEGGER_SYSVIEW_OnTaskStopReady((U32)pxCurrentTCB[xPortGetCoreID()],  (1u << 2))
 #define traceMOVED_TASK_TO_SUSPENDED_LIST(pxTCB)    SEGGER_SYSVIEW_OnTaskStopReady((U32)pxTCB,         ((3u << 3) | 3))
 
 #define traceISR_EXIT_TO_SCHEDULER()                SEGGER_SYSVIEW_RecordExitISRToScheduler()
 #define traceISR_EXIT()                             SEGGER_SYSVIEW_RecordExitISR()
 #define traceISR_ENTER(_n_)                         SEGGER_SYSVIEW_RecordEnterISR(_n_)
 
-
 /*********************************************************************
 *
 *       API functions

components/app_trace/sys_view/esp/SEGGER_RTT_esp.c

@@ -1,243 +0,0 @@
-// Copyright 2017 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-#include "string.h"
-#include "freertos/FreeRTOS.h"
-#include "SEGGER_RTT.h"
-#include "SEGGER_SYSVIEW.h"
-#include "SEGGER_SYSVIEW_Conf.h"
-
-#include "esp_app_trace.h"
-#include "esp_log.h"
-
-const static char *TAG = "segger_rtt";
-
-#define SYSVIEW_EVENTS_BUF_SZ         255U
-
-// size of down channel data buf
-#define SYSVIEW_DOWN_BUF_SIZE   32
-#define SEGGER_STOP_WAIT_TMO    1000000 //us
-#if CONFIG_APPTRACE_SV_BUF_WAIT_TMO == -1
-#define SEGGER_HOST_WAIT_TMO    ESP_APPTRACE_TMO_INFINITE
-#else
-#define SEGGER_HOST_WAIT_TMO    CONFIG_APPTRACE_SV_BUF_WAIT_TMO
-#endif
-
-static uint8_t s_events_buf[SYSVIEW_EVENTS_BUF_SZ];
-static uint16_t s_events_buf_filled;
-static uint8_t s_down_buf[SYSVIEW_DOWN_BUF_SIZE];
-
-/*********************************************************************
-*
-*       Public code
-*
-**********************************************************************
-*/
-
-/*********************************************************************
-*
-*       SEGGER_RTT_ESP_FlushNoLock()
-*
-*  Function description
-*    Flushes buffered events.
-*
-*  Parameters
-*    min_sz  Threshold for flushing data. If current filling level is above this value, data will be flushed. TRAX destinations only.
-*    tmo     Timeout for operation (in us). Use ESP_APPTRACE_TMO_INFINITE to wait indefinetly.
-*
-*  Return value
-*    None.
-*/
-void SEGGER_RTT_ESP_FlushNoLock(unsigned long min_sz, unsigned long tmo)
-{
-    esp_err_t res;
-    if (s_events_buf_filled > 0) {
-      res = esp_apptrace_write(ESP_APPTRACE_DEST_TRAX, s_events_buf, s_events_buf_filled, tmo);
-      if (res != ESP_OK) {
-        ESP_LOGE(TAG, "Failed to flush buffered events (%d)!\n", res);
-      }
-    }
-    // flush even if we failed to write buffered events, because no new events will be sent after STOP
-    res = esp_apptrace_flush_nolock(ESP_APPTRACE_DEST_TRAX, min_sz, tmo);
-    if (res != ESP_OK) {
-      ESP_LOGE(TAG, "Failed to flush apptrace data (%d)!\n", res);
-    }
-    s_events_buf_filled = 0;
-}
-
-/*********************************************************************
-*
-*       SEGGER_RTT_ESP_Flush()
-*
-*  Function description
-*    Flushes buffered events.
-*
-*  Parameters
-*    min_sz  Threshold for flushing data. If current filling level is above this value, data will be flushed. TRAX destinations only.
-*    tmo     Timeout for operation (in us). Use ESP_APPTRACE_TMO_INFINITE to wait indefinetly.
-*
-*  Return value
-*    None.
-*/
-void SEGGER_RTT_ESP_Flush(unsigned long min_sz, unsigned long tmo)
-{
-    SEGGER_SYSVIEW_LOCK();
-    SEGGER_RTT_ESP_FlushNoLock(min_sz, tmo);
-    SEGGER_SYSVIEW_UNLOCK();
-}
-
-/*********************************************************************
-*
-*       SEGGER_RTT_ReadNoLock()
-*
-*  Function description
-*    Reads characters from SEGGER real-time-terminal control block
-*    which have been previously stored by the host.
-*    Do not lock against interrupts and multiple access.
-*
-*  Parameters
-*    BufferIndex  Index of Down-buffer to be used (e.g. 0 for "Terminal").
-*    pBuffer      Pointer to buffer provided by target application, to copy characters from RTT-down-buffer to.
-*    BufferSize   Size of the target application buffer.
-*
-*  Return value
-*    Number of bytes that have been read.
-*/
-unsigned SEGGER_RTT_ReadNoLock(unsigned BufferIndex, void* pData, unsigned BufferSize) {
-  uint32_t size = BufferSize;
-  esp_err_t res = esp_apptrace_read(ESP_APPTRACE_DEST_TRAX, pData, &size, 0);
-  if (res != ESP_OK) {
-    return 0;
-  }
-  return size;
-}
-
-/*********************************************************************
-*
-*       SEGGER_RTT_WriteSkipNoLock
-*
-*  Function description
-*    Stores a specified number of characters in SEGGER RTT
-*    control block which is then read by the host.
-*    SEGGER_RTT_WriteSkipNoLock does not lock the application and
-*    skips all data, if the data does not fit into the buffer.
-*
-*  Parameters
-*    BufferIndex  Index of "Up"-buffer to be used (e.g. 0 for "Terminal").
-*    pBuffer      Pointer to character array. Does not need to point to a \0 terminated string.
-*    NumBytes     Number of bytes to be stored in the SEGGER RTT control block.
-*
-*  Return value
-*    Number of bytes which have been stored in the "Up"-buffer.
-*
-*  Notes
-*    (1) If there is not enough space in the "Up"-buffer, all data is dropped.
-*    (2) For performance reasons this function does not call Init()
-*        and may only be called after RTT has been initialized.
-*        Either by calling SEGGER_RTT_Init() or calling another RTT API function first.
-*/
-unsigned SEGGER_RTT_WriteSkipNoLock(unsigned BufferIndex, const void* pBuffer, unsigned NumBytes) {
-  uint8_t *pbuf = (uint8_t *)pBuffer;
-  uint8_t event_id = *pbuf;
-
-  if (NumBytes > SYSVIEW_EVENTS_BUF_SZ) {
-      ESP_LOGE(TAG, "Too large event %u bytes!", NumBytes);
-      return 0;
-  }
-  if (cpu_hal_get_core_id()) { // dual core specific code
-    // use the highest - 1 bit of event ID to indicate core ID
-    // the highest bit can not be used due to event ID encoding method
-    // this reduces supported ID range to [0..63] (for 1 byte IDs) plus [128..16383] (for 2 bytes IDs)
-    if (*pbuf & 0x80) { // 2 bytes ID
-      *(pbuf + 1) |= (1 << 6);
-    } else if (NumBytes != 10 || *pbuf != 0) { // ignore sync sequence
-      *pbuf |= (1 << 6);
-    }
-  }
-  if (s_events_buf_filled + NumBytes > SYSVIEW_EVENTS_BUF_SZ) {
-    esp_err_t res = esp_apptrace_write(ESP_APPTRACE_DEST_TRAX, s_events_buf, s_events_buf_filled, SEGGER_HOST_WAIT_TMO);
-    if (res != ESP_OK) {
-      return 0; // skip current data buffer only, accumulated events are kept
-    }
-    s_events_buf_filled = 0;
-  }
-  memcpy(&s_events_buf[s_events_buf_filled], pBuffer, NumBytes);
-  s_events_buf_filled += NumBytes;
-  if (event_id == SYSVIEW_EVTID_TRACE_STOP) {
-    SEGGER_RTT_ESP_FlushNoLock(0, SEGGER_STOP_WAIT_TMO);
-  }
-  return NumBytes;
-}
-
-/*********************************************************************
-*
-*       SEGGER_RTT_ConfigUpBuffer
-*
-*  Function description
-*    Run-time configuration of a specific up-buffer (T->H).
-*    Buffer to be configured is specified by index.
-*    This includes: Buffer address, size, name, flags, ...
-*
-*  Parameters
-*    BufferIndex  Index of the buffer to configure.
-*    sName        Pointer to a constant name string.
-*    pBuffer      Pointer to a buffer to be used.
-*    BufferSize   Size of the buffer.
-*    Flags        Operating modes. Define behavior if buffer is full (not enough space for entire message).
-*
-*  Return value
-*    >= 0 - O.K.
-*     < 0 - Error
-*
-*  Additional information
-*    Buffer 0 is configured on compile-time.
-*    May only be called once per buffer.
-*    Buffer name and flags can be reconfigured using the appropriate functions.
-*/
-int SEGGER_RTT_ConfigUpBuffer(unsigned BufferIndex, const char* sName, void* pBuffer, unsigned BufferSize, unsigned Flags) {
-  s_events_buf_filled = 0;
-  return 0;
-}
-
-/*********************************************************************
-*
-*       SEGGER_RTT_ConfigDownBuffer
-*
-*  Function description
-*    Run-time configuration of a specific down-buffer (H->T).
-*    Buffer to be configured is specified by index.
-*    This includes: Buffer address, size, name, flags, ...
-*
-*  Parameters
-*    BufferIndex  Index of the buffer to configure.
-*    sName        Pointer to a constant name string.
-*    pBuffer      Pointer to a buffer to be used.
-*    BufferSize   Size of the buffer.
-*    Flags        Operating modes. Define behavior if buffer is full (not enough space for entire message).
-*
-*  Return value
-*    >= 0  O.K.
-*     < 0  Error
-*
-*  Additional information
-*    Buffer 0 is configured on compile-time.
-*    May only be called once per buffer.
-*    Buffer name and flags can be reconfigured using the appropriate functions.
-*/
-int SEGGER_RTT_ConfigDownBuffer(unsigned BufferIndex, const char* sName, void* pBuffer, unsigned BufferSize, unsigned Flags) {
-  esp_apptrace_down_buffer_config(s_down_buf, sizeof(s_down_buf));
-  return 0;
-}
-
-/*************************** End of file ****************************/

components/app_trace/sys_view/esp32/SEGGER_RTT_esp32.c

@@ -0,0 +1,215 @@
+// Copyright 2017 Espressif Systems (Shanghai) PTE LTD
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "string.h"
+#include "freertos/FreeRTOS.h"
+#include "SEGGER_RTT.h"
+#include "SEGGER_SYSVIEW.h"
+
+#include "rom/ets_sys.h"
+#include "esp_app_trace.h"
+
+#include "esp_log.h"
+const static char *TAG = "segger_rtt";
+
+#define SYSVIEW_EVENTS_BUF_SZ         255U
+
+// size of down channel data buf
+#define SYSVIEW_DOWN_BUF_SIZE   32
+#define SEGGER_HOST_WAIT_TMO    500 //us
+#define SEGGER_STOP_WAIT_TMO    1000000 //us
+
+static uint8_t s_events_buf[SYSVIEW_EVENTS_BUF_SZ];
+static uint16_t s_events_buf_filled;
+static uint8_t s_down_buf[SYSVIEW_DOWN_BUF_SIZE];
+
+/*********************************************************************
+*
+*       Public code
+*
+**********************************************************************
+*/
+
+/*********************************************************************
+*
+*       SEGGER_RTT_ESP32_FlushNoLock()
+*
+*  Function description
+*    Flushes buffered events.
+*
+*  Parameters
+*    min_sz  Threshold for flushing data. If current filling level is above this value, data will be flushed. TRAX destinations only.
+*    tmo     Timeout for operation (in us). Use ESP_APPTRACE_TMO_INFINITE to wait indefinetly.
+*
+*  Return value
+*    None.
+*/
+void SEGGER_RTT_ESP32_FlushNoLock(unsigned long min_sz, unsigned long tmo)
+{
+    esp_err_t res = esp_apptrace_write(ESP_APPTRACE_DEST_TRAX, s_events_buf, s_events_buf_filled, tmo);
+    if (res != ESP_OK) {
+      ESP_LOGE(TAG, "Failed to flush buffered events (%d)!\n", res);
+    }
+    // flush even if we failed to write buffered events, because no new events will be sent after STOP
+    res = esp_apptrace_flush_nolock(ESP_APPTRACE_DEST_TRAX, min_sz, tmo);
+    if (res != ESP_OK) {
+      ESP_LOGE(TAG, "Failed to flush apptrace data (%d)!\n", res);
+    }
+    s_events_buf_filled = 0;
+}
+
+/*********************************************************************
+*
+*       SEGGER_RTT_ReadNoLock()
+*
+*  Function description
+*    Reads characters from SEGGER real-time-terminal control block
+*    which have been previously stored by the host.
+*    Do not lock against interrupts and multiple access.
+*
+*  Parameters
+*    BufferIndex  Index of Down-buffer to be used (e.g. 0 for "Terminal").
+*    pBuffer      Pointer to buffer provided by target application, to copy characters from RTT-down-buffer to.
+*    BufferSize   Size of the target application buffer.
+*
+*  Return value
+*    Number of bytes that have been read.
+*/
+unsigned SEGGER_RTT_ReadNoLock(unsigned BufferIndex, void* pData, unsigned BufferSize) {
+  uint32_t size = BufferSize;
+  esp_err_t res = esp_apptrace_read(ESP_APPTRACE_DEST_TRAX, pData, &size, 0);
+  if (res != ESP_OK) {
+    return 0;
+  }
+  return size;
+}
+
+/*********************************************************************
+*
+*       SEGGER_RTT_WriteSkipNoLock
+*
+*  Function description
+*    Stores a specified number of characters in SEGGER RTT
+*    control block which is then read by the host.
+*    SEGGER_RTT_WriteSkipNoLock does not lock the application and
+*    skips all data, if the data does not fit into the buffer.
+*
+*  Parameters
+*    BufferIndex  Index of "Up"-buffer to be used (e.g. 0 for "Terminal").
+*    pBuffer      Pointer to character array. Does not need to point to a \0 terminated string.
+*    NumBytes     Number of bytes to be stored in the SEGGER RTT control block.
+*
+*  Return value
+*    Number of bytes which have been stored in the "Up"-buffer.
+*
+*  Notes
+*    (1) If there is not enough space in the "Up"-buffer, all data is dropped.
+*    (2) For performance reasons this function does not call Init()
+*        and may only be called after RTT has been initialized.
+*        Either by calling SEGGER_RTT_Init() or calling another RTT API function first.
+*/
+unsigned SEGGER_RTT_WriteSkipNoLock(unsigned BufferIndex, const void* pBuffer, unsigned NumBytes) {
+  uint8_t *pbuf = (uint8_t *)pBuffer;
+  uint8_t event_id = *pbuf;
+
+  if (NumBytes > SYSVIEW_EVENTS_BUF_SZ) {
+      ESP_LOGE(TAG, "Too large event %u bytes!", NumBytes);
+      return 0;
+  }
+  if (xPortGetCoreID()) { // dual core specific code
+    // use the highest - 1 bit of event ID to indicate core ID
+    // the highest bit can not be used due to event ID encoding method
+    // this reduces supported ID range to [0..63] (for 1 byte IDs) plus [128..16383] (for 2 bytes IDs)
+    if (*pbuf & 0x80) { // 2 bytes ID
+      *(pbuf + 1) |= (1 << 6);
+    } else if (NumBytes != 10 || *pbuf != 0) { // ignore sync sequence
+      *pbuf |= (1 << 6);
+    }
+  }
+  if (s_events_buf_filled + NumBytes > SYSVIEW_EVENTS_BUF_SZ) {
+    esp_err_t res = esp_apptrace_write(ESP_APPTRACE_DEST_TRAX, s_events_buf, s_events_buf_filled, SEGGER_HOST_WAIT_TMO);
+    if (res != ESP_OK) {
+      return 0; // skip current data buffer only, accumulated events are kept
+    }
+    s_events_buf_filled = 0;
+  }
+  memcpy(&s_events_buf[s_events_buf_filled], pBuffer, NumBytes);
+  s_events_buf_filled += NumBytes;
+  if (event_id == SYSVIEW_EVTID_TRACE_STOP) {
+    SEGGER_RTT_ESP32_FlushNoLock(0, SEGGER_STOP_WAIT_TMO);
+  }
+  return NumBytes;
+}
+
+/*********************************************************************
+*
+*       SEGGER_RTT_ConfigUpBuffer
+*
+*  Function description
+*    Run-time configuration of a specific up-buffer (T->H).
+*    Buffer to be configured is specified by index.
+*    This includes: Buffer address, size, name, flags, ...
+*
+*  Parameters
+*    BufferIndex  Index of the buffer to configure.
+*    sName        Pointer to a constant name string.
+*    pBuffer      Pointer to a buffer to be used.
+*    BufferSize   Size of the buffer.
+*    Flags        Operating modes. Define behavior if buffer is full (not enough space for entire message).
+*
+*  Return value
+*    >= 0 - O.K.
+*     < 0 - Error
+*
+*  Additional information
+*    Buffer 0 is configured on compile-time.
+*    May only be called once per buffer.
+*    Buffer name and flags can be reconfigured using the appropriate functions.
+*/
+int SEGGER_RTT_ConfigUpBuffer(unsigned BufferIndex, const char* sName, void* pBuffer, unsigned BufferSize, unsigned Flags) {
+  s_events_buf_filled = 0;
+  return 0;
+}
+
+/*********************************************************************
+*
+*       SEGGER_RTT_ConfigDownBuffer
+*
+*  Function description
+*    Run-time configuration of a specific down-buffer (H->T).
+*    Buffer to be configured is specified by index.
+*    This includes: Buffer address, size, name, flags, ...
+*
+*  Parameters
+*    BufferIndex  Index of the buffer to configure.
+*    sName        Pointer to a constant name string.
+*    pBuffer      Pointer to a buffer to be used.
+*    BufferSize   Size of the buffer.
+*    Flags        Operating modes. Define behavior if buffer is full (not enough space for entire message).
+*
+*  Return value
+*    >= 0  O.K.
+*     < 0  Error
+*
+*  Additional information
+*    Buffer 0 is configured on compile-time.
+*    May only be called once per buffer.
+*    Buffer name and flags can be reconfigured using the appropriate functions.
+*/
+int SEGGER_RTT_ConfigDownBuffer(unsigned BufferIndex, const char* sName, void* pBuffer, unsigned BufferSize, unsigned Flags) {
+  esp_apptrace_down_buffer_config(s_down_buf, sizeof(s_down_buf));
+  return 0;
+}
+
+/*************************** End of file ****************************/

components/app_trace/sys_view/ext/heap_trace_module.c

@@ -1,100 +0,0 @@
-// Copyright 2018 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-#include <stdint.h>
-#include <sdkconfig.h>
-#include "SEGGER_SYSVIEW.h"
-#include "SEGGER_RTT.h"
-#include "esp_app_trace.h"
-#include "freertos/FreeRTOS.h"
-#include "freertos/task.h"
-
-#include "esp_log.h"
-const static char *TAG = "sysview_heap_trace";
-
-#ifdef CONFIG_HEAP_TRACING_STACK_DEPTH
-#define CALLSTACK_SIZE  CONFIG_HEAP_TRACING_STACK_DEPTH
-#else
-#define CALLSTACK_SIZE  0
-#endif
-
-static SEGGER_SYSVIEW_MODULE s_esp_sysview_heap_module = {
-    .sModule = "ESP32 SystemView Heap Tracing Module",
-    .NumEvents = 2,
-};
-
-static bool s_mod_registered;
-
-
-esp_err_t esp_sysview_heap_trace_start(uint32_t tmo)
-{
-    uint32_t tmo_ticks = tmo/(1000*portTICK_PERIOD_MS);
-
-    ESP_EARLY_LOGV(TAG, "%s", __func__);
-    do {
-        if (tmo != (uint32_t)-1) {
-            // Currently timeout implementation is simple and has granularity of 1 OS tick,
-            // so just count down the number of times to call vTaskDelay
-            if (tmo_ticks-- == 0) {
-                return ESP_ERR_TIMEOUT;
-            }
-        }
-        vTaskDelay(1);
-    } while(!SEGGER_SYSVIEW_Started());
-
-    SEGGER_SYSVIEW_RegisterModule(&s_esp_sysview_heap_module);
-    s_mod_registered = true;
-    return ESP_OK;
-}
-
-esp_err_t esp_sysview_heap_trace_stop(void)
-{
-    ESP_EARLY_LOGV(TAG, "%s", __func__);
-    SEGGER_RTT_ESP_Flush(0, ESP_APPTRACE_TMO_INFINITE);
-    return ESP_OK;
-}
-
-void esp_sysview_heap_trace_alloc(const void *addr, uint32_t size, const void *callers)
-{
-    U8  aPacket[SEGGER_SYSVIEW_INFO_SIZE + (2+CALLSTACK_SIZE)*SEGGER_SYSVIEW_QUANTA_U32];
-    U8* pPayload = SEGGER_SYSVIEW_PREPARE_PACKET(aPacket);
-    U32 *calls = (U32 *)callers;
-
-    if (!s_mod_registered) {
-        return;
-    }
-    ESP_EARLY_LOGV(TAG, "%s %p %lu", __func__, addr, size);
-    pPayload = SEGGER_SYSVIEW_EncodeU32(pPayload, (U32)addr);
-    pPayload = SEGGER_SYSVIEW_EncodeU32(pPayload, size);
-    for (int i = 0; i < CALLSTACK_SIZE; i++) {
-        pPayload = SEGGER_SYSVIEW_EncodeU32(pPayload, calls[i]);
-    }
-    SEGGER_SYSVIEW_SendPacket(&aPacket[0], pPayload, s_esp_sysview_heap_module.EventOffset + 0);
-}
-
-void esp_sysview_heap_trace_free(const void *addr, const void *callers)
-{
-    U8  aPacket[SEGGER_SYSVIEW_INFO_SIZE + (1+CALLSTACK_SIZE)*SEGGER_SYSVIEW_QUANTA_U32];
-    U8* pPayload = SEGGER_SYSVIEW_PREPARE_PACKET(aPacket);
-    U32 *calls = (U32 *)callers;
-
-    if (!s_mod_registered) {
-        return;
-    }
-    ESP_EARLY_LOGV(TAG, "%s %p", __func__, addr);
-    pPayload = SEGGER_SYSVIEW_EncodeU32(pPayload, (U32)addr);
-    for (int i = 0; i < CALLSTACK_SIZE; i++) {
-        pPayload = SEGGER_SYSVIEW_EncodeU32(pPayload, calls[i]);
-    }
-    SEGGER_SYSVIEW_SendPacket(&aPacket[0], pPayload, s_esp_sysview_heap_module.EventOffset + 1);
-}

components/app_trace/sys_view/ext/logging.c

@@ -1,34 +0,0 @@
-// Copyright 2018 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-#include <stdio.h>
-#include <stdarg.h>
-#include <sdkconfig.h>
-#include "SEGGER_SYSVIEW_Int.h"
-#include "freertos/FreeRTOS.h"
-
-static portMUX_TYPE s_log_mutex = portMUX_INITIALIZER_UNLOCKED;
-
-int esp_sysview_vprintf(const char * format, va_list args)
-{
-    static char log_buffer[SEGGER_SYSVIEW_MAX_STRING_LEN];
-
-    portENTER_CRITICAL(&s_log_mutex);
-    size_t len = vsnprintf(log_buffer, sizeof(log_buffer), format, args);
-    if (len > sizeof(log_buffer) - 1) {
-        log_buffer[sizeof(log_buffer - 1)] = 0;
-    }
-    SEGGER_SYSVIEW_Print(log_buffer);
-    portEXIT_CRITICAL(&s_log_mutex);
-    return len;
-}

components/app_trace/test/CMakeLists.txt

@@ -1,3 +1,6 @@
-idf_component_register(SRC_DIRS "."
-                    PRIV_INCLUDE_DIRS "."
-                    PRIV_REQUIRES cmock)
+set(COMPONENT_SRCDIRS ".")
+set(COMPONENT_ADD_INCLUDEDIRS ".")
+
+set(COMPONENT_REQUIRES unity)
+
+register_component()

components/app_trace/test/test_trace.c

@@ -5,12 +5,11 @@
 #include <stdarg.h>
 #include "unity.h"
 #include "driver/timer.h"
-#include "esp_rom_sys.h"
 #include "soc/cpu.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/semphr.h"
 #include "freertos/task.h"
-#if CONFIG_APPTRACE_ENABLE == 1
+#if CONFIG_ESP32_APPTRACE_ENABLE == 1
 #include "esp_app_trace.h"
 #include "esp_app_trace_util.h"
 
@@ -32,7 +31,7 @@ const static char *TAG = "esp_apptrace_test";
         else \
             ret = xSemaphoreTake(s_print_lock, portMAX_DELAY); \
         if (ret == pdTRUE) { \
-            esp_rom_printf(format, ##__VA_ARGS__); \
+            ets_printf(format, ##__VA_ARGS__); \
             if (xPortInIsrContext()) \
                 xSemaphoreGiveFromISR(s_print_lock, NULL); \
             else \
@@ -42,7 +41,7 @@ const static char *TAG = "esp_apptrace_test";
 #else
 #define ESP_APPTRACE_TEST_LOG( format, ... )   \
     do { \
-        esp_rom_printf(format, ##__VA_ARGS__); \
+        ets_printf(format, ##__VA_ARGS__); \
     } while(0)
 #endif
 
@@ -83,7 +82,7 @@ static void esp_apptrace_test_timer_init(int timer_group, int timer_idx, uint32_
     timer_enable_intr(timer_group, timer_idx);
 }
 
-#if CONFIG_APPTRACE_SV_ENABLE == 0
+#if CONFIG_SYSVIEW_ENABLE == 0
 #define ESP_APPTRACE_TEST_WRITE(_b_, _s_)            esp_apptrace_write(ESP_APPTRACE_DEST_TRAX, _b_, _s_, ESP_APPTRACE_TMO_INFINITE)
 #define ESP_APPTRACE_TEST_WRITE_FROM_ISR(_b_, _s_)   esp_apptrace_write(ESP_APPTRACE_DEST_TRAX, _b_, _s_, 0UL)
 #define ESP_APPTRACE_TEST_WRITE_NOWAIT(_b_, _s_)     esp_apptrace_write(ESP_APPTRACE_DEST_TRAX, _b_, _s_, 0)
@@ -126,7 +125,7 @@ typedef struct {
 static SemaphoreHandle_t s_print_lock;
 #endif
 
-static uint64_t esp_apptrace_test_ts_get(void);
+static uint64_t esp_apptrace_test_ts_get();
 
 static void esp_apptrace_test_timer_isr(void *arg)
 {
@@ -139,32 +138,72 @@ static void esp_apptrace_test_timer_isr(void *arg)
     if (res != ESP_OK) {
     } else {
         if (0) {
-            esp_rom_printf("tim-%d-%d: Written chunk%d %d bytes, %x\n",
+            ets_printf("tim-%d-%d: Written chunk%d %d bytes, %x\n",
                        tim_arg->group, tim_arg->id, tim_arg->data.wr_cnt, tim_arg->data.buf_sz, tim_arg->data.wr_cnt & tim_arg->data.mask);
         }
         tim_arg->data.wr_err = 0;
     }
 
     tim_arg->data.wr_cnt++;
-    timer_group_clr_intr_status_in_isr(tim_arg->group, tim_arg->id);
-    timer_group_enable_alarm_in_isr(tim_arg->group, tim_arg->id);
+    if (tim_arg->group == 0) {
+        if (tim_arg->id == 0) {
+            TIMERG0.int_clr_timers.t0 = 1;
+            TIMERG0.hw_timer[0].update = 1;
+            TIMERG0.hw_timer[0].config.alarm_en = 1;
+        } else {
+            TIMERG0.int_clr_timers.t1 = 1;
+            TIMERG0.hw_timer[1].update = 1;
+            TIMERG0.hw_timer[1].config.alarm_en = 1;
+        }
+    }
+    if (tim_arg->group == 1) {
+        if (tim_arg->id == 0) {
+            TIMERG1.int_clr_timers.t0 = 1;
+            TIMERG1.hw_timer[0].update = 1;
+            TIMERG1.hw_timer[0].config.alarm_en = 1;
+        } else {
+            TIMERG1.int_clr_timers.t1 = 1;
+            TIMERG1.hw_timer[1].update = 1;
+            TIMERG1.hw_timer[1].config.alarm_en = 1;
+        }
+    }
 }
 
 static void esp_apptrace_test_timer_isr_crash(void *arg)
 {
     esp_apptrace_test_timer_arg_t *tim_arg = (esp_apptrace_test_timer_arg_t *)arg;
 
-    timer_group_clr_intr_status_in_isr(tim_arg->group, tim_arg->id);
-    timer_group_enable_alarm_in_isr(tim_arg->group, tim_arg->id);
+    if (tim_arg->group == 0) {
+        if (tim_arg->id == 0) {
+            TIMERG0.int_clr_timers.t0 = 1;
+            TIMERG0.hw_timer[0].update = 1;
+            TIMERG0.hw_timer[0].config.alarm_en = 1;
+        } else {
+            TIMERG0.int_clr_timers.t1 = 1;
+            TIMERG0.hw_timer[1].update = 1;
+            TIMERG0.hw_timer[1].config.alarm_en = 1;
+        }
+    }
+    if (tim_arg->group == 1) {
+        if (tim_arg->id == 0) {
+            TIMERG1.int_clr_timers.t0 = 1;
+            TIMERG1.hw_timer[0].update = 1;
+            TIMERG1.hw_timer[0].config.alarm_en = 1;
+        } else {
+            TIMERG1.int_clr_timers.t1 = 1;
+            TIMERG1.hw_timer[1].update = 1;
+            TIMERG1.hw_timer[1].config.alarm_en = 1;
+        }
+    }
     if (tim_arg->data.wr_cnt < ESP_APPTRACE_TEST_BLOCKS_BEFORE_CRASH) {
         uint32_t *ts = (uint32_t *)(tim_arg->data.buf + sizeof(uint32_t));
         *ts = (uint32_t)esp_apptrace_test_ts_get();//xthal_get_ccount();//xTaskGetTickCount();
         memset(tim_arg->data.buf + 2 * sizeof(uint32_t), tim_arg->data.wr_cnt & tim_arg->data.mask, tim_arg->data.buf_sz - 2 * sizeof(uint32_t));
         int res = ESP_APPTRACE_TEST_WRITE_FROM_ISR(tim_arg->data.buf, tim_arg->data.buf_sz);
         if (res != ESP_OK) {
-            esp_rom_printf("tim-%d-%d: Failed to write trace %d %x!\n", tim_arg->group, tim_arg->id, res, tim_arg->data.wr_cnt & tim_arg->data.mask);
+            ets_printf("tim-%d-%d: Failed to write trace %d %x!\n", tim_arg->group, tim_arg->id, res, tim_arg->data.wr_cnt & tim_arg->data.mask);
         } else {
-            esp_rom_printf("tim-%d-%d: Written chunk%d %d bytes, %x\n",
+            ets_printf("tim-%d-%d: Written chunk%d %d bytes, %x\n",
                        tim_arg->group, tim_arg->id, tim_arg->data.wr_cnt, tim_arg->data.buf_sz, tim_arg->data.wr_cnt & tim_arg->data.mask);
             tim_arg->data.wr_cnt++;
         }
@@ -209,7 +248,7 @@ static void esp_apptrace_dummy_task(void *p)
 
     i = 0;
     while (!arg->stop) {
-        ESP_APPTRACE_TEST_LOGD("%x: dummy task work %d.%d", xTaskGetCurrentTaskHandle(), cpu_hal_get_core_id(), i++);
+        ESP_APPTRACE_TEST_LOGD("%x: dummy task work %d.%d", xTaskGetCurrentTaskHandle(), xPortGetCoreID(), i++);
         if (tmo_ticks) {
             vTaskDelay(tmo_ticks);
         }
@@ -254,7 +293,7 @@ static void esp_apptrace_test_task(void *p)
                 ESP_APPTRACE_TEST_LOGE("Failed to timer_isr_register (%d)!", res);
                 goto on_fail;
             }
-            *(uint32_t *)arg->timers[i].data.buf = ((uint32_t)inth[i]) | (1 << 31) | (cpu_hal_get_core_id() ? 0x1 : 0);
+            *(uint32_t *)arg->timers[i].data.buf = ((uint32_t)inth[i]) | (1 << 31) | (xPortGetCoreID() ? 0x1 : 0);
             ESP_APPTRACE_TEST_LOGI("%x: start timer %x period %u us", xTaskGetCurrentTaskHandle(), inth[i], arg->timers[i].data.period);
             res = timer_start(arg->timers[i].group, arg->timers[i].id);
             if (res != ESP_OK) {
@@ -264,7 +303,7 @@ static void esp_apptrace_test_task(void *p)
         }
     }
 
-    *(uint32_t *)arg->data.buf = (uint32_t)xTaskGetCurrentTaskHandle() | (cpu_hal_get_core_id() ? 0x1 : 0);
+    *(uint32_t *)arg->data.buf = (uint32_t)xTaskGetCurrentTaskHandle() | (xPortGetCoreID() ? 0x1 : 0);
     arg->data.wr_cnt = 0;
     arg->data.wr_err = 0;
     while (!arg->stop) {
@@ -344,7 +383,7 @@ static void esp_apptrace_test_task_crash(void *p)
 
 static int s_ts_timer_group, s_ts_timer_idx;
 
-static uint64_t esp_apptrace_test_ts_get(void)
+static uint64_t esp_apptrace_test_ts_get()
 {
     uint64_t ts = 0;
     timer_get_counter_value(s_ts_timer_group, s_ts_timer_idx, &ts);
@@ -374,7 +413,7 @@ static void esp_apptrace_test_ts_init(int timer_group, int timer_idx)
     timer_start(timer_group, timer_idx);
 }
 
-static void esp_apptrace_test_ts_cleanup(void)
+static void esp_apptrace_test_ts_cleanup()
 {
     timer_config_t config;
 
@@ -405,7 +444,7 @@ static void esp_apptrace_test(esp_apptrace_test_cfg_t *test_cfg)
 #if ESP_APPTRACE_TEST_USE_PRINT_LOCK == 1
     s_print_lock = xSemaphoreCreateBinary();
     if (!s_print_lock) {
-        esp_rom_printf("%s: Failed to create print lock!", TAG);
+        ets_printf("%s: Failed to create print lock!", TAG);
         return;
     }
     xSemaphoreGive(s_print_lock);
@@ -744,7 +783,7 @@ static void esp_logtrace_task(void *p)
         ESP_LOGI(TAG, "%p: sample print 4 %c", xTaskGetCurrentTaskHandle(), ((i & 0xFF) % 95) + 32);
         ESP_LOGI(TAG, "%p: sample print 5 %f", xTaskGetCurrentTaskHandle(), 1.0);
         ESP_LOGI(TAG, "%p: sample print 6 %f", xTaskGetCurrentTaskHandle(), 3.45);
-        ESP_LOGI(TAG, "%p: logtrace task work %d.%d", xTaskGetCurrentTaskHandle(), cpu_hal_get_core_id(), i);
+        ESP_LOGI(TAG, "%p: logtrace task work %d.%d", xTaskGetCurrentTaskHandle(), xPortGetCoreID(), i);
         if (++i == 10000) {
             break;
         }
@@ -811,8 +850,28 @@ static void esp_sysview_test_timer_isr(void *arg)
 
     //ESP_APPTRACE_TEST_LOGI("tim-%d: IRQ %d/%d\n", tim_arg->id, tim_arg->group, tim_arg->timer);
 
-    timer_group_clr_intr_status_in_isr(tim_arg->group, tim_arg->id);
-    timer_group_enable_alarm_in_isr(tim_arg->group, tim_arg->id);
+    if (tim_arg->group == 0) {
+        if (tim_arg->timer == 0) {
+            TIMERG0.int_clr_timers.t0 = 1;
+            TIMERG0.hw_timer[0].update = 1;
+            TIMERG0.hw_timer[0].config.alarm_en = 1;
+        } else {
+            TIMERG0.int_clr_timers.t1 = 1;
+            TIMERG0.hw_timer[1].update = 1;
+            TIMERG0.hw_timer[1].config.alarm_en = 1;
+        }
+    }
+    if (tim_arg->group == 1) {
+        if (tim_arg->timer == 0) {
+            TIMERG1.int_clr_timers.t0 = 1;
+            TIMERG1.hw_timer[0].update = 1;
+            TIMERG1.hw_timer[0].config.alarm_en = 1;
+        } else {
+            TIMERG1.int_clr_timers.t1 = 1;
+            TIMERG1.hw_timer[1].update = 1;
+            TIMERG1.hw_timer[1].config.alarm_en = 1;
+        }
+    }
 }
 
 static void esp_sysviewtrace_test_task(void *p)

components/app_update/CMakeLists.txt

@@ -1,85 +1,40 @@
-idf_component_register(SRCS "esp_ota_ops.c"
-                            "esp_app_desc.c"
-                    INCLUDE_DIRS "include"
-                    REQUIRES spi_flash partition_table bootloader_support)
+set(COMPONENT_SRCS "esp_ota_ops.c"
+                   "esp_app_desc.c")
+set(COMPONENT_ADD_INCLUDEDIRS "include")
 
-# esp_app_desc structure is added as an undefined symbol because otherwise the
+set(COMPONENT_REQUIRES spi_flash partition_table bootloader_support)
+
+register_component()
+
+# esp_app_desc structure is added as an undefined symbol because otherwise the 
 # linker will ignore this structure as it has no other files depending on it.
-target_link_libraries(${COMPONENT_LIB} INTERFACE "-u esp_app_desc")
-
-if(CONFIG_APP_PROJECT_VER_FROM_CONFIG)
-    # Ignore current PROJECT_VER (which was set in __project_get_revision()).
-    # Gets the version from the CONFIG_APP_PROJECT_VER.
-    idf_build_set_property(PROJECT_VER "${CONFIG_APP_PROJECT_VER}")
-endif()
+target_link_libraries(${COMPONENT_TARGET} "-u esp_app_desc")
 
 # cut PROJECT_VER and PROJECT_NAME to required 32 characters.
-idf_build_get_property(project_ver PROJECT_VER)
-idf_build_get_property(project_name PROJECT_NAME)
-string(SUBSTRING "${project_ver}" 0 31 PROJECT_VER_CUT)
-string(SUBSTRING "${project_name}" 0 31 PROJECT_NAME_CUT)
-message(STATUS "App \"${PROJECT_NAME_CUT}\" version: ${PROJECT_VER_CUT}")
+string(SUBSTRING "${PROJECT_VER}" 0 31 PROJECT_VER_CUT)
+string(SUBSTRING "${PROJECT_NAME}" 0 31 PROJECT_NAME_CUT)
 
 set_source_files_properties(
     SOURCE "esp_app_desc.c"
-    PROPERTIES COMPILE_DEFINITIONS
+    PROPERTIES COMPILE_DEFINITIONS 
     "PROJECT_VER=\"${PROJECT_VER_CUT}\"; PROJECT_NAME=\"${PROJECT_NAME_CUT}\"")
 
-if(NOT BOOTLOADER_BUILD)
-    partition_table_get_partition_info(otadata_offset "--partition-type data --partition-subtype ota" "offset")
-    partition_table_get_partition_info(otadata_size "--partition-type data --partition-subtype ota" "size")
+# Add custom target for generating empty otadata partition for flashing
+if(OTADATA_PARTITION_OFFSET AND OTADATA_PARTITION_SIZE)
+    add_custom_command(OUTPUT "${IDF_BUILD_ARTIFACTS_DIR}/${BLANK_OTADATA_FILE}"
+        COMMAND ${PYTHON} ${IDF_PATH}/components/partition_table/parttool.py
+        --partition-type data --partition-subtype ota -q
+        --partition-table-file ${PARTITION_CSV_PATH} generate_blank_partition_file
+        --output "${IDF_BUILD_ARTIFACTS_DIR}/${BLANK_OTADATA_FILE}")
 
-    # Add custom target for generating empty otadata partition for flashing
-    if(otadata_size AND otadata_offset)
-        idf_build_get_property(build_dir BUILD_DIR)
-        set(blank_otadata_file ${build_dir}/ota_data_initial.bin)
-
-        idf_build_get_property(idf_path IDF_PATH)
-        idf_build_get_property(python PYTHON)
-
-        idf_component_get_property(partition_table_dir partition_table COMPONENT_DIR)
-
-        add_custom_command(OUTPUT ${blank_otadata_file}
-            COMMAND ${python} ${partition_table_dir}/gen_empty_partition.py
-            ${otadata_size} ${blank_otadata_file})
-
-        add_custom_target(blank_ota_data ALL DEPENDS ${blank_otadata_file})
-        add_dependencies(flash blank_ota_data)
-
-        set(otatool_py ${python} ${COMPONENT_DIR}/otatool.py)
-
-        set(esptool_args "--esptool-args;before=${CONFIG_ESPTOOLPY_BEFORE};after=${CONFIG_ESPTOOLPY_AFTER}")
-        set(otatool_args "--partition-table-file;${PARTITION_CSV_PATH}"
-                         "--partition-table-offset;${PARTITION_TABLE_OFFSET}")
-        idf_component_get_property(esptool_py_dir esptool_py COMPONENT_DIR)
-
-        add_custom_target(read_otadata DEPENDS "${PARTITION_CSV_PATH}"
-            COMMAND ${CMAKE_COMMAND}
-            -D IDF_PATH="${idf_path}"
-            -D SERIAL_TOOL="${otatool_py}"
-            -D SERIAL_TOOL_ARGS="${esptool_args};${otatool_args};read_otadata"
-            -D WORKING_DIRECTORY="${build_dir}"
-            -P ${esptool_py_dir}/run_serial_tool.cmake
-            WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}
-            USES_TERMINAL
-            )
-
-        add_custom_target(erase_otadata DEPENDS "${PARTITION_CSV_PATH}"
-            COMMAND ${CMAKE_COMMAND}
-            -D IDF_PATH="${idf_path}"
-            -D SERIAL_TOOL="${otatool_py}"
-            -D SERIAL_TOOL_ARGS="${esptool_args};${otatool_args};erase_otadata"
-            -D WORKING_DIRECTORY="${build_dir}"
-            -P ${esptool_py_dir}/run_serial_tool.cmake
-            WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}
-            USES_TERMINAL
-            )
-
-        idf_component_get_property(main_args esptool_py FLASH_ARGS)
-        idf_component_get_property(sub_args esptool_py FLASH_SUB_ARGS)
-        esptool_py_flash_target(otadata-flash "${main_args}" "${sub_args}")
-        esptool_py_flash_target_image(otadata-flash otadata "${otadata_offset}" "${blank_otadata_file}")
-
-        esptool_py_flash_target_image(flash otadata "${otadata_offset}" "${blank_otadata_file}")
-    endif()
+    add_custom_target(blank_ota_data ALL DEPENDS "${IDF_BUILD_ARTIFACTS_DIR}/${BLANK_OTADATA_FILE}")
+    add_dependencies(flash blank_ota_data)
 endif()
+
+set(otatool_py ${PYTHON} ${COMPONENT_PATH}/otatool.py)
+
+add_custom_target(read_otadata DEPENDS "${PARTITION_CSV_PATH}"
+                COMMAND ${otatool_py} --partition-table-file ${PARTITION_CSV_PATH} read_otadata)
+
+add_custom_target(erase_otadata DEPENDS "${PARTITION_CSV_PATH}"
+                COMMAND ${otatool_py} --partition-table-file ${PARTITION_CSV_PATH} erase_otadata)

components/app_update/Kconfig.projbuild

@@ -22,28 +22,4 @@ menu "Application manager"
             The PROJECT_NAME variable from the build system will not affect the firmware image.
             This value will not be contained in the esp_app_desc structure.
 
-    config APP_PROJECT_VER_FROM_CONFIG
-        bool "Get the project version from Kconfig"
-        default n
-        help
-            If this is enabled, then config item APP_PROJECT_VER will be used for the variable PROJECT_VER.
-            Other ways to set PROJECT_VER will be ignored.
-
-    config APP_PROJECT_VER
-        string "Project version"
-        default "1"
-        depends on APP_PROJECT_VER_FROM_CONFIG
-        help
-            Project version
-
-    config APP_RETRIEVE_LEN_ELF_SHA
-        int "The length of APP ELF SHA is stored in RAM(chars)"
-        default 16
-        range 8 64
-        help
-            At startup, the app will read this many hex characters from the embedded APP ELF SHA-256 hash value
-            and store it in static RAM. This ensures the app ELF SHA-256 value is always available
-            if it needs to be printed by the panic handler code.
-            Changing this value will change the size of a static buffer, in bytes.
-
 endmenu # "Application manager"

components/app_update/Makefile.projbuild

@@ -17,34 +17,29 @@ endif
 
 $(BLANK_OTA_DATA_FILE): partition_table_get_info $(PARTITION_TABLE_CSV_PATH) | check_python_dependencies
 	$(shell if [ "$(OTA_DATA_OFFSET)" != "" ] && [ "$(OTA_DATA_SIZE)" != "" ]; then \
-				$(PYTHON) $(IDF_PATH)/components/partition_table/gen_empty_partition.py $(OTA_DATA_SIZE) $(BLANK_OTA_DATA_FILE); \
+				$(PARTTOOL_PY) --partition-type data --partition-subtype ota --partition-table-file $(PARTITION_TABLE_CSV_PATH) \
+								-q generate_blank_partition_file --output $(BLANK_OTA_DATA_FILE); \
 			fi; )
 	$(eval BLANK_OTA_DATA_FILE = $(shell if [ "$(OTA_DATA_OFFSET)" != "" ] && [ "$(OTA_DATA_SIZE)" != "" ]; then \
 			echo $(BLANK_OTA_DATA_FILE); else echo " "; fi) )
 
 blank_ota_data: $(BLANK_OTA_DATA_FILE)
 
-# If there is no otadata partition, both OTA_DATA_OFFSET and BLANK_OTA_DATA_FILE
+# If there is no otadata partition, both OTA_DATA_OFFSET and BLANK_OTA_DATA_FILE 
 # expand to empty values.
 ESPTOOL_ALL_FLASH_ARGS += $(OTA_DATA_OFFSET) $(BLANK_OTA_DATA_FILE)
 
-ESPTOOL_ARGS := --esptool-args port=$(CONFIG_ESPTOOLPY_PORT) baud=$(CONFIG_ESPTOOLPY_BAUD) before=$(CONFIG_ESPTOOLPY_BEFORE) after=$(CONFIG_ESPTOOLPY_AFTER)
-
 erase_otadata: $(PARTITION_TABLE_CSV_PATH) partition_table_get_info | check_python_dependencies
-	$(OTATOOL_PY) $(ESPTOOL_ARGS) --partition-table-file $(PARTITION_TABLE_CSV_PATH) \
-	--partition-table-offset $(PARTITION_TABLE_OFFSET) \
-	erase_otadata
+	$(OTATOOL_PY) --partition-table-file $(PARTITION_TABLE_CSV_PATH) erase_otadata
 
 read_otadata: $(PARTITION_TABLE_CSV_PATH) partition_table_get_info | check_python_dependencies
-	$(OTATOOL_PY) $(ESPTOOL_ARGS) --partition-table-file $(PARTITION_TABLE_CSV_PATH) \
-	--partition-table-offset $(partition_table_offset) \
-	read_otadata
+	$(OTATOOL_PY) --partition-table-file $(PARTITION_TABLE_CSV_PATH) read_otadata
+
+erase_ota: erase_otadata
+	@echo "WARNING: erase_ota is deprecated. Use erase_otadata instead."
 
 all: blank_ota_data
 flash: blank_ota_data
-ifdef CONFIG_SECURE_FLASH_ENCRYPTION_MODE_DEVELOPMENT
-encrypted-flash: blank_ota_data
-endif
 
 TMP_DEFINES := $(BUILD_DIR_BASE)/app_update/tmp_cppflags.txt
 export TMP_DEFINES

components/app_update/component.mk

@@ -3,54 +3,54 @@
 #
 # (Uses default behaviour of compiling all source files in directory, adding 'include' to include path.)
 
-# esp_app_desc structure is added as an undefined symbol because otherwise the
+# esp_app_desc structure is added as an undefined symbol because otherwise the 
 # linker will ignore this structure as it has no other files depending on it.
 COMPONENT_ADD_LDFLAGS += -u esp_app_desc
 
 ifndef IS_BOOTLOADER_BUILD
-    # If ``CONFIG_APP_PROJECT_VER_FROM_CONFIG`` option is set, the value of ``CONFIG_APP_PROJECT_VER`` will be used
-    # Else, if ``PROJECT_VER`` variable set in project Makefile file, its value will be used.
-    # Else, if the ``$PROJECT_PATH/version.txt`` exists, its contents will be used as ``PROJECT_VER``.
-    # Else, if the project is located inside a Git repository, the output of git describe will be used.
-    # Otherwise, ``PROJECT_VER`` will be "1".
-    ifdef CONFIG_APP_PROJECT_VER_FROM_CONFIG
-        PROJECT_VER:= $(CONFIG_APP_PROJECT_VER)
-    else
-        ifneq ("${PROJECT_VER}", "")
-            PROJECT_VER:= $(PROJECT_VER)
-        else
-            ifneq ("$(wildcard ${PROJECT_PATH}/version.txt)","")
-                PROJECT_VER := $(shell cat ${PROJECT_PATH}/version.txt)
-            else
-                GIT_PROJECT_VER := $(shell cd ${PROJECT_PATH} && git describe --always --tags --dirty 2> /dev/null)
-                ifeq ("${GIT_PROJECT_VER}", "")
-                    PROJECT_VER := "1"
-                    $(info Project is not inside a git repository, or git repository has no commits)
-                    $(info will not use 'git describe' to determine PROJECT_VER.)
-                else
-                    PROJECT_VER:= $(GIT_PROJECT_VER)
-                endif # a git repository
-            endif # version.txt
-        endif # PROJECT_VER
-    endif # CONFIG_APP_PROJECT_VER_FROM_CONFIG
+GET_PROJECT_VER ?=
+ifeq ("${PROJECT_VER}", "")
+ifeq ("$(wildcard ${PROJECT_PATH}/version.txt)","")
 
-    # cut PROJECT_VER and PROJECT_NAME to required 32 characters.
-    PROJECT_VER_CUT  := $(shell echo "$(PROJECT_VER)"  | cut -c 1-31)
-    PROJECT_NAME_CUT := $(shell echo "$(PROJECT_NAME)" | cut -c 1-31)
+GET_PROJECT_VER := $(shell cd ${PROJECT_PATH} && git describe --always --tags --dirty 2> /dev/null)
+ifeq ("${GET_PROJECT_VER}", "")
+GET_PROJECT_VER := "1"
+$(info Project is not inside a git repository, will not use 'git describe' to determine PROJECT_VER.)
+endif
 
-    $(info App "$(PROJECT_NAME_CUT)" version: $(PROJECT_VER_CUT))
+else
+# read from version.txt
+GET_PROJECT_VER := $(shell cat ${PROJECT_PATH}/version.txt)
+endif
+endif
+# If ``PROJECT_VER`` variable set in project Makefile file, its value will be used.
+# Else, if the ``$PROJECT_PATH/version.txt`` exists, its contents will be used as ``PROJECT_VER``.
+# Else, if the project is located inside a Git repository, the output of git describe will be used.
+# Otherwise, ``PROJECT_VER`` will be "1".
 
-    NEW_DEFINES:= "$(PROJECT_VER_CUT) $(PROJECT_NAME_CUT) $(IDF_VER)"
-    ifeq ("$(wildcard ${TMP_DEFINES})","")
-        OLD_DEFINES:= ""
-    else
-        OLD_DEFINES:= "$(shell cat $(TMP_DEFINES))"
-    endif
+ifeq ("${PROJECT_VER}", "")
+PROJECT_VER:= $(GET_PROJECT_VER)
+else
+PROJECT_VER:= $(PROJECT_VER)
+endif
 
-    # If NEW_DEFINES (PROJECT_VER, PROJECT_NAME) were changed then rebuild only esp_app_desc.
-    ifneq (${NEW_DEFINES}, ${OLD_DEFINES})
-        $(shell echo $(NEW_DEFINES) > $(TMP_DEFINES); rm -f esp_app_desc.o;)
-    endif
+# cut PROJECT_VER and PROJECT_NAME to required 32 characters.
+PROJECT_VER_CUT  := $(shell echo "$(PROJECT_VER)"  | cut -c 1-31)
+PROJECT_NAME_CUT := $(shell echo "$(PROJECT_NAME)" | cut -c 1-31)
 
-    esp_app_desc.o: CPPFLAGS += -D PROJECT_VER=\""$(PROJECT_VER_CUT)"\" -D PROJECT_NAME=\""$(PROJECT_NAME_CUT)"\"
-endif # IS_BOOTLOADER_BUILD
+$(info App "$(PROJECT_NAME_CUT)" version: $(PROJECT_VER_CUT))
+
+NEW_DEFINES:= "$(PROJECT_VER_CUT) $(PROJECT_NAME_CUT) $(IDF_VER)"
+ifeq ("$(wildcard ${TMP_DEFINES})","")
+OLD_DEFINES:= ""
+else
+OLD_DEFINES:= "$(shell cat $(TMP_DEFINES))"
+endif
+
+# If NEW_DEFINES (PROJECT_VER, PROJECT_NAME) were changed then rebuild only esp_app_desc.
+ifneq (${NEW_DEFINES}, ${OLD_DEFINES})
+$(shell echo $(NEW_DEFINES) > $(TMP_DEFINES); rm -f esp_app_desc.o;)
+endif
+
+esp_app_desc.o: CPPFLAGS += -D PROJECT_VER=\""$(PROJECT_VER_CUT)"\" -D PROJECT_NAME=\""$(PROJECT_NAME_CUT)"\"
+endif

components/app_update/esp_app_desc.c

@@ -34,8 +34,8 @@ const __attribute__((section(".rodata_desc"))) esp_app_desc_t esp_app_desc = {
 #endif
     .idf_ver = IDF_VER,
 
-#ifdef CONFIG_BOOTLOADER_APP_SECURE_VERSION
-    .secure_version = CONFIG_BOOTLOADER_APP_SECURE_VERSION,
+#ifdef CONFIG_APP_SECURE_VERSION
+    .secure_version = CONFIG_APP_SECURE_VERSION,
 #else
     .secure_version = 0,
 #endif
@@ -72,38 +72,13 @@ static inline char IRAM_ATTR to_hex_digit(unsigned val)
     return (val < 10) ? ('0' + val) : ('a' + val - 10);
 }
 
-__attribute__((constructor)) void esp_ota_init_app_elf_sha256(void)
-{
-    esp_ota_get_app_elf_sha256(NULL, 0);
-}
-
-/* The esp_app_desc.app_elf_sha256 should be possible to print in panic handler during cache is disabled.
- * But because the cache is disabled the reading esp_app_desc.app_elf_sha256 is not right and
- * can lead to a complete lock-up of the CPU.
- * For this reason we do a reading of esp_app_desc.app_elf_sha256 while start up in esp_ota_init_app_elf_sha256()
- * and keep it in the static s_app_elf_sha256 value.
- */
 int IRAM_ATTR esp_ota_get_app_elf_sha256(char* dst, size_t size)
 {
-    static char s_app_elf_sha256[CONFIG_APP_RETRIEVE_LEN_ELF_SHA / 2];
-    static bool first_call = true;
-    if (first_call) {
-        first_call = false;
-        // At -O2 optimization level, GCC optimizes out the copying of the first byte of the app_elf_sha256,
-        // because it is zero at compile time, and only modified afterwards by esptool.
-        // Casting to volatile disables the optimization.
-        const volatile uint8_t* src = (const volatile uint8_t*)esp_app_desc.app_elf_sha256;
-        for (size_t i = 0; i < sizeof(s_app_elf_sha256); ++i) {
-            s_app_elf_sha256[i] = src[i];
-        }
-    }
-    if (dst == NULL || size == 0) {
-        return 0;
-    }
-    size_t n = MIN((size - 1) / 2, sizeof(s_app_elf_sha256));
+    size_t n = MIN((size - 1) / 2, sizeof(esp_app_desc.app_elf_sha256));
+    const uint8_t* src = esp_app_desc.app_elf_sha256;
     for (size_t i = 0; i < n; ++i) {
-        dst[2*i] = to_hex_digit(s_app_elf_sha256[i] >> 4);
-        dst[2*i + 1] = to_hex_digit(s_app_elf_sha256[i] & 0xf);
+        dst[2*i] = to_hex_digit(src[i] >> 4);
+        dst[2*i + 1] = to_hex_digit(src[i] & 0xf);
     }
     dst[2*n] = 0;
     return 2*n + 1;

components/app_update/esp_ota_ops.c

@@ -32,25 +32,26 @@
 #include "sdkconfig.h"
 
 #include "esp_ota_ops.h"
-#include "sys/queue.h"
+#include "rom/queue.h"
+#include "rom/crc.h"
+#include "soc/dport_reg.h"
 #include "esp_log.h"
-#include "esp_flash_partitions.h"
+#include "esp_flash_data_types.h"
 #include "bootloader_common.h"
 #include "sys/param.h"
 #include "esp_system.h"
 #include "esp_efuse.h"
-#include "esp_attr.h"
 
-#define SUB_TYPE_ID(i) (i & 0x0F)
 
-/* Partial_data is word aligned so no reallocation is necessary for encrypted flash write */
+#define SUB_TYPE_ID(i) (i & 0x0F) 
+
 typedef struct ota_ops_entry_ {
     uint32_t handle;
     const esp_partition_t *part;
-    bool need_erase;
+    uint32_t erased_size;
     uint32_t wrote_size;
     uint8_t partial_bytes;
-    WORD_ALIGNED_ATTR uint8_t partial_data[16];
+    uint8_t partial_data[16];
     LIST_ENTRY(ota_ops_entry_) entries;
 } ota_ops_entry_t;
 
@@ -107,12 +108,19 @@ static esp_err_t image_validate(const esp_partition_t *partition, esp_image_load
         return ESP_ERR_OTA_VALIDATE_FAILED;
     }
 
+#ifdef CONFIG_SECURE_SIGNED_ON_UPDATE
+    esp_err_t ret = esp_secure_boot_verify_signature(partition->address, data.image_len);
+    if (ret != ESP_OK) {
+        return ESP_ERR_OTA_VALIDATE_FAILED;
+    }
+#endif
+
     return ESP_OK;
 }
 
 static esp_ota_img_states_t set_new_state_otadata(void)
 {
-#ifdef CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE
+#ifdef CONFIG_APP_ROLLBACK_ENABLE
     ESP_LOGD(TAG, "Monitoring the first boot of the app is enabled.");
     return ESP_OTA_IMG_NEW;
 #else
@@ -143,7 +151,7 @@ esp_err_t esp_ota_begin(const esp_partition_t *partition, size_t image_size, esp
         return ESP_ERR_OTA_PARTITION_CONFLICT;
     }
 
-#ifdef CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE
+#ifdef CONFIG_APP_ROLLBACK_ENABLE
     esp_ota_img_states_t ota_state_running_part;
     if (esp_ota_get_state_partition(running_partition, &ota_state_running_part) == ESP_OK) {
         if (ota_state_running_part == ESP_OTA_IMG_PENDING_VERIFY) {
@@ -153,17 +161,15 @@ esp_err_t esp_ota_begin(const esp_partition_t *partition, size_t image_size, esp
     }
 #endif
 
-    if (image_size != OTA_WITH_SEQUENTIAL_WRITES) {
-        // If input image size is 0 or OTA_SIZE_UNKNOWN, erase entire partition
-        if ((image_size == 0) || (image_size == OTA_SIZE_UNKNOWN)) {
-            ret = esp_partition_erase_range(partition, 0, partition->size);
-        } else {
-            const int aligned_erase_size = (image_size + SPI_FLASH_SEC_SIZE - 1) & ~(SPI_FLASH_SEC_SIZE - 1);
-            ret = esp_partition_erase_range(partition, 0, aligned_erase_size);
-        }
-        if (ret != ESP_OK) {
-            return ret;
-        }
+    // If input image size is 0 or OTA_SIZE_UNKNOWN, erase entire partition
+    if ((image_size == 0) || (image_size == OTA_SIZE_UNKNOWN)) {
+        ret = esp_partition_erase_range(partition, 0, partition->size);
+    } else {
+        ret = esp_partition_erase_range(partition, 0, (image_size / SPI_FLASH_SEC_SIZE + 1) * SPI_FLASH_SEC_SIZE);
+    }
+
+    if (ret != ESP_OK) {
+        return ret;
     }
 
     new_entry = (ota_ops_entry_t *) calloc(sizeof(ota_ops_entry_t), 1);
@@ -173,9 +179,14 @@ esp_err_t esp_ota_begin(const esp_partition_t *partition, size_t image_size, esp
 
     LIST_INSERT_HEAD(&s_ota_ops_entries_head, new_entry, entries);
 
+    if ((image_size == 0) || (image_size == OTA_SIZE_UNKNOWN)) {
+        new_entry->erased_size = partition->size;
+    } else {
+        new_entry->erased_size = image_size;
+    }
+
     new_entry->part = partition;
     new_entry->handle = ++s_ota_ops_last_handle;
-    new_entry->need_erase = (image_size == OTA_WITH_SEQUENTIAL_WRITES);
     *out_handle = new_entry->handle;
     return ESP_OK;
 }
@@ -194,24 +205,10 @@ esp_err_t esp_ota_write(esp_ota_handle_t handle, const void *data, size_t size)
     // find ota handle in linked list
     for (it = LIST_FIRST(&s_ota_ops_entries_head); it != NULL; it = LIST_NEXT(it, entries)) {
         if (it->handle == handle) {
-            if (it->need_erase) {
-                // must erase the partition before writing to it
-                uint32_t first_sector = it->wrote_size / SPI_FLASH_SEC_SIZE;
-                uint32_t last_sector = (it->wrote_size + size) / SPI_FLASH_SEC_SIZE;
-
-                ret = ESP_OK;
-                if ((it->wrote_size % SPI_FLASH_SEC_SIZE) == 0) {
-                    ret = esp_partition_erase_range(it->part, it->wrote_size, ((last_sector - first_sector) + 1) * SPI_FLASH_SEC_SIZE);
-                } else if (first_sector != last_sector) {
-                    ret = esp_partition_erase_range(it->part, (first_sector + 1) * SPI_FLASH_SEC_SIZE, (last_sector - first_sector) * SPI_FLASH_SEC_SIZE);
-                }
-                if (ret != ESP_OK) {
-                    return ret;
-                }
-            }
-
+            // must erase the partition before writing to it
+            assert(it->erased_size > 0 && "must erase the partition before writing to it");
             if (it->wrote_size == 0 && it->partial_bytes == 0 && size > 0 && data_bytes[0] != ESP_IMAGE_HEADER_MAGIC) {
-                ESP_LOGE(TAG, "OTA image has invalid magic byte (expected 0xE9, saw 0x%02x)", data_bytes[0]);
+                ESP_LOGE(TAG, "OTA image has invalid magic byte (expected 0xE9, saw 0x%02x", data_bytes[0]);
                 return ESP_ERR_OTA_VALIDATE_FAILED;
             }
 
@@ -260,70 +257,16 @@ esp_err_t esp_ota_write(esp_ota_handle_t handle, const void *data, size_t size)
     return ESP_ERR_INVALID_ARG;
 }
 
-esp_err_t esp_ota_write_with_offset(esp_ota_handle_t handle, const void *data, size_t size, uint32_t offset)
+esp_err_t esp_ota_end(esp_ota_handle_t handle)
 {
-    const uint8_t *data_bytes = (const uint8_t *)data;
-    esp_err_t ret;
     ota_ops_entry_t *it;
+    esp_err_t ret = ESP_OK;
 
-    if (data == NULL) {
-        ESP_LOGE(TAG, "write data is invalid");
-        return ESP_ERR_INVALID_ARG;
-    }
-
-    // find ota handle in linked list
-    for (it = LIST_FIRST(&s_ota_ops_entries_head); it != NULL; it = LIST_NEXT(it, entries)) {
-        if (it->handle == handle) {
-            // must erase the partition before writing to it
-            assert(it->need_erase == 0 && "must erase the partition before writing to it");
-
-            /* esp_ota_write_with_offset is used to write data in non contiguous manner.
-             * Hence, unaligned data(less than 16 bytes) cannot be cached if flash encryption is enabled.
-             */
-            if (esp_flash_encryption_enabled() && (size % 16)) {
-                ESP_LOGE(TAG, "Size should be 16byte aligned for flash encryption case");
-                return ESP_ERR_INVALID_ARG;
-            }
-            ret = esp_partition_write(it->part, offset, data_bytes, size);
-            if (ret == ESP_OK) {
-                it->wrote_size += size;
-            }
-            return ret;
-        }
-    }
-
-    // OTA handle is not found in linked list
-    ESP_LOGE(TAG,"OTA handle not found");
-    return ESP_ERR_INVALID_ARG;
-}
-
-static ota_ops_entry_t *get_ota_ops_entry(esp_ota_handle_t handle)
-{
-    ota_ops_entry_t *it = NULL;
     for (it = LIST_FIRST(&s_ota_ops_entries_head); it != NULL; it = LIST_NEXT(it, entries)) {
         if (it->handle == handle) {
             break;
         }
     }
-   return it;
-}
-
-esp_err_t esp_ota_abort(esp_ota_handle_t handle)
-{
-    ota_ops_entry_t *it = get_ota_ops_entry(handle);
-
-    if (it == NULL) {
-        return ESP_ERR_NOT_FOUND;
-    }
-    LIST_REMOVE(it, entries);
-    free(it);
-    return ESP_OK;
-}
-
-esp_err_t esp_ota_end(esp_ota_handle_t handle)
-{
-    ota_ops_entry_t *it = get_ota_ops_entry(handle);
-    esp_err_t ret = ESP_OK;
 
     if (it == NULL) {
         return ESP_ERR_NOT_FOUND;
@@ -332,7 +275,7 @@ esp_err_t esp_ota_end(esp_ota_handle_t handle)
     /* 'it' holds the ota_ops_entry_t for 'handle' */
 
     // esp_ota_end() is only valid if some data was written to this handle
-    if (it->wrote_size == 0) {
+    if ((it->erased_size == 0) || (it->wrote_size == 0)) {
         ret = ESP_ERR_INVALID_ARG;
         goto cleanup;
     }
@@ -399,7 +342,7 @@ static esp_err_t esp_rewrite_ota_data(esp_partition_subtype_t subtype)
         return ESP_ERR_NOT_FOUND;
     }
 
-    uint8_t ota_app_count = get_ota_partition_count();
+    int ota_app_count = get_ota_partition_count();
     if (SUB_TYPE_ID(subtype) >= ota_app_count) {
         return ESP_ERR_INVALID_ARG;
     }
@@ -458,7 +401,7 @@ esp_err_t esp_ota_set_boot_partition(const esp_partition_t *partition)
                 return ESP_ERR_NOT_FOUND;
             }
         } else {
-#ifdef CONFIG_BOOTLOADER_APP_ANTI_ROLLBACK
+#ifdef CONFIG_APP_ANTI_ROLLBACK
             esp_app_desc_t partition_app_desc;
             esp_err_t err = esp_ota_get_partition_description(partition, &partition_app_desc);
             if (err != ESP_OK) {
@@ -646,7 +589,7 @@ esp_err_t esp_ota_get_partition_description(const esp_partition_t *partition, es
     return ESP_OK;
 }
 
-#ifdef CONFIG_BOOTLOADER_APP_ANTI_ROLLBACK
+#ifdef CONFIG_APP_ANTI_ROLLBACK
 static esp_err_t esp_ota_set_anti_rollback(void) {
     const esp_app_desc_t *app_desc = esp_ota_get_app_description();
     return esp_efuse_update_secure_version(app_desc->secure_version);
@@ -678,7 +621,7 @@ bool esp_ota_check_rollback_is_possible(void)
     int last_active_ota = (~active_ota)&1;
 
     const esp_partition_t *partition = NULL;
-#ifndef CONFIG_BOOTLOADER_APP_ANTI_ROLLBACK
+#ifndef CONFIG_APP_ANTI_ROLLBACK
     if (valid_otadata[last_active_ota] == false) {
         partition = esp_partition_find_first(ESP_PARTITION_TYPE_APP, ESP_PARTITION_SUBTYPE_APP_FACTORY, NULL);
         if (partition != NULL) {
@@ -694,7 +637,7 @@ bool esp_ota_check_rollback_is_possible(void)
         partition = esp_partition_find_first(ESP_PARTITION_TYPE_APP, ESP_PARTITION_SUBTYPE_APP_OTA_MIN + slot, NULL);
         if (partition != NULL) {
             if(image_validate(partition, ESP_IMAGE_VERIFY_SILENT) == ESP_OK) {
-#ifdef CONFIG_BOOTLOADER_APP_ANTI_ROLLBACK
+#ifdef CONFIG_APP_ANTI_ROLLBACK
                 esp_app_desc_t app_desc;
                 if (esp_ota_get_partition_description(partition, &app_desc) == ESP_OK &&
                     esp_efuse_check_secure_version(app_desc.secure_version) == true) {
@@ -725,7 +668,7 @@ static esp_err_t esp_ota_current_ota_is_workable(bool valid)
             otadata[active_otadata].ota_state = ESP_OTA_IMG_VALID;
             ESP_LOGD(TAG, "OTA[current] partition is marked as VALID");
             esp_err_t err = rewrite_ota_seq(otadata, otadata[active_otadata].ota_seq, active_otadata, otadata_partition);
-#ifdef CONFIG_BOOTLOADER_APP_ANTI_ROLLBACK
+#ifdef CONFIG_APP_ANTI_ROLLBACK
             if (err == ESP_OK) {
                 return esp_ota_set_anti_rollback();
             }
@@ -752,12 +695,12 @@ static esp_err_t esp_ota_current_ota_is_workable(bool valid)
     return ESP_OK;
 }
 
-esp_err_t esp_ota_mark_app_valid_cancel_rollback(void)
+esp_err_t esp_ota_mark_app_valid_cancel_rollback()
 {
     return esp_ota_current_ota_is_workable(true);
 }
 
-esp_err_t esp_ota_mark_app_invalid_rollback_and_reboot(void)
+esp_err_t esp_ota_mark_app_invalid_rollback_and_reboot()
 {
     return esp_ota_current_ota_is_workable(false);
 }
@@ -780,7 +723,7 @@ static int get_last_invalid_otadata(const esp_ota_select_entry_t *two_otadata)
     return num_invalid_otadata;
 }
 
-const esp_partition_t* esp_ota_get_last_invalid_partition(void)
+const esp_partition_t* esp_ota_get_last_invalid_partition()
 {
     esp_ota_select_entry_t otadata[2];
     if (read_otadata(otadata) == NULL) {
@@ -885,86 +828,3 @@ esp_err_t esp_ota_erase_last_boot_app_partition(void)
 
     return ESP_OK;
 }
-
-#if SOC_EFUSE_SECURE_BOOT_KEY_DIGESTS > 1 && CONFIG_SECURE_BOOT_V2_ENABLED
-esp_err_t esp_ota_revoke_secure_boot_public_key(esp_ota_secure_boot_public_key_index_t index)
-{
-    if (!esp_secure_boot_enabled()) {
-        ESP_LOGE(TAG, "Secure boot v2 has not been enabled.");
-        return ESP_FAIL;
-    }
-
-    if (index != SECURE_BOOT_PUBLIC_KEY_INDEX_0 &&
-         index != SECURE_BOOT_PUBLIC_KEY_INDEX_1 &&
-         index != SECURE_BOOT_PUBLIC_KEY_INDEX_2) {
-        ESP_LOGE(TAG, "Invalid Index found for public key revocation %d.", index);
-        return ESP_ERR_INVALID_ARG;
-    }
-
-    esp_image_sig_public_key_digests_t app_digests = { 0 };
-    esp_err_t err = esp_secure_boot_get_signature_blocks_for_running_app(true, &app_digests);
-    if (err != ESP_OK || app_digests.num_digests == 0) {
-        ESP_LOGE(TAG, "This app is not signed, but check signature on update is enabled in config. It won't be possible to verify any update.");
-        return ESP_FAIL;
-    }
-
-    ets_secure_boot_key_digests_t trusted_keys;
-    int ets_status = ets_secure_boot_read_key_digests(&trusted_keys);
-    if (ets_status != ETS_OK) {
-        ESP_LOGE(TAG, "Could not read the secure boot key digests from efuse. Aborting..");
-        return ESP_FAIL;
-    }
-
-    if (trusted_keys.key_digests[index] == NULL) {
-        ESP_LOGI(TAG, "Trusted Key block(%d) already revoked.", index);
-        return ESP_OK;
-    }
-
-    esp_image_sig_public_key_digests_t trusted_digests = { 0 };
-    for (unsigned i = 0; i < SECURE_BOOT_NUM_BLOCKS; i++) {
-        if (i == index) {
-            continue; // omitting - to find if there is a valid key after revoking this digest
-        }
-
-        if (trusted_keys.key_digests[i] != NULL) {
-            bool all_zeroes = true;
-            for (unsigned j = 0; j < ESP_SECURE_BOOT_DIGEST_LEN; j++) {
-                all_zeroes = all_zeroes && (*(uint8_t *)(trusted_keys.key_digests[i] + j) == 0);
-            }
-            if (!all_zeroes) {
-                memcpy(trusted_digests.key_digests[trusted_digests.num_digests++], (uint8_t *)trusted_keys.key_digests[i], ESP_SECURE_BOOT_DIGEST_LEN);
-            } else {
-                ESP_LOGD(TAG, "Empty trusted key block (%d).", i);
-            }
-        }
-    }
-
-    bool match = false;
-    for (unsigned i = 0; i < trusted_digests.num_digests; i++) {
-        if (match == true) {
-            break;
-        }
-
-        for (unsigned j = 0; j < app_digests.num_digests; j++) {
-            if (memcmp(trusted_digests.key_digests[i], app_digests.key_digests[j], ESP_SECURE_BOOT_DIGEST_LEN) == 0) {
-                ESP_LOGI(TAG, "App key block(%d) matches Trusted key block(%d)[%d -> Next active trusted key block].", j, i, i);
-                esp_err_t err = esp_efuse_set_digest_revoke(index);
-                if (err != ESP_OK) {
-                    ESP_LOGE(TAG, "Failed to revoke digest (0x%x).", err);
-                    return ESP_FAIL;
-                }
-                ESP_LOGI(TAG, "Revoked signature block %d.", index);
-                match = true;
-                break;
-            }
-        }
-    }
-
-    if (match == false) {
-        ESP_LOGE(TAG, "Running app doesn't have another valid secure boot key. Cannot revoke current key(%d).", index);
-        return ESP_FAIL;
-    }
-
-    return ESP_OK;
-}
-#endif

components/app_update/include/esp_ota_ops.h

@@ -21,7 +21,7 @@
 #include "esp_err.h"
 #include "esp_partition.h"
 #include "esp_image_format.h"
-#include "esp_flash_partitions.h"
+#include "esp_flash_data_types.h"
 
 #ifdef __cplusplus
 extern "C"
@@ -29,7 +29,6 @@ extern "C"
 #endif
 
 #define OTA_SIZE_UNKNOWN 0xffffffff /*!< Used for esp_ota_begin() if new image size is unknown */
-#define OTA_WITH_SEQUENTIAL_WRITES 0xfffffffe /*!< Used for esp_ota_begin() if new image size is unknown and erase can be done in incremental manner (assuming write operation is in continuous sequence) */
 
 #define ESP_ERR_OTA_BASE                         0x1500                     /*!< Base error code for ota_ops api */
 #define ESP_ERR_OTA_PARTITION_CONFLICT           (ESP_ERR_OTA_BASE + 0x01)  /*!< Error if request was to write or erase the current running partition */
@@ -50,7 +49,7 @@ typedef uint32_t esp_ota_handle_t;
 
 /**
  * @brief   Return esp_app_desc structure. This structure includes app version.
- *
+ * 
  * Return description for running app.
  * @return Pointer to esp_app_desc structure.
  */
@@ -118,29 +117,6 @@ esp_err_t esp_ota_begin(const esp_partition_t* partition, size_t image_size, esp
  */
 esp_err_t esp_ota_write(esp_ota_handle_t handle, const void* data, size_t size);
 
-/**
- * @brief   Write OTA update data to partition
- *
- * This function can write data in non contiguous manner.
- * If flash encryption is enabled, data should be 16 byte aligned.
- *
- * @param handle  Handle obtained from esp_ota_begin
- * @param data    Data buffer to write
- * @param size    Size of data buffer in bytes
- * @param offset  Offset in flash partition
- *
- * @note While performing OTA, if the packets arrive out of order, esp_ota_write_with_offset() can be used to write data in non contiguous manner.
- *       Use of esp_ota_write_with_offset() in combination with esp_ota_write() is not recommended.
- *
- * @return
- *    - ESP_OK: Data was written to flash successfully.
- *    - ESP_ERR_INVALID_ARG: handle is invalid.
- *    - ESP_ERR_OTA_VALIDATE_FAILED: First byte of image contains invalid app image magic byte.
- *    - ESP_ERR_FLASH_OP_TIMEOUT or ESP_ERR_FLASH_OP_FAIL: Flash write failed.
- *    - ESP_ERR_OTA_SELECT_INFO_INVALID: OTA data partition has invalid contents
- */
-esp_err_t esp_ota_write_with_offset(esp_ota_handle_t handle, const void *data, size_t size, uint32_t offset);
-
 /**
  * @brief Finish OTA update and validate newly written app image.
  *
@@ -157,18 +133,6 @@ esp_err_t esp_ota_write_with_offset(esp_ota_handle_t handle, const void *data, s
  */
 esp_err_t esp_ota_end(esp_ota_handle_t handle);
 
-/**
- * @brief Abort OTA update, free the handle and memory associated with it.
- *
- * @param handle obtained from esp_ota_begin().
- *
- * @return
- *    - ESP_OK: Handle and its associated memory is freed successfully.
- *    - ESP_ERR_NOT_FOUND: OTA handle was not found.
- */
-esp_err_t esp_ota_abort(esp_ota_handle_t handle);
-
-
 /**
  * @brief Configure OTA data for a new boot partition
  *
@@ -237,7 +201,7 @@ const esp_partition_t* esp_ota_get_next_update_partition(const esp_partition_t *
 
 /**
  * @brief Returns esp_app_desc structure for app partition. This structure includes app version.
- *
+ * 
  * Returns a description for the requested app partition.
  * @param[in] partition     Pointer to app partition. (only app partition)
  * @param[out] app_desc     Structure of info about app.
@@ -257,7 +221,7 @@ esp_err_t esp_ota_get_partition_description(const esp_partition_t *partition, es
  * @return
  *  - ESP_OK: if successful.
  */
-esp_err_t esp_ota_mark_app_valid_cancel_rollback(void);
+esp_err_t esp_ota_mark_app_valid_cancel_rollback();
 
 /**
  * @brief This function is called to roll back to the previously workable app with reboot.
@@ -269,14 +233,14 @@ esp_err_t esp_ota_mark_app_valid_cancel_rollback(void);
  *  - ESP_FAIL: if not successful.
  *  - ESP_ERR_OTA_ROLLBACK_FAILED: The rollback is not possible due to flash does not have any apps.
  */
-esp_err_t esp_ota_mark_app_invalid_rollback_and_reboot(void);
+esp_err_t esp_ota_mark_app_invalid_rollback_and_reboot();
 
 /**
  * @brief Returns last partition with invalid state (ESP_OTA_IMG_INVALID or ESP_OTA_IMG_ABORTED).
  *
  * @return partition.
  */
-const esp_partition_t* esp_ota_get_last_invalid_partition(void);
+const esp_partition_t* esp_ota_get_last_invalid_partition();
 
 /**
  * @brief Returns state for given partition.
@@ -312,34 +276,6 @@ esp_err_t esp_ota_erase_last_boot_app_partition(void);
  */
 bool esp_ota_check_rollback_is_possible(void);
 
-#if SOC_EFUSE_SECURE_BOOT_KEY_DIGESTS > 1 && (CONFIG_SECURE_BOOT_V2_ENABLED || __DOXYGEN__)
-
-/**
- * Secure Boot V2 public key indexes.
- */
-typedef enum {
-    SECURE_BOOT_PUBLIC_KEY_INDEX_0,     /*!< Points to the 0th index of the Secure Boot v2 public key */
-    SECURE_BOOT_PUBLIC_KEY_INDEX_1,     /*!< Points to the 1st index of the Secure Boot v2 public key */
-    SECURE_BOOT_PUBLIC_KEY_INDEX_2      /*!< Points to the 2nd index of the Secure Boot v2 public key */
-} esp_ota_secure_boot_public_key_index_t;
-
-/**
- * @brief Revokes the old signature digest. To be called in the application after the rollback logic.
- *
- * Relevant for Secure boot v2 on targets where upto 3 key digests can be stored (Key N-1, Key N, Key N+1).
- * When key N-1 used to sign an app is invalidated, an OTA update is to be sent with an app signed with key N-1 & Key N.
- * After successfully booting the OTA app should call this function to revoke Key N-1.
- *
- * @param index - The index of the signature block to be revoked
- *
- * @return
- *        - ESP_OK: If revocation is successful.
- *        - ESP_ERR_INVALID_ARG: If the index of the public key to be revoked is incorrect.
- *        - ESP_FAIL: If secure boot v2 has not been enabled.
- */
-esp_err_t esp_ota_revoke_secure_boot_public_key(esp_ota_secure_boot_public_key_index_t index);
-#endif /* SOC_EFUSE_SECURE_BOOT_KEY_DIGESTS > 1 */
-
 #ifdef __cplusplus
 }
 #endif

components/app_update/otatool.py

@@ -16,25 +16,21 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-from __future__ import division, print_function
-
+from __future__ import print_function, division
 import argparse
-import binascii
-import collections
 import os
-import struct
 import sys
+import binascii
+import subprocess
 import tempfile
+import collections
+import struct
 
-try:
-    from parttool import PARTITION_TABLE_OFFSET, PartitionName, PartitionType, ParttoolTarget
-except ImportError:
-    COMPONENTS_PATH = os.path.expandvars(os.path.join('$IDF_PATH', 'components'))
-    PARTTOOL_DIR = os.path.join(COMPONENTS_PATH, 'partition_table')
-    sys.path.append(PARTTOOL_DIR)
-    from parttool import PARTITION_TABLE_OFFSET, PartitionName, PartitionType, ParttoolTarget
+__version__ = '1.0'
 
-__version__ = '2.0'
+IDF_COMPONENTS_PATH = os.path.expandvars(os.path.join("$IDF_PATH", "components"))
+
+PARTTOOL_PY = os.path.join(IDF_COMPONENTS_PATH, "partition_table", "parttool.py")
 
 SPI_FLASH_SEC_SIZE = 0x2000
 
@@ -46,68 +42,121 @@ def status(msg):
         print(msg)
 
 
-class OtatoolTarget():
+def _invoke_parttool(parttool_args, args, output=False, partition=None):
+    invoke_args = []
 
-    OTADATA_PARTITION = PartitionType('data', 'ota')
+    if partition:
+        invoke_args += [sys.executable, PARTTOOL_PY] + partition
+    else:
+        invoke_args += [sys.executable, PARTTOOL_PY, "--partition-type", "data", "--partition-subtype", "ota"]
 
-    def __init__(self, port=None, baud=None, partition_table_offset=PARTITION_TABLE_OFFSET, partition_table_file=None,
-                 spi_flash_sec_size=SPI_FLASH_SEC_SIZE, esptool_args=[], esptool_write_args=[],
-                 esptool_read_args=[], esptool_erase_args=[]):
-        self.target = ParttoolTarget(port, baud, partition_table_offset, partition_table_file, esptool_args,
-                                     esptool_write_args, esptool_read_args, esptool_erase_args)
-        self.spi_flash_sec_size = spi_flash_sec_size
+    if quiet:
+        invoke_args += ["-q"]
 
-        temp_file = tempfile.NamedTemporaryFile(delete=False)
-        temp_file.close()
-        try:
-            self.target.read_partition(OtatoolTarget.OTADATA_PARTITION, temp_file.name)
-            with open(temp_file.name, 'rb') as f:
-                self.otadata = f.read()
-        finally:
-            os.unlink(temp_file.name)
+    if args.port != "":
+        invoke_args += ["--port", args.port]
 
-    def _check_otadata_partition(self):
-        if not self.otadata:
-            raise Exception('No otadata partition found')
+    if args.partition_table_file:
+        invoke_args += ["--partition-table-file", args.partition_table_file]
 
-    def erase_otadata(self):
-        self._check_otadata_partition()
-        self.target.erase_partition(OtatoolTarget.OTADATA_PARTITION)
+    if args.partition_table_offset:
+        invoke_args += ["--partition-table-offset", args.partition_table_offset]
 
-    def _get_otadata_info(self):
-        info = []
+    invoke_args += parttool_args
 
-        otadata_info = collections.namedtuple('otadata_info', 'seq crc')
+    if output:
+        return subprocess.check_output(invoke_args)
+    else:
+        return subprocess.check_call(invoke_args)
 
-        for i in range(2):
-            start = i * (self.spi_flash_sec_size >> 1)
 
-            seq = bytearray(self.otadata[start:start + 4])
-            crc = bytearray(self.otadata[start + 28:start + 32])
+def _get_otadata_contents(args, check=True):
+    global quiet
 
-            seq = struct.unpack('I', seq)
-            crc = struct.unpack('I', crc)
-            info.append(otadata_info(seq[0], crc[0]))
+    if check:
+        check_args = ["get_partition_info", "--info", "offset", "size"]
 
-        return info
+        quiet = True
+        output = _invoke_parttool(check_args, args, True).split(b" ")
+        quiet = args.quiet
 
-    def _get_partition_id_from_ota_id(self, ota_id):
-        if isinstance(ota_id, int):
-            return PartitionType('app', 'ota_' + str(ota_id))
-        else:
-            return PartitionName(ota_id)
+        if not output:
+            raise RuntimeError("No ota_data partition found")
 
-    def switch_ota_partition(self, ota_id):
-        self._check_otadata_partition()
+    with tempfile.NamedTemporaryFile(delete=False) as f:
+        f_name = f.name
 
-        import gen_esp32part as gen
+    try:
+        invoke_args = ["read_partition", "--output", f_name]
+        _invoke_parttool(invoke_args, args)
+        with open(f_name, "rb") as f:
+            contents = f.read()
+    finally:
+        os.unlink(f_name)
 
-        def is_otadata_info_valid(status):
+    return contents
+
+
+def _get_otadata_status(otadata_contents):
+    status = []
+
+    otadata_status = collections.namedtuple("otadata_status", "seq crc")
+
+    for i in range(2):
+        start = i * (SPI_FLASH_SEC_SIZE >> 1)
+
+        seq = bytearray(otadata_contents[start:start + 4])
+        crc = bytearray(otadata_contents[start + 28:start + 32])
+
+        seq = struct.unpack('>I', seq)
+        crc = struct.unpack('>I', crc)
+
+        status.append(otadata_status(seq[0], crc[0]))
+
+    return status
+
+
+def read_otadata(args):
+    status("Reading ota_data partition contents...")
+    otadata_info = _get_otadata_contents(args)
+    otadata_info = _get_otadata_status(otadata_info)
+
+    print(otadata_info)
+
+    print("\t\t{:11}\t{:8s}|\t{:8s}\t{:8s}".format("OTA_SEQ", "CRC", "OTA_SEQ", "CRC"))
+    print("Firmware:  0x{:8x}  \t 0x{:8x} |\t0x{:8x} \t 0x{:8x}".format(otadata_info[0].seq, otadata_info[0].crc,
+                                                                        otadata_info[1].seq, otadata_info[1].crc))
+
+
+def erase_otadata(args):
+    status("Erasing ota_data partition contents...")
+    _invoke_parttool(["erase_partition"], args)
+    status("Erased ota_data partition contents")
+
+
+def switch_otadata(args):
+    sys.path.append(os.path.join(IDF_COMPONENTS_PATH, "partition_table"))
+    import gen_esp32part as gen
+
+    with tempfile.NamedTemporaryFile(delete=False) as f:
+        f_name = f.name
+
+    try:
+        def is_otadata_status_valid(status):
             seq = status.seq % (1 << 32)
-            crc = binascii.crc32(struct.pack('I', seq), 0xFFFFFFFF) % (1 << 32)
+            crc = hex(binascii.crc32(struct.pack("I", seq), 0xFFFFFFFF) % (1 << 32))
             return seq < (int('0xFFFFFFFF', 16) % (1 << 32)) and status.crc == crc
 
-        partition_table = self.target.partition_table
+        status("Looking for ota app partitions...")
+
+        # In order to get the number of ota app partitions, we need the partition table
+        partition_table = None
+        invoke_args = ["get_partition_info", "--table", f_name]
+
+        _invoke_parttool(invoke_args, args)
+
+        partition_table = open(f_name, "rb").read()
+        partition_table = gen.PartitionTable.from_binary(partition_table)
 
         ota_partitions = list()
 
@@ -122,36 +171,39 @@ class OtatoolTarget():
         ota_partitions = sorted(ota_partitions, key=lambda p: p.subtype)
 
         if not ota_partitions:
-            raise Exception('No ota app partitions found')
+            raise RuntimeError("No ota app partitions found")
+
+        status("Verifying partition to switch to exists...")
 
         # Look for the app partition to switch to
         ota_partition_next = None
 
         try:
-            if isinstance(ota_id, int):
-                ota_partition_next = filter(lambda p: p.subtype - gen.MIN_PARTITION_SUBTYPE_APP_OTA  == ota_id, ota_partitions)
+            if args.name:
+                ota_partition_next = filter(lambda p: p.name == args.name, ota_partitions)
             else:
-                ota_partition_next = filter(lambda p: p.name == ota_id, ota_partitions)
+                ota_partition_next = filter(lambda p: p.subtype - gen.MIN_PARTITION_SUBTYPE_APP_OTA  == args.slot, ota_partitions)
 
             ota_partition_next = list(ota_partition_next)[0]
         except IndexError:
-            raise Exception('Partition to switch to not found')
+            raise RuntimeError("Partition to switch to not found")
 
-        otadata_info = self._get_otadata_info()
+        otadata_contents = _get_otadata_contents(args)
+        otadata_status = _get_otadata_status(otadata_contents)
 
         # Find the copy to base the computation for ota sequence number on
         otadata_compute_base = -1
 
         # Both are valid, take the max as computation base
-        if is_otadata_info_valid(otadata_info[0]) and is_otadata_info_valid(otadata_info[1]):
-            if otadata_info[0].seq >= otadata_info[1].seq:
+        if is_otadata_status_valid(otadata_status[0]) and is_otadata_status_valid(otadata_status[1]):
+            if otadata_status[0].seq >= otadata_status[1].seq:
                 otadata_compute_base = 0
             else:
                 otadata_compute_base = 1
         # Only one copy is valid, use that
-        elif is_otadata_info_valid(otadata_info[0]):
+        elif is_otadata_status_valid(otadata_status[0]):
             otadata_compute_base = 0
-        elif is_otadata_info_valid(otadata_info[1]):
+        elif is_otadata_status_valid(otadata_status[1]):
             otadata_compute_base = 1
         # Both are invalid (could be initial state - all 0xFF's)
         else:
@@ -164,7 +216,7 @@ class OtatoolTarget():
 
         # Find the next ota sequence number
         if otadata_compute_base == 0 or otadata_compute_base == 1:
-            base_seq = otadata_info[otadata_compute_base].seq % (1 << 32)
+            base_seq = otadata_status[otadata_compute_base].seq % (1 << 32)
 
             i = 0
             while base_seq > target_seq % ota_partitions_num + i * ota_partitions_num:
@@ -175,124 +227,90 @@ class OtatoolTarget():
             ota_seq_next = target_seq
 
         # Create binary data from computed values
-        ota_seq_next = struct.pack('I', ota_seq_next)
+        ota_seq_next = struct.pack("I", ota_seq_next)
         ota_seq_crc_next = binascii.crc32(ota_seq_next, 0xFFFFFFFF) % (1 << 32)
-        ota_seq_crc_next = struct.pack('I', ota_seq_crc_next)
+        ota_seq_crc_next = struct.pack("I", ota_seq_crc_next)
 
-        temp_file = tempfile.NamedTemporaryFile(delete=False)
-        temp_file.close()
+        with open(f_name, "wb") as otadata_next_file:
+            start = (1 if otadata_compute_base == 0 else 0) * (SPI_FLASH_SEC_SIZE >> 1)
 
-        try:
-            with open(temp_file.name, 'wb') as otadata_next_file:
-                start = (1 if otadata_compute_base == 0 else 0) * (self.spi_flash_sec_size >> 1)
+            otadata_next_file.write(otadata_contents)
 
-                otadata_next_file.write(self.otadata)
+            otadata_next_file.seek(start)
+            otadata_next_file.write(ota_seq_next)
 
-                otadata_next_file.seek(start)
-                otadata_next_file.write(ota_seq_next)
+            otadata_next_file.seek(start + 28)
+            otadata_next_file.write(ota_seq_crc_next)
 
-                otadata_next_file.seek(start + 28)
-                otadata_next_file.write(ota_seq_crc_next)
+            otadata_next_file.flush()
 
-                otadata_next_file.flush()
-
-            self.target.write_partition(OtatoolTarget.OTADATA_PARTITION, temp_file.name)
-        finally:
-            os.unlink(temp_file.name)
-
-    def read_ota_partition(self, ota_id, output):
-        self.target.read_partition(self._get_partition_id_from_ota_id(ota_id), output)
-
-    def write_ota_partition(self, ota_id, input):
-        self.target.write_partition(self._get_partition_id_from_ota_id(ota_id), input)
-
-    def erase_ota_partition(self, ota_id):
-        self.target.erase_partition(self._get_partition_id_from_ota_id(ota_id))
+        _invoke_parttool(["write_partition", "--input", f_name], args)
+        status("Updated ota_data partition")
+    finally:
+        os.unlink(f_name)
 
 
-def _read_otadata(target):
-    target._check_otadata_partition()
-
-    otadata_info = target._get_otadata_info()
-
-    print('             {:8s} \t  {:8s} | \t  {:8s} \t   {:8s}'.format('OTA_SEQ', 'CRC', 'OTA_SEQ', 'CRC'))
-    print('Firmware:  0x{:08x} \t0x{:08x} | \t0x{:08x} \t 0x{:08x}'.format(otadata_info[0].seq, otadata_info[0].crc,
-          otadata_info[1].seq, otadata_info[1].crc))
+def _get_partition_specifier(args):
+    if args.name:
+        return ["--partition-name", args.name]
+    else:
+        return ["--partition-type", "app", "--partition-subtype", "ota_" + str(args.slot)]
 
 
-def _erase_otadata(target):
-    target.erase_otadata()
-    status('Erased ota_data partition contents')
+def read_ota_partition(args):
+    invoke_args = ["read_partition", "--output", args.output]
+    _invoke_parttool(invoke_args, args, partition=_get_partition_specifier(args))
+    status("Read ota partition contents to file {}".format(args.output))
 
 
-def _switch_ota_partition(target, ota_id):
-    target.switch_ota_partition(ota_id)
+def write_ota_partition(args):
+    invoke_args = ["write_partition", "--input", args.input]
+    _invoke_parttool(invoke_args, args, partition=_get_partition_specifier(args))
+    status("Written contents of file {} to ota partition".format(args.input))
 
 
-def _read_ota_partition(target, ota_id, output):
-    target.read_ota_partition(ota_id, output)
-    status('Read ota partition contents to file {}'.format(output))
-
-
-def _write_ota_partition(target, ota_id, input):
-    target.write_ota_partition(ota_id, input)
-    status('Written contents of file {} to ota partition'.format(input))
-
-
-def _erase_ota_partition(target, ota_id):
-    target.erase_ota_partition(ota_id)
-    status('Erased contents of ota partition')
+def erase_ota_partition(args):
+    invoke_args = ["erase_partition"]
+    _invoke_parttool(invoke_args, args, partition=_get_partition_specifier(args))
+    status("Erased contents of ota partition")
 
 
 def main():
-    if sys.version_info[0] < 3:
-        print('WARNING: Support for Python 2 is deprecated and will be removed in future versions.', file=sys.stderr)
-    elif sys.version_info[0] == 3 and sys.version_info[1] < 6:
-        print('WARNING: Python 3 versions older than 3.6 are not supported.', file=sys.stderr)
     global quiet
 
-    parser = argparse.ArgumentParser('ESP-IDF OTA Partitions Tool')
+    parser = argparse.ArgumentParser("ESP-IDF OTA Partitions Tool")
 
-    parser.add_argument('--quiet', '-q', help='suppress stderr messages', action='store_true')
-    parser.add_argument('--esptool-args', help='additional main arguments for esptool', nargs='+')
-    parser.add_argument('--esptool-write-args', help='additional subcommand arguments for esptool write_flash', nargs='+')
-    parser.add_argument('--esptool-read-args', help='additional subcommand arguments for esptool read_flash', nargs='+')
-    parser.add_argument('--esptool-erase-args', help='additional subcommand arguments for esptool erase_region', nargs='+')
+    parser.add_argument("--quiet", "-q", help="suppress stderr messages", action="store_true")
 
     # There are two possible sources for the partition table: a device attached to the host
     # or a partition table CSV/binary file. These sources are mutually exclusive.
-    parser.add_argument('--port', '-p', help='port where the device to read the partition table from is attached')
+    partition_table_info_source_args = parser.add_mutually_exclusive_group()
 
-    parser.add_argument('--baud', '-b', help='baudrate to use', type=int)
+    partition_table_info_source_args.add_argument("--port", "-p", help="port where the device to read the partition table from is attached", default="")
+    partition_table_info_source_args.add_argument("--partition-table-file", "-f", help="file (CSV/binary) to read the partition table from", default="")
 
-    parser.add_argument('--partition-table-offset', '-o', help='offset to read the partition table from',  type=str)
+    parser.add_argument("--partition-table-offset", "-o", help="offset to read the partition table from", default="0x8000")
 
-    parser.add_argument('--partition-table-file', '-f', help='file (CSV/binary) to read the partition table from; \
-                                                            overrides device attached to specified port as the partition table source when defined')
-
-    subparsers = parser.add_subparsers(dest='operation', help='run otatool -h for additional help')
-
-    spi_flash_sec_size = argparse.ArgumentParser(add_help=False)
-    spi_flash_sec_size.add_argument('--spi-flash-sec-size', help='value of SPI_FLASH_SEC_SIZE macro', type=str)
+    subparsers = parser.add_subparsers(dest="operation", help="run otatool -h for additional help")
 
     # Specify the supported operations
-    subparsers.add_parser('read_otadata', help='read otadata partition', parents=[spi_flash_sec_size])
-    subparsers.add_parser('erase_otadata', help='erase otadata partition')
+    subparsers.add_parser("read_otadata", help="read otadata partition")
+    subparsers.add_parser("erase_otadata", help="erase otadata partition")
 
     slot_or_name_parser = argparse.ArgumentParser(add_help=False)
     slot_or_name_parser_args = slot_or_name_parser.add_mutually_exclusive_group()
-    slot_or_name_parser_args.add_argument('--slot', help='slot number of the ota partition', type=int)
-    slot_or_name_parser_args.add_argument('--name', help='name of the ota partition')
+    slot_or_name_parser_args.add_argument("--slot", help="slot number of the ota partition", type=int)
+    slot_or_name_parser_args.add_argument("--name", help="name of the ota partition")
 
-    subparsers.add_parser('switch_ota_partition', help='switch otadata partition', parents=[slot_or_name_parser, spi_flash_sec_size])
+    subparsers.add_parser("switch_otadata", help="switch otadata partition", parents=[slot_or_name_parser])
 
-    read_ota_partition_subparser = subparsers.add_parser('read_ota_partition', help='read contents of an ota partition', parents=[slot_or_name_parser])
-    read_ota_partition_subparser.add_argument('--output', help='file to write the contents of the ota partition to', required=True)
+    read_ota_partition_subparser = subparsers.add_parser("read_ota_partition", help="read contents of an ota partition", parents=[slot_or_name_parser])
+    read_ota_partition_subparser.add_argument("--output", help="file to write the contents of the ota partition to")
 
-    write_ota_partition_subparser = subparsers.add_parser('write_ota_partition', help='write contents to an ota partition', parents=[slot_or_name_parser])
-    write_ota_partition_subparser.add_argument('--input', help='file whose contents to write to the ota partition')
+    write_ota_partition_subparser = subparsers.add_parser("write_ota_partition", help="write contents to an ota partition", parents=[slot_or_name_parser])
+    write_ota_partition_subparser.add_argument("--input", help="file whose contents to write to the ota partition")
 
-    subparsers.add_parser('erase_ota_partition', help='erase contents of an ota partition', parents=[slot_or_name_parser])
+    subparsers.add_parser("erase_ota_partition", help="erase contents of an ota partition", parents=[slot_or_name_parser])
 
     args = parser.parse_args()
 
@@ -304,84 +322,17 @@ def main():
             parser.print_help()
         sys.exit(1)
 
-    target_args = {}
-
-    if args.port:
-        target_args['port'] = args.port
-
-    if args.partition_table_file:
-        target_args['partition_table_file'] = args.partition_table_file
-
-    if args.partition_table_offset:
-        target_args['partition_table_offset'] = int(args.partition_table_offset, 0)
-
-    try:
-        if args.spi_flash_sec_size:
-            target_args['spi_flash_sec_size'] = int(args.spi_flash_sec_size, 0)
-    except AttributeError:
-        pass
-
-    if args.esptool_args:
-        target_args['esptool_args'] = args.esptool_args
-
-    if args.esptool_write_args:
-        target_args['esptool_write_args'] = args.esptool_write_args
-
-    if args.esptool_read_args:
-        target_args['esptool_read_args'] = args.esptool_read_args
-
-    if args.esptool_erase_args:
-        target_args['esptool_erase_args'] = args.esptool_erase_args
-
-    if args.baud:
-        target_args['baud'] = args.baud
-
-    target = OtatoolTarget(**target_args)
-
-    # Create the operation table and execute the operation
-    common_args = {'target':target}
-
-    ota_id = []
-
-    try:
-        if args.name is not None:
-            ota_id = ['name']
-        else:
-            if args.slot is not None:
-                ota_id = ['slot']
-    except AttributeError:
-        pass
-
-    otatool_ops = {
-        'read_otadata':(_read_otadata, []),
-        'erase_otadata':(_erase_otadata, []),
-        'switch_ota_partition':(_switch_ota_partition, ota_id),
-        'read_ota_partition':(_read_ota_partition, ['output'] + ota_id),
-        'write_ota_partition':(_write_ota_partition, ['input'] + ota_id),
-        'erase_ota_partition':(_erase_ota_partition, ota_id)
-    }
-
-    (op, op_args) = otatool_ops[args.operation]
-
-    for op_arg in op_args:
-        common_args.update({op_arg:vars(args)[op_arg]})
-
-    try:
-        common_args['ota_id'] = common_args.pop('name')
-    except KeyError:
-        try:
-            common_args['ota_id'] = common_args.pop('slot')
-        except KeyError:
-            pass
+    # Else execute the operation
+    operation_func = globals()[args.operation]
 
     if quiet:
         # If exceptions occur, suppress and exit quietly
         try:
-            op(**common_args)
+            operation_func(args)
         except Exception:
             sys.exit(2)
     else:
-        op(**common_args)
+        operation_func(args)
 
 
 if __name__ == '__main__':

components/app_update/project_include.cmake

@@ -0,0 +1,9 @@
+
+# Set empty otadata partition file for flashing, if OTA data partition in
+# partition table
+# (NB: because of component dependency, we know partition_table
+# project_include.cmake has already been included.)
+
+if(OTADATA_PARTITION_OFFSET AND OTADATA_PARTITION_SIZE AND IDF_BUILD_ARTIFACTS)
+    set(BLANK_OTADATA_FILE "ota_data_initial.bin")
+endif()

components/app_update/test/CMakeLists.txt

@@ -1,4 +1,6 @@
-idf_component_register(SRC_DIRS "."
-                       PRIV_INCLUDE_DIRS "."
-                       PRIV_REQUIRES cmock test_utils app_update bootloader_support nvs_flash
-                      )
+set(COMPONENT_SRCDIRS ".")
+set(COMPONENT_ADD_INCLUDEDIRS ".")
+
+set(COMPONENT_REQUIRES unity test_utils app_update bootloader_support nvs_flash)
+
+register_component()

components/app_update/test/test_app_desc.c

@@ -4,7 +4,7 @@
 
 TEST_CASE("esp_ota_get_app_elf_sha256 test", "[esp_app_desc]")
 {
-    const int sha256_hex_len = CONFIG_APP_RETRIEVE_LEN_ELF_SHA;
+    const int sha256_hex_len = 64;
     char dst[sha256_hex_len + 2];
     const char fill = 0xcc;
     int res;

components/app_update/test/test_ota_ops.c

@@ -58,7 +58,7 @@ TEST_CASE("esp_ota_get_next_update_partition logic", "[ota]")
     TEST_ASSERT_NOT_NULL(ota_1);
     TEST_ASSERT_NULL(ota_2); /* this partition shouldn't exist in test partition table */
 
-    TEST_ASSERT_EQUAL_PTR(factory, running); /* this may not be true if/when we get OTA tests that do OTA updates */
+    TEST_ASSERT_EQUAL_PTR(factory, running); /* this may not be true if/when we get OTA tests that do OTA updates */ 
 
     /* (The test steps verify subtypes before verifying pointer equality, because the failure messages are more readable
        this way.)
@@ -84,7 +84,7 @@ TEST_CASE("esp_ota_get_next_update_partition logic", "[ota]")
     TEST_ASSERT_EQUAL_PTR(ota_0, p);
 }
 
-TEST_CASE("esp_ota_get_partition_description", "[ota]")
+TEST_CASE("esp_ota_get_partition_description ", "[ota]")
 {
     const esp_partition_t *running = esp_ota_get_running_partition();
     TEST_ASSERT_NOT_NULL(running);

components/app_update/test/test_switch_ota.c

@@ -1,8 +1,3 @@
-/*
- * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD
- *
- * SPDX-License-Identifier: Apache-2.0
- */
 /*
  * Tests for switching between partitions: factory, OTAx, test.
  */
@@ -10,24 +5,20 @@
 #include <esp_types.h>
 #include <stdio.h>
 #include "string.h"
-#include "sdkconfig.h"
 
-#if CONFIG_IDF_TARGET_ESP32
-#include "esp32/rom/spi_flash.h"
-#include "esp32/rom/rtc.h"
-#elif CONFIG_IDF_TARGET_ESP32S2
-#include "esp32s2/rom/spi_flash.h"
-#include "esp32s2/rom/rtc.h"
-#endif
+#include "rom/spi_flash.h"
+#include "rom/rtc.h"
+#include "rom/ets_sys.h"
 
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
 #include "freertos/semphr.h"
 #include "freertos/queue.h"
+#include "freertos/xtensa_api.h"
 #include "unity.h"
 
 #include "bootloader_common.h"
-#include "../include_bootloader/bootloader_flash_priv.h"
+#include "../include_bootloader/bootloader_flash.h"
 
 #include "esp_log.h"
 #include "esp_ota_ops.h"
@@ -37,8 +28,8 @@
 #include "nvs_flash.h"
 
 #include "driver/gpio.h"
-#include "esp_sleep.h"
 
+#include "sdkconfig.h"
 
 RTC_DATA_ATTR static int boot_count = 0;
 static const char *TAG = "ota_test";
@@ -52,34 +43,9 @@ static void copy_app_partition(esp_ota_handle_t update_handle, const esp_partiti
 {
     const void *partition_bin = NULL;
     spi_flash_mmap_handle_t  data_map;
-    ESP_LOGI(TAG, "start the copy process");
     TEST_ESP_OK(esp_partition_mmap(curr_app, 0, curr_app->size, SPI_FLASH_MMAP_DATA, &partition_bin, &data_map));
     TEST_ESP_OK(esp_ota_write(update_handle, (const void *)partition_bin, curr_app->size));
     spi_flash_munmap(data_map);
-    ESP_LOGI(TAG, "finish the copy process");
-}
-
-/* @brief Copies a current app to next partition using handle.
- *
- * @param[in] update_handle - Handle of API ota.
- * @param[in] cur_app - Current app.
- */
-static void copy_app_partition_with_offset(esp_ota_handle_t update_handle, const esp_partition_t *curr_app)
-{
-    const void *partition_bin = NULL;
-    spi_flash_mmap_handle_t  data_map;
-    ESP_LOGI(TAG, "start the copy process");
-    uint32_t offset = 0, bytes_to_write = curr_app->size;
-    uint32_t write_bytes;
-    while (bytes_to_write > 0) {
-        write_bytes = (bytes_to_write > (4 * 1024)) ? (4 * 1024) : bytes_to_write;
-        TEST_ESP_OK(esp_partition_mmap(curr_app, offset, write_bytes, SPI_FLASH_MMAP_DATA, &partition_bin, &data_map));
-        TEST_ESP_OK(esp_ota_write_with_offset(update_handle, (const void *)partition_bin, write_bytes, offset));
-        spi_flash_munmap(data_map);
-        bytes_to_write -= write_bytes;
-        offset += write_bytes;
-    }
-    ESP_LOGI(TAG, "finish the copy process");
 }
 
 #if defined(CONFIG_BOOTLOADER_FACTORY_RESET) || defined(CONFIG_BOOTLOADER_APP_TEST)
@@ -132,26 +98,6 @@ static void copy_current_app_to_next_part(const esp_partition_t *cur_app_partiti
     TEST_ESP_OK(esp_ota_set_boot_partition(next_app_partition));
 }
 
-/* @brief Copies a current app to next partition (OTA0-15) and then configure OTA data for a new boot partition.
- *
- * @param[in] cur_app_partition - Current app.
- * @param[in] next_app_partition - Next app for boot.
- */
-static void copy_current_app_to_next_part_with_offset(const esp_partition_t *cur_app_partition, const esp_partition_t *next_app_partition)
-{
-    esp_ota_get_next_update_partition(NULL);
-    TEST_ASSERT_NOT_EQUAL(NULL, next_app_partition);
-    ESP_LOGI(TAG, "Writing to partition subtype %d at offset 0x%x", next_app_partition->subtype, next_app_partition->address);
-
-    esp_ota_handle_t update_handle = 0;
-    TEST_ESP_OK(esp_ota_begin(next_app_partition, OTA_SIZE_UNKNOWN, &update_handle));
-
-    copy_app_partition_with_offset(update_handle, cur_app_partition);
-
-    TEST_ESP_OK(esp_ota_end(update_handle));
-    TEST_ESP_OK(esp_ota_set_boot_partition(next_app_partition));
-}
-
 /* @brief Erase otadata partition
  */
 static void erase_ota_data(void)
@@ -165,31 +111,19 @@ static void erase_ota_data(void)
  */
 static void reboot_as_deep_sleep(void)
 {
-    ESP_LOGI(TAG, "reboot as deep sleep");
     esp_sleep_enable_timer_wakeup(2000);
     esp_deep_sleep_start();
 }
 
 /* @brief Copies a current app to next partition (OTA0-15), after that ESP is rebooting and run this (the next) OTAx.
  */
-static void copy_current_app_to_next_part_and_reboot(void)
+static void copy_current_app_to_next_part_and_reboot()
 {
     const esp_partition_t *cur_app = esp_ota_get_running_partition();
-    ESP_LOGI(TAG, "copy current app to next part");
     copy_current_app_to_next_part(cur_app, get_next_update_partition());
     reboot_as_deep_sleep();
 }
 
-/* @brief Copies a current app to next partition (OTA0-15) using esp_ota_write_with_offest(), after that ESP is rebooting and run this (the next) OTAx.
- */
-static void copy_current_app_to_next_part_with_offset_and_reboot(void)
-{
-    const esp_partition_t *cur_app = esp_ota_get_running_partition();
-    ESP_LOGI(TAG, "copy current app to next part");
-    copy_current_app_to_next_part_with_offset(cur_app, get_next_update_partition());
-    reboot_as_deep_sleep();
-}
-
 /* @brief Get running app.
  *
  * @return The next partition of OTA(OTA0-15).
@@ -283,7 +217,7 @@ static void set_output_pin(uint32_t num_pin)
     TEST_ESP_OK(gpio_hold_dis(num_pin));
 
     gpio_config_t io_conf;
-    io_conf.intr_type = GPIO_INTR_DISABLE;
+    io_conf.intr_type = GPIO_PIN_INTR_DISABLE;
     io_conf.mode = GPIO_MODE_OUTPUT;
     io_conf.pin_bit_mask = (1ULL << num_pin);
     io_conf.pull_down_en = 0;
@@ -305,7 +239,7 @@ static void reset_output_pin(uint32_t num_pin)
 
 static void mark_app_valid(void)
 {
-#ifdef CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE
+#ifdef CONFIG_APP_ROLLBACK_ENABLE
     TEST_ESP_OK(esp_ota_mark_app_valid_cancel_rollback());
 #endif
 }
@@ -317,7 +251,6 @@ static void start_test(void)
     ESP_LOGI(TAG, "boot count 1 - reset");
     boot_count = 1;
     erase_ota_data();
-    ESP_LOGI(TAG, "ota_data erased");
     reboot_as_deep_sleep();
 }
 
@@ -330,19 +263,19 @@ static void test_flow1(void)
         case 2:
             ESP_LOGI(TAG, "Factory");
             TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_FACTORY, cur_app->subtype);
-            copy_current_app_to_next_part_and_reboot();
+            copy_current_app_to_next_part_and_reboot(cur_app);
             break;
         case 3:
             ESP_LOGI(TAG, "OTA0");
             TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_OTA_0, cur_app->subtype);
             mark_app_valid();
-            copy_current_app_to_next_part_and_reboot();
+            copy_current_app_to_next_part_and_reboot(cur_app);
             break;
         case 4:
             ESP_LOGI(TAG, "OTA1");
             TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_OTA_1, cur_app->subtype);
             mark_app_valid();
-            copy_current_app_to_next_part_and_reboot();
+            copy_current_app_to_next_part_and_reboot(cur_app);
             break;
         case 5:
             ESP_LOGI(TAG, "OTA0");
@@ -373,7 +306,7 @@ static void test_flow2(void)
         case 2:
             ESP_LOGI(TAG, "Factory");
             TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_FACTORY, cur_app->subtype);
-            copy_current_app_to_next_part_and_reboot();
+            copy_current_app_to_next_part_and_reboot(cur_app);
             break;
         case 3:
             ESP_LOGI(TAG, "OTA0");
@@ -410,13 +343,13 @@ static void test_flow3(void)
         case 2:
             ESP_LOGI(TAG, "Factory");
             TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_FACTORY, cur_app->subtype);
-            copy_current_app_to_next_part_and_reboot();
+            copy_current_app_to_next_part_and_reboot(cur_app);
             break;
         case 3:
             ESP_LOGI(TAG, "OTA0");
             TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_OTA_0, cur_app->subtype);
             mark_app_valid();
-            copy_current_app_to_next_part_and_reboot();
+            copy_current_app_to_next_part_and_reboot(cur_app);
             break;
         case 4:
             ESP_LOGI(TAG, "OTA1");
@@ -453,8 +386,8 @@ static void test_flow4(void)
     boot_count++;
     ESP_LOGI(TAG, "boot count %d", boot_count);
     const esp_partition_t *cur_app = get_running_firmware();
-    nvs_handle_t handle = 0;
-    int32_t boot_count_nvs = 0;
+    nvs_handle handle = 0;
+    int boot_count_nvs = 0;
     switch (boot_count) {
         case 2:
             ESP_LOGI(TAG, "Factory");
@@ -468,7 +401,7 @@ static void test_flow4(void)
             nvs_close(handle);
             nvs_flash_deinit();
 
-            copy_current_app_to_next_part_and_reboot();
+            copy_current_app_to_next_part_and_reboot(cur_app);
             break;
         case 3:
             ESP_LOGI(TAG, "OTA0");
@@ -490,7 +423,7 @@ static void test_flow4(void)
             ESP_LOGI(TAG, "Factory");
             TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_FACTORY, cur_app->subtype);
 
-            int32_t boot_count_nvs;
+            int boot_count_nvs;
             TEST_ESP_OK(nvs_flash_init());
             TEST_ESP_OK(nvs_open(STORAGE_NAMESPACE, NVS_READWRITE, &handle));
             TEST_ESP_ERR(ESP_ERR_NVS_NOT_FOUND, nvs_get_i32(handle, "boot_count", &boot_count_nvs));
@@ -510,7 +443,7 @@ static void test_flow4(void)
 // 2 Stage: run factory -> check it -> copy factory to OTA0          -> reboot  --//--
 // 3 Stage: run OTA0    -> check it -> set_pin_factory_reset         -> reboot  --//--
 // 4 Stage: run factory -> check it -> erase OTA_DATA for next tests -> PASS
-TEST_CASE_MULTIPLE_STAGES("Switching between factory, OTA0, sets pin_factory_reset, factory", "[app_update][timeout=90][ignore][reset=DEEPSLEEP_RESET, DEEPSLEEP_RESET, DEEPSLEEP_RESET]", start_test, test_flow4, test_flow4, test_flow4);
+TEST_CASE_MULTIPLE_STAGES("Switching between factory, OTA0, sets pin_factory_reset, factory", "[app_update][timeout=90][reset=DEEPSLEEP_RESET, DEEPSLEEP_RESET, DEEPSLEEP_RESET]", start_test, test_flow4, test_flow4, test_flow4);
 #endif
 
 #ifdef CONFIG_BOOTLOADER_APP_TEST
@@ -553,7 +486,7 @@ static void test_flow5(void)
 // 2 Stage: run factory    -> check it -> copy factory to Test and set pin_test_app -> reboot  --//--
 // 3 Stage: run test       -> check it -> reset pin_test_app                        -> reboot  --//--
 // 4 Stage: run factory    -> check it -> erase OTA_DATA for next tests             -> PASS
-TEST_CASE_MULTIPLE_STAGES("Switching between factory, test, factory", "[app_update][timeout=90][ignore][reset=DEEPSLEEP_RESET, DEEPSLEEP_RESET, DEEPSLEEP_RESET]", start_test, test_flow5, test_flow5, test_flow5);
+TEST_CASE_MULTIPLE_STAGES("Switching between factory, test, factory", "[app_update][timeout=90][reset=DEEPSLEEP_RESET, DEEPSLEEP_RESET, DEEPSLEEP_RESET]", start_test, test_flow5, test_flow5, test_flow5);
 #endif
 
 static const esp_partition_t* app_update(void)
@@ -585,7 +518,7 @@ static void test_rollback1(void)
             TEST_ESP_ERR(ESP_ERR_NOT_SUPPORTED, esp_ota_get_state_partition(cur_app, &ota_state));
             update_partition = app_update();
             TEST_ESP_OK(esp_ota_get_state_partition(update_partition, &ota_state));
-#ifndef CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE
+#ifndef CONFIG_APP_ROLLBACK_ENABLE
             TEST_ASSERT_EQUAL(ESP_OTA_IMG_UNDEFINED, ota_state);
 #else
             TEST_ASSERT_EQUAL(ESP_OTA_IMG_NEW, ota_state);
@@ -597,7 +530,7 @@ static void test_rollback1(void)
             TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_OTA_0, cur_app->subtype);
             TEST_ASSERT_NULL(esp_ota_get_last_invalid_partition());
             TEST_ESP_OK(esp_ota_get_state_partition(cur_app, &ota_state));
-#ifndef CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE
+#ifndef CONFIG_APP_ROLLBACK_ENABLE
             TEST_ASSERT_EQUAL(ESP_OTA_IMG_UNDEFINED, ota_state);
 #else
             TEST_ASSERT_EQUAL(ESP_OTA_IMG_PENDING_VERIFY, ota_state);
@@ -664,7 +597,7 @@ static void test_rollback2(void)
             TEST_ESP_ERR(ESP_ERR_NOT_SUPPORTED, esp_ota_get_state_partition(cur_app, &ota_state));
             update_partition = app_update();
             TEST_ESP_OK(esp_ota_get_state_partition(update_partition, &ota_state));
-#ifndef CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE
+#ifndef CONFIG_APP_ROLLBACK_ENABLE
             TEST_ASSERT_EQUAL(ESP_OTA_IMG_UNDEFINED, ota_state);
 #else
             TEST_ASSERT_EQUAL(ESP_OTA_IMG_NEW, ota_state);
@@ -676,7 +609,7 @@ static void test_rollback2(void)
             TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_OTA_0, cur_app->subtype);
             TEST_ASSERT_NULL(esp_ota_get_last_invalid_partition());
             TEST_ESP_OK(esp_ota_get_state_partition(cur_app, &ota_state));
-#ifndef CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE
+#ifndef CONFIG_APP_ROLLBACK_ENABLE
             TEST_ASSERT_EQUAL(ESP_OTA_IMG_UNDEFINED, ota_state);
 #else
             TEST_ASSERT_EQUAL(ESP_OTA_IMG_PENDING_VERIFY, ota_state);
@@ -687,7 +620,7 @@ static void test_rollback2(void)
             TEST_ASSERT_EQUAL(ESP_OTA_IMG_VALID, ota_state);
             update_partition = app_update();
             TEST_ESP_OK(esp_ota_get_state_partition(update_partition, &ota_state));
-#ifndef CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE
+#ifndef CONFIG_APP_ROLLBACK_ENABLE
             TEST_ASSERT_EQUAL(ESP_OTA_IMG_UNDEFINED, ota_state);
 #else
             TEST_ASSERT_EQUAL(ESP_OTA_IMG_NEW, ota_state);
@@ -699,7 +632,7 @@ static void test_rollback2(void)
             TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_OTA_1, cur_app->subtype);
             TEST_ASSERT_NULL(esp_ota_get_last_invalid_partition());
             TEST_ESP_OK(esp_ota_get_state_partition(cur_app, &ota_state));
-#ifndef CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE
+#ifndef CONFIG_APP_ROLLBACK_ENABLE
             TEST_ASSERT_EQUAL(ESP_OTA_IMG_UNDEFINED, ota_state);
             TEST_ESP_OK(esp_ota_mark_app_invalid_rollback_and_reboot());
 #else
@@ -732,7 +665,7 @@ static void test_rollback2_1(void)
     TEST_ESP_OK(esp_ota_get_state_partition(cur_app, &ota_state));
     TEST_ASSERT_EQUAL(ESP_OTA_IMG_VALID, ota_state);
     TEST_ESP_OK(esp_ota_get_state_partition(invalid_partition, &ota_state));
-#ifndef CONFIG_BOOTLOADER_APP_ROLLBACK_ENABLE
+#ifndef CONFIG_APP_ROLLBACK_ENABLE
     TEST_ASSERT_EQUAL(ESP_OTA_IMG_INVALID, ota_state);
 #else
     TEST_ASSERT_EQUAL(ESP_OTA_IMG_ABORTED, ota_state);
@@ -797,54 +730,3 @@ static void test_erase_last_app_rollback(void)
 // 4 Stage: run OTA1           -> check it -> erase OTA0 and rollback                          -> reboot
 // 5 Stage: run factory        -> check it -> erase OTA_DATA for next tests                    -> PASS
 TEST_CASE_MULTIPLE_STAGES("Test erase_last_boot_app_partition. factory, OTA1, OTA0, factory", "[app_update][timeout=90][reset=DEEPSLEEP_RESET, DEEPSLEEP_RESET, DEEPSLEEP_RESET, SW_CPU_RESET]", start_test, test_erase_last_app_flow, test_erase_last_app_flow, test_erase_last_app_flow, test_erase_last_app_rollback);
-
-static void test_flow6(void)
-{
-    boot_count++;
-    ESP_LOGI(TAG, "boot count %d", boot_count);
-    const esp_partition_t *cur_app = get_running_firmware();
-    switch (boot_count) {
-        case 2:
-            ESP_LOGI(TAG, "Factory");
-            TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_FACTORY, cur_app->subtype);
-            copy_current_app_to_next_part_with_offset_and_reboot();
-            break;
-        case 3:
-            ESP_LOGI(TAG, "OTA0");
-            TEST_ASSERT_EQUAL(ESP_PARTITION_SUBTYPE_APP_OTA_0, cur_app->subtype);
-            mark_app_valid();
-            erase_ota_data();
-            break;
-        default:
-            erase_ota_data();
-            TEST_FAIL_MESSAGE("Unexpected stage");
-            break;
-    }
-}
-
-// 1 Stage: After POWER_RESET erase OTA_DATA for this test              -> reboot through deep sleep.
-// 2 Stage: run factory -> check it -> copy factory to OTA0             -> reboot  --//--
-// 3 Stage: run OTA0    -> check it -> erase OTA_DATA for next tests    -> PASS
-TEST_CASE_MULTIPLE_STAGES("Switching between factory, OTA0 using esp_ota_write_with_offset", "[app_update][timeout=90][reset=DEEPSLEEP_RESET, DEEPSLEEP_RESET]", start_test, test_flow6, test_flow6);
-
-TEST_CASE("Test bootloader_common_get_sha256_of_partition returns ESP_ERR_IMAGE_INVALID when image is ivalid", "[partitions]")
-{
-    const esp_partition_t *cur_app = esp_ota_get_running_partition();
-    ESP_LOGI(TAG, "copy current app to next part");
-    const esp_partition_t *other_app = get_next_update_partition();
-    copy_current_app_to_next_part(cur_app, other_app);
-    erase_ota_data();
-
-    uint8_t sha_256_cur_app[32];
-    uint8_t sha_256_other_app[32];
-    TEST_ESP_OK(bootloader_common_get_sha256_of_partition(cur_app->address, cur_app->size, cur_app->type, sha_256_cur_app));
-    TEST_ESP_OK(bootloader_common_get_sha256_of_partition(other_app->address, other_app->size, other_app->type, sha_256_other_app));
-
-    TEST_ASSERT_EQUAL_MEMORY_MESSAGE(sha_256_cur_app, sha_256_other_app, sizeof(sha_256_cur_app), "must be the same");
-
-    uint32_t data = 0;
-    bootloader_flash_write(other_app->address + 0x50, &data, sizeof(data), false);
-
-    TEST_ESP_ERR(ESP_ERR_IMAGE_INVALID, bootloader_common_get_sha256_of_partition(other_app->address, other_app->size, other_app->type, sha_256_other_app));
-    TEST_ASSERT_EQUAL_MEMORY_MESSAGE(sha_256_cur_app, sha_256_other_app, sizeof(sha_256_cur_app), "must be the same");
-}

components/asio/CMakeLists.txt

@@ -1,41 +1,6 @@
-if(NOT CONFIG_LWIP_IPV6 AND NOT CMAKE_BUILD_EARLY_EXPANSION)
-    # note: the component is still included in the build so it can become visible again in config
-    # without needing to re-run CMake. However no source or header files are built.
-    message(STATUS "IPV6 support is disabled so the asio component will not be built")
-    idf_component_register()
-    return()
-endif()
+set(COMPONENT_ADD_INCLUDEDIRS asio/asio/include port/include)
+set(COMPONENT_SRCS "asio/asio/src/asio.cpp")
 
-set(asio_sources "asio/asio/src/asio.cpp")
+set(COMPONENT_REQUIRES lwip)
 
-if(CONFIG_ASIO_SSL_SUPPORT)
-    if(CONFIG_ASIO_USE_ESP_OPENSSL)
-        list(APPEND asio_sources
-                "asio/asio/src/asio_ssl.cpp"
-                "port/src/esp_asio_openssl_stubs.c")
-    endif()
-
-    if(CONFIG_ASIO_USE_ESP_WOLFSSL)
-        list(APPEND asio_sources
-                "asio/asio/src/asio_ssl.cpp")
-    endif()
-endif()
-
-idf_component_register(SRCS ${asio_sources}
-                    INCLUDE_DIRS "asio/asio/include" "port/include"
-                    REQUIRES lwip)
-
-if(CONFIG_ASIO_SSL_SUPPORT)
-    if(CONFIG_ASIO_USE_ESP_WOLFSSL)
-        idf_component_get_property(wolflib esp-wolfssl COMPONENT_LIB)
-        idf_component_get_property(wolfdir esp-wolfssl COMPONENT_DIR)
-
-        target_link_libraries(${COMPONENT_LIB} PUBLIC ${wolflib})
-        target_include_directories(${COMPONENT_LIB} PUBLIC ${wolfdir}/wolfssl/wolfssl)
-    endif()
-
-    if(CONFIG_ASIO_USE_ESP_OPENSSL)
-        idf_component_get_property(esp_openssl openssl COMPONENT_LIB)
-        target_link_libraries(${COMPONENT_LIB} PUBLIC ${esp_openssl})
-    endif()
-endif()
+register_component()

components/asio/Kconfig

@@ -1,27 +0,0 @@
-menu "ESP-ASIO"
-    visible if LWIP_IPV6
-
-    config ASIO_SSL_SUPPORT
-        bool "Enable SSL/TLS support of ASIO"
-        default n
-        help
-            Enable support for basic SSL/TLS features, available for mbedTLS/OpenSSL
-            as well as wolfSSL TLS library.
-
-    choice ASIO_SSL_LIBRARY_CHOICE
-        prompt "Choose SSL/TLS library for ESP-TLS (See help for more Info)"
-        default ASIO_USE_ESP_OPENSSL
-        depends on ASIO_SSL_SUPPORT
-        help
-            The ASIO support multiple backend TLS libraries. Currently the mbedTLS with a thin ESP-OpenSSL
-            port layer (default choice) and WolfSSL are supported.
-            Different TLS libraries may support different features and have different resource
-            usage. Consult the ESP-TLS documentation in ESP-IDF Programming guide for more details.
-        config ASIO_USE_ESP_OPENSSL
-            bool "esp-openssl"
-        config ASIO_USE_ESP_WOLFSSL
-            depends on TLS_STACK_WOLFSSL
-            bool "wolfSSL (License info in wolfSSL directory README)"
-    endchoice
-
-endmenu

components/asio/component.mk

@@ -1,13 +1,6 @@
-ifdef CONFIG_LWIP_IPV6
-
 COMPONENT_ADD_INCLUDEDIRS := asio/asio/include port/include
 COMPONENT_PRIV_INCLUDEDIRS := private_include
-COMPONENT_SRCDIRS := asio/asio/src port/src
-
-ifeq ($(CONFIG_ASIO_SSL_SUPPORT), )
-COMPONENT_OBJEXCLUDE := asio/asio/src/asio_ssl.o port/src/esp_asio_openssl_stubs.o
-endif
+COMPONENT_SRCDIRS := asio/asio/src
+COMPONENT_OBJEXCLUDE := asio/asio/src/asio_ssl.o
 
 COMPONENT_SUBMODULES += asio
-
-endif # CONFIG_LWIP_IPV6

components/asio/port/include/esp_asio_config.h

@@ -18,16 +18,12 @@
 // Enabling exceptions only when they are enabled in menuconfig
 //
 # include <sdkconfig.h>
-# ifndef CONFIG_COMPILER_CXX_EXCEPTIONS
+# ifndef CONFIG_CXX_EXCEPTIONS
 #  define ASIO_NO_EXCEPTIONS
-# endif   // CONFIG_COMPILER_CXX_EXCEPTIONS
-
-# ifndef CONFIG_COMPILER_RTTI
-#  define ASIO_NO_TYPEID
-# endif   // CONFIG_COMPILER_RTTI
+# endif   // CONFIG_CXX_EXCEPTIONS
 
 //
-// LWIP compatibility inet and address macros/functions
+// LWIP compatifility inet and address macros/functions
 //
 # define LWIP_COMPAT_SOCKET_INET 1
 # define LWIP_COMPAT_SOCKET_ADDR 1
@@ -38,13 +34,12 @@
 # define ASIO_DISABLE_SERIAL_PORT
 # define ASIO_SEPARATE_COMPILATION
 # define ASIO_STANDALONE
+# define ASIO_NO_TYPEID
+# define ASIO_DISABLE_SIGNAL
 # define ASIO_HAS_PTHREADS
-
-# ifdef CONFIG_ASIO_USE_ESP_OPENSSL
-#  define ASIO_USE_ESP_OPENSSL
-#  define OPENSSL_NO_ENGINE
-# elif CONFIG_ASIO_USE_ESP_WOLFSSL
-#  define ASIO_USE_WOLFSSL
-# endif   // CONFIG_ASIO_USE_ESP_OPENSSL
+# define ASIO_DISABLE_EPOLL
+# define ASIO_DISABLE_EVENTFD
+# define ASIO_DISABLE_SIGNAL
+# define ASIO_DISABLE_SIGACTION
 
 #endif // _ESP_ASIO_CONFIG_H_

components/asio/port/include/esp_exception.h

@@ -18,7 +18,7 @@
 //
 // This exception stub is enabled only if exceptions are disabled in menuconfig
 //
-#if !defined(CONFIG_COMPILER_CXX_EXCEPTIONS) && defined (ASIO_NO_EXCEPTIONS)
+#if !defined(CONFIG_CXX_EXCEPTIONS) && defined (ASIO_NO_EXCEPTIONS)
 
 #include "esp_log.h"
 
@@ -30,10 +30,10 @@ namespace detail {
 template <typename Exception>
 void throw_exception(const Exception& e)
 {
-  ESP_LOGE("esp32_asio_exception", "Caught exception: %s!", e.what());
+  ESP_LOGE("esp32_asio_exception", "Caught exception: %s!", e.what());   
   abort();
 }
 }}
-#endif // CONFIG_COMPILER_CXX_EXCEPTIONS==1 && defined (ASIO_NO_EXCEPTIONS)
+#endif // CONFIG_CXX_EXCEPTIONS==1 && defined (ASIO_NO_EXCEPTIONS)
 
 #endif // _ESP_EXCEPTION_H_

components/asio/port/include/openssl/conf.h

@@ -1,26 +0,0 @@
-// Copyright 2020 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-#ifndef _ESP_ASIO_OPENSSL_CONF_H
-#define _ESP_ASIO_OPENSSL_CONF_H
-#include "esp_asio_config.h"
-#include "openssl/esp_asio_openssl_stubs.h"
-
-#if defined(ASIO_USE_WOLFSSL)
-// SSLv3 Methods not present in current wolfSSL library
-#define OPENSSL_NO_SSL3
-#include_next "openssl/conf.h"
-#endif // ASIO_USE_WOLFSSL
-
-#endif // _ESP_ASIO_OPENSSL_CONF_H

components/asio/port/include/openssl/dh.h

@@ -1,23 +0,0 @@
-// Copyright 2020 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-#ifndef _ESP_ASIO_OPENSSL_DH_STUB_H
-#define _ESP_ASIO_OPENSSL_DH_STUB_H
-// Dummy header needed for ASIO compilation with esp-openssl
-
-#if defined(ASIO_USE_WOLFSSL)
-#include_next "openssl/dh.h"
-#endif // ASIO_USE_WOLFSSL
-
-#endif // _ESP_ASIO_OPENSSL_DH_STUB_H

components/asio/port/include/openssl/esp_asio_openssl_stubs.h

@@ -1,209 +0,0 @@
-// Copyright 2020 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-#ifndef _ESP_ASIO_OPENSSL_STUBS_H
-#define _ESP_ASIO_OPENSSL_STUBS_H
-
-/**
- * @note This header contains openssl API which are NOT implemented, and are only provided
- * as stubs or no-operations to get the ASIO library compiled and working with most
- * practical use cases as an embedded application on ESP platform
- */
-
-#if defined(ASIO_USE_WOLFSSL)
-
-#include "wolfssl/ssl.h"
-// esp-wolfssl disables filesystem by default, but the ssl filesystem functions are needed for the ASIO to compile
-//  - so we could either configure wolfSSL to use filesystem
-//  - or use the default wolfSSL and declare the filesystem functions -- preferred option, as whenever
-//    the filesystem functions are used from app code (potential security impact if private keys in a filesystem)
-//    compilation fails with linking errors.
-
-#if defined(NO_FILESYSTEM)
-// WolfSSL methods that are not included in standard esp-wolfssl config, must be defined here
-// as function stubs,  so ASIO compiles, but would get link errors, if these functions were used.
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-typedef struct WOLFSSL_CTX      WOLFSSL_CTX;
-
-void wolfSSL_CTX_set_verify_depth(WOLFSSL_CTX *ctx,int depth);
-int SSL_CTX_load_verify_locations(WOLFSSL_CTX*, const char*, const char*);
-int SSL_CTX_use_certificate_file(WOLFSSL_CTX*, const char*, int);
-int SSL_CTX_use_certificate_chain_file(WOLFSSL_CTX*, const char*);
-int SSL_CTX_use_PrivateKey_file(WOLFSSL_CTX*, const char*, int);
-int SSL_CTX_use_RSAPrivateKey_file(WOLFSSL_CTX*, const char*, int);
-
-#if defined(__cplusplus)
-} /* extern C */
-#endif
-
-#endif // NO_FILESYSTEM
-
-#elif defined(ASIO_USE_ESP_OPENSSL)
-
-#include "internal/ssl_x509.h"
-#include "internal/ssl_pkey.h"
-#include "mbedtls/pem.h"
-#include <stdint.h>
-
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-
-// The most applicable OpenSSL version wrtt ASIO usage
-#define OPENSSL_VERSION_NUMBER 0x10100001L
-// SSLv2 methods not supported
-// OpenSSL port supports: TLS_ANY, TLS_1, TLS_1_1, TLS_1_2, SSL_3
-#define OPENSSL_NO_SSL2
-#define SSL2_VERSION 0x0002
-
-#define SSL_R_SHORT_READ 219
-#define SSL_OP_ALL 0
-#define SSL_OP_SINGLE_DH_USE 0
-#define SSL_OP_NO_COMPRESSION 0
-// Translates mbedTLS PEM parse error, used by ASIO
-#define PEM_R_NO_START_LINE -MBEDTLS_ERR_PEM_NO_HEADER_FOOTER_PRESENT
-
-#define SSL_OP_NO_SSLv2					0x01000000L
-#define SSL_OP_NO_SSLv3					0x02000000L
-#define SSL_OP_NO_TLSv1					0x04000000L
-
-#define X509_FILETYPE_PEM	1
-#define X509_FILETYPE_ASN1	2
-#define SSL_FILETYPE_ASN1	X509_FILETYPE_ASN1
-#define SSL_FILETYPE_PEM	X509_FILETYPE_PEM
-
-#define NID_subject_alt_name 85
-
-
-#define GEN_DNS		2
-#define GEN_IPADD	7
-#define V_ASN1_OCTET_STRING		4
-#define V_ASN1_IA5STRING		22
-#define NID_commonName 13
-
-#define SSL_CTX_get_app_data(ctx) ((void*)SSL_CTX_get_ex_data(ctx, 0))
-
-/**
-* @brief Frees DH object -- not implemented
-*
-* Current implementation calls SSL_ASSERT
-*
-* @param r DH object
-*/
-void DH_free(DH *r);
-
-/**
- * @brief Frees GENERAL_NAMES -- not implemented
- *
- * Current implementation calls SSL_ASSERT
- *
- * @param r GENERAL_NAMES object
- */
-void GENERAL_NAMES_free(GENERAL_NAMES * gens);
-
-/**
- * @brief Returns subject name from X509 -- not implemented
- *
- * Current implementation calls SSL_ASSERT
- *
- * @param r X509 object
- */
-X509_NAME *X509_get_subject_name(X509 *a);
-
-/**
- * @brief API provaded as declaration only
- *
- */
-int	X509_STORE_CTX_get_error_depth(X509_STORE_CTX *ctx);
-
-/**
- * @brief API provaded as declaration only
- *
- */
-int X509_NAME_get_index_by_NID(X509_NAME *name, int nid, int lastpos);
-
-/**
- * @brief API provaded as declaration only
- *
- */
-X509_NAME_ENTRY *X509_NAME_get_entry(X509_NAME *name, int loc);
-
-/**
- * @brief API provaded as declaration only
- *
- */
-ASN1_STRING *X509_NAME_ENTRY_get_data(X509_NAME_ENTRY *ne);
-
-/**
- * @brief API provaded as declaration only
- *
- */
-void *X509_get_ext_d2i(X509 *x, int nid, int *crit, int *idx);
-
-/**
- * @brief API provaded as declaration only
- *
- */
-X509 *	X509_STORE_CTX_get_current_cert(X509_STORE_CTX *ctx);
-
-/**
- * @brief Reads DH params from a bio object -- not implemented
- *
- * Current implementation calls SSL_ASSERT
- */
-DH *PEM_read_bio_DHparams(BIO *bp, DH **x, pem_password_cb *cb, void *u);
-
-/**
- * @brief API provaded as declaration only
- *
- */
-void *	X509_STORE_CTX_get_ex_data(X509_STORE_CTX *ctx,int idx);
-
-/**
- * @brief Sets DH params to ssl ctx -- not implemented
- *
- * Current implementation calls SSL_ASSERT
- */
-int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh);
-
-/**
- * @brief API provaded as declaration only
- *
- */
-void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, void *data);
-
-/**
- * @brief API provaded as declaration only
- *
- */
-void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, pem_password_cb *cb);
-
-/**
- * @brief Clears any existing chain associated with the current certificate of ctx.
- *
- */
-int SSL_CTX_clear_chain_certs(SSL_CTX *ctx);
-
-#if defined(__cplusplus)
-} /* extern C */
-#endif
-
-#endif /* ASIO_USE_ESP_OPENSSL, ASIO_USE_WOLFSSL */
-#endif /* _ESP_ASIO_OPENSSL_STUBS_H */

components/asio/port/include/openssl/rsa.h

@@ -1,23 +0,0 @@
-// Copyright 2020 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-#ifndef _ESP_ASIO_OPENSSL_RSA_STUB_H
-#define _ESP_ASIO_OPENSSL_RSA_STUB_H
-// Dummy header needed for ASIO compilation with esp-openssl
-
-#if defined(ASIO_USE_WOLFSSL)
-#include_next "openssl/rsa.h"
-#endif // ASIO_USE_WOLFSSL
-
-#endif // _ESP_ASIO_OPENSSL_RSA_STUB_H

components/asio/port/include/openssl/x509v3.h

@@ -1,23 +0,0 @@
-// Copyright 2020 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-#ifndef _ESP_ASIO_OPENSSL_X509V3_STUB_H
-#define _ESP_ASIO_OPENSSL_X509V3_STUB_H
-// Dummy header needed for ASIO compilation with esp-openssl
-
-#if defined(ASIO_USE_WOLFSSL)
-#include_next "openssl/x509v3.h"
-#endif // ASIO_USE_WOLFSSL
-
-#endif // _ESP_ASIO_OPENSSL_X509V3_STUB_H

components/asio/port/src/esp_asio_openssl_stubs.c

@@ -1,55 +0,0 @@
-// Copyright 2020 Espressif Systems (Shanghai) PTE LTD
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-
-#include "esp_asio_config.h"
-#include "internal/ssl_dbg.h"
-#include "openssl/esp_asio_openssl_stubs.h"
-
-// Unsupported features as macros to make the assertions more readable
-#define ESP_OPENSSL_DH_IS_SUPPORTED 0
-#define ESP_OPENSSL_GENERAL_NAMES_IS_SUPPORTED 0
-
-void DH_free (DH *r)
-{
-    SSL_ASSERT3(ESP_OPENSSL_DH_IS_SUPPORTED);
-}
-
-DH *PEM_read_bio_DHparams(BIO *bp, DH **x, pem_password_cb *cb, void *u)
-{
-    SSL_ASSERT2(ESP_OPENSSL_DH_IS_SUPPORTED);
-    return NULL;
-}
-
-int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh)
-{
-    SSL_ASSERT1(ESP_OPENSSL_DH_IS_SUPPORTED);
-    return -1;
-}
-
-void GENERAL_NAMES_free(GENERAL_NAMES * gens)
-{
-    SSL_ASSERT3(ESP_OPENSSL_GENERAL_NAMES_IS_SUPPORTED);
-}
-
-X509_NAME *X509_get_subject_name(X509 *a)
-{
-    SSL_ASSERT2(ESP_OPENSSL_GENERAL_NAMES_IS_SUPPORTED);
-    return NULL;
-}
-
-int SSL_CTX_clear_chain_certs(SSL_CTX *ctx)
-{
-    return 1;
-}

components/aws_iot/CMakeLists.txt

@@ -0,0 +1,30 @@
+if(CONFIG_AWS_IOT_SDK)
+    set(COMPONENT_ADD_INCLUDEDIRS "include aws-iot-device-sdk-embedded-C/include")
+    set(aws_sdk_dir aws-iot-device-sdk-embedded-C/src)
+    set(COMPONENT_SRCS "${aws_sdk_dir}/aws_iot_jobs_interface.c"
+                   "${aws_sdk_dir}/aws_iot_jobs_json.c"
+                   "${aws_sdk_dir}/aws_iot_jobs_topics.c"
+                   "${aws_sdk_dir}/aws_iot_jobs_types.c"
+                   "${aws_sdk_dir}/aws_iot_json_utils.c"
+                   "${aws_sdk_dir}/aws_iot_mqtt_client.c"
+                   "${aws_sdk_dir}/aws_iot_mqtt_client_common_internal.c"
+                   "${aws_sdk_dir}/aws_iot_mqtt_client_connect.c"
+                   "${aws_sdk_dir}/aws_iot_mqtt_client_publish.c"
+                   "${aws_sdk_dir}/aws_iot_mqtt_client_subscribe.c"
+                   "${aws_sdk_dir}/aws_iot_mqtt_client_unsubscribe.c"
+                   "${aws_sdk_dir}/aws_iot_mqtt_client_yield.c"
+                   "${aws_sdk_dir}/aws_iot_shadow.c"
+                   "${aws_sdk_dir}/aws_iot_shadow_actions.c"
+                   "${aws_sdk_dir}/aws_iot_shadow_json.c"
+                   "${aws_sdk_dir}/aws_iot_shadow_records.c"
+                   "port/network_mbedtls_wrapper.c"
+                   "port/threads_freertos.c"
+                   "port/timer.c")
+else()
+    message(STATUS "Building empty aws_iot component due to configuration")
+endif()
+
+set(COMPONENT_REQUIRES "mbedtls")
+set(COMPONENT_PRIV_REQUIRES "jsmn")
+
+register_component()

components/aws_iot/Kconfig

@@ -0,0 +1,164 @@
+menuconfig AWS_IOT_SDK
+    bool "Amazon Web Services IoT Platform"
+    help
+        Select this option to enable support for the AWS IoT platform,
+        via the esp-idf component for the AWS IoT Device C SDK.
+
+config AWS_IOT_MQTT_HOST
+    string "AWS IoT Endpoint Hostname"
+    depends on AWS_IOT_SDK
+    default ""
+    help
+        Default endpoint host name to connect to AWS IoT MQTT/S gateway
+
+        This is the custom endpoint hostname and is specific to an AWS
+        IoT account. You can find it by logging into your AWS IoT
+        Console and clicking the Settings button. The endpoint hostname
+        is shown under the "Custom Endpoint" heading on this page.
+
+        If you need per-device hostnames for different regions or
+        accounts, you can override the default hostname in your app.
+
+config AWS_IOT_MQTT_PORT
+    int "AWS IoT MQTT Port"
+    depends on AWS_IOT_SDK
+    default 8883
+    range 0 65535
+    help
+        Default port number to connect to AWS IoT MQTT/S gateway
+
+        If you need per-device port numbers for different regions, you can
+        override the default port number in your app.
+
+
+config AWS_IOT_MQTT_TX_BUF_LEN
+    int "MQTT TX Buffer Length"
+    depends on AWS_IOT_SDK
+    default 512
+    range 32 65536
+    help
+        Maximum MQTT transmit buffer size. This is the maximum MQTT
+        message length (including protocol overhead) which can be sent.
+
+        Sending longer messages will fail.
+
+config AWS_IOT_MQTT_RX_BUF_LEN
+    int "MQTT RX Buffer Length"
+    depends on AWS_IOT_SDK
+    default 512
+    range 32 65536
+    help
+        Maximum MQTT receive buffer size. This is the maximum MQTT
+        message length (including protocol overhead) which can be
+        received.
+
+        Longer messages are dropped.
+
+
+
+config AWS_IOT_MQTT_NUM_SUBSCRIBE_HANDLERS
+    int "Maximum MQTT Topic Filters"
+    depends on AWS_IOT_SDK
+    default 5
+    range 1 100
+    help
+        Maximum number of concurrent MQTT topic filters.
+
+
+config AWS_IOT_MQTT_MIN_RECONNECT_WAIT_INTERVAL
+    int "Auto reconnect initial interval (ms)"
+    depends on AWS_IOT_SDK
+    default 1000
+    range 10 3600000
+    help
+        Initial delay before making first reconnect attempt, if the AWS IoT connection fails.
+        Client will perform exponential backoff, starting from this value.
+
+config AWS_IOT_MQTT_MAX_RECONNECT_WAIT_INTERVAL
+    int "Auto reconnect maximum interval (ms)"
+    depends on AWS_IOT_SDK
+    default 128000
+    range 10 3600000
+    help
+        Maximum delay between reconnection attempts. If the exponentially increased delay
+        interval reaches this value, the client will stop automatically attempting to reconnect.
+
+menu "Thing Shadow"
+    depends on AWS_IOT_SDK
+
+    config AWS_IOT_OVERRIDE_THING_SHADOW_RX_BUFFER
+        bool "Override Shadow RX buffer size"
+        depends on AWS_IOT_SDK
+        default n
+        help
+            Allows setting a different Thing Shadow RX buffer
+            size. This is the maximum size of a Thing Shadow
+            message in bytes, plus one.
+
+            If not overridden, the default value is the MQTT RX Buffer length plus one. If overriden, do not set
+            higher than the default value.
+
+    config AWS_IOT_SHADOW_MAX_SIZE_OF_RX_BUFFER
+        int "Maximum RX Buffer (bytes)"
+        depends on AWS_IOT_OVERRIDE_THING_SHADOW_RX_BUFFER
+        default 513
+        range 32 65536
+        help
+            Allows setting a different Thing Shadow RX buffer size.
+            This is the maximum size of a Thing Shadow message in bytes,
+            plus one.
+
+
+    config AWS_IOT_SHADOW_MAX_SIZE_OF_UNIQUE_CLIENT_ID_BYTES
+        int "Maximum unique client ID size (bytes)"
+        depends on AWS_IOT_SDK
+        default 80
+        range 4 1000
+        help
+            Maximum size of the Unique Client Id.
+
+    config AWS_IOT_SHADOW_MAX_SIMULTANEOUS_ACKS
+        int "Maximum simultaneous responses"
+        depends on AWS_IOT_SDK
+        default 10
+        range 1 100
+        help
+            At any given time we will wait for this many responses. This will correlate to the rate at which the
+            shadow actions are requested
+
+    config AWS_IOT_SHADOW_MAX_SIMULTANEOUS_THINGNAMES
+        int "Maximum simultaneous Thing Name operations"
+        depends on AWS_IOT_SDK
+        default 10
+        range 1 100
+        help
+            We could perform shadow action on any thing Name and this is maximum Thing Names we can act on at any
+            given time
+
+    config AWS_IOT_SHADOW_MAX_JSON_TOKEN_EXPECTED
+        int "Maximum expected JSON tokens"
+        depends on AWS_IOT_SDK
+        default 120
+        help
+            These are the max tokens that is expected to be in the Shadow JSON document. Includes the metadata which
+            is published
+
+    config AWS_IOT_SHADOW_MAX_SHADOW_TOPIC_LENGTH_WITHOUT_THINGNAME
+        int "Maximum topic length (not including Thing Name)"
+        depends on AWS_IOT_SDK
+        default 60
+        range 10 1000
+        help
+            All shadow actions have to be published or subscribed to a topic which is of the format
+            $aws/things/{thingName}/shadow/update/accepted. This refers to the size of the topic without the Thing
+            Name
+
+    config AWS_IOT_SHADOW_MAX_SIZE_OF_THING_NAME
+        int "Maximum Thing Name length"
+        depends on AWS_IOT_SDK
+        default 20
+        range 4 1000
+        help
+            Maximum length of a Thing Name.
+
+endmenu  # Thing Shadow

components/aws_iot/component.mk

@@ -0,0 +1,20 @@
+#
+# Component Makefile
+#
+
+ifdef CONFIG_AWS_IOT_SDK
+
+COMPONENT_ADD_INCLUDEDIRS := include aws-iot-device-sdk-embedded-C/include
+
+COMPONENT_SRCDIRS := aws-iot-device-sdk-embedded-C/src port
+
+# Check the submodule is initialised
+COMPONENT_SUBMODULES := aws-iot-device-sdk-embedded-C
+
+
+else
+# Disable AWS IoT support
+COMPONENT_ADD_INCLUDEDIRS :=
+COMPONENT_ADD_LDFLAGS :=
+COMPONENT_SRCDIRS :=
+endif

components/aws_iot/include/aws_iot_config.h

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+/**
+ * @file aws_iot_config.h
+ * @brief AWS IoT specific configuration file
+ */
+
+#ifndef _AWS_IOT_CONFIG_H_
+#define _AWS_IOT_CONFIG_H_
+
+#include "aws_iot_log.h"
+
+// This configuration macro needs to be available globally to enable threading
+#define _ENABLE_THREAD_SUPPORT_
+
+// These values are defined in the menuconfig of the AWS IoT component.
+// However, you can override these constants from your own code.
+#define AWS_IOT_MQTT_HOST              CONFIG_AWS_IOT_MQTT_HOST ///< Customer specific MQTT HOST. The same will be used for Thing Shadow
+#define AWS_IOT_MQTT_PORT              CONFIG_AWS_IOT_MQTT_PORT ///< default port for MQTT/S
+
+// These values are defaults and are used for ShadowConnectParametersDefault.
+// You should override them from your own code.
+#define AWS_IOT_MQTT_CLIENT_ID         "ESP32" ///< MQTT client ID should be unique for every device
+#define AWS_IOT_MY_THING_NAME          "ESP32" ///< Thing Name of the Shadow this device is associated with
+
+// MQTT PubSub
+#define AWS_IOT_MQTT_TX_BUF_LEN CONFIG_AWS_IOT_MQTT_TX_BUF_LEN ///< Any time a message is sent out through the MQTT layer. The message is copied into this buffer anytime a publish is done. This will also be used in the case of Thing Shadow
+#define AWS_IOT_MQTT_RX_BUF_LEN CONFIG_AWS_IOT_MQTT_RX_BUF_LEN ///< Any message that comes into the device should be less than this buffer size. If a received message is bigger than this buffer size the message will be dropped.
+#define AWS_IOT_MQTT_NUM_SUBSCRIBE_HANDLERS CONFIG_AWS_IOT_MQTT_NUM_SUBSCRIBE_HANDLERS ///< Maximum number of topic filters the MQTT client can handle at any given time. This should be increased appropriately when using Thing Shadow
+
+// Thing Shadow specific configs
+#ifdef CONFIG_AWS_IOT_OVERRIDE_THING_SHADOW_RX_BUFFER
+#define SHADOW_MAX_SIZE_OF_RX_BUFFER CONFIG_AWS_IOT_SHADOW_MAX_SIZE_OF_RX_BUFFER ///< Maximum size of the SHADOW buffer to store the received Shadow message, including NULL terminating byte
+#else
+#define SHADOW_MAX_SIZE_OF_RX_BUFFER (AWS_IOT_MQTT_RX_BUF_LEN + 1)
+#endif
+
+#define MAX_SIZE_OF_UNIQUE_CLIENT_ID_BYTES 80  ///< Maximum size of the Unique Client Id. For More info on the Client Id refer \ref response "Acknowledgments"
+#define MAX_SIZE_CLIENT_ID_WITH_SEQUENCE (MAX_SIZE_OF_UNIQUE_CLIENT_ID_BYTES + 10) ///< This is size of the extra sequence number that will be appended to the Unique client Id
+#define MAX_SIZE_CLIENT_TOKEN_CLIENT_SEQUENCE (MAX_SIZE_CLIENT_ID_WITH_SEQUENCE + 20) ///< This is size of the the total clientToken key and value pair in the JSON
+#define MAX_ACKS_TO_COMEIN_AT_ANY_GIVEN_TIME CONFIG_AWS_IOT_SHADOW_MAX_SIMULTANEOUS_ACKS ///< At Any given time we will wait for this many responses. This will correlate to the rate at which the shadow actions are requested
+#define MAX_THINGNAME_HANDLED_AT_ANY_GIVEN_TIME CONFIG_AWS_IOT_SHADOW_MAX_SIMULTANEOUS_THINGNAMES ///< We could perform shadow action on any thing Name and this is maximum Thing Names we can act on at any given time
+#define MAX_JSON_TOKEN_EXPECTED CONFIG_AWS_IOT_SHADOW_MAX_JSON_TOKEN_EXPECTED ///< These are the max tokens that is expected to be in the Shadow JSON document. Include the metadata that gets published
+#define MAX_SHADOW_TOPIC_LENGTH_WITHOUT_THINGNAME CONFIG_AWS_IOT_SHADOW_MAX_SHADOW_TOPIC_LENGTH_WITHOUT_THINGNAME ///< All shadow actions have to be published or subscribed to a topic which is of the formablogt $aws/things/{thingName}/shadow/update/accepted. This refers to the size of the topic without the Thing Name
+#define MAX_SIZE_OF_THING_NAME CONFIG_AWS_IOT_SHADOW_MAX_SIZE_OF_THING_NAME ///< The Thing Name should not be bigger than this value. Modify this if the Thing Name needs to be bigger
+#define MAX_SHADOW_TOPIC_LENGTH_BYTES (MAX_SHADOW_TOPIC_LENGTH_WITHOUT_THINGNAME + MAX_SIZE_OF_THING_NAME) ///< This size includes the length of topic with Thing Name
+
+// Auto Reconnect specific config
+#define AWS_IOT_MQTT_MIN_RECONNECT_WAIT_INTERVAL CONFIG_AWS_IOT_MQTT_MIN_RECONNECT_WAIT_INTERVAL ///< Minimum time before the First reconnect attempt is made as part of the exponential back-off algorithm
+#define AWS_IOT_MQTT_MAX_RECONNECT_WAIT_INTERVAL CONFIG_AWS_IOT_MQTT_MAX_RECONNECT_WAIT_INTERVAL ///< Maximum time interval after which exponential back-off will stop attempting to reconnect.
+
+#endif /* _AWS_IOT_CONFIG_H_ */

components/aws_iot/include/aws_iot_log.h

@@ -0,0 +1,44 @@
+// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+#pragma once
+
+/* (these two headers aren't used here, but AWS IoT SDK code relies on them
+   being included from here...) */
+#include <stdio.h>
+#include <stdlib.h>
+
+#include "esp_log.h"
+
+/* This is a stub replacement for the aws_iot_log.h header in the AWS IoT SDK,
+   which redirects their logging framework into the esp-idf logging framework.
+
+   The current (2.1.1) upstream AWS IoT SDK doesn't allow this as some of its
+   headers include aws_iot_log.h, but our modified fork does.
+*/
+
+// redefine the AWS IoT log functions to call into the IDF log layer
+#define IOT_DEBUG(format, ...) ESP_LOGD("aws_iot", format, ##__VA_ARGS__)
+#define IOT_INFO(format, ...) ESP_LOGI("aws_iot", format, ##__VA_ARGS__)
+#define IOT_WARN(format, ...) ESP_LOGW("aws_iot", format, ##__VA_ARGS__)
+#define IOT_ERROR(format, ...) ESP_LOGE("aws_iot", format, ##__VA_ARGS__)
+
+/* Function tracing macros used in AWS IoT SDK,
+   mapped to "verbose" level output
+*/
+#define FUNC_ENTRY ESP_LOGV("aws_iot", "FUNC_ENTRY:   %s L#%d \n", __func__, __LINE__)
+#define FUNC_EXIT_RC(x) \
+    do {                                                                \
+        ESP_LOGV("aws_iot", "FUNC_EXIT:   %s L#%d Return Code : %d \n", __func__, __LINE__, x); \
+        return x; \
+    } while(0)

components/aws_iot/include/network_platform.h

@@ -0,0 +1,64 @@
+/*
+ * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Additions Copyright 2016 Espressif Systems (Shanghai) PTE LTD
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+#ifndef IOTSDKC_NETWORK_MBEDTLS_PLATFORM_H_H
+
+#if !defined(MBEDTLS_CONFIG_FILE)
+#include "mbedtls/config.h"
+#else
+#include MBEDTLS_CONFIG_FILE
+#endif
+
+#include "mbedtls/platform.h"
+#include "mbedtls/net_sockets.h"
+#include "mbedtls/ssl.h"
+#include "mbedtls/entropy.h"
+#include "mbedtls/ctr_drbg.h"
+#include "mbedtls/certs.h"
+#include "mbedtls/x509.h"
+#include "mbedtls/error.h"
+#include "mbedtls/debug.h"
+#include "mbedtls/timing.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief TLS Connection Parameters
+ *
+ * Defines a type containing TLS specific parameters to be passed down to the
+ * TLS networking layer to create a TLS secured socket.
+ */
+typedef struct _TLSDataParams {
+    mbedtls_entropy_context entropy;
+    mbedtls_ctr_drbg_context ctr_drbg;
+    mbedtls_ssl_context ssl;
+    mbedtls_ssl_config conf;
+    uint32_t flags;
+    mbedtls_x509_crt cacert;
+    mbedtls_x509_crt clicert;
+    mbedtls_pk_context pkey;
+    mbedtls_net_context server_fd;
+}TLSDataParams;
+
+#define IOTSDKC_NETWORK_MBEDTLS_PLATFORM_H_H
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif //IOTSDKC_NETWORK_MBEDTLS_PLATFORM_H_H

components/aws_iot/include/threads_platform.h

@@ -0,0 +1,45 @@
+/*
+ * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Additions Copyright 2016 Espressif Systems (Shanghai) PTE LTD
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+#include "threads_interface.h"
+
+#ifndef AWS_IOTSDK_THREADS_PLATFORM_H
+#define AWS_IOTSDK_THREADS_PLATFORM_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "freertos/FreeRTOS.h"
+#include "freertos/semphr.h"
+
+/**
+ * @brief Mutex Type
+ *
+ * definition of the Mutex   struct. Platform specific
+ *
+ */
+struct _IoT_Mutex_t {
+    SemaphoreHandle_t mutex;
+};
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* AWS_IOTSDK_THREADS_PLATFORM_H */
+
+

components/aws_iot/include/timer_platform.h

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Additions Copyright 2016 Espressif Systems (Shanghai) PTE LTD
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+#ifndef AWS_IOT_PLATFORM_H
+#define AWS_IOT_PLATFORM_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stdint.h>
+#include "timer_interface.h"
+
+/**
+ * definition of the Timer struct. Platform specific
+ */
+struct Timer {
+    uint32_t start_ticks;
+    uint32_t timeout_ticks;
+    uint32_t last_polled_ticks;
+};
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* AWS_IOT_PLATFORM_H */

components/aws_iot/port/network_mbedtls_wrapper.c

@@ -0,0 +1,419 @@
+/*
+ * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Additions Copyright 2016 Espressif Systems (Shanghai) PTE LTD
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+#include <sys/param.h>
+#include <stdbool.h>
+#include <string.h>
+#include <timer_platform.h>
+#include <network_interface.h>
+
+#include "aws_iot_config.h"
+#include "aws_iot_error.h"
+#include "network_interface.h"
+#include "network_platform.h"
+
+#include "mbedtls/esp_debug.h"
+
+#include "esp_log.h"
+#include "esp_vfs.h"
+
+static const char *TAG = "aws_iot";
+
+/* This is the value used for ssl read timeout */
+#define IOT_SSL_READ_TIMEOUT 10
+
+/*
+ * This is a function to do further verification if needed on the cert received.
+ *
+ * Currently used to print debug-level information about each cert.
+ */
+static int _iot_tls_verify_cert(void *data, mbedtls_x509_crt *crt, int depth, uint32_t *flags) {
+    char buf[256];
+    ((void) data);
+
+    if (LOG_LOCAL_LEVEL >= ESP_LOG_DEBUG) {
+        ESP_LOGD(TAG, "Verify requested for (Depth %d):", depth);
+        mbedtls_x509_crt_info(buf, sizeof(buf) - 1, "", crt);
+        ESP_LOGD(TAG, "%s", buf);
+
+        if((*flags) == 0) {
+            ESP_LOGD(TAG, "  This certificate has no flags");
+        } else {
+            ESP_LOGD(TAG, "Verify result:%s", buf);
+        }
+    }
+
+    return 0;
+}
+
+static void _iot_tls_set_connect_params(Network *pNetwork, const char *pRootCALocation, const char *pDeviceCertLocation,
+                                 const char *pDevicePrivateKeyLocation, const char *pDestinationURL,
+                                 uint16_t destinationPort, uint32_t timeout_ms, bool ServerVerificationFlag) {
+    pNetwork->tlsConnectParams.DestinationPort = destinationPort;
+    pNetwork->tlsConnectParams.pDestinationURL = pDestinationURL;
+    pNetwork->tlsConnectParams.pDeviceCertLocation = pDeviceCertLocation;
+    pNetwork->tlsConnectParams.pDevicePrivateKeyLocation = pDevicePrivateKeyLocation;
+    pNetwork->tlsConnectParams.pRootCALocation = pRootCALocation;
+    pNetwork->tlsConnectParams.timeout_ms = timeout_ms;
+    pNetwork->tlsConnectParams.ServerVerificationFlag = ServerVerificationFlag;
+}
+
+IoT_Error_t iot_tls_init(Network *pNetwork, const char *pRootCALocation, const char *pDeviceCertLocation,
+                         const char *pDevicePrivateKeyLocation, const char *pDestinationURL,
+                         uint16_t destinationPort, uint32_t timeout_ms, bool ServerVerificationFlag) {
+    _iot_tls_set_connect_params(pNetwork, pRootCALocation, pDeviceCertLocation, pDevicePrivateKeyLocation,
+                                pDestinationURL, destinationPort, timeout_ms, ServerVerificationFlag);
+
+    pNetwork->connect = iot_tls_connect;
+    pNetwork->read = iot_tls_read;
+    pNetwork->write = iot_tls_write;
+    pNetwork->disconnect = iot_tls_disconnect;
+    pNetwork->isConnected = iot_tls_is_connected;
+    pNetwork->destroy = iot_tls_destroy;
+
+    pNetwork->tlsDataParams.flags = 0;
+
+    return SUCCESS;
+}
+
+IoT_Error_t iot_tls_is_connected(Network *pNetwork) {
+    /* Use this to add implementation which can check for physical layer disconnect */
+    return NETWORK_PHYSICAL_LAYER_CONNECTED;
+}
+
+IoT_Error_t iot_tls_connect(Network *pNetwork, TLSConnectParams *params) {
+    int ret = SUCCESS;
+    TLSDataParams *tlsDataParams = NULL;
+    char portBuffer[6];
+    char info_buf[256];
+
+    if(NULL == pNetwork) {
+        return NULL_VALUE_ERROR;
+    }
+
+    if(NULL != params) {
+        _iot_tls_set_connect_params(pNetwork, params->pRootCALocation, params->pDeviceCertLocation,
+                                    params->pDevicePrivateKeyLocation, params->pDestinationURL,
+                                    params->DestinationPort, params->timeout_ms, params->ServerVerificationFlag);
+    }
+
+    tlsDataParams = &(pNetwork->tlsDataParams);
+
+    mbedtls_net_init(&(tlsDataParams->server_fd));
+    mbedtls_ssl_init(&(tlsDataParams->ssl));
+    mbedtls_ssl_config_init(&(tlsDataParams->conf));
+
+#ifdef CONFIG_MBEDTLS_DEBUG
+    mbedtls_esp_enable_debug_log(&(tlsDataParams->conf), 4);
+#endif
+
+    mbedtls_ctr_drbg_init(&(tlsDataParams->ctr_drbg));
+    mbedtls_x509_crt_init(&(tlsDataParams->cacert));
+    mbedtls_x509_crt_init(&(tlsDataParams->clicert));
+    mbedtls_pk_init(&(tlsDataParams->pkey));
+
+    ESP_LOGD(TAG, "Seeding the random number generator...");
+    mbedtls_entropy_init(&(tlsDataParams->entropy));
+    if((ret = mbedtls_ctr_drbg_seed(&(tlsDataParams->ctr_drbg), mbedtls_entropy_func, &(tlsDataParams->entropy),
+                                    (const unsigned char *) TAG, strlen(TAG))) != 0) {
+        ESP_LOGE(TAG, "failed! mbedtls_ctr_drbg_seed returned -0x%x", -ret);
+        return NETWORK_MBEDTLS_ERR_CTR_DRBG_ENTROPY_SOURCE_FAILED;
+    }
+
+   /*  Load root CA...
+
+       Certs/keys can be paths or they can be raw data. These use a
+       very basic heuristic: if the cert starts with '/' then it's a
+       path, if it's longer than this then it's raw cert data (PEM or DER,
+       neither of which can start with a slash. */
+    if (pNetwork->tlsConnectParams.pRootCALocation[0] == '/') {
+        ESP_LOGD(TAG, "Loading CA root certificate from file ...");
+        ret = mbedtls_x509_crt_parse_file(&(tlsDataParams->cacert), pNetwork->tlsConnectParams.pRootCALocation);
+    } else {
+        ESP_LOGD(TAG, "Loading embedded CA root certificate ...");
+        ret = mbedtls_x509_crt_parse(&(tlsDataParams->cacert), (const unsigned char *)pNetwork->tlsConnectParams.pRootCALocation,
+                                 strlen(pNetwork->tlsConnectParams.pRootCALocation)+1);
+    }
+
+    if(ret < 0) {
+        ESP_LOGE(TAG, "failed!  mbedtls_x509_crt_parse returned -0x%x while parsing root cert", -ret);
+        return NETWORK_X509_ROOT_CRT_PARSE_ERROR;
+    }
+    ESP_LOGD(TAG, "ok (%d skipped)", ret);
+
+    /* Load client certificate... */
+    if (pNetwork->tlsConnectParams.pDeviceCertLocation[0] == '/') {
+        ESP_LOGD(TAG, "Loading client cert from file...");
+        ret = mbedtls_x509_crt_parse_file(&(tlsDataParams->clicert),
+                                          pNetwork->tlsConnectParams.pDeviceCertLocation);
+    } else {
+        ESP_LOGD(TAG, "Loading embedded client certificate...");
+        ret = mbedtls_x509_crt_parse(&(tlsDataParams->clicert),
+                                     (const unsigned char *)pNetwork->tlsConnectParams.pDeviceCertLocation,
+                                     strlen(pNetwork->tlsConnectParams.pDeviceCertLocation)+1);
+    }
+    if(ret != 0) {
+        ESP_LOGE(TAG, "failed!  mbedtls_x509_crt_parse returned -0x%x while parsing device cert", -ret);
+        return NETWORK_X509_DEVICE_CRT_PARSE_ERROR;
+    }
+
+    /* Parse client private key... */
+    if (pNetwork->tlsConnectParams.pDevicePrivateKeyLocation[0] == '/') {
+        ESP_LOGD(TAG, "Loading client private key from file...");
+        ret = mbedtls_pk_parse_keyfile(&(tlsDataParams->pkey),
+                                       pNetwork->tlsConnectParams.pDevicePrivateKeyLocation,
+                                       "");
+    } else {
+        ESP_LOGD(TAG, "Loading embedded client private key...");
+        ret = mbedtls_pk_parse_key(&(tlsDataParams->pkey),
+                                   (const unsigned char *)pNetwork->tlsConnectParams.pDevicePrivateKeyLocation,
+                                   strlen(pNetwork->tlsConnectParams.pDevicePrivateKeyLocation)+1,
+                                   (const unsigned char *)"", 0);
+    }
+    if(ret != 0) {
+        ESP_LOGE(TAG, "failed!  mbedtls_pk_parse_key returned -0x%x while parsing private key", -ret);
+        return NETWORK_PK_PRIVATE_KEY_PARSE_ERROR;
+    }
+
+    /* Done parsing certs */
+    ESP_LOGD(TAG, "ok");
+    snprintf(portBuffer, 6, "%d", pNetwork->tlsConnectParams.DestinationPort);
+    ESP_LOGD(TAG, "Connecting to %s/%s...", pNetwork->tlsConnectParams.pDestinationURL, portBuffer);
+    if((ret = mbedtls_net_connect(&(tlsDataParams->server_fd), pNetwork->tlsConnectParams.pDestinationURL,
+                                  portBuffer, MBEDTLS_NET_PROTO_TCP)) != 0) {
+        ESP_LOGE(TAG, "failed! mbedtls_net_connect returned -0x%x", -ret);
+        switch(ret) {
+            case MBEDTLS_ERR_NET_SOCKET_FAILED:
+                return NETWORK_ERR_NET_SOCKET_FAILED;
+            case MBEDTLS_ERR_NET_UNKNOWN_HOST:
+                return NETWORK_ERR_NET_UNKNOWN_HOST;
+            case MBEDTLS_ERR_NET_CONNECT_FAILED:
+            default:
+                return NETWORK_ERR_NET_CONNECT_FAILED;
+        };
+    }
+
+    ret = mbedtls_net_set_block(&(tlsDataParams->server_fd));
+    if(ret != 0) {
+        ESP_LOGE(TAG, "failed! net_set_(non)block() returned -0x%x", -ret);
+        return SSL_CONNECTION_ERROR;
+    } ESP_LOGD(TAG, "ok");
+
+    ESP_LOGD(TAG, "Setting up the SSL/TLS structure...");
+    if((ret = mbedtls_ssl_config_defaults(&(tlsDataParams->conf), MBEDTLS_SSL_IS_CLIENT, MBEDTLS_SSL_TRANSPORT_STREAM,
+                                          MBEDTLS_SSL_PRESET_DEFAULT)) != 0) {
+        ESP_LOGE(TAG, "failed! mbedtls_ssl_config_defaults returned -0x%x", -ret);
+        return SSL_CONNECTION_ERROR;
+    }
+
+    mbedtls_ssl_conf_verify(&(tlsDataParams->conf), _iot_tls_verify_cert, NULL);
+
+    if(pNetwork->tlsConnectParams.ServerVerificationFlag == true) {
+        mbedtls_ssl_conf_authmode(&(tlsDataParams->conf), MBEDTLS_SSL_VERIFY_REQUIRED);
+    } else {
+        mbedtls_ssl_conf_authmode(&(tlsDataParams->conf), MBEDTLS_SSL_VERIFY_OPTIONAL);
+    }
+    mbedtls_ssl_conf_rng(&(tlsDataParams->conf), mbedtls_ctr_drbg_random, &(tlsDataParams->ctr_drbg));
+
+    mbedtls_ssl_conf_ca_chain(&(tlsDataParams->conf), &(tlsDataParams->cacert), NULL);
+    ret = mbedtls_ssl_conf_own_cert(&(tlsDataParams->conf), &(tlsDataParams->clicert), &(tlsDataParams->pkey));
+    if(ret != 0) {
+        ESP_LOGE(TAG, "failed! mbedtls_ssl_conf_own_cert returned %d", ret);
+        return SSL_CONNECTION_ERROR;
+    }
+
+    mbedtls_ssl_conf_read_timeout(&(tlsDataParams->conf), pNetwork->tlsConnectParams.timeout_ms);
+
+#ifdef CONFIG_MBEDTLS_SSL_ALPN
+    /* Use the AWS IoT ALPN extension for MQTT, if port 443 is requested */
+    if (pNetwork->tlsConnectParams.DestinationPort == 443) {
+        const char *alpnProtocols[] = { "x-amzn-mqtt-ca", NULL };
+        if ((ret = mbedtls_ssl_conf_alpn_protocols(&(tlsDataParams->conf), alpnProtocols)) != 0) {
+            ESP_LOGE(TAG, "failed! mbedtls_ssl_conf_alpn_protocols returned -0x%x", -ret);
+            return SSL_CONNECTION_ERROR;
+        }
+    }
+#endif
+
+    if((ret = mbedtls_ssl_setup(&(tlsDataParams->ssl), &(tlsDataParams->conf))) != 0) {
+        ESP_LOGE(TAG, "failed! mbedtls_ssl_setup returned -0x%x", -ret);
+        return SSL_CONNECTION_ERROR;
+    }
+    if((ret = mbedtls_ssl_set_hostname(&(tlsDataParams->ssl), pNetwork->tlsConnectParams.pDestinationURL)) != 0) {
+        ESP_LOGE(TAG, "failed! mbedtls_ssl_set_hostname returned %d", ret);
+        return SSL_CONNECTION_ERROR;
+    }
+    ESP_LOGD(TAG, "SSL state connect : %d ", tlsDataParams->ssl.state);
+    mbedtls_ssl_set_bio(&(tlsDataParams->ssl), &(tlsDataParams->server_fd), mbedtls_net_send, NULL,
+                        mbedtls_net_recv_timeout);
+    ESP_LOGD(TAG, "ok");
+
+    ESP_LOGD(TAG, "SSL state connect : %d ", tlsDataParams->ssl.state);
+    ESP_LOGD(TAG, "Performing the SSL/TLS handshake...");
+    while((ret = mbedtls_ssl_handshake(&(tlsDataParams->ssl))) != 0) {
+        if(ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
+            ESP_LOGE(TAG, "failed! mbedtls_ssl_handshake returned -0x%x", -ret);
+            if(ret == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED) {
+                ESP_LOGE(TAG, "    Unable to verify the server's certificate. ");
+            }
+            return SSL_CONNECTION_ERROR;
+        }
+    }
+
+    ESP_LOGD(TAG, "ok    [ Protocol is %s ]    [ Ciphersuite is %s ]", mbedtls_ssl_get_version(&(tlsDataParams->ssl)),
+          mbedtls_ssl_get_ciphersuite(&(tlsDataParams->ssl)));
+    if((ret = mbedtls_ssl_get_record_expansion(&(tlsDataParams->ssl))) >= 0) {
+        ESP_LOGD(TAG, "    [ Record expansion is %d ]", ret);
+    } else {
+        ESP_LOGD(TAG, "    [ Record expansion is unknown (compression) ]");
+    }
+
+    ESP_LOGD(TAG, "Verifying peer X.509 certificate...");
+
+    if(pNetwork->tlsConnectParams.ServerVerificationFlag == true) {
+        if((tlsDataParams->flags = mbedtls_ssl_get_verify_result(&(tlsDataParams->ssl))) != 0) {
+            ESP_LOGE(TAG, "failed");
+            mbedtls_x509_crt_verify_info(info_buf, sizeof(info_buf), "  ! ", tlsDataParams->flags);
+            ESP_LOGE(TAG, "%s", info_buf);
+            ret = SSL_CONNECTION_ERROR;
+        } else {
+            ESP_LOGD(TAG, "ok");
+            ret = SUCCESS;
+        }
+    } else {
+        ESP_LOGW(TAG, " Server Verification skipped");
+        ret = SUCCESS;
+    }
+
+    if(LOG_LOCAL_LEVEL >= ESP_LOG_DEBUG) {
+        if (mbedtls_ssl_get_peer_cert(&(tlsDataParams->ssl)) != NULL) {
+            ESP_LOGD(TAG, "Peer certificate information:");
+            mbedtls_x509_crt_info((char *) info_buf, sizeof(info_buf) - 1, "      ", mbedtls_ssl_get_peer_cert(&(tlsDataParams->ssl)));
+            ESP_LOGD(TAG, "%s", info_buf);
+        }
+    }
+
+    return (IoT_Error_t) ret;
+}
+
+IoT_Error_t iot_tls_write(Network *pNetwork, unsigned char *pMsg, size_t len, Timer *timer, size_t *written_len) {
+    size_t written_so_far;
+    bool isErrorFlag = false;
+    int frags, ret = 0;
+    TLSDataParams *tlsDataParams = &(pNetwork->tlsDataParams);
+
+    for(written_so_far = 0, frags = 0;
+        written_so_far < len && !has_timer_expired(timer); written_so_far += ret, frags++) {
+        while(!has_timer_expired(timer) &&
+              (ret = mbedtls_ssl_write(&(tlsDataParams->ssl), pMsg + written_so_far, len - written_so_far)) <= 0) {
+            if(ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE) {
+                ESP_LOGE(TAG, "failed! mbedtls_ssl_write returned -0x%x", -ret);
+                /* All other negative return values indicate connection needs to be reset.
+                * Will be caught in ping request so ignored here */
+                isErrorFlag = true;
+                break;
+            }
+        }
+        if(isErrorFlag) {
+            break;
+        }
+    }
+
+    *written_len = written_so_far;
+
+    if(isErrorFlag) {
+        return NETWORK_SSL_WRITE_ERROR;
+    } else if(has_timer_expired(timer) && written_so_far != len) {
+        return NETWORK_SSL_WRITE_TIMEOUT_ERROR;
+    }
+
+    return SUCCESS;
+}
+
+IoT_Error_t iot_tls_read(Network *pNetwork, unsigned char *pMsg, size_t len, Timer *timer, size_t *read_len) {
+    TLSDataParams *tlsDataParams = &(pNetwork->tlsDataParams);
+    mbedtls_ssl_context *ssl = &(tlsDataParams->ssl);
+    mbedtls_ssl_config *ssl_conf = &(tlsDataParams->conf);
+    uint32_t read_timeout;
+    size_t rxLen = 0;
+    int ret;
+
+    read_timeout = ssl_conf->read_timeout;
+
+    while (len > 0) {
+
+        /* Make sure we never block on read for longer than timer has left,
+         but also that we don't block indefinitely (ie read_timeout > 0) */
+        mbedtls_ssl_conf_read_timeout(ssl_conf, MAX(1, MIN(read_timeout, left_ms(timer))));
+
+        ret = mbedtls_ssl_read(ssl, pMsg, len);
+
+        /* Restore the old timeout */
+        mbedtls_ssl_conf_read_timeout(ssl_conf, read_timeout);
+
+        if (ret > 0) {
+            rxLen += ret;
+            pMsg += ret;
+            len -= ret;
+        } else if (ret == 0 || (ret != MBEDTLS_ERR_SSL_WANT_READ && ret != MBEDTLS_ERR_SSL_WANT_WRITE && ret != MBEDTLS_ERR_SSL_TIMEOUT)) {
+            return NETWORK_SSL_READ_ERROR;
+        }
+
+        // Evaluate timeout after the read to make sure read is done at least once
+        if (has_timer_expired(timer)) {
+            break;
+        }
+    }
+
+    if (len == 0) {
+        *read_len = rxLen;
+        return SUCCESS;
+    }
+
+    if (rxLen == 0) {
+        return NETWORK_SSL_NOTHING_TO_READ;
+    } else {
+        return NETWORK_SSL_READ_TIMEOUT_ERROR;
+    }
+}
+
+IoT_Error_t iot_tls_disconnect(Network *pNetwork) {
+    mbedtls_ssl_context *ssl = &(pNetwork->tlsDataParams.ssl);
+    int ret = 0;
+    do {
+        ret = mbedtls_ssl_close_notify(ssl);
+    } while(ret == MBEDTLS_ERR_SSL_WANT_WRITE);
+
+    /* All other negative return values indicate connection needs to be reset.
+     * No further action required since this is disconnect call */
+
+    return SUCCESS;
+}
+
+IoT_Error_t iot_tls_destroy(Network *pNetwork) {
+    TLSDataParams *tlsDataParams = &(pNetwork->tlsDataParams);
+
+    mbedtls_net_free(&(tlsDataParams->server_fd));
+
+    mbedtls_x509_crt_free(&(tlsDataParams->clicert));
+    mbedtls_x509_crt_free(&(tlsDataParams->cacert));
+    mbedtls_pk_free(&(tlsDataParams->pkey));
+    mbedtls_ssl_free(&(tlsDataParams->ssl));
+    mbedtls_ssl_config_free(&(tlsDataParams->conf));
+    mbedtls_ctr_drbg_free(&(tlsDataParams->ctr_drbg));
+    mbedtls_entropy_free(&(tlsDataParams->entropy));
+
+    return SUCCESS;
+}

components/aws_iot/port/threads_freertos.c

@@ -0,0 +1,104 @@
+/*
+ * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * Additions Copyright 2016 Espressif Systems (Shanghai) PTE LTD
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+
+#include "threads_platform.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief Initialize the provided mutex
+ *
+ * Call this function to initialize the mutex
+ *
+ * @param IoT_Mutex_t - pointer to the mutex to be initialized
+ * @return IoT_Error_t - error code indicating result of operation
+ */
+IoT_Error_t aws_iot_thread_mutex_init(IoT_Mutex_t *pMutex) {
+
+    pMutex->mutex = xSemaphoreCreateRecursiveMutex();
+    return pMutex->mutex ? SUCCESS : MUTEX_INIT_ERROR;
+}
+
+/**
+ * @brief Lock the provided mutex
+ *
+ * Call this function to lock the mutex before performing a state change
+ * Blocking, thread will block until lock request fails
+ *
+ * @param IoT_Mutex_t - pointer to the mutex to be locked
+ * @return IoT_Error_t - error code indicating result of operation
+ */
+IoT_Error_t aws_iot_thread_mutex_lock(IoT_Mutex_t *pMutex) {
+    xSemaphoreTakeRecursive(pMutex->mutex, portMAX_DELAY);
+    return SUCCESS;
+}
+
+/**
+ * @brief Try to lock the provided mutex
+ *
+ * Call this function to attempt to lock the mutex before performing a state change
+ * Non-Blocking, immediately returns with failure if lock attempt fails
+ *
+ * @param IoT_Mutex_t - pointer to the mutex to be locked
+ * @return IoT_Error_t - error code indicating result of operation
+ */
+IoT_Error_t aws_iot_thread_mutex_trylock(IoT_Mutex_t *pMutex) {
+    if (xSemaphoreTakeRecursive(pMutex->mutex, 0)) {
+        return SUCCESS;
+    } else {
+        return MUTEX_LOCK_ERROR;
+    }
+}
+
+/**
+ * @brief Unlock the provided mutex
+ *
+ * Call this function to unlock the mutex before performing a state change
+ *
+ * @param IoT_Mutex_t - pointer to the mutex to be unlocked
+ * @return IoT_Error_t - error code indicating result of operation
+ */
+IoT_Error_t aws_iot_thread_mutex_unlock(IoT_Mutex_t *pMutex) {
+    if (xSemaphoreGiveRecursive(pMutex->mutex)) {
+        return SUCCESS;
+    } else {
+        return MUTEX_UNLOCK_ERROR;
+    }
+}
+
+/**
+ * @brief Destroy the provided mutex
+ *
+ * Call this function to destroy the mutex
+ *
+ * @param IoT_Mutex_t - pointer to the mutex to be destroyed
+ * @return IoT_Error_t - error code indicating result of operation
+ */
+IoT_Error_t aws_iot_thread_mutex_destroy(IoT_Mutex_t *pMutex) {
+    vSemaphoreDelete(pMutex->mutex);
+    return SUCCESS;
+}
+
+#ifdef __cplusplus
+}
+#endif
+