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

Consider using packet diagrams to describe register contents #60

Open
glopesdev opened this issue Nov 14, 2024 · 0 comments
Open

Consider using packet diagrams to describe register contents #60

glopesdev opened this issue Nov 14, 2024 · 0 comments
Labels
proposal Request for a new feature

Comments

@glopesdev
Copy link
Collaborator

glopesdev commented Nov 14, 2024

This would replace the currently used Gantt diagrams. Example for the R_OPERATION_CTRL register:

---
title: "R_OPERATION_CTRL"
---
%%{
    init: {
        "packet": {
            "bitWidth": 80,
            "bitsPerRow": 8
        }
    }
}%%
packet-beta
  0-1: "OP_MODE"
  2: "-"
  3: "DUMP"
  4: "MUTE_RPL"
  5: "VISUALEN"
  6: "OPLEDEN"
  7: "ALIVE_EN"
Loading

One potentially big disadvantage is packet diagrams go from LSB to MSB (the reverse of the current diagrams). Also not very happy with the excessive blank vertical padding in this simple example, although potentially this could be fixed.

They are also lacking the flexibility to easily represent default bit values and implementation "flags". We could use alternative ways to represent these, as it may be confusing to actually pack both spec and defaults into the same diagram, so perhaps these could go into a separate table or bullet list below.

@glopesdev glopesdev added the proposal Request for a new feature label Nov 14, 2024
@glopesdev glopesdev changed the title Consider replacing mermaid gantt diagrams with packet diagrams to describe register contents Consider using packet diagrams to describe register contents Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal Request for a new feature
Projects
None yet
Development

No branches or pull requests

1 participant