From f03e3c40ee4e6e01384decdd7390985e1e885ae0 Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Tue, 26 Jul 2022 19:33:09 -0400 Subject: [PATCH 01/17] WIP/proof-of-concept --- .gitignore | 4 +- .vscode/cmake-kits.json | 9 ++ .vscode/cmake-variants.yaml | 11 ++ .vscode/settings.json | 9 ++ CMakeLists.txt | 243 +++++++++++++++++++++++++--- cmake/LocalAvrGcc.cmake | 93 +++++++++++ cmake/Utilities.cmake | 64 ++++++++ cmake/helpers/Configuration_prusa.h | 24 +++ utils/bootstrap.py | 191 ++++++++++++++++++++++ 9 files changed, 629 insertions(+), 19 deletions(-) create mode 100644 .vscode/cmake-kits.json create mode 100644 .vscode/cmake-variants.yaml create mode 100644 .vscode/settings.json create mode 100644 cmake/LocalAvrGcc.cmake create mode 100644 cmake/Utilities.cmake create mode 100644 cmake/helpers/Configuration_prusa.h create mode 100755 utils/bootstrap.py diff --git a/.gitignore b/.gitignore index 41ad449af..ac190dd36 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,8 @@ /.settings /.project /.cproject -/.vscode + +/build/ # Temporary configuration /Firmware/Configuration_prusa.h @@ -23,3 +24,4 @@ __pycache__ # Generated files /build-env/ /Firmware/Doc/ +compile_commands.json diff --git a/.vscode/cmake-kits.json b/.vscode/cmake-kits.json new file mode 100644 index 000000000..149bd1988 --- /dev/null +++ b/.vscode/cmake-kits.json @@ -0,0 +1,9 @@ +[ + { + "name": "Local_gcc-avr-none-eabi", + "toolchainFile": "${workspaceFolder}/cmake/LocalAvrGcc.cmake", + "cmakeSettings": { + "CMAKE_MAKE_PROGRAM": "${workspaceFolder}/.dependencies/ninja-1.9.0/ninja" + } + } +] diff --git a/.vscode/cmake-variants.yaml b/.vscode/cmake-variants.yaml new file mode 100644 index 000000000..70f8df827 --- /dev/null +++ b/.vscode/cmake-variants.yaml @@ -0,0 +1,11 @@ +buildType: + default: debug + choices: + debug: + short: Debug + long: Emit debug information + buildType: Debug + release: + short: Release + long: Optimize generated code + buildType: Release diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 000000000..09d4a863f --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,9 @@ +{ + "cmake.configureOnOpen": true, + "cmake.copyCompileCommands": "${workspaceFolder}/compile_commands.json", + "cmake.cmakePath": "${workspaceFolder}/.dependencies/cmake-3.22.5/bin/cmake", + "files.insertFinalNewline": true, + "files.associations": { + "xlocale": "cpp" + } +} diff --git a/CMakeLists.txt b/CMakeLists.txt index 4ca1d95be..ca06bdc58 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,24 +1,231 @@ -cmake_minimum_required(VERSION 3.1) +cmake_minimum_required(VERSION 3.15) +include(cmake/Utilities.cmake) set (CMAKE_CXX_STANDARD 11) +project(Prusa-Firmware) -project(cmake_test) +get_recommended_gcc_version(RECOMMENDED_TOOLCHAIN_VERSION) +if(CMAKE_CROSSCOMPILING AND NOT CMAKE_CXX_COMPILER_VERSION VERSION_EQUAL + ${RECOMMENDED_TOOLCHAIN_VERSION} + ) + message(WARNING "Recommended AVR toolchain is ${RECOMMENDED_TOOLCHAIN_VERSION}" + ", but you have ${CMAKE_CXX_COMPILER_VERSION}" + ) -# Prepare "Catch" library for other executables -set(CATCH_INCLUDE_DIR Catch2) -add_library(Catch INTERFACE) -target_include_directories(Catch INTERFACE ${CATCH_INCLUDE_DIR}) +elseif(NOT CMAKE_CROSSCOMPILING AND NOT CMAKE_CXX_COMPILER_ID STREQUAL "GNU") + message( + WARNING + "Recommended compiler for host tools and unittests is GCC, you have ${CMAKE_CXX_COMPILER_ID}." + ) +endif() -# Make test executable -set(TEST_SOURCES - Tests/tests.cpp - Tests/Example_test.cpp - Tests/Timer_test.cpp - Tests/AutoDeplete_test.cpp - Tests/PrusaStatistics_test.cpp - Firmware/Timer.cpp - Firmware/AutoDeplete.cpp +# append custom C/C++ flags +if(CUSTOM_COMPILE_OPTIONS) + string(REPLACE " " ";" CUSTOM_COMPILE_OPTIONS "${CUSTOM_COMPILE_OPTIONS}") + add_compile_options(${CUSTOM_COMPILE_OPTIONS}) +endif() + +# +# Global Compiler & Linker Configuration +# + +# include symbols +add_compile_options(-g) + +# optimizations +if(CMAKE_CROSSCOMPILING) + if(CMAKE_BUILD_TYPE STREQUAL "Debug") + add_compile_options(-Og) + else() + add_compile_options(-Os) + endif() + + # mcu related settings + set(MCU_FLAGS -mmcu=atmega2560 -DF_CPU=16000000L) + add_compile_options(${MCU_FLAGS}) + add_link_options(${MCU_FLAGS}) + + # split and gc sections + add_compile_options(-ffunction-sections -fdata-sections) + add_link_options(-Wl,--gc-sections) + + # disable exceptions and related metadata + add_compile_options(-fno-exceptions -fno-unwind-tables) + add_compile_options($<$:-fno-rtti>) + add_link_options(-Wl,--defsym,__exidx_start=0,--defsym,__exidx_end=0) +else() + if(CMAKE_BUILD_TYPE STREQUAL "Debug") + add_compile_options(-O0) + else() + add_compile_options(-O2) + endif() +endif() + +# enable all warnings (well, not all, but some) +add_compile_options(-Wall -Wsign-compare) +add_compile_options($<$:-std=c++14>) + +# support _DEBUG macro (some code uses to recognize debug builds) +if(CMAKE_BUILD_TYPE STREQUAL "Debug") + add_compile_definitions(_DEBUG) +endif() + +# +# Firmware - get file lists. +# +file(GLOB FW_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmware/*.c*) +file(GLOB FW_HEADERS RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmware/*.h*) +file(GLOB AVR_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/.dependencies/1.8.19-1.0.5-1-linux-64/portable/packages/PrusaResearch/hardware/avr/1.0.5-1/cores/prusa_einsy_rambo/*.c*) + + # Setup language resources: +file(GLOB LANG_VARIANTS RELATIVE ${PROJECT_SOURCE_DIR}/lang/po ${PROJECT_SOURCE_DIR}/lang/po/Firmware_??.po) +string(REPLACE "Firmware_" "" LANG_VARIANTS "${LANG_VARIANTS}") +string(REPLACE ".po" "" LANG_VARIANTS "${LANG_VARIANTS}") +message("Languages found: ${LANG_VARIANTS}") + +add_library(avr_core STATIC ${AVR_SOURCES}) +target_include_directories(avr_core PRIVATE + ${PROJECT_SOURCE_DIR}/.dependencies/1.8.19-1.0.5-1-linux-64/portable/packages/PrusaResearch/hardware/avr/1.0.5-1/cores/prusa_einsy_rambo/ + ${PROJECT_SOURCE_DIR}/.dependencies/1.8.19-1.0.5-1-linux-64/portable/packages/PrusaResearch/hardware/avr/1.0.5-1/variants/prusa_einsy_rambo/ ) -add_executable(tests ${TEST_SOURCES}) -target_include_directories(tests PRIVATE Tests) -target_link_libraries(tests Catch) +target_compile_options(avr_core PUBLIC -mmcu=atmega2560) + +function(fw_add_variant variant_name) + + add_executable(${variant_name} ${FW_SOURCES} ${FW_HEADERS}) + + set_target_properties(${variant_name} PROPERTIES CXX_STANDARD 14) + + +# # configure linker script + set(LINKER_SCRIPT ${PROJECT_SOURCE_DIR}/.dependencies/1.8.19-1.0.5-1-linux-64/portable/packages/PrusaResearch/hardware/avr/1.0.5-1/ldscripts/avr6.xn) + target_link_options(${variant_name} PUBLIC -Wl,-T,${LINKER_SCRIPT}) + add_link_dependency(${variant_name} ${LINKER_SCRIPT}) + + + # limit the text section to 248K (256K - 8k reserved for the bootloader) + target_link_options(${variant_name} PUBLIC -Wl,--defsym=__TEXT_REGION_LENGTH__=248K) + + # generate firmware.bin file + objcopy(${variant_name} "ihex" ".hex") + + # produce ASM listing. Note we also specify the .map as a byproduct so it gets cleaned + # because link_options doesn't have a "generated outputs" feature. + add_custom_command( + TARGET ${variant_name} POST_BUILD COMMAND ${CMAKE_OBJDUMP} -CSd ${variant_name} > ${variant_name}.asm + BYPRODUCTS ${variant_name}.asm ${variant_name}.map + ) + + # inform about the firmware's size in terminal + add_custom_command( + TARGET ${variant_name} POST_BUILD COMMAND ${CMAKE_SIZE_UTIL} -C --mcu=atmega2560 ${variant_name} + ) + report_size(${variant_name}) + + # generate linker map file + target_link_options(${variant_name} PUBLIC -Wl,-Map=${variant_name}.map) + + + target_include_directories(${variant_name} PRIVATE Firmware + ${PROJECT_SOURCE_DIR}/.dependencies/1.8.19-1.0.5-1-linux-64/portable/packages/PrusaResearch/hardware/avr/1.0.5-1/cores/prusa_einsy_rambo/ + ${PROJECT_SOURCE_DIR}/.dependencies/1.8.19-1.0.5-1-linux-64/portable/packages/PrusaResearch/hardware/avr/1.0.5-1/variants/prusa_einsy_rambo/ + ${PROJECT_SOURCE_DIR}/cmake/helpers/ # Add our magic config helper :) + ) + + target_compile_options(${variant_name} PRIVATE) # turn this on for lolz -Wdouble-promotion) + string(REPLACE "-" "_" DEFINE_NAME "${variant_name}") + target_compile_definitions(${variant_name} PRIVATE H${DEFINE_NAME} ARDUINO=10600 __AVR_ATmega2560__) + target_link_libraries(${variant_name} avr_core) + + #Construct language map + set(LANG_MAP ${CMAKE_CURRENT_BINARY_DIR}/lang/${variant_name}_lang.map) + set(LANG_FWBIN ${CMAKE_BINARY_DIR}/${variant_name}.bin) + set(LANG_FINAL_BIN ${CMAKE_CURRENT_BINARY_DIR}/lang/${variant_name}_lang.bin) + set(LANG_FINAL_HEX ${CMAKE_CURRENT_BINARY_DIR}/lang/${variant_name}_lang.hex) + + add_custom_command(OUTPUT ${LANG_FWBIN} + COMMAND "${CMAKE_OBJCOPY}" -I ihex -O binary ${CMAKE_BINARY_DIR}/${variant_name}.hex ${LANG_FWBIN} + DEPENDS ${variant_name} + ) + add_custom_command(OUTPUT ${LANG_MAP} + COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-map.py "${CMAKE_BINARY_DIR}/${variant_name}" "${LANG_FWBIN}" > "${LANG_MAP}" + DEPENDS ${LANG_FWBIN} + ) + + set(LANG_BINS "") + foreach (LANG IN LISTS LANG_VARIANTS) + set(LANG_BIN ${CMAKE_CURRENT_BINARY_DIR}/lang/${variant_name}_${LANG}.bin) + + set(PO_FILE "${CMAKE_CURRENT_SOURCE_DIR}/lang/po/Firmware_${LANG}.po") + add_custom_command(OUTPUT ${LANG_BIN} + # COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-check.py --no-warning --map "${LANG_MAP}" "${PO_FILE}" + # COMMAND ${CMAKE_COMMAND} -E echo "Building lang_${LANG}.bin" + COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-build.py ${LANG_MAP} ${PO_FILE} ${LANG_BIN} + DEPENDS ${LANG_MAP} + COMMENT "Generating ${variant_name}_${LANG}.bin from .po" + ) + LIST(APPEND LANG_BINS ${LANG_BIN}) + endforeach() + add_custom_command( OUTPUT ${LANG_FINAL_BIN} + # TODO - needs differentiation for platforms, e.g. copy /b on Win + COMMAND cat ${LANG_BINS} > ${LANG_FINAL_BIN} + DEPENDS ${LANG_BINS} + COMMENT "Merging language binaries" + ) + add_custom_command( OUTPUT ${LANG_FINAL_HEX} + # TODO - needs differentiation for platforms, e.g. copy /b on Win + COMMAND ${CMAKE_OBJCOPY} -I binary -O ihex ${LANG_FINAL_BIN} ${LANG_FINAL_HEX} + DEPENDS ${LANG_FINAL_BIN} + COMMENT "Generating Hex for language data" + ) + set(LANG_HEX ${CMAKE_BINARY_DIR}/${variant_name}-lang.hex) + add_custom_target(${variant_name}-languages + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/${variant_name}.hex ${LANG_HEX} + COMMAND cat ${LANG_FINAL_HEX} >> ${LANG_HEX} + COMMENT "Generating final ${variant_name}-lang.hex" + BYPRODUCTS ${LANG_HEX} + DEPENDS ${LANG_FINAL_HEX} + ) + +endfunction() + + +if(CMAKE_CROSSCOMPILING) + + add_custom_target(All_Firmware) + + file(GLOB FW_VARIANTS RELATIVE ${PROJECT_SOURCE_DIR}/Firmware/variants ${PROJECT_SOURCE_DIR}/Firmware/variants/*.h) + foreach(THIS_VAR IN LISTS FW_VARIANTS) + string(REPLACE ".h" "" TRIMMED_NAME "${THIS_VAR}") + message("Variant added: ${TRIMMED_NAME}") + fw_add_variant(${TRIMMED_NAME}) + add_dependencies(All_Firmware ${TRIMMED_NAME}) + + endforeach(THIS_VAR IN LISTS FW_VARIANTS) + +endif() + +if(NOT CMAKE_CROSSCOMPILING) + # do not build the firmware by default (tests are the focus if not crosscompiling) + project(cmake_test) + + # Prepare "Catch" library for other executables + set(CATCH_INCLUDE_DIR Catch2) + add_library(Catch INTERFACE) + target_include_directories(Catch INTERFACE ${CATCH_INCLUDE_DIR}) + + # Make test executable + set(TEST_SOURCES + Tests/tests.cpp + Tests/Example_test.cpp + Tests/Timer_test.cpp + Tests/AutoDeplete_test.cpp + Tests/PrusaStatistics_test.cpp + Firmware/Timer.cpp + Firmware/AutoDeplete.cpp + ) + add_executable(tests ${TEST_SOURCES}) + target_include_directories(tests PRIVATE Tests) + target_link_libraries(tests Catch) + +endif() diff --git a/cmake/LocalAvrGcc.cmake b/cmake/LocalAvrGcc.cmake new file mode 100644 index 000000000..e8c317417 --- /dev/null +++ b/cmake/LocalAvrGcc.cmake @@ -0,0 +1,93 @@ +get_filename_component(PROJECT_CMAKE_DIR "${CMAKE_CURRENT_LIST_FILE}" DIRECTORY) +include("${PROJECT_CMAKE_DIR}/Utilities.cmake") +set(CMAKE_SYSTEM_NAME Generic) +set(CMAKE_SYSTEM_PROCESSOR avr) +set(CMAKE_CROSSCOMPILING 1) + +set(AVR_TOOLCHAIN_DIR "${PROJECT_CMAKE_DIR}/../.dependencies/1.8.19-1.0.5-1-linux-64/hardware/tools/avr/") +message( "tc dir is ${AVR_TOOLCHAIN_DIR}") +# +# Utilities + +if(MINGW + OR CYGWIN + OR WIN32 + ) + set(UTIL_SEARCH_CMD where) + set(EXECUTABLE_SUFFIX ".exe") +elseif(UNIX OR APPLE) + set(UTIL_SEARCH_CMD which) + set(EXECUTABLE_SUFFIX "") +endif() + +set(TOOLCHAIN_PREFIX avr-) + +# +# Looking up the toolchain +# + +if(AVR_TOOLCHAIN_DIR) + # using toolchain set by AvrGcc.cmake (locked version) + set(BINUTILS_PATH "${AVR_TOOLCHAIN_DIR}/bin") +else() + # search for ANY avr-gcc toolchain + execute_process( + COMMAND ${UTIL_SEARCH_CMD} ${TOOLCHAIN_PREFIX}gcc + OUTPUT_VARIABLE AVR_GCC_PATH + OUTPUT_STRIP_TRAILING_WHITESPACE + RESULT_VARIABLE FIND_RESULT + ) + # found? + if(NOT "${FIND_RESULT}" STREQUAL "0") + message(FATAL_ERROR "avr-gcc not found") + endif() + get_filename_component(BINUTILS_PATH "${AVR_GCC_PATH}" DIRECTORY) + get_filename_component(AVR_TOOLCHAIN_DIR ${BINUTILS_PATH} DIRECTORY) +endif() + +# +# Setup CMake +# + +# Without that flag CMake is not able to pass test compilation check +set(CMAKE_TRY_COMPILE_TARGET_TYPE STATIC_LIBRARY) + +set(CMAKE_C_COMPILER + "${BINUTILS_PATH}/${TOOLCHAIN_PREFIX}gcc${EXECUTABLE_SUFFIX}" + CACHE FILEPATH "" FORCE + ) +set(CMAKE_ASM_COMPILER + "${BINUTILS_PATH}/${TOOLCHAIN_PREFIX}gcc${EXECUTABLE_SUFFIX}" + CACHE FILEPATH "" FORCE + ) +set(CMAKE_CXX_COMPILER + "${BINUTILS_PATH}/${TOOLCHAIN_PREFIX}g++${EXECUTABLE_SUFFIX}" + CACHE FILEPATH "" FORCE + ) +set(CMAKE_EXE_LINKER_FLAGS_INIT + "" + CACHE STRING "" FORCE + ) + +set(CMAKE_ASM_COMPILE_OBJECT + " -o -c " + CACHE STRING "" FORCE + ) + +set(CMAKE_OBJCOPY + "${BINUTILS_PATH}/${TOOLCHAIN_PREFIX}objcopy${EXECUTABLE_SUFFIX}" + CACHE INTERNAL "objcopy tool" + ) +set(CMAKE_OBJDUMP + "${BINUTILS_PATH}/${TOOLCHAIN_PREFIX}objdump${EXECUTABLE_SUFFIX}" + CACHE INTERNAL "objdump tool" + ) +set(CMAKE_SIZE_UTIL + "${BINUTILS_PATH}/${TOOLCHAIN_PREFIX}size${EXECUTABLE_SUFFIX}" + CACHE INTERNAL "size tool" + ) + +set(CMAKE_FIND_ROOT_PATH "${AVR_TOOLCHAIN_DIR}") +set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) +set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) +set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) diff --git a/cmake/Utilities.cmake b/cmake/Utilities.cmake new file mode 100644 index 000000000..2221f0b77 --- /dev/null +++ b/cmake/Utilities.cmake @@ -0,0 +1,64 @@ +get_filename_component(PROJECT_CMAKE_DIR "${CMAKE_CURRENT_LIST_FILE}" DIRECTORY) +get_filename_component(PROJECT_ROOT_DIR "${PROJECT_CMAKE_DIR}" DIRECTORY) + +find_package(Python3 COMPONENTS Interpreter) +if(NOT Python3_FOUND) + message(FATAL_ERROR "Python3 not found.") +endif() + +function(get_recommended_gcc_version var) + execute_process( + COMMAND "${Python3_EXECUTABLE}" "${PROJECT_ROOT_DIR}/utils/bootstrap.py" + "--print-dependency-version" "gcc-avr" + OUTPUT_VARIABLE RECOMMENDED_VERSION + OUTPUT_STRIP_TRAILING_WHITESPACE + RESULT_VARIABLE RETVAL + ) + + if(NOT "${RETVAL}" STREQUAL "0") + message(FATAL_ERROR "Failed to obtain recommended gcc version from utils/bootstrap.py") + endif() + + set(${var} + ${RECOMMENDED_VERSION} + PARENT_SCOPE + ) +endfunction() + +function(get_dependency_directory dependency var) + execute_process( + COMMAND "${Python3_EXECUTABLE}" "${PROJECT_ROOT_DIR}/utils/bootstrap.py" + "--print-dependency-directory" "${dependency}" + OUTPUT_VARIABLE DEPENDENCY_DIRECTORY + OUTPUT_STRIP_TRAILING_WHITESPACE + RESULT_VARIABLE RETVAL + ) + + if(NOT "${RETVAL}" STREQUAL "0") + message(FATAL_ERROR "Failed to find directory with ${dependency}") + endif() + + set(${var} + ${DEPENDENCY_DIRECTORY} + PARENT_SCOPE + ) +endfunction() + +function(objcopy target format suffix) + add_custom_command( + TARGET ${target} POST_BUILD + COMMAND "${CMAKE_OBJCOPY}" -O ${format} -S "$" + "${CMAKE_CURRENT_BINARY_DIR}/${target}${suffix}" + COMMENT "Generating ${format} from ${target}..." + BYPRODUCTS "${CMAKE_CURRENT_BINARY_DIR}/${target}${suffix}" + ) +endfunction() + +function(report_size target) + add_custom_command( + TARGET ${target} POST_BUILD + COMMAND echo "" # visually separate the output + COMMAND "${CMAKE_SIZE_UTIL}" -B "$" + USES_TERMINAL + ) +endfunction() diff --git a/cmake/helpers/Configuration_prusa.h b/cmake/helpers/Configuration_prusa.h new file mode 100644 index 000000000..a308af746 --- /dev/null +++ b/cmake/helpers/Configuration_prusa.h @@ -0,0 +1,24 @@ +#ifdef H1_75mm_MK25_RAMBo10a_E3Dv6full +#include "variants/1_75mm_MK25-RAMBo10a-E3Dv6full.h" +#endif +#ifdef H1_75mm_MK25_RAMBo13a_E3Dv6full +#include "variants/1_75mm_MK25-RAMBo13a-E3Dv6full.h" +#endif +#ifdef H1_75mm_MK25S_RAMBo10a_E3Dv6full +#include "variants/1_75mm_MK25S-RAMBo10a-E3Dv6full.h" +#endif +#ifdef H1_75mm_MK25S_RAMBo13a_E3Dv6full +#include "variants/1_75mm_MK25S-RAMBo13a-E3Dv6full.h" +#endif +#ifdef H1_75mm_MK2_RAMBo10a_E3Dv6full +#include "variants/1_75mm_MK2-RAMBo10a-E3Dv6full.h" +#endif +#ifdef H1_75mm_MK2_RAMBo13a_E3Dv6full +#include "variants/1_75mm_MK2-RAMBo13a-E3Dv6full.h" +#endif +#ifdef H1_75mm_MK3_EINSy10a_E3Dv6full +#include "variants/1_75mm_MK3-EINSy10a-E3Dv6full.h" +#endif +#ifdef H1_75mm_MK3S_EINSy10a_E3Dv6full +#include "variants/1_75mm_MK3S-EINSy10a-E3Dv6full.h" +#endif \ No newline at end of file diff --git a/utils/bootstrap.py b/utils/bootstrap.py new file mode 100755 index 000000000..fbe77ec74 --- /dev/null +++ b/utils/bootstrap.py @@ -0,0 +1,191 @@ +#!/usr/bin/env python3 +# +# Bootstrap Script +# +# This script +# 1) records the recommended versions of dependencies, and +# 2) when run, checks that all of them are present and downloads +# them if they are not. +# +# pylint: disable=line-too-long +import json +import os +import platform +import shutil +import stat +import subprocess +import sys +import tarfile +import zipfile +from argparse import ArgumentParser +from pathlib import Path +from urllib.request import urlretrieve + +project_root_dir = Path(__file__).resolve().parent.parent +dependencies_dir = project_root_dir / '.dependencies' + +# All dependencies of this project. +# +# yapf: disable +dependencies = { + 'ninja': { + 'version': '1.9.0', + 'url': { + 'Linux': 'https://github.com/ninja-build/ninja/releases/download/v1.9.0/ninja-linux.zip', + 'Windows': 'https://github.com/ninja-build/ninja/releases/download/v1.9.0/ninja-win.zip', + 'Darwin': 'https://github.com/ninja-build/ninja/releases/download/v1.9.0/ninja-mac.zip', + }, + }, + 'cmake': { + 'version': '3.15.5', + 'url': { + 'Linux': 'https://github.com/Kitware/CMake/releases/download/v3.15.5/cmake-3.15.5-Linux-x86_64.tar.gz', + 'Windows': 'https://github.com/Kitware/CMake/releases/download/v3.15.5/cmake-3.15.5-win64-x64.zip', + 'Darwin': 'https://github.com/Kitware/CMake/releases/download/v3.15.5/cmake-3.15.5-Darwin-x86_64.tar.gz', + }, + }, + 'gcc-avr': { + # dummy placeholder (currently downloading cmake just for the sake of a valid url/zip archive) + # ... we truly need the binaries! :) + 'version': '0.0.0', + 'url': { + 'Linux': 'https://github.com/Kitware/CMake/releases/download/v3.15.5/cmake-3.15.5-Linux-x86_64.tar.gz', + 'Windows': 'https://github.com/Kitware/CMake/releases/download/v3.15.5/cmake-3.15.5-win64-x64.zip', + 'Darwin': 'https://github.com/Kitware/CMake/releases/download/v3.15.5/cmake-3.15.5-Darwin-x86_64.tar.gz', + } + }, +} +pip_dependencies = [] +# yapf: enable + + +def directory_for_dependency(dependency, version): + return dependencies_dir / (dependency + '-' + version) + + +def find_single_subdir(path: Path): + members = list(path.iterdir()) + if path.is_dir() and len(members) > 1: + return path + elif path.is_dir() and len(members) == 1: + return find_single_subdir(members[0]) if members[0].is_dir() else path + else: + raise RuntimeError + + +def download_and_unzip(url: str, directory: Path): + """Download a compressed file and extract it at `directory`.""" + extract_dir = directory.with_suffix('.temp') + shutil.rmtree(directory, ignore_errors=True) + shutil.rmtree(extract_dir, ignore_errors=True) + + print('Downloading ' + directory.name) + f, _ = urlretrieve(url, filename=None) + print('Extracting ' + directory.name) + if '.tar.bz2' in url or '.tar.gz' in url or '.tar.xz' in url: + obj = tarfile.open(f) + else: + obj = zipfile.ZipFile(f, 'r') + obj.extractall(path=str(extract_dir)) + + subdir = find_single_subdir(extract_dir) + shutil.move(str(subdir), str(directory)) + shutil.rmtree(extract_dir, ignore_errors=True) + + +def run(*cmd): + process = subprocess.run([str(a) for a in cmd], + stdout=subprocess.PIPE, + check=True, + encoding='utf-8') + return process.stdout.strip() + + +def fix_executable_permissions(dependency, installation_directory): + to_fix = ('ninja', 'clang-format') + if dependency not in to_fix: + return + for fpath in installation_directory.iterdir(): + if fpath.is_file and fpath.with_suffix('').name in to_fix: + st = os.stat(fpath) + os.chmod(fpath, st.st_mode | stat.S_IEXEC) + + +def recommended_version_is_available(dependency): + version = dependencies[dependency]['version'] + directory = directory_for_dependency(dependency, version) + return directory.exists() and directory.is_dir() + + +def get_installed_pip_packages(): + result = run(sys.executable, '-m', 'pip', 'list', + '--disable-pip-version-check', '--format', 'json') + data = json.loads(result) + return [(pkg['name'].lower(), pkg['version']) for pkg in data] + + +def install_dependency(dependency): + specs = dependencies[dependency] + installation_directory = directory_for_dependency(dependency, + specs['version']) + url = specs['url'] + if isinstance(url, dict): + url = url[platform.system()] + download_and_unzip(url=url, directory=installation_directory) + fix_executable_permissions(dependency, installation_directory) + + +def main() -> int: + parser = ArgumentParser() + # yapf: disable + parser.add_argument( + '--print-dependency-version', type=str, + help='Prints recommended version of given dependency and exits.') + parser.add_argument( + '--print-dependency-directory', type=str, + help='Prints installation directory of given dependency and exits.') + args = parser.parse_args(sys.argv[1:]) + # yapf: enable + + if args.print_dependency_version: + try: + version = dependencies[args.print_dependency_version]['version'] + print(version) + return 0 + except KeyError: + print('Unknown dependency "%s"' % args.print_dependency_version) + return 1 + + if args.print_dependency_directory: + try: + dependency = args.print_dependency_directory + version = dependencies[dependency]['version'] + install_dir = directory_for_dependency(dependency, version) + print(install_dir) + return 0 + except KeyError: + print('Unknown dependency "%s"' % args.print_dependency_directory) + return 1 + + # if no argument present, check and install dependencies + for dependency in dependencies: + if recommended_version_is_available(dependency): + continue + install_dependency(dependency) + + # also, install pip packages + installed_pip_packages = get_installed_pip_packages() + for package in pip_dependencies: + is_installed = any(installed[0] == package + for installed in installed_pip_packages) + if is_installed: + continue + print('Installing Python package %s' % package) + run(sys.executable, '-m', 'pip', 'install', package, + '--disable-pip-version-check') + + return 0 + + +if __name__ == "__main__": + sys.exit(main()) From 739ccdf8042a596291af52de1444518be1de5c31 Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Wed, 27 Jul 2022 07:22:42 -0400 Subject: [PATCH 02/17] remove invalid command --- CMakeLists.txt | 2 -- 1 file changed, 2 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index ca06bdc58..466e0393d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -100,8 +100,6 @@ function(fw_add_variant variant_name) # # configure linker script set(LINKER_SCRIPT ${PROJECT_SOURCE_DIR}/.dependencies/1.8.19-1.0.5-1-linux-64/portable/packages/PrusaResearch/hardware/avr/1.0.5-1/ldscripts/avr6.xn) target_link_options(${variant_name} PUBLIC -Wl,-T,${LINKER_SCRIPT}) - add_link_dependency(${variant_name} ${LINKER_SCRIPT}) - # limit the text section to 248K (256K - 8k reserved for the bootloader) target_link_options(${variant_name} PUBLIC -Wl,--defsym=__TEXT_REGION_LENGTH__=248K) From e187538973681a5bad0acfb135542780c7dc2d22 Mon Sep 17 00:00:00 2001 From: 3d-gussner <3d.gussner@gmail.com> Date: Wed, 27 Jul 2022 15:01:07 +0200 Subject: [PATCH 03/17] Update bootstrap --- .gitignore | 3 ++- .vscode/cmake-kits.json | 4 ++-- CMakeLists.txt | 13 +++++++------ cmake/LocalAvrGcc.cmake | 4 ++-- cmake/Utilities.cmake | 2 +- utils/bootstrap.py | 36 +++++++++++++++++++++--------------- 6 files changed, 35 insertions(+), 27 deletions(-) diff --git a/.gitignore b/.gitignore index ac190dd36..316085fcd 100644 --- a/.gitignore +++ b/.gitignore @@ -3,8 +3,9 @@ /.project /.cproject +#cmake /build/ - +.dependencies # Temporary configuration /Firmware/Configuration_prusa.h diff --git a/.vscode/cmake-kits.json b/.vscode/cmake-kits.json index 149bd1988..4532781be 100644 --- a/.vscode/cmake-kits.json +++ b/.vscode/cmake-kits.json @@ -1,9 +1,9 @@ [ { - "name": "Local_gcc-avr-none-eabi", + "name": "Local_avr-gcc-none-eabi", "toolchainFile": "${workspaceFolder}/cmake/LocalAvrGcc.cmake", "cmakeSettings": { - "CMAKE_MAKE_PROGRAM": "${workspaceFolder}/.dependencies/ninja-1.9.0/ninja" + "CMAKE_MAKE_PROGRAM": "${workspaceFolder}/.dependencies/ninja-1.10.2/ninja" } } ] diff --git a/CMakeLists.txt b/CMakeLists.txt index 466e0393d..c139e6eba 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -2,6 +2,7 @@ cmake_minimum_required(VERSION 3.15) include(cmake/Utilities.cmake) set (CMAKE_CXX_STANDARD 11) +set (PRUSA_BOARDS 1.0.5-2) project(Prusa-Firmware) get_recommended_gcc_version(RECOMMENDED_TOOLCHAIN_VERSION) @@ -75,7 +76,7 @@ endif() # file(GLOB FW_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmware/*.c*) file(GLOB FW_HEADERS RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmware/*.h*) -file(GLOB AVR_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/.dependencies/1.8.19-1.0.5-1-linux-64/portable/packages/PrusaResearch/hardware/avr/1.0.5-1/cores/prusa_einsy_rambo/*.c*) +file(GLOB AVR_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/.dependencies/prusa3dboards-${PRUSA_BOARDS}/cores/prusa_einsy_rambo/*.c*) # Setup language resources: file(GLOB LANG_VARIANTS RELATIVE ${PROJECT_SOURCE_DIR}/lang/po ${PROJECT_SOURCE_DIR}/lang/po/Firmware_??.po) @@ -85,8 +86,8 @@ message("Languages found: ${LANG_VARIANTS}") add_library(avr_core STATIC ${AVR_SOURCES}) target_include_directories(avr_core PRIVATE - ${PROJECT_SOURCE_DIR}/.dependencies/1.8.19-1.0.5-1-linux-64/portable/packages/PrusaResearch/hardware/avr/1.0.5-1/cores/prusa_einsy_rambo/ - ${PROJECT_SOURCE_DIR}/.dependencies/1.8.19-1.0.5-1-linux-64/portable/packages/PrusaResearch/hardware/avr/1.0.5-1/variants/prusa_einsy_rambo/ + ${PROJECT_SOURCE_DIR}/.dependencies/prusa3dboards-${PRUSA_BOARDS}/cores/prusa_einsy_rambo/ + ${PROJECT_SOURCE_DIR}/.dependencies/prusa3dboards-${PRUSA_BOARDS}/variants/prusa_einsy_rambo/ ) target_compile_options(avr_core PUBLIC -mmcu=atmega2560) @@ -98,7 +99,7 @@ function(fw_add_variant variant_name) # # configure linker script - set(LINKER_SCRIPT ${PROJECT_SOURCE_DIR}/.dependencies/1.8.19-1.0.5-1-linux-64/portable/packages/PrusaResearch/hardware/avr/1.0.5-1/ldscripts/avr6.xn) + set(LINKER_SCRIPT ${PROJECT_SOURCE_DIR}/.dependencies/prusa3dboards-${PRUSA_BOARDS}/ldscripts/avr6.xn) target_link_options(${variant_name} PUBLIC -Wl,-T,${LINKER_SCRIPT}) # limit the text section to 248K (256K - 8k reserved for the bootloader) @@ -125,8 +126,8 @@ function(fw_add_variant variant_name) target_include_directories(${variant_name} PRIVATE Firmware - ${PROJECT_SOURCE_DIR}/.dependencies/1.8.19-1.0.5-1-linux-64/portable/packages/PrusaResearch/hardware/avr/1.0.5-1/cores/prusa_einsy_rambo/ - ${PROJECT_SOURCE_DIR}/.dependencies/1.8.19-1.0.5-1-linux-64/portable/packages/PrusaResearch/hardware/avr/1.0.5-1/variants/prusa_einsy_rambo/ + ${PROJECT_SOURCE_DIR}/.dependencies/prusa3dboards-${PRUSA_BOARDS}/cores/prusa_einsy_rambo/ + ${PROJECT_SOURCE_DIR}/.dependencies/prusa3dboards-${PRUSA_BOARDS}/variants/prusa_einsy_rambo/ ${PROJECT_SOURCE_DIR}/cmake/helpers/ # Add our magic config helper :) ) diff --git a/cmake/LocalAvrGcc.cmake b/cmake/LocalAvrGcc.cmake index e8c317417..e6c94e356 100644 --- a/cmake/LocalAvrGcc.cmake +++ b/cmake/LocalAvrGcc.cmake @@ -3,8 +3,8 @@ include("${PROJECT_CMAKE_DIR}/Utilities.cmake") set(CMAKE_SYSTEM_NAME Generic) set(CMAKE_SYSTEM_PROCESSOR avr) set(CMAKE_CROSSCOMPILING 1) - -set(AVR_TOOLCHAIN_DIR "${PROJECT_CMAKE_DIR}/../.dependencies/1.8.19-1.0.5-1-linux-64/hardware/tools/avr/") +set(AVR_GCC_VERSION 7.3.0) +set(AVR_TOOLCHAIN_DIR "${PROJECT_CMAKE_DIR}/../.dependencies/avr-gcc-${AVR_GCC_VERSION}/") message( "tc dir is ${AVR_TOOLCHAIN_DIR}") # # Utilities diff --git a/cmake/Utilities.cmake b/cmake/Utilities.cmake index 2221f0b77..fc37f14cd 100644 --- a/cmake/Utilities.cmake +++ b/cmake/Utilities.cmake @@ -9,7 +9,7 @@ endif() function(get_recommended_gcc_version var) execute_process( COMMAND "${Python3_EXECUTABLE}" "${PROJECT_ROOT_DIR}/utils/bootstrap.py" - "--print-dependency-version" "gcc-avr" + "--print-dependency-version" "avr-gcc" OUTPUT_VARIABLE RECOMMENDED_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE RESULT_VARIABLE RETVAL diff --git a/utils/bootstrap.py b/utils/bootstrap.py index fbe77ec74..f606aa846 100755 --- a/utils/bootstrap.py +++ b/utils/bootstrap.py @@ -29,29 +29,35 @@ dependencies_dir = project_root_dir / '.dependencies' # yapf: disable dependencies = { 'ninja': { - 'version': '1.9.0', + 'version': '1.10.2', 'url': { - 'Linux': 'https://github.com/ninja-build/ninja/releases/download/v1.9.0/ninja-linux.zip', - 'Windows': 'https://github.com/ninja-build/ninja/releases/download/v1.9.0/ninja-win.zip', - 'Darwin': 'https://github.com/ninja-build/ninja/releases/download/v1.9.0/ninja-mac.zip', + 'Linux': 'https://github.com/ninja-build/ninja/releases/download/v1.10.2/ninja-linux.zip', + 'Windows': 'https://github.com/ninja-build/ninja/releases/download/v1.10.2/ninja-win.zip', + 'Darwin': 'https://github.com/ninja-build/ninja/releases/download/v1.10.2/ninja-mac.zip', }, }, 'cmake': { - 'version': '3.15.5', + 'version': '3.22.5', 'url': { - 'Linux': 'https://github.com/Kitware/CMake/releases/download/v3.15.5/cmake-3.15.5-Linux-x86_64.tar.gz', - 'Windows': 'https://github.com/Kitware/CMake/releases/download/v3.15.5/cmake-3.15.5-win64-x64.zip', - 'Darwin': 'https://github.com/Kitware/CMake/releases/download/v3.15.5/cmake-3.15.5-Darwin-x86_64.tar.gz', + 'Linux': 'https://github.com/Kitware/CMake/releases/download/v3.22.5/cmake-3.22.5-Linux-x86_64.tar.gz', + 'Windows': 'https://github.com/Kitware/CMake/releases/download/v3.22.5/cmake-3.22.5-win64-x64.zip', + 'Darwin': 'https://github.com/Kitware/CMake/releases/download/v3.22.5/cmake-3.22.5-Darwin-x86_64.tar.gz', }, }, - 'gcc-avr': { - # dummy placeholder (currently downloading cmake just for the sake of a valid url/zip archive) - # ... we truly need the binaries! :) - 'version': '0.0.0', + 'avr-gcc': { + 'version': '7.3.0', 'url': { - 'Linux': 'https://github.com/Kitware/CMake/releases/download/v3.15.5/cmake-3.15.5-Linux-x86_64.tar.gz', - 'Windows': 'https://github.com/Kitware/CMake/releases/download/v3.15.5/cmake-3.15.5-win64-x64.zip', - 'Darwin': 'https://github.com/Kitware/CMake/releases/download/v3.15.5/cmake-3.15.5-Darwin-x86_64.tar.gz', + 'Linux': 'http://downloads.arduino.cc/tools/avr-gcc-7.3.0-atmel3.6.1-arduino7-x86_64-pc-linux-gnu.tar.bz2', + 'Windows': 'http://downloads.arduino.cc/tools/avr-gcc-7.3.0-atmel3.6.1-arduino7-i686-w64-mingw32.zip', + 'Darwin': 'http://downloads.arduino.cc/tools/avr-gcc-7.3.0-atmel3.6.1-arduino7-x86_64-apple-darwin14.tar.bz2', + }, + }, + 'prusa3dboards': { + 'version': '1.0.5-2', + 'url': { + 'Linux': 'https://raw.githubusercontent.com/prusa3d/Arduino_Boards/devel/IDE_Board_Manager/prusa3dboards-1.0.5-2.tar.bz2', + 'Windows': 'https://raw.githubusercontent.com/prusa3d/Arduino_Boards/devel/IDE_Board_Manager/prusa3dboards-1.0.5-2.tar.bz2', + 'Darwin': 'https://raw.githubusercontent.com/prusa3d/Arduino_Boards/devel/IDE_Board_Manager/prusa3dboards-1.0.5-2.tar.bz2', } }, } From 9001d98061a1d2a4107184cc92dd7ab698425691 Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Wed, 27 Jul 2022 17:58:58 -0400 Subject: [PATCH 04/17] Get version/dir from bootstrap, add pyelftools --- CMakeLists.txt | 15 ++++++++------- cmake/LocalAvrGcc.cmake | 3 +-- utils/bootstrap.py | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index c139e6eba..a9a6b2f9e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -2,7 +2,8 @@ cmake_minimum_required(VERSION 3.15) include(cmake/Utilities.cmake) set (CMAKE_CXX_STANDARD 11) -set (PRUSA_BOARDS 1.0.5-2) + +get_dependency_directory(prusa3dboards PRUSA_BOARDS_DIR) project(Prusa-Firmware) get_recommended_gcc_version(RECOMMENDED_TOOLCHAIN_VERSION) @@ -76,7 +77,7 @@ endif() # file(GLOB FW_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmware/*.c*) file(GLOB FW_HEADERS RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmware/*.h*) -file(GLOB AVR_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/.dependencies/prusa3dboards-${PRUSA_BOARDS}/cores/prusa_einsy_rambo/*.c*) +file(GLOB AVR_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/*.c*) # Setup language resources: file(GLOB LANG_VARIANTS RELATIVE ${PROJECT_SOURCE_DIR}/lang/po ${PROJECT_SOURCE_DIR}/lang/po/Firmware_??.po) @@ -86,8 +87,8 @@ message("Languages found: ${LANG_VARIANTS}") add_library(avr_core STATIC ${AVR_SOURCES}) target_include_directories(avr_core PRIVATE - ${PROJECT_SOURCE_DIR}/.dependencies/prusa3dboards-${PRUSA_BOARDS}/cores/prusa_einsy_rambo/ - ${PROJECT_SOURCE_DIR}/.dependencies/prusa3dboards-${PRUSA_BOARDS}/variants/prusa_einsy_rambo/ + ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/ + ${PRUSA_BOARDS_DIR}/variants/prusa_einsy_rambo/ ) target_compile_options(avr_core PUBLIC -mmcu=atmega2560) @@ -99,7 +100,7 @@ function(fw_add_variant variant_name) # # configure linker script - set(LINKER_SCRIPT ${PROJECT_SOURCE_DIR}/.dependencies/prusa3dboards-${PRUSA_BOARDS}/ldscripts/avr6.xn) + set(LINKER_SCRIPT ${PRUSA_BOARDS_DIR}/ldscripts/avr6.xn) target_link_options(${variant_name} PUBLIC -Wl,-T,${LINKER_SCRIPT}) # limit the text section to 248K (256K - 8k reserved for the bootloader) @@ -126,8 +127,8 @@ function(fw_add_variant variant_name) target_include_directories(${variant_name} PRIVATE Firmware - ${PROJECT_SOURCE_DIR}/.dependencies/prusa3dboards-${PRUSA_BOARDS}/cores/prusa_einsy_rambo/ - ${PROJECT_SOURCE_DIR}/.dependencies/prusa3dboards-${PRUSA_BOARDS}/variants/prusa_einsy_rambo/ + ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/ + ${PRUSA_BOARDS_DIR}/variants/prusa_einsy_rambo/ ${PROJECT_SOURCE_DIR}/cmake/helpers/ # Add our magic config helper :) ) diff --git a/cmake/LocalAvrGcc.cmake b/cmake/LocalAvrGcc.cmake index e6c94e356..2e89cb492 100644 --- a/cmake/LocalAvrGcc.cmake +++ b/cmake/LocalAvrGcc.cmake @@ -3,8 +3,7 @@ include("${PROJECT_CMAKE_DIR}/Utilities.cmake") set(CMAKE_SYSTEM_NAME Generic) set(CMAKE_SYSTEM_PROCESSOR avr) set(CMAKE_CROSSCOMPILING 1) -set(AVR_GCC_VERSION 7.3.0) -set(AVR_TOOLCHAIN_DIR "${PROJECT_CMAKE_DIR}/../.dependencies/avr-gcc-${AVR_GCC_VERSION}/") +get_dependency_directory("avr-gcc" AVR_TOOLCHAIN_DIR) message( "tc dir is ${AVR_TOOLCHAIN_DIR}") # # Utilities diff --git a/utils/bootstrap.py b/utils/bootstrap.py index f606aa846..590de4ce8 100755 --- a/utils/bootstrap.py +++ b/utils/bootstrap.py @@ -61,7 +61,7 @@ dependencies = { } }, } -pip_dependencies = [] +pip_dependencies = ["pyelftools"] # yapf: enable From 5bc936d4f57473ccd6af3c083ab6d1364be6e5d6 Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Wed, 27 Jul 2022 19:40:11 -0400 Subject: [PATCH 05/17] Remove helper file, fix lang ordering, check sizes --- CMakeLists.txt | 52 +++++++++++++++++++-------- cmake/Check_final_lang_bin_size.cmake | 11 ++++++ cmake/Check_lang_size.cmake | 9 +++++ cmake/helpers/Configuration_prusa.h | 24 ------------- 4 files changed, 58 insertions(+), 38 deletions(-) create mode 100644 cmake/Check_final_lang_bin_size.cmake create mode 100644 cmake/Check_lang_size.cmake delete mode 100644 cmake/helpers/Configuration_prusa.h diff --git a/CMakeLists.txt b/CMakeLists.txt index a9a6b2f9e..30a618f9a 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -6,6 +6,13 @@ set (CMAKE_CXX_STANDARD 11) get_dependency_directory(prusa3dboards PRUSA_BOARDS_DIR) project(Prusa-Firmware) +FILE(STRINGS ${CMAKE_CURRENT_SOURCE_DIR}/Firmware/config.h MAX_SIZE_LINE REGEX "^#define \+LANG_SIZE_RESERVED \+") +STRING(REGEX MATCH "0x[0-9]+" MAX_SIZE_HEX "${MAX_SIZE_LINE}") +math(EXPR LANG_MAX_SIZE "${MAX_SIZE_HEX}" OUTPUT_FORMAT DECIMAL) +message("Language maximum size (from config.h): ${LANG_MAX_SIZE} bytes") + +set (LANG_BIN_MAX 249856) # Ditto, this in xflash_layout.h + get_recommended_gcc_version(RECOMMENDED_TOOLCHAIN_VERSION) if(CMAKE_CROSSCOMPILING AND NOT CMAKE_CXX_COMPILER_VERSION VERSION_EQUAL ${RECOMMENDED_TOOLCHAIN_VERSION} @@ -83,6 +90,7 @@ file(GLOB AVR_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PRUSA_BOARDS_DIR}/cores/p file(GLOB LANG_VARIANTS RELATIVE ${PROJECT_SOURCE_DIR}/lang/po ${PROJECT_SOURCE_DIR}/lang/po/Firmware_??.po) string(REPLACE "Firmware_" "" LANG_VARIANTS "${LANG_VARIANTS}") string(REPLACE ".po" "" LANG_VARIANTS "${LANG_VARIANTS}") +list(SORT LANG_VARIANTS) message("Languages found: ${LANG_VARIANTS}") add_library(avr_core STATIC ${AVR_SOURCES}) @@ -94,10 +102,24 @@ target_compile_options(avr_core PUBLIC -mmcu=atmega2560) function(fw_add_variant variant_name) - add_executable(${variant_name} ${FW_SOURCES} ${FW_HEADERS}) + # Create the Configuration_Prusa.h for this variant so it can be #included. + set(VARIANT_CFG_DIR "${CMAKE_CURRENT_BINARY_DIR}/${variant_name}_include") + set(VARIANT_CFG_FILE "${VARIANT_CFG_DIR}/Configuration_prusa.h") + add_custom_command(OUTPUT ${VARIANT_CFG_FILE} + COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_SOURCE_DIR}/Firmware/variants/${variant_name}.h ${VARIANT_CFG_FILE} + COMMENT "Generating Configuration_prusa.h for ${variant_name}" + BYPRODUCTS ${VARIANT_CFG_DIR} + ) + + add_executable(${variant_name} ${FW_SOURCES} ${FW_HEADERS} ${VARIANT_CFG_FILE}) set_target_properties(${variant_name} PROPERTIES CXX_STANDARD 14) + target_include_directories(${variant_name} PRIVATE Firmware + ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/ + ${PRUSA_BOARDS_DIR}/variants/prusa_einsy_rambo/ + ${VARIANT_CFG_DIR} # Include the header for this variant. + ) # # configure linker script set(LINKER_SCRIPT ${PRUSA_BOARDS_DIR}/ldscripts/avr6.xn) @@ -125,23 +147,16 @@ function(fw_add_variant variant_name) # generate linker map file target_link_options(${variant_name} PUBLIC -Wl,-Map=${variant_name}.map) - - target_include_directories(${variant_name} PRIVATE Firmware - ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/ - ${PRUSA_BOARDS_DIR}/variants/prusa_einsy_rambo/ - ${PROJECT_SOURCE_DIR}/cmake/helpers/ # Add our magic config helper :) - ) - target_compile_options(${variant_name} PRIVATE) # turn this on for lolz -Wdouble-promotion) - string(REPLACE "-" "_" DEFINE_NAME "${variant_name}") - target_compile_definitions(${variant_name} PRIVATE H${DEFINE_NAME} ARDUINO=10600 __AVR_ATmega2560__) + target_compile_definitions(${variant_name} PRIVATE ARDUINO=10600 __AVR_ATmega2560__) target_link_libraries(${variant_name} avr_core) #Construct language map - set(LANG_MAP ${CMAKE_CURRENT_BINARY_DIR}/lang/${variant_name}_lang.map) + set(LANG_TMP_DIR ${CMAKE_CURRENT_BINARY_DIR}/lang) + set(LANG_MAP ${LANG_TMP_DIR}/${variant_name}_lang.map) set(LANG_FWBIN ${CMAKE_BINARY_DIR}/${variant_name}.bin) - set(LANG_FINAL_BIN ${CMAKE_CURRENT_BINARY_DIR}/lang/${variant_name}_lang.bin) - set(LANG_FINAL_HEX ${CMAKE_CURRENT_BINARY_DIR}/lang/${variant_name}_lang.hex) + set(LANG_FINAL_BIN ${LANG_TMP_DIR}/${variant_name}_lang.bin) + set(LANG_FINAL_HEX ${LANG_TMP_DIR}/${variant_name}_lang.hex) add_custom_command(OUTPUT ${LANG_FWBIN} COMMAND "${CMAKE_OBJCOPY}" -I ihex -O binary ${CMAKE_BINARY_DIR}/${variant_name}.hex ${LANG_FWBIN} @@ -153,22 +168,31 @@ function(fw_add_variant variant_name) ) set(LANG_BINS "") + foreach (LANG IN LISTS LANG_VARIANTS) - set(LANG_BIN ${CMAKE_CURRENT_BINARY_DIR}/lang/${variant_name}_${LANG}.bin) + set(LANG_BIN ${LANG_TMP_DIR}/${variant_name}_${LANG}.bin) set(PO_FILE "${CMAKE_CURRENT_SOURCE_DIR}/lang/po/Firmware_${LANG}.po") add_custom_command(OUTPUT ${LANG_BIN} # COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-check.py --no-warning --map "${LANG_MAP}" "${PO_FILE}" # COMMAND ${CMAKE_COMMAND} -E echo "Building lang_${LANG}.bin" COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-build.py ${LANG_MAP} ${PO_FILE} ${LANG_BIN} + # Check bin size: + COMMAND ${CMAKE_COMMAND} -DLANG_MAX_SIZE=${LANG_MAX_SIZE} + -DLANG_FILE=${LANG_BIN} + -P ${PROJECT_CMAKE_DIR}/Check_lang_size.cmake DEPENDS ${LANG_MAP} COMMENT "Generating ${variant_name}_${LANG}.bin from .po" ) LIST(APPEND LANG_BINS ${LANG_BIN}) + endforeach() add_custom_command( OUTPUT ${LANG_FINAL_BIN} # TODO - needs differentiation for platforms, e.g. copy /b on Win COMMAND cat ${LANG_BINS} > ${LANG_FINAL_BIN} + COMMAND ${CMAKE_COMMAND} -DLANG_MAX_SIZE=${LANG_BIN_MAX} + -DLANG_FILE=${LANG_FINAL_BIN} + -P ${PROJECT_CMAKE_DIR}/Check_final_lang_bin_size.cmake DEPENDS ${LANG_BINS} COMMENT "Merging language binaries" ) diff --git a/cmake/Check_final_lang_bin_size.cmake b/cmake/Check_final_lang_bin_size.cmake new file mode 100644 index 000000000..18079ea22 --- /dev/null +++ b/cmake/Check_final_lang_bin_size.cmake @@ -0,0 +1,11 @@ +cmake_minimum_required(VERSION 3.18) +FILE(SIZE ${LANG_FILE} FILE_SIZE) +get_filename_component(FILE_BASE ${LANG_FILE} NAME) +MATH(EXPR PADDED_SIZE "((${FILE_SIZE}+4096-1) / 4096 * 4096 )") +message(STATUS "${FILE_BASE} raw size ${FILE_SIZE} bytes (${PADDED_SIZE} b padded)") +if(${PADDED_SIZE} GREATER ${LANG_MAX_SIZE}) + message(FATAL_ERROR "Language file ${FILE_BASE} (${PADDED_SIZE}b) exceeds maximum allowed size of ${LANG_MAX_SIZE} bytes - Aborting!") +else() + MATH(EXPR SIZE_PCT "( ${PADDED_SIZE} * 100) / ${LANG_MAX_SIZE} " ) + message(STATUS "Language file ${FILE_BASE} is ${PADDED_SIZE} bytes, ${SIZE_PCT}% of allowed space - OK") +endif() diff --git a/cmake/Check_lang_size.cmake b/cmake/Check_lang_size.cmake new file mode 100644 index 000000000..58efab7bf --- /dev/null +++ b/cmake/Check_lang_size.cmake @@ -0,0 +1,9 @@ +cmake_minimum_required(VERSION 3.18) +FILE(SIZE ${LANG_FILE} FILE_SIZE) +get_filename_component(FILE_BASE ${LANG_FILE} NAME) +if(${FILE_SIZE} GREATER ${LANG_MAX_SIZE}) + message(FATAL_ERROR "Language file ${FILE_BASE} (${FILE_SIZE}b) exceeds maximum allowed size of ${LANG_MAX_SIZE} bytes - Aborting!") +else() + MATH(EXPR SIZE_PCT "( ${FILE_SIZE} * 100) / ${LANG_MAX_SIZE} " ) + message(STATUS "Language file ${FILE_BASE} is ${FILE_SIZE} bytes, ${SIZE_PCT}% of allowed space - OK") +endif() diff --git a/cmake/helpers/Configuration_prusa.h b/cmake/helpers/Configuration_prusa.h deleted file mode 100644 index a308af746..000000000 --- a/cmake/helpers/Configuration_prusa.h +++ /dev/null @@ -1,24 +0,0 @@ -#ifdef H1_75mm_MK25_RAMBo10a_E3Dv6full -#include "variants/1_75mm_MK25-RAMBo10a-E3Dv6full.h" -#endif -#ifdef H1_75mm_MK25_RAMBo13a_E3Dv6full -#include "variants/1_75mm_MK25-RAMBo13a-E3Dv6full.h" -#endif -#ifdef H1_75mm_MK25S_RAMBo10a_E3Dv6full -#include "variants/1_75mm_MK25S-RAMBo10a-E3Dv6full.h" -#endif -#ifdef H1_75mm_MK25S_RAMBo13a_E3Dv6full -#include "variants/1_75mm_MK25S-RAMBo13a-E3Dv6full.h" -#endif -#ifdef H1_75mm_MK2_RAMBo10a_E3Dv6full -#include "variants/1_75mm_MK2-RAMBo10a-E3Dv6full.h" -#endif -#ifdef H1_75mm_MK2_RAMBo13a_E3Dv6full -#include "variants/1_75mm_MK2-RAMBo13a-E3Dv6full.h" -#endif -#ifdef H1_75mm_MK3_EINSy10a_E3Dv6full -#include "variants/1_75mm_MK3-EINSy10a-E3Dv6full.h" -#endif -#ifdef H1_75mm_MK3S_EINSy10a_E3Dv6full -#include "variants/1_75mm_MK3S-EINSy10a-E3Dv6full.h" -#endif \ No newline at end of file From 8a4b395aec129681c27736a60802e368cb57ae42 Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Wed, 27 Jul 2022 20:24:12 -0400 Subject: [PATCH 06/17] no-xflash case, add convenience target to build absolutely everything. --- CMakeLists.txt | 85 ++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 61 insertions(+), 24 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 30a618f9a..cd988cfe9 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -100,6 +100,9 @@ target_include_directories(avr_core PRIVATE ) target_compile_options(avr_core PUBLIC -mmcu=atmega2560) +# Meta target to build absolutely everything +add_custom_target(ALL_FIRMWARE) + function(fw_add_variant variant_name) # Create the Configuration_Prusa.h for this variant so it can be #included. @@ -110,6 +113,8 @@ function(fw_add_variant variant_name) COMMENT "Generating Configuration_prusa.h for ${variant_name}" BYPRODUCTS ${VARIANT_CFG_DIR} ) + STRING(REPLACE "1_75mm_" "" variant_name "${variant_name}") + STRING(REPLACE "-E3Dv6full" "" variant_name "${variant_name}") add_executable(${variant_name} ${FW_SOURCES} ${FW_HEADERS} ${VARIANT_CFG_FILE}) @@ -187,43 +192,75 @@ function(fw_add_variant variant_name) LIST(APPEND LANG_BINS ${LANG_BIN}) endforeach() - add_custom_command( OUTPUT ${LANG_FINAL_BIN} + string(FIND ${variant_name} "MK3" HAS_XFLASH) + if (HAS_XFLASH GREATER 0) + add_custom_command( OUTPUT ${LANG_FINAL_BIN} + # TODO - needs differentiation for platforms, e.g. copy /b on Win + COMMAND cat ${LANG_BINS} > ${LANG_FINAL_BIN} + COMMAND ${CMAKE_COMMAND} -DLANG_MAX_SIZE=${LANG_BIN_MAX} + -DLANG_FILE=${LANG_FINAL_BIN} + -P ${PROJECT_CMAKE_DIR}/Check_final_lang_bin_size.cmake + DEPENDS ${LANG_BINS} + COMMENT "Merging language binaries" + ) + add_custom_command( OUTPUT ${LANG_FINAL_HEX} # TODO - needs differentiation for platforms, e.g. copy /b on Win - COMMAND cat ${LANG_BINS} > ${LANG_FINAL_BIN} - COMMAND ${CMAKE_COMMAND} -DLANG_MAX_SIZE=${LANG_BIN_MAX} - -DLANG_FILE=${LANG_FINAL_BIN} - -P ${PROJECT_CMAKE_DIR}/Check_final_lang_bin_size.cmake - DEPENDS ${LANG_BINS} - COMMENT "Merging language binaries" - ) - add_custom_command( OUTPUT ${LANG_FINAL_HEX} - # TODO - needs differentiation for platforms, e.g. copy /b on Win - COMMAND ${CMAKE_OBJCOPY} -I binary -O ihex ${LANG_FINAL_BIN} ${LANG_FINAL_HEX} - DEPENDS ${LANG_FINAL_BIN} - COMMENT "Generating Hex for language data" - ) - set(LANG_HEX ${CMAKE_BINARY_DIR}/${variant_name}-lang.hex) - add_custom_target(${variant_name}-languages - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/${variant_name}.hex ${LANG_HEX} - COMMAND cat ${LANG_FINAL_HEX} >> ${LANG_HEX} - COMMENT "Generating final ${variant_name}-lang.hex" - BYPRODUCTS ${LANG_HEX} - DEPENDS ${LANG_FINAL_HEX} - ) + COMMAND ${CMAKE_OBJCOPY} -I binary -O ihex ${LANG_FINAL_BIN} ${LANG_FINAL_HEX} + DEPENDS ${LANG_FINAL_BIN} + COMMENT "Generating Hex for language data" + ) + set(LANG_HEX ${CMAKE_BINARY_DIR}/${variant_name}-lang.hex) + add_custom_target(${variant_name}-languages + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/${variant_name}.hex ${LANG_HEX} + COMMAND cat ${LANG_FINAL_HEX} >> ${LANG_HEX} + COMMENT "Generating final ${variant_name}-lang.hex" + BYPRODUCTS ${LANG_HEX} + DEPENDS ${LANG_FINAL_HEX} + ) + add_dependencies(ALL_FIRMWARE ${variant_name}-languages) + else() + set (ALL_VARIANT_HEXES "") + # Non-xflash, e.g. MK2.5 + foreach(LANG IN LISTS LANG_VARIANTS) + SET(LANG_HEX_FN ${variant_name}-en_${LANG}) + SET(LANG_HEX ${CMAKE_BINARY_DIR}/${LANG_HEX_FN}.hex) + SET(LANG_BIN ${LANG_TMP_DIR}/${variant_name}_${LANG}.bin) + SET(LANG_FWBIN_TMP ${LANG_TMP_DIR}/${variant_name}-en_${LANG}.bin) + #Intermediate 2-lang bin + add_custom_command(OUTPUT ${LANG_FWBIN_TMP} + COMMAND ${CMAKE_COMMAND} -E copy ${LANG_FWBIN} ${LANG_FWBIN_TMP} + COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-patchsec.py ${CMAKE_BINARY_DIR}/${variant_name} ${LANG_BIN} ${LANG_FWBIN_TMP} + DEPENDS ${LANG_FWBIN} ${LANG_BIN} + COMMENT "Generating ${variant_name}-en_${LANG}.bin" + ) + + #Final hex: + add_custom_target(${LANG_HEX_FN} + COMMAND ${CMAKE_OBJCOPY} -I binary -O ihex ${LANG_FWBIN_TMP} ${LANG_HEX} + BYPRODUCTS ${LANG_HEX} + DEPENDS ${LANG_FWBIN_TMP} + COMMENT "Creating ${LANG_HEX_FN}.hex" + ) + LIST(APPEND ALL_VARIANT_HEXES ${LANG_HEX}) + endforeach() + add_custom_target("${variant_name}-All-Languages" + DEPENDS ${ALL_VARIANT_HEXES} + ) + add_dependencies(ALL_FIRMWARE "${variant_name}-All-Languages") + endif() endfunction() if(CMAKE_CROSSCOMPILING) - add_custom_target(All_Firmware) + file(GLOB FW_VARIANTS RELATIVE ${PROJECT_SOURCE_DIR}/Firmware/variants ${PROJECT_SOURCE_DIR}/Firmware/variants/*.h) foreach(THIS_VAR IN LISTS FW_VARIANTS) string(REPLACE ".h" "" TRIMMED_NAME "${THIS_VAR}") message("Variant added: ${TRIMMED_NAME}") fw_add_variant(${TRIMMED_NAME}) - add_dependencies(All_Firmware ${TRIMMED_NAME}) endforeach(THIS_VAR IN LISTS FW_VARIANTS) From f453403ea91a806358891d952dde4440518c758c Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Wed, 27 Jul 2022 22:25:40 -0400 Subject: [PATCH 07/17] bugfix --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index cd988cfe9..02f33936e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -193,7 +193,7 @@ function(fw_add_variant variant_name) endforeach() string(FIND ${variant_name} "MK3" HAS_XFLASH) - if (HAS_XFLASH GREATER 0) + if (${HAS_XFLASH} GREATER_EQUAL 0) add_custom_command( OUTPUT ${LANG_FINAL_BIN} # TODO - needs differentiation for platforms, e.g. copy /b on Win COMMAND cat ${LANG_BINS} > ${LANG_FINAL_BIN} From fa1be17b7c748801f2f7af23f471531e16119b93 Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Thu, 28 Jul 2022 08:07:08 -0400 Subject: [PATCH 08/17] cmake lang control --- CMakeLists.txt | 42 +++++++++++++++++++++++++++++++++++------- Firmware/config.h | 4 ++++ 2 files changed, 39 insertions(+), 7 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 02f33936e..a526c08f3 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -3,6 +3,8 @@ include(cmake/Utilities.cmake) set (CMAKE_CXX_STANDARD 11) +OPTION(SECONDARY_LANGUAGES "Secondary language support in the firmware" ON) + get_dependency_directory(prusa3dboards PRUSA_BOARDS_DIR) project(Prusa-Firmware) @@ -153,8 +155,19 @@ function(fw_add_variant variant_name) target_link_options(${variant_name} PUBLIC -Wl,-Map=${variant_name}.map) target_compile_options(${variant_name} PRIVATE) # turn this on for lolz -Wdouble-promotion) - target_compile_definitions(${variant_name} PRIVATE ARDUINO=10600 __AVR_ATmega2560__) + target_compile_definitions(${variant_name} PRIVATE + ARDUINO=10600 + __AVR_ATmega2560__ + CMAKE_LANG_CONTROL + ) target_link_libraries(${variant_name} avr_core) + if (SECONDARY_LANGUAGES) + target_compile_definitions(${variant_name} PUBLIC LANG_MODE=1) + else() + target_compile_definitions(${variant_name} PUBLIC LANG_MODE=0) + add_dependencies(ALL_FIRMWARE "${variant_name}") + return() #Done, if no languages there's nothing else to do. + endif() #Construct language map set(LANG_TMP_DIR ${CMAKE_CURRENT_BINARY_DIR}/lang) @@ -194,25 +207,40 @@ function(fw_add_variant variant_name) endforeach() string(FIND ${variant_name} "MK3" HAS_XFLASH) if (${HAS_XFLASH} GREATER_EQUAL 0) + if (WIN32) + STRING(REPLACE ";" " + " LANG_CMD_TMP "${LANG_BINS}") + add_custom_command( OUTPUT ${LANG_FINAL_BIN} + COMMAND copy /b ${LANG_CMD_TMP} ${LANG_FINAL_BIN} + DEPENDS ${LANG_BINS} + COMMENT "Merging language binaries (W32)" + ) + else() + add_custom_command( OUTPUT ${LANG_FINAL_BIN} + COMMAND cat ${LANG_BINS} > ${LANG_FINAL_BIN} + DEPENDS ${LANG_BINS} + COMMENT "Merging language binaries (Non-W32)" + ) + endif() add_custom_command( OUTPUT ${LANG_FINAL_BIN} - # TODO - needs differentiation for platforms, e.g. copy /b on Win - COMMAND cat ${LANG_BINS} > ${LANG_FINAL_BIN} COMMAND ${CMAKE_COMMAND} -DLANG_MAX_SIZE=${LANG_BIN_MAX} -DLANG_FILE=${LANG_FINAL_BIN} -P ${PROJECT_CMAKE_DIR}/Check_final_lang_bin_size.cmake - DEPENDS ${LANG_BINS} - COMMENT "Merging language binaries" + APPEND ) add_custom_command( OUTPUT ${LANG_FINAL_HEX} - # TODO - needs differentiation for platforms, e.g. copy /b on Win COMMAND ${CMAKE_OBJCOPY} -I binary -O ihex ${LANG_FINAL_BIN} ${LANG_FINAL_HEX} DEPENDS ${LANG_FINAL_BIN} COMMENT "Generating Hex for language data" ) set(LANG_HEX ${CMAKE_BINARY_DIR}/${variant_name}-lang.hex) + if (WIN32) + SET(TEXT_MERGE_CMD "type") + else() + SET(TEXT_MERGE_CMD "cat") + endif() add_custom_target(${variant_name}-languages COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/${variant_name}.hex ${LANG_HEX} - COMMAND cat ${LANG_FINAL_HEX} >> ${LANG_HEX} + COMMAND ${TEXT_MERGE_CMD} ${LANG_FINAL_HEX} >> ${LANG_HEX} COMMENT "Generating final ${variant_name}-lang.hex" BYPRODUCTS ${LANG_HEX} DEPENDS ${LANG_FINAL_HEX} diff --git a/Firmware/config.h b/Firmware/config.h index acd6cb81f..2efd71ea2 100644 --- a/Firmware/config.h +++ b/Firmware/config.h @@ -54,9 +54,13 @@ #define TMC2130_SPCR SPI_SPCR(TMC2130_SPI_RATE, 1, 1, 1, 0) #define TMC2130_SPSR SPI_SPSR(TMC2130_SPI_RATE) +// This is set by the cmake build to be able to take control of +// the language flag, without breaking existing build mechanisms. +#ifndef CMAKE_LANG_CONTROL //LANG - Multi-language support //#define LANG_MODE 0 // primary language only #define LANG_MODE 1 // sec. language support +#endif #define LANG_SIZE_RESERVED 0x3000 // reserved space for secondary language (12288 bytes). Maximum 32768 bytes From 25ee23ca766f881d4105f321a399f28ad343e648 Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Thu, 28 Jul 2022 08:11:11 -0400 Subject: [PATCH 09/17] clean indentation --- CMakeLists.txt | 427 ++++++++++++++++++++++++------------------------- 1 file changed, 212 insertions(+), 215 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index a526c08f3..b3663d3ff 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -17,23 +17,23 @@ set (LANG_BIN_MAX 249856) # Ditto, this in xflash_layout.h get_recommended_gcc_version(RECOMMENDED_TOOLCHAIN_VERSION) if(CMAKE_CROSSCOMPILING AND NOT CMAKE_CXX_COMPILER_VERSION VERSION_EQUAL - ${RECOMMENDED_TOOLCHAIN_VERSION} - ) - message(WARNING "Recommended AVR toolchain is ${RECOMMENDED_TOOLCHAIN_VERSION}" - ", but you have ${CMAKE_CXX_COMPILER_VERSION}" - ) + ${RECOMMENDED_TOOLCHAIN_VERSION} + ) + message(WARNING "Recommended AVR toolchain is ${RECOMMENDED_TOOLCHAIN_VERSION}" + ", but you have ${CMAKE_CXX_COMPILER_VERSION}" + ) elseif(NOT CMAKE_CROSSCOMPILING AND NOT CMAKE_CXX_COMPILER_ID STREQUAL "GNU") - message( - WARNING - "Recommended compiler for host tools and unittests is GCC, you have ${CMAKE_CXX_COMPILER_ID}." - ) + message( + WARNING + "Recommended compiler for host tools and unittests is GCC, you have ${CMAKE_CXX_COMPILER_ID}." + ) endif() # append custom C/C++ flags if(CUSTOM_COMPILE_OPTIONS) - string(REPLACE " " ";" CUSTOM_COMPILE_OPTIONS "${CUSTOM_COMPILE_OPTIONS}") - add_compile_options(${CUSTOM_COMPILE_OPTIONS}) + string(REPLACE " " ";" CUSTOM_COMPILE_OPTIONS "${CUSTOM_COMPILE_OPTIONS}") + add_compile_options(${CUSTOM_COMPILE_OPTIONS}) endif() # @@ -45,31 +45,31 @@ add_compile_options(-g) # optimizations if(CMAKE_CROSSCOMPILING) - if(CMAKE_BUILD_TYPE STREQUAL "Debug") - add_compile_options(-Og) - else() - add_compile_options(-Os) - endif() + if(CMAKE_BUILD_TYPE STREQUAL "Debug") + add_compile_options(-Og) + else() + add_compile_options(-Os) + endif() - # mcu related settings - set(MCU_FLAGS -mmcu=atmega2560 -DF_CPU=16000000L) - add_compile_options(${MCU_FLAGS}) - add_link_options(${MCU_FLAGS}) + # mcu related settings + set(MCU_FLAGS -mmcu=atmega2560 -DF_CPU=16000000L) + add_compile_options(${MCU_FLAGS}) + add_link_options(${MCU_FLAGS}) - # split and gc sections - add_compile_options(-ffunction-sections -fdata-sections) - add_link_options(-Wl,--gc-sections) + # split and gc sections + add_compile_options(-ffunction-sections -fdata-sections) + add_link_options(-Wl,--gc-sections) - # disable exceptions and related metadata - add_compile_options(-fno-exceptions -fno-unwind-tables) - add_compile_options($<$:-fno-rtti>) - add_link_options(-Wl,--defsym,__exidx_start=0,--defsym,__exidx_end=0) + # disable exceptions and related metadata + add_compile_options(-fno-exceptions -fno-unwind-tables) + add_compile_options($<$:-fno-rtti>) + add_link_options(-Wl,--defsym,__exidx_start=0,--defsym,__exidx_end=0) else() - if(CMAKE_BUILD_TYPE STREQUAL "Debug") - add_compile_options(-O0) - else() - add_compile_options(-O2) - endif() + if(CMAKE_BUILD_TYPE STREQUAL "Debug") + add_compile_options(-O0) + else() + add_compile_options(-O2) + endif() endif() # enable all warnings (well, not all, but some) @@ -78,7 +78,7 @@ add_compile_options($<$:-std=c++14>) # support _DEBUG macro (some code uses to recognize debug builds) if(CMAKE_BUILD_TYPE STREQUAL "Debug") - add_compile_definitions(_DEBUG) + add_compile_definitions(_DEBUG) endif() # @@ -88,7 +88,7 @@ file(GLOB FW_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmwa file(GLOB FW_HEADERS RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmware/*.h*) file(GLOB AVR_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/*.c*) - # Setup language resources: + # Setup language resources: file(GLOB LANG_VARIANTS RELATIVE ${PROJECT_SOURCE_DIR}/lang/po ${PROJECT_SOURCE_DIR}/lang/po/Firmware_??.po) string(REPLACE "Firmware_" "" LANG_VARIANTS "${LANG_VARIANTS}") string(REPLACE ".po" "" LANG_VARIANTS "${LANG_VARIANTS}") @@ -97,8 +97,8 @@ message("Languages found: ${LANG_VARIANTS}") add_library(avr_core STATIC ${AVR_SOURCES}) target_include_directories(avr_core PRIVATE - ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/ - ${PRUSA_BOARDS_DIR}/variants/prusa_einsy_rambo/ + ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/ + ${PRUSA_BOARDS_DIR}/variants/prusa_einsy_rambo/ ) target_compile_options(avr_core PUBLIC -mmcu=atmega2560) @@ -107,214 +107,211 @@ add_custom_target(ALL_FIRMWARE) function(fw_add_variant variant_name) - # Create the Configuration_Prusa.h for this variant so it can be #included. - set(VARIANT_CFG_DIR "${CMAKE_CURRENT_BINARY_DIR}/${variant_name}_include") - set(VARIANT_CFG_FILE "${VARIANT_CFG_DIR}/Configuration_prusa.h") - add_custom_command(OUTPUT ${VARIANT_CFG_FILE} - COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_SOURCE_DIR}/Firmware/variants/${variant_name}.h ${VARIANT_CFG_FILE} - COMMENT "Generating Configuration_prusa.h for ${variant_name}" - BYPRODUCTS ${VARIANT_CFG_DIR} - ) - STRING(REPLACE "1_75mm_" "" variant_name "${variant_name}") - STRING(REPLACE "-E3Dv6full" "" variant_name "${variant_name}") + # Create the Configuration_Prusa.h for this variant so it can be #included. + set(VARIANT_CFG_DIR "${CMAKE_CURRENT_BINARY_DIR}/${variant_name}_include") + set(VARIANT_CFG_FILE "${VARIANT_CFG_DIR}/Configuration_prusa.h") + add_custom_command(OUTPUT ${VARIANT_CFG_FILE} + COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_SOURCE_DIR}/Firmware/variants/${variant_name}.h ${VARIANT_CFG_FILE} + COMMENT "Generating Configuration_prusa.h for ${variant_name}" + BYPRODUCTS ${VARIANT_CFG_DIR} + ) + STRING(REPLACE "1_75mm_" "" variant_name "${variant_name}") + STRING(REPLACE "-E3Dv6full" "" variant_name "${variant_name}") - add_executable(${variant_name} ${FW_SOURCES} ${FW_HEADERS} ${VARIANT_CFG_FILE}) + add_executable(${variant_name} ${FW_SOURCES} ${FW_HEADERS} ${VARIANT_CFG_FILE}) - set_target_properties(${variant_name} PROPERTIES CXX_STANDARD 14) + set_target_properties(${variant_name} PROPERTIES CXX_STANDARD 14) - target_include_directories(${variant_name} PRIVATE Firmware - ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/ - ${PRUSA_BOARDS_DIR}/variants/prusa_einsy_rambo/ - ${VARIANT_CFG_DIR} # Include the header for this variant. - ) + target_include_directories(${variant_name} PRIVATE Firmware + ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/ + ${PRUSA_BOARDS_DIR}/variants/prusa_einsy_rambo/ + ${VARIANT_CFG_DIR} # Include the header for this variant. + ) # # configure linker script - set(LINKER_SCRIPT ${PRUSA_BOARDS_DIR}/ldscripts/avr6.xn) - target_link_options(${variant_name} PUBLIC -Wl,-T,${LINKER_SCRIPT}) + set(LINKER_SCRIPT ${PRUSA_BOARDS_DIR}/ldscripts/avr6.xn) + target_link_options(${variant_name} PUBLIC -Wl,-T,${LINKER_SCRIPT}) - # limit the text section to 248K (256K - 8k reserved for the bootloader) - target_link_options(${variant_name} PUBLIC -Wl,--defsym=__TEXT_REGION_LENGTH__=248K) + # limit the text section to 248K (256K - 8k reserved for the bootloader) + target_link_options(${variant_name} PUBLIC -Wl,--defsym=__TEXT_REGION_LENGTH__=248K) - # generate firmware.bin file - objcopy(${variant_name} "ihex" ".hex") + # generate firmware.bin file + objcopy(${variant_name} "ihex" ".hex") - # produce ASM listing. Note we also specify the .map as a byproduct so it gets cleaned - # because link_options doesn't have a "generated outputs" feature. - add_custom_command( - TARGET ${variant_name} POST_BUILD COMMAND ${CMAKE_OBJDUMP} -CSd ${variant_name} > ${variant_name}.asm - BYPRODUCTS ${variant_name}.asm ${variant_name}.map - ) + # produce ASM listing. Note we also specify the .map as a byproduct so it gets cleaned + # because link_options doesn't have a "generated outputs" feature. + add_custom_command( + TARGET ${variant_name} POST_BUILD COMMAND ${CMAKE_OBJDUMP} -CSd ${variant_name} > ${variant_name}.asm + BYPRODUCTS ${variant_name}.asm ${variant_name}.map + ) - # inform about the firmware's size in terminal - add_custom_command( - TARGET ${variant_name} POST_BUILD COMMAND ${CMAKE_SIZE_UTIL} -C --mcu=atmega2560 ${variant_name} - ) - report_size(${variant_name}) + # inform about the firmware's size in terminal + add_custom_command( + TARGET ${variant_name} POST_BUILD COMMAND ${CMAKE_SIZE_UTIL} -C --mcu=atmega2560 ${variant_name} + ) + report_size(${variant_name}) - # generate linker map file - target_link_options(${variant_name} PUBLIC -Wl,-Map=${variant_name}.map) + # generate linker map file + target_link_options(${variant_name} PUBLIC -Wl,-Map=${variant_name}.map) - target_compile_options(${variant_name} PRIVATE) # turn this on for lolz -Wdouble-promotion) - target_compile_definitions(${variant_name} PRIVATE - ARDUINO=10600 - __AVR_ATmega2560__ - CMAKE_LANG_CONTROL - ) - target_link_libraries(${variant_name} avr_core) - if (SECONDARY_LANGUAGES) - target_compile_definitions(${variant_name} PUBLIC LANG_MODE=1) - else() - target_compile_definitions(${variant_name} PUBLIC LANG_MODE=0) - add_dependencies(ALL_FIRMWARE "${variant_name}") - return() #Done, if no languages there's nothing else to do. - endif() + target_compile_options(${variant_name} PRIVATE) # turn this on for lolz -Wdouble-promotion) + target_compile_definitions(${variant_name} PRIVATE + ARDUINO=10600 + __AVR_ATmega2560__ + CMAKE_LANG_CONTROL + ) + target_link_libraries(${variant_name} avr_core) + if (SECONDARY_LANGUAGES) + target_compile_definitions(${variant_name} PUBLIC LANG_MODE=1) + else() + target_compile_definitions(${variant_name} PUBLIC LANG_MODE=0) + add_dependencies(ALL_FIRMWARE "${variant_name}") + return() #Done, if no languages there's nothing else to do. + endif() - #Construct language map - set(LANG_TMP_DIR ${CMAKE_CURRENT_BINARY_DIR}/lang) - set(LANG_MAP ${LANG_TMP_DIR}/${variant_name}_lang.map) - set(LANG_FWBIN ${CMAKE_BINARY_DIR}/${variant_name}.bin) - set(LANG_FINAL_BIN ${LANG_TMP_DIR}/${variant_name}_lang.bin) - set(LANG_FINAL_HEX ${LANG_TMP_DIR}/${variant_name}_lang.hex) + #Construct language map + set(LANG_TMP_DIR ${CMAKE_CURRENT_BINARY_DIR}/lang) + set(LANG_MAP ${LANG_TMP_DIR}/${variant_name}_lang.map) + set(LANG_FWBIN ${CMAKE_BINARY_DIR}/${variant_name}.bin) + set(LANG_FINAL_BIN ${LANG_TMP_DIR}/${variant_name}_lang.bin) + set(LANG_FINAL_HEX ${LANG_TMP_DIR}/${variant_name}_lang.hex) - add_custom_command(OUTPUT ${LANG_FWBIN} - COMMAND "${CMAKE_OBJCOPY}" -I ihex -O binary ${CMAKE_BINARY_DIR}/${variant_name}.hex ${LANG_FWBIN} - DEPENDS ${variant_name} - ) - add_custom_command(OUTPUT ${LANG_MAP} - COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-map.py "${CMAKE_BINARY_DIR}/${variant_name}" "${LANG_FWBIN}" > "${LANG_MAP}" - DEPENDS ${LANG_FWBIN} - ) + add_custom_command(OUTPUT ${LANG_FWBIN} + COMMAND "${CMAKE_OBJCOPY}" -I ihex -O binary ${CMAKE_BINARY_DIR}/${variant_name}.hex ${LANG_FWBIN} + DEPENDS ${variant_name} + ) + add_custom_command(OUTPUT ${LANG_MAP} + COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-map.py "${CMAKE_BINARY_DIR}/${variant_name}" "${LANG_FWBIN}" > "${LANG_MAP}" + DEPENDS ${LANG_FWBIN} + ) - set(LANG_BINS "") + set(LANG_BINS "") - foreach (LANG IN LISTS LANG_VARIANTS) - set(LANG_BIN ${LANG_TMP_DIR}/${variant_name}_${LANG}.bin) + foreach (LANG IN LISTS LANG_VARIANTS) + set(LANG_BIN ${LANG_TMP_DIR}/${variant_name}_${LANG}.bin) - set(PO_FILE "${CMAKE_CURRENT_SOURCE_DIR}/lang/po/Firmware_${LANG}.po") - add_custom_command(OUTPUT ${LANG_BIN} - # COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-check.py --no-warning --map "${LANG_MAP}" "${PO_FILE}" - # COMMAND ${CMAKE_COMMAND} -E echo "Building lang_${LANG}.bin" - COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-build.py ${LANG_MAP} ${PO_FILE} ${LANG_BIN} - # Check bin size: - COMMAND ${CMAKE_COMMAND} -DLANG_MAX_SIZE=${LANG_MAX_SIZE} - -DLANG_FILE=${LANG_BIN} - -P ${PROJECT_CMAKE_DIR}/Check_lang_size.cmake - DEPENDS ${LANG_MAP} - COMMENT "Generating ${variant_name}_${LANG}.bin from .po" - ) - LIST(APPEND LANG_BINS ${LANG_BIN}) + set(PO_FILE "${CMAKE_CURRENT_SOURCE_DIR}/lang/po/Firmware_${LANG}.po") + add_custom_command(OUTPUT ${LANG_BIN} + # COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-check.py --no-warning --map "${LANG_MAP}" "${PO_FILE}" + # COMMAND ${CMAKE_COMMAND} -E echo "Building lang_${LANG}.bin" + COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-build.py ${LANG_MAP} ${PO_FILE} ${LANG_BIN} + # Check bin size: + COMMAND ${CMAKE_COMMAND} -DLANG_MAX_SIZE=${LANG_MAX_SIZE} + -DLANG_FILE=${LANG_BIN} + -P ${PROJECT_CMAKE_DIR}/Check_lang_size.cmake + DEPENDS ${LANG_MAP} + COMMENT "Generating ${variant_name}_${LANG}.bin from .po" + ) + LIST(APPEND LANG_BINS ${LANG_BIN}) - endforeach() - string(FIND ${variant_name} "MK3" HAS_XFLASH) - if (${HAS_XFLASH} GREATER_EQUAL 0) - if (WIN32) - STRING(REPLACE ";" " + " LANG_CMD_TMP "${LANG_BINS}") - add_custom_command( OUTPUT ${LANG_FINAL_BIN} - COMMAND copy /b ${LANG_CMD_TMP} ${LANG_FINAL_BIN} - DEPENDS ${LANG_BINS} - COMMENT "Merging language binaries (W32)" - ) - else() - add_custom_command( OUTPUT ${LANG_FINAL_BIN} - COMMAND cat ${LANG_BINS} > ${LANG_FINAL_BIN} - DEPENDS ${LANG_BINS} - COMMENT "Merging language binaries (Non-W32)" - ) - endif() - add_custom_command( OUTPUT ${LANG_FINAL_BIN} - COMMAND ${CMAKE_COMMAND} -DLANG_MAX_SIZE=${LANG_BIN_MAX} - -DLANG_FILE=${LANG_FINAL_BIN} - -P ${PROJECT_CMAKE_DIR}/Check_final_lang_bin_size.cmake - APPEND - ) - add_custom_command( OUTPUT ${LANG_FINAL_HEX} - COMMAND ${CMAKE_OBJCOPY} -I binary -O ihex ${LANG_FINAL_BIN} ${LANG_FINAL_HEX} - DEPENDS ${LANG_FINAL_BIN} - COMMENT "Generating Hex for language data" - ) - set(LANG_HEX ${CMAKE_BINARY_DIR}/${variant_name}-lang.hex) - if (WIN32) - SET(TEXT_MERGE_CMD "type") - else() - SET(TEXT_MERGE_CMD "cat") - endif() - add_custom_target(${variant_name}-languages - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/${variant_name}.hex ${LANG_HEX} - COMMAND ${TEXT_MERGE_CMD} ${LANG_FINAL_HEX} >> ${LANG_HEX} - COMMENT "Generating final ${variant_name}-lang.hex" - BYPRODUCTS ${LANG_HEX} - DEPENDS ${LANG_FINAL_HEX} - ) - add_dependencies(ALL_FIRMWARE ${variant_name}-languages) - else() - set (ALL_VARIANT_HEXES "") - # Non-xflash, e.g. MK2.5 - foreach(LANG IN LISTS LANG_VARIANTS) - SET(LANG_HEX_FN ${variant_name}-en_${LANG}) - SET(LANG_HEX ${CMAKE_BINARY_DIR}/${LANG_HEX_FN}.hex) - SET(LANG_BIN ${LANG_TMP_DIR}/${variant_name}_${LANG}.bin) - SET(LANG_FWBIN_TMP ${LANG_TMP_DIR}/${variant_name}-en_${LANG}.bin) + endforeach() + string(FIND ${variant_name} "MK3" HAS_XFLASH) + if (${HAS_XFLASH} GREATER_EQUAL 0) + if (WIN32) + STRING(REPLACE ";" " + " LANG_CMD_TMP "${LANG_BINS}") + add_custom_command( OUTPUT ${LANG_FINAL_BIN} + COMMAND copy /b ${LANG_CMD_TMP} ${LANG_FINAL_BIN} + DEPENDS ${LANG_BINS} + COMMENT "Merging language binaries (W32)" + ) + else() + add_custom_command( OUTPUT ${LANG_FINAL_BIN} + COMMAND cat ${LANG_BINS} > ${LANG_FINAL_BIN} + DEPENDS ${LANG_BINS} + COMMENT "Merging language binaries (Non-W32)" + ) + endif() + add_custom_command( OUTPUT ${LANG_FINAL_BIN} + COMMAND ${CMAKE_COMMAND} -DLANG_MAX_SIZE=${LANG_BIN_MAX} + -DLANG_FILE=${LANG_FINAL_BIN} + -P ${PROJECT_CMAKE_DIR}/Check_final_lang_bin_size.cmake + APPEND + ) + add_custom_command( OUTPUT ${LANG_FINAL_HEX} + COMMAND ${CMAKE_OBJCOPY} -I binary -O ihex ${LANG_FINAL_BIN} ${LANG_FINAL_HEX} + DEPENDS ${LANG_FINAL_BIN} + COMMENT "Generating Hex for language data" + ) + set(LANG_HEX ${CMAKE_BINARY_DIR}/${variant_name}-lang.hex) + if (WIN32) + SET(TEXT_MERGE_CMD "type") + else() + SET(TEXT_MERGE_CMD "cat") + endif() + add_custom_target(${variant_name}-languages + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/${variant_name}.hex ${LANG_HEX} + COMMAND ${TEXT_MERGE_CMD} ${LANG_FINAL_HEX} >> ${LANG_HEX} + COMMENT "Generating final ${variant_name}-lang.hex" + BYPRODUCTS ${LANG_HEX} + DEPENDS ${LANG_FINAL_HEX} + ) + add_dependencies(ALL_FIRMWARE ${variant_name}-languages) + else() + set (ALL_VARIANT_HEXES "") + # Non-xflash, e.g. MK2.5 + foreach(LANG IN LISTS LANG_VARIANTS) + SET(LANG_HEX_FN ${variant_name}-en_${LANG}) + SET(LANG_HEX ${CMAKE_BINARY_DIR}/${LANG_HEX_FN}.hex) + SET(LANG_BIN ${LANG_TMP_DIR}/${variant_name}_${LANG}.bin) + SET(LANG_FWBIN_TMP ${LANG_TMP_DIR}/${variant_name}-en_${LANG}.bin) - #Intermediate 2-lang bin - add_custom_command(OUTPUT ${LANG_FWBIN_TMP} - COMMAND ${CMAKE_COMMAND} -E copy ${LANG_FWBIN} ${LANG_FWBIN_TMP} - COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-patchsec.py ${CMAKE_BINARY_DIR}/${variant_name} ${LANG_BIN} ${LANG_FWBIN_TMP} - DEPENDS ${LANG_FWBIN} ${LANG_BIN} - COMMENT "Generating ${variant_name}-en_${LANG}.bin" - ) + #Intermediate 2-lang bin + add_custom_command(OUTPUT ${LANG_FWBIN_TMP} + COMMAND ${CMAKE_COMMAND} -E copy ${LANG_FWBIN} ${LANG_FWBIN_TMP} + COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-patchsec.py ${CMAKE_BINARY_DIR}/${variant_name} ${LANG_BIN} ${LANG_FWBIN_TMP} + DEPENDS ${LANG_FWBIN} ${LANG_BIN} + COMMENT "Generating ${variant_name}-en_${LANG}.bin" + ) - #Final hex: - add_custom_target(${LANG_HEX_FN} - COMMAND ${CMAKE_OBJCOPY} -I binary -O ihex ${LANG_FWBIN_TMP} ${LANG_HEX} - BYPRODUCTS ${LANG_HEX} - DEPENDS ${LANG_FWBIN_TMP} - COMMENT "Creating ${LANG_HEX_FN}.hex" - ) - LIST(APPEND ALL_VARIANT_HEXES ${LANG_HEX}) - endforeach() - add_custom_target("${variant_name}-All-Languages" - DEPENDS ${ALL_VARIANT_HEXES} - ) - add_dependencies(ALL_FIRMWARE "${variant_name}-All-Languages") - endif() + #Final hex: + add_custom_target(${LANG_HEX_FN} + COMMAND ${CMAKE_OBJCOPY} -I binary -O ihex ${LANG_FWBIN_TMP} ${LANG_HEX} + BYPRODUCTS ${LANG_HEX} + DEPENDS ${LANG_FWBIN_TMP} + COMMENT "Creating ${LANG_HEX_FN}.hex" + ) + LIST(APPEND ALL_VARIANT_HEXES ${LANG_HEX}) + endforeach() + add_custom_target("${variant_name}-All-Languages" + DEPENDS ${ALL_VARIANT_HEXES} + ) + add_dependencies(ALL_FIRMWARE "${variant_name}-All-Languages") + endif() endfunction() if(CMAKE_CROSSCOMPILING) - - - file(GLOB FW_VARIANTS RELATIVE ${PROJECT_SOURCE_DIR}/Firmware/variants ${PROJECT_SOURCE_DIR}/Firmware/variants/*.h) - foreach(THIS_VAR IN LISTS FW_VARIANTS) - string(REPLACE ".h" "" TRIMMED_NAME "${THIS_VAR}") - message("Variant added: ${TRIMMED_NAME}") - fw_add_variant(${TRIMMED_NAME}) - - endforeach(THIS_VAR IN LISTS FW_VARIANTS) + file(GLOB FW_VARIANTS RELATIVE ${PROJECT_SOURCE_DIR}/Firmware/variants ${PROJECT_SOURCE_DIR}/Firmware/variants/*.h) + foreach(THIS_VAR IN LISTS FW_VARIANTS) + string(REPLACE ".h" "" TRIMMED_NAME "${THIS_VAR}") + message("Variant added: ${TRIMMED_NAME}") + fw_add_variant(${TRIMMED_NAME}) + endforeach(THIS_VAR IN LISTS FW_VARIANTS) endif() if(NOT CMAKE_CROSSCOMPILING) - # do not build the firmware by default (tests are the focus if not crosscompiling) - project(cmake_test) + # do not build the firmware by default (tests are the focus if not crosscompiling) + project(cmake_test) - # Prepare "Catch" library for other executables - set(CATCH_INCLUDE_DIR Catch2) - add_library(Catch INTERFACE) - target_include_directories(Catch INTERFACE ${CATCH_INCLUDE_DIR}) + # Prepare "Catch" library for other executables + set(CATCH_INCLUDE_DIR Catch2) + add_library(Catch INTERFACE) + target_include_directories(Catch INTERFACE ${CATCH_INCLUDE_DIR}) - # Make test executable - set(TEST_SOURCES - Tests/tests.cpp - Tests/Example_test.cpp - Tests/Timer_test.cpp - Tests/AutoDeplete_test.cpp - Tests/PrusaStatistics_test.cpp - Firmware/Timer.cpp - Firmware/AutoDeplete.cpp - ) - add_executable(tests ${TEST_SOURCES}) - target_include_directories(tests PRIVATE Tests) - target_link_libraries(tests Catch) + # Make test executable + set(TEST_SOURCES + Tests/tests.cpp + Tests/Example_test.cpp + Tests/Timer_test.cpp + Tests/AutoDeplete_test.cpp + Tests/PrusaStatistics_test.cpp + Firmware/Timer.cpp + Firmware/AutoDeplete.cpp + ) + add_executable(tests ${TEST_SOURCES}) + target_include_directories(tests PRIVATE Tests) + target_link_libraries(tests Catch) endif() From ca0d6caddfad9624f89df01052ed57897c643cc1 Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Thu, 28 Jul 2022 18:16:15 -0400 Subject: [PATCH 10/17] Be explicit on languages --- CMakeLists.txt | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index b3663d3ff..615ffeb3f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -3,8 +3,19 @@ include(cmake/Utilities.cmake) set (CMAKE_CXX_STANDARD 11) +MESSAGE(WARNING " +***************** YOUR ATTENTION PLEASE ***************** +CMake support is experimental. There is no guarantee at this time. If you have problems you are encouraged to fall back to the tried-and-true methods. +*********************** THANK YOU ********************** +We now return to your regularly scheduled Firmware Build." +) + OPTION(SECONDARY_LANGUAGES "Secondary language support in the firmware" ON) +SET(MAIN_LANGUAGES cs de es fr it pl CACHE STRING "The list of 'main' languages to be included, in the correct order") +SET(COMMUNITY_LANGUAGES nl ro hu hr sk sv no CACHE STRING "The list of community languages to be included, in the correct order") +SET(SELECTED_LANGUAGES ${MAIN_LANGUAGES} ${COMMUNITY_LANGUAGES}) + get_dependency_directory(prusa3dboards PRUSA_BOARDS_DIR) project(Prusa-Firmware) @@ -13,7 +24,7 @@ STRING(REGEX MATCH "0x[0-9]+" MAX_SIZE_HEX "${MAX_SIZE_LINE}") math(EXPR LANG_MAX_SIZE "${MAX_SIZE_HEX}" OUTPUT_FORMAT DECIMAL) message("Language maximum size (from config.h): ${LANG_MAX_SIZE} bytes") -set (LANG_BIN_MAX 249856) # Ditto, this in xflash_layout.h +set (LANG_BIN_MAX 249856) # Ditto, this in xflash_layout.h but needs invocation of the preprocessor... :-/ get_recommended_gcc_version(RECOMMENDED_TOOLCHAIN_VERSION) if(CMAKE_CROSSCOMPILING AND NOT CMAKE_CXX_COMPILER_VERSION VERSION_EQUAL @@ -88,12 +99,12 @@ file(GLOB FW_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmwa file(GLOB FW_HEADERS RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmware/*.h*) file(GLOB AVR_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/*.c*) - # Setup language resources: -file(GLOB LANG_VARIANTS RELATIVE ${PROJECT_SOURCE_DIR}/lang/po ${PROJECT_SOURCE_DIR}/lang/po/Firmware_??.po) -string(REPLACE "Firmware_" "" LANG_VARIANTS "${LANG_VARIANTS}") -string(REPLACE ".po" "" LANG_VARIANTS "${LANG_VARIANTS}") -list(SORT LANG_VARIANTS) -message("Languages found: ${LANG_VARIANTS}") +# Setup language resources: +# file(GLOB LANG_VARIANTS RELATIVE ${PROJECT_SOURCE_DIR}/lang/po ${PROJECT_SOURCE_DIR}/lang/po/Firmware_??.po) +# string(REPLACE "Firmware_" "" LANG_VARIANTS "${LANG_VARIANTS}") +# string(REPLACE ".po" "" LANG_VARIANTS "${LANG_VARIANTS}") +# list(SORT LANG_VARIANTS) +# message("Languages found: ${LANG_VARIANTS}") add_library(avr_core STATIC ${AVR_SOURCES}) target_include_directories(avr_core PRIVATE @@ -187,7 +198,7 @@ function(fw_add_variant variant_name) set(LANG_BINS "") - foreach (LANG IN LISTS LANG_VARIANTS) + foreach (LANG IN LISTS SELECTED_LANGUAGES) set(LANG_BIN ${LANG_TMP_DIR}/${variant_name}_${LANG}.bin) set(PO_FILE "${CMAKE_CURRENT_SOURCE_DIR}/lang/po/Firmware_${LANG}.po") @@ -249,7 +260,7 @@ function(fw_add_variant variant_name) else() set (ALL_VARIANT_HEXES "") # Non-xflash, e.g. MK2.5 - foreach(LANG IN LISTS LANG_VARIANTS) + foreach(LANG IN LISTS SELECTED_LANGUAGES) SET(LANG_HEX_FN ${variant_name}-en_${LANG}) SET(LANG_HEX ${CMAKE_BINARY_DIR}/${LANG_HEX_FN}.hex) SET(LANG_BIN ${LANG_TMP_DIR}/${variant_name}_${LANG}.bin) From 9e52798224ca7babb46e12667155cb2e84892440 Mon Sep 17 00:00:00 2001 From: 3d-gussner <3d.gussner@gmail.com> Date: Fri, 5 Aug 2022 16:23:35 +0200 Subject: [PATCH 11/17] Update Windows MAC download urls Add python dependencies for translations --- utils/bootstrap.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/utils/bootstrap.py b/utils/bootstrap.py index 590de4ce8..517ba1a07 100755 --- a/utils/bootstrap.py +++ b/utils/bootstrap.py @@ -39,9 +39,9 @@ dependencies = { 'cmake': { 'version': '3.22.5', 'url': { - 'Linux': 'https://github.com/Kitware/CMake/releases/download/v3.22.5/cmake-3.22.5-Linux-x86_64.tar.gz', - 'Windows': 'https://github.com/Kitware/CMake/releases/download/v3.22.5/cmake-3.22.5-win64-x64.zip', - 'Darwin': 'https://github.com/Kitware/CMake/releases/download/v3.22.5/cmake-3.22.5-Darwin-x86_64.tar.gz', + 'Linux': 'https://github.com/Kitware/CMake/releases/download/v3.22.5/cmake-3.22.5-linux-x86_64.tar.gz', + 'Windows': 'https://github.com/Kitware/CMake/releases/download/v3.22.5/cmake-3.22.5-windows-x86_64.zip', + 'Darwin': 'https://github.com/Kitware/CMake/releases/download/v3.22.5/cmake-3.22.5-macos-universal.tar.gz', }, }, 'avr-gcc': { @@ -61,7 +61,7 @@ dependencies = { } }, } -pip_dependencies = ["pyelftools"] +pip_dependencies = ["pyelftools","polib","regex"] # yapf: enable From 5f12c7f10b58cf0abf976bdcb4786ca08206eecc Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Fri, 5 Aug 2022 16:54:07 -0400 Subject: [PATCH 12/17] * Synchronize flags with arduino * Use cmake -E cat for merge * Set AR/ranlib to GCC flavour --- CMakeLists.txt | 103 ++++++++++++++++++++++------------------ cmake/LocalAvrGcc.cmake | 10 ++++ 2 files changed, 67 insertions(+), 46 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 615ffeb3f..586de351a 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,7 +1,7 @@ cmake_minimum_required(VERSION 3.15) include(cmake/Utilities.cmake) -set (CMAKE_CXX_STANDARD 11) +set (CMAKE_CXX_STANDARD 17) MESSAGE(WARNING " ***************** YOUR ATTENTION PLEASE ***************** @@ -54,6 +54,23 @@ endif() # include symbols add_compile_options(-g) +# +# Firmware - get file lists. +# +file(GLOB FW_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmware/*.c*) +file(GLOB FW_HEADERS RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmware/*.h*) +foreach(_FILE ${FW_SOURCES}) + get_filename_component(_BASE ${_FILE} NAME) + set_property(SOURCE ${_FILE} APPEND_STRING PROPERTY COMPILE_FLAGS "-frandom-seed=${_BASE}.o") +endforeach() + +file(GLOB AVR_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/*.c*) + +foreach(_FILE ${AVR_SOURCES}) + get_filename_component(_BASE ${_FILE} NAME) + set_property(SOURCE ${_FILE} APPEND_STRING PROPERTY COMPILE_FLAGS "-frandom-seed=core/${_BASE}.o") +endforeach() + # optimizations if(CMAKE_CROSSCOMPILING) if(CMAKE_BUILD_TYPE STREQUAL "Debug") @@ -63,17 +80,28 @@ if(CMAKE_CROSSCOMPILING) endif() # mcu related settings - set(MCU_FLAGS -mmcu=atmega2560 -DF_CPU=16000000L) + set(MCU_FLAGS -mmcu=atmega2560 -DF_CPU=16000000L -DARDUINO=10819 -DARDUINO_AVR_PRUSA_EINSY_RAMBO -DARDUINO_ARCH_AVR) add_compile_options(${MCU_FLAGS}) - add_link_options(${MCU_FLAGS}) - # split and gc sections - add_compile_options(-ffunction-sections -fdata-sections) - add_link_options(-Wl,--gc-sections) + add_compile_options($<$:-fno-exceptions>) + add_compile_options($<$:-fno-threadsafe-statics>) + add_compile_options($<$:-fno-rtti>) + add_compile_options(-Wall -Wextra -Wno-expansion-to-defined -ffunction-sections -fdata-sections -MMD -flto -fno-fat-lto-objects) + + # split and gc sections + add_link_options(-Os -g -flto -Wl,--gc-sections -mmcu=atmega2560 -Wl,-u,vfprintf -lprintf_flt -lm ) + + # Create this target before we apply the GC options + add_library(avr_core STATIC ${AVR_SOURCES}) + target_include_directories(avr_core PRIVATE + ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/ + ${PRUSA_BOARDS_DIR}/variants/prusa_einsy_rambo/ + ) + + # disable exceptions and related metadata - add_compile_options(-fno-exceptions -fno-unwind-tables) - add_compile_options($<$:-fno-rtti>) + add_compile_options(-fno-unwind-tables) add_link_options(-Wl,--defsym,__exidx_start=0,--defsym,__exidx_end=0) else() if(CMAKE_BUILD_TYPE STREQUAL "Debug") @@ -84,20 +112,16 @@ else() endif() # enable all warnings (well, not all, but some) -add_compile_options(-Wall -Wsign-compare) -add_compile_options($<$:-std=c++14>) +add_compile_options(-Wsign-compare) +add_compile_options($<$:-std=gnu++17>) +add_compile_options($<$:-std=gnu11>) # support _DEBUG macro (some code uses to recognize debug builds) if(CMAKE_BUILD_TYPE STREQUAL "Debug") add_compile_definitions(_DEBUG) endif() -# -# Firmware - get file lists. -# -file(GLOB FW_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmware/*.c*) -file(GLOB FW_HEADERS RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmware/*.h*) -file(GLOB AVR_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/*.c*) + # Setup language resources: # file(GLOB LANG_VARIANTS RELATIVE ${PROJECT_SOURCE_DIR}/lang/po ${PROJECT_SOURCE_DIR}/lang/po/Firmware_??.po) @@ -106,12 +130,6 @@ file(GLOB AVR_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PRUSA_BOARDS_DIR}/cores/p # list(SORT LANG_VARIANTS) # message("Languages found: ${LANG_VARIANTS}") -add_library(avr_core STATIC ${AVR_SOURCES}) -target_include_directories(avr_core PRIVATE - ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/ - ${PRUSA_BOARDS_DIR}/variants/prusa_einsy_rambo/ -) -target_compile_options(avr_core PUBLIC -mmcu=atmega2560) # Meta target to build absolutely everything add_custom_target(ALL_FIRMWARE) @@ -131,7 +149,7 @@ function(fw_add_variant variant_name) add_executable(${variant_name} ${FW_SOURCES} ${FW_HEADERS} ${VARIANT_CFG_FILE}) - set_target_properties(${variant_name} PROPERTIES CXX_STANDARD 14) + set_target_properties(${variant_name} PROPERTIES CXX_STANDARD 17) target_include_directories(${variant_name} PRIVATE Firmware ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/ @@ -139,6 +157,8 @@ function(fw_add_variant variant_name) ${VARIANT_CFG_DIR} # Include the header for this variant. ) + target_link_libraries(${variant_name} avr_core) + # # configure linker script set(LINKER_SCRIPT ${PRUSA_BOARDS_DIR}/ldscripts/avr6.xn) target_link_options(${variant_name} PUBLIC -Wl,-T,${LINKER_SCRIPT}) @@ -167,15 +187,19 @@ function(fw_add_variant variant_name) target_compile_options(${variant_name} PRIVATE) # turn this on for lolz -Wdouble-promotion) target_compile_definitions(${variant_name} PRIVATE - ARDUINO=10600 - __AVR_ATmega2560__ CMAKE_LANG_CONTROL ) - target_link_libraries(${variant_name} avr_core) + if (SECONDARY_LANGUAGES) target_compile_definitions(${variant_name} PUBLIC LANG_MODE=1) else() target_compile_definitions(${variant_name} PUBLIC LANG_MODE=0) + add_custom_command( + TARGET ${variant_name} + POST_BUILD + COMMAND ${CMAKE_OBJCOPY} -O ihex ${CMAKE_BINARY_DIR}/${variant_name} ${CMAKE_BINARY_DIR}/${variant_name}-EN_ONLY.hex + COMMENT "Generating ${variant_name} hex" + ) add_dependencies(ALL_FIRMWARE "${variant_name}") return() #Done, if no languages there's nothing else to do. endif() @@ -218,20 +242,11 @@ function(fw_add_variant variant_name) endforeach() string(FIND ${variant_name} "MK3" HAS_XFLASH) if (${HAS_XFLASH} GREATER_EQUAL 0) - if (WIN32) - STRING(REPLACE ";" " + " LANG_CMD_TMP "${LANG_BINS}") - add_custom_command( OUTPUT ${LANG_FINAL_BIN} - COMMAND copy /b ${LANG_CMD_TMP} ${LANG_FINAL_BIN} - DEPENDS ${LANG_BINS} - COMMENT "Merging language binaries (W32)" - ) - else() - add_custom_command( OUTPUT ${LANG_FINAL_BIN} - COMMAND cat ${LANG_BINS} > ${LANG_FINAL_BIN} - DEPENDS ${LANG_BINS} - COMMENT "Merging language binaries (Non-W32)" - ) - endif() + add_custom_command( OUTPUT ${LANG_FINAL_BIN} + COMMAND ${CMAKE_COMMEAND} -E cat ${LANG_BINS} > ${LANG_FINAL_BIN} + DEPENDS ${LANG_BINS} + COMMENT "Merging language binaries (Non-W32)" + ) add_custom_command( OUTPUT ${LANG_FINAL_BIN} COMMAND ${CMAKE_COMMAND} -DLANG_MAX_SIZE=${LANG_BIN_MAX} -DLANG_FILE=${LANG_FINAL_BIN} @@ -244,14 +259,10 @@ function(fw_add_variant variant_name) COMMENT "Generating Hex for language data" ) set(LANG_HEX ${CMAKE_BINARY_DIR}/${variant_name}-lang.hex) - if (WIN32) - SET(TEXT_MERGE_CMD "type") - else() - SET(TEXT_MERGE_CMD "cat") - endif() + add_custom_target(${variant_name}-languages COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/${variant_name}.hex ${LANG_HEX} - COMMAND ${TEXT_MERGE_CMD} ${LANG_FINAL_HEX} >> ${LANG_HEX} + COMMAND ${CMAKE_COMMAND} -E cat ${LANG_FINAL_HEX} >> ${LANG_HEX} COMMENT "Generating final ${variant_name}-lang.hex" BYPRODUCTS ${LANG_HEX} DEPENDS ${LANG_FINAL_HEX} diff --git a/cmake/LocalAvrGcc.cmake b/cmake/LocalAvrGcc.cmake index 2e89cb492..17ea199ae 100644 --- a/cmake/LocalAvrGcc.cmake +++ b/cmake/LocalAvrGcc.cmake @@ -73,6 +73,16 @@ set(CMAKE_ASM_COMPILE_OBJECT CACHE STRING "" FORCE ) +set(CMAKE_AR + "${BINUTILS_PATH}/${TOOLCHAIN_PREFIX}gcc-ar${EXECUTABLE_SUFFIX}" + CACHE FILEPATH "ar" FORCE + ) + +set(CMAKE_RANLIB + "${BINUTILS_PATH}/${TOOLCHAIN_PREFIX}gcc-ranlib${EXECUTABLE_SUFFIX}" + CACHE FILEPATH "ranlib" FORCE + ) + set(CMAKE_OBJCOPY "${BINUTILS_PATH}/${TOOLCHAIN_PREFIX}objcopy${EXECUTABLE_SUFFIX}" CACHE INTERNAL "objcopy tool" From 1e7e9aa391ad2d13636252d36f1fc3970b127003 Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Fri, 5 Aug 2022 17:45:48 -0400 Subject: [PATCH 13/17] fix typo --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 586de351a..4244b2acb 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -243,7 +243,7 @@ function(fw_add_variant variant_name) string(FIND ${variant_name} "MK3" HAS_XFLASH) if (${HAS_XFLASH} GREATER_EQUAL 0) add_custom_command( OUTPUT ${LANG_FINAL_BIN} - COMMAND ${CMAKE_COMMEAND} -E cat ${LANG_BINS} > ${LANG_FINAL_BIN} + COMMAND ${CMAKE_COMMAND} -E cat ${LANG_BINS} > ${LANG_FINAL_BIN} DEPENDS ${LANG_BINS} COMMENT "Merging language binaries (Non-W32)" ) From ea920536cb65727ff7b230c431326ca3722691fc Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Fri, 5 Aug 2022 21:03:41 -0400 Subject: [PATCH 14/17] Add version info to filenames --- CMakeLists.txt | 55 +++++- cmake/GetGitRevisionDescription.cmake | 232 +++++++++++++++++++++++ cmake/GetGitRevisionDescription.cmake.in | 37 ++++ cmake/ProjectVersion.cmake | 71 +++++++ 4 files changed, 389 insertions(+), 6 deletions(-) create mode 100644 cmake/GetGitRevisionDescription.cmake create mode 100644 cmake/GetGitRevisionDescription.cmake.in create mode 100644 cmake/ProjectVersion.cmake diff --git a/CMakeLists.txt b/CMakeLists.txt index 4244b2acb..9e216175b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,7 +1,51 @@ cmake_minimum_required(VERSION 3.15) include(cmake/Utilities.cmake) +include(cmake/GetGitRevisionDescription.cmake) -set (CMAKE_CXX_STANDARD 17) +#set (CMAKE_CXX_STANDARD 17) + +SET(PROJECT_VERSION_SUFFIX + "" + CACHE + STRING + "Full version suffix to be shown on the info screen in settings (e.g. full_version=4.0.3-BETA+1035.PR111.B4, suffix=-BETA+1035.PR111.B4). Defaults to '+..' if set to ''." + ) +SET(PROJECT_VERSION_SUFFIX_SHORT + "" + CACHE + STRING + "Short version suffix to be shown on splash screen. Defaults to '+' if set to ''." + ) +SET(BUILD_NUMBER + "" + CACHE STRING "Build number of the firmware. Resolved automatically if not specified." + ) + + +INCLUDE(cmake/ProjectVersion.cmake) +resolve_version_variables() + + +SET(PROJECT_VERSION_FLAVOUR "" CACHE STRING "Firmware flavour to build - DEBUG, DEVEL, APLHA, BETA or RC") +SET(PROJECT_VERSION_FLAVOUR_REVISION "" CACHE STRING "Firmware flavour version, e.g. 1 for RC1, etc") + + +IF( NOT PROJECT_VERSION_FLAVOUR STREQUAL "") + SET(PROJECT_VERSION "${PROJECT_VERSION}-${PROJECT_VERSION_FLAVOUR}") + add_compile_definitions(FW_FLAVOR=${PROJECT_VERSION_FLAVOUR}) + IF( NOT PROJECT_VERSION_FLAVOUR_REVISION STREQUAL "") + SET(PROJECT_VERSION "${PROJECT_VERSION}${PROJECT_VERSION_FLAVOUR_REVISION}") + add_compile_definitions(FW_FLAVERSION=${PROJECT_VERSION_FLAVOUR_REVISION}) + ENDIF() +ENDIF() + +# Inform user about the resolved settings +MESSAGE(STATUS "Project version: ${PROJECT_VERSION}") +MESSAGE( + STATUS "Project version with short suffix: ${PROJECT_VERSION}${PROJECT_VERSION_SUFFIX_SHORT}" + ) + +SET(FN_PREFIX "FW${PROJECT_VERSION}${PROJECT_VERSION_SUFFIX_SHORT}") MESSAGE(WARNING " ***************** YOUR ATTENTION PLEASE ***************** @@ -113,7 +157,6 @@ endif() # enable all warnings (well, not all, but some) add_compile_options(-Wsign-compare) -add_compile_options($<$:-std=gnu++17>) add_compile_options($<$:-std=gnu11>) # support _DEBUG macro (some code uses to recognize debug builds) @@ -197,7 +240,7 @@ function(fw_add_variant variant_name) add_custom_command( TARGET ${variant_name} POST_BUILD - COMMAND ${CMAKE_OBJCOPY} -O ihex ${CMAKE_BINARY_DIR}/${variant_name} ${CMAKE_BINARY_DIR}/${variant_name}-EN_ONLY.hex + COMMAND ${CMAKE_OBJCOPY} -O ihex ${CMAKE_BINARY_DIR}/${variant_name} ${CMAKE_BINARY_DIR}/${FN_PREFIX}-${variant_name}-EN_ONLY.hex COMMENT "Generating ${variant_name} hex" ) add_dependencies(ALL_FIRMWARE "${variant_name}") @@ -258,7 +301,7 @@ function(fw_add_variant variant_name) DEPENDS ${LANG_FINAL_BIN} COMMENT "Generating Hex for language data" ) - set(LANG_HEX ${CMAKE_BINARY_DIR}/${variant_name}-lang.hex) + set(LANG_HEX ${CMAKE_BINARY_DIR}/${FN_PREFIX}-${variant_name}-lang.hex) add_custom_target(${variant_name}-languages COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/${variant_name}.hex ${LANG_HEX} @@ -273,7 +316,7 @@ function(fw_add_variant variant_name) # Non-xflash, e.g. MK2.5 foreach(LANG IN LISTS SELECTED_LANGUAGES) SET(LANG_HEX_FN ${variant_name}-en_${LANG}) - SET(LANG_HEX ${CMAKE_BINARY_DIR}/${LANG_HEX_FN}.hex) + SET(LANG_HEX ${CMAKE_BINARY_DIR}/${FN_PREFIX}-${LANG_HEX_FN}.hex) SET(LANG_BIN ${LANG_TMP_DIR}/${variant_name}_${LANG}.bin) SET(LANG_FWBIN_TMP ${LANG_TMP_DIR}/${variant_name}-en_${LANG}.bin) @@ -292,7 +335,7 @@ function(fw_add_variant variant_name) DEPENDS ${LANG_FWBIN_TMP} COMMENT "Creating ${LANG_HEX_FN}.hex" ) - LIST(APPEND ALL_VARIANT_HEXES ${LANG_HEX}) + LIST(APPEND ALL_VARIANT_HEXES ${LANG_HEX_FN}) endforeach() add_custom_target("${variant_name}-All-Languages" DEPENDS ${ALL_VARIANT_HEXES} diff --git a/cmake/GetGitRevisionDescription.cmake b/cmake/GetGitRevisionDescription.cmake new file mode 100644 index 000000000..0eccbc122 --- /dev/null +++ b/cmake/GetGitRevisionDescription.cmake @@ -0,0 +1,232 @@ +# * Returns a version string from Git +# +# These functions force a re-configure on each git commit so that you can trust the values of the +# variables in your build system. +# +# get_git_head_revision( [ ...]) +# +# Returns the refspec and sha hash of the current head revision +# +# git_describe( [ ...]) +# +# Returns the results of git describe on the source tree, and adjusting the output so that it tests +# false if an error occurs. +# +# git_get_exact_tag( [ ...]) +# +# Returns the results of git describe --exact-match on the source tree, and adjusting the output so +# that it tests false if there was no exact matching tag. +# +# git_local_changes() +# +# Returns either "CLEAN" or "DIRTY" with respect to uncommitted changes. Uses the return code of +# "git diff-index --quiet HEAD --". Does not regard untracked files. +# +# git_count_parent_commits() +# +# Returns number of commits preceeding current commit -1 if git rev-list --count HEAD failed or +# "GIT-NOTFOUND" if git executable was not found or "HEAD-HASH-NOTFOUND" if head hash was not found. +# I don't know if get_git_head_revision() must be called internally or not, as reason of calling it +# is not clear for me also in git_local_changes(). +# +# Requires CMake 2.6 or newer (uses the 'function' command) +# +# Original Author: 2009-2010 Ryan Pavlik +# http://academic.cleardefinition.com Iowa State University HCI Graduate Program/VRAC +# +# Copyright Iowa State University 2009-2010. Distributed under the Boost Software License, Version +# 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) + +if(__get_git_revision_description) + return() +endif() +set(__get_git_revision_description YES) + +# We must run the following at "include" time, not at function call time, to find the path to this +# module rather than the path to a calling list file +get_filename_component(_gitdescmoddir ${CMAKE_CURRENT_LIST_FILE} PATH) + +function(get_git_head_revision _refspecvar _hashvar) + set(GIT_PARENT_DIR "${CMAKE_CURRENT_SOURCE_DIR}") + set(GIT_DIR "${GIT_PARENT_DIR}/.git") + while(NOT EXISTS "${GIT_DIR}") # .git dir not found, search parent directories + set(GIT_PREVIOUS_PARENT "${GIT_PARENT_DIR}") + get_filename_component(GIT_PARENT_DIR ${GIT_PARENT_DIR} PATH) + if(GIT_PARENT_DIR STREQUAL GIT_PREVIOUS_PARENT) + # We have reached the root directory, we are not in git + set(${_refspecvar} + "GITDIR-NOTFOUND" + PARENT_SCOPE + ) + set(${_hashvar} + "GITDIR-NOTFOUND" + PARENT_SCOPE + ) + return() + endif() + set(GIT_DIR "${GIT_PARENT_DIR}/.git") + endwhile() + # check if this is a submodule + if(NOT IS_DIRECTORY ${GIT_DIR}) + file(READ ${GIT_DIR} submodule) + string(REGEX REPLACE "gitdir: (.*)\n$" "\\1" GIT_DIR_RELATIVE ${submodule}) + get_filename_component(SUBMODULE_DIR ${GIT_DIR} PATH) + get_filename_component(GIT_DIR ${SUBMODULE_DIR}/${GIT_DIR_RELATIVE} ABSOLUTE) + endif() + set(GIT_DATA "${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/git-data") + if(NOT EXISTS "${GIT_DATA}") + file(MAKE_DIRECTORY "${GIT_DATA}") + endif() + + if(NOT EXISTS "${GIT_DIR}/HEAD") + return() + endif() + set(HEAD_FILE "${GIT_DATA}/HEAD") + configure_file("${GIT_DIR}/HEAD" "${HEAD_FILE}" COPYONLY) + + configure_file( + "${_gitdescmoddir}/GetGitRevisionDescription.cmake.in" "${GIT_DATA}/grabRef.cmake" @ONLY + ) + include("${GIT_DATA}/grabRef.cmake") + + set(${_refspecvar} + "${HEAD_REF}" + PARENT_SCOPE + ) + set(${_hashvar} + "${HEAD_HASH}" + PARENT_SCOPE + ) +endfunction() + +function(git_describe _var) + if(NOT GIT_FOUND) + find_package(Git QUIET) + endif() + get_git_head_revision(refspec hash) + if(NOT GIT_FOUND) + set(${_var} + "GIT-NOTFOUND" + PARENT_SCOPE + ) + return() + endif() + if(NOT hash) + set(${_var} + "HEAD-HASH-NOTFOUND" + PARENT_SCOPE + ) + return() + endif() + + # TODO sanitize if((${ARGN}" MATCHES "&&") OR (ARGN MATCHES "||") OR (ARGN MATCHES "\\;")) + # message("Please report the following error to the project!") message(FATAL_ERROR "Looks like + # someone's doing something nefarious with git_describe! Passed arguments ${ARGN}") endif() + + # message(STATUS "Arguments to execute_process: ${ARGN}") + + execute_process( + COMMAND "${GIT_EXECUTABLE}" describe ${hash} ${ARGN} + WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" + RESULT_VARIABLE res + OUTPUT_VARIABLE out + ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE + ) + if(NOT res EQUAL 0) + set(out "${out}-${res}-NOTFOUND") + endif() + + set(${_var} + "${out}" + PARENT_SCOPE + ) +endfunction() + +function(git_get_exact_tag _var) + git_describe(out --exact-match ${ARGN}) + set(${_var} + "${out}" + PARENT_SCOPE + ) +endfunction() + +function(git_local_changes _var) + if(NOT GIT_FOUND) + find_package(Git QUIET) + endif() + get_git_head_revision(refspec hash) + if(NOT GIT_FOUND) + set(${_var} + "GIT-NOTFOUND" + PARENT_SCOPE + ) + return() + endif() + if(NOT hash) + set(${_var} + "HEAD-HASH-NOTFOUND" + PARENT_SCOPE + ) + return() + endif() + + execute_process( + COMMAND "${GIT_EXECUTABLE}" diff-index --quiet HEAD -- + WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" + RESULT_VARIABLE res + OUTPUT_VARIABLE out + ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE + ) + if(res EQUAL 0) + set(${_var} + "CLEAN" + PARENT_SCOPE + ) + else() + set(${_var} + "DIRTY" + PARENT_SCOPE + ) + endif() +endfunction() + +function(git_count_parent_commits _var) + if(NOT GIT_FOUND) + find_package(Git QUIET) + endif() + get_git_head_revision(refspec hash) + if(NOT GIT_FOUND) + set(${_var} + "GIT-NOTFOUND" + PARENT_SCOPE + ) + return() + endif() + if(NOT hash) + set(${_var} + "HEAD-HASH-NOTFOUND" + PARENT_SCOPE + ) + return() + endif() + + execute_process( + COMMAND "${GIT_EXECUTABLE}" rev-list --count HEAD + WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" + RESULT_VARIABLE res + OUTPUT_VARIABLE out + ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE + ) + if(res EQUAL 0) + set(${_var} + "${out}" + PARENT_SCOPE + ) + else() + set(${_var} + "-1" + PARENT_SCOPE + ) + endif() + +endfunction() diff --git a/cmake/GetGitRevisionDescription.cmake.in b/cmake/GetGitRevisionDescription.cmake.in new file mode 100644 index 000000000..f7d93ddf8 --- /dev/null +++ b/cmake/GetGitRevisionDescription.cmake.in @@ -0,0 +1,37 @@ +# +# Internal file for GetGitRevisionDescription.cmake +# +# Requires CMake 2.6 or newer (uses the 'function' command) +# +# Original Author: 2009-2010 Ryan Pavlik +# http://academic.cleardefinition.com Iowa State University HCI Graduate Program/VRAC +# +# Copyright Iowa State University 2009-2010. Distributed under the Boost Software License, Version +# 1.0. (See accompanying file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) + +set(HEAD_HASH) + +file(READ "@HEAD_FILE@" HEAD_CONTENTS LIMIT 1024) + +string(STRIP "${HEAD_CONTENTS}" HEAD_CONTENTS) +if(HEAD_CONTENTS MATCHES "ref") + # named branch + string(REPLACE "ref: " "" HEAD_REF "${HEAD_CONTENTS}") + if(EXISTS "@GIT_DIR@/${HEAD_REF}") + configure_file("@GIT_DIR@/${HEAD_REF}" "@GIT_DATA@/head-ref" COPYONLY) + else() + configure_file("@GIT_DIR@/packed-refs" "@GIT_DATA@/packed-refs" COPYONLY) + file(READ "@GIT_DATA@/packed-refs" PACKED_REFS) + if(${PACKED_REFS} MATCHES "([0-9a-z]*) ${HEAD_REF}") + set(HEAD_HASH "${CMAKE_MATCH_1}") + endif() + endif() +else() + # detached HEAD + configure_file("@GIT_DIR@/HEAD" "@GIT_DATA@/head-ref" COPYONLY) +endif() + +if(NOT HEAD_HASH) + file(READ "@GIT_DATA@/head-ref" HEAD_HASH LIMIT 1024) + string(STRIP "${HEAD_HASH}" HEAD_HASH) +endif() diff --git a/cmake/ProjectVersion.cmake b/cmake/ProjectVersion.cmake new file mode 100644 index 000000000..259442735 --- /dev/null +++ b/cmake/ProjectVersion.cmake @@ -0,0 +1,71 @@ +# +# This file is responsible for setting the following variables: +# +# ~~~ +# BUILD_NUMBER (1035) +# PROJECT_VERSION (4.0.3) +# PROJECT_VERSION_FULL (4.0.3-BETA+1035.PR111.B4) +# PROJECT_VERSION_SUFFIX (-BETA+1035.PR111.B4) +# PROJECT_VERSION_SUFFIX_SHORT (+1035) +# +# The `PROJECT_VERSION` variable is set as soon as the file is included. +# To set the rest, the function `resolve_version_variables` has to be called. +# +# ~~~ + +FILE(STRINGS ${CMAKE_CURRENT_SOURCE_DIR}/Firmware/Configuration.h CFG_VER_DATA REGEX "#define FW_[A-Z]+ ([0-9]+)" ) +LIST(GET CFG_VER_DATA 0 PROJECT_VERSION_MAJOR) +LIST(GET CFG_VER_DATA 1 PROJECT_VERSION_MINOR) +LIST(GET CFG_VER_DATA 2 PROJECT_VERSION_REV) +STRING(REGEX MATCH "FW_MAJOR ([0-9]+)" PROJECT_VERSION_MAJOR "${PROJECT_VERSION_MAJOR}") +SET(PROJECT_VERSION_MAJOR "${CMAKE_MATCH_1}") + +STRING(REGEX MATCH "FW_MINOR ([0-9]+)" PROJECT_VERSION_MINOR "${PROJECT_VERSION_MINOR}") +SET(PROJECT_VERSION_MINOR ${CMAKE_MATCH_1}) + +STRING(REGEX MATCH "FW_REVISION +([0-9]+)" PROJECT_VERSION_REV "${PROJECT_VERSION_REV}") +SET(PROJECT_VERSION_REV ${CMAKE_MATCH_1}) + +SET(PROJECT_VERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_REV}") +SET(PROJECT_VERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_REV}" PARENT_SCOPE) + + +function(resolve_version_variables) + # BUILD_NUMBER + if(NOT BUILD_NUMBER) + git_count_parent_commits(BUILD_NUMBER) + set(ERRORS "GIT-NOTFOUND" "HEAD-HASH-NOTFOUND") + if(BUILD_NUMBER IN_LIST ERRORS) + message(WARNING "Failed to resolve build number: ${BUILD_NUMBER}. Setting to zero.") + set(BUILD_NUMBER "0") + endif() + set(BUILD_NUMBER + ${BUILD_NUMBER} + PARENT_SCOPE + ) + endif() + + # PROJECT_VERSION_SUFFIX + if(PROJECT_VERSION_SUFFIX STREQUAL "") + # TODO: set to +.dirty?.debug? + set(PROJECT_VERSION_SUFFIX "+${BUILD_NUMBER}.LOCAL") + set(PROJECT_VERSION_SUFFIX + "+${BUILD_NUMBER}.LOCAL" + PARENT_SCOPE + ) + endif() + + # PROJECT_VERSION_SUFFIX_SHORT + if(PROJECT_VERSION_SUFFIX_SHORT STREQUAL "") + set(PROJECT_VERSION_SUFFIX_SHORT + "+${BUILD_NUMBER}" + PARENT_SCOPE + ) + endif() + + # PROJECT_VERSION_FULL + set(PROJECT_VERSION_FULL + "${PROJECT_VERSION}${PROJECT_VERSION_SUFFIX}" + PARENT_SCOPE + ) +endfunction() From 04ea371936656a2e244f9a18fba775f53970dd85 Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Sat, 6 Aug 2022 10:57:03 -0400 Subject: [PATCH 15/17] Set source files explicitly for reproducible build --- CMakeLists.txt | 92 ++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 89 insertions(+), 3 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 9e216175b..d0acbf421 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -101,14 +101,100 @@ add_compile_options(-g) # # Firmware - get file lists. # -file(GLOB FW_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmware/*.c*) -file(GLOB FW_HEADERS RELATIVE ${PROJECT_SOURCE_DIR} ${PROJECT_SOURCE_DIR}/Firmware/*.h*) +SET(FW_SOURCES + adc.c + bootapp.c + timer02.c + sm4.c + spi.c + rbuf.c + swi2c.c + language.c + tone04.c + uart2.c + xflash.c + Marlin_main.cpp + AutoDeplete.cpp + Configuration.cpp + BlinkM.cpp + Dcodes.cpp + MarlinSerial.cpp + ConfigurationStore.cpp + Sd2Card.cpp + SdBaseFile.cpp + SdFatUtil.cpp + SdFile.cpp + SdVolume.cpp + Servo.cpp + Timer.cpp + backlight.cpp + cardreader.cpp + cmdqueue.cpp + conv2str.cpp + eeprom.cpp + first_lay_cal.cpp + fsensor.cpp + heatbed_pwm.cpp + la10compat.cpp + lcd.cpp + menu.cpp + mesh_bed_calibration.cpp + mesh_bed_leveling.cpp + messages.cpp + mmu.cpp + motion_control.cpp + optiboot_xflash.cpp + pat9125.cpp + planner.cpp + qr_solve.cpp + sound.cpp + speed_lookuptable.cpp + stepper.cpp + swspi.cpp + temperature.cpp + tmc2130.cpp + twi.cpp + ultralcd.cpp + util.cpp + vector_3.cpp + xflash_dump.cpp + xyzcal.cpp +) +list(TRANSFORM FW_SOURCES PREPEND ${CMAKE_CURRENT_SOURCE_DIR}/Firmware/) + foreach(_FILE ${FW_SOURCES}) get_filename_component(_BASE ${_FILE} NAME) set_property(SOURCE ${_FILE} APPEND_STRING PROPERTY COMPILE_FLAGS "-frandom-seed=${_BASE}.o") endforeach() -file(GLOB AVR_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/*.c*) + +set(AVR_SOURCES + wiring_digital.c + WInterrupts.c + wiring_pulse.c + hooks.c + wiring.c + wiring_analog.c + wiring_shift.c + CDC.cpp + PluggableUSB.cpp + HardwareSerial.cpp + HardwareSerial0.cpp + HardwareSerial1.cpp + HardwareSerial3.cpp + IPAddress.cpp + HardwareSerial2.cpp + Print.cpp + Stream.cpp + Tone.cpp + USBCore.cpp + WMath.cpp + WString.cpp + abi.cpp + main.cpp +# new.cpp # What happened to this? it was removed in 1.0.5-1 to 1.0.5.2? +) +list(TRANSFORM AVR_SOURCES PREPEND ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/) foreach(_FILE ${AVR_SOURCES}) get_filename_component(_BASE ${_FILE} NAME) From 598991dc69fa066af3c5e89362314b75f073ec23 Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Sat, 6 Aug 2022 12:24:30 -0400 Subject: [PATCH 16/17] - Fake-gen some folders to organize targets - Support building both en and multilang together --- .gitignore | 1 + CMakeLists.txt | 159 +++++++++++++++++++++++++++---------------------- 2 files changed, 89 insertions(+), 71 deletions(-) diff --git a/.gitignore b/.gitignore index 316085fcd..b0a83687c 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ #cmake /build/ +/build_gen/ .dependencies # Temporary configuration /Firmware/Configuration_prusa.h diff --git a/CMakeLists.txt b/CMakeLists.txt index d0acbf421..293f2ab6f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -2,8 +2,6 @@ cmake_minimum_required(VERSION 3.15) include(cmake/Utilities.cmake) include(cmake/GetGitRevisionDescription.cmake) -#set (CMAKE_CXX_STANDARD 17) - SET(PROJECT_VERSION_SUFFIX "" CACHE @@ -262,90 +260,103 @@ endif() # Meta target to build absolutely everything add_custom_target(ALL_FIRMWARE) +add_custom_target(ALL_ENGLISH) +add_custom_target(ALL_MULTILANG) +add_dependencies(ALL_FIRMWARE ALL_ENGLISH ALL_MULTILANG) + +function(add_base_binary variant_name) + add_executable(${variant_name} ${FW_SOURCES} ${FW_HEADERS} ${VARIANT_CFG_FILE}) + + set_target_properties(${variant_name} PROPERTIES CXX_STANDARD 17) + + target_include_directories(${variant_name} PRIVATE Firmware + ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/ + ${PRUSA_BOARDS_DIR}/variants/prusa_einsy_rambo/ + ${VARIANT_CFG_DIR} # Include the header for this variant. + ) + + target_link_libraries(${variant_name} avr_core) + + # # configure linker script + set(LINKER_SCRIPT ${PRUSA_BOARDS_DIR}/ldscripts/avr6.xn) + target_link_options(${variant_name} PUBLIC -Wl,-T,${LINKER_SCRIPT}) + + # limit the text section to 248K (256K - 8k reserved for the bootloader) + target_link_options(${variant_name} PUBLIC -Wl,--defsym=__TEXT_REGION_LENGTH__=248K) + + # generate firmware.bin file + objcopy(${variant_name} "ihex" ".hex") + + # produce ASM listing. Note we also specify the .map as a byproduct so it gets cleaned + # because link_options doesn't have a "generated outputs" feature. + add_custom_command( + TARGET ${variant_name} POST_BUILD COMMAND ${CMAKE_OBJDUMP} -CSd ${variant_name} > ${variant_name}.asm + BYPRODUCTS ${variant_name}.asm ${variant_name}.map + ) + + # inform about the firmware's size in terminal + add_custom_command( + TARGET ${variant_name} POST_BUILD COMMAND ${CMAKE_SIZE_UTIL} -C --mcu=atmega2560 ${variant_name} + ) + report_size(${variant_name}) + + # generate linker map file + target_link_options(${variant_name} PUBLIC -Wl,-Map=${CMAKE_CURRENT_BINARY_DIR}/${variant_name}.map) + + target_compile_definitions(${variant_name} PRIVATE + CMAKE_LANG_CONTROL + ) +endfunction() function(fw_add_variant variant_name) # Create the Configuration_Prusa.h for this variant so it can be #included. - set(VARIANT_CFG_DIR "${CMAKE_CURRENT_BINARY_DIR}/${variant_name}_include") + set(VARIANT_CFG_DIR "${CMAKE_CURRENT_BINARY_DIR}/include") set(VARIANT_CFG_FILE "${VARIANT_CFG_DIR}/Configuration_prusa.h") add_custom_command(OUTPUT ${VARIANT_CFG_FILE} - COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_SOURCE_DIR}/Firmware/variants/${variant_name}.h ${VARIANT_CFG_FILE} + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/Firmware/variants/${variant_name}.h ${VARIANT_CFG_FILE} COMMENT "Generating Configuration_prusa.h for ${variant_name}" BYPRODUCTS ${VARIANT_CFG_DIR} ) STRING(REPLACE "1_75mm_" "" variant_name "${variant_name}") STRING(REPLACE "-E3Dv6full" "" variant_name "${variant_name}") - add_executable(${variant_name} ${FW_SOURCES} ${FW_HEADERS} ${VARIANT_CFG_FILE}) + SET(FW_EN "${variant_name}_EN-only") + SET(FW_MULTI "${variant_name}_Multilang") - set_target_properties(${variant_name} PROPERTIES CXX_STANDARD 17) + add_base_binary(${FW_EN}) + # target_compile_options(${variant_name} PRIVATE) # turn this on for lolz -Wdouble-promotion) - target_include_directories(${variant_name} PRIVATE Firmware - ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/ - ${PRUSA_BOARDS_DIR}/variants/prusa_einsy_rambo/ - ${VARIANT_CFG_DIR} # Include the header for this variant. - ) - - target_link_libraries(${variant_name} avr_core) - -# # configure linker script - set(LINKER_SCRIPT ${PRUSA_BOARDS_DIR}/ldscripts/avr6.xn) - target_link_options(${variant_name} PUBLIC -Wl,-T,${LINKER_SCRIPT}) - - # limit the text section to 248K (256K - 8k reserved for the bootloader) - target_link_options(${variant_name} PUBLIC -Wl,--defsym=__TEXT_REGION_LENGTH__=248K) - - # generate firmware.bin file - objcopy(${variant_name} "ihex" ".hex") - - # produce ASM listing. Note we also specify the .map as a byproduct so it gets cleaned - # because link_options doesn't have a "generated outputs" feature. - add_custom_command( - TARGET ${variant_name} POST_BUILD COMMAND ${CMAKE_OBJDUMP} -CSd ${variant_name} > ${variant_name}.asm - BYPRODUCTS ${variant_name}.asm ${variant_name}.map - ) - - # inform about the firmware's size in terminal - add_custom_command( - TARGET ${variant_name} POST_BUILD COMMAND ${CMAKE_SIZE_UTIL} -C --mcu=atmega2560 ${variant_name} - ) - report_size(${variant_name}) - - # generate linker map file - target_link_options(${variant_name} PUBLIC -Wl,-Map=${variant_name}.map) - - target_compile_options(${variant_name} PRIVATE) # turn this on for lolz -Wdouble-promotion) - target_compile_definitions(${variant_name} PRIVATE - CMAKE_LANG_CONTROL - ) - - if (SECONDARY_LANGUAGES) - target_compile_definitions(${variant_name} PUBLIC LANG_MODE=1) - else() - target_compile_definitions(${variant_name} PUBLIC LANG_MODE=0) - add_custom_command( - TARGET ${variant_name} - POST_BUILD - COMMAND ${CMAKE_OBJCOPY} -O ihex ${CMAKE_BINARY_DIR}/${variant_name} ${CMAKE_BINARY_DIR}/${FN_PREFIX}-${variant_name}-EN_ONLY.hex - COMMENT "Generating ${variant_name} hex" + target_compile_definitions(${FW_EN} PUBLIC LANG_MODE=0) + add_custom_command( + TARGET ${FW_EN} + POST_BUILD + COMMAND ${CMAKE_OBJCOPY} -O ihex ${CMAKE_CURRENT_BINARY_DIR}/${FW_EN} ${CMAKE_BINARY_DIR}/${FN_PREFIX}-${FW_EN}.hex + BYPRODUCTS ${CMAKE_BINARY_DIR}/${FN_PREFIX}-${FW_EN}.hex + COMMENT "Generating ${variant_name} hex" ) - add_dependencies(ALL_FIRMWARE "${variant_name}") + add_dependencies(ALL_ENGLISH "${FW_EN}") + + if (NOT SECONDARY_LANGUAGES) return() #Done, if no languages there's nothing else to do. + else() + add_base_binary(${FW_MULTI}) + target_compile_definitions(${FW_MULTI} PUBLIC LANG_MODE=1) endif() #Construct language map - set(LANG_TMP_DIR ${CMAKE_CURRENT_BINARY_DIR}/lang) + set(LANG_TMP_DIR ${CMAKE_BINARY_DIR}/${variant_name}/lang) set(LANG_MAP ${LANG_TMP_DIR}/${variant_name}_lang.map) - set(LANG_FWBIN ${CMAKE_BINARY_DIR}/${variant_name}.bin) + set(LANG_FWBIN ${CMAKE_CURRENT_BINARY_DIR}/${variant_name}.bin) set(LANG_FINAL_BIN ${LANG_TMP_DIR}/${variant_name}_lang.bin) set(LANG_FINAL_HEX ${LANG_TMP_DIR}/${variant_name}_lang.hex) add_custom_command(OUTPUT ${LANG_FWBIN} - COMMAND "${CMAKE_OBJCOPY}" -I ihex -O binary ${CMAKE_BINARY_DIR}/${variant_name}.hex ${LANG_FWBIN} - DEPENDS ${variant_name} + COMMAND "${CMAKE_OBJCOPY}" -I ihex -O binary ${CMAKE_CURRENT_BINARY_DIR}/${variant_name}_Multilang.hex ${LANG_FWBIN} + DEPENDS ${FW_MULTI} ) add_custom_command(OUTPUT ${LANG_MAP} - COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-map.py "${CMAKE_BINARY_DIR}/${variant_name}" "${LANG_FWBIN}" > "${LANG_MAP}" + COMMAND ${CMAKE_SOURCE_DIR}/lang/lang-map.py "${FW_MULTI}" "${LANG_FWBIN}" > "${LANG_MAP}" DEPENDS ${LANG_FWBIN} ) @@ -354,11 +365,11 @@ function(fw_add_variant variant_name) foreach (LANG IN LISTS SELECTED_LANGUAGES) set(LANG_BIN ${LANG_TMP_DIR}/${variant_name}_${LANG}.bin) - set(PO_FILE "${CMAKE_CURRENT_SOURCE_DIR}/lang/po/Firmware_${LANG}.po") + set(PO_FILE "${CMAKE_SOURCE_DIR}/lang/po/Firmware_${LANG}.po") add_custom_command(OUTPUT ${LANG_BIN} # COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-check.py --no-warning --map "${LANG_MAP}" "${PO_FILE}" # COMMAND ${CMAKE_COMMAND} -E echo "Building lang_${LANG}.bin" - COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-build.py ${LANG_MAP} ${PO_FILE} ${LANG_BIN} + COMMAND ${CMAKE_SOURCE_DIR}/lang/lang-build.py ${LANG_MAP} ${PO_FILE} ${LANG_BIN} # Check bin size: COMMAND ${CMAKE_COMMAND} -DLANG_MAX_SIZE=${LANG_MAX_SIZE} -DLANG_FILE=${LANG_BIN} @@ -374,7 +385,7 @@ function(fw_add_variant variant_name) add_custom_command( OUTPUT ${LANG_FINAL_BIN} COMMAND ${CMAKE_COMMAND} -E cat ${LANG_BINS} > ${LANG_FINAL_BIN} DEPENDS ${LANG_BINS} - COMMENT "Merging language binaries (Non-W32)" + COMMENT "Merging language binaries" ) add_custom_command( OUTPUT ${LANG_FINAL_BIN} COMMAND ${CMAKE_COMMAND} -DLANG_MAX_SIZE=${LANG_BIN_MAX} @@ -387,16 +398,16 @@ function(fw_add_variant variant_name) DEPENDS ${LANG_FINAL_BIN} COMMENT "Generating Hex for language data" ) - set(LANG_HEX ${CMAKE_BINARY_DIR}/${FN_PREFIX}-${variant_name}-lang.hex) + set(LANG_HEX ${CMAKE_BINARY_DIR}/${FN_PREFIX}-${variant_name}-Languages.hex) - add_custom_target(${variant_name}-languages - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/${variant_name}.hex ${LANG_HEX} + add_custom_target(${variant_name}-language-hex + COMMAND ${CMAKE_COMMAND} -E copy ${FW_MULTI}.hex ${LANG_HEX} COMMAND ${CMAKE_COMMAND} -E cat ${LANG_FINAL_HEX} >> ${LANG_HEX} - COMMENT "Generating final ${variant_name}-lang.hex" + COMMENT "Generating final ${variant_name}-Languages.hex" BYPRODUCTS ${LANG_HEX} DEPENDS ${LANG_FINAL_HEX} ) - add_dependencies(ALL_FIRMWARE ${variant_name}-languages) + add_dependencies(ALL_MULTILANG ${variant_name}-language-hex) else() set (ALL_VARIANT_HEXES "") # Non-xflash, e.g. MK2.5 @@ -409,7 +420,7 @@ function(fw_add_variant variant_name) #Intermediate 2-lang bin add_custom_command(OUTPUT ${LANG_FWBIN_TMP} COMMAND ${CMAKE_COMMAND} -E copy ${LANG_FWBIN} ${LANG_FWBIN_TMP} - COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/lang/lang-patchsec.py ${CMAKE_BINARY_DIR}/${variant_name} ${LANG_BIN} ${LANG_FWBIN_TMP} + COMMAND ${CMAKE_SOURCE_DIR}/lang/lang-patchsec.py ${FW_MULTI} ${LANG_BIN} ${LANG_FWBIN_TMP} DEPENDS ${LANG_FWBIN} ${LANG_BIN} COMMENT "Generating ${variant_name}-en_${LANG}.bin" ) @@ -426,7 +437,7 @@ function(fw_add_variant variant_name) add_custom_target("${variant_name}-All-Languages" DEPENDS ${ALL_VARIANT_HEXES} ) - add_dependencies(ALL_FIRMWARE "${variant_name}-All-Languages") + add_dependencies(ALL_MULTILANG "${variant_name}-All-Languages") endif() endfunction() @@ -437,7 +448,13 @@ if(CMAKE_CROSSCOMPILING) foreach(THIS_VAR IN LISTS FW_VARIANTS) string(REPLACE ".h" "" TRIMMED_NAME "${THIS_VAR}") message("Variant added: ${TRIMMED_NAME}") - fw_add_variant(${TRIMMED_NAME}) + string(REPLACE "-E3Dv6full" "" DIR_NAME "${TRIMMED_NAME}") + string(REPLACE "1_75mm_" "" DIR_NAME "${DIR_NAME}") + # Generate a file in a subfolder so that we can organize things a little more neatly in VS code + FILE(MAKE_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/build_gen/${DIR_NAME}) + FILE(WRITE ${CMAKE_CURRENT_SOURCE_DIR}/build_gen/${DIR_NAME}/CMakeLists.txt "project(${DIR_NAME})\nfw_add_variant(${TRIMMED_NAME})") + add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/build_gen/${DIR_NAME}) + #fw_add_variant(${TRIMMED_NAME}) endforeach(THIS_VAR IN LISTS FW_VARIANTS) endif() From 4a3b07f832f26a443b3b4716febad16bc8321e8c Mon Sep 17 00:00:00 2001 From: VintagePC <53943260+vintagepc@users.noreply.github.com> Date: Sun, 25 Sep 2022 10:55:23 -0400 Subject: [PATCH 17/17] Fix include path --- CMakeLists.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 293f2ab6f..370d4c080 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -269,10 +269,11 @@ function(add_base_binary variant_name) set_target_properties(${variant_name} PROPERTIES CXX_STANDARD 17) - target_include_directories(${variant_name} PRIVATE Firmware + target_include_directories(${variant_name} PRIVATE ${PRUSA_BOARDS_DIR}/cores/prusa_einsy_rambo/ ${PRUSA_BOARDS_DIR}/variants/prusa_einsy_rambo/ ${VARIANT_CFG_DIR} # Include the header for this variant. + ${CMAKE_SOURCE_DIR}/Firmware ) target_link_libraries(${variant_name} avr_core)