UHD(1)                           User Commands                          UHD(1)

<?><?><?> (NAME)
       rfnoc_image_builder - <?><?><?><?> <?><?><?><?><?> UHD <?><?>
       <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> RFNoC

<?><?><?><?><?> <?><?><?><?><?> (SYNOPSIS)
       rfnoc_image_builder [-h] (-y YAML_CONFIG | -r GRC_CONFIG) [-C BASE_DIR]
       [-F FPGA_DIR] [-B BUILD_DIR] [-O BUILD_OUTPUT_DIR] [-E BUILD_IP_DIR]
       [-o IMAGE_CORE_OUTPUT] [-I INCLUDE_DIR] [-b GRC_BLOCKS] [-l LOG_LEVEL]
       [-R] [-G] [-W] [-S SECURE_CORE] [-K SECURE_KEY] [-d DEVICE] [-n
       IMAGE_CORE_NAME] [-t TARGET] [-g] [-Y] [--CHECK] [-s] [-P] [-j JOBS]
       [-c] [-p VIVADO_PATH] [-H] [-D] [--color {never,auto,always}]

<?><?><?><?><?><?><?><?> (OPTIONS)
   <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?> (optional arguments):
       -h, --help
              <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?> <?><?><?><?>

       -y YAML_CONFIG, --yaml-config YAML_CONFIG
              <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?> YAML
              (<?><?><?><?> <?><?><?><?> <?><?><?><?><?>). <?><?><?><?>
              <?><?><?><?> <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?>
              --grc-config <?><?><?><?><?><?> <?><?><?>.

       -r GRC_CONFIG, --grc-config GRC_CONFIG
              <?><?><?><?> <?><?><?><?> .grc <?><?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?> <?><?><?> <?><?>

       -C BASE_DIR, --base-dir BASE_DIR
              <?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?>.
              <?><?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?>.

       -F FPGA_DIR, --fpga-dir FPGA_DIR
              <?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?> FPGA. <?><?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?> <?><?><?><?> FPGA <?><?> <?><?><?><?> <?><?><?><?>
              <?><?><?>.

       -B BUILD_DIR, --build-dir BUILD_DIR
              <?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?>
              <?><?><?><?><?> <?> <?><?><?><?><?><?><?> <?><?><?><?> <?><?>
              <?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?>.
              <?><?><?><?><?> <?><?><?><?><?><?><?> "build-<image-core-name>"
              <?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?>.

       -O BUILD_OUTPUT_DIR, --build-output-dir BUILD_OUTPUT_DIR
              <?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?> FPGA.
              <?><?><?><?><?> <?><?><?><?><?><?><?> "build" <?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?>.

       -E BUILD_IP_DIR, --build-ip-dir BUILD_IP_DIR
              <?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?><?><?><?> <?><?><?><?> IP. <?><?><?><?><?>
              <?><?><?><?><?><?><?> "build-ip" <?><?>
              <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?>.

       -o IMAGE_CORE_OUTPUT, --image-core-output IMAGE_CORE_OUTPUT
              <?><?><?><?><?> <?><?><?>! <?><?><?> <?><?><?><?><?> <?><?>
              --build-dir <?><?><?><?><?><?><?> <?><?><?> <?><?><?>.

       -x ROUTER_HEX_OUTPUT, --router-hex-output ROUTER_HEX_OUTPUT
              <?><?><?><?><?> <?><?><?>! <?><?><?> <?><?><?><?><?>
              <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?>.

       -I INCLUDE_DIR, --include-dir INCLUDE_DIR
              <?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> Out-of-
              Tree <?><?><?><?><?> <?><?> RFNoC

       -b GRC_BLOCKS, --grc-blocks GRC_BLOCKS
              <?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?> GRC (<?><?><?><?> <?><?><?><?> --grc-config
              <?><?><?><?> <?><?><?>)

       -l LOG_LEVEL, --log-level LOG_LEVEL
              <?><?><?><?><?> <?><?><?> <?><?><?><?><?><?><?><?><?><?>

       -R, --reuse
              <?><?><?><?><?><?><?> <?><?><?><?> <?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?><?> (<?><?><?>
              <?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?>).

       -G, --generate-only
              <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?> FPGA

       -W, --ignore-warnings
              <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?><?> <?><?>
              <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?>
              <?><?><?><?><?><?> <?><?><?><?>.

       -S SECURE_CORE, --secure-core SECURE_CORE
              <?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?>
              <?><?> <?><?><?> bitfile. <?><?><?> <?><?><?><?><?><?><?>
              <?><?><?> <?><?><?><?> YAML <?><?><?><?><?><?> <?><?>
              <?><?><?><?> <?><?><?><?><?><?>.

       -K SECURE_KEY, --secure-key SECURE_KEY
              <?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?>
              <?><?><?>.

       -d DEVICE, --device DEVICE
              <?><?><?><?><?><?><?> <?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?><?><?><?> <?><?><?> [x300, x310, e310,
              e320, n300, n310, n320, x410, x440]. <?><?><?><?> <?><?> <?><?>
              <?><?><?><?><?> <?> <?><?> <?><?> <?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?>.

       -n IMAGE_CORE_NAME, --image-core-name IMAGE_CORE_NAME,
       --image_core_name IMAGE_CORE_NAME
              <?><?><?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
              <?><?><?><?> <?><?><?><?><?> RFNoC. <?><?><?><?><?>
              <?><?><?><?><?><?><?><?> <?><?><?> <?><?><?><?> YML <?><?><?><?>
              <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?>.

       -t TARGET, --target TARGET
              <?><?><?> <?><?><?><?> (<?><?><?><?><?> X310_HG, N320_XG, ...).
              <?><?><?><?> <?><?> <?><?> <?><?><?><?><?> <?> <?><?> <?><?>
              <?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?>.

       -g, --GUI
              <?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?>
              <?><?><?><?><?><?><?> Vivado <?><?> <?><?><?> <?><?><?><?><?><?>
              <?><?><?><?> FPGA.

       -Y, --SYNTH
              <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?> FPGA <?><?> <?><?>
              <?><?><?><?><?> <?><?><?><?> (Synthesis).

       -C, --CHECK
              <?><?><?> <?><?><?><?><?> <?><?><?><?><?> elaboration
              <?><?><?><?> <?><?><?><?><?> <?><?><?> HDL.

       -s, --save-project
              <?><?><?><?><?> <?><?><?><?><?> Vivado <?><?><?> <?><?><?><?>.

       -P, --ip-only
              <?><?><?> <?><?><?><?> IP<?><?><?> <?><?><?><?> <?><?><?><?>.

       -j JOBS, --jobs JOBS
              <?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
              <?><?><?><?> <?><?><?><?><?><?><?> <?><?> make.

       -c, --clean-all
              <?><?><?><?><?><?><?><?> IP <?><?><?> <?><?> <?><?><?><?>
              <?><?><?><?>.

       -p VIVADO_PATH, --vivado-path VIVADO_PATH
              <?><?><?><?> <?><?><?><?> <?><?><?> Xilinx Vivado <?><?>
              <?><?><?><?><?> <?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?><?>
              <?><?><?><?><?> (<?><?><?><?> <?><?><?><?><?>
              /tools/Xilinx/Vivado).

       -H, --no-hash
              <?><?><?> <?><?><?> <?><?> <?><?><?><?> <?><?><?><?> YAML <?><?>
              <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>.

       -D, --no-date
              <?><?><?> <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?> <?><?>
              <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>.

       --color {never,auto,always}
              <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?>. <?><?>
              <?><?><?><?> <?><?><?><?><?> <?><?><?> 'auto'<?> <?><?><?><?><?>
              <?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> TTY
              (<?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>)
              <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?>.

<?><?><?><?><?><?><?> (DESCRIPTION)
       <?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
       YAML <?><?> <?><?><?><?><?><?> <?><?><?><?> <?> <?><?>
       <?><?><?><?><?><?><?><?> (bitfile) <?><?><?><?> FPGA <?><?><?><?><?>
       <?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?> <?><?> <?><?>
       <?><?><?><?><?><?> UHD <?><?> <?><?><?><?><?><?> RFNoC <?><?> <?><?><?>
       <?><?><?>. <?><?><?><?> <?><?><?><?><?><?><?><?> YAML
       <?><?><?><?><?><?><?><?> RFNoC <?><?> <?><?> <?><?><?><?> <?><?>
       <?><?><?><?><?> FPGA <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?>
       <?><?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?> <?> <?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>.

<?><?><?><?><?><?> <?><?><?><?><?><?> (SEE ALSO)
       <?><?><?><?><?><?><?> UHD: https://uhd.readthedocs.io

       <?><?><?><?> <?><?><?><?><?><?><?><?><?><?> UHD:

       uhd_cal_tx_dc_offset(1) uhd_cal_rx_iq_balance(1)
       uhd_images_downloader(1) uhd_config_info(1) uhd_find_devices(1)

<?><?><?><?><?><?><?> (AUTHOR)
       <?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?> Maitland Bottoms
       <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?>
       <?><?><?> (<?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?>
       <?><?><?><?><?><?> <?><?><?> <?><?><?><?><?><?><?> <?><?><?>).

<?><?> <?><?><?> (COPYRIGHT)
       Copyright (c) 2020 Ettus Research LLC

       <?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?>
       <?><?><?><?> <?><?><?>: <?><?><?> <?><?><?><?><?><?><?><?><?> <?><?>
       <?><?> <?><?><?> <?><?><?><?><?> <<<?><?><?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?> <?><?><?>>> <?><?> <?><?><?><?> <?><?><?><?><?>
       <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?>
       <?><?><?> <?><?><?><?> <?><?> <?><?><?><?> <?> <?><?><?><?><?><?> <?>
       <?><?> (<?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>) <?><?>
       <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?><?><?> <?><?><?><?>
       <?><?> <?><?><?><?><?> <?><?><?><?>.

       <?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?>
       <?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?><?><?>
       <?><?><?><?><?><?> <?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?>
       <?><?><?><?> <?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?>
       <?><?><?><?> <?><?><?><?> <?><?> <?><?><?> <?><?><?>. <?><?><?><?>
       <?><?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?><?>
       <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?> <?><?><?><?><?><?>
       <?><?><?><?>.

UHD 4                            December 2024                          UHD(1)