Editing a Parameter - 2024.1 English

Vivado Design Suite User Guide: Creating and Packaging Custom IP (UG1118)

Document ID
UG1118
Release Date
2024-05-30
Version
2024.1 English

You can customize parameters in the Customization Parameters page for how it displays in the IP Customization GUI. You can edit the display name, data format, data range, default value, and visibility.

  1. In the Customization Parameters page, right-click the respective parameter and select Edit Parameter.

    The Edit IP Parameter dialog box opens with the detailed information set for the selected parameter.



  2. Select from the options that are available to define the use of the parameter for the custom IP.

    Depending upon the selections within the dialog box, certain options become unavailable. The following options in the dialog box are associated with the display properties of the parameter.

    Name
    This is the name of the parameter. This is a read-only property.
    Visible in Customization GUI
    When checked, the parameter becomes visible in the Customization GUI.
    Show Name
    When checked, the display name of the parameter lists next to the display object in the Customization GUI.
    Display Name
    Displays in the Customization GUI for the parameter. When the IP is customized, this is the text that displays next to the value that you can set. This can be a simple name or a small description.
    Tooltip
    Text that displays when you hover over the parameter in the Customization GUI. This can be a simple name or a small description of the parameter.
  3. Select from the following options that are associated with the data formatting and restrictions for the parameter.
    Format
    Defines the data format of the parameter. The data format selection determines the supported values the user can use to customize the IP. Depending upon the selection, the remaining options adjust, based on the requirements for the format.
    Long
    Integer input
    Float
    Decimal input
    Bool
    Boolean input
    BitString
    Hex input
    String
    String input
    Editable
    Defines if the parameter is editable by the user, or only under certain conditions.
    Yes
    This selection indicates that you can edit the parameter in the Customization GUI. This is the default setting.
    No
    This selection indicates that you cannot edit the parameter in the Customization GUI. If displayed, the parameter is read-only during customization. The value of the parameter is determined by the default value or expression.
    Dependent
    This selection indicates that you can only edit the parameter in the Customization GUI under certain conditions.

    If selected, a new option displays to set the expression as shown in the following figure.

    The evaluated editability expression, if true, allows the parameter to be editable. For more information on setting an editability expression, see Setting a Dependency Expression.

    Dependency
    This defines how the parameter value is determined during customization.
    Yes
    This selection indicates the value of the parameter is dependent on another parameter. If selected, a new option displays to set the expression to evaluate the parameter value, as shown in the following figure. The evaluated dependency expression is used as the parameter value.

    For more information on setting a dependency expression, see Setting a Dependency Expression.

    No
    This selection indicates the value is not dependent on another parameter, and the value is directly set by you or by the default value.
    Specify Range
    Defines the bounds by which the parameter value is set. If not selected, the value can be any value in the selected data format, and the IP Customization GUI does not ensure that the value is within the expected bounds for usage.
    List of values
    This selection limits the value choices for the parameter in a predefined list. The list box defines the valid list of values for the parameter.

    • To add a value to the list, click the Add button . All created elements default the text to value.
    • To change the element text, double-click the value in the list to enable modification. The elements in the list display in the IP Customization GUI in the same order they appear in the list.
    • To change the order of the elements click the element, and select the Move Up button to move the element up by 1 or click the Move Down button to move the element down by 1.
    • To remove an element, select one or more elements in the list, and click the Remove button .
    Range of integers
    This selection limits the value of the parameter to a specific range of numeric integer values. The Minimum and Maximum range restricts the integer values to the user for the parameter, as shown in the following figure.

    A value set outside the specified range within the IP Customization GUI reports as an error. If checked, the Show Range option displays the minimum and maximum range of the integer values in the Customization GUI.

    Pairs
    Limits the value choices for the parameter from a predefined list similar to the List of values restriction; however, you can show the selections in the IP Customization GUI in a different format. A Key/Value pair list controls the value of the parameter (see the following figure).

    • To add a key/value pair to the list, Click the Add button . All created elements default the key to key and the value to value.
    • To change the element text, double-click the element in the list to enable modification. The elements in the list display in the IP Customization GUI in the same order they appear in the list.
    • To change the order of the elements, click the element and select the Move Up button to move the element up by 1, or click the Move Down button to move the element down by 1.
    • To remove an element, select one or more elements in the list and click the Remove button .
  4. Select from the options that describe the display object and the default value of the parameter.
    Show As
    This describes the display object used for the parameter in the Customization GUI. This is a read-only property that is set depending the options defined within the dialog box.
    Layout
    This describes the display layout of a Radio Group. The values are Vertical and Horizontal. In all other fields, Not Applicable displays when Show As is set to all other values.
    Default Value
    This defines the default value for the parameter. If an IP is customized without any modification to the parameters, the parameter is set by the value defined in this option.