Implementing an alternative build framework with CMake #1776
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
massonal
force-pushed
the
cmake_dev
branch
4 times, most recently
from
2f8ea81
to
290b330
Compare
fpistm
requested changes
Aug 3, 2022
massonal
force-pushed
the
cmake_dev
branch
3 times, most recently
from
c0babcf
to
f5960ab
Compare
massonal
force-pushed
the
cmake_dev
branch
4 times, most recently
from
ed57b42
to
fe5794c
Compare
massonal
force-pushed
the
cmake_dev
branch
5 times, most recently
from
2da70fa
to
c4b84c4
Compare
fpistm
reviewed
Sep 16, 2022
fpistm
reviewed
Sep 16, 2022
massonal
force-pushed
the
cmake_dev
branch
4 times, most recently
from
2f04f34
to
d8a659c
Compare
The script uses its location and arduino-cli to write a template of the sketch's CMakeLists.txt. * Defines: - CORE_PATH - USER_LIBS -> for use with `external_library()` * Includes all user libraries * Usable on a given sketch or generically (use placeholders) * Optionally: run CMake (config+build)
I.e. changed some variables from "CACHE" to "regular in the parent scope" CACHE variables can exhibit some counterintuitive behavior; switching back to regular variables is thus safer and does not significantly impact build time.
Using: - platform.txt to get the version of the core - the dev version of the JSON describing all the tools+versions+deps - stand-alone: Python, wrt. version and modules. Changes: - The download folder is no longer inside Arduino_Core_STM32, but alongside. - The options to control the download (clearance + folder) are removed. - CMake: harmonize the `cmake_minimum_required()`s CMSIS and xpack are no longer downloaded _in_ the root folder, but alongside. All this parsing is costly (e.g., on rebuild), so shortcuts have been implemented if it looks like the dependencies are satisfied already.
- Added a new kind of insight: logic structure - Added the CORE_CALLBACK overall setting
Important: the changed implemented here _require_ the user to call `project()` in "step 1", before calling any custom function, but after defining the toolchain file. The whole of Arduino_Core_STM32 (variant + core) is now added automatically when the user calls build_sketch() ; they don't have to do it themselves anymore. Also the standard libraries have moved from stm32_runtime to base_config. Indeed, even the files from the core depend on them. Also, _all_ the Arduino libraries depend on base_config only (even SrcWrapper). Additional dependencies were actually not needed. ***Moved the CMake-related files to /cmake*** -- for clarity with the remainder of the project (when using Arduino IDE) -- Also, this prevents IDEs from building the core "standalone" when seeing a CMakeLists.txt at the root, -- since that would be meaningless anyway. Also improve portability by replacing backslashes with forward slashes in paths on Windows. ======================= Change: moved the download folder away Having the download folder along the core seemed to cause malfunctions with some external tools (Arduino plugin on VScode). Moving it in the user's home folder fixes this issue. Each core installation nonetheless has its own download subfolder, to allow different versions with different requirements to coexist.
Using a fuzzy find after parsing boards.txt. This has required refactoring the board parser code in a dedicated modules, with minor impacts in the files that depended on it. ============= Doc changes: expand on the syntax in easy_setup: Added a comment block to explain the use of the DEPENDS clause. Added "usual" values for board settings. Add a link to the wiki in easy_setup. Also update link in the README_CMAKE - update link to point to the new location for the examples; - unify the displayed text for the links; - add a link to the wiki.
This adds a new keyword, BOOTLOADER, in set_board(). Cmake-wise, the bootloader targets replace the board targets, they are not feature targets to plug in.
Signed-off-by: Frederic Pillon <frederic.pillon@st.com>
Signed-off-by: Frederic Pillon <frederic.pillon@st.com> Signed-off-by: Alexis Masson <alexis.masson@st.com>
Mostly to benefit from the built-in "--help", as the script takes no actual argument.
ASM not being enabled when `external_library()` is called triggered an error where CMAKE_ASM_COMPILE_OBJECT was undefined. This commit fixes that by adding the calls to enable_language() earlier in the config process.
Now detects and warns when arduino-cli is misconfigured, and falls back to a sensible default value for userlibs.
To mirror as closely as possible the behavior of Arduino tools.
Signed-off-by: Frederic Pillon <frederic.pillon@st.com>
Signed-off-by: Frederic Pillon <frederic.pillon@st.com>
fpistm
force-pushed
the
cmake_dev
branch
2 times, most recently
from
f17548f
to
74d524e
Compare
Signed-off-by: Frederic Pillon <frederic.pillon@st.com>
STM32 core based on ST HAL
automation
moved this from Needs review
to Reviewer approved
Dec 20, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implementing an alternative build framework with CMake
This PR implements an alternative build engine to Arduino IDE or arduino-cli.
Although widely compatible with these tools, a CMake implementation is much faster (especially on Windows, especially behind a proxy/firewall): in the order of 10sec, instead of up to a minute with the IDE on my machine. Other benefits include more flexibility in describing the build, and enhanced support of incremental compilation, including when making changes to the core.
Most features of Arduino IDE are reimplemented here; the most obvious missing feature is the lack of automatic dependency management (libraries). Indeed, the way Arduino implements can not be mirrored cleanly with CMake.
How to use:
Examples can be found at https://github.com/massonal/STM32CMake_workspace.
Briefly, there needs to be a CMakeLists.txt present in the sketch, along the sources. The recommended template makes heavy use of wrapper functions designed to mirror the Arduino automation; these are implemented in the
/cmakefolder here.Please read the wiki I started writing on my fork for more details.
How to maintain