diff --git a/modules/drivers/swmem/src/rtos_swmem.c b/modules/drivers/swmem/src/rtos_swmem.c index 6448a83b9..959dd1c15 100644 --- a/modules/drivers/swmem/src/rtos_swmem.c +++ b/modules/drivers/swmem/src/rtos_swmem.c @@ -1,13 +1,14 @@ -// Copyright 2021 XMOS LIMITED. +// Copyright 2021-2023 XMOS LIMITED. // This Software is subject to the terms of the XMOS Public Licence: Version 1. +#include + #include #include #include #include "rtos_interrupt.h" #include "rtos_swmem.h" - static swmem_fill_t swmem_fill_res; static swmem_evict_t swmem_evict_res; @@ -179,4 +180,4 @@ void rtos_swmem_init(uint32_t init_flags) unsigned int rtos_swmem_offset_get() { return __swmem_address; -} \ No newline at end of file +} diff --git a/test/rtos_drivers/clock_control/README.rst b/test/rtos_drivers/clock_control/README.rst index 27deccf79..fe5bf77c4 100644 --- a/test/rtos_drivers/clock_control/README.rst +++ b/test/rtos_drivers/clock_control/README.rst @@ -21,13 +21,13 @@ These tests should be run whenever the code or submodules in ``modules\rtos`` or Building and Running Tests ************************** -To build the test application firmware, run the following command from the top of the repository: +To build the test application firmware, run the following command from the top of the repository: .. code-block:: console bash tools/ci/build_rtos_tests.sh -The `build_test.sh` script will copy the test applications to the `dist` folder. +The ``build_rtos_tests.sh`` script will copy the test applications to the ``dist`` folder. Run the test with the following command from the top of the repository: diff --git a/test/rtos_drivers/hil/README.rst b/test/rtos_drivers/hil/README.rst index 8feffad08..3a4feb1ea 100644 --- a/test/rtos_drivers/hil/README.rst +++ b/test/rtos_drivers/hil/README.rst @@ -57,13 +57,13 @@ Building and Running Tests The Python environment is required to run this test. See the Requirements section of test/README.rst -To build the test application firmware, run the following command from the top of the repository: +To build the test application firmware, run the following command from the top of the repository: .. code-block:: console bash tools/ci/build_rtos_tests.sh -The `build_test.sh` script will copy the test applications to the `dist` folder. +The ``build_rtos_tests.sh``` script will copy the test applications to the ``dist`` folder. Run the test with the following command from the top of the repository: diff --git a/test/rtos_drivers/hil_add/README.rst b/test/rtos_drivers/hil_add/README.rst index 34f8926ac..7b4561bf9 100644 --- a/test/rtos_drivers/hil_add/README.rst +++ b/test/rtos_drivers/hil_add/README.rst @@ -36,13 +36,13 @@ Building and Running Tests The Python environment is required to run this test. See the Requirements section of test/README.rst -To build the test application firmware, run the following command from the top of the repository: +To build the test application firmware, run the following command from the top of the repository: .. code-block:: console bash tools/ci/build_rtos_tests.sh -The `build_test.sh` script will copy the test applications to the `dist` folder. +The ``build_rtos_tests.sh`` script will copy the test applications to the ``dist`` folder. Run the test with the following command from the top of the repository: diff --git a/test/rtos_drivers/usb/README.rst b/test/rtos_drivers/usb/README.rst index 3c493807a..edf532cc3 100644 --- a/test/rtos_drivers/usb/README.rst +++ b/test/rtos_drivers/usb/README.rst @@ -50,7 +50,9 @@ run the following command from the root of this repository: .. code-block:: console - $ ./tools/ci/build_rtos_tests.sh + bash tools/ci/build_rtos_tests.sh + +The ``build_rtos_tests.sh``` script will copy the test applications to the ``dist`` folder. ************* Running Tests diff --git a/test/rtos_drivers/wifi/README.rst b/test/rtos_drivers/wifi/README.rst index 52746bc81..3354b5bcd 100644 --- a/test/rtos_drivers/wifi/README.rst +++ b/test/rtos_drivers/wifi/README.rst @@ -29,19 +29,28 @@ Building and Running Tests The Python environment is required to run this test. See the Requirements section of test/README.rst -To build the test application firmware, run the following command from the top of the repository: +To build the test host applications, run the following command from the top of the repository: + +.. code-block:: console + + bash tools/ci/build_host_apps.sh + +The ``build_host_apps.sh`` script will copy the test applications to the ``dist_host`` folder. + + +To build the test application firmware, run the following command from the top of the repository: .. code-block:: console bash tools/ci/build_rtos_tests.sh -The `build_test.sh` script will copy the test applications to the `dist` folder. +The ``build_rtos_tests.sh`` script will copy the test applications to the ``dist`` folder. Run the test with the following command from the top of the repository: .. code-block:: console - bash test/rtos_drivers/hil_add/check_wifi.sh + bash test/rtos_drivers/wifi/check_wifi.sh The output file can be verified via python: diff --git a/tools/ci/build_rtos_tests.sh b/tools/ci/build_rtos_tests.sh index 132869ac5..acafa5f49 100755 --- a/tools/ci/build_rtos_tests.sh +++ b/tools/ci/build_rtos_tests.sh @@ -41,6 +41,6 @@ for ((i = 0; i < ${#applications[@]}; i += 1)); do (cd ${path}; rm -rf build_${board}) (cd ${path}; mkdir -p build_${board}) - (cd ${path}/build_${board}; log_errors cmake ../ -G "$CI_CMAKE_GENERATOR" -DCMAKE_TOOLCHAIN_FILE=${toolchain_file} -DBOARD=${board} -DFRAMEWORK_RTOS_TESTS=ON; log_errors $CI_BUILD_TOOL ${make_target} $CI_BUILD_TOOL_ARGS) + (cd ${path}/build_${board}; log_errors cmake ../ -G "$CI_CMAKE_GENERATOR" --toolchain=${toolchain_file} -DBOARD=${board} -DFRAMEWORK_RTOS_TESTS=ON; log_errors $CI_BUILD_TOOL ${make_target} $CI_BUILD_TOOL_ARGS) (cd ${path}/build_${board}; cp ${make_target}.xe ${DIST_DIR}) done diff --git a/tools/fatfs_mkimage/README.rst b/tools/fatfs_mkimage/README.rst index 52c807e15..51dbd9b89 100644 --- a/tools/fatfs_mkimage/README.rst +++ b/tools/fatfs_mkimage/README.rst @@ -9,26 +9,37 @@ This is the FAT file system image creation tool. This tool creates a FAT filesys Building the Application ************************ -This application is typically built and installed from tools/install. +This application is typically built and installed from tools/install. -However, if you are modifying the application, it is possible to build the project using CMake. To build this application, run the following commands: +However, if you are modifying the application, it is possible to build the project using CMake. To build this application on Linux and MacOS, run the following commands: -.. tab:: Linux and MacOS - .. code-block:: console - - $ cmake -B build - $ cd build - $ make -j +.. code-block:: console -Note: You may need to run the ``make -j`` command as ``sudo``. + cmake -B build + cd build + make -j -Note: Windows users must run the x86 native tools command prompt from Visual Studio +.. note:: -.. tab:: Windows + You may need to run the ``make -j`` command as ``sudo``. - .. code-block:: doscon - - $ cmake -G "NMake Makefiles" -B build - $ cd build - $ nmake +Windows users must run the x86 native tools command prompt from Visual Studio and we recommend the use of the Ninja build system. + +To install *Ninja* follow install instructions at https://ninja-build.org/ or on Windows +install with ``winget`` by running the following commands in *PowerShell*: + +.. code-block:: PowerShell + + # Install + winget install Ninja-build.ninja + # Reload user Path + $env:Path=[System.Environment]::GetEnvironmentVariable("Path","User") + +To build this application on Windows, run the following commands: + +.. code-block:: console + + cmake -G Ninja -B build + cd build + ninja