quantum/quantum.h

   1 /* Copyright 2016-2018 Erez Zukerman, Jack Humbert, Yiancar
   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 #ifndef QUANTUM_H
  17 #define QUANTUM_H
  18
  19 #if defined(__AVR__)
  20     #include <avr/pgmspace.h>
  21     #include <avr/io.h>
  22     #include <avr/interrupt.h>
  23 #endif
  24 #if defined(PROTOCOL_CHIBIOS)
  25     #include "hal.h"
  26 #endif
  27 #include "wait.h"
  28 #include "matrix.h"
  29 #include "keymap.h"
  30 #ifdef BACKLIGHT_ENABLE
  31     #include "backlight.h"
  32 #endif
  33 #if !defined(RGBLIGHT_ENABLE) && !defined(RGB_MATRIX_ENABLE)
  34         #include "rgb.h"
  35 #endif
  36 #ifdef RGBLIGHT_ENABLE
  37   #include "rgblight.h"
  38 #else
  39     #ifdef RGB_MATRIX_ENABLE
  40         /* dummy define RGBLIGHT_MODE_xxxx */
  41         #define RGBLIGHT_H_DUMMY_DEFINE
  42         #include "rgblight.h"
  43     #endif
  44 #endif
  45
  46 #ifdef SPLIT_KEYBOARD
  47     #include "split_flags.h"
  48 #endif
  49
  50 #ifdef RGB_MATRIX_ENABLE
  51     #include "rgb_matrix.h"
  52 #endif
  53
  54 #include "action_layer.h"
  55 #include "eeconfig.h"
  56 #include <stddef.h>
  57 #include "bootloader.h"
  58 #include "timer.h"
  59 #include "config_common.h"
  60 #include "led.h"
  61 #include "action_util.h"
  62 #include <stdlib.h>
  63 #include "print.h"
  64 #include "send_string_keycodes.h"
  65 #include "suspend.h"
  66
  67 extern uint32_t default_layer_state;
  68
  69 #ifndef NO_ACTION_LAYER
  70     extern uint32_t layer_state;
  71 #endif
  72
  73 #ifdef MIDI_ENABLE
  74 #ifdef MIDI_ADVANCED
  75     #include "process_midi.h"
  76 #endif
  77 #endif // MIDI_ENABLE
  78
  79 #ifdef AUDIO_ENABLE
  80     #include "audio.h"
  81     #include "process_audio.h"
  82     #ifdef AUDIO_CLICKY
  83         #include "process_clicky.h"
  84     #endif // AUDIO_CLICKY
  85 #endif
  86
  87 #ifdef STENO_ENABLE
  88     #include "process_steno.h"
  89 #endif
  90
  91 #if defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
  92     #include "process_music.h"
  93 #endif
  94
  95 #ifdef LEADER_ENABLE
  96     #include "process_leader.h"
  97 #endif
  98
  99 #ifdef UNICODE_ENABLE
 100     #include "process_unicode.h"
 101 #endif
 102
 103 #ifdef UCIS_ENABLE
 104     #include "process_ucis.h"
 105 #endif
 106
 107 #ifdef UNICODEMAP_ENABLE
 108     #include "process_unicodemap.h"
 109 #endif
 110
 111 #ifdef TAP_DANCE_ENABLE
 112   #include "process_tap_dance.h"
 113 #endif
 114
 115 #ifdef PRINTING_ENABLE
 116     #include "process_printer.h"
 117 #endif
 118
 119 #ifdef AUTO_SHIFT_ENABLE
 120     #include "process_auto_shift.h"
 121 #endif
 122
 123 #ifdef COMBO_ENABLE
 124     #include "process_combo.h"
 125 #endif
 126
 127 #ifdef KEY_LOCK_ENABLE
 128     #include "process_key_lock.h"
 129 #endif
 130
 131 #ifdef TERMINAL_ENABLE
 132     #include "process_terminal.h"
 133 #else
 134     #include "process_terminal_nop.h"
 135 #endif
 136
 137 #ifdef HD44780_ENABLE
 138     #include "hd44780.h"
 139 #endif
 140
 141 //Function substitutions to ease GPIO manipulation
 142 #ifdef __AVR__
 143     #define PIN_ADDRESS(p, offset) _SFR_IO8(ADDRESS_BASE + (p >> PORT_SHIFTER) + offset)
 144
 145     #define pin_t uint8_t
 146     #define setPinInput(pin) PIN_ADDRESS(pin, 1) &= ~ _BV(pin & 0xF)
 147     #define setPinInputHigh(pin) ({\
 148             PIN_ADDRESS(pin, 1) &= ~ _BV(pin & 0xF);\
 149             PIN_ADDRESS(pin, 2) |=   _BV(pin & 0xF);\
 150             })
 151     #define setPinInputLow(pin) _Static_assert(0, "AVR Processors cannot impliment an input as pull low")
 152     #define setPinOutput(pin) PIN_ADDRESS(pin, 1) |= _BV(pin & 0xF)
 153
 154     #define writePinHigh(pin) PIN_ADDRESS(pin, 2) |=  _BV(pin & 0xF)
 155     #define writePinLow(pin) PIN_ADDRESS(pin, 2) &= ~_BV(pin & 0xF)
 156     static inline void writePin(pin_t pin, uint8_t level){
 157         if (level){
 158             PIN_ADDRESS(pin, 2) |=  _BV(pin & 0xF);
 159         } else {
 160             PIN_ADDRESS(pin, 2) &= ~_BV(pin & 0xF);
 161         }
 162     }
 163
 164     #define readPin(pin) (PIN_ADDRESS(pin, 0) & _BV(pin & 0xF))
 165 #elif defined(PROTOCOL_CHIBIOS)
 166     #define pin_t ioline_t
 167     #define setPinInput(pin) palSetLineMode(pin, PAL_MODE_INPUT)
 168     #define setPinInputHigh(pin) palSetLineMode(pin, PAL_MODE_INPUT_PULLUP)
 169     #define setPinInputLow(pin) palSetLineMode(pin, PAL_MODE_INPUT_PULLDOWN)
 170     #define setPinOutput(pin) palSetLineMode(pin, PAL_MODE_OUTPUT_PUSHPULL)
 171
 172     #define writePinHigh(pin) palSetLine(pin)
 173     #define writePinLow(pin) palClearLine(pin)
 174     static inline void writePin(pin_t pin, uint8_t level){
 175         if (level){
 176             palSetLine(pin);
 177         } else {
 178             palClearLine(pin);
 179         }
 180     }
 181
 182     #define readPin(pin) palReadLine(pin)
 183 #endif
 184
 185 #define STRINGIZE(z) #z
 186 #define ADD_SLASH_X(y) STRINGIZE(\x ## y)
 187 #define SYMBOL_STR(x) ADD_SLASH_X(x)
 188
 189 #define SS_TAP(keycode) "\1" SYMBOL_STR(keycode)
 190 #define SS_DOWN(keycode) "\2" SYMBOL_STR(keycode)
 191 #define SS_UP(keycode) "\3" SYMBOL_STR(keycode)
 192
 193 #define SS_LCTRL(string) SS_DOWN(X_LCTRL) string SS_UP(X_LCTRL)
 194 #define SS_LGUI(string) SS_DOWN(X_LGUI) string SS_UP(X_LGUI)
 195 #define SS_LCMD(string) SS_LGUI(string)
 196 #define SS_LWIN(string) SS_LGUI(string)
 197 #define SS_LALT(string) SS_DOWN(X_LALT) string SS_UP(X_LALT)
 198 #define SS_LSFT(string) SS_DOWN(X_LSHIFT) string SS_UP(X_LSHIFT)
 199 #define SS_RALT(string) SS_DOWN(X_RALT) string SS_UP(X_RALT)
 200 #define SS_ALGR(string) SS_RALT(string)
 201
 202 #define SEND_STRING(str) send_string_P(PSTR(str))
 203 extern const bool ascii_to_shift_lut[0x80];
 204 extern const uint8_t ascii_to_keycode_lut[0x80];
 205 void send_string(const char *str);
 206 void send_string_with_delay(const char *str, uint8_t interval);
 207 void send_string_P(const char *str);
 208 void send_string_with_delay_P(const char *str, uint8_t interval);
 209 void send_char(char ascii_code);
 210
 211 // For tri-layer
 212 void update_tri_layer(uint8_t layer1, uint8_t layer2, uint8_t layer3);
 213 uint32_t update_tri_layer_state(uint32_t state, uint8_t layer1, uint8_t layer2, uint8_t layer3);
 214
 215 void set_single_persistent_default_layer(uint8_t default_layer);
 216
 217 void tap_random_base64(void);
 218
 219 #define IS_LAYER_ON(layer)  (layer_state & (1UL << (layer)))
 220 #define IS_LAYER_OFF(layer) (~layer_state & (1UL << (layer)))
 221
 222 void matrix_init_kb(void);
 223 void matrix_scan_kb(void);
 224 void matrix_init_user(void);
 225 void matrix_scan_user(void);
 226 bool process_action_kb(keyrecord_t *record);
 227 bool process_record_kb(uint16_t keycode, keyrecord_t *record);
 228 bool process_record_user(uint16_t keycode, keyrecord_t *record);
 229
 230 #ifndef BOOTMAGIC_LITE_COLUMN
 231   #define BOOTMAGIC_LITE_COLUMN 0
 232 #endif
 233 #ifndef BOOTMAGIC_LITE_ROW
 234   #define BOOTMAGIC_LITE_ROW 0
 235 #endif
 236
 237 void bootmagic_lite(void);
 238
 239 void reset_keyboard(void);
 240
 241 void startup_user(void);
 242 void shutdown_user(void);
 243
 244 void register_code16(uint16_t code);
 245 void unregister_code16(uint16_t code);
 246 inline void tap_code16(uint16_t code) { register_code16(code); unregister_code16(code); }
 247
 248 #ifdef BACKLIGHT_ENABLE
 249 void backlight_init_ports(void);
 250 void backlight_task(void);
 251
 252 #ifdef BACKLIGHT_BREATHING
 253 void breathing_enable(void);
 254 void breathing_pulse(void);
 255 void breathing_disable(void);
 256 void breathing_self_disable(void);
 257 void breathing_toggle(void);
 258 bool is_breathing(void);
 259
 260 void breathing_intensity_default(void);
 261 void breathing_period_default(void);
 262 void breathing_period_set(uint8_t value);
 263 void breathing_period_inc(void);
 264 void breathing_period_dec(void);
 265 #endif
 266
 267 #endif
 268 void send_dword(uint32_t number);
 269 void send_word(uint16_t number);
 270 void send_byte(uint8_t number);
 271 void send_nibble(uint8_t number);
 272 uint16_t hex_to_keycode(uint8_t hex);
 273
 274 void led_set_user(uint8_t usb_led);
 275 void led_set_kb(uint8_t usb_led);
 276
 277 void api_send_unicode(uint32_t unicode);
 278
 279 #endif