Migrating from the Classic Vitis IDE to Vitis Unified IDE - 2025.1 English - UG1400

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

Document ID
UG1400
Release Date
2025-05-29
Version
2025.1 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 help you transition, two methods are available for migrating your projects.

Migrate manually (from 2025.1 Onward)

Starting with the 2025.1 release, the Vitis Classic IDE has been removed, and no migration utility is available in this version. If you did not migrate your workspace using the utility in a previous release (2023.2, 2024.1, or 2024.2), you will need to manually recreate your workspace in the Vitis Unified IDE.

To manually migrate your project, follow the steps below:

  • Generate a new XSA file using the latest Vivado tools.

  • Recreate your platform project in the Unified IDE based on the updated XSA file.

  • Recreate your application project using the new platform.

  • Import your application source code into the new project.

  • Build your application and resolve any issues that arise during the build.
    Note: If you encounter any issues related to migration, refer to Standalone Application Component Migration Details
Tip: For a cleaner and more controlled migration process, it is recommended to perform manual migration even if the utility is available in earlier releases.

Migrate Projects Using Previous Version Utility

A migration utility is available in the Classic IDE (versions 2023.2, 2024.1, and 2024.2) to help you migrate your workspace to the Unified IDE. After migrating your project in the Classic IDE, you can then update your hardware platform and application to the current release.

To use this method, follow the steps below.

  1. Open the workspace with the 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.
  6. Open the migrated workspace with Vitis Unified IDE.
  7. Open your platform project in the IDE and locate and open the platform Json file.
  8. Click Switch/Re-read XSA to select the updated XSA file generated with the latest tool version.
    Note: This action regenerates the System Device Tree (SDT) and Board Support Package (BSP) for your applications.
  9. Rebuild your platform and applications.
Table 1. Supported Projects and Limitations when using this utility
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 might encounter compilation errors. Need to regenerate the XSA with 2024.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 the 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 Features.

Migrate manually (from 2025.1 Onward)

Starting with the 2025.1 release, the Vitis Classic IDE has been removed, and no migration utility is available in this version. If you did not migrate your workspace using the utility in a previous release (2023.2, 2024.1, or 2024.2), you will need to manually recreate your workspace in the Vitis Unified IDE.

To manually migrate your project, follow the steps below:

  1. Generate a new XSA file using the latest Vivado tools.
  2. Recreate your platform project in the Unified IDE based on the updated XSA file.
  3. Recreate your application project using the new platform.
  4. Import your application source code into the new project.
  5. Build your application and resolve any issues that arise during the build.
Tip: For a cleaner and more controlled migration process, it is recommend performing manual migration even if the utility is available in earlier releases