1 /* Copyright 2016-2017 Jack Humbert
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.
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.
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/>.
19 #include "outputselect.h"
23 #define TAPPING_TERM 200
26 #ifndef BREATHING_PERIOD
27 #define BREATHING_PERIOD 6
30 #include "backlight.h"
31 extern backlight_config_t backlight_config;
33 #ifdef FAUXCLICKY_ENABLE
34 #include "fauxclicky.h"
42 #include "process_midi.h"
47 #define GOODBYE_SONG SONG(GOODBYE_SOUND)
50 #define AG_NORM_SONG SONG(AG_NORM_SOUND)
53 #define AG_SWAP_SONG SONG(AG_SWAP_SOUND)
55 float goodbye_song[][2] = GOODBYE_SONG;
56 float ag_norm_song[][2] = AG_NORM_SONG;
57 float ag_swap_song[][2] = AG_SWAP_SONG;
58 #ifdef DEFAULT_LAYER_SONGS
59 float default_layer_songs[][16][2] = DEFAULT_LAYER_SONGS;
63 static void do_code16 (uint16_t code, void (*f) (uint8_t)) {
65 case QK_MODS ... QK_MODS_MAX:
80 if (code < QK_RMODS_MIN) return;
92 static inline void qk_register_weak_mods(uint8_t kc) {
93 add_weak_mods(MOD_BIT(kc));
94 send_keyboard_report();
97 static inline void qk_unregister_weak_mods(uint8_t kc) {
98 del_weak_mods(MOD_BIT(kc));
99 send_keyboard_report();
102 static inline void qk_register_mods(uint8_t kc) {
103 add_weak_mods(MOD_BIT(kc));
104 send_keyboard_report();
107 static inline void qk_unregister_mods(uint8_t kc) {
108 del_weak_mods(MOD_BIT(kc));
109 send_keyboard_report();
112 void register_code16 (uint16_t code) {
113 if (IS_MOD(code) || code == KC_NO) {
114 do_code16 (code, qk_register_mods);
116 do_code16 (code, qk_register_weak_mods);
118 register_code (code);
121 void unregister_code16 (uint16_t code) {
122 unregister_code (code);
123 if (IS_MOD(code) || code == KC_NO) {
124 do_code16 (code, qk_unregister_mods);
126 do_code16 (code, qk_unregister_weak_mods);
130 __attribute__ ((weak))
131 bool process_action_kb(keyrecord_t *record) {
135 __attribute__ ((weak))
136 bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
137 return process_record_user(keycode, record);
140 __attribute__ ((weak))
141 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
145 void reset_keyboard(void) {
147 #if defined(MIDI_ENABLE) && defined(MIDI_BASIC)
148 process_midi_all_notes_off();
150 #if defined(AUDIO_ENABLE) && !defined(NO_MUSIC_MODE)
151 music_all_notes_off();
152 uint16_t timer_start = timer_read();
153 PLAY_SONG(goodbye_song);
155 while(timer_elapsed(timer_start) < 250)
161 // this is also done later in bootloader.c - not sure if it's neccesary here
162 #ifdef BOOTLOADER_CATERINA
163 *(uint16_t *)0x0800 = 0x7777; // these two are a-star-specific
168 // Shift / paren setup
171 #define LSPO_KEY KC_9
174 #define RSPC_KEY KC_0
177 // Shift / Enter setup
179 #define SFTENT_KEY KC_ENT
182 static bool shift_interrupted[2] = {0, 0};
183 static uint16_t scs_timer[2] = {0, 0};
185 /* true if the last press of GRAVE_ESC was shifted (i.e. GUI or SHIFT were pressed), false otherwise.
186 * Used to ensure that the correct keycode is released if the key is released.
188 static bool grave_esc_was_shifted = false;
190 bool process_record_quantum(keyrecord_t *record) {
192 /* This gets the keycode from the key pressed */
193 keypos_t key = record->event.key;
196 #if !defined(NO_ACTION_LAYER) && defined(PREVENT_STUCK_MODIFIERS)
197 /* TODO: Use store_or_get_action() or a similar function. */
198 if (!disable_action_cache) {
201 if (record->event.pressed) {
202 layer = layer_switch_get_layer(key);
203 update_source_layers_cache(key, layer);
205 layer = read_source_layers_cache(key);
207 keycode = keymap_key_to_keycode(layer, key);
210 keycode = keymap_key_to_keycode(layer_switch_get_layer(key), key);
212 // This is how you use actions here
213 // if (keycode == KC_LEAD) {
215 // action.code = ACTION_DEFAULT_LAYER_SET(0);
216 // process_action(record, action);
220 #ifdef TAP_DANCE_ENABLE
221 preprocess_tap_dance(keycode, record);
225 #if defined(KEY_LOCK_ENABLE)
226 // Must run first to be able to mask key_up events.
227 process_key_lock(&keycode, record) &&
229 #if defined(AUDIO_ENABLE) && defined(AUDIO_CLICKY)
230 process_clicky(keycode, record) &&
231 #endif //AUDIO_CLICKY
232 process_record_kb(keycode, record) &&
233 #if defined(RGB_MATRIX_ENABLE) && defined(RGB_MATRIX_KEYPRESSES)
234 process_rgb_matrix(keycode, record) &&
236 #if defined(MIDI_ENABLE) && defined(MIDI_ADVANCED)
237 process_midi(keycode, record) &&
240 process_audio(keycode, record) &&
243 process_steno(keycode, record) &&
245 #if ( defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))) && !defined(NO_MUSIC_MODE)
246 process_music(keycode, record) &&
248 #ifdef TAP_DANCE_ENABLE
249 process_tap_dance(keycode, record) &&
251 #ifndef DISABLE_LEADER
252 process_leader(keycode, record) &&
254 #ifndef DISABLE_CHORDING
255 process_chording(keycode, record) &&
258 process_combo(keycode, record) &&
260 #ifdef UNICODE_ENABLE
261 process_unicode(keycode, record) &&
264 process_ucis(keycode, record) &&
266 #ifdef PRINTING_ENABLE
267 process_printer(keycode, record) &&
269 #ifdef AUTO_SHIFT_ENABLE
270 process_auto_shift(keycode, record) &&
272 #ifdef UNICODEMAP_ENABLE
273 process_unicode_map(keycode, record) &&
275 #ifdef TERMINAL_ENABLE
276 process_terminal(keycode, record) &&
282 // Shift / paren setup
286 if (record->event.pressed) {
291 if (record->event.pressed) {
293 print("DEBUG: enabled.\n");
296 #ifdef FAUXCLICKY_ENABLE
298 if (record->event.pressed) {
303 if (record->event.pressed) {
308 if (record->event.pressed) {
313 #if defined(RGBLIGHT_ENABLE) || defined(RGB_MATRIX_ENABLE)
315 if (record->event.pressed) {
319 case RGB_MODE_FORWARD:
320 if (record->event.pressed) {
321 uint8_t shifted = get_mods() & (MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT));
323 rgblight_step_reverse();
330 case RGB_MODE_REVERSE:
331 if (record->event.pressed) {
332 uint8_t shifted = get_mods() & (MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT));
337 rgblight_step_reverse();
342 if (record->event.pressed) {
343 rgblight_increase_hue();
347 if (record->event.pressed) {
348 rgblight_decrease_hue();
352 if (record->event.pressed) {
353 rgblight_increase_sat();
357 if (record->event.pressed) {
358 rgblight_decrease_sat();
362 if (record->event.pressed) {
363 rgblight_increase_val();
367 if (record->event.pressed) {
368 rgblight_decrease_val();
372 if (record->event.pressed) {
373 rgblight_increase_speed();
377 if (record->event.pressed) {
378 rgblight_decrease_speed();
382 if (record->event.pressed) {
386 case RGB_MODE_BREATHE:
387 if (record->event.pressed) {
388 if ((2 <= rgblight_get_mode()) && (rgblight_get_mode() < 5)) {
395 case RGB_MODE_RAINBOW:
396 if (record->event.pressed) {
397 if ((6 <= rgblight_get_mode()) && (rgblight_get_mode() < 8)) {
405 if (record->event.pressed) {
406 if ((9 <= rgblight_get_mode()) && (rgblight_get_mode() < 14)) {
414 if (record->event.pressed) {
415 if ((15 <= rgblight_get_mode()) && (rgblight_get_mode() < 20)) {
422 case RGB_MODE_KNIGHT:
423 if (record->event.pressed) {
424 if ((21 <= rgblight_get_mode()) && (rgblight_get_mode() < 23)) {
432 if (record->event.pressed) {
436 case RGB_MODE_GRADIENT:
437 if (record->event.pressed) {
438 if ((25 <= rgblight_get_mode()) && (rgblight_get_mode() < 34)) {
445 case RGB_MODE_RGBTEST:
446 if (record->event.pressed) {
450 #endif // defined(RGBLIGHT_ENABLE) || defined(RGB_MATRIX_ENABLE)
453 if (record->event.pressed) {
454 set_output(OUTPUT_AUTO);
458 if (record->event.pressed) {
459 set_output(OUTPUT_USB);
462 #ifdef BLUETOOTH_ENABLE
464 if (record->event.pressed) {
465 set_output(OUTPUT_BLUETOOTH);
470 case MAGIC_SWAP_CONTROL_CAPSLOCK ... MAGIC_TOGGLE_NKRO:
471 if (record->event.pressed) {
472 // MAGIC actions (BOOTMAGIC without the boot)
473 if (!eeconfig_is_enabled()) {
477 keymap_config.raw = eeconfig_read_keymap();
480 case MAGIC_SWAP_CONTROL_CAPSLOCK:
481 keymap_config.swap_control_capslock = true;
483 case MAGIC_CAPSLOCK_TO_CONTROL:
484 keymap_config.capslock_to_control = true;
486 case MAGIC_SWAP_LALT_LGUI:
487 keymap_config.swap_lalt_lgui = true;
489 case MAGIC_SWAP_RALT_RGUI:
490 keymap_config.swap_ralt_rgui = true;
493 keymap_config.no_gui = true;
495 case MAGIC_SWAP_GRAVE_ESC:
496 keymap_config.swap_grave_esc = true;
498 case MAGIC_SWAP_BACKSLASH_BACKSPACE:
499 keymap_config.swap_backslash_backspace = true;
501 case MAGIC_HOST_NKRO:
502 keymap_config.nkro = true;
504 case MAGIC_SWAP_ALT_GUI:
505 keymap_config.swap_lalt_lgui = true;
506 keymap_config.swap_ralt_rgui = true;
508 PLAY_SONG(ag_swap_song);
511 case MAGIC_UNSWAP_CONTROL_CAPSLOCK:
512 keymap_config.swap_control_capslock = false;
514 case MAGIC_UNCAPSLOCK_TO_CONTROL:
515 keymap_config.capslock_to_control = false;
517 case MAGIC_UNSWAP_LALT_LGUI:
518 keymap_config.swap_lalt_lgui = false;
520 case MAGIC_UNSWAP_RALT_RGUI:
521 keymap_config.swap_ralt_rgui = false;
524 keymap_config.no_gui = false;
526 case MAGIC_UNSWAP_GRAVE_ESC:
527 keymap_config.swap_grave_esc = false;
529 case MAGIC_UNSWAP_BACKSLASH_BACKSPACE:
530 keymap_config.swap_backslash_backspace = false;
532 case MAGIC_UNHOST_NKRO:
533 keymap_config.nkro = false;
535 case MAGIC_UNSWAP_ALT_GUI:
536 keymap_config.swap_lalt_lgui = false;
537 keymap_config.swap_ralt_rgui = false;
539 PLAY_SONG(ag_norm_song);
542 case MAGIC_TOGGLE_NKRO:
543 keymap_config.nkro = !keymap_config.nkro;
548 eeconfig_update_keymap(keymap_config.raw);
549 clear_keyboard(); // clear to prevent stuck keys
555 if (record->event.pressed) {
556 shift_interrupted[0] = false;
557 scs_timer[0] = timer_read ();
558 register_mods(MOD_BIT(KC_LSFT));
561 #ifdef DISABLE_SPACE_CADET_ROLLOVER
562 if (get_mods() & MOD_BIT(KC_RSFT)) {
563 shift_interrupted[0] = true;
564 shift_interrupted[1] = true;
567 if (!shift_interrupted[0] && timer_elapsed(scs_timer[0]) < TAPPING_TERM) {
568 register_code(LSPO_KEY);
569 unregister_code(LSPO_KEY);
571 unregister_mods(MOD_BIT(KC_LSFT));
577 if (record->event.pressed) {
578 shift_interrupted[1] = false;
579 scs_timer[1] = timer_read ();
580 register_mods(MOD_BIT(KC_RSFT));
583 #ifdef DISABLE_SPACE_CADET_ROLLOVER
584 if (get_mods() & MOD_BIT(KC_LSFT)) {
585 shift_interrupted[0] = true;
586 shift_interrupted[1] = true;
589 if (!shift_interrupted[1] && timer_elapsed(scs_timer[1]) < TAPPING_TERM) {
590 register_code(RSPC_KEY);
591 unregister_code(RSPC_KEY);
593 unregister_mods(MOD_BIT(KC_RSFT));
599 if (record->event.pressed) {
600 shift_interrupted[1] = false;
601 scs_timer[1] = timer_read ();
602 register_mods(MOD_BIT(KC_RSFT));
604 else if (!shift_interrupted[1] && timer_elapsed(scs_timer[1]) < TAPPING_TERM) {
605 unregister_mods(MOD_BIT(KC_RSFT));
606 register_code(SFTENT_KEY);
607 unregister_code(SFTENT_KEY);
610 unregister_mods(MOD_BIT(KC_RSFT));
616 uint8_t shifted = get_mods() & ((MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT)
617 |MOD_BIT(KC_LGUI)|MOD_BIT(KC_RGUI)));
619 #ifdef GRAVE_ESC_ALT_OVERRIDE
620 // if ALT is pressed, ESC is always sent
621 // this is handy for the cmd+opt+esc shortcut on macOS, among other things.
622 if (get_mods() & (MOD_BIT(KC_LALT) | MOD_BIT(KC_RALT))) {
627 #ifdef GRAVE_ESC_CTRL_OVERRIDE
628 // if CTRL is pressed, ESC is always sent
629 // this is handy for the ctrl+shift+esc shortcut on windows, among other things.
630 if (get_mods() & (MOD_BIT(KC_LCTL) | MOD_BIT(KC_RCTL))) {
635 #ifdef GRAVE_ESC_GUI_OVERRIDE
636 // if GUI is pressed, ESC is always sent
637 if (get_mods() & (MOD_BIT(KC_LGUI) | MOD_BIT(KC_RGUI))) {
642 #ifdef GRAVE_ESC_SHIFT_OVERRIDE
643 // if SHIFT is pressed, ESC is always sent
644 if (get_mods() & (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT))) {
649 if (record->event.pressed) {
650 grave_esc_was_shifted = shifted;
651 add_key(shifted ? KC_GRAVE : KC_ESCAPE);
654 del_key(grave_esc_was_shifted ? KC_GRAVE : KC_ESCAPE);
657 send_keyboard_report();
661 #if defined(BACKLIGHT_ENABLE) && defined(BACKLIGHT_BREATHING)
663 if (record->event.pressed)
670 shift_interrupted[0] = true;
671 shift_interrupted[1] = true;
676 return process_action_kb(record);
679 __attribute__ ((weak))
680 const bool ascii_to_shift_lut[0x80] PROGMEM = {
681 0, 0, 0, 0, 0, 0, 0, 0,
682 0, 0, 0, 0, 0, 0, 0, 0,
683 0, 0, 0, 0, 0, 0, 0, 0,
684 0, 0, 0, 0, 0, 0, 0, 0,
685 0, 1, 1, 1, 1, 1, 1, 0,
686 1, 1, 1, 1, 0, 0, 0, 0,
687 0, 0, 0, 0, 0, 0, 0, 0,
688 0, 0, 1, 0, 1, 0, 1, 1,
689 1, 1, 1, 1, 1, 1, 1, 1,
690 1, 1, 1, 1, 1, 1, 1, 1,
691 1, 1, 1, 1, 1, 1, 1, 1,
692 1, 1, 1, 0, 0, 0, 1, 1,
693 0, 0, 0, 0, 0, 0, 0, 0,
694 0, 0, 0, 0, 0, 0, 0, 0,
695 0, 0, 0, 0, 0, 0, 0, 0,
696 0, 0, 0, 1, 1, 1, 1, 0
699 __attribute__ ((weak))
700 const uint8_t ascii_to_keycode_lut[0x80] PROGMEM = {
701 0, 0, 0, 0, 0, 0, 0, 0,
702 KC_BSPC, KC_TAB, KC_ENT, 0, 0, 0, 0, 0,
703 0, 0, 0, 0, 0, 0, 0, 0,
704 0, 0, 0, KC_ESC, 0, 0, 0, 0,
705 KC_SPC, KC_1, KC_QUOT, KC_3, KC_4, KC_5, KC_7, KC_QUOT,
706 KC_9, KC_0, KC_8, KC_EQL, KC_COMM, KC_MINS, KC_DOT, KC_SLSH,
707 KC_0, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7,
708 KC_8, KC_9, KC_SCLN, KC_SCLN, KC_COMM, KC_EQL, KC_DOT, KC_SLSH,
709 KC_2, KC_A, KC_B, KC_C, KC_D, KC_E, KC_F, KC_G,
710 KC_H, KC_I, KC_J, KC_K, KC_L, KC_M, KC_N, KC_O,
711 KC_P, KC_Q, KC_R, KC_S, KC_T, KC_U, KC_V, KC_W,
712 KC_X, KC_Y, KC_Z, KC_LBRC, KC_BSLS, KC_RBRC, KC_6, KC_MINS,
713 KC_GRV, KC_A, KC_B, KC_C, KC_D, KC_E, KC_F, KC_G,
714 KC_H, KC_I, KC_J, KC_K, KC_L, KC_M, KC_N, KC_O,
715 KC_P, KC_Q, KC_R, KC_S, KC_T, KC_U, KC_V, KC_W,
716 KC_X, KC_Y, KC_Z, KC_LBRC, KC_BSLS, KC_RBRC, KC_GRV, KC_DEL
719 void send_string(const char *str) {
720 send_string_with_delay(str, 0);
723 void send_string_P(const char *str) {
724 send_string_with_delay_P(str, 0);
727 void send_string_with_delay(const char *str, uint8_t interval) {
729 char ascii_code = *str;
730 if (!ascii_code) break;
731 if (ascii_code == 1) {
733 uint8_t keycode = *(++str);
734 register_code(keycode);
735 unregister_code(keycode);
736 } else if (ascii_code == 2) {
738 uint8_t keycode = *(++str);
739 register_code(keycode);
740 } else if (ascii_code == 3) {
742 uint8_t keycode = *(++str);
743 unregister_code(keycode);
745 send_char(ascii_code);
749 { uint8_t ms = interval; while (ms--) wait_ms(1); }
753 void send_string_with_delay_P(const char *str, uint8_t interval) {
755 char ascii_code = pgm_read_byte(str);
756 if (!ascii_code) break;
757 if (ascii_code == 1) {
759 uint8_t keycode = pgm_read_byte(++str);
760 register_code(keycode);
761 unregister_code(keycode);
762 } else if (ascii_code == 2) {
764 uint8_t keycode = pgm_read_byte(++str);
765 register_code(keycode);
766 } else if (ascii_code == 3) {
768 uint8_t keycode = pgm_read_byte(++str);
769 unregister_code(keycode);
771 send_char(ascii_code);
775 { uint8_t ms = interval; while (ms--) wait_ms(1); }
779 void send_char(char ascii_code) {
781 keycode = pgm_read_byte(&ascii_to_keycode_lut[(uint8_t)ascii_code]);
782 if (pgm_read_byte(&ascii_to_shift_lut[(uint8_t)ascii_code])) {
783 register_code(KC_LSFT);
784 register_code(keycode);
785 unregister_code(keycode);
786 unregister_code(KC_LSFT);
788 register_code(keycode);
789 unregister_code(keycode);
793 void set_single_persistent_default_layer(uint8_t default_layer) {
794 #if defined(AUDIO_ENABLE) && defined(DEFAULT_LAYER_SONGS)
795 PLAY_SONG(default_layer_songs[default_layer]);
797 eeconfig_update_default_layer(1U<<default_layer);
798 default_layer_set(1U<<default_layer);
801 uint32_t update_tri_layer_state(uint32_t state, uint8_t layer1, uint8_t layer2, uint8_t layer3) {
802 uint32_t mask12 = (1UL << layer1) | (1UL << layer2);
803 uint32_t mask3 = 1UL << layer3;
804 return (state & mask12) == mask12 ? (state | mask3) : (state & ~mask3);
807 void update_tri_layer(uint8_t layer1, uint8_t layer2, uint8_t layer3) {
808 layer_state_set(update_tri_layer_state(layer_state, layer1, layer2, layer3));
811 void tap_random_base64(void) {
812 #if defined(__AVR_ATmega32U4__)
813 uint8_t key = (TCNT0 + TCNT1 + TCNT3 + TCNT4) % 64;
815 uint8_t key = rand() % 64;
819 register_code(KC_LSFT);
820 register_code(key + KC_A);
821 unregister_code(key + KC_A);
822 unregister_code(KC_LSFT);
825 register_code(key - 26 + KC_A);
826 unregister_code(key - 26 + KC_A);
830 unregister_code(KC_0);
833 register_code(key - 53 + KC_1);
834 unregister_code(key - 53 + KC_1);
837 register_code(KC_LSFT);
838 register_code(KC_EQL);
839 unregister_code(KC_EQL);
840 unregister_code(KC_LSFT);
843 register_code(KC_SLSH);
844 unregister_code(KC_SLSH);
849 void matrix_init_quantum() {
850 #ifdef BACKLIGHT_ENABLE
851 backlight_init_ports();
856 #ifdef RGB_MATRIX_ENABLE
862 uint8_t rgb_matrix_task_counter = 0;
864 #ifndef RGB_MATRIX_SKIP_FRAMES
865 #define RGB_MATRIX_SKIP_FRAMES 1
868 void matrix_scan_quantum() {
869 #if defined(AUDIO_ENABLE)
873 #ifdef TAP_DANCE_ENABLE
874 matrix_scan_tap_dance();
881 #if defined(BACKLIGHT_ENABLE) && defined(BACKLIGHT_PIN)
885 #ifdef RGB_MATRIX_ENABLE
887 if (rgb_matrix_task_counter == 0) {
888 rgb_matrix_update_pwm_buffers();
890 rgb_matrix_task_counter = ((rgb_matrix_task_counter + 1) % (RGB_MATRIX_SKIP_FRAMES + 1));
895 #if defined(BACKLIGHT_ENABLE) && defined(BACKLIGHT_PIN)
897 static const uint8_t backlight_pin = BACKLIGHT_PIN;
899 // depending on the pin, we use a different output compare unit
900 #if BACKLIGHT_PIN == B7
901 # define COM1x1 COM1C1
903 #elif BACKLIGHT_PIN == B6
904 # define COM1x1 COM1B1
906 #elif BACKLIGHT_PIN == B5
907 # define COM1x1 COM1A1
910 # define NO_HARDWARE_PWM
913 #ifndef BACKLIGHT_ON_STATE
914 #define BACKLIGHT_ON_STATE 0
917 #ifdef NO_HARDWARE_PWM // pwm through software
919 __attribute__ ((weak))
920 void backlight_init_ports(void)
922 // Setup backlight pin as output and output to on state.
924 _SFR_IO8((backlight_pin >> 4) + 1) |= _BV(backlight_pin & 0xF);
925 #if BACKLIGHT_ON_STATE == 0
927 _SFR_IO8((backlight_pin >> 4) + 2) &= ~_BV(backlight_pin & 0xF);
930 _SFR_IO8((backlight_pin >> 4) + 2) |= _BV(backlight_pin & 0xF);
934 __attribute__ ((weak))
935 void backlight_set(uint8_t level) {}
937 uint8_t backlight_tick = 0;
939 #ifndef BACKLIGHT_CUSTOM_DRIVER
940 void backlight_task(void) {
941 if ((0xFFFF >> ((BACKLIGHT_LEVELS - get_backlight_level()) * ((BACKLIGHT_LEVELS + 1) / 2))) & (1 << backlight_tick)) {
942 #if BACKLIGHT_ON_STATE == 0
944 _SFR_IO8((backlight_pin >> 4) + 2) &= ~_BV(backlight_pin & 0xF);
947 _SFR_IO8((backlight_pin >> 4) + 2) |= _BV(backlight_pin & 0xF);
950 #if BACKLIGHT_ON_STATE == 0
952 _SFR_IO8((backlight_pin >> 4) + 2) |= _BV(backlight_pin & 0xF);
955 _SFR_IO8((backlight_pin >> 4) + 2) &= ~_BV(backlight_pin & 0xF);
958 backlight_tick = (backlight_tick + 1) % 16;
962 #ifdef BACKLIGHT_BREATHING
963 #ifndef BACKLIGHT_CUSTOM_DRIVER
964 #error "Backlight breathing only available with hardware PWM. Please disable."
968 #else // pwm through timer
970 #define TIMER_TOP 0xFFFFU
972 // See http://jared.geek.nz/2013/feb/linear-led-pwm
973 static uint16_t cie_lightness(uint16_t v) {
974 if (v <= 5243) // if below 8% of max
975 return v / 9; // same as dividing by 900%
977 uint32_t y = (((uint32_t) v + 10486) << 8) / (10486 + 0xFFFFUL); // add 16% of max and compare
978 // to get a useful result with integer division, we shift left in the expression above
979 // and revert what we've done again after squaring.
981 if (y > 0xFFFFUL) // prevent overflow
988 // range for val is [0..TIMER_TOP]. PWM pin is high while the timer count is below val.
989 static inline void set_pwm(uint16_t val) {
993 #ifndef BACKLIGHT_CUSTOM_DRIVER
994 __attribute__ ((weak))
995 void backlight_set(uint8_t level) {
996 if (level > BACKLIGHT_LEVELS)
997 level = BACKLIGHT_LEVELS;
1000 // Turn off PWM control on backlight pin
1001 TCCR1A &= ~(_BV(COM1x1));
1003 // Turn on PWM control of backlight pin
1004 TCCR1A |= _BV(COM1x1);
1006 // Set the brightness
1007 set_pwm(cie_lightness(TIMER_TOP * (uint32_t)level / BACKLIGHT_LEVELS));
1010 void backlight_task(void) {}
1011 #endif // BACKLIGHT_CUSTOM_DRIVER
1013 #ifdef BACKLIGHT_BREATHING
1015 #define BREATHING_NO_HALT 0
1016 #define BREATHING_HALT_OFF 1
1017 #define BREATHING_HALT_ON 2
1018 #define BREATHING_STEPS 128
1020 static uint8_t breathing_period = BREATHING_PERIOD;
1021 static uint8_t breathing_halt = BREATHING_NO_HALT;
1022 static uint16_t breathing_counter = 0;
1024 bool is_breathing(void) {
1025 return !!(TIMSK1 & _BV(TOIE1));
1028 #define breathing_interrupt_enable() do {TIMSK1 |= _BV(TOIE1);} while (0)
1029 #define breathing_interrupt_disable() do {TIMSK1 &= ~_BV(TOIE1);} while (0)
1030 #define breathing_min() do {breathing_counter = 0;} while (0)
1031 #define breathing_max() do {breathing_counter = breathing_period * 244 / 2;} while (0)
1033 void breathing_enable(void)
1035 breathing_counter = 0;
1036 breathing_halt = BREATHING_NO_HALT;
1037 breathing_interrupt_enable();
1040 void breathing_pulse(void)
1042 if (get_backlight_level() == 0)
1046 breathing_halt = BREATHING_HALT_ON;
1047 breathing_interrupt_enable();
1050 void breathing_disable(void)
1052 breathing_interrupt_disable();
1053 // Restore backlight level
1054 backlight_set(get_backlight_level());
1057 void breathing_self_disable(void)
1059 if (get_backlight_level() == 0)
1060 breathing_halt = BREATHING_HALT_OFF;
1062 breathing_halt = BREATHING_HALT_ON;
1065 void breathing_toggle(void) {
1067 breathing_disable();
1072 void breathing_period_set(uint8_t value)
1076 breathing_period = value;
1079 void breathing_period_default(void) {
1080 breathing_period_set(BREATHING_PERIOD);
1083 void breathing_period_inc(void)
1085 breathing_period_set(breathing_period+1);
1088 void breathing_period_dec(void)
1090 breathing_period_set(breathing_period-1);
1093 /* To generate breathing curve in python:
1094 * from math import sin, pi; [int(sin(x/128.0*pi)**4*255) for x in range(128)]
1096 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};
1098 // Use this before the cie_lightness function.
1099 static inline uint16_t scale_backlight(uint16_t v) {
1100 return v / BACKLIGHT_LEVELS * get_backlight_level();
1103 /* Assuming a 16MHz CPU clock and a timer that resets at 64k (ICR1), the following interrupt handler will run
1104 * about 244 times per second.
1106 ISR(TIMER1_OVF_vect)
1108 uint16_t interval = (uint16_t) breathing_period * 244 / BREATHING_STEPS;
1109 // resetting after one period to prevent ugly reset at overflow.
1110 breathing_counter = (breathing_counter + 1) % (breathing_period * 244);
1111 uint8_t index = breathing_counter / interval % BREATHING_STEPS;
1113 if (((breathing_halt == BREATHING_HALT_ON) && (index == BREATHING_STEPS / 2)) ||
1114 ((breathing_halt == BREATHING_HALT_OFF) && (index == BREATHING_STEPS - 1)))
1116 breathing_interrupt_disable();
1119 set_pwm(cie_lightness(scale_backlight((uint16_t) pgm_read_byte(&breathing_table[index]) * 0x0101U)));
1122 #endif // BACKLIGHT_BREATHING
1124 __attribute__ ((weak))
1125 void backlight_init_ports(void)
1127 // Setup backlight pin as output and output to on state.
1129 _SFR_IO8((backlight_pin >> 4) + 1) |= _BV(backlight_pin & 0xF);
1130 #if BACKLIGHT_ON_STATE == 0
1132 _SFR_IO8((backlight_pin >> 4) + 2) &= ~_BV(backlight_pin & 0xF);
1135 _SFR_IO8((backlight_pin >> 4) + 2) |= _BV(backlight_pin & 0xF);
1137 // I could write a wall of text here to explain... but TL;DW
1138 // Go read the ATmega32u4 datasheet.
1139 // And this: http://blog.saikoled.com/post/43165849837/secret-konami-cheat-code-to-high-resolution-pwm-on
1141 // Pin PB7 = OCR1C (Timer 1, Channel C)
1142 // Compare Output Mode = Clear on compare match, Channel C = COM1C1=1 COM1C0=0
1143 // (i.e. start high, go low when counter matches.)
1144 // WGM Mode 14 (Fast PWM) = WGM13=1 WGM12=1 WGM11=1 WGM10=0
1145 // Clock Select = clk/1 (no prescaling) = CS12=0 CS11=0 CS10=1
1149 "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 [..]."
1150 "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)."
1153 TCCR1A = _BV(COM1x1) | _BV(WGM11); // = 0b00001010;
1154 TCCR1B = _BV(WGM13) | _BV(WGM12) | _BV(CS10); // = 0b00011001;
1155 // Use full 16-bit resolution. Counter counts to ICR1 before reset to 0.
1159 #ifdef BACKLIGHT_BREATHING
1164 #endif // NO_HARDWARE_PWM
1168 __attribute__ ((weak))
1169 void backlight_init_ports(void) {}
1171 __attribute__ ((weak))
1172 void backlight_set(uint8_t level) {}
1177 // Functions for spitting out values
1180 void send_dword(uint32_t number) { // this might not actually work
1181 uint16_t word = (number >> 16);
1183 send_word(number & 0xFFFFUL);
1186 void send_word(uint16_t number) {
1187 uint8_t byte = number >> 8;
1189 send_byte(number & 0xFF);
1192 void send_byte(uint8_t number) {
1193 uint8_t nibble = number >> 4;
1194 send_nibble(nibble);
1195 send_nibble(number & 0xF);
1198 void send_nibble(uint8_t number) {
1201 register_code(KC_0);
1202 unregister_code(KC_0);
1205 register_code(KC_1 + (number - 1));
1206 unregister_code(KC_1 + (number - 1));
1209 register_code(KC_A + (number - 0xA));
1210 unregister_code(KC_A + (number - 0xA));
1216 __attribute__((weak))
1217 uint16_t hex_to_keycode(uint8_t hex)
1222 } else if (hex < 0xA) {
1223 return KC_1 + (hex - 0x1);
1225 return KC_A + (hex - 0xA);
1229 void api_send_unicode(uint32_t unicode) {
1232 dword_to_bytes(unicode, chunk);
1233 MT_SEND_DATA(DT_UNICODE, chunk, 5);
1237 __attribute__ ((weak))
1238 void led_set_user(uint8_t usb_led) {
1242 __attribute__ ((weak))
1243 void led_set_kb(uint8_t usb_led) {
1244 led_set_user(usb_led);
1247 __attribute__ ((weak))
1248 void led_init_ports(void)
1253 __attribute__ ((weak))
1254 void led_set(uint8_t usb_led)
1259 // // Using PE6 Caps Lock LED
1260 // if (usb_led & (1<<USB_LED_CAPS_LOCK))
1270 // PORTE &= ~(1<<6);
1273 led_set_kb(usb_led);
1277 //------------------------------------------------------------------------------
1278 // Override these functions in your keymap file to play different tunes on
1279 // different events such as startup and bootloader jump
1281 __attribute__ ((weak))
1282 void startup_user() {}
1284 __attribute__ ((weak))
1285 void shutdown_user() {}
1287 //------------------------------------------------------------------------------