FIX: doc and keymap.

2 files changed, 38 insertions, 37 deletions

diff --git a/hhkb/doc/HHKB.txt b/hhkb/doc/HHKB.txt
index 9440efebf4..bdd297dcdb 100644
--- a/hhkb/doc/HHKB.txt
+++ b/hhkb/doc/HHKB.txt
@@ -46,14 +46,14 @@ Teensy++ installation
 Angled USB mini B adapter is used to install Teensy++ laterally.
 (teensy_install.jpg)
 
-Bread baord cables used for connect Teensy++.
+Bread baord wires are used to connect Teensy++.
 (teensy_wiring.jpg)
 (connector_contact.jpg)
 
 
 HHKB internal
 -------------
-HHKB pro has two PCBs and some chips.
+HHKB pro has some chips on separate two PCBs.
 
 Controller PCB:
     M38K07M4    Renesas MCU with USB function
@@ -76,7 +76,7 @@ Keyswitch PCB:
     (HHKB_TP1684.jpg)
 
 
-Two PCBs are connected by 15 lines. Vcc/GND uses 3 lines each, 9lines for keyboard signaling.
+Two PCBs are connected by 15 lines. Vcc and GND use 3 lines each, other 9 lines are for keyboard signaling.
 
     Keyswitch PCB connector                                 Teensy++ pins
     -------------------------------------------------------------------------------
@@ -101,7 +101,7 @@ Two PCBs are connected by 15 lines. Vcc/GND uses 3 lines each, 9lines for keyboa
 
 Keyswitch matrix
 ----------------
-60 keyswitches in 8*8 matrix. ghost free. bounce free.
+60 keyswitches in 8*8 matrix. It is ghost-free and bounce-free.
 
   COL 0     1       2       3       4       5       6       7
 ROW ---------------------------------------------------------------
@@ -181,6 +181,6 @@ Keymap layers
 -------------
 Followings are added layers with additional Fn keys. They are not final decision.
 
-see keymap_hhkb.c
+see keymap.c
 
 EOF
diff --git a/hhkb/keymap.c b/hhkb/keymap.c
index 6f4dc5cd17..57f20c31f4 100644
--- a/hhkb/keymap.c
+++ b/hhkb/keymap.c
@@ -23,14 +23,14 @@ static int onbit(uint8_t bits);
  * |-----------------------------------------------------------|
  * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|Backs|
  * |-----------------------------------------------------------|
- * |Contro|  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return  |
+ * |Contro|  A|  S|  D|  F|  G|  H|  J|  K|  L|Fn3|Fn2|Return  |
  * |-----------------------------------------------------------|
- * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Fn2   |Fn1|
+ * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift |Fn1|
  * `-----------------------------------------------------------'
- *       |Gui|Alt  |Space                  |Fn3  |Gui|
+ *       |Gui|Alt  |Space                  |Alt  |Fn7|
  *       `-------------------------------------------'
  * 
- * Layer1(Fn) HHKB mode
+ * Layer1(HHKB Fn) HHKB mode
  * ,-----------------------------------------------------------.
  * |Pow| F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|Ins|Del|
  * |-----------------------------------------------------------|
@@ -43,20 +43,20 @@ static int onbit(uint8_t bits);
  *      |Gui |Alt  |Space                  |Alt  |Gui|
  *      `--------------------------------------------'
  * 
- * Layer2(RALT) vi mode
+ * 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|   |   |Return  |
+ * |Contro|   |   |   |   |   |Lef|Dow|Up |Rig|   |xxx|Return  |
  * |-----------------------------------------------------------|
- * |Shift   |   |   |   |   |   |McL|McD|McU|McR|Mb1|Mb2   |   |
+ * |Shift   |   |   |   |   |   |   |   |   |   |   |Shift |   |
  * `-----------------------------------------------------------'
- *       |Gui|Alt  |Sapce                  |xxxxx|Mb3|
+ *       |Gui|Alt  |Sapce                  |Alt  |xxx|
  *       `-------------------------------------------'
  *
- * Layer3(semicolon) mouse mode
+ * Layer3(Semicolon) mouse mode
  * ,-----------------------------------------------------------.
  * |Esc|   |   |   |   |   |   |   |   |   |   |   |   |   |   |
  * |-----------------------------------------------------------|
@@ -69,7 +69,7 @@ static int onbit(uint8_t bits);
  *      |Gui |Alt  |Mb1                    |Alt  |Gui|
  *      `--------------------------------------------'
  *
- * Layer4 Matias half keyboard style
+ * Layer4(Space)  Matias half keyboard style
  * ,-----------------------------------------------------------.
  * |  -|  0|  9|  8|  7|  6|  5|  4|  3|  2|  1|   |   |   |Esc|
  * |-----------------------------------------------------------|
@@ -85,19 +85,20 @@ static int onbit(uint8_t bits);
  * 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 };
+
 /* keycode to sent when Fn key released without using layer keys. */
 static const uint8_t PROGMEM fn_keycode[] = {
-    KB_NO,          // FN_0
-    KB_NO,          // FN_1
-    KB_NO,          // FN_2
-    KB_SCOLON,      // FN_3
-    KB_SPACE,       // FN_4
-    KB_NO,          // FN_5
-    KB_NO,          // FN_6
-    KB_NO,          // FN_7
+    KB_NO,          // FN_0 [NOT USED]
+    KB_NO,          // FN_1 layer 1
+    KB_NO,          // 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
 };
-/* layer to change into while Fn key pressed */ 
-static const int PROGMEM fn_layer[] = { 0, 1, 2, 3, 4, 0, 0, 0 };
 
 static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 /*  plain keymap
@@ -119,11 +120,11 @@ static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
         { 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,    FN_2        },
+        { 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,KB_QUOTE,   KB_SLASH,   KB_DOT,     KB_NO       },
+        { KB_MINUS,   KB_EQUAL,   KB_RBRACKET,KB_LBRACKET,FN_7,       KB_SLASH,   KB_DOT,     KB_NO       },
     },
-    // 1: HHKB mode(Fn)
+    // 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       },
@@ -134,29 +135,29 @@ static const uint8_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
         { 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(RALT)
+    // 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,    MS_LEFT,    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,    MS_DOWN,    KB_NO       },
-        { KB_INSERT,  KB_DELETE,  KB_BSPACE,  KB_ENTER,   KB_NO,      MS_BTN2,    MS_BTN3,    KB_NO       },
-        { KB_F9,      KB_F10,     KB_END,     KB_NO,      KB_NO,      KB_RIGHT,   MS_UP,      KB_NO       },
-        { KB_F11,     KB_F12,     MS_WH_UP,   MS_WH_DOWN, KB_NO,      MS_BTN1,    MS_RIGHT,   KB_NO       },
+        { 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(SCOLON)
+    // 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,    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) [NOT USED]
+    // 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        },