Intel® Quartus® Prime Pro Edition User Guide: Platform Designer

ID 683609
Date 12/20/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

8.2.5. Parameter Properties

Type Name Description
Boolean AFFECTS_ELABORATION Set AFFECTS_ELABORATION to false for parameters that do not affect the external interface of the module. An example of a parameter that does not affect the external interface is isNonVolatileStorage. An example of a parameter that does affect the external interface is width. When the value of a parameter changes, if that parameter has set AFFECTS_ELABORATION=false, the elaboration phase (calling the callback or hardware analysis) is not repeated, improving performance. Because the default value of AFFECTS_ELABORATION is true, the provided HDL file is normally re-analyzed to determine the new port widths and configuration every time a parameter changes.
Boolean AFFECTS_GENERATION The default value of AFFECTS_GENERATION is false if you provide a top-level HDL module; it is true if you provide a fileset callback. Set AFFECTS_GENERATION to false if the value of a parameter does not change the results of fileset generation.
Boolean AFFECTS_VALIDATION The AFFECTS_VALIDATION property marks whether a parameter's value is used to set derived parameters, and whether the value affects validation messages. When set to false, this may improve response time in the parameter editor UI when the value is changed.
String[] ALLOWED_RANGES Indicates the range or ranges that the parameter value can have. For integers, The ALLOWED_RANGES property is a list of ranges that the parameter can take on, where each range is a single value, or a range of values defined by a start and end value separated by a colon, such as 11:15. This property can also specify legal values and display strings for integers, such as {0:None 1:Monophonic 2:Stereo 4:Quadrophonic} meaning 0, 1, 2, and 4 are the legal values. You can also assign display strings to be displayed in the parameter editor for string variables. For example, ALLOWED_RANGES {"dev1:Cyclone IV GX""dev2: Stratix® V GT"}.
String DEFAULT_VALUE The default value.
Boolean DERIVED When true, indicates that the parameter value can only be set by the IP component, and cannot be set by the user. Derived parameters are not saved as part of an instance's parameter values. The default value is false.
String DESCRIPTION A short user-visible description of the parameter, suitable for a tooltip description in the parameter editor.
String[] DISPLAY_HINT Provides a hint about how to display a property. The following values are possible:
  • boolean--for integer parameters whose value can be 0 or 1. The parameter displays as an option that you can turn on or off.
  • radio--displays a parameter with a list of values as radio buttons instead of a drop-down list.
  • hexadecimal--for integer parameters, display and interpret the value as a hexadecimal number, for example: 0x00000010 instead of 16.
  • fixed_size--for string_list and integer_list parameters, the fixed_size DISPLAY_HINT eliminates the add and remove buttons from tables.
String DISPLAY_NAME This is the GUI label that appears to the left of this parameter.
String DISPLAY_UNITS This is the GUI label that appears to the right of the parameter.
Boolean ENABLED When false, the parameter is disabled, meaning that it is displayed, but greyed out, indicating that it is not editable on the parameter editor.
String GROUP Controls the layout of parameters in GUI
Boolean HDL_PARAMETER When true, the parameter must be passed to the HDL IP component description. The default value is false.
String LONG_DESCRIPTION A user-visible description of the parameter. Similar to DESCRIPTION, but allows for a more detailed explanation.
String NEW_INSTANCE_VALUE This property allows you to change the default value of a parameter without affecting older IP components that have did not explicitly set a parameter value, and use the DEFAULT_VALUE property. The practical result is that older instances continue to use DEFAULT_VALUE for the parameter and new instances use the value that NEW_INSTANCE_VALUE assigns.
String SV_INTERFACE_PARAMETER

This parameter is used in the SystemVerilog interface instantiation.

Example:

set_parameter_property my_parameter SV_INTERFACE_PARAMETER my_sv_interface
String[] SYSTEM_INFO Allows you to assign information about the instantiating system to a parameter that you define. SYSTEM_INFO requires an argument specifying the type of information requested, <info-type> .
String SYSTEM_INFO_ARG Defines an argument to be passed to a particular SYSTEM_INFO function, such as the name of a reset interface.
(various) SYSTEM_INFO_TYPE Specifies one of the types of system information that can be queried. Refer to System Info Type Properties.
(various) TYPE Specifies the type of the parameter. Refer to Parameter Type Properties.
(various) UNITS Sets the units of the parameter. Refer to Units Properties.
Boolean VISIBLE Indicates whether or not to display the parameter in the parameterization GUI.
String WIDTH For a STD_LOGIC_VECTOR parameter, this indicates the width of the logic vector.