Renesas Synergy SK-S7G2, Synergy DK-S7G2, Synergy PE-HMI1, Synergy DK-S3A7 Quick Start Manual

Application Note

R30AN0232EU0111

Rev.1.11

Nov 18, 2016

Renesas Synergy™ Platform

Getting Started with USBX™ HID Keyboard
(Device)

Introduction

This application note describes how to install, build, and run an example HID keyboard device application on a Renesas
Synergy development board using the Renesas e
application also includes the following key elements to demonstrate how they work together in a typical design:
ThreadX® RTOS, USBX device class, USBX device driver for the Renesas Synergy Platform, and a sample HID
keyboard device application

2

studio ISDE and Renesas Synergy Software Package (SSP). The

Goals and Objectives

The goal of this application note is to help you install, build, and run the example application.
The example application demonstrates HID keyboard device connectivity on the PE-HMI1, DK-S7G2, DK-S3A7, or

SK-S7G kit. It takes you through all the necessary steps with the Renesas Synergy Platform including using an example
application in the Renesas e
illustrates the use of a USB HID keyboard device class as a serial communications device connected through a serial
port (COM port) on a PC.

2

studio ISDE and running that application on the target board. The example application

Prerequisites

The reader of this application note is assumed to have some experience with the Renesas e2 studio ISDE and SSP. For
example, before you perform the procedure in this application note, you should 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 e
and ensure that the debug connection to your board is functioning properly.

2

studio and the SSP

Required Resources

The example application targets Renesas Synergy S7G2 and S3A7 devices. To build and run the example application,
you will need:

• A Renesas Synergy DK-S7G2, SK-S7G2, PE-HMI1, or DK-S3A7 boa rd

• A PC running Microsoft® W i ndows® 7 with the following Renesas software installed:

2

• e

studio ISDE 5.0.0

• Synergy Software Package (SSP) 1.1.0
You can download the required Renesas software from the Renesas Synergy Gallery

(https://synergygallery.renesas.com). The PC must also have a USB 2.0 port and connection to the Internet.

Time Required

You can install, build, and run the example application in under 30 minutes. The high-level steps involved are:

1. Connect to the target board.

2. Import, configure, and build the project.

3. Run the example application.

Contents

1. Connecting to the Board ................................................................................................. 2

2. Importing, Configuring, and Building the Project ......................................................... 2

3. Running the Example Application .................................................................................. 2

4. Next Steps ......................................................................................................................... 2

R30AN0232EU0111 Rev.1.11 Page 1 of 3
Nov 18, 2016

Renesas Synergy™ Platform Getting Started with USBX™ HID Keyboard (Device)

1. Connecting to the Board

To configure and connect your target board, follow the procedure in your target board’s Quick Start Guide to set up the
J-link debugger connection from your PC to the JTAG connector on the target board and power-up the board.

Note: For the DK-S3A7 board, set the USBF to the ON position, as shown in the following diagram:

2. Importing, Configuring, and Building the Project

Follow the procedure in the Synergy Project Import Guide (r11an0023eu0110_synergy_ssp.pdf) to import the project
into the e
USBX_HID_Keyboard Debug (under Renesas GDB Hardwar e Debugging).

2

studio ISDE, build, an d de b ug the project. When prompted to select the debug configuration, select

3. Running the Example Application

The example application illustrates USB connectivity through these two functions:

• The host PC recognizes the PE-HMI1, DK-S7G2, SK-SK7G2 or DK-S3A7 board as a keyboard device.

• The demo application types the characters to the PC.

To run the example application:

1. Follow the steps in section 4 in r11an0023eu0100_synergy_ssp.pdf and click Resume twice.

2. Open a text editor with a blank document. Make sure the cursor is active in the blank document that the application

of focus in Windows is the text editor window.

3. The demo application acts as a keyboard and types the characters ‘a’ through ‘z’ in the text editor window at 2-

second intervals. Characters are sent out automatically, so there is no need for user interaction.

4. Click Terminate to close the debugger.

4. Next Steps

After you run the example application, you can learn more about how the application works and the API calls involved
by examining the application source code.

You can also download additional Synergy example applications from the following URL:

https://www.renesas.com/en­us/search/keywordsearch.html#genre=tooldownload&softwarecategory=4&softwarecategory=7&softwarecategory=8&
softwarecategory=9&softwarecategory=10&softwarecategory=11&softwarecategory=12&softwarecategory=13&softw
arecategory=14&softwarecategory=27&softwarecategory=16&softwarecategory=17&softwarecategory=18&productlay
er=188815&productlayer=188816&productlayer=188817&productlayer=188819&productlayer=188820&productlayer
=188821&productlayer=188822

R30AN0232EU0111 Rev.1.11 Page 2 of 3
Nov 18, 2016

Renesas Synergy™ Platform Getting Started with USBX™ HID Keyboard (Device)

Website and Support
Support: https://synergygallery.renesas.com/support
Technical Contact Details:

• America: https://renesas.zendesk.com/anonymous_requests/new

• 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.

R30AN0232EU0111 Rev.1.11 Page 3 of 3
Nov 18, 2016

Rev.

Date

Description

Page

Summary

1.0

Oct 22, 2015

-

Initial Version

1.01

Jan 8, 2016

-

Update board connection section for multiple boards and for
SSP 1.0.0

1.02

Jan 22, 2016

-

Updated the Debug Configuration Name

-

- Fixed Include Issue

- One Debug session

1.03

Feb 9, 2016
2

Added extra instruction for DK-S3A7 configuration and updated
image.

-

Updated code examples

1.10

May 20, 2016

All

Updated to SSP 1.1.0

1.11

Nov 18, 2016

Title
3

Minor formatting changes.

Revision History

- Optimization -02

- No Yellow/Red in configuration

- High Drive

Fixed Next Steps URL.

Notice

1. Descriptions of cir c uits, software and other related informat ion in this document are provided only to illustrate the operation of semiconductor pr oduc ts and application examples. Y ou ar e fully responsible for
the incorporation of t hes e c ir c uits, software, and information in the des ign of y our equipment. Renesas Electronics assumes no respons ibility for any losses incur r ed by y ou or third parties arising fr om the use
of these circuits , software, or inf ormation.

2. Renesas Electronics has us ed r eas onable c ar e in pr epar ing the information included in this doc um ent, but Renesas Elect r onic s does not warrant that suc h information is error f r ee. Renesas Electronics
assumes no liability whats oev er for any damages incurred by you r es ulting from errors in or om is s ions from the informat ion inc luded her ein.

3. Renesas Electronics does not assume any liability for infringement of patent s , copyrights, or other intellectual propert y r ights of third parties by or ar is ing from the use of Renesas E lec tronics products or
technical information des c ribed in this document. No lic ens e, express, implied or ot her wis e, is granted hereby under any pat ents, copyrights or other intellectual propert y r ights of Renesas Electr onic s or
others.

4. You should not alter, modify, copy, or ot herwise misappropriate any Renesas E lec tronics product, whether in whole or in part. Renesas E lec tronics assumes no respons ibility for any losses incur r ed by y ou or
third parties arising from such alteration, modification, copy or otherwise misappropriation of Renes as E lec tronics product.

5. Renesas Electronics pr oduc ts are classified accor ding to the following two quality gr ades : "Standard" and "High Quality". The recommended applications f or eac h Renes as E lec tronics product depends on
the product's quality grade, as indicated below.
"Standard": Com puters; office equipm ent; communications equipm ent; test and measur em ent equipment; audio and visual equipment; home electronic appliances ; machine tools; personal elec tronic
equipment; and industrial r obots etc.
"High Quality": Transportation equipm ent (automobiles, tr ains , ships, etc.) ; traffic control systems; anti-disaster sys t ems; anti-crime s y s tems; and safety equipm ent etc.
Renesas Electronics pr oduc ts are neither intended nor aut hor iz ed for use in products or sy s tems that may pose a dir ec t threat to human lif e or bodily injur y ( ar tificial life support dev ic es or s y s tems, surgical
implantations etc. ) , or may cause serious pr oper ty damages (nuclear react or c ontrol systems, m ilitary equipment etc. ) . You must check t he quality grade of each Renesas Electronics product befor e us ing it
in a particular application. You may not use any Renesas Electronics product for any applic ation for which it is not intended. Renesas Electronic s s hall not be in any way liable for any damages or los s es
incurred by you or third par ties arising from the us e of any Renesas Electronics pr oduc t for which the product is not intended by Renesas Electr onic s .

6. You should use the Renesas Elect r onic s products described in this doc um ent within the range specified by Renes as E lec tronics, especially wit h r es pec t to the maximum rating, operating supply volt age
range, movement power v oltage range, heat radiation char ac teristics, installation and other product c har ac teristics. Renesas E lec tronics shall have no liability f or m alfunctions or damages arising out of the
use of Renesas Electronic s products beyond such specified ranges.

7. Although Renesas Electronic s endeav ors to improve the qualit y and r eliability of its product s , semiconductor products have specific charac teristics such as the occurrence of failur e at a certain rate and
malfunctions under cer tain use conditions. Fur ther, Renesas Electr onic s pr oduc ts are not subject t o r adiation resistance design. P leas e be s ur e to implement safety m eas ur es to guard them against the
possibility of physical injury, and injury or damage caused by fire in the event of t he failure of a Renesas Electr onic s pr oduc t, such as safet y des ign for hardware and software inc luding but not limited to
redundancy, fire control and malfunction prevention, appropriate treatment for aging degradation or any other appropriate measures. Because the evaluation of m ic r oc om puter software alone is ver y difficult,
please evaluate the safet y of the final products or s y s tems manufactur ed by y ou.

8. Please contact a Renesas E lec tronics sales offic e for details as to envir onm ental matters such as the environmental compatibility of each Renesas Elect r onic s pr oduc t. Please use Renesas Electronics
products in compliance wit h all applic able laws and r egulations that regulate t he inc lus ion or us e of controlled substances , including without limitat ion, the EU RoHS Directive. Renes as E lec tronics assumes
no liability for damages or los s es oc c ur r ing as a r es ult of your noncompliance with applic able laws and r egulations.

9. Renesas Electronics pr oduc ts and technology may not be us ed for or incorporated into any pr oduc ts or systems whos e m anufacture, use, or s ale is pr ohibited under any applicable domestic or foreign laws or
regulations. You should not us e Renes as E lec tronics products or technology described in this docum ent for any purpose relating to military applications or us e by the military, including but not limited to the
development of weapons of m as s des t ruction. When exporting the Renesas Electronic s pr oduc ts or technology described in this document, you should c om ply with the applicable export cont r ol laws and
regulations and follow the proc edur es r equir ed by s uc h laws and r egulations.

10. It is the responsibility of the buyer or dis tributor of Renesas Elec tronics products, who dis tributes, disposes of, or otherwise places the product with a third par ty, to notify s uc h third party in advance of the
contents and conditions s et forth in this docum ent, Renesas Electronic s as s um es no responsibility for any los s es inc ur r ed by y ou or third parties as a result of unauthorized use of Renesas E lec tronics
products.

11. This document may not be reproduced or duplicated in any f or m , in whole or in part, without pr ior wr itten consent of Renesas E lec tronics.

12. Please contact a Renesas E lec tronics sales offic e if you have any questions regar ding the information contained in this document or Renesas Elec tronics products, or if you have any other inquiries.

(Note 1) " Renes as E lec tronics" as used in this doc um ent means Renesas Electronic s Corporation and also includes its m ajor ity-owned subsidiaries.
(Note 2) " Renes as E lec tronics product(s) " means any product developed or m anufactured by or for Renes as E lec tronics.

http://www.renesas.com

Refer to "http://www.renesas.com/" for the latest and detailed information.

Renesas Electronics America Inc.

2801 Scott Boulevard Santa Clara, CA 95050-2549, U.S.A.
Tel: [phone], Fax: [phone]

Renesas Electronics Canada Limited

9251 Yonge Street, Suite 8309 Richmond Hill, Ontario Canada L4C 9T3
Tel: [phone]

Renesas Electronics Europe Limited

Dukes Meadow, Millboard Road, Bourne End, Buckinghamshire, SL8 5FH, U.K
Tel: [phone], Fax: [phone]

Renesas Electronics Europe GmbH

Arcadiastrasse 10, 40472 Düsseldorf, Germany
Tel: [phone], Fax: [phone]

Renesas Electronics (China) Co., Ltd.

Room 1709, Quantum Plaza, No.27 ZhiChunLu Haidian District, Beijing 100191, P.R.China
Tel: [phone], Fax: [phone]

Renesas Electronics (Shanghai) Co., Ltd.

Unit 301, Tower A, Central Towers, 555 Langao Road, Putuo District, Shanghai, P. R. China 200333
Tel: [phone], Fax: [phone]

Renesas El ectronics Hong Kong Limited

Unit 1601-1611, 16/F., Tower 2, Grand Century Place, 193 Prince Edward Road West, Mongkok, Kowloon, Hong Kong
Tel: [phone], Fax: [phone]

Renesas Electronics Taiwan Co., Ltd.

13F, No. 363, Fu Shing North Road, Taipei 10543, Taiwan
Tel: [phone], Fax: [phone]

Renesas Electronics Singapore Pte. Ltd.

80 Bendemeer Road, Unit #06-02 Hyflux Innovation Centre, Singapore 339949
Tel: [phone], Fax: [phone]

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: [phone], Fax: [phone]

Renesas Electronics India Pvt. Ltd.

No.777C, 100 Feet Road, HALII Stage, Indiranagar, Bangalore, India
Tel: [phone], Fax: [phone]

Renesas Electronics Korea Co., Ltd.

12F., 234 Teheran-ro, Gangnam-Gu, Seoul, 135-080, Korea
Tel: [phone], Fax: [phone]

SALES OFFI C ES

© 2016 Renesas Electronics Corporation. All rights reserved.

Colophon 5.0