Cypress CY4672 5.3.3 Model, 5.3.4 Common Code

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

Bridge

5.3.3 Model

Figure 5-6. Firmware Architecture Model

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.4 Common Code

The modules consist of the common code logical grouping.

5.3.4.1 PSoC 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.1 USB 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.

radio driver

master

protocol

timer

flash

main

USB

encrypt

mfgtest

mstimer

usb_1

Common

PSoC Lib

Applicat ion

[+] Feedback

Contents

Main Page Contents 1. Introduction 9 2. WirelessUSB Protocol 2.2 13 3. Mouse 33 4. Keyboard 51 5. Bridge 75 6. Manufacturing Test Support, MTK 101 Page 1. Introduction 1.1 Scope 1.2 Chapter Overviews 1.3 Support 1.4 Conventions 1.4.1 Definitions 1.4.2 Acronyms Table 1-3. Acronyms (continued) Page 2. WirelessUSB Protocol 2.2 2.1 General Overview 2.1.1 Radio Channel Management 2.1.2 Pseudo Noise Codes Host PC or Laptop 2.1.3 Chip Error Correction 2.1.4 Automatic Acknowledgment (AutoACK) 2.1.5 Network ID 2.1.6 Manufacturing ID 2.1.7 Channel Selection Algorithm 2.2 Protocol Modes 2.2.1 Ping Mode (Bridge Only) 2.2.2 Idle Mode (HID only) 2.2.3 Reconnect Mode (HID only) 2.2.4 Button Bind Mode 2.2.5 Enhanced KISSBind CY4672 Reference Design Guide, Document # 001-16968 Revision ** 19 WirelessUSB Protocol 2.2 Figure 2-4. KISSBind Transaction Sequence Master Slave 2.2.6 Unbind 2.2.7 Data Mode 2.2.8 Back Channel Data Support CY4672 Reference Design Guide, Document # 001-16968 Revision ** 21 WirelessUSB Protocol 2.2 Figure 2-5. Back Channel Transaction Sequence 2.2.9 Dynamic Data Rate and Dynamic PA 2.3 Packet Structures 2.3.1 Bind/KISSBind Request Packet (HID) 2.3.2 Bind Response Packet (Bridge) 2.3.3 Connect Request (HID) 2.3.4 Connect Response Packet (Bridge) 2.3.5 Ping Packet (Bridge) 2.3.6 Data Packet/Back Channel Data Packet (Bridge and HID) 2.4 Bind and Reconnect Timing Page 2.5 Signature Byte 2.6 Encryption 2.6.1 TEA Encryption 2.6.1.1 TEA Key Management over WirelessUSB 2.6.2 AES Encryption 2.6.2.1 AES Key Management 2.6.3 Encryption and Power Consumption Trade Off Page 3. Mouse 3.1 Introduction 3.1.1 Design Features 3.2 Hardware Overview 3.2.1 RDK Mouse Assembly Page 3.2.2 Hardware Block Diagram 3.2.3 Schematics 3.2.4 Hardware Considerations 3.3 Firmware Architecture 3.3.1 ROM/RAM Usage 3.3.2 PRoC LP Device Configuration Page 3.3.2.1 Global Configuration 3.3.2.2 SPI Master User Module 3.3.2.3 Programmable Interval Timer User Module 3.3.2.4 Flash Security 3.3.3 Model 3.3.4 Common Code 3.3.4.1 Generated Library Code 3.3.4.2 Debounce Module 3.3.4.3 SPI Module 3.3.4.4 Radio Driver 3.3.4.5 Protocol Module 3.3.4.6 Flash Module 3.3.4.7 Port Module 3.3.4.8 Poll Module 3.3.5 Application Code 3.3.5.1 Mouse Module 3.3.5.2 Optical Module 3.3.5.3 Testmode Module 3.3.5.4 Buttons Module 3.3.5.5 Mfgtest Module 3.3.5.6 Wheel Module 3.3.5.7 Battery Module 3.3.6 Configuration Options 3.3.6.1 MOUSE_REPORT_IN_MS 3.3.6.2 MOUSE_ACTIVE_MS 3.3.6.3 MOUSE_DISCONNECTED_POLL_MS 3.3.6.4 MOUSE_TX_TIMEOUT_MS Page 3.3.6.14 KISS_BIND 3.3.6.15 RSSI_QUALIFY 3.3.6.16 AUTO_CONNECT 3.3.7 Platform and Architecture Portability 3.3.8 Initialization 3.3.9 Wireless Protocol Data Payload 3.3.9.1 Packet Format 1 3.3.9.2 Packet Format 2 3.3.10 Interrupt usage and timing 3.3.11 Code Performance Analysis 3.4 Development Environment 3.4.1 Tools Page 4. Keyboard 4.1 Introduction 4.1.1 Design Features 4.2 Hardware Overview Page Page 4.2.2 Schematic 4.2.3 Keyboard Matrix 4.2.4 Hardware Considerations 4.3 Firmware Architecture 4.3.1 ROM/RAM usage 4.3.2 enCoRe II Device Configuration Page Page V Reset Watchdog Enable 4.3.2.2 SPI Master User Module 4.3.2.3 Programmable Interval Timer User Module 4.3.2.4 Flash Security 4.3.3 Model 4.3.4 Common Code 4.3.4.1 Generated Library Code 4.3.4.2 Radio Driver 4.3.4.3 Protocol Module 4.3.5 Application Code 4.3.5.1 Keyboard Module 4.3.5.2 Mfgtest Module 4.3.5.3 Battery Module 4.3.5.4 Test Module 4.3.5.5 Encrypt Module 4.3.6 Configuration Options 4.3.6.1 KEYBOARD_KEEP_ALIVE_TIMEOUT 4.3.6.2 KEY_DOWN_DELAY_SAMPLE_PERIOD 4.3.6.3 KEYBOARD_DEBOUNCE_COUNT 4.3.6.4 KEYBOARD_MULTIMEDIA_SUPPORT Page 4.3.6.16 MFG_TX_MODES 4.3.6.17 MOUSE_EMULATION_MODE 4.3.6.18 BACK_CHANNEL_SUPPORT 4.3.6.19 MASTER_PROTOCOL 4.3.7 Platform and Architecture Portability 4.3.8 Initialization 4.3.9 Wireless Protocol Data Payload 4.3.9.1 Keyboard Application Report Formats Page Page Page 4.3.10 Ghost Key Detection 4.3.11 Interrupt Usage / Timing 4.3.12 Code Performance Analysis 4.4 Modifying the Keyboard Matrix or Adding New Keys 4.4.1 Modifying the Keyboard Matrix 4.4.2 Adding New Keys 4.5 Development Environment 4.5.1 Tools 4.5.2 Tips and Tricks 4.5.2.1 M8C Sleep 4.5.2.2 Watchdog Timer 4.5.3 Critical Test Points Figure 4-10. RDK Keyboard Test Points 5. Bridge 5.1 Introduction 5.1.1 Design Features 5.2 Hardware Overview Page 5.2.3 Schematics 5.2.4 LED Usage 5.3 Firmware Architecture 5.3.1 ROM/RAM Usage 5.3.2 PRoC LP Device Configuration Page Page Page 5.3.3 Model 5.3.4 Common Code 5.3.4.2 Flash 5.3.4.3 Timer 5.3.4.4 Radio Driver 5.3.5 Application Code 5.3.5.1 Bridge Module 5.3.5.2 USB Module 5.3.5.3 Mfgtest Module 5.3.5.4 Encrypt Module 5.3.6 Configuration Options Page 5.3.7 Platform and Architecture Portability 5.3.8 Initialization 5.3.9 Wireless Protocol Data Payload 5.3.10 Suspend and Remote Wakeup 5.3.11 Interrupt Usage/Timing 5.4 USB Interface 5.4.1 USB Descriptors Page Page Page Page 5.4.2 Keyboard Report Format Page 5.4.3 Mouse Report Format 5.4.4 Battery Level and Link Quality Reports Mouse Endpoint (EP2) Unused Z Wheel 5.4.4.1 Requesting a New Battery Reading 5.4.4.2 Obtaining the RadioParams Report 5.4.5 Example USB Bus Analyzer (CATC) Traces Page Page 5.5 Development and Debug Environment 5.5.1 Tools 5.5.2 Tips and Tricks M8C Sleep Watchdog Timer 6. Manufacturing T est Support, MTK 6.1 Introduction 6.2 MTK Block Diagram 6.3 MTK Serial Protocol Page 6.4 MTK RF Protocol 6.5 MTK DUT Source Code Porting 6.6 Accessing MTK in the DUT Page 7. Regulatory T esting Result s 7.1 Introduction Page 8. Power Considerations 8.1 RDK Keyboard 8.1.1 Usage Model 8.1.2 Current Measurements 8.1.3 Battery Life Calculations 8.2 RDK Mouse 8.2.1 Usage Model 8.2.2 Current Measurements 8.2.3 Battery Life Calculations Page 9. Software Guide 9.1 Introduction 9.2 Software Code Modules 9.2.1 USB HID API module 9.2.1.1 CHidDevice Class Methods Table 9-1. CHidDeviceClass Methods 9.2.1.2 CHidManager Class Methods Table 9-2. CHidManagerClass Methods 9.2.2 System Tray Module 9.2.2.1 CCySysTray Class Methods Table 9-3. CCySysTray Methods 9.2.3 WirelessUSB System Tray Application Module 9.2.3.1 CWirelessUSBTrayApp Class Methods 9.2.3.2 CMainFrame Class Methods 9.2.3.3 CWirelessUSBStatusPropertyPage Class Methods 9.2.3.4 CWirelessUSBStatusPropertySheet Class Methods 9.2.3.5 CHidTrayDevice Class Methods 9.2.3.6 CHidTrayManager Class Methods 9.3 Development Environment Appendix A. References Page Index Numerics A B C H I K L M R S T U W Page CY4672 Reference Design Guide, Document # 001-16968 Revision ** 125 Revision History Document Revision History