quantum/quantum.c

   1 /* Copyright 2016-2017 Jack Humbert
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16
  17 #include "quantum.h"
  18
  19 #if !defined(RGBLIGHT_ENABLE) && !defined(RGB_MATRIX_ENABLE)
  20         #include "rgb.h"
  21 #endif
  22
  23 #ifdef PROTOCOL_LUFA
  24 #include "outputselect.h"
  25 #endif
  26
  27 #ifndef TAPPING_TERM
  28 #define TAPPING_TERM 200
  29 #endif
  30
  31 #ifndef BREATHING_PERIOD
  32 #define BREATHING_PERIOD 6
  33 #endif
  34
  35 #include "backlight.h"
  36 extern backlight_config_t backlight_config;
  37
  38 #ifdef FAUXCLICKY_ENABLE
  39 #include "fauxclicky.h"
  40 #endif
  41
  42 #ifdef API_ENABLE
  43 #include "api.h"
  44 #endif
  45
  46 #ifdef MIDI_ENABLE
  47 #include "process_midi.h"
  48 #endif
  49
  50 #ifdef VELOCIKEY_ENABLE
  51 #include "velocikey.h"
  52 #endif
  53
  54 #ifdef HAPTIC_ENABLE
  55     #include "haptic.h"
  56 #endif
  57
  58 #ifdef ENCODER_ENABLE
  59 #include "encoder.h"
  60 #endif
  61
  62 #ifdef AUDIO_ENABLE
  63   #ifndef GOODBYE_SONG
  64     #define GOODBYE_SONG SONG(GOODBYE_SOUND)
  65   #endif
  66   #ifndef AG_NORM_SONG
  67     #define AG_NORM_SONG SONG(AG_NORM_SOUND)
  68   #endif
  69   #ifndef AG_SWAP_SONG
  70     #define AG_SWAP_SONG SONG(AG_SWAP_SOUND)
  71   #endif
  72   float goodbye_song[][2] = GOODBYE_SONG;
  73   float ag_norm_song[][2] = AG_NORM_SONG;
  74   float ag_swap_song[][2] = AG_SWAP_SONG;
  75   #ifdef DEFAULT_LAYER_SONGS
  76     float default_layer_songs[][16][2] = DEFAULT_LAYER_SONGS;
  77   #endif
  78 #endif
  79
  80 static void do_code16 (uint16_t code, void (*f) (uint8_t)) {
  81   switch (code) {
  82   case QK_MODS ... QK_MODS_MAX:
  83     break;
  84   default:
  85     return;
  86   }
  87
  88   if (code & QK_LCTL)
  89     f(KC_LCTL);
  90   if (code & QK_LSFT)
  91     f(KC_LSFT);
  92   if (code & QK_LALT)
  93     f(KC_LALT);
  94   if (code & QK_LGUI)
  95     f(KC_LGUI);
  96
  97   if (code < QK_RMODS_MIN) return;
  98
  99   if (code & QK_RCTL)
 100     f(KC_RCTL);
 101   if (code & QK_RSFT)
 102     f(KC_RSFT);
 103   if (code & QK_RALT)
 104     f(KC_RALT);
 105   if (code & QK_RGUI)
 106     f(KC_RGUI);
 107 }
 108
 109 static inline void qk_register_weak_mods(uint8_t kc) {
 110     add_weak_mods(MOD_BIT(kc));
 111     send_keyboard_report();
 112 }
 113
 114 static inline void qk_unregister_weak_mods(uint8_t kc) {
 115     del_weak_mods(MOD_BIT(kc));
 116     send_keyboard_report();
 117 }
 118
 119 static inline void qk_register_mods(uint8_t kc) {
 120     add_weak_mods(MOD_BIT(kc));
 121     send_keyboard_report();
 122 }
 123
 124 static inline void qk_unregister_mods(uint8_t kc) {
 125     del_weak_mods(MOD_BIT(kc));
 126     send_keyboard_report();
 127 }
 128
 129 void register_code16 (uint16_t code) {
 130   if (IS_MOD(code) || code == KC_NO) {
 131       do_code16 (code, qk_register_mods);
 132   } else {
 133       do_code16 (code, qk_register_weak_mods);
 134   }
 135   register_code (code);
 136 }
 137
 138 void unregister_code16 (uint16_t code) {
 139   unregister_code (code);
 140   if (IS_MOD(code) || code == KC_NO) {
 141       do_code16 (code, qk_unregister_mods);
 142   } else {
 143       do_code16 (code, qk_unregister_weak_mods);
 144   }
 145 }
 146
 147 void tap_code16(uint16_t code) {
 148   register_code16(code);
 149   #if TAP_CODE_DELAY > 0
 150     wait_ms(TAP_CODE_DELAY);
 151   #endif
 152   unregister_code16(code);
 153 }
 154
 155 __attribute__ ((weak))
 156 bool process_action_kb(keyrecord_t *record) {
 157   return true;
 158 }
 159
 160 __attribute__ ((weak))
 161 bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
 162   return process_record_user(keycode, record);
 163 }
 164
 165 __attribute__ ((weak))
 166 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 167   return true;
 168 }
 169
 170 void reset_keyboard(void) {
 171   clear_keyboard();
 172 #if defined(MIDI_ENABLE) && defined(MIDI_BASIC)
 173   process_midi_all_notes_off();
 174 #endif
 175 #ifdef AUDIO_ENABLE
 176   #ifndef NO_MUSIC_MODE
 177     music_all_notes_off();
 178   #endif
 179   uint16_t timer_start = timer_read();
 180   PLAY_SONG(goodbye_song);
 181   shutdown_user();
 182   while(timer_elapsed(timer_start) < 250)
 183     wait_ms(1);
 184   stop_all_notes();
 185 #else
 186   shutdown_user();
 187   wait_ms(250);
 188 #endif
 189 #ifdef HAPTIC_ENABLE
 190   haptic_shutdown();
 191 #endif
 192 // this is also done later in bootloader.c - not sure if it's neccesary here
 193 #ifdef BOOTLOADER_CATERINA
 194   *(uint16_t *)0x0800 = 0x7777; // these two are a-star-specific
 195 #endif
 196   bootloader_jump();
 197 }
 198
 199 // Shift / paren setup
 200
 201 #ifndef LSPO_KEY
 202   #define LSPO_KEY KC_9
 203 #endif
 204 #ifndef RSPC_KEY
 205   #define RSPC_KEY KC_0
 206 #endif
 207
 208 #ifndef LSPO_MOD
 209   #define LSPO_MOD KC_LSFT
 210 #endif
 211 #ifndef RSPC_MOD
 212   #define RSPC_MOD KC_RSFT
 213 #endif
 214
 215 // Shift / Enter setup
 216 #ifndef SFTENT_KEY
 217   #define SFTENT_KEY KC_ENT
 218 #endif
 219
 220 static bool shift_interrupted[2] = {0, 0};
 221 static uint16_t scs_timer[2] = {0, 0};
 222
 223 /* true if the last press of GRAVE_ESC was shifted (i.e. GUI or SHIFT were pressed), false otherwise.
 224  * Used to ensure that the correct keycode is released if the key is released.
 225  */
 226 static bool grave_esc_was_shifted = false;
 227
 228 /* Convert record into usable keycode via the contained event. */
 229 uint16_t get_record_keycode(keyrecord_t *record) {
 230   return get_event_keycode(record->event);
 231 }
 232
 233
 234 /* Convert event into usable keycode. Checks the layer cache to ensure that it
 235  * retains the correct keycode after a layer change, if the key is still pressed.
 236  */
 237 uint16_t get_event_keycode(keyevent_t event) {
 238
 239   #if !defined(NO_ACTION_LAYER) && !defined(STRICT_LAYER_RELEASE)
 240     /* TODO: Use store_or_get_action() or a similar function. */
 241     if (!disable_action_cache) {
 242       uint8_t layer;
 243
 244       if (event.pressed) {
 245         layer = layer_switch_get_layer(event.key);
 246         update_source_layers_cache(event.key, layer);
 247       } else {
 248         layer = read_source_layers_cache(event.key);
 249       }
 250       return keymap_key_to_keycode(layer, event.key);
 251     } else
 252   #endif
 253     return keymap_key_to_keycode(layer_switch_get_layer(event.key), event.key);
 254 }
 255
 256 /* Main keycode processing function. Hands off handling to other functions,
 257  * then processes internal Quantum keycodes, then processes ACTIONs.
 258  */
 259 bool process_record_quantum(keyrecord_t *record) {
 260     uint16_t keycode = get_record_keycode(record);
 261
 262     // This is how you use actions here
 263     // if (keycode == KC_LEAD) {
 264     //   action_t action;
 265     //   action.code = ACTION_DEFAULT_LAYER_SET(0);
 266     //   process_action(record, action);
 267     //   return false;
 268     // }
 269
 270   #ifdef VELOCIKEY_ENABLE
 271     if (velocikey_enabled() && record->event.pressed) { velocikey_accelerate(); }
 272   #endif
 273
 274   #ifdef TAP_DANCE_ENABLE
 275     preprocess_tap_dance(keycode, record);
 276   #endif
 277
 278   if (!(
 279   #if defined(KEY_LOCK_ENABLE)
 280     // Must run first to be able to mask key_up events.
 281     process_key_lock(&keycode, record) &&
 282   #endif
 283   #if defined(AUDIO_ENABLE) && defined(AUDIO_CLICKY)
 284     process_clicky(keycode, record) &&
 285   #endif //AUDIO_CLICKY
 286   #ifdef HAPTIC_ENABLE
 287     process_haptic(keycode, record) &&
 288   #endif //HAPTIC_ENABLE
 289   #if defined(RGB_MATRIX_ENABLE) && defined(RGB_MATRIX_KEYREACTIVE_ENABLED)
 290     process_rgb_matrix(keycode, record) &&
 291   #endif
 292     process_record_kb(keycode, record) &&
 293   #if defined(MIDI_ENABLE) && defined(MIDI_ADVANCED)
 294     process_midi(keycode, record) &&
 295   #endif
 296   #ifdef AUDIO_ENABLE
 297     process_audio(keycode, record) &&
 298   #endif
 299   #ifdef STENO_ENABLE
 300     process_steno(keycode, record) &&
 301   #endif
 302   #if (defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))) && !defined(NO_MUSIC_MODE)
 303     process_music(keycode, record) &&
 304   #endif
 305   #ifdef TAP_DANCE_ENABLE
 306     process_tap_dance(keycode, record) &&
 307   #endif
 308   #if defined(UNICODE_ENABLE) || defined(UNICODEMAP_ENABLE) || defined(UCIS_ENABLE)
 309     process_unicode_common(keycode, record) &&
 310   #endif
 311   #ifdef LEADER_ENABLE
 312     process_leader(keycode, record) &&
 313   #endif
 314   #ifdef COMBO_ENABLE
 315     process_combo(keycode, record) &&
 316   #endif
 317   #ifdef PRINTING_ENABLE
 318     process_printer(keycode, record) &&
 319   #endif
 320   #ifdef AUTO_SHIFT_ENABLE
 321     process_auto_shift(keycode, record) &&
 322   #endif
 323   #ifdef TERMINAL_ENABLE
 324     process_terminal(keycode, record) &&
 325   #endif
 326       true)) {
 327     return false;
 328   }
 329
 330   // Shift / paren setup
 331
 332   switch(keycode) {
 333     case RESET:
 334       if (record->event.pressed) {
 335         reset_keyboard();
 336       }
 337     return false;
 338     case DEBUG:
 339       if (record->event.pressed) {
 340           debug_enable = true;
 341           print("DEBUG: enabled.\n");
 342       }
 343     return false;
 344     case EEPROM_RESET:
 345       if (record->event.pressed) {
 346           eeconfig_init();
 347       }
 348     return false;
 349   #ifdef FAUXCLICKY_ENABLE
 350   case FC_TOG:
 351     if (record->event.pressed) {
 352       FAUXCLICKY_TOGGLE;
 353     }
 354     return false;
 355   case FC_ON:
 356     if (record->event.pressed) {
 357       FAUXCLICKY_ON;
 358     }
 359     return false;
 360   case FC_OFF:
 361     if (record->event.pressed) {
 362       FAUXCLICKY_OFF;
 363     }
 364     return false;
 365   #endif
 366   #if defined(RGBLIGHT_ENABLE) || defined(RGB_MATRIX_ENABLE)
 367   case RGB_TOG:
 368     // Split keyboards need to trigger on key-up for edge-case issue
 369     #ifndef SPLIT_KEYBOARD
 370     if (record->event.pressed) {
 371     #else
 372     if (!record->event.pressed) {
 373     #endif
 374       rgblight_toggle();
 375     }
 376     return false;
 377   case RGB_MODE_FORWARD:
 378     if (record->event.pressed) {
 379       uint8_t shifted = get_mods() & (MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT));
 380       if(shifted) {
 381         rgblight_step_reverse();
 382       }
 383       else {
 384         rgblight_step();
 385       }
 386     }
 387     return false;
 388   case RGB_MODE_REVERSE:
 389     if (record->event.pressed) {
 390       uint8_t shifted = get_mods() & (MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT));
 391       if(shifted) {
 392         rgblight_step();
 393       }
 394       else {
 395         rgblight_step_reverse();
 396       }
 397     }
 398     return false;
 399   case RGB_HUI:
 400     // Split keyboards need to trigger on key-up for edge-case issue
 401     #ifndef SPLIT_KEYBOARD
 402     if (record->event.pressed) {
 403     #else
 404     if (!record->event.pressed) {
 405     #endif
 406       rgblight_increase_hue();
 407     }
 408     return false;
 409   case RGB_HUD:
 410     // Split keyboards need to trigger on key-up for edge-case issue
 411     #ifndef SPLIT_KEYBOARD
 412     if (record->event.pressed) {
 413     #else
 414     if (!record->event.pressed) {
 415     #endif
 416       rgblight_decrease_hue();
 417     }
 418     return false;
 419   case RGB_SAI:
 420     // Split keyboards need to trigger on key-up for edge-case issue
 421     #ifndef SPLIT_KEYBOARD
 422     if (record->event.pressed) {
 423     #else
 424     if (!record->event.pressed) {
 425     #endif
 426       rgblight_increase_sat();
 427     }
 428     return false;
 429   case RGB_SAD:
 430     // Split keyboards need to trigger on key-up for edge-case issue
 431     #ifndef SPLIT_KEYBOARD
 432     if (record->event.pressed) {
 433     #else
 434     if (!record->event.pressed) {
 435     #endif
 436       rgblight_decrease_sat();
 437     }
 438     return false;
 439   case RGB_VAI:
 440     // Split keyboards need to trigger on key-up for edge-case issue
 441     #ifndef SPLIT_KEYBOARD
 442     if (record->event.pressed) {
 443     #else
 444     if (!record->event.pressed) {
 445     #endif
 446       rgblight_increase_val();
 447     }
 448     return false;
 449   case RGB_VAD:
 450     // Split keyboards need to trigger on key-up for edge-case issue
 451     #ifndef SPLIT_KEYBOARD
 452     if (record->event.pressed) {
 453     #else
 454     if (!record->event.pressed) {
 455     #endif
 456       rgblight_decrease_val();
 457     }
 458     return false;
 459   case RGB_SPI:
 460     if (record->event.pressed) {
 461       rgblight_increase_speed();
 462     }
 463     return false;
 464   case RGB_SPD:
 465     if (record->event.pressed) {
 466       rgblight_decrease_speed();
 467     }
 468     return false;
 469   case RGB_MODE_PLAIN:
 470     if (record->event.pressed) {
 471       rgblight_mode(RGBLIGHT_MODE_STATIC_LIGHT);
 472     }
 473     return false;
 474   case RGB_MODE_BREATHE:
 475   #ifdef RGBLIGHT_EFFECT_BREATHING
 476     if (record->event.pressed) {
 477       if ((RGBLIGHT_MODE_BREATHING <= rgblight_get_mode()) &&
 478           (rgblight_get_mode() < RGBLIGHT_MODE_BREATHING_end)) {
 479         rgblight_step();
 480       } else {
 481         rgblight_mode(RGBLIGHT_MODE_BREATHING);
 482       }
 483     }
 484   #endif
 485     return false;
 486   case RGB_MODE_RAINBOW:
 487   #ifdef RGBLIGHT_EFFECT_RAINBOW_MOOD
 488     if (record->event.pressed) {
 489       if ((RGBLIGHT_MODE_RAINBOW_MOOD <= rgblight_get_mode()) &&
 490           (rgblight_get_mode() < RGBLIGHT_MODE_RAINBOW_MOOD_end)) {
 491         rgblight_step();
 492       } else {
 493         rgblight_mode(RGBLIGHT_MODE_RAINBOW_MOOD);
 494       }
 495     }
 496   #endif
 497     return false;
 498   case RGB_MODE_SWIRL:
 499   #ifdef RGBLIGHT_EFFECT_RAINBOW_SWIRL
 500     if (record->event.pressed) {
 501       if ((RGBLIGHT_MODE_RAINBOW_SWIRL <= rgblight_get_mode()) &&
 502           (rgblight_get_mode() < RGBLIGHT_MODE_RAINBOW_SWIRL_end)) {
 503         rgblight_step();
 504       } else {
 505         rgblight_mode(RGBLIGHT_MODE_RAINBOW_SWIRL);
 506       }
 507     }
 508   #endif
 509     return false;
 510   case RGB_MODE_SNAKE:
 511   #ifdef RGBLIGHT_EFFECT_SNAKE
 512     if (record->event.pressed) {
 513       if ((RGBLIGHT_MODE_SNAKE <= rgblight_get_mode()) &&
 514           (rgblight_get_mode() < RGBLIGHT_MODE_SNAKE_end)) {
 515         rgblight_step();
 516       } else {
 517         rgblight_mode(RGBLIGHT_MODE_SNAKE);
 518       }
 519     }
 520   #endif
 521     return false;
 522   case RGB_MODE_KNIGHT:
 523   #ifdef RGBLIGHT_EFFECT_KNIGHT
 524     if (record->event.pressed) {
 525       if ((RGBLIGHT_MODE_KNIGHT <= rgblight_get_mode()) &&
 526           (rgblight_get_mode() < RGBLIGHT_MODE_KNIGHT_end)) {
 527         rgblight_step();
 528       } else {
 529         rgblight_mode(RGBLIGHT_MODE_KNIGHT);
 530       }
 531     }
 532   #endif
 533     return false;
 534   case RGB_MODE_XMAS:
 535   #ifdef RGBLIGHT_EFFECT_CHRISTMAS
 536     if (record->event.pressed) {
 537       rgblight_mode(RGBLIGHT_MODE_CHRISTMAS);
 538     }
 539   #endif
 540     return false;
 541   case RGB_MODE_GRADIENT:
 542   #ifdef RGBLIGHT_EFFECT_STATIC_GRADIENT
 543     if (record->event.pressed) {
 544       if ((RGBLIGHT_MODE_STATIC_GRADIENT <= rgblight_get_mode()) &&
 545           (rgblight_get_mode() < RGBLIGHT_MODE_STATIC_GRADIENT_end)) {
 546         rgblight_step();
 547       } else {
 548         rgblight_mode(RGBLIGHT_MODE_STATIC_GRADIENT);
 549       }
 550     }
 551   #endif
 552     return false;
 553   case RGB_MODE_RGBTEST:
 554   #ifdef RGBLIGHT_EFFECT_RGB_TEST
 555     if (record->event.pressed) {
 556       rgblight_mode(RGBLIGHT_MODE_RGB_TEST);
 557     }
 558   #endif
 559     return false;
 560   #endif // defined(RGBLIGHT_ENABLE) || defined(RGB_MATRIX_ENABLE)
 561   #ifdef VELOCIKEY_ENABLE
 562     case VLK_TOG:
 563       if (record->event.pressed) {
 564         velocikey_toggle();
 565       }
 566       return false;
 567   #endif
 568   #ifdef PROTOCOL_LUFA
 569     case OUT_AUTO:
 570       if (record->event.pressed) {
 571         set_output(OUTPUT_AUTO);
 572       }
 573       return false;
 574     case OUT_USB:
 575       if (record->event.pressed) {
 576         set_output(OUTPUT_USB);
 577       }
 578       return false;
 579     #ifdef BLUETOOTH_ENABLE
 580     case OUT_BT:
 581       if (record->event.pressed) {
 582         set_output(OUTPUT_BLUETOOTH);
 583       }
 584       return false;
 585     #endif
 586     #endif
 587     case MAGIC_SWAP_CONTROL_CAPSLOCK ... MAGIC_TOGGLE_NKRO:
 588       if (record->event.pressed) {
 589         // MAGIC actions (BOOTMAGIC without the boot)
 590         if (!eeconfig_is_enabled()) {
 591             eeconfig_init();
 592         }
 593         /* keymap config */
 594         keymap_config.raw = eeconfig_read_keymap();
 595         switch (keycode)
 596         {
 597           case MAGIC_SWAP_CONTROL_CAPSLOCK:
 598             keymap_config.swap_control_capslock = true;
 599             break;
 600           case MAGIC_CAPSLOCK_TO_CONTROL:
 601             keymap_config.capslock_to_control = true;
 602             break;
 603           case MAGIC_SWAP_LALT_LGUI:
 604             keymap_config.swap_lalt_lgui = true;
 605             break;
 606           case MAGIC_SWAP_RALT_RGUI:
 607             keymap_config.swap_ralt_rgui = true;
 608             break;
 609           case MAGIC_NO_GUI:
 610             keymap_config.no_gui = true;
 611             break;
 612           case MAGIC_SWAP_GRAVE_ESC:
 613             keymap_config.swap_grave_esc = true;
 614             break;
 615           case MAGIC_SWAP_BACKSLASH_BACKSPACE:
 616             keymap_config.swap_backslash_backspace = true;
 617             break;
 618           case MAGIC_HOST_NKRO:
 619             keymap_config.nkro = true;
 620             break;
 621           case MAGIC_SWAP_ALT_GUI:
 622             keymap_config.swap_lalt_lgui = true;
 623             keymap_config.swap_ralt_rgui = true;
 624             #ifdef AUDIO_ENABLE
 625               PLAY_SONG(ag_swap_song);
 626             #endif
 627             break;
 628           case MAGIC_UNSWAP_CONTROL_CAPSLOCK:
 629             keymap_config.swap_control_capslock = false;
 630             break;
 631           case MAGIC_UNCAPSLOCK_TO_CONTROL:
 632             keymap_config.capslock_to_control = false;
 633             break;
 634           case MAGIC_UNSWAP_LALT_LGUI:
 635             keymap_config.swap_lalt_lgui = false;
 636             break;
 637           case MAGIC_UNSWAP_RALT_RGUI:
 638             keymap_config.swap_ralt_rgui = false;
 639             break;
 640           case MAGIC_UNNO_GUI:
 641             keymap_config.no_gui = false;
 642             break;
 643           case MAGIC_UNSWAP_GRAVE_ESC:
 644             keymap_config.swap_grave_esc = false;
 645             break;
 646           case MAGIC_UNSWAP_BACKSLASH_BACKSPACE:
 647             keymap_config.swap_backslash_backspace = false;
 648             break;
 649           case MAGIC_UNHOST_NKRO:
 650             keymap_config.nkro = false;
 651             break;
 652           case MAGIC_UNSWAP_ALT_GUI:
 653             keymap_config.swap_lalt_lgui = false;
 654             keymap_config.swap_ralt_rgui = false;
 655             #ifdef AUDIO_ENABLE
 656               PLAY_SONG(ag_norm_song);
 657             #endif
 658             break;
 659           case MAGIC_TOGGLE_ALT_GUI:
 660             keymap_config.swap_lalt_lgui = !keymap_config.swap_lalt_lgui;
 661             keymap_config.swap_ralt_rgui = !keymap_config.swap_ralt_rgui;
 662             #ifdef AUDIO_ENABLE
 663               if (keymap_config.swap_ralt_rgui) {
 664                 PLAY_SONG(ag_swap_song);
 665               } else {
 666                 PLAY_SONG(ag_norm_song);
 667               }
 668             #endif
 669             break;
 670           case MAGIC_TOGGLE_NKRO:
 671             keymap_config.nkro = !keymap_config.nkro;
 672             break;
 673           default:
 674             break;
 675         }
 676         eeconfig_update_keymap(keymap_config.raw);
 677         clear_keyboard(); // clear to prevent stuck keys
 678
 679         return false;
 680       }
 681       break;
 682     case KC_LSPO: {
 683       if (record->event.pressed) {
 684         shift_interrupted[0] = false;
 685         scs_timer[0] = timer_read ();
 686         register_mods(MOD_BIT(KC_LSFT));
 687       }
 688       else {
 689         #ifdef DISABLE_SPACE_CADET_ROLLOVER
 690           if (get_mods() & MOD_BIT(RSPC_MOD)) {
 691             shift_interrupted[0] = true;
 692             shift_interrupted[1] = true;
 693           }
 694         #endif
 695         if (!shift_interrupted[0] && timer_elapsed(scs_timer[0]) < TAPPING_TERM) {
 696           #ifdef DISABLE_SPACE_CADET_MODIFIER
 697             unregister_mods(MOD_BIT(KC_LSFT));
 698           #else
 699             if( LSPO_MOD != KC_LSFT ){
 700               unregister_mods(MOD_BIT(KC_LSFT));
 701               register_mods(MOD_BIT(LSPO_MOD));
 702             }
 703           #endif
 704           register_code(LSPO_KEY);
 705           unregister_code(LSPO_KEY);
 706           #ifndef DISABLE_SPACE_CADET_MODIFIER
 707             if( LSPO_MOD != KC_LSFT ){
 708               unregister_mods(MOD_BIT(LSPO_MOD));
 709             }
 710           #endif
 711         }
 712         unregister_mods(MOD_BIT(KC_LSFT));
 713       }
 714       return false;
 715     }
 716
 717     case KC_RSPC: {
 718       if (record->event.pressed) {
 719         shift_interrupted[1] = false;
 720         scs_timer[1] = timer_read ();
 721         register_mods(MOD_BIT(KC_RSFT));
 722       }
 723       else {
 724         #ifdef DISABLE_SPACE_CADET_ROLLOVER
 725           if (get_mods() & MOD_BIT(LSPO_MOD)) {
 726             shift_interrupted[0] = true;
 727             shift_interrupted[1] = true;
 728           }
 729         #endif
 730         if (!shift_interrupted[1] && timer_elapsed(scs_timer[1]) < TAPPING_TERM) {
 731           #ifdef DISABLE_SPACE_CADET_MODIFIER
 732             unregister_mods(MOD_BIT(KC_RSFT));
 733           #else
 734             if( RSPC_MOD != KC_RSFT ){
 735               unregister_mods(MOD_BIT(KC_RSFT));
 736               register_mods(MOD_BIT(RSPC_MOD));
 737             }
 738           #endif
 739           register_code(RSPC_KEY);
 740           unregister_code(RSPC_KEY);
 741           #ifndef DISABLE_SPACE_CADET_MODIFIER
 742             if ( RSPC_MOD != KC_RSFT ){
 743               unregister_mods(MOD_BIT(RSPC_MOD));
 744             }
 745           #endif
 746         }
 747         unregister_mods(MOD_BIT(KC_RSFT));
 748       }
 749       return false;
 750     }
 751
 752     case KC_SFTENT: {
 753       if (record->event.pressed) {
 754         shift_interrupted[1] = false;
 755         scs_timer[1] = timer_read ();
 756         register_mods(MOD_BIT(KC_RSFT));
 757       }
 758       else if (!shift_interrupted[1] && timer_elapsed(scs_timer[1]) < TAPPING_TERM) {
 759         unregister_mods(MOD_BIT(KC_RSFT));
 760         register_code(SFTENT_KEY);
 761         unregister_code(SFTENT_KEY);
 762       }
 763       else {
 764         unregister_mods(MOD_BIT(KC_RSFT));
 765       }
 766       return false;
 767     }
 768
 769     case GRAVE_ESC: {
 770       uint8_t shifted = get_mods() & ((MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT)
 771                                       |MOD_BIT(KC_LGUI)|MOD_BIT(KC_RGUI)));
 772
 773 #ifdef GRAVE_ESC_ALT_OVERRIDE
 774       // if ALT is pressed, ESC is always sent
 775       // this is handy for the cmd+opt+esc shortcut on macOS, among other things.
 776       if (get_mods() & (MOD_BIT(KC_LALT) | MOD_BIT(KC_RALT))) {
 777         shifted = 0;
 778       }
 779 #endif
 780
 781 #ifdef GRAVE_ESC_CTRL_OVERRIDE
 782       // if CTRL is pressed, ESC is always sent
 783       // this is handy for the ctrl+shift+esc shortcut on windows, among other things.
 784       if (get_mods() & (MOD_BIT(KC_LCTL) | MOD_BIT(KC_RCTL))) {
 785         shifted = 0;
 786       }
 787 #endif
 788
 789 #ifdef GRAVE_ESC_GUI_OVERRIDE
 790       // if GUI is pressed, ESC is always sent
 791       if (get_mods() & (MOD_BIT(KC_LGUI) | MOD_BIT(KC_RGUI))) {
 792         shifted = 0;
 793       }
 794 #endif
 795
 796 #ifdef GRAVE_ESC_SHIFT_OVERRIDE
 797       // if SHIFT is pressed, ESC is always sent
 798       if (get_mods() & (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT))) {
 799         shifted = 0;
 800       }
 801 #endif
 802
 803       if (record->event.pressed) {
 804         grave_esc_was_shifted = shifted;
 805         add_key(shifted ? KC_GRAVE : KC_ESCAPE);
 806       }
 807       else {
 808         del_key(grave_esc_was_shifted ? KC_GRAVE : KC_ESCAPE);
 809       }
 810
 811       send_keyboard_report();
 812       return false;
 813     }
 814
 815 #if defined(BACKLIGHT_ENABLE) && defined(BACKLIGHT_BREATHING)
 816     case BL_BRTG: {
 817       if (record->event.pressed)
 818         breathing_toggle();
 819       return false;
 820     }
 821 #endif
 822
 823     default: {
 824       shift_interrupted[0] = true;
 825       shift_interrupted[1] = true;
 826       break;
 827     }
 828   }
 829
 830   return process_action_kb(record);
 831 }
 832
 833 __attribute__ ((weak))
 834 const bool ascii_to_shift_lut[0x80] PROGMEM = {
 835     0, 0, 0, 0, 0, 0, 0, 0,
 836     0, 0, 0, 0, 0, 0, 0, 0,
 837     0, 0, 0, 0, 0, 0, 0, 0,
 838     0, 0, 0, 0, 0, 0, 0, 0,
 839     0, 1, 1, 1, 1, 1, 1, 0,
 840     1, 1, 1, 1, 0, 0, 0, 0,
 841     0, 0, 0, 0, 0, 0, 0, 0,
 842     0, 0, 1, 0, 1, 0, 1, 1,
 843     1, 1, 1, 1, 1, 1, 1, 1,
 844     1, 1, 1, 1, 1, 1, 1, 1,
 845     1, 1, 1, 1, 1, 1, 1, 1,
 846     1, 1, 1, 0, 0, 0, 1, 1,
 847     0, 0, 0, 0, 0, 0, 0, 0,
 848     0, 0, 0, 0, 0, 0, 0, 0,
 849     0, 0, 0, 0, 0, 0, 0, 0,
 850     0, 0, 0, 1, 1, 1, 1, 0
 851 };
 852
 853 __attribute__ ((weak))
 854 const bool ascii_to_alt_lut[0x80] PROGMEM = {
 855     0, 0, 0, 0, 0, 0, 0, 0,
 856     0, 0, 0, 0, 0, 0, 0, 0,
 857     0, 0, 0, 0, 0, 0, 0, 0,
 858     0, 0, 0, 0, 0, 0, 0, 0,
 859     0, 0, 0, 0, 0, 0, 0, 0,
 860     0, 0, 0, 0, 0, 0, 0, 0,
 861     0, 0, 0, 0, 0, 0, 0, 0,
 862     0, 0, 0, 0, 0, 0, 0, 0,
 863     0, 0, 0, 0, 0, 0, 0, 0,
 864     0, 0, 0, 0, 0, 0, 0, 0,
 865     0, 0, 0, 0, 0, 0, 0, 0,
 866     0, 0, 0, 0, 0, 0, 0, 0,
 867     0, 0, 0, 0, 0, 0, 0, 0,
 868     0, 0, 0, 0, 0, 0, 0, 0,
 869     0, 0, 0, 0, 0, 0, 0, 0,
 870     0, 0, 0, 0, 0, 0, 0, 0
 871 };
 872
 873 __attribute__ ((weak))
 874 const uint8_t ascii_to_keycode_lut[0x80] PROGMEM = {
 875     0, 0, 0, 0, 0, 0, 0, 0,
 876     KC_BSPC, KC_TAB, KC_ENT, 0, 0, 0, 0, 0,
 877     0, 0, 0, 0, 0, 0, 0, 0,
 878     0, 0, 0, KC_ESC, 0, 0, 0, 0,
 879     KC_SPC, KC_1, KC_QUOT, KC_3, KC_4, KC_5, KC_7, KC_QUOT,
 880     KC_9, KC_0, KC_8, KC_EQL, KC_COMM, KC_MINS, KC_DOT, KC_SLSH,
 881     KC_0, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7,
 882     KC_8, KC_9, KC_SCLN, KC_SCLN, KC_COMM, KC_EQL, KC_DOT, KC_SLSH,
 883     KC_2, KC_A, KC_B, KC_C, KC_D, KC_E, KC_F, KC_G,
 884     KC_H, KC_I, KC_J, KC_K, KC_L, KC_M, KC_N, KC_O,
 885     KC_P, KC_Q, KC_R, KC_S, KC_T, KC_U, KC_V, KC_W,
 886     KC_X, KC_Y, KC_Z, KC_LBRC, KC_BSLS, KC_RBRC, KC_6, KC_MINS,
 887     KC_GRV, KC_A, KC_B, KC_C, KC_D, KC_E, KC_F, KC_G,
 888     KC_H, KC_I, KC_J, KC_K, KC_L, KC_M, KC_N, KC_O,
 889     KC_P, KC_Q, KC_R, KC_S, KC_T, KC_U, KC_V, KC_W,
 890     KC_X, KC_Y, KC_Z, KC_LBRC, KC_BSLS, KC_RBRC, KC_GRV, KC_DEL
 891 };
 892
 893 void send_string(const char *str) {
 894   send_string_with_delay(str, 0);
 895 }
 896
 897 void send_string_P(const char *str) {
 898   send_string_with_delay_P(str, 0);
 899 }
 900
 901 void send_string_with_delay(const char *str, uint8_t interval) {
 902     while (1) {
 903         char ascii_code = *str;
 904         if (!ascii_code) break;
 905         if (ascii_code == SS_TAP_CODE) {
 906           // tap
 907           uint8_t keycode = *(++str);
 908           register_code(keycode);
 909           unregister_code(keycode);
 910         } else if (ascii_code == SS_DOWN_CODE) {
 911           // down
 912           uint8_t keycode = *(++str);
 913           register_code(keycode);
 914         } else if (ascii_code == SS_UP_CODE) {
 915           // up
 916           uint8_t keycode = *(++str);
 917           unregister_code(keycode);
 918         } else {
 919           send_char(ascii_code);
 920         }
 921         ++str;
 922         // interval
 923         { uint8_t ms = interval; while (ms--) wait_ms(1); }
 924     }
 925 }
 926
 927 void send_string_with_delay_P(const char *str, uint8_t interval) {
 928     while (1) {
 929         char ascii_code = pgm_read_byte(str);
 930         if (!ascii_code) break;
 931         if (ascii_code == SS_TAP_CODE) {
 932           // tap
 933           uint8_t keycode = pgm_read_byte(++str);
 934           register_code(keycode);
 935           unregister_code(keycode);
 936         } else if (ascii_code == SS_DOWN_CODE) {
 937           // down
 938           uint8_t keycode = pgm_read_byte(++str);
 939           register_code(keycode);
 940         } else if (ascii_code == SS_UP_CODE) {
 941           // up
 942           uint8_t keycode = pgm_read_byte(++str);
 943           unregister_code(keycode);
 944         } else {
 945           send_char(ascii_code);
 946         }
 947         ++str;
 948         // interval
 949         { uint8_t ms = interval; while (ms--) wait_ms(1); }
 950     }
 951 }
 952
 953 void send_char(char ascii_code) {
 954   uint8_t keycode;
 955   bool is_shifted;
 956   bool is_alted;
 957
 958   keycode = pgm_read_byte(&ascii_to_keycode_lut[(uint8_t)ascii_code]);
 959   if (pgm_read_byte(&ascii_to_shift_lut[(uint8_t)ascii_code])) { is_shifted = true; } else { is_shifted = false; }
 960   if (pgm_read_byte(&ascii_to_alt_lut[(uint8_t)ascii_code])) { is_alted = true; } else { is_alted = false; }
 961
 962   if (is_shifted) { register_code(KC_LSFT); }
 963   if (is_alted) { register_code(KC_RALT); }
 964
 965   tap_code(keycode);
 966
 967   if (is_alted) { unregister_code(KC_RALT); }
 968   if (is_shifted) { unregister_code(KC_LSFT); }
 969 }
 970
 971 void set_single_persistent_default_layer(uint8_t default_layer) {
 972   #if defined(AUDIO_ENABLE) && defined(DEFAULT_LAYER_SONGS)
 973     PLAY_SONG(default_layer_songs[default_layer]);
 974   #endif
 975   eeconfig_update_default_layer(1U<<default_layer);
 976   default_layer_set(1U<<default_layer);
 977 }
 978
 979 uint32_t update_tri_layer_state(uint32_t state, uint8_t layer1, uint8_t layer2, uint8_t layer3) {
 980   uint32_t mask12 = (1UL << layer1) | (1UL << layer2);
 981   uint32_t mask3 = 1UL << layer3;
 982   return (state & mask12) == mask12 ? (state | mask3) : (state & ~mask3);
 983 }
 984
 985 void update_tri_layer(uint8_t layer1, uint8_t layer2, uint8_t layer3) {
 986   layer_state_set(update_tri_layer_state(layer_state, layer1, layer2, layer3));
 987 }
 988
 989 void tap_random_base64(void) {
 990   #if defined(__AVR_ATmega32U4__)
 991     uint8_t key = (TCNT0 + TCNT1 + TCNT3 + TCNT4) % 64;
 992   #else
 993     uint8_t key = rand() % 64;
 994   #endif
 995   switch (key) {
 996     case 0 ... 25:
 997       register_code(KC_LSFT);
 998       register_code(key + KC_A);
 999       unregister_code(key + KC_A);
1000       unregister_code(KC_LSFT);
1001       break;
1002     case 26 ... 51:
1003       register_code(key - 26 + KC_A);
1004       unregister_code(key - 26 + KC_A);
1005       break;
1006     case 52:
1007       register_code(KC_0);
1008       unregister_code(KC_0);
1009       break;
1010     case 53 ... 61:
1011       register_code(key - 53 + KC_1);
1012       unregister_code(key - 53 + KC_1);
1013       break;
1014     case 62:
1015       register_code(KC_LSFT);
1016       register_code(KC_EQL);
1017       unregister_code(KC_EQL);
1018       unregister_code(KC_LSFT);
1019       break;
1020     case 63:
1021       register_code(KC_SLSH);
1022       unregister_code(KC_SLSH);
1023       break;
1024   }
1025 }
1026
1027 __attribute__((weak))
1028 void bootmagic_lite(void) {
1029   // The lite version of TMK's bootmagic based on Wilba.
1030   // 100% less potential for accidentally making the
1031   // keyboard do stupid things.
1032
1033   // We need multiple scans because debouncing can't be turned off.
1034   matrix_scan();
1035   #if defined(DEBOUNCING_DELAY) && DEBOUNCING_DELAY > 0
1036     wait_ms(DEBOUNCING_DELAY * 2);
1037   #elif defined(DEBOUNCE) && DEBOUNCE > 0
1038     wait_ms(DEBOUNCE * 2);
1039   #else
1040     wait_ms(30);
1041   #endif
1042   matrix_scan();
1043
1044   // If the Esc and space bar are held down on power up,
1045   // reset the EEPROM valid state and jump to bootloader.
1046   // Assumes Esc is at [0,0].
1047   // This isn't very generalized, but we need something that doesn't
1048   // rely on user's keymaps in firmware or EEPROM.
1049   if (matrix_get_row(BOOTMAGIC_LITE_ROW) & (1 << BOOTMAGIC_LITE_COLUMN)) {
1050     eeconfig_disable();
1051     // Jump to bootloader.
1052     bootloader_jump();
1053   }
1054 }
1055
1056 void matrix_init_quantum() {
1057   #ifdef BOOTMAGIC_LITE
1058     bootmagic_lite();
1059   #endif
1060   if (!eeconfig_is_enabled()) {
1061     eeconfig_init();
1062   }
1063   #ifdef BACKLIGHT_ENABLE
1064     #ifdef LED_MATRIX_ENABLE
1065         led_matrix_init();
1066     #else
1067         backlight_init_ports();
1068     #endif
1069   #endif
1070   #ifdef AUDIO_ENABLE
1071     audio_init();
1072   #endif
1073   #ifdef RGB_MATRIX_ENABLE
1074     rgb_matrix_init();
1075   #endif
1076   #ifdef ENCODER_ENABLE
1077     encoder_init();
1078   #endif
1079   #if defined(UNICODE_ENABLE) || defined(UNICODEMAP_ENABLE) || defined(UCIS_ENABLE)
1080     unicode_input_mode_init();
1081   #endif
1082   #ifdef HAPTIC_ENABLE
1083     haptic_init();
1084   #endif
1085   matrix_init_kb();
1086 }
1087
1088 void matrix_scan_quantum() {
1089   #if defined(AUDIO_ENABLE) && !defined(NO_MUSIC_MODE)
1090     matrix_scan_music();
1091   #endif
1092
1093   #ifdef TAP_DANCE_ENABLE
1094     matrix_scan_tap_dance();
1095   #endif
1096
1097   #ifdef COMBO_ENABLE
1098     matrix_scan_combo();
1099   #endif
1100
1101   #if defined(BACKLIGHT_ENABLE)
1102     #if defined(LED_MATRIX_ENABLE)
1103         led_matrix_task();
1104     #elif defined(BACKLIGHT_PIN)
1105         backlight_task();
1106     #endif
1107   #endif
1108
1109   #ifdef RGB_MATRIX_ENABLE
1110     rgb_matrix_task();
1111   #endif
1112
1113   #ifdef ENCODER_ENABLE
1114     encoder_read();
1115   #endif
1116
1117   #ifdef HAPTIC_ENABLE
1118     haptic_task();
1119   #endif
1120
1121   matrix_scan_kb();
1122 }
1123 #if defined(BACKLIGHT_ENABLE) && defined(BACKLIGHT_PIN)
1124
1125 static const uint8_t backlight_pin = BACKLIGHT_PIN;
1126
1127 // depending on the pin, we use a different output compare unit
1128 #if BACKLIGHT_PIN == B7
1129 #  define TCCRxA TCCR1A
1130 #  define TCCRxB TCCR1B
1131 #  define COMxx1 COM1C1
1132 #  define OCRxx  OCR1C
1133 #  define ICRx   ICR1
1134 #elif BACKLIGHT_PIN == B6
1135 #  define TCCRxA TCCR1A
1136 #  define TCCRxB TCCR1B
1137 #  define COMxx1 COM1B1
1138 #  define OCRxx  OCR1B
1139 #  define ICRx   ICR1
1140 #elif BACKLIGHT_PIN == B5
1141 #  define TCCRxA TCCR1A
1142 #  define TCCRxB TCCR1B
1143 #  define COMxx1 COM1A1
1144 #  define OCRxx  OCR1A
1145 #  define ICRx   ICR1
1146 #elif BACKLIGHT_PIN == C6
1147 #  define TCCRxA TCCR3A
1148 #  define TCCRxB TCCR3B
1149 #  define COMxx1 COM1A1
1150 #  define OCRxx  OCR3A
1151 #  define ICRx   ICR3
1152 #elif defined(__AVR_ATmega32A__) && BACKLIGHT_PIN == D4
1153 #  define TCCRxA TCCR1A
1154 #  define TCCRxB TCCR1B
1155 #  define COMxx1 COM1B1
1156 #  define OCRxx  OCR1B
1157 #  define ICRx   ICR1
1158 #  define TIMSK1 TIMSK
1159 #else
1160 #  define NO_HARDWARE_PWM
1161 #endif
1162
1163 #ifndef BACKLIGHT_ON_STATE
1164 #define BACKLIGHT_ON_STATE 0
1165 #endif
1166
1167 #ifdef NO_HARDWARE_PWM // pwm through software
1168
1169 __attribute__ ((weak))
1170 void backlight_init_ports(void)
1171 {
1172   // Setup backlight pin as output and output to on state.
1173   // DDRx |= n
1174   _SFR_IO8((backlight_pin >> 4) + 1) |= _BV(backlight_pin & 0xF);
1175   #if BACKLIGHT_ON_STATE == 0
1176     // PORTx &= ~n
1177     _SFR_IO8((backlight_pin >> 4) + 2) &= ~_BV(backlight_pin & 0xF);
1178   #else
1179     // PORTx |= n
1180     _SFR_IO8((backlight_pin >> 4) + 2) |= _BV(backlight_pin & 0xF);
1181   #endif
1182 }
1183
1184 __attribute__ ((weak))
1185 void backlight_set(uint8_t level) {}
1186
1187 uint8_t backlight_tick = 0;
1188
1189 #ifndef BACKLIGHT_CUSTOM_DRIVER
1190 void backlight_task(void) {
1191   if ((0xFFFF >> ((BACKLIGHT_LEVELS - get_backlight_level()) * ((BACKLIGHT_LEVELS + 1) / 2))) & (1 << backlight_tick)) {
1192     #if BACKLIGHT_ON_STATE == 0
1193       // PORTx &= ~n
1194       _SFR_IO8((backlight_pin >> 4) + 2) &= ~_BV(backlight_pin & 0xF);
1195     #else
1196       // PORTx |= n
1197       _SFR_IO8((backlight_pin >> 4) + 2) |= _BV(backlight_pin & 0xF);
1198     #endif
1199   } else {
1200     #if BACKLIGHT_ON_STATE == 0
1201       // PORTx |= n
1202       _SFR_IO8((backlight_pin >> 4) + 2) |= _BV(backlight_pin & 0xF);
1203     #else
1204       // PORTx &= ~n
1205       _SFR_IO8((backlight_pin >> 4) + 2) &= ~_BV(backlight_pin & 0xF);
1206     #endif
1207   }
1208   backlight_tick = (backlight_tick + 1) % 16;
1209 }
1210 #endif
1211
1212 #ifdef BACKLIGHT_BREATHING
1213   #ifndef BACKLIGHT_CUSTOM_DRIVER
1214   #error "Backlight breathing only available with hardware PWM. Please disable."
1215   #endif
1216 #endif
1217
1218 #else // pwm through timer
1219
1220 #define TIMER_TOP 0xFFFFU
1221
1222 // See http://jared.geek.nz/2013/feb/linear-led-pwm
1223 static uint16_t cie_lightness(uint16_t v) {
1224   if (v <= 5243) // if below 8% of max
1225     return v / 9; // same as dividing by 900%
1226   else {
1227     uint32_t y = (((uint32_t) v + 10486) << 8) / (10486 + 0xFFFFUL); // add 16% of max and compare
1228     // to get a useful result with integer division, we shift left in the expression above
1229     // and revert what we've done again after squaring.
1230     y = y * y * y >> 8;
1231     if (y > 0xFFFFUL) // prevent overflow
1232       return 0xFFFFU;
1233     else
1234       return (uint16_t) y;
1235   }
1236 }
1237
1238 // range for val is [0..TIMER_TOP]. PWM pin is high while the timer count is below val.
1239 static inline void set_pwm(uint16_t val) {
1240         OCRxx = val;
1241 }
1242
1243 #ifndef BACKLIGHT_CUSTOM_DRIVER
1244 __attribute__ ((weak))
1245 void backlight_set(uint8_t level) {
1246   if (level > BACKLIGHT_LEVELS)
1247     level = BACKLIGHT_LEVELS;
1248
1249   if (level == 0) {
1250     // Turn off PWM control on backlight pin
1251     TCCRxA &= ~(_BV(COMxx1));
1252   } else {
1253     // Turn on PWM control of backlight pin
1254     TCCRxA |= _BV(COMxx1);
1255   }
1256   // Set the brightness
1257   set_pwm(cie_lightness(TIMER_TOP * (uint32_t)level / BACKLIGHT_LEVELS));
1258 }
1259
1260 void backlight_task(void) {}
1261 #endif  // BACKLIGHT_CUSTOM_DRIVER
1262
1263 #ifdef BACKLIGHT_BREATHING
1264
1265 #define BREATHING_NO_HALT  0
1266 #define BREATHING_HALT_OFF 1
1267 #define BREATHING_HALT_ON  2
1268 #define BREATHING_STEPS 128
1269
1270 static uint8_t breathing_period = BREATHING_PERIOD;
1271 static uint8_t breathing_halt = BREATHING_NO_HALT;
1272 static uint16_t breathing_counter = 0;
1273
1274 bool is_breathing(void) {
1275     return !!(TIMSK1 & _BV(TOIE1));
1276 }
1277
1278 #define breathing_interrupt_enable() do {TIMSK1 |= _BV(TOIE1);} while (0)
1279 #define breathing_interrupt_disable() do {TIMSK1 &= ~_BV(TOIE1);} while (0)
1280 #define breathing_min() do {breathing_counter = 0;} while (0)
1281 #define breathing_max() do {breathing_counter = breathing_period * 244 / 2;} while (0)
1282
1283 void breathing_enable(void)
1284 {
1285   breathing_counter = 0;
1286   breathing_halt = BREATHING_NO_HALT;
1287   breathing_interrupt_enable();
1288 }
1289
1290 void breathing_pulse(void)
1291 {
1292     if (get_backlight_level() == 0)
1293       breathing_min();
1294     else
1295       breathing_max();
1296     breathing_halt = BREATHING_HALT_ON;
1297     breathing_interrupt_enable();
1298 }
1299
1300 void breathing_disable(void)
1301 {
1302     breathing_interrupt_disable();
1303     // Restore backlight level
1304     backlight_set(get_backlight_level());
1305 }
1306
1307 void breathing_self_disable(void)
1308 {
1309   if (get_backlight_level() == 0)
1310     breathing_halt = BREATHING_HALT_OFF;
1311   else
1312     breathing_halt = BREATHING_HALT_ON;
1313 }
1314
1315 void breathing_toggle(void) {
1316   if (is_breathing())
1317     breathing_disable();
1318   else
1319     breathing_enable();
1320 }
1321
1322 void breathing_period_set(uint8_t value)
1323 {
1324   if (!value)
1325     value = 1;
1326   breathing_period = value;
1327 }
1328
1329 void breathing_period_default(void) {
1330   breathing_period_set(BREATHING_PERIOD);
1331 }
1332
1333 void breathing_period_inc(void)
1334 {
1335   breathing_period_set(breathing_period+1);
1336 }
1337
1338 void breathing_period_dec(void)
1339 {
1340   breathing_period_set(breathing_period-1);
1341 }
1342
1343 /* To generate breathing curve in python:
1344  * from math import sin, pi; [int(sin(x/128.0*pi)**4*255) for x in range(128)]
1345  */
1346 static const uint8_t breathing_table[BREATHING_STEPS] PROGMEM = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 2, 3, 4, 5, 6, 8, 10, 12, 15, 17, 20, 24, 28, 32, 36, 41, 46, 51, 57, 63, 70, 76, 83, 91, 98, 106, 113, 121, 129, 138, 146, 154, 162, 170, 178, 185, 193, 200, 207, 213, 220, 225, 231, 235, 240, 244, 247, 250, 252, 253, 254, 255, 254, 253, 252, 250, 247, 244, 240, 235, 231, 225, 220, 213, 207, 200, 193, 185, 178, 170, 162, 154, 146, 138, 129, 121, 113, 106, 98, 91, 83, 76, 70, 63, 57, 51, 46, 41, 36, 32, 28, 24, 20, 17, 15, 12, 10, 8, 6, 5, 4, 3, 2, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
1347
1348 // Use this before the cie_lightness function.
1349 static inline uint16_t scale_backlight(uint16_t v) {
1350   return v / BACKLIGHT_LEVELS * get_backlight_level();
1351 }
1352
1353 /* Assuming a 16MHz CPU clock and a timer that resets at 64k (ICR1), the following interrupt handler will run
1354  * about 244 times per second.
1355  */
1356 ISR(TIMER1_OVF_vect)
1357 {
1358   uint16_t interval = (uint16_t) breathing_period * 244 / BREATHING_STEPS;
1359   // resetting after one period to prevent ugly reset at overflow.
1360   breathing_counter = (breathing_counter + 1) % (breathing_period * 244);
1361   uint8_t index = breathing_counter / interval % BREATHING_STEPS;
1362
1363   if (((breathing_halt == BREATHING_HALT_ON) && (index == BREATHING_STEPS / 2)) ||
1364       ((breathing_halt == BREATHING_HALT_OFF) && (index == BREATHING_STEPS - 1)))
1365   {
1366       breathing_interrupt_disable();
1367   }
1368
1369   set_pwm(cie_lightness(scale_backlight((uint16_t) pgm_read_byte(&breathing_table[index]) * 0x0101U)));
1370 }
1371
1372 #endif // BACKLIGHT_BREATHING
1373
1374 __attribute__ ((weak))
1375 void backlight_init_ports(void)
1376 {
1377   // Setup backlight pin as output and output to on state.
1378   // DDRx |= n
1379   _SFR_IO8((backlight_pin >> 4) + 1) |= _BV(backlight_pin & 0xF);
1380   #if BACKLIGHT_ON_STATE == 0
1381     // PORTx &= ~n
1382     _SFR_IO8((backlight_pin >> 4) + 2) &= ~_BV(backlight_pin & 0xF);
1383   #else
1384     // PORTx |= n
1385     _SFR_IO8((backlight_pin >> 4) + 2) |= _BV(backlight_pin & 0xF);
1386   #endif
1387   // I could write a wall of text here to explain... but TL;DW
1388   // Go read the ATmega32u4 datasheet.
1389   // And this: http://blog.saikoled.com/post/43165849837/secret-konami-cheat-code-to-high-resolution-pwm-on
1390
1391   // Pin PB7 = OCR1C (Timer 1, Channel C)
1392   // Compare Output Mode = Clear on compare match, Channel C = COM1C1=1 COM1C0=0
1393   // (i.e. start high, go low when counter matches.)
1394   // WGM Mode 14 (Fast PWM) = WGM13=1 WGM12=1 WGM11=1 WGM10=0
1395   // Clock Select = clk/1 (no prescaling) = CS12=0 CS11=0 CS10=1
1396
1397   /*
1398   14.8.3:
1399   "In fast PWM mode, the compare units allow generation of PWM waveforms on the OCnx pins. Setting the COMnx1:0 bits to two will produce a non-inverted PWM [..]."
1400   "In fast PWM mode the counter is incremented until the counter value matches either one of the fixed values 0x00FF, 0x01FF, or 0x03FF (WGMn3:0 = 5, 6, or 7), the value in ICRn (WGMn3:0 = 14), or the value in OCRnA (WGMn3:0 = 15)."
1401   */
1402   TCCRxA = _BV(COMxx1) | _BV(WGM11); // = 0b00001010;
1403   TCCRxB = _BV(WGM13) | _BV(WGM12) | _BV(CS10); // = 0b00011001;
1404   // Use full 16-bit resolution. Counter counts to ICR1 before reset to 0.
1405   ICRx = TIMER_TOP;
1406
1407   backlight_init();
1408   #ifdef BACKLIGHT_BREATHING
1409     breathing_enable();
1410   #endif
1411 }
1412
1413 #endif // NO_HARDWARE_PWM
1414
1415 #else // backlight
1416
1417 __attribute__ ((weak))
1418 void backlight_init_ports(void) {}
1419
1420 __attribute__ ((weak))
1421 void backlight_set(uint8_t level) {}
1422
1423 #endif // backlight
1424
1425 #ifdef HD44780_ENABLED
1426 #include "hd44780.h"
1427 #endif
1428
1429
1430 // Functions for spitting out values
1431 //
1432
1433 void send_dword(uint32_t number) { // this might not actually work
1434     uint16_t word = (number >> 16);
1435     send_word(word);
1436     send_word(number & 0xFFFFUL);
1437 }
1438
1439 void send_word(uint16_t number) {
1440     uint8_t byte = number >> 8;
1441     send_byte(byte);
1442     send_byte(number & 0xFF);
1443 }
1444
1445 void send_byte(uint8_t number) {
1446     uint8_t nibble = number >> 4;
1447     send_nibble(nibble);
1448     send_nibble(number & 0xF);
1449 }
1450
1451 void send_nibble(uint8_t number) {
1452     switch (number) {
1453         case 0:
1454             register_code(KC_0);
1455             unregister_code(KC_0);
1456             break;
1457         case 1 ... 9:
1458             register_code(KC_1 + (number - 1));
1459             unregister_code(KC_1 + (number - 1));
1460             break;
1461         case 0xA ... 0xF:
1462             register_code(KC_A + (number - 0xA));
1463             unregister_code(KC_A + (number - 0xA));
1464             break;
1465     }
1466 }
1467
1468
1469 __attribute__((weak))
1470 uint16_t hex_to_keycode(uint8_t hex)
1471 {
1472   hex = hex & 0xF;
1473   if (hex == 0x0) {
1474     return KC_0;
1475   } else if (hex < 0xA) {
1476     return KC_1 + (hex - 0x1);
1477   } else {
1478     return KC_A + (hex - 0xA);
1479   }
1480 }
1481
1482 void api_send_unicode(uint32_t unicode) {
1483 #ifdef API_ENABLE
1484     uint8_t chunk[4];
1485     dword_to_bytes(unicode, chunk);
1486     MT_SEND_DATA(DT_UNICODE, chunk, 5);
1487 #endif
1488 }
1489
1490 __attribute__ ((weak))
1491 void led_set_user(uint8_t usb_led) {
1492
1493 }
1494
1495 __attribute__ ((weak))
1496 void led_set_kb(uint8_t usb_led) {
1497     led_set_user(usb_led);
1498 }
1499
1500 __attribute__ ((weak))
1501 void led_init_ports(void)
1502 {
1503
1504 }
1505
1506 __attribute__ ((weak))
1507 void led_set(uint8_t usb_led)
1508 {
1509
1510   // Example LED Code
1511   //
1512     // // Using PE6 Caps Lock LED
1513     // if (usb_led & (1<<USB_LED_CAPS_LOCK))
1514     // {
1515     //     // Output high.
1516     //     DDRE |= (1<<6);
1517     //     PORTE |= (1<<6);
1518     // }
1519     // else
1520     // {
1521     //     // Output low.
1522     //     DDRE &= ~(1<<6);
1523     //     PORTE &= ~(1<<6);
1524     // }
1525
1526 #if defined(BACKLIGHT_CAPS_LOCK) && defined(BACKLIGHT_ENABLE)
1527   // Use backlight as Caps Lock indicator
1528   uint8_t bl_toggle_lvl = 0;
1529
1530   if (IS_LED_ON(usb_led, USB_LED_CAPS_LOCK) && !backlight_config.enable) {
1531     // Turning Caps Lock ON and backlight is disabled in config
1532     // Toggling backlight to the brightest level
1533     bl_toggle_lvl = BACKLIGHT_LEVELS;
1534   } else if (IS_LED_OFF(usb_led, USB_LED_CAPS_LOCK) && backlight_config.enable) {
1535     // Turning Caps Lock OFF and backlight is enabled in config
1536     // Toggling backlight and restoring config level
1537     bl_toggle_lvl = backlight_config.level;
1538   }
1539
1540   // Set level without modify backlight_config to keep ability to restore state
1541   backlight_set(bl_toggle_lvl);
1542 #endif
1543
1544   led_set_kb(usb_led);
1545 }
1546
1547
1548 //------------------------------------------------------------------------------
1549 // Override these functions in your keymap file to play different tunes on
1550 // different events such as startup and bootloader jump
1551
1552 __attribute__ ((weak))
1553 void startup_user() {}
1554
1555 __attribute__ ((weak))
1556 void shutdown_user() {}
1557
1558 //------------------------------------------------------------------------------