Tools
This page describes the utilities for Orca. It covers the installation of the tools and provides usage details for utilities.
Skip the following step if you already enabled and updated the repository.
Enable and Update the DeGirum repository
Install prerequisites:
Download DeGirum public key:
Ubuntu 20.04:
Ubuntu 22.04 and Ubuntu 24.04:
Add the DeGirum software repository to your APT sources:
Ubuntu 20.04:
Ubuntu 22.04 and Ubuntu 24.04:
Update package information from configured sources:
Installation procedure for ORCA utilities
Download and install DeGirum tools package:
This installs the dgopwc, dgoinfo, and qflup utilities.
dgoinfo - DeGirum ORCA info
Description
dgoinfo prints information about ORCA devices. If no board is specified, the utility lists all detected boards.
Parameters
dgoinfo command [options]
Options
-b bus, --bus=bus Device bus address: part of BDF for PCIe device, USB Controller / Hub Path for USB device.
-d dev, --dev=dev Device address on a bus: part of BDF for a PCIe device, or the USB connection device address.
-p port, --port=port Device port on a USB bus: N/A for PCIe device, the USB controller or hub port address.
-n number, --ndev=number [=0 by default] If previous parameters matched multiple devices (for example, only the bus was specified) or nothing was specified, then number selects the device in the OS-specific order.
Sample run
dgopwc - DeGirum ORCA power control
Description
dgopwc is a utility to set/get power parameters on ORCA device with PCIe/USB interfaces.
Parameters
dgopwc command [options]
Common options
-b bus, --bus=bus Device bus address: part of BDF for PCIe device, USB Controller / Hub Path for USB device.
-d dev, --dev=dev Device address on a bus: part of BDF for a PCIe device, or the USB connection device address.
-p port, --port=port Device port on a USB bus: N/A for PCIe device, the USB controller or hub port address.
-n number, --ndev=number [=0 by default] If previous parameters matched multiple devices (for example, only the bus was specified) or nothing was specified, then number selects the device in the OS-specific order.
-S, --sua [user by default] Super user access.
Sample run
qflup - QSPI flash updater
Description
qflup is a utility for erasing, reading, checking, updating firmware image on QSPI flash on ORCA device with PCIe/USB interfaces.
Parameters
qflup command [options]
Available commands:
Common options
-b bus, --bus=bus Device bus address: part of BDF for PCIe device, USB Controller / Hub Path for USB device.
-d dev, --dev=dev Device address on a bus: part of BDF for a PCIe device, or the USB connection device address.
-p port, --port=port Device port on a USB bus: N/A for PCIe device, the USB controller or hub port address.
-n number, --ndev=number [=0 by default] If previous parameters matched multiple devices (for example, only the bus was specified) or nothing was specified, then number selects the device in the OS-specific order.
-y, --yesall Confirm 'yes' for questions about any change data operations.
Update command parameter and options:
qflup update fw_image_path [ [-s|--size=size] | [-m|--md5=1] | [-N|--noverif=1] ]
fw_image_path Path to file with new firmware image.
-s size, --size=size [=0 by default] Firmware image size to update. If not specified or set to zero, the size of the firmware image file is used.
-m, --size [no by default] Calculate the MD5 checksum for the written block of firmware and print it. If not specified, the tool prints nothing.
-N, --noverif [verify by default] Skip firmware writing verification. If not specified, the tool verifies the written data.
Sample run updating firmware image in the device with bus number 3:
Erase command options:
qflup erase [ [-a|--address=address] | [-s|--size=size] ]
-a address, --size=address [=0 by default] Start address of the erased area. The address is aligned to the nearest subsector.
-s size, --size=size [=0 by default] Size of the erased area. If not specified, it defaults to the flash size minus address. If the range crosses a subsector boundary, all affected subsectors are erased. If both address and size are zero, the entire flash is erased.
Sample run erasing part of the flash (answer yes when prompted):
Read command options:
qflup read [ [output_file_path] | [-a|--address=address] | [-s|--size=size] ]
-a address, --size=address [=0 by default] Start address in the flash to read.
-s size, --size=size [=1MB by default] Size of the area to read. If not specified, it defaults to 1MB. If the size is 0, it uses the full flash size. The data is written to the file specified by output_file_path or printed to the console.
Sample run (reading a part of the flash from device with bus address 3)
Write command parameter and options:
qflup write file_path [[-a|--address=address] | [-s|--size=size] | [-m|--md5=1] | [-N|--noverif=1] ]
fw_image_path Path to the file with the data to write.
-a address, --size=address [=0 by default] Start address in the flash to write the data.
-s size, --size=size [=0 by default] Data size to write. If not specified or zero, the size of the input file is used.
-m, --size [no by default] Calculate the MD5 checksum for the written data and print it. If not specified, the tool prints nothing.
-N, --noverif [verify by default] Skip verification of the written data. If not specified, the tool reads back the data and compares it with the original.
Sample run of writing a file to the device:
Check command options:
qflup check [ [-a|--address=address] | [-s|--size=size] ]
-a address, --size=address [=0 by default] Start address in the flash to read.
-s size, --size=size [=0 by default] Size of checking area. If size is not specified it is set to board defined flash size. If firmware image is found on the flash and the image is valid for this tool the tool will print out the version of found firmware.
Sample run of checking firmware in the flash from device with bus address 4:
Last updated
Was this helpful?