P&E Microcomputer Systems Cyclone LC Series User manual

Cyclone LC Programmers
User Manual

Purchase Agreement
P&E Microcomputer Systems, Inc. reserves the right to make changes without further notice to any products herein to improve reliability, function, or
design. P&E Microcomputer Systems, Inc. does not assume any liability arising out of the application or use of any product or circuit described herein.
This software and accompanying documentation are protected by United States Copyright law and also by International Treaty provisions. Any use of this
software in violation of copyright law or the terms of this agreement will be prosecuted.
All the software described in this document is copyrighted by P&E Microcomputer Systems, Inc. Copyright notices have been included in the software.
P&E Microcomputer Systems authorizes you to make archival copies of the software and documentation for the sole purpose of back-up and protecting
your investment from loss. Under no circumstances may you copy this software or documentation for the purpose of distribution to others. Under no
conditions may you remove the copyright notices from this software or documentation.
This software may be used by one person on as many computers as that person uses, provided that the software is never used on two computers at the
same time. P&E expects that group programming projects making use of this software will purchase a copy of the software and documentation for each
user in the group. Contact P&E for volume discounts and site licensing agreements.
P&E Microcomputer Systems does not assume any liability for the use of this software beyond the original purchase price of the software. In no event will
P&E Microcomputer Systems be liable for additional damages, including any lost profits, lost savings or other incidental or consequential damages arising
out of the use or inability to use these programs, even if P&E Microcomputer Systems has been advised of the possibility of such damage.
By using this software, you accept the terms of this agreement.
©2015-2019 P&E Microcomputer Systems, Inc.
ARM and Cortex are registered trademarksof ARM Ltd. or its subsidiaries.
NXP, ColdFire, and Kinetis are registered trademarks of NXP Semiconductors.
Texas Instruments and TI are registered trademarks of Texas Instruments Incorporated.
STMicroelectronics is a registered trademark of STMicroelectronics, Inc.
All other product or service names are the property of their respective owners.
P&E Microcomputer Systems, Inc.
98 Galen St.
Watertown, MA 02472
617-923-0053
http://www.pemicro.com
Manual version: 1.17
July 2019

1 INTRODUCTION.........................................................................................................................................9
1.1 Cyclone Feature Comparison..........................................................................................................................9
1.2 Advanced Feature Licenses............................................................................................................................9
1.2.1 ProCryption Security License ........................................................................................................................................9
1.2.2 Cyclone Control Suite Advanced Features License ....................................................................................................10
1.2.3 SDHC Port Activation License.....................................................................................................................................10
2 QUICK START GUIDE FOR SAP OPERATION.......................................................................................11
2.1 Installing The Cyclone Software....................................................................................................................11
2.2 Setting Up The Cyclone Hardware................................................................................................................11
2.3 Creating A Stand-Alone Programming Image ...............................................................................................13
2.3.1 Advanced Features .....................................................................................................................................................16
2.4 Launching Cyclone Programming .................................................................................................................16
3CYCLONE LC HARDWARE .....................................................................................................................18
3.1 Touchscreen LCD .........................................................................................................................................18
3.2 LED Indicators...............................................................................................................................................18
3.3 Start Button ...................................................................................................................................................18
3.4 Access Panel.................................................................................................................................................18
3.5 Cyclone System Power .................................................................................................................................19
3.6 RS232 Communication (Serial Port) .............................................................................................................19
3.7 Ethernet Communication...............................................................................................................................19
3.8 USB Communications ...................................................................................................................................19
3.9 Electromechanical Relays .............................................................................................................................19
3.10 Power Connectors.........................................................................................................................................20
3.11 Reset Button..................................................................................................................................................20
3.12 SDHC Port.....................................................................................................................................................20
3.13 Optional Oscillator (MON08 Only).................................................................................................................21
3.14 Cyclone Time / Real Time Clock ...................................................................................................................21
3.15 Power Jumper Settings .................................................................................................................................21
3.16 Debug Connectors ........................................................................................................................................21
3.17 Target Headers For Part# CYCLONE-LC-ARM ............................................................................................23
3.17.1 PORT A: 10-Pin Keyed Mini Connector (Kinetis, S32 (ARM), other PEmicro-Supported ARM devices) ...................23
3.17.2 PORT B: 20-Pin Keyed Mini Connector (Kinetis, S32 (ARM), other PEmicro-Supported ARM devices) ...................24
3.17.3 PORT C: 20-Pin Debug Connector (Kinetis, S32 (ARM), other PEmicro-Supported ARM devices) ..........................25
3.18 Target Headers For Part# CYCLONE-LC-UNIV ...........................................................................................26
3.18.1 PORT A: 10-Pin Keyed Mini Connector (Kinetis, S32 (ARM), other PEmicro-Supported ARM devices) ...................26
3.18.2 PORT B: 20-Pin Keyed Mini Connector (Kinetis, S32 (ARM), other PEmicro-Supported ARM devices) ...................27
3.18.3 PORT C: 14-Pin Debug Connector (MPC55xx-57xx, SPC5, DSC, S32 (Power)) ......................................................28
3.18.4 PORT D: 26-Pin Debug Connector (ColdFire V2/3/4).................................................................................................29
3.18.5 PORT E: 16-Pin Debug Connector (MON08)..............................................................................................................30
3.18.6 PORT F: 6-Pin Debug Connector (RS08, HCS08, HC(S)12(X), S12Z, ColdFire +/V1, STM8 w/ adapter).................31
3.18.7 PORT G: 10-Pin Debug Connector (Power MPC5xx/8xx) ..........................................................................................32

3.18.8 PORT H: 20-Pin Debug Connector (Kinetis, S32 (ARM), other PEmicro-Supported ARM devices) ..........................32
3.19 Ribbon Cable.................................................................................................................................................33
4 TARGET POWER MANAGEMENT .......................................................................................................... 34
4.1 Cyclone Configuration ...................................................................................................................................34
4.2 Cyclone Setup ...............................................................................................................................................36
4.2.1 Independently Powered Target ...................................................................................................................................36
4.2.2 Power provided by the Cyclone to the debug cable ....................................................................................................36
4.2.3 External Power passed through the Cyclone and out 2.5 mm barrel port...................................................................37
4.2.4 External Power passed through the Cyclone to the debug cable................................................................................37
4.2.5 Power provided by the Cyclone and out 2.5 mm barrel port .......................................................................................38
4.3 Setup Reminders...........................................................................................................................................38
5 TOUCHSCREEN LCD MENU...................................................................................................................39
5.1 Home Screen ................................................................................................................................................39
5.1.1 Icons............................................................................................................................................................................39
5.1.2 Configurable Display Area...........................................................................................................................................39
5.1.3 Status Window ............................................................................................................................................................40
5.1.4 Error Information Icon..................................................................................................................................................40
5.1.5 AUX Button (Appears If Configured) ...........................................................................................................................40
5.2 Main Menu.....................................................................................................................................................40
5.2.1 Select Programming Image.........................................................................................................................................42
5.2.2 Current Image Options ................................................................................................................................................42
5.2.3 Configure Cyclone Settings.........................................................................................................................................44
5.2.4 Status ..........................................................................................................................................................................47
6 CREATING AND MANAGING PROGRAMMING IMAGES....................................................................... 48
6.1 Cyclone Image Creation Utility ......................................................................................................................48
6.1.1 Specify CPU Manufacturer..........................................................................................................................................49
6.1.2 Security Settings - Qorivva (MPC55xx-57xx) Only......................................................................................................51
6.1.3 Programming Sequence..............................................................................................................................................51
6.1.4 Programming Operations ............................................................................................................................................54
6.1.5 Communication Mode and Rate Settings....................................................................................................................56
6.1.6 Target Voltage and Power Settings.............................................................................................................................56
6.1.7 Image Description .......................................................................................................................................................56
6.1.8 ProCryption Security License Features.......................................................................................................................56
6.1.9 FX Exclusive Features ................................................................................................................................................59
6.1.10 Store Image To Cyclone..............................................................................................................................................59
6.1.11 Store Image To Disk....................................................................................................................................................60
6.1.12 Save Cyclone Configuration........................................................................................................................................60
6.1.13 Load Cyclone Configuration ........................................................................................................................................60
6.2 Managing Multiple SAP Images ....................................................................................................................60
6.2.1 Delete Images From Internal/External Memory...........................................................................................................61
6.2.2 Add/Remove Images From The Commit Changes Panels .........................................................................................61
7 CYCLONE PROGRAMMER MANUAL CONTROL...................................................................................63

7.1 Operation Via Start Button ............................................................................................................................63
7.1.1 LED Indicators.............................................................................................................................................................63
7.1.2 Procedure via Start Button / LEDs ..............................................................................................................................63
7.1.3 Example ......................................................................................................................................................................63
7.2 Operation Via LCD Touchscreen Menu ........................................................................................................64
7.3 Home Screen ................................................................................................................................................64
7.3.1 Icons............................................................................................................................................................................64
7.3.2 Configurable Display Area...........................................................................................................................................64
7.4 Status Window ..............................................................................................................................................65
7.4.1 Error Information Icon..................................................................................................................................................65
7.4.2 AUX Button (Appears If Configured) ...........................................................................................................................65
7.4.3 Main Menu...................................................................................................................................................................65
8 CYCLONE PROGRAMMER AUTOMATED CONTROL (CYCLONE CONTROL SUITE) ........................ 68
8.1 Overview Of Cyclone Control Suite...............................................................................................................68
8.1.1 Components ................................................................................................................................................................68
8.1.2 Features ......................................................................................................................................................................68
8.1.3 PEmicro Compatible Hardware ...................................................................................................................................69
8.2 Cyclone Control SDK ....................................................................................................................................69
8.2.1 Introduction..................................................................................................................................................................69
8.2.2 Backwards Compatibility With Classic Cyclone Control API .......................................................................................70
8.2.3 Getting Started with the Cyclone Control DLL.............................................................................................................70
8.2.4 Application Programming Interface (API) ....................................................................................................................73
8.3 Cyclone Control Console...............................................................................................................................87
8.3.1 Startup.........................................................................................................................................................................87
8.3.2 Command-Line Parameters ........................................................................................................................................87
8.3.3 Examples.....................................................................................................................................................................89
8.4 Cyclone Control GUI .....................................................................................................................................90
8.4.1 The Connection Dialog................................................................................................................................................91
8.4.2 The Control Tabs.........................................................................................................................................................92
8.4.3 The Status and Error Window: ....................................................................................................................................97
8.5 License ..........................................................................................................................................................97
8.5.1 Hardware Licensing.....................................................................................................................................................97
9 SAP IMAGE COMPILER (SCRIPTED PROGRAMMING & IMAGE CREATION)..................................... 98
9.1 Launching From the Command Line .............................................................................................................98
9.1.1 Command-Line Example.............................................................................................................................................98
9.1.2 Filename and Additional Command-Line Parameters.................................................................................................99
9.1.3 List of Valid Command-Line Parameters.....................................................................................................................99
9.2 Configuration (.CFG) File Contents.............................................................................................................100
9.2.1 Sample .CFG File......................................................................................................................................................100
9.2.2 Configuration Commands..........................................................................................................................................101
9.2.3 Programming Commands .........................................................................................................................................106
9.2.4 Using Command Line Parameters Inside a .CFG File ..............................................................................................107

9.2.5 Sample Batch File .....................................................................................................................................................108
9.3 CSAP Error Returns ....................................................................................................................................108
10 ETHERNET CONFIGURATION..............................................................................................................111
10.1 Network Architectures .................................................................................................................................111
10.2 Network Parameters....................................................................................................................................111
10.3 Internet Protocol ..........................................................................................................................................112
10.4 Connecting The Cyclone Device .................................................................................................................112
10.4.1 Connecting the Cyclone to the PC over a network....................................................................................................112
10.4.2 Connecting Cyclone-to-PC via an Ethernet cable .....................................................................................................113
10.5 Cyclone IP Setup Via LCD Menu ................................................................................................................113
10.5.1 Configure Network Settings.......................................................................................................................................113
10.6 Configuring Cyclone Network Settings using the Cyclone Control GUI ......................................................114
11 SAP IMAGE ENCRYPTION ....................................................................................................................116
11.1 Overview .....................................................................................................................................................116
11.2 Encrypting/Decrypting a Programming Image.............................................................................................116
11.3 What is Encrypted in an eSAP File, and How .............................................................................................116
11.4 Managing Encryption For Production Programming ...................................................................................117
11.4.1 Provisioning a Cyclone with an ImageKey ................................................................................................................117
11.4.2 Removing ImageKeys From A Cyclone ....................................................................................................................119
11.4.3 Loading and Programming with Encrypted SAP Images ..........................................................................................119
11.4.4 Encryption Status of SAP Images .............................................................................................................................120
11.5 Safer Production That's Easy To Implement...............................................................................................121
12 AUTOMATIC SERIAL NUMBER MECHANISM......................................................................................122
12.1 Understanding Serialization ........................................................................................................................122
12.2 Serialize Utility.............................................................................................................................................122
12.2.1 Startup And File Options ...........................................................................................................................................123
12.2.2 Serial Number File.....................................................................................................................................................124
12.2.3 Serial File Unique ID .................................................................................................................................................124
12.2.4 Serial File Name To Display......................................................................................................................................124
12.2.5 Serial File Notes ........................................................................................................................................................124
12.2.6 Number of Bytes in Serial Number............................................................................................................................124
12.2.7 Starting HEX Address ...............................................................................................................................................124
12.2.8 Count Sequence........................................................................................................................................................124
12.2.9 Serial Number Bytes as Hex .....................................................................................................................................124
12.2.10 Hex Upper Bounds ....................................................................................................................................................125
12.2.11 Hex Lower Bounds ....................................................................................................................................................125
12.2.12 Binary, Numeric, Constant, Alpha Upper, Alpha Lower, and Printable .....................................................................125
12.2.13 Byte Program Order ..................................................................................................................................................125
12.3 Serial File Properties ...................................................................................................................................125
12.3.1 Serial File Example ...................................................................................................................................................125
12.4 Serial Number Handling ..............................................................................................................................126
12.4.1 Invoking A Serial File Via Command-Line.................................................................................................................127

12.5 Creating A SAP Image With Multiple Serial Numbers.................................................................................127
12.6 Shared Serial Numbers ...............................................................................................................................128
12.6.1 Example ....................................................................................................................................................................128
13 CYCLONE LICENSE INSTALLATION ....................................................................................................133
13.1 How to Install Your License.........................................................................................................................133
14 TROUBLESHOOTING ............................................................................................................................138
14.1 My Cyclone Is Non-Responsive, Is There A Way To Re-Activate It?..........................................................138
14.1.1 What Is Bootloader Mode?........................................................................................................................................138
14.1.2 When Is Bootloader Mode Used? .............................................................................................................................138
14.1.3 How Is Bootloader Mode Entered? ...........................................................................................................................138
14.2 I Received A “SAP Image Needs To Be Updated” Error Using A Next-Gen Cyclone, How Do I Update? .138
14.2.1 How Do I Use SAP_Convert_Console.exe? .............................................................................................................138
14.3 When Trying To Install The CYCLONE Software, A Popup WDREG Error Occurs Telling Me That There Are
Open Devices Using WinDriver...................................................................................................................139
15 ERROR CODES......................................................................................................................................140
15.1 Debug Mode Communication Related Errors..............................................................................................140
15.2 SAP Image Handling Related Errors...........................................................................................................140
15.3 SAP Communication Handling Related Errors............................................................................................141
15.4 SAP Algorithm Header Operation Handling Related Errors ........................................................................141
15.5 SAP Operation Related Errors ....................................................................................................................141
15.6 SAP Blank Check Range and Module Related Errors ................................................................................141
15.7 SAP Erase Range and Module Related Errors ...........................................................................................141
15.8 SAP Program Byte, Word, and Module Related Errors...............................................................................141
15.9 SAP Verify Checksum Related Errors.........................................................................................................142
15.10 SAP Verify Range and Module Related Errors ...........................................................................................142
15.11 SAP User Function Related Errors..............................................................................................................142
15.12 SAP Trim Related Errors.............................................................................................................................142
15.13 Unrecoverable Fatal Errors .........................................................................................................................142
15.14 Operation Security Related Errors ..............................................................................................................143
15.15 External Memory-Related Errors.................................................................................................................143
15.16 Serial Number Related Errors .....................................................................................................................144
15.17 Download Count Related Errors..................................................................................................................144
15.18 System Hardware/Firmware/Logic Recoverable Errors ..............................................................................144
16 CYCLONE FEATURE OVERVIEW / COMPARISON .............................................................................145
17 TECHNICAL INFORMATION..................................................................................................................149
17.1 Life Expectancy ...........................................................................................................................................149
17.2 Electrical Specifications...............................................................................................................................149
17.3 Mechanical Specifications ...........................................................................................................................149
17.4 Electromechanical Relays ...........................................................................................................................149
17.5 Debug Ports - CYCLONE-LC-ARM.............................................................................................................149

17.6 Debug Ports - CYCLONE-LC-UNIV ............................................................................................................149
17.7 International Shipping..................................................................................................................................149
17.8 Compliances/Standards ..............................................................................................................................149

User Manual For Cyclone LC Programmers 9
1 INTRODUCTION
PEmicro's Cyclone LC production programmers are powerful, fast, and feature rich in-circuit
programming solutions. PEmicro offers two models which have the same feature set and only vary
by the devices supported.
Part# CYCLONE-LC-ARM supports a wide variety of ARM Cortex devices.
Part# CYCLONE-LC-UNIV supports those ARM Cortex devices as well as the following NXP
device families: Kinetis, LPC, S32, MPC55xx-57xx), MPC5xx/8xx, DSC, S12Z, RS08, S08, HC08,
HC(S)12(X), ColdFire, and STMicroelectronics’ SPC5 & STM8.
Note: PEmicro refreshed Cyclone names and part numbers in July 2019. The part numbers listed on
earlier Cyclones will differ slightly. CYCLONE is now called Cyclone LC, however the hardware
has not changed.
Figure 1-1: Cyclone LC Supported Architectures
Cyclone LC programmers are designed to withstand the demands of a production environment.
They are Stand-Alone Programmers (SAP) that can be operated manually or used to host
automated programming. In manual SAP mode the Cyclone is operated using the touchscreen
LCD Menu and/or the Start button. Host-controlled SAP mode, for automated programming, is
accomplished using the Cyclone Control Suite.
1.1 Cyclone Feature Comparison
In addition to Cyclone LC programmers, PEmicro offers Cyclone FX programmers that include
enhanced speed, storage, and security features, plus advanced Cyclone control/automation
features which make them an incredibly powerful and versatile solution. See CHAPTER 16 -
CYCLONE FEATURE OVERVIEW / COMPARISON for a CYCLONE feature overview and
comparison with the Cyclone FX programmers.
1.2 Advanced Feature Licenses
PEmicro offers Cyclone LC users the flexibility to add many of the advanced security, automation/
control, and expandable memory features included with the Cyclone FX. These features can be
added by purchasing and installing the appropriate activation license.
1.2.1 ProCryption Security License
The ProCryption Security License offers two extremely valuable security features:

User Manual For Cyclone LC Programmers 10
1. RSA/AES encryption of programming images
Users create unique ImageKeys which are used to encrypt their programming images.
SAP images encrypted in this way can only be loaded onto a Cyclone or programmed with
a Cyclone if that Cyclone has been provisioned with the identical ImageKey.
2. The ability to restrict image programming by programming count or date range.
Programming restrictions on images are easily configured during the image creation
process.
Together these security features help keep the user’s valuable IP safe. The user should refer to
CHAPTER 11 - SAP IMAGE ENCRYPTION for more information on encrypted programming
images. Image restrictions are described in Section 6.1.8.2 - Image Restrictions.
1.2.2 Cyclone Control Suite Advanced Features License
Cyclone LC programmers include a basic version of the Cyclone Control Suite. The Advanced
Cyclone Control Suite Update license enables additional features that allow the user to:
• Add/Remove/Update many images in the Cyclone (Console, SDK, GUI)
• Gang program: Simultaneously control multiple Cyclones via the USB, Serial, or Ethernet
connections
• Program (and read) Dynamic Data in addition to fixed image data
• Access a Remote Display for the Cyclone
• Read/write Cyclone properties
• Read Image and target Properties and Status
• Compare images against a SAP file
This gives the user much more control and flexibility during the production process. The user
should refer to Section 8.1 - Overview Of Cyclone Control Suite for more information.
1.2.3 SDHC Port Activation License
The SDHC Port Activation License activates the SDHC port of the Cyclone LC. This allows the
user expand the storage capacity of the Cyclone by loading images onto SDHC cards. SDHC
cards can hold more and larger images than a Cyclone LC programmer can normally
accommodate. The Cyclone display and management tools allow the user to easily distinguish
between “internal” and “external” images. Section 6.2 - Managing Multiple SAP Images displays
an example of how external images are differentiated.