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 */
37 #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 uni_buffer_fill;
112 static uint8_t current_command;
120 static keyboard_report_t keyboard_report; /* report sent to the host */
121 static uchar idleRate; /* in 4 ms units */
122 static uchar key_state = STATE_WAIT;
123 volatile static uchar LED_state = 0xff;
124 /* ------------------------------------------------------------------------- */
127 void memory_clean(void) {
128 memset(secret, 0, 32);
135 uint8_t secret_set(void){
143 const uint8_t length_B = (secret_length_b + 7) / 8;
146 eeprom_write_block(secret, secret_ee, length_B);
149 eeprom_read_block(read_back.w8, secret_ee, length_B);
150 r = memcmp(secret, read_back.w8, length_B);
152 memset(read_back.w8, 0, 32);
158 eeprom_write_word(&secret_length_ee, secret_length_b);
161 r = eeprom_read_word(&secret_length_ee) == secret_length_b;
175 void counter_inc(void){
179 t = eeprom_read_dword(&counter_ee);
181 eeprom_write_dword(&counter_ee, t + 1);
188 void counter_reset(void) {
189 uint8_t reset_counter;
191 reset_counter = eeprom_read_byte(&reset_counter_ee);
194 eeprom_write_dword(&counter_ee, 0);
199 eeprom_write_byte(&reset_counter_ee, reset_counter + 1);
203 void counter_init(void) {
206 if (eeprom_read_byte(&reset_counter_ee) == 0) {
214 void token_generate(void) {
217 eeprom_read_block(secret, secret_ee, 32);
220 hotp(token, secret, eeprom_read_word(&secret_length_ee), eeprom_read_dword(&counter_ee), eeprom_read_byte(&digits_ee));
222 hotp(token, secret, eeprom_read_word(&secret_length_ee), percnt_get(0), eeprom_read_byte(&digits_ee));
229 void buildReport(uchar send_key) {
230 keyboard_report.modifier = 0;
234 keyboard_report.modifier = MOD_SHIFT_LEFT;
235 keyboard_report.keycode[0] = KEY_A + (send_key-'A');
238 keyboard_report.keycode[0] = KEY_A + (send_key-'a');
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 uint8_t debounce_count) {
254 v = PINB & _BV(BUTTON_PIN);
255 while (debounce_count-- && v == (PINB & _BV(BUTTON_PIN))) {
258 if (debounce_count) {
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;
293 case CUSTOM_RQ_SET_SECRET:
294 secret_length_b = rq->wValue.word;
295 if (secret_length_b > 256) {
296 secret_length_b = 256;
298 uni_buffer.w8[0] = 0;
300 case CUSTOM_RQ_INC_COUNTER:
303 case CUSTOM_RQ_GET_COUNTER:
306 uni_buffer.w32[0] = eeprom_read_dword(&counter_ee);
308 uni_buffer.w32[0] = percnt_get(0);
310 usbMsgPtr = (usbMsgPtr_t)uni_buffer.w32;
312 case CUSTOM_RQ_RESET_COUNTER:
315 case CUSTOM_RQ_GET_RESET_COUNTER:
317 uni_buffer.w8[0] = eeprom_read_byte(&reset_counter_ee);
318 usbMsgPtr = uni_buffer.w8;
320 case CUSTOM_RQ_SET_DIGITS:
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);
330 usbMsgPtr = uni_buffer.w8;
332 case CUSTOM_RQ_GET_TOKEN:
334 usbMsgPtr = (usbMsgPtr_t)token;
335 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:{
347 if(len > rq->wLength.word){
348 len = rq->wLength.word;
350 usbMsgPtr = dbg_buffer;
353 case CUSTOM_RQ_READ_MEM:
354 usbMsgPtr = (uchar*)rq->wValue.word;
355 return rq->wLength.word;
356 case CUSTOM_RQ_WRITE_MEM:
357 case CUSTOM_RQ_EXEC_SPM:
358 /* uni_buffer_fill = 4;
359 uni_buffer.w16[0] = rq->wValue.word;
360 uni_buffer.w16[1] = rq->wLength.word;
362 */ case CUSTOM_RQ_READ_FLASH:
363 uni_buffer.w16[0] = rq->wValue.word;
364 uni_buffer.w16[1] = rq->wLength.word;
367 case CUSTOM_RQ_RESET:
368 soft_reset((uint8_t)(rq->wValue.word));
370 case CUSTOM_RQ_READ_BUTTON:
371 uni_buffer.w8[0] = button_get_debounced(25);
372 usbMsgPtr = uni_buffer.w8;
377 return 0; /* default for not implemented requests: return no data back to host */
381 uchar usbFunctionWrite(uchar *data, uchar len)
383 switch(current_command){
386 if (data[0] != LED_state)
388 return 1; // Data read, not expecting more
389 case CUSTOM_RQ_SET_SECRET:
391 if (uni_buffer.w8[0] < (secret_length_b + 7) / 8) {
392 memcpy(&secret[uni_buffer.w8[0]], data, len);
393 uni_buffer.w8[0] += len;
395 if (uni_buffer.w8[0] >= (secret_length_b + 7) / 8) {
401 case CUSTOM_RQ_SET_DBG:
402 if(len > sizeof(dbg_buffer)){
403 len = sizeof(dbg_buffer);
405 memcpy(dbg_buffer, data, len);
407 case CUSTOM_RQ_WRITE_MEM:
408 memcpy(uni_buffer.ptr[0], data, len);
409 uni_buffer.w16[0] += len;
410 return !(uni_buffer.w16[1] -= len);
411 case CUSTOM_RQ_EXEC_SPM:
412 if(uni_buffer_fill < 8){
413 uint8_t l = 8 - uni_buffer_fill;
417 memcpy(&(uni_buffer.w8[uni_buffer_fill]), data, len);
418 uni_buffer_fill += len;
421 uni_buffer.w16[1] -= len;
422 if (uni_buffer.w16[1] > 8) {
423 memcpy(uni_buffer.ptr[0], data, len);
424 uni_buffer.w16[0] += len;
427 memcpy(&(uni_buffer.w8[uni_buffer_fill]), data, len);
428 exec_spm(uni_buffer.w16[2], uni_buffer.w16[3], uni_buffer.ptr[0], data, len);
436 uchar usbFunctionRead(uchar *data, uchar len){
438 switch(current_command){
439 case CUSTOM_RQ_READ_FLASH:
441 *data++ = pgm_read_byte((uni_buffer.w16[0])++);
450 static void calibrateOscillator(void)
453 uchar trialValue = 0, optimumValue;
454 int x, optimumDev, targetValue = (unsigned)(1499 * (double)F_CPU / 10.5e6 + 0.5);
456 /* do a binary search: */
458 OSCCAL = trialValue + step;
459 x = usbMeasureFrameLength(); // proportional to current real frequency
460 if(x < targetValue) // frequency still too low
464 /* We have a precision of +/- 1 for optimum OSCCAL here */
465 /* now do a neighborhood search for optimum value */
466 optimumValue = trialValue;
467 optimumDev = x; // this is certainly far away from optimum
468 for (OSCCAL = trialValue - 1; OSCCAL <= trialValue + 1; OSCCAL++){
469 x = usbMeasureFrameLength() - targetValue;
472 if (x < optimumDev) {
474 optimumValue = OSCCAL;
477 OSCCAL = optimumValue;
481 void usbEventResetReady(void)
483 cli(); // usbMeasureFrameLength() counts CPU cycles, so disable interrupts.
484 calibrateOscillator();
486 // we never read the value from eeprom so this causes only degradation of eeprom
487 // eeprom_write_byte(0, OSCCAL); // store the calibrated value in EEPROM
490 /* ------------------------------------------------------------------------- */
495 int8_t i = 0, last_stable_button_state = 0;
498 /* Even if you don't use the watchdog, turn it off here. On newer devices,
499 * the status of the watchdog (on/off, period) is PRESERVED OVER RESET!
501 /* RESET status: all port bits are inputs without pull-up.
502 * That's the way we need D+ and D-. Therefore we don't need any
503 * additional hardware initialization.
506 DDRB &= ~_BV(BUTTON_PIN); /* make button pin input */
507 PORTB |= _BV(BUTTON_PIN); /* turn on pull-up resistor */
510 usbDeviceDisconnect(); /* enforce re-enumeration, do this while interrupts are disabled! */
511 while(--i){ /* fake USB disconnect for ~512 ms */
519 for(;;){ /* main event loop */
523 i = button_get_debounced(25);
525 if (last_stable_button_state == 0 && i == 1) {
526 key_state = STATE_SEND_KEY;
528 last_stable_button_state = i;
531 if(usbInterruptIsReady() && key_state != STATE_WAIT){
534 buildReport(token[idx]);
535 key_state = STATE_RELEASE_KEY; // release next
537 case STATE_RELEASE_KEY:
540 if (token[idx] == '\0') {
542 key_state = STATE_WAIT;
544 key_state = STATE_SEND_KEY;
548 key_state = STATE_WAIT; // should not happen
551 usbSetInterrupt((void *)&keyboard_report, sizeof(keyboard_report));
559 /* ------------------------------------------------------------------------- */