opensteno_qmk/keyboards/teensy_lc_onekey/instructions.md
fredizzimo 4d4f7684e6 Add ChibiOS support for QMK (#465)
* Modularity and gcc warnings fixes.

* Add ChibiOS support (USB stack + support files).

* Make usb_main more USB_DRIVER #define independent.

* Move chibios to tool.

* Implement jump-to-bootloader.

* Small updates.

* Fix bootloader-jump compiling.

* Move AVR specific sleep_led.c into avr.

* Add basic sleep_led for chibios.

* Update chibios README.

* NKRO fixes.

* Rename some Makefile defines.

* Move STM32 bootloader address config to separate .h file.

* Add ARM Teensies bootloader code.

* Fix chibios/usb_main GET_REPORT handing.

* Add missing #include to keymap.c.

* Make bootmagic.c code portable (_delay_ms -> wait_ms).

* Move declaration of keymap_config.

Should really not declare variables in .h files - since it's included
in different .c files, a proper linker then complains that the same
variable is declared more than once (once for each .c file that the
offending .h is included in).

* Add eeprom support for chibios/kinetis.

* Rename chibios example keyboard.

* Move chibios/cortex selection to local Makefiles.

* Chibios: use WFI in idle. WIP suspend stuff.

* ChibiOS/kinetis: sending remote wakeup.

* ChibiOS/STM32: send remote wakeup.

* Fix report size of boot protocol.

* Fix drop key stroke

Keyboard report should be checked if its transfer finishs successfully.
Otherwise key stroke can be missing when other key event occurs
before the last report transfer is done.

Boot protocol 10ms interval probably causes this problem in case
it receives key events in a row within the period. NKRO protocol
suffers less or nothing due to its interval 1ms.

* Chibios/usb_main: rename a variable for clarity.

* Add correct chibios/bootloader_jump for infinity KB.

* ChibiOS: make reset request more CMSISy.

* Chibios: Add breathing sleep LED on Kinetis MCUs.

* ChibiOS: Update infinity bootloader code to match updated ChibiOS.

* ChibiOS: prettify/document sleep_led code.

* Chibios: Remove the wait in the main loop.

* Add maple mini code.

* Do timeout when writing to CONSOLE EP queue.

Fixes TMK bug #266.

* Chibios: add 'core/protocol' to the makefiles' search path.

* Chibios: Update to new USB API.

* Chibios: add more guards for transmitting (fix a deadlock bug).

* Add update for chibios in README

* Chibios: Fix a HardFault bug (wait after start).

* Chibios: cleanup usb_main code.

* Chibios: Revert common.mk change (fix AVR linking problem).

* core: Fix chibios user compile options

Compile options can be defined in project Makefile such as UDEFS, UADEFS, UINCDIR, ULIBDIR and ULIBS.

* Sysv format for ChibiOS arm-none-eabi-size

Some new patches to ChibiOS puts heap as it's own section. So the
berkeley format is now useless, as the heap will be included in the
BSS report. The sysv format displays the bss size correctly.

* Fix hard-coded path of CHIBIOS

* Add support for new version of ChibiOS and Contrib

The Kinetis support has moved to a separate Contrib repository in
the newest version of Chibios. There has also been some structure
changes. So this adds support for those, while maintaining back-
wards compability.

* Update ChibiOS instructions

* Chibios: implement sleep LED for STM32.

* Chibios: Update the main chibios README.

* Chibios: fix STM32_BOOTLOADER_ADDRESS name.

* Chibios: make the default bootloader_jump redefinable (weak).

* Chibios: disable LTO (link-time optimisation).

With LTO enabled, sometimes things fail for mysterious reasons
(e.g. bootloader jump on WF with LEDs enabled), just because the
linker optimisation is too aggressive.

* Chibios: add default location for chibios-contrib.

* ChibiOS: update mk to match chibios/master.

* ChibiOS: update instructions.md.

* Add chibi_onekey example.

* Add comments to chibi_onekey Makefile.

* Rename some Makefile defines.

* Move STM32 bootloader address config to separate .h file.

* Rename chibios example keyboard.

* Move chibios/cortex selection to local Makefiles.

* Add Teensy LC onekey example.

* Chibios: use WFI in idle. WIP suspend stuff.

* Update chibi/teensy instructions.

* Update chibios/Teensy instructions.

* Add infinity_chibios

* Add keymap_hasu.c

* Infinity_chibios: select correct bootloader_jump.

* Infinity_chibios: improve comments.

* Add generic STM32F103C8T6 example.

* Add maple mini code.

* STM32F103x fixes.

* Add maple mini pinout pic.

* Chibios: updates for 3.0.4 git.

* Chibios: rename example stm32_onekey -> stm32_f072_onekey.

* Chibios: add makefiles for Teensy 3.x examples.

* Chibios: update Teensy 3.x instructions.

* Chibios: Tsy LC is cortex-m0plus.

* Chibios: add more guards for transmitting (fix a deadlock bug).

* Change README for chibios

* Chibios: update examples to current chibios git.

Match the changes in mainline chibios:
 - update chconf.h
 - update supplied ld scripts structure
 - update Teensy instructions (switch to official
    chibios and introduce contrib)

* Add ChibiOS and ChibiOS-Contrib submodules

Also fix the makefile path for them.

* Moves chibios keyboards to keyboards folder

* First version of ChibiOS compilation

Only the stm32_f072_onkey keyboard is ported at the moment. It
compiles, but still doesn't link.

* More chibios fixes

It now compiles without warnings and links

* Move the teensy_lc_onekey to the keyboards folder

* Clean up the make file rule structure

* Remove keymap_fn_to_action

* Update more ChibiOS keyboards to QMK

Most of them does not compile at the moment though.

* Use older version of Chibios libraries

The newest ones have problems with compilation

* Remove USB_UNCONFIGURED event

It isn't present in the older version of ChibiOS

* Fix the infinity_chibios compilation

* Fix potentially uninitialized variable

* Add missing include

* Fix the ChibiOS makefile

* Fix some Chibios keyboard compilation

* Revert the rules.mk file back to master version

* Combine the chibios and AVR makefiles

With just the required overrides in the respective platform
specific one.

* Slight makefile restrucuring

Platform specific compiler options

* Move avr specific targets out of the main rules

* Fix ChibiOS objcopy

The ChibiOS objcopy needs different parameters, so the parameters
are moved to the corresponding platform rule file

* Fix the objcopy for real this time

The comands were moved around, so chibios used avr and the ohter
way around.

Also change the objsize output format

* Fix the thumb flags

* Fix the infinity hasu keymap

* Per platform cpp flags

* Add gcc-arm-none-eabi package to travis

* Add arm-none-eabi-newlib to travis

* Fix the name of the libnewlib-arm-none-eabi lib

* Fix the ChibiOS paths

So that they are properly relative, and builds don't generate
extra folders

* Fix the board path of stm32_f103_onekey

* Only consider folders with Makefiles as subproject
2016-07-01 10:04:53 -04:00

4.8 KiB

Teensy LC, 3.0, 3.1, 3.2 support

These ARM Teensies are now supported through ChibiOS.

You'll need to install an ARM toolchain, for instance from 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. 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.

Next, you'll need ChibiOS. For Teensies, you'll need code from two repositories: chibios-main and chibios-contrib. 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 tmk_core/tool/chibios/chibios (so that the file tmk_core/tool/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 tmk_core/tool/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/README.md.

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.

Credits

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

Pins

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.

Mode

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

    palSetPadMode(TEENSY_PINn_IOPORT, TEENSY_PINn, PAL_MODE_INPUT_PULLUP);

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).

Setting

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

    palSetPad(TEENSY_PINn_IOPORT, TEENSY_PINn);

or set LOW by

    palClearPad(TEENSY_PINn_IOPORT, TEENSY_PINn);

Toggling can be done with

    palTogglePad(TEENSY_PINn_IOPORT, TEENSY_PINn);

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

Reading pin status is done with

    palReadPad(TEENSY_PINn_IOPORT, TEENSY_PINn);

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.