[MOS-1011] Fix frequency switching stability

Multiple fixes of clock switching related
stability issues:
* added RC oscillator hysteresis as in NXP example;
* changed DCDC converter config;
* configure PLL2 to be able to run on any CPU
frequency level;
* added switching to 1.275V (overdrive) voltage
when applying any clock change above 12MHz as
well as LDO or bandgap switching, as done in
Mbed OS' lpm.c for RT1050;
* changed BMCR AXI queues weighs for SDRAM
in JLink scripts to disable operations
reordering, as it is known to cause data
integrity issues;
* extracted some code to separate files;
* smaller or bigger code cleanups.

Author: Lefucjusz

evkbimxrt1050_sdram_init.jlinkscript

@@ -187,8 +187,8 @@ void SDRAM_Init() {
 
   // Config SDR Controller Registers/
   MEM_WriteU32(0x402F0000,0x10000004); // MCR
-  MEM_WriteU32(0x402F0008,0x20200E44); // BMCR0
-  MEM_WriteU32(0x402F000C,0x20200E40); // BMCR1
+  MEM_WriteU32(0x402F0008,0x00000081); // BMCR0
+  MEM_WriteU32(0x402F000C,0x00000081); // BMCR1
   MEM_WriteU32(0x402F0010,0x8000001D); // BR0, 64MB OK
   MEM_WriteU32(0x402F0040,0x00000E31); // SDRAMCR0 OK
   MEM_WriteU32(0x402F0044,0x00774D22); // SDRAMCR1

evkbimxrt1050_sdram_init_T6.jlinkscript

@@ -239,21 +239,21 @@ void SDRAM_SEMC_Init(void)
     reg_val |= 0x00000002;
     MEM_WriteU32(SEMC_MCR, reg_val);
 
-    /* Configure queues for AXI bus:
+    /* Configure queues for AXI bus as suggested in https://community.nxp.com/t5/i-MX-RT/i-MXRT1060-SEMC-SDRAM-Data-Corruption/m-p/11696908:
      * Queue A:
-     * WQOS = 4;
-     * WAGE = 2;
-     * WSH = 3;
-     * WRWS = 5 */
-    MEM_WriteU32(SEMC_BMCR0, 0x00030524);
+     * WQOS = 1;
+     * WAGE = 8;
+     * WSH = 0;
+     * WRWS = 0 */
+    MEM_WriteU32(SEMC_BMCR0, 0x00000081);
 
     /* Queue B:
-     * WQOS = 4;
-     * WAGE = 2;
-     * WPH = 3;
-     * WRWS = 5;
-     * WBR = 6 */
-    MEM_WriteU32(SEMC_BMCR1, 0x06050324);
+     * WQOS = 1;
+     * WAGE = 8;
+     * WPH = 0;
+     * WRWS = 0;
+     * WBR = 0 */
+    MEM_WriteU32(SEMC_BMCR1, 0x00000081);
 
     /* Configure MCR:
      * set bus timeout cycles to 0x10;

harmony_changelog.md

@@ -52,6 +52,7 @@
 * General improvement in Eink display and error handling
 * Changed the "Turn off Harmony" popup display time to 10 seconds
 * The default year has been updated to 2023
+* Improved device stability related to frequency scaling
 
 ## [2.0.0 2023-06-29]
 

module-apps/application-settings/windows/advanced/CPUModeTestWindow.cpp

@@ -1,4 +1,4 @@
-// Copyright (c) 2017-2022, Mudita Sp. z.o.o. All rights reserved.
+// Copyright (c) 2017-2023, Mudita Sp. z.o.o. All rights reserved.
 // For licensing, see https://github.com/mudita/MuditaOS/LICENSE.md
 
 #include "CPUModeTestWindow.hpp"
@@ -134,9 +134,9 @@ namespace gui
         permanentFreqSpinner = new gui::TextSpinnerBox(permanentFreqBody, {"OFF", "ON"}, Boundaries::Continuous);
         permanentFreqSpinner->setMinimumSize(100, 30);
         auto ret =
-            application->async_call<sys::IsCpuPernament, sys::IsCpuPernamentResponse>(service::name::system_manager);
+            application->async_call<sys::IsCpuPermanent, sys::IsCpuPermanentResponse>(service::name::system_manager);
         application->sync(ret);
-        permanentFreqSpinner->setCurrentValue(ret.getResult().pernament ? "ON" : "OFF");
+        permanentFreqSpinner->setCurrentValue(ret.getResult().permanent ? "ON" : "OFF");
 
         permanentFreqBody->inputCallback = [&](Item &item, const InputEvent &event) {
             auto ret = permanentFreqSpinner->onInput(event);
@@ -193,10 +193,10 @@ namespace gui
         newFreqBody->inputCallback = [&](Item &item, const InputEvent &event) {
             auto ret = currentFreqSpinner->onInput(event);
 
-            auto async = application->async_call<sys::IsCpuPernament, sys::IsCpuPernamentResponse>(
+            auto async = application->async_call<sys::IsCpuPermanent, sys::IsCpuPermanentResponse>(
                 service::name::system_manager);
             application->sync(async);
-            if (async.getResult().pernament) {
+            if (async.getResult().permanent) {
                 application->bus.sendUnicastSync(
                     std::make_shared<sys::HoldCpuFrequencyPermanentlyMessage>(
                         magic_enum::enum_cast<bsp::CpuFrequencyMHz>(std::stoi(currentFreqSpinner->getCurrentValue()))

module-bsp/board/linux/lpm/LinuxLPM.cpp

@@ -1,48 +1,36 @@
 // Copyright (c) 2017-2023, Mudita Sp. z.o.o. All rights reserved.
 // For licensing, see https://github.com/mudita/MuditaOS/LICENSE.md
 
-//
-// Created by mati on 09.09.2019.
-//
-
 #include "LinuxLPM.h"
 
 namespace bsp
 {
-
-    int32_t LinuxLPM::PowerOff()
+    std::int32_t LinuxLPM::PowerOff()
     {
         return 0;
     }
 
-    int32_t LinuxLPM::Reboot(RebootType)
+    std::int32_t LinuxLPM::Reboot([[maybe_unused]] RebootType reason)
     {
         return 0;
     }
 
-    void LinuxLPM::SetCpuFrequency(bsp::CpuFrequencyMHz freq)
+    void LinuxLPM::SetCpuFrequency(CpuFrequencyMHz freq)
     {
         currentFrequency = freq;
     }
 
-    uint32_t LinuxLPM::GetCpuFrequency() const noexcept
+    std::uint32_t LinuxLPM::GetCpuFrequency() const noexcept
     {
         return 0;
     }
 
-    void LinuxLPM::SwitchOscillatorSource(bsp::LowPowerMode::OscillatorSource source)
+    void LinuxLPM::SwitchOscillatorSource(LowPowerMode::OscillatorSource source)
     {}
 
     void LinuxLPM::EnableDcdcPowerSaveMode()
     {}
 
     void LinuxLPM::DisableDcdcPowerSaveMode()
     {}
-
-    void LinuxLPM::SwitchToRegularModeLDO()
-    {}
-
-    void LinuxLPM::SwitchToLowPowerModeLDO()
-    {}
-
 } // namespace bsp

module-bsp/board/linux/lpm/LinuxLPM.h

@@ -1,30 +1,22 @@
 // Copyright (c) 2017-2023, Mudita Sp. z.o.o. All rights reserved.
 // For licensing, see https://github.com/mudita/MuditaOS/LICENSE.md
 
-#ifndef PUREPHONE_LINUXLPM_H
-#define PUREPHONE_LINUXLPM_H
+#pragma once
 
 #include "bsp/lpm/bsp_lpm.hpp"
 
 namespace bsp
 {
-
     class LinuxLPM : public LowPowerMode
     {
       public:
-        int32_t PowerOff() override final;
-        int32_t Reboot(RebootType reason) override final;
+        std::int32_t PowerOff() override final;
+        std::int32_t Reboot(RebootType reason) override final;
         void SetCpuFrequency(CpuFrequencyMHz freq) final;
-        [[nodiscard]] uint32_t GetCpuFrequency() const noexcept final;
+        [[nodiscard]] std::uint32_t GetCpuFrequency() const noexcept final;
         void SwitchOscillatorSource(OscillatorSource source) final;
 
         void EnableDcdcPowerSaveMode() final;
         void DisableDcdcPowerSaveMode() final;
-
-        void SwitchToRegularModeLDO() final;
-        void SwitchToLowPowerModeLDO() final;
     };
-
 } // namespace bsp
-
-#endif // PUREPHONE_LINUXLPM_H

module-bsp/board/rt1051/CMakeLists.txt

@@ -1,7 +1,6 @@
 # Copyright (c) 2017-2021, Mudita Sp. z.o.o. All rights reserved.
 # For licensing, see https://github.com/mudita/MuditaOS/LICENSE.md
 
-
 target_sources(module-bsp
 	PRIVATE
 		bluetooth/BlueKitchen.cpp
@@ -28,6 +27,8 @@ target_sources(module-bsp
 		bsp/lpm/Oscillator.cpp
 		bsp/lpm/RT1051LPMCommon.cpp
 		bsp/lpm/Bandgap.cpp
+		bsp/lpm/LDO.cpp
+		bsp/lpm/DCDC.cpp
 		bsp/magnetometer/ALS31300.cpp
 		bsp/pit/pit.cpp
 		bsp/trng/trng.cpp
@@ -74,6 +75,8 @@ set_source_files_properties(
 
 target_compile_definitions(module-bsp PUBLIC USB_STACK_FREERTOS)
 
+target_compile_definitions(module-bsp PRIVATE BOARD_${PRODUCT}=1)
+
 add_subdirectory(common/fsl_drivers)
 add_subdirectory(os)
 add_subdirectory(${BOARD})

module-bsp/board/rt1051/bellpx/bsp/lpm/RT1051LPM.cpp

@@ -2,8 +2,6 @@
 // For licensing, see https://github.com/mudita/MuditaOS/LICENSE.md
 
 #include "RT1051LPM.hpp"
-#include <board.h>
-#include <board/BoardDefinitions.hpp>
 
 namespace bsp
 {
@@ -12,17 +10,4 @@ namespace bsp
 
     void RT1051LPM::DisableDcdcPowerSaveMode()
     {}
-
-    void RT1051LPM::SwitchToRegularModeLDO()
-    {
-        RT1051LPMCommon::RegularLDOMode();
-        NVIC_ClearPendingIRQ(ANATOP_EVENT0_IRQn);
-        EnableIRQ(ANATOP_EVENT0_IRQn);
-    }
-
-    void RT1051LPM::SwitchToLowPowerModeLDO()
-    {
-        DisableIRQ(ANATOP_EVENT0_IRQn);
-        RT1051LPMCommon::LowPowerLDOMode();
-    }
 } // namespace bsp

module-bsp/board/rt1051/bellpx/bsp/lpm/RT1051LPM.hpp

@@ -2,6 +2,7 @@
 // For licensing, see https://github.com/mudita/MuditaOS/LICENSE.md
 
 #pragma once
+
 #include <bsp/lpm/RT1051LPMCommon.hpp>
 
 namespace bsp
@@ -11,9 +12,5 @@ namespace bsp
       public:
         void EnableDcdcPowerSaveMode() final;
         void DisableDcdcPowerSaveMode() final;
-
-        void SwitchToRegularModeLDO() final;
-        void SwitchToLowPowerModeLDO() final;
     };
-
 } // namespace bsp

module-bsp/board/rt1051/bsp/lpm/Bandgap.cpp

@@ -4,6 +4,7 @@
 #include "Bandgap.hpp"
 #include <cstdint>
 #include <fsl_common.h>
+#include <critical.hpp>
 
 namespace
 {
@@ -14,22 +15,30 @@ namespace bsp::bandgap
 {
     void SwitchToRegularMode()
     {
+        cpp_freertos::CriticalSection::Enter();
+
         /* Enable regular bandgap and wait for it to stabilize */
         CCM_ANALOG->MISC0_CLR = CCM_ANALOG_MISC0_REFTOP_PWD_MASK;
         while ((CCM_ANALOG->MISC0 & CCM_ANALOG_MISC0_REFTOP_VBGUP_MASK) == 0) {}
 
         /* Disable low power bandgap */
         XTALOSC24M->LOWPWR_CTRL_CLR = XTALOSC24M_LOWPWR_CTRL_LPBG_SEL_MASK;
         PMU->MISC0_CLR              = REFTOP_LOWPOWER_MASK;
+
+        cpp_freertos::CriticalSection::Exit();
     }
 
     void SwitchToLowPowerMode()
     {
+        cpp_freertos::CriticalSection::Enter();
+
         /* Enable low power bandgap */
         PMU->MISC0_SET = REFTOP_LOWPOWER_MASK;
+        XTALOSC24M->LOWPWR_CTRL_SET = XTALOSC24M_LOWPWR_CTRL_LPBG_SEL_MASK;
 
         /* Disable regular bandgap */
-        XTALOSC24M->LOWPWR_CTRL_SET = XTALOSC24M_LOWPWR_CTRL_LPBG_SEL_MASK;
         PMU->MISC0_SET              = CCM_ANALOG_MISC0_REFTOP_PWD_MASK;
+
+        cpp_freertos::CriticalSection::Exit();
     }
 } // namespace bsp::bandgap

module-bsp/board/rt1051/bsp/lpm/CpuFreqLPM.cpp

@@ -2,7 +2,7 @@
 // For licensing, see https://github.com/mudita/MuditaOS/LICENSE.md
 
 #include "CpuFreqLPM.hpp"
-#include "fsl_dcdc.h"
+#include <fsl_dcdc.h>
 
 namespace bsp
 {

module-bsp/board/rt1051/bsp/lpm/CpuFreqLPM.hpp

@@ -9,6 +9,7 @@ namespace bsp
 {
     inline constexpr std::uint32_t VDDRun_950_mV  = 0x06;
     inline constexpr std::uint32_t VDDRun_1150_mV = 0x0E;
+    inline constexpr std::uint32_t VDDRun_1275_mV = 0x13;
 
     inline constexpr std::uint32_t VDDStandby_925_mV = 0x01;
 

module-bsp/board/rt1051/bsp/lpm/DCDC.cpp

@@ -0,0 +1,48 @@
+// Copyright (c) 2017-2023, Mudita Sp. z.o.o. All rights reserved.
+// For licensing, see https://github.com/mudita/MuditaOS/LICENSE.md
+
+#include "DCDC.hpp"
+#include "CpuFreqLPM.hpp"
+#include <fsl_dcdc.h>
+
+namespace bsp::dcdc
+{
+    void SwitchToOverdriveConfig()
+    {
+        /* Switch to CCM mode for improved stability */
+        DCDC_BootIntoCCM(DCDC);
+
+        /* Connect internal DCDC load resistor */
+        DCDC->REG1 |= DCDC_REG1_REG_RLOAD_SW_MASK;
+
+        /* Adjust target voltage to 1.275V */
+        DCDC_AdjustTargetVoltage(DCDC, VDDRun_1275_mV, VDDStandby_925_mV);
+
+        /* Disable FET ODRIVE */
+        PMU->REG_CORE_CLR = PMU_REG_CORE_FET_ODRIVE_MASK;
+    }
+
+    void SwitchToRegularConfig()
+    {
+        /* Adjust target voltage to 1.15V */
+        DCDC_AdjustTargetVoltage(DCDC, VDDRun_1150_mV, VDDStandby_925_mV);
+    }
+
+    void SwitchToLowPowerConfig()
+    {
+        /* Adjust target voltage to nominal 0.95V */
+        DCDC_AdjustTargetVoltage(DCDC, VDDRun_950_mV, VDDStandby_925_mV);
+
+        /* Switch to DCM mode to reduce current consumption */
+        DCDC_BootIntoDCM(DCDC);
+
+        /* Disconnect internal DCDC load resistor */
+        DCDC->REG1 &= ~DCDC_REG1_REG_RLOAD_SW_MASK;
+
+        /* Power down output range comparator */
+        DCDC->REG0 |= DCDC_REG0_PWD_CMP_OFFSET_MASK;
+
+        /* Enable FET ODRIVE */
+        PMU->REG_CORE_SET = PMU_REG_CORE_FET_ODRIVE_MASK;
+    }
+} // namespace bsp::dcdc

module-bsp/board/rt1051/bsp/lpm/DCDC.hpp

@@ -0,0 +1,11 @@
+// Copyright (c) 2017-2023, Mudita Sp. z.o.o. All rights reserved.
+// For licensing, see https://github.com/mudita/MuditaOS/LICENSE.md
+
+#pragma once
+
+namespace bsp::dcdc
+{
+    void SwitchToOverdriveConfig();
+    void SwitchToRegularConfig();
+    void SwitchToLowPowerConfig();
+} // namespace bsp::dcdc