Command Line Interface

This page provides documentation for our command line tools.

CLI Reference

adidtc

ADI device tree utility

Usage

adidtc [OPTIONS] COMMAND [ARGS]...

Options

-nc, --no-color

Disable formatting

-b, --board <board>

Set board configuration

Default:

'adrv9009_pcbz'

Options:

ad9081_fmc | adrv9009_pcbz | adrv9009_zu11eg | daq2

-c, --context <context>

Set context

Default:

'local_sysfs'

Options:

local_file | local_sd | local_sysfs | remote_sysfs | remote_sd

-i, --ip <ip>

Set ip used by remote contexts

Default:

'192.168.2.1'

-u, --username <username>

Set username used by remote SSH sessions (default is root)

Default:

'root'

-w, --password <password>

Set password used by remote SSH sessions (default is analog)

Default:

'analog'

-a, --arch <arch>

Set target architecture which will set the target DT. auto with determine from running system

Default:

'auto'

Options:

arm | arm64 | auto

-f, --filepath <filepath>

Path of the target devicetree blob to be used in local_file mode (default is devicetree.dtb)

Default:

'devicetree.dtb'

deps

Analyze device tree dependencies

DT_FILE - Path to device tree source file (.dts, .dtsi)

Examples:

View dependency tree:

adidtc deps system.dts

Export to GraphViz and generate image:

adidtc deps system.dts –format dot -o deps.dot dot -Tpng deps.dot -o deps.png

Export to JSON with missing dependencies:

adidtc deps system.dts –format json –show-missing -o deps.json

Limit depth of tree display:

adidtc deps system.dts –max-depth 3

Usage

adidtc deps [OPTIONS] DT_FILE

Options

-f, --format <format>

Output format (tree, json, or dot)

Options:

tree | json | dot

-d, --max-depth <max_depth>

Maximum depth to display in tree format

--show-missing, --hide-missing

Show or hide missing dependencies

-o, --output <output>

Output file (for json/dot formats)

Arguments

DT_FILE

Required argument

gen-dts

Generate device tree source file for AD9081

Generate device tree source (DTS) files for AD9081 FMC evaluation boards

across multiple FPGA platforms.

Supported Platforms:

- zcu102 : Zynq UltraScale+ (ARM64, GTH transceivers)

- vpk180 : Versal (ARM64, GTY transceivers)

- zc706 : Zynq-7000 (ARM, GTX transceivers)

Examples:

Generate DTS for ZCU102:

adidtc gen-dts -p zcu102 -c my_config.json

Generate DTS with custom kernel path:

adidtc gen-dts -p vpk180 -c cfg.json -k /path/to/linux

Generate and compile to DTB:

adidtc gen-dts -p zc706 -c cfg.json –compile

Custom output path:

adidtc gen-dts -p zcu102 -c cfg.json -o custom.dts

Usage

adidtc gen-dts [OPTIONS]

Options

-p, --platform <platform>

Required Target FPGA platform

Options:

zcu102 | vpk180 | zc706

-c, --config <config>

Required Path to JSON configuration file

-k, --kernel-path <kernel_path>

Path to Linux kernel source tree (overrides LINUX_KERNEL_PATH env var)

-o, --output <output>

Output DTS file path (default: generated_dts/ad9081_fmc_<platform>.dts)

--compile

Compile DTS to DTB using dtc

jif

JIF supported updates of DT

NODE_TYPE - Type of device the configuration is to address

Usage

adidtc jif [OPTIONS] {clock|converter|system|fpga}

Options

-r, --reboot

Reboot boards after successful write

-f, --filename <filename>

Name of json file to import with JIF config

Arguments

NODE_TYPE

Required argument

profile2dt

Generate devicetree from Profile Configuration Wizard files

Usage

adidtc profile2dt [OPTIONS]

Options

-p, --profile <profile>

-c, --config <config>

path to talise_config.c

prop

Get and set device tree properties

NODE_NAME - Name of node to address

PROP - Name property to get/set

VALUE - Value to write to property of node

Usage

adidtc prop [OPTIONS] [NODE_NAME] [PROP] [VALUE]

Options

-r, --reboot

Reboot boards after successful write

-cp, --compat

Use node name to check against compatible id of node during search

-ch, --children

Show properties of child nodes 1 level down

Arguments

NODE_NAME

Optional argument

PROP

Optional argument

VALUE

Optional argument

props

Get and set device tree properties

NODE_NAME - Name of node(s) to address

Usage

adidtc props [OPTIONS] [NODE_NAME]...

Options

-cp, --compat

Use node name to check against compatible id of node during search. This is only used for the first node

-r, --reboot

Reboot boards after successful write

-p, --prop <prop>

Property of node to read to set

-v, --value <value>

Value to set property to

Arguments

NODE_NAME

Optional argument(s)

sd-move

Move files on existing SD card

REFERENCE_DESIGN - Name of reference design folder on SD card

Usage

adidtc sd-move [OPTIONS] [RD]

Options

-r, --reboot

Reboot boards after successful write

-s, --show

Print commands as run

-d, --dry-run

Dryrun, do not run commands

Arguments

RD

Optional argument

sd-remote-copy

Copy local boot files to remote existing SD card

FILES - List of files to copy (comma separated)

Usage

adidtc sd-remote-copy [OPTIONS] [FILES]

Options

-r, --reboot

Reboot boards after successful write

-s, --show

Print commands as run

-d, --dry-run

Dryrun, do not run commands

Arguments

FILES

Optional argument