c1ce319f93 | ||
---|---|---|
.github | ||
bsp | ||
components | ||
documentation | ||
examples | ||
include | ||
libcpu | ||
src | ||
tools | ||
.gitattributes | ||
.gitignore | ||
.travis.yml | ||
AUTHORS | ||
ChangeLog.md | ||
Kconfig | ||
LICENSE | ||
README.md | ||
README_zh.md |
README.md
RT-Thread
中文页 |
RT-Thread is an open source IoT operating system from China, which has strong scalability: from a tiny kernel running on a tiny core, for example ARM Cortex-M0, or Cortex-M3/4/7, to a rich feature system running on MIPS32, ARM Cortex-A8, ARM Cortex-A9 DualCore etc.
Overview
RT-Thread RTOS like a traditional real-time operating system. The kernel has real-time multi-task scheduling, semaphore, mutex, mail box, message queue, signal etc. However, it has three different things:
- Device Driver;
- Component;
- Dyanmic Module
The device driver is more like a driver framework, UART, IIC, SPI, SDIO, USB device/host, EMAC, MTD NAND etc. The developer can easily add low level driver and board configuration, then combined with the upper framework, he/she can use lots of features.
The Component is a software concept upon RT-Thread kernel, for example a shell (finsh/msh shell), virtual file system (FAT, YAFFS, UFFS, ROM/RAM file system etc), TCP/IP protocol stack (lwIP), POSIX (thread) interface etc. One component must be a directory under RT-Thread/Components and one component can be descripted by a SConscript file (then be compiled and linked into the system).
The Dyanmic Module, formerly named as User Applicaion (UA) is a dyanmic loaded module or library, it can be compiled standalone without Kernel. Each Dyanmic Module has its own object list to manage thread/semaphore/kernel object which was created or initialized inside this UA. More information about UA, please visit another git repo.
Board Support Package
RT-Thread RTOS can support many architectures:
- ARM Cortex-M0
- ARM Cortex-M3/M4/7
- ARM Cortex-R4
- ARM Cortex-A8/A9
- ARM920T/ARM926 etc
- MIPS32
- x86
- Andes
- C-Sky
- RISC-V
- PowerPC
License
RT-Thread is Open Source software under the Apache License 2.0 since RT-Thread v3.1.1. License and copyright information can be found within the code.
/*
* Copyright (c) 2006-2018, RT-Thread Development Team
*
* SPDX-License-Identifier: Apache-2.0
*/
Since 9th of September 2018, PRs submitted by the community may be merged into the main line only after signing the Contributor License Agreement(CLA).
NOTE:
RT-Thread using the Apache license v2.0 is only launched after the release of v3.1.1, and is still in preparation right now.
Usage
RT-Thread RTOS uses scons as building system. Therefore, please install scons and Python 2.7 firstly. So far, the RT-Thread scons building system support the command line compile or generate some IDE's project. There are some option varaibles in the scons building script (rtconfig.py):
CROSS_TOOL
the compiler which you want to use, gcc/keil/iar.EXEC_PATH
the path of compiler.
In SConstruct file:
RTT_ROOT
This variable is the root directory of RT-Thread RTOS. If you build the porting in the bsp directory, you can use the default setting. Also, you can set the root directory in RTT_ROOT
environment variable and not modify SConstruct files.
When you set these variables correctly, you can use command:
scons
under BSP directory to simplely compile RT-Thread RTOS.
If you want to generate the IDE's project file, you can use command:
scons --target=mdk/mdk4/mdk5/iar/cb -s
to generate the project file.
NOTE: RT-Thread scons building system will tailor the system according to your rtconfig.h configuration header file. For example, if you disable the lwIP in the rtconfig.h by commenting the #define RT_USING_LWIP
, the generated project file should have no lwIP related files.
Contribution
Please refer the contributors in the github. Thank all of RT-Thread Developers.