✨ (dac): Add CoreSTM32HalBasicTimer

Co-Authored-By: Maxime Blanc <[email protected]>
Co-Authored-By: SamHadjes <[email protected]>

Author: 3 people

config/mbed_app.json

@@ -4,6 +4,10 @@
 		"USE_HAL_JPEG_REGISTER_CALLBACKS": {
 			"macro_name": "USE_HAL_JPEG_REGISTER_CALLBACKS",
 			"value": "1U"
+		},
+		"USE_HAL_TIM_REGISTER_CALLBACKS": {
+			"macro_name": "USE_HAL_TIM_REGISTER_CALLBACKS",
+			"value": "1U"
 		}
 	},
 	"target_overrides": {

drivers/CMakeLists.txt

@@ -6,6 +6,7 @@
 add_subdirectory(${DRIVERS_DIR}/CoreBufferedSerial)
 add_subdirectory(${DRIVERS_DIR}/CoreEventFlags)
 add_subdirectory(${DRIVERS_DIR}/CoreEventQueue)
+add_subdirectory(${DRIVERS_DIR}/CoreDAC)
 add_subdirectory(${DRIVERS_DIR}/CoreI2C)
 add_subdirectory(${DRIVERS_DIR}/CoreInterruptIn)
 add_subdirectory(${DRIVERS_DIR}/CoreLL)

drivers/CoreDAC/CMakeLists.txt

@@ -0,0 +1,27 @@
+# Leka - LekaOS
+# Copyright 2024 APF France handicap
+# SPDX-License-Identifier: Apache-2.0
+
+add_library(CoreDAC STATIC)
+
+target_include_directories(CoreDAC
+	PUBLIC
+	include
+)
+
+target_sources(CoreDAC
+	PRIVATE
+	source/CoreSTM32HalBasicTimer.cpp
+)
+
+if(NOT(${CMAKE_PROJECT_NAME} STREQUAL "LekaOSUnitTests"))
+	target_sources(CoreDAC
+		PUBLIC
+		source/HAL_IRQHandlers.cpp
+	)
+endif()
+
+target_link_libraries(CoreDAC
+	mbed-os
+	CoreSTM32Hal
+)

drivers/CoreDAC/include/CoreSTM32HalBasicTimer.h

@@ -0,0 +1,38 @@
+// Leka - LekaOS
+// Copyright 2024 APF France handicap
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <functional>
+
+#include "interface/STM32HalBasicTimer.h"
+
+namespace leka {
+
+class CoreSTM32HalBasicTimer : public interface::STM32HalBasicTimer
+{
+  public:
+	CoreSTM32HalBasicTimer(interface::STM32Hal &hal);
+
+	[[nodiscard]] auto getHandle() -> TIM_HandleTypeDef & final;
+
+	void registerCallback(std::function<void()> const &callback);
+
+	void initialize(uint32_t frequency) final;
+	void terminate() final;
+
+	void start() final;
+	void stop() final;
+
+  private:
+	void _registerMspCallbacks();
+
+	interface::STM32Hal &_hal;
+
+	TIM_HandleTypeDef _htim {};
+
+	std::function<void()> _callback = [] {};
+};
+
+}	// namespace leka

drivers/CoreDAC/include/interface/STM32HalBasicTimer.h

@@ -0,0 +1,25 @@
+// Leka - LekaOS
+// Copyright 2024 APF France handicap
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "interface/drivers/STM32Hal.h"
+
+namespace leka::interface {
+
+class STM32HalBasicTimer
+{
+  public:
+	virtual ~STM32HalBasicTimer() = default;
+
+	[[nodiscard]] virtual auto getHandle() -> TIM_HandleTypeDef & = 0;
+
+	virtual void initialize(uint32_t frequency) = 0;
+	virtual void terminate()					= 0;
+
+	virtual void start() = 0;
+	virtual void stop()	 = 0;
+};
+
+}	// namespace leka::interface

drivers/CoreDAC/source/CoreSTM32HalBasicTimer.cpp

@@ -0,0 +1,77 @@
+// Leka - LekaOS
+// Copyright 2024 APF France handicap
+// SPDX-License-Identifier: Apache-2.0
+
+#include "CoreSTM32HalBasicTimer.h"
+
+using namespace leka;
+
+CoreSTM32HalBasicTimer::CoreSTM32HalBasicTimer(interface::STM32Hal &hal) : _hal(hal)
+{
+	_htim.Instance = TIM6;	 // TIM7 is also possible
+}
+
+auto CoreSTM32HalBasicTimer::getHandle() -> TIM_HandleTypeDef &
+{
+	return _htim;
+}
+
+void CoreSTM32HalBasicTimer::registerCallback(std::function<void()> const &callback)
+{
+	_callback = callback;
+}
+
+void CoreSTM32HalBasicTimer::initialize(uint32_t frequency)
+{
+	_registerMspCallbacks();
+
+	// CK_Timer = CK_Int / ((Prescaler + 1) * (Period + 1))
+	auto divider = 54'000'000 / frequency;
+
+	_htim.Init.Prescaler		 = divider / 100;
+	_htim.Init.Period			 = 100;								 // ? min 1
+	_htim.Init.AutoReloadPreload = TIM_AUTORELOAD_PRELOAD_DISABLE;	 // Disable shadow write
+	// _htim.Init.CounterMode;										 // NOT AVAILABLE for BasicTimer
+	// _htim.Init.ClockDivision;									 // NOT AVAILABLE for BasicTimer
+	// _htim.Init.RepetitionCounter;								 // NOT AVAILABLE for BasicTimer
+	_hal.HAL_TIM_Base_Init(&_htim);
+
+	auto timerMasterConfig				  = TIM_MasterConfigTypeDef {};
+	timerMasterConfig.MasterOutputTrigger = TIM_TRGO_UPDATE;   // Use hardware trigger
+	// timerMasterConfig.MasterSlaveMode;					   // NOT AVAILABLE for BasicTimer
+	_hal.HAL_TIMEx_MasterConfigSynchronization(&_htim, &timerMasterConfig);
+
+	static auto &self = *this;
+	_hal.HAL_TIM_RegisterCallback(&_htim, HAL_TIM_PERIOD_ELAPSED_CB_ID,
+								  [](TIM_HandleTypeDef *htim) { self._callback(); });
+}
+
+void CoreSTM32HalBasicTimer::_registerMspCallbacks()
+{
+	static auto &self = *this;
+
+	_hal.HAL_TIM_RegisterCallback(&_htim, HAL_TIM_BASE_MSPINIT_CB_ID, [](TIM_HandleTypeDef *htim) {
+		self._hal.HAL_RCC_TIM6_CLK_ENABLE();
+
+		self._hal.HAL_NVIC_SetPriority(TIM6_DAC_IRQn, 0x00, 0x00);
+		self._hal.HAL_NVIC_EnableIRQ(TIM6_DAC_IRQn);
+	});
+
+	_hal.HAL_TIM_RegisterCallback(&_htim, HAL_TIM_BASE_MSPDEINIT_CB_ID,
+								  [](TIM_HandleTypeDef *htim) { self._hal.HAL_RCC_TIM6_CLK_DISABLE(); });
+}
+
+void CoreSTM32HalBasicTimer::terminate()
+{
+	_hal.HAL_TIM_Base_DeInit(&_htim);
+}
+
+void CoreSTM32HalBasicTimer::start()
+{
+	_hal.HAL_TIM_Base_Start_IT(&_htim);
+}
+
+void CoreSTM32HalBasicTimer::stop()
+{
+	_hal.HAL_TIM_Base_Stop_IT(&_htim);
+}

drivers/CoreDAC/source/HAL_IRQHandlers.cpp

@@ -0,0 +1,12 @@
+#include "CoreSTM32HalBasicTimer.h"
+
+extern "C" {
+
+extern leka::CoreSTM32HalBasicTimer hal_timer;
+
+void TIM6_DAC_IRQHandler()
+{
+	HAL_TIM_IRQHandler(&hal_timer.getHandle());
+}
+
+}	// extern "C"

drivers/CoreDAC/tests/mocks/STM32HalTimer.h

@@ -0,0 +1,24 @@
+// Leka - LekaOS
+// Copyright 2024 APF France handicap
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "gmock/gmock.h"
+#include "interface/STM32HalBasicTimer.h"
+
+namespace leka::mock {
+
+class STM32HalTimer : public interface::STM32HalBasicTimer
+{
+  public:
+	MOCK_METHOD(TIM_HandleTypeDef &, getHandle, (), (override));
+
+	MOCK_METHOD(void, initialize, (uint32_t), (override));
+	MOCK_METHOD(void, terminate, (), (override));
+
+	MOCK_METHOD(void, start, (), (override));
+	MOCK_METHOD(void, stop, (), (override));
+};
+
+}	// namespace leka::mock

drivers/CoreSTM32Hal/include/CoreSTM32Hal.h

@@ -22,6 +22,9 @@ class CoreSTM32Hal : public interface::STM32Hal
 	void HAL_RCC_GPIOI_CLK_ENABLE() final;
 	void HAL_RCC_GPIOJ_CLK_ENABLE() final;
 
+	void HAL_RCC_TIM6_CLK_ENABLE() final;
+	void HAL_RCC_TIM6_CLK_DISABLE() final;
+
 	void HAL_RCC_FMC_CLK_ENABLE() final;
 
 	void HAL_RCC_DMA2_CLK_ENABLE() final;
@@ -104,6 +107,15 @@ class CoreSTM32Hal : public interface::STM32Hal
 
 	auto HAL_JPEG_Pause(JPEG_HandleTypeDef *hjpeg, uint32_t XferSelection) -> HAL_StatusTypeDef final;
 	auto HAL_JPEG_Resume(JPEG_HandleTypeDef *hjpeg, uint32_t XferSelection) -> HAL_StatusTypeDef final;
+
+	auto HAL_TIM_Base_Init(TIM_HandleTypeDef *htim) -> HAL_StatusTypeDef final;
+	auto HAL_TIMEx_MasterConfigSynchronization(TIM_HandleTypeDef *htim, TIM_MasterConfigTypeDef *sMasterConfig)
+		-> HAL_StatusTypeDef final;
+	auto HAL_TIM_RegisterCallback(TIM_HandleTypeDef *htim, HAL_TIM_CallbackIDTypeDef CallbackID,
+								  pTIM_CallbackTypeDef pCallback) -> HAL_StatusTypeDef final;
+	auto HAL_TIM_Base_Start_IT(TIM_HandleTypeDef *htim) -> HAL_StatusTypeDef final;
+	auto HAL_TIM_Base_Stop_IT(TIM_HandleTypeDef *htim) -> HAL_StatusTypeDef final;
+	auto HAL_TIM_Base_DeInit(TIM_HandleTypeDef *htim) -> HAL_StatusTypeDef final;
 };
 
 }	// namespace leka

drivers/CoreSTM32Hal/source/CoreSTM32Hal.cpp

@@ -41,6 +41,16 @@ void CoreSTM32Hal::HAL_RCC_GPIOJ_CLK_ENABLE()
 	__HAL_RCC_GPIOJ_CLK_ENABLE();	// NOLINT
 }
 
+void CoreSTM32Hal::HAL_RCC_TIM6_CLK_ENABLE()
+{
+	__HAL_RCC_TIM6_CLK_ENABLE();   // NOLINT
+}
+
+void CoreSTM32Hal::HAL_RCC_TIM6_CLK_DISABLE()
+{
+	__HAL_RCC_TIM6_CLK_DISABLE();	// NOLINT
+}
+
 void CoreSTM32Hal::HAL_RCC_FMC_CLK_ENABLE()
 {
 	__HAL_RCC_FMC_CLK_ENABLE();	  // NOLINT
@@ -311,4 +321,36 @@ auto CoreSTM32Hal::HAL_JPEG_Resume(JPEG_HandleTypeDef *hjpeg, uint32_t XferSelec
 	return ::HAL_JPEG_Resume(hjpeg, XferSelection);
 }
 
+auto CoreSTM32Hal::HAL_TIM_Base_Init(TIM_HandleTypeDef *htim) -> HAL_StatusTypeDef
+{
+	return ::HAL_TIM_Base_Init(htim);
+}
+
+auto CoreSTM32Hal::HAL_TIMEx_MasterConfigSynchronization(TIM_HandleTypeDef *htim,
+														 TIM_MasterConfigTypeDef *sMasterConfig) -> HAL_StatusTypeDef
+{
+	return ::HAL_TIMEx_MasterConfigSynchronization(htim, sMasterConfig);
+}
+
+auto CoreSTM32Hal::HAL_TIM_RegisterCallback(TIM_HandleTypeDef *htim, HAL_TIM_CallbackIDTypeDef CallbackID,
+											pTIM_CallbackTypeDef pCallback) -> HAL_StatusTypeDef
+{
+	return ::HAL_TIM_RegisterCallback(htim, CallbackID, pCallback);
+}
+
+auto CoreSTM32Hal::HAL_TIM_Base_Start_IT(TIM_HandleTypeDef *htim) -> HAL_StatusTypeDef
+{
+	return ::HAL_TIM_Base_Start_IT(htim);
+}
+
+auto CoreSTM32Hal::HAL_TIM_Base_Stop_IT(TIM_HandleTypeDef *htim) -> HAL_StatusTypeDef
+{
+	return ::HAL_TIM_Base_Stop_IT(htim);
+}
+
+auto CoreSTM32Hal::HAL_TIM_Base_DeInit(TIM_HandleTypeDef *htim) -> HAL_StatusTypeDef
+{
+	return ::HAL_TIM_Base_DeInit(htim);
+}
+
 }	// namespace leka

include/interface/drivers/STM32Hal.h

@@ -21,6 +21,9 @@ class STM32Hal
 	virtual void HAL_RCC_GPIOI_CLK_ENABLE() = 0;
 	virtual void HAL_RCC_GPIOJ_CLK_ENABLE() = 0;
 
+	virtual void HAL_RCC_TIM6_CLK_ENABLE()	= 0;
+	virtual void HAL_RCC_TIM6_CLK_DISABLE() = 0;
+
 	virtual void HAL_RCC_FMC_CLK_ENABLE() = 0;
 
 	virtual void HAL_RCC_DMA2_CLK_ENABLE() = 0;
@@ -106,6 +109,15 @@ class STM32Hal
 
 	virtual auto HAL_JPEG_Pause(JPEG_HandleTypeDef *hjpeg, uint32_t XferSelection) -> HAL_StatusTypeDef	 = 0;
 	virtual auto HAL_JPEG_Resume(JPEG_HandleTypeDef *hjpeg, uint32_t XferSelection) -> HAL_StatusTypeDef = 0;
+
+	virtual auto HAL_TIM_Base_Init(TIM_HandleTypeDef *htim) -> HAL_StatusTypeDef = 0;
+	virtual auto HAL_TIMEx_MasterConfigSynchronization(TIM_HandleTypeDef *htim, TIM_MasterConfigTypeDef *sMasterConfig)
+		-> HAL_StatusTypeDef																   = 0;
+	virtual auto HAL_TIM_RegisterCallback(TIM_HandleTypeDef *htim, HAL_TIM_CallbackIDTypeDef CallbackID,
+										  pTIM_CallbackTypeDef pCallback) -> HAL_StatusTypeDef = 0;
+	virtual auto HAL_TIM_Base_Start_IT(TIM_HandleTypeDef *htim) -> HAL_StatusTypeDef		   = 0;
+	virtual auto HAL_TIM_Base_Stop_IT(TIM_HandleTypeDef *htim) -> HAL_StatusTypeDef			   = 0;
+	virtual auto HAL_TIM_Base_DeInit(TIM_HandleTypeDef *htim) -> HAL_StatusTypeDef			   = 0;
 };
 
 }	// namespace leka::interface

tests/unit/headers/mbed/mbed_config.h

@@ -288,6 +288,7 @@
 #define SMP_DB_MAX_DEVICES												  3		   // set by library:cordio
 #define TARGET_LSE_DRIVE_LOAD_LEVEL										  RCC_LSEDRIVE_LOW	 // set by target:MCU_STM32F7
 #define USE_HAL_JPEG_REGISTER_CALLBACKS									  1U				 // set by application
+#define USE_HAL_TIM_REGISTER_CALLBACKS									  1U				 // set by application
 // Macros
 #define WSF_MS_PER_TICK 1	// defined by library:cordio
 #define _RTE_				// defined by library:rtos

tests/unit/mocks/mocks/leka/CoreSTM32Hal.h

@@ -19,7 +19,8 @@ class CoreSTM32Hal : public interface::STM32Hal
 	MOCK_METHOD(void, HAL_RCC_GPIOH_CLK_ENABLE, (), (override));
 	MOCK_METHOD(void, HAL_RCC_GPIOI_CLK_ENABLE, (), (override));
 	MOCK_METHOD(void, HAL_RCC_GPIOJ_CLK_ENABLE, (), (override));
-
+	MOCK_METHOD(void, HAL_RCC_TIM6_CLK_ENABLE, (), (override));
+	MOCK_METHOD(void, HAL_RCC_TIM6_CLK_DISABLE, (), (override));
 	MOCK_METHOD(void, HAL_RCC_FMC_CLK_ENABLE, (), (override));
 	MOCK_METHOD(void, HAL_RCC_DMA2_CLK_ENABLE, (), (override));
 	MOCK_METHOD(void, HAL_RCC_JPEG_CLK_ENABLE, (), (override));
@@ -113,6 +114,15 @@ class CoreSTM32Hal : public interface::STM32Hal
 
 	MOCK_METHOD(HAL_StatusTypeDef, HAL_JPEG_Pause, (JPEG_HandleTypeDef *, uint32_t), (override));
 	MOCK_METHOD(HAL_StatusTypeDef, HAL_JPEG_Resume, (JPEG_HandleTypeDef *, uint32_t), (override));
+	MOCK_METHOD(HAL_StatusTypeDef, HAL_TIM_Base_Init, (TIM_HandleTypeDef * htim), (override));
+	MOCK_METHOD(HAL_StatusTypeDef, HAL_TIMEx_MasterConfigSynchronization,
+				(TIM_HandleTypeDef * htim, TIM_MasterConfigTypeDef *sMasterConfig), (override));
+	MOCK_METHOD(HAL_StatusTypeDef, HAL_TIM_RegisterCallback,
+				(TIM_HandleTypeDef * htim, HAL_TIM_CallbackIDTypeDef CallbackID, pTIM_CallbackTypeDef pCallback),
+				(override));
+	MOCK_METHOD(HAL_StatusTypeDef, HAL_TIM_Base_Start_IT, (TIM_HandleTypeDef * htim), (override));
+	MOCK_METHOD(HAL_StatusTypeDef, HAL_TIM_Base_Stop_IT, (TIM_HandleTypeDef * htim), (override));
+	MOCK_METHOD(HAL_StatusTypeDef, HAL_TIM_Base_DeInit, (TIM_HandleTypeDef * htim), (override));
 };
 
 }	// namespace leka::mock