Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
d75a041
Add files via upload
Daniel-Lao77 May 22, 2026
8fc2cff
Delete docs/documentation/configuration/change-pristine.md
Daniel-Lao77 May 22, 2026
304fc10
Add files via upload
Daniel-Lao77 May 22, 2026
76d173e
Add files via upload
Daniel-Lao77 May 22, 2026
e1fc251
Create a
Daniel-Lao77 May 22, 2026
50bb6f4
Add files via upload
Daniel-Lao77 May 22, 2026
a2c0ad0
Delete docs/documentation/memory-analysis directory
Daniel-Lao77 May 22, 2026
9650393
Delete docs/documentation/static-code-analysis directory
Daniel-Lao77 May 22, 2026
f9ef321
Delete docs/documentation/analysis/a
Daniel-Lao77 May 22, 2026
08a20ce
Create a
Daniel-Lao77 May 22, 2026
1672b13
Add files via upload
Daniel-Lao77 May 22, 2026
782a388
Delete docs/documentation/analysis/memory-analysis/a
Daniel-Lao77 May 22, 2026
bfabaad
Create a
Daniel-Lao77 May 22, 2026
7accccd
Add files via upload
Daniel-Lao77 May 22, 2026
cb6e324
Delete docs/documentation/analysis/spdx/a
Daniel-Lao77 May 22, 2026
0585726
Create a
Daniel-Lao77 May 22, 2026
d66242d
Add files via upload
Daniel-Lao77 May 22, 2026
aa78c00
Delete docs/documentation/analysis/static-code-analysis/a
Daniel-Lao77 May 22, 2026
13e36d7
Add files via upload
Daniel-Lao77 May 22, 2026
13c8607
Add files via upload
Daniel-Lao77 May 22, 2026
5b2a940
Add files via upload
Daniel-Lao77 May 22, 2026
b67e067
Add files via upload
Daniel-Lao77 May 22, 2026
ab5b76a
Create a
Daniel-Lao77 May 22, 2026
db0fe5b
Add files via upload
Daniel-Lao77 May 22, 2026
05c1da6
Delete static/img/update/applications/a
Daniel-Lao77 May 22, 2026
d9dd6cd
Create a
Daniel-Lao77 May 22, 2026
3480e88
Add files via upload
Daniel-Lao77 May 22, 2026
4ad1cb9
Delete static/img/update/memory-analysis/a
Daniel-Lao77 May 22, 2026
944ce7a
Create a
Daniel-Lao77 May 22, 2026
46be856
Add files via upload
Daniel-Lao77 May 22, 2026
fc6af61
Delete static/img/update/workspace/a
Daniel-Lao77 May 22, 2026
75cca52
Add files via upload
Daniel-Lao77 May 22, 2026
72fcea7
Add files via upload
Daniel-Lao77 May 22, 2026
29714f0
Delete static/img/zw/zw_overview.png
Daniel-Lao77 May 22, 2026
984238c
Add files via upload
Daniel-Lao77 May 22, 2026
00e428e
Create a
Daniel-Lao77 May 22, 2026
4b1cc71
Add files via upload
Daniel-Lao77 May 22, 2026
d6b95c2
Delete static/img/zw/analysis/a
Daniel-Lao77 May 22, 2026
4767f5e
Create a
Daniel-Lao77 May 22, 2026
3e4b2ff
Delete static/img/zw/memory-analysis/a
Daniel-Lao77 May 22, 2026
291c8d8
Add files via upload
Daniel-Lao77 May 22, 2026
cde1ad6
Create a
Daniel-Lao77 May 22, 2026
1bb9384
Add files via upload
Daniel-Lao77 May 22, 2026
d52e262
Delete static/img/zw/spdx/a
Daniel-Lao77 May 22, 2026
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
9 changes: 9 additions & 0 deletions docs/documentation/analysis/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"label": "Analysis",
"position": 9,
"collapsed": true,
"link": {
"type": "generated-index",
"description": "Run Analysis tools"
}
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Memory Analysis",
"position": 7,
"position": 3,
"collapsed": true,
"link": {
"type": "generated-index",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 5
---
# Puncover

Expand All @@ -8,7 +8,7 @@ to provide a webpage view of the RAM, ROM and stack usage.

To run Puncover, right-click on the application > Memory Analysis > Puncover.

![Puncover menu](/img/zw/memory-analysis/zw_puncover-menu.png)
![Puncover menu](/img/update/memory-analysis/puncover_menu.png)

When the local web server is started, the webpage should automatically be opened.

Expand Down
36 changes: 36 additions & 0 deletions docs/documentation/analysis/memory-analysis/ram-plot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
sidebar_position: 3
---

# RAM Plot

The **RAM Plot** generates a graphical visualization of RAM memory usage for the selected application.

![RAM Plot Menu](/img/zw/memory-analysis/ramplot_menu.png)

It displays memory allocation as an interactive hierarchical chart, making it easier to identify which components consume RAM resources.

## Overview

The RAM Plot organizes memory usage into different sections and modules used by the application.

The visualization can include:

- **Kernel components**
- **Drivers**
- **Architecture-specific modules**
- **Libraries**
- **System components**
- **Application data**
- **Dependencies**

![RAM Plot](/img/zw/memory-analysis/ramplot.png)

Each section size is proportional to its memory usage, allowing users to quickly identify large RAM consumers.

## Features

- Visual representation of RAM allocation
- Hierarchical breakdown of memory usage
- Identification of large memory consumers
- Easy navigation through memory sections
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 1
The RAM Report lists all compiled objects and their RAM usage.
To display the application RAM Report, right-click on the application > Memory Analysis > RAM Report.

![RAM Report menu](/img/zw/memory-analysis/zw_ramreport-menu.png)
![RAM Report menu](/img/update/memory-analysis/ramreport_menu.png)

The report is displayed in the Terminal. The data are shown in a table and grouped based on the file
system location. It provides you the symbols size (in bytes) and its percentage usage.
Expand Down
36 changes: 36 additions & 0 deletions docs/documentation/analysis/memory-analysis/rom-plot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
sidebar_position: 4
---

# ROM Plot

The **ROM Plot** generates a graphical visualization of ROM/Flash memory usage for the selected application.

![ROM Plot Menu](/img/zw/memory-analysis/romplot_menu.png)

It displays how the generated binary is distributed among source files, libraries, drivers, dependencies, and system components.

## Overview

The ROM Plot provides a hierarchical view of Flash memory usage and helps users understand which components contribute to the final binary size.

The visualization may include:

- **Kernel modules**
- **Drivers**
- **Architecture components**
- **Libraries**
- **Dependencies**
- **Generated files**
- **Application code**

![ROM Plot](/img/zw/memory-analysis/romplot.png)

Each section represents its contribution to the overall binary size.

## Features

- Visual representation of Flash/ROM usage
- Hierarchical organization of components
- Binary size analysis
- Identification of large code contributors
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 2
The ROM Report lists all compiled objects and their ROM usage.
To display the application RAM Report, right-click on the application > Memory Analysis > RAM Report.

![RAM Report menu](/img/zw/memory-analysis/zw_romreport-menu.png)
![RAM Report menu](/img/update/memory-analysis/romreport_menu.png)

The report is displayed in the Terminal. The data are shown in a table and grouped based on the file
system location. It provides you the symbols size (in bytes) and its percentage usage.
Expand Down
9 changes: 9 additions & 0 deletions docs/documentation/analysis/spdx/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"label": "SPDX",
"position": 5,
"collapsed": true,
"link": {
"type": "generated-index",
"description": "Run SPDX analysis tools"
}
}
32 changes: 32 additions & 0 deletions docs/documentation/analysis/spdx/cve-bin-tool.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
sidebar_position: 3
---

# CVE Binary Tool

The **CVE Binary Tool** scans software components and binaries to identify known security vulnerabilities.

It compares detected components against public vulnerability databases and reports potential issues.

![CVE Binary Tool](/img/zw/spdx/cve-bin-tool.png)

## Overview

The CVE Binary Tool performs the following tasks:

- Scans generated binaries
- Identifies software components
- Retrieves vulnerability information
- Compares components against CVE databases
- Generates security analysis results

## Analysis Results

The output may include:

- Detected components
- Matching CVEs
- Vulnerability identifiers
- Severity information
- Database update information
- Scan status
34 changes: 34 additions & 0 deletions docs/documentation/analysis/spdx/ntia-checker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
sidebar_position: 1
---

# NTIA Checker

The **NTIA Checker** validates whether a generated Software Bill of Materials (SBOM) satisfies the minimum requirements defined by the National Telecommunications and Information Administration (NTIA).

It analyzes the generated SPDX data and reports missing or incomplete information.

![NTIA Checker](/img/zw/spdx/ntia-checker.png)

## Overview

The NTIA Checker verifies multiple SBOM elements, including:

- Component names
- Component versions
- Component identifiers
- Supplier information
- SBOM author information
- Creation timestamp
- Dependency relationships

The analysis result indicates whether the generated SBOM conforms to NTIA minimum requirements.

## Results

The output displays:

- Overall conformance status
- Validation result for each requirement
- Missing fields or incomplete information
- Pass or fail status for each element
37 changes: 37 additions & 0 deletions docs/documentation/analysis/spdx/sbom2doc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
sidebar_position: 2
---

# SBOM2Doc

The **SBOM2Doc** tool converts a generated SPDX Software Bill of Materials into a human-readable document.

It transforms raw SBOM information into a structured report that is easier to inspect and review.

![SBOM2Doc](/img/zw/spdx/sbom2doc.png)

## Overview

The generated document may contain:

- SBOM summary information
- Package information
- Component summaries
- License summaries
- Dependency information
- NTIA compliance information

The report presents software component data in a structured format.

## Generated Information

The output can include:

- SBOM file details
- Creator information
- Creation date
- Package list
- Package versions
- License information
- Component types
- Dependency relationships
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Static Code Analysis",
"position": 7,
"position": 4,
"collapsed": true,
"link": {
"type": "generated-index",
Expand Down
32 changes: 32 additions & 0 deletions docs/documentation/analysis/w_dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
sidebar_position: 2
---

# West Dashboard

The **West Dashboard** provides a web-based summary of the selected Zephyr application and its build environment.

![West Dashboard Menu](/img/zw/analysis/w_dashboard_menu.png)

It gives access to useful project information such as build attributes, memory reports, Kconfig data, system initialization details, device tree information, and ELF statistics.

![West Dashboard](/img/zw/analysis/w_dashboard.png)

## Overview

The West Dashboard contains several pages:

- **Home:** Displays the build summary, including Zephyr version, board, application path, build date, and selected toolchain.
- **Memory Report:** Shows detailed memory usage information for the application.
- **Kconfig:** Provides information about the application configuration.
- **Sys Init:** Displays system initialization information.
- **Device Tree:** Shows device tree-related information used by the build.
- **ELF Stats:** Displays statistics extracted from the generated ELF file.

## Build Summary

The main page displays:

- **Build Attributes:** Zephyr version, board, application path, build date, and toolchain.
- **Memory Summary:** Binary size, code size, read-only data, read/write data, and BSS.
- **Build Command:** Output directory and command used to build the application.
24 changes: 24 additions & 0 deletions docs/documentation/analysis/wb_dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
sidebar_position: 1
---

# Workbench Dashboard

The **Workbench Dashboard** provides a complete overview of the selected Zephyr application directly inside Visual Studio Code.

![Workbench Dashboard Menu](/img/zw/analysis/wb_dashboard_menu.png)

It displays build information, memory usage, generated artifacts, configuration files, and toolchain details.

![Workbench Dashboard](/img/zw/analysis/wb_dashboard.png)

## Overview

The Workbench Dashboard includes several sections:

- **Target:** Displays the selected application, board, SoC, CPU architecture, Zephyr version, and workspace status.
- **Memory:** Shows Flash and RAM usage.
- **Image:** Displays image size information such as binary size, text section, read-only data, read/write data, and BSS.
- **Toolchain:** Shows the selected toolchain, SDK version, build generator, West version, and build date.
- **Sources:** Provides quick access to configuration and device tree files.
- **Artifacts:** Lists generated build files such as ELF, BIN, HEX, and MAP files.
Loading