Updated License Clarification (markdown)

[qmk_firmware.git] / FAQ.md

diff --git a/FAQ.md b/FAQ.md
index 159959e33711d7de4b864236b3bfd0e483e37d29..417efad48abe76cb861c6b7fd10c1c0aa7714b77 100644 (file)
--- a/FAQ.md
+++ b/FAQ.md
@@ -27,11 +27,14 @@ once the device is pluged in then *hid_listen* finds it you will get this messag
 Check if you can't get this 'Listening:' message:\r
 - build with `CONSOLE_ENABLE=yes` in **Makefile**.\r
 \r
+You may need privilege to access the device on OS like Linux.\r
+- try `sudo hid_listen`\r
+\r
 ## Can't get message on console\r
 Check:\r
 - *hid_listen* finds your device. See above.\r
 - Enable debug with pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).\r
-- set `debug_enable=yes` usually in `matrix_init()` in **matrix.c**.\r
+- set `debug_enable=true` usually in `matrix_init()` in **matrix.c**.\r
 - try using 'print' function instead of debug print. See **common/print.h**.\r
 - disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).\r
 \r
@@ -69,8 +72,8 @@ Without reset circuit you will have inconsistent reuslt due to improper initiali
 - http://www.mikrocontroller.net/attachment/52583/tpm754.pdf\r
 \r
 \r
-## Can't read comlumn of matrix beyond 16 \r
-Use `1UL<<16` intead of `1<<16` in `read_cols()` in **matrix.h** when your columns goes beyond 16.\r
+## Can't read column of matrix beyond 16 \r
+Use `1UL<<16` instead of `1<<16` in `read_cols()` in **matrix.h** when your columns goes beyond 16.\r
 \r
 In C `1` means one of **int** type which is **16bit** in case of AVR so you can't shift left more than 15. You will get unexpected zero when you say `1<<16`. You have to use **unsigned long** type with `1UL`.\r
 \r
@@ -115,7 +118,7 @@ Properly configure bootloader size in **Makefile**. With wrong section size boot
 #   Arduino Caterina(ATmega32U4)   4096             \r
 #   USBaspLoader(ATmega***)        2048             \r
 #   Teensy   halfKay(ATmega32U4)   512              \r
-#   Teensy++ halfKay(AT90USB128)   1024\r
+#   Teensy++ halfKay(AT90USB128)   2048\r
 OPT_DEFS += -DBOOTLOADER_SIZE=4096\r
 ```\r
 AVR Boot section size are defined by setting **BOOTSZ** fuse in fact. Consult with your MCU datasheet.\r
@@ -131,7 +134,7 @@ byte     Atmel/LUFA(ATMega32u4)          byte     Atmel(AT90SUB1286)
          |               |                        |               | \r
          =               =                        =               =\r
          |               | 32KB-4KB               |               | 128KB-8KB\r
-0x6000   +---------------+               0x1FC00  +---------------+\r
+0x6000   +---------------+               0x1E000  +---------------+\r
          |  Bootloader   | 4KB                    |  Bootloader   | 8KB\r
 0x7FFF   +---------------+               0x1FFFF  +---------------+\r
 \r
@@ -143,9 +146,9 @@ byte     Teensy(ATMega32u4)              byte     Teensy++(AT90SUB1286)
          |  Application  |                        |  Application  |\r
          |               |                        |               |\r
          =               =                        =               =\r
-         |               | 32KB-512B              |               | 128KB-1KB\r
+         |               | 32KB-512B              |               | 128KB-2KB\r
 0x7E00   +---------------+               0x1FC00  +---------------+\r
-         |  Bootloader   | 512B                   |  Bootloader   | 1KB\r
+         |  Bootloader   | 512B                   |  Bootloader   | 2KB\r
 0x7FFF   +---------------+               0x1FFFF  +---------------+\r
 ```\r
 \r
@@ -207,4 +210,29 @@ avrdude -patmega32u4 -cavr109 -b57600 -Uflash:w:adb_usb.hex -P/dev/ttyACM0
 Device name will vary depending on your system.\r
 \r
 http://arduino.cc/en/Main/ArduinoBoardMicro\r
-https://geekhack.org/index.php?topic=14290.msg1563867#msg1563867
\ No newline at end of file
+https://geekhack.org/index.php?topic=14290.msg1563867#msg1563867\r
+\r
+\r
+## USB 3 compatibility\r
+I heard some people have a problem with USB 3 port, try USB 2 port.\r
+\r
+\r
+## Mac compatibility\r
+### OS X 10.11 and Hub\r
+https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034\r
+\r
+\r
+## Problem on BIOS(UEFI)/Resume(Sleep&Wake)/Power cycles\r
+Some people reported their keyboard stops working on BIOS and/or after resume(power cycles).\r
+\r
+As of now root of its cause is not clear but some build options seem to be related. In Makefile try to disable those options like `CONSOLE_ENABLE`, `NKRO_ENABLE`, `SLEEP_LED_ENABLE` and/or others. \r
+\r
+https://github.com/tmk/tmk_keyboard/issues/266\r
+https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778\r
+\r
+\r
+\r
+## FLIP doesn't work\r
+### AtLibUsbDfu.dll not found\r
+Remove current driver and reinstall one FLIP provides from DeviceManager.\r
+http://imgur.com/a/bnwzy
\ No newline at end of file