2 - https://github.com/tmk/tmk_keyboard/blob/master/tmk_core/doc/build.md
6 $ make [-f Makefile.<variant>] [KEYMAP=...] clean
7 $ make [-f Makefile.<variant>] [KEYMAP=...]
8 $ make [-f Makefile.<variant>] [KEYMAP=...] dfu
11 ## Can't program on Linux and Mac
12 You will need proper permission to operate a device. For Linux users see udev rules below.
13 Easy way is to use `sudo` command, if you are not familiar with this command check its manual with `man sudo` or this page on line.
15 https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man8/sudo.8.html
17 In short when your controller is ATMega32u4,
19 $ sudo dfu-programmer atmega32u4 erase --force
20 $ sudo dfu-programmer atmega32u4 flash your.hex
21 $ sudo dfu-programmer atmega32u4 reset
27 But to run `make` with root privilege is not good idea. Use former method as possible.
29 ## Do 'make clean' before 'make'
30 You'll need `make clean` after you edit **config.h** or change options like `KEYMAP`.
32 Frist remove all files made in previous build,
36 then build new frimware.
40 Also you can always try `make clean` when you get other strange result during build.
44 It is no longer recommended and may cause some problem.
45 See [Issue #99](https://github.com/tmk/tmk_keyboard/issues/99).
47 ## USB stack: LUFA or PJRC?
50 **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.
51 See also [Issue #50](https://github.com/tmk/tmk_keyboard/issues/50) and [Issue #58](https://github.com/tmk/tmk_keyboard/issues/58).
53 ## Edit configuration but not change
54 You will need followings after editing `CONSOLE_ENABLE`, `NKRO_ENABLE`, `EXTRAKEY_ENABLE` or `MOUSEKEY_ENABLE` option in **Makefile**.
57 This will be needed when you edit **config.h**.
59 ### 2. Remove Drivers from Device Manager(Windows)
60 **Windows only.** Linux, OSX and other OS's doesn't require this. It looks like Windows keeps using driver installed when device was connected first time even after the device changes its configuration. To load proper drivers for new configuration you need to remove existent drivers from **Drvice Manager**.
62 ### 3. Build with different VID:PID
63 **Windows only.** If method 2. does't work fou you try this. Change Vendor ID or Product ID in **config.h** and build firmware. Windows should recognize it as whole new device and start drivers install process.
65 ### 4. Just try other ports
66 This will be useful and the easiest workaround for **Windows**.
71 You can use any ID you want with editing `config.h`. Using any presumably unused ID will be no problem in fact except for very least chance of collision with other product.
73 For example TMK uses following numbers by default.
88 https://github.com/tmk/tmk_keyboard/issues/150
90 You can buy a really unique VID:PID here. I don't think you need this for personal use.
91 - http://www.obdev.at/products/vusb/license.html
92 - http://www.mcselec.com/index.php?page=shop.product_details&flypage=shop.flypage&product_id=92&option=com_phpshop&Itemid=1
96 On Linux you need proper privilege to access device file of MCU, you'll have to use `sudo` when flashing firmware. You can circumvent this with placing these files in `/etc/udev/rules.d/`.
98 **/etc/udev/rules.d/50-atmel-dfu.rules:**
101 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff4", MODE:="0666"
102 # Atmel USBKEY AT90USB1287
103 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ffb", MODE:="0666"
105 SUBSYSTEMS=="usb", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="2ff0", MODE:="0666"
108 **/etc/udev/rules.d/52-tmk-keyboard.rules:**
110 # tmk keyboard products https://github.com/tmk/tmk_keyboard
111 SUBSYSTEMS=="usb", ATTRS{idVendor}=="feed", MODE:="0666"
116 ## Cortex: cstddef: No such file or directory
117 GCC 4.8 of Ubuntu 14.04 had this problem and had to update to 4.9 with this PPA.
118 https://launchpad.net/~terry.guo/+archive/ubuntu/gcc-arm-embedded
120 https://github.com/tmk/tmk_keyboard/issues/212
121 https://github.com/tmk/tmk_keyboard/wiki/mbed-cortex-porting#compile-error-cstddef
122 https://developer.mbed.org/forum/mbed/topic/5205/
125 ## 'clock_prescale_set' and 'clock_div_1' not available
126 Your toolchain is too old to support the MCU. For example WinAVR 20100110 doesn't support ATMega32u2.
129 Compiling C: ../../tmk_core/protocol/lufa/lufa.c
130 avr-gcc -c -mmcu=atmega32u2 -gdwarf-2 -DF_CPU=16000000UL -DINTERRUPT_CONTROL_ENDPOINT -DBOOTLOADER_SIZE=4096 -DF_USB=16000000UL -DARCH=ARCH_AVR8 -DUSB_DEVICE_ONLY -DUSE_FLASH_DESCRIPTORS -DUSE_STATIC_OPTIONS="(USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENABLED | USB_OPT_AUTO_PLL)" -DFIXED_CONTROL_ENDPOINT_SIZE=8 -DFIXED_NUM_CONFIGURATIONS=1 -DPROTOCOL_LUFA -DEXTRAKEY_ENABLE -DCONSOLE_ENABLE -DCOMMAND_ENABLE -DVERSION=unknown -Os -funsigned-char -funsigned-bitfields -ffunction-sections -fdata-sections -fno-inline-small-functions -fpack-struct -fshort-enums -fno-strict-aliasing -Wall -Wstrict-prototypes -Wa,-adhlns=obj_alps64/protocol/lufa/lufa.lst -I. -I../../tmk_core -I../../tmk_core/protocol/lufa -I../../tmk_core/protocol/lufa/LUFA-git -I../../tmk_core/common -std=gnu99 -include config.h -MMD -MP -MF .dep/obj_alps64_protocol_lufa_lufa.o.d ../../tmk_core/protocol/lufa/lufa.c -o obj_alps64/protocol/lufa/lufa.o
131 ../../tmk_core/protocol/lufa/lufa.c: In function 'setup_mcu':
132 ../../tmk_core/protocol/lufa/lufa.c:575: warning: implicit declaration of function 'clock_prescale_set'
133 ../../tmk_core/protocol/lufa/lufa.c:575: error: 'clock_div_1' undeclared (first use in this function)
134 ../../tmk_core/protocol/lufa/lufa.c:575: error: (Each undeclared identifier is reported only once
135 ../../tmk_core/protocol/lufa/lufa.c:575: error: for each function it appears in.)
136 make: *** [obj_alps64/protocol/lufa/lufa.o] Error 1
140 ## BOOTLOADER_SIZE for AVR
141 Note that Teensy2.0++ bootloader size is 2048byte. Some Makefiles may have wrong comment.
144 # Boot Section Size in *bytes*
146 # Teensy++ halfKay 2048
147 # Atmel DFU loader 4096 (TMK Alt Controller)
148 # LUFA bootloader 4096
150 OPT_DEFS += -DBOOTLOADER_SIZE=2048