53898b05ea0f5ccef6e9bfe7a1a71c36973b0533
[labortage2013badge.git] / firmware / main.c
1 /* Name: main.c
2  * Project: hid-custom-rq example
3  * Author: Christian Starkjohann
4  * Creation Date: 2008-04-07
5  * Tabsize: 4
6  * Copyright: (c) 2008 by OBJECTIVE DEVELOPMENT Software GmbH
7  * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt)
8  * This Revision: $Id: main.c 692 2008-11-07 15:07:40Z cs $
9  */
10
11 /*
12 This example should run on most AVRs with only little changes. No special
13 hardware resources except INT0 are used. You may have to change usbconfig.h for
14 different I/O pins for USB. Please note that USB D+ must be the INT0 pin, or
15 at least be connected to INT0 as well.
16 We assume that an LED is connected to port B bit 0. If you connect it to a
17 different port or bit, change the macros below:
18 */
19 #define LED_PORT_DDR        DDRB
20 #define LED_PORT_OUTPUT     PORTB
21 #define R_BIT            4
22 #define G_BIT            3
23 #define B_BIT            1
24 #define BUTTON_PIN 4
25
26 #include <stdint.h>
27 #include <string.h>
28 #include <stdbool.h>
29
30 #include <avr/io.h>
31 #include <avr/wdt.h>
32 #include <avr/eeprom.h>
33 #include <avr/interrupt.h>  /* for sei() */
34 #include <util/delay.h>     /* for _delay_ms() */
35
36 #include <avr/pgmspace.h>   /* required by usbdrv.h */
37 #include "usbdrv.h"
38 #include "oddebug.h"        /* This is also an example for using debug macros */
39 #include "requests.h"       /* The custom request numbers we use */
40 #include "special_functions.h"
41 #include "hotp.h"
42 #include "percnt2.h"
43
44 /* ------------------------------------------------------------------------- */
45 /* ----------------------------- USB interface ----------------------------- */
46 /* ------------------------------------------------------------------------- */
47 PROGMEM const char usbHidReportDescriptor[USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH] = {
48     0x05, 0x01,                    // USAGE_PAGE (Generic Desktop)
49     0x09, 0x06,                    // USAGE (Keyboard)
50     0xa1, 0x01,                    // COLLECTION (Application)
51     0x75, 0x01,                    //   REPORT_SIZE (1)
52     0x95, 0x08,                    //   REPORT_COUNT (8)
53     0x05, 0x07,                    //   USAGE_PAGE (Keyboard)(Key Codes)
54     0x19, 0xe0,                    //   USAGE_MINIMUM (Keyboard LeftControl)(224)
55     0x29, 0xe7,                    //   USAGE_MAXIMUM (Keyboard Right GUI)(231)
56     0x15, 0x00,                    //   LOGICAL_MINIMUM (0)
57     0x25, 0x01,                    //   LOGICAL_MAXIMUM (1)
58     0x81, 0x02,                    //   INPUT (Data,Var,Abs) ; Modifier byte
59     0x95, 0x01,                    //   REPORT_COUNT (1)
60     0x75, 0x08,                    //   REPORT_SIZE (8)
61     0x81, 0x03,                    //   INPUT (Cnst,Var,Abs) ; Reserved byte
62     0x95, 0x05,                    //   REPORT_COUNT (5)
63     0x75, 0x01,                    //   REPORT_SIZE (1)
64     0x05, 0x08,                    //   USAGE_PAGE (LEDs)
65     0x19, 0x01,                    //   USAGE_MINIMUM (Num Lock)
66     0x29, 0x05,                    //   USAGE_MAXIMUM (Kana)
67     0x91, 0x02,                    //   OUTPUT (Data,Var,Abs) ; LED report
68     0x95, 0x01,                    //   REPORT_COUNT (1)
69     0x75, 0x03,                    //   REPORT_SIZE (3)
70     0x91, 0x03,                    //   OUTPUT (Cnst,Var,Abs) ; LED report padding
71     0x95, 0x06,                    //   REPORT_COUNT (6)
72     0x75, 0x08,                    //   REPORT_SIZE (8)
73     0x15, 0x00,                    //   LOGICAL_MINIMUM (0)
74     0x25, 0x65,                    //   LOGICAL_MAXIMUM (101)
75     0x05, 0x07,                    //   USAGE_PAGE (Keyboard)(Key Codes)
76     0x19, 0x00,                    //   USAGE_MINIMUM (Reserved (no event indicated))(0)
77     0x29, 0x65,                    //   USAGE_MAXIMUM (Keyboard Application)(101)
78     0x81, 0x00,                    //   INPUT (Data,Ary,Abs)
79     0xc0                           // END_COLLECTION
80 };
81
82 uint16_t secret_length_ee EEMEM = 0;
83 uint8_t  secret_ee[32] EEMEM;
84 uint8_t  reset_counter_ee EEMEM = 0;
85 uint8_t  digits_ee EEMEM = 8;
86
87 /* Keyboard usage values, see usb.org's HID-usage-tables document, chapter
88  * 10 Keyboard/Keypad Page for more codes.
89  */
90 #define MOD_CONTROL_LEFT    (1<<0)
91 #define MOD_SHIFT_LEFT      (1<<1)
92 #define MOD_ALT_LEFT        (1<<2)
93 #define MOD_GUI_LEFT        (1<<3)
94 #define MOD_CONTROL_RIGHT   (1<<4)
95 #define MOD_SHIFT_RIGHT     (1<<5)
96 #define MOD_ALT_RIGHT       (1<<6)
97 #define MOD_GUI_RIGHT       (1<<7)
98
99 #define KEY_A       4
100 #define KEY_B       5
101 #define KEY_C       6
102 #define KEY_D       7
103 #define KEY_E       8
104 #define KEY_F       9
105 #define KEY_G       10
106 #define KEY_H       11
107 #define KEY_I       12
108 #define KEY_J       13
109 #define KEY_K       14
110 #define KEY_L       15
111 #define KEY_M       16
112 #define KEY_N       17
113 #define KEY_O       18
114 #define KEY_P       19
115 #define KEY_Q       20
116 #define KEY_R       21
117 #define KEY_S       22
118 #define KEY_T       23
119 #define KEY_U       24
120 #define KEY_V       25
121 #define KEY_W       26
122 #define KEY_X       27
123 #define KEY_Y       28
124 #define KEY_Z       29
125 #define KEY_1       30
126 #define KEY_2       31
127 #define KEY_3       32
128 #define KEY_4       33
129 #define KEY_5       34
130 #define KEY_6       35
131 #define KEY_7       36
132 #define KEY_8       37
133 #define KEY_9       38
134 #define KEY_0       39
135
136 #define KEY_F1      58
137 #define KEY_F2      59
138 #define KEY_F3      60
139 #define KEY_F4      61
140 #define KEY_F5      62
141 #define KEY_F6      63
142 #define KEY_F7      64
143 #define KEY_F8      65
144 #define KEY_F9      66
145 #define KEY_F10     67
146 #define KEY_F11     68
147 #define KEY_F12     69
148
149 #define NUM_LOCK 1
150 #define CAPS_LOCK 2
151 #define SCROLL_LOCK 4
152
153 static uint8_t dbg_buffer[8];
154
155 static uint8_t secret[32];
156 static uint16_t secret_length_b;
157 static char token[10];
158
159
160 #define UNI_BUFFER_SIZE 36
161
162 static union {
163         uint8_t  w8[UNI_BUFFER_SIZE];
164         uint16_t w16[UNI_BUFFER_SIZE/2];
165         uint32_t w32[UNI_BUFFER_SIZE/4];
166         void*    ptr[UNI_BUFFER_SIZE/sizeof(void*)];
167 } uni_buffer;
168
169 static uint8_t uni_buffer_fill;
170 static uint8_t current_command;
171
172 typedef struct {
173     uint8_t modifier;
174     uint8_t reserved;
175     uint8_t keycode[6];
176 } keyboard_report_t;
177
178 #define STATE_WAIT 0
179 #define STATE_SEND_KEY 1
180 #define STATE_RELEASE_KEY 2
181 #define STATE_NEXT 3
182
183
184 static keyboard_report_t keyboard_report; // sent to PC
185 static uchar idleRate;           /* in 4 ms units */
186 static uchar key_state = STATE_WAIT;
187 volatile static uchar LED_state = 0xff; // received from PC
188 /* ------------------------------------------------------------------------- */
189
190 void memory_clean(void) {
191     memset(secret, 0, 32);
192     secret_length_b = 0;
193 }
194
195 uint8_t secret_set(void){
196     uint8_t r;
197     union {
198         uint8_t w8[32];
199         uint16_t w16[16];
200     } read_back;
201     const uint8_t length_B = (secret_length_b + 7) / 8;
202
203     eeprom_busy_wait();
204     eeprom_write_block(secret, secret_ee, length_B);
205     eeprom_busy_wait();
206     eeprom_read_block(read_back.w8, secret_ee, length_B);
207     r = memcmp(secret, read_back.w8, length_B);
208     memory_clean();
209     memset(read_back.w8, 0, 32);
210     if (r) {
211         return 1;
212     }
213     eeprom_busy_wait();
214     eeprom_write_word(&secret_length_ee, secret_length_b);
215     eeprom_busy_wait();
216     r = eeprom_read_word(&secret_length_ee) == secret_length_b;
217     memory_clean();
218     *read_back.w16 = 0;
219     if (!r) {
220         return 1;
221     }
222     return 0;
223 }
224
225 void token_generate(void) {
226     percnt_inc(0);
227     eeprom_busy_wait();
228     eeprom_read_block(secret, secret_ee, 32);
229     eeprom_busy_wait();
230     hotp(token, secret, eeprom_read_word(&secret_length_ee), percnt_get(0), eeprom_read_byte(&digits_ee));
231     memory_clean();
232 }
233
234 void counter_reset(void) {
235     uint8_t reset_counter;
236     eeprom_busy_wait();
237     reset_counter = eeprom_read_byte(&reset_counter_ee);
238     percnt_reset(0);
239     eeprom_busy_wait();
240     eeprom_write_byte(&reset_counter_ee, reset_counter + 1);
241 }
242
243 void counter_init(void) {
244     eeprom_busy_wait();
245     if (eeprom_read_byte(&reset_counter_ee) == 0) {
246         counter_reset();
247     }
248     percnt_init(0);
249 }
250
251 void buildReport(uchar send_key) {
252     keyboard_report.modifier = 0;
253
254     switch (send_key) {
255     case 'A' ... 'Z':
256         keyboard_report.modifier = MOD_SHIFT_LEFT;
257         keyboard_report.keycode[0] = KEY_A + (send_key-'A');
258         break;
259     case 'a' ... 'z':
260         keyboard_report.keycode[0] = KEY_A + (send_key-'a');
261         break;
262     case '1' ... '9':
263         keyboard_report.keycode[0] = KEY_1 + (send_key-'1');
264         break;
265     case '0':
266         keyboard_report.keycode[0] = KEY_0;
267         break;
268     default:
269         keyboard_report.keycode[0] = 0;
270     }
271 }
272
273 static inline
274 int8_t button_get_debounced(uint8_t debounce_count) {
275     uint8_t v;
276     v = PINB & _BV(BUTTON_PIN);
277     while (debounce_count-- && v == (PINB & _BV(BUTTON_PIN))) {
278         ;
279     }
280     if (debounce_count) {
281         return -1;
282     }
283     return v ? 0 : 1;
284 }
285
286 void init_temperature_sensor(void){
287         ADMUX = 0x8F;
288         ADCSRA = 0x87;
289 }
290
291 uint16_t read_temperture_sensor(void){
292         ADCSRA |= 0x40;
293         while(ADCSRA & 0x40)
294                 ;
295         return ADC;
296 }
297
298 usbMsgLen_t usbFunctionSetup(uchar data[8])
299 {
300         usbRequest_t    *rq = (usbRequest_t *)data;
301         if ((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_CLASS) {    /* class request type */
302             switch(rq->bRequest) {
303         case USBRQ_HID_GET_REPORT: // send "no keys pressed" if asked here
304             // wValue: ReportType (highbyte), ReportID (lowbyte)
305             usbMsgPtr = (void *)&keyboard_report; // we only have this one
306             keyboard_report.modifier = 0;
307             keyboard_report.keycode[0] = 0;
308             return sizeof(keyboard_report);
309         case USBRQ_HID_SET_REPORT: // if wLength == 1, should be LED state
310             if (rq->wLength.word == 1) {
311                 current_command = LED_WRITE;
312                 return USB_NO_MSG;
313             }
314             return 0;
315         case USBRQ_HID_GET_IDLE: // send idle rate to PC as required by spec
316             usbMsgPtr = &idleRate;
317             return 1;
318         case USBRQ_HID_SET_IDLE: // save idle rate as required by spec
319             idleRate = rq->wValue.bytes[1];
320             return 0;
321         }
322     }
323     if ((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_VENDOR) {
324                 current_command = rq->bRequest;
325         switch(rq->bRequest)
326                 {
327         case CUSTOM_RQ_SET_SECRET:
328             secret_length_b = rq->wValue.word;
329             if (secret_length_b > 256) {
330                 secret_length_b = 256;
331             }
332             uni_buffer.w8[0] = 0;
333             return USB_NO_MSG;
334         case CUSTOM_RQ_INC_COUNTER:
335             percnt_inc(0);
336             return 0;
337         case CUSTOM_RQ_GET_COUNTER:
338             uni_buffer.w32[0] = percnt_get(0);
339             usbMsgPtr = (usbMsgPtr_t)uni_buffer.w32;
340             return 4;
341         case CUSTOM_RQ_RESET_COUNTER:
342             counter_reset();
343             return 0;
344         case CUSTOM_RQ_GET_RESET_COUNTER:
345             eeprom_busy_wait();
346             uni_buffer.w8[0] = eeprom_read_byte(&reset_counter_ee);
347             usbMsgPtr = uni_buffer.w8;
348             return 1;
349         case CUSTOM_RQ_SET_DIGITS:
350             if (rq->wValue.bytes[0] > 9) {
351                 rq->wValue.bytes[0] = 9;
352             }
353             eeprom_busy_wait();
354             eeprom_write_byte(&digits_ee, rq->wValue.bytes[0]);
355             return 0;
356         case CUSTOM_RQ_GET_DIGITS:
357             eeprom_busy_wait();
358             uni_buffer.w8[0] = eeprom_read_byte(&digits_ee);
359             usbMsgPtr = uni_buffer.w8;
360             return 1;
361         case CUSTOM_RQ_GET_TOKEN:
362             token_generate();
363             usbMsgPtr = (usbMsgPtr_t)token;
364             return strlen(token);
365
366         case CUSTOM_RQ_PRESS_BUTTON:
367             key_state = STATE_SEND_KEY;
368             return 0;
369         case CUSTOM_RQ_CLR_DBG:
370             memset(dbg_buffer, 0, sizeof(dbg_buffer));
371             return 0;
372                 case CUSTOM_RQ_SET_DBG:
373                         return USB_NO_MSG;
374                 case CUSTOM_RQ_GET_DBG:{
375                         usbMsgLen_t len = 8;
376                         if(len > rq->wLength.word){
377                                 len = rq->wLength.word;
378                         }
379                         usbMsgPtr = dbg_buffer;
380                         return len;
381                 }
382                 case CUSTOM_RQ_READ_MEM:
383                         usbMsgPtr = (uchar*)rq->wValue.word;
384                         return rq->wLength.word;
385                 case CUSTOM_RQ_WRITE_MEM:
386                 case CUSTOM_RQ_EXEC_SPM:
387 /*                      uni_buffer_fill = 4;
388                         uni_buffer.w16[0] = rq->wValue.word;
389                         uni_buffer.w16[1] = rq->wLength.word;
390                         return USB_NO_MSG;
391 */              case CUSTOM_RQ_READ_FLASH:
392                         uni_buffer.w16[0] = rq->wValue.word;
393                         uni_buffer.w16[1] = rq->wLength.word;
394             uni_buffer_fill = 4;
395                         return USB_NO_MSG;
396                 case CUSTOM_RQ_RESET:
397                         soft_reset((uint8_t)(rq->wValue.word));
398                         break;
399                 case CUSTOM_RQ_READ_BUTTON:
400                         uni_buffer.w8[0] = button_get_debounced(25);
401                         usbMsgPtr = uni_buffer.w8;
402                         return 1;
403                 case CUSTOM_RQ_READ_TMPSENS:
404                         uni_buffer.w16[0] = read_temperture_sensor();
405                         usbMsgPtr = uni_buffer.w8;
406                         return 2;
407                 }
408     }
409
410     return 0;   /* default for not implemented requests: return no data back to host */
411 }
412
413
414 uchar usbFunctionWrite(uchar *data, uchar len)
415 {
416         switch(current_command){
417
418         case LED_WRITE:
419             if (data[0] != LED_state)
420                 LED_state = data[0];
421             return 1; // Data read, not expecting more
422         case CUSTOM_RQ_SET_SECRET:
423         {
424             if (uni_buffer.w8[0] < (secret_length_b + 7) / 8) {
425                 memcpy(&secret[uni_buffer.w8[0]], data, len);
426                 uni_buffer.w8[0] += len;
427             }
428             if (uni_buffer.w8[0] >= (secret_length_b + 7) / 8) {
429                 secret_set();
430                 return 1;
431             }
432             return 0;
433         }
434         case CUSTOM_RQ_SET_DBG:
435                 if(len > sizeof(dbg_buffer)){
436                         len = sizeof(dbg_buffer);
437                 }
438                 memcpy(dbg_buffer, data, len);
439                 return 1;
440         case CUSTOM_RQ_WRITE_MEM:
441                 memcpy(uni_buffer.ptr[0], data, len);
442                 uni_buffer.w16[0] += len;
443                 return !(uni_buffer.w16[1] -= len);
444         case CUSTOM_RQ_EXEC_SPM:
445                 if(uni_buffer_fill < 8){
446                         uint8_t l = 8 - uni_buffer_fill;
447                         if(len<l){
448                                 len = l;
449                         }
450                         memcpy(&(uni_buffer.w8[uni_buffer_fill]), data, len);
451                         uni_buffer_fill += len;
452                         return 0;
453                 }
454                 uni_buffer.w16[1] -= len;
455                 if (uni_buffer.w16[1] > 8) {
456                         memcpy(uni_buffer.ptr[0], data, len);
457                         uni_buffer.w16[0] += len;
458                         return 0;
459                 } else {
460                         memcpy(&(uni_buffer.w8[uni_buffer_fill]), data, len);
461                         exec_spm(uni_buffer.w16[2], uni_buffer.w16[3], uni_buffer.ptr[0], data, len);
462                         return 1;
463                 }
464         default:
465                 return 1;
466         }
467         return 0;
468 }
469 uchar usbFunctionRead(uchar *data, uchar len){
470         uchar ret = len;
471         switch(current_command){
472         case CUSTOM_RQ_READ_FLASH:
473                 while(len--){
474                         *data++ = pgm_read_byte((uni_buffer.w16[0])++);
475                 }
476                 return ret;
477         default:
478                 break;
479         }
480         return 0;
481 }
482
483 static void calibrateOscillator(void)
484 {
485 uchar       step = 128;
486 uchar       trialValue = 0, optimumValue;
487 int         x, optimumDev, targetValue = (unsigned)(1499 * (double)F_CPU / 10.5e6 + 0.5);
488  
489     /* do a binary search: */
490     do {
491         OSCCAL = trialValue + step;
492         x = usbMeasureFrameLength();    // proportional to current real frequency
493         if(x < targetValue)             // frequency still too low
494             trialValue += step;
495         step >>= 1;
496     } while(step > 0);
497     /* We have a precision of +/- 1 for optimum OSCCAL here */
498     /* now do a neighborhood search for optimum value */
499     optimumValue = trialValue;
500     optimumDev = x; // this is certainly far away from optimum
501     for (OSCCAL = trialValue - 1; OSCCAL <= trialValue + 1; OSCCAL++){
502         x = usbMeasureFrameLength() - targetValue;
503         if (x < 0)
504             x = -x;
505         if (x < optimumDev) {
506             optimumDev = x;
507             optimumValue = OSCCAL;
508         }
509     }
510     OSCCAL = optimumValue;
511 }
512  
513
514 void usbEventResetReady(void)
515 {
516     cli();  // usbMeasureFrameLength() counts CPU cycles, so disable interrupts.
517     calibrateOscillator();
518     sei();
519 // we never read the value from eeprom so this causes only degradation of eeprom
520 //    eeprom_write_byte(0, OSCCAL);   // store the calibrated value in EEPROM
521 }
522
523 /* ------------------------------------------------------------------------- */
524
525 int main(void)
526 {
527         size_t idx = 0;
528         int8_t i = 0, last_stable_button_state = 0;
529
530     wdt_enable(WDTO_1S);
531     /* Even if you don't use the watchdog, turn it off here. On newer devices,
532      * the status of the watchdog (on/off, period) is PRESERVED OVER RESET!
533      */
534     /* RESET status: all port bits are inputs without pull-up.
535      * That's the way we need D+ and D-. Therefore we don't need any
536      * additional hardware initialization.
537      */
538
539     DDRB &= ~_BV(BUTTON_PIN); /* make button pin input */
540     PORTB |= _BV(BUTTON_PIN); /* turn on pull-up resistor */
541     init_temperature_sensor();
542     usbInit();
543     usbDeviceDisconnect();  /* enforce re-enumeration, do this while interrupts are disabled! */
544     while(--i){             /* fake USB disconnect for ~512 ms */
545         wdt_reset();
546         _delay_ms(2);
547     }
548     usbDeviceConnect();
549         
550     sei();
551
552     for(;;){                /* main event loop */
553         wdt_reset();
554         usbPoll();
555
556         i = button_get_debounced(25);
557         if (i != -1) {
558             if (last_stable_button_state == 0 && i == 1) {
559                 key_state = STATE_SEND_KEY;
560             }
561             last_stable_button_state = i;
562         }
563
564         if(usbInterruptIsReady() && key_state != STATE_WAIT){
565             switch(key_state) {
566             case STATE_SEND_KEY:
567                 buildReport(token[idx]);
568                 key_state = STATE_RELEASE_KEY; // release next
569                 break;
570             case STATE_RELEASE_KEY:
571                 buildReport(0);
572                 ++idx;
573                 if (token[idx] == '\0') {
574                     idx = 0;
575                     key_state = STATE_WAIT;
576                 } else {
577                     key_state = STATE_SEND_KEY;
578                 }
579                 break;
580             default:
581                 key_state = STATE_WAIT; // should not happen
582             }
583                         // start sending
584             usbSetInterrupt((void *)&keyboard_report, sizeof(keyboard_report));
585
586         }
587
588     }
589     return 0;
590 }
591
592 /* ------------------------------------------------------------------------- */