396 lines
11 KiB
C
396 lines
11 KiB
C
/* Copyright 2016-2018 Erez Zukerman, Jack Humbert, Yiancar
|
|
*
|
|
* 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/>.
|
|
*/
|
|
#pragma once
|
|
|
|
#if defined(__AVR__)
|
|
# include <avr/pgmspace.h>
|
|
# include <avr/io.h>
|
|
# include <avr/interrupt.h>
|
|
#endif
|
|
#if defined(PROTOCOL_CHIBIOS)
|
|
# include <hal.h>
|
|
# include "chibios_config.h"
|
|
#endif
|
|
|
|
#include "wait.h"
|
|
#include "matrix.h"
|
|
#include "keymap.h"
|
|
|
|
#ifdef BACKLIGHT_ENABLE
|
|
# ifdef LED_MATRIX_ENABLE
|
|
# include "led_matrix.h"
|
|
# else
|
|
# include "backlight.h"
|
|
# endif
|
|
#endif
|
|
|
|
#if defined(RGBLIGHT_ENABLE)
|
|
# include "rgblight.h"
|
|
#elif defined(RGB_MATRIX_ENABLE)
|
|
// Dummy define RGBLIGHT_MODE_xxxx
|
|
# define RGBLIGHT_H_DUMMY_DEFINE
|
|
# include "rgblight.h"
|
|
#endif
|
|
|
|
#ifdef RGB_MATRIX_ENABLE
|
|
# include "rgb_matrix.h"
|
|
#endif
|
|
|
|
#include "action_layer.h"
|
|
#include "eeconfig.h"
|
|
#include "bootloader.h"
|
|
#include "timer.h"
|
|
#include "sync_timer.h"
|
|
#include "config_common.h"
|
|
#include "led.h"
|
|
#include "action_util.h"
|
|
#include "action_tapping.h"
|
|
#include "print.h"
|
|
#include "send_string_keycodes.h"
|
|
#include "suspend.h"
|
|
#include <stddef.h>
|
|
#include <stdlib.h>
|
|
|
|
extern layer_state_t default_layer_state;
|
|
|
|
#ifndef NO_ACTION_LAYER
|
|
extern layer_state_t layer_state;
|
|
#endif
|
|
|
|
#if defined(SEQUENCER_ENABLE)
|
|
# include "sequencer.h"
|
|
# include "process_sequencer.h"
|
|
#endif
|
|
|
|
#if defined(MIDI_ENABLE) && defined(MIDI_ADVANCED)
|
|
# include "process_midi.h"
|
|
#endif
|
|
|
|
#ifdef AUDIO_ENABLE
|
|
# include "audio.h"
|
|
# include "process_audio.h"
|
|
# ifdef AUDIO_CLICKY
|
|
# include "process_clicky.h"
|
|
# endif
|
|
#endif
|
|
|
|
#ifdef STENO_ENABLE
|
|
# include "process_steno.h"
|
|
#endif
|
|
|
|
#if defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
|
|
# include "process_music.h"
|
|
#endif
|
|
|
|
#ifdef BACKLIGHT_ENABLE
|
|
# include "process_backlight.h"
|
|
#endif
|
|
|
|
#ifdef LEADER_ENABLE
|
|
# include "process_leader.h"
|
|
#endif
|
|
|
|
#ifdef UNICODE_ENABLE
|
|
# include "process_unicode.h"
|
|
#endif
|
|
|
|
#ifdef UCIS_ENABLE
|
|
# include "process_ucis.h"
|
|
#endif
|
|
|
|
#ifdef UNICODEMAP_ENABLE
|
|
# include "process_unicodemap.h"
|
|
#endif
|
|
|
|
#ifdef TAP_DANCE_ENABLE
|
|
# include "process_tap_dance.h"
|
|
#endif
|
|
|
|
#ifdef PRINTING_ENABLE
|
|
# include "process_printer.h"
|
|
#endif
|
|
|
|
#ifdef AUTO_SHIFT_ENABLE
|
|
# include "process_auto_shift.h"
|
|
#endif
|
|
|
|
#ifdef COMBO_ENABLE
|
|
# include "process_combo.h"
|
|
#endif
|
|
|
|
#ifdef KEY_LOCK_ENABLE
|
|
# include "process_key_lock.h"
|
|
#endif
|
|
|
|
#ifdef TERMINAL_ENABLE
|
|
# include "process_terminal.h"
|
|
#else
|
|
# include "process_terminal_nop.h"
|
|
#endif
|
|
|
|
#ifdef SPACE_CADET_ENABLE
|
|
# include "process_space_cadet.h"
|
|
#endif
|
|
|
|
#ifdef MAGIC_KEYCODE_ENABLE
|
|
# include "process_magic.h"
|
|
#endif
|
|
|
|
#ifdef JOYSTICK_ENABLE
|
|
# include "process_joystick.h"
|
|
#endif
|
|
|
|
#ifdef GRAVE_ESC_ENABLE
|
|
# include "process_grave_esc.h"
|
|
#endif
|
|
|
|
#if defined(RGBLIGHT_ENABLE) || defined(RGB_MATRIX_ENABLE)
|
|
# include "process_rgb.h"
|
|
#endif
|
|
|
|
#ifdef HD44780_ENABLE
|
|
# include "hd44780.h"
|
|
#endif
|
|
|
|
#ifdef HAPTIC_ENABLE
|
|
# include "haptic.h"
|
|
#endif
|
|
|
|
#ifdef OLED_DRIVER_ENABLE
|
|
# include "oled_driver.h"
|
|
#endif
|
|
|
|
#ifdef DIP_SWITCH_ENABLE
|
|
# include "dip_switch.h"
|
|
#endif
|
|
|
|
#ifdef DYNAMIC_MACRO_ENABLE
|
|
# include "process_dynamic_macro.h"
|
|
#endif
|
|
|
|
#ifdef DYNAMIC_KEYMAP_ENABLE
|
|
# include "dynamic_keymap.h"
|
|
#endif
|
|
|
|
#ifdef VIA_ENABLE
|
|
# include "via.h"
|
|
#endif
|
|
|
|
#ifdef WPM_ENABLE
|
|
# include "wpm.h"
|
|
#endif
|
|
|
|
// Function substitutions to ease GPIO manipulation
|
|
#if defined(__AVR__)
|
|
typedef uint8_t pin_t;
|
|
|
|
# define setPinInput(pin) (DDRx_ADDRESS(pin) &= ~_BV((pin)&0xF), PORTx_ADDRESS(pin) &= ~_BV((pin)&0xF))
|
|
# define setPinInputHigh(pin) (DDRx_ADDRESS(pin) &= ~_BV((pin)&0xF), PORTx_ADDRESS(pin) |= _BV((pin)&0xF))
|
|
# define setPinInputLow(pin) _Static_assert(0, "AVR processors cannot implement an input as pull low")
|
|
# define setPinOutput(pin) (DDRx_ADDRESS(pin) |= _BV((pin)&0xF))
|
|
|
|
# define writePinHigh(pin) (PORTx_ADDRESS(pin) |= _BV((pin)&0xF))
|
|
# define writePinLow(pin) (PORTx_ADDRESS(pin) &= ~_BV((pin)&0xF))
|
|
# define writePin(pin, level) ((level) ? writePinHigh(pin) : writePinLow(pin))
|
|
|
|
# define readPin(pin) ((bool)(PINx_ADDRESS(pin) & _BV((pin)&0xF)))
|
|
|
|
# define togglePin(pin) (PORTx_ADDRESS(pin) ^= _BV((pin)&0xF))
|
|
|
|
/* The AVR series GPIOs have a one clock read delay for changes in the digital input signal.
|
|
* But here's more margin to make it two clocks. */
|
|
# if !defined(GPIO_INPUT_PIN_DELAY)
|
|
# define GPIO_INPUT_PIN_DELAY 2
|
|
# endif
|
|
# define waitInputPinDelay() wait_cpuclock(GPIO_INPUT_PIN_DELAY)
|
|
|
|
#elif defined(PROTOCOL_CHIBIOS)
|
|
typedef ioline_t pin_t;
|
|
|
|
# define setPinInput(pin) palSetLineMode(pin, PAL_MODE_INPUT)
|
|
# define setPinInputHigh(pin) palSetLineMode(pin, PAL_MODE_INPUT_PULLUP)
|
|
# define setPinInputLow(pin) palSetLineMode(pin, PAL_MODE_INPUT_PULLDOWN)
|
|
# define setPinOutput(pin) palSetLineMode(pin, PAL_MODE_OUTPUT_PUSHPULL)
|
|
|
|
# define writePinHigh(pin) palSetLine(pin)
|
|
# define writePinLow(pin) palClearLine(pin)
|
|
# define writePin(pin, level) ((level) ? (writePinHigh(pin)) : (writePinLow(pin)))
|
|
|
|
# define readPin(pin) palReadLine(pin)
|
|
|
|
# define togglePin(pin) palToggleLine(pin)
|
|
|
|
#endif
|
|
|
|
#if defined(__ARMEL__) || defined(__ARMEB__)
|
|
/* For GPIOs on ARM-based MCUs, the input pins are sampled by the clock of the bus
|
|
* to which the GPIO is connected.
|
|
* The connected buses differ depending on the various series of MCUs.
|
|
* And since the instruction execution clock of the CPU and the bus clock of GPIO are different,
|
|
* there is a delay of several clocks to read the change of the input signal.
|
|
*
|
|
* Define this delay with the GPIO_INPUT_PIN_DELAY macro.
|
|
* If the GPIO_INPUT_PIN_DELAY macro is not defined, the following default values will be used.
|
|
* (A fairly large value of 0.25 microseconds is set.)
|
|
*/
|
|
# if !defined(GPIO_INPUT_PIN_DELAY)
|
|
# if defined(STM32_SYSCLK)
|
|
# define GPIO_INPUT_PIN_DELAY (STM32_SYSCLK / 1000000L / 4)
|
|
# elif defined(KINETIS_SYSCLK_FREQUENCY)
|
|
# define GPIO_INPUT_PIN_DELAY (KINETIS_SYSCLK_FREQUENCY / 1000000L / 4)
|
|
# endif
|
|
# endif
|
|
# define waitInputPinDelay() wait_cpuclock(GPIO_INPUT_PIN_DELAY)
|
|
#endif
|
|
|
|
// Atomic macro to help make GPIO and other controls atomic.
|
|
#ifdef IGNORE_ATOMIC_BLOCK
|
|
/* do nothing atomic macro */
|
|
# define ATOMIC_BLOCK for (uint8_t __ToDo = 1; __ToDo; __ToDo = 0)
|
|
# define ATOMIC_BLOCK_RESTORESTATE ATOMIC_BLOCK
|
|
# define ATOMIC_BLOCK_FORCEON ATOMIC_BLOCK
|
|
|
|
#elif defined(__AVR__)
|
|
/* atomic macro for AVR */
|
|
# include <util/atomic.h>
|
|
|
|
# define ATOMIC_BLOCK_RESTORESTATE ATOMIC_BLOCK(ATOMIC_RESTORESTATE)
|
|
# define ATOMIC_BLOCK_FORCEON ATOMIC_BLOCK(ATOMIC_FORCEON)
|
|
|
|
#elif defined(PROTOCOL_CHIBIOS) || defined(PROTOCOL_ARM_ATSAM)
|
|
/* atomic macro for ChibiOS / ARM ATSAM */
|
|
# if defined(PROTOCOL_ARM_ATSAM)
|
|
# include "arm_atsam_protocol.h"
|
|
# endif
|
|
|
|
static __inline__ uint8_t __interrupt_disable__(void) {
|
|
# if defined(PROTOCOL_CHIBIOS)
|
|
chSysLock();
|
|
# endif
|
|
# if defined(PROTOCOL_ARM_ATSAM)
|
|
__disable_irq();
|
|
# endif
|
|
return 1;
|
|
}
|
|
|
|
static __inline__ void __interrupt_enable__(const uint8_t *__s) {
|
|
# if defined(PROTOCOL_CHIBIOS)
|
|
chSysUnlock();
|
|
# endif
|
|
# if defined(PROTOCOL_ARM_ATSAM)
|
|
__enable_irq();
|
|
# endif
|
|
__asm__ volatile("" ::: "memory");
|
|
(void)__s;
|
|
}
|
|
|
|
# define ATOMIC_BLOCK(type) for (type, __ToDo = __interrupt_disable__(); __ToDo; __ToDo = 0)
|
|
# define ATOMIC_FORCEON uint8_t sreg_save __attribute__((__cleanup__(__interrupt_enable__))) = 0
|
|
|
|
# define ATOMIC_BLOCK_RESTORESTATE _Static_assert(0, "ATOMIC_BLOCK_RESTORESTATE dose not implement")
|
|
# define ATOMIC_BLOCK_FORCEON ATOMIC_BLOCK(ATOMIC_FORCEON)
|
|
|
|
/* Other platform */
|
|
#else
|
|
|
|
# define ATOMIC_BLOCK_RESTORESTATE _Static_assert(0, "ATOMIC_BLOCK_RESTORESTATE dose not implement")
|
|
# define ATOMIC_BLOCK_FORCEON _Static_assert(0, "ATOMIC_BLOCK_FORCEON dose not implement")
|
|
|
|
#endif
|
|
|
|
#define SEND_STRING(string) send_string_P(PSTR(string))
|
|
#define SEND_STRING_DELAY(string, interval) send_string_with_delay_P(PSTR(string), interval)
|
|
|
|
// Look-Up Tables (LUTs) to convert ASCII character to keycode sequence.
|
|
extern const uint8_t ascii_to_keycode_lut[128];
|
|
extern const uint8_t ascii_to_shift_lut[16];
|
|
extern const uint8_t ascii_to_altgr_lut[16];
|
|
extern const uint8_t ascii_to_dead_lut[16];
|
|
// clang-format off
|
|
#define KCLUT_ENTRY(a, b, c, d, e, f, g, h) \
|
|
( ((a) ? 1 : 0) << 0 \
|
|
| ((b) ? 1 : 0) << 1 \
|
|
| ((c) ? 1 : 0) << 2 \
|
|
| ((d) ? 1 : 0) << 3 \
|
|
| ((e) ? 1 : 0) << 4 \
|
|
| ((f) ? 1 : 0) << 5 \
|
|
| ((g) ? 1 : 0) << 6 \
|
|
| ((h) ? 1 : 0) << 7 )
|
|
// clang-format on
|
|
|
|
void send_string(const char *str);
|
|
void send_string_with_delay(const char *str, uint8_t interval);
|
|
void send_string_P(const char *str);
|
|
void send_string_with_delay_P(const char *str, uint8_t interval);
|
|
void send_char(char ascii_code);
|
|
|
|
// For tri-layer
|
|
void update_tri_layer(uint8_t layer1, uint8_t layer2, uint8_t layer3);
|
|
layer_state_t update_tri_layer_state(layer_state_t state, uint8_t layer1, uint8_t layer2, uint8_t layer3);
|
|
|
|
void set_single_persistent_default_layer(uint8_t default_layer);
|
|
|
|
void tap_random_base64(void);
|
|
|
|
#define IS_LAYER_ON(layer) layer_state_is(layer)
|
|
#define IS_LAYER_OFF(layer) !layer_state_is(layer)
|
|
|
|
#define IS_LAYER_ON_STATE(state, layer) layer_state_cmp(state, layer)
|
|
#define IS_LAYER_OFF_STATE(state, layer) !layer_state_cmp(state, layer)
|
|
|
|
void matrix_init_kb(void);
|
|
void matrix_scan_kb(void);
|
|
void matrix_init_user(void);
|
|
void matrix_scan_user(void);
|
|
uint16_t get_record_keycode(keyrecord_t *record, bool update_layer_cache);
|
|
uint16_t get_event_keycode(keyevent_t event, bool update_layer_cache);
|
|
bool process_action_kb(keyrecord_t *record);
|
|
bool process_record_kb(uint16_t keycode, keyrecord_t *record);
|
|
bool process_record_user(uint16_t keycode, keyrecord_t *record);
|
|
void post_process_record_kb(uint16_t keycode, keyrecord_t *record);
|
|
void post_process_record_user(uint16_t keycode, keyrecord_t *record);
|
|
|
|
#ifndef BOOTMAGIC_LITE_COLUMN
|
|
# define BOOTMAGIC_LITE_COLUMN 0
|
|
#endif
|
|
#ifndef BOOTMAGIC_LITE_ROW
|
|
# define BOOTMAGIC_LITE_ROW 0
|
|
#endif
|
|
|
|
void bootmagic_lite(void);
|
|
|
|
void reset_keyboard(void);
|
|
|
|
void startup_user(void);
|
|
void shutdown_user(void);
|
|
|
|
void register_code16(uint16_t code);
|
|
void unregister_code16(uint16_t code);
|
|
void tap_code16(uint16_t code);
|
|
|
|
void send_dword(uint32_t number);
|
|
void send_word(uint16_t number);
|
|
void send_byte(uint8_t number);
|
|
void send_nibble(uint8_t number);
|
|
uint16_t hex_to_keycode(uint8_t hex);
|
|
|
|
void led_set_user(uint8_t usb_led);
|
|
void led_set_kb(uint8_t usb_led);
|
|
bool led_update_user(led_t led_state);
|
|
bool led_update_kb(led_t led_state);
|
|
|
|
void api_send_unicode(uint32_t unicode);
|