X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=FAQ.md;h=417efad48abe76cb861c6b7fd10c1c0aa7714b77;hb=cad54d531371c8a3955409a28f8b19ba2c8e317f;hp=3cb245ea77afdfe8150b7d22b9c0bc58c4fa7b31;hpb=416f94646389f48b158ffc4712a6593e6c35868f;p=qmk_firmware.git diff --git a/FAQ.md b/FAQ.md index 3cb245ea7..417efad48 100644 --- a/FAQ.md +++ b/FAQ.md @@ -1,8 +1,8 @@ -# READ FIRST +## READ FIRST - **README** of top directory : https://github.com/tmk/tmk_keyboard/blob/master/README.md - **README** of target project(keyboard/converter) directory. -Note that you'll need to read two **README**. +Note that you'll need to read **both**. # Build @@ -13,7 +13,7 @@ Note that you'll need to read two **README**. - [[FAQ/Keymap]] -# Degug Console +# Debug Console ## hid_listen can't recognize device When debug console of your device is not ready you will see like this: @@ -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: - build with `CONSOLE_ENABLE=yes` in **Makefile**. +You may need privilege to access the device on OS like Linux. +- try `sudo hid_listen` + ## Can't get message on console Check: - *hid_listen* finds your device. See above. - Enable debug with pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands). -- set `debug_enable=yes` usually in `matrix_init()` in **matrix.c**. +- set `debug_enable=true` usually in `matrix_init()` in **matrix.c**. - try using 'print' function instead of debug print. See **common/print.h**. - disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97). @@ -53,14 +56,13 @@ SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666" # Miscellaneous ## NKRO Doesn't work -1. Build with this option of Makefile - - NKRO_ENABLE = yes +First you have to compile frimware with this build option `NKRO_ENABLE` in **Makefile**. -2. After boot keyboard may be in **boot mode**(6KRO), you will need to replug keyboard to enable NKRO. +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. -3. Or use `Magic` **N** command to toggle NKRO function.(`LShift+RShift+N` by default) +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. +https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch ## TrackPoint needs reset circuit(PS/2 mouse support) @@ -70,8 +72,8 @@ Without reset circuit you will have inconsistent reuslt due to improper initiali - http://www.mikrocontroller.net/attachment/52583/tpm754.pdf -## Can't read comlumn of matrix beyond 16 -Use `1UL<<16` intead of `1<<16` in `read_cols()` in **matrix.h** when your columns goes beyond 16. +## Can't read column of matrix beyond 16 +Use `1UL<<16` instead of `1<<16` in `read_cols()` in **matrix.h** when your columns goes beyond 16. 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`. @@ -107,20 +109,51 @@ http://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf ## Bootloader jump doesn't work -Properly configure boot section size in Makefile. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**. -- https://github.com/tmk/tmk_keyboard#magic-commands -- https://github.com/tmk/tmk_keyboard#bootloader - +Properly configure bootloader size in **Makefile**. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**. ``` -# Boot Section Size in *bytes* -# Teensy halfKay 512 -# Teensy++ halfKay 1024 -# Atmel DFU loader 4096 (TMK Alt Controller) -# LUFA bootloader 4096 -# USBaspLoader 2048 +# Size of Bootloaders in bytes: +# Atmel DFU loader(ATmega32U4) 4096 +# Atmel DFU loader(AT90USB128) 8192 +# LUFA bootloader(ATmega32U4) 4096 +# Arduino Caterina(ATmega32U4) 4096 +# USBaspLoader(ATmega***) 2048 +# Teensy halfKay(ATmega32U4) 512 +# Teensy++ halfKay(AT90USB128) 2048 OPT_DEFS += -DBOOTLOADER_SIZE=4096 ``` -http://geekhack.org/index.php?topic=12047.msg1292018#msg1292018 +AVR Boot section size are defined by setting **BOOTSZ** fuse in fact. Consult with your MCU datasheet. +Note that **Word**(2 bytes) size and address are used in datasheet while TMK uses **Byte**. + +AVR Boot section is located at end of Flash memory like the followings. +``` +byte Atmel/LUFA(ATMega32u4) byte Atmel(AT90SUB1286) +0x0000 +---------------+ 0x00000 +---------------+ + | | | | + | | | | + | Application | | Application | + | | | | + = = = = + | | 32KB-4KB | | 128KB-8KB +0x6000 +---------------+ 0x1E000 +---------------+ + | Bootloader | 4KB | Bootloader | 8KB +0x7FFF +---------------+ 0x1FFFF +---------------+ + + +byte Teensy(ATMega32u4) byte Teensy++(AT90SUB1286) +0x0000 +---------------+ 0x00000 +---------------+ + | | | | + | | | | + | Application | | Application | + | | | | + = = = = + | | 32KB-512B | | 128KB-2KB +0x7E00 +---------------+ 0x1FC00 +---------------+ + | Bootloader | 512B | Bootloader | 2KB +0x7FFF +---------------+ 0x1FFFF +---------------+ +``` + +And see this discussion for further reference. +https://github.com/tmk/tmk_keyboard/issues/179 ## Special Extra key doesn't work(System, Audio control keys) @@ -177,4 +210,29 @@ avrdude -patmega32u4 -cavr109 -b57600 -Uflash:w:adb_usb.hex -P/dev/ttyACM0 Device name will vary depending on your system. http://arduino.cc/en/Main/ArduinoBoardMicro -https://geekhack.org/index.php?topic=14290.msg1563867#msg1563867 \ No newline at end of file +https://geekhack.org/index.php?topic=14290.msg1563867#msg1563867 + + +## USB 3 compatibility +I heard some people have a problem with USB 3 port, try USB 2 port. + + +## Mac compatibility +### OS X 10.11 and Hub +https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034 + + +## Problem on BIOS(UEFI)/Resume(Sleep&Wake)/Power cycles +Some people reported their keyboard stops working on BIOS and/or after resume(power cycles). + +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. + +https://github.com/tmk/tmk_keyboard/issues/266 +https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778 + + + +## FLIP doesn't work +### AtLibUsbDfu.dll not found +Remove current driver and reinstall one FLIP provides from DeviceManager. +http://imgur.com/a/bnwzy \ No newline at end of file