A simple script to create HTML from an SVD file

This is a simple script written in Rust language to create a single HTML file from an SVD file.

It's really simple and makes some assumptions (e.g. registers are 32 bit wide, the target is little endian etc.)

I created this for myself to make it easier to visually compare and inspect the contents of SVD files. But maybe it's useful to you.

It also omits a lot of things which I might or might not add in the future as needed by myself.

Please note that it will generate a huge HTML file which might bring your browser down on it's knees. Speaking of browsers: I only tested it with Chrome and I am really bad at HTML and CSS. So it might not look good in other browsers.

Also there is almost no error handling in place, currently. i.e. if an error occurs you won't get a nice error message but just some gibberish.

Installation

cargo install --path .

How to use

svd2html 

USAGE:
    svd2html --input <INPUT> --output <OUTPUT>

OPTIONS:
    -h, --help               Print help information
    -i, --input <INPUT>      
    -o, --output <OUTPUT>

Comments

Duplicated fields
I've been using this on the generated soc.svd in the betrusted repo: https://github.com/betrusted-io/xous-core/blob/main/precursors/soc.svd

It looks like every (edit: no, only the last?) field is shown twice. For example:

As far as I can see they're only once in the XML:

<fields> <field> <name>soc_reset</name> <msb>7</msb> <bitRange>[7:0]</bitRange> <lsb>0</lsb> </field> </fields>

Edit: ok, looking at it some more, my guess is that the unused bits in the field are labaled in the same way as the last field encountered.
opened by laanwj 4
Re-write using templates

Just wanted to upstream the changes I've made to this project. It's fairly usable in its current state, but could still use a bit of work. Let me know if you'd like any changes!

opened by jessebraham 1
Render fields' enumerated values when present

There aren't many of these in our SVDs yet, but there will be eventually. There are some for the ESP32, so I was able to verify using these. You can check out RTC_CNTL -> CLK_CONF to see this:

I also bumped all the dependencies, because why not.

opened by jessebraham 0