diff --git a/.clang-format b/.clang-format new file mode 100644 index 000000000..6dc87bc80 --- /dev/null +++ b/.clang-format @@ -0,0 +1,93 @@ +# clang-format configuration file +# +# For more information, see: +# +# Documentation/process/clang-format.rst +# https://clang.llvm.org/docs/ClangFormat.html +# https://clang.llvm.org/docs/ClangFormatStyleOptions.html +# +--- +AccessModifierOffset: -4 +AlignAfterOpenBracket: Align +AlignConsecutiveAssignments: false +AlignConsecutiveDeclarations: false +AlignOperands: true +AlignTrailingComments: false +AllowAllParametersOfDeclarationOnNextLine: false +AllowShortBlocksOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: None +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterDefinitionReturnType: None +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: false +AlwaysBreakTemplateDeclarations: false +BinPackArguments: true +BinPackParameters: true +BraceWrapping: + AfterClass: false + AfterControlStatement: false + AfterEnum: false + AfterFunction: true + AfterNamespace: true + AfterObjCDeclaration: false + AfterStruct: false + AfterUnion: false + BeforeCatch: false + BeforeElse: false + IndentBraces: false +BreakBeforeBinaryOperators: None +BreakBeforeBraces: Custom +BreakBeforeTernaryOperators: false +BreakConstructorInitializersBeforeComma: false +BreakAfterJavaFieldAnnotations: false +BreakStringLiterals: false +ColumnLimit: 80 +ConstructorInitializerAllOnOneLineOrOnePerLine: false +ConstructorInitializerIndentWidth: 8 +ContinuationIndentWidth: 8 +Cpp11BracedListStyle: false +DerivePointerAlignment: false +DisableFormat: false +ExperimentalAutoDetectBinPacking: false +IncludeCategories: + - Regex: '.*' + Priority: 1 +IndentCaseLabels: false +IndentWidth: 4 +IndentWrappedFunctionNames: false +JavaScriptQuotes: Leave +JavaScriptWrapImports: true +KeepEmptyLinesAtTheStartOfBlocks: false +MacroBlockBegin: '' +MacroBlockEnd: '' +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: None +ObjCBlockIndentWidth: 8 +ObjCSpaceAfterProperty: true +ObjCSpaceBeforeProtocolList: true +PenaltyBreakBeforeFirstCallParameter: 30 +PenaltyBreakComment: 10 +PenaltyBreakFirstLessLess: 0 +PenaltyBreakString: 10 +PenaltyExcessCharacter: 100 +PenaltyReturnTypeOnItsOwnLine: 60 +PointerAlignment: Right +ReflowComments: false +SortIncludes: false +SpaceAfterCStyleCast: false +SpaceAfterTemplateKeyword: true +SpaceBeforeAssignmentOperators: true +SpaceBeforeParens: ControlStatements +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 1 +SpacesInAngles: false +SpacesInContainerLiterals: false +SpacesInCStyleCastParentheses: false +SpacesInParentheses: false +SpacesInSquareBrackets: false +Standard: Cpp03 +TabWidth: 4 +UseTab: Never +... diff --git a/.github/workflows/build-push-gh-packages.yml b/.github/workflows/build-push-gh-packages.yml new file mode 100644 index 000000000..925685b2c --- /dev/null +++ b/.github/workflows/build-push-gh-packages.yml @@ -0,0 +1,52 @@ +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +name: Build the SDK Docker container + +on: + push: + tags: + - 'v*' + +# Allow manually triggering of the workflow. + workflow_dispatch: {} + +env: + REGISTRY: ghcr.io + SDK_APP_BUILDER: xmos/sdk_app_builder + +jobs: + build-image: + name: Build Docker image for building and testing applications + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Login to the Container registry + uses: docker/login-action@v1 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract metadata (tags, labels) for Docker + id: meta + uses: docker/metadata-action@v3 + with: + images: ${{ env.REGISTRY }}/${{ env.SDK_APP_BUILDER }} + + - name: Build and push Docker image + uses: docker/build-push-action@v2 + with: + context: '.' + file: 'tools/ci/Dockerfile.apps' + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} diff --git a/.github/workflows/ci_examples.yml b/.github/workflows/ci_examples.yml new file mode 100644 index 000000000..8499c7281 --- /dev/null +++ b/.github/workflows/ci_examples.yml @@ -0,0 +1,155 @@ +# YAML schema for GitHub Actions: +# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions +# +# Helpful YAML parser to clarify YAML syntax: +# https://yaml-online-parser.appspot.com/ +# +# This workflow uses actions that are not certified by GitHub. They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support documentation. +# +# This file contains the workflows that are run prior to merging a pull request. + +name: CI - Examples + +on: + push: + branches: + - 'main' + - 'develop' + pull_request: + branches: + - 'main' + - 'develop' + + # Allow manually triggering of the workflow. + workflow_dispatch: {} + +env: + SDK_BUILDER_IMAGE: 'ghcr.io/xmos/sdk_app_builder:develop' + +jobs: + build_host_apps: + name: Build host applications + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + submodules: recursive + + - name: Pull SDK builder + run: | + docker pull ${SDK_BUILDER_IMAGE} + + - name: Build + run: | + docker run --rm -w /xcore_sdk -v ${{github.workspace}}:/xcore_sdk ${SDK_BUILDER_IMAGE} bash -l tools/ci/build_host_apps.sh + + - name: Upload artifacts + uses: actions/upload-artifact@v3 + with: + name: host_apps + path: ./dist_host + + build_rtos_core_examples: + name: Build RTOS core examples + runs-on: ubuntu-latest + needs: build_host_apps + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + submodules: recursive + + - name: Pull SDK builder + run: | + docker pull ${SDK_BUILDER_IMAGE} + + - name: Download host build artifacts + uses: actions/download-artifact@v3 + with: + name: host_apps + path: ./dist_host + + - name: Build + run: | + docker run --rm -w /xcore_sdk -v ${{github.workspace}}:/xcore_sdk ${SDK_BUILDER_IMAGE} bash -l tools/ci/build_rtos_core_examples.sh + + - name: Upload artifacts + uses: actions/upload-artifact@v3 + with: + name: freertos_core_examples + path: | + ./dist/*.xe + ./dist/*.fs + ./dist/*.swmem + + build_rtos_aiot_examples: + name: Build RTOS AIoT examples + runs-on: ubuntu-latest + needs: build_host_apps + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + submodules: recursive + + - name: Install Python + uses: actions/setup-python@v2 + with: + python-version: '3.8' + + - name: Install Python requirements + run: | + python -m pip install --upgrade pip + pip install -r tools/install/requirements.txt + + - name: Make input data for examples + run: | + cd ./examples/freertos/cifar10/filesystem_support/test_inputs && python make_test_tensors.py + + - name: Pull SDK builder + run: | + docker pull ${SDK_BUILDER_IMAGE} + + - name: Download host build artifacts + uses: actions/download-artifact@v3 + with: + name: host_apps + path: ./dist_host + + - name: Build + run: | + docker run --rm -w /xcore_sdk -v ${{github.workspace}}:/xcore_sdk ${SDK_BUILDER_IMAGE} bash -l tools/ci/build_rtos_aiot_examples.sh + + - name: Upload artifacts + uses: actions/upload-artifact@v3 + with: + name: freertos_aiot_examples + path: | + ./dist/*.xe + ./dist/*.fs + ./dist/*.swmem + + build_metal_examples: + name: Build bare-metal examples + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + submodules: recursive + + - name: Pull SDK builder + run: | + docker pull ${SDK_BUILDER_IMAGE} + + - name: Build + run: | + docker run --rm -w /xcore_sdk -v ${{github.workspace}}:/xcore_sdk ${SDK_BUILDER_IMAGE} bash -l tools/ci/build_metal_examples.sh + + - name: Upload artifacts + uses: actions/upload-artifact@v3 + with: + name: bare-metal_examples + path: ./dist/*.xe \ No newline at end of file diff --git a/.github/workflows/ci_tests.yml b/.github/workflows/ci_tests.yml new file mode 100644 index 000000000..1ad5c389f --- /dev/null +++ b/.github/workflows/ci_tests.yml @@ -0,0 +1,103 @@ +# YAML schema for GitHub Actions: +# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions +# +# Helpful YAML parser to clarify YAML syntax: +# https://yaml-online-parser.appspot.com/ +# +# This workflow uses actions that are not certified by GitHub. They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support documentation. +# +# This file contains the workflows that are run prior to merging a pull request. + +name: CI - Tests + +on: + push: + branches: + - 'develop' + pull_request: + branches: + - 'develop' + + # Allow manually triggering of the workflow. + workflow_dispatch: {} + +env: + SDK_BUILDER_IMAGE: 'ghcr.io/xmos/sdk_app_builder:develop' + +jobs: + changes: + runs-on: ubuntu-latest + name: Change detection + # Set job outputs to values from filter step + outputs: + tusb_demos: ${{ steps.filter.outputs.tusb_demos }} + rtos_tests: ${{ steps.filter.outputs.rtos_tests }} + steps: + - name: Checkout SDK + uses: actions/checkout@v2 + with: + submodules: recursive + - name: Paths filter + uses: dorny/paths-filter@v2 + id: filter + with: + filters: | + tusb_demos: + - 'modules/io/modules/xud/**' + - 'modules/rtos/modules/sw_services/usb/**' + - 'modules/rtos/modules/drivers/usb/**' + rtos_tests: + - 'modules/core/**' + - 'modules/io/**' + - 'modules/rtos/**' + + build_rtos_tusb_demos: + needs: changes + name: Build RTOS TinyUSB demos + if: ${{ needs.changes.outputs.tusb_demos == 'true' }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + submodules: recursive + + - name: Pull SDK builder + run: | + docker pull ${SDK_BUILDER_IMAGE} + + - name: Build + run: | + docker run --rm -w /xcore_sdk -v ${{github.workspace}}:/xcore_sdk ${SDK_BUILDER_IMAGE} bash -l tools/ci/build_rtos_usb_examples.sh + + # - name: Upload artifacts + # uses: actions/upload-artifact@v3 + # with: + # name: freertos_usb_demos + # path: ./dist/*.xe + + build_rtos_tests: + needs: changes + name: Build RTOS tests + if: ${{ needs.changes.outputs.rtos_tests == 'true' }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + with: + submodules: recursive + + - name: Pull SDK builder + run: | + docker pull ${SDK_BUILDER_IMAGE} + + - name: Build + run: | + docker run --rm -w /xcore_sdk -v ${{github.workspace}}:/xcore_sdk ${SDK_BUILDER_IMAGE} bash -l tools/ci/build_rtos_tests.sh all + + # - name: Upload artifacts + # uses: actions/upload-artifact@v3 + # with: + # name: rtos_tests + # path: ./dist/*.xe diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..24782419d --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,50 @@ +# YAML schema for GitHub Actions: +# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions +# +# Helpful YAML parser to clarify YAML syntax: +# https://yaml-online-parser.appspot.com/ +# +# This workflow uses actions that are not certified by GitHub. They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support documentation. +# +# This file contains the workflows that are run prior to merging a pull request. + +name: Docs + +on: + push: + branches: + - 'main' + - 'releases/**' + - 'develop' + + # Allow manually triggering of the workflow. + workflow_dispatch: {} + +env: + DOC_BUILDER_IMAGE: 'ghcr.io/xmos/doc_builder:main' + +jobs: + build_documentation: + name: Build and package documentation + runs-on: ubuntu-latest + steps: + - name: Checkout SDK + uses: actions/checkout@v2 + with: + submodules: recursive + + - name: Pull documentation builder docker image + run: | + docker pull ${DOC_BUILDER_IMAGE} + + - name: Build documentation + run: | + docker run --rm -t -u "$(id -u):$(id -g)" -v ${{ github.workspace }}:/build -e REPO:/build -e EXCLUDE_PATTERNS=/build/doc/exclude_patterns.inc -e DOXYGEN_INCLUDE=/build/doc/Doxyfile.inc -e DOXYGEN_INPUT=ignore ${DOC_BUILDER_IMAGE} + + - name: Save documentation artifacts + uses: actions/upload-artifact@v3 + with: + name: xcore_sdk_docs + path: doc/_build + if-no-files-found: error # 'warn' or 'ignore' are also available, defaults to `warn` diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml new file mode 100644 index 000000000..5d9e132ef --- /dev/null +++ b/.github/workflows/python.yml @@ -0,0 +1,73 @@ +# YAML schema for GitHub Actions: +# https://help.github.com/en/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions +# +# Helpful YAML parser to clarify YAML syntax: +# https://yaml-online-parser.appspot.com/ +# +# This workflow uses actions that are not certified by GitHub. They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support documentation. +# +# This file contains the workflows that are run prior to merging a pull request. +# This workflow will be triggered when a PR modifies some python relevant files + +name: Python + +on: + push: + branches: + - 'main' + - 'develop' + + pull_request: + branches: + - 'main' + - 'develop' + + # Allow manually triggering of the workflow. + workflow_dispatch: {} + +jobs: + changes: + runs-on: ubuntu-latest + name: Change detection + # Set job outputs to values from filter step + outputs: + python_install: ${{ steps.filter.outputs.python_install }} + steps: + - name: Checkout SDK + uses: actions/checkout@v2 + with: + submodules: recursive + - name: Paths filter + uses: dorny/paths-filter@v2 + id: filter + with: + filters: | + python_install: + - 'tools/install/requirements.txt' + - '**.py' + + python_install: + runs-on: ubuntu-latest + needs: changes + name: Install & verify Python packages + if: ${{ needs.changes.outputs.python_install == 'true' }} + steps: + - name: Checkout SDK + uses: actions/checkout@v2 + with: + submodules: recursive + + - name: Install Python + uses: actions/setup-python@v2 + with: + python-version: '3.8' + + - name: Install packages + run: | + python -m pip install --upgrade pip + pip install -r tools/install/requirements.txt + + - name: Verify install + run: | + python test/verify_python_install.py diff --git a/.gitignore b/.gitignore index 94bd4a97b..a14787a3e 100644 --- a/.gitignore +++ b/.gitignore @@ -7,7 +7,6 @@ **/*.egg-info/* **/*.eggs/* **/.ipynb_checkpoints/* -*sdk_venv/* # Build & debug cruft **/.build*/* @@ -24,27 +23,49 @@ *.xmt **/_build/ **/build_*/ +!doc/tutorials/build_system/ **/run_*.log -**/doxygen/* +**/_doxygen/* +**/_templates/* **/pdf/* **/html/* **/.settings/* .metadata **/test_results.csv +**/test_results.xml **/.venv/** .metadata +*.gtkw +*.swmem +*.bin +*.fs # Test cruft **/.pytest_cache/* **/*_junit.xml +**/testing/* # waf build cruft .lock-waf_* .waf-*/ build/ +# filesystem cruft +**/fat.fs +**/flash_bin_node0 +**/fw-* +**/spanning-xn-* +**/target-xn-* + +# wifi cruft +**/networks.dat + # systemview debug cruft *.SVDAT # macOS cruft -.DS_Store \ No newline at end of file +.DS_Store + +# ai_tools +tools/ai/ai_tools +*xcore_sdk_venv/* diff --git a/.gitmodules b/.gitmodules index 9ee1fdd0d..de37256b2 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,86 +1,18 @@ -[submodule "lib_dsp"] - path = modules/lib_dsp - url = git@github.com:xmos/lib_dsp.git -[submodule "lib_xs3_math"] - path = modules/lib_xs3_math - url = git@github.com:xmos/lib_xs3_math.git - shallow = true -[submodule "lib_otpinfo"] - path = modules/lib_otpinfo - url = git@github.com:xmos/lib_otpinfo.git -[submodule "lib_random"] - path = modules/lib_random - url = git@github.com:xmos/lib_random.git -[submodule "mbedtls"] - path = modules/rtos/sw_services/tls_support/thirdparty/mbedtls - url = git@github.com:ARMmbed/mbedtls.git - shallow = true -[submodule "paho.mqtt.embedded-c"] - path = modules/rtos/sw_services/mqtt/thirdparty/paho.mqtt.embedded-c - url = git@github.com:eclipse/paho.mqtt.embedded-c.git - shallow = true -[submodule "http-parser"] - path = modules/rtos/sw_services/http/thirdparty/http-parser - url = git@github.com:nodejs/http-parser.git - shallow = true -[submodule "jsmn"] - path = modules/rtos/sw_services/json/thirdparty/jsmn - url = git@github.com:zserge/jsmn.git - shallow = true -[submodule "ai_tools"] - path = tools/ai_tools - url = git@github.com:xmos/ai_tools.git - shallow = true -[submodule "lib_i2c"] - path = modules/hil/lib_i2c - url = git@github.com:xmos/lib_i2c.git -[submodule "lib_i2s"] - path = modules/hil/lib_i2s - url = git@github.com:xmos/lib_i2s.git -[submodule "lib_mic_array"] - path = modules/hil/lib_mic_array - url = git@github.com:xmos/lib_mic_array.git -[submodule "lib_spi"] - path = modules/hil/lib_spi - url = git@github.com:xmos/lib_spi.git -[submodule "wfx-fullMAC-driver"] - path = modules/rtos/drivers/wifi/sl_wf200/thirdparty/wfx-fullMAC-driver - url = git@github.com:SiliconLabs/wfx-fullMAC-driver.git -[submodule "FreeRTOS-SMP-Kernel"] - path = modules/rtos/FreeRTOS/FreeRTOS-SMP-Kernel - url = git@github.com:xmos/FreeRTOS-Kernel.git - branch = feature/xcore-smp -[submodule "FreeRTOS-Kernel"] - path = modules/rtos/FreeRTOS/FreeRTOS-Kernel - url = git@github.com:xmos/FreeRTOS-Kernel.git - branch = feature/xcore -[submodule "FreeRTOS-Plus-TCP"] - path = modules/rtos/FreeRTOS/FreeRTOS-Plus-TCP - url = git@github.com:xmos/FreeRTOS-Plus-TCP.git - branch = main -[submodule "wfx-firmware"] - path = modules/rtos/drivers/wifi/sl_wf200/thirdparty/wfx-firmware - url = git@github.com:SiliconLabs/wfx-firmware.git -[submodule "tinyusb"] - path = modules/rtos/sw_services/usb/thirdparty/tinyusb - url = git@github.com:hathach/tinyusb.git - shallow = true - fetchRecurseSubmodules = false -[submodule "modules/legacy_compat/lib_mic_array"] - path = modules/legacy_compat/lib_mic_array - url = git@github.com:xmos/lib_mic_array.git -[submodule "modules/aif/lib_nn"] - path = modules/aif/lib_nn - url = git@github.com:xmos/lib_nn.git -[submodule "modules/aif/flatbuffers"] - path = modules/aif/flatbuffers - url = git@github.com:google/flatbuffers.git -[submodule "modules/aif/gemmlowp"] - path = modules/aif/gemmlowp - url = git@github.com:google/gemmlowp.git -[submodule "modules/aif/ruy"] - path = modules/aif/ruy - url = git@github.com:google/ruy.git -[submodule "modules/aif/tensorflow"] - path = modules/aif/tensorflow - url = git@github.com:xmos/tensorflow.git +[submodule "lib_src"] + path = modules/sample_rate_conversion/lib_src + url = git@github.com:xmos/lib_src.git +[submodule "xmos_cmake_toolchain"] + path = xmos_cmake_toolchain + url = git@github.com:xmos/xmos_cmake_toolchain.git +[submodule "avona"] + path = modules/avona + url = git@github.com:xmos/sw_avona.git +[submodule "frameworks/core"] + path = modules/core + url = git@github.com:xmos/fwk_core.git +[submodule "frameworks/io"] + path = modules/io + url = git@github.com:xmos/fwk_io.git +[submodule "frameworks/rtos"] + path = modules/rtos + url = git@github.com:xmos/fwk_rtos.git diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 87c5acda3..801a9d18a 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,15 +1,28 @@ -AIoT SDK change log -=================== +XCore SDK change log +==================== In progress ----------- + + +0.10.0 +------ + +Many enhancements and changes from the prior release. The list below summarizes many of the changes: + + * Addition of UART library and RTOS driver + * Addition of clock control library and RTOS driver + * Addition of L2 cache library and RTOS driver + * Redesign of mic array library to leverage VPU + * Removal of the cifar10, hello_world, hotdog_not_hotdog and microspeech bare-metal example applications + * Addition of explorer_board bare-metal example application + * Removal of the person_detection FreeRTOS example application + * iot_aws FreeRTOS example application redesigned and renamed + * Addition of device_control, getting_started, ls_cache and dispatcher FreeRTOS example applicatiosn * Added USB support for FreeRTOS applications - * Implemented optimized ADD TensorFlow Lite Micro operator - * Added model runner project generation command-line utility - * Added hotdog_not_hotdog bare-metal example application * Simplified SDK installation steps - * Example applications that utilize ``xscope`` for input now support common image formats + * Redesign of CMake build system * Documentation updates 0.9.4 diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 000000000..926d94574 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,33 @@ +cmake_minimum_required(VERSION 3.21) + +## Disable in-source build. +if("${CMAKE_SOURCE_DIR}" STREQUAL "${CMAKE_BINARY_DIR}") + message(FATAL_ERROR "In-source build is not allowed! Please specify a build folder.\n\tex:cmake -B build") +endif() + +## Project declaration +project(xcore_sdk) + +## Enable languages for project +enable_language(CXX C ASM) + +## Project options +option(XCORE_SDK_TESTS "Enable xcore_sdk tests" OFF) + +## Import some helpful macros +include(modules/rtos/tools/cmake_utils/xmos_macros.cmake) + +## Setup a framework root path +set(XCORE_SDK_ROOT ${PROJECT_SOURCE_DIR} CACHE STRING "Root folder of xcore_sdk in this cmake project tree") + +## Add library subdirectories +add_subdirectory(modules) + +## Add top level project targets +if(PROJECT_IS_TOP_LEVEL) + include(examples/examples.cmake) +endif() + +if(XCORE_SDK_TESTS) + include(test/tests.cmake) +endif() diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 000000000..efab4ba05 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,3 @@ +#* @@keithm-xmos @mbruno-xmos @xmos-jmccarthy + +/.github/ @keithm-xmos \ No newline at end of file diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 0e6d3d009..000000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,98 +0,0 @@ -############ -Contributing -############ - -************************************* -Contribution Guidelines and Standards -************************************* - -Before sending your pull request, make sure your changes are consistent with these guidelines and are consistent with the coding style used in this xcore_sdk repository. - -************************************************** -General Guidelines and Philosophy For Contribution -************************************************** - -* Include unit tests when you contribute new features, as they help to a) prove that your code works correctly, and b) guard against future breaking changes to lower the maintenance cost. -* Bug fixes also generally require unit tests, because the presence of bugs usually indicates insufficient test coverage. -* Keep API compatibility in mind when you change code. - -******************* -Python coding style -******************* - -All python code should be `blackened `_. -For convenience, the default workspace settings file under `.vscode/` enables format-on-save, and `black` is also provided in the conda environments. - -************************** -C, XC and ASM coding style -************************** - -Changes to C, C++ or ASM should be consistent with the style of existing C, C++ and ASM code. - -`clang-format `__ is used for formatting code. In most circumstances, the default settings are safe to use. However, you will need to configure so includes are not sorting. - -******************************* -Development Virtual Environment -******************************* - -It is recommended that you install the virtual environment in the repo's directory: - -.. code-block:: console - - conda env create -p ./xcore_sdk_venv -f environment.yml - -Activate the environment by specifying the path: - -.. code-block:: console - - conda activate xcore_sdk_venv/ - -To remove the environment, deactivate and run: - -.. code-block:: console - - conda remove -p xcore_sdk_venv/ --all - -***************** -Building Examples -***************** - -To build the examples, the `XMOS_AIOT_SDK_PATH` environment variable must be set. - -.. code-block:: console - - $ export XMOS_AIOT_SDK_PATH#/xcore_sdk - -You can also add this export command to your `.profile` or `.bash_profile` script. This way the environment variable will be set in a new terminal window. - -A script is provided to build all the example applications. Run this script with: - -.. code-block:: console - - $ bash test/build_examples.sh - -************* -Running Tests -************* - -A script is provided to run all the tests on a connected xcore.ai device. Run this script with: - -.. code-block:: console - - $ bash test/run_tests.sh - -**************** -Development Tips -**************** - -At times submodule repositories will need to be updated. To update all submodules, run the following command - -.. code-block:: console - - $ git submodule update --init --recursive - -Due to some large submodules, cloning the repository can take a few minutes. The following command will only close a history depth of 1 and is considerably faster. - -.. code-block:: console - - $ git clone --recurse-submodules --depth 1 --shallow-submodules https://github.com/xmos/xcore_sdk.git diff --git a/Dockerfile b/Dockerfile deleted file mode 100644 index 8a8db9a9c..000000000 --- a/Dockerfile +++ /dev/null @@ -1,33 +0,0 @@ -FROM continuumio/miniconda3:4.8.2 - -# This Dockerfile is for use by the XMOS CI system -# It provides a minimal environment needed to execute the Jenkinsfile -# Most of the dependecies here are handled conda so we only include: -# - conda setup -# - xmos tools setup - -# fix conda perms -RUN chmod -R 777 /opt/conda \ - && mkdir -p /.conda \ - && chmod -R 777 /.conda - -# install tools lib dependencies -RUN apt-get update && apt-get install -y \ - libncurses5 libncurses5-dev \ - tcl environment-modules \ - && apt-get clean autoclean -# install get_tools.py script -# requires connection to XMOS network at build and run time -# if not possible, find another way to install the tools -RUN mkdir -m 777 /XMOS && cd /XMOS \ - && wget -q https://github0.xmos.com/raw/xmos-int/get_tools/master/get_tools.py \ - && chmod a+x get_tools.py \ - && echo "export PATH=$PATH:/XMOS" \ - >> /etc/profile.d/xmos_tools.sh \ - && chmod a+x /etc/profile.d/xmos_tools.sh - -# install compiler -RUN apt-get install -y build-essential - -# set login shell -SHELL ["/bin/bash", "-l", "-c"] diff --git a/Jenkinsfile b/Jenkinsfile index ab51bc00b..d9e7a07b1 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -1,94 +1,158 @@ -@Library('xmos_jenkins_shared_library@v0.14.2') _ +@Library('xmos_jenkins_shared_library@v0.18.0') _ + +def withXTAG(String target, Closure body) { + // Acquire an xtag adapter-id by target name + def adapterID = sh (script: "xtagctl acquire ${target}", returnStdout: true).trim() + // Run the closure + body(adapterID) + // Release the xtag by adapter-id + sh ("xtagctl release ${adapterID}") +} + + +// Wait here until specified artifacts appear +def artifactUrls = getGithubArtifactUrls([ + "bare-metal_examples", + "freertos_core_examples", + "freertos_aiot_examples" + // "host_apps", + // "rtos_tests" +]) + getApproval() + pipeline { agent { - dockerfile { - args "" - } + label 'sdk' } - parameters { // Available to modify on the job page within Jenkins if starting a build - string( // use to try different tools versions + options { + disableConcurrentBuilds() + skipDefaultCheckout() + timestamps() + // on develop discard builds after a certain number else keep forever + buildDiscarder(logRotator( + numToKeepStr: env.BRANCH_NAME ==~ /develop/ ? '25' : '', + artifactNumToKeepStr: env.BRANCH_NAME ==~ /develop/ ? '25' : '' + )) + } + parameters { + string( name: 'TOOLS_VERSION', - defaultValue: '15.0.6', - description: 'The tools version to build with (check /projects/tools/ReleasesTools/)' - ) - booleanParam( // use to check results of rolling all conda deps forward - name: 'UPDATE_ALL', - defaultValue: false, - description: 'Update all conda packages before building' + defaultValue: '15.1.4', + description: 'The XTC tools version' ) - } - options { // plenty of things could go here - //buildDiscarder(logRotator(numToKeepStr: '10')) - timestamps() - } + } environment { - XMOS_AIOT_SDK_PATH = "${env.WORKSPACE}" - } + PYTHON_VERSION = "3.8.11" + VENV_DIRNAME = ".venv" + DOWNLOAD_DIRNAME = "build" + SDK_TEST_RIG_TARGET = "xcore_sdk_test_rig" + } stages { - stage("Setup") { - // Clone and install build dependencies + stage('Checkout') { steps { - // clean auto default checkout - sh "rm -rf *" - // clone - checkout([ - $class: 'GitSCM', - branches: scm.branches, - doGenerateSubmoduleConfigurations: false, - extensions: [[$class: 'SubmoduleOption', - threads: 8, - timeout: 20, - shallow: false, - parentCredentials: true, - recursiveSubmodules: true], - [$class: 'CleanCheckout']], - userRemoteConfigs: [[credentialsId: 'xmos-bot', - url: 'git@github.com:xmos/aiot_sdk']] - ]) - // create venv - sh "conda env create -q -p sdk_venv -f environment.yml" - // Install xmos tools version - sh "/XMOS/get_tools.py " + params.TOOLS_VERSION + checkout scm + sh "git clone git@github.com:xmos/xcore_sdk.git" } - } - stage("Update environment") { - // Roll all conda packages forward beyond their pinned versions - when { expression { return params.UPDATE_ALL } } + } + stage('Download artifacts') { steps { - sh "conda update --all -y -q -p sdk_venv" + dir("$DOWNLOAD_DIRNAME") { + downloadExtractZips(artifactUrls) + // List extracted files for log + sh "ls -la" + } } } - stage("Build examples") { + stage('Create virtual environment') { steps { - sh """. /XMOS/tools/${params.TOOLS_VERSION}/XMOS/XTC/${params.TOOLS_VERSION}/SetEnv && - . activate ./sdk_venv && bash test/build_examples.sh""" + // Create venv + sh "pyenv install -s $PYTHON_VERSION" + sh "~/.pyenv/versions/$PYTHON_VERSION/bin/python -m venv $VENV_DIRNAME" + // Install dependencies + withVenv() { + // NOTE: only one dependency so not using a requirements.txt file here yet + sh "pip install git+https://github0.xmos.com/xmos-int/xtagctl.git" + } } } - stage("Install") { + stage('Cleanup xtagctl') { steps { - sh """. activate ./sdk_venv && bash install.sh""" + // Cleanup any xtagctl cruft from previous failed runs + withTools(params.TOOLS_VERSION) { + withVenv { + sh "xtagctl reset_all $SDK_TEST_RIG_TARGET" + } + } + sh "rm -f ~/.xtag/status.lock ~/.xtag/acquired" } } - stage("Test") { + stage('Run FreeRTOS examples') { steps { - // run unit tests - sh """. activate ./sdk_venv && cd test && pytest -v --junitxml tests_junit.xml""" - // run notebook tests - sh """. activate ./sdk_venv && cd test && bash test_notebooks.sh""" - // Any call to pytest can be given the "--junitxml SOMETHING_junit.xml" option - // This step collects these files for display in Jenkins UI - junit "**/*_junit.xml" + withTools(params.TOOLS_VERSION) { + withVenv { + script { + if (fileExists("$DOWNLOAD_DIRNAME/example_freertos_getting_started.xe")) { + withXTAG("$SDK_TEST_RIG_TARGET") { adapterID -> + sh "test/examples/run_freertos_getting_started_tests.sh $adapterID" + } + } else { + echo 'SKIPPED: example_freertos_getting_started' + } + } + script { + if (fileExists("$DOWNLOAD_DIRNAME/example_freertos_explorer_board.xe")) { + withXTAG("$SDK_TEST_RIG_TARGET") { adapterID -> + sh "test/examples/run_freertos_explorer_board_tests.sh $adapterID" + } + } else { + echo 'SKIPPED: example_freertos_explorer_board' + } + } + script { + if (fileExists("$DOWNLOAD_DIRNAME/example_freertos_cifar10.xe")) { + withXTAG("$SDK_TEST_RIG_TARGET") { adapterID -> + sh "test/examples/run_freertos_cifar10_tests.sh $adapterID" + } + } else { + echo 'SKIPPED: example_freertos_cifar10' + } + } + script { + if (fileExists("$DOWNLOAD_DIRNAME/example_freertos_dispatcher.xe")) { + withXTAG("$SDK_TEST_RIG_TARGET") { adapterID -> + sh "test/examples/run_freertos_dispatcher_tests.sh $adapterID" + } + } else { + echo 'SKIPPED: example_freertos_dispatcher' + } + } + script { + if (fileExists("$DOWNLOAD_DIRNAME/example_freertos_l2_cache.xe")) { + withXTAG("$SDK_TEST_RIG_TARGET") { adapterID -> + sh "test/examples/run_freertos_l2_cache_tests.sh $adapterID" + } + } else { + echo 'SKIPPED: example_freertos_l2_cache' + } + } + } + } } } - stage("Build documentation") { + stage('Run bare-metal examples') { steps { - dir('documents') { - sh '. activate ../sdk_venv && make clean linkcheck html SPHINXOPTS="-W --keep-going"' - dir('_build') { - archiveArtifacts artifacts: 'html/**/*', fingerprint: false - sh 'tar -czf docs_sdk.tgz html' - archiveArtifacts artifacts: 'docs_sdk.tgz', fingerprint: true + withTools(params.TOOLS_VERSION) { + withVenv { + script { + if (fileExists("$DOWNLOAD_DIRNAME/example_bare_metal_vww_test.xe")) { + withXTAG("$SDK_TEST_RIG_TARGET") { adapterID -> + sh "test/examples/run_bare_metal_vww_tests.sh $adapterID" + } + } else { + echo 'SKIPPED: example_bare_metal_vww' + } + } } } } diff --git a/README.md b/README.md new file mode 100644 index 000000000..8a67c3ba5 --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# XCore SDK Repository + +[![Version](https://img.shields.io/github/v/release/xmos/xcore_sdk?include_prereleases)](https://github.com/xmos/xcore_sdk/releases/latest) +[![Issues](https://img.shields.io/github/issues/xmos/xcore_sdk)](https://github.com/xmos/xcore_sdk/issues) +[![Contributors](https://img.shields.io/github/contributors/xmos/xcore_sdk)](https://github.com/xmos/xcore_sdk/graphs/contributors) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/xmos/xcore_sdk/pulls) + +The XCore SDK is a collection of C/C++ software libraries designed to simplify and accelerate application development on XCore processors. It is composed of the following components: + +- Peripheral IO libraries including; UART, I2C, I2S, SPI, QSPI, PDM microphones, and USB. These libraries support bare-metal and RTOS application development. +- Libraries core to DSP and AI applications, including; vectorized math, DSP, and neural network inferencing. These libraries support bare-metal and RTOS application development. +- Voice processing libraries including; adaptive echo cancellation, adaptive gain control, noise suppression, interference cancellation (IC), and voice activity detection. These libraries support bare-metal and RTOS application development. +- Libraries that enable [multi-core FreeRTOS development](https://www.freertos.org/symmetric-multiprocessing-introduction.html) on XCore including a wide array of RTOS drivers and middleware. +- Code Examples - Examples showing a variety of XCore features based on bare-metal and FreeRTOS programming. + +The SDK is designed to be used in conjunction with the xcore.ai Explorer board evaluation kit. The example applications compile targeting this board. Further information about the Explorer board and xcore.ai devices is available to on [www.xmos.ai](https://www.xmos.ai/). + +## Build Status + +Build Type | Status | +----------- | --------------| +CI (Linux) | ![CI](https://github.com/xmos/xcore_sdk/actions/workflows/ci_examples.yml/badge.svg?branch=develop&event=push) | +CI (Linux) | ![CI](https://github.com/xmos/xcore_sdk/actions/workflows/ci_tests.yml/badge.svg?branch=develop&event=push) | +Docs | ![CI](https://github.com/xmos/xcore_sdk/actions/workflows/docs.yml/badge.svg?branch=develop&event=push) | + +## Cloning + +Some dependent components are included as git submodules. These can be obtained by cloning this repository with the following command: + + git clone --recurse-submodules https://github.com/xmos/xcore_sdk.git + +## Development Tools + +Download and install the XCore [XTC Tools](https://www.xmos.ai/software-tools/) version 15.1.0 or newer. If you already have the XTC Toolchain installed, you can check the version with the following command: + + xcc --version + +## Documentation + +See the [official documentation](https://www.xmos.ai/xcore-sdk/) for more information including: + +- Instructions for installing +- Getting started guides +- Programming tutorials +- API references + +## Getting Help + +A [Github issue](https://github.com/xmos/xcore_sdk/issues/new/choose) should be the primary method of getting in touch with the XMOS SDK development team. + +## License + +This Software is subject to the terms of the [XMOS Public Licence: Version 1](https://github.com/xmos/xcore_sdk/blob/develop/LICENSE.rst). Copyrights and licenses for third party components can be found in [Copyrights and Licenses](https://github.com/xmos/xcore_sdk/blob/develop/doc/copyright.rst). + +## Contribution + +Contributions are greatly welcomed! For guidelines of contribution please check the [Contributing Guide](https://github.com/xmos/xcore_sdk/blob/develop/doc/contributing.rst). + diff --git a/README.rst b/README.rst deleted file mode 100644 index 31b2a3312..000000000 --- a/README.rst +++ /dev/null @@ -1,39 +0,0 @@ -AIoT SDK Repository -=================== - -Summary -------- - -The XMOS AIoT SDK and is intended to enable basic evaluation of xcore.ai functionality and perfomance. It comprises the following components: - -- AIoT Tools - Scripts, tools and libraries to convert TensorFlowLite for Microcontroller models to a format targetting accelerated operations. -- FreeRTOS - Libraries to support FreeRTOS operation. -- Examples - Examples showing a variety of operations based on bare-metal and FreeRTOS operation. -- Documentation - Getting started guides and example build and execution instructions. - -The AIoT SDK is designed to be used in conjunction with the xcore-ai Explorer board. The example -applications compile targeting this board. Further information about the Explorer board, and the xcore.ai -device are available to authorised parties on `www.xmos.ai `_. - -Installation ------------- - -Some dependent components are included as git submodules. These can be obtained by cloning this repository with the following commands: - -.. code-block:: console - - $ git clone https://github.com/xmos/aiot_sdk.git - $ cd aiot_sdk - $ git submodule update --init --recursive modules - -Documentation -------------- - -See the `Getting Started Guide `_ for instructions on installing and using the AI Toolchain Extensions. - -Contributing ------------- - -See the `CONTRIBUTING.rst `_ for information on building example applications, running tests, and guidelines for adding code. - - diff --git a/doc/Doxyfile.inc b/doc/Doxyfile.inc new file mode 100644 index 000000000..56d7c8f6e --- /dev/null +++ b/doc/Doxyfile.inc @@ -0,0 +1,45 @@ +# This file provides overrides to the Doxyfile configuration + +PROJECT_NAME = XCore SDK +PROJECT_BRIEF = "XCore Software Development Kit" + +PREDEFINED = __DOXYGEN__=1 +PREDEFINED += DWORD_ALIGNED= +PREDEFINED += __attribute__((weak))= +PREDEFINED += C_API= MA_C_API= C_API_START= C_API_END= EXTERN_C= + +# Core library APIs +INPUT += ../modules/core/modules/xs3_math + +# IO library APIs +INPUT += ../modules/io/modules/i2c/api +INPUT += ../modules/io/modules/i2s/api +INPUT += ../modules/io/modules/qspi_io/api +INPUT += ../modules/io/modules/spi/api +INPUT += ../modules/io/modules/uart/api +INPUT += ../modules/io/modules/mic_array/lib_mic_array/api ../modules/io/modules/mic_array/etc/vanilla + +# RTOS driver APIs +INPUT += ../modules/rtos/modules/drivers + +# RTOS SW Services +INPUT += ../modules/rtos/modules/sw_services/device_control/host ../modules/rtos/modules/sw_services/device_control/api + +# Avona library APIs +INPUT += ../modules/avona/modules/lib_aec/api ../modules/avona/examples/bare-metal/shared_src/aec/ +INPUT += ../modules/avona/modules/lib_ns/api +INPUT += ../modules/avona/modules/lib_agc/api +INPUT += ../modules/avona/modules/lib_adec/api +INPUT += ../modules/avona/modules/lib_ic/api +INPUT += ../modules/avona/modules/lib_vad/api + +USE_MATHJAX = YES +MATHJAX_FORMAT = HTML-CSS +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/ + +# Make short MATHJAX sequences prettier +ALIASES += math{1}="@f$\1@f$" +ALIASES += vector{1}="@f$\bar \1@f$" +ALIASES += operation{1}="@par Operation Performed:^^@f{align*}{ \1 @f}" +ALIASES += "beginrst=^^\verbatim embed:rst^^" +ALIASES += "endrst=\endverbatim" diff --git a/doc/README.rst b/doc/README.rst new file mode 100644 index 000000000..118fd4bf9 --- /dev/null +++ b/doc/README.rst @@ -0,0 +1,48 @@ +#################### +Documentation Source +#################### + +This folder contains source files for the **XCore SDK documentation**. The sources do not render well in GitHub or an RST viewer. In addition, some information +is not visible at all and some links will not be functional. + +******************** +Hosted Documentation +******************** + +TODO: Include URL for hosted documentation + +********************** +Building Documentation +********************** + +============= +Prerequisites +============= + +Install `Docker `_. + +Pull the docker container: + +.. code-block:: console + + docker pull ghcr.io/xmos/doc_builder:main + +======== +Building +======== + +To build the documentation, run the following command in the root of the repository: + +.. code-block:: console + + docker run --rm -t -u "$(id -u):$(id -g)" -v $(pwd):/build -e REPO:/build -e DOXYGEN_INCLUDE=/build/doc/Doxyfile.inc -e EXCLUDE_PATTERNS=/build/doc/exclude_patterns.inc -e DOXYGEN_INPUT=ignore ghcr.io/xmos/doc_builder:main + +********************** +Adding a New Component +********************** + +Follow the following steps to add a new component. + +- Add an entry for the new component's top-level document to the appropriate TOC in the documents tree. +- If the new component uses `Doxygen`, append the appropriate path(s) to the INPUT variable in `Doxyfile.inc`. +- If the new component includes `.rst` files that should **not** be part of the documentation build, append the appropriate pattern(s) to `exclude_patterns.inc`. \ No newline at end of file diff --git a/doc/contributing.rst b/doc/contributing.rst new file mode 100644 index 000000000..1a02f6084 --- /dev/null +++ b/doc/contributing.rst @@ -0,0 +1,147 @@ +####################### +Contributing Guidelines +####################### + +************ +Requirements +************ + +The following software is required for developing code for the SDK. Install them using your operating systems package management system. + +* `Python 3.8 `__ + +Install development python packages: + +.. code-block:: console + + python -m pip install --upgrade pip + pip install -r tools/install/requirements.txt -r tools/install/contribute.txt -r doc/requirements.txt + +Python Virtual Environment +========================== + +While not required, we recommend you setup an `Anaconda `_ virtual environment. If necessary, download and follow Anaconda's installation instructions. + +Run the following command to create a Conda environment: + +.. code-block:: console + + conda create --prefix xcore_sdk_venv python=3.8 + +Run the following command to activate the Conda environment: + +.. code-block:: console + + conda activate /xcore_sdk_venv + +Install development packages: + +.. code-block:: console + + pip install -r tools/install/requirements.txt -r tools/install/contribute.txt -r doc/requirements.txt + +Run the following command to deactivate the Conda environment: + +.. code-block:: console + + conda deactivate + +************************************* +Contribution Guidelines and Standards +************************************* + +Before sending your pull request, make sure your changes are consistent with these guidelines and are consistent with the coding style used in this xcore_sdk repository. + +************************************************** +General Guidelines and Philosophy For Contribution +************************************************** + +* Include unit tests when you contribute new features, as they help to a) prove that your code works correctly, and b) guard against future breaking changes to lower the maintenance cost. +* Bug fixes also generally require unit tests, because the presence of bugs usually indicates insufficient test coverage. +* Keep API compatibility in mind when you change code. + +*************************** +C, C++ and ASM coding style +*************************** + +Changes to C, C++ or ASM should be consistent with the style of existing C, C++ and ASM code. + +clang-format +============== + +`clang-format `__ is a tool to format source code according to a set of rules and heuristics. + +clang-format can be used to: + +- Reformat a block of code to the SDK style. +- Help you follow the XCore SDK coding style. + +The SDK's clang-format configuration file is `.clang-format` and is in the root of the xcore_sdk repository. The rules contained in ``.clang-format`` were originally derived from the Linux Kernel coding style. A few modifications have been made by the XCore SDK authors. Not all code in the XCore SDK follows the ``.clang-format`` rules. Some non-compliant code is intentional while some is not. Non-intentional instances should be addressed when the non-compliant code needs to be enhanced. + +For more information about `clang-format` visit: + +https://clang.llvm.org/docs/ClangFormat.html + +https://clang.llvm.org/docs/ClangFormatStyleOptions.html + +******************* +Python coding style +******************* + +All python code should be `blackened `_. + +TODO: Add information about the ``black`` config file. + +***************** +Building Examples +***************** + +Some scripts are provided to build all the example applications. Run this script with: + +.. code-block:: console + + bash tools/ci/build_metal_examples.sh all + bash tools/ci/build_rtos_examples.sh all + bash tools/ci/build_rtos_usb_examples.sh all + +************* +Running Tests +************* + +Tests for components in the SDK are located in the ``test`` folder. This includes tests for: + +.. toctree:: + :maxdepth: 1 + :includehidden: + + test/rtos_drivers/hil + test/rtos_drivers/hil_add + test/rtos_drivers/usb + test/rtos_drivers/wifi + test/examples + +******************** +Adding CMake Targets +******************** + +The following conventions are used when naming CMake targets: + +- Targets that match ``xcore_sdk_*`` are linkable .a files +- Targets that match ``tile\d_*`` are intermediates for multitile builds and should not be build directly +- Targets that match ``example_bare_metal_*`` are bare-metal examples +- Targets that match ``example_freertos_*`` are FreeRTOS examples +- Targets that match ``run_example_*`` are a shortcut recipe to call ``xrun`` with ``xscope`` and the associated firmware +- Targets that match ``debug_example_*`` are a shortcut recipe to call ``xgdb`` with ``xscope`` and the associated firmware +- Targets that match ``xsim_example_*`` are a shortcut recipe to call ``xsim`` with the associated firmware +- Targets that match ``flash_example_*`` are a shortcut recipe to flash required data +- Targets that match ``flash_fs_example_*`` are a shortcut recipe to flash required data for applications using a filesystem + +**************** +Development Tips +**************** + +At times submodule repositories will need to be updated. To update all submodules, run the following command + +.. code-block:: console + + git submodule update --init --recursive diff --git a/doc/copyright.rst b/doc/copyright.rst new file mode 100644 index 000000000..6ebb883fd --- /dev/null +++ b/doc/copyright.rst @@ -0,0 +1,37 @@ +Copyrights and Licenses +======================= + +Software Copyrights +------------------- + +All original source code in this repository is Copyright (C) 2019-2022 XMOS Ltd and is licensed under the `XMOS License <../LICENSE.rst>`_. + +Additional third party code is included under the following copyrights and licenses: + +.. list-table:: Third Party Module Copyrights & Licenses + :widths: 50 100 + :header-rows: 1 + :align: left + + * - Module + - Copyright & License + * - `Argtable3 `__ + - Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann, licensed under `LICENSE `__ + * - `FatFS `__ + - Copyright (C) 2017 ChaN, licensed under a `BSD-style license `__ + * - `FreeRTOS `__ + - Copyright (c) 2017 Amazon.com, Inc., licensed under the `MIT License `__ + * - HTTP Parser + - Copyright (c) Joyent, Inc. and other Node contributors, licensed under the `MIT license `__ + * - `JSMN JSON Parser `__ + - Copyright (c) 2010 Serge A. Zaitsev, licensed under the `MIT license `__ + * - `KISS FFT `__ + - Copyright (c) 2003-2010 Mark Borgerding, licensed under the `SPDX-License-Identifier BSD-3-Clause `__ + * - `Mbed TLS library `__ + - Copyright (c) 2006-2018 ARM Limited, licensed under the `Apache License 2.0 `__ + * - `Paho MQTT C/C++ client for Embedded platforms `__ + - Copyright (c) 2013 Eclipse Foundation, licensed under the `Eclipse Public License and Eclipse Distribution License `__ + * - `TensorFlow `__ + - Copyright (c) 2020 The TensorFlow Authors, licensed under the `Apache License `__ + * - `TinyUSB `__ + - Copyright (c) 2018 hathach (tinyusb.org), licensed under the `MIT license `__ diff --git a/doc/exclude_patterns.inc b/doc/exclude_patterns.inc new file mode 100644 index 000000000..d90e4d144 --- /dev/null +++ b/doc/exclude_patterns.inc @@ -0,0 +1,14 @@ +# The following patterns are to be excluded from the documentation build +*_venv +documents/README.rst +tools +projects +test +modules/sample_rate_conversion +modules/core/modules/legacy_compat +modules/core/modules/otpinfo +modules/core/modules/random +modules/core/modules/inferencing +modules/io/modules/xud +modules/io/doc/substitutions.rst +modules/avona/doc/substitutions.rst diff --git a/doc/quick_start/index.rst b/doc/quick_start/index.rst new file mode 100644 index 000000000..df044479f --- /dev/null +++ b/doc/quick_start/index.rst @@ -0,0 +1,20 @@ +############ +Introduction +############ + +The XCore SDK is a collection of C/C++ software libraries designed to simplify and accelerate application development on XCore processors. It is composed of the following components: + +- Peripheral IO libraries including; UART, I2C, I2S, SPI, QSPI, PDM microphones, and USB. These libraries support bare-metal and RTOS application development. +- Libraries core to DSP and AI applications, including; vectorized math, DSP, and neural network inferencing. These libraries support bare-metal and RTOS application development. +- Voice processing libraries including; adaptive echo cancellation, adaptive gain control, noise suppression, interference cancellation (IC), and voice activity detection. These libraries support bare-metal and RTOS application development. +- Libraries that enable `multi-core FreeRTOS development `__ on XCore including a wide array of RTOS drivers and middleware. +- Code Examples - Examples showing a variety of XCore features based on bare-metal and FreeRTOS programming. +- Documentation - Getting started guides, references and API guides. + +The SDK is designed to be used in conjunction with the xcore.ai Explorer board and the Voice Reference evaluation kit. The example applications compile targeting these boards. Further information about the Explorer board, the Voice Reference evaluation kit, and xcore.ai devices is available to on `www.xmos.ai `__. + +*************** +Getting Started +*************** + +Fast-forward to the :ref:`Tutorials ` for information on installing and using the XCore SDK. diff --git a/doc/quick_start/installation.rst b/doc/quick_start/installation.rst new file mode 100644 index 000000000..d25f4c018 --- /dev/null +++ b/doc/quick_start/installation.rst @@ -0,0 +1,74 @@ +.. _sdk-installation: + +############ +Installation +############ + +Follow the following steps to install and setup the SDK: + +Step 1. Cloning the SDK +======================= + +Clone the XCore SDK repository with the following command: + +.. code-block:: console + + $ git clone --recurse-submodules https://github.com/xmos/xcore_sdk.git + +Step 2. Install Host Applications +================================= + +The SDK includes utilities that run on the PC host. Run the following command to build and install these utilities: + +.. tab:: Linux and MacOS + + .. code-block:: console + + $ cmake -B build_host + $ cd build_host + $ sudo make install + + This command installs the applications at ``/opt/xmos/SDK//bin/`` directory. You may wish to append this directory to your ``PATH`` variable. + + .. code-block:: console + + $ export PATH=$PATH:/opt/xmos/SDK//bin/ + +.. tab:: Windows + + Windows users must run the x86 native tools command prompt from Visual Studio + + .. code-block:: console + + $ cmake -G "NMake Makefiles" -B build_host + $ cd build_host + $ make install + + This command installs the applications at ``\.xmos\SDK\\bin\`` directory. You may wish to add this directory to your ``PATH`` variable. + + +Optional Step 3. Install Python and Python Requirements +======================================================= + +The SDK does not require installing Python, however, several example applications do utilize Python scripts. To run these scripts, Python 3 is needed, we recommend and test with Python 3.8. Install `Python `__ and install the dependencies using the following commands: + +.. note:: You can also setup a Python virtual environment using Conda or other virtual environment tool. + +Install pip if needed: + +.. code-block:: console + + $ python -m pip install --upgrade pip + +Then use `pip` to install the required modules. + +.. code-block:: console + + $ pip install -r tools/install/requirements.txt + +********************************** +Build & Run Your First Application +********************************** + +Once your have installed the SDK, the next step is to :ref:`build and run your first XCore application. ` + diff --git a/doc/quick_start/system-requirements.rst b/doc/quick_start/system-requirements.rst new file mode 100644 index 000000000..e1d32b0cc --- /dev/null +++ b/doc/quick_start/system-requirements.rst @@ -0,0 +1,40 @@ +.. _sdk-system-requirements: + +################### +System Requirements +################### + +The XCore SDK is officially supported on the following platforms. Unofficial support is mentioned where appropriate. + + +.. tab:: Windows + + Windows 10 is supported. + + Windows users can also use the Windows Subsystem for Linux (WSL). See `Windows Subsystem for Linux Installation Guide for Windows 10 `__ to install WSL. + + The SDK should also work using other Windows GNU development environments like GNU Make, MinGW or Cygwin. + +.. tab:: Mac + + Operating systems macOS 10.5 (Catalina) and newer are supported. Intel processors only. Older operating systems are likely to also work, though they are not supported. + + A standard C/C++ compiler is required to build applications and libraries on the host PC. Mac users may use the Xcode command line tools. + +.. tab:: Linux + + Many modern Linux distros including Fedora, Ubuntu, CentOS & Debian are supported. + +.. _sdk-prerequisites: + +************* +Prerequisites +************* + +`XTC Tools 15.0.6 `_ or newer and `CMake 3.21 `_ or newer are required for building the example applications. If necessary, download and follow the installation instructions for those components. + +****************** +Installing the SDK +****************** + +Once your have checked the system requirements and installed the prerequisites, the next step is to :ref:`install the SDK. ` \ No newline at end of file diff --git a/doc/reference/index.rst b/doc/reference/index.rst new file mode 100644 index 000000000..3438da75f --- /dev/null +++ b/doc/reference/index.rst @@ -0,0 +1,11 @@ +########## +References +########## + +.. toctree:: + :maxdepth: 2 + + ../../modules/core/index.rst + ../../modules/io/index.rst + ../../modules/avona/index.rst + ../../modules/rtos/index.rst diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 000000000..dff4bd6e7 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,6 @@ +breathe +furo +Sphinx +sphinx-copybutton +sphinx-inline-tabs +sphinx-autobuild diff --git a/doc/substitutions.rst b/doc/substitutions.rst new file mode 100644 index 000000000..a06ed94e8 --- /dev/null +++ b/doc/substitutions.rst @@ -0,0 +1,2 @@ +.. |I2C| replace:: I\ :sup:`2`\ C +.. |I2S| replace:: I\ :sup:`2`\ S diff --git a/doc/test/examples.rst b/doc/test/examples.rst new file mode 100644 index 000000000..4c4219003 --- /dev/null +++ b/doc/test/examples.rst @@ -0,0 +1 @@ +.. include:: ../../test/examples/README.rst \ No newline at end of file diff --git a/doc/test/rtos_drivers/hil.rst b/doc/test/rtos_drivers/hil.rst new file mode 100644 index 000000000..7806c63f6 --- /dev/null +++ b/doc/test/rtos_drivers/hil.rst @@ -0,0 +1 @@ +.. include:: ../../../test/rtos_drivers/hil/README.rst diff --git a/doc/test/rtos_drivers/hil_add.rst b/doc/test/rtos_drivers/hil_add.rst new file mode 100644 index 000000000..9c91fd282 --- /dev/null +++ b/doc/test/rtos_drivers/hil_add.rst @@ -0,0 +1 @@ +.. include:: ../../../test/rtos_drivers/hil_add/README.rst diff --git a/doc/test/rtos_drivers/usb.rst b/doc/test/rtos_drivers/usb.rst new file mode 100644 index 000000000..78570bef6 --- /dev/null +++ b/doc/test/rtos_drivers/usb.rst @@ -0,0 +1 @@ +.. include:: ../../../test/rtos_drivers/usb/README.rst diff --git a/doc/test/rtos_drivers/wifi.rst b/doc/test/rtos_drivers/wifi.rst new file mode 100644 index 000000000..6827ccabd --- /dev/null +++ b/doc/test/rtos_drivers/wifi.rst @@ -0,0 +1 @@ +.. include:: ../../../test/rtos_drivers/wifi/README.rst diff --git a/documents/reference/cmd_line_tools/convert_tflite_to_c_source.rst b/doc/tools/cmd_line_tools/convert_tflite_to_c_source.rst similarity index 89% rename from documents/reference/cmd_line_tools/convert_tflite_to_c_source.rst rename to doc/tools/cmd_line_tools/convert_tflite_to_c_source.rst index 08d8dcaa8..0517917d4 100644 --- a/documents/reference/cmd_line_tools/convert_tflite_to_c_source.rst +++ b/doc/tools/cmd_line_tools/convert_tflite_to_c_source.rst @@ -1,4 +1,4 @@ - .. _convert_tflite_to_c_source-manpage: +.. _convert_tflite_to_c_source-manpage: .. program:: convert_tflite_to_c_source.py @@ -27,16 +27,14 @@ The ``convert_tflite_to_c_source.py`` script is used to generate source and head Usage ===== - .. code-block:: console - $ convert_tflite_to_c_source.py --input --source --header + convert_tflite_to_c_source.py --input --source --header ******* Options ******* - Overall Options =============== diff --git a/doc/tools/cmd_line_tools/index.rst b/doc/tools/cmd_line_tools/index.rst new file mode 100644 index 000000000..c4f9eabfa --- /dev/null +++ b/doc/tools/cmd_line_tools/index.rst @@ -0,0 +1,10 @@ +################## +Command line tools +################## + +This section describes the individual command line tools in a "man page" style. + +.. toctree:: + :maxdepth: 2 + + convert_tflite_to_c_source \ No newline at end of file diff --git a/doc/tools/index.rst b/doc/tools/index.rst new file mode 100644 index 000000000..07398cba4 --- /dev/null +++ b/doc/tools/index.rst @@ -0,0 +1,9 @@ +##################### +XCore SDK Tools Guide +##################### + +.. toctree:: + :maxdepth: 2 + + installing_ai_tools + cmd_line_tools/index \ No newline at end of file diff --git a/doc/tools/installing_ai_tools.rst b/doc/tools/installing_ai_tools.rst new file mode 100644 index 000000000..ac3c97749 --- /dev/null +++ b/doc/tools/installing_ai_tools.rst @@ -0,0 +1,50 @@ + +############################ +Installing the XMOS AI Tools +############################ + +******** +Overview +******** + +The AI Tools are a collection of Python scripts, tools and libraries to convert TensorFlow Lite for Microcontroller models to a format targeting accelerated operations on the xcore.ai platform. + +************ +Installation +************ + +System Requirements +=================== + +Make sure your system meets the minumum :ref:`system requirements ` and that you have installed all necessary :ref:`prerequisites `. + +In addition, `Python 3.8 `_ + is required. + + +Set up Virtual Environment +========================== + +While not required, we recommend you setup an `Anaconda `_ or other Python virtual environment before installing the AI Tools. + +If necessary, download and follow Anaconda's installation instructions. + +Run the following command to create a Conda environment: + +.. code-block:: console + + conda create --prefix xcore_sdk_venv python=3.8 + +Run the following command to activate the Conda environment: + +.. code-block:: console + + conda activate xcore_sdk_venv + +Install AI Tools +================ + +The following commands will install all required libraries. + +.. code-block:: console + + pip install xmos-ai-tools diff --git a/doc/tutorials/bare-metal/examples/explorer_board.rst b/doc/tutorials/bare-metal/examples/explorer_board.rst new file mode 100644 index 000000000..61c03288e --- /dev/null +++ b/doc/tutorials/bare-metal/examples/explorer_board.rst @@ -0,0 +1 @@ +.. include:: ../../../../examples/bare-metal/explorer_board/README.rst diff --git a/documents/tutorials/bare-metal/images/leds.gif b/doc/tutorials/bare-metal/examples/images/leds.gif similarity index 100% rename from documents/tutorials/bare-metal/images/leds.gif rename to doc/tutorials/bare-metal/examples/images/leds.gif diff --git a/doc/tutorials/bare-metal/examples/index.rst b/doc/tutorials/bare-metal/examples/index.rst new file mode 100644 index 000000000..6b016b545 --- /dev/null +++ b/doc/tutorials/bare-metal/examples/index.rst @@ -0,0 +1,12 @@ +######################## +Bare-metal Code Examples +######################## + +Several example bare-metal applications are included to illustrate the fundamental tool flow and provide a starting point for basic evaluation. The examples do not seek to exhibit the full potential of the platform, and are purposely basic to provide instruction. Select an example below for more information on what the example demonstrates, how to build the example, and how to run it. + +.. toctree:: + :maxdepth: 1 + :includehidden: + + explorer_board.rst + visual_wake_words.rst diff --git a/doc/tutorials/bare-metal/examples/visual_wake_words.rst b/doc/tutorials/bare-metal/examples/visual_wake_words.rst new file mode 100644 index 000000000..978393bfd --- /dev/null +++ b/doc/tutorials/bare-metal/examples/visual_wake_words.rst @@ -0,0 +1 @@ +.. include:: ../../../../examples/bare-metal/visual_wake_words/README.rst diff --git a/doc/tutorials/bare-metal/getting_started.rst b/doc/tutorials/bare-metal/getting_started.rst new file mode 100644 index 000000000..b46165722 --- /dev/null +++ b/doc/tutorials/bare-metal/getting_started.rst @@ -0,0 +1,11 @@ +.. include:: ../../substitutions.rst + +.. _sdk-bare-metal-getting-started: + +################################ +Bare-Metal Getting Started Guide +################################ + +.. note:: + + Stay tuned for a bare-metal application development Getting Started Guide. \ No newline at end of file diff --git a/doc/tutorials/bare-metal/index.rst b/doc/tutorials/bare-metal/index.rst new file mode 100644 index 000000000..536c3b76a --- /dev/null +++ b/doc/tutorials/bare-metal/index.rst @@ -0,0 +1,12 @@ +########## +Bare-Metal +########## + +.. note:: + + Stay tuned for a bare-metal application development Getting Started Guide. + +.. toctree:: + :maxdepth: 2 + + examples/index \ No newline at end of file diff --git a/doc/tutorials/build_system/cmakelists.rst b/doc/tutorials/build_system/cmakelists.rst new file mode 100644 index 000000000..8dab7016c --- /dev/null +++ b/doc/tutorials/build_system/cmakelists.rst @@ -0,0 +1,136 @@ +###################### +Example CMakeLists.txt +###################### + +.. note:: + + CMake is powerful tool that provides the developer a great deal of flexibility in how their projects are built. As a result, CMakeLists.txt files in the example applications may vary from the examples below. This example can be used as a starting point for your bare-metal application. Or, you may choose to copy a ``CMakeLists.txt`` from one of the applications in the SDK that closely resembles your application. + +********** +Bare-Metal +********** + +Below is an example ``CMakeLists.txt`` that shows both required and conventional commands for a basic bare-metal project. + +.. code-block:: cmake + + ## Specify your application sources and includes + file(GLOB_RECURSE APP_SOURCES src/*.c ) + set(APP_INCLUDES + src + src/audio_pipeline + src/platform + src/misc + src/demos + ) + + ## Specify your compiler flags + set(APP_COMPILER_FLAGS + -Os + -g + -report + -fxscope + -mcmodel=large + -Wno-xcore-fptrgroup + ${CMAKE_CURRENT_SOURCE_DIR}/src/config.xscope + ${CMAKE_CURRENT_SOURCE_DIR}/XCORE-AI-EXPLORER.xn + ) + + ## Specify any compile definitions + set(APP_COMPILE_DEFINITIONS + DEBUG_PRINT_ENABLE=1 + PLATFORM_SUPPORTS_TILE_0=1 + PLATFORM_SUPPORTS_TILE_1=1 + PLATFORM_SUPPORTS_TILE_2=0 + PLATFORM_SUPPORTS_TILE_3=0 + PLATFORM_USES_TILE_0=1 + PLATFORM_USES_TILE_1=1 + ) + + ## Set your link options + set(APP_LINK_OPTIONS + -report + ${CMAKE_CURRENT_SOURCE_DIR}/XCORE-AI-EXPLORER.xn + ${CMAKE_CURRENT_SOURCE_DIR}/src/config.xscope + ) + + ## Create your targets + add_executable(my_app EXCLUDE_FROM_ALL) + target_sources(my_app PUBLIC ${APP_SOURCES}) + target_include_directories(my_app PUBLIC ${APP_INCLUDES}) + target_compile_definitions(my_app PRIVATE ${APP_COMPILE_DEFINITIONS}) + target_compile_options(my_app PRIVATE ${APP_COMPILER_FLAGS}) + target_link_libraries(my_app PUBLIC core:general io:i2c io::uart) + target_link_options(my_app PRIVATE ${APP_LINK_OPTIONS}) + + ## Optionally create run and debug targets + create_run_target(my_app) + create_debug_target(my_app) + +******** +FreeRTOS +******** + +Below is an example ``CMakeLists.txt`` that shows both required and conventional commands for a basic FreeRTOS project. This example can be used as a starting point for your FreeRTOS application. Or, you may choose to copy a ``CMakeLists.txt`` from one of the applications in the SDK that closely resembles your application. + +.. code-block:: cmake + + ## Specify your application sources and includes + file(GLOB_RECURSE APP_SOURCES src/*.c ) + set(APP_INCLUDES src src/platform) + + ## Specify your compiler flags + set(APP_COMPILER_FLAGS + -Os + -report + -fxscope + -mcmodel=large + ${CMAKE_CURRENT_SOURCE_DIR}/src/config.xscope + ${CMAKE_CURRENT_SOURCE_DIR}/XCORE-AI-EXPLORER.xn + ) + + ## Specify any compile definitions + set(APP_COMPILE_DEFINITIONS + DEBUG_PRINT_ENABLE=1 + PLATFORM_SUPPORTS_TILE_0=1 + PLATFORM_SUPPORTS_TILE_1=1 + PLATFORM_SUPPORTS_TILE_2=0 + PLATFORM_SUPPORTS_TILE_3=0 + PLATFORM_USES_TILE_0=1 + PLATFORM_USES_TILE_1=1 + ) + + ## Set your link options + set(APP_LINK_OPTIONS + -report + ${CMAKE_CURRENT_SOURCE_DIR}/XCORE-AI-EXPLORER.xn + ${CMAKE_CURRENT_SOURCE_DIR}/src/config.xscope + ) + + ## Create your targets + set(TARGET_NAME tile0_my_app) + add_executable(${TARGET_NAME} EXCLUDE_FROM_ALL) + target_sources(${TARGET_NAME} PUBLIC ${APP_SOURCES}) + target_include_directories(${TARGET_NAME} PUBLIC ${APP_INCLUDES}) + target_compile_definitions(${TARGET_NAME} PUBLIC ${APP_COMPILE_DEFINITIONS} THIS_XCORE_TILE=0) + target_compile_options(${TARGET_NAME} PRIVATE ${APP_COMPILER_FLAGS}) + target_link_libraries(${TARGET_NAME} PUBLIC core::general rtos::freertos) + target_link_options(${TARGET_NAME} PRIVATE ${APP_LINK_OPTIONS}) + unset(TARGET_NAME) + + set(TARGET_NAME tile1_my_app) + add_executable(${TARGET_NAME} EXCLUDE_FROM_ALL) + target_sources(${TARGET_NAME} PUBLIC ${APP_SOURCES}) + target_include_directories(${TARGET_NAME} PUBLIC ${APP_INCLUDES}) + target_compile_definitions(${TARGET_NAME} PUBLIC ${APP_COMPILE_DEFINITIONS} THIS_XCORE_TILE=1) + target_compile_options(${TARGET_NAME} PRIVATE ${APP_COMPILER_FLAGS}) + target_link_libraries(${TARGET_NAME} PUBLIC core::general rtos::freertos) + target_link_options(${TARGET_NAME} PRIVATE ${APP_LINK_OPTIONS} ) + unset(TARGET_NAME) + + ## Merge tile0 and tile1 binaries + merge_binaries(my_app tile0_my_app tile1_my_app 1) + + ## Optionally create run and debug targets + create_run_target(my_app) + create_debug_target(my_app) \ No newline at end of file diff --git a/doc/tutorials/build_system/index.rst b/doc/tutorials/build_system/index.rst new file mode 100644 index 000000000..38ef3de73 --- /dev/null +++ b/doc/tutorials/build_system/index.rst @@ -0,0 +1,36 @@ +.. _sdk-build_system-label: + +.. include:: ../../substitutions.rst + +############ +Build System +############ + +This document describes the `CMake `_-based build system used by the example applications in the XCore SDK. The build system is designed so a user does not have to be an expert using CMake. However, some familiarity with CMake is helpful. You can familiarize yourself by reading the `Cmake Tutorial `_ or `CMake documentation `_. + +******** +Overview +******** + +An XCore SDK project can be seen as an integration of several modules. For example, for a FreeRTOS application that captures audio from PDM microphones and outputs it to a DAC, there could be the following modules: + +- The SDK core modules (for debug prints, etc...) +- The FreeRTOS kernel +- Microphone array driver for audio samples +- |I2C| driver for configuring the DAC +- |I2S| driver for output to the DAC +- Application code tying it all together + +When a project is compiled, the build system will build all libraries and source files specified by the application. + +********************** +Using the Build System +********************** + +Below are some examples ``CMakeLists.txt`` files that should get you started when using the SDK's build system in your own application. We encourage you to use the SDK's build system as it provides many libraries that can be built and linked with your application. + +.. toctree:: + :maxdepth: 2 + + cmakelists + target_aliases diff --git a/doc/tutorials/build_system/target_aliases.rst b/doc/tutorials/build_system/target_aliases.rst new file mode 100644 index 000000000..8a90057e8 --- /dev/null +++ b/doc/tutorials/build_system/target_aliases.rst @@ -0,0 +1,208 @@ +.. _sdk-cmake-target-aliases: + +############## +Target Aliases +############## + +The following library target aliases can be used in your application `CMakeLists.txt`. An example of how to add aliases to your target link libraries is shown below: + +.. code-block:: cmake + + target_link_libraries(my_app PUBLIC core::general rtos::freertos sdk::rtos_bsp::xcore_ai_explorer) + +******* +General +******* + +Several aliases are provided that specify a collection of libraries with similar functions. These composite target libraries provide a concise alternative to specifying all the individual targets that are commonly required. + +.. list-table:: Composite Target Libraries + :widths: 50 50 + :header-rows: 1 + :align: left + + * - Target + - Description + * - core::all + - All core libraries + * - io::all + - All peripheral libraries + * - rtos::freertos + - All RTOS libraries + + +**** +Core +**** + +If you prefer, you can specify individual core libraries. + +.. list-table:: Core Libraries + :widths: 50 50 + :header-rows: 1 + :align: left + + * - Target + - Description + * - core::clock_control + - Clock control API + * - core::utils + - General utilities used by most applications + * - core::xs3_math + - Optimize math and DSP API + * - core::general + - All core libraries except for inferencing + * - core::inferencing + - Neural networking inferencing API + +*********** +Peripherals +*********** + +If you prefer, you can specify individual peripheral libraries. + +.. list-table:: Peripheral Libraries + :widths: 50 50 + :header-rows: 1 + :align: left + + * - Target + - Description + * - io::i2c + - I2C library + * - io::spi + - SPI library + * - io::uart + - UART library + * - io::qspi_io + - QSPI library + * - io::xud + - XUD USB library + * - io::i2s + - I2S library + * - io::mic_array + - Microphone Array library + +**** +RTOS +**** + +Several aliases are provided that specify a collection of RTOS libraries with similar functions. These composite target libraries provide a concise alternative to specifying all the individual targets that are commonly required. + +.. list-table:: Composite RTOS Libraries + :widths: 50 50 + :header-rows: 1 + :align: left + + * - Target + - Description + * - rtos::freertos + - All libraries used my most XCore FreeRTOS applications + * - rtos::drivers:all + - All RTOS Driver libraries + * - rtos::freertos_usb + - All libraries to support development with TinyUSB + * - rtos::sw_services::general + - Most commonly used RTOS software service libraries + * - rtos::iot + - All IoT libraries + * - rtos::wifi + - All WiFi libraries + +These board support libraries simplify development with a specific board. + +.. list-table:: Board Support Libraries + :widths: 50 50 + :header-rows: 1 + :align: left + + * - Target + - Description + * - rtos::bsp_config::xcore_ai_explorer + - xcore.ai Explorer RTOS board support library + +If you prefer, you can specify individual RTOS driver libraries. + +.. list-table:: Individual RTOS Driver Libraries + :widths: 50 50 + :header-rows: 1 + :align: left + + * - Target + - Description + * - rtos::drivers::uart + - UART RTOS driver library + * - rtos::drivers::i2c + - I2C RTOS driver library + * - rtos::drivers::i2s + - I2S RTOS driver library + * - rtos::drivers::spi + - SPI RTOS driver library + * - rtos::drivers::qspi_io + - QSPI RTOS driver library + * - rtos::drivers::mic_array + - Microphone Array RTOS driver library + * - rtos::drivers::usb + - USB RTOS driver library + * - rtos::drivers::gpio + - GPIO RTOS driver library + * - rtos::drivers::l2_cache + - L2 Cache RTOS driver library + * - rtos::drivers::clock_control + - Clock control RTOS driver library + * - rtos::drivers::trace + - Trace RTOS driver library + * - rtos::drivers::swmem + - SwMem RTOS driver library + * - rtos::drivers::wifi + - WiFi RTOS driver library + * - rtos::drivers::intertile + - Intertile RTOS driver library + * - rtos::drivers::rpc + - Remote procedure call RTOS driver library + +If you prefer, you can specify individual software service libraries. + +.. list-table:: Individual Software Service Libraries + :widths: 50 50 + :header-rows: 1 + :align: left + + * - Target + - Description + * - rtos::sw_services::fatfs + - FatFS library + * - rtos::sw_services::usb + - USB library + * - rtos::sw_services::device_control + - Device control library + * - rtos::sw_services::usb_device_control + - USB device control library + * - rtos::sw_services::dispatcher + - Dispatcher thread pool library + * - rtos::sw_services::wifi_manager + - WiFi manager library + * - rtos::sw_services::tls_support + - TLS library + * - rtos::sw_services::dhcp + - DHCP library + * - rtos::sw_services::json + - JSON library + * - rtos::sw_services::http + - HTTP library + * - rtos::sw_services::sntpd + - SNTP daemon library + * - rtos::sw_services::mqtt + - MQTT library + +The following libraries for building host applications are also provided by the SDK. + +.. list-table:: Host (x86) Libraries + :widths: 50 50 + :header-rows: 1 + :align: left + + * - Target + - Description + * - rtos::sw_services::device_control_host_usb + - Host USB device control library diff --git a/doc/tutorials/freertos/application_design.rst b/doc/tutorials/freertos/application_design.rst new file mode 100644 index 000000000..9462d8842 --- /dev/null +++ b/doc/tutorials/freertos/application_design.rst @@ -0,0 +1,159 @@ +.. include:: ../../substitutions.rst + +####################### +RTOS Application Design +####################### + +This document is intended to help you start your first FreeRTOS application on XCore. We assume you have read :doc:`FreeRTOS Application Programming ` and that you are familiar with FreeRTOS. + +************************ +RTOS Application Example +************************ + +A fully functional example application that can be found in the SDK under the path `examples/freertos/explorer_board `_. This application is a reference for how to use an RTOS drivers or software service, and serves as an example for how to structure an SMP RTOS application for XCore. Additional code to initialize the SoC platform for this example is provided by a board support configuration library `modules/rtos/modules/board_support/XCORE-AI-EXPLORER_2V0/platform `_ + +This example application runs two instances of SMP FreeRTOS, one on each of the processor's two tiles. Because each tile has its own memory which is not shared between them, this can be viewed as a single asymmetric multiprocessing (AMP) system that comprises two SMP systems. A FreeRTOS thread that is created on one tile will never be scheduled to run on the other tile. Similarly, an RTOS object that is created on a tile, such as a queue, can only be accessed by threads and ISRs that run on that tile and never by code running on the other tile. + +That said, the example application is programmed and built as a single coherent application, which will be familiar to programmers who have previously programmed for the XCore in the XC programming language. Data that must be shared between threads running on different tiles is sent via a channel using the RTOS intertile driver, which under the hood uses a streaming channel between the tiles. + +Most of the I/O interface drivers in fact provide a mechanism to share driver instances between tiles that utilizes this intertile driver. For those familiar with XC programming, this can be viewed as a C alternative to XC interfaces. + +For example, a SPI interface might be available on tile 0. Normally, initialization code that runs on tile 0 sets this interface up and then starts the driver. Without any further initialization, code that runs on tile 1 will be unable to access this interface directly, due both to not having direct access to tile 0's memory, as well as not having direct access to tile 0's ports. The drivers, however, provide some additional initialization functions that can be used by the application to share the instance on tile 0 with tile 1. After this initialization is done, code running on tile 1 may use the instance with the same driver API as tile 0, almost as if it was actually running on tile 0. + +The example application referenced above, as well as the RTOS driver documentation, should be consulted to see exactly how to initialize and share driver instances. Additionally, not all IO is capable of being shared between tiles directly through the driver API due to timing constraints. + +The SDK provides the ON_TILE(t) preprocessor macro. This macro may be used by applications to ensure certain code is included only on a specific tile at compile time. In the example application, there is a single task that is created on both tiles that starts the drivers and creates the remaining application tasks. While this function is written as a single function, various parts are inside #if ON_TILE() blocks. For example, consider the following code snippet found inside the i2c_init() `function `_: + +.. code-block:: C + + #if ON_TILE(I2C_TILE_NO) + rtos_intertile_t *client_intertile_ctx[1] = {intertile_ctx}; + rtos_i2c_master_init( + i2c_master_ctx, + PORT_I2C_SCL, 0, 0, + PORT_I2C_SDA, 0, 0, + 0, + 100); + + rtos_i2c_master_rpc_host_init( + i2c_master_ctx, + &i2c_rpc_config, + client_intertile_ctx, + 1); + #else + rtos_i2c_master_rpc_client_init( + i2c_master_ctx, + &i2c_rpc_config, + intertile_ctx); + #endif + +When this function is compiled for tile I2C_TILE_NO, only the first block is included. When it is compiled for the other tile, only the second block is included. When the application is run, tile I2C_TILE_NO performs the initialization of the the |I2C| master driver host, while the other tile initializes the |I2C| master driver client. Because the |I2C| driver instance is shared between the two tiles, it may in fact be set to either zero or one, providing a demonstration of the way that drivers instances may be shared between tiles. + +The SDK provides a single XC file that provides the `main()` function. This provided `main()` function calls `main_tile0()` through `main_tile3()`, depending on the number of tiles that the application requires and the number of tiles provided by the target XCore processor. The application must provide each of these tile entry point functions. Each one is provided with up to three channel ends that are connected to each of the other tiles. + +The example application provides both `main_tile0()` and `main_tile1()`. Each one calls a common initialization function that initializes all the drivers for the interfaces specific to its tile. These functions also call the initialization functions to share these driver instances between the tiles. These initialization functions are found in the `platform/platform_init.c` source file. + +Each tile then creates the `startup_task()` task and starts the FreeRTOS scheduler. The `startup_task()` completes the driver instance sharing and then starts all of the driver instances. The driver startup functions are found in the `platform/platform_start.c` source file. + +Consult the RTOS driver documentation for the details on what exactly each of the RTOS API functions called by this application does. + +**************************** +Board Support Configurations +**************************** + +XCore leverages its architecture to provide a flexible chip where many typically silicon based peripherals are found in software. This allows a chip to be reconfigured in a way that provides the specific IO required for a given application, thus resulting in a low cost yet incredibly silicon efficient solution. Board support configurations (bsp_configs) are the description for the hardware IO that exists in a given board. The bsp_configs provide the application programmer with an API to initialize and start the hardware configuration, as well as the supported RTOS driver contexts. The programming model in this FreeRTOS architecture is: + * `.xn files `__ provide the mapping of ports, pins, and links + * bsp_configs setup and start hardware IO and provide the application with RTOS driver contexts + * applications use the bsp_config init/start code as well as RTOS driver contexts, similar to conventional microcontroller programming models. + + +To support any generic bsp_config, applications should call `platform_init()` before starting the scheduler, and then `platform_start()` after the scheduler is running and before any RTOS drivers are used. + +The bsp_configs provided with the XCore SDK in `modules/rtos/modules/bsp_config `_ are an excellent starting point. They provide the most common peripheral drivers that are supported by the boards that support the XCore SDK. For advanced users, it is recommended that you copy one of these bsp_config into your application project and customize as needed. + +******************************* +Developing and Debugging Memory +******************************* + +The XTC Tools provide compile time information to aid developers in creating and testing of their application. + +============== +Resource Usage +============== + +One of these features if the `-report` option, which will `Display a summary of resource usage`. One of the outputs of this report is memory usage, split into the stack, code, and data requirements of the program. Unlike most XC applications, FreeRTOS makes heavy use of dynamic memory allocation. The FreeRTOS heap will appear as `Data` in the XTC Tools report. The heap size is determined by the compile time definition `configTOTAL_HEAP_SIZE`, which can be found in an application's FreeRTOSConfig.h. + +For AMP SMP FreeRTOS builds, which are created using the cmake macro `merge_binaries()`, there are actually multiple application builds, one per tile, which are then combined. While building a given AMP application, the console output will contain both of the individual tile build reports. + +As an example, consider building the `example_freertos_explorer_board` target. + +.. code-block:: console + + Constraint check for tile[0]: + Memory available: 524288, used: 318252 . OKAY + (Stack: 5260, Code: 42314, Data: 270678) + Constraints checks PASSED WITH CAVEATS. + Constraint check for tile[1]: + Memory available: 524288, used: 4060 . OKAY + (Stack: 356, Code: 3146, Data: 558) + Constraints checks PASSED. + + Constraint check for tile[0]: + Memory available: 524288, used: 4836 . OKAY + (Stack: 356, Code: 3802, Data: 678) + Constraints checks PASSED. + Constraint check for tile[1]: + Memory available: 524288, used: 319476 . OKAY + (Stack: 14740, Code: 30730, Data: 274006) + Constraints checks PASSED WITH CAVEATS. + + +In this example, the cmake contains the command: + +.. code-block:: cmake + + merge_binaries(example_freertos_explorer_board tile0_example_freertos_explorer_board tile1_example_freertos_explorer_board 1) + + +Which means the final application usage would be interpreted as: + +.. code-block:: console + + Constraint check for tile[0]: + Memory available: 524288, used: 318252 . OKAY + (Stack: 5260, Code: 42314, Data: 270678) + Constraints checks PASSED WITH CAVEATS. + Constraint check for tile[1]: + Memory available: 524288, used: 319476 . OKAY + (Stack: 14740, Code: 30730, Data: 274006) + Constraints checks PASSED WITH CAVEATS. + +Because the tile 1 portion of the tile1 target build replaces the tile 1 portion in the tile0 target build. + +The XTC Tools also provide a method to examine the resource usage of a binary post build. This method will only work if used on the intermediate binaries. + +.. code-block:: console + + $ xobjdump --resources tile0_example_freertos_explorer_board.xe + $ xobjdump --resources tile1_example_freertos_explorer_board.xe + + +Note: Because the resulting example_freertos_explorer_board.xe binary was created by merging into tile0_example_freertos_explorer_board.xe, the results of `xobjdump --resources example_freertos_explorer_board.xe` will be the exact same as `xobjdump --resources tile0_example_freertos_explorer_board.xe` and not account for the actual tile 1 requirements. + +************************** +Building RTOS Applications +************************** + +RTOS applications using the SDK are built using `CMake`. The SDK provides many libraries, drivers and software services, all of which can be included by the application's ``CMakeLists.txt`` file. The application's CMakeLists can specify precisely which drivers and software services within the SDK should be included through the use of various CMake target aliases. + +See :ref:`Build System ` for more information on the SDK's build system. + +See :ref:`Target Aliases ` for more information on the SDK's build system target aliases. + +All SDK example applications have a README file with additional instructions on how to setup, build and run the application. In addition, they contain ``CMakeLists.txt`` files that can be used as starting point for a new application. See the :doc:`FreeRTOS Examples ` page for a list of all example applications. + +******************* +Additional Examples +******************* + +Additional code examples are provided on the :doc:`FreeRTOS Examples ` page. diff --git a/doc/tutorials/freertos/application_programming.rst b/doc/tutorials/freertos/application_programming.rst new file mode 100644 index 000000000..927cc3c03 --- /dev/null +++ b/doc/tutorials/freertos/application_programming.rst @@ -0,0 +1,99 @@ +.. include:: ../../substitutions.rst + +################################ +FreeRTOS Application Programming +################################ + +This document is intended to help you become familiar with FreeRTOS application programming on XCore. + +********* +Rationale +********* + +Traditionally, XCore multi-core processors have been programmed using the XC language. The XC language allows the programmer to statically place tasks on the available hardware cores and wire them together with channels to provide inter-process communication. The XC language also exposes "events," which are unique to the XCore architecture and are a useful alternative to interrupts. + +Using the XC language, it is possible to write dedicated application software with deterministic timing and very low latency between I/O and tasks. + +While XC elegantly enables the intrinsic, unique capabilities of the XCore architecture, there often needs to be higher level application type software running alongside it. The programming model that makes the lower level deterministic software possible may not be best suited for many higher level parts of an application that do not require deterministic timing. Where strict real-time execution is not required, higher level abstractions can be used to manage finite hardware resources, and provide a more familiar programming environment. + +A symmetric multiprocessing (SMP) real time operating system (RTOS) can be used to simplify XCore application designs, as well as to preserve the hard real-time benefits provided by the XCore architecture for the lower level software functions that require it. + +This document assumes familiarity with real time operating systems in general. Familiarity with FreeRTOS specifically should not be required, but will be helpful. For current up to date documentation on FreeRTOS see the following links on the `FreeRTOS website `_. + +- `Overview `_ +- `Developer Documentation `_ +- `API `_ + +************ +SMP FreeRTOS +************ + +To support this new programming model for XCore, XMOS has extended the popular and free FreeRTOS kernel to support SMP (now upstreamed to Amazon Web Services). This allows for the kernel's scheduler to be started on any number of available XCore logical cores per tile, leaving the remaining free to support other program elements that combine to create complete systems. Once the scheduler is started, FreeRTOS threads are placed on cores dynamically at runtime, rather than statically at compile time. All the usual FreeRTOS rules for thread scheduling are followed, except that rather than only running the single highest priority thread that is ready at any given time, multiple threads may run simultaneously. The threads chosen to run are always the highest priority threads that are ready. When there are more threads of a single priority that are ready to run than the number of cores available, they are scheduled in a round robin fashion. Dynamic scheduling allows FreeRTOS to optimize physical core usage based on priority and availability at runtime, opening up the potential for using tile wide MIPs more efficiently than what could be manually specified in a static compile time setting. + +One of XCore’s primary strengths is its guarantee of deterministic behavior and timing. RTOS threads can also benefit from this determinism provided by the XCore architecture. An RTOS thread with interrupts disabled and a high enough priority behaves just as a bare-metal thread. An SMP RTOS kernel does not need to preempt a high priority thread because it has many other cores to utilize to schedule lower priority threads. Using an SMP RTOS allows developers to concentrate on specific requirements of their application without worrying about what affect they might have on non-preemptable thread response times. Furthermore, modification of the program in the future is much easier because the developer does not have to worry about affecting existing responsiveness with changes in unrelated areas. The non-preemptable threads will not be effected by adding lower-priority functionality. + +Another XCore strength is it's performance. xcore.ai provides lightning fast general purpose compute, AI acceleration, powerful DSP and instantaneous I/O control. RTOS threads can also benefit from the performance provided by the XCore architecture, allowing an application developer to dynamically shift performance usage from one application feature to another. If more general purpose compute is needed, simply make those tasks higher priority, if more AI acceleration suddenly is required, simply make those tasks higher priority. The same is true for DSP and I/O control. + +See `Symmetric Multiprocessing (SMP) with FreeRTOS `_ for information on SMP support in the FreeRTOS kernel and SMP specific considerations. + +**************** +AMP SMP FreeRTOS +**************** + +To further leverage the XCore hardware and the FreeRTOS programming model, XMOS provides support for asymmetric multiprocessing (AMP) per tile. Each XMOS chip contains at least two tiles, which consist of their own set of logical XCore cores, IO, memory space, and more. XMOS provides a build method and variety of software drivers to allow an application to be created that is an AMP system containing, multiple SMP FreeRTOS kernels. More information on how this programming model works can be found in :doc:`Getting Started with FreeRTOS `. + +************ +RTOS Drivers +************ + +To help ease development of XCore applications using an SMP RTOS, XMOS provides several SMP RTOS compatible drivers. These include, but are not necessarily limited to: + +- Common I/O interfaces + + - GPIO + - UART + - |I2C| + - |I2S| + - PDM microphones + - QSPI flash + - SPI + - USB + - Clock control + +- XCore features + + - Intertile channel communication + - Software defined memory (xcore.ai only) + - Software defined L2 Cache (xcore.ai only) + +- External parts + + - Silicon Labs WF200 series WiFi transceiver + +These drivers are all found in the SDK under the path `modules/rtos/modules/drivers `_. + +Documentation on each of these drivers can be found under the :ref:`fwk_rtos-rtos_drivers` section in the SDK documentation pages. + +It is worth noting that most of these drivers utilize a lightweight RTOS abstraction layer, meaning that they are not dependent on FreeRTOS. Conceivably they should work on any SMP RTOS, provided an abstraction layer for it is provided. This abstraction layer is found under the path `modules/rtos/modules/osal `_. At the moment the only available SMP RTOS for XCore is the XMOS SMP FreeRTOS, but more may become available in the future. + +***************** +Software Services +***************** + +The SDK also includes some higher level RTOS compatible software services, some of which call the aforementioned drivers. These include, but are not necessarily limited to: + +- DHCP server +- Dispatcher +- FAT filesystem +- HTTP parser +- JSON parser +- MQTT client +- SNTP client +- TLS +- USB stack +- WiFi connection manager + +Documentation on several software services can be found under the :ref:`fwk_rtos-rtos_services` section in the SDK documentation pages. + +These services are all found in the SDK under the path `modules/rtos/modules/sw_services `_. + diff --git a/doc/tutorials/freertos/common_issues.rst b/doc/tutorials/freertos/common_issues.rst new file mode 100644 index 000000000..ea28da275 --- /dev/null +++ b/doc/tutorials/freertos/common_issues.rst @@ -0,0 +1,22 @@ +.. _freertos-common_issues: + +.. include:: ../../substitutions.rst + +###################### +FreeRTOS Common Issues +###################### + +**************** +Task Stack Space +**************** + +One easy to make mistake in FreeRTOS, is not providing enough stack space for a created task. A vast amount of questions exist online around how to select the FreeRTOS stack size, which the most common answer being to create the task with more than enough stack, force the worst case stack condition (not always trivial), and then use the FreeRTOS debug function `uxTaskGetStackHighWaterMark()` to determine how much you can decrease the stack. This method leaves plenty of room for error and must be done during runtime, and therefore on a build by build basis. The static analysis tools provided by The XTC Tools greatly simplify this process since they calculate the exact stack required for a given function call. The macro `RTOS_THREAD_STACK_SIZE` will return the `nstackwords` symbol for a given thread plus the additional space required for the kernel ISRs. Using this macro for every task create will ensure that there is appropriate stack space for each thread, and thus no stack overflow. + +.. code-block:: C + + xTaskCreate((TaskFunction_t) task_foo, + "foo", + RTOS_THREAD_STACK_SIZE(task_foo), + NULL, + configMAX_PRIORITIES-1, + NULL); diff --git a/doc/tutorials/freertos/examples/cifar10.rst b/doc/tutorials/freertos/examples/cifar10.rst new file mode 100644 index 000000000..3b33331ed --- /dev/null +++ b/doc/tutorials/freertos/examples/cifar10.rst @@ -0,0 +1 @@ +.. include:: ../../../../examples/freertos/cifar10/README.rst diff --git a/doc/tutorials/freertos/examples/device_control.rst b/doc/tutorials/freertos/examples/device_control.rst new file mode 100644 index 000000000..e128a6808 --- /dev/null +++ b/doc/tutorials/freertos/examples/device_control.rst @@ -0,0 +1 @@ +.. include:: ../../../../examples/freertos/device_control/README.rst diff --git a/doc/tutorials/freertos/examples/dispatcher.rst b/doc/tutorials/freertos/examples/dispatcher.rst new file mode 100644 index 000000000..23311c13b --- /dev/null +++ b/doc/tutorials/freertos/examples/dispatcher.rst @@ -0,0 +1 @@ +.. include:: ../../../../examples/freertos/dispatcher/README.rst diff --git a/doc/tutorials/freertos/examples/explorer_board.rst b/doc/tutorials/freertos/examples/explorer_board.rst new file mode 100644 index 000000000..0a05eb1be --- /dev/null +++ b/doc/tutorials/freertos/examples/explorer_board.rst @@ -0,0 +1 @@ +.. include:: ../../../../examples/freertos/explorer_board/README.rst diff --git a/documents/tutorials/freertos/images/not_person.png b/doc/tutorials/freertos/examples/images/not_person.png similarity index 100% rename from documents/tutorials/freertos/images/not_person.png rename to doc/tutorials/freertos/examples/images/not_person.png diff --git a/documents/tutorials/freertos/images/person.png b/doc/tutorials/freertos/examples/images/person.png similarity index 100% rename from documents/tutorials/freertos/images/person.png rename to doc/tutorials/freertos/examples/images/person.png diff --git a/doc/tutorials/freertos/examples/index.rst b/doc/tutorials/freertos/examples/index.rst new file mode 100644 index 000000000..24d67d2af --- /dev/null +++ b/doc/tutorials/freertos/examples/index.rst @@ -0,0 +1,18 @@ +.. _sdk-freertos-code-examples: + +###################### +FreeRTOS Code Examples +###################### + +Several FreeRTOS code examples are included to illustrate the fundamental tool flow and provide a starting point for new applications. The examples do not seek to exhibit the full potential of the platform, and are purposely basic to provide instruction. Select an example below for more information on what the example demonstrates, how to build the example, and how to run it. + +.. toctree:: + :maxdepth: 1 + :includehidden: + + explorer_board.rst + device_control.rst + dispatcher.rst + l2_cache.rst + cifar10.rst + iot.rst diff --git a/doc/tutorials/freertos/examples/iot.rst b/doc/tutorials/freertos/examples/iot.rst new file mode 100644 index 000000000..456150986 --- /dev/null +++ b/doc/tutorials/freertos/examples/iot.rst @@ -0,0 +1 @@ +.. include:: ../../../../examples/freertos/iot/README.rst diff --git a/doc/tutorials/freertos/examples/l2_cache.rst b/doc/tutorials/freertos/examples/l2_cache.rst new file mode 100644 index 000000000..bed600481 --- /dev/null +++ b/doc/tutorials/freertos/examples/l2_cache.rst @@ -0,0 +1 @@ +.. include:: ../../../../examples/freertos/l2_cache/README.rst diff --git a/doc/tutorials/freertos/faq.rst b/doc/tutorials/freertos/faq.rst new file mode 100644 index 000000000..99d4de943 --- /dev/null +++ b/doc/tutorials/freertos/faq.rst @@ -0,0 +1,33 @@ +.. _freertos-faq: + +.. include:: ../../substitutions.rst + +############# +FreeRTOS FAQs +############# + +1. What is the memory overhead of the FreeRTOS kernel? + + The FreeRTOS kernel requires approximately 9kB of RAM. + +2. How do I determine the number of words to allocate for use as a task's stack? + + Since tasks run within FreeRTOS, the RTOS stack requirement must be known at compile time. In FreeRTOS applications on most other microcontrollers, the general practice is to create a task with a large amount of stack, use the FreeRTOS stack debug functions to determine the worst case runtime usage of stack, and then adjust the stack memory value accordingly. The problem with this method is that the stack of any given thread varies greatly based on the functions that are called within, and thus a code or compiler optimization change result in the optimal task stack usage to have to be redetermined. This issue results in many FreeRTOS applications being written in such a way that wastes memory, by providing task with way more stack than they should need. Additionally, stack overflow bugs can remain hidden for a long time and even when bugs do manifest, the source can be difficult to pinpoint. + + The XTC Tools address this issue by creating a symbol that represents the maximum stack requirement of any function at compile time. By using the `RTOS_THREAD_STACK_SIZE()` macro, for the stack words argument for creating a FreeRTOS task, it is guaranteed that the optimal stack requirement is used, provided that the function does not call function pointers nor can infinitely recurse. + + .. code-block:: C + + xTaskCreate((TaskFunction_t) example_task, + "example_task", + RTOS_THREAD_STACK_SIZE(example_task), + NULL, + EXAMPLE_TASK_PRIORITY, + NULL); + + If function pointers are used within a thread, then the application programmer must annotate the code with the appropriate function pointer group attribute. For recursive functions, the only option is to specify the stack manually. See `Appendix A - Guiding Stack Size Calculation `_ in the XTC Tools documentation for more information. + +3. Can I use XCore resources like channels, timers and hw_locks? + + You are free to use channels, ports, timers, etc… in your FreeRTOS applications. However, some considerations need to be made. The RTOS kernel knows about RTOS primitives. For example, if RTOS thread A attempts to take a semaphore, the kernel is free to schedule other tasks in thread A’s place while thread A is waiting for some other task to give the semaphore. The RTOS kernel does not know anything about XCore resources. For example, if RTOS thread A attempts to `recv` on a channel, the kernel is **not** free to schedule other tasks in its place while thread A is waiting for some other task to send to the other end of the channel. A developer should be aware that blocking calls on XCore resources will block a FreeRTOS thread. This may be OK as long as it is carefully considered in the application design. There are a variety of methods to handle the decoupling of XCore and RTOS resources. These can be best seen in the various RTOS drivers, which wrap the realtime IO hardware imitation layer. + diff --git a/doc/tutorials/freertos/getting_started.rst b/doc/tutorials/freertos/getting_started.rst new file mode 100644 index 000000000..63560304d --- /dev/null +++ b/doc/tutorials/freertos/getting_started.rst @@ -0,0 +1,9 @@ +.. _sdk-freertos-getting-started: + +.. include:: ../../../examples/freertos/getting_started/README.rst + +********** +Next Steps +********** + +Explore more :ref:`FreeRTOS code examples ` or return to the :ref:`Tutorials `. diff --git a/doc/tutorials/freertos/index.rst b/doc/tutorials/freertos/index.rst new file mode 100644 index 000000000..2f8903e85 --- /dev/null +++ b/doc/tutorials/freertos/index.rst @@ -0,0 +1,12 @@ +######## +FreeRTOS +######## + +.. toctree:: + :maxdepth: 2 + + application_programming + application_design + examples/index + faq + common_issues diff --git a/doc/tutorials/index.rst b/doc/tutorials/index.rst new file mode 100644 index 000000000..96411f759 --- /dev/null +++ b/doc/tutorials/index.rst @@ -0,0 +1,30 @@ +.. _sdk-tutorials: + +###################### +Getting Started Guides +###################### + +Follow these 3 steps: + +#. :ref:`Check the system requirements and prerequisites ` +#. :ref:`Install the SDK ` +#. Select the Getting Started guide below based on your preferred development path + +- :ref:`Build and run your first FreeRTOS application on XCore ` +- :ref:`Build and run your first bare-metal application on XCore ` + +Now you are ready to dive into the advanced tutorials. + +.. _sdk-advanced-tutorials: + +################## +Advanced Tutorials +################## + +.. toctree:: + :maxdepth: 2 + + platform + build_system/index + freertos/index + bare-metal/index diff --git a/doc/tutorials/platform.rst b/doc/tutorials/platform.rst new file mode 100644 index 000000000..7905309f9 --- /dev/null +++ b/doc/tutorials/platform.rst @@ -0,0 +1,15 @@ +######## +Platform +######## + +***************************** +Architecture & Hardware Guide +***************************** + +See the `Architecture & Hardware Guide `_ in the XTC Tools documentation for an introduction to the XCore platform architecture and hardware. + +***************** +Programming Guide +***************** + +See the `Programming Guide `_ in the XTC Tools documentation for an introduction to XCore platform programming. diff --git a/doc/versions.rst b/doc/versions.rst new file mode 100644 index 000000000..85819b638 --- /dev/null +++ b/doc/versions.rst @@ -0,0 +1,59 @@ +######## +Versions +######## + +******** +Releases +******** + +The ``develop`` branch where new development takes place. For production use, there are also stable releases available. The ``main`` branch represents the most recent stable release. + +A history of all releases can be found on the `Releases `_ page. The Releases page is where +you can find release notes, links to each version of the documentation, and instructions for checking out each version. + +********** +Versioning +********** + +The XCore SDK uses `Semantic Versioning `_. + +Major Releases +============== + +Major releases, like ``v1.0``, add new functionality and may change existing functionality. If updating to a new major release (for example, from ``v1.1`` to ``v2.0``), some of your application's code may need updating and functionality may need to be re-tested. See the release notes for a list of breaking changes. + +Minor Releases +============== + +Minor releases like ``v1.1`` add new functionality and fix bugs but will not change documented functionality and will not make incompatible changes to public APIs. If updating to a new minor release (for example, from ``v1.0`` to ``v1.1``), your application's code does not require updating, but you should re-test your application. See the release notes for a list of important changes. + +Bugfix Releases +=============== + +Bugfix releases like ``v1.1.1`` only fix bugs and do not add new functionality. If updating to a new bugfix release (for example, from ``v1.1`` to ``v1.1.1``), you do not need to change any code in your application, and you only need to re-test the functionality directly related to bugs listed in the release notes. + +********************************** +Which Version Should I Start With? +********************************** + +For production purposes, use the most recent stable release. Stable releases have been verified and are updated with "bugfix releases" when necessary. Every stable release version can be found on the `Releases`_ page. + +For prototyping, experimentation or for developing new SDK features, use the ``develop`` branch. The latest version in the ``develop`` branch has all the latest features and has passed automated testing, but has not been completely verified. + +************************************** +How Do I Checking the Current Version? +************************************** + +The ``settings.json`` file in the root of the repository contains the version string for the current version. + +``git status`` can be used to report if your local repository has commits that have not been pushed to the remote repository. If you have local commits then you are not on a stable version. + +.. code-block:: console + + $ git status -sb + +************** +Support Period +************** + +Each XCore SDK release version has an associated support period. After this period, the release is ``End of Life`` and no longer supported. Given the number of releases of the XCore SDK is currently small, no official support period policy exists. Version 1.x will be support for at least two years. diff --git a/documents/Doxyfile b/documents/Doxyfile deleted file mode 100644 index 17fa85a0e..000000000 --- a/documents/Doxyfile +++ /dev/null @@ -1,2658 +0,0 @@ -# Doxyfile 1.9.1 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the configuration -# file that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# https://www.gnu.org/software/libiconv/ for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = "AIoT SDK" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = - -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. - -PROJECT_LOGO = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = doxygen - -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all generated output in the proper direction. -# Possible values are: None, LTR, RTL and Context. -# The default value is: None. - -OUTPUT_TEXT_DIRECTION = None - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = YES - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line -# such as -# /*************** -# as being the beginning of a Javadoc-style comment "banner". If set to NO, the -# Javadoc-style will behave just like regular comments and it will not be -# interpreted by doxygen. -# The default value is: NO. - -JAVADOC_BANNER = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# By default Python docstrings are displayed as preformatted text and doxygen's -# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the -# doxygen's special commands can be used and the contents of the docstring -# documentation blocks is shown as doxygen documentation. -# The default value is: YES. - -PYTHON_DOCSTRING = YES - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines (in the resulting output). You can put ^^ in the value part of an -# alias to insert a newline as if a physical newline was in the original file. -# When you need a literal { or } or , in the value part of an alias you have to -# escape them by means of a backslash (\), this can lead to conflicts with the -# commands \{ and \} for these it is advised to use the version @{ and @} or use -# a double escape (\\{ and \\}) - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = YES - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = NO - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice -# sources only. Doxygen will then generate output that is more tailored for that -# language. For instance, namespaces will be presented as modules, types will be -# separated into more groups, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_SLICE = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, -# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, -# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: -# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser -# tries to guess whether the code is fixed or free formatted code, this is the -# default for Fortran type files). For instance to make doxygen treat .inc files -# as Fortran files (default is PHP), and .f files as C (default is Fortran), -# use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. When specifying no_extension you should add -# * to the FILE_PATTERNS. -# -# Note see also the list of default file extension mappings. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See https://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up -# to that level are automatically included in the table of contents, even if -# they do not have an id attribute. -# Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 5. -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. - -TOC_INCLUDE_HEADINGS = 5 - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = YES - -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. - -GROUP_NESTED_COMPOUNDS = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = YES - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use -# during processing. When set to 0 doxygen will based this on the number of -# cores available in the system. You can set it explicitly to a value larger -# than 0 to get more control over the balance between CPU load and processing -# speed. At this moment only the input processing can be done using multiple -# threads. Since this is still an experimental feature the default is set to 1, -# which efficively disables parallel processing. Please report any issues you -# encounter. Generating dot graphs in parallel is controlled by the -# DOT_NUM_THREADS setting. -# Minimum value: 0, maximum value: 32, default value: 1. - -NUM_PROC_THREADS = 1 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = NO - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual -# methods of a class will be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIV_VIRTUAL = NO - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If this flag is set to YES, the name of an unnamed parameter in a declaration -# will be determined by the corresponding definition. By default unnamed -# parameters remain unnamed in the output. -# The default value is: YES. - -RESOLVE_UNNAMED_PARAMS = YES - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# declarations. If set to NO, these declarations will be included in the -# documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# With the correct setting of option CASE_SENSE_NAMES doxygen will better be -# able to match the capabilities of the underlying filesystem. In case the -# filesystem is case sensitive (i.e. it supports files in the same directory -# whose names only differ in casing), the option must be set to YES to properly -# deal with such files in case they appear in the input. For filesystems that -# are not case sensitive the option should be be set to NO to properly deal with -# output files written for symbols that only differ in casing, such as for two -# classes, one named CLASS and the other named Class, and to also support -# references to files without having to specify the exact matching casing. On -# Windows (including Cygwin) and MacOS, users should typically set this option -# to NO, whereas on Linux or other Unix flavors it should typically be set to -# YES. -# The default value is: system dependent. - -CASE_SENSE_NAMES = YES - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. If -# EXTRACT_ALL is set to YES then this flag will automatically be disabled. -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS -# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but -# at the end of the doxygen process doxygen will return with a non-zero status. -# Possible values are: NO, YES and FAIL_ON_WARNINGS. -# The default value is: NO. - -WARN_AS_ERROR = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING -# Note: If this tag is empty the current directory is searched. - -INPUT = ../modules/rtos/drivers - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: -# https://www.gnu.org/software/libiconv/) for the list of possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. -# -# Note the list of default checked file patterns might differ from the list of -# default file extension mappings. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), -# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, -# *.ucf, *.qsf and *.ice. - -FILE_PATTERNS = *.c \ - *.cc \ - *.cxx \ - *.cpp \ - *.c++ \ - *.java \ - *.ii \ - *.ixx \ - *.ipp \ - *.i++ \ - *.inl \ - *.idl \ - *.ddl \ - *.odl \ - *.h \ - *.hh \ - *.hxx \ - *.hpp \ - *.h++ \ - *.cs \ - *.d \ - *.php \ - *.php4 \ - *.php5 \ - *.phtml \ - *.inc \ - *.m \ - *.markdown \ - *.md \ - *.mm \ - *.dox \ - *.py \ - *.pyw \ - *.f90 \ - *.f95 \ - *.f03 \ - *.f08 \ - *.f18 \ - *.f \ - *.for \ - *.vhd \ - *.vhdl \ - *.ucf \ - *.qsf \ - *.ice - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = * - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# entity all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see https://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the -# clang parser (see: -# http://clang.llvm.org/) for more accurate parsing at the cost of reduced -# performance. This can be particularly helpful with template rich C++ code for -# which doxygen's built-in parser lacks the necessary type information. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse_libclang=ON option for CMake. -# The default value is: NO. - -CLANG_ASSISTED_PARSING = NO - -# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to -# YES then doxygen will add the directory of each input to the include path. -# The default value is: YES. - -CLANG_ADD_INC_PATHS = YES - -# If clang assisted parsing is enabled you can provide the compiler with command -# line options that you would normally use when invoking the compiler. Note that -# the include paths will already be set by doxygen for the files and directories -# specified with INPUT and INCLUDE_PATH. -# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. - -CLANG_OPTIONS = - -# If clang assisted parsing is enabled you can provide the clang parser with the -# path to the directory containing a file called compile_commands.json. This -# file is the compilation database (see: -# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the -# options used when the source files were built. This is equivalent to -# specifying the -p option to a clang tool, such as clang-check. These options -# will then be passed to the parser. Any options specified with CLANG_OPTIONS -# will be added as well. -# Note: The availability of this option depends on whether or not doxygen was -# generated with the -Duse_libclang=ON option for CMake. - -CLANG_DATABASE_PATH = - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# https://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = NO - -# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML -# documentation will contain a main index with vertical navigation menus that -# are dynamically created via JavaScript. If disabled, the navigation index will -# consists of multiple levels of tabs that are statically embedded in every HTML -# page. Disable this option to support browsers that do not have JavaScript, -# like the Qt help browser. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_MENUS = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: -# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To -# create a documentation set, doxygen will generate a Makefile in the HTML -# output directory. Running make will produce the docset in that directory and -# running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy -# genXcode/_index.html for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: -# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the main .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location (absolute path -# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to -# run qhelpgenerator on the generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = NO - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg -# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see -# https://inkscape.org) to generate formulas as SVG images instead of PNGs for -# the HTML output. These images will generally look nicer at scaled resolutions. -# Possible values are: png (the default) and svg (looks nicer but requires the -# pdf2svg or inkscape tool). -# The default value is: png. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FORMULA_FORMAT = png - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANSPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands -# to create new LaTeX commands to be used in formulas as building blocks. See -# the section "Including formulas" for details. - -FORMULA_MACROFILE = - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# https://www.mathjax.org) which uses client side JavaScript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from https://www.mathjax.org before deployment. -# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: -# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /