-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
76 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,94 +1,98 @@ | ||
| # Azure RTOS LevelX | ||
|
|
||
| LevelX provides NAND and NOR flash wear leveling facilities to embedded applications. Since both NAND and NOR flash memory can only be erased a finite number of times, it’s critical to distribute the flash memory use evenly. This is typically called “wear leveling” and is the purpose behind LevelX. LevelX presents to the user an array of logical sectors that are mapped to physical flash memory inside of LevelX. Applications may use LevelX in conjunction with FileX or may read/write logical sectors directly. LevelX is designed for fault tolerance. Flash updates are performed in a multiple-step process that can be interrupted in each step. LevelX automatically recovers to the optimal state during the next operation. | ||
| LevelX provides NAND and NOR flash wear leveling facilities to embedded applications. Since both NAND and NOR flash memory can only be erased a finite number of times, it’s critical to distribute the flash memory use evenly. This is typically called **wear leveling** and is the purpose behind LevelX. LevelX presents to the user an array of logical sectors that are mapped to physical flash memory inside of LevelX. Applications may use LevelX in conjunction with FileX or may read/write logical sectors directly. LevelX is designed for fault tolerance. Flash updates are performed in a multiple-step process that can be interrupted in each step. LevelX automatically recovers to the optimal state during the next operation. | ||
|
|
||
| ## Documentation | ||
| ## Getting Started | ||
|
|
||
| Documentation for this library can be found here: https://github.com/azure-rtos/levelx/releases/download/v6.0_rel/Azure_RTOS_LevelX_User_Guide.pdf | ||
| Azure RTOS LevelX 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). | ||
|
|
||
| # Understanding inter-component dependencies | ||
| See [Overview of Azure RTOS LevelX](https://learn.microsoft.com/azure/rtos/levelx/overview-levelx) for the high-level overview, and all documentation and APIs can be found in: [Azure RTOS LevelX documentation](https://learn.microsoft.com/azure/rtos/levelx/). | ||
|
|
||
| The main components of Azure RTOS are each provided in their own repository, but there are dependencies between them--shown in the following graph--that are important to understand when setting up your builds. | ||
| ## Repository Structure and Usage | ||
|
|
||
|  | ||
| ### Directory layout | ||
|
|
||
| . | ||
| ├── cmake # CMakeList files for building the project | ||
| ├── common # Core LevelX files | ||
| ├── samples # Sample codes | ||
| ├── LICENSE.txt # License terms | ||
| ├── LICENSE-HARDWARE.txt # Licensed hardware from semiconductors | ||
| ├── CONTRIBUTING.md # Contribution guidance | ||
| └── SECURITY.md # Microsoft repo security guidance | ||
|
|
||
| # Building and using the library | ||
| ### Branches & Releases | ||
|
|
||
| ## Prerequisites | ||
| The master branch has the most recent code with all new features and bug fixes. It does not represent the latest General Availability (GA) release of the library. Each official release (preview or GA) will be tagged to mark the commit and push it into the Github releases tab, e.g. `v6.2-rel`. | ||
|
|
||
| Install the following tools: | ||
| ## Component dependencies | ||
|
|
||
| * [CMake](https://cmake.org/download/) version 3.0 or later | ||
| * [GCC compilers for arm-none-eabi](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads) | ||
| * [Ninja](https://ninja-build.org/) | ||
| 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. | ||
|
|
||
| ## Cloning the repo | ||
|  | ||
|
|
||
| ```bash | ||
| $ git clone https://github.com/azure-rtos/levelx.git | ||
| ``` | ||
| > You will have to take the dependency graph above into account when building anything other than ThreadX itself. | ||
| ## Building as a static library | ||
| ### Building and using the library | ||
|
|
||
| Each component of Azure RTOS comes with a composible 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 command `add_subdirectory()`. | ||
| Instruction for building the LevelX 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. | ||
|
|
||
| While the typical usage pattern is to include threadx 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. | ||
| 1. Install the following tools: | ||
|
|
||
| ```bash | ||
| $ cmake -Bbuild -DCMAKE_TOOLCHAIN_FILE=cmake/cortex_m4.cmake -GNinja . | ||
| * [CMake](https://cmake.org/download/) version 3.0 or later | ||
| * [Arm GNU Toolchain for arm-none-eabi](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads) | ||
| * [Ninja](https://ninja-build.org/) | ||
|
|
||
| $ cmake --build ./build | ||
| ``` | ||
| 1. Build the [ThreadX library](https://github.com/azure-rtos/threadx#building-and-using-the-library) as the dependency. | ||
|
|
||
| NOTE: You will have to take the dependency graph above into account when building anything other than threadx itself. | ||
| 1. Cloning the repo. | ||
|
|
||
| # Repository Structure and Usage | ||
| ```bash | ||
| $ git clone --recursive https://github.com/azure-rtos/levelx.git | ||
| ``` | ||
|
|
||
| ## Branches & Releases | ||
| 1. Define the features and addons you need in `lx_user.h` and build together with the component source code. You can refer to [`lx_user_sample.h`](https://github.com/azure-rtos/levelx/blob/master/common/inc/lx_user_sample.h) as an example. | ||
|
|
||
| The master branch has the most recent code with all new features and bug fixes. It does not represent the latest General Availability (GA) release of the library. | ||
| 1. Building as a static library | ||
|
|
||
| ## Releases | ||
| 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 official release (preview or GA) will be tagged to mark the commit and push it into the Github releases tab, e.g. `v6.0-rel`. | ||
| While the typical usage pattern is to include LevelX 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. | ||
| ## Directory layout | ||
| An example of building the library for Cortex-M4: | ||
| ``` | ||
| - cmake | ||
| - common | ||
| - inc | ||
| - src | ||
| - samples | ||
| ``` | ||
| ```bash | ||
| $ cmake -Bbuild -GNinja -DCMAKE_TOOLCHAIN_FILE=cmake/cortex_m4.cmake . | ||
|
|
||
| # Security | ||
| $ cmake --build ./build | ||
| ``` | ||
|
|
||
| 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. | ||
| ## Professional support | ||
|
|
||
| # Licensing | ||
| [Professional support plans](https://azure.microsoft.com/support/options/) are available from Microsoft. For community support and others, see the [Resources](#resources) section below. | ||
|
|
||
| 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 file. If you are using hardware not defined in the LICENSED-HARDWARE.txt file or have licensing questions in general, please contact Microsoft directly at https://aka.ms/azrtos-license. | ||
| ## Licensing | ||
|
|
||
| # Contribution, feedback, issues, and professional support | ||
| 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. | ||
|
|
||
| If you encounter any bugs, have suggestions for new features, or if you would like to become an active contributor to this project, please follow the instructions provided in the contribution guideline for the corresponding repo. | ||
| ## Resources | ||
|
|
||
| For basic support, click Issues in the command bar or post a question to [Stack Overflow](http://stackoverflow.com/questions/tagged/azure-rtos+threadx) using the `threadx` and `azure-rtos` tags. | ||
| The following are references to additional Azure RTOS resources: | ||
|
|
||
| Professional support plans (https://azure.microsoft.com/en-us/support/options/) are available from Microsoft. | ||
| - **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/levelx/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 | ||
|
|
||
| You can also check [previous questions](https://stackoverflow.com/questions/tagged/azure-rtos+levelx) or ask new ones on StackOverflow using the `azure-rtos` and `levelx` 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. | ||
|
|
||
| # Additional Resources | ||
| ## Contribution | ||
|
|
||
| The following are references to additional Azure RTOS and Azure IoT in general: | ||
| | Content | Link | | ||
| |---|---| | ||
| | TraceX Installer | https://aka.ms/azrtos-tracex-installer | | ||
| | Azure RTOS Documentation and Guides: | https://docs.microsoft.com/azure/rtos | | ||
| | Azure RTOS Website: | https://azure.microsoft.com/services/rtos/ | | ||
| | Azure RTOS Sales Questions: | https://aka.ms/azrtos-license | | ||
| | Azure RTOS Product Support Policy | https://aka.ms/azrtos/lts | | ||
| | Azure RTOS Functional Safety Artifacts | https://aka.ms/azrtos/tuv | | ||
| | For technical questions check out Microsoft Q/A for Azure IoT | https://aka.ms/QnA/azure-rtos | | ||
| | Internet of Things Show for latest announcements and online training | https://aka.ms/iotshow | | ||
| | IoT Tech Community | https://aka.ms/community/azure-rtos | | ||
| Please follow the instructions provided in the [CONTRIBUTING.md](./CONTRIBUTING.md) for the corresponding repository. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters