1
0
tmk_keyboard/protocol/chibios/README.md
tmk 28203e909e Squashed 'tmk_core/' changes from 57d27a8..08ce4c3
08ce4c3 Add update for chibios in README
30cac1d Merge remote-tracking branch 'flabbergast-tmk_keyboard/chibios'
f218a38 core: Remove unused warning. Fix tmk_keyboard/#293
3e68807 Chibios: add more guards for transmitting (fix a deadlock bug).
cecc807 core: Speed up compilation
d01d959 Merge remote-tracking branch 'upstream/master' into chibios
8ff12ae Merge pull request #230 from jerryen/master
3afb83d core: Add note about sudo and git
2525d5d Chibios: Update to new USB API.
2fc5cd6 Merge branch 'master' into chibios
6f5511a core: Fix variable initialize
02a15fa core: Fix variable init and header include
1833ca1 Merge pull request #292 from obones/command_warning
bc9dc6f Merge pull request #294 from shayneholmes/fix-debug-message
c1b891b Merge pull request #295 from doopai/master
1da837c core: Add macro commands SM(), RM() and CM()
d9d5a93 Add support for storing, restoring and clearing modifiers in macros
4f371c0 core: Add dfu-programmer example to doc/build.md
ba3792e core: Fix doc/build.md
4b99fed remove  SERIAL_SOFT_DEBUG macro
984accb Fix typo in bootmagic debug message
67a7ea1 usb_usb: Fix for keymap editor
2fc9ae4 host_driver is only used if KEYBOARD_LOCK_ENABLE is defined
a35cdea Chibios: add 'core/protocol' to the makefiles' search path.
5ed2fd6 Merge remote-tracking branch 'upstream/master' into chibios
bbc4851 Do timeout when writing to CONSOLE EP queue.
2450559 Remove an errant comma trailing the KC_ERAS macro alias
8465747 Merge pull request #270 from jeffgran/single-tap-toggle
a37339a Merge pull request #271 from jeffgran/default-layer-toggle
8e732f7 core: Update doc/build.md and remove other_projects.md
e47dc15 Workaround for compiler warnings when console disabled.
4184c52 Add maple mini code.
b555238 core: Fix rules.mk for dfu target
26dacf4 add ACTION_DEFAULT_LAYER_TOGGLE to toggle a default layer on/off
83607d9 enable TAPPING_TOGGLE=1 to work correctly
bef3089 Merge branch 'master' into chibios
f7a55fd core: Fix debug print of usb_hid
1402f7d core: Add keycode KC_JPY for JIS
8e3a460 Chibios: Remove the wait in the main loop.
7d41746 ChibiOS: prettify/document sleep_led code.
235cdee ChibiOS: Update infinity bootloader code to match updated ChibiOS.
807bf1e Chibios: Add breathing sleep LED on Kinetis MCUs.
ba3bf7c ChibiOS: make reset request more CMSISy.
bf2ffd4 Add correct chibios/bootloader_jump for infinity KB.
f5e03fd Chibios/usb_main: rename a variable for clarity.
63a330c Fix drop key stroke
d8f5b06 Fix report size of boot protocol.
38abb50 ChibiOS/STM32: send remote wakeup.
6725650 ChibiOS/kinetis: sending remote wakeup.
69f6e54 Chibios: use WFI in idle. WIP suspend stuff.
02f044b Move chibios/cortex selection to local Makefiles.
fa59dfa Rename chibios example keyboard.
5c060de Add eeprom support for chibios/kinetis.
efd0044 Move declaration of keymap_config.
7196b24 Make bootmagic.c code portable (_delay_ms -> wait_ms).
37b15b2 Add missing #include to keymap.c.
31316e3 Merge branch 'master' into chibios
166f312 Fix chibios/usb_main GET_REPORT handing.
57ac6c2 Add ARM Teensies bootloader code.
1758086 Move STM32 bootloader address config to separate .h file.
03bb026 Rename some Makefile defines.
76ba6ac NKRO fixes.
06498f8 Update chibios README.
db0a4f5 Add basic sleep_led for chibios.
c3f930e Move AVR specific sleep_led.c into avr.
4069494 Fix bootloader-jump compiling.
9117f7b Small updates.
269cb85 Implement jump-to-bootloader.
7e81b34 Move chibios to tool.
923a892 Make usb_main more USB_DRIVER #define independent.
aa054f0 Add ChibiOS support (USB stack + support files).
1e3e282 Modularity and gcc warnings fixes.
2f60ce0 Add KEYBOARD_LOCK_ENABLE to makefile

git-subtree-dir: tmk_core
git-subtree-split: 08ce4c3021d2ecd446c5b9a137aded65423d241e
2016-02-11 12:21:21 +09:00

51 lines
3.9 KiB
Markdown

## TMK running on top of ChibiOS
### Notes
- To use, unpack or symlink [ChibiOS] {currently 3.0.2} to `tmk_core/tool/chibios/chibios`. For Kinetis support, you'll need a fork which implements the USB driver, e.g. [this one](https://github.com/flabbergast/ChibiOS/tree/kinetis).
- For gcc options, inspect `tmk_core/tool/chibios/chibios.mk`. For instance, I enabled `-Wno-missing-field-initializers`, because TMK common bits generated a lot of warnings on that.
Also pay attention to `-O0` (enabled for debugging); for deployment use `-O2`.
- USB string descriptors are messy. 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`, or 1.5sec wait for USB init, in `main.c`. There should be no such in `usb_main.c` (the main USB stack). 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.
- Jumping to (the built-in) bootloaders on STM32 works, but it is not entirely pleasant, since it is very much MCU dependent. So, one needs to dig out the right address to jump to, and either pass it to the compiler in the `Makefile`, or better, define it in `<your_kb>/bootloader_defs.h`. Also, a patch to upstream ChibiOS is needed (supplied), because it `ResetHandler` needs adjusting.
- Sleep LED works, but at the moment only on/off, i.e. no breathing.
### Immediate todo
- host-wakeup packet sending during suspend
- power saving for suspend?
- PWM for sleep led
### Not tested, but possibly working
- backlight
### Missing / not working (TMK vs ChibiOS bits)
- eeprom / bootmagic for STM32 (will be chip dependent; eeprom needs to be emulated in flash, which means less writes; wear-levelling?) There is a semi-official ST "driver" for eeprom, with wear-levelling, but I think it consumes a lot of RAM (like 2 pages, i.e. 1kB or so).
### Tried with
- ChibiOS 3.0.1, 3.0.2 and ST F072RB DISCOVERY board.
- Need to test on other STM32 chips (F3, F4) to make it as much chip-independent as possible.
- ChibiOS with Kinetis patches and Teensy LC and 3.0.
## ChibiOS-supported MCUs (as of 3.0.2)
- Pretty much all STM32 chips.
- There is some support for K20x and KL2x Freescale chips (i.e. Teensy 3.x/LC, mchck, FRDM-KL2{5,6}Z, FRDM-K20D50M), but again, no official USB stack yet. However the `kinetis` branch of [my ChibiOS fork](https://github.com/flabbergast/ChibiOS). With this fork, TMK work normally on all the ARM Teensies.
- There is also support for AVR8, but the USB stack is not implemented for them yet, and also the kernel itself takes about 1k of RAM. I think people managed to get ChibiOS running on atmega32[8p/u4] though.
- I've seen community support for Nordic NRF51822 (the chip in Adafruit's Bluefruit bluetooth-low-energy boards), but not sure about the extent.
## STM32-based keyboard design considerations
- STM32F0x2 chips can do crystal-less USB, but they still need a 3.3V voltage regulator.
- The BOOT0 pin should be tied to GND.
- For a hardware way of accessing the in-built DFU bootloader, in addition to the reset button, put another button between the BOOT0 pin and 3V3.
- For breathing the caps lock LED during the suspended state ("sleep LED"), it is desirable to have that LED on a hardware PWM pin (there's usually plenty of those, look for TIMERs in the datasheet). However this is not strictly necessary, because instead of direct output of a timer to a pin (better of course), it is easy to define timer callbacks in ChibiOS that turn on/off an arbitrary pin.
[ChibiOS]: http://chibios.org