Adding CMake build support for the KLL compiler
- Automatically downloads the kll compiler if not found - Added capability files to each of the module that currently have them - Split modules.cmake so kll.cmake could influence build targets (also needs info from modules.cmake) - Updated .gitignore for kll compiler directory - Added documentation on how to manipulate layouts using CMakeLists.txt - Cleanup of old layout files
This commit is contained in:
Jacob Alexander
parent
cb37c82330
commit
e0a2a4806b
11 changed files with 357 additions and 563 deletions
81
Lib/CMake/build.cmake
Normal file
81
Lib/CMake/build.cmake
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
###| CMAKE Kiibohd Controller Source Configurator |###
|
||||
#
|
||||
# Written by Jacob Alexander in 2011-2014 for the Kiibohd Controller
|
||||
#
|
||||
# Released into the Public Domain
|
||||
#
|
||||
###
|
||||
|
||||
|
||||
|
||||
###
|
||||
# Build Targets
|
||||
#
|
||||
|
||||
#| Create the .ELF file
|
||||
set( TARGET_ELF ${TARGET}.elf )
|
||||
add_executable( ${TARGET_ELF} ${SRCS} generatedKeymap.h )
|
||||
|
||||
|
||||
#| .ELF Properties
|
||||
set_target_properties( ${TARGET_ELF} PROPERTIES
|
||||
LINK_FLAGS ${LINKER_FLAGS}
|
||||
SUFFIX "" # XXX Force Windows to keep the .exe off
|
||||
)
|
||||
|
||||
|
||||
#| Convert the .ELF into a .bin to load onto the McHCK
|
||||
if( DEFINED DFU )
|
||||
set( TARGET_BIN ${TARGET}.dfu.bin )
|
||||
add_custom_command( TARGET ${TARGET_ELF} POST_BUILD
|
||||
COMMAND ${CMAKE_OBJCOPY} ${BIN_FLAGS} ${TARGET_ELF} ${TARGET_BIN}
|
||||
COMMENT "Creating dfu binary file: ${TARGET_BIN}"
|
||||
)
|
||||
endif()
|
||||
|
||||
|
||||
#| Convert the .ELF into a .HEX to load onto the Teensy
|
||||
if ( DEFINED TEENSY )
|
||||
set( TARGET_HEX ${TARGET}.teensy.hex )
|
||||
add_custom_command( TARGET ${TARGET_ELF} POST_BUILD
|
||||
COMMAND ${CMAKE_OBJCOPY} ${HEX_FLAGS} ${TARGET_ELF} ${TARGET_HEX}
|
||||
COMMENT "Creating iHex file to load: ${TARGET_HEX}"
|
||||
)
|
||||
endif()
|
||||
|
||||
|
||||
#| Generate the Extended .LSS
|
||||
set( TARGET_LSS ${TARGET}.lss )
|
||||
add_custom_command( TARGET ${TARGET_ELF} POST_BUILD
|
||||
COMMAND ${CMAKE_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 ${CMAKE_NM} -n ${TARGET_ELF} > ${TARGET_SYM}
|
||||
COMMENT "Creating Symbol Table: ${TARGET_SYM}"
|
||||
)
|
||||
|
||||
|
||||
#| Compiler Selection Record
|
||||
add_custom_command( TARGET ${TARGET_ELF} POST_BUILD
|
||||
COMMAND ${CMAKE_SOURCE_DIR}/Lib/CMake/writer compiler ${COMPILER_FAMILY}
|
||||
)
|
||||
|
||||
|
||||
|
||||
###
|
||||
# Size Information
|
||||
#
|
||||
|
||||
#| After Changes Size Information
|
||||
add_custom_target( SizeAfter ALL
|
||||
COMMAND ${CMAKE_SOURCE_DIR}/Lib/CMake/sizeCalculator ${CMAKE_SIZE} ram ${TARGET_ELF} ${SIZE_RAM} " SRAM"
|
||||
COMMAND ${CMAKE_SOURCE_DIR}/Lib/CMake/sizeCalculator ${CMAKE_SIZE} flash ${TARGET_ELF} ${SIZE_FLASH} "Flash"
|
||||
DEPENDS ${TARGET_ELF}
|
||||
COMMENT "Chip usage for ${CHIP}"
|
||||
)
|
||||
|
||||
124
Lib/CMake/kll.cmake
Normal file
124
Lib/CMake/kll.cmake
Normal file
|
|
@ -0,0 +1,124 @@
|
|||
###| CMAKE Kiibohd Controller KLL Configurator |###
|
||||
#
|
||||
# Written by Jacob Alexander in 2014 for the Kiibohd Controller
|
||||
#
|
||||
# Released into the Public Domain
|
||||
#
|
||||
###
|
||||
|
||||
|
||||
###
|
||||
# Check if KLL compiler is needed
|
||||
#
|
||||
|
||||
if ( "${MacroModule}" STREQUAL "PartialMap" )
|
||||
|
||||
|
||||
|
||||
###
|
||||
# KLL Installation (Make sure repo has been cloned)
|
||||
#
|
||||
|
||||
if ( NOT EXISTS "${PROJECT_SOURCE_DIR}/kll/kll.py" )
|
||||
# Make sure git is available
|
||||
find_package ( Git REQUIRED )
|
||||
|
||||
# Clone kll git repo
|
||||
execute_process ( COMMAND ${GIT_EXECUTABLE} clone https://github.com/kiibohd/kll.git
|
||||
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
|
||||
)
|
||||
endif () # kll/kll.py exists
|
||||
|
||||
|
||||
|
||||
###
|
||||
# Prepare KLL layout arguments
|
||||
#
|
||||
|
||||
#| KLL_DEPENDS is used to build a dependency tree for kll.py, this way when files are changed, kll.py gets re-run
|
||||
|
||||
#| Search for capabilities.kll in each module directory
|
||||
foreach ( DIR ${ScanModulePath} ${MacroModulePath} ${OutputModulePath} ${DebugModulePath} )
|
||||
# capabilities.kll exists, add to BaseMap
|
||||
set ( filename "${PROJECT_SOURCE_DIR}/${DIR}/capabilities.kll" )
|
||||
if ( EXISTS ${filename} )
|
||||
set ( BaseMap_Args ${BaseMap_Args} ${filename} )
|
||||
set ( KLL_DEPENDS ${KLL_DEPENDS} ${filename} )
|
||||
endif ()
|
||||
endforeach ()
|
||||
|
||||
#| If set BaseMap cannot be found, use default map
|
||||
set ( pathname "${PROJECT_SOURCE_DIR}/${ScanModulePath}" )
|
||||
if ( NOT EXISTS "${filename}/${BaseMap}.kll" )
|
||||
set ( BaseMap_Args ${BaseMap_Args} ${pathname}/defaultMap.kll )
|
||||
set ( KLL_DEPENDS ${KLL_DEPENDS} ${pathname}/defaultMap.kll )
|
||||
else ()
|
||||
set ( BaseMap_Args ${BaseMap_Args} ${pathname}/${BaseMap}.kll )
|
||||
set ( KLL_DEPENDS ${KLL_DEPENDS} ${pathname}/${BaseMap}.kll )
|
||||
endif ()
|
||||
|
||||
#| Configure DefaultMap if specified
|
||||
if ( NOT "${DefaultMap}" STREQUAL "" )
|
||||
set ( DefaultMap_Args -d )
|
||||
|
||||
string ( REPLACE " " ";" MAP_LIST ${DefaultMap} ) # Change spaces to semicolons
|
||||
foreach ( MAP ${MAP_LIST} )
|
||||
# Check if kll file is in build directory, otherwise default to layout directory
|
||||
if ( EXISTS "${PROJECT_BINARY_DIR}/${MAP}.kll" )
|
||||
set ( DefaultMap_Args ${DefaultMap_Args} ${MAP}.kll )
|
||||
set ( KLL_DEPENDS ${KLL_DEPENDS} ${MAP}.kll )
|
||||
else ()
|
||||
set ( DefaultMap_Args ${DefaultMap_Args} ${PROJECT_SOURCE_DIR}/kll/layouts/${MAP}.kll )
|
||||
set ( KLL_DEPENDS ${KLL_DEPENDS} ${PROJECT_SOURCE_DIR}/kll/layouts/${MAP}.kll )
|
||||
endif ()
|
||||
endforeach ()
|
||||
endif ()
|
||||
|
||||
#| Configure PartialMaps if specified
|
||||
if ( NOT "${PartialMaps}" STREQUAL "" )
|
||||
# For each partial layer
|
||||
foreach ( MAP ${PartialMaps} )
|
||||
set ( PartialMap_Args ${PartialMap_Args} -p )
|
||||
|
||||
# Combine each layer
|
||||
string ( REPLACE " " ";" MAP_LIST ${MAP} ) # Change spaces to semicolons
|
||||
foreach ( MAP_PART ${MAP_LIST} )
|
||||
# Check if kll file is in build directory, otherwise default to layout directory
|
||||
if ( EXISTS "${PROJECT_BINARY_DIR}/${MAP_PART}.kll" )
|
||||
set ( PartialMap_Args ${PartialMap_Args} ${MAP_PART}.kll )
|
||||
set ( KLL_DEPENDS ${KLL_DEPENDS} ${MAP_PART}.kll )
|
||||
else ()
|
||||
set ( PartialMap_Args ${PartialMap_Args} ${PROJECT_SOURCE_DIR}/kll/layouts/${MAP_PART}.kll )
|
||||
set ( KLL_DEPENDS ${KLL_DEPENDS} ${PROJECT_SOURCE_DIR}/kll/layouts/${MAP_PART}.kll )
|
||||
endif ()
|
||||
endforeach ()
|
||||
endforeach ()
|
||||
endif ()
|
||||
|
||||
|
||||
|
||||
###
|
||||
# Run KLL Compiler
|
||||
#
|
||||
|
||||
#| KLL Options
|
||||
set ( kll_backend -b kiibohd )
|
||||
set ( kll_template -t ${PROJECT_SOURCE_DIR}/kll/templates/kiibohdKeymap.h )
|
||||
set ( kll_outputname generatedKeymap.h )
|
||||
set ( kll_output -o ${kll_outputname} )
|
||||
|
||||
#| KLL Cmd
|
||||
set ( kll_cmd ${PROJECT_SOURCE_DIR}/kll/kll.py ${BaseMap_Args} ${DefaultMap_Args} ${PartialMap_Args} ${kll_backend} ${kll_template} ${kll_output} )
|
||||
add_custom_command ( OUTPUT ${kll_outputname}
|
||||
COMMAND ${kll_cmd}
|
||||
DEPENDS ${KLL_DEPENDS}
|
||||
COMMENT "Generating KLL Layout"
|
||||
)
|
||||
|
||||
#| Append generated file to required sources so it becomes a dependency in the main build
|
||||
set ( SRCS ${SRCS} ${kll_outputname} )
|
||||
|
||||
|
||||
|
||||
endif () # PartialMap
|
||||
|
||||
|
|
@ -112,11 +112,6 @@ include ( "${DebugModulePath}/setup.cmake" )
|
|||
PathPrepend( DEBUG_SRCS ${DebugModulePath} ${DEBUG_SRCS} )
|
||||
|
||||
|
||||
#| Default Map
|
||||
# TODO Add support for different defaultMaps
|
||||
configure_file( "${ScanModulePath}/defaultMap.h" defaultMap.h )
|
||||
|
||||
|
||||
#| Print list of all module sources
|
||||
message( STATUS "Detected Scan Module Source Files:" )
|
||||
message( "${SCAN_SRCS}" )
|
||||
|
|
@ -150,7 +145,7 @@ set( MANUFACTURER "Kiibohd" )
|
|||
|
||||
#| Modified
|
||||
#| Takes a bit of work to extract the "M " using CMake, and not using it if there are no modifications
|
||||
execute_process( COMMAND git status -s -uno --porcelain
|
||||
execute_process( COMMAND ${GIT_EXECUTABLE} status -s -uno --porcelain
|
||||
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
|
||||
OUTPUT_VARIABLE Git_Modified_INFO
|
||||
ERROR_QUIET
|
||||
|
|
@ -164,7 +159,7 @@ if ( ${Git_Modified_LENGTH} GREATER 2 )
|
|||
endif ()
|
||||
|
||||
#| Branch
|
||||
execute_process( COMMAND git rev-parse --abbrev-ref HEAD
|
||||
execute_process( COMMAND ${GIT_EXECUTABLE} rev-parse --abbrev-ref HEAD
|
||||
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
|
||||
OUTPUT_VARIABLE Git_Branch_INFO
|
||||
ERROR_QUIET
|
||||
|
|
@ -172,7 +167,7 @@ execute_process( COMMAND git rev-parse --abbrev-ref HEAD
|
|||
)
|
||||
|
||||
#| Date
|
||||
execute_process( COMMAND git show -s --format=%ci
|
||||
execute_process( COMMAND ${GIT_EXECUTABLE} show -s --format=%ci
|
||||
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
|
||||
OUTPUT_VARIABLE Git_Date_INFO
|
||||
ERROR_QUIET
|
||||
|
|
@ -180,7 +175,7 @@ execute_process( COMMAND git show -s --format=%ci
|
|||
)
|
||||
|
||||
#| Commit Author and Email
|
||||
execute_process( COMMAND git show -s --format="%cn <%ce>"
|
||||
execute_process( COMMAND ${GIT_EXECUTABLE} show -s --format="%cn <%ce>"
|
||||
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
|
||||
OUTPUT_VARIABLE Git_Commit_Author
|
||||
ERROR_QUIET
|
||||
|
|
@ -188,7 +183,7 @@ execute_process( COMMAND git show -s --format="%cn <%ce>"
|
|||
)
|
||||
|
||||
#| Commit Revision
|
||||
execute_process( COMMAND git show -s --format=%H
|
||||
execute_process( COMMAND ${GIT_EXECUTABLE} show -s --format=%H
|
||||
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
|
||||
OUTPUT_VARIABLE Git_Commit_Revision
|
||||
ERROR_QUIET
|
||||
|
|
@ -196,7 +191,7 @@ execute_process( COMMAND git show -s --format=%H
|
|||
)
|
||||
|
||||
#| Origin URL
|
||||
execute_process( COMMAND git config --get remote.origin.url
|
||||
execute_process( COMMAND ${GIT_EXECUTABLE} config --get remote.origin.url
|
||||
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
|
||||
OUTPUT_VARIABLE Git_Origin_URL
|
||||
ERROR_QUIET
|
||||
|
|
@ -271,84 +266,10 @@ endif()
|
|||
|
||||
|
||||
|
||||
###
|
||||
# Build Targets
|
||||
#
|
||||
|
||||
#| 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
|
||||
)
|
||||
|
||||
|
||||
#| Convert the .ELF into a .bin to load onto the McHCK
|
||||
if( DEFINED DFU )
|
||||
set( TARGET_BIN ${TARGET}.dfu.bin )
|
||||
add_custom_command( TARGET ${TARGET_ELF} POST_BUILD
|
||||
COMMAND ${CMAKE_OBJCOPY} ${BIN_FLAGS} ${TARGET_ELF} ${TARGET_BIN}
|
||||
COMMENT "Creating dfu binary file: ${TARGET_BIN}"
|
||||
)
|
||||
endif()
|
||||
|
||||
|
||||
#| Convert the .ELF into a .HEX to load onto the Teensy
|
||||
if ( DEFINED TEENSY )
|
||||
set( TARGET_HEX ${TARGET}.teensy.hex )
|
||||
add_custom_command( TARGET ${TARGET_ELF} POST_BUILD
|
||||
COMMAND ${CMAKE_OBJCOPY} ${HEX_FLAGS} ${TARGET_ELF} ${TARGET_HEX}
|
||||
COMMENT "Creating iHex file to load: ${TARGET_HEX}"
|
||||
)
|
||||
endif()
|
||||
|
||||
|
||||
#| Generate the Extended .LSS
|
||||
set( TARGET_LSS ${TARGET}.lss )
|
||||
add_custom_command( TARGET ${TARGET_ELF} POST_BUILD
|
||||
COMMAND ${CMAKE_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 ${CMAKE_NM} -n ${TARGET_ELF} > ${TARGET_SYM}
|
||||
COMMENT "Creating Symbol Table: ${TARGET_SYM}"
|
||||
)
|
||||
|
||||
|
||||
#| Compiler Selection Record
|
||||
add_custom_command( TARGET ${TARGET_ELF} POST_BUILD
|
||||
COMMAND ${CMAKE_SOURCE_DIR}/Lib/CMake/writer compiler ${COMPILER_FAMILY}
|
||||
)
|
||||
|
||||
|
||||
|
||||
###
|
||||
# Size Information
|
||||
#
|
||||
|
||||
#| After Changes Size Information
|
||||
add_custom_target( SizeAfter ALL
|
||||
COMMAND ${CMAKE_SOURCE_DIR}/Lib/CMake/sizeCalculator ${CMAKE_SIZE} ram ${TARGET_ELF} ${SIZE_RAM} " SRAM"
|
||||
COMMAND ${CMAKE_SOURCE_DIR}/Lib/CMake/sizeCalculator ${CMAKE_SIZE} flash ${TARGET_ELF} ${SIZE_FLASH} "Flash"
|
||||
DEPENDS ${TARGET_ELF}
|
||||
COMMENT "Chip usage for ${CHIP}"
|
||||
)
|
||||
|
||||
|
||||
|
||||
###
|
||||
# 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" )
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue