Add ChibiOS support (USB stack + support files).

diff --git a/tmk_core/common/chibios/bootloader.c b/tmk_core/common/chibios/bootloader.c
new file mode 100644 (file)
index 0000000..6c34e2e
--- /dev/null
+++ b/tmk_core/common/chibios/bootloader.c
@@ -0,0 +1,7 @@
+/* TODO */
+/* ... chip dependent ... */
+
+#include "bootloader.h"
+
+
+void bootloader_jump(void) {}

diff --git a/tmk_core/common/chibios/printf.c b/tmk_core/common/chibios/printf.c
new file mode 100644 (file)
index 0000000..72e3d4f
--- /dev/null
+++ b/tmk_core/common/chibios/printf.c
@@ -0,0 +1,240 @@
+/*
+ * found at: http://www.sparetimelabs.com/tinyprintf/tinyprintf.php
+ * and:      http://www.sparetimelabs.com/printfrevisited/printfrevisited.php
+ */
+
+/*
+File: printf.c
+
+Copyright (C) 2004  Kustaa Nyholm
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+*/
+
+#include "printf.h"
+
+typedef void (*putcf) (void*,char);
+static putcf stdout_putf;
+static void* stdout_putp;
+
+// this adds cca 400 bytes
+#define PRINTF_LONG_SUPPORT
+
+#ifdef PRINTF_LONG_SUPPORT
+
+static void uli2a(unsigned long int num, unsigned int base, int uc,char * bf)
+    {
+    int n=0;
+    unsigned int d=1;
+    while (num/d >= base)
+        d*=base;         
+    while (d!=0) {
+        int dgt = num / d;
+        num%=d;
+        d/=base;
+        if (n || dgt>0|| d==0) {
+            *bf++ = dgt+(dgt<10 ? '0' : (uc ? 'A' : 'a')-10);
+            ++n;
+            }
+        }
+    *bf=0;
+    }
+
+static void li2a (long num, char * bf)
+    {
+    if (num<0) {
+        num=-num;
+        *bf++ = '-';
+        }
+    uli2a(num,10,0,bf);
+    }
+
+#endif
+
+static void ui2a(unsigned int num, unsigned int base, int uc,char * bf)
+    {
+    int n=0;
+    unsigned int d=1;
+    while (num/d >= base)
+        d*=base;        
+    while (d!=0) {
+        int dgt = num / d;
+        num%= d;
+        d/=base;
+        if (n || dgt>0 || d==0) {
+            *bf++ = dgt+(dgt<10 ? '0' : (uc ? 'A' : 'a')-10);
+            ++n;
+            }
+        }
+    *bf=0;
+    }
+
+static void i2a (int num, char * bf)
+    {
+    if (num<0) {
+        num=-num;
+        *bf++ = '-';
+        }
+    ui2a(num,10,0,bf);
+    }
+
+static int a2d(char ch)
+    {
+    if (ch>='0' && ch<='9') 
+        return ch-'0';
+    else if (ch>='a' && ch<='f')
+        return ch-'a'+10;
+    else if (ch>='A' && ch<='F')
+        return ch-'A'+10;
+    else return -1;
+    }
+
+static char a2i(char ch, char** src,int base,int* nump)
+    {
+    char* p= *src;
+    int num=0;
+    int digit;
+    while ((digit=a2d(ch))>=0) {
+        if (digit>base) break;
+        num=num*base+digit;
+        ch=*p++;
+        }
+    *src=p;
+    *nump=num;
+    return ch;
+    }
+
+static void putchw(void* putp,putcf putf,int n, char z, char* bf)
+    {
+    char fc=z? '0' : ' ';
+    char ch;
+    char* p=bf;
+    while (*p++ && n > 0)
+        n--;
+    while (n-- > 0) 
+        putf(putp,fc);
+    while ((ch= *bf++))
+        putf(putp,ch);
+    }
+
+void tfp_format(void* putp,putcf putf,char *fmt, va_list va)
+    {
+    char bf[12];
+    
+    char ch;
+
+
+    while ((ch=*(fmt++))) {
+        if (ch!='%') 
+            putf(putp,ch);
+        else {
+            char lz=0;
+#ifdef  PRINTF_LONG_SUPPORT
+            char lng=0;
+#endif
+            int w=0;
+            ch=*(fmt++);
+            if (ch=='0') {
+                ch=*(fmt++);
+                lz=1;
+                }
+            if (ch>='0' && ch<='9') {
+                ch=a2i(ch,&fmt,10,&w);
+                }
+#ifdef  PRINTF_LONG_SUPPORT
+            if (ch=='l') {
+                ch=*(fmt++);
+                lng=1;
+            }
+#endif
+            switch (ch) {
+                case 0: 
+                    goto abort;
+                case 'u' : {
+#ifdef  PRINTF_LONG_SUPPORT
+                    if (lng)
+                        uli2a(va_arg(va, unsigned long int),10,0,bf);
+                    else
+#endif
+                    ui2a(va_arg(va, unsigned int),10,0,bf);
+                    putchw(putp,putf,w,lz,bf);
+                    break;
+                    }
+                case 'd' :  {
+#ifdef  PRINTF_LONG_SUPPORT
+                    if (lng)
+                        li2a(va_arg(va, unsigned long int),bf);
+                    else
+#endif
+                    i2a(va_arg(va, int),bf);
+                    putchw(putp,putf,w,lz,bf);
+                    break;
+                    }
+                case 'x': case 'X' : 
+#ifdef  PRINTF_LONG_SUPPORT
+                    if (lng)
+                        uli2a(va_arg(va, unsigned long int),16,(ch=='X'),bf);
+                    else
+#endif
+                    ui2a(va_arg(va, unsigned int),16,(ch=='X'),bf);
+                    putchw(putp,putf,w,lz,bf);
+                    break;
+                case 'c' : 
+                    putf(putp,(char)(va_arg(va, int)));
+                    break;
+                case 's' : 
+                    putchw(putp,putf,w,0,va_arg(va, char*));
+                    break;
+                case '%' :
+                    putf(putp,ch);
+                default:
+                    break;
+                }
+            }
+        }
+    abort:;
+    }
+
+
+void init_printf(void* putp,void (*putf) (void*,char))
+    {
+    stdout_putf=putf;
+    stdout_putp=putp;
+    }
+
+void tfp_printf(char *fmt, ...)
+    {
+    va_list va;
+    va_start(va,fmt);
+    tfp_format(stdout_putp,stdout_putf,fmt,va);
+    va_end(va);
+    }
+
+static void putcp(void* p,char c)
+    {
+    *(*((char**)p))++ = c;
+    }
+
+
+
+void tfp_sprintf(char* s,char *fmt, ...)
+    {
+    va_list va;
+    va_start(va,fmt);
+    tfp_format(&s,putcp,fmt,va);
+    putcp(&s,0);
+    va_end(va);
+    }

diff --git a/tmk_core/common/chibios/printf.h b/tmk_core/common/chibios/printf.h
new file mode 100644 (file)
index 0000000..0081319
--- /dev/null
+++ b/tmk_core/common/chibios/printf.h
@@ -0,0 +1,111 @@
+/*
+ * found at: http://www.sparetimelabs.com/tinyprintf/tinyprintf.php
+ * and:      http://www.sparetimelabs.com/printfrevisited/printfrevisited.php
+ */
+
+/*
+File: printf.h
+
+Copyright (C) 2004  Kustaa Nyholm
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
+See the GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+This library is realy just two files: 'printf.h' and 'printf.c'.
+
+They provide a simple and small (+200 loc) printf functionality to 
+be used in embedded systems.
+
+I've found them so usefull in debugging that I do not bother with a 
+debugger at all.
+
+They are distributed in source form, so to use them, just compile them 
+into your project. 
+
+Two printf variants are provided: printf and sprintf. 
+
+The formats supported by this implementation are: 'd' 'u' 'c' 's' 'x' 'X'.
+
+Zero padding and field width are also supported.
+
+If the library is compiled with 'PRINTF_SUPPORT_LONG' defined then the 
+long specifier is also
+supported. Note that this will pull in some long math routines (pun intended!)
+and thus make your executable noticably longer.
+
+The memory foot print of course depends on the target cpu, compiler and 
+compiler options, but a rough guestimate (based on a H8S target) is about 
+1.4 kB for code and some twenty 'int's and 'char's, say 60 bytes of stack space. 
+Not too bad. Your milage may vary. By hacking the source code you can 
+get rid of some hunred bytes, I'm sure, but personally I feel the balance of 
+functionality and flexibility versus  code size is close to optimal for
+many embedded systems.
+
+To use the printf you need to supply your own character output function, 
+something like :
+
+       void putc ( void* p, char c)
+               {
+               while (!SERIAL_PORT_EMPTY) ;
+               SERIAL_PORT_TX_REGISTER = c;
+               }
+
+Before you can call printf you need to initialize it to use your 
+character output function with something like:
+
+       init_printf(NULL,putc);
+
+Notice the 'NULL' in 'init_printf' and the parameter 'void* p' in 'putc', 
+the NULL (or any pointer) you pass into the 'init_printf' will eventually be 
+passed to your 'putc' routine. This allows you to pass some storage space (or 
+anything realy) to the character output function, if necessary. 
+This is not often needed but it was implemented like that because it made 
+implementing the sprintf function so neat (look at the source code).
+
+The code is re-entrant, except for the 'init_printf' function, so it 
+is safe to call it from interupts too, although this may result in mixed output. 
+If you rely on re-entrancy, take care that your 'putc' function is re-entrant!
+
+The printf and sprintf functions are actually macros that translate to 
+'tfp_printf' and 'tfp_sprintf'. This makes it possible
+to use them along with 'stdio.h' printf's in a single source file. 
+You just need to undef the names before you include the 'stdio.h'.
+Note that these are not function like macros, so if you have variables
+or struct members with these names, things will explode in your face.
+Without variadic macros this is the best we can do to wrap these
+fucnction. If it is a problem just give up the macros and use the
+functions directly or rename them.
+
+For further details see source code.
+
+regs Kusti, 23.10.2004
+*/
+
+
+#ifndef __TFP_PRINTF__
+#define __TFP_PRINTF__
+
+#include <stdarg.h>
+
+void init_printf(void* putp,void (*putf) (void*,char));
+
+void tfp_printf(char *fmt, ...);
+void tfp_sprintf(char* s,char *fmt, ...);
+
+void tfp_format(void* putp,void (*putf) (void*,char),char *fmt, va_list va);
+
+#define printf tfp_printf 
+#define sprintf tfp_sprintf 
+
+#endif

diff --git a/tmk_core/common/chibios/suspend.c b/tmk_core/common/chibios/suspend.c
new file mode 100644 (file)
index 0000000..49ecad4
--- /dev/null
+++ b/tmk_core/common/chibios/suspend.c
@@ -0,0 +1,8 @@
+/* TODO */
+
+#include <stdbool.h>
+
+
+void suspend_power_down(void) {}
+bool suspend_wakeup_condition(void) { return true; }
+void suspend_wakeup_init(void) {}

diff --git a/tmk_core/common/chibios/timer.c b/tmk_core/common/chibios/timer.c
new file mode 100644 (file)
index 0000000..c812994
--- /dev/null
+++ b/tmk_core/common/chibios/timer.c
@@ -0,0 +1,27 @@
+#include "ch.h"
+
+#include "timer.h"
+
+void timer_init(void) {}
+
+void timer_clear(void) {}
+
+uint16_t timer_read(void)
+{
+    return (uint16_t)ST2MS(chVTGetSystemTime());
+}
+
+uint32_t timer_read32(void)
+{
+    return ST2MS(chVTGetSystemTime());
+}
+
+uint16_t timer_elapsed(uint16_t last)
+{
+    return (uint16_t)(ST2MS(chVTTimeElapsedSinceX(MS2ST(last))));
+}
+
+uint32_t timer_elapsed32(uint32_t last)
+{
+       return ST2MS(chVTTimeElapsedSinceX(MS2ST(last)));
+}

diff --git a/tmk_core/common/command.c b/tmk_core/common/command.c
index b017f2e2226722274e3c40c04670a7eed1a862db..8fb6db5638c3bee4bbbc5b853366a8e8a32f9b5b 100644 (file)
--- a/tmk_core/common/command.c
+++ b/tmk_core/common/command.c
@@ -287,6 +287,9 @@ static bool command_common(uint8_t code)
 #ifdef PROTOCOL_VUSB
             " VUSB"
 #endif
+#ifdef PROTOCOL_CHIBIOS
+            " CHIBIOS"
+#endif
 #ifdef BOOTMAGIC_ENABLE
             " BOOTMAGIC"
 #endif

diff --git a/tmk_core/common/print.c b/tmk_core/common/print.c
index ca94e1e5d6a7ffb9649648ef367b2ab2c5fa21c3..00489557f2245b6fcef72f7c8053188586c9d08d 100644 (file)
--- a/tmk_core/common/print.c
+++ b/tmk_core/common/print.c
@@ -38,11 +38,15 @@ void print_set_sendchar(int8_t (*sendchar_func)(uint8_t))
     xdev_out(sendchar_func);
 }
 
-#elif defined(__arm__)
+#elif defined(PROTOCOL_CHIBIOS) /* __AVR__ */
+
+// don't need anything extra
+
+#elif defined(__arm__) /* __AVR__ */
 
 // TODO
 //void print_set_sendchar(int8_t (*sendchar_func)(uint8_t)) { }
 
-#endif
+#endif /* __AVR__ */
 
 #endif

diff --git a/tmk_core/common/print.h b/tmk_core/common/print.h
index c0e9e14309d9ca03985097a2fbf95914ff0eceb6..1e1b9b402a68748f14e7bf06c292a7a3877fe12e 100644 (file)
--- a/tmk_core/common/print.h
+++ b/tmk_core/common/print.h
@@ -47,7 +47,15 @@ extern "C"
 /* function pointer of sendchar to be used by print utility */
 void print_set_sendchar(int8_t (*print_sendchar_func)(uint8_t));
 
-#elif defined(__arm__)
+#elif defined(PROTOCOL_CHIBIOS) /* __AVR__ */
+
+#include "chibios/printf.h"
+
+#define print(s)    printf(s)
+#define println(s)  printf(s "\r\n")
+#define xprintf  printf
+
+#elif defined(__arm__) /* __AVR__ */
 
 #include "mbed/xprintf.h"
 

diff --git a/tmk_core/common/wait.h b/tmk_core/common/wait.h
index 40d00b0c75184e88f1effc9a9153bde01979d9fc..82727be01254d93eb73f4eb9a05945df197583ff 100644 (file)
--- a/tmk_core/common/wait.h
+++ b/tmk_core/common/wait.h
@@ -9,9 +9,13 @@ extern "C" {
 #   include <util/delay.h>
 #   define wait_ms(ms)  _delay_ms(ms)
 #   define wait_us(us)  _delay_us(us)
-#elif defined(__arm__)
+#elif defined(PROTOCOL_CHIBIOS) /* __AVR__ */
+#   include "ch.h"
+#   define wait_ms(ms) chThdSleepMilliseconds(ms)
+#   define wait_us(us) chThdSleepMicroseconds(us)
+#elif defined(__arm__) /* __AVR__ */
 #   include "wait_api.h"
-#endif
+#endif /* __AVR__ */
 
 #ifdef __cplusplus
 }

diff --git a/tmk_core/protocol/chibios/.gitignore b/tmk_core/protocol/chibios/.gitignore
new file mode 100644 (file)
index 0000000..3118dbe
--- /dev/null
+++ b/tmk_core/protocol/chibios/.gitignore
@@ -0,0 +1 @@
+chibios

diff --git a/tmk_core/protocol/chibios/README.md b/tmk_core/protocol/chibios/README.md
new file mode 100644 (file)
index 0000000..38fd495
--- /dev/null
+++ b/tmk_core/protocol/chibios/README.md
@@ -0,0 +1,25 @@
+## USB stack implementation using ChibiOS
+
+### Notes
+
+- To use, unpack or symlink ChibiOS here, to `chibios`.
+- For gcc options, inspect `chibios.mk`. For instance, I enabled `-Wno-missing-field-initializers`, because TMK common bits generated a lot of hits on that.
+Also pay attention to `-O0` (enabled for debugging); for deployment use `-O2`.
+- USB string descriptors are a mess. I did not find a way to cleanly generate the right structures from actual strings, so the definitions in individual keyboards' `config.h` are ugly as heck.
+- There are some random constants left so far, e.g. 5ms sleep between calling `keyboard_task` in `main.c`. There should be no such in `usb_main.c`. Everything is based on timers/interrupts/kernel scheduling (well except `keyboard_task`), so no periodically called things (again, except `keyboard_task`, which is just how TMK is designed).
+- It is easy to add some code for testing (e.g. blink LED, do stuff on button press, etc...) - just create another thread in `main.c`, it will run independently of the keyboard business.
+- The USB stack works pretty completely; however there are bits of other TMK stuff that are not done yet:
+
+### Immediate todo
+
+- suspend / sleep led
+
+### Missing / not working (TMK vs ChibiOS bits)
+
+- eeprom / bootmagic (will be chip dependent)
+- bootloader jump (chip dependent)
+
+### Tried with
+
+- ChibiOS 3.0.1 and ST F072RB DISCOVERY board.
+- Need to test on other STM32 chips (F3, F4) to make it as much chip-independent as possible.

diff --git a/tmk_core/protocol/chibios/chibios.mk b/tmk_core/protocol/chibios/chibios.mk
new file mode 100644 (file)
index 0000000..d667f60
--- /dev/null
+++ b/tmk_core/protocol/chibios/chibios.mk
@@ -0,0 +1,225 @@
+##############################################################################
+# Build global options
+# NOTE: Can be overridden externally.
+#
+
+# Compiler options here.
+ifeq ($(USE_OPT),)
+  USE_OPT = -O0 -ggdb -fomit-frame-pointer -falign-functions=16 -std=gnu99 -DPROTOCOL_CHIBIOS
+endif
+
+# C specific options here (added to USE_OPT).
+ifeq ($(USE_COPT),)
+  USE_COPT =
+endif
+
+# include specific config.h?
+ifdef CONFIG_H
+    USE_COPT += -include $(CONFIG_H)
+endif
+
+# C++ specific options here (added to USE_OPT).
+ifeq ($(USE_CPPOPT),)
+  USE_CPPOPT = -fno-rtti
+endif
+
+# Enable this if you want the linker to remove unused code and data
+ifeq ($(USE_LINK_GC),)
+  USE_LINK_GC = yes
+endif
+
+# Linker extra options here.
+ifeq ($(USE_LDOPT),)
+  USE_LDOPT =
+endif
+
+# Enable this if you want link time optimizations (LTO)
+ifeq ($(USE_LTO),)
+  USE_LTO = yes
+endif
+
+# If enabled, this option allows to compile the application in THUMB mode.
+ifeq ($(USE_THUMB),)
+  USE_THUMB = yes
+endif
+
+# Enable this if you want to see the full log while compiling.
+ifeq ($(USE_VERBOSE_COMPILE),)
+  USE_VERBOSE_COMPILE = no
+endif
+
+# If enabled, this option makes the build process faster by not compiling
+# modules not used in the current configuration.
+ifeq ($(USE_SMART_BUILD),)
+  USE_SMART_BUILD = yes
+endif
+
+#
+# Build global options
+##############################################################################
+
+##############################################################################
+# Architecture or project specific options
+#
+
+# Stack size to be allocated to the Cortex-M process stack. This stack is
+# the stack used by the main() thread.
+ifeq ($(USE_PROCESS_STACKSIZE),)
+  USE_PROCESS_STACKSIZE = 0x200
+endif
+
+# Stack size to the allocated to the Cortex-M main/exceptions stack. This
+# stack is used for processing interrupts and exceptions.
+ifeq ($(USE_EXCEPTIONS_STACKSIZE),)
+  USE_EXCEPTIONS_STACKSIZE = 0x400
+endif
+
+#
+# Architecture or project specific options
+##############################################################################
+
+##############################################################################
+# Project, sources and paths
+#
+
+# Imported source files and paths
+CHIBIOS = $(TMK_DIR)/protocol/chibios/chibios
+# Startup files.
+include $(CHIBIOS)/os/common/ports/ARMCMx/compilers/GCC/mk/startup_$(shell echo $(MCU_SERIES) | tr '[:upper:]' '[:lower:]').mk
+# HAL-OSAL files (optional).
+include $(CHIBIOS)/os/hal/hal.mk
+include $(CHIBIOS)/os/hal/ports/$(MCU_FAMILY)/$(MCU_SERIES)/platform.mk
+ifneq ("$(wildcard $(TARGET_DIR)/boards/$(BOARD))","")
+       include $(TARGET_DIR)/boards/$(BOARD)/board.mk
+else
+       include $(CHIBIOS)/os/hal/boards/$(BOARD)/board.mk
+endif
+include $(CHIBIOS)/os/hal/osal/rt/osal.mk
+# RTOS files (optional).
+include $(CHIBIOS)/os/rt/rt.mk
+include $(CHIBIOS)/os/rt/ports/ARMCMx/compilers/GCC/mk/port_v6m.mk
+# Other files (optional).
+
+# Define linker script file here
+ifneq ("$(wildcard $(TARGET_DIR)/ld/$(MCU_MODEL_FAMILY).ld)","")
+LDSCRIPT = $(TARGET_DIR)/ld/$(MCU_MODEL_FAMILY).ld
+else
+LDSCRIPT = $(STARTUPLD)/$(MCU_MODEL_FAMILY).ld
+endif
+
+# C sources that can be compiled in ARM or THUMB mode depending on the global
+# setting.
+CSRC = $(STARTUPSRC) \
+       $(KERNSRC) \
+       $(PORTSRC) \
+       $(OSALSRC) \
+       $(HALSRC) \
+       $(PLATFORMSRC) \
+       $(BOARDSRC) \
+       $(CHIBIOS)/os/hal/lib/streams/chprintf.c \
+       $(TMK_DIR)/protocol/chibios/usb_main.c \
+       $(TMK_DIR)/protocol/chibios/main.c \
+       $(SRC)
+
+# C++ sources that can be compiled in ARM or THUMB mode depending on the global
+# setting.
+CPPSRC =
+
+# C sources to be compiled in ARM mode regardless of the global setting.
+# NOTE: Mixing ARM and THUMB mode enables the -mthumb-interwork compiler
+#       option that results in lower performance and larger code size.
+ACSRC =
+
+# C++ sources to be compiled in ARM mode regardless of the global setting.
+# NOTE: Mixing ARM and THUMB mode enables the -mthumb-interwork compiler
+#       option that results in lower performance and larger code size.
+ACPPSRC =
+
+# C sources to be compiled in THUMB mode regardless of the global setting.
+# NOTE: Mixing ARM and THUMB mode enables the -mthumb-interwork compiler
+#       option that results in lower performance and larger code size.
+TCSRC =
+
+# C sources to be compiled in THUMB mode regardless of the global setting.
+# NOTE: Mixing ARM and THUMB mode enables the -mthumb-interwork compiler
+#       option that results in lower performance and larger code size.
+TCPPSRC =
+
+# List ASM source files here
+ASMSRC = $(STARTUPASM) $(PORTASM) $(OSALASM)
+
+INCDIR = $(STARTUPINC) $(KERNINC) $(PORTINC) $(OSALINC) \
+         $(HALINC) $(PLATFORMINC) $(BOARDINC) $(TESTINC) \
+         $(CHIBIOS)/os/hal/lib/streams $(CHIBIOS)/os/various \
+         $(TMK_DIR) $(COMMON_DIR) $(TMK_DIR)/protocol/chibios \
+         $(TARGET_DIR)
+
+#
+# Project, sources and paths
+##############################################################################
+
+##############################################################################
+# Compiler settings
+#
+
+MCU  = cortex-m0
+
+#TRGT = arm-elf-
+TRGT = arm-none-eabi-
+CC   = $(TRGT)gcc
+CPPC = $(TRGT)g++
+# Enable loading with g++ only if you need C++ runtime support.
+# NOTE: You can use C++ even without C++ support if you are careful. C++
+#       runtime support makes code size explode.
+LD   = $(TRGT)gcc
+#LD   = $(TRGT)g++
+CP   = $(TRGT)objcopy
+AS   = $(TRGT)gcc -x assembler-with-cpp
+AR   = $(TRGT)ar
+OD   = $(TRGT)objdump
+SZ   = $(TRGT)size
+HEX  = $(CP) -O ihex
+BIN  = $(CP) -O binary
+
+# ARM-specific options here
+AOPT =
+
+# THUMB-specific options here
+TOPT = -mthumb -DTHUMB
+
+# Define C warning options here
+CWARN = -Wall -Wextra -Wundef -Wstrict-prototypes -Wno-missing-field-initializers
+
+# Define C++ warning options here
+CPPWARN = -Wall -Wextra -Wundef
+
+#
+# Compiler settings
+##############################################################################
+
+##############################################################################
+# Start of user section
+#
+
+# List all user C define here, like -D_DEBUG=1
+## Select which interfaces to include here!
+UDEFS = $(OPT_DEFS)
+
+# Define ASM defines here
+UADEFS =
+
+# List all user directories here
+UINCDIR =
+
+# List the user directory to look for the libraries here
+ULIBDIR =
+
+# List all user libraries here
+ULIBS =
+
+#
+# End of user defines
+##############################################################################
+
+RULESPATH = $(CHIBIOS)/os/common/ports/ARMCMx/compilers/GCC
+include $(RULESPATH)/rules.mk

diff --git a/tmk_core/protocol/chibios/main.c b/tmk_core/protocol/chibios/main.c
new file mode 100644 (file)
index 0000000..ce7cd8e
--- /dev/null
+++ b/tmk_core/protocol/chibios/main.c
@@ -0,0 +1,91 @@
+/*
+ * (c) 2015 flabberast <s3+flabbergast@sdfeu.org>
+ *
+ * Based on the following work:
+ *  - Guillaume Duc's raw hid example (MIT License)
+ *    https://github.com/guiduc/usb-hid-chibios-example
+ *  - PJRC Teensy examples (MIT License)
+ *    https://www.pjrc.com/teensy/usb_keyboard.html
+ *  - hasu's TMK keyboard code (GPL v2 and some code Modified BSD)
+ *    https://github.com/tmk/tmk_keyboard/
+ *  - ChibiOS demo code (Apache 2.0 License)
+ *    http://www.chibios.org
+ *
+ * Since some GPL'd code is used, this work is licensed under
+ * GPL v2 or later.
+ */
+
+#include "ch.h"
+#include "hal.h"
+
+#include "usb_main.h"
+
+/* TMK includes */
+#include "report.h"
+#include "host.h"
+#include "host_driver.h"
+#include "keyboard.h"
+#include "action.h"
+#include "led.h"
+#include "sendchar.h"
+#include "debug.h"
+#ifdef SLEEP_LED_ENABLE
+#include "sleep_led.h"
+#endif
+#include "suspend.h"
+
+
+/* -------------------------
+ *   TMK host driver defs
+ * -------------------------
+ */
+
+host_driver_t chibios_driver = {
+  keyboard_leds,
+  send_keyboard,
+  send_mouse,
+  send_system,
+  send_consumer
+};
+
+/* Main thread
+ */
+int main(void) {
+  /* ChibiOS/RT init */
+  halInit();
+  chSysInit();
+
+  palSetPad(GPIOC, GPIOC_LED_BLUE);
+  chThdSleepMilliseconds(400);
+  palClearPad(GPIOC, GPIOC_LED_BLUE);
+
+  /* Init USB */
+  init_usb_driver();
+
+  /* init printf */
+  init_printf(NULL,sendchar_pf);
+
+  /* Wait until the USB is active */
+  while(USB_DRIVER.state != USB_ACTIVE)
+    chThdSleepMilliseconds(50);
+
+  print("USB configured.\n");
+
+  /* init TMK modules */
+  keyboard_init();
+  host_set_driver(&chibios_driver);
+
+#ifdef SLEEP_LED_ENABLE
+    sleep_led_init();
+#endif
+
+  print("Keyboard start.\n");
+
+  /* Main loop */
+  while(true) {
+    /* TODO: check for suspended event */
+
+    keyboard_task();
+    chThdSleepMilliseconds(5);
+  }
+}

diff --git a/tmk_core/protocol/chibios/usb_main.c b/tmk_core/protocol/chibios/usb_main.c
new file mode 100644 (file)
index 0000000..875f47d
--- /dev/null
+++ b/tmk_core/protocol/chibios/usb_main.c
@@ -0,0 +1,1251 @@
+/*
+ * (c) 2015 flabberast <s3+flabbergast@sdfeu.org>
+ *
+ * Based on the following work:
+ *  - Guillaume Duc's raw hid example (MIT License)
+ *    https://github.com/guiduc/usb-hid-chibios-example
+ *  - PJRC Teensy examples (MIT License)
+ *    https://www.pjrc.com/teensy/usb_keyboard.html
+ *  - hasu's TMK keyboard code (GPL v2 and some code Modified BSD)
+ *    https://github.com/tmk/tmk_keyboard/
+ *  - ChibiOS demo code (Apache 2.0 License)
+ *    http://www.chibios.org
+ *
+ * Since some GPL'd code is used, this work is licensed under
+ * GPL v2 or later.
+ */
+
+#include "ch.h"
+#include "hal.h"
+
+#include "usb_main.h"
+
+/* ---------------------------------------------------------
+ *       Global interface variables and declarations
+ * ---------------------------------------------------------
+ */
+
+uint8_t keyboard_idle = 0;
+uint8_t keyboard_protocol = 1;
+uint16_t keyboard_led_stats = 0;
+volatile uint16_t keyboard_idle_count = 0;
+static virtual_timer_t keyboard_idle_timer;
+static void keyboard_idle_timer_cb(void *arg);
+#ifdef NKRO_ENABLE
+bool keyboard_nkro = true;
+#endif /* NKRO_ENABLE */
+
+report_keyboard_t keyboard_report_sent = {{0}};
+
+#ifdef CONSOLE_ENABLE
+/* The emission queue */
+output_queue_t console_queue;
+static uint8_t console_queue_buffer[CONSOLE_QUEUE_BUFFER_SIZE];
+static virtual_timer_t console_flush_timer;
+void console_queue_onotify(io_queue_t *qp);
+static void console_flush_cb(void *arg);
+#endif /* CONSOLE_ENABLE */
+
+/* ---------------------------------------------------------
+ *            Descriptors and USB driver objects
+ * ---------------------------------------------------------
+ */
+
+/* HID specific constants */
+#define USB_DESCRIPTOR_HID 0x21
+#define USB_DESCRIPTOR_HID_REPORT 0x22
+#define HID_GET_REPORT 0x01
+#define HID_GET_IDLE 0x02
+#define HID_GET_PROTOCOL 0x03
+#define HID_SET_REPORT 0x09
+#define HID_SET_IDLE 0x0A
+#define HID_SET_PROTOCOL 0x0B
+
+/* USB Device Descriptor */
+static const uint8_t usb_device_descriptor_data[] = {
+  USB_DESC_DEVICE(0x0200,      // bcdUSB (1.1)
+                  0,           // bDeviceClass (defined in later in interface)
+                  0,           // bDeviceSubClass
+                  0,           // bDeviceProtocol
+                  64,          // bMaxPacketSize (64 bytes) (the driver didn't work with 32)
+                  VENDOR_ID,   // idVendor
+                  PRODUCT_ID,  // idProduct
+                  DEVICE_VER,      // bcdDevice
+                  1,           // iManufacturer
+                  2,           // iProduct
+                  3,           // iSerialNumber
+                  1)           // bNumConfigurations
+};
+
+/* Device Descriptor wrapper */
+static const USBDescriptor usb_device_descriptor = {
+  sizeof usb_device_descriptor_data,
+  usb_device_descriptor_data
+};
+
+/*
+ * HID Report Descriptor
+ *
+ * See "Device Class Definition for Human Interface Devices (HID)"
+ * (http://www.usb.org/developers/hidpage/HID1_11.pdf) for the
+ * detailed descrition of all the fields
+ */
+
+/* Keyboard Protocol 1, HID 1.11 spec, Appendix B, page 59-60 */
+static const uint8_t keyboard_hid_report_desc_data[] = {
+  0x05, 0x01,                // Usage Page (Generic Desktop),
+  0x09, 0x06,                // Usage (Keyboard),
+  0xA1, 0x01,                // Collection (Application),
+  0x75, 0x01,                //   Report Size (1),
+  0x95, 0x08,                //   Report Count (8),
+  0x05, 0x07,                //   Usage Page (Key Codes),
+  0x19, 0xE0,                //   Usage Minimum (224),
+  0x29, 0xE7,                //   Usage Maximum (231),
+  0x15, 0x00,                //   Logical Minimum (0),
+  0x25, 0x01,                //   Logical Maximum (1),
+  0x81, 0x02,                //   Input (Data, Variable, Absolute), ;Modifier byte
+  0x95, 0x01,                //   Report Count (1),
+  0x75, 0x08,                //   Report Size (8),
+  0x81, 0x03,                //   Input (Constant),                 ;Reserved byte
+  0x95, 0x05,                //   Report Count (5),
+  0x75, 0x01,                //   Report Size (1),
+  0x05, 0x08,                //   Usage Page (LEDs),
+  0x19, 0x01,                //   Usage Minimum (1),
+  0x29, 0x05,                //   Usage Maximum (5),
+  0x91, 0x02,                //   Output (Data, Variable, Absolute), ;LED report
+  0x95, 0x01,                //   Report Count (1),
+  0x75, 0x03,                //   Report Size (3),
+  0x91, 0x03,                //   Output (Constant),                 ;LED report padding
+  0x95, KBD_REPORT_KEYS,          //   Report Count (),
+  0x75, 0x08,                //   Report Size (8),
+  0x15, 0x00,                //   Logical Minimum (0),
+  0x25, 0xFF,                //   Logical Maximum(255),
+  0x05, 0x07,                //   Usage Page (Key Codes),
+  0x19, 0x00,                //   Usage Minimum (0),
+  0x29, 0xFF,                //   Usage Maximum (255),
+  0x81, 0x00,                //   Input (Data, Array),
+  0xc0                       // End Collection
+};
+/* wrapper */
+static const USBDescriptor keyboard_hid_report_descriptor = {
+  sizeof keyboard_hid_report_desc_data,
+  keyboard_hid_report_desc_data
+};
+
+#ifdef NKRO_ENABLE
+static const uint8_t nkro_hid_report_desc_data[] = {
+  0x05, 0x01,                           // Usage Page (Generic Desktop),
+  0x09, 0x06,                           // Usage (Keyboard),
+  0xA1, 0x01,                           // Collection (Application),
+  // bitmap of modifiers
+  0x75, 0x01,                           //   Report Size (1),
+  0x95, 0x08,                           //   Report Count (8),
+  0x05, 0x07,                           //   Usage Page (Key Codes),
+  0x19, 0xE0,                           //   Usage Minimum (224),
+  0x29, 0xE7,                           //   Usage Maximum (231),
+  0x15, 0x00,                           //   Logical Minimum (0),
+  0x25, 0x01,                           //   Logical Maximum (1),
+  0x81, 0x02,                           //   Input (Data, Variable, Absolute), ;Modifier byte
+  // LED output report
+  0x95, 0x05,                           //   Report Count (5),
+  0x75, 0x01,                           //   Report Size (1),
+  0x05, 0x08,                           //   Usage Page (LEDs),
+  0x19, 0x01,                           //   Usage Minimum (1),
+  0x29, 0x05,                           //   Usage Maximum (5),
+  0x91, 0x02,                           //   Output (Data, Variable, Absolute),
+  0x95, 0x01,                           //   Report Count (1),
+  0x75, 0x03,                           //   Report Size (3),
+  0x91, 0x03,                           //   Output (Constant),
+  // bitmap of keys
+  0x95, NKRO_REPORT_KEYS * 8,           //   Report Count (),
+  0x75, 0x01,                           //   Report Size (1),
+  0x15, 0x00,                           //   Logical Minimum (0),
+  0x25, 0x01,                           //   Logical Maximum(1),
+  0x05, 0x07,                           //   Usage Page (Key Codes),
+  0x19, 0x00,                           //   Usage Minimum (0),
+  0x29, NKRO_REPORT_KEYS * 8 - 1,       //   Usage Maximum (),
+  0x81, 0x02,                           //   Input (Data, Variable, Absolute),
+  0xc0                                  // End Collection
+};
+/* wrapper */
+static const USBDescriptor nkro_hid_report_descriptor = {
+  sizeof nkro_hid_report_desc_data,
+  nkro_hid_report_desc_data
+};
+#endif /* NKRO_ENABLE */
+
+#ifdef MOUSE_ENABLE
+/* Mouse Protocol 1, HID 1.11 spec, Appendix B, page 59-60, with wheel extension
+ * http://www.microchip.com/forums/tm.aspx?high=&m=391435&mpage=1#391521
+ * http://www.keil.com/forum/15671/
+ * http://www.microsoft.com/whdc/device/input/wheel.mspx */
+static const uint8_t mouse_hid_report_desc_data[] = {
+  /* mouse */
+  0x05, 0x01,                      // USAGE_PAGE (Generic Desktop)
+  0x09, 0x02,                      // USAGE (Mouse)
+  0xa1, 0x01,                      // COLLECTION (Application)
+  //0x85, REPORT_ID_MOUSE,         //   REPORT_ID (1)
+  0x09, 0x01,                      //   USAGE (Pointer)
+  0xa1, 0x00,                      //   COLLECTION (Physical)
+                                   // ----------------------------  Buttons
+  0x05, 0x09,                      //     USAGE_PAGE (Button)
+  0x19, 0x01,                      //     USAGE_MINIMUM (Button 1)
+  0x29, 0x05,                      //     USAGE_MAXIMUM (Button 5)
+  0x15, 0x00,                      //     LOGICAL_MINIMUM (0)
+  0x25, 0x01,                      //     LOGICAL_MAXIMUM (1)
+  0x75, 0x01,                      //     REPORT_SIZE (1)
+  0x95, 0x05,                      //     REPORT_COUNT (5)
+  0x81, 0x02,                      //     INPUT (Data,Var,Abs)
+  0x75, 0x03,                      //     REPORT_SIZE (3)
+  0x95, 0x01,                      //     REPORT_COUNT (1)
+  0x81, 0x03,                      //     INPUT (Cnst,Var,Abs)
+                                   // ----------------------------  X,Y position
+  0x05, 0x01,                      //     USAGE_PAGE (Generic Desktop)
+  0x09, 0x30,                      //     USAGE (X)
+  0x09, 0x31,                      //     USAGE (Y)
+  0x15, 0x81,                      //     LOGICAL_MINIMUM (-127)
+  0x25, 0x7f,                      //     LOGICAL_MAXIMUM (127)
+  0x75, 0x08,                      //     REPORT_SIZE (8)
+  0x95, 0x02,                      //     REPORT_COUNT (2)
+  0x81, 0x06,                      //     INPUT (Data,Var,Rel)
+                                   // ----------------------------  Vertical wheel
+  0x09, 0x38,                      //     USAGE (Wheel)
+  0x15, 0x81,                      //     LOGICAL_MINIMUM (-127)
+  0x25, 0x7f,                      //     LOGICAL_MAXIMUM (127)
+  0x35, 0x00,                      //     PHYSICAL_MINIMUM (0)        - reset physical
+  0x45, 0x00,                      //     PHYSICAL_MAXIMUM (0)
+  0x75, 0x08,                      //     REPORT_SIZE (8)
+  0x95, 0x01,                      //     REPORT_COUNT (1)
+  0x81, 0x06,                      //     INPUT (Data,Var,Rel)
+                                   // ----------------------------  Horizontal wheel
+  0x05, 0x0c,                      //     USAGE_PAGE (Consumer Devices)
+  0x0a, 0x38, 0x02,                //     USAGE (AC Pan)
+  0x15, 0x81,                      //     LOGICAL_MINIMUM (-127)
+  0x25, 0x7f,                      //     LOGICAL_MAXIMUM (127)
+  0x75, 0x08,                      //     REPORT_SIZE (8)
+  0x95, 0x01,                      //     REPORT_COUNT (1)
+  0x81, 0x06,                      //     INPUT (Data,Var,Rel)
+  0xc0,                            //   END_COLLECTION
+  0xc0,                            // END_COLLECTION
+};
+/* wrapper */
+static const USBDescriptor mouse_hid_report_descriptor = {
+  sizeof mouse_hid_report_desc_data,
+  mouse_hid_report_desc_data
+};
+#endif /* MOUSE_ENABLE */
+
+#ifdef CONSOLE_ENABLE
+static const uint8_t console_hid_report_desc_data[] = {
+  0x06, 0x31, 0xFF, // Usage Page 0xFF31 (vendor defined)
+  0x09, 0x74,       // Usage 0x74
+  0xA1, 0x53,       // Collection 0x53
+  0x75, 0x08,       // report size = 8 bits
+  0x15, 0x00,       // logical minimum = 0
+  0x26, 0xFF, 0x00, // logical maximum = 255
+  0x95, CONSOLE_SIZE, // report count
+  0x09, 0x75,       // usage
+  0x81, 0x02,       // Input (array)
+  0xC0              // end collection
+};
+/* wrapper */
+static const USBDescriptor console_hid_report_descriptor = {
+  sizeof console_hid_report_desc_data,
+  console_hid_report_desc_data
+};
+#endif /* CONSOLE_ENABLE */
+
+#ifdef EXTRAKEY_ENABLE
+/* audio controls & system controls
+ * http://www.microsoft.com/whdc/archive/w2kbd.mspx */
+static const uint8_t extra_hid_report_desc_data[] = {
+  /* system control */
+  0x05, 0x01,                      // USAGE_PAGE (Generic Desktop)
+  0x09, 0x80,                      // USAGE (System Control)
+  0xa1, 0x01,                      // COLLECTION (Application)
+  0x85, REPORT_ID_SYSTEM,          //   REPORT_ID (2)
+  0x15, 0x01,                      //   LOGICAL_MINIMUM (0x1)
+  0x25, 0xb7,                      //   LOGICAL_MAXIMUM (0xb7)
+  0x19, 0x01,                      //   USAGE_MINIMUM (0x1)
+  0x29, 0xb7,                      //   USAGE_MAXIMUM (0xb7)
+  0x75, 0x10,                      //   REPORT_SIZE (16)
+  0x95, 0x01,                      //   REPORT_COUNT (1)
+  0x81, 0x00,                      //   INPUT (Data,Array,Abs)
+  0xc0,                            // END_COLLECTION
+  /* consumer */
+  0x05, 0x0c,                      // USAGE_PAGE (Consumer Devices)
+  0x09, 0x01,                      // USAGE (Consumer Control)
+  0xa1, 0x01,                      // COLLECTION (Application)
+  0x85, REPORT_ID_CONSUMER,        //   REPORT_ID (3)
+  0x15, 0x01,                      //   LOGICAL_MINIMUM (0x1)
+  0x26, 0x9c, 0x02,                //   LOGICAL_MAXIMUM (0x29c)
+  0x19, 0x01,                      //   USAGE_MINIMUM (0x1)
+  0x2a, 0x9c, 0x02,                //   USAGE_MAXIMUM (0x29c)
+  0x75, 0x10,                      //   REPORT_SIZE (16)
+  0x95, 0x01,                      //   REPORT_COUNT (1)
+  0x81, 0x00,                      //   INPUT (Data,Array,Abs)
+  0xc0,                            // END_COLLECTION
+};
+/* wrapper */
+static const USBDescriptor extra_hid_report_descriptor = {
+  sizeof extra_hid_report_desc_data,
+  extra_hid_report_desc_data
+};
+#endif /* EXTRAKEY_ENABLE */
+
+
+/*
+ * Configuration Descriptor tree for a HID device
+ *
+ * The HID Specifications version 1.11 require the following order:
+ * - Configuration Descriptor
+ * - Interface Descriptor
+ * - HID Descriptor
+ * - Endpoints Descriptors
+ */
+#define KBD_HID_DESC_NUM                0
+#define KBD_HID_DESC_OFFSET             (9 + (9 + 9 + 7) * KBD_HID_DESC_NUM + 9)
+
+#ifdef MOUSE_ENABLE
+#   define MOUSE_HID_DESC_NUM           (KBD_HID_DESC_NUM + 1)
+#   define MOUSE_HID_DESC_OFFSET        (9 + (9 + 9 + 7) * MOUSE_HID_DESC_NUM + 9)
+#else /* MOUSE_ENABLE */
+#   define MOUSE_HID_DESC_NUM           (KBD_HID_DESC_NUM + 0)
+#endif /* MOUSE_ENABLE */
+
+#ifdef CONSOLE_ENABLE
+#define CONSOLE_HID_DESC_NUM            (MOUSE_HID_DESC_NUM + 1)
+#define CONSOLE_HID_DESC_OFFSET         (9 + (9 + 9 + 7) * CONSOLE_HID_DESC_NUM + 9)
+#else /* CONSOLE_ENABLE */
+#   define CONSOLE_HID_DESC_NUM         (MOUSE_HID_DESC_NUM + 0)
+#endif /* CONSOLE_ENABLE */
+
+#ifdef EXTRAKEY_ENABLE
+#   define EXTRA_HID_DESC_NUM           (CONSOLE_HID_DESC_NUM + 1)
+#   define EXTRA_HID_DESC_OFFSET        (9 + (9 + 9 + 7) * EXTRA_HID_DESC_NUM + 9)
+#else /* EXTRAKEY_ENABLE */
+#   define EXTRA_HID_DESC_NUM           (CONSOLE_HID_DESC_NUM + 0)
+#endif /* EXTRAKEY_ENABLE */
+
+#ifdef NKRO_ENABLE
+#   define NKRO_HID_DESC_NUM            (EXTRA_HID_DESC_NUM + 1)
+#   define NKRO_HID_DESC_OFFSET         (9 + (9 + 9 + 7) * EXTRA_HID_DESC_NUM + 9)
+#else /* NKRO_ENABLE */
+#   define NKRO_HID_DESC_NUM            (EXTRA_HID_DESC_NUM + 0)
+#endif /* NKRO_ENABLE */
+
+#define NUM_INTERFACES                  (NKRO_HID_DESC_NUM + 1)
+#define CONFIG1_DESC_SIZE               (9 + (9 + 9 + 7) * NUM_INTERFACES)
+
+static const uint8_t hid_configuration_descriptor_data[] = {
+  /* Configuration Descriptor (9 bytes) USB spec 9.6.3, page 264-266, Table 9-10 */
+  USB_DESC_CONFIGURATION(CONFIG1_DESC_SIZE, // wTotalLength
+                         NUM_INTERFACES,    // bNumInterfaces
+                         1,    // bConfigurationValue
+                         0,    // iConfiguration
+                         0xA0, // bmAttributes
+                         50),  // bMaxPower (100mA)
+
+  /* Interface Descriptor (9 bytes) USB spec 9.6.5, page 267-269, Table 9-12 */
+  USB_DESC_INTERFACE(KBD_INTERFACE,        // bInterfaceNumber
+                     0,        // bAlternateSetting
+                     1,        // bNumEndpoints
+                     0x03,     // bInterfaceClass: HID
+                     0x01,     // bInterfaceSubClass: Boot
+                     0x01,     // bInterfaceProtocol: Keyboard
+                     0),       // iInterface
+
+  /* HID descriptor (9 bytes) HID 1.11 spec, section 6.2.1 */
+  USB_DESC_BYTE(9),            // bLength
+  USB_DESC_BYTE(0x21),         // bDescriptorType (HID class)
+  USB_DESC_BCD(0x0111),        // bcdHID: HID version 1.11
+  USB_DESC_BYTE(0),            // bCountryCode
+  USB_DESC_BYTE(1),            // bNumDescriptors
+  USB_DESC_BYTE(0x22),         // bDescriptorType (report desc)
+  USB_DESC_WORD(sizeof(keyboard_hid_report_desc_data)), // wDescriptorLength
+
+  /* Endpoint Descriptor (7 bytes) USB spec 9.6.6, page 269-271, Table 9-13 */
+  USB_DESC_ENDPOINT(KBD_ENDPOINT | 0x80,  // bEndpointAddress
+                    0x03,      // bmAttributes (Interrupt)
+                    KBD_SIZE,  // wMaxPacketSize
+                    10),       // bInterval
+
+  #ifdef MOUSE_ENABLE
+  /* Interface Descriptor (9 bytes) USB spec 9.6.5, page 267-269, Table 9-12 */
+  USB_DESC_INTERFACE(MOUSE_INTERFACE,   // bInterfaceNumber
+                     0,        // bAlternateSetting
+                     1,        // bNumEndpoints
+                     0x03,     // bInterfaceClass (0x03 = HID)
+                     // ThinkPad T23 BIOS doesn't work with boot mouse.
+                     0x00,     // bInterfaceSubClass (0x01 = Boot)
+                     0x00,     // bInterfaceProtocol (0x02 = Mouse)
+                     /*
+                        0x01,      // bInterfaceSubClass (0x01 = Boot)
+                        0x02,      // bInterfaceProtocol (0x02 = Mouse)
+                      */
+                     0),        // iInterface
+
+  /* HID descriptor (9 bytes) HID 1.11 spec, section 6.2.1 */
+  USB_DESC_BYTE(9),            // bLength
+  USB_DESC_BYTE(0x21),         // bDescriptorType (HID class)
+  USB_DESC_BCD(0x0111),        // bcdHID: HID version 1.11
+  USB_DESC_BYTE(0),            // bCountryCode
+  USB_DESC_BYTE(1),            // bNumDescriptors
+  USB_DESC_BYTE(0x22),         // bDescriptorType (report desc)
+  USB_DESC_WORD(sizeof(mouse_hid_report_desc_data)), // wDescriptorLength
+
+  /* Endpoint Descriptor (7 bytes) USB spec 9.6.6, page 269-271, Table 9-13 */
+  USB_DESC_ENDPOINT(MOUSE_ENDPOINT | 0x80,  // bEndpointAddress
+                    0x03,      // bmAttributes (Interrupt)
+                    MOUSE_SIZE,  // wMaxPacketSize
+                    1),        // bInterval
+  #endif /* MOUSE_ENABLE */
+
+  #ifdef CONSOLE_ENABLE
+  /* Interface Descriptor (9 bytes) USB spec 9.6.5, page 267-269, Table 9-12 */
+  USB_DESC_INTERFACE(CONSOLE_INTERFACE, // bInterfaceNumber
+                     0,        // bAlternateSetting
+                     1,        // bNumEndpoints
+                     0x03,     // bInterfaceClass: HID
+                     0x00,     // bInterfaceSubClass: None
+                     0x00,     // bInterfaceProtocol: None
+                     0),       // iInterface
+
+  /* HID descriptor (9 bytes) HID 1.11 spec, section 6.2.1 */
+  USB_DESC_BYTE(9),            // bLength
+  USB_DESC_BYTE(0x21),         // bDescriptorType (HID class)
+  USB_DESC_BCD(0x0111),        // bcdHID: HID version 1.11
+  USB_DESC_BYTE(0),            // bCountryCode
+  USB_DESC_BYTE(1),            // bNumDescriptors
+  USB_DESC_BYTE(0x22),         // bDescriptorType (report desc)
+  USB_DESC_WORD(sizeof(console_hid_report_desc_data)), // wDescriptorLength
+
+  /* Endpoint Descriptor (7 bytes) USB spec 9.6.6, page 269-271, Table 9-13 */
+  USB_DESC_ENDPOINT(CONSOLE_ENDPOINT | 0x80,  // bEndpointAddress
+                    0x03,      // bmAttributes (Interrupt)
+                    CONSOLE_SIZE, // wMaxPacketSize
+                    1),        // bInterval
+  #endif /* CONSOLE_ENABLE */
+
+  #ifdef EXTRAKEY_ENABLE
+  /* Interface Descriptor (9 bytes) USB spec 9.6.5, page 267-269, Table 9-12 */
+  USB_DESC_INTERFACE(EXTRA_INTERFACE, // bInterfaceNumber
+                     0,        // bAlternateSetting
+                     1,        // bNumEndpoints
+                     0x03,     // bInterfaceClass: HID
+                     0x00,     // bInterfaceSubClass: None
+                     0x00,     // bInterfaceProtocol: None
+                     0),       // iInterface
+
+  /* HID descriptor (9 bytes) HID 1.11 spec, section 6.2.1 */
+  USB_DESC_BYTE(9),            // bLength
+  USB_DESC_BYTE(0x21),         // bDescriptorType (HID class)
+  USB_DESC_BCD(0x0111),        // bcdHID: HID version 1.11
+  USB_DESC_BYTE(0),            // bCountryCode
+  USB_DESC_BYTE(1),            // bNumDescriptors
+  USB_DESC_BYTE(0x22),         // bDescriptorType (report desc)
+  USB_DESC_WORD(sizeof(extra_hid_report_desc_data)), // wDescriptorLength
+
+  /* Endpoint Descriptor (7 bytes) USB spec 9.6.6, page 269-271, Table 9-13 */
+  USB_DESC_ENDPOINT(EXTRA_ENDPOINT | 0x80,  // bEndpointAddress
+                    0x03,      // bmAttributes (Interrupt)
+                    EXTRA_SIZE, // wMaxPacketSize
+                    10),       // bInterval
+  #endif /* EXTRAKEY_ENABLE */
+
+  #ifdef NKRO_ENABLE
+  /* Interface Descriptor (9 bytes) USB spec 9.6.5, page 267-269, Table 9-12 */
+  USB_DESC_INTERFACE(NKRO_INTERFACE, // bInterfaceNumber
+                     0,        // bAlternateSetting
+                     1,        // bNumEndpoints
+                     0x03,     // bInterfaceClass: HID
+                     0x00,     // bInterfaceSubClass: None
+                     0x00,     // bInterfaceProtocol: None
+                     0),       // iInterface
+
+  /* HID descriptor (9 bytes) HID 1.11 spec, section 6.2.1 */
+  USB_DESC_BYTE(9),            // bLength
+  USB_DESC_BYTE(0x21),         // bDescriptorType (HID class)
+  USB_DESC_BCD(0x0111),        // bcdHID: HID version 1.11
+  USB_DESC_BYTE(0),            // bCountryCode
+  USB_DESC_BYTE(1),            // bNumDescriptors
+  USB_DESC_BYTE(0x22),         // bDescriptorType (report desc)
+  USB_DESC_WORD(sizeof(nkro_hid_report_desc_data)), // wDescriptorLength
+
+  /* Endpoint Descriptor (7 bytes) USB spec 9.6.6, page 269-271, Table 9-13 */
+  USB_DESC_ENDPOINT(NKRO_ENDPOINT | 0x80,  // bEndpointAddress
+                    0x03,      // bmAttributes (Interrupt)
+                    NKRO_SIZE, // wMaxPacketSize
+                    1),       // bInterval
+  #endif /* NKRO_ENABLE */
+};
+
+/* Configuration Descriptor wrapper */
+static const USBDescriptor hid_configuration_descriptor = {
+  sizeof hid_configuration_descriptor_data,
+  hid_configuration_descriptor_data
+};
+
+/* wrappers */
+#define HID_DESCRIPTOR_SIZE 9
+static const USBDescriptor keyboard_hid_descriptor = {
+  HID_DESCRIPTOR_SIZE,
+  &hid_configuration_descriptor_data[KBD_HID_DESC_OFFSET]
+};
+#ifdef MOUSE_ENABLE
+static const USBDescriptor mouse_hid_descriptor = {
+  HID_DESCRIPTOR_SIZE,
+  &hid_configuration_descriptor_data[MOUSE_HID_DESC_OFFSET]
+};
+#endif /* MOUSE_ENABLE */
+#ifdef CONSOLE_ENABLE
+static const USBDescriptor console_hid_descriptor = {
+  HID_DESCRIPTOR_SIZE,
+  &hid_configuration_descriptor_data[CONSOLE_HID_DESC_OFFSET]
+};
+#endif /* CONSOLE_ENABLE */
+#ifdef EXTRAKEY_ENABLE
+static const USBDescriptor extra_hid_descriptor = {
+  HID_DESCRIPTOR_SIZE,
+  &hid_configuration_descriptor_data[EXTRA_HID_DESC_OFFSET]
+};
+#endif /* EXTRAKEY_ENABLE */
+#ifdef NKRO_ENABLE
+static const USBDescriptor nkro_hid_descriptor = {
+  HID_DESCRIPTOR_SIZE,
+  &hid_configuration_descriptor_data[NKRO_HID_DESC_OFFSET]
+};
+#endif /* NKRO_ENABLE */
+
+
+/* U.S. English language identifier */
+static const uint8_t usb_string_langid[] = {
+  USB_DESC_BYTE(4),                        // bLength
+  USB_DESC_BYTE(USB_DESCRIPTOR_STRING),    // bDescriptorType
+  USB_DESC_WORD(0x0409)                    // wLANGID (U.S. English)
+};
+
+/* ugly ugly hack */
+#define PP_NARG(...) \
+         PP_NARG_(__VA_ARGS__,PP_RSEQ_N())
+#define PP_NARG_(...) \
+         PP_ARG_N(__VA_ARGS__)
+#define PP_ARG_N( \
+          _1, _2, _3, _4, _5, _6, _7, _8, _9,_10, \
+         _11,_12,_13,_14,_15,_16,_17,_18,_19,_20, \
+         _21,_22,_23,_24,_25,_26,_27,_28,_29,_30, \
+         _31,_32,_33,_34,_35,_36,_37,_38,_39,_40, \
+         _41,_42,_43,_44,_45,_46,_47,_48,_49,_50, \
+         _51,_52,_53,_54,_55,_56,_57,_58,_59,_60, \
+         _61,_62,_63,N,...) N
+#define PP_RSEQ_N() \
+         63,62,61,60,                   \
+         59,58,57,56,55,54,53,52,51,50, \
+         49,48,47,46,45,44,43,42,41,40, \
+         39,38,37,36,35,34,33,32,31,30, \
+         29,28,27,26,25,24,23,22,21,20, \
+         19,18,17,16,15,14,13,12,11,10, \
+         9,8,7,6,5,4,3,2,1,0
+
+/* Vendor string = manufacturer */
+static const uint8_t usb_string_vendor[] = {
+  USB_DESC_BYTE(PP_NARG(USBSTR_MANUFACTURER)+2),                       // bLength
+  USB_DESC_BYTE(USB_DESCRIPTOR_STRING),    // bDescriptorType
+  USBSTR_MANUFACTURER
+};
+
+/* Device Description string = product */
+static const uint8_t usb_string_description[] = {
+  USB_DESC_BYTE(PP_NARG(USBSTR_PRODUCT)+2),           // bLength
+  USB_DESC_BYTE(USB_DESCRIPTOR_STRING),    // bDescriptorType
+  USBSTR_PRODUCT
+};
+
+/* Serial Number string (will be filled by the function init_usb_serial_string) */
+static uint8_t usb_string_serial[] = {
+  USB_DESC_BYTE(22),                       // bLength
+  USB_DESC_BYTE(USB_DESCRIPTOR_STRING),    // bDescriptorType
+  '0', 0, 'x', 0, 'D', 0, 'E', 0, 'A', 0, 'D', 0, 'B', 0, 'E', 0, 'E', 0, 'F', 0
+};
+
+/* Strings wrappers array */
+static const USBDescriptor usb_strings[] = {
+  { sizeof usb_string_langid, usb_string_langid }
+  ,
+  { sizeof usb_string_vendor, usb_string_vendor }
+  ,
+  { sizeof usb_string_description, usb_string_description }
+  ,
+  { sizeof usb_string_serial, usb_string_serial }
+};
+
+/*
+ * Handles the GET_DESCRIPTOR callback
+ *
+ * Returns the proper descriptor
+ */
+static const USBDescriptor *usb_get_descriptor_cb(USBDriver *usbp, uint8_t dtype, uint8_t dindex, uint16_t lang) {
+  (void)usbp;
+  (void)lang;
+  switch(dtype) {
+  /* Generic descriptors */
+  case USB_DESCRIPTOR_DEVICE:   /* Device Descriptor */
+    return &usb_device_descriptor;
+
+  case USB_DESCRIPTOR_CONFIGURATION:    /* Configuration Descriptor */
+    return &hid_configuration_descriptor;
+
+  case USB_DESCRIPTOR_STRING:   /* Strings */
+    if(dindex < 4)
+      return &usb_strings[dindex];
+    break;
+
+  /* HID specific descriptors */
+  case USB_DESCRIPTOR_HID:      /* HID Descriptors */
+    switch(lang) {    /* yea, poor label, it's actually wIndex from the setup packet */
+    case KBD_INTERFACE:
+      return &keyboard_hid_descriptor;
+
+#ifdef MOUSE_ENABLE
+    case MOUSE_INTERFACE:
+      return &mouse_hid_descriptor;
+#endif /* MOUSE_ENABLE */
+#ifdef CONSOLE_ENABLE
+    case CONSOLE_INTERFACE:
+      return &console_hid_descriptor;
+#endif /* CONSOLE_ENABLE */
+#ifdef EXTRAKEY_ENABLE
+    case EXTRA_INTERFACE:
+      return &extra_hid_descriptor;
+#endif /* EXTRAKEY_ENABLE */
+#ifdef NKRO_ENABLE
+    case NKRO_INTERFACE:
+      return &nkro_hid_descriptor;
+#endif /* NKRO_ENABLE */
+    }
+
+  case USB_DESCRIPTOR_HID_REPORT:       /* HID Report Descriptor */
+    switch(lang) {
+    case KBD_INTERFACE:
+      return &keyboard_hid_report_descriptor;
+
+#ifdef MOUSE_ENABLE
+    case MOUSE_INTERFACE:
+      return &mouse_hid_report_descriptor;
+#endif /* MOUSE_ENABLE */
+#ifdef CONSOLE_ENABLE
+    case CONSOLE_INTERFACE:
+      return &console_hid_report_descriptor;
+#endif /* CONSOLE_ENABLE */
+#ifdef EXTRAKEY_ENABLE
+    case EXTRA_INTERFACE:
+      return &extra_hid_report_descriptor;
+#endif /* EXTRAKEY_ENABLE */
+#ifdef NKRO_ENABLE
+    case NKRO_INTERFACE:
+      return &nkro_hid_report_descriptor;
+#endif /* NKRO_ENABLE */
+    }
+  }
+  return NULL;
+}
+
+/* keyboard endpoint state structure */
+static USBInEndpointState kbd_ep_state;
+/* keyboard endpoint initialization structure (IN) */
+static const USBEndpointConfig kbd_ep_config = {
+  USB_EP_MODE_TYPE_INTR,        /* Interrupt EP */
+  NULL,                         /* SETUP packet notification callback */
+  kbd_in_cb,                    /* IN notification callback */
+  NULL,                         /* OUT notification callback */
+  KBD_SIZE,                     /* IN maximum packet size */
+  0,                            /* OUT maximum packet size */
+  &kbd_ep_state,                /* IN Endpoint state */
+  NULL,                         /* OUT endpoint state */
+  2,                            /* IN multiplier */
+  NULL                          /* SETUP buffer (not a SETUP endpoint) */
+};
+
+#ifdef MOUSE_ENABLE
+/* mouse endpoint state structure */
+static USBInEndpointState mouse_ep_state;
+
+/* mouse endpoint initialization structure (IN) */
+static const USBEndpointConfig mouse_ep_config = {
+  USB_EP_MODE_TYPE_INTR,        /* Interrupt EP */
+  NULL,                         /* SETUP packet notification callback */
+  mouse_in_cb,                  /* IN notification callback */
+  NULL,                         /* OUT notification callback */
+  MOUSE_SIZE,                   /* IN maximum packet size */
+  0,                            /* OUT maximum packet size */
+  &mouse_ep_state,              /* IN Endpoint state */
+  NULL,                         /* OUT endpoint state */
+  2,                            /* IN multiplier */
+  NULL                          /* SETUP buffer (not a SETUP endpoint) */
+};
+#endif /* MOUSE_ENABLE */
+
+#ifdef CONSOLE_ENABLE
+/* console endpoint state structure */
+static USBInEndpointState console_ep_state;
+
+/* console endpoint initialization structure (IN) */
+static const USBEndpointConfig console_ep_config = {
+  USB_EP_MODE_TYPE_INTR,        /* Interrupt EP */
+  NULL,                         /* SETUP packet notification callback */
+  console_in_cb,                /* IN notification callback */
+  NULL,                         /* OUT notification callback */
+  CONSOLE_SIZE,                 /* IN maximum packet size */
+  0,                            /* OUT maximum packet size */
+  &console_ep_state,            /* IN Endpoint state */
+  NULL,                         /* OUT endpoint state */
+  2,                            /* IN multiplier */
+  NULL                          /* SETUP buffer (not a SETUP endpoint) */
+};
+#endif /* CONSOLE_ENABLE */
+
+#ifdef EXTRAKEY_ENABLE
+/* extrakey endpoint state structure */
+static USBInEndpointState extra_ep_state;
+
+/* extrakey endpoint initialization structure (IN) */
+static const USBEndpointConfig extra_ep_config = {
+  USB_EP_MODE_TYPE_INTR,        /* Interrupt EP */
+  NULL,                         /* SETUP packet notification callback */
+  extra_in_cb,                  /* IN notification callback */
+  NULL,                         /* OUT notification callback */
+  EXTRA_SIZE,                   /* IN maximum packet size */
+  0,                            /* OUT maximum packet size */
+  &extra_ep_state,              /* IN Endpoint state */
+  NULL,                         /* OUT endpoint state */
+  2,                            /* IN multiplier */
+  NULL                          /* SETUP buffer (not a SETUP endpoint) */
+};
+#endif /* EXTRAKEY_ENABLE */
+
+#ifdef NKRO_ENABLE
+/* nkro endpoint state structure */
+static USBInEndpointState nkro_ep_state;
+
+/* nkro endpoint initialization structure (IN) */
+static const USBEndpointConfig nkro_ep_config = {
+  USB_EP_MODE_TYPE_INTR,        /* Interrupt EP */
+  NULL,                         /* SETUP packet notification callback */
+  nkro_in_cb,                   /* IN notification callback */
+  NULL,                         /* OUT notification callback */
+  NKRO_SIZE,                    /* IN maximum packet size */
+  0,                            /* OUT maximum packet size */
+  &nkro_ep_state,               /* IN Endpoint state */
+  NULL,                         /* OUT endpoint state */
+  2,                            /* IN multiplier */
+  NULL                          /* SETUP buffer (not a SETUP endpoint) */
+};
+#endif /* NKRO_ENABLE */
+
+/* ---------------------------------------------------------
+ *                  USB driver functions
+ * ---------------------------------------------------------
+ */
+
+/* Handles the USB driver global events
+ * TODO: maybe disable some things when connection is lost? */
+static void usb_event_cb(USBDriver *usbp, usbevent_t event) {
+  switch(event) {
+  case USB_EVENT_RESET:
+    return;
+
+  case USB_EVENT_ADDRESS:
+    return;
+
+  case USB_EVENT_CONFIGURED:
+    osalSysLockFromISR();
+    /* Enable the endpoints specified into the configuration. */
+    usbInitEndpointI(usbp, KBD_ENDPOINT, &kbd_ep_config);
+#ifdef MOUSE_ENABLE
+    usbInitEndpointI(usbp, MOUSE_ENDPOINT, &mouse_ep_config);
+#endif /* MOUSE_ENABLE */
+#ifdef CONSOLE_ENABLE
+    usbInitEndpointI(usbp, CONSOLE_ENDPOINT, &console_ep_config);
+    /* don't need to start the flush timer, it starts from console_in_cb automatically */
+#endif /* CONSOLE_ENABLE */
+#ifdef EXTRAKEY_ENABLE
+    usbInitEndpointI(usbp, EXTRA_ENDPOINT, &extra_ep_config);
+#endif /* EXTRAKEY_ENABLE */
+#ifdef NKRO_ENABLE
+    usbInitEndpointI(usbp, NKRO_ENDPOINT, &nkro_ep_config);
+#endif /* NKRO_ENABLE */
+    osalSysUnlockFromISR();
+    return;
+
+  case USB_EVENT_SUSPEND:
+    return;
+
+  case USB_EVENT_WAKEUP:
+    return;
+
+  case USB_EVENT_STALLED:
+    return;
+  }
+}
+
+/* Function used locally in os/hal/src/usb.c for getting descriptors
+ * need it here for HID descriptor */
+static uint16_t get_hword(uint8_t *p) {
+  uint16_t hw;
+
+  hw = (uint16_t)*p++;
+  hw |= (uint16_t)*p << 8U;
+  return hw;
+}
+
+/*
+ * Appendix G: HID Request Support Requirements
+ *
+ * The following table enumerates the requests that need to be supported by various types of HID class devices.
+ * Device type     GetReport   SetReport   GetIdle     SetIdle     GetProtocol SetProtocol
+ * ------------------------------------------------------------------------------------------
+ * Boot Mouse      Required    Optional    Optional    Optional    Required    Required
+ * Non-Boot Mouse  Required    Optional    Optional    Optional    Optional    Optional
+ * Boot Keyboard   Required    Optional    Required    Required    Required    Required
+ * Non-Boot Keybrd Required    Optional    Required    Required    Optional    Optional
+ * Other Device    Required    Optional    Optional    Optional    Optional    Optional
+ */
+
+/* Callback for SETUP request on the endpoint 0 (control) */
+static bool usb_request_hook_cb(USBDriver *usbp) {
+  const USBDescriptor *dp;
+
+  /* usbp->setup fields:
+   *  0:   bmRequestType (bitmask)
+   *  1:   bRequest
+   *  2,3: (LSB,MSB) wValue
+   *  4,5: (LSB,MSB) wIndex
+   *  6,7: (LSB,MSB) wLength (number of bytes to transfer if there is a data phase) */
+
+  /* Handle HID class specific requests */
+  if(((usbp->setup[0] & USB_RTYPE_TYPE_MASK) == USB_RTYPE_TYPE_CLASS) &&
+     ((usbp->setup[0] & USB_RTYPE_RECIPIENT_MASK) == USB_RTYPE_RECIPIENT_INTERFACE)) {
+    switch(usbp->setup[0] & USB_RTYPE_DIR_MASK) {
+    case USB_RTYPE_DIR_DEV2HOST:
+      switch(usbp->setup[1]) {   /* bRequest */
+      case HID_GET_REPORT:
+        switch(usbp->setup[4]) {     /* LSB(wIndex) (check MSB==0?) */
+        case KBD_INTERFACE:
+#ifdef NKRO_ENABLE
+        case NKRO_INTERFACE:
+#endif /* NKRO_ENABLE */
+          usbSetupTransfer(usbp, (uint8_t *)&keyboard_report_sent, sizeof(keyboard_report_sent), NULL);
+          return TRUE;
+          break;
+
+        default:
+          usbSetupTransfer(usbp, NULL, 0, NULL);
+          return TRUE;
+          break;
+        }
+        break;
+
+      case HID_GET_PROTOCOL:
+        if((usbp->setup[4] == KBD_INTERFACE) && (usbp->setup[5] == 0)) {   /* wIndex */
+          usbSetupTransfer(usbp, &keyboard_protocol, 1, NULL);
+          return TRUE;
+        }
+        break;
+
+      case HID_GET_IDLE:
+        usbSetupTransfer(usbp, &keyboard_idle, 1, NULL);
+        return TRUE;
+        break;
+      }
+      break;
+
+    case USB_RTYPE_DIR_HOST2DEV:
+      switch(usbp->setup[1]) {   /* bRequest */
+      case HID_SET_REPORT:
+        switch(usbp->setup[4]) {       /* LSB(wIndex) (check MSB==0 and wLength==1?) */
+        case KBD_INTERFACE:
+#ifdef NKRO_ENABLE
+        case NKRO_INTERFACE:
+#endif  /* NKRO_ENABLE */
+        /* keyboard_led_stats = <read byte from next OUT report>
+         * keyboard_led_stats needs be word (or dword), otherwise we get an exception on F0 */
+          usbSetupTransfer(usbp, (uint8_t *)&keyboard_led_stats, 1, NULL);
+          return TRUE;
+          break;
+        }
+        break;
+
+      case HID_SET_PROTOCOL:
+        if((usbp->setup[4] == KBD_INTERFACE) && (usbp->setup[5] == 0)) {   /* wIndex */
+          keyboard_protocol = ((usbp->setup[2]) != 0x00);   /* LSB(wValue) */
+#ifdef NKRO_ENABLE
+          keyboard_nkro = !!keyboard_protocol;
+          if(!keyboard_nkro && keyboard_idle) {
+#else /* NKRO_ENABLE */
+          if(keyboard_idle) {
+#endif /* NKRO_ENABLE */
+          /* arm the idle timer if boot protocol & idle */
+            osalSysLockFromISR();
+            chVTSetI(&keyboard_idle_timer, 4*MS2ST(keyboard_idle), keyboard_idle_timer_cb, NULL);
+            osalSysUnlockFromISR();
+          }
+        }
+        usbSetupTransfer(usbp, NULL, 0, NULL);
+        return TRUE;
+        break;
+
+      case HID_SET_IDLE:
+        keyboard_idle = usbp->setup[3];     /* MSB(wValue) */
+        /* arm the timer */
+#ifdef NKRO_ENABLE
+        if(!keyboard_nkro && keyboard_idle) {
+#else /* NKRO_ENABLE */
+        if(keyboard_idle) {
+#endif /* NKRO_ENABLE */
+          osalSysLockFromISR();
+          chVTSetI(&keyboard_idle_timer, 4*MS2ST(keyboard_idle), keyboard_idle_timer_cb, NULL);
+          osalSysUnlockFromISR();
+        }
+        usbSetupTransfer(usbp, NULL, 0, NULL);
+        return TRUE;
+        break;
+      }
+      break;
+    }
+  }
+
+  /* Handle the Get_Descriptor Request for HID class (not handled by the default hook) */
+  if((usbp->setup[0] == 0x81) && (usbp->setup[1] == USB_REQ_GET_DESCRIPTOR)) {
+    dp = usbp->config->get_descriptor_cb(usbp, usbp->setup[3], usbp->setup[2], get_hword(&usbp->setup[4]));
+    if(dp == NULL)
+      return FALSE;
+    usbSetupTransfer(usbp, (uint8_t *)dp->ud_string, dp->ud_size, NULL);
+    return TRUE;
+  }
+
+  return FALSE;
+}
+
+/* Start-of-frame callback */
+static void usb_sof_cb(USBDriver *usbp) {
+  kbd_sof_cb(usbp);
+}
+
+
+/* USB driver configuration */
+static const USBConfig usbcfg = {
+  usb_event_cb,                 /* USB events callback */
+  usb_get_descriptor_cb,        /* Device GET_DESCRIPTOR request callback */
+  usb_request_hook_cb,          /* Requests hook callback */
+  usb_sof_cb                    /* Start Of Frame callback */
+};
+
+/*
+ * Initialize the USB driver
+ */
+void init_usb_driver(void) {
+  /*
+   * Activates the USB driver and then the USB bus pull-up on D+.
+   * Note, a delay is inserted in order to not have to disconnect the cable
+   * after a reset.
+   */
+  usbDisconnectBus(&USB_DRIVER);
+  chThdSleepMilliseconds(1500);
+  usbStart(&USB_DRIVER, &usbcfg);
+  usbConnectBus(&USB_DRIVER);
+
+  chVTObjectInit(&keyboard_idle_timer);
+#ifdef CONSOLE_ENABLE
+  oqObjectInit(&console_queue, console_queue_buffer, sizeof(console_queue_buffer), console_queue_onotify, NULL);
+  chVTObjectInit(&console_flush_timer);
+#endif
+}
+
+/* ---------------------------------------------------------
+ *                  Keyboard functions
+ * ---------------------------------------------------------
+ */
+
+/* keyboard IN callback hander (a kbd report has made it IN) */
+void kbd_in_cb(USBDriver *usbp, usbep_t ep) {
+  /* STUB */
+  (void)usbp;
+  (void)ep;
+}
+
+#ifdef NKRO_ENABLE
+/* nkro IN callback hander (a nkro report has made it IN) */
+void nkro_in_cb(USBDriver *usbp, usbep_t ep) {
+  /* STUB */
+  (void)usbp;
+  (void)ep;
+}
+#endif /* NKRO_ENABLE */
+
+/* start-of-frame handler
+ * TODO: i guess it would be better to re-implement using timers,
+ *  so that this is not going to have to be checked every 1ms */
+void kbd_sof_cb(USBDriver *usbp) {
+  (void)usbp;
+}
+
+/* Idle requests timer code
+ * callback (called from ISR, unlocked state) */
+static void keyboard_idle_timer_cb(void *arg) {
+  (void)arg;
+
+  osalSysLockFromISR();
+
+  /* check that the states of things are as they're supposed to */
+  if(usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) {
+    /* do not rearm the timer, should be enabled on IDLE request */
+    osalSysUnlockFromISR();
+    return;
+  }
+
+#ifdef NKRO_ENABLE
+  if(!keyboard_nkro && keyboard_idle) {
+#else /* NKRO_ENABLE */
+  if(keyboard_idle) {
+#endif /* NKRO_ENABLE */
+    /* TODO: are we sure we want the KBD_ENDPOINT? */
+    osalSysUnlockFromISR();
+    usbPrepareTransmit(&USB_DRIVER, KBD_ENDPOINT, (uint8_t *)&keyboard_report_sent, sizeof(keyboard_report_sent));
+    osalSysLockFromISR();
+    usbStartTransmitI(&USB_DRIVER, KBD_ENDPOINT);
+    /* rearm the timer */
+    chVTSetI(&keyboard_idle_timer, 4*MS2ST(keyboard_idle), keyboard_idle_timer_cb, NULL);
+  }
+
+  /* do not rearm the timer if the condition above fails
+   * it should be enabled again on either IDLE or SET_PROTOCOL requests */
+  osalSysUnlockFromISR();
+}
+
+/* LED status */
+uint8_t keyboard_leds(void) {
+  return (uint8_t)(keyboard_led_stats & 0xFF);
+}
+
+/* prepare and start sending a report IN
+ * not callable from ISR or locked state */
+void send_keyboard(report_keyboard_t *report) {
+  osalSysLock();
+  if(usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) {
+    osalSysUnlock();
+    return;
+  }
+  osalSysUnlock();
+
+#ifdef NKRO_ENABLE
+  if(keyboard_nkro) {  /* NKRO protocol */
+    usbPrepareTransmit(&USB_DRIVER, NKRO_ENDPOINT, (uint8_t *)report, sizeof(report_keyboard_t));
+    osalSysLock();
+    usbStartTransmitI(&USB_DRIVER, NKRO_ENDPOINT);
+    osalSysUnlock();
+  } else
+#endif /* NKRO_ENABLE */
+  { /* boot protocol */
+    usbPrepareTransmit(&USB_DRIVER, KBD_ENDPOINT, (uint8_t *)report, sizeof(report_keyboard_t));
+    osalSysLock();
+    usbStartTransmitI(&USB_DRIVER, KBD_ENDPOINT);
+    osalSysUnlock();
+  }
+  keyboard_report_sent = *report;
+}
+
+/* ---------------------------------------------------------
+ *                     Mouse functions
+ * ---------------------------------------------------------
+ */
+
+#ifdef MOUSE_ENABLE
+
+/* mouse IN callback hander (a mouse report has made it IN) */
+void mouse_in_cb(USBDriver *usbp, usbep_t ep) {
+  (void)usbp;
+  (void)ep;
+}
+
+void send_mouse(report_mouse_t *report) {
+  osalSysLock();
+  if(usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) {
+    osalSysUnlock();
+    return;
+  }
+  osalSysUnlock();
+
+  /* TODO: LUFA manually waits for the endpoint to become ready
+   * for about 10ms for mouse, kbd, system; 1ms for nkro
+   * is this really needed?
+   */
+
+  usbPrepareTransmit(&USB_DRIVER, MOUSE_ENDPOINT, (uint8_t *)report, sizeof(report_mouse_t));
+  osalSysLock();
+  usbStartTransmitI(&USB_DRIVER, MOUSE_ENDPOINT);
+  osalSysUnlock();
+}
+
+#else /* MOUSE_ENABLE */
+void send_mouse(report_mouse_t *report) {
+  (void)report;
+}
+#endif /* MOUSE_ENABLE */
+
+/* ---------------------------------------------------------
+ *                   Extrakey functions
+ * ---------------------------------------------------------
+ */
+
+#ifdef EXTRAKEY_ENABLE
+
+/* extrakey IN callback hander */
+void extra_in_cb(USBDriver *usbp, usbep_t ep) {
+  /* STUB */
+  (void)usbp;
+  (void)ep;
+}
+
+static void send_extra_report(uint8_t report_id, uint16_t data) {
+  osalSysLock();
+  if(usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) {
+    osalSysUnlock();
+    return;
+  }
+
+  report_extra_t report = {
+    .report_id = report_id,
+    .usage = data
+  };
+
+  osalSysUnlock();
+  usbPrepareTransmit(&USB_DRIVER, EXTRA_ENDPOINT, (uint8_t *)&report, sizeof(report_extra_t));
+  osalSysLock();
+  usbStartTransmitI(&USB_DRIVER, EXTRA_ENDPOINT);
+  osalSysUnlock();
+}
+
+void send_system(uint16_t data) {
+  send_extra_report(REPORT_ID_SYSTEM, data);
+}
+
+void send_consumer(uint16_t data) {
+  send_extra_report(REPORT_ID_CONSUMER, data);
+}
+
+#else /* EXTRAKEY_ENABLE */
+void send_system(uint16_t data) {
+  (void)data;
+}
+void send_consumer(uint16_t data) {
+  (void)data;
+}
+#endif /* EXTRAKEY_ENABLE */
+
+/* ---------------------------------------------------------
+ *                   Console functions
+ * ---------------------------------------------------------
+ */
+
+#ifdef CONSOLE_ENABLE
+
+/* debug IN callback hander */
+void console_in_cb(USBDriver *usbp, usbep_t ep) {
+  (void)ep;
+  osalSysLockFromISR();
+
+  /* rearm the timer */
+  chVTSetI(&console_flush_timer, MS2ST(CONSOLE_FLUSH_MS), console_flush_cb, NULL);
+
+  /* Check if there is data to send left in the output queue */
+  if(chOQGetFullI(&console_queue) >= CONSOLE_SIZE) {
+    osalSysUnlockFromISR();
+    usbPrepareQueuedTransmit(usbp, CONSOLE_ENDPOINT, &console_queue, CONSOLE_SIZE);
+    osalSysLockFromISR();
+    usbStartTransmitI(usbp, CONSOLE_ENDPOINT);
+  }
+
+  osalSysUnlockFromISR();
+}
+
+/* Callback when data is inserted into the output queue
+ * Called from a locked state */
+void console_queue_onotify(io_queue_t *qp) {
+  (void)qp;
+
+  if(usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE)
+    return;
+
+  if(!usbGetTransmitStatusI(&USB_DRIVER, CONSOLE_ENDPOINT)
+     && (chOQGetFullI(&console_queue) >= CONSOLE_SIZE)) {
+    osalSysUnlock();
+    usbPrepareQueuedTransmit(&USB_DRIVER, CONSOLE_ENDPOINT, &console_queue, CONSOLE_SIZE);
+    osalSysLock();
+    usbStartTransmitI(&USB_DRIVER, CONSOLE_ENDPOINT);
+  }
+}
+
+/* Flush timer code
+ * callback (called from ISR, unlocked state) */
+static void console_flush_cb(void *arg) {
+  (void)arg;
+  size_t i, n;
+  uint8_t buf[CONSOLE_SIZE]; /* TODO: a solution without extra buffer? */
+  osalSysLockFromISR();
+
+  /* check that the states of things are as they're supposed to */
+  if(usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) {
+    /* rearm the timer */
+    chVTSetI(&console_flush_timer, MS2ST(CONSOLE_FLUSH_MS), console_flush_cb, NULL);
+    osalSysUnlockFromISR();
+    return;
+  }
+
+  /* don't do anything if the queue is empty or has enough stuff in it */
+  if(((n = oqGetFullI(&console_queue)) == 0) || (n >= CONSOLE_SIZE)) {
+    /* rearm the timer */
+    chVTSetI(&console_flush_timer, MS2ST(CONSOLE_FLUSH_MS), console_flush_cb, NULL);
+    osalSysUnlockFromISR();
+    return;
+  }
+
+  /* there's stuff hanging in the queue - so dequeue and send */
+  for(i = 0; i < n; i++)
+    buf[i] = (uint8_t)oqGetI(&console_queue);
+  for(i = n; i < CONSOLE_SIZE; i++)
+    buf[i] = 0;
+  osalSysUnlockFromISR();
+  usbPrepareTransmit(&USB_DRIVER, CONSOLE_ENDPOINT, buf, CONSOLE_SIZE);
+  osalSysLockFromISR();
+  (void)usbStartTransmitI(&USB_DRIVER, CONSOLE_ENDPOINT);
+
+  /* rearm the timer */
+  chVTSetI(&console_flush_timer, MS2ST(CONSOLE_FLUSH_MS), console_flush_cb, NULL);
+  osalSysUnlockFromISR();
+}
+
+
+int8_t sendchar(uint8_t c) {
+  osalSysLock();
+  if(usbGetDriverStateI(&USB_DRIVER) != USB_ACTIVE) {
+    osalSysUnlock();
+    return 0;
+  }
+  osalSysUnlock();
+  /* should get suspended and wait if the queue is full
+   * but it's not blocking even if noone is listening,
+   *  because the USB packets are sent anyway */
+  return(chOQPut(&console_queue, c));
+}
+
+#else /* CONSOLE_ENABLE */
+int8_t sendchar(uint8_t c) {
+  (void)c;
+  return 0;
+}
+#endif /* CONSOLE_ENABLE */
+
+void sendchar_pf(void *p, char c) {
+  (void)p;
+  sendchar((uint8_t)c);
+}

diff --git a/tmk_core/protocol/chibios/usb_main.h b/tmk_core/protocol/chibios/usb_main.h
new file mode 100644 (file)
index 0000000..b769664
--- /dev/null
+++ b/tmk_core/protocol/chibios/usb_main.h
@@ -0,0 +1,149 @@
+/*
+ * (c) 2015 flabberast <s3+flabbergast@sdfeu.org>
+ *
+ * Based on the following work:
+ *  - Guillaume Duc's raw hid example (MIT License)
+ *    https://github.com/guiduc/usb-hid-chibios-example
+ *  - PJRC Teensy examples (MIT License)
+ *    https://www.pjrc.com/teensy/usb_keyboard.html
+ *  - hasu's TMK keyboard code (GPL v2 and some code Modified BSD)
+ *    https://github.com/tmk/tmk_keyboard/
+ *  - ChibiOS demo code (Apache 2.0 License)
+ *    http://www.chibios.org
+ *
+ * Since some GPL'd code is used, this work is licensed under
+ * GPL v2 or later.
+ */
+
+
+#ifndef _USB_MAIN_H_
+#define _USB_MAIN_H_
+
+#include "ch.h"
+#include "hal.h"
+
+/* -------------------------
+ * General USB driver header
+ * -------------------------
+ */
+
+/* The USB driver to use */
+#define USB_DRIVER USBD1
+
+/* Initialize the USB driver and bus */
+void init_usb_driver(void);
+
+/* ---------------
+ * Keyboard header
+ * ---------------
+ */
+
+/* main keyboard (6kro) */
+#define KBD_INTERFACE   0
+#define KBD_ENDPOINT    1
+#define KBD_SIZE        8
+#define KBD_REPORT_KEYS   (KBD_SIZE - 2)
+
+/* secondary keyboard */
+#ifdef NKRO_ENABLE
+#define NKRO_INTERFACE    4
+#define NKRO_ENDPOINT     5
+#define NKRO_SIZE         16
+#define NKRO_REPORT_KEYS  (NKRO_SIZE - 1)
+#endif
+
+/* this defines report_keyboard_t and computes REPORT_SIZE defines */
+#include "report.h"
+
+/* extern report_keyboard_t keyboard_report_sent; */
+
+/* keyboard IN request callback handler */
+void kbd_in_cb(USBDriver *usbp, usbep_t ep);
+
+/* start-of-frame handler */
+void kbd_sof_cb(USBDriver *usbp);
+
+#ifdef NKRO_ENABLE
+/* nkro IN callback hander */
+void nkro_in_cb(USBDriver *usbp, usbep_t ep);
+#endif /* NKRO_ENABLE */
+
+/* ------------
+ * Mouse header
+ * ------------
+ */
+
+#ifdef MOUSE_ENABLE
+
+#define MOUSE_INTERFACE         1
+#define MOUSE_ENDPOINT          2
+#define MOUSE_SIZE              8
+
+/* mouse IN request callback handler */
+void mouse_in_cb(USBDriver *usbp, usbep_t ep);
+#endif /* MOUSE_ENABLE */
+
+/* ---------------
+ * Extrakey header
+ * ---------------
+ */
+
+#ifdef EXTRAKEY_ENABLE
+
+#define EXTRA_INTERFACE         3
+#define EXTRA_ENDPOINT          4
+#define EXTRA_SIZE              8
+
+/* extrakey IN request callback handler */
+void extra_in_cb(USBDriver *usbp, usbep_t ep);
+
+/* extra report structure */
+typedef struct {
+  uint8_t report_id;
+  uint16_t usage;
+} __attribute__ ((packed)) report_extra_t;
+#endif /* EXTRAKEY_ENABLE */
+
+/* --------------
+ * Console header
+ * --------------
+ */
+
+#ifdef CONSOLE_ENABLE
+
+#define CONSOLE_INTERFACE      2
+#define CONSOLE_ENDPOINT       3
+#define CONSOLE_SIZE           16
+
+/* Number of IN reports that can be stored inside the output queue */
+#define CONSOLE_QUEUE_CAPACITY 2
+#define CONSOLE_QUEUE_BUFFER_SIZE (CONSOLE_QUEUE_CAPACITY * CONSOLE_SIZE)
+
+/* Console flush time */
+#define CONSOLE_FLUSH_MS 50
+
+/* Putchar over the USB console */
+int8_t sendchar(uint8_t c);
+/* wrapper for printf lib */
+
+/* Flush output (send everything immediately) */
+void console_flush_output(void);
+
+/* console IN request callback handler */
+void console_in_cb(USBDriver *usbp, usbep_t ep);
+#endif /* CONSOLE_ENABLE */
+
+void sendchar_pf(void *p, char c);
+
+/* ---------------------------
+ * Host driver functions (TMK)
+ * ---------------------------
+ */
+
+uint8_t keyboard_leds(void);
+void send_keyboard(report_keyboard_t *report);
+void send_mouse(report_mouse_t *report);
+void send_system(uint16_t data);
+void send_consumer(uint16_t data);
+
+#endif /* _USB_MAIN_H_ */

diff --git a/tmk_core/tool/chibios/common.mk b/tmk_core/tool/chibios/common.mk
new file mode 100644 (file)
index 0000000..952ec49
--- /dev/null
+++ b/tmk_core/tool/chibios/common.mk
@@ -0,0 +1,86 @@
+COMMON_DIR = $(TMK_DIR)/common
+SRC += $(COMMON_DIR)/host.c \
+       $(COMMON_DIR)/keyboard.c \
+       $(COMMON_DIR)/action.c \
+       $(COMMON_DIR)/action_tapping.c \
+       $(COMMON_DIR)/action_macro.c \
+       $(COMMON_DIR)/action_layer.c \
+       $(COMMON_DIR)/action_util.c \
+       $(COMMON_DIR)/keymap.c \
+       $(COMMON_DIR)/print.c \
+       $(COMMON_DIR)/debug.c \
+       $(COMMON_DIR)/util.c \
+       $(COMMON_DIR)/chibios/suspend.c \
+       $(COMMON_DIR)/chibios/printf.c \
+       $(COMMON_DIR)/chibios/timer.c \
+       $(COMMON_DIR)/chibios/bootloader.c
+
+
+# Option modules
+ifdef BOOTMAGIC_ENABLE
+    $(error Bootmagic Not Supported)
+    SRC += $(COMMON_DIR)/bootmagic.c
+    SRC += $(COMMON_DIR)/chibios/eeconfig.c
+    OPT_DEFS += -DBOOTMAGIC_ENABLE
+endif
+
+ifdef MOUSEKEY_ENABLE
+    SRC += $(COMMON_DIR)/mousekey.c
+    OPT_DEFS += -DMOUSEKEY_ENABLE
+    OPT_DEFS += -DMOUSE_ENABLE
+endif
+
+ifdef EXTRAKEY_ENABLE
+    OPT_DEFS += -DEXTRAKEY_ENABLE
+endif
+
+ifdef CONSOLE_ENABLE
+    OPT_DEFS += -DCONSOLE_ENABLE
+else
+    OPT_DEFS += -DNO_PRINT
+    OPT_DEFS += -DNO_DEBUG
+endif
+
+ifdef COMMAND_ENABLE
+    SRC += $(COMMON_DIR)/command.c
+    OPT_DEFS += -DCOMMAND_ENABLE
+endif
+
+ifdef NKRO_ENABLE
+    OPT_DEFS += -DNKRO_ENABLE
+endif
+
+ifdef USB_6KRO_ENABLE
+    OPT_DEFS += -DUSB_6KRO_ENABLE
+endif
+
+ifdef SLEEP_LED_ENABLE
+    $(error Sleep LED Not Supported)
+    SRC += $(COMMON_DIR)/sleep_led.c
+    OPT_DEFS += -DSLEEP_LED_ENABLE
+    OPT_DEFS += -DNO_SUSPEND_POWER_DOWN
+endif
+
+ifdef BACKLIGHT_ENABLE
+    SRC += $(COMMON_DIR)/backlight.c
+    OPT_DEFS += -DBACKLIGHT_ENABLE
+endif
+
+ifdef KEYMAP_SECTION_ENABLE
+    OPT_DEFS += -DKEYMAP_SECTION_ENABLE
+
+    ifeq ($(strip $(MCU)),atmega32u2)
+       EXTRALDFLAGS = -Wl,-L$(TMK_DIR),-Tldscript_keymap_avr35.x
+    else ifeq ($(strip $(MCU)),atmega32u4)
+       EXTRALDFLAGS = -Wl,-L$(TMK_DIR),-Tldscript_keymap_avr5.x
+    else
+       EXTRALDFLAGS = $(error no ldscript for keymap section)
+    endif
+endif
+
+# Version string
+OPT_DEFS += -DVERSION=$(shell (git describe --always --dirty || echo 'unknown') 2> /dev/null)
+
+
+# Search Path
+VPATH += $(TMK_DIR)/common