Migrating from the Classic Vitis IDE to Vitis Unified IDE - 2023.2 English

Vitis Unified Software Platform Documentation: Embedded Software Development (UG1400)

Document ID
Release Date
2023.2 English

The Vitis Unified IDE workspace is designed to ensure version control optimization. Hence, the workspace and project metadata is incompatible with classic IDE. To facilitate the migration of projects, a new action is added to the classic IDE under Vitis > Export Workspace to Unified IDE.

The tool launches a dialog with a list of all identified projects. All the projects have an associated status with them to inform you if the projects can be exported.

Execute the following steps to migrate a classic Vitis IDE project to Unified Vitis IDE.

  1. Open the workspace with Classic Vitis IDE.
  2. Select Vitis > Export Worksapce to Unified IDE. Once you choose this, a dialog box appears.

  3. In the dialog setup page, specify the migration target workspace location.

  4. Click Finish. A migration script is generated in the specified location.
  5. Open a terminal with Vitis environment settings, type the following command and hit enter.
    vitis -s migrate.py
    Vitis would run the migration script. The running process takes some time. Once completed, you can see the migrated components and projects in this workspace directory. All the project resources are copied to the new location.
Table 1. Supported Projects and Limitations
Project type Limitation Workaround
Platform Local changes to BSP sources are not be migrated to the new workspace. A new BSP is created, and the settings are applied on the new BSP. Copy the sources to the new BSP manually.
Any embedded software repositories added to Vitis IDE cannot be migrated. A warning is shown in the wizard if you have any local sw repos. All software repositories need to be migrated to lopper first. The path to the migrated repository can be added to the migration script (refer below screenshot for an example) to migrate the projects.
IP drivers included in XSAs which were created with 2023.1 or older releases will encounter compilation errors. Need to regenerate the XSA with 2023.2 release.
Embedded Application Applications referring to platforms that are outside the current workspace cannot be migrated. Migrate the platform first and update the application to use the new platform before migrating the application.
If your application relies on the device ID, some modifications might be required in the application source code. This is because the Device ID in the xparameter.h file has is deprecated. For more details, refer to: Porting Guide for embeddedsw Components System Device Tree Based Build Flow (UG1647). Refer to Standalone Application Component Migration Details
Debug Configurations cannot be taken over to Unified IDE Create launch configuration in Vitis Unified IDE
Note: If you wish to continue using the classic Vitis IDE, you can launch the classic Vitis IDE with the following command
vitis --classic
Note: To use classic Vitis IDE, install the full Vitis Software Platform.

For more information on Vitis Unified IDE, refer to Launching the Vitis Unified IDE and Vitis Unified IDE View and Feature.