core: Add unimap support

diff --git a/tmk_core/common.mk b/tmk_core/common.mk
index 9cfe6d5a9e275e48b2748f462262f641db6cdb39..4fc5398c8ce9827a865d727298b13032047095fd 100644 (file)
--- a/tmk_core/common.mk
+++ b/tmk_core/common.mk
@@ -17,11 +17,16 @@ SRC +=      $(COMMON_DIR)/host.c \
 
 
 # Option modules
-ifdef ACTIONMAP_ENABLE
-    SRC += $(COMMON_DIR)/actionmap.c
-    OPT_DEFS += -DACTIONMAP_ENABLE
+ifdef UNIMAP_ENABLE
+    SRC += $(COMMON_DIR)/unimap.c
+    OPT_DEFS += -DUNIMAP_ENABLE
 else
-    SRC += $(COMMON_DIR)/keymap.c
+    ifdef ACTIONMAP_ENABLE
+       SRC += $(COMMON_DIR)/actionmap.c
+       OPT_DEFS += -DACTIONMAP_ENABLE
+    else
+       SRC += $(COMMON_DIR)/keymap.c
+    endif
 endif
 
 ifdef BOOTMAGIC_ENABLE

diff --git a/tmk_core/common/actionmap.c b/tmk_core/common/actionmap.c
index 49d0f5cef0573f52b5bc712ed6708ac0007e032a..6b0fa8e923d759643da163629b25b4f576b058bf 100644 (file)
--- a/tmk_core/common/actionmap.c
+++ b/tmk_core/common/actionmap.c
@@ -18,6 +18,11 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "action_code.h"
 #include "actionmap.h"
 
+
+/* Keymapping with 16bit action codes */
+extern const action_t actionmaps[][MATRIX_ROWS][MATRIX_COLS];
+
+
 /* Converts key to action */
 __attribute__ ((weak))
 action_t action_for_key(uint8_t layer, keypos_t key)

diff --git a/tmk_core/common/actionmap.h b/tmk_core/common/actionmap.h
index ac5299752decacab3984433cd9e145370622b7dd..5e00bb2ed13321c1929024cb78f69498db9611b5 100644 (file)
--- a/tmk_core/common/actionmap.h
+++ b/tmk_core/common/actionmap.h
@@ -24,10 +24,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #include "action.h"
 
 
-/* Keymapping with 16bit action codes */
-extern const action_t actionmaps[][MATRIX_ROWS][MATRIX_COLS];
-
-
 /* Modified key */
 #define AC_c(kc)                ACTION_MODS_KEY(MOD_LCTL, KC_##kc)
 #define AC_s(kc)                ACTION_MODS_KEY(MOD_LSFT, KC_##kc)

diff --git a/tmk_core/common/unimap.c b/tmk_core/common/unimap.c
new file mode 100644 (file)
index 0000000..c3d6c26
--- /dev/null
+++ b/tmk_core/common/unimap.c
@@ -0,0 +1,57 @@
+#include "keyboard.h"
+#include "action.h"
+#include "unimap.h"
+#include "print.h"
+#if defined(__AVR__)
+#   include <avr/pgmspace.h>
+#endif
+
+
+/* Keymapping with 16bit action codes */
+extern const action_t actionmaps[][UNIMAP_ROWS][UNIMAP_COLS];
+
+// table translates matrix to universal keymap
+extern const uint8_t unimap_trans[MATRIX_ROWS][MATRIX_COLS];
+
+
+
+// translates raw matrix to universal map
+keypos_t unimap_translate(keypos_t key)
+{
+    uint8_t unimap_pos = 
+#if defined(__AVR__)
+        pgm_read_byte(&unimap_trans[key.row][key.col]);
+#else
+        unimap_trans[key.row][key.col];
+#endif
+    return (keypos_t) {
+        .row = ((unimap_pos & 0x70) >> 4),
+        .col = (unimap_pos & 0x0F)
+    };
+}
+
+/* Converts key to action */
+__attribute__ ((weak))
+action_t action_for_key(uint8_t layer, keypos_t key)
+{
+    keypos_t uni = unimap_translate(key);
+    if ((uni.row << 4 | uni.col) == UNIMAP_NO) return (action_t)ACTION_NO;
+#if defined(__AVR__)
+    return (action_t)pgm_read_word(&actionmaps[(layer)][(uni.row)][(uni.col)]);
+#else
+    return actionmaps[(layer)][(uni.row)][(uni.col)];
+#endif
+}
+
+/* Macro */
+__attribute__ ((weak))
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
+{
+    return MACRO_NONE;
+}
+
+/* Function */
+__attribute__ ((weak))
+void action_function(keyrecord_t *record, uint8_t id, uint8_t opt)
+{
+}

diff --git a/tmk_core/common/unimap.h b/tmk_core/common/unimap.h
new file mode 100644 (file)
index 0000000..43be70b
--- /dev/null
+++ b/tmk_core/common/unimap.h
@@ -0,0 +1,211 @@
+/*
+Copyright 2016 Jun Wako <wakojun@gmail.com>
+*/
+#ifndef _UNIMAP_H_
+#define _UNIMAP_H_
+
+#include <stdint.h>
+#include <stdbool.h>
+#include "action.h"
+#include "action_code.h"
+#include "actionmap.h"
+
+
+// Universal map table: 8x16=128key
+#define UNIMAP_ROWS 8
+#define UNIMAP_COLS 16
+
+/* Universal 128-key keyboard layout(8x16)
+        ,-----------------------------------------------.
+        |F13|F14|F15|F16|F17|F18|F19|F20|F21|F22|F23|F24|
+,---.   |-----------------------------------------------|     ,-----------.     ,-----------.
+|Esc|   |F1 |F2 |F3 |F4 |F5 |F6 |F7 |F8 |F9 |F10|F11|F12|     |PrS|ScL|Pau|     |VDn|VUp|Mut|
+`---'   `-----------------------------------------------'     `-----------'     `-----------'
+,-----------------------------------------------------------. ,-----------. ,---------------.
+|  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|JPY|Bsp| |Ins|Hom|PgU| |NmL|  /|  *|  -|
+|-----------------------------------------------------------| |-----------| |---------------|
+|Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|  \  | |Del|End|PgD| |  7|  8|  9|  +|
+|-----------------------------------------------------------| `-----------' |---------------|
+|CapsL |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|  #|Retn|               |  4|  5|  6|KP,|
+|-----------------------------------------------------------|     ,---.     |---------------|
+|Shft|  <|  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /| RO|Shift |     |Up |     |  1|  2|  3|KP=|
+|-----------------------------------------------------------| ,-----------. |---------------|
+|Ctl|Gui|Alt|MHEN|     Space      |HENK|KANA|Alt|Gui|App|Ctl| |Lef|Dow|Rig| |  0    |  .|Ent|
+`-----------------------------------------------------------' `-----------' `---------------'
+App:         Windows Menu key
+Gui:         Windows key, Mac ⌘ key or Meta key
+VDn Vup Mut: Volume control
+< #:         ISO keys(in UK legend)
+KP=:         Keypad = for Mac
+KP,:         Brazilian Keypad Comma
+JPY:         Japanese Yen(￥)
+RO:          Japanese ろ(Ro) or Brazilian /(Slash)
+MHEN:        Japanese 無変換(Non Conversion) or Korean Hanja
+HENK:        Japanese 変換(Conversion) or Korean Hangul/English
+KANA:        Japanese かな(Hiragana/Katakana)
+https://en.wikipedia.org/wiki/Keyboard_layout#Japanese
+https://en.wikipedia.org/wiki/Keyboard_layout#Hangul_.28for_Korean.29
+*/
+#define UNIMAP( \
+            K68,K69,K6A,K6B,K6C,K6D,K6E,K6F,K70,K71,K72,K73,                                     \
+    K29,    K3A,K3B,K3C,K3D,K3E,K3F,K40,K41,K42,K43,K44,K45,      K46,K47,K48,      K01,K02,K03, \
+    K35,K1E,K1F,K20,K21,K22,K23,K24,K25,K26,K27,K2D,K2E,K74,K2A,  K49,K4A,K4B,  K53,K54,K55,K56, \
+    K2B,K14,K1A,K08,K15,K17,K1C,K18,K0C,K12,K13,K2F,K30,    K31,  K4C,K4D,K4E,  K5F,K60,K61,K57, \
+    K39,K04,K16,K07,K09,K0A,K0B,K0D,K0E,K0F,K33,K34,    K32,K28,                K5C,K5D,K5E,K66, \
+    K79,K64,K1D,K1B,K06,K19,K05,K11,K10,K36,K37,K38,    K75,K7D,      K52,      K59,K5A,K5B,K67, \
+    K78,K7B,K7A,K77,        K2C,        K76,K00,K7E,K7F,K65,K7C,  K50,K51,K4F,  K62,    K63,K58  \
+) { \
+    { AC_##K00, AC_##K01, AC_##K02, AC_##K03, AC_##K04, AC_##K05, AC_##K06, AC_##K07,   /* 00-07 */ \
+      AC_##K08, AC_##K09, AC_##K0A, AC_##K0B, AC_##K0C, AC_##K0D, AC_##K0E, AC_##K0F }, /* 08-0F */ \
+    { AC_##K10, AC_##K11, AC_##K12, AC_##K13, AC_##K14, AC_##K15, AC_##K16, AC_##K17,   /* 10-17 */ \
+      AC_##K18, AC_##K19, AC_##K1A, AC_##K1B, AC_##K1C, AC_##K1D, AC_##K1E, AC_##K1F }, /* 18-1F */ \
+    { AC_##K20, AC_##K21, AC_##K22, AC_##K23, AC_##K24, AC_##K25, AC_##K26, AC_##K27,   /* 20-27 */ \
+      AC_##K28, AC_##K29, AC_##K2A, AC_##K2B, AC_##K2C, AC_##K2D, AC_##K2E, AC_##K2F }, /* 28-2F */ \
+    { AC_##K30, AC_##K31, AC_##K32, AC_##K33, AC_##K34, AC_##K35, AC_##K36, AC_##K37,   /* 30-37 */ \
+      AC_##K38, AC_##K39, AC_##K3A, AC_##K3B, AC_##K3C, AC_##K3D, AC_##K3E, AC_##K3F }, /* 38-3F */ \
+    { AC_##K40, AC_##K41, AC_##K42, AC_##K43, AC_##K44, AC_##K45, AC_##K46, AC_##K47,   /* 40-47 */ \
+      AC_##K48, AC_##K49, AC_##K4A, AC_##K4B, AC_##K4C, AC_##K4D, AC_##K4E, AC_##K4F }, /* 48-4F */ \
+    { AC_##K50, AC_##K51, AC_##K52, AC_##K53, AC_##K54, AC_##K55, AC_##K56, AC_##K57,   /* 50-57 */ \
+      AC_##K58, AC_##K59, AC_##K5A, AC_##K5B, AC_##K5C, AC_##K5D, AC_##K5E, AC_##K5F }, /* 58-5F */ \
+    { AC_##K60, AC_##K61, AC_##K62, AC_##K63, AC_##K64, AC_##K65, AC_##K66, AC_##K67,   /* 60-67 */ \
+      AC_##K68, AC_##K69, AC_##K6A, AC_##K6B, AC_##K6C, AC_##K6D, AC_##K6E, AC_##K6F }, /* 68-6F */ \
+    { AC_##K70, AC_##K71, AC_##K72, AC_##K73, AC_##K74, AC_##K75, AC_##K76, AC_##K77,   /* 70-77 */ \
+      AC_##K78, AC_##K79, AC_##K7A, AC_##K7B, AC_##K7C, AC_##K7D, AC_##K7E, AC_##K7F }  /* 78-7F */ \
+}
+
+// Universal map position codes
+enum unimap_position_codes {
+//  logical name            position(row << 4 | col)
+//  ------------------------------------------------
+    UNIMAP_KANA,            // 0x00
+    UNIMAP_VOLUME_DOWN,     // 0x01
+    UNIMAP_VOLUME_UP,       // 0x02
+    UNIMAP_VOLUME_MUTE,     // 0x03
+    UNIMAP_A,               // 0x04
+    UNIMAP_B,               // 0x05
+    UNIMAP_C,               // 0x06
+    UNIMAP_D,               // 0x07
+    UNIMAP_E,               // 0x08
+    UNIMAP_F,               // 0x09
+    UNIMAP_G,               // 0x0A
+    UNIMAP_H,               // 0x0B
+    UNIMAP_I,               // 0x0C
+    UNIMAP_J,               // 0x0D
+    UNIMAP_K,               // 0x0E
+    UNIMAP_L,               // 0x0F
+    UNIMAP_M,               // 0x10
+    UNIMAP_N,               // 0x11
+    UNIMAP_O,               // 0x12
+    UNIMAP_P,               // 0x13
+    UNIMAP_Q,               // 0x14
+    UNIMAP_R,               // 0x15
+    UNIMAP_S,               // 0x16
+    UNIMAP_T,               // 0x17
+    UNIMAP_U,               // 0x18
+    UNIMAP_V,               // 0x19
+    UNIMAP_W,               // 0x1A
+    UNIMAP_X,               // 0x1B
+    UNIMAP_Y,               // 0x1C
+    UNIMAP_Z,               // 0x1D
+    UNIMAP_1,               // 0x1E
+    UNIMAP_2,               // 0x1F
+    UNIMAP_3,               // 0x20
+    UNIMAP_4,               // 0x21
+    UNIMAP_5,               // 0x22
+    UNIMAP_6,               // 0x23
+    UNIMAP_7,               // 0x24
+    UNIMAP_8,               // 0x25
+    UNIMAP_9,               // 0x26
+    UNIMAP_0,               // 0x27
+    UNIMAP_ENTER,           // 0x28
+    UNIMAP_ESCAPE,          // 0x29
+    UNIMAP_BSPACE,          // 0x2A
+    UNIMAP_TAB,             // 0x2B
+    UNIMAP_SPACE,           // 0x2C
+    UNIMAP_MINUS,           // 0x2D
+    UNIMAP_EQUAL,           // 0x2E
+    UNIMAP_LBRACKET,        // 0x2F
+    UNIMAP_RBRACKET,        // 0x30
+    UNIMAP_BSLASH,          // 0x31
+    UNIMAP_NONUS_HASH,      // 0x32 ISO UK hasu
+    UNIMAP_SCOLON,          // 0x33
+    UNIMAP_QUOTE,           // 0x34
+    UNIMAP_GRAVE,           // 0x35
+    UNIMAP_COMMA,           // 0x36
+    UNIMAP_DOT,             // 0x37
+    UNIMAP_SLASH,           // 0x38
+    UNIMAP_CAPSLOCK,        // 0x39
+    UNIMAP_F1,              // 0x3A
+    UNIMAP_F2,              // 0x3B
+    UNIMAP_F3,              // 0x3C
+    UNIMAP_F4,              // 0x3D
+    UNIMAP_F5,              // 0x3E
+    UNIMAP_F6,              // 0x3F
+    UNIMAP_F7,              // 0x40
+    UNIMAP_F8,              // 0x41
+    UNIMAP_F9,              // 0x42
+    UNIMAP_F10,             // 0x43
+    UNIMAP_F11,             // 0x44
+    UNIMAP_F12,             // 0x45
+    UNIMAP_PSCREEN,         // 0x46
+    UNIMAP_SCROLLLOCK,      // 0x47
+    UNIMAP_PAUSE,           // 0x48
+    UNIMAP_INSERT,          // 0x49
+    UNIMAP_HOME,            // 0x4A
+    UNIMAP_PGUP,            // 0x4B
+    UNIMAP_DELETE,          // 0x4C
+    UNIMAP_END,             // 0x4D
+    UNIMAP_PGDOWN,          // 0x4E
+    UNIMAP_RIGHT,           // 0x4F
+    UNIMAP_LEFT,            // 0x50
+    UNIMAP_DOWN,            // 0x51
+    UNIMAP_UP,              // 0x52
+    UNIMAP_NUMLOCK,         // 0x53
+    UNIMAP_KP_SLASH,        // 0x54
+    UNIMAP_KP_ASTERISK,     // 0x55
+    UNIMAP_KP_MINUS,        // 0x56
+    UNIMAP_KP_PLUS,         // 0x57
+    UNIMAP_KP_ENTER,        // 0x58
+    UNIMAP_KP_1,            // 0x59
+    UNIMAP_KP_2,            // 0x5A
+    UNIMAP_KP_3,            // 0x5B
+    UNIMAP_KP_4,            // 0x5C
+    UNIMAP_KP_5,            // 0x5D
+    UNIMAP_KP_6,            // 0x5E
+    UNIMAP_KP_7,            // 0x5F
+    UNIMAP_KP_8,            // 0x60
+    UNIMAP_KP_9,            // 0x61
+    UNIMAP_KP_0,            // 0x62
+    UNIMAP_KP_DOT,          // 0x63
+    UNIMAP_NONUS_BSLASH,    // 0x64 ISO UK backslash
+    UNIMAP_APPLICATION,     // 0x65
+    UNIMAP_KP_COMMA,        // 0x66
+    UNIMAP_KP_EQUAL,        // 0x67
+    UNIMAP_F13,             // 0x68
+    UNIMAP_F14,             // 0x69
+    UNIMAP_F15,             // 0x6A
+    UNIMAP_F16,             // 0x6B
+    UNIMAP_F17,             // 0x6C
+    UNIMAP_F18,             // 0x6D
+    UNIMAP_F19,             // 0x6E
+    UNIMAP_F20,             // 0x6F
+    UNIMAP_F21,             // 0x70
+    UNIMAP_F22,             // 0x71
+    UNIMAP_F23,             // 0x72
+    UNIMAP_F24,             // 0x73
+    UNIMAP_JYEN,            // 0x74
+    UNIMAP_RO,              // 0x75
+    UNIMAP_HENK,            // 0x76
+    UNIMAP_MHEN,            // 0x77
+    UNIMAP_LCTRL,           // 0x78
+    UNIMAP_LSHIFT,          // 0x79
+    UNIMAP_LALT,            // 0x7A
+    UNIMAP_LGUI,            // 0x7B
+    UNIMAP_RCTRL,           // 0x7C
+    UNIMAP_RSHIFT,          // 0x7D
+    UNIMAP_RALT,            // 0x7E
+    UNIMAP_RGUI,            // 0x7F
+    UNIMAP_NO,              // 0x80
+};
+
+#endif

diff --git a/tmk_core/doc/unimap.txt b/tmk_core/doc/unimap.txt
new file mode 100644 (file)
index 0000000..0db038e
--- /dev/null
+++ b/tmk_core/doc/unimap.txt
@@ -0,0 +1,51 @@
+Unimap
+======
+universal keymapping framework
+using logical 128-key keyboard layout independent from physical keyboad matrix
+
+unimap is actually an actionmap whose size is row:8xcol:16.
+
+/* Keymapping with 16bit action codes */
+extern const action_t actionmaps[][UNIMAP_ROWS][UNIMAP_COLS];
+
+/* Universal 128-key keyboard layout(8x16)
+        ,-----------------------------------------------.
+        |F13|F14|F15|F16|F17|F18|F19|F20|F21|F22|F23|F24|
+,---.   |-----------------------------------------------|     ,-----------.     ,-----------.
+|Esc|   |F1 |F2 |F3 |F4 |F5 |F6 |F7 |F8 |F9 |F10|F11|F12|     |PrS|ScL|Pau|     |VDn|VUp|Mut|
+`---'   `-----------------------------------------------'     `-----------'     `-----------'
+,-----------------------------------------------------------. ,-----------. ,---------------.
+|  `|  1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|JPY|Bsp| |Ins|Hom|PgU| |NmL|  /|  *|  -|
+|-----------------------------------------------------------| |-----------| |---------------|
+|Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|  \  | |Del|End|PgD| |  7|  8|  9|  +|
+|-----------------------------------------------------------| `-----------' |---------------|
+|CapsL |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|  #|Retn|               |  4|  5|  6|KP,|
+|-----------------------------------------------------------|     ,---.     |---------------|
+|Shft|  <|  Z|  X|  C|  V|  B|  N|  M|  ,|  ,|  /| RO|Shift |     |Up |     |  1|  2|  3|KP=|
+|-----------------------------------------------------------| ,-----------. |---------------|
+|Ctl|Gui|Alt|MHEN|     Space      |HENK|KANA|Alt|Gui|App|Ctl| |Lef|Dow|Rig| |  0    |  .|Ent|
+`-----------------------------------------------------------' `-----------' `---------------'
+App:         Windows Menu key
+Gui:         Windows key, Mac ⌘ key or Meta key
+VDn Vup Mut: Volume control
+< #:         ISO keys(in UK legend)
+KP=:         Keypad = for Mac
+KP,:         Brazilian Keypad Comma
+JPY:         Japanese Yen(￥)
+RO:          Japanese ろ(Ro) or Brazilian /(Slash)
+MHEN:        Japanese 無変換(Non Conversion) or Korean Hanja
+HENK:        Japanese 変換(Conversion) or Korean Hangul/English
+KANA:        Japanese かな(Hiragana/Katakana)
+https://en.wikipedia.org/wiki/Keyboard_layout#Japanese
+https://en.wikipedia.org/wiki/Keyboard_layout#Hangul_.28for_Korean.29
+*/
+
+
+when refering to keymapping physical matrix position needed to be translated into logical one on unimap
+the translation is defined in unimap array
+
+row and col of unimap positon is encoded as follows
+position = (row << 4) | col
+
+// table translates matrix to universal keymap
+extern const uint8_t unimap_trans[MATRIX_ROWS][MATRIX_COLS];