mirrors/keychron_qmk_firmware
mirrors/keychron_qmk_firmware
0
0
Fork 0
mirror of https://github.com/Keychron/qmk_firmware.git synced 2024-11-22 00:16:41 +06:00
Code Issues Packages Projects Releases Wiki Activity

ADD: keymap macro for human to read easier

Browse Source 
ADD: controller.h for controller board definition(teensy)
ADD: debug toggle
This commit is contained in:
tmk 2010-10-26 21:32:45 +09:00
parent 7a336b05ec
commit 461e0d3d8c
17 changed files with 432 additions and 257 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Makefile.common
View File

@ -116,15 +116,15 @@ CSTANDARD = -std=gnu99
# Place -D or -U options here for C sources
CDEFS = -DF_CPU=$(F_CPU)UL
CDEFS = -DF_CPU=$(F_CPU)UL -DDESCRIPTION=$(DESCRIPTION)
# Place -D or -U options here for ASM sources
ADEFS = -DF_CPU=$(F_CPU)
ADEFS = -DF_CPU=$(F_CPU) -DDESCRIPTION=$(DESCRIPTION)
# Place -D or -U options here for C++ sources
CPPDEFS = -DF_CPU=$(F_CPU)UL
CPPDEFS = -DF_CPU=$(F_CPU)UL -DDESCRIPTION=$(DESCRIPTION)
#CPPDEFS += -D__STDC_LIMIT_MACROS
#CPPDEFS += -D__STDC_CONSTANT_MACROS

10
controller_teensy.h Normal file
View File

@ -0,0 +1,10 @@
#ifndef TEENSY_H
#define TEENSY_H 1
// for Teensy/Teensy++ 2.0
#define DEBUG_LED 1
#define DEBUG_LED_CONFIG (DDRD |= (1<<6))
#define DEBUG_LED_ON (PORTD |= (1<<6))
#define DEBUG_LED_OFF (PORTD &= ~(1<<6))
#endif

19
debug.h Normal file
View File

@ -0,0 +1,19 @@
#ifndef DEBUG_H
#define DEBUG_H 1
#include "print.h"
#define debug(s) if(debug_enable) print(s)
#define debug_hex(c) if(debug_enable) phex(c)
#define debug_hex16(i) if(debug_enable) phex(i)
#define debug_bin(c) if(debug_enable) pbin(c)
#define debug_bin_reverse(c) if(debug_enable) pbin_reverse(c)
bool debug_enable;
bool debug_matrix;
bool debug_keyboard;
bool debug_mouse;
#endif

1
hhkb/Makefile
View File

@ -39,6 +39,7 @@
# To rebuild project do "make clean" then "make all".
#----------------------------------------------------------------------------
DESCRIPTION = 't.m.k. firmware for HHKB pro\n'
# Target file name (without extension).
TARGET = tmk_hhkb

6
hhkb/controller.h Normal file
View File

@ -0,0 +1,6 @@
#ifndef CONTROLLER_H
#define CONTROLLER_H 1
#include "controller_teensy.h"
#endif

297
hhkb/keymap.c
View File

@ -1,173 +1,156 @@
/*
* keymap for HHKB pro
* Keymap for PFU HHKB Pro
*/
#include <stdbool.h>
#include <avr/pgmspace.h>
#include "usb_keyboard.h"
#include "usb_keycodes.h"
#include "matrix.h"
#include "keymap.h"
#include "print.h"
#include "debug.h"
#define FN_KEYCODE(fn) (pgm_read_byte(&fn_keycode[(fn)]))
#define FN_LAYER(fn) (pgm_read_byte(&fn_layer[(fn)]))
#define KEYMAPS(layer, row, col) (pgm_read_byte(&keymaps[(layer)][(row)][(col)]))
#define KEYCODE(layer, row, col) (pgm_read_byte(&keymaps[(layer)][(row)][(col)]))
#define KEYMAP( \
R3C1, R3C0, R0C0, R1C0, R1C1, R2C0, R2C1, R4C0, R4C1, R6C0, R6C1, R7C0, R7C1, R5C0, R5C1, \
R3C2, R0C1, R0C2, R1C3, R1C2, R2C3, R2C2, R4C2, R4C3, R6C2, R6C3, R7C3, R7C2, R5C2, \
R3C3, R0C4, R0C3, R1C4, R1C5, R2C4, R2C5, R4C5, R4C4, R6C5, R6C4, R7C4, R5C3, \
R3C4, R0C5, R0C6, R0C7, R1C6, R1C7, R2C6, R4C6, R6C6, R7C6, R7C5, R5C5, R5C4, \
R3C5, R3C6, R3C7, R5C7, R5C6 \
) \
{ \
{ R0C0, R0C1, R0C2, R0C3, R0C4, R0C5, R0C6, R0C7 }, \
{ R1C0, R1C1, R1C2, R1C3, R1C4, R1C5, R1C6, R1C7 }, \
{ R2C0, R2C1, R2C2, R2C3, R2C4, R2C5, R2C6, KB_NO }, \
{ R3C0, R3C1, R3C2, R3C3, R3C4, R3C5, R3C6, R3C7 }, \
{ R4C0, R4C1, R4C2, R4C3, R4C4, R4C5, R4C6, KB_NO }, \
{ R5C0, R5C1, R5C2, R5C3, R5C4, R5C5, R5C6, R5C7 }, \
{ R6C0, R6C1, R6C2, R6C3, R6C4, R6C5, R6C6, KB_NO }, \
{ R7C0, R7C1, R7C2, R7C3, R7C4, R7C5, R7C6, KB_NO } \
}
static int onbit(uint8_t bits);
static int current_layer = 0;
static bool layer_used = false;
static int onbit(uint8_t bits);
/*
* Layer0(Default Layer)
* ,-----------------------------------------------------------.
* |Esc| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =| \| `|
* |-----------------------------------------------------------|
* |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]|Backs|
* |-----------------------------------------------------------|
* |Contro| A| S| D| F| G| H| J| K| L|Fn3|Fn2|Return |
* |-----------------------------------------------------------|
* |Shift | Z| X| C| V| B| N| M| ,| .| /|Shift |Fn1|
* `-----------------------------------------------------------'
* |Gui|Alt |Space |Alt |Fn7|
* `-------------------------------------------'
*
* Layer1(HHKB Fn) HHKB mode
* ,-----------------------------------------------------------.
* |Pow| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
* |-----------------------------------------------------------|
* |Caps | | | | | | | |Psc|Slk|Pus|Up | |Backs|
* |-----------------------------------------------------------|
* |Contro|VoD|VoU|Mut| | | *| /|Hom|PgU|Lef|Rig|Enter |
* |-----------------------------------------------------------|
* |Shift | | | | | | +| -|End|PgD|Dow|Shift |xxx|
* `-----------------------------------------------------------'
* |Gui |Alt |Space |Alt |Gui|
* `--------------------------------------------'
*
* Layer2(Quote/Rmeta) vi mode
* ,-----------------------------------------------------------.
* |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
* |-----------------------------------------------------------|
* |Tab | | | | | |Hom|PgD|PgUlEnd| | | |Backs|
* |-----------------------------------------------------------|
* |Contro| | | | | |Lef|Dow|Up |Rig| |xxx|Return |
* |-----------------------------------------------------------|
* |Shift | | | | | | | | | | |Shift | |
* `-----------------------------------------------------------'
* |Gui|Alt |Sapce |Alt |xxx|
* `-------------------------------------------'
*
* Layer3(Semicolon) mouse mode
* ,-----------------------------------------------------------.
* |Esc| | | | | | | | | | | | | | |
* |-----------------------------------------------------------|
* |Tab | | | | | |MwL|MwD|MwU|MwR| | | |Backs|
* |-----------------------------------------------------------|
* |Contro| | | | | |McL|McD|McU|McR|xxx| |Return |
* |-----------------------------------------------------------|
* |Shift | | | | | | |Mb1|Mb2|Mb3| |Shift | |
* `-----------------------------------------------------------'
* |Gui |Alt |Mb1 |Alt |Gui|
* `--------------------------------------------'
*
* Layer4(Space) Matias half keyboard style
* ,-----------------------------------------------------------.
* | -| 0| 9| 8| 7| 6| 5| 4| 3| 2| 1| | | |Esc|
* |-----------------------------------------------------------|
* |Backs| P| O| I| U| Y| T| R| E| W| Q| | |Tab |
* |-----------------------------------------------------------|
* |Contro| ;| L| K| J| H| G| F| D| S| A|Con|Control |
* |-----------------------------------------------------------|
* |Shift | /| .| ,| M| N| B| V| C| X| Z|Shift | |
* `-----------------------------------------------------------'
* |Gui |Alt |xxxxxxxxxxxxxxxxxxxxxxx|Alt |Gui|
* `--------------------------------------------'
*
* Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
*/
/* layer to change into while Fn key pressed */
static const int PROGMEM fn_layer[] = { 0, 1, 2, 3, 4, 0, 0, 2 };
static const int PROGMEM fn_layer[] = { 0, 1, 2, 3, 4, 0, 0, 0 };
/* keycode to sent when Fn key released without using layer keys. */
static const uint8_t PROGMEM fn_keycode[] = {
KB_NO, // FN_0 [NOT USED]
KB_NO, // FN_1 layer 1
KB_NO, // FN_2 layer 2
KB_QUOTE, // FN_2 layer 2
KB_SCOLON, // FN_3 layer 3
KB_SPACE, // FN_4 layer 4 [NOT USED]
KB_NO, // FN_5 [NOT USED]
KB_NO, // FN_6 [NOT USED]
KB_QUOTE, // FN_7 layer 2
KB_NO // FN_7 [NOT USED]
};
static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* plain keymap
{
{ KB_2, KB_Q, KB_W, KB_S, KB_A, KB_Z, KB_X, KB_C },
{ KB_3, KB_4, KB_R, KB_E, KB_D, KB_F, KB_V, KB_B },
{ KB_5, KB_6, KB_Y, KB_T, KB_G, KB_H, KB_N, KB_NO },
{ KB_1, KB_ESCAPE, KB_TAB, KB_LCTRL, KB_LSHIFT, KB_LGUI, KB_LALT, KB_SPACE },
{ KB_7, KB_8, KB_U, KB_I, KB_K, KB_J, KB_M, KB_NO },
{ KB_BSLASH, KB_GRAVE, KB_BSPACE, KB_ENTER, FN_1, KB_RSHIFT, KB_RGUI, KB_RALT },
{ KB_9, KB_0, KB_O, KB_P, KB_SCOLON, KB_L, KB_COMMA, KB_NO },
{ KB_MINUS, KB_EQUAL, KB_RBRACKET,KB_LBRACKET,KB_QUOTE, KB_SLASH, KB_DOT, KB_NO },
},
*/
// 0: default
{
{ KB_2, KB_Q, KB_W, KB_S, KB_A, KB_Z, KB_X, KB_C },
{ KB_3, KB_4, KB_R, KB_E, KB_D, KB_F, KB_V, KB_B },
{ KB_5, KB_6, KB_Y, KB_T, KB_G, KB_H, KB_N, KB_NO },
{ KB_1, KB_ESCAPE, KB_TAB, KB_LCTRL, KB_LSHIFT, KB_LGUI, KB_LALT, KB_SPACE },
{ KB_7, KB_8, KB_U, KB_I, KB_K, KB_J, KB_M, KB_NO },
{ KB_BSLASH, KB_GRAVE, KB_BSPACE, KB_ENTER, FN_1, KB_RSHIFT, FN_2, KB_RALT },
{ KB_9, KB_0, KB_O, KB_P, FN_3, KB_L, KB_COMMA, KB_NO },
{ KB_MINUS, KB_EQUAL, KB_RBRACKET,KB_LBRACKET,FN_7, KB_SLASH, KB_DOT, KB_NO },
},
// 1: HHKB mode(HHKB Fn)
{
{ KB_F2, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO },
{ KB_F3, KB_F4, KB_NO, KB_NO, KB_MUTE, KB_F20, KB_NO, KB_NO },
{ KB_F5, KB_F6, KB_NO, KB_NO, KB_NO, KP_ASTERISK,KP_PLUS, KB_NO },
{ KB_F1, KB_POWER, KB_CAPSLOCK,KB_LCTRL, KB_LSHIFT, KB_LGUI, KB_LALT, KB_SPACE },
{ KB_F7, KB_F8, KB_NO, KB_PSCREEN, KB_HOME, KP_SLASH, KB_MINUS, KB_NO },
{ KB_INSERT, KB_DELETE, KB_BSPACE, KP_ENTER, KB_NO, KB_RSHIFT, KB_RGUI, KB_RALT },
{ KB_F9, KB_F10, KB_SCKLOCK, KB_BREAK, KB_LEFT, KB_PGUP, KB_END, KB_NO },
{ KB_F11, KB_F12, KB_NO, KB_UP, KB_RIGHT, KB_DOWN, KB_PGDOWN, KB_NO },
},
// 2: vi mode(Quote/Rmeta)
{
{ KB_F2, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO },
{ KB_F3, KB_F4, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO },
{ KB_F5, KB_F6, KB_HOME, KB_NO, KB_NO, KB_LEFT, KB_NO, KB_NO },
{ KB_F1, KB_ESCAPE, KB_TAB, KB_LCTRL, KB_LSHIFT, KB_LGUI, KB_LALT, KB_SPACE },
{ KB_F7, KB_F8, KB_PGDOWN, KB_PGUP, KB_UP, KB_DOWN, KB_NO, KB_NO },
{ KB_INSERT, KB_DELETE, KB_BSPACE, KB_ENTER, KB_NO, KB_RSHIFT, KB_NO, KB_RALT },
{ KB_F9, KB_F10, KB_END, KB_NO, KB_NO, KB_RIGHT, KB_NO, KB_NO },
{ KB_F11, KB_F12, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO },
},
// 3: vi mouse mode(Semicolon)
{
{ KB_F2, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO },
{ KB_F3, KB_F4, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO },
{ KB_F5, KB_F6, MS_WH_LEFT, KB_NO, KB_NO, MS_LEFT, MS_BTN2, KB_NO },
{ KB_F1, KB_ESCAPE, KB_TAB, KB_LCTRL, KB_LSHIFT, KB_LGUI, KB_LALT, MS_BTN1 },
{ KB_F7, KB_F8, MS_WH_DOWN, MS_WH_UP, MS_UP, MS_DOWN, MS_BTN1, KB_NO },
{ KB_NO, KB_NO, KB_BSPACE, KB_ENTER, KB_NO, KB_RSHIFT, KB_RGUI, KB_RALT },
{ KB_F9, KB_F10, MS_WH_RIGHT,KB_NO, KB_NO, MS_RIGHT, MS_BTN2, KB_NO },
{ KB_F11, KB_F12, KB_NO, KB_NO, KB_NO, KB_NO, MS_BTN3, KB_NO },
},
// 4: Matias half keyboard style(Space)
{
{ KB_9, KB_P, KB_O, KB_L, KB_SCOLON, KB_SLASH, KB_DOT, KB_COMMA },
{ KB_8, KB_7, KB_U, KB_I, KB_K, KB_J, KB_M, KB_N },
{ KB_6, KB_5, KB_T, KB_Y, KB_H, KB_G, KB_B, KB_NO },
{ KB_0, KB_MINUS, KB_BSPACE, KB_LCTRL, KB_LSHIFT, KB_LGUI, KB_LALT, KB_NO },
{ KB_4, KB_3, KB_R, KB_E, KB_D, KB_F, KB_V, KB_NO },
{ KB_NO, KB_ESCAPE, KB_TAB, KB_RCTRL, FN_1, KB_RSHIFT, KB_RGUI, KB_RALT },
{ KB_2, KB_1, KB_W, KB_Q, KB_A, KB_S, KB_C, KB_NO },
{ KB_NO, KB_NO, KB_RBRACKET,KB_LBRACKET,KB_QUOTE, KB_Z, KB_X, KB_NO },
},
/* Layer 0: Default Layer
* ,-----------------------------------------------------------.
* |Esc| 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =| \| `|
* |-----------------------------------------------------------|
* |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]|Backs|
* |-----------------------------------------------------------|
* |Contro| A| S| D| F| G| H| J| K| L|Fn3|Fn2|Return |
* |-----------------------------------------------------------|
* |Shift | Z| X| C| V| B| N| M| ,| .| /|Shift |Fn1|
* `-----------------------------------------------------------'
* |Gui|Alt |Space |Alt |Gui|
* `-------------------------------------------'
*/
KEYMAP(KB_ESC, KB_1, KB_2, KB_3, KB_4, KB_5, KB_6, KB_7, KB_8, KB_9, KB_0, KB_MINS,KB_EQL, KB_BSLS,KB_GRV, \
KB_TAB, KB_Q, KB_W, KB_E, KB_R, KB_T, KB_Y, KB_U, KB_I, KB_O, KB_P, KB_LBRC,KB_RBRC,KB_BSPC, \
KB_LCTL,KB_A, KB_S, KB_D, KB_F, KB_G, KB_H, KB_J, KB_K, KB_L, FN_3, FN_2, KB_ENT, \
KB_LSFT,KB_Z, KB_X, KB_C, KB_V, KB_B, KB_N, KB_M, KB_COMM,KB_DOT, KB_SLSH,KB_RSFT,FN_1, \
KB_LGUI,KB_LALT,KB_SPC, KB_RALT,KB_RGUI),
/* Layer 1: HHKB mode (HHKB Fn)
* ,-----------------------------------------------------------.
* |Pow| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
* |-----------------------------------------------------------|
* |Caps | | | | | | | |Psc|Slk|Pus|Up | |Backs|
* |-----------------------------------------------------------|
* |Contro| | | | | | *| /|Hom|PgU|Lef|Rig|Enter |
* |-----------------------------------------------------------|
* |Shift | | | | | | +| -|End|PgD|Dow|Shift |xxx|
* `-----------------------------------------------------------'
* |Gui |Alt |Space |Alt |Gui|
* `--------------------------------------------'
*/
KEYMAP(KB_PWR, KB_F1, KB_F2, KB_F3, KB_F4, KB_F5, KB_F6, KB_F7, KB_F8, KB_F9, KB_F10, KB_F11, KB_F12, KB_INS, KB_DEL, \
KB_CAPS,KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_PSCR,KB_SLCK,KB_BRK, KB_UP, KB_NO, KB_BSPC, \
KB_LCTL,KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KP_ASTR,KP_SLSH,KB_HOME,KB_PGUP,KB_LEFT,KB_RGHT,KB_ENT, \
KB_LSFT,KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KP_PLUS,KP_MINS,KB_END, KB_PGDN,KB_DOWN,KB_RSFT,FN_1, \
KB_LGUI,KB_LALT,KB_SPC, KB_RALT,KB_RGUI),
/* Layer 2: Vi mode (Quote/Rmeta)
* ,-----------------------------------------------------------.
* |Esc| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
* |-----------------------------------------------------------|
* |Tab |Hom|PgD|Up |PgU|End|Hom|PgD|PgUlEnd| | | |Backs|
* |-----------------------------------------------------------|
* |Contro| |Lef|Dow|Rig| |Lef|Dow|Up |Rig| |xxx|Return |
* |-----------------------------------------------------------|
* |Shift | | | | | | | | | | |Shift | |
* `-----------------------------------------------------------'
* |Gui|Alt |Sapce |Alt |Gui|
* `-------------------------------------------'
*/
KEYMAP(KB_ESC, KB_F1, KB_F2, KB_F3, KB_F4, KB_F5, KB_F6, KB_F7, KB_F8, KB_F9, KB_F10, KB_F11, KB_F12, KB_INS, KB_DEL, \
KB_TAB, KB_HOME,KB_PGDN,KB_UP, KB_PGUP,KB_END, KB_HOME,KB_PGDN,KB_PGUP,KB_END, KB_NO, KB_NO, KB_NO, KB_BSPC, \
KB_LCTL,KB_NO, KB_LEFT,KB_DOWN,KB_RGHT,KB_NO, KB_LEFT,KB_DOWN,KB_UP, KB_RGHT,KB_NO, FN_2, KB_ENT, \
KB_LSFT,KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_NO, KB_RSFT,KB_NO, \
KB_LGUI,KB_LALT,KB_SPC, KB_RALT,KB_RGUI),
/* Layer 3: Mouse mode (Semicolon)
* ,-----------------------------------------------------------.
* |Esc| | | | | | | | | | | | | | |
* |-----------------------------------------------------------|
* |Tab |MwL|MwU|McU|MwD|MwL|MwR|MwD|MwU|MwR| | | |Backs|
* |-----------------------------------------------------------|
* |Contro| |McL|McD|McR| |McL|McD|McU|McR|xxx| |Return |
* |-----------------------------------------------------------|
* |Shift | | | | | |Mb2|Mb1|Mb2|Mb3| |Shift | |
* `-----------------------------------------------------------'
* |Gui |Alt |Mb1 |Alt |Gui|
* `--------------------------------------------'
* Mc: Mouse Cursor / Mb: Mouse Button / Mw: Mouse Wheel
*/
KEYMAP(KB_ESC, KB_F1, KB_F2, KB_F3, KB_F4, KB_F5, KB_F6, KB_F7, KB_F8, KB_F9, KB_F10, KB_F11, KB_F12, KB_INS, KB_DEL, \
KB_TAB, MS_WH_L,MS_WH_U,MS_UP, MS_WH_D,MS_WH_R,MS_WH_L,MS_WH_D,MS_WH_U,MS_WH_R,KB_NO, KB_NO, KB_NO, KB_BSPC, \
KB_LCTL,KB_NO, MS_LEFT,MS_DOWN,MS_RGHT,KB_NO, MS_LEFT,MS_DOWN,MS_UP, MS_RGHT,FN_3, KB_NO, KB_ENT, \
KB_LSFT,KB_NO, MS_DOWN,KB_NO, KB_NO, KB_NO, MS_BTN2,MS_BTN1,MS_BTN2,MS_BTN3,KB_NO, KB_RSFT,KB_NO, \
KB_LGUI,KB_LALT,MS_BTN1,KB_RALT,KB_RGUI),
/* Layer 4: Matias half keyboard style (Space)
* ,-----------------------------------------------------------.
* | -| 0| 9| 8| 7| 6| 5| 4| 3| 2| 1| | | |Esc|
* |-----------------------------------------------------------|
* |Backs| P| O| I| U| Y| T| R| E| W| Q| | |Tab |
* |-----------------------------------------------------------|
* |Contro| ;| L| K| J| H| G| F| D| S| A|Con|Control |
* |-----------------------------------------------------------|
* |Shift | /| .| ,| M| N| B| V| C| X| Z|Shift | |
* `-----------------------------------------------------------'
* |Gui |Alt |xxxxxxxxxxxxxxxxxxxxxxx|Alt |Gui|
* `--------------------------------------------'
*/
KEYMAP(KB_MINS,KB_0, KB_9, KB_8, KB_7, KB_6, KB_5, KB_4, KB_3, KB_2, KB_1, KB_NO, KB_NO, KB_NO, KB_ESC, \
KB_BSPC,KB_P, KB_O, KB_I, KB_U, KB_Y, KB_T, KB_R, KB_E, KB_W, KB_Q, KB_NO, KB_NO, KB_TAB, \
KB_LCTL,KB_SCLN,KB_L, KB_K, KB_J, KB_H, KB_G, KB_F, KB_D, KB_S, KB_A, KB_RCTL,KB_RCTL, \
KB_LSFT,KB_SLSH,KB_DOT, KB_COMM,KB_M, KB_N, KB_B, KB_V, KB_C, KB_X, KB_Z, KB_RSFT,KB_NO, \
KB_LGUI,KB_LALT,FN_4, KB_RALT,KB_RGUI)
};
@ -178,26 +161,34 @@ uint8_t keymap_get_keycode(int row, int col)
uint8_t keymap_get_keycodel(int layer, int row, int col)
{
uint8_t code = KEYMAPS(layer, row, col);
uint8_t code = KEYCODE(layer, row, col);
// normal key or mouse key
if ((KB_A <= code && code <= KP_HEXADECIMAL) ||
(MS_UP <= code && code <= MS_WH_RIGHT))
if (IS_KEY(code) || IS_MOUSE(code))
layer_used = true;
return code;
}
inline
int keymap_get_layer(void) {
int keymap_get_layer(void)
{
return current_layer;
}
inline
int keymap_set_layer(int layer) {
int keymap_set_layer(int layer)
{
current_layer = layer;
return current_layer;
}
void keymap_fn_proc(int fn_bits) {
inline
bool keymap_is_special_mode(int fn_bits)
{
return (keyboard_modifier_keys == (BIT_LCTRL | BIT_LSHIFT | BIT_LALT | BIT_LGUI));
}
void keymap_fn_proc(int fn_bits)
{
// layer switching
static int last_bits = 0;
static uint8_t last_mod = 0;
@ -210,7 +201,7 @@ void keymap_fn_proc(int fn_bits) {
if (!layer_used) {
uint8_t code = FN_KEYCODE(onbit(last_bits));
if (code != KB_NO) {
if (KB_LCTRL <= code && code <= KB_RGUI) {
if (IS_MOD(code)) {
keyboard_modifier_keys = last_mod | 1<<(code & 0x07);
} else {
keyboard_keys[0] = code;
@ -225,20 +216,20 @@ void keymap_fn_proc(int fn_bits) {
last_mod = 0;
layer_used = false;
keymap_set_layer(0); // default layer
print("layer default: "); phex(current_layer); print("\n");
} else if ((fn_bits & (fn_bits - 1)) == 0) {
// switch layer when just one Fn Key is pressed
last_bits = fn_bits;
last_mod = keyboard_modifier_keys;
layer_used = false;
keymap_set_layer(FN_LAYER(onbit(fn_bits)));
print("layer: "); phex(current_layer); print("\n");
print("last_bits: "); phex(last_bits); print("\n");
print("last_mod: "); phex(last_mod); print("\n");
debug("layer: "); phex(current_layer); debug("(");
debug_bin(last_bits); debug(")\n");
debug("last_mod: "); debug_hex(last_mod); debug("\n");
}
}
static int onbit(uint8_t bits) {
static int onbit(uint8_t bits)
{
int n = 0;
if (bits >> 4) { bits >>= 4; n += 4;}
if (bits >> 2) { bits >>= 2; n += 2;}

44
hhkb/matrix.c
View File

@ -35,12 +35,14 @@ static int bit_pop(uint8_t bits);
inline
int matrix_rows(void) {
int matrix_rows(void)
{
return MATRIX_ROWS;
}
inline
int matrix_cols(void) {
int matrix_cols(void)
{
return MATRIX_COLS;
}
@ -55,8 +57,8 @@ void matrix_init(void)
PORTE = 0xC0;
// initialize matrix state: all keys off
for (int i=0; i < MATRIX_ROWS; i++) _matrix0[i] = 0xFF;
for (int i=0; i < MATRIX_ROWS; i++) _matrix1[i] = 0xFF;
for (int i=0; i < MATRIX_ROWS; i++) _matrix0[i] = 0x00;
for (int i=0; i < MATRIX_ROWS; i++) _matrix1[i] = 0x00;
matrix = _matrix0;
matrix_prev = _matrix1;
}
@ -76,9 +78,9 @@ int matrix_scan(void)
KEY_ENABLE;
_delay_us(10); // from logic analyzer chart
if (KEY_ON) {
matrix[row] &= ~(1<<col);
} else {
matrix[row] |= (1<<col);
} else {
matrix[row] &= ~(1<<col);
}
KEY_UNABLE;
_delay_us(150); // from logic analyzer chart
@ -87,7 +89,8 @@ int matrix_scan(void)
return 1;
}
bool matrix_is_modified(void) {
bool matrix_is_modified(void)
{
for (int i = 0; i < MATRIX_ROWS; i++) {
if (matrix[i] != matrix_prev[i])
return true;
@ -96,16 +99,25 @@ bool matrix_is_modified(void) {
}
inline
bool matrix_has_ghost(void) {
bool matrix_has_ghost(void)
{
return false;
}
inline
uint16_t matrix_get_row(int row) {
bool matrix_is_on(int row, int col)
{
return (matrix[row] & (1<<col));
}
inline
uint16_t matrix_get_row(int row)
{
return matrix[row];
}
void matrix_print(void) {
void matrix_print(void)
{
print("\nr/c 01234567\n");
for (int row = 0; row < matrix_rows(); row++) {
phex(row); print(": ");
@ -117,20 +129,24 @@ void matrix_print(void) {
}
}
int matrix_key_count(void) {
int matrix_key_count(void)
{
int count = 0;
for (int i = 0; i < MATRIX_ROWS; i++) {
count += bit_pop(~matrix[i]);
count += bit_pop(matrix[i]);
}
return count;
}
inline
static bool matrix_has_ghost_in_row(int row) {
static bool matrix_has_ghost_in_row(int row)
{
return false;
}
static int bit_pop(uint8_t bits) {
inline
static int bit_pop(uint8_t bits)
{
int c;
for (c = 0; bits; c++)
bits &= bits -1;

171
key_process.c
View File

@ -1,28 +1,24 @@
// TODO: clean unused headers
#include <stdbool.h>
#include <avr/io.h>
#include <avr/pgmspace.h>
#include <avr/interrupt.h>
#include <util/delay.h>
#include "usb.h"
#include "usb_keyboard.h"
#include "usb_mouse.h"
#include "usb_keycodes.h"
#include "print.h"
#include "debug.h"
#include "util.h"
#include "jump_bootloader.h"
#include "matrix_skel.h"
#include "keymap_skel.h"
#include "controller.h"
#include "key_process.h"
// for Teensy/Teensy++ 2.0
#define LED_CONFIG (DDRD |= (1<<6))
#define LED_ON (PORTD |= (1<<6))
#define LED_OFF (PORTD &= ~(1<<6))
#define MOUSE_MOVE_UNIT 10
#define MOUSE_DELAY_MS 200
#define MOUSE_DELAY_ACC 5
#define MOUSE_MOVE_ACCEL (mouse_repeat < 50 ? mouse_repeat/5 : 10)
#define MOUSE_DELAY_TIME 255
#define MOUSE_DELAY_MS (MOUSE_DELAY_TIME >> (mouse_repeat < 5 ? mouse_repeat : 5))
// TODO: refactoring
@ -35,7 +31,7 @@ void proc_matrix(void) {
uint8_t mouse_btn = 0;
int8_t mouse_x = 0;
int8_t mouse_y = 0;
int8_t mouse_wheel = 0;
int8_t mouse_vwheel = 0;
int8_t mouse_hwheel = 0;
int fn_bits = 0;
@ -43,50 +39,51 @@ void proc_matrix(void) {
modified = matrix_is_modified();
if (modified) {
matrix_print();
if (debug_matrix) matrix_print();
#ifdef DEBUG_LED
// LED flash for debug
LED_CONFIG;
LED_ON;
DEBUG_LED_CONFIG;
DEBUG_LED_ON;
#endif
}
if (matrix_has_ghost()) {
// should send error?
print("matrix has ghost!!\n");
debug("matrix has ghost!!\n");
return;
}
usb_keyboard_clear();
for (int row = 0; row < matrix_rows(); row++) {
for (int col = 0; col < matrix_cols(); col++) {
if (matrix_get_row(row) & 1<<col) continue;
if (!matrix_is_on(row, col)) continue;
uint8_t code = keymap_get_keycode(row, col);
if (code == KB_NO) {
code = keymap_get_keycodel(0, row, col);
if (FN_0 <= code && code <= FN_7) {
fn_bits |= 1<<(code - FN_0);
}
} else if (KB_LCTRL <= code && code <= KB_RGUI) {
// modifier keys(0xE0-0xE7)
keyboard_modifier_keys |= 1<<(code & 0x07);
} else if (code >= MS_UP) {
// do nothing
} else if (IS_MOD(code)) {
keyboard_modifier_keys |= MOD_BIT(code);
} else if (IS_MOUSE(code)) {
// mouse
if (code == MS_UP) mouse_y -= MOUSE_MOVE_UNIT + (mouse_repeat < 50 ? mouse_repeat/5 : 10);
if (code == MS_DOWN) mouse_y += MOUSE_MOVE_UNIT + (mouse_repeat < 50 ? mouse_repeat/5 : 10);
if (code == MS_LEFT) mouse_x -= MOUSE_MOVE_UNIT + (mouse_repeat < 50 ? mouse_repeat/5 : 10);
if (code == MS_RIGHT) mouse_x += MOUSE_MOVE_UNIT + (mouse_repeat < 50 ? mouse_repeat/5 : 10);
if (code == MS_BTN1) mouse_btn |= 1<<0;
if (code == MS_BTN2) mouse_btn |= 1<<1;
if (code == MS_BTN3) mouse_btn |= 1<<2;
if (code == MS_BTN4) mouse_btn |= 1<<3;
if (code == MS_BTN5) mouse_btn |= 1<<4;
if (code == MS_WH_UP) mouse_wheel += 1;
if (code == MS_WH_DOWN) mouse_wheel -= 1;
if (code == MS_UP)
mouse_y -= MOUSE_MOVE_UNIT + MOUSE_MOVE_ACCEL;
if (code == MS_DOWN)
mouse_y += MOUSE_MOVE_UNIT + MOUSE_MOVE_ACCEL;
if (code == MS_LEFT)
mouse_x -= MOUSE_MOVE_UNIT + MOUSE_MOVE_ACCEL;
if (code == MS_RIGHT)
mouse_x += MOUSE_MOVE_UNIT + MOUSE_MOVE_ACCEL;
if (code == MS_BTN1) mouse_btn |= BIT_BTN1;
if (code == MS_BTN2) mouse_btn |= BIT_BTN2;
if (code == MS_BTN3) mouse_btn |= BIT_BTN3;
if (code == MS_BTN4) mouse_btn |= BIT_BTN4;
if (code == MS_BTN5) mouse_btn |= BIT_BTN5;
if (code == MS_WH_UP) mouse_vwheel += 1;
if (code == MS_WH_DOWN) mouse_vwheel -= 1;
if (code == MS_WH_LEFT) mouse_hwheel -= 1;
if (code == MS_WH_RIGHT) mouse_hwheel += 1;
} else if (FN_0 <= code && code <= FN_7) {
fn_bits |= 1<<(code - FN_0);
} else if (IS_FN(code)) {
fn_bits |= FN_BIT(code);
} else {
// normal keys
if (key_index < 6)
@ -98,41 +95,103 @@ void proc_matrix(void) {
keymap_fn_proc(fn_bits);
// when 4 left modifier keys down
if (keyboard_modifier_keys == (MOD_LCTRL | MOD_LSHIFT | MOD_LALT | MOD_LGUI)) {
// cancel all keys
keyboard_modifier_keys = 0;
for (int i = 0; i < 6; i++) keyboard_keys[i] = KB_NO;
usb_keyboard_send();
print("jump to bootloader...\n");
_delay_ms(100);
jump_bootloader(); // not return
if (keymap_is_special_mode(fn_bits)) {
switch (keyboard_keys[0]) {
case KB_B: // bootloader
usb_keyboard_clear();
usb_keyboard_send();
print_enable = true;
print("jump to bootloader...\n");
_delay_ms(1000);
jump_bootloader(); // not return
break;
case KB_D: // debug all toggle
usb_keyboard_clear();
usb_keyboard_send();
debug_enable = !debug_enable;
if (debug_enable) {
print("debug enabled.\n");
print_enable = true;
debug_matrix = true;
debug_keyboard = true;
debug_mouse = true;
} else {
print("debug disabled.\n");
print_enable = false;
debug_matrix = false;
debug_keyboard = false;
debug_mouse = false;
}
_delay_ms(1000);
break;
case KB_X: // debug matrix toggle
usb_keyboard_clear();
usb_keyboard_send();
debug_matrix = !debug_matrix;
if (debug_matrix)
print("debug matrix enabled.\n");
else
print("debug matrix disabled.\n");
_delay_ms(1000);
break;
case KB_K: // debug keyboard toggle
usb_keyboard_clear();
usb_keyboard_send();
debug_keyboard = !debug_keyboard;
if (debug_keyboard)
print("debug keyboard enabled.\n");
else
print("debug keyboard disabled.\n");
_delay_ms(1000);
break;
case KB_M: // debug mouse toggle
usb_keyboard_clear();
usb_keyboard_send();
debug_mouse = !debug_mouse;
if (debug_mouse)
print("debug mouse enabled.\n");
else
print("debug mouse disabled.\n");
_delay_ms(1000);
break;
case KB_V: // print version & information
usb_keyboard_clear();
usb_keyboard_send();
print(XSTR(DESCRIPTION));
_delay_ms(1000);
break;
}
}
if (mouse_x || mouse_y || mouse_wheel || mouse_hwheel || mouse_btn != mouse_buttons) {
// send mouse packet to host
if (mouse_x || mouse_y || mouse_vwheel || mouse_hwheel || mouse_btn != mouse_buttons) {
mouse_buttons = mouse_btn;
usb_mouse_move(mouse_x, mouse_y, mouse_wheel, mouse_hwheel);
usb_mouse_print(mouse_x, mouse_y, mouse_wheel, mouse_hwheel);
if (mouse_x && mouse_y)
usb_mouse_move(mouse_x*0.7, mouse_y*0.7, mouse_vwheel, mouse_hwheel);
else
usb_mouse_move(mouse_x, mouse_y, mouse_vwheel, mouse_hwheel);
usb_mouse_print(mouse_x, mouse_y, mouse_vwheel, mouse_hwheel);
// acceleration
_delay_ms(MOUSE_DELAY_MS >> (mouse_repeat < MOUSE_DELAY_ACC ? mouse_repeat : MOUSE_DELAY_ACC));
_delay_ms(MOUSE_DELAY_MS);
mouse_repeat++;
} else {
mouse_repeat = 0;
}
// send keys to host
// send key packet to host
if (modified) {
if (key_index > 6) {
//Rollover
}
usb_keyboard_send();
usb_keyboard_print();
#ifdef DEBUG_LED
// LED flash for debug
LED_CONFIG;
LED_OFF;
DEBUG_LED_CONFIG;
DEBUG_LED_OFF;
#endif
}
}

1
keymap_skel.h
View File

@ -11,6 +11,7 @@ uint8_t keymap_get_keycodel(int layer, int row, int col);
int keymap_get_layer(void);
int keymap_set_layer(int layer);
bool keymap_is_special_mode(int fn_bits);
/* process Fn keys. This.should be called every scan. */
void keymap_fn_proc(int fn_bits);

2
matrix_skel.h
View File

@ -15,6 +15,8 @@ int matrix_scan(void);
bool matrix_is_modified(void);
/* whether ghosting occur on matrix. */
bool matrix_has_ghost(void);
/* whether a swtich is on */
bool matrix_is_on(int row, int col);
/* matrix state on row */
uint16_t matrix_get_row(int row);
/* count keys pressed */

43
tmk.c
View File

@ -24,30 +24,25 @@
* THE SOFTWARE.
*/
// TODO: clean unused headers
#include <stdbool.h>
#include <avr/io.h>
#include <avr/pgmspace.h>
#include <avr/interrupt.h>
#include <util/delay.h>
#include "usb.h"
#include "usb_keyboard.h"
#include "usb_mouse.h"
#include "print.h"
#include "matrix_skel.h"
#include "keymap.h"
#include "jump_bootloader.h"
#include "key_process.h"
#include "print.h"
#include "debug.h"
#include "util.h"
#include "controller.h"
#define CPU_PRESCALE(n) (CLKPR = 0x80, CLKPR = (n))
// TODO: should go to hardware dependent file
// for Teensy/Teensy++ 2.0
#define LED_CONFIG (DDRD |= (1<<6))
#define LED_ON (PORTD |= (1<<6))
#define LED_OFF (PORTD &= ~(1<<6))
bool debug_enable = false;
bool debug_matrix = false;
bool debug_keyboard = false;
bool debug_mouse = false;
uint16_t idle_count=0;
@ -74,20 +69,26 @@ int main(void)
matrix_init();
matrix_scan();
// debug on when 4 keys are pressed
// debug on by pressing down any 4 keys during boot time.
if (matrix_key_count() == 4) print_enable = true;
/* wait for debug pipe to print greetings. */
/* wait for debug pipe ready */
if (print_enable) {
for (int i =0; i < 6; i++) {
LED_CONFIG;
LED_ON;
#ifdef DEBUG_LED
for (int i = 0; i < 6; i++) {
DEBUG_LED_CONFIG;
DEBUG_LED_ON;
_delay_ms(500);
LED_OFF;
DEBUG_LED_OFF;
_delay_ms(500);
}
#else
_delay_ms(6000);
#endif
}
print("\nt.m.k. keyboard 1.2\n");
// print description
print(XSTR(DESCRIPTION));
while (1) {
proc_matrix();
_delay_ms(2);

2
usb_keyboard.c
View File

@ -2,6 +2,7 @@
#include <avr/pgmspace.h>
#include "usb_keyboard.h"
#include "print.h"
#include "debug.h"
static bool is_sent = false;
@ -112,6 +113,7 @@ bool usb_keyboard_has_mod(void) {
}
void usb_keyboard_print(void) {
if (!debug_keyboard) return;
print("\nkeys: ");
for (int i = 0; i < 6; i++) { phex(keyboard_keys[i]); print(" "); }
print("\n");

22
usb_keyboard.h
View File

@ -11,16 +11,18 @@
#define KEYBOARD_SIZE 8
#define KEYBOARD_BUFFER EP_DOUBLE_BUFFER
// TODO: move to usb_keycodes.h ?
// modifier bits
#define MOD_LCTRL (1<<0)
#define MOD_LSHIFT (1<<1)
#define MOD_LALT (1<<2)
#define MOD_LGUI (1<<3)
#define MOD_RCTRL (1<<4)
#define MOD_RSHIFT (1<<5)
#define MOD_RALT (1<<6)
#define MOD_RGUI (1<<7)
#define BIT_LCTRL (1<<0)
#define BIT_LSHIFT (1<<1)
#define BIT_LALT (1<<2)
#define BIT_LGUI (1<<3)
#define BIT_RCTRL (1<<4)
#define BIT_RSHIFT (1<<5)
#define BIT_RALT (1<<6)
#define BIT_RGUI (1<<7)
#define BIT_LCTL BIT_LCTRL
#define BIT_RCTL BIT_RCTRL
#define BIT_LSFT BIT_LSHIFT
#define BIT_RSFT BIT_RSHIFT
// TODO: change variable name: usb_keyboard_ or usb_kb_

49
usb_keycodes.h
View File

@ -36,6 +36,55 @@
#ifndef USB_KEYCODES_H
#define USB_KEYCODES_H
#define IS_ERROR(code) (KB_ROLL_OVER <= (code) && (code) <= KB_UNDEFINED)
#define IS_KEY(code) (KB_A <= (code) && (code) <= KP_HEXADECIMAL)
#define IS_MOD(code) (KB_LCTRL <= (code) && (code) <= KB_RGUI)
#define IS_FN(code) (FN_0 <= (code) && (code) <= FN_7)
#define IS_MOUSE(code) (MS_UP <= (code) && (code) <= MS_WH_RIGHT)
#define IS_MOUSE_MOVE(code) (MS_UP <= (code) && (code) <= MS_RIGHT)
#define IS_MOUSE_BUTTON(code) (MS_BTN1 <= (code) && (code) <= MS_BTN5)
#define IS_MOUSE_WHEEL(code) (MS_WH_UP <= (code) && (code) <= MS_WH_RIGHT)
#define MOD_BIT(code) (1<<((code) & 0x07))
#define FN_BIT(code) (1<<((code) - FN_0))
// short names
#define KB_LCTL KB_LCTRL
#define KB_RCTL KB_RCTRL
#define KB_LSFT KB_LSHIFT
#define KB_RSFT KB_RSHIFT
#define KB_ESC KB_ESCAPE
#define KB_BSPC KB_BSPACE
#define KB_ENT KB_ENTER
#define KB_DEL KB_DELETE
#define KB_INS KB_INSERT
#define KB_CAPS KB_CAPSLOCK
#define KB_RGHT KB_RIGHT
#define KB_PGDN KB_PGDOWN
#define KB_PSCR KB_PSCREEN
#define KB_SLCK KB_SCKLOCK
#define KB_BRK KB_BREAK
#define KB_SPC KB_SPACE
#define KB_MINS KB_MINUS
#define KB_EQL KB_EQUAL
#define KB_GRV KB_GRAVE
#define KB_RBRC KB_RBRACKET
#define KB_LBRC KB_LBRACKET
#define KB_COMM KB_COMMA
#define KB_BSLS KB_BSLASH
#define KB_SLSH KB_SLASH
#define KB_SCLN KB_SCOLON
#define KB_PWR KB_POWER
#define KP_SLSH KP_SLASH
#define KP_ASTR KP_ASTERISK
#define KP_MINS KP_MINUS
#define MS_RGHT MS_RIGHT
#define MS_WH_U MS_WH_UP
#define MS_WH_D MS_WH_DOWN
#define MS_WH_L MS_WH_LEFT
#define MS_WH_R MS_WH_RIGHT
enum keycodes {
KB_NO = 0,

2
usb_mouse.c
View File

@ -2,6 +2,7 @@
#include <util/delay.h>
#include "usb_mouse.h"
#include "print.h"
#include "debug.h"
static bool is_sent = false;
@ -76,6 +77,7 @@ bool usb_mouse_is_sent(void) {
}
void usb_mouse_print(int8_t mouse_x, int8_t mouse_y, int8_t wheel_v, int8_t wheel_h) {
if (!debug_mouse) return;
print("mouse btn|x y v h: ");
phex(mouse_buttons); print("|");
phex(mouse_x); print(" ");

7
usb_mouse.h
View File

@ -11,6 +11,13 @@
#define MOUSE_SIZE 8
#define MOUSE_BUFFER EP_DOUBLE_BUFFER
#define BIT_BTN1 (1<<0)
#define BIT_BTN2 (1<<1)
#define BIT_BTN3 (1<<2)
#define BIT_BTN4 (1<<3)
#define BIT_BTN5 (1<<4)
extern uint8_t mouse_buttons;
extern uint8_t mouse_protocol;

7
util.h Normal file
View File

@ -0,0 +1,7 @@
#ifndef UTIL_H
#define UTIL_H 1
#define XSTR(s) STR(s)
#define STR(s) #s
#endif