FAQ.md

   1 # Build
   2 ## 'make clean' needs after changing config.h
   3 To build with new **config.h** you need
   4
   5     $ make clean
   6
   7 ## WINAVR is obsolete
   8 It is no longer recommended and may cause some problem.
   9 See [Issue #99](https://github.com/tmk/tmk_keyboard/issues/99).
  10
  11 ## USB stack: LUFA or PJRC?
  12 Use **LUFA**.
  13
  14 **PJRC** stack won't be supported actively anymore. There is no reason to hesitate to use LUFA except for binary size(about 1KB lager?). But **PJRC** is still very useful for debug and development purpose.
  15 See also [Issue #50](https://github.com/tmk/tmk_keyboard/issues/50) and [Issue #58](https://github.com/tmk/tmk_keyboard/issues/58).
  16
  17
  18
  19 # Degug Console
  20 ## hid_listen can't find device
  21 When debug console of your device is not ready you will see like this:
  22
  23     Waiting for device:.........
  24
  25 once the device is pluged in then *hid_listen* finds it you will get this message:
  26
  27     Waiting for new device:.........................
  28     Listening:
  29
  30 Check if you can't get this 'Listening:' message:
  31 - build with `CONSOLE_ENABLE=yes` in **Makefile**.
  32
  33 ## Can't get message from console
  34 Check:
  35 - connect the device to *hid_listen*. See above.
  36 - push **LShift+RShift+d** to enable debug. See [Magic Commands](https://github.com/tmk/tmk_keyboard#magic-commands).
  37 - set `debug_enable=yes` usually in `matrix_init()` in **matrix.c**.
  38 - try using 'print' function instead of debug print. See **common/print.h**.
  39 - disconnect other devices with console function. See [Issue #97](https://github.com/tmk/tmk_keyboard/issues/97).
  40
  41 ***
  42
  43 # Miscellaneous
  44 ## NKRO Doesn't work
  45 Build with this option of Makefile
  46
  47     NKRO_ENABLE = yes
  48
  49 And use `Magic` command **N** to toggle NKRO feature.
  50 At this time NKRO is not used by default even if it is build with `NKRO_ENABLE`, you still need the `Magic`.
  51
  52 To turn on NKRO by default see this fix.
  53 https://github.com/shayneholmes/tmk_keyboard/commit/b8375a0
  54 ```
  55 --- a/common/host.c
  56 +++ b/common/host.c
  57 @@ -24,7 +24,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
  58
  59
  60  #ifdef NKRO_ENABLE
  61 -bool keyboard_nkro = false;
  62 +bool keyboard_nkro = true;
  63  #endif
  64
  65  static host_driver_t *driver;
  66 ```
  67
  68 ## TrackPoint needs reset circuit(PS/2 mouse support)
  69 Without reset circuit you will have inconsistent reuslt due to improper initialize of the hardware. See circuit schematic of TPM754.
  70
  71 - http://geekhack.org/index.php?topic=50176.msg1127447#msg1127447
  72 - http://www.mikrocontroller.net/attachment/52583/tpm754.pdf
  73
  74
  75 ## Can't read comlumn of matrix beyond 16
  76 Use `1UL<<16` intead of `1<<16` in `read_cols()` in **matrix.h** when your columns goes beyond 16.
  77
  78 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`.
  79
  80 http://deskthority.net/workshop-f7/rebuilding-and-redesigning-a-classic-thinkpad-keyboard-t6181-60.html#p146279