]> git.donarmstrong.com Git - qmk_firmware.git/blob - tmk_core/common/bootmagic.h
Generate API docs from source code comments (#2491)
[qmk_firmware.git] / tmk_core / common / bootmagic.h
1 #ifndef BOOTMAGIC_H
2 #define BOOTMAGIC_H
3
4
5 /* FIXME: Add special doxygen comments for defines here. */
6
7 /* bootmagic salt key */
8 #ifndef BOOTMAGIC_KEY_SALT
9 #define BOOTMAGIC_KEY_SALT              KC_SPACE
10 #endif
11
12 /* skip bootmagic and eeconfig */
13 #ifndef BOOTMAGIC_KEY_SKIP
14 #define BOOTMAGIC_KEY_SKIP              KC_ESC
15 #endif
16
17 /* eeprom clear */
18 #ifndef BOOTMAGIC_KEY_EEPROM_CLEAR
19 #define BOOTMAGIC_KEY_EEPROM_CLEAR      KC_BSPACE
20 #endif
21
22 /* kick up bootloader */
23 #ifndef BOOTMAGIC_KEY_BOOTLOADER
24 #define BOOTMAGIC_KEY_BOOTLOADER        KC_B
25 #endif
26
27 /* debug enable */
28 #ifndef BOOTMAGIC_KEY_DEBUG_ENABLE
29 #define BOOTMAGIC_KEY_DEBUG_ENABLE      KC_D
30 #endif
31 #ifndef BOOTMAGIC_KEY_DEBUG_MATRIX
32 #define BOOTMAGIC_KEY_DEBUG_MATRIX      KC_X
33 #endif
34 #ifndef BOOTMAGIC_KEY_DEBUG_KEYBOARD
35 #define BOOTMAGIC_KEY_DEBUG_KEYBOARD    KC_K
36 #endif
37 #ifndef BOOTMAGIC_KEY_DEBUG_MOUSE
38 #define BOOTMAGIC_KEY_DEBUG_MOUSE       KC_M
39 #endif
40
41 /*
42  * keymap config
43  */
44 #ifndef BOOTMAGIC_KEY_SWAP_CONTROL_CAPSLOCK
45 #define BOOTMAGIC_KEY_SWAP_CONTROL_CAPSLOCK     KC_LCTRL
46 #endif
47 #ifndef BOOTMAGIC_KEY_CAPSLOCK_TO_CONTROL
48 #define BOOTMAGIC_KEY_CAPSLOCK_TO_CONTROL       KC_CAPSLOCK
49 #endif
50 #ifndef BOOTMAGIC_KEY_SWAP_LALT_LGUI
51 #define BOOTMAGIC_KEY_SWAP_LALT_LGUI            KC_LALT
52 #endif
53 #ifndef BOOTMAGIC_KEY_SWAP_RALT_RGUI
54 #define BOOTMAGIC_KEY_SWAP_RALT_RGUI            KC_RALT
55 #endif
56 #ifndef BOOTMAGIC_KEY_NO_GUI
57 #define BOOTMAGIC_KEY_NO_GUI                    KC_LGUI
58 #endif
59 #ifndef BOOTMAGIC_KEY_SWAP_GRAVE_ESC
60 #define BOOTMAGIC_KEY_SWAP_GRAVE_ESC            KC_GRAVE
61 #endif
62 #ifndef BOOTMAGIC_KEY_SWAP_BACKSLASH_BACKSPACE
63 #define BOOTMAGIC_KEY_SWAP_BACKSLASH_BACKSPACE  KC_BSLASH
64 #endif
65 #ifndef BOOTMAGIC_HOST_NKRO
66 #define BOOTMAGIC_HOST_NKRO              KC_N
67 #endif
68
69
70 /*
71  * change default layer
72  */
73 #ifndef BOOTMAGIC_KEY_DEFAULT_LAYER_0
74 #define BOOTMAGIC_KEY_DEFAULT_LAYER_0   KC_0
75 #endif
76 #ifndef BOOTMAGIC_KEY_DEFAULT_LAYER_1
77 #define BOOTMAGIC_KEY_DEFAULT_LAYER_1   KC_1
78 #endif
79 #ifndef BOOTMAGIC_KEY_DEFAULT_LAYER_2
80 #define BOOTMAGIC_KEY_DEFAULT_LAYER_2   KC_2
81 #endif
82 #ifndef BOOTMAGIC_KEY_DEFAULT_LAYER_3
83 #define BOOTMAGIC_KEY_DEFAULT_LAYER_3   KC_3
84 #endif
85 #ifndef BOOTMAGIC_KEY_DEFAULT_LAYER_4
86 #define BOOTMAGIC_KEY_DEFAULT_LAYER_4   KC_4
87 #endif
88 #ifndef BOOTMAGIC_KEY_DEFAULT_LAYER_5
89 #define BOOTMAGIC_KEY_DEFAULT_LAYER_5   KC_5
90 #endif
91 #ifndef BOOTMAGIC_KEY_DEFAULT_LAYER_6
92 #define BOOTMAGIC_KEY_DEFAULT_LAYER_6   KC_6
93 #endif
94 #ifndef BOOTMAGIC_KEY_DEFAULT_LAYER_7
95 #define BOOTMAGIC_KEY_DEFAULT_LAYER_7   KC_7
96 #endif
97
98
99 void bootmagic(void);
100 bool bootmagic_scan_keycode(uint8_t keycode);
101
102 #endif