Infineon CYPRESS User manual

user guide Please read the Important Notice and Warnings at the end of this document 002-25230 Rev. *F
www.infineon.com page 1 of 38 2022-03-17
CYPRESS™ Programmer
GUI user guide
Version
4.0.1
About this document
Scope and purpose
CYPRESS™ Programmer (CYP) is a stand-alone, cross-platform, flash programmer tool. It replaces several
existing flash programmers for various MCU and connectivity devices. CYP provides a graphical user interface to
Program, Erase, Verify, and Read the flash of the target device. CYP supports HEX, SREC, ELF, and BIN
programming file formats.
Intended audience
This document helps you learn how to use the CYP GUI to perform various operations on devices.
Document conventions
Convention
Explanation
Bold
Emphasizes heading levels, column headings, menus and sub-menus
Italics
Denotes file names and paths.
Courier New
Denotes APIs, functions, interrupt handlers, events, data types, error handlers, file/folder names,
directories, command line inputs, code snippets
File > New
Indicates that a cascading sub-menu opens when you select a menu item
Abbreviations and definitions
The following define the abbreviations and terms used in this document:
Term
Description
CMSIS
Arm® Cortex® Microcontroller Software Interface Standard.
CMSIS-DAP
CMSIS Debug Access Port.
CYP
CYPRESS™ Programmer.
OpenOCD
The Open On-Chip Debugger is the debugger tool that provides on-chip programming support.
This tool acts as a backend of the CYP application.
Data File
The data file for programming in the hex or binary format
DP
The Debug Port register of the Arm Cortex CPU. Used for programming and debugging, along
with the corresponding SWD-address bit selections.
Flash kernel/loader
The firmware file loaded into the MCU's RAM. Sometimes referred to as RAM program, Flash
kernel, Flash loader.
GDB
GNU Project Debugger –GNU.org.
JTAG
Joint Test Action Group. Specifies the use of a dedicated debug port while implementing a serial
communication interface for low-overhead access without requiring direct external access to
the system address and data buses.
MCU
Microcontroller Unit.

user guide 2 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
About this document
Term
Description
PSoC™
A family of microcontroller integrated circuits. These chips include a CPU core and mixed-signal
arrays of configurable integrated analog and digital peripherals.
Region
Logical areas within the target device the programmer operates on.
SWD
Serial Wire Debug interface.
QSPI
Quad Serial Peripheral Interface. A name used for SPI external memory interfaces

user guide 3 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
Table of contents
Table of contents
1Overview............................................................................................................................... 4
2Installing CYP......................................................................................................................... 5
2.1 Package Contents....................................................................................................................................5
2.2 System Prerequisites ..............................................................................................................................5
2.3 Installing on Windows.............................................................................................................................5
2.4 Installing on Ubuntu ...............................................................................................................................5
2.5 Installing on macOS ................................................................................................................................6
3Getting Started ...................................................................................................................... 7
3.1 Run CYP....................................................................................................................................................7
3.2 Load Programming File...........................................................................................................................8
3.3 Connect Device........................................................................................................................................9
3.4 Program Device .....................................................................................................................................10
3.5 Save Log File..........................................................................................................................................10
4GUI Description.....................................................................................................................11
4.1 Menus.....................................................................................................................................................11
4.2 Toolbar ..................................................................................................................................................13
5Programming Operations.......................................................................................................15
5.1 Erase Device...........................................................................................................................................15
5.2 Program Device .....................................................................................................................................16
5.3 Program Device and Reset Chip ...........................................................................................................17
5.4 Program Binary File with Offset............................................................................................................18
5.5 Program External Memory....................................................................................................................19
5.6 Program PSoC™ 6 MCU in JTAG Chain..................................................................................................21
5.7 Verify Device ..........................................................................................................................................24
5.8 Verify Device with External Memory .....................................................................................................25
5.9 Verify Custom Flash Regions of PSoC™ 6 MCU .....................................................................................27
5.10 Read Device ...........................................................................................................................................29
5.11 Program eFuse Region of PSoC™ 6 MCU ..............................................................................................31
5.12 Program PSoC™ 4 MCU With Protected Flash ......................................................................................32
5.13 Program Chip-Protected PSoC™ 4 MCU ...............................................................................................33
5.14 Limitations.............................................................................................................................................33
5.15 How to Recover IoT BT Devices on Failure...........................................................................................34
6Upgrading Firmware..............................................................................................................35
6.1 Upgrade KitProg2 Firmware .................................................................................................................35
6.2 Upgrade KitProg3 on Kit or MiniProg4 Firmware.................................................................................36

user guide 4 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
Overview
1Overview
CYP supports the following features:
•Programming Infineon MCUs' internal and external memories
•PSoC™6 MCUs, including corresponding starter kits and evaluation boards
•PSoC™ 4 MCUs, including corresponding starter kits and evaluation boards
•PMG1 and WLC1 MCUs, including corresponding evaluation boards
•IoT Wi-Fi/Bluetooth® platforms (CYW4390x, CYW4343W, CYW208xx and others), including corresponding
starter kits and evaluation boards
•Connectivity devices via support of development boards
•Windows, Linux, and macOS
•Programming external memory devices using PSoC™ 6 external memory interfaces (EBI / QSPI)
•Programming external memory of IoT Wi-Fi devices
•KitProg3 and MiniProg4 hardware
•SEGGER J-Link Base and J-Link Ultra hardware
•OpenOCD via machine interface (MI) to 3rd party debug hardware
•Cross-platform Bridge library –I2C, SPI, UART communications
•KitProg3 firmware update

user guide 5 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
Installing CYP
2Installing CYP
2.1 Package Contents
The CYP package contains:
•CypGui executable –The application to program flash of various devices
•Drivers and firmware for the MiniProg4, KitProg2, KitProg3 hardware programmers
•OpenOCD debugger tool that provides on-chip programming support
•Cross-platform library that provides access to USB devices
2.2 System Prerequisites
We recommend the following minimum system configuration:
•PassMark CPU score > 2000 (cpubenchmark.net)
•Minimum of 4 GB RAM
•Minimum 60 MB free disk space
•Minimum 1280x1024 screen resolution
CYP is supported on the following platforms:
•Windows 7 (x64)
•Windows 10 (x64)
•macOS 10.14, 10.15, 11
•Ubuntu 18.04 LTS (x64)
2.3 Installing on Windows
1. Run the Windows installer program: CyProgrammer_4.0.1.<build>.exe
2. Follow the instructions of the installation wizard.
2.4 Installing on Ubuntu
1. Open a command-line terminal.
2. Unpack the CYP installation archive. Run:
tar -xvzf CyProgrammer_4.0.1.<build>.tar.gz
3. Install the rules for the connected programming hardware MiniProg4, KitProg3.
The script install_rules.sh script copies 57-cypress_programmer.rules and 70-wiced-JTAG.rules files
to /etc/udev/rules.d. It allows a non-superuser to have access to the connected devices:
a. Change directory to <cyp_install_dir>/udev_rules.
b. Run:
./install_rules.sh

user guide 6 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
Installing CYP
4. Register CYP in the Infineon Developer Center.
a. Change directory to <cyp_install_dir>
b. Run:
./idc_registration.bash
2.5 Installing on macOS
1. Run the pkg installer for the CYP - CyProgrammer_4.0.1.<build>.pkg.
2. Follow the instructions on the installation wizard.
3. Under System Preferences > Security & Privacy > General, choose to Allow the 'System software from
developer "Cypress Semiconductor" was blocked from loading.'

user guide 7 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
Getting Started
3Getting Started
3.1 Run CYP
To run the CYP application, navigate to the install location and run the executable. See Installing CYP. The GUI
opens and looks similar to this:
In this case, no kit or device is connected, and a message displays asking you to connect a device.

user guide 8 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
Getting Started
3.2 Load Programming File
1. Connect the device to the host computer. Select the device name in the Probe/Kit drop-down, and CYP will
display information under Probe Settings (if the Settings section is viewable).
2. Click Open.
On the Open Programming File dialog, navigate to the location of the HEX, SREC, ELF, or BIN file to load,
select it, and click Open.

user guide 9 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
Getting Started
3.3 Connect Device
1. If the device is not powered, the status message "Not Powered" is displayed in the Status Bar. Click Power
to power up the device.
2. Click Connect. CYP communicates with the device and displays various messages in the Log. Then, a
message in the Status Bar indicates that it is connected.

user guide 10 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
Getting Started
3.4 Program Device
Click Program. CYP downloads the program file onto the device and displays messages in the Log.
3.5 Save Log File
Right-click in the Log section and select Save As.
Note: You can also select the Select All command to select the text, then copy and paste the text to the
file you selected.

user guide 11 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
GUI Description
4GUI Description
CYP contains menus and toolbar commands to perform actions. This chapter describes the various GUI
elements.
4.1 Menus
4.1.1 File
The File menu contains the following commands:
•Open (Ctrl+O) –Opens the programming file.
•Connect/Disconnect (Alt+Q) –Connects and disconnects the selected device.
•Program (Alt+G) –Programs the selected device with the selected file.
•Erase (Alt+E) –Erases the selected device.
•Read (Alt+R) –Reads flash of the selected device into a HEX or SREC file.
•Verify (Alt+Y) –Verifies that the selected device is programmed correctly.
•Recent Files –Lists up to five recently loaded programming files.
•Exit (Alt+F4) –Closes the CYP application.

user guide 12 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
GUI Description
4.1.2 View
The View menu contains the Settings check box. Select it to view the Settings section of the window; unselect
it to hide the Settings section. See Settings.
4.1.3 Options
The Options menu contains the following commands:
4.1.3.1 Programmer Options (Alt+T)
Opens the Programmer Options dialog to set the Upgrade Firmware mode and other options.
•Upgrade Firmware mode:
•Automatically –The firmware is updated automatically when the tool opens.
•Show Pop-up –A dialog displays asking if you want to upgrade the firmware.
•Ignore –The firmware is not updated and no prompt displays.
•OpenOCD Telnet Port: This option specifies the port number of the OpenOCD telnet connection.
4.1.3.2 Upgrade Firmware (Alt+U)
When this command is enabled, select it to upgrade the programmer firmware on the device.
4.1.4 Verify Regions
The Verify Regions menu is available only if Verify Regions option is selected in Program Settings.
•Add Region –Adds a custom flash region to the Verify Regions list.
•Reload Regions –Resets the Verify Regions list to the default state corresponding to the flash map of the
target.
•Undo (Ctrl+Z) –Undo the last change in the Verify Regions list.
•Redo (Ctrl+Y) –Redo the last change in the Verify Regions list.
•Verify –Initiates the Verify device operation.
4.1.5 Help
The Help menu contains the following commands:
•View Help (F1) –Provides access to this document.
•About Cypress Programmer –Opens the About box.

user guide 13 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
GUI Description
4.2 Toolbar
The toolbar contains the Open, Connect, Erase, Program, Read, and Verify commands, which are also
located on the File menu. This area also contains the following:
4.2.1 Probe/Kit and Platforms
If you have more than one device connected to your computer, use these pull-down menus to select the
specific probe and target platform to use.
4.2.2 Power
Use the Power button to power on and off the selected device.
4.2.3 Connect
Use the Connect button to connect to and disconnect from the selected device.
4.2.4 Settings
The Settings section of the tool allows you to update the program and probe/target settings as follows:
4.2.4.1 Program Settings
•File –Use this to select the programming file to perform actions on or with.
•Offset –This is an optional offset parameter; it can be an integer or hexadecimal value. The relocation
offset is added to the base address for each section in the image when the image is programmed. This
option is visible only if a binary or elf file is selected for programming operations.
•Reset Chip –Use this to reset the chip after the Program operation completes. This option resets the target
chip and runs the programmed firmware on it.
•Verify Regions –Use this option to define flash regions used during device verification. This allows to verify
user defined flash regions of the PSoC™ MCU. This option does not change behavior of the Program
operation. See Verify Custom Flash Regions of PSoC™ 6 MCU for details.
•External Memory –Enables/disables the programming of external memory in the target device. For PSoC™
6x MCUs, this option enables programming of the QSPI regions. This is also used for programming external
memory of IoT Wi-Fi devices.

user guide 14 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
GUI Description
•Program Security Data –Allows programming security regions if the target device supports this capability.
For example, for PSoC™ 61 PSoC™ 62, and PSoC™ 63 MCUs, this option enables programming the eFuse
region.
•Target AP –Allows you to select the target access port (DAP) that will be used for programming. Possible
values include: CM0, CM4, and SYS_AP. This option is available only for PSoC™ 64 MCUs.
•Flash Size Limit –Limits the size of application flash available for programming operations. This option is
available only for PSoC™ 64 MCUs.
•Programming Mode –Use this option to define programming mode for PMG1 devices. The mode options
include:
•Reset - this programming mode enables acquisition of the target device in the Test mode.
•PowerCycle - In this mode the programmer cycles power to acquire the device.
4.2.4.2 Probe Settings
The Probe settings allow you to configure the programming and target device before you connect to it. These
settings are available when CYP is not connected to the device.
•Interface –To select the hardware (debug) interface for communication with the target device. The
possible values include: SWD and JTAG if supported by the device.
•JTAG Chain –To select the interested target device in the JTAG chain. This option is only available for
probes supporting JTAG interface. See Program PSoC™ 6 MCU in JTAG Chain for details.
•Voltage (V) –To select the power supply voltage of the target device in Volts. This option is available only if
the selected probe has the power control capability.
•Clock (KHz) –To select the frequency of the hardware interface in KHz. This option is available only if the
selected probe supports configurable frequencies.
•Reset Type –Specifies the type of the Reset Chip operation. The possible values include: Soft and XRES:
•Soft is a software reset type that sends the system reset request to the ARM core.
•XRES is a hardware reset type that toggles the XRES hardware line.
•Sflash Restrictions –Specifies the Sflash programming behavior for PSoC™ 6 MCUs. This option is available
only for PSoC™ 61/62/63 MCUs. The possible values include:
•Erase/Program of Sflash is prohibited.
•Erase and Program of USER/TOC/KEY is allowed.
•Erase of USER/TOC/KEY and Program of USER/TOC/KEY/NAR is allowed.
•Erase and Program of entire Sflash is allowed.

user guide 15 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
Programming Operations
5Programming Operations
This chapter covers the various programming operations you can perform using CYP tool.
5.1 Erase Device
1. Connect to the device (see Connect Device).
2. Click the Erase button.
CYP erases the device and displays various messages in the Log. Then, a message in the Status Bar indicates
that the device was erased successfully or that an error occurred.

user guide 16 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
Programming Operations
5.2 Program Device
1. Connect the device to the host computer and select it in the Probe/Kit drop-down.
2. Select the programming file as described in Load Programming File section.
3. Connect to the device (see Connect Device).
4. Click the Program button.
CYP programs the device and displays various messages in the Log. Then, a message in the Status Bar indicates
that device was programmed successfully or that an error occurred.

user guide 17 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
Programming Operations
5.3 Program Device and Reset Chip
1. Connect the device to the host computer and select it in the Probe/Kit drop-down.
2. Select the programming file as described in the Load Programming File section.
3. Connect to the device (see Connect Device).
4. Select the Reset Chip check box under Program Settings.
5. Click the Program button.
CYP programs the device and displays various messages in the Log. Then, a message in the Status Bar indicates
that the device was programmed successfully or that an error occurred.
The target device is reset and running.

user guide 18 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
Programming Operations
5.4 Program Binary File with Offset
1. Connect the device to the host computer and select it in the Probe/Kit drop-down.
2. Select the binary programming file as described in the Load Programming File section.
3. Connect to the device (see Connect Device).
4. Enter the desired address in the Offset field under Program Settings.
5. Click the Program button.
CYP programs the device and displays various messages in the Log. Then, a message in the Status Bar indicates
that the device was programmed successfully or that an error occurred.

user guide 19 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
Programming Operations
5.5 Program External Memory
1. Attach and select a device that supports external memory (for example, CY8CKIT-062-WiFi-BT with QSPI
support).
2. Select the External Memory option under Program Settings.
3. Select the programming file as described in the Load Programming File section. The programming file
should contain external memory region(s) and correct QSPI configuration data.
4. Select Erase/Program USER/TOC/KEY allowed option under Probe Settings > Sflash Restrictions.
5. Connect to the device (see Connect Device).
6. Click the Program button.

user guide 20 of 38 002-25230 Rev. *F
2022-03-17
CYPRESS™ Programmer
GUI user guide
Programming Operations
CYP programs the device and displays various messages in the Log. Then, a message in the Status Bar indicates
that the device was programmed successfully or that an error occurred.