Add ChibiOS support (USB stack + support files).
This commit is contained in:
flabbergast
parent
be9be90483
commit
27dec2db7b
16 changed files with 2245 additions and 5 deletions
1
tmk_core/protocol/chibios/.gitignore
vendored
Normal file
1
tmk_core/protocol/chibios/.gitignore
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
chibios
|
||||
25
tmk_core/protocol/chibios/README.md
Normal file
25
tmk_core/protocol/chibios/README.md
Normal file
|
|
@ -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.
|
||||
225
tmk_core/protocol/chibios/chibios.mk
Normal file
225
tmk_core/protocol/chibios/chibios.mk
Normal file
|
|
@ -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
|
||||
91
tmk_core/protocol/chibios/main.c
Normal file
91
tmk_core/protocol/chibios/main.c
Normal file
|
|
@ -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);
|
||||
}
|
||||
}
|
||||
1251
tmk_core/protocol/chibios/usb_main.c
Normal file
1251
tmk_core/protocol/chibios/usb_main.c
Normal file
File diff suppressed because it is too large
Load diff
149
tmk_core/protocol/chibios/usb_main.h
Normal file
149
tmk_core/protocol/chibios/usb_main.h
Normal file
|
|
@ -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_ */
|
||||
Loading…
Add table
Add a link
Reference in a new issue