Mouse Report Format, Usage ID Usage Name | Cypress CY4672 manual

Bridge

5.4.3Mouse Report Format

The mouse data is sent over the data endpoint 2 using Report ID 1. The format of the mouse report is shown below:

Figure 5-16. Mouse Report Format

Mouse Endpoint (EP2)

Report ID 1

Unused

Middle Right Left Button Button Button

X

Y

ZWheel

5.4.4Battery Level and Link Quality Reports

The PRoC LP bridge implements a mechanism to report the radio parameters of attached HID devices via the USB control endpoint. The code for this functionality can be found in the user custom code section of the User Module source file usb_1_cls_hid.asm.

The RadioParams HID report is a vendor-defined HID report for communicating several radio parameters of the PRoC LP HID devices.

The HID Report Page is defined as:

Cypress WirelessUSB™ HID RadioParams Report Page (0xFF01–Vendor Defined)

Table 5-3. USB Report Usage IDs

Usage ID	Usage Name
0x00	Undefined
0x01	WirelessUSB keyboard
0x 02	WirelessUSB mouse
0x03-0x1F	RESERVED
0x 20	Battery Level
0x 21	WirelessUSB Channel
0x 22	WirelessUSB PN Code
0x 23	Corrupt Packets
0x 24	Packets Transferred

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

95

[+] Feedback

Image 95

Cypress CY4672 Mouse Report Format, Mouse Endpoint EP2 Report ID Unused, Wheel Battery Level and Link Quality Reports

Contents

CY4672 Reference Design Guide Disclaimer Copyrights Contents 4.1 2.3 Programmable Interval Timer User Module 2.42.1 2.2 9.3 9.19.2 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 Acronyms ConventionsDefinitions 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 Button Bind Mode Idle Mode HID onlyReconnect Mode HID only Enhanced KISSBind Slave Back Channel Data Support Data ModeUnbind 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 Data Byte 0-N This is byte-aligned application data Ping Packet BridgeData Packet/Back Channel Data Packet Bridge and HID Bind and Reconnect Timing Bind Timing Diagram Device Signature Byte TEA Encryption TEA Key Management over WirelessUSBEncryption 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 Flash Security Programmable Interval Timer User ModuleModel SPI Module Common CodeGenerated Library Code Debounce Module Flash Module Timer ModuleRadio Driver Protocol Module Mouse Module Application CodeISR Module Testmode Module Optical Module Wheel Module Buttons ModuleMfgtest 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 Tools Development EnvironmentCode Performance Analysis 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 Build Option ROM Usage RAM Usage Bytes EnCoRe II Device ConfigurationTotal ROM Total RAM 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 Application TimerIsr Keyboard Module Test Module Encrypt Module Keyboardkeepalivetimeout Encryptaes TimercalEncrypttea 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 Serial Protocol MTK Block DiagramManufacturing Test Support, MTK Serial Response Protocol Serial Command ProtocolCommand Command Description 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 RDK Mouse Battery Life CalculationsMode Hrs/day Days Average Icc mA Charge mAh Active mode-Move the mouse in a circle on white Paper Power Considerations USB HID API module Software GuideSoftware Code Modules Method Type Description CHidDevice Class MethodsCHidDeviceClass Methods CHidManagerClass Methods CHidManager Class Methods CCySysTray Methods System Tray ModuleCCySysTray Class 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