Name

ocpidev-utilization — displays or records FPGA resource use for OpenCPI HDL assets.

Synopsis

ocpidev [<options>] utilization [<noun> [<name> ]]

DESCRIPTION

The utilization verb invokes the OpenCPI tool that displays or records FPGA resource use for OpenCPI HDL assets. In order to display usage information about an HDL asset for a given platform, the asset needs to be built for that platform.

Asset types to be specified in the <noun> argument are:

hdl

A prefix to indicate an HDL asset in the hdl subdirectory of a project. Possible HDL assets are:

assembly|ies
Display usage information for all built assemblies contained in the current project or a for specified built HDL assembly contained in the current project.
platform|s
Display usage information for all built platforms or for a specified built HDL platform contained in the current project.
library
Display usage information for all built workers contained in a component library.
project
Display usage information for all built workers, platforms, and HDL assemblies contained in a project.
worker
Display usage information for the specified worker.
workers
Display usage information for all built workers contained in the current project.

OPTIONS

In addition to the options common to all OpenCPI tools (see opencpi(1)), the options described below can be specified for utilization operations. In the following descriptions, a plus sign (+) after the option indicates that it can be specified more than once on the command line.

Keywords for platforms supported by OpenCPI that can be specified in the <platform> argument to an option can be found in the tables of supported platforms in the OpenCPI User Guide.

Keywords for architectures supported by OpenCPI that can be specified in the <target> argument include isim, modelsim, xsim, zynq, zynq_ultra, zynq_ise, spartan3adsp.

-P <hdl-platform-directory>, --platform=<hdl-platform-directory>
Specify the HDL platform subdirectory in which the utilization operation is to be performed.
-l <library>, --library=<library>
Specify the component library in which the utilization operation is to be performed.
--format=table|latex
Specify how to output the usage information. Specifying table sends the information to stdout in tabular format. Specifying latex bypasses stdout and writes all output to utilization.inc files in the directories for the assets on which it operates.
--hdl-library=<hdl-primitive-library>
Specify the HDL primitive library in which this operation is to be performed.
--hdl-platform=<platform>+
Specify the buildable HDL platform for which to display usage information.
--hdl-target=<target>+
Specify the buildable HDL architecture for which to display usage information.

EXAMPLES

  1. Show usage information for the worker named complex_mixer using build results from all platforms: 

    ocpidev utilization worker complex_mixer

  2. Show usage information for the worker named complex_mixer using build results from the xsim platform: 

    ocpidev utilization worker complex_mixer --hdl-platform=xsim

  3. Show usage information for all workers in the current location (project, library, etc.): 

    ocpidev utilization workers

  4. Show usage information for the fir_real_sse worker in the components/dsp_comps library of the assets project: 

    ocpidev utilization worker fir_real_sse -l dsp_comps

  5. Show usage information for the xsim platform: 

    ocpidev utilization hdl-platform=xsim

  6. Show usage information for all HDL platforms in the current project: 

    ocpidev utilization hdl-platforms

  7. Show usage information for an HDL assembly named my_assy: 

    ocpidev utilization hdl assembly my_assy

  8. Show usage information for all HDL assemblies in the current project: 

    ocpidev utilization hdl assemblies

  9. Record usage information for an HDL assembly named my_assy in LaTeX format: 

    ocpidev utilization hdl assembly my_assy --format=latex

  10. Show usage information for all supported assets in a project: 

    ocpidev utilization project

  11. Record usage information for all supported assets in a project in LaTeX format: 

    ocpidev utilization project --format=latex

BUGS

See https://www.opencpi.org/report-defects

RESOURCES

See the main web site: https://www.opencpi.org

See the OpenCPI Component Development Guide: https://opencpi.gitlab.io/releases/latest/docs/OpenCPI_Component_Development_Guide.pdf

See the OpenCPI HDL Development Guide: https://opencpi.gitlab.io/releases/latest/docs/OpenCPI_HDL_Development_Guide.pdf

See the OpenCPI Platform Development Guide: https://opencpi.gitlab.io/releases/latest/docs/OpenCPI_Platform_Development_Guide.pdf

SEE ALSO

ocpidev(1) ocpidev-build(1) ocpidev-clean(1) ocpidev-create(1) ocpidev-delete(1) ocpidev-refresh(1) ocpidev-register(1) ocpidev-run(1) ocpidev-set(1) ocpidev-show(1) ocpidev-unset(1)

COPYING

Copyright (C) 2023 OpenCPI www.opencpi.org. OpenCPI is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.