Skip to content

v0.1.0

Choose a tag to compare

@mtravaillard mtravaillard released this 25 Sep 13:10
· 11 commits to main since this release

Initial release

First public release of xactflow-sv, a XactFlow importer plugin that reads a SystemVerilog module plus a JSON metadata file (and, optionally, a SystemRDL register map) and produces an ipxact.Component object, built on ipxact-compiler's IEEE 1685-2022 object model.

What's included

  • SystemVerilog module header parsing (via pyslang, no elaboration, no package loading, no symbol resolution) into ipxact.Component: wire, struct-typed, and SV interface-typed ports, module and component parameters, all built directly against ipxact-compiler's dataclasses rather than XML.
  • Metadata-driven bus interface mapping: discrete port mappings, dotted port.field references into struct-typed ports, and SV interface-typed ports that already group their own signals.
  • SystemRDL register map conversion, via systemrdl-compiler/peakrdl-ipxact, into ipxact.MemoryMap/AddressBlock/Register/Field.
  • Registered under the xactflow.importers entry point as sv, so it's usable end to end straight from XactFlow's CLI: xactflow sv module.sv --option metadata=... --then component --output out/ (requires xactflow>=0.1.2), chaining directly into an installed exporter such as xactflow-component in the same process.
  • Fails loudly instead of silently dropping data: SystemVerilog or SystemRDL constructs this package doesn't yet support raise NotImplementedError/ValueError naming exactly what's unsupported, rather than producing a Component that quietly leaves something out.

Status

This is an early, alpha-stage release. register_map.py reads peakrdl-ipxact's own XML output through a dedicated reader rather than ipxact-compiler's parser, a deliberate keep-it-simple choice, not necessarily a permanent one. A number of SystemVerilog and SystemRDL constructs are intentionally not supported yet: explicit ANSI ports and non-ANSI port lists, indexed part-selects ([base+:width]), register/register-file arrays, ispresent = false, and a few others. See the README for the full list of known limitations and what's planned next.

License

LGPL-3.0. See LICENSE.

Full Changelog: https://github.com/IP-XACT/XactFlow-sv/commits/v0.1.0