200K+ tool usages 50K+ downloads 69 tools, all free Intel Qualcomm Mediatek LG NVIDIA Samsung Broadcom NXP Huawei Texas Instruments AMD ARM Renesas Ciena 40+ more leading semiconductor companies Free for commercial and academic use 200K+ tool usages 50K+ downloads 69 tools, all free Intel Qualcomm Mediatek LG NVIDIA Samsung Broadcom NXP Huawei Texas Instruments AMD ARM Renesas Ciena 40+ more leading semiconductor companies Free for commercial and academic use

ipxactlint: IP-XACT linter for IEEE 1685

Check IP-XACT 1685-2009, 1685-2014 and 1685-2022 documents against the IEEE 1685 Annex B semantic consistency rules. Every finding names the file, line and rule, and says how to fix it.

ipxactlint is the EDAUtils linter for IP-XACT (IEEE 1685). A file can pass schema validation and still describe an IP that cannot be built or integrated: registers that overlap, a field wider than its register, a logical port mapped to a port of the wrong direction, a VLNV reference to a bus definition that does not exist. IEEE 1685 Annex B lists these as semantic consistency rules (SCRs). ipxactlint checks them, plus the name-uniqueness and local-reference constraints of the schemas, which an XSD or JAXB load does not check. It reports each violation with the file, the line, the rule and how to fix it.

At a glance

  • Checks all 224 IEEE 1685-2014 and all 175 IEEE 1685-2009 Annex B semantic consistency rules (SCRs)
  • IEEE 1685-2022 documents checked with the 1685-2014 rules (2022 renames and value types mapped) plus 22 EDAUtils EU-2022 rules on what 2022 added, derived from the 2022 schema, User Guide and release notes (not IEEE SCR numbers)
  • Schema identity constraints a JAXB or XSD load does not check: unique names (K.1) and local references that resolve (K.2)
  • Lints component, design, design configuration, bus definition, abstraction definition, abstractor, catalog and generator chain documents
  • Cross-document rules across a library given with -lib, or across a whole directory with -in
  • Every finding gives file, line, SCR number, rule name, what is wrong and a Fix: hint
  • -lint_rules prints every rule with its 2014 and 2009 numbers and its fix hint, then the EU-2022 rules with their fix and source
  • Waiver files by rule name, SCR number or EU-2022 id, file and message globs and line, with a mandatory reason and an optional owner
  • Waiver report, stale-waiver warnings, and -waive_all / -gen_waivers to write a waiver file for the next run
  • Exit status 0 clean, 2 lint errors, 1 usage or unreadable input, 10 no license: usable as a CI gate
  • Ships with an AGENTS.md for AI agents; available as a tool in the EDAUtils AI SDK and as a FECAD static check

IEEE 1685 version coverage

ipxactlint reads documents as plain XML, so one rule implementation serves every revision. Each finding is reported under the rule number of the document's own standard, and a rule that one standard does not have is not applied to its documents.

StandardRules appliedNotes
IEEE 1685-2009All 175 Annex B SCRs, 2009 numberingSPIRIT 1.4 and 1.5 documents are treated the same way
IEEE 1685-2014All 224 Annex B SCRs, 2014 numbering
IEEE 1685-2022The 1685-2014 rules, 2014 numbering, plus the 22 EDAUtils EU-2022-* rulesThe 2022 standard's own Annex B is not available to the tool, so 2022 Annex B numbering is not used. The 2022 renames (initiator/target, access policies, array/dim, componentInstanceRef, initiatorRef, clearbox) and value types are mapped. SCR 8.3-8.15 are not applied, since 2022 filters a child's access by its parents'; EU-2022-ACC-3 reports a filtered access as a Warning instead. A Note says so for every 2022 document.

Rules overview

For 1685-2009 and 1685-2014, the rules follow the tables of IEEE 1685 Annex B, plus two schema identity constraints. ipxactlint -lint_rules prints every rule with its numbers in both standards and its fix hint. Every rule has at least one failing regression case, the 22 EU-2022 rules included.

TableRulesExamples
B.1Cross-referencesVLNV references, and port connection equivalence classes
B.2Interconnectionsinterfaces connected in a design
B.3Channels, bridges, abstractorsmirrored interfaces, bridges, abstractor use
B.4Monitorsmonitor interfaces and their connections
B.5Configurable elements and parameters1685-2009: XPath dependencies
B.6Port maps and portsdirections, widths, port connection compatibility
B.7Registers and fieldsoverlaps, fields that fit their register
B.8Memory mapsaccess consistency, e.g. read-only registers
B.9Addressingaddresses, ranges and widths
B.10Hierarchical familiesinterfaces exported through hierarchy
B.11Hierarchical memory mapsa hierarchical slave map against the sub-instance map it exports
B.12Constraints
B.13Design configurations
B.14Expression value types1685-2009: rules needing external knowledge
B.15PresenceisPresent
B.16Access handles
K.1uniqueNamesschema identity constraint: names unique in their scope
K.2localRefExistsschema identity constraint: local references resolve

Cross-document rules need the documents a file references: give them with -lib, or lint a directory. Without either, a Note says the cross-document rules were skipped. Expressions in 2014 and 2022 documents are evaluated as SystemVerilog (based literals, operators, ?:, $clog2, $pow, parameter references). An address, size or offset check that rests on a user-resolved or generated parameter is reported as a Warning, since configuration can change the verdict; everything else is an Error.

IEEE 1685-2022 rules (EU-2022)

What IEEE 1685-2022 added is checked by 22 EDAUtils rules, derived from the 1685-2022 schema, the Accellera IP-XACT 2022 User Guide and the IP-XACT 2022 release notes, pending the 2022 Annex B. Their ids, EU-2022-<area>-<n>, cannot be mistaken for IEEE SCR numbers. They apply to 1685-2022 documents only, and -lint_rules lists each with its fix and source. EU-2022-ACC-3 and EU-2022-DOC-1 are Warnings; the rest are Errors.

AreaRulesChecks
ModesMODE-1, MODE-2mode conditions name existing port and field slices and modes; slice references resolve
Access policiesACC-1 to ACC-4unique modeRef priorities, at most one default access policy, access narrowed by a container (Warning), readResponse only in a readable policy
PowerPWR-1, PWR-2power domain references resolve; design instances link each power domain once, to a declared domain
PortsPORT-1 to PORT-3unique subPort names, port maps reach a leaf wire subPort, one domainTypeDef / signalTypeDef per view
PacketsPKT-1$ipxact_absdefport_value and $ipxact_packetfield_value name existing ports and packet fields
ArraysARR-1 to ARR-3stride covers an element, indexVar names unique and resolvable
ExpressionsEXPR-1$ipxact_*() functions only where allowed, and no unknown ones
Port mappingMAP-1, MAP-2allBits logical ports fully mapped; match logical ports mapped with the same bits on every end (needs -lib)
CPUCPU-1a cpu region lies inside the cpu's range
FieldsFLD-1aliasOf / broadcastTo reach an existing field
DocumentationDOC-1a shortDescription shorter than its description (Warning)
Type definitionsTD-1a typeDefinitions attribute names an externalTypeDefinitions of the component

Usage

ipxactlint -in <file.xml | directory> [-lib <file | directory>]...
           [-waiver <file>]... [-waive_all] [-waiver_report <file>] [-gen_waivers <file>]
           [-nobanner] [-quiet] [-user <email>]
ipxactlint -lint_rules
ipxactlint -help
OptionMeaning
-in <file or dir>Required. The document to lint, or a directory: every IP-XACT .xml under it is linted, and the directory also serves as the library
-lib <file or dir>Repeatable. Documents the input references (bus and abstraction definitions, components, designs, abstractors); enables the cross-document rules
-waiver <file>Repeatable. Waiver file; a covered violation becomes a Waived note and is not counted
-waive_allWaive every violation and write a waiver file covering them (ipxactlint.waivers unless -gen_waivers names it)
-waiver_report <file>Waiver report path (default ipxactlint_waived.rpt)
-gen_waivers <file>Write a waiver file with one waiver per violation of this run, for -waiver next time
-lint_rulesPrint every rule: its 1685-2014 number (also used for 2022), its 1685-2009 number, its name and how to fix a violation; then the EU-2022 rules with id, name, fix and source
-nobanner, -quietNo banner and summary; silence every later message
-helpUsage

Findings and the summary Found N error(s) and M warning(s) go to the terminal and to ipxactlint.log in the current directory.

Example: five planted mistakes

The examples/findings directory of the bundle holds a UART register block with five planted mistakes. This is its output:

$ cd examples/findings
$ ipxactlint -in uart.xml -lib lib
ipxactlint: Error: 62300: uart.xml:37: K.2 localRefExists: reference to memoryMap 'uart_map', which does not exist in this component. Fix: point the reference at an element that is declared in this document, or declare the missing element
ipxactlint: Error: 62300: uart.xml:24: SCR 6.6 LogPortOutPortDir: logical port 'RDATA' is direction out for this slave interface but is mapped to port 'prdata' of direction in. Fix: map this logical port to a component port of direction out, inout or phantom (or swap the port's direction)
ipxactlint: Error: 62300: uart.xml:60: SCR 7.4 BitWithinRegister: field 'baud_div' bits [35:20] do not fit in register 'ctrl' of size 32. Fix: lower the field's bitOffset or bitWidth, or enlarge the register's size
ipxactlint: Error: 62300: uart.xml:77: SCR 8.5 ReadOnlyRegisterCondition: read-only register 'status' contains read-write field 'rx_full'. Fix: put only read-only fields in a read-only register, or change the register's access
ipxactlint: Error: 62300: uart.xml:66: SCR 7.1 RegisterOverlap: register 'status' [0x2..0x5] overlaps register 'ctrl' [0x0..0x3] in addressBlock 'uart_regs'. Fix: move the register to a free addressOffset, or give the two registers non-conflicting access (read-only vs write-only)
ipxactlint: Note: 53250: Found 5 error(s) and 0 warning(s) ...
$ echo $?
2

The same UART without the mistakes, in examples/clean, exits 0 with Found 0 error(s).

Shipped examples

The bundle ships eight examples under examples/ (tools/ipxactlint/examples/ in the shell bundles). Each runme.csh exits 0 only when its expected result holds, so each doubles as a check.

ExampleWhat it showsExpected
cleanA 1685-2014 UART register blockexit 0, Found 0 error(s)
findingsThe same UART with five planted mistakes (K.2, SCR 6.6, 7.1, 7.4, 8.5)exit 2, Found 5 error(s)
waiversThe five findings waived with reasonsexit 0, 5 waived violations
soc_2014A 1685-2014 SoC subsystem: RV32 core on AXI4-lite, AXI4-lite-to-APB bridge, UART, GPIO, timerexit 0
legacy_2009The same IPs and design as a 1685-2009 component library, linted as a directoryexit 0
dmac_2022A 1685-2022 version plus a DMA controller using modes, mode-specific access policies, readResponse, strided register arrays, a field alias, power domains and a structured portexit 0
waiver_flow-gen_waivers, review, then -waiver on a 2022 IPexit 2, 1 error, 2 warnings waived
ci_gateA CI lint gate script over four trees, deciding on the exit statusexit 2, GATE: FAIL on one tree

Waivers

A waiver names a rule by name or SCR number, can narrow it with file and message globs or a line number, and must give a reason. A waived violation is printed as a Note, is not counted, and is listed in the waiver report (ipxactlint_waived.rpt). A waiver that matches nothing is a Warning: its violation was fixed or renamed. A typical flow is to run -waive_all once, review the generated file, delete the lines for violations to be fixed, then run with -waiver <file> -gen_waivers <file> to keep it current. Generated waivers carry a TODO reason until someone replaces it.

# uart.waivers -- one waiver per line; reason= is required
rule=RegisterOverlap file=uart.xml msg="register 'status' *" reason="status aliases ctrl on purpose (legacy map)" owner=soc-team
rule=7.4 msg="field 'baud_div' *" reason="baud_div spills into the next word in this IP revision" owner=soc-team
rule=* file=*.xml line=315 reason="po is driven in test mode only"

$ ipxactlint -in uart.xml -lib lib -waiver uart.waivers -gen_waivers next.waivers

Using ipxactlint in CI

# lint every IP-XACT file under ipxact/, resolving references against busdefs/
cd build/lint            # each parallel run in its own directory: the log is written to the cwd
ipxactlint -in ../../ipxact -lib ../../busdefs -waiver ../../ip.waivers -nobanner </dev/null
status=$?                # 0 clean, 2 lint errors, 1 usage or unreadable input, 10 no license
[ $status -eq 0 ] || { grep -E 'Error:|Warning:' ipxactlint.log; exit $status; }
Exit statusMeaning
0No lint errors (warnings and waived violations do not fail the run)
2Lint errors found
1Usage error, an input, library or waiver file that does not exist or cannot be read, a malformed waiver line, or an internal error
10No license for the IPXACTLINT feature (nor an ipxact-shell or designplayer-shell license)

For AI agents and automated flows

Install and prerequisites

ipxactlint ships as its own ipxactlint bundle, and as a point tool inside the ipxact-shell and designplayer-shell bundles. It runs on Linux and Windows and needs Java 11 or newer; setup_env finds one or offers to install it, sets EDAUTILS_ROOT and the license file, and puts bin/ on the PATH. It needs a license with the IPXACTLINT feature, which an ipxact-shell or designplayer-shell license also grants. It needs no schemas, no network and no other tools.

source setup_env.sh        (or setup_env.csh, setup_env.bat)
cd examples/findings
ipxactlint -in uart.xml -lib lib

Known limits

Frequently asked questions

What is an IP-XACT linter?
An IP-XACT linter checks IEEE 1685 XML for mistakes that schema validation cannot see. A document can be valid against the XSD and still have overlapping registers, a field wider than its register, a logical port mapped to a port of the wrong direction, or a VLNV reference to a bus definition that does not exist. IEEE 1685 Annex B lists these checks as semantic consistency rules (SCRs). ipxactlint checks them.
What does ipxactlint check that XSD schema validation does not?
The semantic consistency rules of IEEE 1685 Annex B: all 224 rules of 1685-2014 and all 175 of 1685-2009. It also checks the schema identity constraints that a JAXB or XSD load does not enforce: names that must be unique in their scope, and local references (memoryMapRef, addressSpaceRef, port, view, fileSet and others) that must resolve.
Which IP-XACT versions does ipxactlint support?
IEEE 1685-2009 (SPIRIT 1.4 and 1.5 documents are treated the same way), IEEE 1685-2014 and IEEE 1685-2022. Each finding is reported under the rule number of the document's own standard.
Does ipxactlint implement the IEEE 1685-2022 Annex B rules?
Not under 2022 numbering: the 2022 standard's own Annex B is not available to the tool, so no IEEE SCR number is invented for 2022. A 2022 document is checked with the 1685-2014 rules under their 2014 numbers, with the 2022 renames and value types mapped, plus 22 EDAUtils rules (EU-2022-<area>-<n>) on what 2022 added: modes and mode conditions, per-mode access policies, readResponse, power domains, structured ports, packets, arrays with stride and indexVar, the $ipxact_*() functions, allBits and match port mapping, cpu regions, field aliases and broadcasts, shortDescription and typeDefinitions references. They are derived from the 2022 schema, the Accellera IP-XACT 2022 User Guide and the release notes, pending the 2022 Annex B. -lint_rules lists each with its source.
What does an ipxactlint finding look like?
One line per finding: file:line, the SCR number and rule name, what is wrong with the elements and values involved, then a Fix: hint. Example: uart.xml:60: SCR 7.4 BitWithinRegister: field 'baud_div' bits [35:20] do not fit in register 'ctrl' of size 32. Fix: lower the field's bitOffset or bitWidth, or enlarge the register's size.
How do I waive a known violation?
Pass a waiver file with -waiver. Each line names a rule by name, SCR number or EU-2022 id, can narrow it with file and message globs or a line number, and must give a reason; an owner is optional. A waived violation is not counted and is listed in the waiver report, and a waiver that matches nothing is reported as stale. -gen_waivers writes a waiver file covering the current findings, and -waive_all waives everything and writes one.
Can ipxactlint gate a CI pipeline?
Yes. It is non-interactive, and its exit status is 0 when there are no lint errors (warnings and waived violations do not fail the run), 2 when lint errors are found, 1 on a usage error or an unreadable input, library or waiver file, and 10 when no license is found.
How is ipxactlint related to validateipxact?
ipxactlint is the -lint mode of validateipxact as a tool of its own, with its own log (ipxactlint.log), banner and exit status. validateipxact also offers a JAXB-based semantic check and a -sanity mode.
Where does ipxactlint ship and what does it need?
As its own ipxactlint bundle, and as a point tool inside the ipxact-shell and designplayer-shell bundles. It needs Java 11 or newer, EDAUTILS_ROOT set to the unpacked bundle (setup_env sets it), and a license file with the IPXACTLINT feature; an ipxact-shell or designplayer-shell license also grants it. It needs no schemas, no network and no other tools.

Related IP-XACT tools

  • IP-XACT tools guide - validateipxact, upgradeipxact, compareipxact, register model generators
  • verilog2ipxact and vhdl2ipxact - generate IP-XACT components from RTL, then lint them
  • IP-XACT 1685 solution - component packaging, registers, memory maps and generators
  • ipxactlint capability file - machine-readable summary for AI agents
Download ipxactlint →

Trusted by design teams worldwide

The collection of tools and utilities fills a real void in EDA. The baya tool is exactly what we had been looking for to assemble large top-level modules in Verilog. The GUI and high-level TCL commands are intuitive, allowing designers to get started immediately.
Michael TrocinoIC Design Manager, Coherent Logix
Thanks for efficient tools which have been successfully used in our internal wireless design flow. Friendly support has been highly appreciated.
Claudine RaibautEDA Manager, Texas Instruments
Baya is a mature production quality tool with features and capabilities beyond those of tools provided by large EDA vendors. Its flexibility is a key reason we have chosen it for use in our Cloud-based platform.
David FritzCEO, Social Silicon
Kanai produced an excellent tool set, which is very useful for complex system-on-chip integration flows. We were skeptical in the beginning, but later got really impressed by the high quality and ease of use.
Boris V. KuznetsovCEO, SOCC
Thanks a lot for creating DesignPlayer and the huge Java class library behind it. Your strong support makes me confident to explore more details in future.
Rolf KemperManager, Mixed Signal Design, Renesas Electronics Europe
EDAUtils is one of the most comprehensive tools for SoC design and integration, and it is available for free. I included EDAUtils in the OpenTech Package as a featured application.
Jamil KhatibOpenTech Package
The VHDL2Verilog translator worked great, even handling the generate statements in the source VHDL. It met our needs exactly.
Jerry FrenkilVP of Engineering, NanoWatt Design
We use the Verilog Parser for developing FPGA CAD applications. The library is very stable and EDAUtils provided much helpful support to us.
Dustin PetersonUniversity of Tübingen
I like the IP-XACT tools and others that you have developed. The IP-XACT tools are great.
Amal KhailtashLead FPGA Designer, Ciena Communications
The netlist parser provides an easy to use and flexible environment for developing my own custom analysis tools. The best part has been the prompt and helpful support.
Gene Y. WuUniversity of Texas
We have been using the Verilog testbench generator in Unix. It is really useful in the coding process and easy to use. I would recommend their tools.
Lucas TeixeiraSMDH
That really helped me now. I got the job done at the right time.
S. KrishnanIntel
The collection of tools and utilities fills a real void in EDA. The baya tool is exactly what we had been looking for to assemble large top-level modules in Verilog. The GUI and high-level TCL commands are intuitive, allowing designers to get started immediately.
Michael TrocinoIC Design Manager, Coherent Logix
Thanks for efficient tools which have been successfully used in our internal wireless design flow. Friendly support has been highly appreciated.
Claudine RaibautEDA Manager, Texas Instruments
Baya is a mature production quality tool with features and capabilities beyond those of tools provided by large EDA vendors. Its flexibility is a key reason we have chosen it for use in our Cloud-based platform.
David FritzCEO, Social Silicon
Kanai produced an excellent tool set, which is very useful for complex system-on-chip integration flows. We were skeptical in the beginning, but later got really impressed by the high quality and ease of use.
Boris V. KuznetsovCEO, SOCC
Thanks a lot for creating DesignPlayer and the huge Java class library behind it. Your strong support makes me confident to explore more details in future.
Rolf KemperManager, Mixed Signal Design, Renesas Electronics Europe
EDAUtils is one of the most comprehensive tools for SoC design and integration, and it is available for free. I included EDAUtils in the OpenTech Package as a featured application.
Jamil KhatibOpenTech Package
The VHDL2Verilog translator worked great, even handling the generate statements in the source VHDL. It met our needs exactly.
Jerry FrenkilVP of Engineering, NanoWatt Design
We use the Verilog Parser for developing FPGA CAD applications. The library is very stable and EDAUtils provided much helpful support to us.
Dustin PetersonUniversity of Tübingen
I like the IP-XACT tools and others that you have developed. The IP-XACT tools are great.
Amal KhailtashLead FPGA Designer, Ciena Communications
The netlist parser provides an easy to use and flexible environment for developing my own custom analysis tools. The best part has been the prompt and helpful support.
Gene Y. WuUniversity of Texas
We have been using the Verilog testbench generator in Unix. It is really useful in the coding process and easy to use. I would recommend their tools.
Lucas TeixeiraSMDH
That really helped me now. I got the job done at the right time.
S. KrishnanIntel

Read all customer feedback →