Skip to content

Commit

Permalink
Remove double underscores
Browse files Browse the repository at this point in the history
  • Loading branch information
xluciano committed Nov 3, 2023
1 parent 4e07363 commit 093fa23
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 23 deletions.
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
35 changes: 17 additions & 18 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 @@ -32,19 +32,18 @@ Additional third party code is included under the following copyrights and licen

* - Module
- Copyright & License
* - `Argtable3 <https://github.com/xmos/fwk_rtos/tree/develop/tools/fatfs_mkimage/argtable>`__
- Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann, licensed under `LICENSE <https://github.com/xmos/fwk_rtos/blob/cbb80e17373ea76ca474921012ca684d092d1059/modules/sw_services/fatfs/host/argtable/LICENSE>`__
* - `FatFS <http://elm-chan.org/fsw/ff/00index_e.html>`__
- Copyright (C) 2017 ChaN, licensed under a `BSD-style license <https://github.com/xmos/fwk_rtos/blob/develop/modules/sw_services/fatfs/thirdparty/LICENSE.txt>`__
* - `FreeRTOS <https://freertos.org/>`__
- Copyright (c) 2017 Amazon.com, Inc., licensed under the `MIT License <https://github.com/xmos/FreeRTOS/blob/release/xcore-smp/LICENSE.md>`__
* - `Argtable3 <https://github.com/xmos/fwk_rtos/tree/develop/tools/fatfs_mkimage/argtable>`_
- Copyright (C) 1998-2001,2003-2011,2013 Stewart Heitmann, licensed under `LICENSE <https://github.com/xmos/fwk_rtos/blob/cbb80e17373ea76ca474921012ca684d092d1059/modules/sw_services/fatfs/host/argtable/LICENSE>`_
- Copyright (C) 2017 ChaN, licensed under a `BSD-style license <https://github.com/xmos/fwk_rtos/blob/develop/modules/sw_services/fatfs/thirdparty/LICENSE.txt>`_
* - `FreeRTOS <https://freertos.org/>`_
- Copyright (c) 2017 Amazon.com, Inc., licensed under the `MIT License <https://github.com/xmos/FreeRTOS/blob/release/xcore-smp/LICENSE.md>`_
* - HTTP Parser
- Copyright (c) Joyent, Inc. and other Node contributors, licensed under the `MIT license <https://github.com/nodejs/http-parser/blob/d9275da4650fd1133ddc96480df32a9efe4b059b/LICENSE-MIT>`__
* - `JSMN JSON Parser <https://github.com/zserge/jsmn>`__
- Copyright (c) 2010 Serge A. Zaitsev, licensed under the `MIT license <https://github.com/zserge/jsmn/blob/master/LICENSE>`__
* - `Mbed TLS library <https://www.trustedfirmware.org/projects/mbed-tls/>`__
- Copyright (c) 2006-2018 ARM Limited, licensed under the `Apache License 2.0 <https://github.com/ARMmbed/mbedtls/blob/2a1d9332d55d1270084232e42df08fdb08129f1b/LICENSE>`__
* - `Paho MQTT C/C++ client for Embedded platforms <https://github.com/eclipse/paho.mqtt.embedded-c>`__
- Copyright (c) 2020 The TensorFlow Authors, licensed under the `Apache License <http://www.apache.org/licenses/LICENSE-2.0>`__
* - `TinyUSB <https://docs.tinyusb.org/en/latest/index.html>`__
- Copyright (c) 2018 hathach (tinyusb.org), licensed under the `MIT license <https://github.com/hathach/tinyusb/blob/1bba2c0fc3bce05e9fbe4ff23dda30283d08574d/LICENSE>`__
- Copyright (c) Joyent, Inc. and other Node contributors, licensed under the `MIT license <https://github.com/nodejs/http-parser/blob/d9275da4650fd1133ddc96480df32a9efe4b059b/LICENSE-MIT>`_
* - `JSMN JSON Parser <https://github.com/zserge/jsmn>`_
- Copyright (c) 2010 Serge A. Zaitsev, licensed under the `MIT license <https://github.com/zserge/jsmn/blob/master/LICENSE>`_
* - `Mbed TLS library <https://www.trustedfirmware.org/projects/mbed-tls/>`_
- Copyright (c) 2006-2018 ARM Limited, licensed under the `Apache License 2.0 <https://github.com/ARMmbed/mbedtls/blob/2a1d9332d55d1270084232e42df08fdb08129f1b/LICENSE>`_
* - `Paho MQTT C/C++ client for Embedded platforms <https://github.com/eclipse/paho.mqtt.embedded-c>`_
- Copyright (c) 2020 The TensorFlow Authors, licensed under the `Apache License <http://www.apache.org/licenses/LICENSE-2.0>`_
* - `TinyUSB <https://docs.tinyusb.org/en/latest/index.html>`_
- Copyright (c) 2018 hathach (tinyusb.org), licensed under the `MIT license <https://github.com/hathach/tinyusb/blob/1bba2c0fc3bce05e9fbe4ff23dda30283d08574d/LICENSE>`_
2 changes: 1 addition & 1 deletion test/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Requirements
The following software is required for running tests.

* Linux, MacOS, or Windows Subsystem for Linux
* `Python 3.8 <https://www.python.org/>`__
* `Python 3.8 <https://www.python.org/>`_

Python Virtual Environment
==========================
Expand Down

0 comments on commit 093fa23

Please sign in to comment.