README.md
1# Eclipse ThreadX FileX
2
3This 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.
4
5Here are the key features and modules of FileX:
6
7
8
9## Getting Started
10
11FileX 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).
12
13We also provide [samples](https://github.com/eclipse-threadx/samples) using hero development boards from semiconductors you can build and test with.
14
15See [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.
16
17## Repository Structure and Usage
18
19### Directory layout
20
21 .
22 ├── cmake # CMakeList files for building the project
23 ├── common # Core FileX files
24 ├── ports # Architecture and compiler specific files
25 ├── samples # Sample codes
26 ├── LICENSE.txt # License terms
27 ├── LICENSE-HARDWARE.txt # Licensed hardware from semiconductors
28 ├── CONTRIBUTING.md # Contribution guidance
29 └── SECURITY.md # Repo security guidance
30
31### Branches & Releases
32
33The 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`.
34
35> When you see xx-xx-xxxx, 6.x or x.x in function header, this means the file is not officially released yet. They will be updated in the next release. See example below.
36```
37/**************************************************************************/
38/* */
39/* FUNCTION RELEASE */
40/* */
41/* _tx_initialize_low_level Cortex-M23/GNU */
42/* 6.x */
43/* AUTHOR */
44/* */
45/* Scott Larson, Microsoft Corporation */
46/* */
47/* DESCRIPTION */
48/* */
49/* This function is responsible for any low-level processor */
50/* initialization, including setting up interrupt vectors, setting */
51/* up a periodic timer interrupt source, saving the system stack */
52/* pointer for use in ISR processing later, and finding the first */
53/* available RAM memory address for tx_application_define. */
54/* */
55/* INPUT */
56/* */
57/* None */
58/* */
59/* OUTPUT */
60/* */
61/* None */
62/* */
63/* CALLS */
64/* */
65/* None */
66/* */
67/* CALLED BY */
68/* */
69/* _tx_initialize_kernel_enter ThreadX entry function */
70/* */
71/* RELEASE HISTORY */
72/* */
73/* DATE NAME DESCRIPTION */
74/* */
75/* 09-30-2020 Scott Larson Initial Version 6.1 */
76/* xx-xx-xxxx Scott Larson Include tx_user.h, */
77/* resulting in version 6.x */
78/* */
79/**************************************************************************/
80```
81
82## Component dependencies
83
84The 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.
85
86
87
88> You will have to take the dependency graph above into account when building anything other than ThreadX itself.
89
90### Building and using the library
91
92Instruction 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.
93
941. Install the following tools:
95
96 * [CMake](https://cmake.org/download/) version 3.0 or later
97 * [Arm GNU Toolchain for arm-none-eabi](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads)
98 * [Ninja](https://ninja-build.org/)
99
1001. Build the [ThreadX library](https://github.com/eclipse-threadx/threadx#building-and-using-the-library) as the dependency.
101
1021. Cloning the repo.
103
104 ```bash
105 $ git clone https://github.com/eclipse-threadx/filex.git
106 ```
107
1081. 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.
109
1101. Building as a static library
111
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()`.
113
114 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.
115
116 An example of building the library for Cortex-M4:
117
118 ```bash
119 $ cmake -Bbuild -GNinja -DCMAKE_TOOLCHAIN_FILE=cmake/cortex_m4.cmake .
120
121 $ cmake --build ./build
122 ```
123
124## Licensing
125
126License 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.
127
128## Resources
129
130The following are references to additional Eclipse ThreadX resources:
131
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
135
136You 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.
137
138## Security
139
140Eclipse 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.
141
142## Contribution
143
144Please follow the instructions provided in the [CONTRIBUTING.md](./CONTRIBUTING.md) for the corresponding repository.
145
