keyboard/planck/CYGWIN_GUIDE.md

   1 #Planck Advanced (but not too advanced) `cygwin` Users Guide
   2 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.
   3
   4 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`.
   5
   6 #####Do not skip steps. Do not move past a step until the previous step finishes successfully.
   7
   8 Based on [avr-libc installation guide](http://www.nongnu.org/avr-libc/user-manual/install_tools.html)
   9
  10 ##Get the Required Packages
  11 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:
  12 - devel/git
  13 - devel/gcc-core
  14 - devel/gcc-g++
  15 - devel/flex
  16 - devel/bison
  17 - devel/make
  18 - devel/texinfo
  19 - devel/gettext-devel
  20 - text/gettext
  21 - libs/libgcc1
  22 - interpreters/m4
  23 - web/wget
  24 - archive/unzip
  25
  26 The following sources will be required:
  27 - [gmp](https://gmplib.org/) (6.1.0)
  28 - [mpfr](http://www.mpfr.org/) (3.1.4)
  29 - [mpc](http://www.multiprecision.org/) (1.0.3)
  30 - [binutils](https://www.sourceware.org/binutils/) (2.26)
  31 - [gcc](https://gcc.gnu.org/) (5.3.0)
  32 - [avr-libc](http://www.nongnu.org/avr-libc/) (2.0.0)
  33
  34 The `dfu-programmer` will be required to flash the new firmware
  35 - [dfu-programmer](https://dfu-programmer.github.io/) (0.7.2)
  36
  37 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
  38 ```
  39 $ mkdir ~/local
  40 $ mkdir ~/local/avr
  41 $ mkdir ~/src
  42 $ cd ~/src
  43 $ wget https://gmplib.org/download/gmp/gmp-6.1.0.tar.bz2
  44 $ wget http://www.mpfr.org/mpfr-3.1.4/mpfr-3.1.4.tar.bz2
  45 $ wget ftp://ftp.gnu.org/gnu/mpc/mpc-1.0.3.tar.gz
  46 $ wget http://ftp.gnu.org/gnu/binutils/binutils-2.26.tar.gz
  47 $ wget http://mirror0.babylon.network/gcc/releases/gcc-5.3.0/gcc-5.3.0.tar.gz
  48 $ wget http://download.savannah.gnu.org/releases/avr-libc/avr-libc-2.0.0.tar.bz2
  49 $ tar -xjf gmp-6.1.0.tar.bz2
  50 $ tar -xjf mpfr-3.1.4.tar.bz2
  51 $ tar -zxf mpc-1.0.3.tar.gz
  52 $ tar -zxf binutils-2.26.tar.gz
  53 $ tar -zxf gcc-5.3.0.tar.gz
  54 $ tar -xjf avr-libc-2.0.0.tar.bz2
  55 ```
  56
  57 ##Setup the Build Environment
  58 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.
  59 ```
  60 $ PREFIX=$HOME/local/avr
  61 $ export PREFIX
  62 $ PATH=/usr/local/bin:/usr/local/lib:/usr/local/include:/bin:/lib:/cygdrive/c/WINDOWS/system32:/cygdrive/c/WINDOWS
  63 $ PATH=$PATH:$PREFIX/bin
  64 $ export PATH
  65 ```
  66
  67 ##The `gcc` Required Math Library Packages
  68 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.
  69
  70 ###Build and Install `gmp`
  71 ```
  72 $ cd ~/src/gmp-6.1.0
  73 $ ./configure --enable-static --disable-shared
  74 $ make
  75 $ make check
  76 $ make install
  77 ```
  78
  79 ###Build and Install `mpfr`
  80 ```
  81 $ cd ~/src/mpfr-3.1.4
  82 $ ./configure --with-gmp-build=../gmp-6.1.0 --enable-static --disable-shared
  83 $ make
  84 $ make check
  85 $ make install
  86 ```
  87
  88 ###Build and Install `mpc`
  89 ```
  90 $ cd ~/src/mpc-1.0.3
  91 $ ./configure --with-gmp=/usr/local --with-mpfr=/usr/local --enable-static --disable-shared
  92 $ make
  93 $ make check
  94 $ make install
  95 ```
  96
  97 ##OPTIONAL Part
  98 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).
  99
 100 ###Build and Install `gcc` for Your Machine
 101 ```
 102 $ cd ~/src/gcc-5.3.0
 103 $ mkdir obj-local
 104 $ cd obj-local
 105 $ ../configure --enable-languages=c,c++ --with-gmp=/usr/local --with-mpfr=/usr/local --with-mpc=/usr/local --enable-static --disable-shared
 106 $ make
 107 $ make install
 108 ```
 109 ##End OPTIONAL Part
 110
 111 ###Build and Install `binutils` for Your Machine
 112 ```
 113 $ cd ~/src/binutils-2.26
 114 $ mkdir obj-local
 115 $ cd obj-local
 116 $ ../configure
 117 $ make
 118 $ make install
 119 ```
 120
 121 ##Buliding `binutils`, `gcc`, and `avr-libc` for the AVR system
 122 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.
 123
 124 ###Build `binutils` for AVR
 125 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`
 126 ```
 127 $ cd ~/src/binutils-2.26
 128 $ mkdir obj-avr
 129 $ cd obj-avr
 130 $ ../configure --prefix=$PREFIX --target=avr --disable-nls
 131 $ make
 132 $ make install
 133 ```
 134
 135 ###Build `gcc` for AVR
 136 ```
 137 $ cd ~/src/gcc-5.3.0
 138 $ mkdir obj-avr
 139 $ cd obj-avr
 140 $ ../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
 141 $ make
 142 $ make install
 143 ```
 144
 145 ###Build `avr-libc` for AVR
 146 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`.
 147 ```
 148 $ cd ~/src/avr-libc-2.0.0
 149 $ ./configure --prefix=$PREFIX --build=x86_64-unknown-cygwin --host=avr
 150 $ make
 151 $ make install
 152 ```
 153
 154 ##Building 'dfu-programmer' for flashing the firmware via USB and installing the drivers
 155 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.
 156
 157 ### Build and Install the `libusb`
 158 The `dfu-programmer` requires `libusb` so that it can interact with the USB system.
 159 ```
 160 $ cd ~/src
 161 $ git clone https://github.com/libusb/libusb.git
 162 $ cd libusb
 163 $ ./bootstrap.sh
 164 $ ./configure --prefix=$PREFIX
 165 $ make
 166 $ make install
 167 ```
 168
 169 ### Build and Install the `dfu-programmer`
 170 ```
 171 $ cd ~/src
 172 $ git clone https://github.com/dfu-programmer/dfu-programmer.git
 173 $ cd dfu-programmer
 174 $ ./bootstrap.sh
 175 $ ./configure --prefix=$PREFIX
 176 $ make
 177 $ make install
 178 ```
 179
 180 Verify the installation with:
 181 ```
 182 $ which dfu-programmer
 183 /home/Kevin/local/avr/bin/dfu-programmer
 184
 185 $ dfu-programmer
 186 dfu-programmer 0.7.2
 187 https://github.com/dfu-programmer/dfu-programmer
 188 Type 'dfu-programmer --help'    for a list of commands
 189      'dfu-programmer --targets' to list supported target devices
 190 ```
 191 If you are not getting the above result, you will not be able to flash the firmware!
 192
 193 ###Install the USB drivers
 194 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).
 195 ```
 196 $ cd ~/src
 197 $ wget http://iweb.dl.sourceforge.net/project/dfu-programmer/dfu-programmer/0.7.2/dfu-programmer-win-0.7.2.zip
 198 $ unzip dfu-programmer-win-0.7.2.zip -d dfu-programmer-win-0.7.2
 199 ```
 200
 201 or
 202
 203 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`.
 204
 205 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:
 206 ```
 207 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
 208 or
 209 C:\> pnputil -i -a "C:\Program Files (x86)\Atmel\Flip 3.4.7\usb\atmel_usb_dfu.inf"
 210 ```
 211
 212 This should be the result:
 213 ```
 214 Microsoft PnP Utility
 215
 216 Processing inf :            atmel_usb_dfu.inf
 217 Successfully installed the driver on a device on the system.
 218 Driver package added successfully.
 219 Published name :            oem104.inf
 220
 221
 222 Total attempted:              1
 223 Number successfully imported: 1
 224 ```
 225
 226 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.
 227
 228 ##Building and Flashing the Planck firmware!
 229 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.
 230
 231 ###Build Planck and Load the Firmware
 232 ```
 233 $ cd ~/src
 234 $ git clone https://github.com/jackhumbert/qmk_firmware.git
 235 $ cd qmk_firmware/keyboard/planck
 236 $ make
 237 ```
 238
 239 Make sure there are no errors.  You should end up with this or something similar:
 240 ```
 241 Creating load file for Flash: planck.hex
 242 avr-objcopy -O ihex -R .eeprom -R .fuse -R .lock -R .signature planck.elf planck.hex
 243
 244 Creating load file for EEPROM: planck.eep
 245 avr-objcopy -j .eeprom --set-section-flags=.eeprom="alloc,load" \
 246 --change-section-lma .eeprom=0 --no-change-warnings -O ihex planck.elf planck.eep || exit 0
 247
 248 Creating Extended Listing: planck.lss
 249 avr-objdump -h -S -z planck.elf > planck.lss
 250
 251 Creating Symbol Table: planck.sym
 252 avr-nm -n planck.elf > planck.sym
 253
 254 Size after:
 255    text    data     bss     dec     hex filename
 256   18602      82     155   18839    4997 planck.elf
 257
 258 -------- end --------
 259 ```
 260
 261 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.
 262
 263 But if everything went OK, you are ready to flash! Press the reset button on the bottom of the Planck, wait two seconds, then:
 264 ```
 265 $ make dfu
 266 ```
 267 .
 268 .
 269 .
 270 profit!!!
 271
 272
 273
 274
 275
 276 ##extra bits...
 277
 278 ###Installing Precompiled `dfu-programmer` Binaries (not recommended for `cygwin`)
 279 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)).
 280
 281 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):
 282 ```
 283 C:\> set PATH=%PATH%;C:\cygwin64\home\Kevin\local\avr\bin
 284 ```
 285
 286 Then, rename `libusb0_x86.dll` to `libusb0.dll`.
 287
 288 You can tell that you were successful by trying to execute 'dfu-programmer' from the 'cygwin' prompt:
 289 ```
 290 $ which dfu-programmer
 291 /home/Kevin/local/avr/bin/dfu-programmer
 292
 293 $ dfu-programmer
 294 dfu-programmer 0.7.2
 295 https://github.com/dfu-programmer/dfu-programmer
 296 Type 'dfu-programmer --help'    for a list of commands
 297      'dfu-programmer --targets' to list supported target devices
 298 ```
 299
 300 If you are not getting the above result, you will not be able to flash the firmware!
 301 - Try making sure your `PATH` variables are set correctly for both `Windows` and `cygwin`.
 302 - Make sure the `dll` is named correctly.
 303 - 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`.
 304 - Still have problems? Try building it instead.
 305
 306
 307 ##Debugging Tools
 308
 309 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.
 310
 311 ### `gdb` for AVR
 312 `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.
 313
 314 ```
 315 $ cd ~/src
 316 $ git clone git://sourceware.org/git/binutils-gdb.git
 317 $ cd binutils-gdb
 318 $ ./bootstrap
 319 $ mkdir obj-avr
 320 $ cd obj-avr
 321 $ ../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
 322 $ make
 323 $ make install
 324 ```
 325
 326 ### `simulavr`
 327 `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.
 328
 329 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`.
 330
 331
 332 ```
 333 $ cd ~/src
 334 $ git clone https://github.com/Traumflug/simulavr.git
 335 $ cd simulavr
 336 $ ./bootstrap
 337 $ ./configure --prefix=$PREFIX --enable-static --disable-tcl --disable-doxygen-doc
 338 ```
 339  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.
 340
 341 ```
 342 $ make
 343 $ make install
 344 ```
 345
 346
 347 TODO:
 348 - git repos for all sources
 349 - command line magic for cygwin setup
 350 - better options for `dfu-drivers`