├── .gitignore
├── src
    └── CH552duinoKeyboardCore
    │   ├── KeyboardCore.h
    │   ├── via.h
    │   ├── USBconstant.h
    │   ├── USBHIDKeyboardMouse.h
    │   ├── USBhandler.h
    │   ├── KeyboardCore.c
    │   ├── via.c
    │   ├── USBHIDKeyboardMouse.c
    │   ├── USBconstant.c
    │   └── USBhandler.c
├── KeyboardConfig.h.sample
├── README.md
├── CH552duinoKeyboard.ino
└── LICENSE


/.gitignore:
--------------------------------------------------------------------------------
1 | KeyboardConfig.h
2 | 
3 | 


--------------------------------------------------------------------------------
/src/CH552duinoKeyboardCore/KeyboardCore.h:
--------------------------------------------------------------------------------
1 | void keyboard_init(void);
2 | void keyboard_scan(void);
3 | 


--------------------------------------------------------------------------------
/src/CH552duinoKeyboardCore/via.h:
--------------------------------------------------------------------------------
1 | void raw_hid_receive(void);
2 | uint16_t dynamic_keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col);
3 | 
4 | 


--------------------------------------------------------------------------------
/KeyboardConfig.h.sample:
--------------------------------------------------------------------------------
 1 | #define ROWS_COUNT 2
 2 | #define COLS_COUNT 2
 3 | 
 4 | #define MATRIX_ROWS { 34, 33 }
 5 | #define MATRIX_COLS { 31, 30 }
 6 | 
 7 | //#define STATUS_LED_FUNCTION(led) set_led(led)
 8 | 
 9 | void set_led(uint8_t led_status);
10 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | ## Remap対応CH552マクロパッドファームウェア
 2 | 
 3 | ### できること
 4 | 
 5 | * Remapからのキー割当
 6 | * マトリックススキャン
 7 | * キーボードのキーの送信
 8 | * Modifier+キー (例: Ctrl+A)
 9 | 
10 | ### 未実装
11 | 
12 | * マウスキー
13 | * レイヤー
14 | * ConsumerControl
15 | 
16 | ### 使い方
17 | 
18 | 1. 本リポジトリをクローン
19 | 1. `KeyboardConfig.h.sample` を `KeyboardConfig.h` としてコピーし, 設定を書き換え
20 | 1. `CH552duinoKeyboard.ino`をArduino IDEで開く
21 | 1. [CH55xduino](https://github.com/DeqingSun/ch55xduino)をインストール
22 | 1. `USB Settings` から `USER CODE w/ 148B ram` を選択
23 | 1. コンパイル・書き込み
24 | 
25 | ### 書き込みのコツ
26 | 
27 | 1回目の書き込みがダメでも挿し込みから10秒以内にもう一度書き込みをすると大体成功する
28 | 
29 | 


--------------------------------------------------------------------------------
/CH552duinoKeyboard.ino:
--------------------------------------------------------------------------------
 1 | /*
 2 |   HID Keyboard mouse combo example
 3 | 
 4 | 
 5 |   created 2022
 6 |   by Deqing Sun for use with CH55xduino
 7 | 
 8 |   This example code is in the public domain.
 9 | 
10 | */
11 | 
12 | //For windows user, if you ever played with other HID device with the same PID C55D
13 | //You may need to uninstall the previous driver completely
14 | 
15 | 
16 | #ifndef USER_USB_RAM
17 | #error "This example needs to be compiled with a USER USB setting"
18 | #endif
19 | 
20 | #include "src/CH552duinoKeyboardCore/KeyboardCore.h"
21 | 
22 | void setup() {
23 |   keyboard_init();
24 | }
25 | 
26 | void loop() {
27 |   keyboard_scan();
28 |   delay(50);  //naive debouncing
29 | }
30 | 


--------------------------------------------------------------------------------
/src/CH552duinoKeyboardCore/USBconstant.h:
--------------------------------------------------------------------------------
 1 | #ifndef __USB_CONST_DATA_H__
 2 | #define __USB_CONST_DATA_H__
 3 | 
 4 | #include <stdint.h>
 5 | #include "include/ch5xx.h"
 6 | #include "include/ch5xx_usb.h"
 7 | 
 8 | #define  EP0_ADDR 0
 9 | #define  EP1_ADDR 10
10 | 
11 | extern __code uint8_t DevDesc[];
12 | extern __code uint8_t CfgDesc[];
13 | extern __code uint8_t LangDes[];
14 | extern __code uint8_t ReportDesc[];
15 | extern __code uint8_t SerDes[];
16 | extern __code uint8_t Prod_Des[];
17 | extern __code uint8_t Manuf_Des[];
18 | 
19 | extern __code uint16_t DevDescLen;
20 | extern __code uint16_t CfgDescLen;
21 | extern __code uint16_t LangDesLen;
22 | extern __code uint16_t ReportDescLen;
23 | extern __code uint16_t SerDesLen;
24 | extern __code uint16_t Prod_DesLen;
25 | extern __code uint16_t Manuf_DesLen;
26 | 
27 | #endif
28 | 


--------------------------------------------------------------------------------
/src/CH552duinoKeyboardCore/USBHIDKeyboardMouse.h:
--------------------------------------------------------------------------------
 1 | #ifndef __USB_HID_KBD_H__
 2 | #define __USB_HID_KBD_H__
 3 | 
 4 | #include <stdint.h>
 5 | #include "include/ch5xx.h"
 6 | #include "include/ch5xx_usb.h"
 7 | 
 8 | enum MOUSE_BUTTON {
 9 |     MOUSE_LEFT = 1,
10 |     MOUSE_RIGHT = 2,
11 |     MOUSE_MIDDLE = 4,
12 | };
13 | 
14 | #ifdef __cplusplus
15 | extern "C" {
16 | #endif
17 | 
18 | void USBInit(void);
19 | 
20 | void Keyboard_press(uint8_t kc);
21 | void Keyboard_release(uint8_t kc);
22 | void Keyboard_releaseAll(void);
23 |     
24 | uint8_t Mouse_press(uint8_t k);
25 | uint8_t Mouse_release(uint8_t k);
26 | uint8_t Mouse_click(uint8_t k);
27 | uint8_t Mouse_move(int8_t x, int8_t y);
28 | uint8_t Mouse_scroll(int8_t tilt);
29 | 
30 | void raw_hid_send(void);
31 | void send_keyboard_report(void);
32 | 
33 | #include "USBconstant.h"
34 | 
35 | extern __xdata __at (EP0_ADDR) uint8_t  Ep0Buffer[];
36 | extern __xdata __at (EP1_ADDR) uint8_t  Ep1Buffer[];
37 | 
38 | #ifdef __cplusplus
39 | } // extern "C"
40 | #endif
41 | 
42 | #endif
43 | 
44 | 


--------------------------------------------------------------------------------
/src/CH552duinoKeyboardCore/USBhandler.h:
--------------------------------------------------------------------------------
 1 | #ifndef __USB_HANDLER_H__
 2 | #define __USB_HANDLER_H__
 3 | 
 4 | #include <stdint.h>
 5 | #include "include/ch5xx.h"
 6 | #include "include/ch5xx_usb.h"
 7 | #include "USBconstant.h"
 8 | 
 9 | extern __xdata __at (EP0_ADDR) uint8_t  Ep0Buffer[];
10 | extern __xdata __at (EP1_ADDR) uint8_t  Ep1Buffer[];
11 | 
12 | extern uint16_t SetupLen;
13 | extern uint8_t SetupReq,UsbConfig;
14 | extern const __code uint8_t *pDescr;
15 | 
16 | void USB_EP1_IN(void);
17 | void USB_EP1_OUT(void);
18 | 
19 | #define UsbSetupBuf     ((PUSB_SETUP_REQ)Ep0Buffer)
20 | 
21 | // Out
22 | #define EP0_OUT_Callback USB_EP0_OUT
23 | #define EP1_OUT_Callback USB_EP1_OUT
24 | #define EP2_OUT_Callback NOP_Process
25 | #define EP3_OUT_Callback NOP_Process
26 | #define EP4_OUT_Callback NOP_Process
27 | 
28 | // SOF
29 | #define EP0_SOF_Callback NOP_Process
30 | #define EP1_SOF_Callback NOP_Process
31 | #define EP2_SOF_Callback NOP_Process
32 | #define EP3_SOF_Callback NOP_Process
33 | #define EP4_SOF_Callback NOP_Process
34 | 
35 | // IN
36 | #define EP0_IN_Callback USB_EP0_IN
37 | #define EP1_IN_Callback USB_EP1_IN
38 | #define EP2_IN_Callback NOP_Process
39 | #define EP3_IN_Callback NOP_Process
40 | #define EP4_IN_Callback NOP_Process
41 | 
42 | // SETUP
43 | #define EP0_SETUP_Callback USB_EP0_SETUP
44 | #define EP1_SETUP_Callback NOP_Process
45 | #define EP2_SETUP_Callback NOP_Process
46 | #define EP3_SETUP_Callback NOP_Process
47 | #define EP4_SETUP_Callback NOP_Process
48 | 
49 | #ifdef __cplusplus
50 | extern "C" {
51 | #endif
52 | 
53 | void USBInterrupt(void);
54 | void USBDeviceCfg();
55 | void USBDeviceIntCfg();
56 | void USBDeviceEndPointCfg();
57 | 
58 | #ifdef __cplusplus
59 | } // extern "C"
60 | #endif
61 | 
62 | #endif
63 | 
64 | 


--------------------------------------------------------------------------------
/src/CH552duinoKeyboardCore/KeyboardCore.c:
--------------------------------------------------------------------------------
  1 | #include <Arduino.h>
  2 | #include "./via.h"
  3 | #include "./USBHIDKeyboardMouse.h"
  4 | #include "../../KeyboardConfig.h"
  5 | 
  6 | uint8_t press_status[ROWS_COUNT];
  7 | 
  8 | __code uint8_t rows[ROWS_COUNT] = MATRIX_ROWS;
  9 | __code uint8_t cols[COLS_COUNT] = MATRIX_COLS;
 10 | 
 11 | void press_key(uint8_t row, uint8_t col, bool press)
 12 | {
 13 |     uint16_t keycode = dynamic_keymap_get_keycode(0,row,col);
 14 |     uint8_t application = (keycode>>8) & 0x00FF;
 15 |     
 16 |     if( application )
 17 |     {
 18 |         switch( application & 0xF0 )
 19 |         {
 20 |             case 0x00:
 21 |                 for(uint8_t i=0;i<4;i++)
 22 |                 {
 23 |                     if( application & (1<<i) )
 24 |                     {
 25 |                         if( press )
 26 |                         {
 27 |                             Keyboard_press( 0xE0+i );
 28 |                         } else {
 29 |                             Keyboard_release( 0xE0+i );
 30 |                         }
 31 |                     }
 32 |                 }
 33 |                 break;
 34 |             case 0x10:
 35 |                 for(uint8_t i=0;i<4;i++)
 36 |                 {
 37 |                     if( application & (1<<i) )
 38 |                     {
 39 |                         if( press )
 40 |                         {
 41 |                             Keyboard_press( 0xE4+i );
 42 |                         } else {
 43 |                             Keyboard_release( 0xE4+i );
 44 |                         }
 45 |                     }
 46 |                 }
 47 |                 break;
 48 |             default:
 49 |                 break;
 50 |         }
 51 |     }
 52 |     
 53 |     if( press )
 54 |     {
 55 |         Keyboard_press(keycode & 0x00FF);
 56 |     } else {
 57 |         Keyboard_release(keycode & 0x00FF);
 58 |     }
 59 | }
 60 | 
 61 | void keyboard_init(void)
 62 | {
 63 |     USBInit();
 64 |     
 65 |     for(uint8_t i=0; i<ROWS_COUNT; i++) {
 66 |         press_status[i] = 0;
 67 |         pinMode(rows[i], OUTPUT);
 68 |         digitalWrite(rows[i], LOW);
 69 |     }
 70 |     
 71 |     for(uint8_t i=0; i<COLS_COUNT; i++) {
 72 |         pinMode(cols[i], INPUT_PULLUP);
 73 |     }   
 74 | }
 75 | 
 76 | void keyboard_scan(void)
 77 | {
 78 |     bool matrix_change = false;
 79 |     
 80 |     for(uint8_t row=0;row<ROWS_COUNT;row++)
 81 |     {
 82 |         digitalWrite(rows[row], LOW);
 83 |         for(uint8_t col=0;col<COLS_COUNT;col++)
 84 |         {
 85 |             if(digitalRead(cols[col])==LOW)
 86 |             {
 87 |                 // press
 88 |                 if(! (press_status[row] & (1<<col)) )
 89 |                 {
 90 |                     press_status[row] |= 1<<col;
 91 |                     press_key(row,col,true);
 92 |                     matrix_change = true;
 93 |                 }
 94 |             } else {
 95 |                 // release
 96 |                 if( press_status[row] & (1<<col) )
 97 |                 {
 98 |                     press_status[row] &= ~(1<<col);
 99 |                     press_key(row,col,false);
100 |                     matrix_change = true;
101 |                 }
102 |             }
103 |         }
104 |         digitalWrite(rows[row], HIGH);
105 |     }
106 |     
107 |     if( matrix_change )
108 |     {
109 |         send_keyboard_report();
110 |     }
111 | }
112 | 


--------------------------------------------------------------------------------
/src/CH552duinoKeyboardCore/via.c:
--------------------------------------------------------------------------------
  1 | #include <stdint.h>
  2 | #include <stdbool.h>
  3 | #include "include/ch5xx.h"
  4 | #include "include/ch5xx_usb.h"
  5 | #include "./USBconstant.h"
  6 | #include "./USBhandler.h"
  7 | #include "Arduino.h"
  8 | #include "USBHIDKeyboardMouse.h"
  9 | 
 10 | #include "../../KeyboardConfig.h"
 11 | 
 12 | enum {
 13 |     ID_GET_PROTOCOL_VERSION = 0x01,
 14 |     ID_GET_KEYBOARD_VALUE,
 15 |     ID_SET_KEYBOARD_VALUE,
 16 |     ID_KEYMAP_GET_KEYCODE,
 17 |     ID_KEYMAP_SET_KEYCODE,
 18 |     ID_KEYMAP_RESET,
 19 |     ID_LIGHTING_SET_VALUE,
 20 |     ID_LIGHTING_GET_VALUE,
 21 |     ID_LIGHTING_SAVE,
 22 |     ID_EEPROM_RESET,
 23 |     ID_BOOTLOADER_JUMP,
 24 |     ID_MACRO_GET_COUNT,
 25 |     ID_MACRO_GET_BUFFER_SIZE,
 26 |     ID_MACRO_GET_BUFFER,
 27 |     ID_MACRO_SET_BUFFER,
 28 |     ID_MACRO_RESET,
 29 |     ID_KEYMAP_GET_LAYER_COUNT,
 30 |     ID_KEYMAP_GET_BUFFER,
 31 |     ID_KEYMAP_SET_BUFFER,
 32 |     ID_UNHANDLED = 0xFF,
 33 | };
 34 | 
 35 | uint16_t dynamic_keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col) {
 36 |     uint8_t addr = (layer*ROWS_COUNT*COLS_COUNT) + row*COLS_COUNT*2 + col*2;
 37 |     return eeprom_read_byte(addr)<<8 | eeprom_read_byte(addr+1);
 38 | }
 39 | 
 40 | void dynamic_keymap_set_keycode(void) {
 41 |     uint8_t addr = (Ep1Buffer[2]*ROWS_COUNT*COLS_COUNT) + Ep1Buffer[3]*COLS_COUNT*2 + Ep1Buffer[4]*2;
 42 |     eeprom_write_byte(addr, Ep1Buffer[5]);
 43 |     eeprom_write_byte(addr+1, Ep1Buffer[6]);
 44 | }
 45 |     
 46 | 
 47 | void raw_hid_receive(void) {
 48 |     uint8_t *ResponseBuf = Ep1Buffer+65;
 49 |     uint16_t keycode;
 50 |     
 51 |     for(uint8_t i=0; i<32; i++) {
 52 |         ResponseBuf[i] = Ep1Buffer[i+1];
 53 |     }
 54 |     
 55 |     switch( Ep1Buffer[1] ) {
 56 |         case ID_GET_PROTOCOL_VERSION:
 57 |             ResponseBuf[1] = 0;
 58 |             ResponseBuf[2] = 9;
 59 |             break;
 60 |         case ID_GET_KEYBOARD_VALUE:
 61 |             for(uint8_t i=2; i<32;i++) {
 62 |                 ResponseBuf[i] = 0;
 63 |             }
 64 |             break;
 65 |         case ID_SET_KEYBOARD_VALUE:
 66 |             break;
 67 |         case ID_KEYMAP_GET_KEYCODE:
 68 |             keycode = dynamic_keymap_get_keycode(Ep1Buffer[2], Ep1Buffer[3], Ep1Buffer[4]);
 69 |             ResponseBuf[4] = keycode>>8 & 0x00FF;
 70 |             ResponseBuf[5] = keycode & 0x00FF;
 71 |             break;
 72 |         case ID_KEYMAP_SET_KEYCODE:
 73 |             dynamic_keymap_set_keycode();
 74 |             break;
 75 |         case ID_MACRO_GET_COUNT:
 76 |             ResponseBuf[1] = 0;
 77 |             break;
 78 |         case ID_MACRO_GET_BUFFER_SIZE:
 79 |             ResponseBuf[2] = 0;
 80 |             ResponseBuf[3] = 0;
 81 |             break;
 82 |         case ID_MACRO_GET_BUFFER:
 83 |             break;
 84 |         case ID_MACRO_SET_BUFFER:
 85 |             break;
 86 |             
 87 |         case ID_KEYMAP_GET_LAYER_COUNT:
 88 |             ResponseBuf[1] = 1;
 89 |             break;
 90 |         case ID_KEYMAP_GET_BUFFER:
 91 |             for(uint8_t i=0;i<Ep1Buffer[4];i++) {
 92 |                 ResponseBuf[4+i] = eeprom_read_byte(Ep1Buffer[3]+i);
 93 |             }
 94 |             break;
 95 |         case ID_KEYMAP_SET_BUFFER:
 96 |             for(uint8_t i=0;i<Ep1Buffer[4];i++) {
 97 |                 eeprom_write_byte(Ep1Buffer[3]+i, Ep1Buffer[5+i]);
 98 |             }
 99 |             break;
100 |         default:
101 |             ResponseBuf[0] = ID_UNHANDLED;
102 |             break;
103 |     }
104 |     delay(2);
105 |     raw_hid_send();
106 | }
107 |                 
108 | 


--------------------------------------------------------------------------------
/src/CH552duinoKeyboardCore/USBHIDKeyboardMouse.c:
--------------------------------------------------------------------------------
  1 | #include <stdint.h>
  2 | #include <stdbool.h>
  3 | #include "include/ch5xx.h"
  4 | #include "include/ch5xx_usb.h"
  5 | #include "USBconstant.h"
  6 | #include "USBhandler.h"
  7 | #include "USBHIDKeyboardMouse.h"
  8 | #include "../../KeyboardConfig.h"
  9 | #include "via.h"
 10 | 
 11 | volatile __xdata uint8_t UpPoint1_Busy  = 0;   //Flag of whether upload pointer is busy
 12 | 
 13 | __xdata uint8_t HIDKey[8] = {0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0};
 14 | __xdata uint8_t HIDMouse[4] = {0x0,0x0,0x0,0x0};
 15 | 
 16 | __xdata uint8_t statusLED = 0;
 17 | 
 18 | // to avoid CSEG align issue
 19 | __data uint8_t padding = 1;
 20 | 
 21 | typedef void( *pTaskFn)( void );
 22 | 
 23 | void delayMicroseconds(uint16_t us);
 24 | 
 25 | void USBInit(){
 26 |     USBDeviceCfg();                                                       //Device mode configuration
 27 |     USBDeviceEndPointCfg();                                               //Endpoint configuration   
 28 |     USBDeviceIntCfg();                                                    //Interrupt configuration    
 29 |     UEP0_T_LEN = 0;
 30 |     UEP1_T_LEN = 0;                                                       //Pre-use send length must be cleared	  
 31 |     UEP2_T_LEN = 0;                                                          
 32 | }
 33 | 
 34 | 
 35 | void USB_EP1_IN(){
 36 |     UEP1_T_LEN = 0;
 37 |     UEP1_CTRL = (UEP1_CTRL & (~MASK_UEP_T_RES)) | UEP_T_RES_ACK;           // Default NAK
 38 |     UpPoint1_Busy = 0;                                                  //Clear busy flag
 39 | }
 40 | 
 41 | 
 42 | void USB_EP1_OUT(){
 43 |     if ( U_TOG_OK )                                                     // Discard unsynchronized packets
 44 |     {
 45 |         switch(Ep1Buffer[0]) {
 46 |             case 1:
 47 |                 statusLED = Ep1Buffer[1];
 48 | #ifdef STATUS_LED_FUNCTION
 49 |                 STATUS_LED_FUNCTION(statusLED);
 50 | #endif
 51 |                 break;
 52 |             case 8:
 53 |                 raw_hid_receive();
 54 |                 break;
 55 |             default:
 56 |                 break;
 57 |         }
 58 |     }
 59 | }
 60 | 
 61 |     
 62 | uint8_t USB_EP1_send(uint8_t reportID){
 63 |     uint16_t waitWriteCount = 0;
 64 |     
 65 |     waitWriteCount = 0;
 66 |     while (UpPoint1_Busy){//wait for 250ms or give up
 67 |         waitWriteCount++;
 68 |         delayMicroseconds(5);
 69 |         if (waitWriteCount>=50000) return 0;
 70 |     }
 71 |     
 72 |     if (reportID == 1){
 73 |         Ep1Buffer[64+0] = 1;
 74 |         for (uint8_t i=0;i<sizeof(HIDKey);i++){                                  //load data for upload
 75 |             Ep1Buffer[64+1+i] = HIDKey[i];
 76 |         }
 77 |         UEP1_T_LEN = 1+sizeof(HIDKey);                                             //data length
 78 |     }else if (reportID == 2){
 79 |         Ep1Buffer[64+0] = 2;
 80 |         for (uint8_t i=0;i<sizeof(HIDMouse);i++){                                  //load data for upload
 81 |             Ep1Buffer[64+1+i] = ((uint8_t *)HIDMouse)[i];
 82 |         }
 83 |         UEP1_T_LEN = 1+sizeof(HIDMouse);                                             //data length
 84 |     }
 85 |     else if (reportID == 8){
 86 |         Ep1Buffer[64+0] = 8;
 87 |         UEP1_T_LEN = 33;
 88 |     }
 89 |     
 90 |     UpPoint1_Busy = 1;
 91 |     UEP1_CTRL = (UEP1_CTRL & (~MASK_UEP_T_RES)) | UEP_T_RES_ACK;                //upload data and respond ACK
 92 |     
 93 |     return 1;
 94 | }
 95 | 
 96 | 
 97 | void raw_hid_send(void) {
 98 |     USB_EP1_send(8);
 99 | }
100 | 
101 | 
102 | void send_keyboard_report(void) {
103 |     USB_EP1_send(1);
104 | }
105 | 
106 | void Keyboard_press(uint8_t kc)
107 | {
108 | 	if( kc<0xE0 )
109 | 	{
110 | 	    for(uint8_t i=2;i<8;i++)
111 | 	    {
112 | 	        if( HIDKey[i]==0 ) {
113 | 	            HIDKey[i] = kc;
114 | 	            break;
115 | 	        } else if( HIDKey[i]==kc ) {
116 | 	            break;
117 | 	        }
118 | 	    }
119 | 	} else {
120 | 	    HIDKey[0] |= 1<<(kc-0xE0);
121 | 	}
122 | }
123 | 
124 | void Keyboard_release(uint8_t kc)
125 | {
126 |     uint8_t backwardCount = 0;
127 | 	if( kc<0xE0 )
128 | 	{
129 | 	    for(uint8_t i=2;i<8;i++)
130 | 	    {
131 | 	        if( HIDKey[i]==kc )
132 | 	        {
133 | 	            backwardCount++;
134 | 	        }
135 | 	        
136 | 	        if( backwardCount )
137 | 	        {
138 | 	            if( i+backwardCount<8 )
139 | 	            {
140 | 	                HIDKey[i] = HIDKey[i+backwardCount];
141 | 	            } else {
142 | 	                HIDKey[i] = 0;
143 | 	            }
144 | 	        }
145 |         }
146 |     } else {
147 |         HIDKey[0] &= ~(1<<(kc-0xE0));
148 |     }
149 | }
150 | 
151 | void Keyboard_releaseAll(void){
152 |     for (uint8_t i=0;i<sizeof(HIDKey);i++){                                  //load data for upload
153 |         HIDKey[i] = 0;
154 |     }
155 | 	USB_EP1_send(1);
156 | }
157 | 
158 | uint8_t Mouse_press(uint8_t k) {
159 |     HIDMouse[0] |= k;
160 |     USB_EP1_send(2);
161 |     return 1;
162 | }
163 | 
164 | uint8_t Mouse_release(uint8_t k) {
165 |     HIDMouse[0] &= ~k;
166 |     USB_EP1_send(2);
167 |     return 1;
168 | }
169 | 
170 | uint8_t Mouse_click(uint8_t k){
171 |     Mouse_press(k);
172 |     delayMicroseconds(10000);
173 |     Mouse_release(k);
174 |     return 1;
175 | }
176 | 
177 | uint8_t Mouse_move(int8_t x, int8_t y){
178 |     HIDMouse[1] = x;
179 |     HIDMouse[2] = y;
180 |     USB_EP1_send(2);
181 |     return 1;
182 | }
183 | 
184 | uint8_t Mouse_scroll(int8_t tilt){
185 |     HIDMouse[3] = tilt;
186 |     USB_EP1_send(2);
187 |     return 1;
188 | }
189 | 


--------------------------------------------------------------------------------
/src/CH552duinoKeyboardCore/USBconstant.c:
--------------------------------------------------------------------------------
  1 | #include "USBconstant.h"
  2 | 
  3 | 
  4 | //Device descriptor
  5 | __code uint8_t DevDesc[] = {
  6 |     0x12,0x01,
  7 |     0x10,0x01,  //USB spec release number in BCD format, USB1.1 (0x10, 0x01).
  8 |     0x00,0x00,0x00, //bDeviceClass, bDeviceSubClass, bDeviceProtocol 
  9 |     DEFAULT_ENDP0_SIZE, //bNumConfigurations
 10 |     0x09,0x12,0x5D,0xC5, // VID PID 
 11 |     0x00,0x01,  //version
 12 |     0x01,0x02,0x03, //bString
 13 |     0x01    //bNumConfigurations
 14 | };
 15 | 
 16 | __code uint16_t DevDescLen = sizeof(DevDesc);
 17 | 
 18 | __code uint8_t CfgDesc[] ={
 19 |     0x09,0x02,sizeof(CfgDesc) & 0xff,sizeof(CfgDesc) >> 8,
 20 |     0x01,0x01,0x00,0x80,0x64,             //Configuration descriptor (1 interface)
 21 |     // Interface 1 (HID) descriptor
 22 |     0x09,0x04,0x00,0x00,0x02,0x03,0x01,0x01,0x00,    // HID Keyboard, 2 endpoints
 23 |     0x09,0x21,0x10,0x01,0x21,0x01,0x22,sizeof(ReportDesc) & 0xff,sizeof(ReportDesc) >> 8,    //HID Descriptor
 24 |     // len=7, endpoint, ep1out, interrupt, 64byte, interval(8ms)
 25 |     0x07,0x05,0x01,0x03,0x40,0x00,0x08,                       //endpoint descriptor
 26 |     // len=7, endpoint, ep1in, interrupt, 64byte, interval(8ms)
 27 |     0x07,0x05,0x81,0x03,0x40,0x00,0x08,                       //endpoint descriptor
 28 | };
 29 | 
 30 | __code uint16_t ReportDescLen = sizeof(ReportDesc);
 31 | 
 32 | __code uint8_t ReportDesc[] ={
 33 |     0x05, 0x01,                    // USAGE_PAGE (Generic Desktop)
 34 |     0x09, 0x06,                    // USAGE (Keyboard)
 35 |     0xa1, 0x01,                    // COLLECTION (Application)
 36 |     0x85, 0x01,                    //   REPORT_ID (1)
 37 |     0x05, 0x07,                    //   USAGE_PAGE (Keyboard)
 38 |     0x19, 0xe0,                    //   USAGE_MINIMUM (Keyboard LeftControl)
 39 |     0x29, 0xe7,                    //   USAGE_MAXIMUM (Keyboard Right GUI)
 40 |     0x15, 0x00,                    //   LOGICAL_MINIMUM (0)
 41 |     0x25, 0x01,                    //   LOGICAL_MAXIMUM (1)
 42 |     0x95, 0x08,                    //   REPORT_COUNT (8)
 43 |     0x75, 0x01,                    //   REPORT_SIZE (1)
 44 |     0x81, 0x02,                    //   INPUT (Data,Var,Abs)
 45 |     0x95, 0x01,                    //   REPORT_COUNT (1)
 46 |     0x75, 0x08,                    //   REPORT_SIZE (8)
 47 |     0x81, 0x03,                    //   INPUT (Cnst,Var,Abs)
 48 |     0x95, 0x06,                    //   REPORT_COUNT (6)
 49 |     0x75, 0x08,                    //   REPORT_SIZE (8)
 50 |     0x15, 0x00,                    //   LOGICAL_MINIMUM (0)
 51 |     0x26, 0xff, 0x00,              //   LOGICAL_MAXIMUM (255)
 52 |     0x05, 0x07,                    //   USAGE_PAGE (Keyboard)
 53 |     0x19, 0x00,                    //   USAGE_MINIMUM (Reserved (no event indicated))
 54 |     0x29, 0xe7,                    //   USAGE_MAXIMUM (Keyboard Right GUI)
 55 |     0x81, 0x00,                    //   INPUT (Data,Ary,Abs)
 56 |     0x05, 0x08,                    //   USAGE_PAGE (LEDs)
 57 |     0x19, 0x01,                    //   USAGE_MINIMUM (Num Lock)
 58 |     0x29, 0x05,                    //   USAGE_MAXIMUM (Kana)
 59 |     0x15, 0x00,                    //   LOGICAL_MINIMUM (0)
 60 |     0x25, 0x01,                    //   LOGICAL_MAXIMUM (1)
 61 |     0x95, 0x05,                    //   REPORT_COUNT (5)
 62 |     0x75, 0x01,                    //   REPORT_SIZE (1)
 63 |     0x91, 0x02,                    //   OUTPUT (Data,Var,Abs)
 64 |     0x95, 0x01,                    //   REPORT_COUNT (1)
 65 |     0x75, 0x03,                    //   REPORT_SIZE (3)
 66 |     0x91, 0x03,                    //   OUTPUT (Cnst,Var,Abs)
 67 |     0xc0,                          // END_COLLECTION
 68 |     // Mouse
 69 |     0x05, 0x01,                    // USAGE_PAGE (Generic Desktop)
 70 |     0x09, 0x02,                    // USAGE (Mouse)
 71 |     0xa1, 0x01,                    // COLLECTION (Application)
 72 |     0x09, 0x01,                    //   USAGE (Pointer)
 73 |     0xa1, 0x00,                    //   COLLECTION (Physical)
 74 |     0x85, 0x02,                    //   REPORT_ID (2)
 75 |     0x05, 0x09,                    //     USAGE_PAGE (Button)
 76 |     0x19, 0x01,                    //     USAGE_MINIMUM (Button 1)
 77 |     0x29, 0x03,                    //     USAGE_MAXIMUM (Button 3)
 78 |     0x15, 0x00,                    //     LOGICAL_MINIMUM (0)
 79 |     0x25, 0x01,                    //     LOGICAL_MAXIMUM (1)
 80 |     0x95, 0x03,                    //     REPORT_COUNT (3)
 81 |     0x75, 0x01,                    //     REPORT_SIZE (1)
 82 |     0x81, 0x02,                    //     INPUT (Data,Var,Abs)
 83 |     0x95, 0x01,                    //     REPORT_COUNT (1)
 84 |     0x75, 0x05,                    //     REPORT_SIZE (5)
 85 |     0x81, 0x03,                    //     INPUT (Cnst,Var,Abs)
 86 |     0x05, 0x01,                    //     USAGE_PAGE (Generic Desktop)
 87 |     0x09, 0x30,                    //     USAGE (X)
 88 |     0x09, 0x31,                    //     USAGE (Y)
 89 |     0x15, 0x81,                    //     LOGICAL_MINIMUM (-127)
 90 |     0x25, 0x7f,                    //     LOGICAL_MAXIMUM (127)
 91 |     0x75, 0x08,                    //     REPORT_SIZE (8)
 92 |     0x95, 0x02,                    //     REPORT_COUNT (2)
 93 |     0x81, 0x06,                    //     INPUT (Data,Var,Rel)
 94 |     0xc0,                          //     END_COLLECTION
 95 |     0xc0                           // END_COLLECTION
 96 |     // RAW HID
 97 |     ,
 98 |     0x06, 0x60, 0xFF,
 99 |     0x09, 0x61,
100 |     0xa1, 0x01,
101 |     0x85, 8,    // Report ID: 8
102 |     0x09, 0x62, 
103 |     0x15, 0x00, 
104 |     0x26, 0xFF, 0x00, 
105 |     0x95, 32,   // length: 32
106 |     0x75, 0x08, // size: 8
107 |     0x81, 0x06, // INPUT
108 |     0x09, 0x63, 
109 |     /*
110 |     0x15, 0x00, 
111 |     0x26, 0xFF, 0x00, 
112 |     0x95, 32,   //REPORT_COUNT(32)
113 |     0x75, 0x08, //REPORT_SIZE(8)
114 |     */
115 |     0x91, 0x83, // OUTPUT
116 |     0xC0        // End Collection (Application)
117 | };
118 | 
119 | __code uint16_t CfgDescLen = sizeof(CfgDesc);
120 | 
121 | //String Descriptors
122 | __code uint8_t LangDes[]={0x04,0x03,0x09,0x04};           //Language Descriptor
123 | __code uint16_t LangDesLen = sizeof(LangDes);
124 | __code uint8_t SerDes[]={                                 //Serial String Descriptor
125 |     0x1c,0x03,
126 |     'C',0x00,'H',0x00,'5',0x00,'5',0x00,'x',0x00,' ',0x00,'k',0x00,'b',0x00,'d',0x00,' ',0x00,'m',0x00,'o',0x00,'s',0x00
127 | };
128 | __code uint16_t SerDesLen = sizeof(SerDes);
129 | __code uint8_t Prod_Des[]={                                //Produce String Descriptor
130 |     0x16,0x03,
131 |     'C',0x00,'H',0x00,'5',0x00,'5',0x00,'x',0x00,'d',0x00,
132 |     'u',0x00,'i',0x00,'n',0x00,'o',0x00,
133 |     'k',0x00,'b',0x00,'d',0x00
134 | };
135 | __code uint16_t Prod_DesLen = sizeof(Prod_Des);
136 | 
137 | __code uint8_t Manuf_Des[]={
138 |     0x0E,0x03,
139 |     'D',0x00,'e',0x00,'q',0x00,'i',0x00,'n',0x00,'g',0x00,
140 | };
141 | __code uint16_t Manuf_DesLen = sizeof(Manuf_Des);
142 | 


--------------------------------------------------------------------------------
/src/CH552duinoKeyboardCore/USBhandler.c:
--------------------------------------------------------------------------------
  1 | #include "USBhandler.h"
  2 | 
  3 | #include "USBconstant.h"
  4 | 
  5 | //Keyboard functions:
  6 | 
  7 | void USB_EP2_IN();
  8 | void USB_EP2_OUT();
  9 | 
 10 | __xdata __at (EP0_ADDR) uint8_t  Ep0Buffer[8];     
 11 | __xdata __at (EP1_ADDR) uint8_t  Ep1Buffer[128];       //on page 47 of data sheet, the receive buffer need to be min(possible packet size+2,64), IN and OUT buffer, must be even address
 12 | 
 13 | #if (EP1_ADDR+128) > USER_USB_RAM
 14 | #error "This example needs more USB ram. Increase this setting in menu."
 15 | #endif
 16 | 
 17 | uint16_t SetupLen;
 18 | uint8_t SetupReq,UsbConfig;
 19 | 
 20 | __code uint8_t *pDescr;
 21 | 
 22 | volatile uint8_t usbMsgFlags=0;    // uint8_t usbMsgFlags copied from VUSB
 23 | 
 24 | inline void NOP_Process(void) {}
 25 | 
 26 | void USB_EP0_SETUP(){
 27 |     uint8_t len = USB_RX_LEN;
 28 |     if(len == (sizeof(USB_SETUP_REQ)))
 29 |     {
 30 |         SetupLen = ((uint16_t)UsbSetupBuf->wLengthH<<8) | (UsbSetupBuf->wLengthL);
 31 |         len = 0;                                                      // Default is success and upload 0 length
 32 |         SetupReq = UsbSetupBuf->bRequest;
 33 |         usbMsgFlags = 0;
 34 |         if ( ( UsbSetupBuf->bRequestType & USB_REQ_TYP_MASK ) != USB_REQ_TYP_STANDARD )//Not standard request
 35 |         {
 36 |             
 37 |             //here is the commnunication starts, refer to usbFunctionSetup of USBtiny
 38 |             //or usb_setup in usbtiny
 39 |             
 40 |             switch( ( UsbSetupBuf->bRequestType & USB_REQ_TYP_MASK ))
 41 |             {
 42 |                 case USB_REQ_TYP_VENDOR:    
 43 |                 {
 44 |                     switch( SetupReq )
 45 |                     {
 46 |                         default:
 47 |                             len = 0xFF;                                                                        //command not supported
 48 |                             break;
 49 |                     }
 50 |                     break;
 51 |                 }
 52 |                 case USB_REQ_TYP_CLASS:
 53 |                 {
 54 |                     switch( SetupReq )
 55 |                     {       
 56 |                         default:
 57 |                             len = 0xFF;                                                                        //command not supported
 58 |                             break;
 59 |                     }
 60 |                     break;
 61 |                 }
 62 |                 default:
 63 |                     len = 0xFF;                                                                        //command not supported
 64 |                     break;
 65 |             }
 66 | 
 67 |         }
 68 |         else                                                             //Standard request
 69 |         {
 70 |             switch(SetupReq)                                             //Request ccfType
 71 |             {
 72 |                 case USB_GET_DESCRIPTOR:
 73 |                     switch(UsbSetupBuf->wValueH)
 74 |                 {
 75 |                     case 1:                                                       //Device Descriptor
 76 |                         pDescr = DevDesc;                                         //Put Device Descriptor into outgoing buffer
 77 |                         len = DevDescLen;
 78 |                         break;
 79 |                     case 2:                                                        //Configure Descriptor
 80 |                         pDescr = CfgDesc;                                       
 81 |                         len = CfgDescLen;
 82 |                         break;
 83 |                     case 3:
 84 |                         if(UsbSetupBuf->wValueL == 0)
 85 |                         {
 86 |                             pDescr = LangDes;
 87 |                             len = LangDesLen;
 88 |                         }
 89 |                         else if(UsbSetupBuf->wValueL == 1)
 90 |                         {
 91 |                             pDescr = Manuf_Des;
 92 |                             len = Manuf_DesLen;
 93 |                         }
 94 |                         else if(UsbSetupBuf->wValueL == 2)
 95 |                         {
 96 |                             pDescr = Prod_Des;
 97 |                             len = Prod_DesLen;
 98 |                         }
 99 |                         else if(UsbSetupBuf->wValueL == 3)
100 |                         {
101 |                             pDescr = SerDes;
102 |                             len = SerDesLen;
103 |                         }
104 |                         else
105 |                         {
106 |                             len = 0xff;  
107 |                         }
108 |                         break;
109 |                      case 0x22:
110 |                         if(UsbSetupBuf->wValueL == 0){
111 |                             pDescr = ReportDesc;
112 |                             len = ReportDescLen;
113 |                         }
114 |                         else
115 |                         {
116 |                             len = 0xff;  
117 |                         }
118 |                         break;
119 |                     default:
120 |                         len = 0xff;                                                // Unsupported descriptors or error
121 |                         break;
122 |                 }
123 |                     if (len != 0xff){
124 |                         if ( SetupLen > len )
125 |                         {
126 |                             SetupLen = len;    // Limit length
127 |                         }
128 |                         len = SetupLen >= DEFAULT_ENDP0_SIZE ? DEFAULT_ENDP0_SIZE : SetupLen;                            //transmit length for this packet
129 |                         for (uint8_t i=0;i<len;i++){
130 |                             Ep0Buffer[i] = pDescr[i];
131 |                         }
132 |                         SetupLen -= len;
133 |                         pDescr += len;
134 |                     }
135 |                     break;
136 |                 case USB_SET_ADDRESS:
137 |                     SetupLen = UsbSetupBuf->wValueL;                              // Save the assigned address
138 |                     break;
139 |                 case USB_GET_CONFIGURATION:
140 |                     Ep0Buffer[0] = UsbConfig;
141 |                     if ( SetupLen >= 1 )
142 |                     {
143 |                         len = 1;
144 |                     }
145 |                     break;
146 |                 case USB_SET_CONFIGURATION:
147 |                     UsbConfig = UsbSetupBuf->wValueL;
148 |                     break;
149 |                 case USB_GET_INTERFACE:
150 |                     break;
151 |                 case USB_SET_INTERFACE:
152 |                     break;
153 |                 case USB_CLEAR_FEATURE:                                            //Clear Feature
154 |                     if( ( UsbSetupBuf->bRequestType & 0x1F ) == USB_REQ_RECIP_DEVICE )                  // Clear the device featuee.
155 |                     {
156 |                         if( ( ( ( uint16_t )UsbSetupBuf->wValueH << 8 ) | UsbSetupBuf->wValueL ) == 0x01 )
157 |                         {
158 |                             if( CfgDesc[ 7 ] & 0x20 )
159 |                             {
160 |                                 // wake up
161 |                             }
162 |                             else
163 |                             {
164 |                                 len = 0xFF;                                        //Failed
165 |                             }
166 |                         }
167 |                         else
168 |                         {
169 |                             len = 0xFF;                                            //Failed
170 |                         }
171 |                     }
172 |                     else if ( ( UsbSetupBuf->bRequestType & USB_REQ_RECIP_MASK ) == USB_REQ_RECIP_ENDP )// endpoint
173 |                     {
174 |                         switch( UsbSetupBuf->wIndexL )
175 |                         {
176 |                             case 0x84:
177 |                                 UEP4_CTRL = UEP4_CTRL & ~ ( bUEP_T_TOG | MASK_UEP_T_RES ) | UEP_T_RES_NAK;
178 |                                 break;
179 |                             case 0x04:
180 |                                 UEP4_CTRL = UEP4_CTRL & ~ ( bUEP_R_TOG | MASK_UEP_R_RES ) | UEP_R_RES_ACK;
181 |                                 break;
182 |                             case 0x83:
183 |                                 UEP3_CTRL = UEP3_CTRL & ~ ( bUEP_T_TOG | MASK_UEP_T_RES ) | UEP_T_RES_NAK;
184 |                                 break;
185 |                             case 0x03:
186 |                                 UEP3_CTRL = UEP3_CTRL & ~ ( bUEP_R_TOG | MASK_UEP_R_RES ) | UEP_R_RES_ACK;
187 |                                 break;
188 |                             case 0x82:
189 |                                 UEP2_CTRL = UEP2_CTRL & ~ ( bUEP_T_TOG | MASK_UEP_T_RES ) | UEP_T_RES_NAK;
190 |                                 break;
191 |                             case 0x02:
192 |                                 UEP2_CTRL = UEP2_CTRL & ~ ( bUEP_R_TOG | MASK_UEP_R_RES ) | UEP_R_RES_ACK;
193 |                                 break;
194 |                             case 0x81:
195 |                                 UEP1_CTRL = UEP1_CTRL & ~ ( bUEP_T_TOG | MASK_UEP_T_RES ) | UEP_T_RES_NAK;
196 |                                 break;
197 |                             case 0x01:
198 |                                 UEP1_CTRL = UEP1_CTRL & ~ ( bUEP_R_TOG | MASK_UEP_R_RES ) | UEP_R_RES_ACK;
199 |                                 break;
200 |                             default:
201 |                                 len = 0xFF;                                         // Unsupported endpoint
202 |                                 break;
203 |                         }
204 |                     }
205 |                     else
206 |                     {
207 |                         len = 0xFF;                                                // Unsupported for non-endpoint
208 |                     }
209 |                     break;
210 |                 case USB_SET_FEATURE:                                          // Set Feature
211 |                     if( ( UsbSetupBuf->bRequestType & 0x1F ) == USB_REQ_RECIP_DEVICE )                  // Set  the device featuee.
212 |                     {
213 |                         if( ( ( ( uint16_t )UsbSetupBuf->wValueH << 8 ) | UsbSetupBuf->wValueL ) == 0x01 )
214 |                         {
215 |                             if( CfgDesc[ 7 ] & 0x20 )
216 |                             {
217 |                                 // suspend
218 | 
219 |                                 //while ( XBUS_AUX & bUART0_TX );    //Wait till uart0 sending complete
220 |                                 //SAFE_MOD = 0x55;
221 |                                 //SAFE_MOD = 0xAA;
222 |                                 //WAKE_CTRL = bWAK_BY_USB | bWAK_RXD0_LO | bWAK_RXD1_LO;                      //wake up by USB or RXD0/1 signal
223 |                                 //PCON |= PD;                                                                 //sleep
224 |                                 //SAFE_MOD = 0x55;
225 |                                 //SAFE_MOD = 0xAA;
226 |                                 //WAKE_CTRL = 0x00;
227 |                             }
228 |                             else
229 |                             {
230 |                                 len = 0xFF;                                        // Failed
231 |                             }
232 |                         }
233 |                         else
234 |                         {
235 |                             len = 0xFF;                                            // Failed
236 |                         }
237 |                     }
238 |                     else if( ( UsbSetupBuf->bRequestType & 0x1F ) == USB_REQ_RECIP_ENDP )             //endpoint
239 |                     {
240 |                         if( ( ( ( uint16_t )UsbSetupBuf->wValueH << 8 ) | UsbSetupBuf->wValueL ) == 0x00 )
241 |                         {
242 |                             switch( ( ( uint16_t )UsbSetupBuf->wIndexH << 8 ) | UsbSetupBuf->wIndexL )
243 |                             {
244 |                                 case 0x84:
245 |                                     UEP4_CTRL = UEP4_CTRL & (~bUEP_T_TOG) | UEP_T_RES_STALL;// Set endpoint4 IN STALL 
246 |                                     break;
247 |                                 case 0x04:
248 |                                     UEP4_CTRL = UEP4_CTRL & (~bUEP_R_TOG) | UEP_R_RES_STALL;// Set endpoint4 OUT Stall 
249 |                                     break;
250 |                                 case 0x83:
251 |                                     UEP3_CTRL = UEP3_CTRL & (~bUEP_T_TOG) | UEP_T_RES_STALL;// Set endpoint3 IN STALL 
252 |                                     break;
253 |                                 case 0x03:
254 |                                     UEP3_CTRL = UEP3_CTRL & (~bUEP_R_TOG) | UEP_R_RES_STALL;// Set endpoint3 OUT Stall 
255 |                                     break;
256 |                                 case 0x82:
257 |                                     UEP2_CTRL = UEP2_CTRL & (~bUEP_T_TOG) | UEP_T_RES_STALL;// Set endpoint2 IN STALL 
258 |                                     break;
259 |                                 case 0x02:
260 |                                     UEP2_CTRL = UEP2_CTRL & (~bUEP_R_TOG) | UEP_R_RES_STALL;// Set endpoint2 OUT Stall 
261 |                                     break;
262 |                                 case 0x81:
263 |                                     UEP1_CTRL = UEP1_CTRL & (~bUEP_T_TOG) | UEP_T_RES_STALL;// Set endpoint1 IN STALL 
264 |                                     break;
265 |                                 case 0x01:
266 |                                     UEP1_CTRL = UEP1_CTRL & (~bUEP_R_TOG) | UEP_R_RES_STALL;// Set endpoint1 OUT Stall 
267 |                                 default:
268 |                                     len = 0xFF;                                    // Failed
269 |                                     break;
270 |                             }
271 |                         }
272 |                         else
273 |                         {
274 |                             len = 0xFF;                                      // Failed
275 |                         }
276 |                     }
277 |                     else
278 |                     {
279 |                         len = 0xFF;                                          // Failed
280 |                     }
281 |                     break;
282 |                 case USB_GET_STATUS:
283 |                     Ep0Buffer[0] = 0x00;
284 |                     Ep0Buffer[1] = 0x00;
285 |                     if ( SetupLen >= 2 )
286 |                     {
287 |                         len = 2;
288 |                     }
289 |                     else
290 |                     {
291 |                         len = SetupLen;
292 |                     }
293 |                     break;
294 |                 default:
295 |                     len = 0xff;                                                    // Failed
296 |                     break;
297 |             }
298 |         }
299 |     }
300 |     else
301 |     {
302 |         len = 0xff;                                                         //Wrong packet length
303 |     }
304 |     if(len == 0xff)
305 |     {
306 |         SetupReq = 0xFF;
307 |         UEP0_CTRL = bUEP_R_TOG | bUEP_T_TOG | UEP_R_RES_STALL | UEP_T_RES_STALL;//STALL
308 |     }
309 |     else if(len <= DEFAULT_ENDP0_SIZE)                                                       // Tx data to host or send 0-length packet
310 |     {
311 |         UEP0_T_LEN = len;
312 |         UEP0_CTRL = bUEP_R_TOG | bUEP_T_TOG | UEP_R_RES_ACK | UEP_T_RES_ACK;//Expect DATA1, Answer ACK
313 |     }
314 |     else
315 |     {
316 |         UEP0_T_LEN = 0;  // Tx data to host or send 0-length packet
317 |         UEP0_CTRL = bUEP_R_TOG | bUEP_T_TOG | UEP_R_RES_ACK | UEP_T_RES_ACK;//Expect DATA1, Answer ACK
318 |     }
319 | }
320 | 
321 | void USB_EP0_IN(){
322 |     switch(SetupReq)
323 |     {
324 |         case USB_GET_DESCRIPTOR:
325 |         {
326 |             uint8_t len = SetupLen >= DEFAULT_ENDP0_SIZE ? DEFAULT_ENDP0_SIZE : SetupLen;                                 //send length
327 |             for (uint8_t i=0;i<len;i++){
328 |                 Ep0Buffer[i] = pDescr[i];
329 |             }
330 |             //memcpy( Ep0Buffer, pDescr, len );                                  
331 |             SetupLen -= len;
332 |             pDescr += len;
333 |             UEP0_T_LEN = len;
334 |             UEP0_CTRL ^= bUEP_T_TOG;                    //Switch between DATA0 and DATA1
335 |         }
336 |             break;
337 |         case USB_SET_ADDRESS:
338 |             USB_DEV_AD = USB_DEV_AD & bUDA_GP_BIT | SetupLen;
339 |             UEP0_CTRL = UEP_R_RES_ACK | UEP_T_RES_NAK;
340 |             break;
341 |         default:
342 |             UEP0_T_LEN = 0;                                                      // End of transaction
343 |             UEP0_CTRL = UEP_R_RES_ACK | UEP_T_RES_NAK;
344 |             break;
345 |     }
346 | }
347 | 
348 | void USB_EP0_OUT(){
349 |     {
350 |         UEP0_T_LEN = 0;
351 |         UEP0_CTRL |= UEP_R_RES_ACK | UEP_T_RES_NAK;  //Respond Nak
352 |     }
353 | }
354 | 
355 | 
356 | 
357 | #pragma save
358 | #pragma nooverlay
359 | void USBInterrupt(void) {   //inline not really working in multiple files in SDCC
360 | 
361 |     if(UIF_TRANSFER) {
362 |         // Dispatch to service functions
363 |         uint8_t callIndex=USB_INT_ST & MASK_UIS_ENDP;
364 | 
365 |         switch (USB_INT_ST & MASK_UIS_TOKEN) {
366 |             case UIS_TOKEN_OUT:
367 |             {//SDCC will take IRAM if array of function pointer is used.
368 |                 switch (callIndex) {
369 |                     case 0: EP0_OUT_Callback(); break;
370 |                     case 1: EP1_OUT_Callback(); break;
371 |                     case 2: EP2_OUT_Callback(); break;
372 |                     case 3: EP3_OUT_Callback(); break;
373 |                     case 4: EP4_OUT_Callback(); break;
374 |                     default: break;
375 |                 }
376 |             }
377 |                 break;
378 |             case UIS_TOKEN_SOF:
379 |             {//SDCC will take IRAM if array of function pointer is used.
380 |                 switch (callIndex) {
381 |                     case 0: EP0_SOF_Callback(); break;
382 |                     case 1: EP1_SOF_Callback(); break;
383 |                     case 2: EP2_SOF_Callback(); break;
384 |                     case 3: EP3_SOF_Callback(); break;
385 |                     case 4: EP4_SOF_Callback(); break;
386 |                     default: break;
387 |                 }
388 |             }
389 |                 break;
390 |             case UIS_TOKEN_IN:
391 |             {//SDCC will take IRAM if array of function pointer is used.
392 |                 switch (callIndex) {
393 |                     case 0: EP0_IN_Callback(); break;
394 |                     case 1: EP1_IN_Callback(); break;
395 |                     case 2: EP2_IN_Callback(); break;
396 |                     case 3: EP3_IN_Callback(); break;
397 |                     case 4: EP4_IN_Callback(); break;
398 |                     default: break;
399 |                 }
400 |             }
401 |                 break;
402 |             case UIS_TOKEN_SETUP:
403 |             {//SDCC will take IRAM if array of function pointer is used.
404 |                 switch (callIndex) {
405 |                     case 0: EP0_SETUP_Callback(); break;
406 |                     case 1: EP1_SETUP_Callback(); break;
407 |                     case 2: EP2_SETUP_Callback(); break;
408 |                     case 3: EP3_SETUP_Callback(); break;
409 |                     case 4: EP4_SETUP_Callback(); break;
410 |                     default: break;
411 |                 }
412 |             }
413 |                 break;
414 |         }
415 |         
416 |         UIF_TRANSFER = 0;                                                     // Clear interrupt flag
417 |     }
418 |     
419 |     // Device mode USB bus reset
420 |     if(UIF_BUS_RST) {
421 |         UEP0_CTRL = UEP_R_RES_ACK | UEP_T_RES_NAK;
422 |         UEP1_CTRL = bUEP_AUTO_TOG | UEP_T_RES_NAK | UEP_R_RES_ACK;
423 |         
424 |         USB_DEV_AD = 0x00;
425 |         UIF_SUSPEND = 0;
426 |         UIF_TRANSFER = 0;
427 |         UIF_BUS_RST = 0;                                                        // Clear interrupt flag
428 |     }
429 |     
430 |     // USB bus suspend / wake up
431 |     if (UIF_SUSPEND) {
432 |         UIF_SUSPEND = 0;
433 |         if ( USB_MIS_ST & bUMS_SUSPEND ) {                    // Suspend
434 |             
435 |             //while ( XBUS_AUX & bUART0_TX );                    // Wait for Tx
436 |             //SAFE_MOD = 0x55;
437 |             //SAFE_MOD = 0xAA;
438 |             //WAKE_CTRL = bWAK_BY_USB | bWAK_RXD0_LO;    // Wake up by USB or RxD0
439 |             //PCON |= PD;                                                            // Chip sleep
440 |             //SAFE_MOD = 0x55;
441 |             //SAFE_MOD = 0xAA;
442 |             //WAKE_CTRL = 0x00;
443 |             
444 |         } else {    // Unexpected interrupt, not supposed to happen !
445 |             USB_INT_FG = 0xFF;        // Clear interrupt flag
446 |         }
447 |     }
448 | }
449 | #pragma restore
450 | 
451 | void USBDeviceCfg()
452 | {
453 |     USB_CTRL = 0x00;                                                           //Clear USB control register
454 |     //USB_CTRL &= ~bUC_HOST_MODE;                                                //This bit is the device selection mode
455 |     USB_CTRL |=  bUC_DEV_PU_EN | bUC_INT_BUSY | bUC_DMA_EN;                    //USB device and internal pull-up enable, automatically return to NAK before interrupt flag is cleared during interrupt
456 |     //USB_CTRL |= bUC_SYS_CTRL1;
457 |     USB_DEV_AD = 0x00;                                                         //Device address initialization
458 | #if 0
459 | // LOW Speed
460 |     USB_CTRL |= bUC_LOW_SPEED;
461 |     UDEV_CTRL |= bUD_LOW_SPEED;                                                //Run for 1.5M
462 | #else
463 | // FULL Speed
464 |     USB_CTRL &= ~bUC_LOW_SPEED;
465 |     UDEV_CTRL &= ~bUD_LOW_SPEED;                                             //Select full speed 12M mode, default mode
466 | #endif
467 | 
468 | #if defined(CH551) || defined(CH552) || defined(CH549)
469 |     UDEV_CTRL = bUD_PD_DIS;                                                     // Disable DP/DM pull-down resistor
470 | #endif
471 | #if defined(CH559)
472 |     UDEV_CTRL = bUD_DP_PD_DIS;                                                     // Disable DP/DM pull-down resistor
473 | #endif
474 |     UDEV_CTRL |= bUD_PORT_EN;                                                  //Enable physical port
475 | }
476 | 
477 | void USBDeviceIntCfg()
478 | {
479 |     USB_INT_EN |= bUIE_SUSPEND;                                               //Enable device hang interrupt
480 |     USB_INT_EN |= bUIE_TRANSFER;                                              //Enable USB transfer completion interrupt
481 |     USB_INT_EN |= bUIE_BUS_RST;                                               //Enable device mode USB bus reset interrupt
482 |     USB_INT_FG |= 0x1F;                                                       //Clear interrupt flag
483 |     IE_USB = 1;                                                               //Enable USB interrupt
484 |     EA = 1;                                                                   //Enable global interrupts
485 | }
486 | 
487 | void USBDeviceEndPointCfg()
488 | {
489 |     UEP1_DMA = (uint16_t) Ep1Buffer;                                                      //Endpoint 1 data transfer address
490 |     UEP1_CTRL = bUEP_AUTO_TOG | UEP_T_RES_NAK | UEP_R_RES_ACK;        //Endpoint 2 automatically flips the sync flag, IN transaction returns NAK, OUT returns ACK
491 |     UEP0_DMA = (uint16_t) Ep0Buffer;                                                      //Endpoint 0 data transfer address
492 |     UEP4_1_MOD = 0XC0;                                                         //endpoint1 TX RX enable
493 |     UEP0_CTRL = UEP_R_RES_ACK | UEP_T_RES_ACK;                //Manual flip, OUT transaction returns ACK, IN transaction returns ACK
494 | }
495 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                   GNU LESSER GENERAL PUBLIC LICENSE
  2 |                        Version 2.1, February 1999
  3 | 
  4 |  Copyright (C) 1991, 1999 Free Software Foundation, Inc.
  5 |  51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  6 |  Everyone is permitted to copy and distribute verbatim copies
  7 |  of this license document, but changing it is not allowed.
  8 | 
  9 | [This is the first released version of the Lesser GPL.  It also counts
 10 |  as the successor of the GNU Library Public License, version 2, hence
 11 |  the version number 2.1.]
 12 | 
 13 |                             Preamble
 14 | 
 15 |   The licenses for most software are designed to take away your
 16 | freedom to share and change it.  By contrast, the GNU General Public
 17 | Licenses are intended to guarantee your freedom to share and change
 18 | free software--to make sure the software is free for all its users.
 19 | 
 20 |   This license, the Lesser General Public License, applies to some
 21 | specially designated software packages--typically libraries--of the
 22 | Free Software Foundation and other authors who decide to use it.  You
 23 | can use it too, but we suggest you first think carefully about whether
 24 | this license or the ordinary General Public License is the better
 25 | strategy to use in any particular case, based on the explanations below.
 26 | 
 27 |   When we speak of free software, we are referring to freedom of use,
 28 | not price.  Our General Public Licenses are designed to make sure that
 29 | you have the freedom to distribute copies of free software (and charge
 30 | for this service if you wish); that you receive source code or can get
 31 | it if you want it; that you can change the software and use pieces of
 32 | it in new free programs; and that you are informed that you can do
 33 | these things.
 34 | 
 35 |   To protect your rights, we need to make restrictions that forbid
 36 | distributors to deny you these rights or to ask you to surrender these
 37 | rights.  These restrictions translate to certain responsibilities for
 38 | you if you distribute copies of the library or if you modify it.
 39 | 
 40 |   For example, if you distribute copies of the library, whether gratis
 41 | or for a fee, you must give the recipients all the rights that we gave
 42 | you.  You must make sure that they, too, receive or can get the source
 43 | code.  If you link other code with the library, you must provide
 44 | complete object files to the recipients, so that they can relink them
 45 | with the library after making changes to the library and recompiling
 46 | it.  And you must show them these terms so they know their rights.
 47 | 
 48 |   We protect your rights with a two-step method: (1) we copyright the
 49 | library, and (2) we offer you this license, which gives you legal
 50 | permission to copy, distribute and/or modify the library.
 51 | 
 52 |   To protect each distributor, we want to make it very clear that
 53 | there is no warranty for the free library.  Also, if the library is
 54 | modified by someone else and passed on, the recipients should know
 55 | that what they have is not the original version, so that the original
 56 | author's reputation will not be affected by problems that might be
 57 | introduced by others.
 58 | 
 59 |   Finally, software patents pose a constant threat to the existence of
 60 | any free program.  We wish to make sure that a company cannot
 61 | effectively restrict the users of a free program by obtaining a
 62 | restrictive license from a patent holder.  Therefore, we insist that
 63 | any patent license obtained for a version of the library must be
 64 | consistent with the full freedom of use specified in this license.
 65 | 
 66 |   Most GNU software, including some libraries, is covered by the
 67 | ordinary GNU General Public License.  This license, the GNU Lesser
 68 | General Public License, applies to certain designated libraries, and
 69 | is quite different from the ordinary General Public License.  We use
 70 | this license for certain libraries in order to permit linking those
 71 | libraries into non-free programs.
 72 | 
 73 |   When a program is linked with a library, whether statically or using
 74 | a shared library, the combination of the two is legally speaking a
 75 | combined work, a derivative of the original library.  The ordinary
 76 | General Public License therefore permits such linking only if the
 77 | entire combination fits its criteria of freedom.  The Lesser General
 78 | Public License permits more lax criteria for linking other code with
 79 | the library.
 80 | 
 81 |   We call this license the "Lesser" General Public License because it
 82 | does Less to protect the user's freedom than the ordinary General
 83 | Public License.  It also provides other free software developers Less
 84 | of an advantage over competing non-free programs.  These disadvantages
 85 | are the reason we use the ordinary General Public License for many
 86 | libraries.  However, the Lesser license provides advantages in certain
 87 | special circumstances.
 88 | 
 89 |   For example, on rare occasions, there may be a special need to
 90 | encourage the widest possible use of a certain library, so that it becomes
 91 | a de-facto standard.  To achieve this, non-free programs must be
 92 | allowed to use the library.  A more frequent case is that a free
 93 | library does the same job as widely used non-free libraries.  In this
 94 | case, there is little to gain by limiting the free library to free
 95 | software only, so we use the Lesser General Public License.
 96 | 
 97 |   In other cases, permission to use a particular library in non-free
 98 | programs enables a greater number of people to use a large body of
 99 | free software.  For example, permission to use the GNU C Library in
100 | non-free programs enables many more people to use the whole GNU
101 | operating system, as well as its variant, the GNU/Linux operating
102 | system.
103 | 
104 |   Although the Lesser General Public License is Less protective of the
105 | users' freedom, it does ensure that the user of a program that is
106 | linked with the Library has the freedom and the wherewithal to run
107 | that program using a modified version of the Library.
108 | 
109 |   The precise terms and conditions for copying, distribution and
110 | modification follow.  Pay close attention to the difference between a
111 | "work based on the library" and a "work that uses the library".  The
112 | former contains code derived from the library, whereas the latter must
113 | be combined with the library in order to run.
114 | 
115 |                   GNU LESSER GENERAL PUBLIC LICENSE
116 |    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
117 | 
118 |   0. This License Agreement applies to any software library or other
119 | program which contains a notice placed by the copyright holder or
120 | other authorized party saying it may be distributed under the terms of
121 | this Lesser General Public License (also called "this License").
122 | Each licensee is addressed as "you".
123 | 
124 |   A "library" means a collection of software functions and/or data
125 | prepared so as to be conveniently linked with application programs
126 | (which use some of those functions and data) to form executables.
127 | 
128 |   The "Library", below, refers to any such software library or work
129 | which has been distributed under these terms.  A "work based on the
130 | Library" means either the Library or any derivative work under
131 | copyright law: that is to say, a work containing the Library or a
132 | portion of it, either verbatim or with modifications and/or translated
133 | straightforwardly into another language.  (Hereinafter, translation is
134 | included without limitation in the term "modification".)
135 | 
136 |   "Source code" for a work means the preferred form of the work for
137 | making modifications to it.  For a library, complete source code means
138 | all the source code for all modules it contains, plus any associated
139 | interface definition files, plus the scripts used to control compilation
140 | and installation of the library.
141 | 
142 |   Activities other than copying, distribution and modification are not
143 | covered by this License; they are outside its scope.  The act of
144 | running a program using the Library is not restricted, and output from
145 | such a program is covered only if its contents constitute a work based
146 | on the Library (independent of the use of the Library in a tool for
147 | writing it).  Whether that is true depends on what the Library does
148 | and what the program that uses the Library does.
149 | 
150 |   1. You may copy and distribute verbatim copies of the Library's
151 | complete source code as you receive it, in any medium, provided that
152 | you conspicuously and appropriately publish on each copy an
153 | appropriate copyright notice and disclaimer of warranty; keep intact
154 | all the notices that refer to this License and to the absence of any
155 | warranty; and distribute a copy of this License along with the
156 | Library.
157 | 
158 |   You may charge a fee for the physical act of transferring a copy,
159 | and you may at your option offer warranty protection in exchange for a
160 | fee.
161 | 
162 |   2. You may modify your copy or copies of the Library or any portion
163 | of it, thus forming a work based on the Library, and copy and
164 | distribute such modifications or work under the terms of Section 1
165 | above, provided that you also meet all of these conditions:
166 | 
167 |     a) The modified work must itself be a software library.
168 | 
169 |     b) You must cause the files modified to carry prominent notices
170 |     stating that you changed the files and the date of any change.
171 | 
172 |     c) You must cause the whole of the work to be licensed at no
173 |     charge to all third parties under the terms of this License.
174 | 
175 |     d) If a facility in the modified Library refers to a function or a
176 |     table of data to be supplied by an application program that uses
177 |     the facility, other than as an argument passed when the facility
178 |     is invoked, then you must make a good faith effort to ensure that,
179 |     in the event an application does not supply such function or
180 |     table, the facility still operates, and performs whatever part of
181 |     its purpose remains meaningful.
182 | 
183 |     (For example, a function in a library to compute square roots has
184 |     a purpose that is entirely well-defined independent of the
185 |     application.  Therefore, Subsection 2d requires that any
186 |     application-supplied function or table used by this function must
187 |     be optional: if the application does not supply it, the square
188 |     root function must still compute square roots.)
189 | 
190 | These requirements apply to the modified work as a whole.  If
191 | identifiable sections of that work are not derived from the Library,
192 | and can be reasonably considered independent and separate works in
193 | themselves, then this License, and its terms, do not apply to those
194 | sections when you distribute them as separate works.  But when you
195 | distribute the same sections as part of a whole which is a work based
196 | on the Library, the distribution of the whole must be on the terms of
197 | this License, whose permissions for other licensees extend to the
198 | entire whole, and thus to each and every part regardless of who wrote
199 | it.
200 | 
201 | Thus, it is not the intent of this section to claim rights or contest
202 | your rights to work written entirely by you; rather, the intent is to
203 | exercise the right to control the distribution of derivative or
204 | collective works based on the Library.
205 | 
206 | In addition, mere aggregation of another work not based on the Library
207 | with the Library (or with a work based on the Library) on a volume of
208 | a storage or distribution medium does not bring the other work under
209 | the scope of this License.
210 | 
211 |   3. You may opt to apply the terms of the ordinary GNU General Public
212 | License instead of this License to a given copy of the Library.  To do
213 | this, you must alter all the notices that refer to this License, so
214 | that they refer to the ordinary GNU General Public License, version 2,
215 | instead of to this License.  (If a newer version than version 2 of the
216 | ordinary GNU General Public License has appeared, then you can specify
217 | that version instead if you wish.)  Do not make any other change in
218 | these notices.
219 | 
220 |   Once this change is made in a given copy, it is irreversible for
221 | that copy, so the ordinary GNU General Public License applies to all
222 | subsequent copies and derivative works made from that copy.
223 | 
224 |   This option is useful when you wish to copy part of the code of
225 | the Library into a program that is not a library.
226 | 
227 |   4. You may copy and distribute the Library (or a portion or
228 | derivative of it, under Section 2) in object code or executable form
229 | under the terms of Sections 1 and 2 above provided that you accompany
230 | it with the complete corresponding machine-readable source code, which
231 | must be distributed under the terms of Sections 1 and 2 above on a
232 | medium customarily used for software interchange.
233 | 
234 |   If distribution of object code is made by offering access to copy
235 | from a designated place, then offering equivalent access to copy the
236 | source code from the same place satisfies the requirement to
237 | distribute the source code, even though third parties are not
238 | compelled to copy the source along with the object code.
239 | 
240 |   5. A program that contains no derivative of any portion of the
241 | Library, but is designed to work with the Library by being compiled or
242 | linked with it, is called a "work that uses the Library".  Such a
243 | work, in isolation, is not a derivative work of the Library, and
244 | therefore falls outside the scope of this License.
245 | 
246 |   However, linking a "work that uses the Library" with the Library
247 | creates an executable that is a derivative of the Library (because it
248 | contains portions of the Library), rather than a "work that uses the
249 | library".  The executable is therefore covered by this License.
250 | Section 6 states terms for distribution of such executables.
251 | 
252 |   When a "work that uses the Library" uses material from a header file
253 | that is part of the Library, the object code for the work may be a
254 | derivative work of the Library even though the source code is not.
255 | Whether this is true is especially significant if the work can be
256 | linked without the Library, or if the work is itself a library.  The
257 | threshold for this to be true is not precisely defined by law.
258 | 
259 |   If such an object file uses only numerical parameters, data
260 | structure layouts and accessors, and small macros and small inline
261 | functions (ten lines or less in length), then the use of the object
262 | file is unrestricted, regardless of whether it is legally a derivative
263 | work.  (Executables containing this object code plus portions of the
264 | Library will still fall under Section 6.)
265 | 
266 |   Otherwise, if the work is a derivative of the Library, you may
267 | distribute the object code for the work under the terms of Section 6.
268 | Any executables containing that work also fall under Section 6,
269 | whether or not they are linked directly with the Library itself.
270 | 
271 |   6. As an exception to the Sections above, you may also combine or
272 | link a "work that uses the Library" with the Library to produce a
273 | work containing portions of the Library, and distribute that work
274 | under terms of your choice, provided that the terms permit
275 | modification of the work for the customer's own use and reverse
276 | engineering for debugging such modifications.
277 | 
278 |   You must give prominent notice with each copy of the work that the
279 | Library is used in it and that the Library and its use are covered by
280 | this License.  You must supply a copy of this License.  If the work
281 | during execution displays copyright notices, you must include the
282 | copyright notice for the Library among them, as well as a reference
283 | directing the user to the copy of this License.  Also, you must do one
284 | of these things:
285 | 
286 |     a) Accompany the work with the complete corresponding
287 |     machine-readable source code for the Library including whatever
288 |     changes were used in the work (which must be distributed under
289 |     Sections 1 and 2 above); and, if the work is an executable linked
290 |     with the Library, with the complete machine-readable "work that
291 |     uses the Library", as object code and/or source code, so that the
292 |     user can modify the Library and then relink to produce a modified
293 |     executable containing the modified Library.  (It is understood
294 |     that the user who changes the contents of definitions files in the
295 |     Library will not necessarily be able to recompile the application
296 |     to use the modified definitions.)
297 | 
298 |     b) Use a suitable shared library mechanism for linking with the
299 |     Library.  A suitable mechanism is one that (1) uses at run time a
300 |     copy of the library already present on the user's computer system,
301 |     rather than copying library functions into the executable, and (2)
302 |     will operate properly with a modified version of the library, if
303 |     the user installs one, as long as the modified version is
304 |     interface-compatible with the version that the work was made with.
305 | 
306 |     c) Accompany the work with a written offer, valid for at
307 |     least three years, to give the same user the materials
308 |     specified in Subsection 6a, above, for a charge no more
309 |     than the cost of performing this distribution.
310 | 
311 |     d) If distribution of the work is made by offering access to copy
312 |     from a designated place, offer equivalent access to copy the above
313 |     specified materials from the same place.
314 | 
315 |     e) Verify that the user has already received a copy of these
316 |     materials or that you have already sent this user a copy.
317 | 
318 |   For an executable, the required form of the "work that uses the
319 | Library" must include any data and utility programs needed for
320 | reproducing the executable from it.  However, as a special exception,
321 | the materials to be distributed need not include anything that is
322 | normally distributed (in either source or binary form) with the major
323 | components (compiler, kernel, and so on) of the operating system on
324 | which the executable runs, unless that component itself accompanies
325 | the executable.
326 | 
327 |   It may happen that this requirement contradicts the license
328 | restrictions of other proprietary libraries that do not normally
329 | accompany the operating system.  Such a contradiction means you cannot
330 | use both them and the Library together in an executable that you
331 | distribute.
332 | 
333 |   7. You may place library facilities that are a work based on the
334 | Library side-by-side in a single library together with other library
335 | facilities not covered by this License, and distribute such a combined
336 | library, provided that the separate distribution of the work based on
337 | the Library and of the other library facilities is otherwise
338 | permitted, and provided that you do these two things:
339 | 
340 |     a) Accompany the combined library with a copy of the same work
341 |     based on the Library, uncombined with any other library
342 |     facilities.  This must be distributed under the terms of the
343 |     Sections above.
344 | 
345 |     b) Give prominent notice with the combined library of the fact
346 |     that part of it is a work based on the Library, and explaining
347 |     where to find the accompanying uncombined form of the same work.
348 | 
349 |   8. You may not copy, modify, sublicense, link with, or distribute
350 | the Library except as expressly provided under this License.  Any
351 | attempt otherwise to copy, modify, sublicense, link with, or
352 | distribute the Library is void, and will automatically terminate your
353 | rights under this License.  However, parties who have received copies,
354 | or rights, from you under this License will not have their licenses
355 | terminated so long as such parties remain in full compliance.
356 | 
357 |   9. You are not required to accept this License, since you have not
358 | signed it.  However, nothing else grants you permission to modify or
359 | distribute the Library or its derivative works.  These actions are
360 | prohibited by law if you do not accept this License.  Therefore, by
361 | modifying or distributing the Library (or any work based on the
362 | Library), you indicate your acceptance of this License to do so, and
363 | all its terms and conditions for copying, distributing or modifying
364 | the Library or works based on it.
365 | 
366 |   10. Each time you redistribute the Library (or any work based on the
367 | Library), the recipient automatically receives a license from the
368 | original licensor to copy, distribute, link with or modify the Library
369 | subject to these terms and conditions.  You may not impose any further
370 | restrictions on the recipients' exercise of the rights granted herein.
371 | You are not responsible for enforcing compliance by third parties with
372 | this License.
373 | 
374 |   11. If, as a consequence of a court judgment or allegation of patent
375 | infringement or for any other reason (not limited to patent issues),
376 | conditions are imposed on you (whether by court order, agreement or
377 | otherwise) that contradict the conditions of this License, they do not
378 | excuse you from the conditions of this License.  If you cannot
379 | distribute so as to satisfy simultaneously your obligations under this
380 | License and any other pertinent obligations, then as a consequence you
381 | may not distribute the Library at all.  For example, if a patent
382 | license would not permit royalty-free redistribution of the Library by
383 | all those who receive copies directly or indirectly through you, then
384 | the only way you could satisfy both it and this License would be to
385 | refrain entirely from distribution of the Library.
386 | 
387 | If any portion of this section is held invalid or unenforceable under any
388 | particular circumstance, the balance of the section is intended to apply,
389 | and the section as a whole is intended to apply in other circumstances.
390 | 
391 | It is not the purpose of this section to induce you to infringe any
392 | patents or other property right claims or to contest validity of any
393 | such claims; this section has the sole purpose of protecting the
394 | integrity of the free software distribution system which is
395 | implemented by public license practices.  Many people have made
396 | generous contributions to the wide range of software distributed
397 | through that system in reliance on consistent application of that
398 | system; it is up to the author/donor to decide if he or she is willing
399 | to distribute software through any other system and a licensee cannot
400 | impose that choice.
401 | 
402 | This section is intended to make thoroughly clear what is believed to
403 | be a consequence of the rest of this License.
404 | 
405 |   12. If the distribution and/or use of the Library is restricted in
406 | certain countries either by patents or by copyrighted interfaces, the
407 | original copyright holder who places the Library under this License may add
408 | an explicit geographical distribution limitation excluding those countries,
409 | so that distribution is permitted only in or among countries not thus
410 | excluded.  In such case, this License incorporates the limitation as if
411 | written in the body of this License.
412 | 
413 |   13. The Free Software Foundation may publish revised and/or new
414 | versions of the Lesser General Public License from time to time.
415 | Such new versions will be similar in spirit to the present version,
416 | but may differ in detail to address new problems or concerns.
417 | 
418 | Each version is given a distinguishing version number.  If the Library
419 | specifies a version number of this License which applies to it and
420 | "any later version", you have the option of following the terms and
421 | conditions either of that version or of any later version published by
422 | the Free Software Foundation.  If the Library does not specify a
423 | license version number, you may choose any version ever published by
424 | the Free Software Foundation.
425 | 
426 |   14. If you wish to incorporate parts of the Library into other free
427 | programs whose distribution conditions are incompatible with these,
428 | write to the author to ask for permission.  For software which is
429 | copyrighted by the Free Software Foundation, write to the Free
430 | Software Foundation; we sometimes make exceptions for this.  Our
431 | decision will be guided by the two goals of preserving the free status
432 | of all derivatives of our free software and of promoting the sharing
433 | and reuse of software generally.
434 | 
435 |                             NO WARRANTY
436 | 
437 |   15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
443 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
444 | LIBRARY IS WITH YOU.  SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
446 | 
447 |   16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
456 | DAMAGES.
457 | 
458 |                      END OF TERMS AND CONDITIONS
459 | 
460 |            How to Apply These Terms to Your New Libraries
461 | 
462 |   If you develop a new library, and you want it to be of the greatest
463 | possible use to the public, we recommend making it free software that
464 | everyone can redistribute and change.  You can do so by permitting
465 | redistribution under these terms (or, alternatively, under the terms of the
466 | ordinary General Public License).
467 | 
468 |   To apply these terms, attach the following notices to the library.  It is
469 | safest to attach them to the start of each source file to most effectively
470 | convey the exclusion of warranty; and each file should have at least the
471 | "copyright" line and a pointer to where the full notice is found.
472 | 
473 |     <one line to give the library's name and a brief idea of what it does.>
474 |     Copyright (C) <year>  <name of author>
475 | 
476 |     This library is free software; you can redistribute it and/or
477 |     modify it under the terms of the GNU Lesser General Public
478 |     License as published by the Free Software Foundation; either
479 |     version 2.1 of the License, or (at your option) any later version.
480 | 
481 |     This library is distributed in the hope that it will be useful,
482 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
483 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
484 |     Lesser General Public License for more details.
485 | 
486 |     You should have received a copy of the GNU Lesser General Public
487 |     License along with this library; if not, write to the Free Software
488 |     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
489 |     USA
490 | 
491 | Also add information on how to contact you by electronic and paper mail.
492 | 
493 | You should also get your employer (if you work as a programmer) or your
494 | school, if any, to sign a "copyright disclaimer" for the library, if
495 | necessary.  Here is a sample; alter the names:
496 | 
497 |   Yoyodyne, Inc., hereby disclaims all copyright interest in the
498 |   library `Frob' (a library for tweaking knobs) written by James Random
499 |   Hacker.
500 | 
501 |   <signature of Ty Coon>, 1 April 1990
502 |   Ty Coon, President of Vice
503 | 
504 | That's all there is to it!
505 | 


--------------------------------------------------------------------------------