Skip to main content

Generate a Rust module from SystemRDL for accessing control/status registers.

Project description

PeakRDL-rust

Coverage Status

Generate Rust code for accessing control/status registers from a SystemRDL description.

This is currently in a beta state. Feel free to try it out and report any bugs encountered.

For documentation including API reference, configuration options, and detailed examples, visit:

PeakRDL-rust Documentation on Read the Docs

Installation

It can be installed from PyPI using

pip install peakrdl-rust[cli]

Usage

For usage available options, use

peakrdl rust --help

TODO

  • Arrays
  • Enum encoding
  • Reg impl with regwidth != accesswidth
  • Impl Default for registers
  • Test generator
  • Add field constants (width, offset, etc.)
  • Impl Debug for registers
  • Add ARCHITECTURE.md
  • Find/generate additional test input
  • Mem components
  • More efficient field tests
  • Set up github actions/PyPI publishing
  • Fixedpoint/signed UDPs
  • Rust keyword conflict test
  • Unwrap encoded field enums if exhaustive
  • Restrict read/write to memories
  • Add examples to docs
  • Regwidth > native integer types

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

peakrdl_rust-0.6.1.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

peakrdl_rust-0.6.1-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

Details for the file peakrdl_rust-0.6.1.tar.gz.

File metadata

  • Download URL: peakrdl_rust-0.6.1.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.2

File hashes

Hashes for peakrdl_rust-0.6.1.tar.gz
Algorithm Hash digest
SHA256 292b82652ef998dbba76b518720e6f81c2b007fc9da870ee6306cf46515fb676
MD5 d8712080e0220378ddf68609dd8911d3
BLAKE2b-256 6fee50be38fe01242c84dc4ddd18a1d9f06e999e5a0b0296ca8a1c89ec245090

See more details on using hashes here.

File details

Details for the file peakrdl_rust-0.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for peakrdl_rust-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8e0b13000417f470717970c763fd2574a17f2740993f0dce9549184c3172c278
MD5 048a343bd7fe4d5a9efdf760da649fa5
BLAKE2b-256 a48fc039d3573771f0a5f47fde069973c46fbdb465bf9c57da6494ea3dbfe8d5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page