From 1b5cf8207fcd9e2dc9d8e01ee8f1402d373fe534 Mon Sep 17 00:00:00 2001 From: Stefan Wick Date: Tue, 20 Feb 2024 22:45:24 -0800 Subject: [PATCH] Update README.md --- README.md | 33 +++++++++++++-------------------- 1 file changed, 13 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 20f3cc2..41aa050 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# Azure RTOS TraceX +# Eclipse ThreadX TraceX -Azure RTOS TraceX is Microsoft's host-based analysis tool that provides developers with a graphical view of real-time system events and enables them to visualize and better understand the behavior of their real-time systems. With Azure RTOS TraceX, developers can see clearly the occurrence of system events like interrupts and context switches that occur out of view of standard debugging tools. The ability to identify and study these events, and to pinpoint the timing of their occurrence in the context of the overall system’s operation enables developers to resolve programming problems by finding unexpected behavior and letting them investigate specific areas further Trace information is stored in a buffer on the target system, with the buffer location and size determined by the application at run-time. Azure RTOS TraceX can process any buffer constructed in the proper manner, not only from Azure RTOS ThreadX, but from any application or RTOS. The trace information may be uploaded to the host for analysis at any time – either post mortem or upon a breakpoint. Azure RTOS ThreadX implements a circular buffer, which enables the most recent “N” events to be available for inspection in the event of system malfunction or other significant event. +Eclipse ThreadX TraceX is a host-based analysis tool that provides developers with a graphical view of real-time system events and enables them to visualize and better understand the behavior of their real-time systems. With TraceX, developers can see clearly the occurrence of system events like interrupts and context switches that occur out of view of standard debugging tools. The ability to identify and study these events, and to pinpoint the timing of their occurrence in the context of the overall system’s operation enables developers to resolve programming problems by finding unexpected behavior and letting them investigate specific areas further Trace information is stored in a buffer on the target system, with the buffer location and size determined by the application at run-time. TraceX can process any buffer constructed in the proper manner, not only from Eclipse ThreadX RTOS, but from any application or RTOS. The trace information may be uploaded to the host for analysis at any time – either post mortem or upon a breakpoint. Eclipse ThreadX RTOS implements a circular buffer, which enables the most recent “N” events to be available for inspection in the event of system malfunction or other significant event. -The Azure RTOS TraceX installer is available here: https://aka.ms/azrtos-tracex-installer. +The Eclipse ThreadX TraceX installer is available here: https://aka.ms/azrtos-tracex-installer. ## Getting Started -See [Overview of TraceX](https://learn.microsoft.com/en-us/azure/rtos/tracex/overview-tracex) for the high-level overview, and all documentation can be found in: [Azure RTOS TraceX documentation](https://learn.microsoft.com/en-us/azure/rtos/tracex/). +See [Overview of TraceX](https://github.com/eclipse-threadx/rtos-docs/blob/main/rtos-docs/tracex/overview-tracex.md) for the high-level overview. ## Repository Structure and Usage @@ -18,7 +18,7 @@ See [Overview of TraceX](https://learn.microsoft.com/en-us/azure/rtos/tracex/ove ├── 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 @@ -82,7 +82,7 @@ You can obtain the TraceX app from the [Microsoft App Store](https://microsoft.c 1. When the install finishes, choose the **Launch** button. -### Use of Azure RTOS TraceX +### Use of Eclipse ThreadX TraceX Using TraceX is as easy as opening a trace file inside TraceX! Run TraceX via the ***Start*** button. At this point you will observe the TraceX graphic user interface (GUI). You are now ready to use TraceX to graphically view an existing target trace buffer. This is easily done by clicking ***File -> Open,*** then entering the binary trace file. >[!IMPORTANT] @@ -90,30 +90,23 @@ Using TraceX is as easy as opening a trace file inside TraceX! Run TraceX via th ![Screenshot of the TraceX GUI.](./docs/tracex_gui.png) -## 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/tracex/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 +- **Product introduction**: https://github.com/eclipse-threadx/rtos-docs +- **Product issues and bugs, or feature requests**: https://github.com/eclipse-threadx/tracex/issues +- **TraceX Installer**: https://aka.ms/azrtos-tracex-installer -You can also check [previous questions](https://stackoverflow.com/questions/tagged/azure-rtos+tracex) or ask new ones on StackOverflow using the `azure-rtos` and `tracex` tags. +You can also check [previous questions](https://stackoverflow.com/questions/tagged/azure-rtos+tracex) or ask new ones on StackOverflow using the `threadx` and `tracex` 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