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.3.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.3-py3-none-any.whl (25.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: peakrdl_rust-0.7.3.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.3.tar.gz
Algorithm Hash digest
SHA256 602ad9ec41987ad8a2734772c807296a05b664daea7f0db37969ad01f8d62f29
MD5 321b1426f99e3ff8fb8e2d059414c07a
BLAKE2b-256 155ea2a7fafda6a7e7a60af038ed50a5ca8ac7f577bbe67305eb636a70ef2923

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peakrdl_rust-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b0eed1d1bec954297106e4094f5389c8687dc81e8067ccd640e5ba7352bfa523
MD5 7db0487204ae5ff1d045f5d1aae636ba
BLAKE2b-256 70acbc7360ccfc56cf98989ce0047d80aaad406262db0902b6c1941fa795353d

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