Software Guide, Software Code Modules | Cypress CY4672 instruction

9.Software Guide

9.1Introduction

This section describes the software source code modules used in order to communicate with the PRoC™ LP bridge HID device to obtain the current radio parameters for the attached Wire- lessUSB™ LP devices. It does not cover the details of the Microsoft Foundation Class (MFC) Library or the HID Library that contains standard system-supplied routines that user-mode applications use to communicate with USB devices that comply with the USB HID Standard. Refer to the Microsoft Visual C++ documentation for more on MFC and HID Class concepts, in addition to the Device Class Definition for Human Interface Devices (HID) defined by the USB Implementers Forum, Inc.

(http://www.usb.org/developers/hidpage).

9.2Software Code Modules

There are three main modules contained in the WirelessUSB Software:

■USB HID API module–generic class interface to HID Class compliant devices

■System Tray module–generic class to create and control an icon on the system tray

■WirelessUSB System Tray Application module–main system tray application module

The following sections describe the software module contents.

9.2.1USB HID API module

The USB HID API module defines two classes, CHidDevice and CHidManager. The CHidDevice class is the primary interface to a HID device, while the CHidManager class keeps track of the arrival and removal of HID devices, along with notification to the application of such events. The building blocks for the USB HID API module was derived from the HCLIENT sample code provided in the Windows DDK. This module was designed to provide a generic interface to any HID Class compliant device and is not expected to require any modification, however all source code is provided for refer- ence.

CY4672 Reference Design Guide, Document # 001-16968 Revision **

111

[+] Feedback

Image 111

Cypress CY4672 manual Software Guide, Software Code Modules, USB HID API module

Contents

CY4672 Reference Design Guide Disclaimer Copyrights Contents 4.1 2.3 Programmable Interval Timer User Module 2.42.1 2.2 9.1 9.29.3 6.18 2.4 1 Millisecond Interval Timer User Module 2.56.16 6.17 100 1.11.2 1.3 109 105107 108 Support IntroductionScope Chapter Overviews Conventions DefinitionsAcronyms Rssi Introduction Pseudo Noise Codes WirelessUSB ProtocolGeneral Overview Radio Channel Management Manufacturing ID Chip Error CorrectionAutomatic Acknowledgment AutoACK Network ID Channel Selection Algorithm Protocol Modes KISSBind Mode Ping Mode Bridge OnlyIdle Mode Bind Mode Reconnect Idle Mode HID only Reconnect Mode HID onlyButton Bind Mode Enhanced KISSBind Slave Data Mode UnbindBack Channel Data Support Back Channel Transaction Sequence Dynamic Data Rate Dynamic Data Rate and Dynamic PA Bind/KISSBind Request Packet HID Packet Structures Device Type Bind Response Packet BridgeConnect Request HID Connect Response Packet Bridge Ping Packet Bridge Data Packet/Back Channel Data Packet Bridge and HIDData Byte 0-N This is byte-aligned application data Bind and Reconnect Timing Bind Timing Diagram Device Signature Byte TEA Key Management over WirelessUSB EncryptionTEA Encryption TEA Encryption Key Management AES Encryption AES Key Management Encryption and Power Consumption Trade Off WirelessUSB Protocol Introduction Design FeaturesRDK Mouse Assembly Mouse Bottom View Bind Button and On-Off Switch Schematics Hardware Block Diagram 1 ROM/RAM Usage PRoC LP Device ConfigurationFirmware Architecture Hardware Considerations CYRF69103 Device Architecture SPI Master User Module Global Configuration Programmable Interval Timer User Module ModelFlash Security SPI Module Common CodeGenerated Library Code Debounce Module Flash Module Timer ModuleRadio Driver Protocol Module Application Code ISR ModuleMouse Module Testmode Module Optical Module Buttons Module Mfgtest ModuleWheel Module Battery Module Configuration Options Mfgtxmodes PlatformhMOUSE800NOT400CPI Mfgtestcode Kissbind Wireless Protocol Data PayloadPlatform and Architecture Portability Initialization Byte Interrupt usage and timingPacket Format 9.2 Packet Format Development Environment Code Performance AnalysisTools 2.1 M8C Sleep Watchdog TimerTips and Tricks Critical Test Points Keyboard Keyboard Plastic RDK Keyboard Assembly Radio and PSoC Board PDC-9265 Bind Button Schematic Row Keyboard Matrix EnCoRe II Device Configuration Total ROM Total RAM BytesBuild Option ROM Usage RAM Usage Bytes Microcontroller Device Architecture This parameter is set to ‘1’ This parameter is set to EnableThis parameter is set to Disable This parameter is set to Tcap Reset Timer IsrApplication Keyboard Module Test Module Encrypt Module Keyboardkeepalivetimeout Timercal EncryptteaEncryptaes Mouseemulationmode Keyboard Application Report Formats Modifier Reserved Scan Code Keys 0x00 Byte Name0xFC Modifier Reserved Scan Code Keys 0x00 0x04 Application Report Power Key Scan Interrupt Usage / Timing Ghost Key Detection Code Performance Analysis Build the firmware, the new key ‘My Computer’ will work Modifying the Keyboard Matrix or Adding New KeysModifying the Keyboard Matrix Adding New Keys RDK Keyboard with POD Installed 10. RDK Keyboard Test Points Bridge In-System Programming Bridge Photographs RDK Bridge with USB Adapter and PSoC MiniProg Schematics LED Usage Build Option ROM Usage Bytes RAM Usage Bytes Total ROM Bytes Total RAM Bytes CYRF69213 Device Architecture This parameter is set to 4.44 4.53 This parameter is set to 1Hz USB Device User Module 2.4 1 Millisecond Interval Timer User Module Modules consist of the common code logical grouping PSoC Generated Library Code Bridge Module TimerFlash Master Protocol USB Module Mfgtestcode Dalenable Powerbind Parameter Icc Units Suspend and Remote WakeupInterrupt Usage/Timing Polling method is used for the Bind button USB Descriptors USB Interface Keyboard HID Report Descriptor Device/Config Descriptors Keyboard HID Report Descriptor Endpoint Mouse/Keyboard HID Report Descriptor Bridge Keyboard power keys use Report ID Keyboard Report Format Reserved Standard Key Keyboard Endpoint EP1 Usage ID Usage Name Wheel Battery Level and Link Quality ReportsMouse Report Format Mouse Endpoint EP2 Report ID Unused Obtaining the RadioParams Report Requesting a New Battery Reading 17. Example keyboard Catc Trace Standard and MM Keys Example USB Bus Analyzer Catc Traces 18. Example Mouse Catc Trace Key Up 19. Example Keyboard Catc Trace Power Key Few of ways for working with the kit are the following Development and Debug Environment MTK Block Diagram Manufacturing Test Support, MTKMTK Serial Protocol Serial Command Protocol Command Command DescriptionSerial Response Protocol MTK DUT Source Code Porting Accessing MTK in the DUTSerial Port Parameter Settings MTK RF Protocol Manufacturing Test Support, MTK Test Parameter FCC Limit Measured Value Margin Regulatory Testing Results Regulatory Testing Results Usage Model Power ConsiderationsOperation Mode Icc mA with Average Icc Supply Voltage = RDK Keyboard Battery Life Calculations Mode Hrs/day Days Average Icc mA Charge mAhRDK Mouse Active mode-Move the mouse in a circle on white Paper Power Considerations Software Guide Software Code ModulesUSB HID API module CHidDevice Class Methods CHidDeviceClass MethodsMethod Type Description CHidManagerClass Methods CHidManager Class Methods System Tray Module CCySysTray Class MethodsCCySysTray Methods CWirelessUSBTrayApp Class Methods WirelessUSB System Tray Application Module CMainFrame Class Methods OnStopTimer Public This method stops the timer OnTimer CWirelessUSBStatusPropertySheet Class Methods CWirelessUSBStatusPropertyPage Class Methods CHidTrayManager Class Methods CHidTrayDevice Class Methods Appendix A. References + Feedback Numerics Index LED Pseudo noise codes 13, 14 PSoC Designer generated files Index Revision History + Feedback