AN 1002: Sharing Platform Designer Packaged Subsystems

Download PDF
ID 786899
Date 10/02/2023
Public
Document Table of Contents
Document Table of Contents x
1. Answers to Top FAQs 2. About This Application Note 3. Packaged Subsystems Overview 4. Packaged Subsystem Author Flow 5. Packaged Subsystem User Flow 6. Document Revision History of AN 1002: Sharing Platform Designer Packaged Subsystems
2. About This Application Note x
2.1. Document Prerequisites
3. Packaged Subsystems Overview x
3.1. User Personas for Packaged Subsystems 3.2. Terminology for Packaged Subsystems
4. Packaged Subsystem Author Flow x
4.1. Step 1: Create a Project and Platform Designer System 4.2. Step 2: Add Components to the System 4.3. Step 3: Connect Components in the System 4.4. Step 4: Create and Configure a Packaged Subsystem 4.5. Step 5: Revise a Packaged Subsystem
4.4. Step 4: Create and Configure a Packaged Subsystem x
4.4.1. Editing the Packaged Subsystem 4.4.2. Step 4a: Add Two Checkbox Controls 4.4.3. Step 4b: Enable or Disable Modules and Checkboxes 4.4.4. Step 4c: Run run_system_script 4.4.5. Step 4d: Iterate Over All Parameters 4.4.6. Step 4e: Setting DisplayPort IP Functionality 4.4.7. Step 4f: Make Packaged Subsystem Unlockable 4.4.8. Step 4g: Sync System Infos, Assign Base Addresses, and Save
5. Packaged Subsystem User Flow x
5.1. Step 1: Create the User Project and System 5.2. Step 2: Add Components to the User System 5.3. Step 3: Instantiate the Packaged Subsystem 5.4. Step 4: Unlock the Packaged Subsystem 5.5. Step 5: Integrate the Top Hierarchy of the System 5.6. Step 6: Generate HDL and Run Synthesis
1. Answers to Top FAQs
2. About This Application Note
3. Packaged Subsystems Overview
4. Packaged Subsystem Author Flow
5. Packaged Subsystem User Flow
6. Document Revision History of AN 1002: Sharing Platform Designer Packaged Subsystems

3.2. Terminology for Packaged Subsystems

Table 1.  Packaged Subsystems Terminology
Term Description
Packaged Subsystem

A packaged subsystem combines everything about a Platform Designer system into a single, compressed .qcp file for sharing and reuse in other Platform Designer systems. The packaged subsystem author can optionally lock the packaged subsystem for viewing or modification by the packaged subsystem user.

Packaged Subsystem Author

The creator of a Platform Designer packaged subsystem that saves a system or subsystem as a packaged subsystem (.qcp) for sharing and reuse. The packaged subsystem author can set the UNLOCKABLE property to prevent or permit packaged subsystem editing for packaged subsystem users.

Packaged Subsystem Sharing

A packaged subsystem author can share a package subsystem with a packaged subsystem user by sharing the packaged subsystem .qcp file or by providing the IP search path for the user to specify when launching Platform Designer.

Packaged Subsystem User

Reuses a packaged subsystem by instantiating and connecting it to other components in another Platform Designer system. The packaged subsystem user may be able to modify the parameters or unlock the packaged subsystem for full editing control, depending on the packaged subsystem author specifications.

Package-level parameters Parameters that appear in the parameter editor GUI when the packaged subsystem user instantiates or selects the packaged subsystem.
run_system_script An important command for modifying the internal system inside a subsystem, run_system_script runs Platform Designer scripting commands such that all commands within curly braces run as separate scripts.
Subsystem

A standard unpackaged subsystem that you create in Platform Designer of the file type .qsys.

Subcomponent parameters

Parameters of the components of a packaged subsystem.

System A standard top-level system that you create in Platform Designer of the file type .qsys.
Divable The packaged subsystem author can use the DIVABLE property to specify whether the packaged subsystem user can dive in and view the internals of the packaged subsystem.
Unlockable

The packaged subsystem author can use the UNLOCKABLE property to specify whether the packaged subsystem user can unlock the packaged subsystem for full editing control.

Level Two Title