search

chipsalliance / caliptra-rtl

HW Design Collateral for Caliptra RoT IP
Apache License 2.0
75 stars 38 forks source link

Register spec web page needed for 1.x #605

Open nquarton opened 4 weeks ago

nquarton commented 4 weeks ago

The register spec web page looks like it's starting to reflect 2.0 changes. I'm not able to find a reference for 1.1 and 1.0. I thought it might be https://chipsalliance.github.io/caliptra-rtl/patch_v1.1/internal-regs/?p= but that doesn't seem to exist.

Is it possible to have the register specs published from both the 1.0 and 1.1 branch?

nquarton commented 1 week ago

Just wanted to check if there is any idea when this could be addressed. (And if there is at least agreement this should continue to be supported for 1.x.)

calebofearth commented 1 week ago

Hey Nick, I agree this should be addressed but will have to be pushed out past the RTL feature freeze for 2.0.

This requires an update to the release checklist, plus we'll have to make a commit against the 1.X READMEs and workflow files once we have a fix in place, to point to the correct generated pages. If you want to take on this work, please feel free 😉

jhand2 commented 1 week ago

One possibility is during the workflow that generates the docs, we could checkout the 1.0 and 1.1 branches to also generate docs for those. But the workflow would still only exist on the main branch.

I looked into this a couple weeks ago, but I wasn't able to come up with a nice with to generate HTML to handle this. Ideally we would have a single page where you could select hw revision from a dropdown. But maybe we can do something more simple in the short term.