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

Replacing opcode images by Wavedrom snippets #6

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

nibrunieAtSi5
Copy link
Contributor

No description provided.

@wmat
Copy link

wmat commented Dec 10, 2024

Can you name the new images with a .edn extension to align with the way it's done in riscv-isa-manual? These aren't really adoc files.

@nibrunieAtSi5
Copy link
Contributor Author

@wmat : I am not sure I am following: my PR removed the image files and introduced the wavedrom snippets into each of the instruction .adoc.

IIRC riscv-isa-manual has also switched to incorporating the instruction descriptions directly in the extension chapter rather in separate files, I may have to do this as well.

@wmat
Copy link

wmat commented Dec 16, 2024

I don't believe we've switched to including the wavedrom as snippets directly in the .adoc. Was there a thread about this somewhere? riscv-isa-manual still uses separate .adoc files.

@nibrunieAtSi5
Copy link
Contributor Author

I don't believe we've switched to including the wavedrom as snippets directly in the .adoc. Was there a thread about this somewhere? riscv-isa-manual still uses separate .adoc files.

Looking at the official ratified vector crypto spec for example:
https://github.com/riscv/riscv-isa-manual/blob/472a62018afbd14e24e18b2583546dfa61d6ba0c/src/vector-crypto.adoc#L1198-L1210

Encoding (Vector-Vector)::
[wavedrom, , svg]
....
{reg:[
{bits: 7, name: 'OP-VE'},
{bits: 5, name: 'vd'},
{bits: 3, name: 'OPMVV'},
{bits: 5, name: '00001'},
{bits: 5, name: 'vs2'},
{bits: 1, name: '1'},
{bits: 6, name: '101000'},
]}
....

This is what I could find, so I thought this was supposed to be the new way.

@wmat
Copy link

wmat commented Dec 16, 2024

I don't think we've ever landed on a preferred way tbh. When I took over the doc conversions the method of including wavedrom as separate files was the method being used. For the riscv-isa-manual specifically we are using bytefield-svg encoding of diagrams as well which I believe require using #include macros in the .adoc files. Let me look into this more as I'd actually prefer not to use includes.

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

Successfully merging this pull request may close these issues.

2 participants