diff --git a/doc/README.rst b/doc/README.rst index 8c9fe66a7..46b630538 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -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. ********************** diff --git a/doc/exclude_patterns.inc b/doc/exclude_patterns.inc index 27cc18955..6247fed17 100644 --- a/doc/exclude_patterns.inc +++ b/doc/exclude_patterns.inc @@ -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* \ No newline at end of file +**CHANGELOG* +**LICENSE* +**README* diff --git a/doc/programming_guide/tutorials/application_design.rst b/doc/programming_guide/tutorials/application_design.rst index d0ca87049..35b7798a8 100644 --- a/doc/programming_guide/tutorials/application_design.rst +++ b/doc/programming_guide/tutorials/application_design.rst @@ -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 `__ provide the mapping of ports, pins, and links +- `.xn files `_ 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. @@ -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 diff --git a/doc/programming_guide/tutorials/bsp_config.rst b/doc/programming_guide/tutorials/bsp_config.rst index 92467094a..ecf0bb71d 100644 --- a/doc/programming_guide/tutorials/bsp_config.rst +++ b/doc/programming_guide/tutorials/bsp_config.rst @@ -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 `__ provide the mapping of ports, pins, and links +- `.xn files `_ 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. @@ -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 diff --git a/doc/shared/legal.rst b/doc/shared/legal.rst index b0b45b002..0fc47688a 100644 --- a/doc/shared/legal.rst +++ b/doc/shared/legal.rst @@ -4,11 +4,11 @@ Copyright & Disclaimer ====================== - + |XMOS copyright| - + |XMOS disclaimer| - + |XMOS trademarks| @@ -18,7 +18,7 @@ Licenses XMOS ^^^^ -All original source code is licensed under the `XMOS License `_. +All original source code is licensed under the `XMOS License `__. Third-Party ^^^^^^^^^^^ diff --git a/index.rst b/index.rst index c192aaa5b..fd27d4a65 100644 --- a/index.rst +++ b/index.rst @@ -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 `_. Copyrights and licenses for third party components can be found in :ref:`fwk_rtos_copyright`. \ No newline at end of file +This Software is subject to the terms of the `XMOS Public Licence: Version 1 `_. Copyrights and licenses for third party components can be found at the end of each guide. diff --git a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host.c b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host.c index 5acb39802..6f4449cff 100644 --- a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host.c +++ b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host.c @@ -1,7 +1,6 @@ -// Copyright 2020 XMOS LIMITED. This Software is subject to the terms of the +// Copyright 2020-2023 XMOS LIMITED. // This Software is subject to the terms of the XMOS Public Licence: Version 1. - #include #include diff --git a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host.h b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host.h index 9e5571c8d..727556a60 100644 --- a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host.h +++ b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host.h @@ -1,4 +1,4 @@ -// Copyright 2021 XMOS LIMITED. This Software is subject to the terms of the +// Copyright 2021-2023 XMOS LIMITED. // This Software is subject to the terms of the XMOS Public Licence: Version 1. #ifndef SL_WFX_HOST_H_ diff --git a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host_spi.c b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host_spi.c index 52af81d52..e0960262a 100644 --- a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host_spi.c +++ b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host_spi.c @@ -1,4 +1,4 @@ -// Copyright 2020 XMOS LIMITED. This Software is subject to the terms of the +// Copyright 2020-2023 XMOS LIMITED. // This Software is subject to the terms of the XMOS Public Licence: Version 1. #include diff --git a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host_task.c b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host_task.c index e39f87528..ec6f76e56 100644 --- a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host_task.c +++ b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_host_task.c @@ -1,4 +1,4 @@ -// Copyright 2020 XMOS LIMITED. This Software is subject to the terms of the +// Copyright 2020-2023 XMOS LIMITED. // This Software is subject to the terms of the XMOS Public Licence: Version 1. #include diff --git a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_iot_wifi.c b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_iot_wifi.c index c055e5fe8..4194d4e92 100644 --- a/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_iot_wifi.c +++ b/modules/drivers/wifi/sl_wf200/FreeRTOS/sl_wfx_iot_wifi.c @@ -1,4 +1,4 @@ -// Copyright 2019 XMOS LIMITED. This Software is subject to the terms of the +// Copyright 2019-2023 XMOS LIMITED. // This Software is subject to the terms of the XMOS Public Licence: Version 1. #define DEBUG_UNIT IOT_WIFI diff --git a/modules/sw_services/wifi_manager/FreeRTOS/heapsort.h b/modules/sw_services/wifi_manager/FreeRTOS/heapsort.h index 6a56cfae0..fefbcfe9c 100644 --- a/modules/sw_services/wifi_manager/FreeRTOS/heapsort.h +++ b/modules/sw_services/wifi_manager/FreeRTOS/heapsort.h @@ -1,7 +1,6 @@ // Copyright 2020-2023 XMOS LIMITED. // This Software is subject to the terms of the XMOS Public Licence: Version 1. - #ifndef HEAPSORT_H_ #define HEAPSORT_H_ diff --git a/test/rtos_drivers/hil/README.rst b/test/rtos_drivers/hil/README.rst index 3a4feb1ea..bb425c662 100644 --- a/test/rtos_drivers/hil/README.rst +++ b/test/rtos_drivers/hil/README.rst @@ -63,7 +63,7 @@ To build the test application firmware, run the following command from the top o bash tools/ci/build_rtos_tests.sh -The ``build_rtos_tests.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 edf532cc3..7f4e4c5fa 100644 --- a/test/rtos_drivers/usb/README.rst +++ b/test/rtos_drivers/usb/README.rst @@ -52,7 +52,7 @@ run the following command from the root of this repository: bash tools/ci/build_rtos_tests.sh -The ``build_rtos_tests.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. ************* Running Tests diff --git a/test/rtos_drivers/usb/serial_send_receive.py b/test/rtos_drivers/usb/serial_send_receive.py index 337ce61b2..5548a76fa 100644 --- a/test/rtos_drivers/usb/serial_send_receive.py +++ b/test/rtos_drivers/usb/serial_send_receive.py @@ -6,7 +6,6 @@ import serial import serial.tools.list_ports import argparse -import time # USB VID:PID for test application vid=0x20B1 @@ -86,4 +85,4 @@ def main(if0, if1, of0, of1): if __name__ == "__main__": args = parse_arguments() - main(args.if0, args.if1, args.of0, args.of1) \ No newline at end of file + main(args.if0, args.if1, args.of0, args.of1)