diff --git a/src/main/target/common_post.h b/src/main/target/common_post.h index 1d060319c0..1d1286b2a9 100644 --- a/src/main/target/common_post.h +++ b/src/main/target/common_post.h @@ -18,12 +18,26 @@ * If not, see . */ -// Touch up configuration - #pragma once #include "build/version.h" +/* + + The purpose of this file is to enable / disable any firmware "gates" for features and drivers + that require hardware resources that are either available or not available after the target.h + has been processed. + + It should also be used to define anything that should be defined (and is required), but is not + already, to some sort of defaults. + + CLOUD_BUILD and CORE_BUILD should not be referenced here. + + NOTE: for 4.5 we will be removing any conditions related to specific MCU types, instead + these should be defined in the target.h or in a file that is imported by target.h (in the + case of common settings for a given MCU group) + +*/ /* BEGIN HARDWARE INCLUSIONS diff --git a/src/main/target/common_pre.h b/src/main/target/common_pre.h index 66c009e35b..a8277b9791 100644 --- a/src/main/target/common_pre.h +++ b/src/main/target/common_pre.h @@ -20,6 +20,27 @@ #pragma once +/* + + The purpose of this file is to enable the firmware "gates" for features and drivers + prior to entering the target.h. + + CLOUD_BUILD is used to signify that the build is a user requested build and that the + features to be enabled will be defined ALREADY. + + CORE_BUILD is used to signify that the build is a user requested build and that the + features to be enabled will be the minimal set, and all the drivers should be present. + + If neither of the above are present then the build should simply be a baseline build + for continuous integration, i.e. the compilation of the majority of features and drivers + dependent on the size of the flash available. + + NOTE: for 4.5 we will be removing any conditions related to specific MCU types, instead + these should be defined in the target.h or in a file that is imported by target.h (in the + case of common settings for a given MCU group) + +*/ + #define USE_PARAMETER_GROUPS // type conversion warnings. // -Wconversion can be turned on to enable the process of eliminating these warnings