Customization GUI - 2024.1 English

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

Document ID
UG1118
Release Date
2024-06-19
Version
2024.1 English

The Customization GUI page, shown in the following figure, provides an environment for the GUI customization of your custom IP. This page lets you customize the layout by adding display pages, parameter groupings, and text fields.

After you setup the parameters of your IP in the Customization Parameters page, you can customize the GUI to change how you interact with your custom IP.

Initially, the Customization GUI page generates a layout with all the viewable parameters displayed on a single page of the GUI, as shown in the following figure:

Figure 1. Package IP Window: Customization GUI Page

The two columns that display in the Customization GUI page are:

Layout
A hierarchical display of the layout which allows for modification of the Re-customize IP dialog box.
Preview
A preview display of the Re-customize IP dialog box of the custom IP.

The Layout column displays a hierarchical view of the Re-customize IP dialog box components.

Within a Window component, which is the top-level to which to associate the customization components, there are a total of four components that you can create to customize the display of your custom IP GUI:

Page
An individual page to display the parameters of the custom IP.
Group
A collection of parameters to display in a single group.
Parameter
A parameter of the custom IP.
Text
A text field to display any necessary information in the GUI.

Each component can be associated hierarchically to other components within the customization layout. The Group, Parameter, and Text components can be within a Page or Group. The Page component can only be a child of the Window component.

The Preview area shows you a real-time feedback view of the customization GUI as it would appear if the IP was customized through the IP catalog.

The components in the Preview display in the same order in which they are arranged in the Layout. You can change the order in which the components display by dragging the components in the Layout column to the location you want.

The Customization GUI page retains its information, thereby allowing for a simple iterative process for updating the custom IP because it only affects the parameters that were added or removed.