You copied the Doc URL to your clipboard.

Set up an Iris connection for models supplied in Arm Development Studio

Information in this article applies to:

  • Arm Development Studio


How do I use Iris to connect a model that is supplied with Arm Development Studio?


Set up an Iris debug and trace connection with one of the following Arm Development Studio versions:

  • Arm Development Studio 2019.1

  • Arm Development Studio 2019.b


What is Iris?

Iris is a new interface for debug and trace from Arm.

In Arm Development Studio, you can connect to the supplied Fixed Virtual Platforms (FVPs) using either the Component Architecture Debug Interface (CADI) or the new Iris interface.

Currently, CADI is set up as the default interface to connect to models. The Iris debug and trace interface complements and will, in time, replace the existing debug API, which is CADI, and trace API, which is the Model Trace Interface ( MTI).

To enable the Iris interface, see the steps in the following section: How to enable Iris connections in Development Studio.

Known issues

The following features are not supported in Arm Development Studio 2019.1, but will be supported in a future release:

  • Trace

  • CPU cache visibility

How to enable Iris connections in Arm Development Studio

The following steps show you how to:

  • Create a configuration database and customize it.

  • Take an existing CADI configuration and modify it so that it applies to Iris.

  • Create a debug configuration and connect to it.

You can apply these instructions to any FVP that implements both the CADI and Iris interfaces.

Before you begin

You must start from an existing configuration database entry for the FVP which uses the CADI interface.

This example uses:

  • A new custom configuration database. You can either use an existing configuration database or create a new one. Arm recommends creating a new configuration database to keep your customized database entries separate.

  • The configuration files for the Cortex-A72 (Base_A72x1) Arm FVP (installed with Arm DS).
    You can locate this in your Arm Development Studio installation folder under:

    <installation directory>/sw/debugger/configdb/Boards/Arm FVP (Installed with Arm DS)/Base_A72x1


  1. Create a new configuration database in Arm Development Studio:

    1. From the main menu, select File > New > Other.

    2. In the New dialog box, select Configuration Database, and click Next.

    3. Enter a Database Name for the configuration database. For example, MyConfigDB.

    4. Click Finish.

      You can see the configuration database in the Project Explorer view, as shown in the following screenshot:


  2. In the configuration database you just created, expand the tree. Create a new folder under Boards and give it a name. For example, Iris_models, as shown in the following screenshot:


  3. Copy the Base_A72x1 model configuration files folder into the Iris_models folder in your configuration database. You can locate the Base_A72x1 model configuration folder in your Arm Development Studio installation folder under:

    <installation directory>/sw/debugger/configdb/Boards/Arm FVP (Installed with Arm DS)/Base_A72x1.

  4. In the File and Folder Operation dialog box which appears, select Copy files and folders, and click OK.

  5. Create a new Iris configuration XML file with the following content. Give it a name, for example iris_config.xml:

    <?xml version="1.0" encoding="UTF-8"?>
    <!--Copyright (C) 2009-2019 ARM Limited. All rights reserved.-->
    <?RVConfigUtility MajorVersion = "1" MinorVersion = "0" PatchVersion = "0"?>
            <rddi type="rddi-debug-iris"/>

    Note: The preceding example uses FVP_Base_Cortex_A72x1 as the FVP. Change this to the appropriate name for your FVP.

  6. In the Base_A72x1 FVP configuration folder, open the project_types.xml file and:

    • Locate the CDB:// reference to the cadi_config.xml file and change it to iris_config.xml (The file that you created as part of Step 5).

    • For each debug activity, remove references to trace capabilities:

      <param default="options.traceBuffer.traceCaptureDevice" id="dtsl_tracecapture_option" type="string" visible="false"/>

    • For each debug activity, add the following after the <param> element with the id=”model params”:

      <param default="" id="model_connection_address" type="string" visible="true">
           <name>Connection address</name>
           <description>Connect debugger to a model that is already running on the specified connection address.</description>
      <param default="" id="connect_existing_model" type="string" visible="false">
           <name>Connect to existing running model</name>
           <description>Connect to an existing running model</description>
      <param default="1" id="model_iris" type="string" visible="false"/>
  7. In the Project Explorer view, navigate to the f older in the configuration database for your model , locate the file , and remove any references to trace and cache set up and configuration.

    As an example, see this file. This file is customised for the FVP_Base_Cortex_A72x1 that is provided with Arm Development Studio. You can locate the original file in your Arm Development studio installation folder at: <installation_folder>/sw/debugger/configdb/Boards/Arm FVP (Installed with Arm DS)/Base_A72x1/ and compare the differences.

  8. After making changes to your configuration, rebuild your configuration database:

    1. From the Arm DS main menu, select Window > Preferences > Arm DS > Configuration Database to open the Preferences dialog box.

    2. Confirm that your configuration database exists in the User Configuration Databases list.

    3. Click Rebuild Database.


  9. Create a new Connect only debug configuration to test your changes:

    1. From the main menu, select Run > Debug Configurations....

    2. In the Connections tab:

      1. Give the debug configuration a name.

      2. In the Select target area , select the model configuration you created as part of the initial steps.

      3. In the Connections area, select Launch a new model .

    3. In the Debugger tab, select Connect only .

    4. Click Debug and debug as usual.





Related Information


Was this page helpful? Yes No