2 * Project: labortage-2013-badge
3 * Author: bg (bg@das-labor.org)
4 * Creation Date: 2013-10-16
6 * Copyright: (c) 2008 by OBJECTIVE DEVELOPMENT Software GmbH, (c) Daniel Otte
8 * This Revision: $Id: main.c 692 2008-11-07 15:07:40Z cs $
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.
19 #define DEBOUNCE_DELAY 50
20 #define SIMPLE_COUNTER 1
22 #define ALLOW_SECRET_READ 0
30 #include <avr/eeprom.h>
31 #include <avr/interrupt.h> /* for sei() */
32 #include <util/delay.h> /* for _delay_ms() */
34 #include <avr/pgmspace.h> /* required by usbdrv.h */
36 #include "requests.h" /* The custom request numbers we use */
38 #include "special_functions.h"
42 #include "usb_keyboard_codes.h"
44 /* ------------------------------------------------------------------------- */
45 /* ----------------------------- USB interface ----------------------------- */
46 /* ------------------------------------------------------------------------- */
49 #define STATE_SEND_KEY 1
50 #define STATE_RELEASE_KEY 2
53 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
55 PROGMEM const char usbHidReportDescriptor[USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH] = {
56 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */
57 0x09, 0x06, /* USAGE (Keyboard) */
58 0xa1, 0x01, /* COLLECTION (Application) */
59 0x75, 0x01, /* REPORT_SIZE (1) */
60 0x95, 0x08, /* REPORT_COUNT (8) */
61 0x05, 0x07, /* USAGE_PAGE (Keyboard)(Key Codes) */
62 0x19, 0xe0, /* USAGE_MINIMUM (Keyboard LeftControl)(224) */
63 0x29, 0xe7, /* USAGE_MAXIMUM (Keyboard Right GUI)(231) */
64 0x15, 0x00, /* LOGICAL_MINIMUM (0) */
65 0x25, 0x01, /* LOGICAL_MAXIMUM (1) */
66 0x81, 0x02, /* INPUT (Data,Var,Abs) ; Modifier byte */
67 0x95, 0x01, /* REPORT_COUNT (1) */
68 0x75, 0x08, /* REPORT_SIZE (8) */
69 0x81, 0x03, /* INPUT (Cnst,Var,Abs) ; Reserved byte */
70 0x95, 0x05, /* REPORT_COUNT (5) */
71 0x75, 0x01, /* REPORT_SIZE (1) */
72 0x05, 0x08, /* USAGE_PAGE (LEDs) */
73 0x19, 0x01, /* USAGE_MINIMUM (Num Lock) */
74 0x29, 0x05, /* USAGE_MAXIMUM (Kana) */
75 0x91, 0x02, /* OUTPUT (Data,Var,Abs) ; LED report */
76 0x95, 0x01, /* REPORT_COUNT (1) */
77 0x75, 0x03, /* REPORT_SIZE (3) */
78 0x91, 0x03, /* OUTPUT (Cnst,Var,Abs) ; LED report padding */
79 0x95, 0x06, /* REPORT_COUNT (6) */
80 0x75, 0x08, /* REPORT_SIZE (8) */
81 0x15, 0x00, /* LOGICAL_MINIMUM (0) */
82 0x25, 0x65, /* LOGICAL_MAXIMUM (101) */
83 0x05, 0x07, /* USAGE_PAGE (Keyboard)(Key Codes) */
84 0x19, 0x00, /* USAGE_MINIMUM (Reserved (no event indicated))(0) */
85 0x29, 0x65, /* USAGE_MAXIMUM (Keyboard Application)(101) */
86 0x81, 0x00, /* INPUT (Data,Ary,Abs) */
87 0xc0 /* END_COLLECTION */
90 static uint16_t secret_length_ee EEMEM = 0;
91 static uint8_t secret_ee[32] EEMEM;
92 static uint8_t reset_counter_ee EEMEM = 0;
93 static uint8_t digits_ee EEMEM = 8;
96 static uint32_t counter_ee EEMEM = 0;
99 static uint8_t dbg_buffer[8];
100 static uint8_t secret[32];
101 static uint16_t secret_length_b;
102 static char token[10];
104 #define UNI_BUFFER_SIZE 16
106 static union __attribute__((packed)) {
107 uint8_t w8[UNI_BUFFER_SIZE];
108 uint16_t w16[UNI_BUFFER_SIZE/2];
109 uint32_t w32[UNI_BUFFER_SIZE/4];
110 void* ptr[UNI_BUFFER_SIZE/sizeof(void*)];
113 static uint8_t current_command;
115 typedef struct __attribute__((packed)) {
121 static keyboard_report_t keyboard_report; /* report sent to the host */
122 static uchar idleRate; /* in 4 ms units */
123 static uchar key_state = STATE_WAIT;
124 volatile static uchar LED_state = 0xff;
125 /* ------------------------------------------------------------------------- */
128 void memory_clean(void) {
129 memset(secret, 0, 32);
134 uint8_t secret_set(void){
142 const uint8_t length_B = (secret_length_b + 7) / 8;
145 eeprom_write_block(secret, secret_ee, length_B);
148 eeprom_read_block(read_back.w8, secret_ee, length_B);
149 r = memcmp(secret, read_back.w8, length_B);
151 memset(read_back.w8, 0, 32);
157 eeprom_write_word(&secret_length_ee, secret_length_b);
160 r = eeprom_read_word(&secret_length_ee) == secret_length_b;
174 void counter_inc(void){
178 t = eeprom_read_dword(&counter_ee);
180 eeprom_write_dword(&counter_ee, t + 1);
187 void counter_reset(void) {
188 uint8_t reset_counter;
190 reset_counter = eeprom_read_byte(&reset_counter_ee);
193 eeprom_write_dword(&counter_ee, 0);
198 eeprom_write_byte(&reset_counter_ee, reset_counter + 1);
202 void counter_init(void) {
205 if (eeprom_read_byte(&reset_counter_ee) == 0) {
213 void token_generate(void) {
218 eeprom_read_block(secret, secret_ee, 32);
220 s_length_b = eeprom_read_word(&secret_length_ee);
221 if (s_length_b > 256) {
225 digits = eeprom_read_byte(&digits_ee);
228 hotp(token, secret, s_length_b, eeprom_read_dword(&counter_ee) - 1, digits);
230 hotp(token, secret, s_length_b, percnt_get(0) - 1, digits);
237 void buildReport(uchar send_key) {
238 keyboard_report.modifier = 0;
241 keyboard_report.keycode[0] = KEY_1 + (send_key-'1');
244 keyboard_report.keycode[0] = KEY_0;
247 keyboard_report.keycode[0] = 0;
252 int8_t button_get_debounced(volatile int8_t debounce_count) {
254 v = PINB & _BV(BUTTON_PIN);
255 while (debounce_count-- && (v == (PINB & _BV(BUTTON_PIN)))) {
258 if (debounce_count != -1) {
264 usbMsgLen_t usbFunctionSetup(uchar data[8])
266 usbRequest_t *rq = (usbRequest_t *)data;
267 if ((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_CLASS) { /* class request type */
268 switch(rq->bRequest) {
269 case USBRQ_HID_GET_REPORT: /* send "no keys pressed" if asked here */
270 /* wValue: ReportType (highbyte), ReportID (lowbyte) */
271 usbMsgPtr = (void *)&keyboard_report; /* we only have this one */
272 keyboard_report.modifier = 0;
273 keyboard_report.keycode[0] = 0;
274 return sizeof(keyboard_report);
275 case USBRQ_HID_SET_REPORT: /* if wLength == 1, should be LED state */
276 if (rq->wLength.word == 1) {
277 current_command = LED_WRITE;
281 case USBRQ_HID_GET_IDLE: /* send idle rate to PC as required by spec */
282 usbMsgPtr = &idleRate;
284 case USBRQ_HID_SET_IDLE: /* save idle rate as required by spec */
285 idleRate = rq->wValue.bytes[1];
289 if ((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_VENDOR) {
290 current_command = rq->bRequest;
291 usbMsgPtr = uni_buffer.w8;
294 case CUSTOM_RQ_SET_SECRET:
295 secret_length_b = rq->wValue.word;
296 if (secret_length_b > 256) {
297 secret_length_b = 256;
299 uni_buffer.w8[0] = 0;
301 case CUSTOM_RQ_INC_COUNTER:
304 case CUSTOM_RQ_GET_COUNTER:
307 uni_buffer.w32[0] = eeprom_read_dword(&counter_ee);
309 uni_buffer.w32[0] = percnt_get(0);
312 case CUSTOM_RQ_RESET_COUNTER:
315 case CUSTOM_RQ_GET_RESET_COUNTER:
317 uni_buffer.w8[0] = eeprom_read_byte(&reset_counter_ee);
319 case CUSTOM_RQ_SET_DIGITS:
320 if (rq->wValue.bytes[0] < 6) {
321 rq->wValue.bytes[0] = 6;
323 if (rq->wValue.bytes[0] > 9) {
324 rq->wValue.bytes[0] = 9;
327 eeprom_write_byte(&digits_ee, rq->wValue.bytes[0]);
329 case CUSTOM_RQ_GET_DIGITS:
331 uni_buffer.w8[0] = eeprom_read_byte(&digits_ee);
333 case CUSTOM_RQ_GET_TOKEN:
335 usbMsgPtr = (usbMsgPtr_t)token;
336 return strlen(token);
337 case CUSTOM_RQ_PRESS_BUTTON:
338 key_state = STATE_SEND_KEY;
340 case CUSTOM_RQ_CLR_DBG:
341 memset(dbg_buffer, 0, sizeof(dbg_buffer));
343 case CUSTOM_RQ_SET_DBG:
345 case CUSTOM_RQ_GET_DBG:
346 usbMsgPtr = dbg_buffer;
347 return MIN(8, rq->wLength.word);
348 case CUSTOM_RQ_RESET:
349 soft_reset((uint8_t)(rq->wValue.word));
351 case CUSTOM_RQ_READ_BUTTON:
352 uni_buffer.w8[0] = button_get_debounced(DEBOUNCE_DELAY);
354 #if ALLOW_SECRET_READ
355 case CUSTOM_RQ_GET_SECRET:
356 uni_buffer.w8[0] = 0;
365 return 0; /* default for not implemented requests: return no data back to host */
369 uchar usbFunctionWrite(uchar *data, uchar len)
371 switch(current_command){
374 if (data[0] != LED_state)
376 return 1; /* Data read, not expecting more */
377 case CUSTOM_RQ_SET_SECRET:
379 if (uni_buffer.w8[0] < (secret_length_b + 7) / 8) {
380 memcpy(&secret[uni_buffer.w8[0]], data, len);
381 uni_buffer.w8[0] += len;
383 if (uni_buffer.w8[0] >= (secret_length_b + 7) / 8) {
389 case CUSTOM_RQ_SET_DBG:
390 if(len > sizeof(dbg_buffer)){
391 len = sizeof(dbg_buffer);
393 memcpy(dbg_buffer, data, len);
398 uchar usbFunctionRead(uchar *data, uchar len){
399 #if ALLOW_SECRET_READ || 1
402 switch(current_command){
403 case CUSTOM_RQ_GET_SECRET:
405 s_length_B = (eeprom_read_word(&secret_length_ee) + 7) / 8;
406 r = MIN(len, s_length_B - uni_buffer.w8[0]);
408 eeprom_read_block(data, secret_ee + uni_buffer.w8[0], r);
409 uni_buffer.w8[0] += r;
416 static void calibrateOscillator(void)
419 uchar trialValue = 0, optimumValue;
420 int x, optimumDev, targetValue = (unsigned)(1499 * (double)F_CPU / 10.5e6 + 0.5);
422 /* do a binary search: */
424 OSCCAL = trialValue + step;
425 x = usbMeasureFrameLength(); /* proportional to current real frequency */
426 if(x < targetValue) /* frequency still too low */
430 /* We have a precision of +/- 1 for optimum OSCCAL here */
431 /* now do a neighborhood search for optimum value */
432 optimumValue = trialValue;
433 optimumDev = x; /* this is certainly far away from optimum */
434 for (OSCCAL = trialValue - 1; OSCCAL <= trialValue + 1; OSCCAL++){
435 x = usbMeasureFrameLength() - targetValue;
438 if (x < optimumDev) {
440 optimumValue = OSCCAL;
443 OSCCAL = optimumValue;
447 void usbEventResetReady(void)
449 cli(); /* usbMeasureFrameLength() counts CPU cycles, so disable interrupts. */
450 calibrateOscillator();
454 /* ------------------------------------------------------------------------- */
459 int8_t i = 0, last_stable_button_state = 0;
462 /* Even if you don't use the watchdog, turn it off here. On newer devices,
463 * the status of the watchdog (on/off, period) is PRESERVED OVER RESET!
465 /* RESET status: all port bits are inputs without pull-up.
466 * That's the way we need D+ and D-. Therefore we don't need any
467 * additional hardware initialization.
472 usbDeviceDisconnect(); /* enforce re-enumeration, do this while interrupts are disabled! */
473 while(--i){ /* fake USB disconnect for ~512 ms */
480 DDRB &= ~_BV(BUTTON_PIN); /* make button pin input */
481 PORTB |= _BV(BUTTON_PIN); /* turn on pull-up resistor */
483 for(;;){ /* main event loop */
487 i = button_get_debounced(DEBOUNCE_DELAY);
489 if (last_stable_button_state == 0 && i == 1) {
491 key_state = STATE_SEND_KEY;
493 last_stable_button_state = i;
496 if(usbInterruptIsReady() && key_state != STATE_WAIT){
499 buildReport(token[idx]);
500 key_state = STATE_RELEASE_KEY; /* release next */
502 case STATE_RELEASE_KEY:
505 if (token[idx] == '\0') {
507 key_state = STATE_WAIT;
509 key_state = STATE_SEND_KEY;
513 key_state = STATE_WAIT; /* should not happen */
516 usbSetInterrupt((void *)&keyboard_report, sizeof(keyboard_report));
524 /* ------------------------------------------------------------------------- */