###| CMAKE Kiibohd Controller |###
#
-# Jacob Alexander 2011-2014
+# Jacob Alexander 2011-2015
# Due to this file's usefulness:
#
# Released into the Public Domain
#
###
-#| Windows / Cygwin Compatibility options
-set( CMAKE_LEGACY_CYGWIN_WIN32 0 )
-set( CMAKE_USE_RELATIVE_PATHS 1 )
-
###
-# Compiler Family
+# Chip Selection
#
-#| 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
-#| "arm" # Teensy 3.1
-#set( COMPILER_FAMILY "arm" )
-set( COMPILER_FAMILY "avr" )
-
-message( STATUS "Compiler Family:" )
-message( "${COMPILER_FAMILY}" )
-
-
-
-#| Load the compiler family specific configurations
-include( ${COMPILER_FAMILY}.cmake )
+#| 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
+#|
+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)
+ "mk20dx128vlf5" # McHCK mk20dx128vlf5
+# "mk20dx256" # Teensy 3.1,3.2 (arm)
+# "mk20dx256vlh7" # Kiibohd-dfu mk20dx256vlh7
+ CACHE STRING "Microcontroller Chip" )
###
-# Project Description
+# Compiler Selection
#
-#| Project
-project( kiibohd_controller )
-
-#| Target Name (output name)
-set( TARGET kiibohd )
-
-#| General Settings
-cmake_minimum_required( VERSION 2.8 )
+#| *** EXPERIMENTAL ***
+#| Stick with gcc unless you know what you're doing
+#| Currently only arm is supported with clang
+set( COMPILER
+ "gcc" # arm-none-eabi-gcc / avr-gcc - Default
+# "clang" # arm-none-eabi
+ CACHE STRING "Compiler Type" )
###
-# Source Defines
+# Compiler Intialization
#
-
-#| Sources (see setup.h for configuring in/away code blocks or other complete modules)
-#| XXX Not set here in this project, see setup.cmake
-#set( SRCS ./main.c )
-
-#| Instead, include the module source selector
-include( setup.cmake )
-set( SRCS
- main.c
- ${COMPILER_SRCS}
- ${SCAN_SRCS}
- ${MACRO_SRCS}
- ${OUTPUT_SRCS}
- ${DEBUG_SRCS}
-)
-
-#| Directories to include by default
-include_directories( ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR} )
+set ( CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_SOURCE_DIR}/Lib/CMake )
+include( initialize )
###
-# Module Compatibility Check
+# Project Modules
#
-#| Check for whether the set modules are compatible with the specified compiler family
-ModuleCompatibility( ${ScanModulePath} ${ScanModuleCompatibility} )
-ModuleCompatibility( ${MacroModulePath} ${MacroModuleCompatibility} )
-ModuleCompatibility( ${OutputModulePath} ${OutputModuleCompatibility} )
-ModuleCompatibility( ${DebugModulePath} ${DebugModuleCompatibility} )
+#| Note: This is the only section you probably want to modify
+#| Each module is defined by it's own folder (e.g. Scan/Matrix represents the "Matrix" module)
+#| 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,Output,Debug} 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 "MD1"
+ CACHE STRING "Scan Module" )
-###
-# CMake Module Checking
-#
-find_package( Git REQUIRED )
+##| Provides the mapping functions for DefaultMap and handles any macro processing before sending to the OutputModule
+set( MacroModule "PartialMap"
+ CACHE STRING "Macro Module" )
+##| Sends the current list of usb key codes through USB HID
+set( OutputModule "pjrcUSB"
+ CACHE STRING "Output Module" )
-###
-# Build Targets
-#
+##| Debugging source to use, each module has it's own set of defines that it sets
+set( DebugModule "full"
+ CACHE STRING "Debug Module" )
-#| Create the .ELF file
-set( TARGET_ELF ${TARGET}.elf )
-add_executable( ${TARGET_ELF} ${SRCS} )
-#| .ELF Properties
-set_target_properties( ${TARGET_ELF} PROPERTIES
- LINK_FLAGS ${LINKER_FLAGS}
- SUFFIX "" # XXX Force Windows to keep the .exe off
-)
-
+###
+# Keymap Configuration (do not include the .kll extension)
+#
-#| Convert the .ELF into a .HEX to load onto the Teensy
-set( TARGET_HEX ${TARGET}.hex )
-add_custom_command( TARGET ${TARGET_ELF} POST_BUILD
- COMMAND ${OBJCOPY} ${HEX_FLAGS} ${TARGET_ELF} ${TARGET_HEX}
- COMMENT "Creating load file for Flash: ${TARGET_HEX}"
-)
+#| Do not include the .kll extension
+#| * BaseMap maps the native keyboard scan codes to USB Codes so the layout is compatible with all other layouts
+#| * DefaultMap allows the default keymap to be modified from the BaseMap
+#| * PartialMaps is a set of dynamically set layers (there is no limit, but too many may use up too much RAM...)
+#| BaseMap generally does not need to be changed from "defaultMap"
+#|
+#| Syntax:
+#| myMap
+#| * defines a single .kll layout file, double-quotes are needed to distinguish between layers
+#| "myMap specialLayer"
+#| * defines myMap to be the main layout, then replace specialLayers on top of it
+#|
+#| - Only for PartialMaps -
+#| "myMap specialLayer" "myMap colemak" dvorak
+#| * As before, but also generates a second layer at index 2 and third at index 3
+#|
+#| NOTE: Remember to add key(s) to enable each Partial Layer
+#| NOTE2: Layers are always based up the BaseMap (which should be an ANSI-like mapping)
+#| NOTE3: Compiler looks in kll/layouts and the build directory for layout files (precedence on build directory)
+
+##| Set the base keyboard .kll map, defaults to "defaultMap" if not found
+##| Looks in Scan/<Module Name> for the available BaseMaps
+set( BaseMap "defaultMap"
+ CACHE STRING "KLL BaseMap/Scancode Keymapping" )
+
+##| Layer additonal .kll maps on the BaseMap, layers are in order from 1st to nth
+##| Can be set to ""
+set( DefaultMap "md1Overlay stdFuncMap"
+ CACHE STRING "KLL DefaultMap" )
+
+##| ParitalMaps available on top of the BaseMap. See above for syntax on specifying multiple layers vs. layering
+##| Can be set to ""
+set( PartialMaps "hhkbpro2"
+ CACHE STRING "KLL PartialMaps/Layer Definitions" )
-#| Generate the Extended .LSS
-set( TARGET_LSS ${TARGET}.lss )
-add_custom_command( TARGET ${TARGET_ELF} POST_BUILD
- COMMAND ${OBJDUMP} ${LSS_FLAGS} ${TARGET_ELF} > ${TARGET_LSS}
- COMMENT "Creating Extended Listing: ${TARGET_LSS}"
-)
-
-#| Generate the Symbol Table .SYM
-set( TARGET_SYM ${TARGET}.sym )
-add_custom_command( TARGET ${TARGET_ELF} POST_BUILD
- COMMAND ${NM} -n ${TARGET_ELF} > ${TARGET_SYM}
- COMMENT "Creating Symbol Table: ${TARGET_SYM}"
+###
+# Source Defines (in addition to the selected Modules)
+#
+set( MAIN_SRCS
+ main.c
)
###
-# Size Information
+# Project Description
#
-#| After Changes Size Information
-#| TODO Do lookup on Flash and RAM sizes and do % used
-add_custom_target( SizeAfter ALL
- COMMAND ${SIZE} --target=${FORMAT} ${TARGET_HEX} ${TARGET_ELF}
- DEPENDS ${TARGET_ELF}
- COMMENT "Size after generation\n\tFlash Usage: data (hex)\n\t RAM Usage: data (elf)"
-)
+#| Project
+project( kiibohd_controller )
+#| Target Name (output name)
+set( TARGET kiibohd )
+#| General Settings
+cmake_minimum_required( VERSION 2.8 )
-###
-# Setup Loader Script and Program
-#
-#| Provides the user with the correct teensy-loader-cli command for the built .HEX file
-#| Windows
-if( CMAKE_SYSTEM_NAME MATCHES "Windows" )
- configure_file( LoadFile/winload load NEWLINE_STYLE UNIX )
-#| Default
-else()
- configure_file( LoadFile/load load NEWLINE_STYLE UNIX )
-endif()
+###
+# Module Initialization / Compilation / Targets
+#
+include( modules )
+include( kll ) # Generate kll layouts if necessary
+include( build )
projects / kiibohd-controller.git / blobdiff