keyboards/chibios_test/teensy_lc_onekey/instructions.md

   1 # Teensy LC, 3.0, 3.1, 3.2 support
   2
   3 These ARM Teensies are now supported through [ChibiOS](http://chibios.org).
   4
   5 ## Installing the ARM toolchain
   6
   7 You'll need to install an ARM toolchain, there is now a nice documentation about the two AVR/ARM toolchain : https://docs.qmk.fm/getting_started_build_tools.html and you can just run `sudo util/install_dependencies.sh`.
   8 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.
   9
  10 You can find others way with the [gcc ARM embedded](https://launchpad.net/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.
  11
  12 ## Installing ChibiOS
  13
  14 Next, you'll need ChibiOS. For Teensies, you'll need code from two repositories: [chibios-main](https://github.com/ChibiOS/ChibiOS) and [chibios-contrib](https://github.com/ChibiOS/ChibiOS).
  15
  16 ### If you’re using git
  17
  18 Run `git submodule sync —recursive && git submodule update --init —recursive`. This will install ChibiOS and ChibiOS-Contrib in the `/lib/` directory.
  19
  20 ### If you’re not using Git
  21
  22 If you're not using git, you can just download a [zip of chibios from here](https://github.com/ChibiOS/ChibiOS/archive/a7df9a891067621e8e1a5c2a2c0ceada82403afe.zip), 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](https://github.com/ChibiOS/ChibiOS-Contrib/archive/e1311c4db6cd366cf760673f769e925741ac0ad3.zip): unpack and move `ChibiOS-Contrib-<long_hash_here>` to `lib/chibios/chibios-contrib`.
  23
  24 (If you're using git, you can just clone the two repos: [chibios](https://github.com/ChibiOS/ChibiOS) and [chibios-contrib](https://github.com/ChibiOS/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.)
  25
  26 (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.)
  27
  28 This should be it. Running `make` in `keyboard/teensy_lc_onekey` should create a working firmware in `build/`, called `ch.hex`.
  29
  30 For more notes about the ChibiOS backend in TMK, see `tmk_core/protocol/chibios/README.md`.
  31
  32 ## About this onekey example
  33
  34 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`.
  35
  36 ## Credits
  37
  38 TMK itself is written by hasu, original sources [here](https://github.com/tmk/tmk_keyboard).
  39
  40 The USB support for Kinetis MCUs is due to RedoX. His ChibiOS fork is also [on github](https://github.com/RedoXyde/ChibiOS); but it doesn't include Teensy LC definitions.
  41
  42 ## Features that are not implemented yet
  43
  44 Currently only the more fancy suspend features are not there (power saving during suspend). The rest should work fine (reports either way are welcome).
  45
  46 # Matrix programming notes
  47
  48 The notes below explain what commands can be used to examine and set the status of Teensy pins.
  49
  50 ## ChibiOS pin manipulation basics
  51
  52 ### Pins
  53
  54 Each pin sits on a "port", each of which comprises at most 32 individual pins.
  55 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.
  56
  57 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.
  58
  59 ### Mode
  60
  61 A MCU pin can be in several modes. The basic command to set a pin mode is
  62
  63         palSetPadMode(TEENSY_PINn_IOPORT, TEENSY_PINn, PAL_MODE_INPUT_PULLUP);
  64
  65 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).
  66
  67 ### Setting
  68
  69 Pins are set HIGH (after they've been put into `OUTPUT_PUSHPULL` mode) by
  70
  71         palSetPad(TEENSY_PINn_IOPORT, TEENSY_PINn);
  72
  73 or set LOW by
  74
  75         palClearPad(TEENSY_PINn_IOPORT, TEENSY_PINn);
  76
  77 Toggling can be done with
  78
  79         palTogglePad(TEENSY_PINn_IOPORT, TEENSY_PINn);
  80
  81 Alternatively, you can use
  82
  83         palWritePad(TEENSY_PINn_IOPORT, TEENSY_PINn, bit);
  84
  85 where `bit` is either `PAL_LOW` or `PAL_HIGH` (i.e. `0` or `1`).
  86
  87 ### Reading
  88
  89 Reading pin status is done with
  90
  91         palReadPad(TEENSY_PINn_IOPORT, TEENSY_PINn);
  92
  93 The function returns either `PAL_HIGH` (actually `1`) or `PAL_LOW` (actually `0`).
  94
  95 ### Further docs
  96
  97 All the commands that are available for pin manipulation through ChibiOS HAL are documented in [ChibiOS PAL driver docs](http://chibios.sourceforge.net/docs3/hal/group___p_a_l.html).