Merge commit '20b787fc1284176834cbe7ca2134e4b36bec5828'

tmk · tmk · commit 3918ea2e161e · 2016-05-22T22:49:29.000+09:00
diff --git a/common/action_layer.c b/common/action_layer.c
@@ -22,6 +22,7 @@ static void default_layer_state_set(uint32_t state)
     debug("default_layer_state: ");
     default_layer_debug(); debug(" to ");
     default_layer_state = state;
+    hook_default_layer_change(default_layer_state);
     default_layer_debug(); debug("\n");
     clear_keyboard_but_mods(); // To avoid stuck keys
 }
diff --git a/common/hook.c b/common/hook.c
@@ -19,43 +19,31 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "hook.h"
 
 /* -------------------------------------------------
- * Definitions of hardware-independent default hooks
+ * Definitions of default hooks
  * ------------------------------------------------- */
 
-/* Called on layer state change event. */
-/* Default behaviour: do nothing. */
 __attribute__((weak))
-void hook_layer_change(uint8_t layer_state) {
-    (void)layer_state;
+void hook_keyboard_loop(void) {}
+
+__attribute__((weak))
+void hook_matrix_change(keyevent_t event) {
+    (void)event;
 }
 
-/* Called periodically from the matrix scan loop (very often!) */
-/* Default behaviour: do nothing. */
 __attribute__((weak))
-void hook_keyboard_loop(void) {}
+void hook_default_layer_change(uint32_t default_layer_state) {
+    (void)default_layer_state;
+}
 
-/* Called on matrix state change event (every keypress => often!) */
-/* Default behaviour: do nothing. */
 __attribute__((weak))
-void hook_matrix_change(keyevent_t event) {
-	(void)event;
+void hook_layer_change(uint32_t layer_state) {
+    (void)layer_state;
 }
 
-/* Called on indicator LED update event (when reported from host). */
-/* Default behaviour: calls led_set (for compatibility). */
 __attribute__((weak))
 void hook_keyboard_leds_change(uint8_t led_status) {
     keyboard_set_leds(led_status);
 }
 
-/* Called once, on checking the bootmagic combos. */
-/* Default behaviour: do nothing. */
 __attribute__((weak))
-void hook_bootmagic(void) {
-	/* An example: */
-	// #include "bootmagic.h"
-	// #include "keymap.h"
-	// if(bootmagic_scan_keycode(KC_W)) {
-	// 	// do something
-	// }
-}
+void hook_bootmagic(void) {}
diff --git a/common/hook.h b/common/hook.h
@@ -22,14 +22,14 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "led.h"
 
 /* -------------------------------------
- *       Hardware / one-off hooks
+ * Protocol hooks
  * ------------------------------------- */
 
-/* Called once, before initialising USB. */
+/* Called once, very early stage of initialization, just after processor startup. */
 /* Default behaviour: do nothing. */
 void hook_early_init(void);
 
-/* Called once, after USB is connected and keyboard initialised. */
+/* Called once, very last stage of initialization, just before keyboard loop. */
 /* Default behaviour: do nothing. */
 void hook_late_init(void);
 
@@ -47,12 +47,9 @@ void hook_usb_suspend_loop(void);
  * the "normal" indicator LED status by default. */
 void hook_usb_wakeup(void);
 
-/* Called once, on checking the bootmagic combos. */
-/* Default behaviour: do nothing. */
-void hook_bootmagic(void);
 
 /* -------------------------------------
- *       Keyboard / periodic hooks
+ * Keyboard hooks
  * ------------------------------------- */
 
 /* Called periodically from the keyboard loop (very often!) */
@@ -63,12 +60,21 @@ void hook_keyboard_loop(void);
 /* Default behaviour: do nothing. */
 void hook_matrix_change(keyevent_t event);
 
+/* Called on default layer state change event. */
+/* Default behaviour: do nothing. */
+void hook_default_layer_change(uint32_t default_layer_state);
+
 /* Called on layer state change event. */
 /* Default behaviour: do nothing. */
-void hook_layer_change(uint8_t layer_state);
+void hook_layer_change(uint32_t layer_state);
 
 /* Called on indicator LED update event (when reported from host). */
-/* Default behaviour: calls keyboard_set_leds (for compatibility). */
+/* Default behaviour: calls keyboard_set_leds. */
 void hook_keyboard_leds_change(uint8_t led_status);
 
+/* Called once, on checking the bootmagic combos. */
+/* Default behaviour: do nothing. */
+void hook_bootmagic(void);
+
+
 #endif /* _HOOKS_H_ */
diff --git a/doc/hook.txt b/doc/hook.txt
@@ -0,0 +1,111 @@
+Hooks
+-----
+Hooks allow you to execute custom code at certain predefined points in the firmware execution. To use them, just define the hook function in your keymap file.
+
+The following hooks are available available:
+
+Hook function                   | Timing
+--------------------------------|-----------------------------------------------
+`hook_early_init(void)`         | Early in the boot process, before the matrix is initialized and before a connection is made with the host. Thus, this hook has access to very few parameters, but it is a good place to define any custom parameters needed by other early processes.
+`hook_late_init(void)`          | Near the end of the boot process, after Boot Magic has run and LEDs have been initialized.
+`hook_bootmagic(void)`          | During the Boot Magic window, after EEPROM and Bootloader checks are made, but before any other built-in Boot Magic checks are made.
+`hook_usb_wakeup(void)`         | When the device wakes up from USB suspend state.
+`hook_usb_suspend_entry(void)`  | When the device enters USB suspend state.
+`hook_usb_suspend_loop(void)`   | Continuously, while the device is in USB suspend state. *Default action:* power down and periodically check the matrix, causing wakeup if needed.
+`hook_keyboard_loop(void)`      | Continuously, during the main loop, after the matrix is checked.
+`hook_matrix_change(keyevent_t event)`      | When a matrix state change is detected, before any other actions are processed.
+`hook_layer_change(uint32_t layer_state)`   | When any layer is changed.
+`hook_default_layer_change(uint32_t default_layer_state)`   | When any default layer is changed.
+`hook_keyboard_leds_change(uint8_t led_status)`             | Whenever a change in the LED status is performed. *Default action:* call `keyboard_set_leds(led_status)`
+
+
+
+
+
+### Hooks Examples
+
+You can try these out by copying the code to your keymap file, or any .c file in the Makefile `SRC`.
+
+#### Activate keymap layer 5 on startup
+
+```C
+#include "action_layer.h"
+
+void hook_late_init(void)
+{
+    layer_on(5);
+    print("Layer 5 enabled!");
+}
+```
+
+#### Blink the Caps Lock LED every .5 seconds
+
+```C
+#include "timer.h"
+#include "led.h"
+
+bool my_led_status = 0;
+uint16_t my_led_timer;
+
+void hook_keyboard_loop(void)
+{
+    // check if we've reached 500 milliseconds yet...
+    if (timer_elapsed(my_led_timer) > 500)
+    {
+        // we've reached 500 milliseconds!
+        // reset the timer
+        my_led_timer = timer_read();
+
+        // check the current LED state
+        if (my_led_status)
+        {
+            // LED is on, so let's turn it off
+            led_set(host_keyboard_leds() & ~(1<<USB_LED_CAPS_LOCK));
+            my_led_status = 0;
+        }
+        else
+        {
+            // LED is off, so let's turn it on
+            led_set(host_keyboard_leds() | (1<<USB_LED_CAPS_LOCK));
+            my_led_status = 1;
+        }
+    }
+}
+```
+
+#### Flash the Caps Lock LED for 20ms on every keypress
+```C
+include "timer.h"
+#include "led.h"
+
+bool my_led_status = 0;
+uint16_t my_led_timer;
+
+void hook_matrix_change(keyevent_t event)
+{
+    // only flash LED for key press events, not key release events.
+    if (event.pressed)
+    {
+        // check the current LED status and reverse it
+        led_set(host_keyboard_leds() ^ (1<<USB_LED_CAPS_LOCK));
+
+        my_led_status = 1;
+        my_led_timer = timer_read();
+    }
+}
+
+void hook_keyboard_loop(void)
+{
+    if (my_led_status)
+    {
+        // check if we've reached 20 milliseconds yet...
+        if (timer_elapsed(my_led_timer) > 50)
+        {
+            led_set(host_keyboard_leds());
+
+            my_led_status = 0;
+        }
+    }
+}
+
+```
diff --git a/protocol/chibios/README.md b/protocol/chibios/README.md
@@ -4,23 +4,19 @@ This code can be used to run TMK keyboard logic on top of [ChibiOS], meaning tha
 
 ### Usage
 
-- To use, unpack or symlink [ChibiOS] to `tmk_core/tool/chibios/chibios`. For Kinetis support (this means Teensies, Infinity keyboard, WhiteFox keyboard), you'll need a fork which implements the USB driver, e.g. [this one](https://github.com/flabbergast/ChibiOS/tree/kinetis).
+- To use, [get a zip of chibios](https://github.com/ChibiOS/ChibiOS/archive/a7df9a891067621e8e1a5c2a2c0ceada82403afe.zip) and unpack/rename it to `tmk_core/tool/chibios/chibios`; or you can just clone [the repo](https://github.com/ChibiOS/ChibiOS) there. For Freescale/NXP Kinetis support (meaning ARM Teensies and the Infinity keyboard), you'll also need [a zip of chibios-contrib](https://github.com/ChibiOS/ChibiOS-Contrib/archive/e1311c4db6cd366cf760673f769e925741ac0ad3.zip), unpacked/renamed to `tmk_core/tool/chibios/chibios-contrib`. Likewise, for git-savvy people, just clone [the repo](https://github.com/ChibiOS/ChibiOS-Contrib) there.
+- Note: the abovementioned directories are the defaults. You can have the two chibios repositories wherever you want, just define their location in `CHIBIOS` and `CHIBIOS_CONTRIB` variables in your `Makefile`.
 - You will also need to install an ARM toolchain, for instance from [here](https://launchpad.net/gcc-arm-embedded). On linux, this is usually also present as a package for your distribution (as `gcc-arm` or something similar). On OS X, you can use [homebrew](http://brew.sh/) with an appropriate tap.
 
 ### Notes
 
 - Some comments about ChibiOS syntax and the most commonly used GPIO functions are, as well as an example for ARM Teensies, is [here](https://github.com/tmk/tmk_keyboard/blob/master/keyboard/teensy_lc_onekey/instructions.md).
 - 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`.
+- For debugging, it is sometimes useful disable gcc optimisations, you can do that by adding `-O0` to `OPT_DEFS` in your `Makefile`.
 - 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.
 - 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`. An additional startup code is also needed; the best way to deal with this is to define custom board files. (Example forthcoming.)
+- 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`. An additional startup code is also needed; the best way to deal with this is to define custom board files. (Example forthcoming.) In any case, there are no problems for Teensies.
 
-### Experimental pre-ChibiOS 4 support
-- As an alternative to the mentioned flabbergast branch above, you can use the [master branch of ChibiOS](https://github.com/ChibiOS/ChibiOS). 
-- Note that the Kinetis support has moved to the [ChibiOS-Contrib repository](https://github.com/ChibiOS/ChibiOS-Contrib), so you need to put that into your repository in the same way as you did for the main ChibiOS repository. 
-- You also need to define CHIBIOS_CONTRIB in your makefile and point it to the right directory.
-- You need to add some new options to chconf.h, or you will get compiler errors. Just copy the new options from samples provided by the ChibiOS-Contrib repository.
 
 ### Immediate todo
 
@@ -43,15 +39,16 @@ Also pay attention to `-O0` (enabled for debugging); for deployment use `-O2`.
 ## ChibiOS-supported MCUs
 
 - 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 [flabbergast's 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.
+- K20x and KL2x Freescale/NXP chips (i.e. Teensy 3.x/LC, mchck, FRDM-KL2{5,6}Z, FRDM-K20D50M), via the [ChibiOS-Contrib](https://github.com/ChibiOS/ChibiOS-Contrib) repository.
+- There is also support for AVR8, but the USB stack is not implemented for them yet (some news on that front recently though), and also the kernel itself takes about 1k of RAM. I think people managed to get ChibiOS running on atmega32[8p/u4] though.
+- There is also support for Nordic NRF51822 (the chip in Adafruit's Bluefruit bluetooth-low-energy boards), but be aware that that chip does *not* have USB, and the BLE softdevice (i.e. Bluetooth) is not supported directly at the moment.
 
 ## 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.
+- There is a working example of a STM32F042-based keyboard: [firmware here](https://github.com/flabbergast/flabber_kbs/tree/master/kb45p) and [hardware (kicad) here](https://github.com/flabbergast/kicad/tree/master/kb45p). You can check this example firmware for custom board files, and a more complicated matrix than just one key.
 
 
 
diff --git a/tool/chibios/.gitignore b/tool/chibios/.gitignore
@@ -1 +1,2 @@
 chibios
+chibios-contrib
diff --git a/tool/chibios/chibios.mk b/tool/chibios/chibios.mk
@@ -84,6 +84,7 @@ endif
 
 # Imported source files and paths
 CHIBIOS ?= $(TMK_DIR)/tool/chibios/chibios
+CHIBIOS_CONTRIB ?= $(TMK_DIR)/tool/chibios/chibios-contrib
 # Startup files. Try a few different locations, for compability with old versions and 
 # for things hardware in the contrib repository
 STARTUP_MK = $(CHIBIOS)/os/common/ports/ARMCMx/compilers/GCC/mk/startup_$(MCU_STARTUP).mk
@@ -122,6 +123,7 @@ PORT_V = $(CHIBIOS)/os/common/ports/ARMCMx/compilers/GCC/mk/port_v$(ARMV)m.mk
 endif
 include $(PORT_V)
 # Other files (optional).
+include $(CHIBIOS)/os/hal/lib/streams/streams.mk
 
 # Define linker script file here
 ifneq ("$(wildcard $(TARGET_DIR)/ld/$(MCU_LDSCRIPT).ld)","")
@@ -139,7 +141,7 @@ CSRC = $(STARTUPSRC) \
        $(HALSRC) \
        $(PLATFORMSRC) \
        $(BOARDSRC) \
-       $(CHIBIOS)/os/hal/lib/streams/chprintf.c \
+       $(STREAMSSRC) \
        $(TMK_DIR)/protocol/chibios/usb_main.c \
        $(TMK_DIR)/protocol/chibios/main.c \
        $(SRC)
@@ -169,11 +171,13 @@ TCSRC =
 TCPPSRC =
 
 # List ASM source files here
-ASMSRC = $(STARTUPASM) $(PORTASM) $(OSALASM)
+ASMSRC =
+ASMXSRC = $(STARTUPASM) $(PORTASM) $(OSALASM)
 
-INCDIR = $(STARTUPINC) $(KERNINC) $(PORTINC) $(OSALINC) \
+INCDIR = $(CHIBIOS)/os/license \
+         $(STARTUPINC) $(KERNINC) $(PORTINC) $(OSALINC) \
          $(HALINC) $(PLATFORMINC) $(BOARDINC) $(TESTINC) \
-         $(CHIBIOS)/os/hal/lib/streams $(CHIBIOS)/os/various \
+         $(STREAMSINC) $(CHIBIOS)/os/various \
          $(TMK_DIR) $(COMMON_DIR) $(TMK_DIR)/protocol/chibios \
          $(TMK_DIR)/protocol $(TARGET_DIR)
 

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ static void default_layer_state_set(uint32_t state)`
`22`	`22`	`debug("default_layer_state: ");`
`23`	`23`	`default_layer_debug(); debug(" to ");`
`24`	`24`	`default_layer_state = state;`
	`25`	`+ hook_default_layer_change(default_layer_state);`
`25`	`26`	`default_layer_debug(); debug("\n");`
`26`	`27`	`clear_keyboard_but_mods(); // To avoid stuck keys`
`27`	`28`	`}`