Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Solantro Software Development Environment (SDE) Installation Guide
Document Number: DPD1167 rev. 2.1
The Solantro trademark is owned by Solantro Semiconductor Corp. Windows® is a registered trademark of Microsoft Corporation. Javatm is a trademark of Oracle® Corporation.
Caution - Use of Controls, adjustments or performance of procedures other than those specified herein may result in injury or damage to equipment.
© 2019 Solantro Semiconductor Corp. ("Solantro"). Strictly Confidential & Proprietary to Solantro. Use and disclosure of this document and its contents is subject to a Non-Disclosure Agreement between you and Solantro. Except as permitted by such agreements, no part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the written permission of Solantro Semiconductor Corp.
All rights reserved.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 1
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Table of Contents
Introduction ...... 2 Quick-start ...... 3 Directory Structure ...... 4 Installation ...... 4 Helios ...... 4 USB Driver ...... 6 Eclipse ...... 6 Python ...... 15 Git ...... 18 PuTTY ...... 22 Import and Build project with Eclipse ...... 23 Establish communication ...... 28 Connection with PuTTY for SA4041 ...... 30 Connection with PuTTY for SA4011 ...... 33 Program the board with PuTTY ...... 33 Connection with Helios ...... 34 Program the board with Helios ...... 34 References: ...... 35 Revision History ...... 35
Introduction This guide assists in setting up a directory structure and installing applications for running Helios and developing firmware for Solantro’s digital power processor. Helios Test and Control Tool (Helios) is a Windows application that uses a COM port to communicate with the firmware running on Solantro’s processor ICs through a UART. The primary purpose is to observe and change program variables and hardware registers as well as loading new firmware. Eclipse is used as the Integrated Development Environment; however, the toolchain has been customized to compile Solantro’s projects for the processor. Additional Python scripts transfer the program and variable definitions to Helios for interacting with the firmware. Solantro uses Git repositories so many of the projects and applications may be cloned from an internet server to provide updates and issue tracking. Solantro’s website provides access to zipped folders of the applications and files without the Git repository or links to the origin repository if you do not wish to use version control. The Appendix contains a Quick-start summary for each step in the installation process.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 2
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Quick-start Quick-start summary for installing the Solantro Development Environment and establishing communication with Solantro’s digital power processors. Notes: 1. This Quick-start summary is created to help during the set up process of Solantro’s Development Environment. The user should always consult the manual for detailed information. The user should use this sheet only to keep track of what has already been completed and what has yet to be done. 2. The page numbers in brackets in each step reference the page of this Installation Guide that provides additional information.
Step 1 Create Directory Structure (page 1) Follow the instruction of this Installation Guide to create the directory structures. Path: \ThisPC\Documents\Solantro\ Folders: Application, Firmware, Helios Build Projects, Helios Relist Projects, Workspace, etc. Step 2 Install Helios Test & Control Tool (page 4) Copy the file Helios.zip to the folder \Application, then unzip the file. Link: www.solantro.com/product_development or http://bitbucket.org/solantro/helios Step 3 Launch Helios by double clicking on the Helios icon. Step 4 Download and install the SiLabs USB driver for interfacing with UART bus. (page 6) https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers Step 5 Install the Eclipse (eSi-RISC Development Environment) software (page 6) Link: www.solantro.com/product_development Step 6 Install Python (page 15) Download file from: http://www.python.org. Step 7 Install Putty (page 22) Download file from: http://www.putty.org. Step 8 Import and Build project with Eclipse (page 23) Copy the project file provided by Solantro to the folder \Helios Build Project Step 9 Launch Eclipse in Windows (page 23) \Start\eSi_RISC Development Suite\Eclipse Step 10 Establish communication (page 28)
Solantro Semiconductor Corp. DPD1167 rev. 2.1 3
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Directory Structure The directory structure, shown in Figure 1, can be created anywhere on your computer. The recommended place is your Documents folder. This structure is not mandatory, but it helps to have a consistent organization of all installations and may simplify any support issues.
Figure 1 Solantro Directory Structure
Applications: The Helios application should be placed inside this folder. Firmware: The Firmware folder is for Eclipse projects containing the project file source code. Helios Build Projects: When the firmware is compiled, post-build scripts transfer a zipped XML file into the directory. This allows Helios to identify and access the information for the project. Helios Release Projects: Solantro may provide XML files that work with the various evaluation board designs. This folder allows them to be stored separately from your local builds. Workspace: This folder is designated as the Eclipse workspace. It maintains your settings and could contain source code for the firmware projects Installation
Helios Create an Applications folder as shown in Figure 1. Download Helios.zip from the USB memory stick (if provided with the evaluation kit) or from Solantro’s web-site at www.solantro.com/product_development, or clone it from an online repository at (http://bitbucket.org/solantro/helios). Unzip the files in the Helios folder. The content in the Helios folder is shown in Figure 2:
Solantro Semiconductor Corp. DPD1167 rev. 2.1 4
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Figure 2 - Helios folder
Launch Helios by double clicking on the Helios.exe file. When Helios is launched for the first time, licensing terms should be accepted. Figure 3 shows the Startup screen upon the first launch of Helios. Upon first launch, Helios requires that the path to either the Build or Release directories be specified. Click on the Specify Path button (Figure 4) and choose the appropriate folder using the folder browser. Once chosen, the startup screen refreshes to show the available projects within the designated folder.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 5
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Figure 3 Startup screen - Helios first launch
Figure 4 - Specify the path for the project.
Helios remembers the project(s) that were open when it was last closed. If these projects are found, they are opened by default, thereby bypassing the open project screen altogether. It is recommended to pin the Helios application to the task bar for easy access to the application. See DPD1006 - Helios Test and Control Tool User’s Guide for more information.
USB Driver Solantro uses isolated USB to UART TTL converters to connect between a PC and the evaluation boards. They require software for the virtual COM port drivers. The software can be obtained from: https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers
Eclipse Obtain “esirisc-development-suite-solantro-windows_6_0_3_1.exe” either from the USB memory stick provided with the evaluation kit or from www.solantro.com/product_development. Start installation by double-clicking on the exe file. The installation begins with a welcome to the Solantro Prerequisites setup wizard window shown in Figure 5 below.
Figure 5- Welcome to the Prerequisite Setup Wizard
Solantro Semiconductor Corp. DPD1167 rev. 2.1 6
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
During execution, the suite verifies your existing installation or additionally installs Cygwin, Java, WinPcap and Adobe Reader (See Figure 6). During each installation, you will be asked to allow the application installer to make changes to your device. In the example shown in Figure 6, the Acrobat reader has already been installed so the suite will skip this installation.
Figure 6 – 3rd party applications necessary for running the eSi-RISC Development suite
Solantro Semiconductor Corp. DPD1167 rev. 2.1 7
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
For Cygwin, choose the installation type to be “Install from Internet” as shown in Figure 7.
Figure 7 Cygwin Setup - Choose installation type.
The setup chooses the installation directory. If you want another place for installing Cygwin, you can specify it. The setup checks that Cygwin will be available for all users of the system. The next setup window selects a local package directory where you want the installation files and downloads to be stored. The directory will be created if it does not exist. The install location should be c:\cygwin. If you want to select new place it can be done with the “Browse…” button. The next step of Cygwin setup is to select connection type ( Figure 8).
Figure 8 - Cygwin setup - select connection type
Choosing site for downloading Cygwin (Figure 9).
Solantro Semiconductor Corp. DPD1167 rev. 2.1 8
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Figure 9 Choosing a Cygwin download site
Downloading an installation of Cygwin is shown in Figure 10. Note: the user may perform the Cygwin install directory download ahead of time, and specify to install from the downloaded folder, as opposed to using the installer download feature.
Figure 10 - Download and installation of Cygwin.
In the next step Cygwin setup selects package for installing (Figure 11). Click Next.
Figure 11 - Select package for installing
Cygwin setup prompts the user to review and confirm the changes. Click Next.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 9
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Figure 12 - Review and confirm changes.
After reviewing, the Cygwin installer will start downloading and installing, which may take several minutes. The progress window for the Cygwin install is shown in Figure 13. If upgrading from a previous version of Cygwin, note that all Cygwin mintty windows must be closed before proceeding.
Figure 13- Progress of the download and installation.
At the end of Cygwin installation, the setup prompts the user for creating an icon on the Desktop or Start Menu. It also gives the installation status (see Figure 14). Since Cygwin is an auxiliary application, an icon is not necessary (but user’s may specify their own preferences).
Figure 14 Installation status and create icons
Solantro Semiconductor Corp. DPD1167 rev. 2.1 10
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Next step for eSi-RISC-development-suite is to install Java. The installation begins with “Welcome to Java window”. Another three windows will pop-up successively with the last one showing that Java is successfully installed. Figure 16 to Figure 18.
Figure 15 Welcome to Java window
Figure 16 Java installation window
Figure 17 Java status window
:
Figure 18 - Successfully installed Java window
Solantro Semiconductor Corp. DPD1167 rev. 2.1 11
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Next installation is WinPcap. It starts with the WinPcap welcome window shown in Figure 19
Figure 19 WinPcap welcome window
The user should accept the license agreement (Figure 20).
Figure 20- License agreement window
The installation options are shown in Figure 21:
Figure 21 - Installation options window
Window showing completion of the WinPcap installation is shown in Figure 22.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 12
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Figure 22 - Window showing completing the WinPcap installation
If you don’t have Adobe Reader, it should be installed. Ready to install and status Adobe Reader windows are shown in Figure 23 and Figure 24.
Figure 23- Ready to install Adobe Reader window
Figure 24 Adobe Reader status window
When Adobe Reader setup finishes installation, a welcome to the eSi-Risc Development Suite - Solantro Edition Setup Wizard window pops up. The window is shown in Figure 25.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 13
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Figure 25 - The eSi-RISC Development Suite Setup Wizard window
The user is prompted to accept the licence agreement as shown in Figure 26:
Figure 26 - eSi-RISC license agreement
Figure 27 - Window for selecting the place for the installation folder for eSi-RISC
Solantro Semiconductor Corp. DPD1167 rev. 2.1 14
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Click Next, then Install, and provide admin authentication if prompted. Launch the eclipse installer by clicking on the start menu item. When Eclipse is launched, the workspace should be directed to the workspace folder shown in Figure 1.
Figure 28 - Window for selecting a directory as workspace.
If you are upgrading from a previous version of eclipse, you may be prompted about version compatibility. Eclipse will automatically upgrade any files needed in the workspace to the new versions. For more information about eSi-RISC Development Suite read: eSi-RISC Development Suite Getting Started Guide. (see Figure 29).
Figure 29 - eSi-RISC documentation
For convenience, pinning the application to the task bar will provide easy access to the application. sPython Python is used to build the scripts. Download the latest Python 3 version for Windows (Python 3.7.3 as of 07/2019) at http://www.python.org. It is ok to use the default installer from their web page. The installer should be run as administrator. During the installation the Python setup prompts the user to specify the installation settings (see Figure 30). Add Python 3.7 to the path and choose Customize installation.
Figure 30 - Select default or customize installation settings.
The next step is to install optional features. By default, all boxes are checked so click Next.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 15
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Figure 31 – Install optional features
The next installation step is Advanced Options. Check the “install for all users” and change the path to remove "Program Files" from the path. It is best to install Python at the top level since the folder permissions of Program Files may prevent the addition of new modules through "pip". Now click install (Figure 32). Check the install for all users and change the path to remove "Program Files" from the path. It is best to install Python at the top level since the folder permissions of Program Files may prevent the addition of new modules through "pip". Now click install.
Figure 32 Advanced Options
The setup progress is shown in Figure 33.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 16
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Figure 33 - Setup progress
The window shown in Figure 34 shows that Python has been successfully installed.
Figure 34 Successful Python installation
(Go to the Python37 folder when the install completes. Copy the python executable and then rename it to python3. The folder should contain both python and python3 (Figure 35).
Figure 35 - Python 37 folder with added python3.exe
Solantro Semiconductor Corp. DPD1167 rev. 2.1 17
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
When you finish with the installation of the Python, go to the start menu and type Command Prompt and run the application as administrator (see Figure 36).
Figure 36 - Selecting Command Prompt
When the Command Prompt windows appears (Figure 37), you should type pip install xmltodict.
Figure 37 - Command Prompt widows
Git Git allows and encourages you to have multiple local branches that can be entirely independent of each other. The creation, merging, and deletion of those lines of development takes seconds. Git can be downloaded from https://git-scm.com/download/win. The Git installer should be run as administrator and used default values. The following windows will appear during the installation.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 18
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Solantro Semiconductor Corp. DPD1167 rev. 2.1 19
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Solantro Semiconductor Corp. DPD1167 rev. 2.1 20
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Solantro Semiconductor Corp. DPD1167 rev. 2.1 21
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
PuTTY PuTTY is a free and open-source terminal emulator, serial console and network file transfer application. It is a free program available at http://www.putty.org. A terminal emulator is often connected to the first UART which is used for the Bootloader monitor and debugging messages. Choose MSI package PuTTY for Windows Installer depend on your PC 32 or 64 -bits and download it. The installation starts with an “Welcome window” (Figure 38).
Figure 38- PuTTY installation welcome window.
Creating a folder where PuTTY will be installed (Figure 39).
Figure 39 Selecting the destination folder.
Next installation window adds a shortcut to PuTTY on the desktop.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 22
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Figure 40 Adding a shortcut to Desktop.
The installation and status window is passing very fast and after it the window for successfully completing the installation pops-up.
Figure 41 - Successfully installed PuTTY window.
After PuTTY is installed, you can add the PuTTY icon to the task bar. Import and Build project with Eclipse For every application platform, Solantro provides a software folder that should be downloaded from the Solantro website. After you download the folder you should place it in the Firmware folder (Figure 1). Launch Eclipse from the start menu, a window for selecting a directory as workspace pops up. You should select the workspace directory shown in Figure 1 and also you should check the box “ Use this as default and do not ask again”. Press “Launch”.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 23
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Figure 42 - Selecting a directory as workspace.
When you launch Eclipse, it will open with a welcome window as shown in Figure 43
Figure 43 - Eclipse welcome window.
Close the welcome window with the cross indicated with red circle. Eclipse workspace window is shown in Figure 44.
Figure 44 - Eclipse window.
To import a project, go to File and select “Import…”. A window for selecting the import directory pops- up (Figure 45).
Solantro Semiconductor Corp. DPD1167 rev. 2.1 24
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Figure 45 - Select an import wizard.
Select “Projects from Gits and press Next. A window for selecting location for the Git Repositories pops up (Figure - 46).
Figure - 46 Selecting location for the Git Repositories.
Select the Existing Local repository and press “Next”. The next window shown Figure 47, you should browse to the firmware of the project that you want to import. You need also to check the box “look for nested repositories and the project as shown with circle and then press “Finish.”
Solantro Semiconductor Corp. DPD1167 rev. 2.1 25
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Figure 47 Search and select Git repositories.
Next step is to select a Git repository i.e. your project folder (Figure 48).
Figure 48 - Select a Git Repository.
The next step is to select a wizard to use for importing the project (Figure 49).
Solantro Semiconductor Corp. DPD1167 rev. 2.1 26
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Figure 49 - Selecting a wizard for importing.
The last step is to import the project from Git.
Figure 50 - Import project
The imported project in Eclipse is shown in Figure 51.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 27
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Figure 51 - Eclipse workspace with imported project.
After the project is imported, right click on the project name and a popup menu appears as shown in Figure 52. Select “Clean Project”. When the cleaning finishes select “Build Project. If there is no error, you have successfully installed the Solantro Development environment.
Figure 52 - Popup menu for selecting clean and build the project. Establish communication The communication between the evaluation board and a PC can be done through PuTTY and / or Helios. PuTTY is used to connect to the bootloader monitor for first time programming or getting debug messages from the running firmware. After the firmware is running on the evaluation board, Helios communications can be used to program new loads. To establish communication, follow the steps: Step 1 Connect a power supply to the board and set the right voltage according to the evaluation board instructions.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 28
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Step 2 Go to Windows Start menu and right click on the mouse. The following window
appears: Step 4 Select the Device Manager and expand the ports.
Step 5 Connect a cable with UART adapters to the computer (First cable)
A new COM (COM4) is shown. Windows assigns different port number. Step 6 Connect a second cable with UART adapters to the computer (Second cable)
A new COM (COM5) is shown. Windows assigns different port number.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 29
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Connection with PuTTY for SA4041 Step 1 Connect the first cable with UART adapters to the computer Step 2 Launch PuTTY and set the PuTTY options to the following values: In the Session category: – Connection type - Serial – Serial line - specify the PC COM port that is connected to the UART communications port on the target device. (For example, you can write COM5) – Speed (baud rate) set 115200
Figure 53 Settings for Section category
In the Terminal category: – Local echo set to Force off
Figure 54 Settings for Terminal category
Solantro Semiconductor Corp. DPD1167 rev. 2.1 30
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
In the Window category: – Reset scrollback on display activity set to off (uncheck) – Lines of scrollback set to 20000
In the Session category: 1 In Save Session choose a name for the session. (For example, “IXC2”) 2 Click Save to save the settings as default settings
By saving as default settings, next time when you open the PuTTY you can select IXC2 and load and all the setting will be populated automatically, and you do not need to repeat the steps above. Step 3 Turn ON the power supply
Solantro Semiconductor Corp. DPD1167 rev. 2.1 31
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Step 4 Click Open. The PuTTY session launches. The session launches when a black Windows appears. Step 3 Turn OFF and ON the power supply or press the reset button. The following text will appear if the IXC2 is not programed.
Figure 55 Bootloader image when SA4041 is not programed If the board is programed then the flash Image, Length Code check and Copy check will be different.
Figure 56 _Bootloader image of SA4041 is programed.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 32
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Connection with PuTTY for SA4011 Follow the instruction given in section above and set the settings for SA 4011 as follow:
• Speed: 38400 • 8 Data bits • 1 stop bit
• No parity • XON / XOFF • Local echo on
• Set the lines of scroll back to 20000 • Disable reset scroll back on activity (uncheck)
• Save the session to recall the settings later The bootloader image for SA4011(IXC) is shown below:
Program the board with PuTTY Step 1 Launch the Helios Test and Control Tool. Step 2 Click on Edit and the following menu opens:
Step 3 Select Bootloader 3xImage To Clipboard. A pop-up window that asks you to select the revision to be copied to the clipboard. Step 4 Restart the board and quickly click on “*” (Shift+8) and the “Solantro MONITO
Step 5 Right click on the mouse in the PuTTY windows and the program will start to be written in the SA40x1 memory. When it finishes, the SA40x1 reboots automatically.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 33
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
Connection with Helios Step 1 Connect the second cable with UART adapters to the board and launch Helios. Step 2 Go to HDLC port and from the drop-down menu select the COM port for Helios. (From the upper procedures we saw that in our example COM4 is for PuTTY then COM5 is for Helios. Then select COM5) Step 3 Optionally, to view and configure the HDLC port settings, click Setup icon. The HDLC COM Port Setting dialog box is displayed. It is recommended that you accept the default settings. The HDLC Port Baud rate must be set to 115200. When you are done, click Ok. Step 4 Click on Connect button. It may take up to 30 seconds for the port to be connected. When communication between IXC and Helios is done, clicking to IXC peripherals for example
DAC0, the values of the different GACs channels will be in green.
Program the board with Helios When the connection is established between SA40x1 and Helios, the board can be programed through Helios as follows: Step 1 Click on the “Program” button. The following window appears where the Source Directory, the Available Project and the Available revision can be chosen:
Step 2 Click Ok and Helios starts to write the program in the SA4011. When the writing finishes, the SA4011 is reset and a “Force Reset Underway windows appears. Different examples for configuring the SA4011 blocks are provided in Solantro document - DPD1058-SA4011 (IXC) Technical Reference Guide.
Solantro Semiconductor Corp. DPD1167 rev. 2.1 34
Solantro Semiconductor Corp. Software Development Environment – Installation Guide
References: DPD1006 - Helios Test and Control Tool User’s Guide Revision History
Revision Description Date 1 Preliminary Document Sep., 2017 2 Cross references error cleaned April 2018 2.1 Add Python 3 and editorial clean-up June, 2019
Solantro Semiconductor Corp 146 Colonnade Rd, Suite 200 Ottawa, On, Canada K2E 7Y1
Phone: (613) 274-0440 Fax: (613) 482-4748 Email: [email protected] Web: www.solantro.com
Solantro Semiconductor Corp. DPD1167 rev. 2.1 35