Executable Usage - 2024.1 English

Vitis Libraries

Release Date
2024-08-06
Version
2024.1 English

This application is present under the L3/demos/gzip_app/ directory. Follow the build instructions to generate the executable and binary.

The host executable generated is named “xil_gzip”, and it is generated in the ./build directory.

The following is the usage of the executable:

  1. To execute a single file for compression: ./build_dir.<TARGET mode>.<xsa_name>/xil_gzip -xbin ./build_dir.<TARGET mode>.<xsa_name>/compress_decompress.xclbin -c <input file_name>

  2. To execute a single file for decompression: ./build_dir.<TARGET mode>.<xsa_name>/xil_gzip -xbin ./build_dir.<TARGET mode>.<xsa_name>/compress_decompress.xclbin -d <compressed file_name>

  3. To validate a single file (compress & decompress): ./build_dir.<TARGET mode>.<xsa_name>/xil_gzip -xbin ./build_dir.<TARGET mode>.<xsa_name>/compress_decompress.xclbin -t <input file_name>

  4. To execute multiple files for compression: ./build_dir.<TARGET mode>.<xsa_name>/xil_gzip -xbin ./build_dir.<TARGET mode>.<xsa_name>/compress_decompress.xclbin -cfl <files.list>

  5. To execute multiple files for decompression: ./build_dir.<TARGET mode>.<xsa_name>/xil_gzip -xbin ./build_dir.<TARGET mode>.<xsa_name>/compress_decompress.xclbin -dfl <compressed files.list>

  6. To validate multiple files (compress & decompress): ./build_dir.<TARGET mode>.<xsa_name>/xil_gzip -xbin ./build_dir.<TARGET mode>.<xsa_name>/compress_decompress.xclbin -l <files.list>

    • <files.list>: Contains various file names with the current path.

The default design flow is for the GZIP design to run the ZLIB, enable the switch -zlib in the command line, as mentioned below: ./build_dir.<TARGET mode>.<xsa_name>/xil_gzip -xbin ./build_dir.<TARGET mode>.<xsa_name>/compress_decompress.xclbin -c <input file_name> -zlib 1

The -xbin option mentioned above is optional, you can provide path to your binary file using the -xbin option; otherwise, it will by default map to ./build_dir.<TARGET mode>.<xsa_name>/compress_decompress.xclbin.

The usage of the generated executable is as follows:

Usage: application.exe -[-h-c-d-xbin-t-l-id-mcr]
       --help,                -h        Print Help Options
       --compress,            -c        Compress
       --decompress,          -d        Decompress
       --test,                -t        Compress & Decompress
       --compress_list,       -cfl      Compress List of Input Files
       --decompress_list,     -dfl      Decompress List of compressed Input Files
       --test_list,           -l        Compress & Decompress on Input Files
       --max_cr,              -mcr      Maximum CR                                      Default: [10]
       --xclbin,              -xbin     XCLBIN
       --device_id,           -id       Device ID                                       Default: [0]
       --zlib,                -zlib     [0:GZip, 1:Zlib]                                Default: [0]