docs/faq.md

   1 # Frequently Asked Questions
   2
   3 ## General
   4
   5 ### What is QMK?
   6
   7 [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).
   8
   9 ### Why the name Quantum?
  10
  11 <!-- FIXME -->
  12
  13 ### What Differences Are There Between QMK and TMK?
  14
  15 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.
  16
  17 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).
  18
  19 From a project and community management standpoint TMK maintains all the officially supported keyboards by himself, with a bit of community support. Separate community maintained forks exist or can be created for other keyboards. Only a few keymaps are provided by default, so users typically don't share keymaps with each other. QMK encourages sharing of both keyboards and keymaps through a centrally managed repository, accepting all pull requests that follows the quality standards. These are mostly community maintained, but the QMK team also helps when necessary.
  20
  21 Both approaches have their merits and their drawbacks, and code flows freely between TMK and QMK when it makes sense.
  22
  23 # Building
  24
  25 ## Windows
  26
  27 ### I'm on Windows Vista, 7, or 8, how do I setup my build environment?
  28
  29 Follow the build instructions to [install MHV AVR Tools](https://docs.qmk.fm/build_environment_setup.html#windows-vista-and-later).
  30
  31 ### I'm on Windows 10 without the Creators Update. Do I have to install it?
  32
  33 No, but if you don't install the creators update you will not be able to build and flash with a single command. You will be able to build but to flash you will have to use a separate program, such as [QMK Flasher](https://github.com/qmk/qmk_flasher).
  34
  35 # Troubleshooting
  36
  37 ## Debug Console
  38 ### hid_listen can't recognize device
  39 When debug console of your device is not ready you will see like this:
  40
  41 ```
  42 Waiting for device:.........
  43 ```
  44
  45 once the device is pluged in then *hid_listen* finds it you will get this message:
  46
  47 ```
  48 Waiting for new device:.........................
  49 Listening:
  50 ```
  51
  52 If you can't get this 'Listening:' message try building with `CONSOLE_ENABLE=yes` in [Makefile]
  53
  54 You may need privilege to access the device on OS like Linux.
  55 - try `sudo hid_listen`
  56
  57 ### Can't get message on console
  58 Check:
  59 - *hid_listen* finds your device. See above.
  60 - Enable debug with pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).
  61 - set `debug_enable=true` usually in `matrix_init()` in **matrix.c**.
  62 - try using 'print' function instead of debug print. See **common/print.h**.
  63 - disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).
  64
  65 ### Linux or UNIX like system requires Super User privilege
  66 Just use 'sudo' to execute *hid_listen* with privilege.
  67 ```
  68 $ sudo hid_listen
  69 ```
  70
  71 Or add an *udev rule* for TMK devices with placing a file in rules directory. The directory may vary on each system.
  72
  73 File: /etc/udev/rules.d/52-tmk-keyboard.rules(in case of Ubuntu)
  74 ```
  75 # tmk keyboard products     https://github.com/tmk/tmk_keyboard
  76 SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
  77 ```
  78
  79 ## Software Issues
  80
  81 ### NKRO Doesn't work
  82 First you have to compile frimware with this build option `NKRO_ENABLE` in **Makefile**.
  83
  84 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.
  85
  86 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.
  87
  88 https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch
  89
  90 ### Can't read column of matrix beyond 16
  91 Use `1UL<<16` instead of `1<<16` in `read_cols()` in [matrix.h] when your columns goes beyond 16.
  92
  93 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`.
  94
  95 http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279
  96
  97
  98 ### Bootloader jump doesn't work
  99 Properly configure bootloader size in **Makefile**. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**.
 100 ```
 101 # Size of Bootloaders in bytes:
 102 #   Atmel DFU loader(ATmega32U4)   4096
 103 #   Atmel DFU loader(AT90USB128)   8192
 104 #   LUFA bootloader(ATmega32U4)    4096
 105 #   Arduino Caterina(ATmega32U4)   4096
 106 #   USBaspLoader(ATmega***)        2048
 107 #   Teensy   halfKay(ATmega32U4)   512
 108 #   Teensy++ halfKay(AT90USB128)   2048
 109 OPT_DEFS += -DBOOTLOADER_SIZE=4096
 110 ```
 111 AVR Boot section size are defined by setting **BOOTSZ** fuse in fact. Consult with your MCU datasheet.
 112 Note that **Word**(2 bytes) size and address are used in datasheet while TMK uses **Byte**.
 113
 114 AVR Boot section is located at end of Flash memory like the followings.
 115 ```
 116 byte     Atmel/LUFA(ATMega32u4)          byte     Atmel(AT90SUB1286)
 117 0x0000   +---------------+               0x00000  +---------------+
 118          |               |                        |               |
 119          |               |                        |               |
 120          |  Application  |                        |  Application  |
 121          |               |                        |               |
 122          =               =                        =               =
 123          |               | 32KB-4KB               |               | 128KB-8KB
 124 0x6000   +---------------+               0x1E000  +---------------+
 125          |  Bootloader   | 4KB                    |  Bootloader   | 8KB
 126 0x7FFF   +---------------+               0x1FFFF  +---------------+
 127
 128
 129 byte     Teensy(ATMega32u4)              byte     Teensy++(AT90SUB1286)
 130 0x0000   +---------------+               0x00000  +---------------+
 131          |               |                        |               |
 132          |               |                        |               |
 133          |  Application  |                        |  Application  |
 134          |               |                        |               |
 135          =               =                        =               =
 136          |               | 32KB-512B              |               | 128KB-2KB
 137 0x7E00   +---------------+               0x1FC00  +---------------+
 138          |  Bootloader   | 512B                   |  Bootloader   | 2KB
 139 0x7FFF   +---------------+               0x1FFFF  +---------------+
 140 ```
 141
 142 And see this discussion for further reference.
 143 https://github.com/tmk/tmk_keyboard/issues/179
 144
 145
 146 ### Special Extra key doesn't work(System, Audio control keys)
 147 You need to define `EXTRAKEY_ENABLE` in `rules.mk` to use them in QMK.
 148
 149 ```
 150 EXTRAKEY_ENABLE = yes          # Audio control and System control
 151 ```
 152
 153 ### Wakeup from sleep doesn't work
 154
 155 In Windows check `Allow this device to wake the computer` setting in Power **Management property** tab of **Device Manager**. Also check BIOS setting.
 156
 157 Pressing any key during sleep should wake host.
 158
 159 ## Hardware Issues
 160
 161 ### TrackPoint needs reset circuit(PS/2 mouse support)
 162 Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754.
 163
 164 - http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447
 165 - http://www.mikrocontroller.net/attachment/52583/tpm754.pdf
 166
 167 ### Using Arduino?
 168
 169 **Note that Arduino pin naming is different from actual chip.** For example, Arduino pin `D0` is not `PD0`. Check circuit with its schematics yourself.
 170
 171 - http://arduino.cc/en/uploads/Main/arduino-leonardo-schematic_3b.pdf
 172 - http://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf
 173
 174 Arduino leonardo and micro have **ATMega32U4** and can be used for TMK, though Arduino bootloader may be a problem.
 175
 176 ### Using PF4-7 pins of USB AVR?
 177 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.
 178
 179 If you are using Teensy this isn't needed. Teensy is shipped with JTAGEN fuse bit unprogrammed to disable the function.
 180
 181 See this code.
 182 ```
 183     // JTAG disable for PORT F. write JTD bit twice within four cycles.
 184     MCUCR |= (1<<JTD);
 185     MCUCR |= (1<<JTD);
 186 ```
 187 https://github.com/tmk/tmk_keyboard/blob/master/keyboard/hbkb/matrix.c#L67
 188
 189 And read **26.5.1 MCU Control Register – MCUCR** of ATMega32U4 datasheet.
 190
 191
 192 ### Program Arduino Micro/Leonardo
 193 Push reset button and then run command like this within 8 seconds.
 194
 195 ```
 196 avrdude -patmega32u4 -cavr109 -b57600 -Uflash:w:adb_usb.hex -P/dev/ttyACM0
 197 ```
 198
 199 Device name will vary depending on your system.
 200
 201 http://arduino.cc/en/Main/ArduinoBoardMicro
 202 https://geekhack.org/index.php?topic=14290.msg1563867#msg1563867
 203
 204 ### Problem on BIOS(UEFI)/Resume(Sleep&Wake)/Power cycles
 205 Some people reported their keyboard stops working on BIOS and/or after resume(power cycles).
 206
 207 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.
 208
 209 https://github.com/tmk/tmk_keyboard/issues/266
 210 https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778
 211
 212 ## Flashing Problems
 213
 214 ### Can't use dfu-programmer or QMK Flasher to flash on Windows
 215
 216 Windows requires a driver to support the keyboard in DFU mode. You can use [QMK Driver Installer](https://github.com/qmk/qmk_driver_installer/releases) to install the necessary drivers.