Regvue

A modern web-based viewer for FPGA/ASIC register documentation.

Note	This repository is in the process of being migrated from JPL GitHub Enterprise to github.com. The Git repository has been migrated but the issues, pull requests, and releases have not.

Table of Contents

• Screenshot
• Demos
• Generate the Register Description
• Install Regvue
• Load a Register Description
  • Via a URL (Preferred)
  • Via the Filesystem

Screenshot

Disclaimer: Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise, does not constitute or imply its endorsement by the United States Government or the Jet Propulsion Laboratory, California Institute of Technology.

Demos

• Basic demo

• Multi-SoC

• FE310 SoC

• Betrusted SoC

Generate the Register Description

Generate the Regvue JSON according to the Register Description Format.

Install Regvue

The preferred method of installing Regvue is to not install it at all. Instead, use an existing deployment of Regvue managed by the Regvue team.

The latest deployment is https://nasa-jpl.github.io/regvue/v1/#/

Load a Register Description

Register descriptions can be loaded via the filesystem or via a URL.

Via a URL (Preferred)

URLs can be created that automatically load a hosted register description into Regvue.

For example,

• the v1 deployment: https://nasa-jpl.github.io/regvue/v1/#/

• and the demo register description: https://nasa-jpl.github.io/regvue/v1/example.json

• can be paired as: https://nasa-jpl.github.io/regvue/v1/#/?data=https://nasa-jpl.github.io/regvue/v1/example.json

Via the Filesystem

Open Regvue and and load a register descriptions by dragging-and-dropping a register description JSON into Regvue or by using the file open dialog.