Compiling a Model for Hardware Co-Simulation - 2024.1 English

Vitis Model Composer User Guide (UG1483)

Document ID
Release Date
2024.1 English

The starting point for hardware co-simulation is the Vitis Model Composer model or subsystem you would like to run in hardware. A model can be co-simulated if it meets the requirements of the underlying hardware board. The model must include a Model Composer Hub block; this block defines how the model should be compiled into hardware.

For information on how to use the Model Composer Hub, see Compiling and Simulating Using the Model Composer Hub.

To compile your Vitis Model Composer model for hardware co-simulation, perform the following:

  1. Double-click the Vitis Model Composer Hub block to open the Model Composer Hub dialog box.
    Generated by Your Tool
  2. In the Hardware Selection tab, click the button next to the Select Hardware field to open the Device Chooser.
  3. In the Boards tab, select a Board.

    The boards displaying in the Board list are:

    • All of the boards installed as part of Vivado.
    • Any custom boards you have created in Vivado.
    • Any Partner boards you have purchased and enabled in Vivado.

    For a Partner board or a custom board to appear in the Board list, you must configure Vitis Model Composer to access the board files that describe the board. Board awareness in Model Composer is detailed in Specifying Board Support in Model Composer.

    To compile for hardware co-simulation, you must select a Board. You cannot select a Part or Platform.

  4. Click OK to close the Device Chooser.
  5. In the Code Generation pane, select the desired HDL subsystem from the list on the left.
  6. In the Export tab, select Hardware Co-Simulation (JTAG) as the Export Type.
  7. If you will use burst mode for a faster hardware co-simulation run, click the button next to the Compilation Type field, select Burst Mode, and enter a FIFO depth for the burst mode operation. Then click OK to close the Hardware Co-Simulation Settings dialog box.

    For a description of the burst mode, see Burst Data Transfers for Hardware Co-Simulation.

    Generated by Your Tool
    Important: To perform a burst mode hardware co-simulation, you must create a test bench by checking the Generate testbench box on the Export tab of the Vitis Model Composer Hub block.
  8. If you want to create a testbench as part of the compilation, select Generate testbench on the Export tab. If you select Generate testbench, the compilation will automatically create an example testbench for you. You can also create your own test bench for hardware co-simulation (see M-Code Access to Hardware Co-Simulation).
  9. Click the Export button.

    The code generator produces an FPGA configuration bitstream for your design that is suitable for hardware co-simulation. Model Composer not only generates the HDL and netlist files for your model during the compilation process, but it also runs the downstream tools necessary to produce an FPGA configuration file.

    The configuration bitstream contains the hardware associated with your model, and also contains additional interfacing logic that allows Model Composer to communicate with your design using a physical interface between the board and the PC. This logic includes a memory map interface over which Model Composer can read and write values to the input and output ports on your design. It also includes any board-specific circuitry that is required for the target FPGA board to function correctly.

    When the Compilation finishes the results are as follows:

    • If you have not selected Burst mode in step 7 above (standard mode), a JTAG Cosim hardware co-simulation block will appear in a separate window. Drag (or Copy and Paste) the Hardware Cosim block into your Simulink model. The Hardware Cosim block will enable you to perform hardware co-simulation from within the Simulink window.

      For a description of the hardware co-simulation block, see Hardware Co-Simulation Blocks.

      Figure 1. Hardware Co-Simulation Library Block

      If you selected the Generate testbench option for compilation, an M-Code HWCosim example test bench will also be generated (see M-Code Access to Hardware Co-Simulation) by the compilation. You can use this test bench to perform hardware co-simulation, or customize this test bench to develop a test bench of your own.

    • If you have selected Burst mode in step 7 above (burst mode), no hardware co-simulation block will appear. When you perform the burst mode co-simulation, you will use the MATLABĀ® M-code test bench placed in the target directory during compilation.
      • If you compiled the top-level design the test bench will be named:
      • If you compiled a subsystem of the design the test bench will be named:

      The compilation has prepared the Simulink model for performing hardware co-simulation.

      To perform the hardware co-simulation, proceed as follows: