Skip to content

v0.1.0

Choose a tag to compare

@mtravaillard mtravaillard released this 16 Oct 15:09
· 18 commits to main since this release

First public release of xactflow-archidesc, a XactFlow importer plugin that turns a design
described in a Python script (its IP instances, bus connections and port connections) into an
IEEE 1685-2022 ipxact.Design object.

What's included

  • A Design API for design scripts: add_ip() to add IP instances from an IP-XACT library,
    connect_bus() to connect bus interfaces, and connect() to connect ports directly.
  • add_ip() resolves each VLNV right away, records parameter overrides as
    configurableElementValues (only for resolve="user" parameters, as the standard requires),
    and records requested transformations for a separate transformer tool to apply.
  • connect_bus() picks matching initiator/target interfaces by itself, connects the other
    modes (mirrored, system, monitor) when they are named, and can record a target's address
    with base_addr/size.
  • connect() checks port directions, refuses a second driver on an input, and gives every
    connection a unique name.
  • Clear errors on the line that made the mistake: unknown VLNVs, parameters or ports,
    duplicate names, interfaces already used, or more than one possible bus pair.
  • ArchiDescImporter, registered under the xactflow.importers entry point, so
    xactflow archidesc design.py runs a script from the CLI, and --then design exports the
    result to XML through xactflow-design.
  • A test suite that includes an end-to-end run of the example: import, elaborate() with no
    diagnostics, export to XML with xactflow-design, and read the file back.

Status

This is an early, alpha-stage release. The format description in doc/ describes the tool as
it is meant to work once finished. The known differences are listed in the README: bus type
parameter values are not compared yet, elaborate() does not apply parameter overrides yet,
only wire ports are checked in detail, and port widths are not compared. Hierarchical designs
and a real address mapping are planned for later.

License

LGPL-3.0.

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