From 20927253c795d1328d8fb98c21b33507f1976031 Mon Sep 17 00:00:00 2001 From: Stefan Wick Date: Tue, 20 Feb 2024 22:36:51 -0800 Subject: [PATCH] Update README.md --- README.md | 46 +++++++++++++++++++--------------------------- 1 file changed, 19 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 7ae9186..30302c3 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Azure RTOS FileX +# Eclipse ThreadX FileX -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. +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. Here are the key features and modules of FileX: @@ -8,11 +8,11 @@ Here are the key features and modules of FileX: ## Getting Started -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). +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). -We also provide [samples](https://github.com/azure-rtos/samples) using hero development boards from semiconductors you can build and test with. +We also provide [samples](https://github.com/eclipse-threadx/samples) using hero development boards from semiconductors you can build and test with. -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). +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. ## Repository Structure and Usage @@ -26,7 +26,7 @@ See [Overview of Azure RTOS FileX](https://learn.microsoft.com/azure/rtos/filex/ ├── LICENSE.txt # License terms ├── LICENSE-HARDWARE.txt # Licensed hardware from semiconductors ├── CONTRIBUTING.md # Contribution guidance - └── SECURITY.md # Microsoft repo security guidance + └── SECURITY.md # Repo security guidance ### Branches & Releases @@ -81,7 +81,7 @@ The master branch has the most recent code with all new features and bug fixes. ## Component dependencies -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. +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. ![dependency graph](docs/deps.png) @@ -89,7 +89,7 @@ The main components of Azure RTOS are each provided in their own repository, but ### Building and using the library -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. +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. 1. Install the following tools: @@ -97,19 +97,19 @@ Instruction for building the FileX as static library using Arm GNU Toolchain and * [Arm GNU Toolchain for arm-none-eabi](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads) * [Ninja](https://ninja-build.org/) -1. Build the [ThreadX library](https://github.com/azure-rtos/threadx#building-and-using-the-library) as the dependency. +1. Build the [ThreadX library](https://github.com/eclipse-threadx/threadx#building-and-using-the-library) as the dependency. 1. Cloning the repo. ```bash - $ git clone https://github.com/azure-rtos/filex.git + $ git clone https://github.com/eclipse-threadx/filex.git ``` -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. +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. 1. Building as a static library - 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()`. + 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()`. 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. @@ -121,31 +121,23 @@ Instruction for building the FileX as static library using Arm GNU Toolchain and $ cmake --build ./build ``` -## Professional support - -[Professional support plans](https://azure.microsoft.com/support/options/) are available from Microsoft. For community support and others, see the [Resources](#resources) section below. - ## Licensing -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. +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. ## Resources -The following are references to additional Azure RTOS resources: +The following are references to additional Eclipse ThreadX resources: -- **Product introduction and white papers**: https://azure.com/rtos -- **General technical questions**: https://aka.ms/QnA/azure-rtos -- **Product issues and bugs, or feature requests**: https://github.com/azure-rtos/filex/issues -- **Licensing and sales questions**: https://aka.ms/azrtos-license -- **Product roadmap and support policy**: https://aka.ms/azrtos/lts -- **Blogs and videos**: http://msiotblog.com and https://aka.ms/iotshow -- **Azure RTOS TraceX Installer**: https://aka.ms/azrtos-tracex-installer +- **Product introduction**: https://github.com/eclipse-threadx/rtos-docs +- **Product issues and bugs, or feature requests**: https://github.com/eclipse-threadx/filex/issues +- **TraceX Installer**: https://aka.ms/azrtos-tracex-installer -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. +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. ## Security -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. +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. ## Contribution