Elprotronic XStream-Iso CMSIS-DAP for XStream Adapters User Guide
- October 30, 2023
- Elprotronic
Table of Contents
Elprotronic XStream-Iso CMSIS-DAP for XStream Adapters
User Guide – PM050A01 rev 0.0 7.March.2021
The CMSIS-DAP for XStream Adapters is a debugger used for programming and debugging microcontrollers. It is compatible with XStream-Iso and XStreamPro- Iso adapters and uses the CMSIS-DAP 2.0 Vprotocol.
Usage Instructions:
- Ensure that the XStream adapter is properly connected to the microcontroller.
- Connect the CMSIS-DAP for XStream Adapters to the USB port of your computer.
- Install the necessary software drivers for the debugger.
- Launch your preferred Integrated Development Environment (IDE) and select the CMSIS-DAP as the debugger.
- You can now program and debug your microcontroller using the IDE.
End User License Agreement:
You may use this product on multiple computers and make one copy of the software for archival purposes. You may also use the software on a network. However, you may not sublicense, reverse engineer, decompile, disassemble, modify, translate, or create derivative works from the product. Additionally, you may not redistribute any part of the software component of this product or use it with a programming adapter (hardware) that is not a product of Elprotronic Inc.
Limitation of Liability:
In no event shall Elprotronic Inc. be liable to you for any loss of use, interruption of business, or any direct, indirect, special, incidental, or consequential damages of any kind (including lost profits) regardless of the form of action whether in contract, tort (including negligence), strict product liability or otherwise, even if Elprotronic Inc. has been advised of the possibility of such damages.
Copyright:
All rights, title, and copyrights in and to the product and any copies of the product are owned by Elprotronic. The product is protected by copyright laws and international treaty provisions. Therefore, you must treat the product like any other copyrighted material.
Elprotronic Inc. 35 Austin Rumble Court King City Ontario, L7B0B2 CANADA
Web site: www.elprotronic.com
E-mail: info@elprotronic.com
Fax : 905-539-0474
Voice: 905-539-0424
Copyright © Elprotronic Inc. All rights reserved
Disclaimer:
No part of this document may be reproduced without the prior written consent
of Elprotronic Inc. The information in this document is subject to change
without notice and does not represent a commitment on any part of Elprotronic
Inc. While the information contained herein is assumed to be accurate,
Elprotronic Inc. assumes no responsibility for any errors or omissions.
In no event shall Elprotronic Inc., its employees or authors of this document
be liable for special, direct, indirect, or consequential damage, losses,
costs, charges, claims, demands, claims for lost profits, fees, or expenses of
any nature or kind.
The software described in this document is furnished under a license and may
only be used or copied in accordance with the terms of such a license.
Disclaimer of warranties: You agree that Elprotronic Inc. has made no express
warranties to You regarding the software, hardware, firmware and related
documentation. The software, hardware, firmware and related documentation
being provided to You “AS IS” without warranty or support of any kind.
Elprotronic Inc. disclaims all warranties with regard to the software, express
or implied, including, without limitation, any implied warranties of fitness
for a particular purpose, merchantability, merchantable quality or non-
infringement of third-party rights.
Limit of liability: In no event will Elprotronic Inc. be liable to you for any
loss of use, interruption of business, or any direct, indirect, special
incidental or consequential damages of any kind (including lost profits)
regardless of the form of action whether in contract, tort (including
negligence), strict product liability or otherwise, even if Elprotronic Inc.
has been advised of the possibility of such damages.
END USER LICENSE AGREEMENT
PLEASE READ THIS DOCUMENT CAREFULLY BEFORE USING THE SOFTWARE AND THE ASSOCIATED HARDWARE. ELPROTRONIC INC. AND/OR ITS SUBSIDIARIES (“ELPROTRONIC”) IS WILLING TO LICENSE THE SOFTWARE TO YOU AS AN INDIVIDUAL, THE COMPANY, OR LEGAL ENTITY THAT WILL BE USING THE SOFTWARE (REFER- ENCED BELOW AS “YOU” OR “YOUR”) ONLY ON THE CONDITION THAT YOU AGREE TO ALL TERMS OF THIS LICENSE AGREEMENT. THIS IS A LEGAL AND ENFORCA- BLE CONTRACT BETWEEN YOU AND ELPROTRONIC. BY OPENING THIS PACKAGE, BREAKING THE SEAL, CLICKING I AGREE BUTTON OR OTHERWISE INDICATING AS-SENT ELECTRONICALLY, OR LOADING THE SOFTWARE YOU AGREE TO THE TERMS AND CONDITIONS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THESE TERMS AND CONDITIONS, CLICK ON THE I DO NOT AGREE BUTTON OR OTHERWISE INDI- CATE REFUSAL, MAKE NO FURTHER USE OF THE FULL PRODUCT AND RETURN IT WITH THE PROOF OF PURCHASE TO THE DEALER FROM WHOM IT WAS ACQUIRED WITHIN THIRTY (30) DAYS OF PURCHASE AND YOUR MONEY WILL BE REFUNDED.
License.
The software, firmware and related documentation (collectively the “Product”)
is the property of Elprotronic or its licensors and is protected by copyright
law. While Elprotronic continues to own
the Product, You will have certain rights to use the Product after Your
acceptance of this license.
This license governs any releases, revisions, or enhancements to the Product
that Elprotronic may furnish to You. Your rights and obligations with respect
to the use of this Product are as follows:
YOU MAY:
- A. use this Product on many computers;
- B. make one copy of the software for archival purposes, or copy the software onto the hard disk of Your computer and retain the original for archival purposes;
- C. use the software on a network
YOU MAY NOT:
- A. sublicense, reverse engineer, decompile, disassemble, modify, translate, make any attempt to discover the Source Code of the Product; or create derivative works from the Product;
- B. redistribute, in whole or in part, any part of the software component of this Product;
- C. use this software with a programming adapter (hardware) that is not a product of Elprotronic Inc.
Copyright
All rights, title, and copyrights in and to the Product and any copies of the Product are owned by Elprotronic. The Product is protected by copyright laws and international treaty provisions. Therefore, you must treat the Product like any other copyrighted material.
Limitation of liability
In no event shall Elprotronic be liable to you for any loss of use, interruption of business, or any direct, indirect, special, incidental or consequential damages of any kind (including lost profits) regardless of the form of action whether in contract, tort (including negligence), strict product liability or otherwise, even if Elprotronic has been advised of the possibility of such damages.
DISCLAIMER OF WARRANTIES.
You agree that Elprotronic has made no express warranties to You regarding the software, hardware, firmware and related documentation. The software, hardware, firmware and related documentation being provided to You “AS IS” without warranty or support of any kind. Elprotronic disclaims all warranties with regard to the software and hardware, express or implied, including, without limitation, any implied warranties of fitness for a particular purpose, merchantability, merchantable quality or non-infringement of third- party rights.
Introduction
- The XStream (XStream-Iso and XStreamPro-Iso) adapters support the CMSIS-DAP 2.0 debugging protocol. The “debugging software” is designed for IDEs that target ARM MCUs and support the CMSIS-DAP 2.0 protocol from ARM.
- The debugging software package comes with a WindowsTM USB driver that can register XStream adapters as CMSIS-DAP debuggers or standard Elprotronic Flash/Gang Programmers. The software is available for download online at http://www.elprotronic.com (supported from Windows 7 to Windows 10).
- The debugging software enables communication with the IDE at USB full-speed performance with communication up to 12 Mb/s (1.5 MB/s). On the adapter side, the XStream adapter can communicate with the target device via JTAG or SWD protocol with programmable speed ranging from 100kHz to 20 MHz. In addition, when the SWD protocol is selected, the SWO line can be used for tracing the data transferred from debugged target (if supported) via UART protocol with programmable baud rate between 10 kb/s to 12.5 Mb/s.
- The remainder of this manual will explain how to use all the different features of the debugging software, and how to configure the XStream adapter to act as a CMSIS-DAP debugger or revert to default Elprotronic Flash/Gang programmer mode.
Features
XStream-Iso and XStreamPro-Iso adapters can be configured as CMSIS-DAP debuggers supporting the CMSIS-DAP 2.0 protocol for ARM MCUs. Any IDE that supports the CMSIS-DAP 2.0 protocol can then use the XStream adapter in this mode for debugging.
Key Features
The key features of the CMSIS-DAP setup for XStream adapters:
- Supports the CMSIS-DAP 2.0 communication protocol via USB interface.
- Debugging via JTAG or SWD interface.
- Programmable JTAG/SWD communication speed from 100 kHz to 20 MHz.
- Supports tracing via SWO pin when SWD interface is used.
- Trace via UART with programmable baud rate from 10 kb/s up to 12.5 Mb/s
- Trace buffer size – 32 kB
- Target device can be powered from external power supply or from XStream adapter.
- Programmable power supply from adapter – 1.65V to 4.0V for XStream-Iso adapter and in the range 1.2V to 4.0 V for XStreamPro-Iso adapter. Max current up to 200 mA.
- Galvanic isolation between PC and target device
- Easy to use WindowsTM based software for configuration setup.
- The XS-CMSIS-DAP product is a dedicated low-cost debugging adapter that does not run any other Elprotronic programming software.
- XStream-Iso and XstreamPro-Iso adapters that already have the FlashPro-ARM, GangPro-ARM, FlashPro-X and GangPro-X license, can also run the XS-CMSIS-DAP software after they download the latest ARM software package update.
Hardware details are provided in the below documents:
https://content.elprotronic.ca/docs/Elprotronic-
Programmers.pdf
https://content.elprotronic.ca/docs/Elprotronic-
Connection%20to%20Programmers.pdf
Getting Started
The XS-CMSIS-DAP product package contains:
- One XStream-Iso adapter
- Runs software available for download from www.elprotronic.com – download page.
- One 6 feet long USB-A to USB-B cable
- FPA to ARM 14-pin to 20-pin and 10 pin adapter (PE036X02) and ribbon cables
The CMSIS-DAP debugging software run under Windows 7 to 10. Follow instruction below to install the software
- Download XS-CMSIS-DAP-Setup.zip, unzip it and run setup.exe.
- The setup wizard appears automatically after clicking setup.exe. Begin the installation process.
- Once the installation program starts, on-screen instructions will guide you through the remainder of the installation. You must accept the license agreement before using this software.
Driver Installation
The installation program will place the USB driver files in Windows
directories “Windows\inf” and
“Windows\system32\drivers”. When the CMSIS-DAP debugging software is installed
then by default the drivers are preinstalled automatically. If for any reason
the device cannot be seen under Device Manager when the adapter is plugged-in
to USB port, then install the drivers manually. Drivers are located in the
directory
C:\Program Files (x86)\Elprotronic\Drivers XStream\WIN64
Main Graphical User Interface
The main dialog (see Figure 4.1) contains an adapter’s label and setup options
.
Figure 4.1: Main Dialog Screen. This label shows a XStreamPro-Iso adapter with the GangPro-X license. It can run in CMSIS-DAP debugger mode, or as an Elprotronic programmer. The user can switch between these two modes at any time.
CMSIS-DAP debugging software
The XStream adapters (XStream-Iso and XStreamPro-Iso) have the capability to
operate as an Elprotronic programmer or as a CMSIS-DAP Debugger. The working
mode is selected in the Adapter Option Selector. Each of these two working
modes uses different USB communication protocols and different USB drivers,
therefore only one mode can be used at one time. Elprotronic programming
software like the FlashPro-ARM or GangPro-ARM will not detect the adapter if
it is in CMSIS-DAP mode. Conversely, debugging IDEs will not see the adapter
if it is in Elprotronic programmer mode. Therefore, make sure to select your
desired mode of operation before proceeding to production programming or
debugging. When the programming mode is selected then the following USB driver
can be seen under Device Manager (see Figure 4.2)
Figure 4.2: USB Driver for adapter working in the programming mode.
When the CMSIS-DAP mode is selected then the following USB driver can be seen
under Device Manager (see Figure 4.3)
Configuration setup in the XStream Adapter
Connect XStream adapter to PC and run the CMSIS-DAP configuration software.
You should see the adapter’s label and selected configuration as seen in
Figure 4.1. First check if the CMSIS-DAP firmware version inside the adapter
is the same as the available firmware version in the configuration software.
If firmware is not the same or the check sum/PSA is not OK, then press the
Update FW button and the firmware inside the XStream adapter will be updated.
The next option that should be set in the CMSIS-DAP configuration is the power
option for the XStream adapter. The CMSIS-DAP 2.0 protocol does not explicitly
control power supply, but the XStream adapter has the option to supply the
target. That is why the user must choose between external power supply or
configure the XStream adapter’s output voltage and check the “Power from
Adapter Enable” box. The XStream-Iso adapter can supply Vcc from 1.7V to 4.0V,
or if the XStreamPro-Iso adapter is used from 1.2V to 4.0. Additionally, the
Vcc Settle time should be set to specify the time from when the power-up of
the target is initiated to when the other circuits on the target board are
stable. The Settle time can be specified in the range from 50 to 300 ms. By,
default that time is set to 50 ms. When finished, press the “Save” button to
store the configuration inside the XStream adapter.
Debugging with IDE
When the XStream adapter is set for CMSIS-DAP debugging mode then adapter is ready to be used with IDE software that supports the CMSIS-DAP 2.0 USB protocol. Below is the setup description for two IDEs that support the CMSIS- DAP 2.0 USB protocol – the Keil uVision and the IAR EW-ARM IDE.
Keil uVision
Run the Keil IDE software uVision 5 or higher and select the Option for Target
(see Figure 5.1). Then in Tab Debug select the option CMSIS-DAP Debugger.
Press button Settings then the following screen should be displayed (see
Figure 5.2). On the CMSIS-DAP – JTAG/SWD Adapter should be displayed XStream-
Iso CMSIS-DAP. Select desired communication protocol, JTAG or SWD and desired
communication speed. If target device is connected then in the SW Device Group
should be displayed valid IDCODE and Device Name. Now, the XStream adapter is
ready for debugging via CMSIS-DAP protocol. Select and set the Trace option if
applicable.
**CMSIS-DAP for XStream Adapters
**
IAR EW-ARM
Run the IAR IDE software EW-ARM version 9.1 or up and select the Option -> Debugger (see Figure 5.3).
Select the CMSIS-DAP Debugger. Press button OK then go to CMSIS DAP Debugger
option setup (see Figure 5.4). Select Interface type JTAG or SWD. The Vcc
external or internal is set by the configuration software (see Figure 4.1).
www.elprotronic.ca