Optimise arduino library management in speeduino repo (speeduino#1306)

* Replace bit_shifts.h with avr-fast-shift library

* Replace embedded libdivide source with library

* Replace embedded FastCRC source with library

* Replace udiv_32_16() with avr-fast-div library

* Fix non-mega builds

* Fix Arduino CLI build

* Fix non-mega Arduino CLI build

* Reduce flash usage on Arduino CLI compile

* Use specific library versions

* Use shared lists of core libraries

* Add missing library for Arduino build

* Performance: replace stock division with fast_div(), percentage() or shifts

Author: adbancroft

.github/workflows/pr-memory-deltas-generate.yml

@@ -7,6 +7,18 @@ on:
 env:
   # It's convenient to set variables for values used multiple times in the workflow.
   SKETCHES_REPORTS_PATH: sketches-reports
+  # Libraries shared by all builds
+  COMMON_LIB_DEPS: | 
+    - name: SimplyAtomic
+      version: "1.0"
+    - name: avr-fast-shift
+      version: "1.1.0"
+    - name: libdivide
+      version: "5.2.0"
+    - name: FastCRC
+      version: "1.41"
+    - name: avr-fast-div
+      version: "1.4.0"
 
 jobs:
   compile:
@@ -25,10 +37,10 @@ jobs:
               - name: arduino:avr
             compile-flags: |
               - --build-property
-              - build.extra_flags=-DPLATFORMIO -DUSE_LIBDIVIDE -O3 -ffast-math -fshort-enums -funroll-loops -Wall -Wextra -std=c++14
+              - build.extra_flags=-DPLATFORMIO -DUSE_LIBDIVIDE -DCRC_BIGTABLES=0 -DAFD_INLINE=0 -O3 -ffast-math -fshort-enums -funroll-loops -Wall -Wextra -std=c++14
             lib_deps: |
               - name: Time
-              - name: SimplyAtomic
+
           - fqbn: teensy:avr:teensy35
             artifact-name-suffix: teensy-avr-teensy35
             platform: |
@@ -39,9 +51,9 @@ jobs:
               - build.extra_flags="-Wall"
             lib_deps: |
               - name: SDfat
-              - name: SimplyAtomic
               - name: InternalTemperature
               - name: elapsedMillis
+              
           - fqbn: teensy:avr:teensy41
             artifact-name-suffix: teensy-avr-teensy41
             platform: |
@@ -52,9 +64,9 @@ jobs:
               - build..extra_flags="-Wall"
             lib_deps: |
               - name: SDfat
-              - name: SimplyAtomic
               - name: InternalTemperature
               - name: elapsedMillis
+          
           - fqbn: STMicroelectronics:stm32:GenF4
             artifact-name-suffix: stm32-avr-stm32f4
             platform: |
@@ -68,12 +80,11 @@ jobs:
               - name: "STM32duino RTC"
                 version: 1.2.0
               - name: SdFat
-              - name: SimplyAtomic
               - name: elapsedMillis
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v4     
 
       - name: Compile platforms
         uses: arduino/compile-sketches@v1.1.2
@@ -90,6 +101,7 @@ jobs:
             ${{ matrix.board.compile-flags }}
           libraries: |
             ${{ matrix.board.lib_deps }}
+            ${{ env.COMMON_LIB_DEPS }}
 
       # This step is needed to pass the size data to the report job.
       - name: Upload sketches report to workflow artifact

misra/check_misra.sh

@@ -94,16 +94,8 @@ if [ $output_xml -eq 1 ]; then
   cppcheck_parameters+=(--xml)
 fi
 
-# There is no way to tell the misra add on to skip certain headers
-# libdivide adds 10+ minutes to each file so rename the folder 
-# before the scan
-mv "$source_folder"/src/libdivide "$source_folder"/src/_libdivide
-
 "$cppcheck_bin" ${cppcheck_parameters[@]} 2> $cppcheck_out_file
 
-# Restore libdivide folder name after scan
-mv "$source_folder"/src/_libdivide "$source_folder"/src/libdivide
-
 # Count lines for Mandatory or Required rules
 error_count=`grep -i "Mandatory - \|Required - " < "$cppcheck_out_file" | wc -l`
 

platformio.ini

@@ -8,16 +8,28 @@
 ; Please visit documentation for the other options and examples
 ; http://docs.platformio.org/page/projectconf.html
 
+[common]
+; These libraries are used by all builds.
+lib_deps = 
+    wizard97/SimplyAtomic@^1.0
+    adbancroft/avr-fast-shift@^1.1.0
+	ridiculousfish/libdivide@^5.2.0
+	frankboesing/FastCRC@^1.41
+	adbancroft/avr-fast-div@^1.4.0
+
 [env:megaatmega2560]
 platform=atmelavr
 board=megaatmega2560
 framework=arduino
 build_unflags = -Os -std=gnu++11
-build_flags = -DUSE_LIBDIVIDE -O3 -ffast-math -fshort-enums -funroll-loops -Wall -Wextra -std=c++14
-; Note that fp64lib is only used by unit tests. It isn't referenced by the firmware & will be
-; ignored.
-lib_deps = EEPROM, Time, fp64lib, simplyatomic
-;test_build_project_src = true
+build_flags = -DCRC_BIGTABLES=0 -DUSE_LIBDIVIDE -DAFD_INLINE=0U -O3 -ffast-math -fshort-enums -funroll-loops -Wall -Wextra -std=c++14
+lib_deps = 
+    EEPROM
+    Time
+	${common.lib_deps}
+	; Note that fp64lib is only used by unit tests. It isn't referenced by the firmware & will be
+	; ignored.
+    fp64lib/fp64lib@^1.1.20
 debug_tool = simavr
 test_ignore = test_table3d_native
 
@@ -53,7 +65,12 @@ test_testing_command =
 platform=https://github.com/platformio/platform-teensy.git
 board=teensy35
 framework=arduino
-lib_deps = EEPROM, FlexCAN_T4, Time, SimplyAtomic, InternalTemperature
+lib_deps = 
+	EEPROM
+	FlexCAN_T4
+	Time
+	InternalTemperature
+	${common.lib_deps}
 test_ignore = test_table3d_native
 extra_scripts = post:post_extra_script.py  
 
@@ -62,7 +79,12 @@ extra_scripts = post:post_extra_script.py
 platform=https://github.com/platformio/platform-teensy.git
 board=teensy36
 framework=arduino
-lib_deps = EEPROM, FlexCAN_T4, Time, SimplyAtomic, InternalTemperature
+lib_deps = 
+	EEPROM
+	FlexCAN_T4
+	Time
+	InternalTemperature
+	${common.lib_deps}
 test_ignore = test_table3d_native
 extra_scripts = post:post_extra_script.py  
 
@@ -71,7 +93,12 @@ extra_scripts = post:post_extra_script.py
 platform=https://github.com/platformio/platform-teensy.git
 board=teensy41
 framework=arduino
-lib_deps = EEPROM, FlexCAN_T4, Time, SimplyAtomic, InternalTemperature
+lib_deps = 
+	EEPROM
+	FlexCAN_T4
+	Time
+	InternalTemperature
+	${common.lib_deps}
 test_ignore = test_table3d_native
 build_flags = -DTEENSY_INIT_USB_DELAY_AFTER=40
 extra_scripts = post:post_extra_script.py  
@@ -82,7 +109,11 @@ platform = ststm32
 framework = arduino
 board = black_f407ve
 ; RTC library fixed to 1.2.0, because in newer than that the RTC fails to keep up time. At least up to 1.3.7 version
-lib_deps = stm32duino/STM32duino RTC @ 1.2.0, greiman/SdFat, SimplyAtomic, elapsedMillis
+lib_deps = 
+	stm32duino/STM32duino RTC @ 1.2.0
+	greiman/SdFat
+	elapsedMillis
+	${common.lib_deps}
 board_build.core = stm32
 build_flags = -DUSE_LIBDIVIDE -std=c++14 -UBOARD_MAX_IO_PINS -DENABLE_HWSERIAL2 -DENABLE_HWSERIAL3 -DUSBCON -DHAL_PCD_MODULE_ENABLED -DUSBD_USE_CDC -DHAL_CAN_MODULE_ENABLED -DSERIAL_TX_BUFFER_SIZE=128 -DSERIAL_RX_BUFFER_SIZE=128
 upload_protocol = dfu
@@ -122,7 +153,9 @@ build_flags = ${env:black_F407VE.build_flags} -DFRAM_AS_EEPROM
 platform = ststm32
 framework = arduino
 board = blackpill_f401cc
-lib_deps = stm32duino/STM32duino RTC @ 1.2.0, SimplyAtomic
+lib_deps = 
+	stm32duino/STM32duino RTC @ 1.2.0
+	${common.lib_deps}
 board_build.core = stm32
 build_flags = -DUSE_LIBDIVIDE -std=c++14 -UBOARD_MAX_IO_PINS -DUSBCON -DHAL_PCD_MODULE_ENABLED -DUSBD_USE_CDC -DHAL_DAC_MODULE_DISABLED -DHAL_ETH_MODULE_DISABLED -DHAL_SD_MODULE_DISABLED -DHAL_QSPI_MODULE_DISABLED 
 upload_protocol = dfu
@@ -134,7 +167,9 @@ monitor_speed = 115200
 platform = ststm32
 framework = arduino
 board = blackpill_f411ce
-lib_deps = stm32duino/STM32duino RTC @ 1.2.0, SimplyAtomic
+lib_deps = 
+	stm32duino/STM32duino RTC @ 1.2.0
+	${common.lib_deps}
 board_build.core = stm32
 build_flags = -DUSE_LIBDIVIDE -O3 -std=c++14 -UBOARD_MAX_IO_PINS
 upload_protocol = dfu
@@ -146,13 +181,45 @@ monitor_speed = 115200
 platform = ststm32
 framework = arduino
 board = blackpill_f411ce
-lib_deps = stm32duino/STM32duino RTC @ 1.2.0, SimplyAtomic
+lib_deps = 
+	stm32duino/STM32duino RTC @ 1.2.0
+	${common.lib_deps}
 board_build.core = stm32
 build_flags = -DUSE_LIBDIVIDE -O3 -std=c++14 -UBOARD_MAX_IO_PINS -DUSBCON -DHAL_PCD_MODULE_ENABLED -DUSBD_USE_CDC
 upload_protocol = dfu
 debug_tool = stlink
 monitor_speed = 115200
 
+[env:bluepill_f103c8]
+platform = ststm32
+framework = arduino
+; framework-arduinoststm32
+board = bluepill_f103c8_128k
+lib_deps = 
+	EEPROM
+	stm32duino/STM32duino RTC @ 1.2.0
+	${common.lib_deps}
+build_flags = -DUSE_LIBDIVIDE -fpermissive -std=gnu++11 -Os -DCORE_STM32_OFFICIAL -UBOARD_MAX_IO_PINS
+
+;SAMD21
+[env:samd21]
+platform = atmelsam
+framework = arduino
+board = zeroUSB
+build_flags = -DUSE_LIBDIVIDE -fpermissive -std=gnu++11
+upload_protocol = sam-ba
+
+;SAME51
+[env:same51]
+platform = atmelsam
+framework = arduino
+board = adafruit_feather_m4_can
+build_flags = -DUSE_LIBDIVIDE -fpermissive -std=gnu++11
+upload_protocol = sam-ba
+
+[env:custom_monitor_speedrate]
+monitor_speed = 115200
+
 [platformio]
 src_dir=speeduino
 default_envs = megaatmega2560