Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include xs1.h in rtos_swmem.c and update documentation #213

Merged
merged 9 commits into from
Nov 1, 2023
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions modules/drivers/swmem/src/rtos_swmem.c
Original file line number Diff line number Diff line change
@@ -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 <xs1.h>

#include <xcore/swmem_fill.h>
#include <xcore/swmem_evict.h>
#include <xcore/triggerable.h>

#include "rtos_interrupt.h"
#include "rtos_swmem.h"

static swmem_fill_t swmem_fill_res;
static swmem_evict_t swmem_evict_res;

Expand Down Expand Up @@ -179,4 +180,4 @@ void rtos_swmem_init(uint32_t init_flags)
unsigned int rtos_swmem_offset_get()
{
return __swmem_address;
}
}
2 changes: 1 addition & 1 deletion tools/ci/build_rtos_tests.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sets minimum CMake version at 3.21, is this correct?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is the default minimum version in the CMakeLists.txt file. Is there any issue with that?

(cd ${path}/build_${board}; cp ${make_target}.xe ${DIST_DIR})
done
43 changes: 27 additions & 16 deletions tools/fatfs_mkimage/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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