+/* Copyright 2016-2017 Jack Humbert
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
#include "quantum.h"
#ifdef PROTOCOL_LUFA
#include "outputselect.h"
#define TAPPING_TERM 200
#endif
+#ifndef BREATHING_PERIOD
+#define BREATHING_PERIOD 6
+#endif
+
#include "backlight.h"
extern backlight_config_t backlight_config;
#include "fauxclicky.h"
#endif
+#ifdef API_ENABLE
+#include "api.h"
+#endif
+
+#ifdef MIDI_ENABLE
+#include "process_midi.h"
+#endif
+
+#ifdef AUDIO_ENABLE
+ #ifndef GOODBYE_SONG
+ #define GOODBYE_SONG SONG(GOODBYE_SOUND)
+ #endif
+ #ifndef AG_NORM_SONG
+ #define AG_NORM_SONG SONG(AG_NORM_SOUND)
+ #endif
+ #ifndef AG_SWAP_SONG
+ #define AG_SWAP_SONG SONG(AG_SWAP_SOUND)
+ #endif
+ float goodbye_song[][2] = GOODBYE_SONG;
+ float ag_norm_song[][2] = AG_NORM_SONG;
+ float ag_swap_song[][2] = AG_SWAP_SONG;
+ #ifdef DEFAULT_LAYER_SONGS
+ float default_layer_songs[][16][2] = DEFAULT_LAYER_SONGS;
+ #endif
+#endif
+
static void do_code16 (uint16_t code, void (*f) (uint8_t)) {
switch (code) {
case QK_MODS ... QK_MODS_MAX:
void reset_keyboard(void) {
clear_keyboard();
-#ifdef AUDIO_ENABLE
- stop_all_notes();
- shutdown_user();
+#if defined(MIDI_ENABLE) && defined(MIDI_BASIC)
+ process_midi_all_notes_off();
#endif
+#if defined(AUDIO_ENABLE) && !defined(NO_MUSIC_MODE)
+ music_all_notes_off();
+ uint16_t timer_start = timer_read();
+ PLAY_SONG(goodbye_song);
+ shutdown_user();
+ while(timer_elapsed(timer_start) < 250)
+ wait_ms(1);
+ stop_all_notes();
+#else
wait_ms(250);
-#ifdef CATERINA_BOOTLOADER
+#endif
+// this is also done later in bootloader.c - not sure if it's neccesary here
+#ifdef BOOTLOADER_CATERINA
*(uint16_t *)0x0800 = 0x7777; // these two are a-star-specific
#endif
bootloader_jump();
#define RSPC_KEY KC_0
#endif
+// Shift / Enter setup
+#ifndef SFTENT_KEY
+ #define SFTENT_KEY KC_ENT
+#endif
+
static bool shift_interrupted[2] = {0, 0};
-static uint16_t scs_timer = 0;
+static uint16_t scs_timer[2] = {0, 0};
+
+/* true if the last press of GRAVE_ESC was shifted (i.e. GUI or SHIFT were pressed), false otherwise.
+ * Used to ensure that the correct keycode is released if the key is released.
+ */
+static bool grave_esc_was_shifted = false;
bool process_record_quantum(keyrecord_t *record) {
// return false;
// }
+ #ifdef TAP_DANCE_ENABLE
+ preprocess_tap_dance(keycode, record);
+ #endif
+
if (!(
+ #if defined(KEY_LOCK_ENABLE)
+ // Must run first to be able to mask key_up events.
+ process_key_lock(&keycode, record) &&
+ #endif
+ #if defined(AUDIO_ENABLE) && defined(AUDIO_CLICKY)
+ process_clicky(keycode, record) &&
+ #endif //AUDIO_CLICKY
process_record_kb(keycode, record) &&
- #ifdef MIDI_ENABLE
+ #if defined(RGB_MATRIX_ENABLE) && defined(RGB_MATRIX_KEYPRESSES)
+ process_rgb_matrix(keycode, record) &&
+ #endif
+ #if defined(MIDI_ENABLE) && defined(MIDI_ADVANCED)
process_midi(keycode, record) &&
#endif
#ifdef AUDIO_ENABLE
+ process_audio(keycode, record) &&
+ #endif
+ #ifdef STENO_ENABLE
+ process_steno(keycode, record) &&
+ #endif
+ #if ( defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))) && !defined(NO_MUSIC_MODE)
process_music(keycode, record) &&
#endif
#ifdef TAP_DANCE_ENABLE
#ifdef PRINTING_ENABLE
process_printer(keycode, record) &&
#endif
+ #ifdef AUTO_SHIFT_ENABLE
+ process_auto_shift(keycode, record) &&
+ #endif
#ifdef UNICODEMAP_ENABLE
process_unicode_map(keycode, record) &&
+ #endif
+ #ifdef TERMINAL_ENABLE
+ process_terminal(keycode, record) &&
#endif
true)) {
return false;
if (record->event.pressed) {
reset_keyboard();
}
- return false;
- break;
+ return false;
case DEBUG:
if (record->event.pressed) {
- print("\nDEBUG: enabled.\n");
debug_enable = true;
+ print("DEBUG: enabled.\n");
}
- return false;
- break;
+ return false;
#ifdef FAUXCLICKY_ENABLE
case FC_TOG:
if (record->event.pressed) {
FAUXCLICKY_TOGGLE;
}
return false;
- break;
case FC_ON:
if (record->event.pressed) {
FAUXCLICKY_ON;
}
return false;
- break;
case FC_OFF:
if (record->event.pressed) {
FAUXCLICKY_OFF;
}
return false;
- break;
#endif
- #ifdef RGBLIGHT_ENABLE
- case RGB_TOG:
- if (record->event.pressed) {
- rgblight_toggle();
+ #if defined(RGBLIGHT_ENABLE) || defined(RGB_MATRIX_ENABLE)
+ case RGB_TOG:
+ if (record->event.pressed) {
+ rgblight_toggle();
+ }
+ return false;
+ case RGB_MODE_FORWARD:
+ if (record->event.pressed) {
+ uint8_t shifted = get_mods() & (MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT));
+ if(shifted) {
+ rgblight_step_reverse();
}
- return false;
- break;
- case RGB_MOD:
- if (record->event.pressed) {
- rgblight_step();
+ else {
+ rgblight_step();
}
- return false;
- break;
- case RGB_HUI:
- if (record->event.pressed) {
- rgblight_increase_hue();
+ }
+ return false;
+ case RGB_MODE_REVERSE:
+ if (record->event.pressed) {
+ uint8_t shifted = get_mods() & (MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT));
+ if(shifted) {
+ rgblight_step();
}
- return false;
- break;
- case RGB_HUD:
- if (record->event.pressed) {
- rgblight_decrease_hue();
+ else {
+ rgblight_step_reverse();
}
- return false;
- break;
- case RGB_SAI:
- if (record->event.pressed) {
- rgblight_increase_sat();
+ }
+ return false;
+ case RGB_HUI:
+ if (record->event.pressed) {
+ rgblight_increase_hue();
+ }
+ return false;
+ case RGB_HUD:
+ if (record->event.pressed) {
+ rgblight_decrease_hue();
+ }
+ return false;
+ case RGB_SAI:
+ if (record->event.pressed) {
+ rgblight_increase_sat();
+ }
+ return false;
+ case RGB_SAD:
+ if (record->event.pressed) {
+ rgblight_decrease_sat();
+ }
+ return false;
+ case RGB_VAI:
+ if (record->event.pressed) {
+ rgblight_increase_val();
+ }
+ return false;
+ case RGB_VAD:
+ if (record->event.pressed) {
+ rgblight_decrease_val();
+ }
+ return false;
+ case RGB_MODE_PLAIN:
+ if (record->event.pressed) {
+ rgblight_mode(1);
+ }
+ return false;
+ case RGB_MODE_BREATHE:
+ if (record->event.pressed) {
+ if ((2 <= rgblight_get_mode()) && (rgblight_get_mode() < 5)) {
+ rgblight_step();
+ } else {
+ rgblight_mode(2);
}
- return false;
- break;
- case RGB_SAD:
- if (record->event.pressed) {
- rgblight_decrease_sat();
+ }
+ return false;
+ case RGB_MODE_RAINBOW:
+ if (record->event.pressed) {
+ if ((6 <= rgblight_get_mode()) && (rgblight_get_mode() < 8)) {
+ rgblight_step();
+ } else {
+ rgblight_mode(6);
}
- return false;
- break;
- case RGB_VAI:
- if (record->event.pressed) {
- rgblight_increase_val();
+ }
+ return false;
+ case RGB_MODE_SWIRL:
+ if (record->event.pressed) {
+ if ((9 <= rgblight_get_mode()) && (rgblight_get_mode() < 14)) {
+ rgblight_step();
+ } else {
+ rgblight_mode(9);
}
- return false;
- break;
- case RGB_VAD:
- if (record->event.pressed) {
- rgblight_decrease_val();
+ }
+ return false;
+ case RGB_MODE_SNAKE:
+ if (record->event.pressed) {
+ if ((15 <= rgblight_get_mode()) && (rgblight_get_mode() < 20)) {
+ rgblight_step();
+ } else {
+ rgblight_mode(15);
}
- return false;
- break;
- #endif
+ }
+ return false;
+ case RGB_MODE_KNIGHT:
+ if (record->event.pressed) {
+ if ((21 <= rgblight_get_mode()) && (rgblight_get_mode() < 23)) {
+ rgblight_step();
+ } else {
+ rgblight_mode(21);
+ }
+ }
+ return false;
+ case RGB_MODE_XMAS:
+ if (record->event.pressed) {
+ rgblight_mode(24);
+ }
+ return false;
+ case RGB_MODE_GRADIENT:
+ if (record->event.pressed) {
+ if ((25 <= rgblight_get_mode()) && (rgblight_get_mode() < 34)) {
+ rgblight_step();
+ } else {
+ rgblight_mode(25);
+ }
+ }
+ return false;
+ #endif
#ifdef PROTOCOL_LUFA
case OUT_AUTO:
if (record->event.pressed) {
set_output(OUTPUT_AUTO);
}
return false;
- break;
case OUT_USB:
if (record->event.pressed) {
set_output(OUTPUT_USB);
}
return false;
- break;
#ifdef BLUETOOTH_ENABLE
case OUT_BT:
if (record->event.pressed) {
set_output(OUTPUT_BLUETOOTH);
}
return false;
- break;
#endif
#endif
case MAGIC_SWAP_CONTROL_CAPSLOCK ... MAGIC_TOGGLE_NKRO:
case MAGIC_SWAP_ALT_GUI:
keymap_config.swap_lalt_lgui = true;
keymap_config.swap_ralt_rgui = true;
+ #ifdef AUDIO_ENABLE
+ PLAY_SONG(ag_swap_song);
+ #endif
break;
case MAGIC_UNSWAP_CONTROL_CAPSLOCK:
keymap_config.swap_control_capslock = false;
case MAGIC_UNSWAP_ALT_GUI:
keymap_config.swap_lalt_lgui = false;
keymap_config.swap_ralt_rgui = false;
+ #ifdef AUDIO_ENABLE
+ PLAY_SONG(ag_norm_song);
+ #endif
break;
case MAGIC_TOGGLE_NKRO:
keymap_config.nkro = !keymap_config.nkro;
case KC_LSPO: {
if (record->event.pressed) {
shift_interrupted[0] = false;
- scs_timer = timer_read ();
+ scs_timer[0] = timer_read ();
register_mods(MOD_BIT(KC_LSFT));
}
else {
shift_interrupted[1] = true;
}
#endif
- if (!shift_interrupted[0] && timer_elapsed(scs_timer) < TAPPING_TERM) {
+ if (!shift_interrupted[0] && timer_elapsed(scs_timer[0]) < TAPPING_TERM) {
register_code(LSPO_KEY);
unregister_code(LSPO_KEY);
}
unregister_mods(MOD_BIT(KC_LSFT));
}
return false;
- // break;
}
case KC_RSPC: {
if (record->event.pressed) {
shift_interrupted[1] = false;
- scs_timer = timer_read ();
+ scs_timer[1] = timer_read ();
register_mods(MOD_BIT(KC_RSFT));
}
else {
shift_interrupted[1] = true;
}
#endif
- if (!shift_interrupted[1] && timer_elapsed(scs_timer) < TAPPING_TERM) {
+ if (!shift_interrupted[1] && timer_elapsed(scs_timer[1]) < TAPPING_TERM) {
register_code(RSPC_KEY);
unregister_code(RSPC_KEY);
}
unregister_mods(MOD_BIT(KC_RSFT));
}
return false;
- // break;
}
+
+ case KC_SFTENT: {
+ if (record->event.pressed) {
+ shift_interrupted[1] = false;
+ scs_timer[1] = timer_read ();
+ register_mods(MOD_BIT(KC_RSFT));
+ }
+ else if (!shift_interrupted[1] && timer_elapsed(scs_timer[1]) < TAPPING_TERM) {
+ unregister_mods(MOD_BIT(KC_RSFT));
+ register_code(SFTENT_KEY);
+ unregister_code(SFTENT_KEY);
+ }
+ else {
+ unregister_mods(MOD_BIT(KC_RSFT));
+ }
+ return false;
+ }
+
+ case GRAVE_ESC: {
+ uint8_t shifted = get_mods() & ((MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT)
+ |MOD_BIT(KC_LGUI)|MOD_BIT(KC_RGUI)));
+
+#ifdef GRAVE_ESC_ALT_OVERRIDE
+ // if ALT is pressed, ESC is always sent
+ // this is handy for the cmd+opt+esc shortcut on macOS, among other things.
+ if (get_mods() & (MOD_BIT(KC_LALT) | MOD_BIT(KC_RALT))) {
+ shifted = 0;
+ }
+#endif
+
+#ifdef GRAVE_ESC_CTRL_OVERRIDE
+ // if CTRL is pressed, ESC is always sent
+ // this is handy for the ctrl+shift+esc shortcut on windows, among other things.
+ if (get_mods() & (MOD_BIT(KC_LCTL) | MOD_BIT(KC_RCTL))) {
+ shifted = 0;
+ }
+#endif
+
+#ifdef GRAVE_ESC_GUI_OVERRIDE
+ // if GUI is pressed, ESC is always sent
+ if (get_mods() & (MOD_BIT(KC_LGUI) | MOD_BIT(KC_RGUI))) {
+ shifted = 0;
+ }
+#endif
+
+#ifdef GRAVE_ESC_SHIFT_OVERRIDE
+ // if SHIFT is pressed, ESC is always sent
+ if (get_mods() & (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT))) {
+ shifted = 0;
+ }
+#endif
+
+ if (record->event.pressed) {
+ grave_esc_was_shifted = shifted;
+ add_key(shifted ? KC_GRAVE : KC_ESCAPE);
+ }
+ else {
+ del_key(grave_esc_was_shifted ? KC_GRAVE : KC_ESCAPE);
+ }
+
+ send_keyboard_report();
+ return false;
+ }
+
+#if defined(BACKLIGHT_ENABLE) && defined(BACKLIGHT_BREATHING)
+ case BL_BRTG: {
+ if (record->event.pressed)
+ breathing_toggle();
+ return false;
+ }
+#endif
+
default: {
shift_interrupted[0] = true;
shift_interrupted[1] = true;
return process_action_kb(record);
}
-const bool ascii_to_qwerty_shift_lut[0x80] PROGMEM = {
+__attribute__ ((weak))
+const bool ascii_to_shift_lut[0x80] PROGMEM = {
0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 1, 1, 1, 1, 0
};
-const uint8_t ascii_to_qwerty_keycode_lut[0x80] PROGMEM = {
+__attribute__ ((weak))
+const uint8_t ascii_to_keycode_lut[0x80] PROGMEM = {
0, 0, 0, 0, 0, 0, 0, 0,
KC_BSPC, KC_TAB, KC_ENT, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0,
KC_X, KC_Y, KC_Z, KC_LBRC, KC_BSLS, KC_RBRC, KC_GRV, KC_DEL
};
-/* for users whose OSes are set to Colemak */
-#if 0
-#include "keymap_colemak.h"
-
-const bool ascii_to_colemak_shift_lut[0x80] PROGMEM = {
- 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 1, 1, 1, 1, 1, 1, 0,
- 1, 1, 1, 1, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 1, 0, 1, 0, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 1, 1, 1, 1, 1,
- 1, 1, 1, 0, 0, 0, 1, 1,
- 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, 1, 1, 1, 1, 0
-};
-
-const uint8_t ascii_to_colemak_keycode_lut[0x80] PROGMEM = {
- 0, 0, 0, 0, 0, 0, 0, 0,
- KC_BSPC, KC_TAB, KC_ENT, 0, 0, 0, 0, 0,
- 0, 0, 0, 0, 0, 0, 0, 0,
- 0, 0, 0, KC_ESC, 0, 0, 0, 0,
- KC_SPC, KC_1, KC_QUOT, KC_3, KC_4, KC_5, KC_7, KC_QUOT,
- KC_9, KC_0, KC_8, KC_EQL, KC_COMM, KC_MINS, KC_DOT, KC_SLSH,
- KC_0, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7,
- KC_8, KC_9, CM_SCLN, CM_SCLN, KC_COMM, KC_EQL, KC_DOT, KC_SLSH,
- KC_2, CM_A, CM_B, CM_C, CM_D, CM_E, CM_F, CM_G,
- CM_H, CM_I, CM_J, CM_K, CM_L, CM_M, CM_N, CM_O,
- CM_P, CM_Q, CM_R, CM_S, CM_T, CM_U, CM_V, CM_W,
- CM_X, CM_Y, CM_Z, KC_LBRC, KC_BSLS, KC_RBRC, KC_6, KC_MINS,
- KC_GRV, CM_A, CM_B, CM_C, CM_D, CM_E, CM_F, CM_G,
- CM_H, CM_I, CM_J, CM_K, CM_L, CM_M, CM_N, CM_O,
- CM_P, CM_Q, CM_R, CM_S, CM_T, CM_U, CM_V, CM_W,
- CM_X, CM_Y, CM_Z, KC_LBRC, KC_BSLS, KC_RBRC, KC_GRV, KC_DEL
-};
+void send_string(const char *str) {
+ send_string_with_delay(str, 0);
+}
-#endif
+void send_string_P(const char *str) {
+ send_string_with_delay_P(str, 0);
+}
-void send_string(const char *str) {
+void send_string_with_delay(const char *str, uint8_t interval) {
while (1) {
- uint8_t keycode;
- uint8_t ascii_code = pgm_read_byte(str);
+ char ascii_code = *str;
if (!ascii_code) break;
- keycode = pgm_read_byte(&ascii_to_qwerty_keycode_lut[ascii_code]);
- if (pgm_read_byte(&ascii_to_qwerty_shift_lut[ascii_code])) {
- register_code(KC_LSFT);
- register_code(keycode);
- unregister_code(keycode);
- unregister_code(KC_LSFT);
+ if (ascii_code == 1) {
+ // tap
+ uint8_t keycode = *(++str);
+ register_code(keycode);
+ unregister_code(keycode);
+ } else if (ascii_code == 2) {
+ // down
+ uint8_t keycode = *(++str);
+ register_code(keycode);
+ } else if (ascii_code == 3) {
+ // up
+ uint8_t keycode = *(++str);
+ unregister_code(keycode);
+ } else {
+ send_char(ascii_code);
}
- else {
- register_code(keycode);
- unregister_code(keycode);
+ ++str;
+ // interval
+ { uint8_t ms = interval; while (ms--) wait_ms(1); }
+ }
+}
+
+void send_string_with_delay_P(const char *str, uint8_t interval) {
+ while (1) {
+ char ascii_code = pgm_read_byte(str);
+ if (!ascii_code) break;
+ if (ascii_code == 1) {
+ // tap
+ uint8_t keycode = pgm_read_byte(++str);
+ register_code(keycode);
+ unregister_code(keycode);
+ } else if (ascii_code == 2) {
+ // down
+ uint8_t keycode = pgm_read_byte(++str);
+ register_code(keycode);
+ } else if (ascii_code == 3) {
+ // up
+ uint8_t keycode = pgm_read_byte(++str);
+ unregister_code(keycode);
+ } else {
+ send_char(ascii_code);
}
++str;
+ // interval
+ { uint8_t ms = interval; while (ms--) wait_ms(1); }
}
}
-void update_tri_layer(uint8_t layer1, uint8_t layer2, uint8_t layer3) {
- if (IS_LAYER_ON(layer1) && IS_LAYER_ON(layer2)) {
- layer_on(layer3);
+void send_char(char ascii_code) {
+ uint8_t keycode;
+ keycode = pgm_read_byte(&ascii_to_keycode_lut[(uint8_t)ascii_code]);
+ if (pgm_read_byte(&ascii_to_shift_lut[(uint8_t)ascii_code])) {
+ register_code(KC_LSFT);
+ register_code(keycode);
+ unregister_code(keycode);
+ unregister_code(KC_LSFT);
} else {
- layer_off(layer3);
+ register_code(keycode);
+ unregister_code(keycode);
}
}
+void set_single_persistent_default_layer(uint8_t default_layer) {
+ #if defined(AUDIO_ENABLE) && defined(DEFAULT_LAYER_SONGS)
+ PLAY_SONG(default_layer_songs[default_layer]);
+ #endif
+ eeconfig_update_default_layer(1U<<default_layer);
+ default_layer_set(1U<<default_layer);
+}
+
+uint32_t update_tri_layer_state(uint32_t state, uint8_t layer1, uint8_t layer2, uint8_t layer3) {
+ uint32_t mask12 = (1UL << layer1) | (1UL << layer2);
+ uint32_t mask3 = 1UL << layer3;
+ return (state & mask12) == mask12 ? (state | mask3) : (state & ~mask3);
+}
+
+void update_tri_layer(uint8_t layer1, uint8_t layer2, uint8_t layer3) {
+ layer_state_set(update_tri_layer_state(layer_state, layer1, layer2, layer3));
+}
+
void tap_random_base64(void) {
#if defined(__AVR_ATmega32U4__)
uint8_t key = (TCNT0 + TCNT1 + TCNT3 + TCNT4) % 64;
#ifdef BACKLIGHT_ENABLE
backlight_init_ports();
#endif
+ #ifdef AUDIO_ENABLE
+ audio_init();
+ #endif
+ #ifdef RGB_MATRIX_ENABLE
+ rgb_matrix_init_drivers();
+ #endif
matrix_init_kb();
}
+uint8_t rgb_matrix_task_counter = 0;
+
+#ifndef RGB_MATRIX_SKIP_FRAMES
+ #define RGB_MATRIX_SKIP_FRAMES 1
+#endif
+
void matrix_scan_quantum() {
- #ifdef AUDIO_ENABLE
+ #if defined(AUDIO_ENABLE)
matrix_scan_music();
#endif
backlight_task();
#endif
+ #ifdef RGB_MATRIX_ENABLE
+ rgb_matrix_task();
+ if (rgb_matrix_task_counter == 0) {
+ rgb_matrix_update_pwm_buffers();
+ }
+ rgb_matrix_task_counter = ((rgb_matrix_task_counter + 1) % (RGB_MATRIX_SKIP_FRAMES + 1));
+ #endif
+
matrix_scan_kb();
}
-
#if defined(BACKLIGHT_ENABLE) && defined(BACKLIGHT_PIN)
static const uint8_t backlight_pin = BACKLIGHT_PIN;
+// depending on the pin, we use a different output compare unit
#if BACKLIGHT_PIN == B7
# define COM1x1 COM1C1
# define OCR1x OCR1C
# define COM1x1 COM1A1
# define OCR1x OCR1A
#else
-# define NO_BACKLIGHT_CLOCK
+# define NO_HARDWARE_PWM
#endif
#ifndef BACKLIGHT_ON_STATE
#define BACKLIGHT_ON_STATE 0
#endif
+#ifdef NO_HARDWARE_PWM // pwm through software
+
__attribute__ ((weak))
void backlight_init_ports(void)
{
-
// Setup backlight pin as output and output to on state.
// DDRx |= n
_SFR_IO8((backlight_pin >> 4) + 1) |= _BV(backlight_pin & 0xF);
// PORTx |= n
_SFR_IO8((backlight_pin >> 4) + 2) |= _BV(backlight_pin & 0xF);
#endif
-
- #ifndef NO_BACKLIGHT_CLOCK
- // Use full 16-bit resolution.
- ICR1 = 0xFFFF;
-
- // I could write a wall of text here to explain... but TL;DW
- // Go read the ATmega32u4 datasheet.
- // And this: http://blog.saikoled.com/post/43165849837/secret-konami-cheat-code-to-high-resolution-pwm-on
-
- // Pin PB7 = OCR1C (Timer 1, Channel C)
- // Compare Output Mode = Clear on compare match, Channel C = COM1C1=1 COM1C0=0
- // (i.e. start high, go low when counter matches.)
- // WGM Mode 14 (Fast PWM) = WGM13=1 WGM12=1 WGM11=1 WGM10=0
- // Clock Select = clk/1 (no prescaling) = CS12=0 CS11=0 CS10=1
-
- TCCR1A = _BV(COM1x1) | _BV(WGM11); // = 0b00001010;
- TCCR1B = _BV(WGM13) | _BV(WGM12) | _BV(CS10); // = 0b00011001;
- #endif
-
- backlight_init();
- #ifdef BACKLIGHT_BREATHING
- breathing_defaults();
- #endif
}
__attribute__ ((weak))
-void backlight_set(uint8_t level)
-{
- // Prevent backlight blink on lowest level
- // #if BACKLIGHT_ON_STATE == 0
- // // PORTx &= ~n
- // _SFR_IO8((backlight_pin >> 4) + 2) &= ~_BV(backlight_pin & 0xF);
- // #else
- // // PORTx |= n
- // _SFR_IO8((backlight_pin >> 4) + 2) |= _BV(backlight_pin & 0xF);
- // #endif
-
- if ( level == 0 ) {
- #ifndef NO_BACKLIGHT_CLOCK
- // Turn off PWM control on backlight pin, revert to output low.
- TCCR1A &= ~(_BV(COM1x1));
- OCR1x = 0x0;
- #else
- // #if BACKLIGHT_ON_STATE == 0
- // // PORTx |= n
- // _SFR_IO8((backlight_pin >> 4) + 2) |= _BV(backlight_pin & 0xF);
- // #else
- // // PORTx &= ~n
- // _SFR_IO8((backlight_pin >> 4) + 2) &= ~_BV(backlight_pin & 0xF);
- // #endif
- #endif
- }
- #ifndef NO_BACKLIGHT_CLOCK
- else if ( level == BACKLIGHT_LEVELS ) {
- // Turn on PWM control of backlight pin
- TCCR1A |= _BV(COM1x1);
- // Set the brightness
- OCR1x = 0xFFFF;
- }
- else {
- // Turn on PWM control of backlight pin
- TCCR1A |= _BV(COM1x1);
- // Set the brightness
- OCR1x = 0xFFFF >> ((BACKLIGHT_LEVELS - level) * ((BACKLIGHT_LEVELS + 1) / 2));
- }
- #endif
-
- #ifdef BACKLIGHT_BREATHING
- breathing_intensity_default();
- #endif
-}
+void backlight_set(uint8_t level) {}
uint8_t backlight_tick = 0;
+#ifndef BACKLIGHT_CUSTOM_DRIVER
void backlight_task(void) {
- #ifdef NO_BACKLIGHT_CLOCK
- if ((0xFFFF >> ((BACKLIGHT_LEVELS - backlight_config.level) * ((BACKLIGHT_LEVELS + 1) / 2))) & (1 << backlight_tick)) {
+ if ((0xFFFF >> ((BACKLIGHT_LEVELS - get_backlight_level()) * ((BACKLIGHT_LEVELS + 1) / 2))) & (1 << backlight_tick)) {
#if BACKLIGHT_ON_STATE == 0
// PORTx &= ~n
_SFR_IO8((backlight_pin >> 4) + 2) &= ~_BV(backlight_pin & 0xF);
#endif
}
backlight_tick = (backlight_tick + 1) % 16;
+}
+#endif
+
+#ifdef BACKLIGHT_BREATHING
+ #ifndef BACKLIGHT_CUSTOM_DRIVER
+ #error "Backlight breathing only available with hardware PWM. Please disable."
#endif
+#endif
+
+#else // pwm through timer
+
+#define TIMER_TOP 0xFFFFU
+
+// See http://jared.geek.nz/2013/feb/linear-led-pwm
+static uint16_t cie_lightness(uint16_t v) {
+ if (v <= 5243) // if below 8% of max
+ return v / 9; // same as dividing by 900%
+ else {
+ uint32_t y = (((uint32_t) v + 10486) << 8) / (10486 + 0xFFFFUL); // add 16% of max and compare
+ // to get a useful result with integer division, we shift left in the expression above
+ // and revert what we've done again after squaring.
+ y = y * y * y >> 8;
+ if (y > 0xFFFFUL) // prevent overflow
+ return 0xFFFFU;
+ else
+ return (uint16_t) y;
+ }
+}
+
+// range for val is [0..TIMER_TOP]. PWM pin is high while the timer count is below val.
+static inline void set_pwm(uint16_t val) {
+ OCR1x = val;
+}
+
+#ifndef BACKLIGHT_CUSTOM_DRIVER
+__attribute__ ((weak))
+void backlight_set(uint8_t level) {
+ if (level > BACKLIGHT_LEVELS)
+ level = BACKLIGHT_LEVELS;
+
+ if (level == 0) {
+ // Turn off PWM control on backlight pin
+ TCCR1A &= ~(_BV(COM1x1));
+ } else {
+ // Turn on PWM control of backlight pin
+ TCCR1A |= _BV(COM1x1);
+ }
+ // Set the brightness
+ set_pwm(cie_lightness(TIMER_TOP * (uint32_t)level / BACKLIGHT_LEVELS));
}
+void backlight_task(void) {}
+#endif // BACKLIGHT_CUSTOM_DRIVER
+
#ifdef BACKLIGHT_BREATHING
#define BREATHING_NO_HALT 0
#define BREATHING_HALT_OFF 1
#define BREATHING_HALT_ON 2
+#define BREATHING_STEPS 128
-static uint8_t breath_intensity;
-static uint8_t breath_speed;
-static uint16_t breathing_index;
-static uint8_t breathing_halt;
+static uint8_t breathing_period = BREATHING_PERIOD;
+static uint8_t breathing_halt = BREATHING_NO_HALT;
+static uint16_t breathing_counter = 0;
-void breathing_enable(void)
-{
- if (get_backlight_level() == 0)
- {
- breathing_index = 0;
- }
- else
- {
- // Set breathing_index to be at the midpoint (brightest point)
- breathing_index = 0x20 << breath_speed;
- }
+bool is_breathing(void) {
+ return !!(TIMSK1 & _BV(TOIE1));
+}
- breathing_halt = BREATHING_NO_HALT;
+#define breathing_interrupt_enable() do {TIMSK1 |= _BV(TOIE1);} while (0)
+#define breathing_interrupt_disable() do {TIMSK1 &= ~_BV(TOIE1);} while (0)
+#define breathing_min() do {breathing_counter = 0;} while (0)
+#define breathing_max() do {breathing_counter = breathing_period * 244 / 2;} while (0)
- // Enable breathing interrupt
- TIMSK1 |= _BV(OCIE1A);
+void breathing_enable(void)
+{
+ breathing_counter = 0;
+ breathing_halt = BREATHING_NO_HALT;
+ breathing_interrupt_enable();
}
void breathing_pulse(void)
{
if (get_backlight_level() == 0)
- {
- breathing_index = 0;
- }
+ breathing_min();
else
- {
- // Set breathing_index to be at the midpoint + 1 (brightest point)
- breathing_index = 0x21 << breath_speed;
- }
-
+ breathing_max();
breathing_halt = BREATHING_HALT_ON;
-
- // Enable breathing interrupt
- TIMSK1 |= _BV(OCIE1A);
+ breathing_interrupt_enable();
}
void breathing_disable(void)
{
- // Disable breathing interrupt
- TIMSK1 &= ~_BV(OCIE1A);
+ breathing_interrupt_disable();
+ // Restore backlight level
backlight_set(get_backlight_level());
}
void breathing_self_disable(void)
{
- if (get_backlight_level() == 0)
- {
- breathing_halt = BREATHING_HALT_OFF;
- }
- else
- {
- breathing_halt = BREATHING_HALT_ON;
- }
-
- //backlight_set(get_backlight_level());
+ if (get_backlight_level() == 0)
+ breathing_halt = BREATHING_HALT_OFF;
+ else
+ breathing_halt = BREATHING_HALT_ON;
}
-void breathing_toggle(void)
-{
- if (!is_breathing())
- {
- if (get_backlight_level() == 0)
- {
- breathing_index = 0;
- }
- else
- {
- // Set breathing_index to be at the midpoint + 1 (brightest point)
- breathing_index = 0x21 << breath_speed;
- }
-
- breathing_halt = BREATHING_NO_HALT;
- }
-
- // Toggle breathing interrupt
- TIMSK1 ^= _BV(OCIE1A);
-
- // Restore backlight level
- if (!is_breathing())
- {
- backlight_set(get_backlight_level());
- }
+void breathing_toggle(void) {
+ if (is_breathing())
+ breathing_disable();
+ else
+ breathing_enable();
}
-bool is_breathing(void)
+void breathing_period_set(uint8_t value)
{
- return (TIMSK1 && _BV(OCIE1A));
+ if (!value)
+ value = 1;
+ breathing_period = value;
}
-void breathing_intensity_default(void)
-{
- //breath_intensity = (uint8_t)((uint16_t)100 * (uint16_t)get_backlight_level() / (uint16_t)BACKLIGHT_LEVELS);
- breath_intensity = ((BACKLIGHT_LEVELS - get_backlight_level()) * ((BACKLIGHT_LEVELS + 1) / 2));
+void breathing_period_default(void) {
+ breathing_period_set(BREATHING_PERIOD);
}
-void breathing_intensity_set(uint8_t value)
+void breathing_period_inc(void)
{
- breath_intensity = value;
+ breathing_period_set(breathing_period+1);
}
-void breathing_speed_default(void)
+void breathing_period_dec(void)
{
- breath_speed = 4;
+ breathing_period_set(breathing_period-1);
}
-void breathing_speed_set(uint8_t value)
-{
- bool is_breathing_now = is_breathing();
- uint8_t old_breath_speed = breath_speed;
-
- if (is_breathing_now)
- {
- // Disable breathing interrupt
- TIMSK1 &= ~_BV(OCIE1A);
- }
-
- breath_speed = value;
-
- if (is_breathing_now)
- {
- // Adjust index to account for new speed
- breathing_index = (( (uint8_t)( (breathing_index) >> old_breath_speed ) ) & 0x3F) << breath_speed;
-
- // Enable breathing interrupt
- TIMSK1 |= _BV(OCIE1A);
- }
+/* To generate breathing curve in python:
+ * from math import sin, pi; [int(sin(x/128.0*pi)**4*255) for x in range(128)]
+ */
+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};
+// Use this before the cie_lightness function.
+static inline uint16_t scale_backlight(uint16_t v) {
+ return v / BACKLIGHT_LEVELS * get_backlight_level();
}
-void breathing_speed_inc(uint8_t value)
-{
- if ((uint16_t)(breath_speed - value) > 10 )
- {
- breathing_speed_set(0);
- }
- else
- {
- breathing_speed_set(breath_speed - value);
- }
-}
-
-void breathing_speed_dec(uint8_t value)
+/* Assuming a 16MHz CPU clock and a timer that resets at 64k (ICR1), the following interrupt handler will run
+ * about 244 times per second.
+ */
+ISR(TIMER1_OVF_vect)
{
- if ((uint16_t)(breath_speed + value) > 10 )
- {
- breathing_speed_set(10);
- }
- else
- {
- breathing_speed_set(breath_speed + value);
- }
-}
+ uint16_t interval = (uint16_t) breathing_period * 244 / BREATHING_STEPS;
+ // resetting after one period to prevent ugly reset at overflow.
+ breathing_counter = (breathing_counter + 1) % (breathing_period * 244);
+ uint8_t index = breathing_counter / interval % BREATHING_STEPS;
+
+ if (((breathing_halt == BREATHING_HALT_ON) && (index == BREATHING_STEPS / 2)) ||
+ ((breathing_halt == BREATHING_HALT_OFF) && (index == BREATHING_STEPS - 1)))
+ {
+ breathing_interrupt_disable();
+ }
-void breathing_defaults(void)
-{
- breathing_intensity_default();
- breathing_speed_default();
- breathing_halt = BREATHING_NO_HALT;
+ set_pwm(cie_lightness(scale_backlight((uint16_t) pgm_read_byte(&breathing_table[index]) * 0x0101U)));
}
-/* Breathing Sleep LED brighness(PWM On period) table
- * (64[steps] * 4[duration]) / 64[PWM periods/s] = 4 second breath cycle
- *
- * http://www.wolframalpha.com/input/?i=%28sin%28+x%2F64*pi%29**8+*+255%2C+x%3D0+to+63
- * (0..63).each {|x| p ((sin(x/64.0*PI)**8)*255).to_i }
- */
-static const uint8_t breathing_table[64] PROGMEM = {
- 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 2, 4, 6, 10,
- 15, 23, 32, 44, 58, 74, 93, 113, 135, 157, 179, 199, 218, 233, 245, 252,
-255, 252, 245, 233, 218, 199, 179, 157, 135, 113, 93, 74, 58, 44, 32, 23,
- 15, 10, 6, 4, 2, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
-};
+#endif // BACKLIGHT_BREATHING
-ISR(TIMER1_COMPA_vect)
+__attribute__ ((weak))
+void backlight_init_ports(void)
{
- // OCR1x = (pgm_read_byte(&breathing_table[ ( (uint8_t)( (breathing_index++) >> breath_speed ) ) & 0x3F ] )) * breath_intensity;
-
-
- uint8_t local_index = ( (uint8_t)( (breathing_index++) >> breath_speed ) ) & 0x3F;
-
- if (((breathing_halt == BREATHING_HALT_ON) && (local_index == 0x20)) || ((breathing_halt == BREATHING_HALT_OFF) && (local_index == 0x3F)))
- {
- // Disable breathing interrupt
- TIMSK1 &= ~_BV(OCIE1A);
- }
-
- OCR1x = (uint16_t)(((uint16_t)pgm_read_byte(&breathing_table[local_index]) * 257)) >> breath_intensity;
+ // Setup backlight pin as output and output to on state.
+ // DDRx |= n
+ _SFR_IO8((backlight_pin >> 4) + 1) |= _BV(backlight_pin & 0xF);
+ #if BACKLIGHT_ON_STATE == 0
+ // PORTx &= ~n
+ _SFR_IO8((backlight_pin >> 4) + 2) &= ~_BV(backlight_pin & 0xF);
+ #else
+ // PORTx |= n
+ _SFR_IO8((backlight_pin >> 4) + 2) |= _BV(backlight_pin & 0xF);
+ #endif
+ // I could write a wall of text here to explain... but TL;DW
+ // Go read the ATmega32u4 datasheet.
+ // And this: http://blog.saikoled.com/post/43165849837/secret-konami-cheat-code-to-high-resolution-pwm-on
+
+ // Pin PB7 = OCR1C (Timer 1, Channel C)
+ // Compare Output Mode = Clear on compare match, Channel C = COM1C1=1 COM1C0=0
+ // (i.e. start high, go low when counter matches.)
+ // WGM Mode 14 (Fast PWM) = WGM13=1 WGM12=1 WGM11=1 WGM10=0
+ // Clock Select = clk/1 (no prescaling) = CS12=0 CS11=0 CS10=1
+
+ /*
+ 14.8.3:
+ "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 [..]."
+ "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)."
+ */
+
+ TCCR1A = _BV(COM1x1) | _BV(WGM11); // = 0b00001010;
+ TCCR1B = _BV(WGM13) | _BV(WGM12) | _BV(CS10); // = 0b00011001;
+ // Use full 16-bit resolution. Counter counts to ICR1 before reset to 0.
+ ICR1 = TIMER_TOP;
+ backlight_init();
+ #ifdef BACKLIGHT_BREATHING
+ breathing_enable();
+ #endif
}
-
-
-#endif // breathing
+#endif // NO_HARDWARE_PWM
#else // backlight
__attribute__ ((weak))
-void backlight_init_ports(void)
-{
-
-}
+void backlight_init_ports(void) {}
__attribute__ ((weak))
-void backlight_set(uint8_t level)
-{
-
-}
+void backlight_set(uint8_t level) {}
#endif // backlight
__attribute__((weak))
uint16_t hex_to_keycode(uint8_t hex)
{
+ hex = hex & 0xF;
if (hex == 0x0) {
return KC_0;
} else if (hex < 0xA) {
projects / qmk_firmware.git / blobdiff