Merge branch 'feature/esp_cryptoauthlib_from_manager_v5.0' into 'release/v5.0'

Push out esp-cryptoauthlib to component manager (v5.0)

See merge request espressif/esp-idf!19654

.flake8

@@ -149,7 +149,6 @@ exclude =
         components/tinyusb,
         components/unity/unity,
         components/spiffs/spiffs,
-        examples/peripherals/secure_element/atecc608_ecdsa/components/esp-cryptoauthlib,
     # autogenerated scripts
         components/protocomm/python/constants_pb2.py,
         components/protocomm/python/sec0_pb2.py,

.gitlab/ci/rules.yml

@@ -173,7 +173,6 @@
   - "components/tinyusb/tinyusb"
   - "components/unity/unity"
   - "components/heap/tlsf"
-  - "examples/peripherals/secure_element/atecc608_ecdsa/components/esp-cryptoauthlib"
   - ".gitmodules"
 
 # for jobs: example_test*flash_encryption_wifi_high_traffic

.gitmodules

@@ -51,10 +51,6 @@
 	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

components/mbedtls/CMakeLists.txt

@@ -268,6 +268,5 @@ endif()
 
 # Link esp-cryptoauthlib to mbedtls
 if(CONFIG_ATCA_MBEDTLS_ECDSA)
-    idf_component_get_property(cryptoauthlib esp-cryptoauthlib COMPONENT_LIB)
+    idf_component_optional_requires(PRIVATE espressif__esp-cryptoauthlib esp-cryptoauthlib)
-    target_link_libraries(${COMPONENT_LIB} ${linkage_type} ${cryptoauthlib})
 endif()

docs/en/COPYRIGHT.rst

@@ -55,8 +55,6 @@ These third party libraries can be included into the application (firmware) prod
 
 * `mynewt-nimble`_ Apache Mynewt NimBLE, Copyright 2015-2018, The Apache Software Foundation, is licensed under Apache License 2.0 as described in :component_file:`LICENSE file<bt/host/nimble/nimble/LICENSE>`.
 
-* `cryptoauthlib`_ Microchip CryptoAuthentication Library - Copyright (c) 2015 - 2018 Microchip Technology Inc, is licensed under common Microchip software License as described in :example_file:`LICENSE file <peripherals/secure_element/atecc608_ecdsa/components/esp-cryptoauthlib/cryptoauthlib/LICENSE>`
-
 * `TLSF allocator <https://github.com/espressif/tlsf>` Two Level Segregated Fit memory allocator, Copyright (c) 2006-2016, Matthew Conte, and licensed under the BSD 3-clause license.
 
 * `qrcode`_ QR Code generator library Copyright (c) Project Nayuki, is licensed under MIT license.
@@ -167,7 +165,6 @@ Copyright (C) 2011, ChaN, all right reserved.
 .. _ESP-IDF Programming Guide: https://docs.espressif.com/projects/esp-idf/en/latest/
 .. _sphinx_idf_theme: https://github.com/espressif/sphinx_idf_theme
 .. _sphinx_rtd_theme: https://github.com/readthedocs/sphinx_rtd_theme
-.. _cryptoauthlib: https://github.com/MicrochipTech/cryptoauthlib
 .. _qrcode: https://github.com/nayuki/QR-Code-generator
 .. _freemodbus: https://github.com/armink/FreeModbus_Slave-Master-RTT-STM32
 .. _SEGGER SystemView: https://www.segger.com/downloads/systemview/

docs/en/migration-guides/release-5.x/removed-components.rst

@@ -18,6 +18,7 @@ Following components are removed from ESP-IDF and moved to `IDF Component Regist
 * `sh2lib <https://components.espressif.com/component/espressif/sh2lib>`_
 * `expat <https://components.espressif.com/component/espressif/expat>`_
 * `coap <https://components.espressif.com/component/espressif/coap>`_
+* `esp-cryptoauthlib <https://components.espressif.com/component/espressif/esp-cryptoauthlib>`_
 
 .. note::
     Please note that http parser functionality which was previously part of ``nghttp`` component is now part of :component:`http_parser <http_parser>` component.

examples/peripherals/secure_element/atecc608_ecdsa/main/idf_component.yml

@@ -0,0 +1,3 @@
+## IDF Component Manager Manifest File
+dependencies:
+  espressif/esp-cryptoauthlib: "^3.3.1"

tools/ci/check_readme_links.py

@@ -18,8 +18,6 @@ from collections import defaultdict, namedtuple
 from pathlib import Path
 from typing import List
 
-EXCLUDE_DOCS_LIST = ['examples/peripherals/secure_element/atecc608_ecdsa/components/esp-cryptoauthlib/cryptoauthlib/**']
-
 # The apple apps links are not accessible from the company network for some reason
 EXCLUDE_URL_LIST = ['https://apps.apple.com/in/app/esp-ble-provisioning/id1473590141', 'https://apps.apple.com/in/app/esp-softap-provisioning/id1474040630']
 
@@ -98,10 +96,6 @@ def get_md_links(folder: str) -> List:
     links = []
 
     for path in (idf_path / folder).rglob('*.md'):
-        if any([path.relative_to(idf_path).match(exclude_doc) for exclude_doc in EXCLUDE_DOCS_LIST]):
-            print('{} - excluded'.format(path))
-            continue
-
         with path.open(encoding='utf8') as f:
             content = f.read()
 

tools/ci/static-analysis-rules.yml

@@ -30,7 +30,6 @@ skip:
   - "components/tinyusb/tinyusb"
   - "components/unity/unity"
   - "components/heap/tlsf"
-  - "examples/peripherals/secure_element/atecc608_ecdsa/components/esp-cryptoauthlib"
 
   # disabled temporarily to pass the CI
   - "components/bt/common/btc/core/btc_task.c"

tools/idf_py_actions/hints.yml

@@ -119,6 +119,10 @@
     re: "fatal error: esp_adc_cal.h: No such file or directory"
     hint: "``esp_adc_cal`` component is no longer supported. New adc calibration driver is in ``esp_adc``. Legacy adc calibration driver has been moved into ``esp_adc`` component. To use legacy ``esp_adc_cal`` driver APIs, you should add ``esp_adc`` component to the list of component requirements in CMakeLists.txt. For more information run 'idf.py docs -sp migration-guides/release-5.x/peripherals.html'."
 
+-
+    re: "fatal error: .*atca_mbedtls_wrap\\.h: No such file or directory"
+    hint: "To use CONFIG_ESP_TLS_USE_SECURE_ELEMENT option, please install `esp-cryptoauthlib` using 'idf.py add-dependency espressif/esp-cryptoauthlib'"
+
 -
     re: "fatal error: [\\w/]+\\.h: No such file or directory"
     hint: "Please make sure that the header name is correct. Also please check if you've specified all component dependencies with 'idf_component_register(REQUIRES ...)'. If the component is not present then it should be added by the IDF Component Manager. For more information run 'idf.py docs -sp api-guides/build-system.html'.\nAlso, please check if the header file has been removed, renamed or relocated - refer to the migration guide for more information."