X-Git-Url: https://git.donarmstrong.com/?p=qmk_firmware.git;a=blobdiff_plain;f=quantum%2Fquantum.h;h=56f30624c75ce0c36aa43cd3cd5061a4857d2ebb;hp=580d51202a429cb59914cb098f665b2d13bb6ddc;hb=a5ecf146085716f3a79424c2f4b3b3039ff36b3e;hpb=e7347ff0de93ff823462b3ff2b4136b44dc576c0
diff --git a/quantum/quantum.h b/quantum/quantum.h
index 580d51202..56f30624c 100644
--- a/quantum/quantum.h
+++ b/quantum/quantum.h
@@ -1,84 +1,221 @@
-#ifndef QUANTUM_H
-#define QUANTUM_H
+/* 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 .
+ */
+#pragma once
#if defined(__AVR__)
-#include
-#include
-#include
+ #include
+ #include
+ #include
#endif
+#if defined(PROTOCOL_CHIBIOS)
+ #include "hal.h"
+#endif
+
#include "wait.h"
#include "matrix.h"
#include "keymap.h"
+
#ifdef BACKLIGHT_ENABLE
- #include "backlight.h"
+ #ifdef LED_MATRIX_ENABLE
+ #include "ledmatrix.h"
+ #else
+ #include "backlight.h"
+ #endif
#endif
-#ifdef RGBLIGHT_ENABLE
- #include "rgblight.h"
+
+#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
#include "bootloader.h"
#include "timer.h"
#include "config_common.h"
#include "led.h"
#include "action_util.h"
-#include
#include "print.h"
+#include "send_string_keycodes.h"
+#include "suspend.h"
+#include
+#include
-
-extern uint32_t default_layer_state;
+extern layer_state_t default_layer_state;
#ifndef NO_ACTION_LAYER
- extern uint32_t layer_state;
+ extern layer_state_t layer_state;
#endif
-#ifdef MIDI_ENABLE
- #include
- #include "process_midi.h"
+#if defined(MIDI_ENABLE) && defined(MIDI_ADVANCED)
+ #include "process_midi.h"
#endif
#ifdef AUDIO_ENABLE
- #include "audio.h"
- #include "process_music.h"
+ #include "audio.h"
+ #include "process_audio.h"
+ #ifdef AUDIO_CLICKY
+ #include "process_clicky.h"
+ #endif
+#endif
+
+#ifdef STENO_ENABLE
+ #include "process_steno.h"
#endif
-#ifndef DISABLE_LEADER
- #include "process_leader.h"
+#if defined(AUDIO_ENABLE) || (defined(MIDI_ENABLE) && defined(MIDI_BASIC))
+ #include "process_music.h"
#endif
-#define DISABLE_CHORDING
-#ifndef DISABLE_CHORDING
- #include "process_chording.h"
+#ifdef LEADER_ENABLE
+ #include "process_leader.h"
#endif
#ifdef UNICODE_ENABLE
- #include "process_unicode.h"
+ #include "process_unicode.h"
#endif
#ifdef UCIS_ENABLE
- #include "process_ucis.h"
+ #include "process_ucis.h"
#endif
#ifdef UNICODEMAP_ENABLE
- #include "process_unicodemap.h"
+ #include "process_unicodemap.h"
#endif
-#include "process_tap_dance.h"
+#ifdef TAP_DANCE_ENABLE
+ #include "process_tap_dance.h"
+#endif
#ifdef PRINTING_ENABLE
- #include "process_printer.h"
+ #include "process_printer.h"
+#endif
+
+#ifdef AUTO_SHIFT_ENABLE
+ #include "process_auto_shift.h"
#endif
#ifdef COMBO_ENABLE
- #include "process_combo.h"
+ #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 HD44780_ENABLE
+ #include "hd44780.h"
+#endif
+
+#ifdef HAPTIC_ENABLE
+ #include "haptic.h"
+#endif
+
+#ifdef OLED_DRIVER_ENABLE
+ #include "oled_driver.h"
#endif
-#define SEND_STRING(str) send_string(PSTR(str))
+// Function substitutions to ease GPIO manipulation
+#if defined(__AVR__)
+ typedef uint8_t pin_t;
+
+ #define PIN_ADDRESS(p, offset) (_SFR_IO8(ADDRESS_BASE + ((p) >> PORT_SHIFTER) + (offset)))
+ #define setPinInput(pin) (PIN_ADDRESS(pin, 1) &= ~_BV((pin) & 0xF))
+ #define setPinInputHigh(pin) (PIN_ADDRESS(pin, 1) &= ~_BV((pin) & 0xF), \
+ PIN_ADDRESS(pin, 2) |= _BV((pin) & 0xF))
+ #define setPinInputLow(pin) _Static_assert(0, "AVR processors cannot implement an input as pull low")
+ #define setPinOutput(pin) (PIN_ADDRESS(pin, 1) |= _BV((pin) & 0xF))
+
+ #define writePinHigh(pin) (PIN_ADDRESS(pin, 2) |= _BV((pin) & 0xF))
+ #define writePinLow(pin) (PIN_ADDRESS(pin, 2) &= ~_BV((pin) & 0xF))
+ #define writePin(pin, level) ((level) ? writePinHigh(pin) : writePinLow(pin))
+
+ #define readPin(pin) ((bool)(PIN_ADDRESS(pin, 0) & _BV((pin) & 0xF)))
+#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)
+#endif
+
+// Send string macros
+#define STRINGIZE(z) #z
+#define ADD_SLASH_X(y) STRINGIZE(\x ## y)
+#define SYMBOL_STR(x) ADD_SLASH_X(x)
+
+#define SS_TAP_CODE 1
+#define SS_DOWN_CODE 2
+#define SS_UP_CODE 3
+
+#define SS_TAP(keycode) "\1" SYMBOL_STR(keycode)
+#define SS_DOWN(keycode) "\2" SYMBOL_STR(keycode)
+#define SS_UP(keycode) "\3" SYMBOL_STR(keycode)
+
+// `string` arguments must not be parenthesized
+#define SS_LCTRL(string) SS_DOWN(X_LCTRL) string SS_UP(X_LCTRL)
+#define SS_LGUI(string) SS_DOWN(X_LGUI) string SS_UP(X_LGUI)
+#define SS_LCMD(string) SS_LGUI(string)
+#define SS_LWIN(string) SS_LGUI(string)
+#define SS_LALT(string) SS_DOWN(X_LALT) string SS_UP(X_LALT)
+#define SS_LSFT(string) SS_DOWN(X_LSHIFT) string SS_UP(X_LSHIFT)
+#define SS_RALT(string) SS_DOWN(X_RALT) string SS_UP(X_RALT)
+#define SS_ALGR(string) SS_RALT(string)
+
+#define SEND_STRING(string) send_string_P(PSTR(string))
+
+extern const bool ascii_to_shift_lut[128];
+extern const bool ascii_to_altgr_lut[128];
+extern const uint8_t ascii_to_keycode_lut[128];
+
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);
+uint32_t update_tri_layer_state(uint32_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);
@@ -89,22 +226,39 @@ 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);
+uint16_t get_event_keycode(keyevent_t event);
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);
+#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 register_code16(uint16_t code);
+void unregister_code16(uint16_t code);
+void tap_code16(uint16_t code);
#ifdef BACKLIGHT_ENABLE
void backlight_init_ports(void);
+void backlight_task(void);
+void backlight_task_internal(void);
+void backlight_on(uint8_t backlight_pin);
+void backlight_off(uint8_t backlight_pin);
-#ifdef BACKLIGHT_BREATHING
+ #ifdef BACKLIGHT_BREATHING
+void breathing_task(void);
void breathing_enable(void);
void breathing_pulse(void);
void breathing_disable(void);
@@ -112,15 +266,14 @@ void breathing_self_disable(void);
void breathing_toggle(void);
bool is_breathing(void);
-void breathing_defaults(void);
void breathing_intensity_default(void);
-void breathing_speed_default(void);
-void breathing_speed_set(uint8_t value);
-void breathing_speed_inc(uint8_t value);
-void breathing_speed_dec(uint8_t value);
+void breathing_period_default(void);
+void breathing_period_set(uint8_t value);
+void breathing_period_inc(void);
+void breathing_period_dec(void);
+ #endif
#endif
-#endif
void send_dword(uint32_t number);
void send_word(uint16_t number);
void send_byte(uint8_t number);
@@ -131,5 +284,3 @@ void led_set_user(uint8_t usb_led);
void led_set_kb(uint8_t usb_led);
void api_send_unicode(uint32_t unicode);
-
-#endif