Peter's keyboard firmware (QMK) https://qmk.fm/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

quantum.h 7.5KB

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