You copied the Doc URL to your clipboard.

Running the example plugins

The SoC Designer plugin example folder contains the following plugin examples:

  • GuiPluginExample shows how to create GUI-mode plugins.
  • BatchModePluginExample shows how to create SoC Designer batch-mode plugins.

To run the example plugins provided follow these steps:

  1. Install the provided SoC Designer version supporting plugins and ensure that the MAXSIM_HOME environment variable is pointing to the correct location.
  2. If the plugin DLL/SO library is not already present in the provided package, compile the plugin sources and create the plugin DLLs/SOs.


    The release version of the DLL/SO libraries is typically already provided as part of the plugins package. If you are not debugging the source code of the component, you do not require the debug versions. This step is only shown for completeness.
  3. Copy the plugin DLLs/SOs into the following directories:

    • Copy the release version DLL into %MAXSIM_HOME%/etc/plugins/Release.

      (for Linux, copy the SO into $(MAXSIM_HOME)/etc/plugins/Release).

    • Copy the debug version DLL into %MAXSIM_HOME%/etc/plugins/Debug.

      (for Linux, copy the SO into $(MAXSIM_HOME)/etc/plugins/Debug)


    The DLLs provided in the package are release version and must be placed into the release directory.
  4. Start SoC Designer:

    • For the GUI-mode plugin example:

      1. Open SoC Designer Canvas or SoC Designer Simulator and load any mxp system provided as an example in the gui_plugin_example directory.

      2. Click the Hierarchy toolbar button or select Hierarchy from the Plugins menu. This launches the Hierarchy plugin functionality and displays the hierarchy of the current system in the Output window of SoC Designer Canvas or SoC Designer Simulator.


        To see the output window results in SoC Designer Canvas, you must explicitly open the Output window from the Windows menu of the SoC Designer tool.
      3. Right-click a component and select the Plugins/View ports… context menu. This launches the View ports plugin functionality that opens a dialog showing all the ports of the component selected.

      4. Right-click a component and select the Plugins/Edit parameters… context menu. This opens a dialog with the parameters of the component.
      5. Right-click a component and select the Plugins/Get Dll Path context menu. This opens a dialog and displays the path to the DLL file of the component respectively.
    • For the batch-mode example, perform one of the following:

      • Start SoC Designer Simulator using the following command:

        sdsim –script my_example.mxscr
      • Use the provided batch script called run.bat (Win32) or run.csh (Linux).

      This starts running the my_example.mxscr SoC Designer Simulator script that invokes the example batch-mode plugin.

      The plugin:

      1. Opens the MxStub_example.mxp system.
      2. Displays the hierarchy.
      3. Runs the simulation.
      4. Displays some CAPI profiling results.
      5. Saves the system under a different MXP file.
      6. Opens or runs this other system.


This functionality is described as part of the example plugins that use the provided SoC Designer interfaces. Arm recommends browsing the example plugin source code and using it as a template for your plugin development.
Was this page helpful? Yes No