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 PROGMEM const char usbHidReportDescriptor[USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH] = {
54 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */
55 0x09, 0x06, /* USAGE (Keyboard) */
56 0xa1, 0x01, /* COLLECTION (Application) */
57 0x75, 0x01, /* REPORT_SIZE (1) */
58 0x95, 0x08, /* REPORT_COUNT (8) */
59 0x05, 0x07, /* USAGE_PAGE (Keyboard)(Key Codes) */
60 0x19, 0xe0, /* USAGE_MINIMUM (Keyboard LeftControl)(224) */
61 0x29, 0xe7, /* USAGE_MAXIMUM (Keyboard Right GUI)(231) */
62 0x15, 0x00, /* LOGICAL_MINIMUM (0) */
63 0x25, 0x01, /* LOGICAL_MAXIMUM (1) */
64 0x81, 0x02, /* INPUT (Data,Var,Abs) ; Modifier byte */
65 0x95, 0x01, /* REPORT_COUNT (1) */
66 0x75, 0x08, /* REPORT_SIZE (8) */
67 0x81, 0x03, /* INPUT (Cnst,Var,Abs) ; Reserved byte */
68 0x95, 0x05, /* REPORT_COUNT (5) */
69 0x75, 0x01, /* REPORT_SIZE (1) */
70 0x05, 0x08, /* USAGE_PAGE (LEDs) */
71 0x19, 0x01, /* USAGE_MINIMUM (Num Lock) */
72 0x29, 0x05, /* USAGE_MAXIMUM (Kana) */
73 0x91, 0x02, /* OUTPUT (Data,Var,Abs) ; LED report */
74 0x95, 0x01, /* REPORT_COUNT (1) */
75 0x75, 0x03, /* REPORT_SIZE (3) */
76 0x91, 0x03, /* OUTPUT (Cnst,Var,Abs) ; LED report padding */
77 0x95, 0x06, /* REPORT_COUNT (6) */
78 0x75, 0x08, /* REPORT_SIZE (8) */
79 0x15, 0x00, /* LOGICAL_MINIMUM (0) */
80 0x25, 0x65, /* LOGICAL_MAXIMUM (101) */
81 0x05, 0x07, /* USAGE_PAGE (Keyboard)(Key Codes) */
82 0x19, 0x00, /* USAGE_MINIMUM (Reserved (no event indicated))(0) */
83 0x29, 0x65, /* USAGE_MAXIMUM (Keyboard Application)(101) */
84 0x81, 0x00, /* INPUT (Data,Ary,Abs) */
85 0xc0 /* END_COLLECTION */
88 static uint16_t secret_length_ee EEMEM = 0;
89 static uint8_t secret_ee[32] EEMEM;
90 static uint8_t reset_counter_ee EEMEM = 0;
91 static uint8_t digits_ee EEMEM = 8;
94 static uint32_t counter_ee EEMEM = 0;
97 static uint8_t dbg_buffer[8];
98 static uint8_t secret[32];
99 static uint16_t secret_length_b;
100 static char token[10];
102 #define UNI_BUFFER_SIZE 16
104 static union __attribute__((packed)) {
105 uint8_t w8[UNI_BUFFER_SIZE];
106 uint16_t w16[UNI_BUFFER_SIZE/2];
107 uint32_t w32[UNI_BUFFER_SIZE/4];
108 void* ptr[UNI_BUFFER_SIZE/sizeof(void*)];
111 static uint8_t current_command;
113 typedef struct __attribute__((packed)) {
119 static keyboard_report_t keyboard_report; /* report sent to the host */
120 static uchar idleRate; /* in 4 ms units */
121 static uchar key_state = STATE_WAIT;
122 volatile static uchar LED_state = 0xff;
123 /* ------------------------------------------------------------------------- */
126 void memory_clean(void) {
127 memset(secret, 0, 32);
132 uint8_t secret_set(void){
140 const uint8_t length_B = (secret_length_b + 7) / 8;
143 eeprom_write_block(secret, secret_ee, length_B);
146 eeprom_read_block(read_back.w8, secret_ee, length_B);
147 r = memcmp(secret, read_back.w8, length_B);
149 memset(read_back.w8, 0, 32);
155 eeprom_write_word(&secret_length_ee, secret_length_b);
158 r = eeprom_read_word(&secret_length_ee) == secret_length_b;
172 void counter_inc(void){
176 t = eeprom_read_dword(&counter_ee);
178 eeprom_write_dword(&counter_ee, t + 1);
185 void counter_reset(void) {
186 uint8_t reset_counter;
188 reset_counter = eeprom_read_byte(&reset_counter_ee);
191 eeprom_write_dword(&counter_ee, 0);
196 eeprom_write_byte(&reset_counter_ee, reset_counter + 1);
200 void counter_init(void) {
203 if (eeprom_read_byte(&reset_counter_ee) == 0) {
211 void token_generate(void) {
216 eeprom_read_block(secret, secret_ee, 32);
218 s_length_b = eeprom_read_word(&secret_length_ee);
219 if (s_length_b > 256) {
223 digits = eeprom_read_byte(&digits_ee);
226 hotp(token, secret, s_length_b, eeprom_read_dword(&counter_ee) - 1, digits);
228 hotp(token, secret, s_length_b, percnt_get(0) - 1, digits);
235 void buildReport(uchar send_key) {
236 keyboard_report.modifier = 0;
239 keyboard_report.keycode[0] = KEY_1 + (send_key-'1');
242 keyboard_report.keycode[0] = KEY_0;
245 keyboard_report.keycode[0] = 0;
250 int8_t button_get_debounced(volatile int8_t debounce_count) {
252 v = PINB & _BV(BUTTON_PIN);
253 while (debounce_count-- && (v == (PINB & _BV(BUTTON_PIN)))) {
256 if (debounce_count != -1) {
262 usbMsgLen_t usbFunctionSetup(uchar data[8])
264 usbRequest_t *rq = (usbRequest_t *)data;
265 if ((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_CLASS) { /* class request type */
266 switch(rq->bRequest) {
267 case USBRQ_HID_GET_REPORT: /* send "no keys pressed" if asked here */
268 /* wValue: ReportType (highbyte), ReportID (lowbyte) */
269 usbMsgPtr = (void *)&keyboard_report; /* we only have this one */
270 keyboard_report.modifier = 0;
271 keyboard_report.keycode[0] = 0;
272 return sizeof(keyboard_report);
273 case USBRQ_HID_SET_REPORT: /* if wLength == 1, should be LED state */
274 if (rq->wLength.word == 1) {
275 current_command = LED_WRITE;
279 case USBRQ_HID_GET_IDLE: /* send idle rate to PC as required by spec */
280 usbMsgPtr = &idleRate;
282 case USBRQ_HID_SET_IDLE: /* save idle rate as required by spec */
283 idleRate = rq->wValue.bytes[1];
287 if ((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_VENDOR) {
288 current_command = rq->bRequest;
289 usbMsgPtr = uni_buffer.w8;
292 case CUSTOM_RQ_SET_SECRET:
293 secret_length_b = rq->wValue.word;
294 if (secret_length_b > 256) {
295 secret_length_b = 256;
297 uni_buffer.w8[0] = 0;
299 case CUSTOM_RQ_INC_COUNTER:
302 case CUSTOM_RQ_GET_COUNTER:
305 uni_buffer.w32[0] = eeprom_read_dword(&counter_ee);
307 uni_buffer.w32[0] = percnt_get(0);
310 case CUSTOM_RQ_RESET_COUNTER:
313 case CUSTOM_RQ_GET_RESET_COUNTER:
315 uni_buffer.w8[0] = eeprom_read_byte(&reset_counter_ee);
317 case CUSTOM_RQ_SET_DIGITS:
318 if (rq->wValue.bytes[0] < 6) {
319 rq->wValue.bytes[0] = 6;
321 if (rq->wValue.bytes[0] > 9) {
322 rq->wValue.bytes[0] = 9;
325 eeprom_write_byte(&digits_ee, rq->wValue.bytes[0]);
327 case CUSTOM_RQ_GET_DIGITS:
329 uni_buffer.w8[0] = eeprom_read_byte(&digits_ee);
331 case CUSTOM_RQ_GET_TOKEN:
333 usbMsgPtr = (usbMsgPtr_t)token;
334 return strlen(token);
335 case CUSTOM_RQ_PRESS_BUTTON:
336 key_state = STATE_SEND_KEY;
338 case CUSTOM_RQ_CLR_DBG:
339 memset(dbg_buffer, 0, sizeof(dbg_buffer));
341 case CUSTOM_RQ_SET_DBG:
343 case CUSTOM_RQ_GET_DBG:{
345 if(len > rq->wLength.word){
346 len = rq->wLength.word;
348 usbMsgPtr = dbg_buffer;
351 case CUSTOM_RQ_RESET:
352 soft_reset((uint8_t)(rq->wValue.word));
354 case CUSTOM_RQ_READ_BUTTON:
355 uni_buffer.w8[0] = button_get_debounced(DEBOUNCE_DELAY);
357 case CUSTOM_RQ_GET_SECRET:
358 uni_buffer.w8[0] = 0;
363 return 0; /* default for not implemented requests: return no data back to host */
367 uchar usbFunctionWrite(uchar *data, uchar len)
369 switch(current_command){
372 if (data[0] != LED_state)
374 return 1; /* Data read, not expecting more */
375 case CUSTOM_RQ_SET_SECRET:
377 if (uni_buffer.w8[0] < (secret_length_b + 7) / 8) {
378 memcpy(&secret[uni_buffer.w8[0]], data, len);
379 uni_buffer.w8[0] += len;
381 if (uni_buffer.w8[0] >= (secret_length_b + 7) / 8) {
387 case CUSTOM_RQ_SET_DBG:
388 if(len > sizeof(dbg_buffer)){
389 len = sizeof(dbg_buffer);
391 memcpy(dbg_buffer, data, len);
399 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
401 uchar usbFunctionRead(uchar *data, uchar len){
402 #if ALLOW_SECRET_READ
405 switch(current_command){
406 case CUSTOM_RQ_GET_SECRET:
408 s_length_B = (eeprom_read_word(&secret_length_ee) + 7) / 8;
409 r = MIN(len, s_length_B - uni_buffer.w8[0]);
411 eeprom_read_block(data, secret_ee + uni_buffer.w8[0], r);
412 uni_buffer.w8[0] += r;
419 static void calibrateOscillator(void)
422 uchar trialValue = 0, optimumValue;
423 int x, optimumDev, targetValue = (unsigned)(1499 * (double)F_CPU / 10.5e6 + 0.5);
425 /* do a binary search: */
427 OSCCAL = trialValue + step;
428 x = usbMeasureFrameLength(); /* proportional to current real frequency */
429 if(x < targetValue) /* frequency still too low */
433 /* We have a precision of +/- 1 for optimum OSCCAL here */
434 /* now do a neighborhood search for optimum value */
435 optimumValue = trialValue;
436 optimumDev = x; /* this is certainly far away from optimum */
437 for (OSCCAL = trialValue - 1; OSCCAL <= trialValue + 1; OSCCAL++){
438 x = usbMeasureFrameLength() - targetValue;
441 if (x < optimumDev) {
443 optimumValue = OSCCAL;
446 OSCCAL = optimumValue;
450 void usbEventResetReady(void)
452 cli(); /* usbMeasureFrameLength() counts CPU cycles, so disable interrupts. */
453 calibrateOscillator();
457 /* ------------------------------------------------------------------------- */
462 int8_t i = 0, last_stable_button_state = 0;
465 /* Even if you don't use the watchdog, turn it off here. On newer devices,
466 * the status of the watchdog (on/off, period) is PRESERVED OVER RESET!
468 /* RESET status: all port bits are inputs without pull-up.
469 * That's the way we need D+ and D-. Therefore we don't need any
470 * additional hardware initialization.
475 usbDeviceDisconnect(); /* enforce re-enumeration, do this while interrupts are disabled! */
476 while(--i){ /* fake USB disconnect for ~512 ms */
483 DDRB &= ~_BV(BUTTON_PIN); /* make button pin input */
484 PORTB |= _BV(BUTTON_PIN); /* turn on pull-up resistor */
486 for(;;){ /* main event loop */
490 i = button_get_debounced(DEBOUNCE_DELAY);
492 if (last_stable_button_state == 0 && i == 1) {
494 key_state = STATE_SEND_KEY;
496 last_stable_button_state = i;
499 if(usbInterruptIsReady() && key_state != STATE_WAIT){
502 buildReport(token[idx]);
503 key_state = STATE_RELEASE_KEY; /* release next */
505 case STATE_RELEASE_KEY:
508 if (token[idx] == '\0') {
510 key_state = STATE_WAIT;
512 key_state = STATE_SEND_KEY;
516 key_state = STATE_WAIT; /* should not happen */
519 usbSetInterrupt((void *)&keyboard_report, sizeof(keyboard_report));
527 /* ------------------------------------------------------------------------- */