Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Overview.md #124

Merged
merged 3 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ARM.CMSIS-View.pdsc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<package schemaVersion="1.7.36" xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="https://raw.githubusercontent.com/Open-CMSIS-Pack/Open-CMSIS-Pack-Spec/v1.7.36/schema/PACK.xsd">
<vendor>ARM</vendor>
<name>CMSIS-View</name>
<description>Debugger visualization of software events and statistics</description>
<description overview="./Documentation/Overview.md">Debugger visualization of software events and statistics</description>
<url>https://www.keil.com/pack/</url>
<license>LICENSE</license>
<licenseSets>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 50 additions & 0 deletions Documentation/Overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Introduction

**CMSIS-View** provides software components and utilities that allow embedded software developers to analyze program execution flows, debug potential issues, and measure code execution times. The data can be observed in real-time in an IDE or can be saved as a log file during program execution.

CMSIS-View contains these components:

- [Event Recorder](https://arm-software.github.io/CMSIS-View/latest/evr.html) - lets you record event timing and data information while the program is executing.
- [Event Statistics](https://arm-software.github.io/CMSIS-View/latest/ev_stat.html) - allows you to collect and statistical data about the code execution.
- [eventlist utility](https://arm-software.github.io/CMSIS-View/latest/evntlst.html) - a command line tool for processing Event Recorder log files.
- [Component Viewer](https://arm-software.github.io/CMSIS-View/latest/cmp_viewer.html) - provides visibility to the user relevant static information of a software component or application program.
- [Fault](https://arm-software.github.io/CMSIS-View/latest/fault.html) - allows you to store, record, and analyze exception fault information.

For more information, please refer to:

- [Repository](https://github.com/ARM-software/CMSIS-View)
- [Documentation](https://arm-software.github.io/CMSIS-View/latest/index.html)

## CMSIS-View Introduction Webinar

Watch the [introduction webinar](https://developer.arm.com/Additional%20Resources/Video%20Tutorials/CMSIS-View%20and%20CMSIS-Compiler) to learn about CMSIS-View and how to use it.

[![Using CMSIS-View and CMSIS-Compiler Webinar](./Doxygen/src/images/webinar_video_preview.png)](https://developer.arm.com/Additional%20Resources/Video%20Tutorials/CMSIS-View%20and%20CMSIS-Compiler)

## Related CMSIS-Packs

The following CMSIS-Packs are maintained by Arm and related to CMSIS-View.

### CMSIS Component Packs

- [CMSIS-Compiler](https://www.keil.arm.com/packs/cmsis-compiler-arm): Retarget I/O functions of the standard C run-time library.
- [CMSIS-DSP](https://www.keil.arm.com/packs/cmsis-dsp-arm/): Optimized compute functions for embedded systems.
- [CMSIS-NN](https://www.keil.arm.com/packs/cmsis-nn-arm): Efficient and performant neural network kernels.

### Real-time Operating Systems

- [CMSIS-RTX](https://www.keil.arm.com/packs/cmsis-rtx-arm): Keil RTX5, a CMSIS-RTOS2 API compliant real-time operating system.
- [CMSIS-FreeRTOS](https://github.com/ARM-software/CMSIS-FreeRTOS): CMSIS-RTOS adaptation of FreeRTOS.
- [CMSIS-RTOS2 Validation](https://github.com/arm-software/CMSIS-RTOS2_Validation): Validation suite for RTOS2 compliant implementations.

### Middleware

- [MDK-Middleware](https://www.keil.arm.com/packs/mdk-middleware-keil): File system, network, and USB stacks.
- [CMSIS-mbedTLS](https://github.com/ARM-software/CMSIS-mbedTLS): Mbed TLS framed in a CMSIS-Pack.
- [SDS-Framework](https://github.com/ARM-software/SDS-Framework): Synchronous data streaming.

### Other Software Components

- [Cortex_DFP](https://github.com/ARM-software/CMSIS-DFP): Generic Arm Cortex-M device family pack.
- [CMSIS-Driver](https://github.com/ARM-software/CMSIS-Driver): MCU peripheral driver implementations.
- [CMSIS-Driver Validation](https://github.com/ARM-software/CMSIS-Driver_Validation/): Validation suite for CMSIS-Driver implementations.