Skip to content

Commit 695730e

Browse files
authored
Merge pull request #146 from eclipse-threadx/wickste-patch-4
Update README.md
2 parents 6b5c8a7 + 8acb58c commit 695730e

File tree

2 files changed

+18
-26
lines changed

2 files changed

+18
-26
lines changed

README.md

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

3-
A high-performance USB host, device, and on-the-go (OTG) embedded stack, Azure RTOS USBX is fully integrated with Azure RTOS ThreadX and available for all Azure RTOS ThreadX–supported processors. Like Azure RTOS ThreadX, Azure RTOS 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.
3+
A 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.
44

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

77
![USBX Key Features](./docs/usbx-features.png)
88

99
## Getting Started
1010

11-
Azure RTOS USBX 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+
Eclipse 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).
1212

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

15-
See [Overview of Azure RTOS USBX](https://learn.microsoft.com/azure/rtos/usbx/overview-usbx) for the high-level overview, and all documentation and APIs can be found in: [Azure RTOS USBX documentation](https://learn.microsoft.com/azure/rtos/usbx/).
15+
See [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.
1616

1717
## Repository Structure and Usage
1818

@@ -27,7 +27,7 @@ See [Overview of Azure RTOS USBX](https://learn.microsoft.com/azure/rtos/usbx/ov
2727
├── LICENSE.txt # License terms
2828
├── LICENSE-HARDWARE.txt # Licensed hardware from semiconductors
2929
├── CONTRIBUTING.md # Contribution guidance
30-
└── SECURITY.md # Microsoft repo security guidance
30+
└── SECURITY.md # Repo security guidance
3131

3232
### Branches & Releases
3333

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

8383
## Component dependencies
8484

85-
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.
85+
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.
8686

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

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

93-
Instruction 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 Azure RTOS components as explained in the [Getting Started](#getting-started) section.
93+
Instruction 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.
9494

9595
1. Install the following tools:
9696

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

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

103103
1. Cloning the repo.
104104

105105
```bash
106-
$ git clone https://github.com/azure-rtos/usbx.git
106+
$ git clone https://github.com/eclipse-threadx/usbx.git
107107
```
108108

109-
1. 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/azure-rtos/usbx/blob/master/common/core/inc/ux_user_sample.h) as an example.
109+
1. 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.
110110

111111
1. Building as a static library
112112

113-
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()`.
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()`.
114114
115115
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.
116116
@@ -122,31 +122,23 @@ Instruction for building the USBX as static library using Arm GNU Toolchain and
122122
$ cmake --build ./build
123123
```
124124

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

131-
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.
127+
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.
132128

133129
## Resources
134130

135-
The following are references to additional Azure RTOS resources:
131+
The following are references to additional Eclipse ThreadX resources:
136132

137-
- **Product introduction and white papers**: https://azure.com/rtos
138-
- **General technical questions**: https://aka.ms/QnA/azure-rtos
139-
- **Product issues and bugs, or feature requests**: https://github.com/azure-rtos/usbx/issues
140-
- **Licensing and sales questions**: https://aka.ms/azrtos-license
141-
- **Product roadmap and support policy**: https://aka.ms/azrtos/lts
142-
- **Blogs and videos**: http://msiotblog.com and https://aka.ms/iotshow
143-
- **Azure RTOS TraceX Installer**: https://aka.ms/azrtos-tracex-installer
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
144136

145-
You can also check [previous questions](https://stackoverflow.com/questions/tagged/azure-rtos+usbx) or ask new ones on StackOverflow using the `azure-rtos` and `usbx` tags.
137+
You 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.
146138

147139
## Security
148140

149-
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.
141+
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.
150142

151143
## Contribution
152144

docs/usbx-features.png

-49.2 KB
Loading

0 commit comments

Comments
 (0)