Command Reference

usage: sphinx-build [-h] {share,libs,api-gen-sv,ifc-gen-sv,ifc-gen-types} ...

Sub-commands

share

Displays the path to the ‘share’ directory

sphinx-build share [-h]

libs

Displays the simulator library paths

sphinx-build libs [-h] [-t {dpi,vpi}]

Named Arguments

-t, --type

Possible choices: dpi, vpi

Specifies the type of library to retrieve. Currently optional

api-gen-sv

Generate one or more SV classes, optionally enclosed in a package

sphinx-build api-gen-sv [-h] [-m MODULE] [-s SPEC]
                        [--spec-fmt {json,yaml,toml}] [-j JSON] [-uvm]
                        [--deprecated] [-i INCLUDE] [-e EXCLUDE]
                        [--follow-deps] [-p PACKAGE] [-o OUTPUT]

Named Arguments

-m, --module

Specify a Python module to load for API discovery

-s, --spec

Specify API specification (JSON string or filepath)

--spec-fmt

Possible choices: json, yaml, toml

Format of the API specification (auto-detected if not specified)

-j, --json

(Deprecated) Specify JSON string defining the API classes. Use –spec instead

-uvm

Generates UVM-friendly interface classes

Default: False

--deprecated

Enable deprecated SV class output

Default: False

-i, --include

Specify a pattern for API inclusion

-e, --exclude

Specify a pattern for API exclusion

--follow-deps

Also generate classes for API base classes (dependencies)

Default: False

-p, --package

Place the generated class APIs in a package

-o, --output

Specifies the output filename

Default: 'hdl_call_if_api.svh'

ifc-gen-sv

Generates

sphinx-build ifc-gen-sv [-h] [-m MODULE] [-t]
                        [-s {vl,verilog,sv,systemverilog}] [-o OUTPUT]
                        ifc

Positional Arguments

ifc

Specifies the interface to generate

Named Arguments

-m, --module

Specifies a Python module to load

-t, --types

Generate a ‘types’ file containing packed struct definitions

Default: False

-s, --style

Possible choices: vl, verilog, sv, systemverilog

Specifies the style of output

Default: 'sv'

-o, --output

Specifies the output file

ifc-gen-types

Generates struct types for use with the TLM interface

sphinx-build ifc-gen-types [-h] [-m MODULE] [-o OUTPUT] ifc

Positional Arguments

ifc

Specifies the interfaces for which to generate types

Named Arguments

-m, --module

Specifies a Python module to load

-o, --output

Specifies the output file