layer.c

   1 #include "keymap_skel.h"
   2 #include "usb_keyboard.h"
   3 #include "debug.h"
   4 #include "timer.h"
   5 #include "layer.h"
   6
   7 /*
   8  * Parameters:
   9  *     enter_delay         |=======|
  10  *     send_fn_term        |================|
  11  *
  12  * Fn key processing cases:
  13  * 1. release Fn after send_fn_term.
  14  *     Layer sw         ___________|~~~~~~~~~~~|___
  15  *     Fn press         ___|~~~~~~~~~~~~~~~~~~~|___
  16  *     Fn send          ___________________________
  17  *
  18  * 2. release Fn in send_fn_term.(not layer used)
  19  *     Layer sw         ___________|~~~~~~|________
  20  *     Fn press         ___|~~~~~~~~~~~~~~|________
  21  *     Fn key send      __________________|~|______
  22  *     other key press  ___________________________
  23  *     other key send   ___________________________
  24  *
  25  * 3. release Fn in send_fn_term.(layer used)
  26  *     Layer sw         ___________|~~~~~~|________
  27  *     Fn press         ___|~~~~~~~~~~~~~~|________
  28  *     Fn key send      ___________________________
  29  *     Fn send          ___________________________
  30  *     other key press  _____________|~~|__________
  31  *     other key send   _____________|~~|__________
  32  *
  33  * 4. press other key in ENTER_DELAY.
  34  *     Layer sw         ___________________________
  35  *     Fn key press     ___|~~~~~~~~~|_____________
  36  *     Fn key send      ______|~~~~~~|_____________
  37  *     other key press  ______|~~~|________________
  38  *     other key send   _______|~~|________________
  39  *
  40  * 5. press Fn while press other key.
  41  *     Layer sw         ___________________________
  42  *     Fn key press     ___|~~~~~~~~~|_____________
  43  *     Fn key send      ___|~~~~~~~~~|_____________
  44  *     other key press  ~~~~~~~|___________________
  45  *     other key send   ~~~~~~~|___________________
  46  *
  47  * 6. press Fn twice quickly and keep holding down.(repeat)
  48  *     Layer sw         ___________________________
  49  *     Fn key press     ___|~|____|~~~~~~~~~~~~~~~~
  50  *     Fn key send      _____|~|__|~~~~~~~~~~~~~~~~
  51  */
  52
  53 // LAYER_ENTER_DELAY: prevent from moving new layer
  54 #define LAYER_ENTER_DELAY 8
  55
  56 // LAYER_SEND_FN_TERM: send keycode if release key in this term
  57 #define LAYER_SEND_FN_TERM 40
  58
  59
  60 static uint8_t current_layer = 0;
  61 static bool layer_used = false;
  62
  63
  64 uint8_t layer_get_keycode(uint8_t row, uint8_t col)
  65 {
  66     uint8_t code = keymap_get_keycode(current_layer, row, col);
  67     // normal key or mouse key
  68     if ((IS_KEY(code) || IS_MOUSEKEY(code))) {
  69         layer_used = true;
  70     }
  71     return code;
  72 }
  73
  74 void layer_switching(uint8_t fn_bits)
  75 {
  76     // layer switching
  77     static uint8_t new_layer = 0;
  78     static uint8_t last_fn = 0;
  79     static uint8_t last_mods = 0;
  80     static uint16_t last_timer = 0;
  81     static uint8_t sent_fn = 0;
  82
  83     if (fn_bits == last_fn) { // Fn key is not changed
  84         if (current_layer != new_layer) {
  85             // not switch layer yet
  86             if (timer_elapsed(last_timer) > LAYER_ENTER_DELAY) {
  87                 debug("Fn case: 1,2,3(switch layer)\n");
  88                 // case: 1,2,3
  89                 current_layer = new_layer;
  90                 debug("timer_elapsed: "); debug_hex16(timer_elapsed(last_timer)); debug("\n");
  91                 debug("switch layer: "); debug_hex(current_layer); debug("\n");
  92             } else if (usb_keyboard_has_key()) {
  93                 debug("Fn case: 4(send Fn first, then add Fn to report)\n");
  94                 // case: 4
  95                 // send only Fn key first
  96                 usb_keyboard_swap_report();
  97                 usb_keyboard_clear_report();
  98                 usb_keyboard_add_code(keymap_fn_keycode(last_fn));
  99                 usb_keyboard_set_mods(last_mods);
 100                 usb_keyboard_send();
 101                 usb_keyboard_swap_report();
 102                 // add Fn key to send with other keys
 103                 usb_keyboard_add_code(keymap_fn_keycode(last_fn));
 104
 105                 new_layer = 0;
 106                 sent_fn = last_fn;
 107            }
 108         } else {
 109             if (fn_bits && new_layer == 0) {
 110                 // case: 4,5,6
 111                 usb_keyboard_add_code(keymap_fn_keycode(last_fn));
 112                 sent_fn = last_fn;
 113             }
 114         }
 115     } else { // Fn key is changed
 116         if (fn_bits == 0) { // Fn key is released(falling edge)
 117             if (!layer_used && timer_elapsed(last_timer) < LAYER_SEND_FN_TERM) {
 118                 debug("Fn case: 2(send Fn)\n");
 119                 // case: 2
 120                 usb_keyboard_swap_report();
 121                 usb_keyboard_clear_report();
 122                 usb_keyboard_add_code(keymap_fn_keycode(last_fn));
 123                 usb_keyboard_set_mods(last_mods);
 124                 usb_keyboard_send();
 125                 usb_keyboard_swap_report();
 126                 sent_fn = last_fn;
 127             }
 128             debug("Fn case: 1,2,3,4,5,6(return to default layer)\n");
 129             new_layer = 0;
 130             current_layer = 0;
 131         } else { // Fn Key is pressed(rising edge)
 132             if (usb_keyboard_has_key() ||
 133                     (fn_bits == sent_fn &&timer_elapsed(last_timer) < LAYER_ENTER_DELAY)) {
 134                 debug("Fn case: 5,6(add Fn to repeat)\n");
 135                 usb_keyboard_add_code(keymap_fn_keycode(fn_bits));
 136                 sent_fn = fn_bits;
 137             } else {
 138                 debug("Fn case: 1,2,3,4(ready for switching layer)\n");
 139                 // ready for switching layer(case: 1,2,3,4)
 140                 new_layer = keymap_fn_layer(fn_bits);
 141                 sent_fn = 0;
 142             }
 143         }
 144         layer_used = false;
 145         last_fn = fn_bits;
 146         last_mods = usb_keyboard_mods;
 147         last_timer = timer_read();
 148         debug("new_layer: "); debug_hex(new_layer); debug("\n");
 149         debug("last_fn: "); debug_bin(last_fn); debug("\n");
 150         debug("last_mods: "); debug_hex(last_mods); debug("\n");
 151         debug("last_timer: "); debug_hex16(last_timer); debug("\n");
 152     }
 153 }