Adding wavedrom images of the encoding #18
Conversation
Nope. I do think this is needed however, and i had sent a mail to riscv-help earlier today |
for now, best thing during review is to build locally or to pase into https://wavedrom.com/editor.html |
|
Note that if you are building locally, be sure to do git submodule update --remote --init to pull in the submodule code or the local build will fail to find the theme and fonts. As for the wavedrom, if you add --verbose to the Makefile and build locally, it spits out these errors: asciidoctor: DEBUG: images/wavedrom/load_store_pair.adoc: line 4: unknown style for literal block: wavedrom I'm working on figuring out why. |
|
OK, all fixed up. I pushed to this PR. The latest GH Action build now includes the generated wavedrom diagrams. https://github.com/riscv/riscv-zilsd/actions/runs/9271407039 The Makefile was missing some build requirements. |
|
I have done a rework of the spec to get it closer to what current specifications look like. Previously, it was in the style of RV64 & RVC, as this is where the encodings come from. Please have a look. |
christian-herber-nxp
force-pushed
the
main
branch
from
b03cca2 to
5de1319
Compare
Signed-off-by: Christian Herber <[email protected]>
Added missing required extensions to the Makefile. Pointed docs-resources at latest version. Fixed heading levels in header.adoc.
…ed and complicated the build setup
- single page per instruction - just moving information, no content change
christian-herber-nxp
force-pushed
the
13-clarifications-of-the-instructions-in-the-specification
branch
from
b308e45 to
035e0cd
Compare
zilsd.adoc
Outdated
| {bits: 5, name: 'rd', type: 2, attr: ['5','dest≠0, dest[0]=0']}, | ||
| {bits: 1, name: 'imm', type: 3, attr: ['1','offset[5]']}, | ||
| {bits: 3, name: 'funct3', type: 8, attr: ['3','C.LDSP']}, |
There was a problem hiding this comment.
the value of this funct3 isn't specified anywhere, and similarly for the other instructions.
and the ≠ character doesn't render in the pdf.
I really think the encoding page needs to specify every bit in the binary encoding, including things like width=D, otherwise you have to look in another doc to see what the encoding is (or riscv-opcodes)
There was a problem hiding this comment.
i have updated the encoding to explicit in a025144.
I have no idea why the ≠ character does not render.
It might be my local setup, because it is done in the same way for C and there it renders.
There was a problem hiding this comment.
The not-equal sign was not rendering because the sans-serif font inclusion was commented out in the theme. I've updated docs-resources to fix this. I'll open an issue to update the docs-resources pointer.
There was a problem hiding this comment.
thanks
- Not all instructions are generally reserved in RV32 - Zcf has an overlap with Zcmlsd in RV32
|
I hope this has had sufficient review. Thanks for the work on this. If you still spot an issue, please flag in a new issue. |
christian-herber-nxp
deleted the
13-clarifications-of-the-instructions-in-the-specification
branch
No description provided.