added firmware

This commit is contained in:
Steffen Vogel 2012-03-09 16:10:24 +01:00
parent a8a749e64b
commit d7c12ee669
8 changed files with 1603 additions and 0 deletions

444
firmware/Makefile Normal file
View file

@ -0,0 +1,444 @@
# Hey Emacs, this is a -*- makefile -*-
#----------------------------------------------------------------------------
# avr-gcc Makefile
#
# by Steffen Vogel <info@steffenvogel.de>
#
# Released to the Public Domain - Credits to:
# Eric B. Weddington, Jörg Wunsch, Peter Fleury, Tim Henigan Colin O'Flynn,
# Reiner Patommel, Markus Pfaff, Sander Pool, Frederik Rouleau, Carlos Lamas
#----------------------------------------------------------------------------
# On command line:
#
# make all = Make software
#
# make clean = Clean out built project files
#
# make program = Download the hex file to the device, using avrdude
# Please customize the avrdude settings below first!
#
# make filename.s = Just compile filename.c into the assembler code only
#
# make filename.i = Create a preprocessed source file for use in submitting
# bug reports to the GCC project.
#
# To rebuild project do "make clean" then "make all".
#----------------------------------------------------------------------------
#------------------------------ General Options -----------------------------
# MCU name
MCU = atmega8
# Processor frequency
# This will define a symbol, F_CPU, in all source code files equal to the
# processor frequency. You can then use this symbol in your source code to
# calculate timings. Do NOT tack on a 'UL' at the end, this will be done
# automatically to create a 32-bit value in your source code.
# Typical values are:
F_CPU = 12000000
#F_CPU = 1843200
#F_CPU = 2000000
#F_CPU = 3686400
#F_CPU = 4000000
#F_CPU = 7372800
#F_CPU = 8000000
#F_CPU = 11059200
#F_CPU = 14745600
#F_CPU = 16000000
#F_CPU = 18432000
#F_CPU = 20000000
# Output format
#FORMAT = srec
#FORMAT = binary
FORMAT = ihex
# Target file name (without extension)
TARGET = hidekey
# List C source files here (C dependencies are automatically generated)
SRC = $(TARGET).c usbdrv/usbdrv.c usbdrv/oddebug.c
# List C++ source files here (C dependencies are automatically generated)
CPPSRC =
# List Assembler source files here
# Make them always end in a capital .S. Files ending in a lowercase .s
# will not be considered source files but generated files (assembler
# output from the compiler), and will be deleted upon "make clean"!
# Even though the DOS/Win* filesystem matches both .s and .S the same,
# it will preserve the spelling of the filenames, and gcc itself does
# are about how the name is spelled on its command-line.
ASRC = usbdrv/usbdrvasm.S
# Optimization level, can be [0, 1, 2, 3, ..., s]
# 0 = turn off optimization
# s = optimize for size
# (Note: 3 is not always the best optimization level. See avr-libc FAQ.)
OPT = s
# Debugging format
# Native formats for AVR-GCC's -g are dwarf-2 [default] or stabs.
# AVR Studio 4.10 requires dwarf-2.
# AVR [Extended] COFF format requires stabs, plus an avr-objcopy run.
DEBUG = dwarf-2
# List any extra directories to look for include files here.
# Each directory must be seperated by a space.
# Use forward slashes for directory separators.
# For a directory that has spaces, enclose it in quotes.
EXTRAINCDIRS = usbdrv/
# Compiler flag to set the C Standard level
# c89 = "ANSI" C
# gnu89 = c89 plus GCC extensions
# c99 = ISO C99 standard (not yet fully implemented)
# gnu99 = c99 plus GCC extensions
CSTANDARD = -std=gnu99
# Place -D or -U options here for C sources
CDEFS = -DF_CPU=$(F_CPU)UL
# Place -D or -U options here for C++ sources
#CPPDEFS += -D__STDC_LIMIT_MACROS
#CPPDEFS += -D__STDC_CONSTANT_MACROS
CPPDEFS = -DF_CPU=$(F_CPU)UL
#------------------------------ Compiler Options -----------------------------
# C Compiler Options
# -g generate debugging information
# -O optimization level
# -f tuning, see GCC manual and avr-libc documentation
# -Wall warning level
# -Wa tell GCC to pass this to the assembler.
# -adhlns create assembler listing
#CFLAGS = -g$(DEBUG)
#CFLAGS += -mint8
#CFLAGS += -mshort-calls
#CFLAGS += -Wunreachable-code
#CFLAGS += -Wsign-compare
CFLAGS += -Wall
CFLAGS += -Wstrict-prototypes
CFLAGS += -Wundef
#CFLAGS += -fno-unit-at-a-time
CFLAGS += -funsigned-char
CFLAGS += -funsigned-bitfields
CFLAGS += -fpack-struct
CFLAGS += -fshort-enums
CFLAGS += $(CDEFS)
CFLAGS += -O$(OPT)
CFLAGS += -Wa,-adhlns=$(<:%.c=%.lst)
CFLAGS += $(patsubst %,-I%,$(EXTRAINCDIRS))
CFLAGS += $(CSTANDARD)
# C++ Compiler Options
# -g generate debugging information
# -O optimization level
# -f tuning, see GCC manual and avr-libc documentation
# -Wall warning level
# -Wa tell GCC to pass this to the assembler.
# -adhlns create assembler listing
#CPPFLAGS = -g$(DEBUG)
#CPPFLAGS += -mint8
#CPPFLAGS += -mshort-calls
#CPPFLAGS += $(CSTANDARD)
#CPPFLAGS += -Wstrict-prototypes
#CPPFLAGS += -Wunreachable-code
#CPPFLAGS += -Wsign-compare
CPPFLAGS += -Wall
CFLAGS += -Wundef
#CPPFLAGS += -fno-unit-at-a-time
CPPFLAGS += -funsigned-char
CPPFLAGS += -funsigned-bitfields
CPPFLAGS += -fpack-struct
CPPFLAGS += -fshort-enums
CPPFLAGS += -fno-exceptions
CPPFLAGS += $(CPPDEFS)
CPPFLAGS += -O$(OPT)
CPPFLAGS += -Wa,-adhlns=$(<:%.cpp=%.lst)
CPPFLAGS += $(patsubst %,-I%,$(EXTRAINCDIRS))
# Assembler Options
# -Wa tell GCC to pass this to the assembler.
# -adhlms create listing
# -gstabs have the assembler create line number information;
# note that for use in COFF files, additional information
# about filenames and function names needs to be present
# in the assembler source files
ASFLAGS = -Wa,-adhlns=$(<:%.S=%.lst),-gstabs
#------------------------------ Library Options ------------------------------
# Minimalistic printf version
PRINTF_LIB_MIN = -Wl,-u,vfprintf -lprintf_min
# Floating point printf version (requires MATH_LIB = -lm below)
PRINTF_LIB_FLOAT = -Wl,-u,vfprintf -lprintf_flt
# If this is left blank, then it will use the Standard printf version.
#PRINTF_LIB = $(PRINTF_LIB_MIN)
#PRINTF_LIB = $(PRINTF_LIB_FLOAT)
PRINTF_LIB =
# Minimalistic scanf version
SCANF_LIB_MIN = -Wl,-u,vfscanf -lscanf_min
# Floating point + %[ scanf version (requires MATH_LIB = -lm below)
SCANF_LIB_FLOAT = -Wl,-u,vfscanf -lscanf_flt
# If this is left blank, then it will use the Standard scanf version.
#SCANF_LIB = $(SCANF_LIB_MIN)
#SCANF_LIB = $(SCANF_LIB_FLOAT)
SCANF_LIB =
MATH_LIB = -lm
#-------------------------- External Memory Options --------------------------
# 64 KB of external RAM, starting after internal RAM (ATmega128!),
# used for variables (.data/.bss) and heap (malloc()).
#EXTMEMOPTS = -Wl,-Tdata=0x801100,--defsym=__heap_end=0x80ffff
# 64 KB of external RAM, starting after internal RAM (ATmega128!),
# only used for heap (malloc()).
#EXTMEMOPTS = -Wl,--defsym=__heap_start=0x801100,--defsym=__heap_end=0x80ffff
EXTMEMOPTS =
#------------------------------- Linker Options ------------------------------
# -Wl tell GCC to pass this to linker.
# -Map create map file
# --cref add cross reference to map file
LDFLAGS = -Wl,-Map=$(TARGET).map,--cref
LDFLAGS += $(EXTMEMOPTS)
LDFLAGS += $(PRINTF_LIB) $(SCANF_LIB) $(MATH_LIB)
#------------------------ Programmer Options (avrdude) -----------------------
# Programmer hardware
# avr910
# avrisp
# arduino
# picoweb
# pony-stk200
# stk200
# stk500
# "avrdude -c ?" to get a full listing
#AVRDUDE_PROGRAMMER = avr910
#AVRDUDE_PROGRAMMER = arduino
AVRDUDE_PROGRAMMER = avrisp2
# The port your programmer is connected to
#AVRDUDE_PORT = /dev/ttyUSB0
#AVRDUDE_PORT = /dev/ttyS0
#AVRDUDE_PORT = /dev/ttyACM0
AVRDUDE_PORT = usb
AVRDUDE_WRITE_FLASH = -U flash:w:$(TARGET).hex
AVRDUDE_WRITE_EEPROM = -U eeprom:w:$(TARGET).eep
# Uncomment the following if you want avrdude's erase cycle counter.
# Note that this counter needs to be initialized first using -Yn,
# see avrdude manual.
#AVRDUDE_ERASE_COUNTER = -y
# Uncomment the following if you do /not/ wish a verification to be
# performed after programming the device.
#AVRDUDE_NO_VERIFY = -V
#AVRDUDE_NO_ERASE = -D
# Increase verbosity level
#AVRDUDE_VERBOSE = -v -v
AVRDUDE_FLAGS = -p $(MCU) -P $(AVRDUDE_PORT) -c $(AVRDUDE_PROGRAMMER)
AVRDUDE_FLAGS += $(AVRDUDE_NO_VERIFY)
AVRDUDE_FLAGS += $(AVRDUDE_NO_ERASE)
AVRDUDE_FLAGS += $(AVRDUDE_VERBOSE)
AVRDUDE_FLAGS += $(AVRDUDE_ERASE_COUNTER)
#=========================== End of Configuration ===========================
# Define programs and commands.
SHELL = bash
CC = avr-gcc
OBJCOPY = avr-objcopy
OBJDUMP = avr-objdump
SIZE = avr-size
NM = avr-nm
AVRDUDE = avrdude
REMOVE = rm -f
REMOVEDIR = rm -rf
COPY = cp
# Define messages (english)
MSG_ERRORS_NONE = Errors: none
MSG_SIZE_BEFORE = Size before:
MSG_SIZE_AFTER = Size after:
MSG_FLASH = Creating load file for Flash:
MSG_EEPROM = Creating load file for EEPROM:
MSG_BINARY = Creating binary:
MSG_EXTENDED_LISTING = Creating Extended Listing:
MSG_SYMBOL_TABLE = Creating Symbol Table:
MSG_LINKING = Linking:
MSG_COMPILING = Compiling C:
MSG_COMPILING_CPP = Compiling C++:
MSG_ASSEMBLING = Assembling:
MSG_CLEANING = Cleaning project:
MSG_CREATING_LIBRARY = Creating library:
MSG_PROGRAM = Flashing controller:
# Define all object files
OBJ = $(SRC:%.c=%.o) $(CPPSRC:%.cpp=%.o) $(ASRC:%.S=%.o)
# Define all listing files
LST = $(SRC:%.c=%.lst) $(CPPSRC:%.cpp=%.lst) $(ASRC:%.S=%.lst)
# Compiler flags to generate dependency files
GENDEPFLAGS = -MD -MP -MF .dep/$(@F).d
# Combine all necessary flags and optional flags
# Add target processor to flags
ALL_CFLAGS = -mmcu=$(MCU) -I. $(CFLAGS) $(GENDEPFLAGS)
ALL_CPPFLAGS = -mmcu=$(MCU) -I. -x c++ $(CPPFLAGS) $(GENDEPFLAGS)
ALL_ASFLAGS = -mmcu=$(MCU) -I. -x assembler-with-cpp $(ASFLAGS)
# Default target
all: gccversion sizebefore build sizeafter
# Change the build target to build a HEX file or a library
build: genkey elf hex eep bin lss sym
elf: $(TARGET).elf
hex: $(TARGET).hex
eep: $(TARGET).eep
bin: $(TARGET).bin
lss: $(TARGET).lss
sym: $(TARGET).sym
lib: $(LIBNAME)
# Display size of file
HEXSIZE = $(SIZE) --target=$(FORMAT) $(TARGET).hex
ELFSIZE = $(SIZE) -A $(TARGET).elf
sizebefore:
@if test -f $(TARGET).elf; then echo; echo $(MSG_SIZE_BEFORE); $(ELFSIZE); \
$(SHELL) avr-mem.sh $(TARGET) $(MCU); fi
sizeafter:
@if test -f $(TARGET).elf; then echo; echo $(MSG_SIZE_AFTER); $(ELFSIZE); \
$(SHELL) avr-mem.sh $(TARGET) $(MCU); fi
# Display compiler version information
gccversion:
@$(CC) --version
# Program the device
program: build
@echo $(MSG_PROGRAM)
@echo
$(AVRDUDE) $(AVRDUDE_FLAGS) $(AVRDUDE_WRITE_FLASH) \
$(AVRDUDE_WRITE_EEPROM)
# Create final output files (.hex, .eep) from ELF output file
%.hex: %.elf
@echo
@echo $(MSG_FLASH) $@
$(OBJCOPY) -O $(FORMAT) -R .eeprom $< $@
%.eep: %.elf
@echo
@echo $(MSG_EEPROM) $@
$(OBJCOPY) -j .eeprom --set-section-flags=.eeprom="alloc,load" \
--change-section-lma .eeprom=0 -O $(FORMAT) $< $@
# Create binary output
%.bin: %.elf
@echo
@echo $(MSG_BINARY) $@
$(OBJCOPY) $(TARGET).elf -R .eeprom -O binary $(TARGET).bin
# Create extended listing file from ELF output file
%.lss: %.elf
@echo
@echo $(MSG_EXTENDED_LISTING) $@
$(OBJDUMP) -h -S $< > $@
# Create a symbol table from ELF output file
%.sym: %.elf
@echo
@echo $(MSG_SYMBOL_TABLE) $@
$(NM) -n $< > $@
# Create library from object files
.SECONDARY: $(TARGET).a
.PRECIOUS: $(OBJ)
%.a: $(OBJ)
@echo
@echo $(MSG_CREATING_LIBRARY) $@
$(AR) $@ $(OBJ)
# Link: create ELF output file from object files
.SECONDARY : $(TARGET).elf
.PRECIOUS : $(OBJ)
%.elf: $(OBJ)
@echo
@echo $(MSG_LINKING) $@
$(CC) $(ALL_CFLAGS) $^ -o $@ $(LDFLAGS)
# Compile: create object files from C source files
%.o : %.c
@echo $(MSG_COMPILING) $<
$(CC) -c $(ALL_CFLAGS) $< -o $@
# Compile: create object files from C++ source files
%.o : %.cpp
@echo
@echo $(MSG_COMPILING_CPP) $<
$(CC) -c $(ALL_CPPFLAGS) $< -o $@
# Compile: create assembler files from C source files
%.s : %.c
$(CC) -S $(ALL_CFLAGS) $< -o $@
# Compile: create assembler files from C++ source files
%.s : %.cpp
$(CC) -S $(ALL_CPPFLAGS) $< -o $@
# Assemble: create object files from assembler source files
%.o : %.S
@echo
@echo $(MSG_ASSEMBLING) $<
$(CC) -c $(ALL_ASFLAGS) $< -o $@
# Create preprocessed source for use in sending a bug report
%.i : %.c
$(CC) -E -mmcu=$(MCU) -I. $(CFLAGS) $< -o $@
# generate random key
genkey:
@echo "generate individual random key:"
./genkey.sh 512 > key.h
# Clean project
clean:
@echo $(MSG_CLEANING)
$(REMOVE) $(OBJ)
$(REMOVE) $(TARGET).hex
$(REMOVE) $(TARGET).bin
$(REMOVE) $(TARGET).eep
$(REMOVE) $(TARGET).elf
$(REMOVE) $(TARGET).map
$(REMOVE) $(TARGET).sym
$(REMOVE) $(TARGET).lss
$(REMOVE) $(TARGET).lst
$(REMOVE) $(SRC:.c=.s)
$(REMOVE) key.h
$(REMOVEDIR) .dep
# Include the dependency files
-include $(shell mkdir .dep 2>/dev/null) $(wildcard .dep/*)
# Listing of phony targets
.PHONY: all finish sizebefore sizeafter gccversion \
build elf hex eep lss sym \
clean program

26
firmware/avr-mem.sh Executable file
View file

@ -0,0 +1,26 @@
#!/bin/bash
MAXPERCENT=40
IMAGESIZE=$(ls -l $1.bin | awk '{ print $5 }')
FLASHSIZE=$(perl -e "print 0x$(echo -e "#include <avr/io.h>\nFLASHEND" | avr-cpp -mmcu=$2 | tail -n 1 |cut -c3-);")
FLASHSIZE=$[$FLASHSIZE + 1]
PERCENT=$(perl -e "printf('%.2f', $IMAGESIZE.0 / $FLASHSIZE.0 *100.0);" )
PER=$(perl -e "printf('%i', $IMAGESIZE / $FLASHSIZE *$MAXPERCENT);" )
echo "Imagesize: $IMAGESIZE/$FLASHSIZE bytes (${PERCENT}%)"
if [ $IMAGESIZE -gt $FLASHSIZE ];then
echo " WARNING! Your Image is too big for the selected chip. WARNING!"
echo ""
exit 1
else
echo -n " ["
COUNTER=0
while [ $COUNTER -lt $MAXPERCENT ]; do
if [ $COUNTER -lt $PER ]; then
echo -n "="
else
echo -n "-"
fi
let COUNTER=COUNTER+1
done
echo "]"
fi

28
firmware/genkey.sh Executable file
View file

@ -0,0 +1,28 @@
#!/bin/sh
KEYLEN=$1
#header
cat <<END
#ifndef _KEY_H_
#define _KEY_H_
/* this file is automatical generated and should NOT be edited by hand! */
/* 128bit key for encryption */
const uint8_t key_p[512] PROGMEM = {
END
# random key generation
printf "0x%02x" $(($RANDOM % 256))
for ((c = 1; c < KEYLEN; c++))
do
printf ", 0x%02x" $(($RANDOM % 256))
done
# footer
cat <<END
};
#endif /* _KEY_H_ */
END

665
firmware/hidekey.c Normal file
View file

@ -0,0 +1,665 @@
#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <avr/io.h>
#include <avr/interrupt.h>
#include <avr/wdt.h>
#include <avr/pgmspace.h>
#include <avr/eeprom.h>
#include <util/delay.h>
#include <usbdrv.h>
#include "hidekey.h"
int descriptorStringSerial[MAX_SERIAL_LEN+1]; /* plus 1 for USB_STRING_DESCRIPTOR_HEADER() byte */
int descriptorStringSerial_e[MAX_SERIAL_LEN+1] EEMEM = {
USB_STRING_DESCRIPTOR_HEADER(1), '0' /* this is the default serial number and should be changed prior shipping */
};
uint16_t counter_e EEMEM = 0; /* how often the stick has been started/enumerated */
struct slot slots_e[MAX_SLOTS] EEMEM; /* is intitialized dynamically during first enumeration */
#ifdef ENCRYPTION
#include "key.h"
#else
#warning "Encryption is DISABLED! This should only be done for debugging purposes."
#endif /* ENCRYPTION */
struct status status; /* status for USBRQ_VENDOR_GET_STATUS */
struct slot currentSlot;
struct slot updateSlot;
uint16_t currentSlotIndex = 0;
uint16_t updateSlotIndex;
/* used by usbFunctionWrite() */
uint8_t bytesRemaining;
uint8_t bytesOffset;
/* USB report descriptor (length is defined in usbconfig.h)
This has been changed to conform to the USB keyboard boot protocol */
char usbHidReportDescriptor[USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH] PROGMEM = {
0x05, 0x01, // USAGE_PAGE (Generic Desktop)
0x09, 0x06, // USAGE (Keyboard)
0xa1, 0x01, // COLLECTION (Application)
0x05, 0x07, // USAGE_PAGE (Keyboard)
0x19, 0xe0, // USAGE_MINIMUM (Keyboard LeftControl)
0x29, 0xe7, // USAGE_MAXIMUM (Keyboard Right GUI)
0x15, 0x00, // LOGICAL_MINIMUM (0)
0x25, 0x01, // LOGICAL_MAXIMUM (1)
0x75, 0x01, // REPORT_SIZE (1)
0x95, 0x08, // REPORT_COUNT (8)
0x81, 0x02, // INPUT (Data,Var,Abs)
0x95, 0x01, // REPORT_COUNT (1)
0x75, 0x08, // REPORT_SIZE (8)
0x81, 0x03, // INPUT (Cnst,Var,Abs)
0x95, 0x05, // REPORT_COUNT (5)
0x75, 0x01, // REPORT_SIZE (1)
0x05, 0x08, // USAGE_PAGE (LEDs)
0x19, 0x01, // USAGE_MINIMUM (Num Lock)
0x29, 0x05, // USAGE_MAXIMUM (Kana)
0x91, 0x02, // OUTPUT (Data,Var,Abs)
0x95, 0x01, // REPORT_COUNT (1)
0x75, 0x03, // REPORT_SIZE (3)
0x91, 0x03, // OUTPUT (Cnst,Var,Abs)
0x95, 0x06, // REPORT_COUNT (6)
0x75, 0x08, // REPORT_SIZE (8)
0x15, 0x00, // LOGICAL_MINIMUM (0)
0x25, 0x65, // LOGICAL_MAXIMUM (101)
0x05, 0x07, // USAGE_PAGE (Keyboard)
0x19, 0x00, // USAGE_MINIMUM (Reserved (no event indicated))
0x29, 0x65, // USAGE_MAXIMUM (Keyboard Application)
0x81, 0x00, // INPUT (Data,Ary,Abs)
0xc0 // END_COLLECTION
};
/* ASCII to USB scan/usage codes according to German keyboard layout!
Keep in mind to change these for other keyboard layouts! */
const uint8_t asciiKeyMap[][2] PROGMEM = {
{0x2C, 0}, // SPACE (ASCII: 32)
{0x1E, SHIFT_R}, // !
{0x1F, SHIFT_R}, // "
{0x32, 0}, // #
{0x21, SHIFT_R}, // $
{0x22, SHIFT_R}, // %
{0x23, SHIFT_R}, // &
{0x32, SHIFT_R}, // '
{0x25, SHIFT_R}, // (
{0x26, SHIFT_R}, // )
{0x30, SHIFT_R}, // *
{0x30, 0}, // +
{0x36, 0}, // ,
{0x38, 0}, // -
{0x37, 0}, // .
{0x24, SHIFT_R}, // /
{0x27, 0}, // 0
{0x1E, 0}, // 1
{0x1F, 0}, // 2
{0x20, 0}, // 3
{0x21, 0}, // 4
{0x22, 0}, // 5
{0x23, 0}, // 6
{0x24, 0}, // 7
{0x25, 0}, // 8
{0x26, 0}, // 9
{0x37, SHIFT_R}, // :
{0x36, SHIFT_R}, // ;
{0x64, 0}, // <
{0x27, SHIFT_R}, // =
{0x64, SHIFT_R}, // >
{0x2D, SHIFT_R}, // ?
{0x14, ALT_R}, // @
{0x04, SHIFT_R}, // A
{0x05, SHIFT_R}, // B
{0x06, SHIFT_R}, // C
{0x07, SHIFT_R}, // D
{0x08, SHIFT_R}, // E
{0x09, SHIFT_R}, // F
{0x0A, SHIFT_R}, // G
{0x0B, SHIFT_R}, // H
{0x0C, SHIFT_R}, // I
{0x0D, SHIFT_R}, // J
{0x0E, SHIFT_R}, // K
{0x0F, SHIFT_R}, // L
{0x10, SHIFT_R}, // M
{0x11, SHIFT_R}, // N
{0x12, SHIFT_R}, // O
{0x13, SHIFT_R}, // P
{0x14, SHIFT_R}, // Q
{0x15, SHIFT_R}, // R
{0x16, SHIFT_R}, // S
{0x17, SHIFT_R}, // T
{0x18, SHIFT_R}, // U
{0x19, SHIFT_R}, // V
{0x1A, SHIFT_R}, // W
{0x1B, SHIFT_R}, // X
{0x1D, SHIFT_R}, // Y
{0x1C, SHIFT_R}, // Z
{0x25, ALT_R}, // [
{0x2D, ALT_R}, // \ '\\'
{0x26, ALT_R}, // ]
{0x35, SHIFT_R}, // ^
{0x38, SHIFT_R}, // _
{0x2E, 0}, // `
{0x04, 0}, // a
{0x05, 0}, // b
{0x06, 0}, // c
{0x07, 0}, // d
{0x08, 0}, // e
{0x09, 0}, // f
{0x0A, 0}, // g
{0x0B, 0}, // h
{0x0C, 0}, // i
{0x0D, 0}, // j
{0x0E, 0}, // k
{0x0F, 0}, // l
{0x10, 0}, // m
{0x11, 0}, // n
{0x12, 0}, // o
{0x13, 0}, // p
{0x14, 0}, // q
{0x15, 0}, // r
{0x16, 0}, // s
{0x17, 0}, // t
{0x18, 0}, // u
{0x19, 0}, // v
{0x1A, 0}, // w
{0x1B, 0}, // x
{0x1D, 0}, // y
{0x1C, 0}, // z
{0x24, ALT_R}, // {
{0x64, ALT_R}, // |
{0x27, ALT_R}, // }
{0x30, ALT_R} // ~ (ASCII: 126)
};
static uint8_t reportBuffer[8]; /* contains the USB HID report sent to the PC */
static uint8_t idleRate = 0; /* in 4 ms units */
static uint8_t protocolVer = 1; /* 0 is boot protocol, 1 is report protocol */
void pgm_read_block(uint8_t *pTarget, const uint8_t *pSource, size_t len) {
for(size_t i = 0; i < len; i++) {
*pTarget++ = pgm_read_byte(pSource++);
}
}
void getPassword(struct slot *slot, char *str, size_t n) {
switch (slot->type) {
case SLOT_STRING:
case SLOT_GENERATE:
memcpy(str, slot->pass.string, n);
break;
case SLOT_OTP:
snprintf(str, n, "s%u", slot->pass.otp.sequence);
break;
case SLOT_RANDOM:
genPassword(str, MAX_PASS_LEN/2);
break;
default: /* unknown password mode */
str[0] = '\0'; /* empty string */
break;
}
str[n-1] = '\0';
}
void genPassword(char *str, size_t n) {
uint8_t i;
for (i = 0; i < n-1; i++) {
str[i] = '!' + rand() % ('!' - '~'); /* all printable ASCII characters */
}
str[n-1] = '\0';
}
char convToMultiASCII(uint8_t in) {
in -= '!';
in += (in >= 67) ? 94*rand(2) : 94*rand(3);
return in;
}
char convFromMultiASCII(uint8_t in) {
in = in % 94;
in += '!';
return in;
}
void setSlot(struct slot *slot, uint16_t index) {
struct slot tmpSlot = *slot; // TODO workaround?
uint8_t *slotRaw = (uint8_t *) &tmpSlot;
/* prepare slot, on-stick password generation */
if (slot->type == SLOT_GENERATE) {
genPassword(tmpSlot.pass.string, MAX_PASS_LEN/2);
}
#ifdef ENCRYPTION
/* read key */
uint8_t key[sizeof(struct slot)];
pgm_read_block(key, (uint8_t *)(key_p + sizeof(struct slot) * index), sizeof(struct slot));
/* encrypt slot */
for (uint16_t i = 0; i < sizeof(struct slot); i++) {
slotRaw[i] ^= key[i];
}
#endif /* ENCRYPTION */
/* store slot */
eeprom_write_block(slotRaw, &slots_e[index], sizeof(struct slot));
}
void getSlot(struct slot *slot, uint16_t index) {
/* read slot */
uint8_t *slotRaw = (uint8_t *) slot;
eeprom_read_block(slotRaw, &slots_e[index], sizeof(struct slot));
#ifdef ENCRYPTION
/* read key */
uint8_t key[sizeof(struct slot)];
pgm_read_block(key, (uint8_t *)(key_p + sizeof(struct slot) * index), sizeof(struct slot));
/* decrypt key */
for (uint16_t i = 0; i < sizeof(struct slot); i++) {
slotRaw[i] ^= key[i];
}
#endif /* ENCRYPTION */
}
void usbReset() {
DDRB |= (1 << PB0) | (1 << PB1); /* enable USB pins as output */
_delay_ms(15); /* sleeping for 15ms */
DDRB &= ~(1 << PB0) & ~(1 << PB1); /* disbale USB pins as output */
}
void hardwareInit() {
usbReset();
/* LEDs */
DDRC |= (1 << PC0) | (1 << PC1); /* set LED pins as output */
PORTC &= ~(1 << PC0) & ~(1 << PC1); /* set LEDs (active low) */
/* push button */
BTN_DDR &= ~(1 << BTN_BIT1); /* set button pin as input */
BTN_DDR |= (1 << BTN_BIT2); /* set button pin as output */
BTN_PORT |= (1 << BTN_BIT1); /* enable pullup for button */
BTN_PORT &= ~(1 << BTN_BIT2);
#ifdef WRITE_PROTECTION
/* write protect jumper */
WRLOCK_DDR &= ~(1 << WRLOCK_BIT);
WRLOCK_PORT |= (1 << WRLOCK_BIT); /* enable pullup for button */
#endif /* WRITE_PROTECTION */
TCCR0 = (1 << CS02); /* CPU prescaler = 512 */
}
void hidBuildReport(char chr) {
for (int i = 0; i < 8; i++) {
reportBuffer[i] = 0x0; /* clear report */
}
if (chr >= ' ' && chr <= '~') {
uint16_t map = pgm_read_word(asciiKeyMap[chr - ' ']);
reportBuffer[0] = map >> 8; /* modifier */
reportBuffer[2] = map & 0xff; /* key */
}
else switch (chr) {
case 0x8E: // Ä
reportBuffer[0] = SHIFT_R;
case 0x84: // ä
reportBuffer[2] = 0x34;
break;
case 0x99: // Ö
reportBuffer[0] = SHIFT_R;
case 0x94: // ö
reportBuffer[2] = 0x33;
break;
case 0x9A: // Ü
reportBuffer[0] = SHIFT_R;
case 0x81: // ü
reportBuffer[2] = 0x2F;
break;
case '\b':
reportBuffer[2] = 0x2A;
break;
case '\t':
reportBuffer[2] = 0x2B;
break;
case '\n':
reportBuffer[2] = 0x28;
break;
}
}
void hidSendChar(char chr) {
while (!usbInterruptIsReady()); /* wait until previous transmission is finished */
hidBuildReport(chr); /* build HID report buffer for one character */
usbSetInterrupt(reportBuffer, sizeof(reportBuffer));
}
void hidSendString(char *str) {
while (*str) {
hidSendChar(*str); /* send character string one by one */
hidSendChar(0); /* release any keys */
str++;
}
}
usbMsgLen_t usbFunctionDescriptor(struct usbRequest *rq) {
usbMsgLen_t len = 0;
usbMsgPtr = NULL;
/* 3 is the type of string descriptor, in this case the device serial number */
if (rq->wValue.bytes[1] == USBDESCR_STRING && rq->wValue.bytes[0] == 3) {
/* read serial number from eeprom */
eeprom_read_block(descriptorStringSerial, descriptorStringSerial_e, sizeof(descriptorStringSerial));
usbMsgPtr = (uint8_t *) descriptorStringSerial;
len = *((uint8_t *) descriptorStringSerial);
}
return len;
}
uint8_t usbFunctionSetup(uint8_t data[8]) {
usbRequest_t *rq = (void *)data;
usbMsgPtr = reportBuffer;
if ((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_CLASS) {
switch (rq->bRequest) {
case USBRQ_HID_GET_IDLE:
usbMsgPtr = &idleRate;
return 1;
case USBRQ_HID_SET_IDLE:
idleRate = rq->wValue.bytes[1];
return 0;
case USBRQ_HID_GET_REPORT:
hidBuildReport(0);
return sizeof(reportBuffer);
case USBRQ_HID_SET_REPORT:
if (rq->wLength.word == 1) {
status.mode = EXPECT_REPORT;
return USB_NO_MSG;
}
return 0;
case USBRQ_HID_SET_PROTOCOL:
if (rq->wValue.bytes[1] < 1) {
protocolVer = rq->wValue.bytes[1];
}
return 0;
case USBRQ_HID_GET_PROTOCOL:
usbMsgPtr = &protocolVer;
return 1;
}
}
else if ((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_VENDOR) {
switch (rq->bRequest) {
case USBRQ_VENDOR_SET_SERIAL:
if (writable()) {
status.mode = EXPECT_SERIAL;
bytesRemaining = rq->wLength.word & 0xff; /* string length */
bytesOffset = 1; /* first index is reserved for USB_STRING_DESCRIPTOR_HEADER() */
if (bytesRemaining > MAX_SERIAL_LEN) {
status.error = ERROR_OVERFLOW;
return 0;
}
PORTC &= ~(1 << PC1); /* set LED */
return USB_NO_MSG; /* use usbFunctionWrite() */
}
else {
status.error = ERROR_LOCKED;
return 0;
}
case USBRQ_VENDOR_SET_SLOT:
if (writable() || !WRITE_PROTECTION) {
status.mode = EXPECT_SLOT;
updateSlotIndex = rq->wIndex.word;
bytesRemaining = sizeof(struct slot);
bytesOffset = 0;
if (updateSlotIndex >= MAX_SLOTS) {
status.error = ERROR_INVALID_SLOT;
return 0;
}
PORTC &= ~(1 << PC1); /* set LED */
return USB_NO_MSG; /* use usbFunctionWrite() */
}
else {
status.error = ERROR_LOCKED;
return 0;
}
case USBRQ_VENDOR_GET_STATUS: {
status.writable = 0;
if (WRITE_PROTECTION) {
status.writable = (writable()) ? 1 : 2;
}
usbMsgPtr = (uint8_t *) &status;
return sizeof(status);
}
case USBRQ_VENDOR_RESET:
if (!writable() && WRITE_PROTECTION) {
status.error = ERROR_LOCKED;
}
eeprom_write_word(&counter_e, 0);
usbReset(); // TODO check
return 0;
}
}
return 0;
}
uint8_t usbFunctionWrite(uint8_t *data, uint8_t len) {
if(len > bytesRemaining) { /* if this is the last incomplete chunk */
len = bytesRemaining; /* limit to the amount we can store */
}
bytesRemaining -= len;
for(uint8_t i = 0; i < len; i++) {
switch (status.mode) {
case EXPECT_SLOT:
((uint8_t *) &updateSlot)[bytesOffset++] = data[i];
break;
case EXPECT_SERIAL:
descriptorStringSerial[bytesOffset++] = data[i];
break;
case EXPECT_REPORT: // TODO
default: break;
}
}
if (bytesRemaining == 0) { /* store slot into eeprom when completed */
switch (status.mode) {
case EXPECT_SLOT:
setSlot(&updateSlot, updateSlotIndex);
break;
case EXPECT_SERIAL:
descriptorStringSerial[0] = USB_STRING_DESCRIPTOR_HEADER(bytesOffset-1);
eeprom_write_block(descriptorStringSerial, descriptorStringSerial_e, sizeof(descriptorStringSerial));
break;
case EXPECT_REPORT: // TODO
default: break;
}
currentSlotIndex = 0; /* reset slot */
status.mode = IDLE;
status.error = ERROR_SUCCESS;
PORTC |= (1 << PC1); /* clear LED */
return 1;
}
return 0;
}
int main(void) {
uint8_t updateNeeded = 0;
uint8_t idleCounter = 0;
uint8_t len = 0;
uint8_t debounce = 0;
uint16_t pressed = 0;
status.counter = eeprom_read_word(&counter_e);
status.maxSlots = MAX_SLOTS;
status.maxUserLen = MAX_USER_LEN;
status.maxPassLen = MAX_PASS_LEN;
status.maxSerialLen = MAX_SERIAL_LEN;
status.mode = IDLE;
status.error = ERROR_SUCCESS;
/* Initialize EEPROM */
if (status.counter == 0) {
struct slot empty = { SLOT_EMPTY };
struct slot slots[] = {
{ SLOT_STRING, 0, '\t', "HIDeKey v1.0", { .string = "" } },
{ SLOT_RANDOM, 0, '\t', "demo1_random" },
{ SLOT_GENERATE,0, '\t', "demo2_random_gen" },
{ SLOT_STRING, 0, '\t', "demo3_string", { .string = "constant" } },
{ SLOT_OTP, 0, '\t', "demo4_otp", { .otp = { .seed = {1, 2, 3, 4, 5, 6, 7, 8}, .sequence = 0 } } }
};
uint16_t i;
for (i = 0; i < (sizeof(slots) / sizeof(struct slot)); i++) {
setSlot(&slots[i], i);
}
for (; i < MAX_SLOTS; i++) {
setSlot(&empty, i);
}
}
wdt_enable(WDTO_2S); /* enable watchdog timer 2s */
srand((status.counter * 256) % RAND_MAX); /* crypto initialization */
/* increment and store startup counter */
status.counter++;
eeprom_write_word(&counter_e, status.counter);
usbInit(); /* initialize USB stack processing */
hardwareInit(); /* setup io & starts timer */
sei(); /* enable global interrupts */
PORTC |= (1 << PC1); /* disable startup LED */
/* main loop */
for (;;) {
wdt_reset(); /* reset the watchdog */
usbPoll(); /* poll the USB stack */
if (TIFR & (1 << TOV0)) { /* timer0 overflow? */
TIFR = 1 << TOV0; /* reset timer overflow flag */
if (buttonPressed()) pressed++;
else if (debounce > 0) debounce--;
else if (pressed > 0) {
if (pressed < BTN_LONG_PRESS) {
do { /* find next non-empty slot */
currentSlotIndex %= MAX_SLOTS; /* avoid overflow */
getSlot(&currentSlot, currentSlotIndex);
currentSlotIndex++; /* increment slot */
} while (currentSlot.type == SLOT_EMPTY); /* skip empty slots */
}
if (currentSlot.options & SKIP_USER || pressed > BTN_LONG_PRESS) {
char pass[MAX_PASS_LEN];
getPassword(&currentSlot, pass, MAX_PASS_LEN);
if (~currentSlot.options & SKIP_DELIMITER) {
if (currentSlot.delimiter) {
hidSendChar(currentSlot.delimiter);
hidSendChar(0);
}
}
hidSendString(pass);
if (~currentSlot.options & SKIP_RETURN) {
hidSendChar('\n');
hidSendChar(0);
}
if (currentSlot.type == SLOT_OTP) {
currentSlot.pass.otp.sequence++;
setSlot(&currentSlot, currentSlotIndex - 1);
}
if (currentSlot.options & SKIP_RESET) {
currentSlotIndex = 0;
}
len = 0;
}
else {
/* delete old username */
for (uint8_t i = 0; i < len; i++) {
hidSendChar('\b');
hidSendChar(0);
}
/* write new username */
hidSendString(currentSlot.user);
len = strlen(currentSlot.user);
}
pressed = 0;
debounce = 10;
}
if (idleRate != 0) { /* do we need periodic reports? */
if (idleCounter > 3) { /* yes, but not yet */
idleCounter -= 3;
} else { /* yes, it is time now */
updateNeeded = 1;
idleCounter = idleRate;
}
}
}
/* if an update is needed, send the report */
if(updateNeeded && usbInterruptIsReady()) {
updateNeeded = 0;
usbSetInterrupt(reportBuffer, sizeof(reportBuffer));
}
}
return 0;
}

53
firmware/hidekey.h Normal file
View file

@ -0,0 +1,53 @@
#ifndef _HIDEKEY_H_
#define _HIDEKEY_H_
#include "../config.h"
/* Push button */
#define BTN_PORT PORTB
#define BTN_DDR DDRB
#define BTN_PIN PINB
#define BTN_BIT1 3 /* we set PB5 to low and enable pullup on PB3 */
#define BTN_BIT2 5
#define buttonPressed() (~BTN_PIN & (1 << BTN_BIT1))
/* Write lock jumper */
#define WRLOCK_PORT PORTC
#define WRLOCK_DDR DDRC
#define WRLOCK_PIN PINC
#define WRLOCK_BIT 2
#define writable() (~WRLOCK_PIN & (1 << WRLOCK_BIT)) /* eeprom is writable if jumper is set */
/* The LED states */
#define LED_NUM (1 << 0)
#define LED_CAPS (1 << 1)
#define LED_SCROLL (1 << 2)
#define LED_COMPOSE (1 << 3)
#define LED_KANA (1 << 4)
/* The control keys */
#define CTRL_L (1 << 0)
#define SHIFT_L (1 << 1)
#define ALT_L (1 << 2)
#define GUI_L (1 << 3) /* windows logo */
#define CTRL_R (1 << 4)
#define SHIFT_R (1 << 5)
#define ALT_R (1 << 6)
#define GUI_R (1 << 7) /* windows logo */
void usbReset(void);
void hardwareInit(void);
void genPassword(char *str, size_t n);
void getPassword(struct slot *slot, char *str, size_t n);
uint8_t getSeed(void);
void hidBuildReport(char chr);
void hidSendChar(char chr);
void hidSendString(char *str);
void setSlot(struct slot *slot, uint16_t index);
void getSlot(struct slot *slot, uint16_t index);
#endif /* _HIDEKEY_H_ */

10
firmware/key.h Normal file
View file

@ -0,0 +1,10 @@
#ifndef _KEY_H_
#define _KEY_H_
/* this file is automatical generated and should NOT be edited by hand! */
/* 128bit key for encryption */
const uint8_t key_p[512] PROGMEM = {
0x81, 0x71, 0x86, 0xe2, 0x72, 0x6e, 0x26, 0x55, 0x73, 0x71, 0xc2, 0x3b, 0x87, 0x01, 0xa9, 0xfe, 0xa7, 0x65, 0x5c, 0x41, 0xa2, 0x10, 0x5a, 0xaf, 0x23, 0xed, 0xcd, 0xee, 0xc5, 0xb2, 0xd5, 0x40, 0xbb, 0x14, 0x8c, 0x74, 0xf3, 0xee, 0x51, 0x5d, 0xe7, 0x62, 0x62, 0x0c, 0x4e, 0xbd, 0x5c, 0x23, 0x64, 0x6f, 0x11, 0x95, 0x6d, 0xbb, 0xf2, 0xa3, 0x3d, 0xd3, 0x99, 0xb3, 0xa6, 0x2e, 0x0f, 0xce, 0x14, 0xff, 0xe6, 0x28, 0x24, 0xd5, 0xb8, 0x07, 0x7c, 0x10, 0xf6, 0xa0, 0x2a, 0xc5, 0xca, 0x23, 0x8f, 0xf6, 0xfd, 0x3d, 0x2b, 0x33, 0xa7, 0x02, 0xa6, 0x93, 0xb3, 0x4b, 0x9d, 0x34, 0xcf, 0x40, 0x26, 0xa2, 0xc5, 0x33, 0x4c, 0xba, 0x1a, 0x57, 0x94, 0xd2, 0x45, 0xa2, 0x0a, 0xa0, 0x62, 0x93, 0xb2, 0x3b, 0x45, 0xdb, 0x94, 0x6d, 0xf9, 0xfc, 0xe4, 0xea, 0x83, 0xd0, 0x6c, 0xc3, 0x6e, 0x1b, 0x8f, 0xcf, 0xab, 0x8f, 0x4c, 0x2a, 0x59, 0xe4, 0x9f, 0xcd, 0xeb, 0x02, 0xda, 0x19, 0xf5, 0x24, 0x34, 0xa0, 0xcc, 0xf8, 0x25, 0x59, 0xc8, 0x6a, 0x86, 0x91, 0xc1, 0x3f, 0x69, 0x73, 0x33, 0x6b, 0x98, 0x88, 0x31, 0xa0, 0x4a, 0x89, 0xdf, 0x5e, 0xdc, 0xe6, 0x4b, 0x6c, 0xec, 0xbf, 0xb3, 0xf3, 0xca, 0x51, 0x0d, 0x92, 0x8e, 0x73, 0x33, 0x6c, 0xe8, 0x9f, 0x91, 0xe5, 0x0a, 0xd9, 0x23, 0x8a, 0x5c, 0x1b, 0xf4, 0x07, 0x40, 0x1c, 0xee, 0x28, 0xd9, 0x62, 0x3f, 0x1d, 0x06, 0xa2, 0x5a, 0xd0, 0x05, 0x39, 0xdc, 0x96, 0xa2, 0x56, 0xef, 0x5f, 0x37, 0xc3, 0x57, 0x46, 0x54, 0x22, 0x26, 0x71, 0x3b, 0xe2, 0x0a, 0xee, 0x76, 0xe9, 0xc5, 0x3d, 0x45, 0x27, 0xe6, 0xa3, 0x80, 0x75, 0xbc, 0x37, 0xe6, 0x5f, 0x4c, 0x9d, 0xbf, 0xa6, 0xd7, 0xad, 0xfd, 0x7b, 0xb9, 0xe1, 0xab, 0xfd, 0xdc, 0x57, 0x64, 0xc2, 0x27, 0xd5, 0x19, 0x9f, 0x75, 0x16, 0xf4, 0x0f, 0xe2, 0x4c, 0x5d, 0xac, 0x9e, 0x06, 0x89, 0x1d, 0x88, 0x92, 0x48, 0x66, 0x70, 0x6e, 0x1e, 0xc6, 0x30, 0x62, 0x3d, 0x6b, 0x5e, 0x32, 0x73, 0x9c, 0x83, 0xa4, 0xc0, 0x74, 0x6e, 0xd3, 0x50, 0xab, 0x2e, 0xeb, 0x5e, 0x8a, 0xf6, 0x79, 0xf1, 0xbd, 0xd2, 0x4e, 0xcc, 0x75, 0x2c, 0x61, 0x80, 0xfc, 0x5e, 0x7a, 0xe6, 0x93, 0xe4, 0x8f, 0x3b, 0xf1, 0xab, 0x5f, 0x33, 0x2e, 0x78, 0xec, 0xb7, 0x8e, 0x00, 0x4a, 0xd6, 0xd5, 0x51, 0x49, 0x76, 0x3f, 0xbf, 0x83, 0x2f, 0xbb, 0x5c, 0xfa, 0xae, 0x0a, 0x97, 0x37, 0xe6, 0xb7, 0x5d, 0x3e, 0x1d, 0xd1, 0x58, 0xe9, 0x75, 0x76, 0x92, 0xca, 0x4a, 0xad, 0xfc, 0x64, 0x9e, 0x78, 0x95, 0xcd, 0x68, 0x3c, 0x07, 0xc9, 0x7f, 0x53, 0x86, 0xc2, 0x4a, 0xdd, 0xd0, 0x8c, 0x15, 0x22, 0x3e, 0x51, 0x1c, 0x78, 0x37, 0x8d, 0x75, 0x5b, 0xac, 0x65, 0x5e, 0x5a, 0x6c, 0x31, 0xef, 0xc2, 0x67, 0xbd, 0x29, 0x24, 0x95, 0x19, 0x52, 0x4f, 0x82, 0xd4, 0x51, 0x81, 0xad, 0xa1, 0xe0, 0x30, 0xc8, 0x2f, 0xab, 0x62, 0xaa, 0x1d, 0xff, 0xc8, 0x72, 0xe0, 0x83, 0xb2, 0x3d, 0xd6, 0xfd, 0x10, 0x77, 0xb0, 0xf5, 0x2f, 0x95, 0xa1, 0xd7, 0xd6, 0x89, 0x8b, 0xac, 0xed, 0x61, 0x5f, 0x84, 0x85, 0xcc, 0x87, 0xe4, 0x08, 0xd0, 0xe0, 0x1c, 0x6a, 0x6f, 0xb1, 0x08, 0x14, 0x38, 0x23, 0x18, 0x09, 0x60, 0x9e, 0x9b, 0xbc, 0xbd, 0x8e, 0xaf, 0x95, 0xec, 0x82, 0x92, 0x2d, 0x0f, 0x4f, 0x3e, 0x64, 0xa3, 0x51, 0x4a, 0xe3, 0xa7, 0x27, 0x58, 0xac, 0xb3, 0x23, 0xa4, 0xab, 0xaf, 0x4e, 0x62, 0x95, 0xf4, 0x6f, 0x89, 0x7f, 0xf5, 0x80, 0x4e, 0x93, 0x71, 0xc3, 0xd2, 0x35, 0x23, 0x26, 0xd9, 0xe5, 0x5a, 0x43};
#endif /* _KEY_H_ */

376
firmware/usbconfig.h Normal file
View file

@ -0,0 +1,376 @@
/* Name: usbconfig.h
* Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers
* Author: Christian Starkjohann
* Creation Date: 2005-04-01
* Tabsize: 4
* Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH
* License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt)
* This Revision: $Id: usbconfig-prototype.h 785 2010-05-30 17:57:07Z cs $
*/
#ifndef __usbconfig_h_included__
#define __usbconfig_h_included__
/*
General Description:
This file is an example configuration (with inline documentation) for the USB
driver. It configures V-USB for USB D+ connected to Port D bit 2 (which is
also hardware interrupt 0 on many devices) and USB D- to Port D bit 4. You may
wire the lines to any other port, as long as D+ is also wired to INT0 (or any
other hardware interrupt, as long as it is the highest level interrupt, see
section at the end of this file).
+ To create your own usbconfig.h file, copy this file to your project's
+ firmware source directory) and rename it to "usbconfig.h".
+ Then edit it accordingly.
*/
/* ---------------------------- Hardware Config ---------------------------- */
#define USB_CFG_IOPORTNAME B
/* This is the port where the USB bus is connected. When you configure it to
* "B", the registers PORTB, PINB and DDRB will be used.
*/
#define USB_CFG_DMINUS_BIT 0
/* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected.
* This may be any bit in the port.
*/
#define USB_CFG_DPLUS_BIT 1
/* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected.
* This may be any bit in the port. Please note that D+ must also be connected
* to interrupt pin INT0! [You can also use other interrupts, see section
* "Optional MCU Description" below, or you can connect D- to the interrupt, as
* it is required if you use the USB_COUNT_SOF feature. If you use D- for the
* interrupt, the USB interrupt will also be triggered at Start-Of-Frame
* markers every millisecond.]
*/
#define USB_CFG_CLOCK_KHZ 12000
/* Clock rate of the AVR in kHz. Legal values are 12000, 12800, 15000, 16000,
* 16500, 18000 and 20000. The 12.8 MHz and 16.5 MHz versions of the code
* require no crystal, they tolerate +/- 1% deviation from the nominal
* frequency. All other rates require a precision of 2000 ppm and thus a
* crystal!
* Since F_CPU should be defined to your actual clock rate anyway, you should
* not need to modify this setting.
*/
#define USB_CFG_CHECK_CRC 0
/* Define this to 1 if you want that the driver checks integrity of incoming
* data packets (CRC checks). CRC checks cost quite a bit of code size and are
* currently only available for 18 MHz crystal clock. You must choose
* USB_CFG_CLOCK_KHZ = 18000 if you enable this option.
*/
/* ----------------------- Optional Hardware Config ------------------------ */
/* #define USB_CFG_PULLUP_IOPORTNAME D */
/* If you connect the 1.5k pullup resistor from D- to a port pin instead of
* V+, you can connect and disconnect the device from firmware by calling
* the macros usbDeviceConnect() and usbDeviceDisconnect() (see usbdrv.h).
* This constant defines the port on which the pullup resistor is connected.
*/
/* #define USB_CFG_PULLUP_BIT 4 */
/* This constant defines the bit number in USB_CFG_PULLUP_IOPORT (defined
* above) where the 1.5k pullup resistor is connected. See description
* above for details.
*/
/* --------------------------- Functional Range ---------------------------- */
#define USB_CFG_HAVE_INTRIN_ENDPOINT 1
/* Define this to 1 if you want to compile a version with two endpoints: The
* default control endpoint 0 and an interrupt-in endpoint (any other endpoint
* number).
*/
#define USB_CFG_HAVE_INTRIN_ENDPOINT3 0
/* Define this to 1 if you want to compile a version with three endpoints: The
* default control endpoint 0, an interrupt-in endpoint 3 (or the number
* configured below) and a catch-all default interrupt-in endpoint as above.
* You must also define USB_CFG_HAVE_INTRIN_ENDPOINT to 1 for this feature.
*/
#define USB_CFG_EP3_NUMBER 3
/* If the so-called endpoint 3 is used, it can now be configured to any other
* endpoint number (except 0) with this macro. Default if undefined is 3.
*/
/* #define USB_INITIAL_DATATOKEN USBPID_DATA1 */
/* The above macro defines the startup condition for data toggling on the
* interrupt/bulk endpoints 1 and 3. Defaults to USBPID_DATA1.
* Since the token is toggled BEFORE sending any data, the first packet is
* sent with the oposite value of this configuration!
*/
#define USB_CFG_IMPLEMENT_HALT 0
/* Define this to 1 if you also want to implement the ENDPOINT_HALT feature
* for endpoint 1 (interrupt endpoint). Although you may not need this feature,
* it is required by the standard. We have made it a config option because it
* bloats the code considerably.
*/
#define USB_CFG_SUPPRESS_INTR_CODE 0
/* Define this to 1 if you want to declare interrupt-in endpoints, but don't
* want to send any data over them. If this macro is defined to 1, functions
* usbSetInterrupt() and usbSetInterrupt3() are omitted. This is useful if
* you need the interrupt-in endpoints in order to comply to an interface
* (e.g. HID), but never want to send any data. This option saves a couple
* of bytes in flash memory and the transmit buffers in RAM.
*/
#define USB_CFG_INTR_POLL_INTERVAL 10
/* If you compile a version with endpoint 1 (interrupt-in), this is the poll
* interval. The value is in milliseconds and must not be less than 10 ms for
* low speed devices.
*/
#define USB_CFG_IS_SELF_POWERED 0
/* Define this to 1 if the device has its own power supply. Set it to 0 if the
* device is powered from the USB bus.
*/
#define USB_CFG_MAX_BUS_POWER 100
/* Set this variable to the maximum USB bus power consumption of your device.
* The value is in milliamperes. [It will be divided by two since USB
* communicates power requirements in units of 2 mA.]
*/
#define USB_CFG_IMPLEMENT_FN_WRITE 1
/* Set this to 1 if you want usbFunctionWrite() to be called for control-out
* transfers. Set it to 0 if you don't need it and want to save a couple of
* bytes.
*/
#define USB_CFG_IMPLEMENT_FN_READ 0
/* Set this to 1 if you need to send control replies which are generated
* "on the fly" when usbFunctionRead() is called. If you only want to send
* data from a static buffer, set it to 0 and return the data from
* usbFunctionSetup(). This saves a couple of bytes.
*/
#define USB_CFG_IMPLEMENT_FN_WRITEOUT 0
/* Define this to 1 if you want to use interrupt-out (or bulk out) endpoints.
* You must implement the function usbFunctionWriteOut() which receives all
* interrupt/bulk data sent to any endpoint other than 0. The endpoint number
* can be found in 'usbRxToken'.
*/
#define USB_CFG_HAVE_FLOWCONTROL 0
/* Define this to 1 if you want flowcontrol over USB data. See the definition
* of the macros usbDisableAllRequests() and usbEnableAllRequests() in
* usbdrv.h.
*/
#define USB_CFG_DRIVER_FLASH_PAGE 0
/* If the device has more than 64 kBytes of flash, define this to the 64 k page
* where the driver's constants (descriptors) are located. Or in other words:
* Define this to 1 for boot loaders on the ATMega128.
*/
#define USB_CFG_LONG_TRANSFERS 0
/* Define this to 1 if you want to send/receive blocks of more than 254 bytes
* in a single control-in or control-out transfer. Note that the capability
* for long transfers increases the driver size.
*/
/* #define USB_RX_USER_HOOK(data, len) if(usbRxToken == (uchar)USBPID_SETUP) blinkLED(); */
/* This macro is a hook if you want to do unconventional things. If it is
* defined, it's inserted at the beginning of received message processing.
* If you eat the received message and don't want default processing to
* proceed, do a return after doing your things. One possible application
* (besides debugging) is to flash a status LED on each packet.
*/
/* #define USB_RESET_HOOK(resetStarts) if(!resetStarts){hadUsbReset();} */
/* This macro is a hook if you need to know when an USB RESET occurs. It has
* one parameter which distinguishes between the start of RESET state and its
* end.
*/
/* #define USB_SET_ADDRESS_HOOK() hadAddressAssigned(); */
/* This macro (if defined) is executed when a USB SET_ADDRESS request was
* received.
*/
#define USB_COUNT_SOF 0
/* define this macro to 1 if you need the global variable "usbSofCount" which
* counts SOF packets. This feature requires that the hardware interrupt is
* connected to D- instead of D+.
*/
/* #ifdef __ASSEMBLER__
* macro myAssemblerMacro
* in YL, TCNT0
* sts timer0Snapshot, YL
* endm
* #endif
* #define USB_SOF_HOOK myAssemblerMacro
* This macro (if defined) is executed in the assembler module when a
* Start Of Frame condition is detected. It is recommended to define it to
* the name of an assembler macro which is defined here as well so that more
* than one assembler instruction can be used. The macro may use the register
* YL and modify SREG. If it lasts longer than a couple of cycles, USB messages
* immediately after an SOF pulse may be lost and must be retried by the host.
* What can you do with this hook? Since the SOF signal occurs exactly every
* 1 ms (unless the host is in sleep mode), you can use it to tune OSCCAL in
* designs running on the internal RC oscillator.
* Please note that Start Of Frame detection works only if D- is wired to the
* interrupt, not D+. THIS IS DIFFERENT THAN MOST EXAMPLES!
*/
#define USB_CFG_CHECK_DATA_TOGGLING 0
/* define this macro to 1 if you want to filter out duplicate data packets
* sent by the host. Duplicates occur only as a consequence of communication
* errors, when the host does not receive an ACK. Please note that you need to
* implement the filtering yourself in usbFunctionWriteOut() and
* usbFunctionWrite(). Use the global usbCurrentDataToken and a static variable
* for each control- and out-endpoint to check for duplicate packets.
*/
#define USB_CFG_HAVE_MEASURE_FRAME_LENGTH 0
/* define this macro to 1 if you want the function usbMeasureFrameLength()
* compiled in. This function can be used to calibrate the AVR's RC oscillator.
*/
#define USB_USE_FAST_CRC 0
/* The assembler module has two implementations for the CRC algorithm. One is
* faster, the other is smaller. This CRC routine is only used for transmitted
* messages where timing is not critical. The faster routine needs 31 cycles
* per byte while the smaller one needs 61 to 69 cycles. The faster routine
* may be worth the 32 bytes bigger code size if you transmit lots of data and
* run the AVR close to its limit.
*/
/* -------------------------- Device Description --------------------------- */
#define USB_CFG_VENDOR_ID 0xc0, 0x16 /* = 0x16c0 = 5824 = voti.nl */
/* USB vendor ID for the device, low byte first. If you have registered your
* own Vendor ID, define it here. Otherwise you may use one of obdev's free
* shared VID/PID pairs. Be sure to read USB-IDs-for-free.txt for rules!
* *** IMPORTANT NOTE ***
* This template uses obdev's shared VID/PID pair for Vendor Class devices
* with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand
* the implications!
*/
#define USB_CFG_DEVICE_ID 0xdc, 0x05 /* = 0x05dc = 1500 */
/* This is the ID of the product, low byte first. It is interpreted in the
* scope of the vendor ID. If you have registered your own VID with usb.org
* or if you have licensed a PID from somebody else, define it here. Otherwise
* you may use one of obdev's free shared VID/PID pairs. See the file
* USB-IDs-for-free.txt for details!
* *** IMPORTANT NOTE ***
* This template uses obdev's shared VID/PID pair for Vendor Class devices
* with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand
* the implications!
*/
#define USB_CFG_DEVICE_VERSION 0x01, 0x01
/* Version number of the device: Minor number first, then major number.
*/
#define USB_CFG_VENDOR_NAME '/', 'd', 'e', 'v', '/', 'n', 'u', 'l', 'l', 'l'
#define USB_CFG_VENDOR_NAME_LEN 10
/* These two values define the vendor name returned by the USB device. The name
* must be given as a list of characters under single quotes. The characters
* are interpreted as Unicode (UTF-16) entities.
* If you don't want a vendor name string, undefine these macros.
* ALWAYS define a vendor name containing your Internet domain name if you use
* obdev's free shared VID/PID pair. See the file USB-IDs-for-free.txt for
* details.
*/
#define USB_CFG_DEVICE_NAME 'H', 'I', 'D', 'e', 'K', 'e', 'y'
#define USB_CFG_DEVICE_NAME_LEN 7
/* Same as above for the device name. If you don't want a device name, undefine
* the macros. See the file USB-IDs-for-free.txt before you assign a name if
* you use a shared VID/PID.
*/
#define USB_CFG_SERIAL_NUMBER '0', '0', '0', '1'
#define USB_CFG_SERIAL_NUMBER_LEN 4
/* Same as above for the serial number. If you don't want a serial number,
* undefine the macros.
* It may be useful to provide the serial number through other means than at
* compile time. See the section about descriptor properties below for how
* to fine tune control over USB descriptors such as the string descriptor
* for the serial number.
*/
#define USB_CFG_DEVICE_CLASS 0 /* set to 0 if deferred to interface */
#define USB_CFG_DEVICE_SUBCLASS 0
/* See USB specification if you want to conform to an existing device class.
* Class 0xff is "vendor specific".
*/
#define USB_CFG_INTERFACE_CLASS 3 /* define class here if not at device level */
#define USB_CFG_INTERFACE_SUBCLASS 1
#define USB_CFG_INTERFACE_PROTOCOL 0
/* See USB specification if you want to conform to an existing device class or
* protocol. The following classes must be set at interface level:
* HID class is 3, no subclass and protocol required (but may be useful!)
* CDC class is 2, use subclass 2 and protocol 1 for ACM
*/
#define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH 63
/* Define this to the length of the HID report descriptor, if you implement
* an HID device. Otherwise don't define it or define it to 0.
* If you use this define, you must add a PROGMEM character array named
* "usbHidReportDescriptor" to your code which contains the report descriptor.
* Don't forget to keep the array and this define in sync!
*/
/* #define USB_PUBLIC static */
/* Use the define above if you #include usbdrv.c instead of linking against it.
* This technique saves a couple of bytes in flash memory.
*/
/* ------------------- Fine Control over USB Descriptors ------------------- */
/* If you don't want to use the driver's default USB descriptors, you can
* provide our own. These can be provided as (1) fixed length static data in
* flash memory, (2) fixed length static data in RAM or (3) dynamically at
* runtime in the function usbFunctionDescriptor(). See usbdrv.h for more
* information about this function.
* Descriptor handling is configured through the descriptor's properties. If
* no properties are defined or if they are 0, the default descriptor is used.
* Possible properties are:
* + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched
* at runtime via usbFunctionDescriptor(). If the usbMsgPtr mechanism is
* used, the data is in FLASH by default. Add property USB_PROP_IS_RAM if
* you want RAM pointers.
* + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found
* in static memory is in RAM, not in flash memory.
* + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash),
* the driver must know the descriptor's length. The descriptor itself is
* found at the address of a well known identifier (see below).
* List of static descriptor names (must be declared PROGMEM if in flash):
* char usbDescriptorDevice[];
* char usbDescriptorConfiguration[];
* char usbDescriptorHidReport[];
* char usbDescriptorString0[];
* int usbDescriptorStringVendor[];
* int usbDescriptorStringDevice[];
* int usbDescriptorStringSerialNumber[];
* Other descriptors can't be provided statically, they must be provided
* dynamically at runtime.
*
* Descriptor properties are or-ed or added together, e.g.:
* #define USB_CFG_DESCR_PROPS_DEVICE (USB_PROP_IS_RAM | USB_PROP_LENGTH(18))
*
* The following descriptors are defined:
* USB_CFG_DESCR_PROPS_DEVICE
* USB_CFG_DESCR_PROPS_CONFIGURATION
* USB_CFG_DESCR_PROPS_STRINGS
* USB_CFG_DESCR_PROPS_STRING_0
* USB_CFG_DESCR_PROPS_STRING_VENDOR
* USB_CFG_DESCR_PROPS_STRING_PRODUCT
* USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER
* USB_CFG_DESCR_PROPS_HID
* USB_CFG_DESCR_PROPS_HID_REPORT
* USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver)
*
* Note about string descriptors: String descriptors are not just strings, they
* are Unicode strings prefixed with a 2 byte header. Example:
* int serialNumberDescriptor[] = {
* USB_STRING_DESCRIPTOR_HEADER(6),
* 'S', 'e', 'r', 'i', 'a', 'l'
* };
*/
#define USB_CFG_DESCR_PROPS_DEVICE 0
#define USB_CFG_DESCR_PROPS_CONFIGURATION 0
#define USB_CFG_DESCR_PROPS_STRINGS 0
#define USB_CFG_DESCR_PROPS_STRING_0 0
#define USB_CFG_DESCR_PROPS_STRING_VENDOR 0
#define USB_CFG_DESCR_PROPS_STRING_PRODUCT 0
#define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER (USB_PROP_IS_DYNAMIC | USB_PROP_IS_RAM)
#define USB_CFG_DESCR_PROPS_HID 0
#define USB_CFG_DESCR_PROPS_HID_REPORT 0
#define USB_CFG_DESCR_PROPS_UNKNOWN 0
/* ----------------------- Optional MCU Description ------------------------ */
/* The following configurations have working defaults in usbdrv.h. You
* usually don't need to set them explicitly. Only if you want to run
* the driver on a device which is not yet supported or with a compiler
* which is not fully supported (such as IAR C) or if you use a differnt
* interrupt than INT0, you may have to define some of these.
*/
/* #define USB_INTR_CFG MCUCR */
/* #define USB_INTR_CFG_SET ((1 << ISC00) | (1 << ISC01)) */
/* #define USB_INTR_CFG_CLR 0 */
/* #define USB_INTR_ENABLE GIMSK */
/* #define USB_INTR_ENABLE_BIT INT0 */
/* #define USB_INTR_PENDING GIFR */
/* #define USB_INTR_PENDING_BIT INTF0 */
/* #define USB_INTR_VECTOR INT0_vect */
#endif /* __usbconfig_h_included__ */

1
firmware/usbdrv Symbolic link
View file

@ -0,0 +1 @@
../vusb/usbdrv/