Merge pull request #524 from ckormanyos/reduce_cmsis

Reduce cmsis scope and add license

readme.md

@@ -627,3 +627,8 @@ Some of the code snippets demonstrate language elements not only from C++14,
 but also from C++17, 20, 23 and beyond. A compiler with C++17 support
 or even C++20, 23 support (such as GCC 13, clang 15, MSVC 14.3, or higher) can,
 therefore, be beneficial for success with *all* of the code snippets.
+
+### Licensing
+
+  - The source code written for this repo is licensed under [Boost Software License 1.0](./LICENSE_1_0.txt).
+  - A modified subset of CMSIS is temporarily included for the target `rpi_pico_rp2040`. It is licensed under the Apache Software License version 2.0. The scope of modifications by Christopher Kormanyos 2024-July-23 includes removal of significant content not needed in this project.

ref_app/cmake/rpi_pico_rp2040.cmake

@@ -68,7 +68,6 @@ string(REPLACE ";" " " TARGET_LDFLAGS "${_TARGET_LDFLAGS}")
 set(FILES_TARGET
     ${PATH_APP}/mcal/${TARGET}/Mcal/Clock/Clock
     ${PATH_APP}/mcal/${TARGET}/Mcal/Cpu/Cpu
-    ${PATH_APP}/mcal/${TARGET}/Mcal/SysTickTimer/SysTickTimer
     ${PATH_APP}/mcal/mcal_gcc_cxx_completion
     ${PATH_TGT}/startup/crt0
     ${PATH_TGT}/startup/crt0_init_ram

ref_app/ref_app.vcxproj

@@ -580,10 +580,6 @@
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">true</ExcludedFromBuild>
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Release|x64'">true</ExcludedFromBuild>
     </ClCompile>
-    <ClCompile Include="src\mcal\rpi_pico_rp2040\Mcal\SysTickTimer\SysTickTimer.cpp">
-      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">true</ExcludedFromBuild>
-      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Release|x64'">true</ExcludedFromBuild>
-    </ClCompile>
     <ClCompile Include="src\mcal\rpi_pico_rp2040\mcal_cpu.cpp">
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">true</ExcludedFromBuild>
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Release|x64'">true</ExcludedFromBuild>
@@ -1847,10 +1843,6 @@
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">true</ExcludedFromBuild>
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Release|x64'">true</ExcludedFromBuild>
     </ClInclude>
-    <ClInclude Include="src\mcal\rpi_pico_rp2040\Mcal\SysTickTimer\SysTickTimer.h">
-      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">true</ExcludedFromBuild>
-      <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Release|x64'">true</ExcludedFromBuild>
-    </ClInclude>
     <ClInclude Include="src\mcal\rpi_pico_rp2040\mcal_benchmark.h">
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Debug|x64'">true</ExcludedFromBuild>
       <ExcludedFromBuild Condition="'$(Configuration)|$(Platform)'=='Release|x64'">true</ExcludedFromBuild>

ref_app/ref_app.vcxproj.filters

@@ -239,9 +239,6 @@
     <Filter Include="src\mcal\rpi_pico_rp2040\Mcal\Gpio">
       <UniqueIdentifier>{59916297-16f2-4013-9a36-e79d1949e196}</UniqueIdentifier>
     </Filter>
-    <Filter Include="src\mcal\rpi_pico_rp2040\Mcal\SysTickTimer">
-      <UniqueIdentifier>{6e830cfb-9d3d-4644-b52f-6fb3aa25ea0c}</UniqueIdentifier>
-    </Filter>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="src\app\led\app_led.cpp">
@@ -1108,9 +1105,6 @@
     <ClCompile Include="src\mcal\rpi_pico_rp2040\Mcal\Cpu\Cpu.cpp">
       <Filter>src\mcal\rpi_pico_rp2040\Mcal\Cpu</Filter>
     </ClCompile>
-    <ClCompile Include="src\mcal\rpi_pico_rp2040\Mcal\SysTickTimer\SysTickTimer.cpp">
-      <Filter>src\mcal\rpi_pico_rp2040\Mcal\SysTickTimer</Filter>
-    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="src\math\calculus\derivative.h">
@@ -2562,9 +2556,6 @@
     <ClInclude Include="src\mcal\rpi_pico_rp2040\Mcal\Gpio\Gpio.h">
       <Filter>src\mcal\rpi_pico_rp2040\Mcal\Gpio</Filter>
     </ClInclude>
-    <ClInclude Include="src\mcal\rpi_pico_rp2040\Mcal\SysTickTimer\SysTickTimer.h">
-      <Filter>src\mcal\rpi_pico_rp2040\Mcal\SysTickTimer</Filter>
-    </ClInclude>
     <ClInclude Include="src\mcal\rpi_pico_rp2040\Std\Platform_Types.h">
       <Filter>src\mcal\rpi_pico_rp2040\Std</Filter>
     </ClInclude>

ref_app/src/mcal/rpi_pico_rp2040/Mcal/Cpu/Cpu.cpp

@@ -149,7 +149,9 @@ boolean RP2040_StartCore1(void)
     return FALSE;
   }
 
-  // Clear the stiky bits of the FIFO_ST on core 0.
+  // Clear the sticky bits of the FIFO_ST on core 0.
+  // Note: Core 0 has called us to get here so these are,
+  // in fact, the FIFO_ST sticky bits on core 0.
   SIO->FIFO_ST.reg = 0xFFU;
 
   return TRUE;

ref_app/src/mcal/rpi_pico_rp2040/Mcal/RP2040.h

@@ -97,7 +97,6 @@ typedef enum {
 /** @} */ /* End of group Configuration_of_CMSIS */
 
 #include "core_cm0plus.h"                       /*!< ARM Cortex-M0+ processor and core peripherals                             */
-//#include "system_RP2040.h"                      /*!< RP2040 System                                                             */
 
 #ifndef __IM                                    /*!< Fallback for older CMSIS versions                                         */
   #define __IM   __I

ref_app/target/micros/rpi_pico_rp2040/make/rpi_pico_rp2040_files.gmk

@@ -11,7 +11,6 @@
 
 FILES_TGT  = $(PATH_APP)/mcal/$(TGT)/Mcal/Clock/Clock                  \
              $(PATH_APP)/mcal/$(TGT)/Mcal/Cpu/Cpu                      \
-             $(PATH_APP)/mcal/$(TGT)/Mcal/SysTickTimer/SysTickTimer    \
              $(PATH_APP)/mcal/mcal_gcc_cxx_completion                  \
              $(PATH_TGT)/startup/crt0                                  \
              $(PATH_TGT)/startup/crt0_init_ram                         \