aboutsummaryrefslogtreecommitdiff
path: root/docs/faq_debug.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/faq_debug.md')
-rw-r--r--docs/faq_debug.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/docs/faq_debug.md b/docs/faq_debug.md
index df35fbb98..9dfec773f 100644
--- a/docs/faq_debug.md
+++ b/docs/faq_debug.md
@@ -4,7 +4,7 @@ This page details various common questions people have about troubleshooting the
4 4
5# Debug Console 5# Debug Console
6 6
7## hid_listen can't recognize device 7## `hid_listen` Can't Recognize Device
8When debug console of your device is not ready you will see like this: 8When debug console of your device is not ready you will see like this:
9 9
10``` 10```
@@ -23,7 +23,7 @@ If you can't get this 'Listening:' message try building with `CONSOLE_ENABLE=yes
23You may need privilege to access the device on OS like Linux. 23You may need privilege to access the device on OS like Linux.
24- try `sudo hid_listen` 24- try `sudo hid_listen`
25 25
26## Can't get message on console 26## Can't Get Message on Console
27Check: 27Check:
28- *hid_listen* finds your device. See above. 28- *hid_listen* finds your device. See above.
29- Enable debug with pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands). 29- Enable debug with pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).
@@ -31,7 +31,7 @@ Check:
31- try using 'print' function instead of debug print. See **common/print.h**. 31- try using 'print' function instead of debug print. See **common/print.h**.
32- disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97). 32- disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).
33 33
34## Linux or UNIX like system requires Super User privilege 34## Linux or UNIX Like System Requires Super User Privilege
35Just use 'sudo' to execute *hid_listen* with privilege. 35Just use 'sudo' to execute *hid_listen* with privilege.
36``` 36```
37$ sudo hid_listen 37$ sudo hid_listen
@@ -97,14 +97,14 @@ If your firmware built with `BOOTMAGIC_ENABLE` you need to turn its switch on by
97https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch 97https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch
98 98
99 99
100## TrackPoint needs reset circuit(PS/2 mouse support) 100## TrackPoint Needs Reset Circuit (PS/2 Mouse Support)
101Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754. 101Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754.
102 102
103- http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447 103- http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447
104- http://www.mikrocontroller.net/attachment/52583/tpm754.pdf 104- http://www.mikrocontroller.net/attachment/52583/tpm754.pdf
105 105
106 106
107## Can't read column of matrix beyond 16 107## Can't Read Column of Matrix Beyond 16
108Use `1UL<<16` instead of `1<<16` in `read_cols()` in [matrix.h] when your columns goes beyond 16. 108Use `1UL<<16` instead of `1<<16` in `read_cols()` in [matrix.h] when your columns goes beyond 16.
109 109
110In 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`. 110In 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`.
@@ -112,7 +112,7 @@ In C `1` means one of [int] type which is [16bit] in case of AVR so you can't sh
112http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279 112http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279
113 113
114 114
115## Bootloader jump doesn't work 115## Bootloader Jump Doesn't Work
116Properly configure bootloader size in **Makefile**. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**. 116Properly configure bootloader size in **Makefile**. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**.
117``` 117```
118# Size of Bootloaders in bytes: 118# Size of Bootloaders in bytes:
@@ -161,14 +161,14 @@ https://github.com/tmk/tmk_keyboard/issues/179
161 161
162If you are using a TeensyUSB, there is a [known bug](https://github.com/qmk/qmk_firmware/issues/164) in which the hardware reset button prevents the RESET key from working. Unplugging the keyboard and plugging it back in should resolve the problem. 162If you are using a TeensyUSB, there is a [known bug](https://github.com/qmk/qmk_firmware/issues/164) in which the hardware reset button prevents the RESET key from working. Unplugging the keyboard and plugging it back in should resolve the problem.
163 163
164## Special Extra key doesn't work(System, Audio control keys) 164## Special Extra Key Doesn't Work (System, Audio Control Keys)
165You need to define `EXTRAKEY_ENABLE` in `rules.mk` to use them in QMK. 165You need to define `EXTRAKEY_ENABLE` in `rules.mk` to use them in QMK.
166 166
167``` 167```
168EXTRAKEY_ENABLE = yes # Audio control and System control 168EXTRAKEY_ENABLE = yes # Audio control and System control
169``` 169```
170 170
171## Wakeup from sleep doesn't work 171## Wakeup from Sleep Doesn't Work
172 172
173In Windows check `Allow this device to wake the computer` setting in Power **Management property** tab of **Device Manager**. Also check BIOS setting. 173In Windows check `Allow this device to wake the computer` setting in Power **Management property** tab of **Device Manager**. Also check BIOS setting.
174 174
@@ -184,7 +184,7 @@ Pressing any key during sleep should wake host.
184Arduino leonardo and micro have **ATMega32U4** and can be used for TMK, though Arduino bootloader may be a problem. 184Arduino leonardo and micro have **ATMega32U4** and can be used for TMK, though Arduino bootloader may be a problem.
185 185
186 186
187## Using PF4-7 pins of USB AVR? 187## Using PF4-7 Pins of USB AVR?
188You need to set JTD bit of MCUCR yourself to use PF4-7 as GPIO. Those pins are configured to serve JTAG function by default. MCUs like ATMega*U* or AT90USB* are affeteced with this. 188You need to set JTD bit of MCUCR yourself to use PF4-7 as GPIO. Those pins are configured to serve JTAG function by default. MCUs like ATMega*U* or AT90USB* are affeteced with this.
189 189
190If you are using Teensy this isn't needed. Teensy is shipped with JTAGEN fuse bit unprogrammed to disable the function. 190If you are using Teensy this isn't needed. Teensy is shipped with JTAGEN fuse bit unprogrammed to disable the function.
@@ -200,7 +200,7 @@ https://github.com/tmk/tmk_keyboard/blob/master/keyboard/hbkb/matrix.c#L67
200And read **26.5.1 MCU Control Register – MCUCR** of ATMega32U4 datasheet. 200And read **26.5.1 MCU Control Register – MCUCR** of ATMega32U4 datasheet.
201 201
202 202
203## Adding LED indicators of Lock keys 203## Adding LED Indicators of Lock Keys
204You need your own LED indicators for CapsLock, ScrollLock and NumLock? See this post. 204You need your own LED indicators for CapsLock, ScrollLock and NumLock? See this post.
205 205
206http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-120.html#p191560 206http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-120.html#p191560
@@ -218,16 +218,16 @@ http://arduino.cc/en/Main/ArduinoBoardMicro
218https://geekhack.org/index.php?topic=14290.msg1563867#msg1563867 218https://geekhack.org/index.php?topic=14290.msg1563867#msg1563867
219 219
220 220
221## USB 3 compatibility 221## USB 3 Compatibility
222I heard some people have a problem with USB 3 port, try USB 2 port. 222I heard some people have a problem with USB 3 port, try USB 2 port.
223 223
224 224
225## Mac compatibility 225## Mac Compatibility
226### OS X 10.11 and Hub 226### OS X 10.11 and Hub
227https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034 227https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034
228 228
229 229
230## Problem on BIOS(UEFI)/Resume(Sleep&Wake)/Power cycles 230## Problem on BIOS (UEFI)/Resume (Sleep & Wake)/Power Cycles
231Some people reported their keyboard stops working on BIOS and/or after resume(power cycles). 231Some people reported their keyboard stops working on BIOS and/or after resume(power cycles).
232 232
233As 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. 233As 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.
@@ -237,7 +237,7 @@ https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778
237 237
238 238
239 239
240## FLIP doesn't work 240## FLIP Doesn't Work
241### AtLibUsbDfu.dll not found 241### `AtLibUsbDfu.dll` Not Found
242Remove current driver and reinstall one FLIP provides from DeviceManager. 242Remove current driver and reinstall one FLIP provides from DeviceManager.
243http://imgur.com/a/bnwzy 243http://imgur.com/a/bnwzy