# ipxact2verilog

> Generate Verilog module from IP-XACT definition

- Catalog id: `Ipxact2Verilog`; bundle: `ipxact2verilog`; latest version 20261018
- Documentation page: https://edautils.com/ip-xact.html
- Keywords: IP-XACT to Verilog, module generator, IEEE 1685, RTL from IP-XACT
- Terms: as stated on edautils.com, EDAUtils tools are free for commercial and academic use, with no license server. The bundle's own metadata says: "Free to evaluate with the bundled licence; commercial licences from help@edautils.com". Licence prerequisites per tool are under "How an agent runs it".
- This file: https://edautils.com/capabilities/ipxact2verilog.md

## Downloads

- EDAUtils download site: https://edautils.ai/download/Ipxact2Verilog (latest file `ipxact2verilog-20261018.tar.gz`)
- SourceForge: https://sourceforge.net/projects/edautils-converters/files/ipxact2verilog/
- SourceForge: https://sourceforge.net/projects/ip-xact-tools/files/ipxact2verilog/
- GitHub Releases: https://github.com/edautils/releases/releases/download/RELEASE_20261018/ipxact2verilog-20261018.tar.gz (release `RELEASE_20261018`; all releases: https://github.com/edautils/releases/releases)

## How an agent runs it

The following is the AGENTS.md shipped at the root of the bundle.

Converts IP-XACT to Verilog/SystemVerilog. Component XMLs (`-components`) become modules with
their ports and parameters; a Design XML (`-design`) becomes a netlist module that
instantiates the referenced components; Abstraction Definition XMLs (`-abstractiondef2009`,
`-abstractiondef2014`, `-abstractiondef2022`) become SystemVerilog interfaces. Everything is
written into one file (default `output.v`): interfaces first, then each top module preceded by
its sub-modules. IP-XACT 1685-2009, 2014 and 2022 inputs are accepted. Main class:
`com.eu.miscedautils.shell.ipxact2verilog` (jar `lib/designplayer.jar`).

### Where it ships

Its own bundle, `ipxact2verilog.tar.gz` (flow `ipxact2verilog`; release tree
`release_scripts/ipxact2verilog/1.0`), and as a point tool in the **ipxact-shell**, **baya-shell**
and **designplayer-shell** bundles (`bin/ipxact2verilog` running the shell's jar; this guide as
`tools/ipxact2verilog/AGENTS.md`, examples under `tools/ipxact2verilog/examples/`).

### Prerequisites

- Java on `PATH` (the launcher runs plain `java`). Use Java 11 or newer (Java 21 recommended: the
  release is built and regression-tested with OpenJDK 21); the bundled JAXB and Eclipse libraries
  are class-file version 55, so a Java 8 runtime fails with `UnsupportedClassVersionError`.
- `EDAUTILS_ROOT` = the unpacked bundle directory (must contain `bin/` and `lib/`). The
  launcher exits 1 with "Environment variable EDAUTILS_ROOT is not set" otherwise.
  `source setup_env.sh` (or `setup_env.csh`) from the bundle root sets `EDAUTILS_ROOT`,
  `EDAUTILS_LICENSE_FILE=$EDAUTILS_ROOT/edautils.lic` and prepends `bin/` to `PATH`.
- Licence feature `IPXACT2VERILOG`. The licence file is searched in this order:
  `$EDAUTILS_LICENSE_FILE`, `./edautils.lic` (run directory), `$HOME/edautils.lic`,
  `$EDAUTILS_ROOT/edautils.lic`. No licence for the feature: exit status 10.
- Optional environment: `JAVA_FLAGS` (passed to the JVM, e.g. `-Xmx8g`; with no heap option in it the launcher adds `-Xmx` sized to the machine (`bin/eu_heap.sh`: the largest of 64/32/16/12/8/4 GB within 3/4 of physical or cgroup memory, else 2 GB; `EDAUTILS_MAX_HEAP_GB` caps it)),
  `EDAUTILS_LOG_FILE` / `EDAUTILS_APPEND_LOG_FILE` (log file name; the second appends),
  `EDAUTILS_DISABLE_USAGE_TRACKING=true`, `EDAUTILS_PRINT_STACK_TRACE` (stack traces on
  internal exceptions), `EDAUTILS_ENABLE_DEBUG_ENVIRONMENT=1` (debug messages).
  `EDAUTILS_IPXACT_SEARCH_PATH`, `EDAUTILS_IPXACT_SEARCH_PATH_COMPONENTS`,
  `..._BUS_DEFINITIONS`, `..._ABSTRACTION_DEFINITIONS`, `..._DESIGNS` (colon-separated
  directories) are read by the IP-XACT 2009/2014/2022 loaders. `-search_path` replaces the
  general path, but only after the `-components` files have been imported.
- The bundle also carries `vhdl_pkgs/` (the bundle script marks this flow as needing it);
  whether this tool's code path opens it was not determined.

### Invocation

```
ipxact2verilog [-components <c1.xml:c2.xml:...>] [-design <design.xml>]
               [-abstractiondef2009|-abstractiondef2014|-abstractiondef2022 <absdef.xml>]
               [-search_path <p1:p2>] [-out <file.v>] [-nobanner] [-quiet] [-suppress <ids>]
```

| Option | Meaning |
|---|---|
| `-components <a.xml:b.xml>` | Colon-separated component XMLs. With `-design` the **first** entry must be the design's own component (gives the netlist module its ports/parameters); a leading `:` (empty first entry) means the design has none |
| `-design <file>` | IP-XACT Design XML to turn into a netlist module |
| `-abstractiondef2009 <file>` | 1685-2009 Abstraction Definition -> SystemVerilog interface |
| `-abstractiondef2014 <file>` | 1685-2014 Abstraction Definition -> SystemVerilog interface |
| `-abstractiondef2022 <file>` | 1685-2022 Abstraction Definition -> SystemVerilog interface |
| `-search_path <p1:p2>` | Directories searched for instantiated components (2009, 2014 and 2022 loaders) |
| `-out <file>` | Output file (default `output.v`; parent dirs are not created) |
| `-nobanner` | No banner, and no completion summary |
| `-quiet` | Silence every later message (log included); errors are then not counted |
| `-suppress <id1:id2>` | Colon-separated message numbers to suppress |
| `-user <email>` | Usage-tracking user id |
| `-help` | Print usage and exit |

An unrecognised option prints "Unrecognized option : <opt>" and the usage. No arguments
prints the usage. No input option is enforced: with none, an empty `-out` file is written.

### Inputs / Outputs

- Reads: the component, design and abstraction-definition XMLs named on the command line,
  plus whatever the search paths supply for instances in the design.
- Writes: the `-out` file (default `output.v` in the current directory), always created.
- Log: `ipxact2verilog.log` in the current directory (override with `EDAUTILS_LOG_FILE`).

### Exit status and messages

- 0 on a normal finish, **including runs that reported errors** (unreadable XML, unresolved
  instances). 10 = licence checkout failed. 1 = `EDAUTILS_ROOT` missing/invalid.
- Message format: `ipxact2verilog: <Severity>: <id>: <text>`; `<id>` is a 5-digit number.
  Usage lines have no severity or id.
- Success prints `Created verilog file <out> ... ` and then
  `Found N error(s) and M warning(s) ...` (not with `-nobanner`). An internal exception prints
  a stack-trace note and skips the summary.

### Examples

Shipped (each dir has `runme.csh` and `runme.bat`):

```
cd $EDAUTILS_ROOT/examples/simpletest_with_generics      # one component
ipxact2verilog -components simpletest_with_param.xml -out simpletest_with_param.v

cd $EDAUTILS_ROOT/examples/design                        # 2009 design + components
ipxact2verilog -design design.xml -components :cgu.xml:uart.xml -out design_simple.v

cd $EDAUTILS_ROOT/examples/design_2022                   # 2022 design, i2c_*.xml components
ipxact2verilog -design design_2022.xml -components ":`ls i2c_*.xml | tr '\n' ':'`" -out design_2022.v
```

From the regression suite (references: `tests.edautilscommandline/tests/ipxact2verilog/design_simple/runme.csh`,
`.../abstractiondef_clock_rtl/runme.csh`, `.../help_msg/runme.csh`):

```
ipxact2verilog -design design_simple.xml -components :cgu.xml:uart.xml -out design_simple.v
ipxact2verilog -abstractiondef2009 clock_rtl.xml -out <outfile>
```

### Integration notes

- Non-interactive; does not read stdin. Run with `</dev/null`.
- Writes the log and default output into the current directory: give each parallel run its
  own working directory (or distinct `-out` and `EDAUTILS_LOG_FILE`).
- Set `EDAUTILS_DISABLE_USAGE_TRACKING=true` to stop usage registration.
- Success test: exit status 0 **and** the log contains `Found 0 error(s)` (do not use
  `-nobanner`/`-quiet` if you rely on it) **and** the `-out` file is non-empty. The file is
  created even when nothing was imported.
- Windows: `bin/ipxact2verilog.bat` does not set `CLASSPATH`; it relies on `setup_env.bat`.
- (2026-10-03) The output is legal Verilog that iverilog and verilator elaborate: a 1685-2009 string
  modelParameter (or an untyped bare word) is printed quoted (`parameter module_name = "uart";`), a
  boolean one as `1'b0`/`1'b1`, and an input port's driver default value -- which a non-ANSI port
  declaration cannot carry -- is printed as a trailing comment (`input [7:0] scaler; // default 'h0`).

### See also

ipxactinterface2svinterface (abstraction definition only), ipxact2vhdlentity, verilog2ipxact
(the reverse), ipxactcoherencychecker, ipxact-shell.
