If you are a user of the [cygwin environment](https://cygwin.com) in Windows and want the freedom to use the latest tools available, then this is the guide for you. If compiling your own copy of the latest and greatest Gnu C Compiler makes you super happy, then this is the guide for you. If the command line make you smile, then this is the guide for you.\r
\r
\r
-This guide was written step by step as I went through the process on a `Windows 10` `x86_64` based system. This should be generally applicable to to any `Windows` environment with `cygwin`.\r
+This guide was written step by step as I went through the process on a `Windows 10` `x86_64` and a `Windows 7` `amd k10` based system. This should be generally applicable to to any `Windows` environment with `cygwin`.\r
\r
\r
#####Do not skip steps. Do not move past a step until the previous step finishes successfully.\r
- devel/gcc-g++\r
- devel/flex\r
- devel/git\r
-- libs/libglib2.0_0\r
+- devel/bison\r
+- devel/make\r
- libs/libgcc1\r
- interpreters/m4\r
- web/wget\r
+- archive/unzip\r
\r
The following sources will be required:\r
- [gmp](https://gmplib.org/) (6.1.0)\r
-- [mpfr](http://www.mpfr.org/) (3.1.3)\r
+- [mpfr](http://www.mpfr.org/) (3.1.4)\r
- [mpc](http://www.multiprecision.org/) (1.0.3) \r
- [binutils](https://www.sourceware.org/binutils/) (2.26)\r
- [gcc](https://gcc.gnu.org/) (5.3.0)\r
The set of commands below will create a directory (`~/local/avr`) for the sources you compile to be installed on the machine and a directory (`~/src`) for these source files to be stored. The commands then download the sources of the needed packages and unpack them. Note: the expand commands are different depending on if the packages are offered as a `bz2` or `gz` archive\r
\r
```\r
+$ mkdir ~/local\r
$ mkdir ~/local/avr\r
$ mkdir ~/src\r
$ cd ~/src\r
$ wget https://gmplib.org/download/gmp/gmp-6.1.0.tar.bz2\r
-$ wget http://www.mpfr.org/mpfr-current/mpfr-3.1.3.tar.bz2\r
+$ wget http://www.mpfr.org/mpfr-3.1.4/mpfr-3.1.4.tar.bz2\r
$ wget ftp://ftp.gnu.org/gnu/mpc/mpc-1.0.3.tar.gz\r
$ wget http://ftp.gnu.org/gnu/binutils/binutils-2.26.tar.gz\r
$ wget http://mirror0.babylon.network/gcc/releases/gcc-5.3.0/gcc-5.3.0.tar.gz\r
$ wget http://download.savannah.gnu.org/releases/avr-libc/avr-libc-2.0.0.tar.bz2\r
$ tar -xjf gmp-6.1.0.tar.bz2\r
-$ tar -xjf mpfr-3.1.3.tar.bz2\r
+$ tar -xjf mpfr-3.1.4.tar.bz2\r
$ tar -zxf mpc-1.0.3.tar.gz\r
$ tar -zxf binutils-2.26.tar.gz\r
$ tar -zxf gcc-5.3.0.tar.gz\r
\r
###Build and Install `mpfr`\r
```\r
-$ cd ~/src/mpfr-3.1.3\r
+$ cd ~/src/mpfr-3.1.4\r
$ ./configure --with-gmp-build=../gmp-6.1.0 --enable-static --disable-shared\r
$ make\r
$ make check\r
```\r
\r
##OPTIONAL Part\r
-You can build and install a brand new `gcc` or you can use the one supplied by `cygwin`. This will take about 4-5 hours to compile (It is a "native build", so it does the entire build **3 times**. This takes a long while). I would skip it.\r
+You can build and install a brand new `gcc` or you can use the one supplied by `cygwin`. This will take about 4-5 hours to compile (It is a "native build", so it does the entire build **3 times**. This takes a long while).\r
+\r
###Build and Install `gcc` on your Machine \r
```\r
$ cd ~/src/gcc-5.3.0\r
$ make install\r
```\r
\r
-For building the `avr-libc`, we have to specify the host build system. in my case it is `x86_64-unknown-cygwin`. You can look for build system type in the `gcc` configure notes for the proper `--build` specification to pass when you configure `avr-libc`.\r
+For building the `avr-libc`, we have to specify the host build system. In my case it is `x86_64-unknown-cygwin`. You can look for build system type in the `gcc` configure notes for the proper `--build` specification to pass when you configure `avr-libc`.\r
\r
###Build `avr-libc` for AVR\r
```\r
$ make install\r
```\r
\r
-##Install `dfu-programmer`\r
-To install the `dfu-programmer`, we must get if from [their website](https://dfu-programmer.github.io/) (no fancy command line tricks here, but [this](http://iweb.dl.sourceforge.net/project/dfu-programmer/dfu-programmer/0.7.2/dfu-programmer-win-0.7.2.zip) might work).\r
-Copy this file into your `cygwin` home directory. (For me, it is `C:\cygwin64\home\Kevin`), extract the files, move `dfu-programmer.exe` to `~/local/avr/bin`. Most obnoxiously, the `libusb0_x86.dll` and `libusb0.sys` need to be moved from `dfu/dfu-prog-usb-1.2.2/x86/` to a directory in the `Windows` `PATH` and the `cygwin` `PATH`. I achieved this by moving the files with Windows Explorer (you know, click and drag...) to `C:\cygwin64\home\Kevin\local\avr\bin` Then, in a `WINDOWS` command prompt running:\r
+### Build and Install the `dfu-programmer`\r
+We can either build our own, or use the precomplied binaries. The precompiled binaries don't play well with `cygwin` so it is better to build them ourselves. The procedure for the precompiled binaries is included at the end of this guide.\r
+\r
+The `dfu-programmer` requires `libusb`. So let's go ahead and build that first.\r
+\r
```\r
-C:\> set PATH=%PATH%;C:\cygwin64\home\Kevin\local\avr\bin\r
+$ cd ~/src\r
+$ git clone https://github.com/libusb/libusb.git\r
+$ cd libusb\r
+$ ./bootstrap.sh\r
+$ ./configure --prefix=$PREFIX\r
+$ make\r
+$ make install\r
```\r
-Adjust your path (for username) as needed. Also, `libusb0_x86.dll` needs to be renamed to `libusb0.dll`. Why must this be so hard? You can tell that you were successful this way:\r
+\r
+Next, we can build the `dfu-programmer`. This should be quick.\r
+```\r
+$ cd ~/src\r
+$ git clone https://github.com/dfu-programmer/dfu-programmer.git\r
+$ cd dfu-programmer\r
+$ ./bootstrap.sh\r
+$ ./configure --prefix=$PREFIX\r
+$ make\r
+$ make install\r
+```\r
+\r
+Verify the installation with:\r
+\r
```\r
$ which dfu-programmer\r
/home/Kevin/local/avr/bin/dfu-programmer\r
'dfu-programmer --targets' to list supported target devices\r
```\r
If you are not getting the above result, you will not be able to flash the firmware! \r
-- Try making sure your `PATH` variables are set correctly for both `Windows` and `cygwin`. \r
-- Do not extract it with `cygwin`'s `unzip` as it does not set the executable permissions correctly. If you did it anyway, do `chmod 755 dfu-programmer.exe`\r
\r
-####Install the USB drivers\r
-These drivers are included in the `dfu-programmer` 0.7.2 (but you can get newer ones [here](http://iweb.dl.sourceforge.net/project/libusb-win32/libusb-win32-releases/1.2.6.0/libusb-win32-bin-1.2.6.0.zip)) and allow the `dfu-programmer` to program the firmware. From an **administrator-privileged** `Windows` terminal, run the following command (adjust the path as necessary) and accept the prompt that pops up:\r
+###Install the USB drivers\r
+The official Atmel drivers are included in the windows binary version of [`dfu-programmer` 0.7.2](http://iweb.dl.sourceforge.net/project/dfu-programmer/dfu-programmer/0.7.2/dfu-programmer-win-0.7.2.zip) and allow the `dfu-programmer` to program the firmware.\r
+\r
```\r
-C:\> pnputil -i -a C:\cygwin64\home\Kevin\dfu-prog-usb-1.2.2\atmel_usb_dfu.inf\r
+$ cd ~/src\r
+$ wget http://iweb.dl.sourceforge.net/project/dfu-programmer/dfu-programmer/0.7.2/dfu-programmer-win-0.7.2.zip\r
+$ unzip dfu-programmer-win-0.7.2.zip -d dfu-programmer-win-0.7.2\r
+\r
```\r
+\r
+Then, from an **administrator-privileged** `Windows` terminal, run the following command (adjust the path for username as necessary) and accept the prompt that pops up:\r
+```\r
+C:\> pnputil -i -a C:\cygwin64\home\Kevin\src\dfu-programmer-win-0.7.2\dfu-prog-usb-1.2.2\atmel_usb_dfu.inf\r
+```\r
+\r
This should be the result:\r
```\r
Microsoft PnP Utility\r
Total attempted: 1\r
Number successfully imported: 1\r
```\r
+Alternativly, the `Windows` driver can be installed when prompted by `Windows` when the keyboard is attached. Do not let `Windows` search for a driver; specify the path to search for a driver and point it to the `atmel_usb_dfu.inf` file.\r
+\r
\r
##Building and Flashing the Planck firmware!\r
\r
.\r
.\r
profit!!!\r
+\r
+\r
+\r
+\r
+\r
+##extra bits...\r
+\r
+\r
+\r
+###Installing Precompiled `dfu-programmer` Binaries (Not recommended)\r
+To install the `dfu-programmer` from the binaries, we must get if from [the `dfu-programmer` website](https://dfu-programmer.github.io/) ([0.7.2](http://iweb.dl.sourceforge.net/project/dfu-programmer/dfu-programmer/0.7.2/dfu-programmer-win-0.7.2.zip)).\r
+Copy this file into your `cygwin` home\src directory. (For me, it is `C:\cygwin64\home\Kevin\src`), extract the files, move `dfu-programmer.exe` to `~/local/avr/bin`. Most obnoxiously, the `libusb0_x86.dll` and `libusb0.sys` need to be moved from `./dfu-prog-usb-1.2.2/x86/` to a directory in the `Windows` `PATH` and the `cygwin` `PATH`. I achieved this by moving the files with Windows Explorer (you know, click and drag...) to `C:\cygwin64\home\Kevin\local\avr\bin` Then, in a `WINDOWS` command prompt running:\r
+```\r
+C:\> set PATH=%PATH%;C:\cygwin64\home\Kevin\local\avr\bin\r
+```\r
+Adjust your path (for username) as needed. \r
+Then, rename `libusb0_x86.dll` to `libusb0.dll`. \r
+You can tell that you were successful by trying to execute 'dfu-programmer' from the 'cygwin' prompt:\r
+```\r
+$ which dfu-programmer\r
+/home/Kevin/local/avr/bin/dfu-programmer\r
+\r
+$ dfu-programmer\r
+dfu-programmer 0.7.2\r
+https://github.com/dfu-programmer/dfu-programmer\r
+Type 'dfu-programmer --help' for a list of commands\r
+ 'dfu-programmer --targets' to list supported target devices\r
+```\r
+If you are not getting the above result, you will not be able to flash the firmware! \r
+- Try making sure your `PATH` variables are set correctly for both `Windows` and `cygwin`. \r
+- Make sure the `dll` is named correctly.\r
+- Do not extract it with `cygwin`'s `unzip` as it does not set the executable permission. If you did it anyway, do `chmod +x dfu-programmer.exe`.\r
+\r
+\r
+##Debugging Tools\r
+\r
+These tools are for debugging your firmware, etc. before flashing. Theoretically, it can save your flash memory from wearing out. However, these tool do not work 100% for the Planck firmware.\r
+\r
+### `gdb` for AVR\r
+`gdb` has a simulator for AVR but it does not support all instructions (like WDT), so it immediately crashes when running the Planck firmware (because `lufa.c` disables the WDT in the first few lines of execution). But it can still be useful in debugging example code and test cases, if you know how to use it.\r
+\r
+```\r
+$ cd ~/src\r
+$ git clone git://sourceware.org/git/binutils-gdb.git\r
+$ cd binutils-gdb\r
+$ ./bootstrap\r
+$ mkdir obj-avr\r
+$ cd obj-avr\r
+$ ../configure --prefix=$PREFIX --target=avr --build=x86_64-unknown-cygwin --with-gmp=/usr/local --with-mpfr=/usr/local --with-mpc=/usr/local --disable-nls --enable-static\r
+$ make\r
+$ make install\r
+```\r
+\r
+\r
+### `simulavr`\r
+`simulavr` is an AVR simulator. It runs the complied AVR elf's. `simulavr` does not support the `atmega32u4` device... it does `atmega32` but that is not good enough for the firmware (no PORTE and other things), so you cannot run the Planck firmware. I use it to simulate ideas I have for features in separate test projects.\r
+\r
+This one is a major pain in the butt because it has a lot of dependencies and it is almost always buggy. I will do my best to explain it but... it was hard to figure out. A few things need to be changed in the 'Makefile' to make it work in `cygwin`.\r
+\r
+\r
+```\r
+$ cd ~/src\r
+$ git clone https://github.com/Traumflug/simulavr.git\r
+$ cd simulavr\r
+$ ./bootstrap\r
+$ ./configure --prefix=$PREFIX --enable-static --disable-tcl --disable-doxygen-doc\r
+```\r
+ Edit `src/Makefile.am` now so that `-no-undefined` is included (I did this by removing the SYS_MINGW conditional surrounding `libsim_la_LDFLAGS += -no-undefined` and `libsimulavr_la_LDFLAGS += -no-undefined \ libsimulavr_la_LIBADD += $(TCL_LIB)`. Also, `$(EXEEXT)` is added after `kbdgentables` in two places.\r
+\r
+```\r
+$ make\r
+$ make install\r
+```\r
+\r
+\r
projects / qmk_firmware.git / commitdiff