USB Peripheral Human Interface Devices Class Driver Using
Contents
1. USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules 2 Software Configuration 2 1 Module Configuration The PHID comprises a HID class driver as well as mouse and keyboard device drivers In response to data transfer requests from the APL it transfers data to the USB host via the PCD Figure 2 1 shows the module configuration of the PHID and Table 2 1 lists the functions of the modules RSK driver ico aaa Cane LCD LED KEY H W User application APL USB Peripheral Control Driver PCD USB Peripheral controller H W Figure 2 1 Module Configuration Table 2 1 Function of Moudles Module Name Function APL Sample application program RSK driver Sample application for using the peripheral functions on the RSK board PHID r_usb_phidi Interprets requests from the HID host Reports APL key operation information to the HID host via the PCD PCD r_usb_basic USB Peripheral Hardware Control Driver RO1AN2664EJ011 1 Sep 30 2015 Rev 1 11 RENESAS Page 7 of 20 Ren esas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules 3 Sample Application 3 1 Application Specifications The main functionalities of the PHID sample application APL are described below 1 Keyboard Mode Keyboard Functionality When the RSK co2. Rev 1 11 Page 5 of 20 Sep 30 2015 RENESAS Renesas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules 2 Import the project to the workspace a Select File gt Import b Select General gt Rename amp Import Existing C C Project into Workspace Select y Rename and Import and Existing C C Project into the workspace 145 Select an import source type filter text 4 2 General Archive File la Convert CCRX to GNURX Project tae DS 5 KPIT GNUARM RZ NONE Project Existing Projects into Workspace G File System HEW Project E Preferences 1 Rename amp Import Existing C C Project into Workspace la Renesas Common Project File gt E gt C C Select the root directory of the project that is the folder containing the cproject file Rename amp Import Project Specify a new project name dl Project name osama SSS Select archive file v Browse Projects c Click Finish You have now imported the project into the workspace Note that you can import other projects into the same workspace 3 Generate the binary target program by clicking the Build button 4 Connect the target board to the debug tool and download the executable The target is run by clicking the Run button RO1AN2664EJ0111 Rev 1 11 Page 6 of 20 Sep 30 2015 RENESAS Renesas USB MCU
3. 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 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 should not alter modify copy or otherwise misappropriate any Renesas Electronics product whether in whole or in part Renesas Electronics assumes no responsibility for any losses incurred by you or third parties arising from such alteration modification copy or otherwise misappropriation of Renesas Electronics product 5 Renesas Electronics products are classified according to the following two quality grades Standard and High Quality The recommended 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 and industrial robots etc High Quality Transportation equipment automobiles trains ships etc traffic control systems anti disaster systems anti crime systems and safety equipment etc Renesas Electronics products are neither intended nor authorized for use in products or systems that may pose a direct threat to human life or bodily inju
4. exporting the Renesas Electronics products or technology described in this document you should comply with the applicable export control laws and regulations and follow the procedures required by such laws and regulations 10 It is the responsibility of the buyer or distributor of Renesas Electronics products who distributes disposes of or otherwise places the product with a third party to notify such third party in advance of the contents and conditions set forth in this document Renesas Electronics assumes no responsibility for any losses incurred by you or third parties as a result of unauthorized use of Renesas Electronics products 11 This document may not be 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 or if you have any other inquiries Note 1 Renesas Electronics as used in this document means Renesas Electronics Corporation and also includes its majority owned subsidiaries Note 2 Renesas Electronics product s means any product developed or manufactured by or for Renesas Electronics ENESAS SALES OFFICES Renesas Electronics Corporation http www renesas com Refer to http www renesas com for the latest and detailed information Renesas Electronics America Inc 2801 Scot
5. mode enable USB communication with PCs USB hosts supporting OSes such as Windows 7 Windows 8 Windows 8 1 and Windows 10 RO1AN2664EJO111 Rev 1 11 Page 8 of 20 Sep 30 2015 RENESAS Ren esas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules 3 2 Overview of Application Processing The APL consists of two parts processing of initial settings and the main loop These are described in outline below 3 2 1 Initial setting The initial settings include microcontroller pin settings USB driver settings and USB controller initial settings 3 2 2 Main loop Mouse mode In Mouse mode the main loop performs the following processing a When enumeration with the USB host finishes the USB driver calls the function hid_open which is specified by member devconfig of structure USB_PCDREG_t The function hid_open sets EVENT_CONFIGURED as the event value b The processing of EVENT_USB_WRITE_START calls the function R_usb_phid_send_data to request transmission of mouse data by the USB driver When transmission of the mouse data finishes the callback function hid_write_trans_cb specified by the 4th argument of the function R_usb_phid_send_data is called This callback function sets EVENT_USB_WRITE_COMPLETE as the event value c The processing of EVENT USB WRITE COMPLETE sets the transmission status variable to not transmitting d The processing of EVENT_SUSPEND calls the functi
6. of the data finishes the callback function hid_read_trans_cb specified by the 4th argument of the function R_usb_phid_receive_data is called This callback function sets EVENT_USB_READ_ COMPLETE as the event value The processing of EVENT_USB_READ_COMPLETE calls the function R_usb_phid_send_data to transmit to the USB host the data received in b above When reception of the data finishes the callback function hid_write_trans_cb specified by the 4th argument of the function R_usb_phid_send_data is called This callback function sets EVENT_USB_WRITE_COMPLETE as the event value The processing of EVENT_USB_WRITE_COMPLETE sets EVENT_USB_READ_START as the event value If the USB host transmits a suspend signal to the HID device RSK while steps b to d above are being processed repeatedly the USB driver calls the function hid_suspend specified by member devsuspend in structure USB_PCDREG _t The function hid_suspend sets EVENT_SUSPEND as the event value The processing of EVENT_SUSPEND calls the function hid_low_power_control to transition the HID device RSK to the low power mode sleep mode Note that if the HID device RSK is in the suspend state it is woken from the suspend state when a resume signal transmitted by the USB host is detected If the HID device RSK is detached from the USB host while steps b to d above are being processed repeatedly the USB driver calls the function hid_close specified by member devdetach in stru
7. program does not recognize a switch press as having occurred when the switch is only pressed down The combination of a switch press and release is recognized as a switch press 1 Mouse mode Switch Number Operation Switch1 SW1 Left click Switch2 SW2 Reports motion data for mouse up down direction Switch3 SW3 Reports motion data for mouse right left direction 2 Keyboard mode Switch Number Operation Switch2 SW2 One of the key codes for characters a to z or Enter is reported to the host each time SW is pressed Switch3 SW3 One of the key codes for 1 to 9 and 0 or Enter is notified to the host each time SW is pressed Note1 Movement data is generated when a switch is pressed and held and the data is reported to the host Data reporting stops when the switch is released Pressing the switch again switches the movement direction and movement data reporting continues Note2 When switches 2 and 3 are both unpressed in keyboard mode NULL data is transferred to the USB host and in mouse mode no data is transferred to the USB host RO1AN2664EJ0111 Rev 1 11 Page 16 of 20 Sep 30 2015 RENESAS Renesas USB MCU 3 3 2 Data Format USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules The table below shows the transmit report format used for sending data to and from USB Host These da
8. renesas com Inquiries http www renesas com inquiry All trademarks and registered trademarks are the property of their respective owners RO1AN2664EJ0111 Rev 1 11 Page 20 of 20 Sep 30 2015 RENESAS Revision Record Rev Date Description Page Summary 1 11 Sep 30 2015 First Edition Issued General Precautions in the Handling of MPU MCU Products The following usage notes are applicable to all MPU MCU products from Renesas For detailed usage notes on the products covered by this document refer to the relevant sections of the document as well as any technical updates that have been issued for the products 1 Handling of Unused Pins Handle unused pins in accordance with the directions given under Handling of Unused Pins in the manual The input pins of CMOS products are generally in the high impedance state In operation with an unused pin in the open circuit state extra electromagnetic noise is induced in the vicinity of LSI an associated shoot through current flows internally and malfunctions occur due to the false recognition of the pin state as an input signal become possible Unused pins should be handled as described under Handling of Unused Pins in the manual 2 Processing at Power on The state of the product is undefined at the moment when power is supplied The states of internal circuits in the LSI are indeterminate and the states of register setti
9. EG _t The function hid_suspend sets EVENT_SUSPEND as the event value h The processing of EVENT_SUSPEND calls the function hid_low_power_control to transition the HID device RSK to the low power mode sleep mode Note that if the HID device RSK is in the suspend state it is woken from the suspend state when a resume signal transmitted by the USB host is detected i If the HID device RSK is detached from the USB host while steps b to f above are being processed repeatedly the USB driver calls the function hid_close specified by member devdetach in structure USB_PCDREG_t The function hid_close sets EVENT_DETACH as the event value j The processing of EVENT_DETACH calls the function R_usb_phid_TransferEnd to transition the HID device RSK to the low power mode software standby mode after the data receive request ends If the HID device RSK is attached to the USB host again enumeration starts with the USB host and the processing resumes from step a above An outline of the processing of the APL is shown below RO1AN2664EJ0111 Rev 1 11 Page 11 of 20 Sep 30 2015 RENESAS Renesas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules PHID APL usb_main Initialization Getting the event hid_event_get VENT_CONFIGURED ENT_USB_READ_STAR VENT_USB_READ_COMPLETE EVENT_USB_WRITE_START Switch checking processing USB device s
10. 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 HALII Stage Indiranagar Bangalore India Tel 91 80 67208700 Fax 91 80 67208777 Renesas Electronics Korea Co Ltd 12F 234 Teheran ro Gangnam Gu Seoul 135 080 Korea Tel 82 2 558 3737 Fax 82 2 558 5141 2015 Renesas Electronics Corporation All rights reserved Colophon 5 0
11. RENESAS APPLICATION NOTE R01AN2664EJ0111 Renesas USB MCU Rev 1 11 Sep 30 2015 USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules Introduction This document describes the following sample firmware USB Peripheral Human Interface Devices Class Driver for using Firmware Integration Technology The sample firmware is referred to below as the PHID During actual software development make sure to refer to the USB Peripheral Human Interface Devices Class Driver f using Firmware Integration Technology application note document No R01AN2663EJ in combination with the USB Basic Host and Peripheral Driver using Firmware Integration Technology application note document No RO1AN2025EJ and the user s manual hardware of the microcontroller used Target Device RX63N RX631 Group RX64M Group RX71M Group The operation of this program has been confirmed using the Renesas Starter Kit RSK Contents TL INTOUCI ON cc cita A A A 2 2 Software Configuration sssi cionado tica 7 3 Sample Application 0 c42 c 2cd caian ad ia 8 4 Class Request E a ee eee 18 5 Using the e studio project With CS ccccccccsescssscssesssssesesssseeesessessesnssecaneeesscsesneseneesanees 19 RO1AN2664EJ0111 Rev 1 11 Page 1 of 20 Sep 30 2015 RENESAS Ren esas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules 1 Introduct
12. S Set Idle Ox0A Receives a duration time from the USB Host YES Get Protocol 0x03 Sends a protocol to the USB Host NO Set Protocol 0x0B Receives a protocol from the USB Host NO Get Report Descriptor Standard Sends a report descriptor to the USB Host YES Get HID Descriptor Standard Sends an HID descriptor to the USB Host YES RO1AN2664EJ0111 Rev 1 11 Page 18 of 20 Sep 30 2015 RENESAS Ren esas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules 5 Using the e studio project with CS The PHID contains a project only for e studio When you use the PHID with CS import the project to CS by following procedures CubeSuite Start File Edit View Project Build Debug Tool Window Help Loads the project of CubeSuite Can also be opened directly from the following link Recent Project Favorte Project GO Go Nothing Nothing Open Existing e2studio CubeSuite High performance Embedded Workshop PM Project The project created with e2studio and the old IDE can be converted to the CubeSuite project Support version A G ji n 1 Build optionem gt i vue l version e T Search Sample_mxe p Launch CS and click Start 1 0 Select Open Exsisting e2studio CS High performance Embedded Workshop PM project in Start menu Arrange by Folder y Date modified Type setings 6 30 2013 1 2 3 Libraries HardwareDebug 1 29 PM Do
13. are met Table 3 3 Conditions for Transition to Low Power Mode Transition Condition Transition Status VBUS USB State OFF Software standby mode ON Suspend Configured Sleep mode ON Other than Suspend Configured Normal mode program running a When the device is detached VBUSOFF the APL transtions the MCU to software standby mode Note that recovery from software standby mode occurs when the RSK boardattaches to the USB host causing a transition to normal mode b When the HID device is suspended the APL transitions the MCU to sleep mode Note that recovery from sleep mode occurs when a Resume signal is transmitted by the USB host causing a transition to normal mode RO1AN2664EJ0111 Rev 1 11 Sep 30 2015 Page 15 of 20 RENESAS Ren esas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules MCU Low power consumption processing hid_low_power_control Acquisition USB device information USB device information Change MCU to the software standby mode USB suspend VBUS OFF 88 USB suspend Change MCU to Sleep mode Figure 3 4 Flowchart of MCU Low Power Consumption Processsing 3 3 Switch 3 3 1 Switch specification The specifications of the switches used in mouse mode and keyboard mode are listed below The switches on the RSK are not used in echo mode Note that the application
14. cture USB_PCDREG_t The function hid_close sets EVENT_DETACH as the event value The processing of EVENT_DETACH calls the function R_usb_phid_TransferEnd to transition the HID device RSK to the low power mode software standby mode after the data transfer receive request ends If the HID device RSK is attached to the USB host again enumeration starts with the USB host and the processing resumes from step a above An outline of the processing of the APL is shown below RO1AN2664EJO111 Rev 1 11 Page 13 of 20 Sep 30 2015 RENESAS Renesas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules PHID APL usb_main Initialization Getting Event hid_event_get VENT_CONFIGURED VENT_USB_READ_START2 Data Receiving Request R_usb_phid_receive_data Setting EVENT_USB WRITE_START hid_event_set Data Sending Request R_usb_phid_send_data Setting EVENT_USB_READ_START hid_event_set Low power consumption processng hid_low_power_control Data transfer stop processing R_usb_pstd_TransferEnd VENT_USB_READ_COMPLETE EVENT_USB_WRITE_START VENT_USB_WRITE_COMPLETE Low power consumption processing hid_low_power_control RO1AN2664EJ0111 Sep 30 2015 Figure 3 3 Main Loop Processing Echo mode Rev 1 11 RENESAS Page 14 of 20 Renesas USB MCU USB Peripheral Human Interface Devices Clas
15. cuments de Release 1 29 PM a Music 6 M E Pictures Select the file with the extension rcpe and click Open button Project File for e2studio rcpc v 7 Descrintion You can convert your project for the CubeSuite Select the project s from the left list box and change the settings to conversion as necessary Select A OS Select the device used in When you press the OK button without changing any settings the new project i j place as the selected projects and the old projects are backuped in _org ai y the proj ect Select the used project Project setings New microcontroller e g Sample Meca New microcontroller The project name depends on the AN EEE Cay 5 RX111 2 Product Name R5F51111AxFK IRSFS1111AxFK G4pin DN ip RAM size Bytes pia Addtional Information Package PLOPODS4GA A NE R5F51111AxLF 64pin a RSFS1111AxLM 26pin AN R5F51111AxNE 48pin ME R5F511134xFK 64pin Select Project type and specify the project name and its location Krd of project Emp Application CCR Click OK button if they are OK Projectname SE C Usersib1500049 Documentsie2studioiworksp Figure 5 1 Using the e studio project with CS R01AN2664EJ0111 Rev 1 11 Page 19 of 20 Sep 30 2015 RENESAS Renesas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules Website and Support Renesas Electronics Website http www
16. esas Starter Kit for RX63N RSK RX63N Product No ROK50563NC000 RX63N Group Renesas Microcontroller Development Starter Kit from Renesas Electronics Renesas Starter Kit for RX64M RSK RX64M Product No ROK50564MC010BR RX64M Group Renesas Microcontroller Development Starter Kit from Renesas Electronics Renesas Starter Kit for RX71M RSK RX71M Product No ROKSRX71MCO10BR RX71M Group Renesas Microcontroller Development Starter Kit from Renesas Electronics 2 Development Environment a estudio integrated development environment from Renesas Electronics b RX Family C C compiler package version 2 03 00 from Renesas Electronics c El or E20 emulator from Renesas Electronics 3 Other a HID Host PC Microsoft Windowse 7 Windowse 8 Windowse 8 1 or Windowse 10 b Host PC for emulator Microsoft Windows 7 Windowse 8 or Windowse 8 1 c USB cable d User cable packaged with El or E20 emulator e Emulator cable packaged with E1 or E20 emulator RO1AN2664EJ0111 Rev 1 11 Page 3 of 20 Sep 30 2015 RENESAS Ren esas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules 1 4 Setup 1 4 1 Hardware Figure 1 1 shows an example operating environment for the PHID Refer to the associated instruction manuals for details on setting up the evaluation board and using the emulator etc Peripheral Human Interface Device Class Driver PHID USB Basic Peripheral Dr
17. ion 1 1 Functions The PHID conforms to the USB human interface device HID class specification and implements communication with HID devices The PHID provides the following functionalities 1 Operation as a Full Speed 12 Mbps device 2 Itis recognized as an HID device when connected to a USB host and transfers data as a virtual mouse or virtual keyboard 1 2 FIT Module Configuration The PHID comprises the following FIT modules and a sample application Table 1 1 FIT Module Configuration FIT Module Folder Name Version Board Support Package Module Fbs 2 81 Using Firmware Integration Technology dd Renesas USB MCU USB Basic Host and Peripheral firmware r_usb_basic 1 11 Firmware Integration Technology Renesas USB MCU USB Peripheral Human Interface Devices Class F usb bhid 1 11 Driver HID Firmware Integration Technology SDA i Refer to the related documentation for details of each FIT module Note that the latest versions of the FIT modules used by the sample firmware are available for download from the following website Renesas Electronics website http www renesas com RO1AN2664EJO111 Rev 1 11 Page 2 of 20 Sep 30 2015 RENESAS Ren esas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules 1 3 Operating Confirmation Environment The environment required for the PHID to operate is described below 1 Evaluation Board Ren
18. iver USB Cable Enumeration Control Transfer USB Interrupt IN data transfer USB Evaluation PORT PORT Interrupt OUT data transfer Board USB Host PC OS Windows 7 Windows 8 Windows 8 1 Windows 10 etc Figure 1 1 Example Operating Environment Table 1 2 shows the evaluation board on which operation has been confirmed Table 1 2 Evaluation Board on which PHID operation has been verified MCU Evaluation Board RX63N RSK RX63N RX64M RSK RX64M RX71M RSK RX71M RO1AN2664EJ0111 Rev 1 11 Page 4 of 20 Sep 30 2015 RENESAS Renesas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules 1 4 2 Software 1 Setup e studio a Start e studio b Ifyou start up e studio at first the following dialog is displayed Specify the folder to store the project in this dialog r Select a workspace e2 studio stores your projects in a folder called a workspace Choose a workspace folder to use for this session Wise Use this as the default and do not ask again c Click Workbench icon Welcome to e2studio Cc Overview FA Renesas Tutorials Get an overview of the features Go through Renesas Tutorials Renesas Samples What s New Find out what is new e Try out the Renesas Samples First Steps Workbench p Ay Take your first steps Q Go to the e2 studio workbench R01AN2664EJ0111
19. lback function hid_write_trans_cb specified by the 4th argument of the function R_usb_phid_send_data is called This callback function sets EVENT_USB_WRITE_COMPLETE as the event value e The processing of EVENT_USB_WRITE_COMPLETE i When transmission of the key input data is finished it is necessary to transmit data consisting of 8 bytes of zeroes to the USB host to notify it of key release Processing is performed to set the necessary zero data and the transmission status variable is set to zero data transmission Also EVENT_USB_WRITE_START is set as the event value ii When transmission of the zero data is finished the transmission status variable is set to not transmitting f The processing of EVENT_NONE determines whether or not key input has occurred If the HID device is in the suspend state and SW1 is pressed and then released a Remote WakeUp signal is sent to the USB host by means of the R_usb_phid_ChangeDeviceState function If a key other than SW1 is pressed processing to set the key data takes place and the transmission status variable is set to transmitting key data Also EVENT_USB_WRITE_START is set as the event value in order to transmit the specified key data to the USB host g If the USB host transmits a suspend signal to the HID device RSK while steps b to f above are being processed repeatedly the USB driver calls the function hid_suspend specified by member devsuspend in structure USB_PCDR
20. ngs and pins are undefined at the moment when power is supplied In a finished product where the reset signal is applied to the external reset pin the states of pins are not guaranteed from the moment when power is supplied until the reset process is completed In a similar way the states of pins in a product that is reset by an on chip power on reset function are not guaranteed from the moment when power is supplied until the power reaches the level at which resetting has been specified 3 Prohibition of Access to Reserved Addresses Access to reserved addresses is prohibited The reserved addresses are provided for the possible future expansion of functions Do not access these addresses the correct operation of LSI is not guaranteed if they are accessed 4 Clock Signals After applying a reset only release the reset line after the operating clock signal has become stable When switching the clock signal during program execution wait until the target clock signal has stabilized When the clock signal is generated with an external resonator or from an external oscillator during a reset ensure that the reset line is only released after full stabilization of the clock signal Moreover when switching to a clock signal produced with an external resonator or by an external oscillator while program execution is in progress wait until the target clock signal is stable 5 Differences between Products Before changing from one produc
21. nnects to the USB host the USB host recognizes the RSK as a keyboard The RSK operates as a keyboard transmitting keyboard data to the USB host using interrupt IN transfer 2 Mouse Mode Mouse Functionality When the RSK connects to the USB host the USB host recognizes the RSK as a mouse The RSK operates as a mouse transmitting mouse data to the USB host using interrupt IN transfer 3 Echo Mode USB Loopback Functionality Interrupt IN OUT Data Transfer The RSK connects to the USB host and performs interrupt IN OUT data transfer This functionality performs processing to transmit the data received from the USB host back to the USB host unaltered 4 Low Power Consumption Functionality This functionality transitions the microcontroller to a low power mode according to the USB state To enable this functionality set the macro definition USB_CPU_LPW_PP to USB_LPWR_USE_PP in the file r_usb_basic_config h a Inthe USB suspend state the microcontroller transitions to sleep mode b In the USB detached state the microcontroller transitions to software standby mode Note 1 Make the selection of keyboard mode mouse mode or other mode in r_usb_phid_config h For details see the application note USB Peripheral Human Interface Device Class Driver for USB Firmware Firmware Integration Technology document No RO1AN2663E J 2 Echo mode enables communication with USB hosts supporting USB loopback functionality Keyboard mode and mouse
22. on hid_low_power_control to transition the HID device RSK to the low power mode sleep mode Note that if the HID device RSK is in the suspend state it is woken from the suspend state when a resume signal transmitted by the USB host is detected e The processing of EVENT_NONE captures key input information When SW1 is pressed i Ifthe HID device is in the suspend state a RemoteWakeUp signal is sent to the USB host by means of the R_usb_phid_ChangeDeviceState function ii Ifthe HID device is in the configured state processing to set the key data mouse data is performed and the event value is set to EVENT_USB_WRITE_START in order to transmit the specified data to the USB host The transmission status variable is set to transmitting f Ifthe USB host transmits a suspend signal to the HID device RSK while steps b to e above are being processed repeatedly the USB driver calls the function hid_suspend specified by member devsuspend in structure USB_PCDREG _t The function hid_suspend sets EVENT_SUSPEND as the event value g The processing of EVENT_SUSPEND calls the function hid_low_power_control to transition the HID device RSK to the low power mode sleep mode Note that if the HID device RSK is in the suspend state it is woken from the suspend state when a resume signal transmitted by the USB host is detected h Ifthe HID device RSK is detached from the USB host while steps b to e above are being processed repeatedl
23. ry artificial life support devices or systems surgical implantations etc or may cause serious property damages nuclear reactor control systems military equipment etc You must check the quality grade of each Renesas Electronics product before using it in a particular application You may not use any Renesas Electronics product for any application for which it is not intended Renesas Electronics shall not be in any way liable for any damages or losses incurred by you or third parties arising from the use of any Renesas Electronics product for which the product is not intended by Renesas Electronics 6 You should use the Renesas Electronics products described in this document within the range specified by Renesas Electronics especially with respect to the maximum rating operating supply voltage range movement power voltage range heat radiation characteristics installation and other product characteristics Renesas Electronics shall have no liability for malfunctions or damages arising out of the use of Renesas Electronics products beyond such specified ranges 7 Although Renesas Electronics endeavors to improve the quality and reliability of its products semiconductor products have specific characteristics such as the occurrence of failure at a certain rate and malfunctions under certain use conditions Further Renesas Electronics products are not subject to radiation resistance design Please be sure to implement safety measures to guard them again
24. s Driver Using Firmware Integration Technology Modules Table 3 1 Event List Event Description EVENT_CONFIGURD USB device connecting competion EVENT_USB_READ_START Data reception request EVENT_USB_READ_COMPLETE Data reception completion EVENT_USB_WRITE_START Data transmission request EVENT_USB_WRITE_COMPLETE Data transmission completion EVENT_SUSPEND Suspend EVENT_DETACH USB detach EVENT_NONE No event Note 1 Ifthe processing to get the event determines that the event to be fetched is not present the event is set to EVENT_NONE 2 The following events are set by the callback function The following shows the callback functions set each event Table 3 2 Event and Callback Function Event Callback Function EVENT_CONFIGURD hid_open EVENT_USB_READ_COMPLETE EVENT_USB_WRITE_COMPLETE hid_read_trans_cb hid_write_trans_cb EVENT_SUSPEND hid_suspend EVENT_DETACH hid_close 3 2 5 Event Management Members event_cnt event of the following structure are used to manage states and events This structure is prepared by the APL typedef struct DEV_INFO Structure for HID device control uint16_t event_cnt Event count uint16_t event EVENT_MAX Event DEV_INFO_t 3 2 6 MCU Low power consumption processing MCU low power consumption processing transitions the MCU to low power mode when the following conditions
25. st the possibility of physical injury and injury or damage caused by fire in the event of the failure of a Renesas Electronics product 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 please evaluate 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 Please use Renesas Electronics products in compliance with all applicable laws and regulations that regulate the inclusion or use of controlled substances including without limitation the EU RoHS Directive Renesas Electronics assumes no liability for damages or losses occurring as a result of your noncompliance with applicable laws and regulations 9 Renesas Electronics products and technology may 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 should not use Renesas Electronics products or technology described in this document for any purpose relating to military applications or use by the military including but not limited to the development of weapons of mass destruction When
26. t Boulevard Santa Clara CA 95050 2549 U S A Tel 1 408 588 6000 Fax 1 408 588 6130 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 585 100 Fax 44 1628 585 900 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 P R China 200333 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 g 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 Jin Persiaran Barat 46050
27. t to another i e to a product with a different part number confirm that the change will not lead to problems The characteristics of an MPU or MCU in the same group but having a different part number may differ in terms of the internal memory capacity layout pattern and other factors which can affect the ranges of electrical characteristics such as characteristic values operating margins immunity to noise and amount of radiated noise When changing to a product with a different part number implement a system evaluation test for the given product 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 of these circuits software and information in the design of your equipment Renesas Electronics assumes no responsibility for any losses incurred by you or third parties arising from the Use of these circuits software or information 2 Renesas Electronics has used reasonable care in preparing the information included in this document but Renesas Electronics does not warrant that such information is error free Renesas Electronics assumes no liability whatsoever for any damages incurred by you resulting from errors in or omissions from the information included herein 3 Renesas Electronics does not assume any liability for infringement of patents
28. ta formats are set in conjunction with the HID report descriptor contents notified to USB Host Table 3 4 Data Formats Used when Notifying the Host offset Mouse Mode Keyboard Mode 3Bytes 8Bytes 0 bO Button 1 Modifier keys b1 Button 2 b2 Reserved 1 X displacement Reserved 2 Y displacement Keycode 1 3 Keycode 2 4 Keycode 3 5 Keycode 4 6 Keycode 5 7 Keycode 6 Table 3 5 Keyboard OUTPUT Report format of set byte Value 0 b0 LED 0 NumLock b1 LED 1 CapsLock b2 LED 2 ScrollLock b3 LED 3 Compose 0 OFF 1 ON 3 4 Descriptor The PHID s descriptor information is contained in r_usb_phid_descriptor c Also please be sure to use your vendor ID RO1AN2664EJ0111 Sep 30 2015 Rev 1 11 RENESAS Page 17 of 20 Ren esas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules _ _ _ _ _ _ _ o co o o _ eee 4 Class Request Table 4 1 shows the class requests supported by PHID Table 4 1 Supported Basic Requests and HID Class Requests Request Code Description Supported Get Report 0x01 Sends a report to the USB Host YES Set Report 0x09 Receives a report from the USB Host YES Get Idle 0x02 Sends a duration time to the USB Host YE
29. tatus Suspend Data receiving request R_usb_phid_receive_data Data receiving processing EVENT_USB_READ_START Setting Data sending request R_usb_phid_send_data Sending Data setting ENT_USB_WRITE_COMPLETE 7 Communication status variable setting EVENT_USB_WRITE_START Setting Low power consumption processing hid_low_power_control Data transfer stop processing R_usb_pstd_TransferEnd Low power consumption processing hid_low_power_control Switch check processing REMOTE_WAKEUP Signal sending HID Data sending Sending data setting in progress Seding status variable setting ending status varia EVENT_USB WRITE_START Setting Figure 3 2 Main Loop Processing Keyboard mode RO1AN2664EJ0111 Sep 30 2015 Rev 1 11 Page 12 of 20 RENESAS Renesas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules 3 2 4 Main loop Echo mode In echo mode the main loop performs the following processing a b c d e 2 h When enumeration with the USB host finishes the USB driver calls the function hid_open which is specified by member devconfig of structure USB_PCDREG_t The function hid_open sets EVENT_CONFIGURED as the event value The processing of EVENT_CONFIGURED calls the function R_usb_phid_receive_data to request reception of data from the USB host When reception
30. tus variable Setting EVENT_USB_WRITE_START erding HID data in progre ending status variable Figure 3 1 Main Loop Processing Mouse mode RO1AN2664EJ0111 Rev 1 11 Sep 30 2015 RENESAS Page 10 of 20 Ren esas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules 3 2 3 Main loop Keyboard mode In keyboard mode the main loop performs the following processing a When enumeration with the USB host finishes the USB driver calls the function hid_open which is specified by member devconfig of structure USB_PCDREG_t The function hid_open sets EVENT_CONFIGURED as the event value b The processing of EVENT_CONFIGURED calls the function R_usb_phid_receive_data to request reception by the USB driver of OUT data transmitted by the USB host When reception of the OUT data finishes the callback function hid_read_trans_cb specified by the 4th argument of the function R_usb_phid_receive_data is called This callback function sets EVENT_USB_READ_ COMPLETE as the event value c The processing of EVENT_USB_READ_COMPLETE performs LED display processing based on the received OUT data etc It also sets EVENT_USB_READ_START as the event value d The processing of EVENT_USB_WRITE_START calls the function R_usb_phid_send_data to request data transfer by the USB driver of the key input data etc to the USB host When transmission of the key input data etc finishes the cal
31. y the USB driver calls the function hid_close specified by member devdetach in structure USB_PCDREG_t The function hid_close sets EVENT_DETACH as the event value i The processing of EVENT_DETACH calls the function R_usb_phid_TransferEnd to transition the HID device RSK to the low power mode software standby mode after the data transfer request ends If the HID device RSK is attached to the USB host again enumeration starts with the USB host and the processing resumes from step a above RO1AN2664EJ0111 Rev 1 11 Page 9 of 20 Sep 30 2015 RENESAS Ren esas USB MCU USB Peripheral Human Interface Devices Class Driver Using Firmware Integration Technology Modules An outline of the processing of the APL is shown below PHID APL usb_main Initialization Getting the event hid_event_get EVENT_USB_WRITE_START Data sending request R_usb_phid_send_data Setting Not sending status to Sending status variable Low power consumption processing hid_low_power_control Data transfer stop processing R_usb_pstd TransferEnd Low power consumption processing hid_low_power_control Switch check processing VENT_USB_WRITE_COMPLETE Switch check processing Getting the key data Getting USB device status R_usb_phid_Devicelnformation REMOTE_WAKEUP signal sending USB device status Suspend Sending the data setting Setting Sending status to Sending sta
Download Pdf Manuals
Related Search