Nulo/qmk_firmware
1
0
Fork 0
Code Releases Activity

Merge pull request #191 from yoyoerx/windocs

Browse source 
Cygwin Based Users Guide v0.5 -further corrections
This commit is contained in:
Jack Humbert 2016-03-10 11:03:27 -05:00
commit cadd9015dd
1 changed files with 350 additions and 347 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

75
keyboard/planck/CYGWIN_GUIDE.md
View file

@ -1,25 +1,23 @@
#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/git
- devel/gcc-core - devel/gcc-core
- devel/gcc-g++ - devel/gcc-g++
- devel/flex - devel/flex
- devel/git
- devel/bison - devel/bison
- devel/make - devel/make
- devel/texinfo
- devel/gettext-devel
- text/gettext
- libs/libgcc1 - libs/libgcc1
- interpreters/m4 - interpreters/m4
- web/wget - web/wget
@ -36,9 +34,7 @@ The following sources will be required:
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
@ -69,7 +65,7 @@ $ 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. Verfiy that for each package, `make check` returns all passing and no fails.
###Build and Install `gmp` ###Build and Install `gmp`
``` ```
@ -101,7 +97,7 @@ $ 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` for Your Machine
``` ```
$ cd ~/src/gcc-5.3.0 $ cd ~/src/gcc-5.3.0
$ mkdir obj-local $ mkdir obj-local
@ -110,8 +106,9 @@ $ ../configure --enable-languages=c,c++ --with-gmp=/usr/local --with-mpfr=/usr/l
$ make $ make
$ make install $ make install
``` ```
##End OPTIONAL Part
###Build and Install `binutils` on your Machine ###Build and Install `binutils` for Your Machine
``` ```
$ cd ~/src/binutils-2.26 $ cd ~/src/binutils-2.26
$ mkdir obj-local $ mkdir obj-local
@ -120,12 +117,12 @@ $ ../configure
$ make $ make
$ make install $ 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
If you plan to build and install `avr-gdb` also, use the `gdb` install at the end of this guide as it also builds the `binutils`
``` ```
$ cd ~/src/binutils-2.26 $ cd ~/src/binutils-2.26
$ mkdir obj-avr $ mkdir obj-avr
@ -145,9 +142,8 @@ $ 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 ###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`.
``` ```
$ 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
@ -155,11 +151,11 @@ $ make
$ make install $ make install
``` ```
### Build and Install the `dfu-programmer` ##Building 'dfu-programmer' for flashing the firmware via USB and installing the drivers
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. ### Build and Install the `libusb`
The `dfu-programmer` requires `libusb` so that it can interact with the USB system.
``` ```
$ cd ~/src $ cd ~/src
$ git clone https://github.com/libusb/libusb.git $ git clone https://github.com/libusb/libusb.git
@ -170,7 +166,7 @@ $ make
$ make install $ make install
``` ```
Next, we can build the `dfu-programmer`. This should be quick. ### Build and Install the `dfu-programmer`
``` ```
$ cd ~/src $ cd ~/src
$ git clone https://github.com/dfu-programmer/dfu-programmer.git $ git clone https://github.com/dfu-programmer/dfu-programmer.git
@ -182,7 +178,6 @@ $ make install
``` ```
Verify the installation with: Verify the installation with:
``` ```
$ which dfu-programmer $ which dfu-programmer
/home/Kevin/local/avr/bin/dfu-programmer /home/Kevin/local/avr/bin/dfu-programmer
@ -196,18 +191,22 @@ 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! If you are not getting the above result, you will not be able to flash the firmware!
###Install the USB drivers ###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. 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).
``` ```
$ cd ~/src $ cd ~/src
$ wget http://iweb.dl.sourceforge.net/project/dfu-programmer/dfu-programmer/0.7.2/dfu-programmer-win-0.7.2.zip $ 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 $ unzip dfu-programmer-win-0.7.2.zip -d dfu-programmer-win-0.7.2
``` ```
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: 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, 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: This should be the result:
@ -223,11 +222,10 @@ Published name : oem104.inf
Total attempted: 1 Total attempted: 1
Number successfully imported: 1 Number successfully imported: 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.
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.
##Building and Flashing the Planck firmware! ##Building and Flashing the Planck 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. 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.
###Build Planck and Load the Firmware ###Build Planck and Load the Firmware
@ -237,8 +235,8 @@ $ git clone https://github.com/jackhumbert/qmk_firmware.git
$ cd qmk_firmware/keyboard/planck $ cd qmk_firmware/keyboard/planck
$ make $ make
``` ```
Make sure there are no errors. You should end up with this or something similar:
Make sure there are no errors. You should end up with this or something similar:
``` ```
Creating load file for Flash: planck.hex Creating load file for Flash: planck.hex
avr-objcopy -O ihex -R .eeprom -R .fuse -R .lock -R .signature planck.elf planck.hex avr-objcopy -O ihex -R .eeprom -R .fuse -R .lock -R .signature planck.elf planck.hex
@ -260,7 +258,7 @@ Size after:
-------- end -------- -------- end --------
``` ```
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. 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.
But if everything went OK, you are ready to flash! Press the reset button on the bottom of the Planck, wait two seconds, then: But if everything went OK, you are ready to flash! Press the reset button on the bottom of the Planck, wait two seconds, then:
``` ```
@ -277,16 +275,16 @@ profit!!!
##extra bits... ##extra bits...
###Installing Precompiled `dfu-programmer` Binaries (not recommended for `cygwin`)
###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)). 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`. 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:
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 to `C:\cygwin64\home\Kevin\local\avr\bin` Then, in a `WINDOWS` command prompt running (Adjusting your path for username, etc. as needed):
``` ```
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`. 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: You can tell that you were successful by trying to execute 'dfu-programmer' from the 'cygwin' prompt:
``` ```
$ which dfu-programmer $ which dfu-programmer
@ -298,15 +296,17 @@ https://github.com/dfu-programmer/dfu-programmer
Type 'dfu-programmer --help' for a list of commands Type 'dfu-programmer --help' for a list of commands
'dfu-programmer --targets' to list supported target devices '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! 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`. - Try making sure your `PATH` variables are set correctly for both `Windows` and `cygwin`.
- Make sure the `dll` is named correctly. - 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`. - 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 ##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. 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` for AVR ### `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. `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.
@ -323,11 +323,10 @@ $ make
$ make install $ make install
``` ```
### `simulavr` ### `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` 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 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`. 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`.
``` ```
@ -345,3 +344,7 @@ $ make install
``` ```
TODO:
- git repos for all sources
- command line magic for cygwin setup
- better options for `dfu-drivers`