Introduction Application Note This application note assists you in understanding the Renesas Synergy Platform based USBX CDC ACM application and its capabilities when using the Renesas Synergy Target Board (TB). Instructions guide you as you implement the USBX CDC application using the Synergy Software Package (SSP). Target Devices Renesas Synergy Target Boards Minimum PC Requirements Microsoft Windows 7 or 10 Intel Core family processor running at 2.0 GHz or higher (or equivalent processor) 8 GB memory 2 GB of free space on the hard disk or solid state drive (SSD) USB 2.0 R11AN0215EU0103 Rev.1.03 Required Resources To build and run the application, you need: Tools Required e 2 studio ISDE v5.4.0.023 or greater, IAR EW for Synergy v7.71.3 or greater, Synergy Software Package (SSP) v1.3.0 or greater, Synergy Standalone Configurator (SSC) v5.4.0.023 or greater e 2 studio ISDE v6.2 or greater, IAR EW for Synergy v8.2 or greater Synergy Software Package (SSP) v1.4.0 or greater, Synergy Standalone Configurator (SSC) v6_2_0_r20180102 or greater Kits supported TB-S3A6 v 1.0, TB-S5D5 v1.0, TB-S3A3 v1.0 TB-S3A1 v1.0 Test PC (running on Windows 7 or 10) Tera Term terminal emulator installed on a test PC. SEGGER J-Link USB driver For the Windows USB driver (go to https://www.segger.com/downloads/jlink and download the SEGGER J-Link software and documentation pack) Micro USB cables. You can download the required Renesas software from the Renesas Synergy Gallery (https://synergygallery.renesas.com). R11AN0215EU0103 Rev.1.03 Page 1 of 16
Prerequisites These instructions are intended for developers wanting to develop applications with USB CDC interface using Renesas Synergy Target Boards. To use this application note, it is assumed that you have some knowledge on the USB device stack and its communication protocols. This application note also assumes you have some experience with the Renesas Synergy e 2 studio Integrated Solutions Development Environment (ISDE) and the Synergy Software Package (SSP), as well as familiarity with a common terminal emulation program (such as Tera Term) running on a Windows PC. The enclosed instructions assist you to import the application project and as you use e 2 studio ISDE to recreate the application. Before you use the instructions in this application note, follow the procedure in your board s Quick Start Guide to build and run the Blinky project. By doing so, you will become familiar with using e 2 studio and the SSP, and ensure that the debug connection to your board is functioning properly. Contents 1. Application Overview... 3 1.1 USBX Subsystem... 3 1.2 USBX Device CDC-ACM Configuration... 3 1.3 Application Software Architecture... 4 2. Creating a sample USBX CDC ACM project... 5 2.1 Creating a new project with RTOS... 5 2.2 Creating the USB thread... 6 2.3 Adding the USBX CDC device framework... 6 2.4 Creating the button processing thread... 9 2.5 Generating Project Content... 11 2.6 Setting up the Application Project files... 11 3. Running the Pre-existing USBX CDC ACM Device demonstration application... 12 3.1 Powering up the Board... 12 3.2 Importing, Building and Running the Project... 12 3.3 Verifying the demonstration application... 13 3.4 Verifying the Expected Results... 14 4. Next Steps... 15 5. Limitations and Assumptions... 15 R11AN0215EU0103 Rev.1.03 Page 2 of 16
1. Application Overview This application example shows the use of a USB communication device class as a serial communications device connected through a serial port (COM port) on a PC. This application also demonstrates how key elements work together in a typical design. These elements include the ThreadX RTOS, the USBX device class, the USBX device driver for the Renesas Synergy Platform, and a sample USBX CDC ACM device application. 1.1 USBX Subsystem The Renesas Synergy Platform uses the Express Logic USBX USB stack (UX) integrated in the SSP. USBX supports USB specifications: 1.1 and 2.0. The USB Device CDC-ACM class allows a USB host system to communicate as a serial device with the target board. This class is based on the USB standard and is a subset of the CDC standard. Figure 1 USBX Device class stack configuration The USBX device class stack configuration shows one USBX Device class components (ux_device_class_xxx) on top with its components, the USBX (ux) in the middle, and the USBX Port driver (sf_el_ux) Device Controller Driver (DCD) located on the bottom of the stack. As the recommended option, the SSP Transfer module (r_dmac or r_dtc) supports data transfer between the memory and hardware FIFO in the Synergy USB peripherals (USBHS or USBFS). To support the USB device stack configuration, there are some components named USBX Device Configuration and USBX Interface Configuration. These components do not represent actual software modules in the SSP, but are virtual modules used to handle the code generation. 1.2 USBX Device CDC-ACM Configuration The USBX Device Class CDC-ACM component has configurations to setup USB Device Class CDC-ACM. The component can be configured through the SSC. Table 1 USB Device Class CDC-ACM Configurations Configuration Settings Description Name Arbitrary symbol name (Default: Specify the name of USBX g_ux_device_class_cdc_acm0 ) Device CDC-ACM class USBX CDC-ACM instance_activate Function Callback USBX CDC-ACM instance_deactivate Function callback Arbitrary symbol name (Default: ux_cdc_device_instance_activate ) Arbitrary symbol name (Default: ux_cdc_device_instance_deactivate ) module instance. Specify the name of instance_activate user callback function for the USBX Device CDC-ACM Class module. Specify the name of instance_deactivate user callback function for the USBX Device CDC-ACM Class module. R11AN0215EU0103 Rev.1.03 Page 3 of 16
1.3 Application Software Architecture The USB thread and the Button thread are the main software components in the application. The USB thread includes the USBX device CDC ACM class stack framework, the USBX port driver and the SSP transfer module r_dmac that supports data transfer between memory and hardware FIFO in the Synergy USB peripherals. The USB thread handles all USB related communication with the underlying USB controller, such as enumeration of the USB CDC communication protocol. The USB thread receives any button push event from the button processing thread and sends out a Welcome to the Synergy Platform text string to serial console. The button processing thread handles processing of button events using the interrupt mechanism. Whenever a user presses a button, the interrupt is generated and the pb_switch_event_callback is invoked. The button event is processed and the button trigger event is sent to USB thread through ThreadX message queue API. Application Button Thread USB Thread Framework USBX CDC Class driver ThreadX RTOS Shared Interface USBX Device Stack USB DCD HAL IO Port DMAC BSP Synergy MCU Figure 2 USBX CDC ACM device application software architecture R11AN0215EU0103 Rev.1.03 Page 4 of 16
2. Creating a sample USBX CDC ACM project To recreate the USBX CDC ACM Device application project using the e 2 studio ISDE or the IAR EW for Synergy SSC, follow these steps: 2.1 Creating a new project with RTOS 1. Create a new Synergy project by clicking File->New-> Synergy C/C++ Project 2. For IAR EW for Synergy, click Renesas Synergy -> New Synergy Project. Select the name as described in the figure that follows and select the license file and SSC version. 3. Choose Renesas Synergy C Executable Project and click Next. 4. Enter the project name and set up the Synergy license file. 5. Choose the target board (for example, in the case of S3A6 Target Board, choose S3A6TB). 6. Choose SSP version (In case of SSP 1.3.0, choose 1.3.0 (see Figure 3)) 7. Choose the board support package (BSP) option in the project template selection window. R11AN0215EU0103 Rev.1.03 Page 5 of 16
Figure 3 Synergy project creation 2.2 Creating the USB thread 1. Go to the Thread tab and click the New Thread button to create a new thread. 2. Set the property of this new thread as shown in Figure 4. 2.3 Adding the USBX CDC device framework 1. Click USB Thread, the newly created thread. In the USB Thread Stacks window, click the New Stack button to add the USBX CDC ACM Device framework. 2. Choose X-Ware -> USBX -> Device -> Classes -> CDC-ACM -> USBX Device Class CDC-ACM Figure 4 Add USBX CDC ACM device framework module 3. Click Add USBX Port DCD block in the USB thread Stacks window. 4. Select USBX Port DCD on sf_el_ux for USBFS. R11AN0215EU0103 Rev.1.03 Page 6 of 16
Figure 5 Add USBX Port DCD module 5. Click Add Transfer Module for TX and Add Transfer Module for Rx on the USB thread Stacks window. 6. Select Transfer Driver on r_dmac. Figure 6 Add r_dmac module 7. Refer to Figure 7 as you select the following USBX module properties: A. Select g_sf_el_ux_dcd_fs_0 USBX Port DCD on sf_el_ux for USBFS and set the Full Speed interrupt priority in its Properties tab. B. Select g_transfer0 Transfer Driver on r_dmac Software Activation box and set the Interrupt priority in its Properties tab. C. Select g_transfer1 Transfer Driver on r_dmac Software Activation box and set the Interrupt priority in its Properties tab. R11AN0215EU0103 Rev.1.03 Page 7 of 16
A B C Figure 7 USBX module properties 8. Select the USBX Device Configuration block. In the Properties tab, configure the Product ID and Class Code. Figure 8 USBX device configuration properties 9. Click the New Object button in the USB Thread Objects window and create the following thread objects. R11AN0215EU0103 Rev.1.03 Page 8 of 16
Figure 9 USB thread objects properties 2.4 Creating the button processing thread 1. Go to New Thread tab and click the New Thread button to create the button_processing_thread. 2. Set the property of this new thread as shown in Figure 10. 3. Include External IRQ Driver on r_icu module by clicking the New Stack button in the HAL/Common Stacks window and go to Driver Input External IRQ Driver on r_icu (see Figure 10). R11AN0215EU0103 Rev.1.03 Page 9 of 16
Figure 10 Adding IRQ driver module R11AN0215EU0103 Rev.1.03 Page 10 of 16
4. Click the + sign in the Button_Processing_Thread Objects window and create the following thread object. 2.5 Generating Project Content Figure 11 Button thread object properties Click the Generate Project Content button icon. The project files generate using the configuration option you selected. The e 2 studio ISDE has now generated the application project files for the configuration chosen. 2.6 Setting up the Application Project files 1. Go to project Explorer window and under your project open the src folder and notice the following files generated for this application project. These files are place holders for adding your application code. R11AN0215EU0103 Rev.1.03 Page 11 of 16
2. Now you can either write your own application functions for these threads or copy the existing USBX CDC ACM device demonstration application project source file to recreate this demonstration. Button_processing_thread_entry.c Common.h Board configuration file (For example, Config_s3a6.h) Push_button_switch.h Usb_thread_entry.c Util.h 3. Build the application project by clicking the Hammer icon as seen in the menu bar in Figure 13. Figure 12 Build button 3. Running the Pre-existing USBX CDC ACM Device demonstration application 3.1 Powering up the Board This section describes how to connect the board to power, the J-Link debugger to the PC, the board to the PC USB port, and how to run the debug application to see it in action. 1. Connect the Micro USB end of the supplied USB cable to the Renesas Synergy Target board J11 connector (DEBUG_USB). Note: The kit contains a SEGGER J-Link On-board (OB). The J-Link provides full debug and programming capabilities for the Renesas Synergy Target board. 2. Connect the other end of the USB cable to the USB port on your workstation. LED2 turns green, indicating a good connection. 3.2 Importing, Building and Running the Project For instructions on importing the project into e 2 studio ISDE to build and run the project, see Renesas Synergy Project Import Guide (r11an0023eu0119-synergy-ssp-import-guide.pdf). Note: Select USBX_CDC_Device_TBS3A6Kit Debug, and the GDB Hardware Debugging configuration to debug. R11AN0215EU0103 Rev.1.03 Page 12 of 16
3.3 Verifying the demonstration application 1. Connect Renesas Synergy Target Board to the Windows 10 PC. 2. Follow Section 3.1 to power up the kit and Section 3.2 to load and run the application project on Renesas Synergy Target Board. 3. Connect a micro USB cable to the Renesas Synergy Target Board J9 connector (USB DEVICE). 4. Connect the other end of the USB cable to the USB port on your workstation. 5. Open the device manager window on your Test PC. The Renesas Synergy Target Board will be detected as USB Serial Device, shown in the following figures. Figure 13 Device Manager in Windows 10 6. Connect Renesas Synergy Target Board to the Windows 7 PC. 7. Follow Section 3.1 to power up the kit and Section 3.2 to load and run the application project on Renesas Synergy Target Board. 8. Connect a micro USB cable to the Renesas Synergy Target Board connector J9 (USB DEVICE). 9. Connect the other end of the USB cable to the USB port on your workstation. 10. Open the device manager window on your Test PC. The Renesas Synergy Target Board will be detected as an Unknown Device. 11. Right click on this device and select Update Driver software. R11AN0215EU0103 Rev.1.03 Page 13 of 16
12. When prompted for the location of the drivers, browse to the location of the Windows USB serial driver provided as part of this application project. Once the driver is updated, a new COM device shows up in the Device Manager. 3.4 Verifying the Expected Results Figure 14 Device Manager in Windows 7 1. Follow Section 3.3, based on the Windows version of your Test PC, to load the windows USB driver. 2. Once the Renesas Synergy Target Board is detected as USB Serial Device in the Device Manager, run the Tera Term application and open new connection by selecting the USB Serial device. 3. Press the S1 User button on the Renesas Synergy Target Board. Every time the S1 button is pressed, the following message is printed on the Tera Term terminal. Figure 15 Welcome to the Synergy Platform screen R11AN0215EU0103 Rev.1.03 Page 14 of 16
4. Next Steps 1. Visit renesassynergy.com to quickly get started with developing in three steps. A. Get a kit B. Download software & development tools C. Begin developing 2. Visit the following URLs to learn about the three key elements of the Synergy Platform and download components/documentation related to them. Software : renesassynergy.com/software Hardware : renesassynergy.com/hardware Solutions Gallery : renesassynergy.com/solutionsgallery 3. Visit the following URLs to learn about the following: Microcontrollers : renesassynergy.com/mcus Development tools : renesassynergy.com/devtools Kits : renesassynergy.com/kits 5. Limitations and Assumptions None Help & Support You can utilize the following self-service help and support resources: Documentation : renesassynergy.com/docs Knowledgebase : renesassynergy.com/knowledgebase Forums : renesassynergy.com/forums Training : renesassynergy.com/training Videos : renesassynergy.com/videos You can also obtain personalized technical support through online chat and web ticket at renesassynergy.com/support. R11AN0215EU0103 Rev.1.03 Page 15 of 16
Website and Support Support: https://synergygallery.renesas.com/support Technical Contact Details: America: https://www.renesas.com/en-us/support/contact.html Europe: https://www.renesas.com/en-eu/support/contact.html Japan: https://www.renesas.com/ja-jp/support/contact.html All trademarks and registered trademarks are the property of their respective owners. R11AN0215EU0103 Rev.1.03 Page 16 of 16
Revision History Rev. Date Description Page Summary 1.00 Aug 25, 2017 Initial release 1.01 Oct 16, 2017 1, 4 &13 Modified required resources version information, updated the software architecture diagram, and added module guide collateral link. 1.02 Oct 27, 2017 Updated release for version 1.3.2 1.03 Added support for TB-S3A1 kit
Notice 1. Descriptions of circuits, software and other related information in this document are provided only to illustrate the operation of semiconductor products and application examples. You are fully responsible for the incorporation or any other use of the circuits, software, and information in the design of your product or system. Renesas Electronics disclaims any and all liability for any losses and damages incurred by you or third parties arising from the use of these circuits, software, or information. 2. Renesas Electronics hereby expressly disclaims any warranties against and liability for infringement or any other claims involving patents, copyrights, or other intellectual property rights of third parties, by or arising from the use of Renesas Electronics products or technical information described in this document, including but not limited to, the product data, drawings, charts, programs, algorithms, and application examples. 3. No license, express, implied or otherwise, is granted hereby under any patents, copyrights or other intellectual property rights of Renesas Electronics or others. 4. You shall not alter, modify, copy, or reverse engineer any Renesas Electronics product, whether in whole or in part. Renesas Electronics disclaims any and all liability for any losses or damages incurred by you or third parties arising from such alteration, modification, copying or reverse engineering. 5. Renesas Electronics products are classified according to the following two quality grades: Standard and High Quality. The intended applications for each Renesas Electronics product depends on the product s quality grade, as indicated below. "Standard": Computers; office equipment; communications equipment; test and measurement equipment; audio and visual equipment; home electronic appliances; machine tools; personal electronic equipment; industrial robots; etc. "High Quality": Transportation equipment (automobiles, trains, ships, etc.); traffic control (traffic lights); large-scale communication equipment; key financial terminal systems; safety control equipment; etc. Unless expressly designated as a high reliability product or a product for harsh environments in a Renesas Electronics data sheet or other Renesas Electronics document, Renesas Electronics products are not intended or authorized for use in products or systems that may pose a direct threat to human life or bodily injury (artificial life support devices or systems; surgical implantations; etc.), or may cause serious property damage (space system; undersea repeaters; nuclear power control systems; aircraft control systems; key plant systems; military equipment; etc.). Renesas Electronics disclaims any and all liability for any damages or losses incurred by you or any third parties arising from the use of any Renesas Electronics product that is inconsistent with any Renesas Electronics data sheet, user s manual or other Renesas Electronics document. 6. When using Renesas Electronics products, refer to the latest product information (data sheets, user s manuals, application notes, General Notes for Handling and Using Semiconductor Devices in the reliability handbook, etc.), and ensure that usage conditions are within the ranges specified by Renesas Electronics with respect to maximum ratings, operating power supply voltage range, heat dissipation characteristics, installation, etc. Renesas Electronics disclaims any and all liability for any malfunctions, failure or accident arising out of the use of Renesas Electronics products outside of such specified ranges. 7. Although Renesas Electronics endeavors to improve the quality and reliability of Renesas Electronics products, semiconductor products have specific characteristics, such as the occurrence of failure at a certain rate and malfunctions under certain use conditions. Unless designated as a high reliability product or a product for harsh environments in a Renesas Electronics data sheet or other Renesas Electronics document, Renesas Electronics products are not subject to radiation resistance design. You are responsible for implementing safety measures to guard against the possibility of bodily injury, injury or damage caused by fire, and/or danger to the public in the event of a failure or malfunction of Renesas Electronics products, such as safety design for hardware and software, including but not limited to redundancy, fire control and malfunction prevention, appropriate treatment for aging degradation or any other appropriate measures. Because the evaluation of microcomputer software alone is very difficult and impractical, you are responsible for evaluating the safety of the final products or systems manufactured by you. 8. Please contact a Renesas Electronics sales office for details as to environmental matters such as the environmental compatibility of each Renesas Electronics product. You are responsible for carefully and sufficiently investigating applicable laws and regulations that regulate the inclusion or use of controlled substances, including without limitation, the EU RoHS Directive, and using Renesas Electronics products in compliance with all these applicable laws and regulations. Renesas Electronics disclaims any and all liability for damages or losses occurring as a result of your noncompliance with applicable laws and regulations. 9. Renesas Electronics products and technologies shall not be used for or incorporated into any products or systems whose manufacture, use, or sale is prohibited under any applicable domestic or foreign laws or regulations. You shall comply with any applicable export control laws and regulations promulgated and administered by the governments of any countries asserting jurisdiction over the parties or transactions. 10. It is the responsibility of the buyer or distributor of Renesas Electronics products, or any other party who distributes, disposes of, or otherwise sells or transfers the product to a third party, to notify such third party in advance of the contents and conditions set forth in this document. 11. This document shall not be reprinted, reproduced or duplicated in any form, in whole or in part, without prior written consent of Renesas Electronics. 12. Please contact a Renesas Electronics sales office if you have any questions regarding the information contained in this document or Renesas Electronics products. (Note 1) Renesas Electronics as used in this document means Renesas Electronics Corporation and also includes its directly or indirectly controlled subsidiaries. (Note 2) Renesas Electronics product(s) means any product developed or manufactured by or for Renesas Electronics. (Rev.4.0-1 November 2017) SALES OFFICES Refer to "http://www.renesas.com/" for the latest and detailed information. Renesas Electronics America Inc. 1001 Murphy Ranch Road, Milpitas, CA 95035, U.S.A. Tel: +1-408-432-8888, Fax: +1-408-434-5351 Renesas Electronics Canada Limited 9251 Yonge Street, Suite 8309 Richmond Hill, Ontario Canada L4C 9T3 Tel: +1-905-237-2004 Renesas Electronics Europe Limited Dukes Meadow, Millboard Road, Bourne End, Buckinghamshire, SL8 5FH, U.K Tel: +44-1628-651-700, Fax: +44-1628-651-804 Renesas Electronics Europe GmbH Arcadiastrasse 10, 40472 Düsseldorf, Germany Tel: +49-211-6503-0, Fax: +49-211-6503-1327 Renesas Electronics (China) Co., Ltd. Room 1709 Quantum Plaza, No.27 ZhichunLu, Haidian District, Beijing, 100191 P. R. China Tel: +86-10-8235-1155, Fax: +86-10-8235-7679 Renesas Electronics (Shanghai) Co., Ltd. Unit 301, Tower A, Central Towers, 555 Langao Road, Putuo District, Shanghai, 200333 P. R. China Tel: +86-21-2226-0888, Fax: +86-21-2226-0999 Renesas Electronics Hong Kong Limited Unit 1601-1611, 16/F., Tower 2, Grand Century Place, 193 Prince Edward Road West, Mongkok, Kowloon, Hong Kong Tel: +852-2265-6688, Fax: +852 2886-9022 Renesas Electronics Taiwan Co., Ltd. 13F, No. 363, Fu Shing North Road, Taipei 10543, Taiwan Tel: +886-2-8175-9600, Fax: +886 2-8175-9670 Renesas Electronics Singapore Pte. Ltd. 80 Bendemeer Road, Unit #06-02 Hyflux Innovation Centre, Singapore 339949 Tel: +65-6213-0200, Fax: +65-6213-0300 Renesas Electronics Malaysia Sdn.Bhd. Unit 1207, Block B, Menara Amcorp, Amcorp Trade Centre, No. 18, Jln Persiaran Barat, 46050 Petaling Jaya, Selangor Darul Ehsan, Malaysia Tel: +60-3-7955-9390, Fax: +60-3-7955-9510 Renesas Electronics India Pvt. Ltd. No.777C, 100 Feet Road, HAL 2nd Stage, Indiranagar, Bangalore 560 038, India Tel: +91-80-67208700, Fax: +91-80-67208777 Renesas Electronics Korea Co., Ltd. 17F, KAMCO Yangjae Tower, 262, Gangnam-daero, Gangnam-gu, Seoul, 06265 Korea Tel: +82-2-558-3737, Fax: +82-2-558-5338 http://www.renesas.com 2018 Renesas Electronics Corporation. All rights reserved. Colophon 7.0