rt-thread 私人库
Go to file
Bernard Xiong c9fa432756
Merge pull request #4826 from ArdaFu/master
[bsp][tm4c129x] Fix the buffer free error in eth driver receive func.
2021-06-26 14:09:00 +08:00
.gitee [pr][template] 增加符合RTThread代码规范条款描述 2021-03-08 10:35:14 +08:00
.github Merge pull request #4457 from mysterywolf/issue 2021-06-19 06:55:00 +08:00
bsp [bsp][tm4c129x] Do not free net driver rx pBuf in receive method when device is not ready. Fix#4625 2021-06-26 12:37:59 +08:00
components Merge pull request #4819 from whj4674672/pm 2021-06-24 21:32:25 +08:00
documentation [pr][template] 增加符合RTThread代码规范条款描述 2021-03-08 10:35:14 +08:00
examples Merge pull request #4809 from KyleChenjh/serial_v2_tc 2021-06-24 21:29:13 +08:00
include Merge pull request #4796 from mysterywolf/__CLANG_ARM 2021-06-24 21:05:05 +08:00
libcpu [update] 整理cortex-a kconfig菜单,并更新相关BSP的配置。 2021-05-27 17:44:44 +08:00
src Merge pull request #4796 from mysterywolf/__CLANG_ARM 2021-06-24 21:05:05 +08:00
tools [cmake] fix path issue. 2021-06-25 21:07:23 +08:00
.gitattributes Update .gitattributes 2021-03-03 03:16:53 +08:00
.gitignore [tools] 增加cmake生成工具 2021-03-18 00:12:48 +08:00
.ignore_format.yml [update] ignore format check for lwip files. 2021-04-10 18:07:09 +08:00
AUTHORS update CRLF 2013-01-09 00:06:34 +08:00
ChangeLog.md Update ChangeLog.md 2020-12-31 19:44:53 +08:00
Jenkinsfile [bsp]delete fh8620、gkipc, because of gpl license 2021-04-25 11:39:21 +08:00
Kconfig [add] auto test ci. 2021-05-10 20:34:35 +08:00
LICENSE Update license information. 2018-09-09 11:13:41 +08:00
README.md [DOC] Add Nuclei to main README.md 2020-04-20 10:33:32 +08:00
README_zh.md [DOC] Add Nuclei to main README.md 2020-04-20 10:33:32 +08:00

README.md

RT-Thread

中文页 |

GitHub GitHub release Build Status Gitter GitHub pull-requests PRs Welcome

Introduction

RT-Thread was born in 2006, it is an open source, neutral, and community-based real-time operating system (RTOS).

RT-Thread is mainly written in C language, easy to understand and easy to port(can be quickly port to a wide range of mainstream MCUs and module chips). It applies object-oriented programming methods to real-time system design, making the code elegant, structured, modular, and very tailorable.

RT-Thread has Standard version and Nano version. For resource-constrained microcontroller (MCU) systems, the NANO kernel version that requires only 3KB Flash and 1.2KB RAM memory resources can be tailored with easy-to-use tools; And for resource-rich IoT devices, RT-Thread can use the on-line software package management tool, together with system configuration tools, to achieve intuitive and rapid modular cutting, seamlessly import rich software packages, thus achieving complex functions like Android's graphical interface and touch sliding effects, smart voice interaction effects, and so on.

RT-Thread Architecture

RT-Thread has not only a real-time kernel, but also rich components. Its architecture is as follows:

architecture

It includes:

  • Kernel layer: RT-Thread kernel, the core part of RT-Thread, includes the implementation of objects in the kernel system, such as multi-threading and its scheduling, semaphore, mailbox, message queue, memory management, timer, etc.; libcpu/BSP (Chip Migration Related Files/Board Support Package) is closely related to hardware and consists of peripheral drivers and CPU porting.

  • Components and Service Layer: Components are based on upper-level software on top of the RT-Thread kernel, such as virtual file systems, FinSH command-line interfaces, network frameworks, device frameworks, and more. Its modular design allows for high internal cohesion inside the components and low coupling between components.

  • RT-Thread software package: A general-purpose software component running on the RT-Thread IoT operating system platform for different application areas, consisting of description information, source code or library files. RT-Thread provides an open package platform with officially available or developer-supplied packages that provide developers with a choice of reusable packages that are an important part of the RT-Thread ecosystem. The package ecosystem is critical to the choice of an operating system because these packages are highly reusable and modular, making it easy for application developers to build the system they want in the shortest amount of time. RT-Thread supports more than 180 software packages.

RT-Thread Features

  • Designed for resource-constrained devices, the minimum kernel requires only 1.2KB of RAM and 3 KB of Flash.

  • Has rich components and a prosperous and fast growing package ecosystem.

  • Elegant code style, easy to use, read and master.

  • High Scalability. RT-Thread has high-quality scalable software architecture, loose coupling, modularity, is easy to tailor and expand.

  • Supports high-performance applications.

  • Supports cross-platform and a wide range of chips.

Code Catalogue

RT-Thread source code catalog is shown as follow:

Name Description
BSP Board Support Package based on the porting of various development boards
components Components, such as finsh shell, file system, protocol stack etc.
documentation Related documents, like coding style, doxygen etc.
examples Related sample code
include Head files of RT-Thread kernel
libcpu CPU porting code such as ARM/MIPS/RISC-V etc.
src The source files for the RT-Thread kernel.
tools The script files for the RT-Thread command build tool.

RT-Thread has now been ported for nearly 90 development boards, most BSPs support MDK, IAR development environment and GCC compiler, and have provided default MDK and IAR project, which allows users to add their own application code directly based on the project. Each BSP has a similar directory structure, and most BSPs provide a README.md file, which is a markdown-format file that contains the basic introduction of BSP, and introduces how to simply start using BSP.

Env is a development tool developed by RT-Thread which provides a build environment, text graphical system configuration, and package management capabilities for project based on the RT-Thread operating system. Its built-in menuconfig provides an easy-to-use configuration tool. It can tailor the kernels, components and software packages freely, so that the system can be constructed by building blocks.

Resources

Supported Architectures

RT-Thread supports many architectures, and has covered the major architectures in current applications. Architecture and chip manufacturer involved:

  • ARM Cortex-M0/M0+manufacturers like ST
  • ARM Cortex-M3manufacturers like ST、Winner Micro、MindMotion, ect.
  • ARM Cortex-M4manufacturers like ST、Nuvton、NXP、GigaDevice、Realtek、Ambiq Micro, ect.
  • ARM Cortex-M7manufacturers like ST、NXP
  • ARM Cortex-M23manufacturers like GigaDevice
  • ARM Cortex-R4
  • ARM Cortex-A8/A9manufacturers like NXP
  • ARM7manufacturers like Samsung
  • ARM9manufacturers like Allwinner、Xilinx 、GOKE
  • ARM11manufacturers like Fullhan
  • MIPS32manufacturers like loongson、Ingenic
  • RISC-Vmanufacturers like Hifive、Kendryte、Nuclei
  • ARCmanufacturers like SYNOPSYS
  • DSPmanufacturers like TI
  • C-Sky
  • x86

Supported IDE and Compiler

The main IDE/compilers supported by RT-Thread are:

  • MDK KEIL
  • IAR
  • GCC
  • RT-Thread Studio

Use Python-based scons for command-line builds.

RT-Thread Studio Demonstration:

studio

Getting Started

RT-Thread BSP can be compiled directly and downloaded to the corresponding development board for use. In addition, RT-Thread also provides qemu-vexpress-a9 BSP, which can be used without hardware platform. See the getting started guide below for details.

Documentation

RT-Thread Programming Guide | RT-Thread Supported Chips & Boards | RT-Thread Software Package | RT-Thread Studio

Sample

Kernel Sample | Device Sample Code | File System Sample Code | Network Sample Code |

Based on the STM32L475 IoT Board SDK | Based on the W601 IoT Board SDK

License

RT-Thread is an open source software and has been licensed under Apache License Version 2.0 since v3.1.1. License information and copyright information can generally be seen at the beginning of the code:

/* Copyright (c) 2006-2018, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 * ...
 */

To avoid possible future license conflicts, developers need to sign a Contributor License Agreement (CLA) when submitting PR to RT-Thread.

Community

RT-Thread is very grateful for the support from all community developers, and if you have any ideas, suggestions or questions in the process of using RT-Thread, RT-Thread can be reached by the following means, and we are also updating RT-Thread in real time on these channels. At the same time, Any questions can be asked in the issue section of rtthread-manual-doc. By creating a new issue to describe your questions, community members will answer them.

Website | Twitter | Youtube | Gitter | Facebook | Medium

Contribution

If you are interested in RT-Thread and want to join in the development of RT-Thread and become a code contributor,please refer to the Code Contribution Guide.