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

Document relationship between svd xml and h #8

Open
spth opened this issue Apr 11, 2021 · 3 comments
Open

Document relationship between svd xml and h #8

spth opened this issue Apr 11, 2021 · 3 comments

Comments

@spth
Copy link

spth commented Apr 11, 2021

This repository contains .svd, .sxml and .h files.

Over at SourceForge, there is a ticket for adding the headers to SDCC: https://sourceforge.net/p/sdcc/patches/367/
If SDCC would add the h files, would those be the preferred form for modification?

What is the relation between the svd, xml and h files? Which are generated from which using which tool? Which is the preferred form for making modifications?

@gicking
Copy link
Owner

gicking commented Apr 17, 2021

After careful consideration I have decided to re-structure the XML and the derived .h and .SVD files.

Currently the creation of the XMLs is quite messy and takes a multitude of (badly documented) input formats. Correcting them in case of errors, like the one described in issue #6, is a pain in the backside, as doing it manually is virtually impossible for the 178 individual files. Therefore I now plan to change this to a more module based and more manual approach.

As a positive side effect I can make the register names more consistent. By the automatic generation I found this is not always guaranteed, but with a manual approach I can make sure of this.

Another positive side effect will be that I plan to improve the documentation of the XML, header and SVD creation and input files (all in Python). And these I plan to publish on Github for review and improvement. The current code is just too messy!

Please bear with me that this will take some time, as I also will need to carefully check the consistency across DS, UM, SPL and IAR. Yippie... ;-(

@prosper00
Copy link

Appreciate the effort , and look forward to seeing the results.

@gicking
Copy link
Owner

gicking commented Apr 23, 2021

I can promise one thing: progress will be slow... ;-)

@gicking gicking closed this as completed Apr 23, 2021
@gicking gicking reopened this Apr 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants