PSoC Generated Library Code | Cypress CY4672 specification

Bridge

5.3.3Model

Figure 5-6. Firmware Architecture Model

	Common
	radio driver
	master
PSoC Lib	protocol
PSoC Lib
mstimer	timer
usb_1	flash

Application

main

USB

encrypt

mfgtest

The bridge firmware is partitioned into two logical groups. The Common group is a collection of code modules that provide the underlying support for the application. This group provides services such as, radio protocol, radio driver, USB, timing, flash access, SPI, and interrupts.

The Application group implements the core functionality and features of the RDK wireless bridge. This includes USB HID packet formatting and reporting, encryption, and manufacturing test mode. The code modules for each of these groups are described below in further detail.

All of the following module descriptions have corresponding <module name>.c and <module name>.h source code files. The module API and definitions are exported in the header file while the module implementation and local definitions are contained in the C file.

5.3.4Common Code

The modules consist of the common code logical grouping.

5.3.4.1PSoC Generated Library Code

There are currently only three files generated by PSoC Designer that are modified for the use of the application. A minimal amount of code has been added to these modules in user protected areas that are preserved across code generation.

5.3.4.1.1USB include (USB_1.inc)

This file includes the additional code for the Battery Level and Link Quality software application in USB_1_cls_hid.asm.

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

[+] Feedback

Image 82

Cypress CY4672 manual PSoC Generated Library Code, Modules consist of the common code logical grouping

Contents

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