The Kiibohd Controller
----------------------
-TODO, write some insightful/informative :P
+This README is a bit long, just look at the sections you are interested in.
+Linux is the ideal build environment (preferably recent'ish).
+
+
+Building on Mac should be ok for 99% of users with Macports (haven't tried Brew).
+The dfu Bootloader will not build correctly with the old version of arm-none-eabi-gcc that Macports currently has (4.7.3).
+This is due to a bug with lto (link time optimizations) which makes the resulting binary too big to fit on the chip (must be less than 4096 Bytes).
+
+Building on Windows should also be fine for 99% of users, but takes a bunch of work to setup (because Windows is a crappy dev environment).
+Cygwin is currently required along with some non-Cygwin compilers and utilities (because they are not available for Cygwin).
+The dfu Bootloader will not build because of a Make 3.81+ bug/feature that removed support for non-Unix (Windows) filenames as dependencies of targets.
+If you replace the version of Make in Cygwin it should work (e.g. http://stackoverflow.com/questions/601516/cygwin-make-error-target-pattern-contains-no).
+However, make sure that the flash size is no larger than 4096 Bytes or the bootloader will not work.
+
Please give authors credit for modules used if you use in a distributed product :D
These depend a bit on which targets you are trying to build, but the general one:
- cmake (2.8 and higher)
-- Teensy Loader (http://pjrc.com/teensy/loader.html)
+- git
+- ctags (recommended, not required)
+- python3
+- libusb1.0 (and -devel)
+- make
AVR Specific (Teensy 1.0/++,2.0/++) (try to use something recent, suggested versions below)
-- avr-gcc (4.8.0)
-- avr-binutils (2.23.2)
-- avr-libc (1.8.0)
+- avr-gcc (~4.8.0)
+- avr-binutils (~2.23.2)
+- avr-libc (~1.8.0)
-ARM Specific (Teensy 3.0) (Sourcery CodeBench Lite for ARM EABI
+ARM Specific (Teensy 3.0/3.1) (Sourcery CodeBench Lite for ARM EABI
(http://www.mentor.com/embedded-software/sourcery-tools/sourcery-codebench/editions/lite-edition/)
- arm-none-eabi
-- TODO?
+OR
+- arm-none-eabi-gcc
+- arm-none-eaby-binutils
+(I've actually had some issues with Sourcery CodeBench on Linux, so I often just use these)
----------------------
-Selecting Architecture
+Windows Setup
----------------------
-This is where you choose which architecture you want to build for.
-The options are:
- - Teensy 1.0 (Not tested)
- - Teensy 1.0++ (Not tested)
- - Teensy 2.0
- - Teensy 2.0++
- - Teensy 3.0
+Compiling on Windows does work, just it's a bunch more work.
-Open up CMakeLists.txt in your favourite text editor.
-You are looking for:
+First make sure Cygwin is installed - http://www.cygwin.com/ - 32bit or 64bit is fine. Make sure the following are installed:
+- make
+- git (needed for some compilation info)
+- cmake
+- gcc-core
+- gcc-g++
+- libusb1.0
+- libusb1.0-devel
+- python3
+- ctags (recommended, not required)
- ###
- Compiler Family
- #
+Please note, I use cygwin term exclusively for any command line options. Unless mentioned otherwise use it.
+Do NOT use CMD or Powershell.
- #| Specify the compiler family to use
- #| Currently only supports AVR and ARM
- #| "avr" # Teensy 1.0
- #| "avr" # Teensy 2.0
- #| "avr" # Teensy++ 1.0
- #| "avr" # Teensy++ 2.0
- #| "arm" # Teensy 3.0
+Also install the Windows version of CMake (3+ is ideal) - http://cmake.org/cmake/resources/software.html
+This is in addition to the Cygwin version. This is an easier alternative to installing another C compiler.
+Add the following line to your .bashrc, making sure the CMake path is correct:
+ echo "alias wincmake=\"PATH='/cygdrive/c/Program Files (x86)/CMake'/bin:'${PATH}' cmake -G 'Unix Makefiles'\"" >> ~/.bashrc
- set( COMPILER_FAMILY "avr" )
+Install the PJRC Virtual Serial Port Driver:
+(http://pjrc.com/teensy/serial_install.exe)
+Next, install the compiler(s) you want.
-Just change the COMPILER_FAMILY variable to whatever you are trying to build for.
-NOTE: If you change this option, you will *may* to delete the build directory that is created in the Building sections below.
+ ---------
+| AVR GCC |
+ ---------
+You just need the Atmel AVR 8-bit Toolchain. The latest should be fine, as of writing it was 3.4.3.
-----------------------
-Selecting Microcontroller
-----------------------
+http://www.atmel.com/tools/atmelavrtoolchainforwindows.aspx
+(Atmel AVR 8-bit Toolchain 3.4.3 - Windows)
-Even if you selected the "avr" family of microcontroller architectures, you will still need to specify a target microcontroller (or once more ARM microcontrollers are supported).
+Extract the files to a directory, say C:\avr8-gnu-toolchain. Then copy all the folders in that directory to the Cygwin /usr/local directory.
+Mine is C:\cygwin64\usr\local.
+(You can also just setup the paths, but this is faster/simpler. Might screw up your Cygwin though).
-Open up avr.cmake (or arm.cmake) in your favourite text editor.
-You are looking for:
- ###
- # Atmel Defines and Linker Options
- #
+ ----------
+| ARM EABI |
+ ----------
- #| MCU Name
- #| You _MUST_ set this to match the board you are using
- #| type "make clean" after changing this, so all files will be rebuilt
- #|
- #| "at90usb162" # Teensy 1.0
- #| "atmega32u4" # Teensy 2.0
- #| "at90usb646" # Teensy++ 1.0
- #| "at90usb1286" # Teensy++ 2.0
+Download the latest version of Mentor Graphics Sourcery CodeBench ARM EABI.
+
+http://www.mentor.com/embedded-software/sourcery-tools/sourcery-codebench/editions/lite-edition/
- set( MCU "at90usb1286" )
+Look for "Download the EABI Release".
+Enter your info to get the download link.
+Select the most recent download.
+Then download the "IA32 Windows Installer".
-*OR*
+Then copy all the folders/files installed (e.g. C:\Users\Haata\MentorGraphics\Sourcery_CodeBench_Lite_for_ARM_EABI\) to Cygwin /usr/local directory.
+Mine is C:\cygwin64\usr\local.
+Or, you can setup paths using the installer (you have to be more careful though).
+
+
+
+----------------------
+Selecting Microcontroller
+----------------------
+
+This is where you select the chip you want to compile for.
+The build system will automatically select the compiler needed to compile for your chip.
+
+Open up CMakeLists.txt in your favourite text editor.
+You are looking for:
###
- # ARM Defines and Linker Options
+ # Chip Selection
#
- #| Chip Name (Linker)
- #| You _MUST_ set this to match the board you are using
- #| type "make clean" after changing this, so all files will be rebuilt
+ #| You _MUST_ set this to match the microcontroller you are trying to compile for
+ #| You _MUST_ clean the build directory if you change this value
#|
- #| "mk20dx128" # Teensy 3.0
-
- set( CHIP "mk20dx128" )
-
+ set( CHIP
+ # "at90usb162" # Teensy 1.0 (avr)
+ # "atmega32u4" # Teensy 2.0 (avr)
+ # "at90usb646" # Teensy++ 1.0 (avr)
+ "at90usb1286" # Teensy++ 2.0 (avr)
+ # "mk20dx128" # Teensy 3.0 (arm)
+ # "mk20dx256" # Teensy 3.1 (arm)
+ )
-Just change the CHIP variable to the microcontroller you are trying to build for.
+Just uncomment the chip you want, and comment out the old one.
NOTE: If you change this option, you will *need* to delete the build directory that is created in the Building sections below.
- Scan Module
- Macro Module
-- USB Module
+- Output Module
- Debug Module
The Scan Module is where the most interesting stuff happens. These modules take in "keypress data".
This module just has to give press/release codes, but does have some callback control to other modules depending on the lifecycle for press/release codes (this can be very complicated depending on the protocol).
Each Scan Module has it's own default keymap/modifier map. (TODO recommend keymap changing in the Macro Module).
+Some scan modules have very specialized hardware requirements, each module directory should have at least a link to the needed parts and/or schematics (TODO!).
-The Macro Module takes care of the mapping of the key press/release code into a USB scan code.
+
+The Macro Module takes care of the mapping of the key press/release code into an Output (USB) scan code.
Any layering, macros, keypress intelligence/reaction is done here.
-The USB Module is the output module of the microcontroller. Currently USB is the only output protocol.
+The Output Module is the module dealing with output from the microcontroller. Currently USB is the only output protocol.
Different USB output implementations are available, pjrc being the safest/least featureful one.
Debug capabilities may depend on the module selected.
-Open up setup.cmake in your favourite text editor.
+Open up CMakeLists.txt in your favourite text editor.
Look for:
###
#| All of the modules must be specified, as they generate the sources list of files to compile
#| Any modifications to this file will cause a complete rebuild of the project
- #| Please look at the {Scan,Macro,USB,Debug}/module.txt for information on the modules and how to create new ones
+ #| Please look at the {Scan,Macro,Output,Debug}/module.txt for information on the modules and how to create new ones
##| Deals with acquiring the keypress information and turning it into a key index
set( ScanModule "avr-capsense" )
set( MacroModule "buffer" )
##| Sends the current list of usb key codes through USB HID
- set( USBModule "pjrc" )
+ set( OutputModule "pjrc" )
##| Debugging source to use, each module has it's own set of defines that it sets
set( DebugModule "full" )
Scan/avr-capsense/scan_loop.c
-- Detected Macro Module Source Files:
Macro/buffer/macro.c
- -- Detected USB Module Source Files:
- USB/pjrc/usb_com.c;USB/pjrc/avr/usb_keyboard_debug.c
+ -- Detected Output Module Source Files:
+ Output/pjrc/usb_com.c;Output/pjrc/avr/usb_keyboard_debug.c
-- Detected Debug Module Source Files:
Debug/full/../led/led.c;Debug/full/../print/print.c
-- Configuring done
[ 12%] Building C object CMakeFiles/kiibohd.elf.dir/main.c.o
[ 25%] Building C object CMakeFiles/kiibohd.elf.dir/Scan/avr-capsense/scan_loop.c.o
[ 37%] Building C object CMakeFiles/kiibohd.elf.dir/Macro/buffer/macro.c.o
- [ 50%] Building C object CMakeFiles/kiibohd.elf.dir/USB/pjrc/usb_com.c.o
- [ 62%] Building C object CMakeFiles/kiibohd.elf.dir/USB/pjrc/avr/usb_keyboard_debug.c.o
+ [ 50%] Building C object CMakeFiles/kiibohd.elf.dir/Output/pjrc/usb_com.c.o
+ [ 62%] Building C object CMakeFiles/kiibohd.elf.dir/Output/pjrc/avr/usb_keyboard_debug.c.o
[ 75%] Building C object CMakeFiles/kiibohd.elf.dir/Debug/led/led.c.o
[ 87%] Building C object CMakeFiles/kiibohd.elf.dir/Debug/print/print.c.o
Linking C executable kiibohd.elf
Linux Loading Firmware
----------------------
+First place the keyboard into re-flash mode.
+This can be done either by pressing the re-flash button on the PCB/Teensy.
+Or by entering the Kiibohd Virtual Serial Port and using the 'reload' command.
+
The 'load' script that is created during the build can load the firmware over USB.
-It uses sudo, so make sure you have the priviledges.
+Either run it with sudo, or install the 98-kiibohd.rules to /etc/udev/rules.d
+ and run: udevadm control --reload-rules
-(TODO, not complete, avr and arm are different currently, need to be unified)
+
+To load the newly built firmware:
./load
----------------------
-Windows Building
+Linux Building Bootloader
----------------------
+*NOTE* Does not apply to Teensy based builds.
+
+From this directory.
+cd Bootloader
+mkdir build
+cd build
+cmake ..
+make
+
+Example output:
TODO
+
+
----------------------
-Windows Loading Firmware
+Linux Loading Bootloader
----------------------
+*NOTE* Does not apply to Teensy based builds.
+
+It's recommended to use an SWD-type flasher like a Bus Pirate.
TODO
+(Guidelines here https://github.com/mchck/mchck/wiki/Getting-Started)
+
+
+
+----------------------
+Windows Building
+----------------------
+
+From this directory.
+mkdir build
+cd build
+wincmake ..
+make
+
+
+Example output:
+
+ $ cmake -G "Unix Makefiles" ..
+ -- Compiler Family:
+ avr
+ -- MCU Selected:
+ atmega32u4
+ -- CPU Selected:
+ megaAVR
+ -- Detected Scan Module Source Files:
+ Scan/SKM67001/../matrix/matrix_scan.c;Scan/SKM67001/../matrix/scan_loop.c
+ -- Detected Macro Module Source Files:
+ Macro/PartialMap/macro.c
+ -- Detected Output Module Source Files:
+ Output/pjrcUSB/output_com.c;Output/pjrcUSB/avr/usb_keyboard_serial.c
+ -- Detected Debug Module Source Files:
+ Debug/full/../cli/cli.c;Debug/full/../led/led.c;Debug/full/../print/print.c
+ -- Found Git: C:/cygwin64/bin/git.exe (found version "1.7.9")
+ -- Configuring done
+ -- Generating done
+ -- Build files have been written to: C:/cygwin64/home/jacob.alexander/src/capsense-beta/build
+
+ jacob.alexander@JALEXANDER2-LT ~/src/capsense-beta/build
+ $ make
+ Scanning dependencies of target kiibohd.elf
+ [ 10%] Building C object CMakeFiles/kiibohd.elf.dir/main.c.obj
+ [ 20%] Building C object CMakeFiles/kiibohd.elf.dir/Scan/matrix/matrix_scan.c.obj
+ [ 30%] Building C object CMakeFiles/kiibohd.elf.dir/Scan/matrix/scan_loop.c.obj
+ [ 40%] Building C object CMakeFiles/kiibohd.elf.dir/Macro/PartialMap/macro.c.obj
+ [ 50%] Building C object CMakeFiles/kiibohd.elf.dir/Output/pjrcUSB/output_com.c.obj
+ [ 60%] Building C object CMakeFiles/kiibohd.elf.dir/Output/pjrcUSB/avr/usb_keyboard_serial.c.obj
+ [ 70%] Building C object CMakeFiles/kiibohd.elf.dir/Debug/cli/cli.c.obj
+ [ 80%] Building C object CMakeFiles/kiibohd.elf.dir/Debug/led/led.c.obj
+ [ 90%] Building C object CMakeFiles/kiibohd.elf.dir/Debug/print/print.c.obj
+ Linking C executable kiibohd.elf
+ Creating load file for Flash: kiibohd.hex
+ Creating Extended Listing: kiibohd.lss
+ Creating Symbol Table: kiibohd.sym
+ [ 90%] Built target kiibohd.elf
+ Scanning dependencies of target SizeAfter
+ [100%] Size after generation
+ Flash Usage: data (hex)
+ RAM Usage: data (elf)
+ text data bss dec hex filename
+ 0 9738 0 9738 260a kiibohd.hex
+ 7982 1756 264 10002 2712 kiibohd.elf
+ [100%] Built target SizeAfter
+
+
+
+----------------------
+Windows Loading Firmware
+----------------------
+
+First place the keyboard into re-flash mode.
+This can be done either by pressing the re-flash button on the PCB/Teensy.
+Or by entering the Kiibohd Virtual Serial Interface and using the 'reload' command.
+
+The 'load' script that is created during the build can load the firmware over USB.
+
+To load the newly built firmware:
+./load
+
+Be patient the couple of times, Windows is slow at installing drivers...
+
+
----------------------
Mac OS X Building
----------------------
+From this directory.
+mkdir build
+cd build
+cmake ..
+make
+
+
+Example output:
TODO
+
+
----------------------
Mac OS X Loading Firmware
----------------------
-TODO
+First place the keyboard into re-flash mode.
+This can be done either by pressing the re-flash button on the PCB/Teensy.
+Or by entering the Kiibohd Virtual Serial Port and using the 'reload' command.
+
+The 'load' script that is created during the build can load the firmware over USB.
+
+
+To load the newly built firmware:
+./load
----------------------
-Debugging
+Virtual Serial Port - CLI
----------------------
-TODO
+Rather than use a special program that can interpret Raw HID, this controller exposes a USB Serial CDC endpoint.
+This allows for you to use a generic serial terminal to debug/control the keyboard firmware (e.g. Tera Term, minicom, screen)
+
+
+ -------
+| Linux |
+ -------
+
+I generally use screen.
+You will need sudo/root priviledges if you haven't installed the 98-kiibohd.rules file to /etc/udev/rules.d
+
+screen /dev/ttyACM0
+(Might be ACM1, ACM2, etc.)
+
+
+ ---------
+| Windows |
+ ---------
+
+Make sure the Teensy Virtual Serial Port driver is installed.
+If possible use screen (as part of Cygwin).
+Check which COM port the virtual serial port has been assigned to:
+ Device Manager->Ports (COM & LPT)->Teensy USB Serial
+ In brackets it will say which COM port (e.g. COM3)
+
+
+putty works well when using DTR/DSR or RTS/CTS flow control.
+Connection type: Serial
+Serial line: <Your COM port, e.g. COM3>
+Speed: (doesn't matter, it's auto-negotiated)
+
+Under Category->Connections->Serial
+Flow control: DTR/DSR
+
+If stuff is hard to read (you have a dumb colour scheme):
+Category->Window->Colours->Use system colur
+That seems to make text at least readable (I use a custom colour scheme that makes each colour easy to see -HaaTa).
+
+
+Unfortunately, screen for Cygwin seems to be broken for serial ports, but you can try it...
+screen /dev/ttyS2
+(Might be a different file, ttyS0, ttyACM0, ttyUSB0, etc.)
+
+Gnu screen doesn't seem to echo all the characters (it works though).
+I believe it's a problem with stty, but I don't know how to fix it...
+
+ ----------
+| Mac OS X |
+ ----------
+I recommend screen (can be installed via Macports).
+screen /dev/tty.<usb something>
projects / kiibohd-controller.git / blobdiff