README.md

# System Defiinition File Visualization: sdfvisio

This tool provesses an Arm Development Studio System Defenition file and provides a visual representation of the JTAG, DAP, trace, CTI and other topologies. We are displaying the topologgy as a box, funnel, or replicator based on the component type and connection lines between these components.
SDFvisio can export the created diagrams as PNG and SVG files using different color schema. 

## Authords and Acknowledgement
I'd like to thank Lewis Won and Tyler-Jay Osborne for the initial version of the sdfvisio tool.
Authors:
- Lewis Won
- Tyler-Jay Osborne
- Robert Wiesner

## License
The tool is licensed under Apache 2.0

# Dependency, build,  and installation

## External dependency
This tool is using PySide6 (https://pypi.org/project/PySide6/) as the user interface engine which is licend under LGPLv3/LGPLv2. The PiSide6 installation package are avaialbe under Windows, Mac, and Linux. The Pyside6 packages are automatically installed with the sdfvisio package
The build machanism is using the Python "build" package (https://pypi.org/project/build/)

## Build

How to build:
- Change to the source directory `<repo>/sdfvisio/src`
- Execute:  `python -m build`.
You find the WHL installation package under dist/sdfvisio-<version>-py3-none-any.whl. 

## Installation
Install this package using
`pip install dist/sdfvisio-<version>-py3-none-any.whl`

Note: you may need to update the `pip` install package; some users may require the additiona option --user:
- `python -m pip install --upgrade pip`
- `python -m pip install --user --upgrade pip`

# Usage
You can start the tool using the command line
- `python -m sdfvisio`
- `python -m sdfvisio <sdf files>`

After starting the tool, you can open additional SDF files.

## the command line options
| Option | Description | UI |
| -------- | ------------- | --- |
| -h | show this help message and exit| no |
| --help | show this help message and exit| no |
| --notopology NOTOPOLOGY | If the names are matching exclude these components from the topolgy view | no |
| --highlight HIGHLIGHT | if name matches, Comp:highlight the box, CompA:CompB: highlight patrh from compA to CompB | YES |
| --excluded | Add tab if excluded components exist | YES |
| --sinktop | start with trace sinks on top, the default is source on top, sink on the bottom row | YES |
| --addtf | add 'hidden' trace funnels | YES |
| --addtr | add 'hidden' trace replicator | YES |
| --widerect | draw wide rectange | YES |
| --oldlayout | use the layout with centered boxes | YES |
| --curve | use curved lines | YES |
| --shadow | enable shadow for boxes | YES |

The tool creates a tab for each opened SDF file. Each SDF tab is opening several tabs containing JTAG/SWD, DAP hierarchy, CortexTrace/ATB, CTITrigger and others. Most of the tabs contain a graphical representation, which can be exported as PNG or SVG. You can change the color theme: light, dark, and user based on your preference. Similar with the curved and shodow effect. 

## Settings
The Steetings are store in the 
## Example N1SDP trace topology:
1. Trace source and sink can be identifed by the different border color
1. Trace funnel and replicator a using a unique shape
1. The backgroiund color is related to the used access port in the SDF file
1. Unique connections are using the "first" color, while when a source or definitaion point is connect a second time, the "seconds" color is used. 
## Color Overview
| Color | Usage |
| ----- | ----- |
| foreground | default forground color |
| background | default background color |
| text color | element test color |
| first | first connection between two topology items |
| seconds | if the same source or destination point (component) is used a secondary time, this color is used |
| red | Background color used for device marked as exceluded |
| artcstf | background for artificial added Coresight Trace Funnel, not part of the SDF file |
| artrepl | background for artificial added Coresight Trace Funnel, not part of the SDF file |
| tracesink | border color of a trace sink |
| tracesource | border color of a trace source |
| defaultBorder | all other border color colors |
| ERRORtab | tab background if the tab text starts with "ERROR", created if reading the SDF file causes an error |
| INFOtab | tab background if the tab text starts with "INFO ", currently unused |
| highlight | bruch color to highlight trace path(s) |
| AP Red/Green/Blue | start, end, and step values for the AP color selection |

![SDV Viso Trace Topology](sdfvisio.jpg)


## Getting started

To make it easy for you to get started with GitLab, here's a list of recommended next steps.

Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!

## Add your files

- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:

```
cd existing_repo
git remote add origin https://git.gitlab.arm.com/application/sdfvisio.git
git branch -M main
git push -uf origin main
```

## Integrate with your tools

- [ ] [Set up project integrations](https://gitlab.arm.com/application/sdfvisio/-/settings/integrations)

## Collaborate with your team

- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)

## Test and Deploy

Use the built-in continuous integration in GitLab.

- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)

***

# Editing this README

When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.

## Suggestions for a good README

Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.

## Name
Choose a self-explaining name for your project.

## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.

## Contributing
State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.

## License
For open source projects, say how it is licensed.

## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.