docs/faq.md

   1 # Frequently Asked Questions
   2
   3 ## What is QMK?
   4
   5 [QMK](https://github.com/qmk), short for Quantum Mechanical Keyboard, is a group of people building tools for custom keyboards. We started with the [QMK firmware](https://github.com/qmk/qmk_firmware), a heavily modified fork of [TMK](https://github.com/tmk/tmk_keyboard).
   6
   7 ## What Differences Are There Between QMK and TMK?
   8
   9 TMK was originally designed and implemented by [Jun Wako](https://github.com/tmk). QMK started as [Jack Humbert's](https://github.com/jackhumbert) fork of TMK for the Planck. After a while Jack's fork had diverged quite a bit from TMK, and in 2015 Jack decided to rename his fork to QMK.
  10
  11 From a technical standpoint QMK builds upon TMK by adding several new features. Most notably QMK has expanded the number of available keycodes and uses these to implement advanced features like `S()`, `LCTL()`, and `MO()`. You can see a complete list of these keycodes in [Quantum Keycodes](quantum_keycodes.html).
  12
  13 From a project and community management standpoint TMK prefers to have keyboards maintained in separate forks while QMK prefers to have keyboards maintained in one central repository.
  14
  15 # Debug Console
  16 ## hid_listen can't recognize device
  17 When debug console of your device is not ready you will see like this:
  18
  19 ```
  20 Waiting for device:.........
  21 ```
  22
  23 once the device is pluged in then *hid_listen* finds it you will get this message:
  24
  25 ```
  26 Waiting for new device:.........................
  27 Listening:
  28 ```
  29
  30 If you can't get this 'Listening:' message try building with `CONSOLE_ENABLE=yes` in [Makefile]
  31
  32 You may need privilege to access the device on OS like Linux.
  33 - try `sudo hid_listen`
  34
  35 ## Can't get message on console
  36 Check:
  37 - *hid_listen* finds your device. See above.
  38 - Enable debug with pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).
  39 - set `debug_enable=true` usually in `matrix_init()` in **matrix.c**.
  40 - try using 'print' function instead of debug print. See **common/print.h**.
  41 - disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).
  42
  43 ## Linux or UNIX like system requires Super User privilege
  44 Just use 'sudo' to execute *hid_listen* with privilege.
  45 ```
  46 $ sudo hid_listen
  47 ```
  48
  49 Or add an *udev rule* for TMK devices with placing a file in rules directory. The directory may vary on each system.
  50
  51 File: /etc/udev/rules.d/52-tmk-keyboard.rules(in case of Ubuntu)
  52 ```
  53 # tmk keyboard products     https://github.com/tmk/tmk_keyboard
  54 SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
  55 ```
  56
  57 ***
  58
  59 # Miscellaneous
  60 ## NKRO Doesn't work
  61 First you have to compile frimware with this build option `NKRO_ENABLE` in **Makefile**.
  62
  63 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.
  64
  65 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.
  66
  67 https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch
  68
  69
  70 ## TrackPoint needs reset circuit(PS/2 mouse support)
  71 Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754.
  72
  73 - http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447
  74 - http://www.mikrocontroller.net/attachment/52583/tpm754.pdf
  75
  76
  77 ## Can't read column of matrix beyond 16
  78 Use `1UL<<16` instead of `1<<16` in `read_cols()` in [matrix.h] when your columns goes beyond 16.
  79
  80 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`.
  81
  82 http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279
  83
  84
  85 ## Bootloader jump doesn't work
  86 Properly configure bootloader size in **Makefile**. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**.
  87 ```
  88 # Size of Bootloaders in bytes:
  89 #   Atmel DFU loader(ATmega32U4)   4096
  90 #   Atmel DFU loader(AT90USB128)   8192
  91 #   LUFA bootloader(ATmega32U4)    4096
  92 #   Arduino Caterina(ATmega32U4)   4096
  93 #   USBaspLoader(ATmega***)        2048
  94 #   Teensy   halfKay(ATmega32U4)   512
  95 #   Teensy++ halfKay(AT90USB128)   2048
  96 OPT_DEFS += -DBOOTLOADER_SIZE=4096
  97 ```
  98 AVR Boot section size are defined by setting **BOOTSZ** fuse in fact. Consult with your MCU datasheet.
  99 Note that **Word**(2 bytes) size and address are used in datasheet while TMK uses **Byte**.
 100
 101 AVR Boot section is located at end of Flash memory like the followings.
 102 ```
 103 byte     Atmel/LUFA(ATMega32u4)          byte     Atmel(AT90SUB1286)
 104 0x0000   +---------------+               0x00000  +---------------+
 105          |               |                        |               |
 106          |               |                        |               |
 107          |  Application  |                        |  Application  |
 108          |               |                        |               |
 109          =               =                        =               =
 110          |               | 32KB-4KB               |               | 128KB-8KB
 111 0x6000   +---------------+               0x1E000  +---------------+
 112          |  Bootloader   | 4KB                    |  Bootloader   | 8KB
 113 0x7FFF   +---------------+               0x1FFFF  +---------------+
 114
 115
 116 byte     Teensy(ATMega32u4)              byte     Teensy++(AT90SUB1286)
 117 0x0000   +---------------+               0x00000  +---------------+
 118          |               |                        |               |
 119          |               |                        |               |
 120          |  Application  |                        |  Application  |
 121          |               |                        |               |
 122          =               =                        =               =
 123          |               | 32KB-512B              |               | 128KB-2KB
 124 0x7E00   +---------------+               0x1FC00  +---------------+
 125          |  Bootloader   | 512B                   |  Bootloader   | 2KB
 126 0x7FFF   +---------------+               0x1FFFF  +---------------+
 127 ```
 128
 129 And see this discussion for further reference.
 130 https://github.com/tmk/tmk_keyboard/issues/179
 131
 132
 133 ## Special Extra key doesn't work(System, Audio control keys)
 134 You need to define `EXTRAKEY_ENABLE` in `rules.mk` to use them in QMK.
 135
 136 ```
 137 EXTRAKEY_ENABLE = yes          # Audio control and System control
 138 ```
 139
 140 ## Wakeup from sleep doesn't work
 141
 142 In Windows check `Allow this device to wake the computer` setting in Power **Management property** tab of **Device Manager**. Also check BIOS setting.
 143
 144 Pressing any key during sleep should wake host.
 145
 146 ## Using Arduino?
 147
 148 **Note that Arduino pin naming is different from actual chip.** For example, Arduino pin `D0` is not `PD0`. Check circuit with its schematics yourself.
 149
 150 - http://arduino.cc/en/uploads/Main/arduino-leonardo-schematic_3b.pdf
 151 - http://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf
 152
 153 Arduino leonardo and micro have **ATMega32U4** and can be used for TMK, though Arduino bootloader may be a problem.
 154
 155
 156 ## Using PF4-7 pins of USB AVR?
 157 You 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.
 158
 159 If you are using Teensy this isn't needed. Teensy is shipped with JTAGEN fuse bit unprogrammed to disable the function.
 160
 161 See this code.
 162 ```
 163     // JTAG disable for PORT F. write JTD bit twice within four cycles.
 164     MCUCR |= (1<<JTD);
 165     MCUCR |= (1<<JTD);
 166 ```
 167 https://github.com/tmk/tmk_keyboard/blob/master/keyboard/hbkb/matrix.c#L67
 168
 169 And read **26.5.1 MCU Control Register – MCUCR** of ATMega32U4 datasheet.
 170
 171
 172 ## Adding LED indicators of Lock keys
 173 You need your own LED indicators for CapsLock, ScrollLock and NumLock? See this post.
 174
 175 http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-120.html#p191560
 176
 177 ## Program Arduino Micro/Leonardo
 178 Push reset button and then run command like this within 8 seconds.
 179
 180 ```
 181 avrdude -patmega32u4 -cavr109 -b57600 -Uflash:w:adb_usb.hex -P/dev/ttyACM0
 182 ```
 183
 184 Device name will vary depending on your system.
 185
 186 http://arduino.cc/en/Main/ArduinoBoardMicro
 187 https://geekhack.org/index.php?topic=14290.msg1563867#msg1563867
 188
 189
 190 ## USB 3 compatibility
 191 I heard some people have a problem with USB 3 port, try USB 2 port.
 192
 193
 194 ## Mac compatibility
 195 ### OS X 10.11 and Hub
 196 https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034
 197
 198
 199 ## Problem on BIOS(UEFI)/Resume(Sleep&Wake)/Power cycles
 200 Some people reported their keyboard stops working on BIOS and/or after resume(power cycles).
 201
 202 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.
 203
 204 https://github.com/tmk/tmk_keyboard/issues/266
 205 https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778
 206
 207
 208
 209 ## FLIP doesn't work
 210 ### AtLibUsbDfu.dll not found
 211 Remove current driver and reinstall one FLIP provides from DeviceManager.
 212 http://imgur.com/a/bnwzy