darkkirb/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Cygwin Based Users Guide v0.5 -further corrections

Browse source
This commit is contained in:
yoyoerx 2016-03-09 15:53:37 -05:00
parent 6bfb9d17cf
commit 79e0d7cbc3
1 changed files with 353 additions and 347 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

700
keyboard/planck/CYGWIN_GUIDE.md
View file

@ -1,347 +1,353 @@
#Planck Advanced (but not too advanced) `cygwin` Users Guide #Planck Advanced (but not too advanced) `cygwin` Users Guide
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. 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.
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`. 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`.
#####Do not skip steps. Do not move past a step until the previous step finishes successfully. #####Do not skip steps. Do not move past a step until the previous step finishes successfully.
Based on [avr-libc installation guide](http://www.nongnu.org/avr-libc/user-manual/install_tools.html) Based on [avr-libc installation guide](http://www.nongnu.org/avr-libc/user-manual/install_tools.html)
##Get the Required Packages ##Get the Required Packages
Download the `cygwin` setup ([x86_64](https://cygwin.com/setup-x86_64.exe)) and install the default system plus the following if they are not already selected: Download the `cygwin` setup ([x86_64](https://cygwin.com/setup-x86_64.exe)) and install the default system plus the following if they are not already selected:
- devel/gcc-core - devel/gcc-core
- devel/gcc-g++ - devel/gcc-g++
- devel/flex - devel/flex
- devel/git - devel/git
- devel/bison - devel/bison
- devel/make - devel/make
- libs/libgcc1 - libs/libgcc1
- interpreters/m4 - interpreters/m4
- web/wget - web/wget
- archive/unzip - archive/unzip
The following sources will be required: The following sources will be required:
- [gmp](https://gmplib.org/) (6.1.0) - [gmp](https://gmplib.org/) (6.1.0)
- [mpfr](http://www.mpfr.org/) (3.1.4) - [mpfr](http://www.mpfr.org/) (3.1.4)
- [mpc](http://www.multiprecision.org/) (1.0.3) - [mpc](http://www.multiprecision.org/) (1.0.3)
- [binutils](https://www.sourceware.org/binutils/) (2.26) - [binutils](https://www.sourceware.org/binutils/) (2.26)
- [gcc](https://gcc.gnu.org/) (5.3.0) - [gcc](https://gcc.gnu.org/) (5.3.0)
- [avr-libc](http://www.nongnu.org/avr-libc/) (2.0.0) - [avr-libc](http://www.nongnu.org/avr-libc/) (2.0.0)
The `dfu-programmer` will be required to flash the new firmware The `dfu-programmer` will be required to flash the new firmware
- [dfu-programmer](https://dfu-programmer.github.io/) (0.7.2) - [dfu-programmer](https://dfu-programmer.github.io/) (0.7.2)
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 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
``` ```
$ mkdir ~/local $ mkdir ~/local
$ mkdir ~/local/avr $ mkdir ~/local/avr
$ mkdir ~/src $ mkdir ~/src
$ cd ~/src $ cd ~/src
$ wget https://gmplib.org/download/gmp/gmp-6.1.0.tar.bz2 $ wget https://gmplib.org/download/gmp/gmp-6.1.0.tar.bz2
$ wget http://www.mpfr.org/mpfr-3.1.4/mpfr-3.1.4.tar.bz2 $ wget http://www.mpfr.org/mpfr-3.1.4/mpfr-3.1.4.tar.bz2
$ wget ftp://ftp.gnu.org/gnu/mpc/mpc-1.0.3.tar.gz $ wget ftp://ftp.gnu.org/gnu/mpc/mpc-1.0.3.tar.gz
$ wget http://ftp.gnu.org/gnu/binutils/binutils-2.26.tar.gz $ wget http://ftp.gnu.org/gnu/binutils/binutils-2.26.tar.gz
$ wget http://mirror0.babylon.network/gcc/releases/gcc-5.3.0/gcc-5.3.0.tar.gz $ wget http://mirror0.babylon.network/gcc/releases/gcc-5.3.0/gcc-5.3.0.tar.gz
$ wget http://download.savannah.gnu.org/releases/avr-libc/avr-libc-2.0.0.tar.bz2 $ wget http://download.savannah.gnu.org/releases/avr-libc/avr-libc-2.0.0.tar.bz2
$ tar -xjf gmp-6.1.0.tar.bz2 $ tar -xjf gmp-6.1.0.tar.bz2
$ tar -xjf mpfr-3.1.4.tar.bz2 $ tar -xjf mpfr-3.1.4.tar.bz2
$ tar -zxf mpc-1.0.3.tar.gz $ tar -zxf mpc-1.0.3.tar.gz
$ tar -zxf binutils-2.26.tar.gz $ tar -zxf binutils-2.26.tar.gz
$ tar -zxf gcc-5.3.0.tar.gz $ tar -zxf gcc-5.3.0.tar.gz
$ tar -xjf avr-libc-2.0.0.tar.bz2 $ tar -xjf avr-libc-2.0.0.tar.bz2
``` ```
##Setup the Build Environment ##Setup the Build Environment
These commands will set up the install directory and the `PATH` variable, which will allow you to access your installed packages. Note: if you close the `cygwin` terminal window, you will need to rerun these commands, they are not permanent. These commands will set up the install directory and the `PATH` variable, which will allow you to access your installed packages. Note: if you close the `cygwin` terminal window, you will need to rerun these commands, they are not permanent.
``` ```
$ PREFIX=$HOME/local/avr $ PREFIX=$HOME/local/avr
$ export PREFIX $ export PREFIX
$ PATH=/usr/local/bin:/usr/local/lib:/usr/local/include:/bin:/lib:/cygdrive/c/WINDOWS/system32:/cygdrive/c/WINDOWS $ PATH=/usr/local/bin:/usr/local/lib:/usr/local/include:/bin:/lib:/cygdrive/c/WINDOWS/system32:/cygdrive/c/WINDOWS
$ PATH=$PATH:$PREFIX/bin $ PATH=$PATH:$PREFIX/bin
$ export PATH $ export PATH
``` ```
##The `gcc` Required Math Library Packages ##The `gcc` Required Math Library Packages
The following packages are required to be complied and installed in order to compile `gcc`. They are not available through the `cygwin` package system, so we have to make them ourselves. They must be complied in this order because each one depends on the previous. The following packages are required to be complied and installed in order to compile `gcc`. They are not sufficiently available through the `cygwin` package system, so we have to make them ourselves. They must be complied in this order because each one depends on the previous.
###Build and Install `gmp` ###Build and Install `gmp`
``` ```
$ cd ~/src/gmp-6.1.0 $ cd ~/src/gmp-6.1.0
$ ./configure --enable-static --disable-shared $ ./configure --enable-static --disable-shared
$ make $ make
$ make check $ make check
$ make install $ make install
``` ```
###Build and Install `mpfr` ###Build and Install `mpfr`
``` ```
$ cd ~/src/mpfr-3.1.4 $ cd ~/src/mpfr-3.1.4
$ ./configure --with-gmp-build=../gmp-6.1.0 --enable-static --disable-shared $ ./configure --with-gmp-build=../gmp-6.1.0 --enable-static --disable-shared
$ make $ make
$ make check $ make check
$ make install $ make install
``` ```
###Build and Install `mpc` ###Build and Install `mpc`
``` ```
$ cd ~/src/mpc-1.0.3 $ cd ~/src/mpc-1.0.3
$ ./configure --with-gmp=/usr/local --with-mpfr=/usr/local --enable-static --disable-shared $ ./configure --with-gmp=/usr/local --with-mpfr=/usr/local --enable-static --disable-shared
$ make $ make
$ make check $ make check
$ make install $ make install
``` ```
##OPTIONAL Part ##OPTIONAL Part
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). 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).
###Build and Install `gcc` on your Machine ###Build and Install `gcc` on your Machine
``` ```
$ cd ~/src/gcc-5.3.0 $ cd ~/src/gcc-5.3.0
$ mkdir obj-local $ mkdir obj-local
$ cd obj-local $ cd obj-local
$ ../configure --enable-languages=c,c++ --with-gmp=/usr/local --with-mpfr=/usr/local --with-mpc=/usr/local --enable-static --disable-shared $ ../configure --enable-languages=c,c++ --with-gmp=/usr/local --with-mpfr=/usr/local --with-mpc=/usr/local --enable-static --disable-shared
$ make $ make
$ make install $ make install
``` ```
##End OPTIONAL Part
###Build and Install `binutils` on your Machine
``` ###Build and Install `binutils` on your Machine
$ cd ~/src/binutils-2.26 ```
$ mkdir obj-local $ cd ~/src/binutils-2.26
$ cd obj-local $ mkdir obj-local
$ ../configure $ cd obj-local
$ make $ ../configure
$ make install $ make
``` $ make install
##End OPTIONAL Part ```
##Buliding `binutils`, `gcc`, and `avr-libc` for the AVR system ##Buliding `binutils`, `gcc`, and `avr-libc` for the AVR system
Now we can make the critical stuff for compiling our firmware: `binutils`, `gcc`, and `avr-libc` for the AVR architecture. These allow us to build and manipulate the firmware for the keyboard. Now we can make the critical stuff for compiling our firmware: `binutils`, `gcc`, and `avr-libc` for the AVR architecture. These allow us to build and manipulate the firmware for the keyboard.
###Build `binutils` for AVR ###Build `binutils` for AVR
``` ```
$ cd ~/src/binutils-2.26 $ cd ~/src/binutils-2.26
$ mkdir obj-avr $ mkdir obj-avr
$ cd obj-avr $ cd obj-avr
$ ../configure --prefix=$PREFIX --target=avr --disable-nls $ ../configure --prefix=$PREFIX --target=avr --disable-nls
$ make $ make
$ make install $ make install
``` ```
###Build `gcc` for AVR ###Build `gcc` for AVR
``` ```
$ cd ~/src/gcc-5.3.0 $ cd ~/src/gcc-5.3.0
$ mkdir obj-avr $ mkdir obj-avr
$ cd obj-avr $ cd obj-avr
$ ../configure --prefix=$PREFIX --target=avr --enable-languages=c,c++ --with-gmp=/usr/local --with-mpfr=/usr/local --with-mpc=/usr/local --enable-static --disable-shared --disable-nls --disable-libssp --with-dwarf2 $ ../configure --prefix=$PREFIX --target=avr --enable-languages=c,c++ --with-gmp=/usr/local --with-mpfr=/usr/local --with-mpc=/usr/local --enable-static --disable-shared --disable-nls --disable-libssp --with-dwarf2
$ make $ make
$ make install $ make install
``` ```
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`. ###Build `avr-libc` for AVR
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`.
###Build `avr-libc` for AVR ```
``` $ cd ~/src/avr-libc-2.0.0
$ cd ~/src/avr-libc-2.0.0 $ ./configure --prefix=$PREFIX --build=x86_64-unknown-cygwin --host=avr
$ ./configure --prefix=$PREFIX --build=x86_64-unknown-cygwin --host=avr $ make
$ make $ make install
$ make install ```
```
### Build and Install the `dfu-programmer`
### Build and Install the `dfu-programmer` 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.
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.
The `dfu-programmer` requires `libusb`. So let's go ahead and build that first.
The `dfu-programmer` requires `libusb`. So let's go ahead and build that first. ```
$ cd ~/src
``` $ git clone https://github.com/libusb/libusb.git
$ cd ~/src $ cd libusb
$ git clone https://github.com/libusb/libusb.git $ ./bootstrap.sh
$ cd libusb $ ./configure --prefix=$PREFIX
$ ./bootstrap.sh $ make
$ ./configure --prefix=$PREFIX $ make install
$ make ```
$ make install
``` Next, we can build the `dfu-programmer`. This is quick.
```
Next, we can build the `dfu-programmer`. This should be quick. $ cd ~/src
``` $ git clone https://github.com/dfu-programmer/dfu-programmer.git
$ cd ~/src $ cd dfu-programmer
$ git clone https://github.com/dfu-programmer/dfu-programmer.git $ ./bootstrap.sh
$ cd dfu-programmer $ ./configure --prefix=$PREFIX
$ ./bootstrap.sh $ make
$ ./configure --prefix=$PREFIX $ make install
$ make ```
$ make install
``` Verify the installation with:
```
Verify the installation with: $ which dfu-programmer
/home/Kevin/local/avr/bin/dfu-programmer
```
$ which dfu-programmer $ dfu-programmer
/home/Kevin/local/avr/bin/dfu-programmer dfu-programmer 0.7.2
https://github.com/dfu-programmer/dfu-programmer
$ dfu-programmer Type 'dfu-programmer --help' for a list of commands
dfu-programmer 0.7.2 'dfu-programmer --targets' to list supported target devices
https://github.com/dfu-programmer/dfu-programmer ```
Type 'dfu-programmer --help' for a list of commands If you are not getting the above result, you will not be able to flash the firmware!
'dfu-programmer --targets' to list supported target devices
``` ###Install the USB drivers
If you are not getting the above result, you will not be able to flash the firmware! The 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).
###Install the USB drivers ```
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. $ cd ~/src
$ wget http://iweb.dl.sourceforge.net/project/dfu-programmer/dfu-programmer/0.7.2/dfu-programmer-win-0.7.2.zip
``` $ unzip dfu-programmer-win-0.7.2.zip -d dfu-programmer-win-0.7.2
$ cd ~/src ```
$ wget http://iweb.dl.sourceforge.net/project/dfu-programmer/dfu-programmer/0.7.2/dfu-programmer-win-0.7.2.zip
$ unzip dfu-programmer-win-0.7.2.zip -d dfu-programmer-win-0.7.2 or
``` The official drivers are found in [Atmel's `FLIP` installer](http://www.atmel.com/images/Flip%20Installer%20-%203.4.7.112.exe). Download and then install `FLIP`. Upon installation, the drivers will be found in `C:\Program Files (x86)\Atmel\Flip 3.4.7\usb`.
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: Then, from an **administrator-privileged** `Windows` terminal, run the following command (adjust the path for username, etc. as necessary) and accept the prompt that pops up:
``` ```
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 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
``` or
C:\> pnputil -i -a "C:\Program Files (x86)\Atmel\Flip 3.4.7\usb\atmel_usb_dfu.inf"
This should be the result: ```
```
Microsoft PnP Utility This should be the result:
```
Processing inf : atmel_usb_dfu.inf Microsoft PnP Utility
Successfully installed the driver on a device on the system.
Driver package added successfully. Processing inf : atmel_usb_dfu.inf
Published name : oem104.inf Successfully installed the driver on a device on the system.
Driver package added successfully.
Published name : oem104.inf
Total attempted: 1
Number successfully imported: 1
``` Total attempted: 1
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. Number successfully imported: 1
```
##Building and Flashing the Planck firmware! Alternatively, 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.
If you did everything else right. This part should be a snap! Grab the latest sources from `github`, make the Plank firmware, then flash it.
##Building and Flashing the Planck firmware!
###Build Planck and Load the Firmware
``` If you did everything else right. This part should be a snap! Grab the latest sources from `github`, make the Plank firmware, then flash it.
$ cd ~/src
$ git clone https://github.com/jackhumbert/qmk_firmware.git ###Build Planck and Load the Firmware
$ cd qmk_firmware/keyboard/planck ```
$ make $ cd ~/src
``` $ git clone https://github.com/jackhumbert/qmk_firmware.git
Make sure there are no errors. You should end up with this or something similar: $ cd qmk_firmware/keyboard/planck
$ make
``` ```
Creating load file for Flash: planck.hex Make sure there are no errors. You should end up with this or something similar:
avr-objcopy -O ihex -R .eeprom -R .fuse -R .lock -R .signature planck.elf planck.hex
```
Creating load file for EEPROM: planck.eep Creating load file for Flash: planck.hex
avr-objcopy -j .eeprom --set-section-flags=.eeprom="alloc,load" \ avr-objcopy -O ihex -R .eeprom -R .fuse -R .lock -R .signature planck.elf planck.hex
--change-section-lma .eeprom=0 --no-change-warnings -O ihex planck.elf planck.eep || exit 0
Creating load file for EEPROM: planck.eep
Creating Extended Listing: planck.lss avr-objcopy -j .eeprom --set-section-flags=.eeprom="alloc,load" \
avr-objdump -h -S -z planck.elf > planck.lss --change-section-lma .eeprom=0 --no-change-warnings -O ihex planck.elf planck.eep || exit 0
Creating Symbol Table: planck.sym Creating Extended Listing: planck.lss
avr-nm -n planck.elf > planck.sym avr-objdump -h -S -z planck.elf > planck.lss
Size after: Creating Symbol Table: planck.sym
text data bss dec hex filename avr-nm -n planck.elf > planck.sym
18602 82 155 18839 4997 planck.elf
Size after:
-------- end -------- text data bss dec hex filename
``` 18602 82 155 18839 4997 planck.elf
If you do not get the above, you **did not** build the firmware, and you will have nothing to flash. If you have the fresh clone from github, it was probably something gone wrong in this install process, go check and see what didn't work and threw errors or what steps you might have missed. -------- end --------
```
But if everything went OK, you are ready to flash! Press the reset button on the bottom of the Planck, wait two seconds, then:
``` If you do not get the above, you **did not** build the firmware, and you will have nothing to flash. If you have the fresh clone from github, it was probably something gone wrong in this install process, go check and see what didn't work and threw errors or what steps you might have missed.
$ make dfu
``` But if everything went OK, you are ready to flash! Press the reset button on the bottom of the Planck, wait two seconds, then:
. ```
. $ make dfu
. ```
profit!!! .
.
.
profit!!!
##extra bits...
##extra bits...
###Installing Precompiled `dfu-programmer` Binaries (Not recommended)
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)). ###Installing Precompiled `dfu-programmer` Binaries (Not recommended)
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: 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)).
``` 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`. This is because the `dfu-programmer` binary is `mingw` based, not `cygwin` based, so the `dlls` do not cooperate. I achieved acceptable pathing 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:
C:\> set PATH=%PATH%;C:\cygwin64\home\Kevin\local\avr\bin ```
``` C:\> set PATH=%PATH%;C:\cygwin64\home\Kevin\local\avr\bin
Adjust your path (for username) as needed. ```
Then, rename `libusb0_x86.dll` to `libusb0.dll`. Adjust your path (for username) as needed.
You can tell that you were successful by trying to execute 'dfu-programmer' from the 'cygwin' prompt: Then, rename `libusb0_x86.dll` to `libusb0.dll`.
``` You can tell that you were successful by trying to execute 'dfu-programmer' from the 'cygwin' prompt:
$ which dfu-programmer ```
/home/Kevin/local/avr/bin/dfu-programmer $ which dfu-programmer
/home/Kevin/local/avr/bin/dfu-programmer
$ dfu-programmer
dfu-programmer 0.7.2 $ dfu-programmer
https://github.com/dfu-programmer/dfu-programmer dfu-programmer 0.7.2
Type 'dfu-programmer --help' for a list of commands https://github.com/dfu-programmer/dfu-programmer
'dfu-programmer --targets' to list supported target devices Type 'dfu-programmer --help' for a list of commands
``` 'dfu-programmer --targets' to list supported target devices
If you are not getting the above result, you will not be able to flash the firmware! ```
- Try making sure your `PATH` variables are set correctly for both `Windows` and `cygwin`. If you are not getting the above result, you will not be able to flash the firmware!
- Make sure the `dll` is named correctly. - Try making sure your `PATH` variables are set correctly for both `Windows` and `cygwin`.
- 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`. - Make sure the `dll` is named correctly.
- 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`.
- Still have problems? Try building it instead.
##Debugging Tools
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. ##Debugging Tools
### `gdb` for AVR These tools are for debugging your firmware, etc. before flashing. Theoretically, it can save your memory from wearing out. However, these tool do not work 100% for the Planck firmware.
`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.
### `gdb` for AVR
``` `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.
$ cd ~/src
$ git clone git://sourceware.org/git/binutils-gdb.git ```
$ cd binutils-gdb $ cd ~/src
$ ./bootstrap $ git clone git://sourceware.org/git/binutils-gdb.git
$ mkdir obj-avr $ cd binutils-gdb
$ cd obj-avr $ ./bootstrap
$ ../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 $ mkdir obj-avr
$ make $ cd obj-avr
$ make install $ ../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
``` $ make
$ make install
```
### `simulavr`
`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.
### `simulavr`
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`. `simulavr` is an AVR simulator. It runs the complied AVR elfs. `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.
This one is a major pain in the butt because it has a lot of dependencies and it is 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`.
```
$ cd ~/src
$ git clone https://github.com/Traumflug/simulavr.git ```
$ cd simulavr $ cd ~/src
$ ./bootstrap $ git clone https://github.com/Traumflug/simulavr.git
$ ./configure --prefix=$PREFIX --enable-static --disable-tcl --disable-doxygen-doc $ cd simulavr
``` $ ./bootstrap
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. $ ./configure --prefix=$PREFIX --enable-static --disable-tcl --disable-doxygen-doc
```
``` 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.
$ make
$ make install ```
``` $ make
$ make install
```
TODO:
git repos for all sources
command line magic for cygwin setup
better options for dfu drivers