PG API Examples - 2024.1 English

Vitis Model Composer User Guide (UG1483)

Document ID
Release Date
2024.1 English

Hello World

In this example, you will run the PG API in the learning mode where you can type the commands in the MATLABĀ® command shell.

  1. To start a new learning session, in MATLAB command console, run: xBlock.
  2. Type the following three commands in MATLAB command console to create a new Subsystem named 'Subsystem' inside a new model named 'untitled'.
    [a, b] = xInport('a', 'b'); 
    s = xOutport('s'); 
    adder = xBlock('AddSub', struct('latency', 1), {a, b}, {s});
    Figure 1. Subsystem Example

The above commands create the Subsystem with two Simulink Inports a and b, an adder block having a latency of one, and a Simulink Outport s. The two Inports source the adder which in turn sources the Subsystem outport. The AddSub parameter refers to the AddSub block inside the xbsIndex_r4 library. By default, if the full block path is not specified, xBlock will search xbsIndex_r4 and built-in libraries in turn. The library must be loaded before using xBlock. So use load_system to load the library before invoking xBlock.

Tip: If you type adder in the MATLAB console, Model Composer will print a brief description of the adder block to the MATLAB console and the block is highlighted in the Simulink diagram. Similarly, you can type a, b, and s to highlight Subsystem Inports and Outports.


  1. Run this example in the learning mode. To start a new learning session, run: xBlock.
  2. Type the following commands in the MATLAB console window to create a multiply-accumulate function in a new Subsystem.
    [a, b] = xInport('a', 'b'); 
    mac = xOutport('mac'); 
    m = xSignal; 
    mult = xBlock('Mult', struct('latency', 0, 'use_behavioral_HDL', 'on'), {a, b}, 
    acc = xBlock('Accumulator', struct('rst', 'off', 'use_behavioral_HDL', 'on'), {m}, 

By directing Model Composer to generate behavioral HDL, the two blocks should be packed into a single DSP48 block. As of this writing, Vivado synthesis only does so if you force the multiplier block to be combinational.

Figure 2. Forcing a Mult Block
Note: If you do not close the model that is created in example 1, example 2 is created in a model named untiltled1. Otherwise, a new model, untitled, is created for this example.
Tip: The PG API provides functions to get information about blocks and signals in the generated Subsystem. After each of the following commands, observe the output in the MATLAB console and the effect on the Simulink diagram.
mult_ins = mult.getInSignals 
src_a = mult_ins{1}.getSrc 
m_dst = m.getDst 

MACC in a Masked Subsystem

If you want a particular Subsystem to be generated by the PG API and pass parameters from the mask parameters of that Subsystem to PG API, you need to run the PG API in production mode, where you need to have a physical M-function file and pass that function to the xBlock constructor.

  1. Create the top-level PG API M-function file MACC_sub.m with the following lines.
    function MACC_sub(latency, nbits) 
    [a, b] = xInport('a', 'b'); 
    mac = xOutport('mac'); 
    if latency <= 0 
       error('latency must be positive'); 
    elseif latency == 1 
       a_in = a; b_in = b; 
       [a_in, b_in] = xSignal; 
       dblock1 = xBlock('Delay', struct('latency', latency - 1, 'reg_retiming', 'on'), 
    {a}, {a_in}); 
       block2 = xBlock('Delay', struct('latency', latency - 1, 'reg_retiming', 'on'), 
    {b}, {b_in}); 
    m = xSignal; 
    mult = xBlock('Mult', struct('latency', 0, 'use_behavioral_HDL', 'on'), {a_in, 
    b_in}, {m}); 
    acc = xBlock('Accumulator', struct('rst', 'off', 'n_bits', nbits, 
    'use_behavioral_HDL', 'on'), {m}, {mac});
    Figure 3. Top-Level PG API M-Function File

  2. To mask the Subsystem defined by the script, add two mask parameters latency and nbits.

  3. Then put the following lines to the mask initialization of the Subsystem.
    config.source = str2func('MACC_sub'); 
    config.toplevel = gcb; 
    xBlock(config, {latency, nbits});

    In the production mode, the first argument of the xBlock constructor is a MATLAB struct for configuration, which must have a source field and a toplevel field. The source field is a function pointer pointing to the M-function and the toplevel is a string specifying the Simulink Subsystem. If the top-level field is 1, an untitled model is created and a Subsystem inside that model is created.

    Alternatively you can use the MATLAB struct call to create the toplevel configuration:

    xBlock(struct('source', str2func(MACC_sub), 'toplevel', gcb),{latency, 

    Then click OK.

    You'll get the following Subsystem.

    Generated by Your Tool
  4. Set the mask parameters as shown in the following figure, then click OK.

    The following diagram is generated:

    Generated by Your Tool
Tip: Open MACC_sub.m in the MATLAB editor to debug the function. By default the xBlock constructor will do an auto layout in the end. If you want to see the auto layout every time a block is added, invoke the toplevel xBlock as the following:
config.source = str2func('MACC_sub'); 
config.toplevel = gcb; 
config.debug = 1; 
xBlock(config, {latency, nbits});

By setting the debug field of the configuration struct to be 1, you run the PG API in debug mode where every action will trigger an auto layout.

Tip: Most often you only want to re-generate the Subsystem if needed. The xBlock constructor has a caching mechanism. You can specify the list of dependent files in a cell array, and set the depend field of the toplevel configuration with this list. If any file in the 'depend' list is changed, or the argument list that passed to the toplevel function is changed, the Subsystem is re-generated. If you want to have the caching capability for the MACC_sub, invoke the toplevel xBlock as the following:
config.source = str2func('MACC_sub'); 
config.toplevel = gcb; 
config.depend = {'MACC_sub.m'}; 
xBlock(config, {latency, nbits});

The depend field of the configuration struct is a cell array. Each element of the array is a file name. You can put a p-file name or an M-file name. You can also put a name without a suffix. The xBlock will use the first in the path.