Operator AppletProperties

The operator AppletProperties has no inputs and no outputs. It controls the applet and the board hardware setup.

The operator also provides a set of parameters that describe the applet (by partly user defined, partly automatically generated values).

This operator is mandatory in every design and is automatically instantiated by VisualApplets. The operator cannot be deleted.

Available for Hardware Platforms
mE5 marathon VCLx
mE5 marathon VCL
mE5 marathon VCX-QP
mE5 marathon VF2
LightBridge VCL
mE5 ironman VQ8-CXP6D
mE5 ironman VQ8-CXP6B
mE5 ironman VD8-PoCL

[Note] Available Parameters

Operator AppletProperties provides a specific set of parameters for every hardware platform.

The parameter descriptions below state for which hardware platforms a specific parameter is available.

I/O Properties

Property Value
Operator Type None (since there are no Inputs or Outputs)

Supported Link Format

None

Parameters

VisualAppletsVersion
Type static read parameter
Default
Range

Version number of used VisualApplets version.

[Note] Availability

mE5 marathon VCLx, mE5 marathon VCL, mE5 marathon VCX-QP, mE5 marathon VF2, LightBridge VCL, mE5 ironman VD8-PoCL, mE5 ironman VQ8-CXP6D, and mE5 ironman VQ8-CXP6B

ProjectName
Type static read parameter
Default
Range

Name of the project as specified in menu Design, menu item Properties.

[Note] Availability

mE5 marathon VCLx, mE5 marathon VCL, mE5 marathon VCX-QP, mE5 marathon VF2, LightBridge VCL, mE5 ironman VD8-PoCL, mE5 ironman VQ8-CXP6D, and mE5 ironman VQ8-CXP6B

AppletVersion
Type static read parameter
Default
Range

Version as specified in menu Design, menu item Properties.

[Note] Availability

mE5 marathon VCLx, mE5 marathon VCL, mE5 marathon VCX-QP, mE5 marathon VF2, LightBridge VCL, mE5 ironman VD8-PoCL, mE5 ironman VQ8-CXP6D, and mE5 ironman VQ8-CXP6B

AppletVendor
Type static read parameter
Default
Range

Directly in the Module Properties dialog of this operator, you can enter information on the Applet vendor.

[Note] Availability

mE5 marathon VCLx, mE5 marathon VCL, mE5 marathon VCX-QP, mE5 marathon VF2, LightBridge VCL, mE5 ironman VD8-PoCL, mE5 ironman VQ8-CXP6D, and mE5 ironman VQ8-CXP6B

AppletAuthor
Type static read parameter
Default
Range

Directly in the Module Properties dialog of this operator, you can enter information on the Applet author.

[Note] Availability

mE5 marathon VCLx, mE5 marathon VCL, mE5 marathon VCX-QP, mE5 marathon VF2, LightBridge VCL, mE5 ironman VD8-PoCL, mE5 ironman VQ8-CXP6D, and mE5 ironman VQ8-CXP6B

DesignClock
Type static read parameter
Default 125
Range [125;312.5]

The parameter represents the design system clock frequency in Mega Hertz. You can alter the design system clock frequency in VisualApplets, menu Design, menu item Change FPGA Clock. Using higher frequency settings as 135 MHz may result in a timing violation. In this case, reduce frequency.

[Note] Availability

mE5 marathon VCLx, mE5 marathon VCL, mE5 marathon VCX-QP, mE5 marathon VF2, LightBridge VCL

BuildTime
Type static read parameter
Default
Range

The BuildTime parameter is an automatically generated string showing when the applet has been build (date and time of latest net list generation).

The parameter value is only visible in the Runtime. The following image shows the formatting of the string:

[Note] Availability

mE5 marathon VCLx, mE5 marathon VCL, mE5 marathon VCX-QP, mE5 marathon VF2, LightBridge VCL, mE5 ironman VD8-PoCL, mE5 ironman VQ8-CXP6D, and mE5 ironman VQ8-CXP6B

AppletUid
Type static read parameter
Default
Range

Unique ID of the applet. A new ID is created with every new build (if the precondition check is set).

[Note] Availability

mE5 marathon VCLx, mE5 marathon VCL, mE5 marathon VCX-QP, mE5 marathon VF2, LightBridge VCL, mE5 ironman VD8-PoCL, mE5 ironman VQ8-CXP6D, and mE5 ironman VQ8-CXP6B

PcieInterfaceType (ironman platforms)
Type static write parameter
Default Generation_2
Range {Generation_1, Generation_2}

The parameter PcieInterfaceType allows you to select the PCIe interface type and thus the supported DMA bandwidth.

Generation_2 (default) stands for the PCIe Generation 2 protocol and provides a bandwidth of 3,600,000 bytes/s.

Generation_1 stands for PCIe Generation 1 protocol and provides a bandwidth of 1,800,000 bytes/s.

Generation_1 designs utilize slightly less FPGA resources. It is much easier to achieve timing closure for the applet with a Generation_1 design. Generation_2 provides maximal performance, but makes it more challenging to achieve timing closure for the applet. Multiple place and route synthesis runs will probably be necessary to meet the timing.

[Note] Availability

mE5 ironman VD8-PoCL, mE5 ironman VQ8-CXP6D, and mE5 ironman VQ8-CXP6B

GpioType
Type dynamic write parameter
Default OpenDrain
Range {OpenDrain, PushPull}

This parameter allows the user to select the circuitry type for the external GPIO connector. In PushPull mode, the GPIOs are driven directly.

[Note] Parameter only effects GPIO connector

This parameter has no effect on Front GPIO connector. Only the GPIO connector is influenced by this parameter.

[Note] Availability

mE5 marathon VCLx, mE5 marathon VCL, mE5 marathon VCX-QP, mE5 marathon VF2, mE5 ironman VD8-PoCL, mE5 ironman VQ8-CXP6D, and mE5 ironman VQ8-CXP6B

PcieInterfaceType (marathon and LightBridge platforms)
Type static write parameter
Default Generation_2
Range {Generation_1, Generation_2}

The parameter PcieInterfaceType allows you to select the PCIe interface type and thus the supported DMA bandwidth.

Generation_1: The applet only supports PCIE generation 1. Thus, the maximum DMA transmission bandwidth is ca. 900 MByte/s (1MByte = 1^10Byte). The DmaToPC operator is limited so that LinkParallelism x LinkPixelWidth needs to be <= 64 bit.

Generation_2: The applet supports PCIE generation 2. Thus, the maximum DMA transmission bandwidth is ca. 1800 MByte/s (1MByte = 1^10Byte). The DmaToPC operator is limited so that LinkParallelism x LinkPixelWidth needs to be <= 128 bit.

The implementation of Generation_1 consumes less resources than the implementation of Generation_2. The Generation_1 mode is helpful in designs that do not need the high bandwidth of Generation_2, but are short of resources.

[Note] Availability

mE5 marathon VCLx, mE5 marathon VCL, mE5 marathon VCX-QP, mE5 marathon VF2, and LightBridge VCL.

BuildTimeStamp
Type static write parameter
Default
Range
[Note] Visibility

This parameter is not displayed in the operator's parameter list.

However, the parameter is visible in the runtime.

BuildTimeStamp is an automatically generated identification number. It's a 32-bit time stamp that can be read out of the applet during runtime for checking the consistency between the loaded applet and the loaded applet runtime environment.

[Note] Availability

mE5 marathon VCLx, mE5 marathon VCL, mE5 marathon VCX-QP, mE5 marathon VF2, LightBridge VCL, mE5 ironman VD8-PoCL, mE5 ironman VQ8-CXP6D, and mE5 ironman VQ8-CXP6B

ProjectNameHash
Type static read parameter
Default
Range
[Note] Visibility

This parameter is not displayed in the operator's parameter list.

However, the parameter is visible in the runtime.

32-bit hash over the entry in ProjectName (menu Design, menu item Properties). This value can be read out of the applet during runtime for checking the consistency between the loaded applet and the loaded applet runtime environment.

[Note] Availability

mE5 marathon VCLx, mE5 marathon VCL, mE5 marathon VCX-QP, mE5 marathon VF2, LightBridge VCL, mE5 ironman VD8-PoCL, mE5 ironman VQ8-CXP6D, and mE5 ironman VQ8-CXP6B

AppletUidHigh
Type static read parameter
Default
Range
[Note] Visibility

This parameter is not displayed in the operator's parameter list.

However, the parameter is visible in the runtime.

Parameter AppletUid represents a 128-bit number. The upper 64 bit of this number are given out as a number in AppletUidHigh.

[Note] Availability

mE5 marathon VCLx, mE5 marathon VCL, mE5 marathon VCX-QP, mE5 marathon VF2, LightBridge VCL, mE5 ironman VD8-PoCL, mE5 ironman VQ8-CXP6D, and mE5 ironman VQ8-CXP6B

AppletUidLow
Type static read parameter
Default 1
Range {0; 2^32 – 1}
[Note] Visibility

This parameter is not displayed in the operator's parameter list.

However, the parameter is visible in the runtime.

Parameter AppletUid represents a 128-bit number. The lower 64 bit of this number are given out as a number in AppletUidLow.

[Note] Availability

mE5 marathon VCLx, mE5 marathon VCL, mE5 marathon VCX-QP, mE5 marathon VF2, LightBridge VCL, mE5 ironman VD8-PoCL, mE5 ironman VQ8-CXP6D, and mE5 ironman VQ8-CXP6B

Examples of Use

The use of operator AppletProperties is shown in the following examples: