docs/faq_debug.md

   1 # Debugging FAQ
   2
   3 This page details various common questions people have about troubleshooting their keyboards.
   4
   5 # Debug Console
   6
   7 ## `hid_listen` Can't Recognize Device
   8 When debug console of your device is not ready you will see like this:
   9
  10 ```
  11 Waiting for device:.........
  12 ```
  13
  14 once the device is plugged in then *hid_listen* finds it you will get this message:
  15
  16 ```
  17 Waiting for new device:.........................
  18 Listening:
  19 ```
  20
  21 If you can't get this 'Listening:' message try building with `CONSOLE_ENABLE=yes` in [Makefile]
  22
  23 You may need privilege to access the device on OS like Linux.
  24 - try `sudo hid_listen`
  25
  26 ## Can't Get Message on Console
  27 Check:
  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).
  30 - set `debug_enable=true`. See [Testing and Debugging](newbs_testing_debugging.md#debugging)
  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).
  33
  34 ## Linux or UNIX Like System Requires Super User Privilege
  35 Just use 'sudo' to execute *hid_listen* with privilege.
  36 ```
  37 $ sudo hid_listen
  38 ```
  39
  40 Or add an *udev rule* for TMK devices with placing a file in rules directory. The directory may vary on each system.
  41
  42 File: /etc/udev/rules.d/52-tmk-keyboard.rules(in case of Ubuntu)
  43 ```
  44 # tmk keyboard products     https://github.com/tmk/tmk_keyboard
  45 SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
  46 ```
  47
  48 ***
  49
  50 # Miscellaneous
  51 ## Safety Considerations
  52
  53 You probably don't want to "brick" your keyboard, making it impossible
  54 to rewrite firmware onto it.  Here are some of the parameters to show
  55 what things are (and likely aren't) too risky.
  56
  57 - If your keyboard map does not include RESET, then, to get into DFU
  58   mode, you will need to press the reset button on the PCB, which
  59   requires unscrewing the bottom.
  60 - Messing with tmk_core / common files might make the keyboard
  61   inoperable
  62 - Too large a .hex file is trouble; `make dfu` will erase the block,
  63   test the size (oops, wrong order!), which errors out, failing to
  64   flash the keyboard, leaving it in DFU mode.
  65   - To this end, note that the maximum .hex file size on Planck is
  66     7000h (28672 decimal)
  67
  68 ```
  69 Linking: .build/planck_rev4_cbbrowne.elf                                                            [OK]
  70 Creating load file for Flash: .build/planck_rev4_cbbrowne.hex                                       [OK]
  71
  72 Size after:
  73    text    data     bss     dec     hex filename
  74       0   22396       0   22396    577c planck_rev4_cbbrowne.hex
  75 ```
  76
  77   - The above file is of size 22396/577ch, which is less than
  78     28672/7000h
  79   - As long as you have a suitable alternative .hex file around, you
  80     can retry, loading that one
  81   - Some of the options you might specify in your keyboard's Makefile
  82     consume extra memory; watch out for BOOTMAGIC_ENABLE,
  83     MOUSEKEY_ENABLE, EXTRAKEY_ENABLE, CONSOLE_ENABLE, API_SYSEX_ENABLE
  84 - DFU tools do /not/ allow you to write into the bootloader (unless
  85   you throw in extra fruit salad of options), so there is little risk
  86   there.
  87 - EEPROM has around a 100000 write cycle.  You shouldn't rewrite the
  88   firmware repeatedly and continually; that'll burn the EEPROM
  89   eventually.
  90
  91 ## NKRO Doesn't work
  92 First you have to compile firmware with this build option `NKRO_ENABLE` in **Makefile**.
  93
  94 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.
  95
  96 If your firmware 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 kept over power cycles.
  97
  98 https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch
  99
 100
 101 ## TrackPoint Needs Reset Circuit (PS/2 Mouse Support)
 102 Without reset circuit you will have inconsistent result due to improper initialize of the hardware. See circuit schematic of TPM754.
 103
 104 - http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447
 105 - http://www.mikrocontroller.net/attachment/52583/tpm754.pdf
 106
 107
 108 ## Can't Read Column of Matrix Beyond 16
 109 Use `1UL<<16` instead of `1<<16` in `read_cols()` in [matrix.h] when your columns goes beyond 16.
 110
 111 In C `1` means one of [int] type which is [16 bit] 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
 113 http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279
 114
 115 ## Special Extra Key Doesn't Work (System, Audio Control Keys)
 116 You need to define `EXTRAKEY_ENABLE` in `rules.mk` to use them in QMK.
 117
 118 ```
 119 EXTRAKEY_ENABLE = yes          # Audio control and System control
 120 ```
 121
 122 ## Wakeup from Sleep Doesn't Work
 123
 124 In Windows check `Allow this device to wake the computer` setting in Power **Management property** tab of **Device Manager**. Also check BIOS setting.
 125
 126 Pressing any key during sleep should wake host.
 127
 128 ## Using Arduino?
 129
 130 **Note that Arduino pin naming is different from actual chip.** For example, Arduino pin `D0` is not `PD0`. Check circuit with its schematics yourself.
 131
 132 - http://arduino.cc/en/uploads/Main/arduino-leonardo-schematic_3b.pdf
 133 - http://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf
 134
 135 Arduino Leonardo and micro have **ATMega32U4** and can be used for TMK, though Arduino bootloader may be a problem.
 136
 137 ## Enabling JTAG
 138
 139 By default, the JTAG debugging interface is disabled as soon as the keyboard starts up. JTAG-capable MCUs come from the factory with the `JTAGEN` fuse set, and it takes over certain pins of the MCU that the board may be using for the switch matrix, LEDs, etc.
 140
 141 If you would like to keep JTAG enabled, just add the following to your `config.h`:
 142
 143 ```c
 144 #define NO_JTAG_DISABLE
 145 ```
 146
 147 ## USB 3 Compatibility
 148 I heard some people have a problem with USB 3 port, try USB 2 port.
 149
 150
 151 ## Mac Compatibility
 152 ### OS X 10.11 and Hub
 153 https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034
 154
 155
 156 ## Problem on BIOS (UEFI)/Resume (Sleep & Wake)/Power Cycles
 157 Some people reported their keyboard stops working on BIOS and/or after resume(power cycles).
 158
 159 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.
 160
 161 https://github.com/tmk/tmk_keyboard/issues/266
 162 https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778
 163
 164
 165
 166 ## FLIP Doesn't Work
 167 ### `AtLibUsbDfu.dll` Not Found
 168 Remove current driver and reinstall one FLIP provides from DeviceManager.
 169 http://imgur.com/a/bnwzy