Skip to content

Commit 4d688f7

Browse files
committed
convert .md files to .adoc file
1 parent 62b46b0 commit 4d688f7

File tree

2 files changed

+115
-78
lines changed

2 files changed

+115
-78
lines changed
Lines changed: 40 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,48 @@
1-
# Contributing to Eclipse ThreadX
1+
////
2+
3+
Copyright (c) Microsoft
4+
Copyright (c) 2024-present Eclipse ThreadX contributors
5+
6+
This program and the accompanying materials are made available
7+
under the terms of the MIT license which is available at
8+
https://opensource.org/license/mit.
9+
10+
SPDX-License-Identifier: MIT
11+
12+
Contributors:
13+
* Frédéric Desbiens - Initial AsciiDoc version.
14+
15+
////
16+
= Contributing to Eclipse ThreadX
217
318
Thanks for your interest in this project.
419
5-
## Project description
20+
== Project description
621
722
Eclipse ThreadX provides a vendor-neutral, open source, safety-certified OS for
823
real-time applications published on under a permissive license. The Eclipse
924
ThreadX suite encompasses:
10-
* ThreadX - advanced real-time operating system (RTOS) designed specifically for deeply embedded applications
11-
* NetX Duo - advanced, industrial-grade TCP/IP network stack designed specifically for deeply embedded real-time and IoT applications
12-
* FileX - high-performance, FAT-compatible file system that’s fully integrated with ThreadX kernel
13-
* GUIX - provides a complete, embedded graphical user interface (GUI) library
14-
* USBX - high-performance USB host, device, and on-the-go (OTG) embedded stack, that is fully integrated with ThreadX kernel
15-
* LevelX - flash wear leveling for FileX and stand-alone purposes
16-
* GuiX Studio - design environment, facilitating the creation and maintenance of all graphical elements for GUIX
17-
* TraceX - analysis tool that provides a graphical view of real-time system events to better understand the behavior of real-time systems
25+
26+
* ThreadX - advanced real-time operating system (RTOS) designed specifically for deeply embedded applications.
27+
* NetX Duo - advanced, industrial-grade TCP/IP network stack designed specifically for deeply embedded real-time and IoT applications.
28+
* FileX - high-performance, FAT-compatible file system that’s fully integrated with ThreadX kernel.
29+
* GUIX - provides a complete, embedded graphical user interface (GUI) library.
30+
* USBX - high-performance USB host, device, and on-the-go (OTG) embedded stack, that is fully integrated with ThreadX kernel.
31+
* LevelX - flash wear leveling for FileX and stand-alone purposes.
32+
* GuiX Studio - design environment, facilitating the creation and maintenance of all graphical elements for GUIX.
33+
* TraceX - analysis tool that provides a graphical view of real-time system events to better understand the behavior of real-time systems.
1834
1935
Project websites:
36+
2037
* https://threadx.io
2138
* https://projects.eclipse.org/projects/iot.threadx
2239
23-
## Terms of Use
40+
== Terms of Use
2441
2542
This repository is subject to the Terms of Use of the Eclipse Foundation
2643
https://www.eclipse.org/legal/termsofuse.php
2744
28-
## Developer resources
45+
== Developer resources
2946
3047
Information regarding source code management, builds, coding standards, and more.
3148
https://projects.eclipse.org/projects/iot.threadx/developer
@@ -47,17 +64,18 @@ The project maintains the following source code repositories
4764
* https://github.com/eclipse-threadx/tracex
4865
* https://github.com/eclipse-threadx/usbx
4966
50-
## Eclipse Development Process
67+
== Eclipse Development Process
5168
5269
This Eclipse Foundation open project is governed by the Eclipse Foundation
5370
Development Process and operates under the terms of the Eclipse IP Policy.
5471
5572
* https://eclipse.org/projects/dev_process
5673
* https://www.eclipse.org/org/documents/Eclipse_IP_Policy.pdf
5774
58-
## Eclipse Contributor Agreement
75+
== Eclipse Contributor Agreement
5976
6077
In order to be able to contribute to Eclipse Foundation projects you must electronically sign the Eclipse Contributor Agreement (ECA).
78+
6179
https://www.eclipse.org/legal/ECA.php
6280
6381
The ECA provides the Eclipse Foundation with a permanent record that you agree
@@ -67,21 +85,25 @@ the email address matching the "Author" field of your contribution's Git commits
6785
fulfills the DCO's requirement that you sign-off on your contributions.
6886
6987
For more information, please see the Eclipse Committer Handbook:
88+
7089
https://www.eclipse.org/projects/handbook/#resources-commit
7190
72-
## Contact
91+
== Contact
7392
7493
The project owns several mailing lists.
7594
76-
### Main ThreadX mailing list
95+
=== Main ThreadX mailing list
7796
News and updates about the ThreadX project and the ThreadX Alliance.
97+
7898
https://accounts.eclipse.org/mailing-list/threadx
7999
80-
### Developer mailing list
100+
=== Developer mailing list
81101
Project team conversations. Feel free to jump in and ask non-technical questions there.
102+
82103
https://accounts.eclipse.org/mailing-list/threadx-dev
83104
84-
### User mailing list
105+
=== User mailing list
85106
Ask your technical questions and discuss issues here.
107+
86108
https://accounts.eclipse.org/mailing-list/threadx-users
87109
Lines changed: 75 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
1-
# About this repository
2-
This is the AsciiDoc source for the Eclipse ThreadX documentation. The project team generates HTML and PDF versions from the contents of this repository.
1+
////
32

4-
If you want to propse changes or addition to the documentation, this is the right place!
3+
Copyright (c) Microsoft
4+
Copyright (c) 2024-present Eclipse ThreadX contributors
5+
6+
This program and the accompanying materials are made available
7+
under the terms of the MIT license which is available at
8+
https://opensource.org/license/mit.
9+
10+
SPDX-License-Identifier: MIT
11+
12+
Contributors:
13+
* Frédéric Desbiens - Initial AsciiDoc version.
514

6-
# What is Eclipse ThreadX?
15+
////
16+
17+
= About this repository
18+
:description: This is the AsciiDoc source for the Eclipse ThreadX documentation. The project team generates HTML and PDF versions from the contents of this repository.
19+
20+
== What is Eclipse ThreadX?
721
822
Eclipse ThreadX is a real time operating system (RTOS) for Internet of Things (IoT) and edge devices powered by microcontroller units (MCUs). Eclipse ThreadX is designed to support most highly constrained devices (battery powered and having less than 64 KB of flash memory).
923
@@ -13,72 +27,73 @@ Eclipse ThreadX provides full IP layer security via IPsec and socket layer secur
1327
1428
With Eclipse Foundation as the new home, Azure RTOS becomes Eclipse ThreadX. For more information, see the following pages:
1529
16-
* [Microsoft IoT blog](https://techcommunity.microsoft.com/t5/internet-of-things-blog/microsoft-contributes-azure-rtos-to-open-source/ba-p/3986318)
17-
* [Eclipse ThreadX project](https://threadx.io/)
30+
* https://techcommunity.microsoft.com/t5/internet-of-things-blog/microsoft-contributes-azure-rtos-to-open-source/ba-p/3986318[Microsoft IoT blog]
31+
* https://threadx.io[Eclipse ThreadX project]
1832
19-
## Eclipse ThreadX resources
33+
== Eclipse ThreadX resources
2034
21-
[Eclipse ThreadX repositories](https://github.com/eclipse-threadx/)
35+
https://github.com/eclipse-threadx[Eclipse ThreadX repositories]
2236
2337
Documentation for components:
2438
25-
- [ThreadX](./rtos-docs/threadx/index.md)
26-
- [ThreadX Modules](./rtos-docs/threadx-modules/index.md)
27-
- [NetX Duo](./rtos-docs/netx-duo/index.md)
28-
- [GUIX](./rtos-docs/guix/index.md)
29-
- [FileX](./rtos-docs/filex/index.md)
30-
- [LevelX](./rtos-docs/levelx/index.md)
31-
- [USBX](./rtos-docs/usbx/index.md)
32-
- [TraceX](./rtos-docs/tracex/index.md)
39+
* xref:./rtos-docs/threadx/index.adoc[ThreadX]
40+
* xref:./rtos-docs/threadx-modules/index.adoc[ThreadX Modules]
41+
* xref:./rtos-docs/netx-duo/index.adoc[NetX Duo]
42+
* xref:./rtos-docs/guix/index.adoc[GUIX]
43+
* xref:./rtos-docs/filex/index.adoc[FileX]
44+
* xref:./rtos-docs/levelx/index.adoc[LevelX]
45+
* xref:./rtos-docs/usbx/index.adoc[USBX]
46+
* xref:./rtos-docs/tracex/index.adoc[TraceX]
3347
3448
Other resources:
3549
36-
- [Product Support Policy](./rtos-docs/general/lts.md)
37-
- [Security Updates](./rtos-docs/general/security-updates.md)
50+
* xref:./rtos-docs/general/lts.adoc[Product Support Policy]
51+
* xref:./rtos-docs/general/security-updates.adoc[Security Updates]
3852
3953
40-
## Components of Eclipse ThreadX
54+
== Components of Eclipse ThreadX
4155
4256
The Eclipse ThreadX platform is the collection of run-time solutions including ThreadX, NetX Duo, FileX, GUIX and USBX.
4357
44-
![The diagram of Eclipse ThreadX system components.](./rtos-docs/media/eclipse-threadx-system-components.png)
58+
image::./rtos-docs/media/eclipse-threadx-system-components.png[]
4559
46-
### ThreadX
60+
=== ThreadX
4761
4862
ThreadX is an advanced Real-Time Operating System (RTOS) designed specifically for deeply embedded applications. Among the multiple benefits ThreadX provides are advanced scheduling facilities, message passing, interrupt management, and messaging services. ThreadX has many advanced features, including its picokernel architecture, preemption-threshold scheduling, event-chaining, and a rich set of system services.
4963
50-
### FileX
64+
=== FileX
5165
5266
FileX is a high-performance FAT-compatible file system. It is fully integrated with ThreadX and is available for all supported processors. Like ThreadX, FileX is designed to have a small footprint and high performance, making it ideal for today's deeply embedded applications that require file operations. FileX supports most physical media, including RAM disk, USBX, SD CARD, and NAND/NOR flash memories via LevelX.
5367
54-
### GUIX
68+
=== GUIX
5569
5670
GUIX is a professional quality graphical user interface package, created to meet the needs of embedded systems developers. Unlike the alternatives, GUIX is small, fast, and easily ported to virtually any hardware configuration capable of supporting graphical output. GUIX also delivers exceptional visual appeal and an intuitive and powerful API for application-level user interface development.
5771
58-
### NetX Duo
72+
=== NetX Duo
5973
6074
NetX Duo is an advanced, Industrial Grade TCP/IP network stacks designed specifically for deeply embedded, real-time, and IoT applications. NetX Duo is a dual IPv4 and IPv6 network stack.
6175
62-
### USBX
76+
=== USBX
6377
6478
USBX is a high-performance USB host, device, and On-The-Go (OTG) embedded stack. It is fully integrated with ThreadX and is available for all ThreadX supported processors. Like ThreadX, USBX is designed to have a small footprint and high performance, making it ideal for deeply embedded applications that require an interface with USB devices.
6579
66-
### Windows tools
80+
=== Windows tools
6781
6882
GUIX Studio provides a complete GUI application design environment, facilitating the creation and maintenance of all graphical elements in the application's GUI. GUIX Studio automatically generates C code compatible with the GUIX library, ready to be compiled and run on the target.
6983
84+
=== TRACEX
7085
TraceX is a host-based analysis tool that provides developers with a graphical view of real-time system events and enables them to visualize and better understand the behavior of their real-time systems.
7186
72-
## The Eclipse ThreadX Advantage
87+
== The Eclipse ThreadX Advantage
7388
7489
Eclipse ThreadX provides the following advantages over other real-time operating systems.
7590
76-
### Most deployed RTOS
91+
=== Most deployed RTOS
7792
7893
Eclipse ThreadX has over 12 billion deployments worldwide. The popularity of Eclipse ThreadX is a testament to its reliability, quality, size, performance, advanced features, ease-of-use, and overall time-to-market advantages.
7994
> _"We have followed the growth trajectory of THREADX in the wireless and IoT markets since the company's founding, and are increasingly impressed by the widespread industry adoption of THREADX."_ – Chris Rommel, Executive Vice President, VDC Research
8095
81-
### Intuitive and consistent API design
96+
=== Intuitive and consistent API design
8297
8398
- Intuitive and consistent API.
8499
- Noun-verb naming convention.
@@ -88,13 +103,13 @@ Eclipse ThreadX has over 12 billion deployments worldwide. The popularity of Ecl
88103
- Optional user-notification callbacks for media and file operations.
89104
- Event-driven programming model (API).
90105
91-
### High efficiency
106+
=== High efficiency
92107
93108
- Small code footprint.
94109
- Scalable code footprint based on the services used.
95110
- Fast execution. Eclipse ThreadX is designed for speed and has minimal internal function call layering to help achieve the fastest possible performance.
96111
97-
### Fastest time-to-market
112+
=== Fastest time-to-market
98113
99114
Eclipse ThreadX is easy to install, learn, use, debug, verify, certify, and maintain. As a result, Eclipse ThreadX is one of the most popular real time operating systems for embedded IoT devices, including many SoCs from Broadcom, Gainspan, and so forth. Our consistent time-to-market advantage is built on:
100115
@@ -103,80 +118,80 @@ Eclipse ThreadX is easy to install, learn, use, debug, verify, certify, and main
103118
- Comprehensive and advanced feature set.
104119
- Quality documentation.
105120
106-
### Full, highest-quality source code
121+
=== Full, highest-quality source code
107122
108123
Throughout the years, Eclipse ThreadX source code has set the bar in quality and ease of understanding. In addition, the convention of having one function per file provides for easy source navigation.
109124
110-
### Pre-certified by TÜV and UL to many safety standards
125+
=== Pre-certified by TÜV and UL to many safety standards
111126
112127
Eclipse ThreadX has been certified by SGS-TÜV Saar for use in safety-critical systems, according to IEC-61508 SIL 4. The certification confirms that Eclipse ThreadX can be used in the development of safety-related software for the highest safety integrity levels of IEC-61508 for the "Functional Safety of electrical, electronic, and programmable electronic safety-related systems." SGS-TUV Saar, formed through a joint venture of Germany's SGS-Group and TUV Saarland, has become the leading accredited, independent company for testing, auditing, verifying, and certifying embedded software for safety-related systems worldwide.
113128
114-
![SGS-TUV certification](./rtos-docs/media/partener-logo-sgs-tuv-saar.png)
129+
image::./rtos-docs/media/partener-logo-sgs-tuv-saar.png[]
115130
116131
Eclipse ThreadX has been recognized by UL for compliance with UL 60730-1 Annex H, CSA E60730-1 Annex H, IEC 60730-1 Annex H, UL 60335-1 Annex R, IEC 60335-1 Annex R, and UL 1998 safety standards for software in programmable components. UL is a global, independent, safety-science company with more than a century of expertise innovating safety solutions, ranging from the public adoption of electricity to breakthroughs in sustainability, renewable energy, and nanotechnology.
117132
118-
![CRU UL certification](./rtos-docs/media/cru-logo-certification.png)
133+
image::./rtos-docs/media/cru-logo-certification.png[]
119134
120135
Artifacts (Certificate, Safety Manual, Test Report, etc.) associated with the TUV and UL certifications are available to license.
121136
122137
In cases where the application needs additional certification, a certification service is available through Eclipse Foundation for providing turn-key certification to various standards using the actual hardware platform and even covering the application code. Contact us for more details on our certification service.
123138
124-
### EAL4+ Common Criteria security certification
139+
=== EAL4+ Common Criteria security certification
125140
126141
ThreadX has achieved EAL4+ Common Criteria security certification. The Target of Evaluation (TOE) covers ThreadX, NetX Duo, NetX Secure TLS, and NetX MQTT. This represents the most typical IoT protocols required by deeply embedded sensors, devices, edge routers, and gateways.
127142
128-
![EAL certification](./rtos-docs/media/eal-logo-certification.png)
143+
image::./rtos-docs/media/eal-logo-certification.png[]
129144
130145
The IT Security Evaluation Facility used for the Eclipse ThreadX SC security certification is Brightsight BV and the Certification Authority is SERTIT.
131146
132-
### FIPS 140-2 Validated
147+
=== FIPS 140-2 Validated
133148
134149
Eclipse ThreadX Crypto libraries have achieved Federal Information Processing Standardization 140-2 (FIPS 140-2) Certification for software, which specifies requirements for cryptography modules. FIPS 140-2 requires all federal government agencies and departments that use cryptographic-based security to meet specific standards related to encryption strength and capabilities. These cryptographic-based security standards are also recognized in Canada and the European Union.
135150
136-
The Information Security evaluation lab used for Eclipse ThreadX Crypto libraries was atsec and the certification authority is [The National Institute of Standards and Technology (NIST)](https://csrc.nist.gov/projects/cryptographic-module-validation-program/Certificate/3394).
151+
The Information Security evaluation lab used for Eclipse ThreadX Crypto libraries was atsec and the certification authority is https://csrc.nist.gov/projects/cryptographic-module-validation-program/Certificate/3394[The National Institute of Standards and Technology (NIST)].
137152
138-
### Supports most popular architectures
153+
=== Supports most popular architectures
139154
140155
Eclipse ThreadX works on most popular 32/64-bit microprocessors, out-of-the-box, fully tested and fully supported, including the following advanced architectures:
141156
142-
- **Analog Devices**: SHARC, Blackfin, CM4xx
157+
- *Analog Devices*: SHARC, Blackfin, CM4xx
143158
144-
- **Andes Core**: RISC-V
159+
- *Andes Core*: RISC-V
145160
146-
- **Ambiqmicro**: Apollo MCUs
161+
- *Ambiqmicro*: Apollo MCUs
147162
148-
- **ARM**: ARM7, ARM9, ARM11, Cortex-M0/M3/M4/M7/A15/A5/A7/A8/A9/A5x 64-bi/A7x 64-bit/R4/R5, TrustZone ARMv8-M
163+
- *ARM*: ARM7, ARM9, ARM11, Cortex-M0/M3/M4/M7/A15/A5/A7/A8/A9/A5x 64-bi/A7x 64-bit/R4/R5, TrustZone ARMv8-M
149164
150-
- **Cadence**: Xtensa, Diamond
165+
- *Cadence*: Xtensa, Diamond
151166
152-
- **CEVA**: PSoC, PSoC 4, PSoC 5, PSoC 6, FM0+, FM3, MF4, WICED WiFi
167+
- *CEVA*: PSoC, PSoC 4, PSoC 5, PSoC 6, FM0+, FM3, MF4, WICED WiFi
153168
154-
- **Cypress**: RISC-V
169+
- *Cypress*: RISC-V
155170
156-
- **EnSilica**: eSi-RISC
171+
- *EnSilica*: eSi-RISC
157172
158-
- **Infineon**: XMC1000, XMC4000, TriCore
173+
- *Infineon*: XMC1000, XMC4000, TriCore
159174
160-
- **Intel; Intel FPGA**: x36/Pentium, XScale, NIOS II, Cyclone, Arria 10
175+
- *Intel; Intel FPGA*: x36/Pentium, XScale, NIOS II, Cyclone, Arria 10
161176
162-
- **Microchip**: AVR32, ARM7, ARM9, Cortex-M3/M4/M7, SAM3/4/7/9/A/C/D/E/G/L/SV, PIC24/PIC32
177+
- *Microchip*: AVR32, ARM7, ARM9, Cortex-M3/M4/M7, SAM3/4/7/9/A/C/D/E/G/L/SV, PIC24/PIC32
163178
164-
- **Microsemi**: RISC-V
179+
- *Microsemi*: RISC-V
165180
166-
- **NXP**: i.MX RT10xx and RT116x/7x series crossover MCUs, LPC5500 series
181+
- *NXP*: i.MX RT10xx and RT116x/7x series crossover MCUs, LPC5500 series
167182
168-
- **Renesas**: SH, HS, V850, RA, RX, RZ, Synergy
183+
- *Renesas*: SH, HS, V850, RA, RX, RZ, Synergy
169184
170-
- **Silicon Labs**: EFM32
185+
- *Silicon Labs*: EFM32
171186
172-
- **Synopsys**: ARC 600, 700, ARC EM, ARC HS
187+
- *Synopsys*: ARC 600, 700, ARC EM, ARC HS
173188
174-
- **ST**: STM32, ARM7, ARM9, Cortex-M3/M4/M7
189+
- *ST*: STM32, ARM7, ARM9, Cortex-M3/M4/M7
175190
176-
- **Tl**: C5xxx, C6xxx, Stellaris, Sitara, Tiva-C
191+
- *Tl*: C5xxx, C6xxx, Stellaris, Sitara, Tiva-C
177192
178-
- **Wave Computing**: MIPS32 4K, 24 K, 34 K, 1004 K, MIPS64 5K, microAptiv, interAptiv, proAptiv, M-Class
193+
- *Wave Computing*: MIPS32 4K, 24 K, 34 K, 1004 K, MIPS64 5K, microAptiv, interAptiv, proAptiv, M-Class
179194
180-
- **Xilinx**: MicroBlaze, PowerPC 405, ZYNQ, ZYNQ UltraSCALE
195+
- *Xilinx*: MicroBlaze, PowerPC 405, ZYNQ, ZYNQ UltraSCALE
181196
182197
_All timing and size figures listed are estimates and may be different on your development platform._

0 commit comments

Comments
 (0)