Command Line Interface

This page provides documentation for our command line tools.

adidtc

ADI device tree utility

Usage:

adidtc [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--no-color`, `-nc`	boolean	Disable formatting	`False`
`--board`, `-b`	choice (`ad9081_fmc` \| `adrv9009_pcbz` \| `adrv9009_zu11eg` \| `daq2`)	Set board configuration	`adrv9009_pcbz`
`--context`, `-c`	choice (`local_file` \| `local_sd` \| `local_sysfs` \| `remote_sysfs` \| `remote_sd`)	Set context	`local_sysfs`
`--ip`, `-i`	text	Set ip used by remote contexts	`192.168.2.1`
`--username`, `-u`	text	Set username used by remote SSH sessions (default is root)	`root`
`--password`, `-w`	text	Set password used by remote SSH sessions (default is analog)	`analog`
`--arch`, `-a`	choice (`arm` \| `arm64` \| `auto`)	Set target architecture which will set the target DT. auto with determine from running system	`auto`
`--filepath`, `-f`	text	Path of the target devicetree blob to be used in local_file mode (default is devicetree.dtb)	`devicetree.dtb`
`--help`	boolean	Show this message and exit.	`False`

JIF supported updates of DT

NODE_TYPE - Type of device the configuration is to address

Usage:

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

Options:

Name	Type	Description	Default
`--reboot`, `-r`	boolean	Reboot boards after successful write	`False`
`--filename`, `-f`	path	Name of json file to import with JIF config	None
`--help`	boolean	Show this message and exit.	`False`

Generate devicetree from Profile Configuration Wizard files

Usage:

adidtc profile2dt [OPTIONS]

Options:

Name	Type	Description	Default
`--profile`, `-p`	Path		None
`--config`, `-c`	Path	path to talise_config.c	None
`--help`	boolean	Show this message and exit.	`False`

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:

Name	Type	Description	Default
`--reboot`, `-r`	boolean	Reboot boards after successful write	`False`
`--compat`, `-cp`	boolean	Use node name to check against compatible id of node during search	`False`
`--children`, `-ch`	boolean	Show properties of child nodes 1 level down	`False`
`--help`	boolean	Show this message and exit.	`False`

Get and set device tree properties

NODE_NAME - Name of node(s) to address

Usage:

adidtc props [OPTIONS] [NODE_NAME]...

Options:

Name	Type	Description	Default
`--compat`, `-cp`	boolean	Use node name to check against compatible id of node during search. This is only used for the first node	`False`
`--reboot`, `-r`	boolean	Reboot boards after successful write	`False`
`--prop`, `-p`	text	Property of node to read to set	None
`--value`, `-v`	text	Value to set property to	None
`--help`	boolean	Show this message and exit.	`False`

Move files on existing SD card

REFERENCE_DESIGN - Name of reference design folder on SD card

Usage:

adidtc sd-move [OPTIONS] [RD]

Options:

Name	Type	Description	Default
`--reboot`, `-r`	boolean	Reboot boards after successful write	`False`
`--show`, `-s`	boolean	Print commands as run	`False`
`--dry-run`, `-d`	boolean	Dryrun, do not run commands	`False`
`--help`	boolean	Show this message and exit.	`False`

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:

Name	Type	Description	Default
`--reboot`, `-r`	boolean	Reboot boards after successful write	`False`
`--show`, `-s`	boolean	Print commands as run	`False`
`--dry-run`, `-d`	boolean	Dryrun, do not run commands	`False`
`--help`	boolean	Show this message and exit.	`False`