2 * Project: hid-custom-rq example
3 * Author: Christian Starkjohann
4 * Creation Date: 2008-04-07
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 $
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:
21 #define SIMPLE_COUNTER 1
29 #include <avr/eeprom.h>
30 #include <avr/interrupt.h> /* for sei() */
31 #include <util/delay.h> /* for _delay_ms() */
33 #include <avr/pgmspace.h> /* required by usbdrv.h */
35 #include "oddebug.h" /* This is also an example for using debug macros */
36 #include "requests.h" /* The custom request numbers we use */
41 #include "usb_keyboard_codes.h"
43 /* ------------------------------------------------------------------------- */
44 /* ----------------------------- USB interface ----------------------------- */
45 /* ------------------------------------------------------------------------- */
48 #define STATE_SEND_KEY 1
49 #define STATE_RELEASE_KEY 2
52 PROGMEM const char usbHidReportDescriptor[USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH] = {
53 0x05, 0x01, /* USAGE_PAGE (Generic Desktop) */
54 0x09, 0x06, /* USAGE (Keyboard) */
55 0xa1, 0x01, /* COLLECTION (Application) */
56 0x75, 0x01, /* REPORT_SIZE (1) */
57 0x95, 0x08, /* REPORT_COUNT (8) */
58 0x05, 0x07, /* USAGE_PAGE (Keyboard)(Key Codes) */
59 0x19, 0xe0, /* USAGE_MINIMUM (Keyboard LeftControl)(224) */
60 0x29, 0xe7, /* USAGE_MAXIMUM (Keyboard Right GUI)(231) */
61 0x15, 0x00, /* LOGICAL_MINIMUM (0) */
62 0x25, 0x01, /* LOGICAL_MAXIMUM (1) */
63 0x81, 0x02, /* INPUT (Data,Var,Abs) ; Modifier byte */
64 0x95, 0x01, /* REPORT_COUNT (1) */
65 0x75, 0x08, /* REPORT_SIZE (8) */
66 0x81, 0x03, /* INPUT (Cnst,Var,Abs) ; Reserved byte */
67 0x95, 0x05, /* REPORT_COUNT (5) */
68 0x75, 0x01, /* REPORT_SIZE (1) */
69 0x05, 0x08, /* USAGE_PAGE (LEDs) */
70 0x19, 0x01, /* USAGE_MINIMUM (Num Lock) */
71 0x29, 0x05, /* USAGE_MAXIMUM (Kana) */
72 0x91, 0x02, /* OUTPUT (Data,Var,Abs) ; LED report */
73 0x95, 0x01, /* REPORT_COUNT (1) */
74 0x75, 0x03, /* REPORT_SIZE (3) */
75 0x91, 0x03, /* OUTPUT (Cnst,Var,Abs) ; LED report padding */
76 0x95, 0x06, /* REPORT_COUNT (6) */
77 0x75, 0x08, /* REPORT_SIZE (8) */
78 0x15, 0x00, /* LOGICAL_MINIMUM (0) */
79 0x25, 0x65, /* LOGICAL_MAXIMUM (101) */
80 0x05, 0x07, /* USAGE_PAGE (Keyboard)(Key Codes) */
81 0x19, 0x00, /* USAGE_MINIMUM (Reserved (no event indicated))(0) */
82 0x29, 0x65, /* USAGE_MAXIMUM (Keyboard Application)(101) */
83 0x81, 0x00, /* INPUT (Data,Ary,Abs) */
84 0xc0 /* END_COLLECTION */
87 static uint16_t secret_length_ee EEMEM = 0;
88 static uint8_t secret_ee[32] EEMEM;
89 static uint8_t reset_counter_ee EEMEM = 0;
90 static uint8_t digits_ee EEMEM = 8;
93 static uint32_t counter_ee EEMEM = 0;
96 static uint8_t dbg_buffer[8];
97 static uint8_t secret[32];
98 static uint16_t secret_length_b;
99 static char token[10];
101 #define UNI_BUFFER_SIZE 16
103 static union __attribute__((packed)) {
104 uint8_t w8[UNI_BUFFER_SIZE];
105 uint16_t w16[UNI_BUFFER_SIZE/2];
106 uint32_t w32[UNI_BUFFER_SIZE/4];
107 void* ptr[UNI_BUFFER_SIZE/sizeof(void*)];
110 static uint8_t current_command;
118 static keyboard_report_t keyboard_report; /* report sent to the host */
119 static uchar idleRate; /* in 4 ms units */
120 static uchar key_state = STATE_WAIT;
121 volatile static uchar LED_state = 0xff;
122 /* ------------------------------------------------------------------------- */
125 void memory_clean(void) {
126 memset(secret, 0, 32);
133 uint8_t secret_set(void){
141 const uint8_t length_B = (secret_length_b + 7) / 8;
144 eeprom_write_block(secret, secret_ee, length_B);
147 eeprom_read_block(read_back.w8, secret_ee, length_B);
148 r = memcmp(secret, read_back.w8, length_B);
150 memset(read_back.w8, 0, 32);
156 eeprom_write_word(&secret_length_ee, secret_length_b);
159 r = eeprom_read_word(&secret_length_ee) == secret_length_b;
173 void counter_inc(void){
177 t = eeprom_read_dword(&counter_ee);
179 eeprom_write_dword(&counter_ee, t + 1);
186 void counter_reset(void) {
187 uint8_t reset_counter;
189 reset_counter = eeprom_read_byte(&reset_counter_ee);
192 eeprom_write_dword(&counter_ee, 0);
197 eeprom_write_byte(&reset_counter_ee, reset_counter + 1);
201 void counter_init(void) {
204 if (eeprom_read_byte(&reset_counter_ee) == 0) {
212 void token_generate(void) {
215 eeprom_read_block(secret, secret_ee, 32);
218 hotp(token, secret, eeprom_read_word(&secret_length_ee), eeprom_read_dword(&counter_ee), eeprom_read_byte(&digits_ee));
220 hotp(token, secret, eeprom_read_word(&secret_length_ee), percnt_get(0), eeprom_read_byte(&digits_ee));
227 void buildReport(uchar send_key) {
228 keyboard_report.modifier = 0;
232 keyboard_report.keycode[0] = KEY_1 + (send_key-'1');
235 keyboard_report.keycode[0] = KEY_0;
238 keyboard_report.keycode[0] = 0;
243 int8_t button_get_debounced(volatile uint8_t debounce_count) {
245 v = PINB & _BV(BUTTON_PIN);
246 while (debounce_count-- && v == (PINB & _BV(BUTTON_PIN))) {
249 if (debounce_count) {
255 usbMsgLen_t usbFunctionSetup(uchar data[8])
257 usbRequest_t *rq = (usbRequest_t *)data;
258 if ((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_CLASS) { /* class request type */
259 switch(rq->bRequest) {
260 case USBRQ_HID_GET_REPORT: /* send "no keys pressed" if asked here */
261 /* wValue: ReportType (highbyte), ReportID (lowbyte) */
262 usbMsgPtr = (void *)&keyboard_report; /* we only have this one */
263 keyboard_report.modifier = 0;
264 keyboard_report.keycode[0] = 0;
265 return sizeof(keyboard_report);
266 case USBRQ_HID_SET_REPORT: /* if wLength == 1, should be LED state */
267 if (rq->wLength.word == 1) {
268 current_command = LED_WRITE;
272 case USBRQ_HID_GET_IDLE: /* send idle rate to PC as required by spec */
273 usbMsgPtr = &idleRate;
275 case USBRQ_HID_SET_IDLE: /* save idle rate as required by spec */
276 idleRate = rq->wValue.bytes[1];
280 if ((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_VENDOR) {
281 current_command = rq->bRequest;
284 case CUSTOM_RQ_SET_SECRET:
285 secret_length_b = rq->wValue.word;
286 if (secret_length_b > 256) {
287 secret_length_b = 256;
289 uni_buffer.w8[0] = 0;
291 case CUSTOM_RQ_INC_COUNTER:
294 case CUSTOM_RQ_GET_COUNTER:
297 uni_buffer.w32[0] = eeprom_read_dword(&counter_ee);
299 uni_buffer.w32[0] = percnt_get(0);
301 usbMsgPtr = (usbMsgPtr_t)uni_buffer.w32;
303 case CUSTOM_RQ_RESET_COUNTER:
306 case CUSTOM_RQ_GET_RESET_COUNTER:
308 uni_buffer.w8[0] = eeprom_read_byte(&reset_counter_ee);
309 usbMsgPtr = uni_buffer.w8;
311 case CUSTOM_RQ_SET_DIGITS:
312 if (rq->wValue.bytes[0] > 9) {
313 rq->wValue.bytes[0] = 9;
316 eeprom_write_byte(&digits_ee, rq->wValue.bytes[0]);
318 case CUSTOM_RQ_GET_DIGITS:
320 uni_buffer.w8[0] = eeprom_read_byte(&digits_ee);
321 usbMsgPtr = uni_buffer.w8;
323 case CUSTOM_RQ_GET_TOKEN:
325 usbMsgPtr = (usbMsgPtr_t)token;
326 return strlen(token);
328 case CUSTOM_RQ_PRESS_BUTTON:
329 key_state = STATE_SEND_KEY;
331 case CUSTOM_RQ_CLR_DBG:
332 memset(dbg_buffer, 0, sizeof(dbg_buffer));
334 case CUSTOM_RQ_SET_DBG:
336 case CUSTOM_RQ_GET_DBG:{
338 if(len > rq->wLength.word){
339 len = rq->wLength.word;
341 usbMsgPtr = dbg_buffer;
344 case CUSTOM_RQ_RESET:
345 soft_reset((uint8_t)(rq->wValue.word));
347 case CUSTOM_RQ_READ_BUTTON:
348 uni_buffer.w8[0] = button_get_debounced(25);
349 usbMsgPtr = uni_buffer.w8;
354 return 0; /* default for not implemented requests: return no data back to host */
358 uchar usbFunctionWrite(uchar *data, uchar len)
360 switch(current_command){
363 if (data[0] != LED_state)
365 return 1; /* Data read, not expecting more */
366 case CUSTOM_RQ_SET_SECRET:
368 if (uni_buffer.w8[0] < (secret_length_b + 7) / 8) {
369 memcpy(&secret[uni_buffer.w8[0]], data, len);
370 uni_buffer.w8[0] += len;
372 if (uni_buffer.w8[0] >= (secret_length_b + 7) / 8) {
378 case CUSTOM_RQ_SET_DBG:
379 if(len > sizeof(dbg_buffer)){
380 len = sizeof(dbg_buffer);
382 memcpy(dbg_buffer, data, len);
389 uchar usbFunctionRead(uchar *data, uchar len){
393 static void calibrateOscillator(void)
396 uchar trialValue = 0, optimumValue;
397 int x, optimumDev, targetValue = (unsigned)(1499 * (double)F_CPU / 10.5e6 + 0.5);
399 /* do a binary search: */
401 OSCCAL = trialValue + step;
402 x = usbMeasureFrameLength(); /* proportional to current real frequency */
403 if(x < targetValue) /* frequency still too low */
407 /* We have a precision of +/- 1 for optimum OSCCAL here */
408 /* now do a neighborhood search for optimum value */
409 optimumValue = trialValue;
410 optimumDev = x; /* this is certainly far away from optimum */
411 for (OSCCAL = trialValue - 1; OSCCAL <= trialValue + 1; OSCCAL++){
412 x = usbMeasureFrameLength() - targetValue;
415 if (x < optimumDev) {
417 optimumValue = OSCCAL;
420 OSCCAL = optimumValue;
424 void usbEventResetReady(void)
426 cli(); /* usbMeasureFrameLength() counts CPU cycles, so disable interrupts. */
427 calibrateOscillator();
431 /* ------------------------------------------------------------------------- */
436 int8_t i = 0, last_stable_button_state = 0;
439 /* Even if you don't use the watchdog, turn it off here. On newer devices,
440 * the status of the watchdog (on/off, period) is PRESERVED OVER RESET!
442 /* RESET status: all port bits are inputs without pull-up.
443 * That's the way we need D+ and D-. Therefore we don't need any
444 * additional hardware initialization.
447 DDRB &= ~_BV(BUTTON_PIN); /* make button pin input */
448 PORTB |= _BV(BUTTON_PIN); /* turn on pull-up resistor */
451 usbDeviceDisconnect(); /* enforce re-enumeration, do this while interrupts are disabled! */
452 while(--i){ /* fake USB disconnect for ~512 ms */
460 for(;;){ /* main event loop */
464 i = button_get_debounced(25);
466 if (last_stable_button_state == 0 && i == 1) {
467 key_state = STATE_SEND_KEY;
469 last_stable_button_state = i;
472 if(usbInterruptIsReady() && key_state != STATE_WAIT){
475 buildReport(token[idx]);
476 key_state = STATE_RELEASE_KEY; /* release next */
478 case STATE_RELEASE_KEY:
481 if (token[idx] == '\0') {
483 key_state = STATE_WAIT;
485 key_state = STATE_SEND_KEY;
489 key_state = STATE_WAIT; /* should not happen */
492 usbSetInterrupt((void *)&keyboard_report, sizeof(keyboard_report));
500 /* ------------------------------------------------------------------------- */