1# Eclipse ThreadX RTOS 2 3This advanced real-time operating system (RTOS) is designed specifically for deeply embedded applications. Among the multiple benefits it provides are advanced scheduling facilities, message passing, interrupt management, and messaging services. Eclipse ThreadX RTOS has many advanced features, including picokernel architecture, preemption threshold, event chaining, and a rich set of system services. 4 5Here are the key features and modules of ThreadX: 6 7 8 9## Getting Started 10 11Eclipse ThreadX has been integrated to the semiconductor's SDKs and development environment. You can develop using the tools of choice from [STMicroelectronics](https://www.st.com/content/st_com/en/campaigns/x-cube-azrtos-azure-rtos-stm32.html), [NXP](https://www.nxp.com/design/software/embedded-software/azure-rtos-for-nxp-microcontrollers:AZURE-RTOS), [Renesas](https://github.com/renesas/azure-rtos) and [Microchip](https://mu.microchip.com/get-started-simplifying-your-iot-design-with-azure-rtos). 12 13We also provide [getting started guide](https://github.com/eclipse-threadx/getting-started) and [samples](https://github.com/eclipse-threadx/samples) using development boards from semiconductors you can build and test with. 14 15See [Overview of Eclipse ThreadX RTOS](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/threadx/overview-threadx.md) for the high-level overview. 16 17## Repository Structure and Usage 18### Directory layout 19 20 . 21 ├── cmake # CMakelist files for building the project 22 ├── common # Core ThreadX files 23 ├── common_modules # Core ThreadX module files 24 ├── common_smp # Core ThreadX SMP files 25 ├── docs # Documentation supplements 26 ├── ports # Architecture and compiler specific files. See below for directory breakdown 27 │ ├── cortex_m7 28 │ │ ├── iar # Example IAR compiler sample project 29 │ │ │ ├── example build # IAR workspace and sample project files 30 │ │ │ ├── inc # tx_port.h for this architecture 31 │ │ │ └── src # Source files for this architecture 32 │ │ ├── ac6 # Example ac6/Keil sample project 33 │ │ ├── gnu # Example gnu sample project 34 │ │ └── ... 35 │ └── ... 36 ├── ports_modules # Architecture and compiler specific files for threadX modules 37 ├── ports_smp # Architecture and compiler specific files for threadX SMP 38 ├── samples # demo_threadx.c 39 └── utility # Test cases and utilities 40 41 42## Branches & Releases 43 44The master branch has the most recent code with all new features and bug fixes. It does not represent the latest General Availability (GA) release of the library. Each official release (preview or GA) will be tagged to mark the commit and push it into the Github releases tab, e.g. `v6.2-rel`. 45 46> When you see xx-xx-xxxx, 6.x or x.x in function header, this means the file is not officially released yet. They will be updated in the next release. See example below. 47``` 48/**************************************************************************/ 49/* */ 50/* FUNCTION RELEASE */ 51/* */ 52/* _tx_initialize_low_level Cortex-M23/GNU */ 53/* 6.x */ 54/* AUTHOR */ 55/* */ 56/* Scott Larson, Microsoft Corporation */ 57/* */ 58/* DESCRIPTION */ 59/* */ 60/* This function is responsible for any low-level processor */ 61/* initialization, including setting up interrupt vectors, setting */ 62/* up a periodic timer interrupt source, saving the system stack */ 63/* pointer for use in ISR processing later, and finding the first */ 64/* available RAM memory address for tx_application_define. */ 65/* */ 66/* INPUT */ 67/* */ 68/* None */ 69/* */ 70/* OUTPUT */ 71/* */ 72/* None */ 73/* */ 74/* CALLS */ 75/* */ 76/* None */ 77/* */ 78/* CALLED BY */ 79/* */ 80/* _tx_initialize_kernel_enter ThreadX entry function */ 81/* */ 82/* RELEASE HISTORY */ 83/* */ 84/* DATE NAME DESCRIPTION */ 85/* */ 86/* 09-30-2020 Scott Larson Initial Version 6.1 */ 87/* xx-xx-xxxx Scott Larson Include tx_user.h, */ 88/* resulting in version 6.x */ 89/* */ 90/**************************************************************************/ 91``` 92 93## Supported Architecture Ports 94 95### ThreadX 96``` 97arc_em cortex_a12 cortex_m0 cortex_r4 98arc_hs cortex_a15 cortex_m23 cortex_r5 99arm11 cortex_a17 cortex_m3 cortex_r7 100arm9 cortex_a34 cortex_m33 101c667x cortex_a35 cortex_m4 102linux cortex_a5 cortex_m55 103risc-v32 cortex_a53 cortex_m7 104rxv1 cortex_a55 cortex_m85 105rxv2 cortex_a57 106rxv3 cortex_a5x 107win32 cortex_a65 108xtensa cortex_a65ae 109 cortex_a7 110 cortex_a72 111 cortex_a73 112 cortex_a75 113 cortex_a76 114 cortex_a76ae 115 cortex_a77 116 cortex_a8 117 cortex_a9 118``` 119 120### ThreadX Modules 121[Eclipse ThreadX Modules](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/threadx-modules/chapter1.md) component provides an infrastructure for applications to dynamically load modules that are built separately from the resident portion of the application. 122``` 123cortex_a35 124cortex_a35_smp 125cortex_a7 126cortex_m0+ 127cortex_m23 128cortex_m3 129cortex_m33 130cortex_m4 131cortex_m7 132cortex_r4 133rxv2 134``` 135 136### ThreadX SMP 137[Eclipse ThreadX SMP](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/threadx/threadx-smp/chapter1.md) is a high-performance real-time SMP kernel designed specifically for embedded applications. 138``` 139arc_hs_smp 140cortex_a34_smp 141cortex_a35_smp 142cortex_a53_smp 143cortex_a55_smp 144cortex_a57_smp 145cortex_a5x_smp 146cortex_a5_smp 147cortex_a65ae_smp 148cortex_a65_smp 149cortex_a72_smp 150cortex_a73_smp 151cortex_a75_smp 152cortex_a76ae_smp 153cortex_a76_smp 154cortex_a77_smp 155cortex_a78_smp 156cortex_a7_smp 157cortex_a9_smp 158linux 159``` 160 161## Adaptation layer for ThreadX 162 163ThreadX is an advanced real-time operating system (RTOS) designed specifically for deeply embedded applications. To help ease application migration to ThreadX RTOS, Eclipse ThreadX provides [adaption layers](https://github.com/eclipse-threadx/threadx/tree/master/utility/rtos_compatibility_layers) for various legacy RTOS APIs (FreeRTOS, POSIX, OSEK, etc.). 164 165## Component dependencies 166 167The main components of ThreadX RTOS are each provided in their own repository, but there are dependencies between them, as shown in the following graph. This is important to understand when setting up your builds. 168 169 170 171> You will have to take the dependency graph above into account when building anything other than ThreadX itself. 172 173### Building and using the library 174 175Instruction for building the ThreadX as static library using Arm GNU Toolchain and CMake. If you are using toolchain and IDE from semiconductor, you might follow its own instructions to use ThreadX RTOS components as explained in the [Getting Started](#getting-started) section. 176 1771. Install the following tools: 178 179 * [CMake](https://cmake.org/download/) version 3.0 or later 180 * [Arm GNU Toolchain for arm-none-eabi](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads) 181 * [Ninja](https://ninja-build.org/) 182 1831. Cloning the repo 184 185 ```bash 186 $ git clone https://github.com/eclipse-threadx/threadx.git 187 ``` 188 1891. Define the features and addons you need in `tx_user.h` and build together with the component source code. You can refer to [`tx_user_sample.h`](https://github.com/eclipse-threadx/threadx/blob/master/common/inc/tx_user_sample.h) as an example. 190 1911. Building as a static library 192 193 Each component of ThreadX RTOS comes with a composable CMake-based build system that supports many different MCUs and host systems. Integrating any of these components into your device app code is as simple as adding a git submodule and then including it in your build using the CMake `add_subdirectory()`. 194 195 While the typical usage pattern is to include ThreadX into your device code source tree to be built & linked with your code, you can compile this project as a standalone static library to confirm your build is set up correctly. 196 197 An example of building the library for Cortex-M4: 198 199 ```bash 200 $ cmake -Bbuild -GNinja -DCMAKE_TOOLCHAIN_FILE=cmake/cortex_m4.cmake . 201 202 $ cmake --build ./build 203 ``` 204 205## Professional support 206 207 208## Licensing 209 210License terms for using Eclipse ThreadX are defined in the LICENSE.txt file of this repo. Please refer to this file for all definitive licensing information. 211 212## Resources 213 214The following are references to additional ThreadX RTOS resources: 215 216- **Product introduction**: https://github.com/eclipse-threadx/rtos-docs 217- **Product issues and bugs, or feature requests**: https://github.com/eclipse-threadx/threadx/issues 218- **TraceX Installer**: https://aka.ms/azrtos-tracex-installer 219 220You can also check [previous questions](https://stackoverflow.com/questions/tagged/threadx-rtos+threadx) or ask new ones on StackOverflow using the `threadx-rtos` and `threadx` tags. 221 222## Security 223 224Eclipse ThreadX provides OEMs with components to secure communication and to create code and data isolation using underlying MCU/MPU hardware protection mechanisms. It is ultimately the responsibility of the device builder to ensure the device fully meets the evolving security requirements associated with its specific use case. 225 226## Contribution 227 228Please follow the instructions provided in the [CONTRIBUTING.md](./CONTRIBUTING.md) for the corresponding repository. 229
