Skip to content

Consider using packet diagrams to describe register contents #60

@glopesdev

Description

@glopesdev

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    proposalRequest for a new feature

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions