Updated Previously Asked Questions (asciidoc => mediawiki)

[qmk_firmware.git] / FAQ.md

diff --git a/FAQ.md b/FAQ.md
index 8239546a543762d8f417594f2077a54bf310fe29..159959e33711d7de4b864236b3bfd0e483e37d29 100644 (file)
--- a/FAQ.md
+++ b/FAQ.md
@@ -1,4 +1,4 @@
-# READ FIRST\r
+## READ FIRST\r
 - **README** of top directory : https://github.com/tmk/tmk_keyboard/blob/master/README.md\r
 - **README** of target project(keyboard/converter) directory.\r
 \r
@@ -13,7 +13,7 @@ Note that you'll need to read **both**.
 - [[FAQ/Keymap]]\r
 \r
 \r
-# Degug Console\r
+# Debug Console\r
 ## hid_listen can't recognize device\r
 When debug console of your device is not ready you will see like this:\r
 \r
@@ -53,14 +53,13 @@ SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
 \r
 # Miscellaneous\r
 ## NKRO Doesn't work\r
-1. Build with this option of Makefile\r
+First you have to compile frimware with this build option `NKRO_ENABLE` in **Makefile**.\r
 \r
-    NKRO_ENABLE = yes\r
+Try `Magic` **N** command(`LShift+RShift+N` by default) when **NKRO** still doesn't work. You can use this command to toggle between **NKRO** and **6KRO** mode temporarily. In some situations **NKRO** doesn't work you need to switch to **6KRO** mode, in particular when you are in BIOS.\r
 \r
-2. After boot keyboard may be in **boot mode**(6KRO), you will need to replug keyboard to enable NKRO.\r
-\r
-3. Or use `Magic` **N** command to toggle NKRO function.(`LShift+RShift+N` by default)\r
+If your firmeare built with `BOOTMAGIC_ENABLE` you need to turn its switch on by `BootMagic` **N** command(`Space+N` by default). This setting is stored in EEPROM and keeped over power cycles.\r
 \r
+https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch\r
 \r
 \r
 ## TrackPoint needs reset circuit(PS/2 mouse support)\r
@@ -107,20 +106,51 @@ http://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf
 \r
 \r
 ## Bootloader jump doesn't work\r
-Properly configure boot section size in Makefile. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**.\r
-- https://github.com/tmk/tmk_keyboard#magic-commands\r
-- https://github.com/tmk/tmk_keyboard#bootloader\r
-\r
+Properly configure bootloader size in **Makefile**. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**.\r
 ```\r
-# Boot Section Size in *bytes*\r
-#   Teensy halfKay   512\r
-#   Teensy++ halfKay 1024\r
-#   Atmel DFU loader 4096       (TMK Alt Controller)\r
-#   LUFA bootloader  4096\r
-#   USBaspLoader     2048\r
+# Size of Bootloaders in bytes:\r
+#   Atmel DFU loader(ATmega32U4)   4096    \r
+#   Atmel DFU loader(AT90USB128)   8192    \r
+#   LUFA bootloader(ATmega32U4)    4096             \r
+#   Arduino Caterina(ATmega32U4)   4096             \r
+#   USBaspLoader(ATmega***)        2048             \r
+#   Teensy   halfKay(ATmega32U4)   512              \r
+#   Teensy++ halfKay(AT90USB128)   1024\r
 OPT_DEFS += -DBOOTLOADER_SIZE=4096\r
 ```\r
-http://geekhack.org/index.php?topic=12047.msg1292018#msg1292018\r
+AVR Boot section size are defined by setting **BOOTSZ** fuse in fact. Consult with your MCU datasheet.\r
+Note that **Word**(2 bytes) size and address are used in datasheet while TMK uses **Byte**.\r
+\r
+AVR Boot section is located at end of Flash memory like the followings.\r
+```\r
+byte     Atmel/LUFA(ATMega32u4)          byte     Atmel(AT90SUB1286)\r
+0x0000   +---------------+               0x00000  +---------------+\r
+         |               |                        |               |\r
+         |               |                        |               |\r
+         |  Application  |                        |  Application  |\r
+         |               |                        |               | \r
+         =               =                        =               =\r
+         |               | 32KB-4KB               |               | 128KB-8KB\r
+0x6000   +---------------+               0x1FC00  +---------------+\r
+         |  Bootloader   | 4KB                    |  Bootloader   | 8KB\r
+0x7FFF   +---------------+               0x1FFFF  +---------------+\r
+\r
+ \r
+byte     Teensy(ATMega32u4)              byte     Teensy++(AT90SUB1286)\r
+0x0000   +---------------+               0x00000  +---------------+\r
+         |               |                        |               |\r
+         |               |                        |               |\r
+         |  Application  |                        |  Application  |\r
+         |               |                        |               |\r
+         =               =                        =               =\r
+         |               | 32KB-512B              |               | 128KB-1KB\r
+0x7E00   +---------------+               0x1FC00  +---------------+\r
+         |  Bootloader   | 512B                   |  Bootloader   | 1KB\r
+0x7FFF   +---------------+               0x1FFFF  +---------------+\r
+```\r
+\r
+And see this discussion for further reference.\r
+https://github.com/tmk/tmk_keyboard/issues/179\r
 \r
 \r
 ## Special Extra key doesn't work(System, Audio control keys)\r