An Overview of Downloading and Installing Synergy Platform Tools
There are two different ISDEs available for developing with the Synergy Platform. The Renesas e2 studio ISDE is an eclipse based development environment and leverages the familiar GCC tool flow. The IAR Engineering Workbench for Renesas Synergy (IAR EW for Synergy) is also available and provides the familiar IAR tool flow. Developers can select either of these environments based on their experience and development needs. Both of these advanced ISDE's are available free of charge.
The files needed and installation steps used are slightly different depending on your selected ISDE. Figure 1 illustrates the files needed and installation flow used for the e2 studio 'path' and the IAR EW for Synergy 'path'.
The e2 studio 'path' requires two installations- e2 studio and SSP.
The IAR EW for Renesas Synergy 'path' requires three installations- IAR for RS, SCC and SSP.
The remainder of this how to article will guide you through these steps so that you end up with the ISDE you want to use in your development environment.
Figure 1: Installation Selection and Flow for the Synergy ISDE
1: Download Synergy Software Package related files
- Download the Synergy Software Package (SSP) by navigating to the ‘Synergy Software Package’ menu on the Gallery homepage as shown in Figure 2.
- Press the Download button to see the latest released and preview versions. (The latest official release is SSP v1.3.0.)
- Click the download button and save the installer to your computer.
While the SSP is being downloaded, hover over the ‘Development Tools’ menu as illustrated in Figure 3 below. The Development Tools menu will lead you to the locations for the remaining downloads.
If you want to build the e2 studio-based ISDE:
- Click on the e2 studio ISDE link and download the associated file.
If you want to build the IAR-based ISDE:
- Click on the IAR EW for Synergy link and download the associated file.
- Click on the Renesas Synergy Standalone Configurator (SSC) link and download the associated file.
Figure 3: e2 studio and IAR EW for Renesas Synergy file download selections
2: Install the ISDE and the required Synergy Software
2.1: Install the e2 studio based ISDE
Once the file extraction completes, a new pop-up will appear which will allow you to install the ISDE, or upgrade if you have an older version. Select the ‘Install’ option as shown in Figure 5 to begin the installation wizard.
Figure 5: Installation Selection
Important Note: An active internet connection is required to continue installation from this point. The eclipse IDE must be downloaded from the web and sometimes a corporate firewall may block this step. Refer to the Installation tips at the end of this article for suggestions on what to do if you run into any installation issues.
As is the case with every installer, there is now an option to select where to install the software. Select the desired installation location and press the ‘Next’ button to advance the installer. (Note: Remember where you are installing e2 studio since you will need to install SSP at the same location. One of the most common installation errors is to NOT install the programs at the same root directory). You will see the Device Families installation screen as shown in Figure 6. Select the ‘Renesas Synergy’ check-box and press ‘Next’.
Figure 6: Installation Device family Selection
At this point, you could customize your installation as shown in Figure 7. Just leave the defaults as selected and press ‘Next’.
Figure 7: Selecting Optional Components
The Additional Software screen, shown in Figure 8, is used to choose the most up-to-date GCC Arm® Embedded toolchain. You can select multiple versions for installation, but it is recommended to install the most up-to-date version of the toolchain. Press ‘Next’.
Figure 8: GCC Selection
You now need to accept the Software License Agreement. It is highly recommended that you read the entire agreement. Once the agreement has been read, check the ‘accept’ box and press next as shown in Figure 9.
Figure 9: License Agreement
You can now customize your start menus if you want. The recommendation is to accept the default settings and press ‘Next' (No figure shown).
At this point no changes have occurred to your system. A summary is displayed, as shown in Figure 10. Verify the information and then click 'Install'.
Figure 10: e2 studio Installation Summary
The installer will now go through the installation process as shown in Figure 11. Occasionally additional pop-ups will occur for the installation of third party drivers and the Arm® GCC toolchain. (Remember that an internet connection with access outside the firewall is needed to download the GCC toolchain. Refer to the Installation Tips section at the end of this article if you are not able to download GCC).
Figure 11: e2 studio progress Indication
Towards the end of the installation process, the installer will ask you to select a language. Choose the appropriate language and press ‘OK’ as shown in Figure 12.
Figure 12: Installation Language
Press the ‘Next’ button to continue and then press ‘I Agree’ to accept the License Agreement. Choose an installation location on the next screen and press ‘Install.’ as shown as Figure 13.
Figure 13: GNU Installation Progress
When the installer completes, press the ‘Finish’ button. Launching e2 studio at this time is not necessary since we still need to install the Synergy Software Package (SSP). This completes the installation of e2 studio. Press ‘OK’ to close the installer and complete the installation process. A DOS prompt may open. Type “exit” and press ‘Enter’ on the keyboard to close the window.
Go to step 2.4 to install SSP.
2.2: Install the IAR EW for Synergy based ISDE
IAR EW for Synergy is an alternative development environment that can be used instead of e2 Studio. To install the toolchain Unzip the installer for IAR EW for Synergy which you downloaded earlier and open the executable installer. This will install some temporary files, shown in Figure 14, and then open the installation menu.
If desired, you can now change the installation location as shown in Figure 17. Select the desired program folder name for the Start menu using the "Change" button and press ‘Next’.
Figure 17: Select the Installation Location
When the installation completes, deselect the option to launch the tool immediately and press the ‘Finish’ button and shown in Figure 20.
Figure 20: IAR Installation Finish
Upon pressing ‘Finish’ two separate windows security confirmation boxes may appear as shown in Figure 21. Check the ‘Always trust…’ check box in each pop up window, followed by the ‘Install’ button. This will install the required drivers.
Figure 21: Always Trust for Driver Installation
The IAR Embedded Workbench for Synergy is now installed. Before using the workbench, you must also install the Renesas SSC. Just continue to step 2.3 below.
2.3: Installing the Renesas Synergy Standalone Configurator (SSC)
The SSC provides you with the Synergy Configuration tools within the IAR Embedded Workbench Environment. To begin the installation Unzip the installer for the SSC which you downloaded earlier and open the executable installer. Press the ‘Next’ button, followed by ‘I Agree’ to the License Agreement, to begin the installation process. This is shown in Figure 22.
Figure 22: SSC Setup
On the first installation screen, select the installation location, or use the default, and press the ‘Install’ button. This will immediately begin the installation process. Upon completion, press ‘Close’ to exit the installer. This process can be seen in Figure 23
Figure 23: SSC Completion
The SSC is now installed! Now you need to install SSP. As shown in Figure 1 SSP is required for both tool flow options. There is only one slight difference so both installations can use the below step by step instructions. Proceed to step 2.4 below.
2.4: Installing the Synergy Software Package
The Synergy Software Package contains the baseline RTOS drivers and frameworks that are the foundation for the Synergy Platform. You will not be able to use the Synergy Configurator until the SSP is installed. The SSP will need to be installed for each ISDE that is used! This means that if you are using e2 Studio, you will need to install SSP into the e2 Studio directory. If you are using SSC with IAR EW for Synergy, the SSP needs to be installed into the SSC directory. If both tools are being used, you need to install SSP in both locations! Just follow the below steps and we will guide you through the process no matter what tool flow(s) you want to use.
Unzip the SSP installation file which was downloaded earlier and run the executable installer. Press the ‘Next’ button on the pop up, followed by ‘I Agree’ on the License Agreement screen, to continue the installation process as shown in Figure 24.
Figure 24: SSP Installation Welcome and Agreement
There are multiple components that are installed by the wizard. First, the SSP_Release_Pack which contains the driver and framework modules. Second, the SSP_Documentation that contains the user manual for the SSP. You will want to install both and then press ‘Next’ as shown in Figure 25.
Figure 25: SSP Component Selection
Select the installation location by using the ‘Browse’ button or use the default location. Once the location has been chosen, press the ‘Install’ button to begin the installation process as shown in Figure 26.
Figure 26: SSP Installation Location
Note: If you are using the SSP and the Synergy Standalone Configurator (SSC) with IAR EW for Synergy then you must target the installation directory of SSP to the installation directory of SSC, instead of the e2 studio installation directory.
To install the SSP into the SSC, click the ‘Browse’ button and navigate to the SSC directory. If the default directory was used for installation, the pathway should be C:\Renesas\Synergy\SSC_SSCVersion\. This process can be seen in Figure 27.
Figure 27: Installation Location for SCC
Choosing this pathway will save the SSP Evaluation License into the SSC directory, under C:<\Renesas\Synergy\SSC_SSCVersion>\internal\projectgen\arm\Licenses\, instead of within the e2 studio directory.
Partway through the installation, a secondary installer for documentation will appear. Select the desired install location, or use the default, and press ‘Install.’ as shown in Figure 28.
Figure 28: SSP Documentation Installation
Once the documentation has been installed, the initial installer will complete. Press the ‘Close’ button to complete the installation shown in Figure 29
Figure 29: Installation Complete
Congratulations! You have now successfully installed the tools necessary to begin developing on the Synergy Platform.
3: Additional Resources
Here is a handy list of additional Synergy related resources available to speed your development projects:
- Module Guides (from Renesas.com)
- Resource Library (from Renesas.com)
- YouTube channel
- Developer Examples (SSP 1.2.0) (from Renesas Synergy Gallery)
- Renesas Academy (two courses currently posted – dozen more coming)
- Synergy Explorer
- Synergy Book
- IoT Community
- Synergy Chat (from any Synergy page)
- Knowledge base / FAQ