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.7.1.tar.gz (17.4 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.7.1-py3-none-any.whl (24.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for peakrdl_rust-0.7.1.tar.gz
Algorithm Hash digest
SHA256 65664281634d966dbc4f8c8966e2bbf75ff051eb7fe742d49cc3f2e31747fe1a
MD5 917c4b9aa77fb30e1ac54b08f1ebcfd0
BLAKE2b-256 4719e524909e88a862394c14eb4e38eb24ad3a83b78215a4406bf8792b358990

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peakrdl_rust-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f285b85d336908e6fcd2845d648714c3f6e8315df6beb19595ee3eb5caf72d53
MD5 3b5361b34587912893173a8c5d7436da
BLAKE2b-256 c4b7fc007de9d23add9d27e11995b1f402bf52ee68f8a3b942c64394298ad7ad

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