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

Uploaded Python 3

File details

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

File metadata

  • Download URL: peakrdl_rust-0.7.0.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.0.tar.gz
Algorithm Hash digest
SHA256 ddc37b8198e2a79242a8b1ec6fca2d15137af88846b6cb6ae34f464298755c7a
MD5 de0732f53cebe4dd4506604acfa1238a
BLAKE2b-256 92f60a09e022b48f4b1adcb60b90fa3e8f2b98f58f075a4fea2cb5c5c143a234

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for peakrdl_rust-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8b362501bcd6f7112f2656b8cf0152b5e91b6e1e2ed81c9c3ec4cd75d7758884
MD5 f6d97e667eae95631b7f661ff528e97d
BLAKE2b-256 852783f539dfc7d35603b66e211c535d36c80258514d9c75213ce5b2d25c37bf

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