Skip to content
Branch: master
Find file Copy path
Find file Copy path
2 contributors

Users who have contributed to this file

@Shinichi-Ohki @fredizzimo
98 lines (50 sloc) 5.18 KB

Teensy LC, 3.0, 3.1, 3.2 support

These ARM Teensies are now supported through ChibiOS.

Installing the ARM toolchain

You'll need to install an ARM toolchain, there is now a nice documentation about the two AVR/ARM toolchain : and you can just run sudo util/ This toolchain is used instead of avr-gcc, which is only for AVR chips. Naturally you'll also need the usual development tools (e.g. make), just as in the AVR setting.

You can find others way with the gcc ARM embedded website, or using your favourite package manager. After installing, you should be able to run arm-none-eabi-gcc -v in the command prompt and get sensible output.

Installing ChibiOS

Next, you'll need ChibiOS. For Teensies, you'll need code from two repositories: chibios-main and chibios-contrib.

If you’re using git

Run git submodule sync --recursive && git submodule update --init --recursive. This will install ChibiOS and ChibiOS-Contrib in the /lib/ directory.

If you’re not using Git

If you're not using git, you can just download a zip of chibios from here, unpack the zip, and rename/move the unpacked directory (named ChibiOS-<long_hash_here>) to lib/chibios/chibios (so that the file lib/chibios/chibios/license.txt exists). Now the same procedure with a zip of chibios-contrib from here: unpack and move ChibiOS-Contrib-<long_hash_here> to lib/chibios/chibios-contrib.

(If you're using git, you can just clone the two repos: chibios and chibios-contrib. However - be warned that things may be somewhat out-of-sync (updates at different rates), so you may need to hunt a bit for the right commits.)

(Why do we need chibios-contrib? Well, the main repo focuses on STM32 chips, and Freescale/NXP Kinetis chips are supported via the Contrib repository.)

This should be it. Running make in keyboard/teensy_lc_onekey should create a working firmware in build/, called ch.hex.

For more notes about the ChibiOS backend in TMK, see tmk_core/protocol/chibios/

About this onekey example

It's set up for Teensy LC. To use 3.x, you'll need to edit the Makefile (and comment out one line in mcuconf.h). A sample makefile for Teensy 3.0 is provided as Makefile.3.0, can be used without renaming with make -f Makefile.3.0. Similarly for Teensy 3.2, there's Makefile.3.2.


TMK itself is written by hasu, original sources here.

The USB support for Kinetis MCUs is due to RedoX. His ChibiOS fork is also on github; but it doesn't include Teensy LC definitions.

Features that are not implemented yet

Currently only the more fancy suspend features are not there (power saving during suspend). The rest should work fine (reports either way are welcome).

Matrix programming notes

The notes below explain what commands can be used to examine and set the status of Teensy pins.

ChibiOS pin manipulation basics


Each pin sits on a "port", each of which comprises at most 32 individual pins. So for instance "PTC5" from Kinetis manual/datasheet refers to port C (or GPIOA), pin 5. Most functions dealing with pins take 2 parameters which specify the pin -- the first being the port, the second being the pin number.

Within ChibiOS, there are definitions which simplify this a bit for the Teensies. TEENSY_PINn_IOPORT represents the port of the MCU's pin connected Teensy's PIN n, and TEENSY_PINn represents its MCU's pin number.


A MCU pin can be in several modes. The basic command to set a pin mode is


The last parameter is the mode. For keyboards, the usual ones that are used are PAL_MODE_INPUT_PULLUP (input with a pullup), PAL_MODE_INPUT_PULLDOWN (input with a pulldown), PAL_MODE_INPUT (input floating, a.k.a. Hi-Z), PAL_MODE_OUTPUT_PUSHPULL (output in the Arduino sense -- can be then set HIGH or LOW).


Pins are set HIGH (after they've been put into OUTPUT_PUSHPULL mode) by


or set LOW by


Toggling can be done with


Alternatively, you can use

    palWritePad(TEENSY_PINn_IOPORT, TEENSY_PINn, bit);

where bit is either PAL_LOW or PAL_HIGH (i.e. 0 or 1).


Reading pin status is done with


The function returns either PAL_HIGH (actually 1) or PAL_LOW (actually 0).

Further docs

All the commands that are available for pin manipulation through ChibiOS HAL are documented in ChibiOS PAL driver docs.

You can’t perform that action at this time.