# ipxact2vhdlentity

> Generate VHDL entity from IP-XACT Component definition

- Catalog id: `Ipxact2Vhdlentity`; bundle: `ipxact2vhdlentity`; latest version 20261018
- Documentation page: https://edautils.com/ip-xact.html
- Keywords: IP-XACT to VHDL, entity generator, IEEE 1685
- 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/ipxact2vhdlentity.md

## Downloads

- EDAUtils download site: https://edautils.ai/download/Ipxact2Vhdlentity (latest file `ipxact2vhdlentity-20261018.tar.gz`)
- SourceForge: https://sourceforge.net/projects/edautils-converters/files/ipxact2vhdlentity/
- SourceForge: https://sourceforge.net/projects/ip-xact-tools/files/ipxact2vhdlentity/
- GitHub Releases: https://github.com/edautils/releases/releases/download/RELEASE_20261018/ipxact2vhdlentity-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.

Reads one IP-XACT component XML and writes the matching VHDL entity declaration (ports and
generics only, no architecture body) into one file (default `component.vhd`). The component is
imported through the Baya backbone into a Verilog module and then printed as a VHDL entity.
Main class: `com.eu.miscedautils.shell.ipxact2vhdl` (jar `lib/designplayer.jar`); the launcher
is `bin/ipxact2vhdlentity` and the tool prefix is `ipxact2vhdlentity`.

### Where it ships

Its own bundle, `ipxact2vhdlentity.tar.gz` (flow `ipxact2vhdlentity`; release tree
`release_scripts/ipxact2vhdlentity/1.0`), and as a point tool in the **ipxact-shell**,
**baya-shell** and **designplayer-shell** bundles (`bin/ipxact2vhdlentity` running the shell's
jar; this guide as `tools/ipxact2vhdlentity/AGENTS.md`, examples under
`tools/ipxact2vhdlentity/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 `IPXACT2VHDL`. 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*` (colon-separated directories) are read by the IP-XACT
  loaders used for the import.
- The bundle carries `vhdl_pkgs/` (the bundle script marks this flow as needing it); whether
  this tool's code path opens it was not determined.

### Invocation

```
ipxact2vhdlentity -in <component.xml> [-out <file.vhd>] [-nobanner] [-quiet] [-suppress <ids>]
```

| Option | Meaning |
|---|---|
| `-in <file>` | IP-XACT component XML (effectively mandatory) |
| `-out <file>` | Output VHDL file (default `component.vhd`) |
| `-nobanner` | No banner, and no completion summary on success |
| `-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 the one-line usage and exit |

Parsing quirk: once `-in` has been seen, any token that is not one of the options above is
silently accepted as an extra file and ignored -- including `-help`, and the `-top <name>`
shown in `README.txt` (there is no `-top` option). Before `-in`, an unknown option prints
"Unrecognized option : <opt>" and the usage. No arguments prints the usage.

### Inputs / Outputs

- Reads: the `-in` component XML. The IP-XACT revisions accepted are those of the Baya
  backbone component import; not separately determined for this tool.
- Writes: the `-out` file (default `component.vhd` in the current directory).
- Log: `ipxact2vhdlentity.log` in the current directory (override with `EDAUTILS_LOG_FILE`).

### Exit status and messages

- 0 on every normal return, **including failures** (component not importable). 10 = licence
  checkout failed. 1 = `EDAUTILS_ROOT` missing/invalid.
- Message format: `ipxact2vhdlentity: <Severity>: <id>: <text>`; `<id>` is a 5-digit
  number. Usage lines have no severity or id.
- Success prints `Created VHDL file <out> ... ` then `Found N error(s) and M warning(s) ...`
  (not with `-nobanner`). If the import fails the summary is printed (even with `-nobanner`)
  and no file is written.

### Examples

Shipped: `examples/simpletest_with_generics/` (`runme.csh`, `runme.bat`,
`simpletest_with_generics.xml`):

```
cd $EDAUTILS_ROOT/examples/simpletest_with_generics
ipxact2vhdlentity -in simpletest_with_generics.xml -out simpletest_with_generics.vhd
```

From the regression suite (reference:
`tests.edautilscommandline/tests/ipxact2vhdl/simpletest_with_generics/runme.csh`; help golden
in `tests.edautilscommandline/tests/ipxact2vhdl/help_msg/`):

```
ipxact2vhdlentity -in simpletest_with_generics.xml -out simpletest_with_generics.vhd
```

### 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 `Created VHDL file` and
  `Found 0 error(s)` (do not use `-nobanner`/`-quiet` if you rely on these) **and** the
  `-out` file exists.
- Windows: `bin/ipxact2vhdlentity.bat` does not set `CLASSPATH`; it relies on `setup_env.bat`.

### See also

ipxact2verilog, ipxactcoherencychecker (`ipxactcoherencycheckervhdl`), vhdl2ipxact (the
reverse), verilog2vhdl.
