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.2.tar.gz (18.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.7.2-py3-none-any.whl (25.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for peakrdl_rust-0.7.2.tar.gz
Algorithm Hash digest
SHA256 9ed7cda530786c045347b9771cc0b0ece85965ba94f675a4786585fb699bbff5
MD5 8c17c3d44b3913442dfd043aa24365b2
BLAKE2b-256 91aea2fded540f18c77a488251dcb8ebf53cd947b633df5a0a17a509618c43e6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peakrdl_rust-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 56242c6244ddec782d23aa7b3cdb8f9beab2050393322044c651920789ba741a
MD5 5933c6b94d47192427b78297fb12d6a5
BLAKE2b-256 c1c3a99f7c433721948243e0dc6f2ed4f8253ae5f490d99463554ef7c421a509

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