]> git.friedersdorff.com Git - max/tmk_keyboard.git/blobdiff - layer.c
added initial V-USB support for HHKB
[max/tmk_keyboard.git] / layer.c
diff --git a/layer.c b/layer.c
index 5b9b591fe0f94ffd449c1bf067b8247f34e98643..700752c98a0b023f2a5e3f10488b2f353dcddca4 100644 (file)
--- a/layer.c
+++ b/layer.c
-#include "keymap_skel.h"
-#include "usb_keyboard.h"
+#include "keymap.h"
+#include "host.h"
 #include "debug.h"
 #include "timer.h"
 #include "layer.h"
 
-/*
- * LAYER_ENTER_DELAY: prevent from moving new layer
- *                     press                release
- * Fn key sate     ____|~~~~~~~~~~~~~~~~~~~|_______________
- * 
- * enter_delay         |======|
- *                              new layer
- * Layer sw        ___________|~~~~~~~~~~~~|_______________
- */ 
-#define LAYER_ENTER_DELAY 10
 
 /*
- * LAYER_SEND_FN_TERM: send keycode if release key in this term
- *                     press          release(send)
- * Fn key state    ____|~~~~~~~~~~~~~|_______________
- *                     press         |       release(not send)
- * Fn key state    ____|~~~~~~~~~~~~~|~~~~~~|__________
- *                                   |      |
- * send_fn_term        |=============o==|   x
+ * Parameters:
+ *     ENTER_DELAY         |=======|
+ *     SEND_FN_TERM        |================|
+ *
+ * Fn key processing cases:
+ * 1. release Fn after SEND_FN_TERM.
+ *     Layer sw         ___________|~~~~~~~~~~~|___
+ *     Fn press         ___|~~~~~~~~~~~~~~~~~~~|___
+ *     Fn send          ___________________________
+ *
+ * 2. release Fn during SEND_FN_TERM.(not layer used)
+ *     Layer sw         ___________|~~~~~~|________
+ *     Fn press         ___|~~~~~~~~~~~~~~|________
+ *     Fn key send      __________________|~|______
+ *     other key press  ___________________________
+ *     other key send   ___________________________
+ *
+ * 3. release Fn during SEND_FN_TERM.(layer used)
+ *     Layer sw         ___________|~~~~~~|________
+ *     Fn press         ___|~~~~~~~~~~~~~~|________
+ *     Fn key send      ___________________________
+ *     Fn send          ___________________________
+ *     other key press  _____________|~~|__________
+ *     other key send   _____________|~~|__________
+ *
+ * 4. press other key during ENTER_DELAY.
+ *     Layer sw         ___________________________
+ *     Fn key press     ___|~~~~~~~~~|_____________
+ *     Fn key send      ______|~~~~~~|_____________
+ *     other key press  ______|~~~|________________
+ *     other key send   _______|~~|________________
+ *
+ * 5. press Fn while press other key.
+ *     Layer sw         ___________________________
+ *     Fn key press     ___|~~~~~~~~~|_____________
+ *     Fn key send      ___|~~~~~~~~~|_____________
+ *     other key press  ~~~~~~~|___________________
+ *     other key send   ~~~~~~~|___________________
+ *
+ * 6. press Fn twice quickly and keep holding down.(repeat)
+ *     Layer sw         ___________________________
+ *     Fn key press     ___|~|____|~~~~~~~~~~~~~~~~
+ *     Fn key send      _____|~|__|~~~~~~~~~~~~~~~~
  */
-#define LAYER_SEND_FN_TERM 30
+
+// LAYER_ENTER_DELAY: prevent from moving new layer
+#define LAYER_ENTER_DELAY 5
+
+// LAYER_SEND_FN_TERM: send keycode if release key in this term
+#define LAYER_SEND_FN_TERM 40
 
 
-static uint8_t current_layer = 0;
+uint8_t default_layer = 0;
+uint8_t current_layer = 0;
+
 static bool layer_used = false;
+static uint8_t new_layer(uint8_t fn_bits);
 
 
 uint8_t layer_get_keycode(uint8_t row, uint8_t col)
 {
     uint8_t code = keymap_get_keycode(current_layer, row, col);
     // normal key or mouse key
-    if ((IS_KEY(code) || IS_MOUSE(code)))
+    if ((IS_KEY(code) || IS_MOUSEKEY(code))) {
         layer_used = true;
+    }
     return code;
 }
 
+// bit substract b from a
+#define BIT_SUBST(a, b) (a&(a^b))
 void layer_switching(uint8_t fn_bits)
 {
     // layer switching
-    static uint8_t last_bits = 0;
-    static uint8_t last_mod = 0;
+    static uint8_t last_fn = 0;
+    static uint8_t last_mods = 0;
     static uint16_t last_timer = 0; 
+    static uint8_t sent_fn = 0;
 
-    //uint16_t now_timer;
-
-    if (fn_bits == last_bits) {
-        // switch layer when specific time elapsed
-        if (current_layer != keymap_fn_layer(fn_bits) &&
-                timer_elapsed(last_timer) > LAYER_ENTER_DELAY) {
-            current_layer = keymap_fn_layer(fn_bits);
-            debug("time_elapsed: "); debug_hex16(timer_elapsed(last_timer)); debug("\n"); 
-            debug("switch layer: "); debug_hex(current_layer); debug("\n");
+    if (fn_bits == last_fn) { // Fn state is not changed
+        if (fn_bits == 0) {
+            // do nothing
+        } else {
+            if (timer_elapsed(last_timer) > LAYER_ENTER_DELAY) {
+                uint8_t _layer_to_switch = new_layer(BIT_SUBST(fn_bits, sent_fn));
+                if (current_layer != _layer_to_switch) { // not switch layer yet
+                    debug("Fn case: 1,2,3(LAYER_ENTER_DELAY passed)\n");
+                    debug("Switch Layer: "); debug_hex(current_layer);
+                    current_layer = _layer_to_switch;
+                    layer_used = false;
+                    debug(" -> "); debug_hex(current_layer); debug("\n");
+                }
+            } else {
+                if (host_has_anykey()) { // other keys is pressed
+                    uint8_t _fn_to_send = BIT_SUBST(fn_bits, sent_fn);
+                    if (_fn_to_send) {
+                        debug("Fn case: 4(send Fn before other key pressed)\n");
+                        // send only Fn key first
+                        host_swap_keyboard_report();
+                        host_clear_keyboard_report();
+                        host_set_mods(last_mods);
+                        host_add_code(keymap_fn_keycode(_fn_to_send));   // TODO: do all Fn keys
+                        host_send_keyboard_report();
+                        host_swap_keyboard_report();
+                        sent_fn |= _fn_to_send;
+                    }
+                }
+            }
+            // add Fn keys to send
+            //host_add_code(keymap_fn_keycode(fn_bits&sent_fn));  // TODO: do all Fn keys
         }
-    } else if (fn_bits == 0) {
-        // send key when Fn key is released without using the layer and within specific time
-        if ((!layer_used || current_layer != keymap_fn_layer(last_bits)) &&
-                timer_elapsed(last_timer) < LAYER_SEND_FN_TERM) {
-            uint8_t code = keymap_fn_keycode(last_bits);
-            if (code != KB_NO) {
-                if (IS_MOD(code)) {
-                    keyboard_modifier_keys = last_mod | MOD_BIT(code);
+    } else { // Fn state is changed(edge)
+        uint8_t fn_changed = 0;
+
+        debug("fn_bits: "); debug_bin(fn_bits); debug("\n");
+        debug("sent_fn: "); debug_bin(sent_fn); debug("\n");
+        debug("last_fn: "); debug_bin(last_fn); debug("\n");
+        debug("last_mods: "); debug_hex(last_mods); debug("\n");
+        debug("last_timer: "); debug_hex16(last_timer); debug("\n");
+
+        // pressed Fn
+        if ((fn_changed = BIT_SUBST(fn_bits, last_fn))) {
+        debug("fn_changed: "); debug_bin(fn_changed); debug("\n");
+            if (host_has_anykey()) {
+                debug("Fn case: 5(pressed Fn with other key)\n");
+                sent_fn |= fn_changed;
+            } else if (fn_changed & sent_fn) { // pressed same Fn in a row
+                if (timer_elapsed(last_timer) > LAYER_ENTER_DELAY) {
+                    debug("Fn case: 6(not repeat)\n");
+                    // time passed: not repeate
+                    sent_fn &= ~fn_changed;
                 } else {
-                    keyboard_keys[0] = code;
-                    keyboard_modifier_keys = last_mod;
+                    debug("Fn case: 6(repeat)\n");
                 }
-                usb_keyboard_send();
-                usb_keyboard_print();
-                usb_keyboard_clear();
             }
         }
-        last_bits = 0;
-        last_mod = 0;
+        // released Fn
+        if ((fn_changed = BIT_SUBST(last_fn, fn_bits))) {
+        debug("fn_changed: "); debug_bin(fn_changed); debug("\n");
+            if (timer_elapsed(last_timer) < LAYER_SEND_FN_TERM) {
+                if (!layer_used && BIT_SUBST(fn_changed, sent_fn)) {
+                    debug("Fn case: 2(send Fn one shot: released Fn during LAYER_SEND_FN_TERM)\n");
+                    // send only Fn key first
+                    host_swap_keyboard_report();
+                    host_clear_keyboard_report();
+                    host_set_mods(last_mods);
+                    host_add_code(keymap_fn_keycode(fn_changed));   // TODO: do all Fn keys
+                    host_send_keyboard_report();
+                    host_swap_keyboard_report();
+                    sent_fn |= fn_changed;
+                }
+            }
+            debug("Switch Layer(released Fn): "); debug_hex(current_layer);
+            current_layer = new_layer(BIT_SUBST(fn_bits, sent_fn));
+            debug(" -> "); debug_hex(current_layer); debug("\n");
+        }
+
         layer_used = false;
-        current_layer = 0; // default layer
-    } else if ((fn_bits & (fn_bits - 1)) == 0) {
-        // switch layer when just one Fn Key is pressed
-        if (!usb_keyboard_has_key()) {
-            last_bits = fn_bits;
-            last_mod = keyboard_modifier_keys;
-            last_timer = timer_read();
-            debug("last_bits: "); debug_bin(last_bits); debug("\n");
-            debug("last_mod: "); debug_hex(last_mod); debug("\n");
-            debug("last_timer: "); debug_hex16(last_timer); debug("\n");
+        last_fn = fn_bits;
+        last_mods = keyboard_report->mods;
+        last_timer = timer_read();
+    }
+    // send Fn keys
+    for (uint8_t i = 0; i < 8; i++) {
+        if ((sent_fn & fn_bits) & (1<<i)) {
+            host_add_code(keymap_fn_keycode(1<<i));
         }
     }
 }
+
+inline
+static uint8_t new_layer(uint8_t fn_bits)
+{
+    return (fn_bits ? keymap_fn_layer(fn_bits) : default_layer);
+}