Skip to content

Commit

Permalink
Merge from develop
Browse files Browse the repository at this point in the history
  • Loading branch information
xluciano committed Nov 9, 2023
2 parents e918c38 + e70fc03 commit dca1057
Show file tree
Hide file tree
Showing 265 changed files with 2,075 additions and 2,041 deletions.
5 changes: 5 additions & 0 deletions .xmos_ignore_source_check
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
modules/FreeRTOS
modules/drivers/wifi
fatfs_mkimage/argtable/
fatfs_mkimage/src/tinydir.h
thirdparty
1 change: 1 addition & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ RTOS Framework change log

* FIXED: Added dummy definitions of vTaskCoreAffinitySet() and vTaskCoreAffinitySet() functions to
avoid warnings when configNUM_CORES is set to 1.
* UPDATED: Updated xmos_cmake_toolchain to v1.0.0 from untagged commit e577fbc
* UPDATED: Tested against fwk_io v3.3.0 updated from v3.0.1
* UPDATED: Tested against fwk_core v1.0.2 updated from v1.0.0
* ADDED: Runtime check for I2S RPC functions called for I2S Slave
Expand Down
4 changes: 3 additions & 1 deletion doc/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
Documentation Source
####################

This folder contains source files for the documentation. The sources do not render well in GitHub or an RST viewer.
This folder contains source files for the documentation and is intended for XMOS users. Pre-built documentation is published on https://www.xmos.com.

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.

**********************
Expand Down
8 changes: 4 additions & 4 deletions doc/exclude_patterns.inc
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ tools
projects
test
xmos_cmake_toolchain
modules/drivers
modules/**/thirdparty
modules/FreeRTOS
modules/sw_services
build
build_*
CHANGELOG.rst
LICENSE.rst
**README*
**CHANGELOG*
**LICENSE*
**README*
4 changes: 2 additions & 2 deletions doc/programming_guide/tutorials/application_design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ 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 <https://www.xmos.ai/documentation/XM-014363-PC-LATEST/html/tools-guide/tools-ref/formats/xn-spec/xn-spec.html?highlight=xn>`__ provide the mapping of ports, pins, and links
- `.xn files <https://www.xmos.ai/documentation/XM-014363-PC-LATEST/html/tools-guide/tools-ref/formats/xn-spec/xn-spec.html?highlight=xn>`_ provide the mapping of ports, pins, and links
- bsp_configs specify, 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.

Expand All @@ -77,7 +77,7 @@ Creating Custom bsp_configs
To enable hardware portability, a minimal bsp_config should contain the following:

.. code-block:: console
custom_config/
platform/
driver_instances.c
Expand Down
4 changes: 2 additions & 2 deletions doc/programming_guide/tutorials/bsp_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ 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 <https://www.xmos.ai/documentation/XM-014363-PC-LATEST/html/tools-guide/tools-ref/formats/xn-spec/xn-spec.html?highlight=xn>`__ provide the mapping of ports, pins, and links
- `.xn files <https://www.xmos.ai/documentation/XM-014363-PC-LATEST/html/tools-guide/tools-ref/formats/xn-spec/xn-spec.html?highlight=xn>`_ provide the mapping of ports, pins, and links
- bsp_configs specify, 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.

Expand All @@ -20,7 +20,7 @@ Creating Custom bsp_configs
To enable hardware portability, a minimal ``bsp_config`` should contain the following:

.. code-block:: console
custom_config/
platform/
driver_instances.c
Expand Down
8 changes: 4 additions & 4 deletions doc/shared/legal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

Copyright & Disclaimer
======================

|XMOS copyright|

|XMOS disclaimer|

|XMOS trademarks|


Expand All @@ -18,7 +18,7 @@ Licenses
XMOS
^^^^

All original source code is licensed under the `XMOS License <https://github.com/xmos/sln_voice/blob/develop/LICENSE.rst>`_.
All original source code is licensed under the `XMOS License <https://github.com/xmos/sln_voice/blob/develop/LICENSE.rst>`__.

Third-Party
^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ Framework of FreeRTOS kernel, RTOS drivers, and software service libraries for X
Licensing
*********

This Software is subject to the terms of the `XMOS Public Licence: Version 1 <https://github.com/xmos/sln_voice/blob/develop/LICENSE.rst>`_. Copyrights and licenses for third party components can be found in :ref:`fwk_rtos_copyright`.
This Software is subject to the terms of the `XMOS Public Licence: Version 1 <https://github.com/xmos/sln_voice/blob/develop/LICENSE.rst>`_. Copyrights and licenses for third party components can be found at the end of each guide.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef AIC3204_H_
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2021 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include <platform.h>
#include <xs1.h>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2021 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef APP_PLL_CTRL_H_
#define APP_PLL_CTRL_H_
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2021-2022 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include "platform/driver_instances.h"

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2021-2022 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef DRIVER_INSTANCES_H_
#define DRIVER_INSTANCES_H_
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2022 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2022-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef PLATFORM_CONF_H_
#define PLATFORM_CONF_H_
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2021-2022 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include <platform.h>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2021 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef PLATFORM_INIT_H_
#define PLATFORM_INIT_H_
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2021-2022 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include <platform.h>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef AIC3204_H_
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2021 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include <platform.h>
#include <xs1.h>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2021 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef APP_PLL_CTRL_H_
#define APP_PLL_CTRL_H_
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2021-2022 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include "platform/driver_instances.h"

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2021-2022 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef DRIVER_INSTANCES_H_
#define DRIVER_INSTANCES_H_
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2022 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2022-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef PLATFORM_CONF_H_
#define PLATFORM_CONF_H_
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2021-2022 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include <platform.h>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2021 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef PLATFORM_INIT_H_
#define PLATFORM_INIT_H_
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Copyright (c) 2021-2022 XMOS LIMITED. This Software is subject to the terms of the
// XMOS Public License: Version 1
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include <platform.h>

Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/clock_control/api/rtos_clock_control_rpc.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2022 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef RTOS_CLOCK_CONTROL_RPC_H_
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/clock_control/src/rtos_clock_control_rpc.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2022 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include <xcore/assert.h>
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/gpio/api/rtos_gpio.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef RTOS_GPIO_H_
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/gpio/api/rtos_gpio_rpc.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef RTOS_GPIO_RPC_H_
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/gpio/src/rtos_gpio.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include <string.h>
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/gpio/src/rtos_gpio_rpc.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include <string.h>
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/i2c/api/rtos_i2c_master.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef RTOS_I2C_MASTER_H_
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/i2c/api/rtos_i2c_master_rpc.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef RTOS_I2C_MASTER_RPC_H_
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/i2c/api/rtos_i2c_slave.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2021 XMOS LIMITED.
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef RTOS_I2C_SLAVE_H_
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/i2c/src/rtos_i2c_master.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#define DEBUG_UNIT RTOS_I2C
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/i2c/src/rtos_i2c_master_rpc.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include "rtos_rpc.h"
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/i2c/src/rtos_i2c_slave.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2021 XMOS LIMITED.
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include <xcore/triggerable.h>
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/i2s/api/rtos_i2s.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef RTOS_I2S_H_
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/i2s/api/rtos_i2s_rpc.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef RTOS_I2S_RPC_H_
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/i2s/src/rtos_i2s.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#define DEBUG_UNIT RTOS_I2S
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/i2s/src/rtos_i2s_rpc.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include "rtos_rpc.h"
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/intertile/api/rtos_intertile.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

/**
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/intertile/src/rtos_intertile.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include <xcore/triggerable.h>
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/l2_cache/api/rtos_l2_cache.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2021 XMOS LIMITED.
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef RTOS_L2_CACHE_H_
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/l2_cache/src/rtos_l2_cache.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2021 XMOS LIMITED.
// Copyright 2021-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#include <xcore/channel.h>
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/mic_array/api/rtos_mic_array_rpc.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef RTOS_MIC_ARRAY_RPC_H_
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/qspi_flash/api/rtos_qspi_flash_rpc.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef RTOS_QSPI_FLASH_RPC_H_
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/rpc/api/rtos_driver_rpc.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

#ifndef RTOS_DRIVER_RPC_H_
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/rpc/api/rtos_rpc.h
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

/**
Expand Down
2 changes: 1 addition & 1 deletion modules/drivers/rpc/src/rtos_rpc.c
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2020-2021 XMOS LIMITED.
// Copyright 2020-2023 XMOS LIMITED.
// This Software is subject to the terms of the XMOS Public Licence: Version 1.

/* Standard library headers */
Expand Down
Loading

0 comments on commit dca1057

Please sign in to comment.