README.md
1# Eclipse ThreadX USBX
2
3A high-performance USB host, device, and on-the-go (OTG) embedded stack, Eclipse ThreadX USBX is fully integrated with Eclipse ThreadX RTOS and available for all Eclipse ThreadX RTOS–supported processors. Like Eclipse ThreadX RTOS, Eclipse 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.
4
5Here are the key features and modules of USBX:
6
7
8
9## Getting Started
10
11Eclipse ThreadX USBX 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/azure-rtos/samples) using hero development boards from semiconductors you can build and test with.
14
15See [Overview of Eclipse ThreadX USBX](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/usbx/overview-usbx.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 USBX files
24 ├── ports # Architecture and compiler specific files
25 ├── samples # Sample codes
26 ├── support # Misc platform configurations file used by USBX
27 ├── LICENSE.txt # License terms
28 ├── LICENSE-HARDWARE.txt # Licensed hardware from semiconductors
29 ├── CONTRIBUTING.md # Contribution guidance
30 └── SECURITY.md # Repo security guidance
31
32### Branches & Releases
33
34The 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`.
35
36> 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.
37```
38/**************************************************************************/
39/* */
40/* FUNCTION RELEASE */
41/* */
42/* _tx_initialize_low_level Cortex-M23/GNU */
43/* 6.x */
44/* AUTHOR */
45/* */
46/* Scott Larson, Microsoft Corporation */
47/* */
48/* DESCRIPTION */
49/* */
50/* This function is responsible for any low-level processor */
51/* initialization, including setting up interrupt vectors, setting */
52/* up a periodic timer interrupt source, saving the system stack */
53/* pointer for use in ISR processing later, and finding the first */
54/* available RAM memory address for tx_application_define. */
55/* */
56/* INPUT */
57/* */
58/* None */
59/* */
60/* OUTPUT */
61/* */
62/* None */
63/* */
64/* CALLS */
65/* */
66/* None */
67/* */
68/* CALLED BY */
69/* */
70/* _tx_initialize_kernel_enter ThreadX entry function */
71/* */
72/* RELEASE HISTORY */
73/* */
74/* DATE NAME DESCRIPTION */
75/* */
76/* 09-30-2020 Scott Larson Initial Version 6.1 */
77/* xx-xx-xxxx Scott Larson Include tx_user.h, */
78/* resulting in version 6.x */
79/* */
80/**************************************************************************/
81```
82
83## Component dependencies
84
85The 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.
86
87
88
89> You will have to take the dependency graph above into account when building anything other than ThreadX itself.
90
91### Building and using the library
92
93Instruction for building the USBX 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.
94
951. Install the following tools:
96
97 * [CMake](https://cmake.org/download/) version 3.0 or later
98 * [Arm GNU Toolchain for arm-none-eabi](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads)
99 * [Ninja](https://ninja-build.org/)
100
1011. Build the [ThreadX library](https://github.com/eclipse-threadx/threadx#building-and-using-the-library) as the dependency.
102
1031. Cloning the repo.
104
105 ```bash
106 $ git clone https://github.com/eclipse-threadx/usbx.git
107 ```
108
1091. Define the features and addons you need in `ux_user.h` and build together with the component source code. You can refer to [`ux_user_sample.h`](https://github.com/eclipse-threadx/usbx/blob/master/common/core/inc/ux_user_sample.h) as an example.
110
1111. Building as a static library
112
113 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()`.
114
115 While the typical usage pattern is to include USBX 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.
116
117 An example of building the library for Cortex-M4:
118
119 ```bash
120 $ cmake -Bbuild -GNinja -DCMAKE_TOOLCHAIN_FILE=cmake/cortex_m4.cmake .
121
122 $ cmake --build ./build
123 ```
124
125## Licensing
126
127License 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.
128
129## Resources
130
131The following are references to additional Eclipse ThreadX resources:
132
133- **Product introduction**: https://github.com/eclipse-threadx/rtos-docs
134- **Product issues and bugs, or feature requests**: https://github.com/eclipse-threadx/usbx/issues
135- **TraceX Installer**: https://aka.ms/azrtos-tracex-installer
136
137You can also check [previous questions](https://stackoverflow.com/questions/tagged/azure-rtos+usbx) or ask new ones on StackOverflow using the `threadx` and `usbx` tags.
138
139## Security
140
141Eclipse 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.
142
143## Contribution
144
145Please follow the instructions provided in the [CONTRIBUTING.md](./CONTRIBUTING.md) for the corresponding repository.
146
