/uC-OS3-Ozone

Segger Ozone μC/OS-III Kernel Awareness

Primary LanguageJavaScriptMIT LicenseMIT

Segger Ozone μC/OS-III Kernel Awareness

Enhancment to Segger Ozone allowing kernel awarness debugging for Micrium μC/OS-III.

Table of Contents

  1. Project Status
  2. Getting Started
    1. Dependencies
    2. Building
    3. Installation
    4. Usage
  3. Release Process
    1. Versioning
    2. Payload
  4. How to Get Help
  5. Further Reading
  6. Contributing
  7. License
  8. Authors
  9. Acknowledgements

Project Status

Plugin currently supports displaying information for the following

  1. Task(s)
  2. Timers(s)
  3. Queue(s)
  4. Mutex(s)
  5. Semaphore(s)
  6. Memory Partition(s)
  7. Flag Group(s)
  8. System Information

Back to top

Getting Started

The following section will discuss the steps required to get started setting up Segger Ozone and how to install the μC/OS-III kernel awareness plugin.

Dependencies

A recent version of Segger Ozone is required for using μC/OS-III kernel awareness plugin. The latest version can be obtained directly from Segger's website. Select a version of Ozone compatible with your operating system.

Getting the Source

Two methods are provided to obtain the kernel awareness plugin.

Stable Release

The latest stable release can always be found on GiHub Release page. Simply download and extract the zip to a location on your computer.

Development Version

The development version is hosted on GitHub and can be cloned directly using the following command:

git clone git@github.com:SDA-Labs/uC-OS3-Ozone.git

Installation

To use μC/OS-III kernel awareness plugin within Segger Ozone, first Ozone must be installed followed by placing μC/OS-III kernel awareness plugin in a specific installation directly.

Segger Ozone

After downloading Segger Ozone, follow the platform specific instructions for installing Ozone.

μC/OS-III Kernel Awareness Plugin

Windows

After Segger Ozone is installed, μC/OS-III kernel awareness plugin can be installed.

First close Segger Ozone if it is open. Next copy uC-OS3Plugin.js from the extracted zip file or cloned repository to Ozone's OS plugin folder. For Microsoft Windows this is normally found at <USER INSTALL PATH>\SEGGER\Ozone\Plugins\OS.

Usage

Enabling Kernel Awareness

Enabling kernel awareness debugging in Ozone requires first to load the plugin into Ozone, followed by enabling the plugin. Start Segger Ozone and enter the following into the console

Project.SetOSPlugin("uC-OS3Plugin")

Then press enter. If successful the console will output something similar to the following

Project.SetOSPlugin ("uC-OS3Plugin");
File name resolved: "uC-OS3Plugin.js" was found at "<USER INSTALL PATH>/SEGGER/Ozone/Plugins/OS/uC-OS3Plugin.js"
RTOS awareness plugin loaded: <USER INSTALL PATH>/SEGGER/Ozone/Plugins/OS/uC-OS3Plugin.js.

Next to enable the plugin, select uC-OS3 under the view menu.

View > Advanced > uC/OS-III

Upon selecting uC/OS-III, Ozone will default to displaying the task list within kernel awareness window.

Chang Displayed Data

μC/OS-III kernel awareness plugin is designed to show detailed information of the runtime performance of μC/OS-III when paused. Currently the following displays are supported

  1. Task(s)
  2. Timers(s)
  3. Queue(s)
  4. Mutex(s)
  5. Semaphore(s)
  6. Memory Partition(s)
  7. Flag Group(s)
  8. System Information

By default when activated only the task display will be shown. To enable additional displays, or remove a display, right click within the kernel awareness window and select one of the available options. If the option is enabled it will be disabled, otherwise the option will be enabled.

Back to top

Release Process

New releases will be made as bugs are fixed or new features are added. New releases will be tagged and made available through GitHub.

Versioning

This project uses the following format for versioning

MAJOR.MINOR

MAJOR will be update after addition of a new feature or enhancement and MINOR will be updated after a bug fix. An update to MAJOR will always reset MINOR to 0. Available versions can be viewed at the repository tag list.

How to Get Help

To request help, open a issue through GitHub Issues.

Contributing

New enhancements, features, and bug reports should be reported using GitHub Issues.

Back to top

Further Reading

Segger Ozone

μC/OS-III

Miscellaneous

Back to top

License

Copyright (c) 2021 SDA Labs

This project is licensed under the MIT License - see LICENSE.md file for details.

Back to top

Authors

Back to top