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