eclipse-threadx/threadxPublic

NotificationsYou must be signed in to change notification settings
Fork899
Star3.4k

Eclipse ThreadX is an advanced real-time operating system (RTOS) designed specifically for deeply embedded applications.

github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/threadx/index.md

License

MIT license

3.4k stars 899 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 261 Commits
.devcontainer		.devcontainer
.github		.github
cmake		cmake
common		common
common_modules		common_modules
common_smp		common_smp
docs		docs
ports		ports
ports_arch		ports_arch
ports_module		ports_module
ports_smp		ports_smp
samples		samples
scripts		scripts
test		test
utility		utility
.gitattributes		.gitattributes
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CMakeLists.txt		CMakeLists.txt
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE.txt		LICENSE.txt
README.md		README.md
SECURITY.md		SECURITY.md

Repository files navigation

Eclipse ThreadX RTOS

This 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.

Here are the key features and modules of ThreadX:

Getting Started

Eclipse ThreadX has been integrated to the semiconductor's SDKs and development environment. You can develop using the tools of choice fromSTMicroelectronics,NXP,Renesas andMicrochip.

We also providegetting started guide andsamples using development boards from semiconductors you can build and test with.

SeeOverview of Eclipse ThreadX RTOS for the high-level overview.

Repository Structure and Usage

Directory layout

.├── cmake                        # CMakelist files for building the project├── common                       # Core ThreadX files├── common_modules               # Core ThreadX module files├── common_smp                   # Core ThreadX SMP files├── docs                         # Documentation supplements├── ports                        # Architecture and compiler specific files. See below for directory breakdown     │   ├── cortex_m7     │   │   ├── iar                  # Example IAR compiler sample project│   │   │   ├── example build    # IAR workspace and sample project files│   │   │   ├── inc              # tx_port.h for this architecture│   │   │   └── src              # Source files for this architecture│   │   ├── ac6                  # Example ac6/Keil sample project│   │   ├── gnu                  # Example gnu sample project│   │   └── ...│   └── ...        ├── ports_modules                # Architecture and compiler specific files for threadX modules├── ports_smp                    # Architecture and compiler specific files for threadX SMP├── samples                      # demo_threadx.c└── utility                      # Test cases and utilities

Branches & Releases

The 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.

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.

/**************************************************************************//*                                                                        *//*  FUNCTION                                               RELEASE        *//*                                                                        *//*    _tx_initialize_low_level                          Cortex-M23/GNU    *//*                                                           6.x          *//*  AUTHOR                                                                *//*                                                                        *//*    Scott Larson, Microsoft Corporation                                 *//*                                                                        *//*  DESCRIPTION                                                           *//*                                                                        *//*    This function is responsible for any low-level processor            *//*    initialization, including setting up interrupt vectors, setting     *//*    up a periodic timer interrupt source, saving the system stack       *//*    pointer for use in ISR processing later, and finding the first      *//*    available RAM memory address for tx_application_define.             *//*                                                                        *//*  INPUT                                                                 *//*                                                                        *//*    None                                                                *//*                                                                        *//*  OUTPUT                                                                *//*                                                                        *//*    None                                                                *//*                                                                        *//*  CALLS                                                                 *//*                                                                        *//*    None                                                                *//*                                                                        *//*  CALLED BY                                                             *//*                                                                        *//*    _tx_initialize_kernel_enter           ThreadX entry function        *//*                                                                        *//*  RELEASE HISTORY                                                       *//*                                                                        *//*    DATE              NAME                      DESCRIPTION             *//*                                                                        *//*  09-30-2020      Scott Larson            Initial Version 6.1           *//*  xx-xx-xxxx      Scott Larson            Include tx_user.h,            *//*                                            resulting in version 6.x    *//*                                                                        *//**************************************************************************/

Supported Architecture Ports

ThreadX

arc_em      cortex_a12        cortex_m0     cortex_r4arc_hs      cortex_a15        cortex_m23    cortex_r5arm11       cortex_a17        cortex_m3     cortex_r7arm9        cortex_a34        cortex_m33    c667x       cortex_a35        cortex_m4    linux       cortex_a5         cortex_m55risc-v32    cortex_a53        cortex_m7rxv1        cortex_a55        cortex_m85rxv2        cortex_a57rxv3        cortex_a5xwin32       cortex_a65xtensa      cortex_a65ae            cortex_a7            cortex_a72            cortex_a73            cortex_a75            cortex_a76            cortex_a76ae            cortex_a77            cortex_a8            cortex_a9

ThreadX Modules

Eclipse ThreadX Modules component provides an infrastructure for applications to dynamically load modules that are built separately from the resident portion of the application.

cortex_a35cortex_a35_smpcortex_a7cortex_m0+cortex_m23cortex_m3cortex_m33cortex_m4cortex_m7cortex_r4rxv2

ThreadX SMP

Eclipse ThreadX SMP is a high-performance real-time SMP kernel designed specifically for embedded applications.

arc_hs_smpcortex_a34_smpcortex_a35_smpcortex_a53_smpcortex_a55_smpcortex_a57_smpcortex_a5x_smpcortex_a5_smpcortex_a65ae_smpcortex_a65_smpcortex_a72_smpcortex_a73_smpcortex_a75_smpcortex_a76ae_smpcortex_a76_smpcortex_a77_smpcortex_a78_smpcortex_a7_smpcortex_a9_smplinux

Adaptation layer for ThreadX

ThreadX is an advanced real-time operating system (RTOS) designed specifically for deeply embedded applications. To help ease application migration to ThreadX RTOS, Eclipse ThreadX providesadaption layers for various legacy RTOS APIs (FreeRTOS, POSIX, OSEK, etc.).

Component dependencies

The 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.

You will have to take the dependency graph above into account when building anything other than ThreadX itself.

Building and using the library

Instruction 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 theGetting Started section.

Install the following tools:
- CMake version 3.0 or later
- Arm GNU Toolchain for arm-none-eabi
- Ninja

Cloning the repo

$ git clone https://github.com/eclipse-threadx/threadx.git

Define the features and addons you need intx_user.h and build together with the component source code. You can refer totx_user_sample.h as an example.
Building as a static library
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 CMakeadd_subdirectory().
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.
An example of building the library for Cortex-M4:
```
$ cmake -Bbuild -GNinja -DCMAKE_TOOLCHAIN_FILE=cmake/cortex_m4.cmake.$ cmake --build ./build
```

Licensing

License 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 for all content, incl. the history of this repo.

Resources

The following are references to additional ThreadX RTOS resources:

Product introduction:https://github.com/eclipse-threadx/rtos-docs
Product issues and bugs, or feature requests:https://github.com/eclipse-threadx/threadx/issues
TraceX Installer:https://aka.ms/azrtos-tracex-installer

You can also checkprevious questions or ask new ones on StackOverflow using thethreadx-rtos andthreadx tags.

Security

Eclipse 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.