1 # Frequently Asked Questions
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).
7 ## What Differences Are There Between QMK and TMK?
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.
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).
13 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.
15 Both approaches have their merits and their drawbacks, and code flows freely between TMK and QMK when it makes sense.
18 ## hid_listen can't recognize device
19 When debug console of your device is not ready you will see like this:
22 Waiting for device:.........
25 once the device is pluged in then *hid_listen* finds it you will get this message:
28 Waiting for new device:.........................
32 If you can't get this 'Listening:' message try building with `CONSOLE_ENABLE=yes` in [Makefile]
34 You may need privilege to access the device on OS like Linux.
35 - try `sudo hid_listen`
37 ## Can't get message on console
39 - *hid_listen* finds your device. See above.
40 - Enable debug with pressing **Magic**+d. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).
41 - set `debug_enable=true` usually in `matrix_init()` in **matrix.c**.
42 - try using 'print' function instead of debug print. See **common/print.h**.
43 - disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).
45 ## Linux or UNIX like system requires Super User privilege
46 Just use 'sudo' to execute *hid_listen* with privilege.
51 Or add an *udev rule* for TMK devices with placing a file in rules directory. The directory may vary on each system.
53 File: /etc/udev/rules.d/52-tmk-keyboard.rules(in case of Ubuntu)
55 # tmk keyboard products https://github.com/tmk/tmk_keyboard
56 SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
63 First you have to compile frimware with this build option `NKRO_ENABLE` in **Makefile**.
65 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.
67 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.
69 https://github.com/tmk/tmk_keyboard#boot-magic-configuration---virtual-dip-switch
72 ## TrackPoint needs reset circuit(PS/2 mouse support)
73 Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754.
75 - http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447
76 - http://www.mikrocontroller.net/attachment/52583/tpm754.pdf
79 ## Can't read column of matrix beyond 16
80 Use `1UL<<16` instead of `1<<16` in `read_cols()` in [matrix.h] when your columns goes beyond 16.
82 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`.
84 http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279
87 ## Bootloader jump doesn't work
88 Properly configure bootloader size in **Makefile**. With wrong section size bootloader won't probably start with **Magic command** and **Boot Magic**.
90 # Size of Bootloaders in bytes:
91 # Atmel DFU loader(ATmega32U4) 4096
92 # Atmel DFU loader(AT90USB128) 8192
93 # LUFA bootloader(ATmega32U4) 4096
94 # Arduino Caterina(ATmega32U4) 4096
95 # USBaspLoader(ATmega***) 2048
96 # Teensy halfKay(ATmega32U4) 512
97 # Teensy++ halfKay(AT90USB128) 2048
98 OPT_DEFS += -DBOOTLOADER_SIZE=4096
100 AVR Boot section size are defined by setting **BOOTSZ** fuse in fact. Consult with your MCU datasheet.
101 Note that **Word**(2 bytes) size and address are used in datasheet while TMK uses **Byte**.
103 AVR Boot section is located at end of Flash memory like the followings.
105 byte Atmel/LUFA(ATMega32u4) byte Atmel(AT90SUB1286)
106 0x0000 +---------------+ 0x00000 +---------------+
109 | Application | | Application |
112 | | 32KB-4KB | | 128KB-8KB
113 0x6000 +---------------+ 0x1E000 +---------------+
114 | Bootloader | 4KB | Bootloader | 8KB
115 0x7FFF +---------------+ 0x1FFFF +---------------+
118 byte Teensy(ATMega32u4) byte Teensy++(AT90SUB1286)
119 0x0000 +---------------+ 0x00000 +---------------+
122 | Application | | Application |
125 | | 32KB-512B | | 128KB-2KB
126 0x7E00 +---------------+ 0x1FC00 +---------------+
127 | Bootloader | 512B | Bootloader | 2KB
128 0x7FFF +---------------+ 0x1FFFF +---------------+
131 And see this discussion for further reference.
132 https://github.com/tmk/tmk_keyboard/issues/179
135 ## Special Extra key doesn't work(System, Audio control keys)
136 You need to define `EXTRAKEY_ENABLE` in `rules.mk` to use them in QMK.
139 EXTRAKEY_ENABLE = yes # Audio control and System control
142 ## Wakeup from sleep doesn't work
144 In Windows check `Allow this device to wake the computer` setting in Power **Management property** tab of **Device Manager**. Also check BIOS setting.
146 Pressing any key during sleep should wake host.
150 **Note that Arduino pin naming is different from actual chip.** For example, Arduino pin `D0` is not `PD0`. Check circuit with its schematics yourself.
152 - http://arduino.cc/en/uploads/Main/arduino-leonardo-schematic_3b.pdf
153 - http://arduino.cc/en/uploads/Main/arduino-micro-schematic.pdf
155 Arduino leonardo and micro have **ATMega32U4** and can be used for TMK, though Arduino bootloader may be a problem.
158 ## Using PF4-7 pins of USB AVR?
159 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.
161 If you are using Teensy this isn't needed. Teensy is shipped with JTAGEN fuse bit unprogrammed to disable the function.
165 // JTAG disable for PORT F. write JTD bit twice within four cycles.
169 https://github.com/tmk/tmk_keyboard/blob/master/keyboard/hbkb/matrix.c#L67
171 And read **26.5.1 MCU Control Register – MCUCR** of ATMega32U4 datasheet.
174 ## Adding LED indicators of Lock keys
175 You need your own LED indicators for CapsLock, ScrollLock and NumLock? See this post.
177 http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478-120.html#p191560
179 ## Program Arduino Micro/Leonardo
180 Push reset button and then run command like this within 8 seconds.
183 avrdude -patmega32u4 -cavr109 -b57600 -Uflash:w:adb_usb.hex -P/dev/ttyACM0
186 Device name will vary depending on your system.
188 http://arduino.cc/en/Main/ArduinoBoardMicro
189 https://geekhack.org/index.php?topic=14290.msg1563867#msg1563867
192 ## USB 3 compatibility
193 I heard some people have a problem with USB 3 port, try USB 2 port.
197 ### OS X 10.11 and Hub
198 https://geekhack.org/index.php?topic=14290.msg1884034#msg1884034
201 ## Problem on BIOS(UEFI)/Resume(Sleep&Wake)/Power cycles
202 Some people reported their keyboard stops working on BIOS and/or after resume(power cycles).
204 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.
206 https://github.com/tmk/tmk_keyboard/issues/266
207 https://geekhack.org/index.php?topic=41989.msg1967778#msg1967778
212 ### AtLibUsbDfu.dll not found
213 Remove current driver and reinstall one FLIP provides from DeviceManager.
214 http://imgur.com/a/bnwzy