aboutsummaryrefslogtreecommitdiff
path: root/tmk_core/common/keymap.h
diff options
context:
space:
mode:
Diffstat (limited to 'tmk_core/common/keymap.h')
-rw-r--r--tmk_core/common/keymap.h71
1 files changed, 71 insertions, 0 deletions
diff --git a/tmk_core/common/keymap.h b/tmk_core/common/keymap.h
new file mode 100644
index 000000000..e1a6f992e
--- /dev/null
+++ b/tmk_core/common/keymap.h
@@ -0,0 +1,71 @@
1/*
2Copyright 2011 Jun Wako <wakojun@gmail.com>
3
4This program is free software: you can redistribute it and/or modify
5it under the terms of the GNU General Public License as published by
6the Free Software Foundation, either version 2 of the License, or
7(at your option) any later version.
8
9This program is distributed in the hope that it will be useful,
10but WITHOUT ANY WARRANTY; without even the implied warranty of
11MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12GNU General Public License for more details.
13
14You should have received a copy of the GNU General Public License
15along with this program. If not, see <http://www.gnu.org/licenses/>.
16*/
17
18#ifndef KEYMAP_H
19#define KEYMAP_H
20
21#include <stdint.h>
22#include <stdbool.h>
23#include "action.h"
24
25
26#ifdef BOOTMAGIC_ENABLE
27/* NOTE: Not portable. Bit field order depends on implementation */
28typedef union {
29 uint8_t raw;
30 struct {
31 bool swap_control_capslock:1;
32 bool capslock_to_control:1;
33 bool swap_lalt_lgui:1;
34 bool swap_ralt_rgui:1;
35 bool no_gui:1;
36 bool swap_grave_esc:1;
37 bool swap_backslash_backspace:1;
38 bool nkro:1;
39 };
40} keymap_config_t;
41keymap_config_t keymap_config;
42#endif
43
44
45/* translates key to keycode */
46uint8_t keymap_key_to_keycode(uint8_t layer, keypos_t key);
47
48/* translates Fn keycode to action */
49action_t keymap_fn_to_action(uint8_t keycode);
50
51
52
53#ifdef USE_LEGACY_KEYMAP
54/*
55 * Legacy keymap
56 * Consider using new keymap API above instead.
57 */
58/* keycode of key */
59__attribute__ ((deprecated))
60uint8_t keymap_get_keycode(uint8_t layer, uint8_t row, uint8_t col);
61
62/* layer to move during press Fn key */
63__attribute__ ((deprecated))
64uint8_t keymap_fn_layer(uint8_t fn_bits);
65
66/* keycode to send when release Fn key without using */
67__attribute__ ((deprecated))
68uint8_t keymap_fn_keycode(uint8_t fn_bits);
69#endif
70
71#endif