Skip to content

Commit 2092725

Browse files
authored
Update README.md
1 parent 878a1c6 commit 2092725

1 file changed

Lines changed: 19 additions & 27 deletions

File tree

README.md

Lines changed: 19 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# Azure RTOS FileX
1+
# Eclipse ThreadX FileX
22

3-
This is a high-performance, file allocation table (FAT)-compatible file system that’s fully integrated with Azure RTOS ThreadX and available for all supported processors. Like Azure RTOS ThreadX, Azure RTOS FileX is designed to have a small footprint and high performance, making it ideal for today’s deeply embedded applications that require file management operations. FileX supports most physical media, including RAM, Azure RTOS USBX, SD CARD, and NAND/NOR flash memories via Azure RTOS LevelX.
3+
This is a high-performance, file allocation table (FAT)-compatible file system that’s fully integrated with Eclipse ThreadX RTOS and available for all supported processors. Like Eclipse ThreadX RTOS, FileX is designed to have a small footprint and high performance, making it ideal for today’s deeply embedded applications that require file management operations. FileX supports most physical media, including RAM, Eclipse ThreadX USBX, SD CARD, and NAND/NOR flash memories via Eclipse ThreadX LevelX.
44

55
Here are the key features and modules of FileX:
66

77
![FileX Key Features](./docs/filex-features.png)
88

99
## Getting Started
1010

11-
Azure RTOS FileX as part of Azure RTOS 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).
11+
FileX as part of Eclipse 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).
1212

13-
We also provide [samples](https://github.com/azure-rtos/samples) using hero development boards from semiconductors you can build and test with.
13+
We also provide [samples](https://github.com/eclipse-threadx/samples) using hero development boards from semiconductors you can build and test with.
1414

15-
See [Overview of Azure RTOS FileX](https://learn.microsoft.com/azure/rtos/filex/overview-filex) for the high-level overview, and all documentation and APIs can be found in: [Azure RTOS FileX documentation](https://learn.microsoft.com/azure/rtos/filex).
15+
See [Overview of Eclipse ThreadX FileX](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/filex/overview-filex.md) for the high-level overview.
1616

1717
## Repository Structure and Usage
1818

@@ -26,7 +26,7 @@ See [Overview of Azure RTOS FileX](https://learn.microsoft.com/azure/rtos/filex/
2626
├── LICENSE.txt # License terms
2727
├── LICENSE-HARDWARE.txt # Licensed hardware from semiconductors
2828
├── CONTRIBUTING.md # Contribution guidance
29-
└── SECURITY.md # Microsoft repo security guidance
29+
└── SECURITY.md # Repo security guidance
3030

3131
### Branches & Releases
3232

@@ -81,35 +81,35 @@ The master branch has the most recent code with all new features and bug fixes.
8181

8282
## Component dependencies
8383

84-
The main components of Azure 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.
84+
The main components of Eclipse ThreadX 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.
8585

8686
![dependency graph](docs/deps.png)
8787

8888
> You will have to take the dependency graph above into account when building anything other than ThreadX itself.
8989
9090
### Building and using the library
9191

92-
Instruction for building the FileX 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 Azure RTOS components as explained in the [Getting Started](#getting-started) section.
92+
Instruction for building the FileX 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 Eclipse ThreadX components as explained in the [Getting Started](#getting-started) section.
9393

9494
1. Install the following tools:
9595

9696
* [CMake](https://cmake.org/download/) version 3.0 or later
9797
* [Arm GNU Toolchain for arm-none-eabi](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads)
9898
* [Ninja](https://ninja-build.org/)
9999

100-
1. Build the [ThreadX library](https://github.com/azure-rtos/threadx#building-and-using-the-library) as the dependency.
100+
1. Build the [ThreadX library](https://github.com/eclipse-threadx/threadx#building-and-using-the-library) as the dependency.
101101

102102
1. Cloning the repo.
103103

104104
```bash
105-
$ git clone https://github.com/azure-rtos/filex.git
105+
$ git clone https://github.com/eclipse-threadx/filex.git
106106
```
107107

108-
1. Define the features and addons you need in `fx_user.h` and build together with the component source code. You can refer to [`fx_user_sample.h`](https://github.com/azure-rtos/filex/blob/master/common/inc/fx_user_sample.h) as an example.
108+
1. Define the features and addons you need in `fx_user.h` and build together with the component source code. You can refer to [`fx_user_sample.h`](https://github.com/eclipse-threadx/filex/blob/master/common/inc/fx_user_sample.h) as an example.
109109

110110
1. Building as a static library
111111

112-
Each component of Azure 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()`.
112+
Each component of Eclipse ThreadX 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()`.
113113
114114
While the typical usage pattern is to include FileX 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.
115115
@@ -121,31 +121,23 @@ Instruction for building the FileX as static library using Arm GNU Toolchain and
121121
$ cmake --build ./build
122122
```
123123

124-
## Professional support
125-
126-
[Professional support plans](https://azure.microsoft.com/support/options/) are available from Microsoft. For community support and others, see the [Resources](#resources) section below.
127-
128124
## Licensing
129125

130-
License terms for using Azure RTOS are defined in the LICENSE.txt file of this repo. Please refer to this file for all definitive licensing information. No additional license fees are required for deploying Azure RTOS on hardware defined in the [LICENSED-HARDWARE.txt](./LICENSED-HARDWARE.txt) file. If you are using hardware not listed in the file or having licensing questions in general, please contact Microsoft directly at https://aka.ms/azrtos-license.
126+
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.
131127

132128
## Resources
133129

134-
The following are references to additional Azure RTOS resources:
130+
The following are references to additional Eclipse ThreadX resources:
135131

136-
- **Product introduction and white papers**: https://azure.com/rtos
137-
- **General technical questions**: https://aka.ms/QnA/azure-rtos
138-
- **Product issues and bugs, or feature requests**: https://github.com/azure-rtos/filex/issues
139-
- **Licensing and sales questions**: https://aka.ms/azrtos-license
140-
- **Product roadmap and support policy**: https://aka.ms/azrtos/lts
141-
- **Blogs and videos**: http://msiotblog.com and https://aka.ms/iotshow
142-
- **Azure RTOS TraceX Installer**: https://aka.ms/azrtos-tracex-installer
132+
- **Product introduction**: https://github.com/eclipse-threadx/rtos-docs
133+
- **Product issues and bugs, or feature requests**: https://github.com/eclipse-threadx/filex/issues
134+
- **TraceX Installer**: https://aka.ms/azrtos-tracex-installer
143135

144-
You can also check [previous questions](https://stackoverflow.com/questions/tagged/azure-rtos+filex) or ask new ones on StackOverflow using the `azure-rtos` and `filex` tags.
136+
You can also check [previous questions](https://stackoverflow.com/questions/tagged/azure-rtos+filex) or ask new ones on StackOverflow using the `threadx` and `filex` tags.
145137

146138
## Security
147139

148-
Azure RTOS 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.
140+
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.
149141

150142
## Contribution
151143

0 commit comments

Comments
 (0)