Perchance We May need Input?

CMakeLists.txt

@@ -34,6 +34,7 @@ target_sources(${PROJECT_NAME} PRIVATE
         src/core/io/GPIO.cpp
         src/core/io/I2C.cpp
         src/core/io/PWM.cpp
+        src/core/io/PWMInput.cpp
         src/core/io/UART.cpp
         src/core/io/SPI.cpp
         src/core/io/types/CANMessage.cpp
@@ -57,6 +58,7 @@ if(COMPDEFS MATCHES "(.*)STM32F3xx(.*)")
     src/core/io/platform/f3xx/GPIOf3xx.cpp
     src/core/io/platform/f3xx/I2Cf3xx.cpp
     src/core/io/platform/f3xx/PWMf3xx.cpp
+            src/core/io/platform/f3xx/PWMInputf3xx.cpp
     src/core/io/platform/f3xx/UARTf3xx.cpp
     src/core/io/platform/f3xx/SPIf3xx.cpp
     src/core/dev/platform/f3xx/IWDGf3xx.cpp

include/core/io/PWMInput.hpp

@@ -0,0 +1,58 @@
+
+#ifndef EVT_PWMINPUT_HPP
+#define EVT_PWMINPUT_HPP
+
+#include <stdint.h>
+
+namespace core::io {
+
+// Forward declarations:
+// The different pins are hardware specific. Forward declaration to allow
+// at compilation time the decision of which pins should be used.
+enum class Pin;
+
+class PWMInput {
+
+public:
+    /**
+     * Setup the given pin for PWMInput usage.
+     *
+     * @param[in] pin The pin to setup for PWMInput
+     */
+    PWMInput(Pin pin);
+
+    /**
+     * Get the current duty cycle.
+     *
+     * @return The duty cycle of the PWM signal being read, as a percentage.
+     */
+    virtual uint8_t getDutyCycle() = 0;
+
+    /**
+     * Get the current period.
+     *
+     * @return The period the PWM signal being read is operating at in timer ticks.
+     */
+    virtual uint32_t getPeriod() = 0;
+
+    /**
+     * Get the current frequency.
+     *
+     * @return The frequency the PWM signal being read is operating at in Hz.
+     */
+    virtual uint32_t getFrequency() = 0;
+
+protected:
+    /// The pin PWM input is on
+    Pin pin;
+    /// The duty cycle of the PWM input
+    uint8_t dutyCycle;
+    /// The period of the PWM input
+    uint32_t period;
+    /// The frequency of the PWM input
+    uint32_t frequency;
+};
+
+} // namespace core::io
+
+#endif

include/core/io/platform/f3xx/PWMInputf3xx.hpp

@@ -0,0 +1,51 @@
+
+#ifndef EVT_PWMINPUTF3XX_HPP
+#define EVT_PWMINPUTF3XX_HPP
+
+#include <HALf3/stm32f3xx.h>
+
+#include <core/io/PWMInput.hpp>
+#include <core/io/pin.hpp>
+#include <stdint.h>
+
+namespace core::io {
+
+/**
+ * PWM input for f3
+ * Measures the duty cycle, frequency, and period of a PWM signal on a pin
+ */
+class PWMInputf3xx : public PWMInput {
+public:
+    /**
+     * Setup the given pin for PWM Input usage.
+     *
+     * @param pin[in] The pin to setup for PWM Input Capture
+     */
+    PWMInputf3xx(Pin pin);
+
+    uint8_t getDutyCycle();
+
+    uint32_t getPeriod();
+
+    uint32_t getFrequency();
+
+    /// Called from HAL_TIM_IC_CaptureCallback to update duty cycle, period, and frequency
+    void handleCapture(TIM_HandleTypeDef* htim);
+
+    /// Provides access to HAL handle for IRQ forwarding
+    TIM_HandleTypeDef* getHandle();
+
+private:
+    /// HAL timer representation
+    TIM_HandleTypeDef halTIM; // hal timer handle
+    /// Channel for rising edge measurement
+    uint32_t directChannel;
+    /// Channel for falling edge measurement
+    uint32_t indirectChannel;
+    /// active channel
+    uint32_t activeChannel;
+};
+
+} // namespace core::io
+
+#endif

include/core/manager.hpp

@@ -8,6 +8,7 @@
 #include <core/io/GPIO.hpp>
 #include <core/io/I2C.hpp>
 #include <core/io/PWM.hpp>
+#include <core/io/PWMInput.hpp>
 #include <core/io/UART.hpp>
 #include <core/io/pin.hpp>
 
@@ -19,6 +20,7 @@
     #define IWDG_SUPPORTED
     #define MCU_SUPPORTED
     #define PWM_SUPPORTED
+    #define PWM_INPUT_SUPPORTED
     #define RTC_SUPPORTED
     #define SPI_SUPPORTED
     #define UART_SUPPORTED
@@ -31,6 +33,7 @@
     #include <core/io/platform/f3xx/CANf3xx.hpp>
     #include <core/io/platform/f3xx/GPIOf3xx.hpp>
     #include <core/io/platform/f3xx/I2Cf3xx.hpp>
+    #include <core/io/platform/f3xx/PWMInputf3xx.hpp>
     #include <core/io/platform/f3xx/PWMf3xx.hpp>
     #include <core/io/platform/f3xx/SPIf3xx.hpp>
     #include <core/io/platform/f3xx/UARTf3xx.hpp>
@@ -240,6 +243,21 @@ PWM& getPWM() {
 }
 #endif
 
+/**
+ * Get an instance of a PWMInput pin.
+ *
+ * @param[in] pin The pin to attach to the PWMInput.
+ */
+#ifdef PWM_INPUT_SUPPORTED
+template<Pin pin>
+PWMInput& getPWM_INPUT() {
+    #ifdef STM32F3xx
+    static PWMInputf3xx pwm_input(pin);
+    return pwm_input;
+    #endif
+}
+#endif
+
 /**
  * Get an instance of a UART.
  *

samples/CMakeLists.txt

@@ -15,6 +15,7 @@ add_subdirectory(lcd)
 add_subdirectory(log)
 add_subdirectory(millis)
 add_subdirectory(pwm)
+add_subdirectory(pwm_input)
 add_subdirectory(queue)
 add_subdirectory(read_write)
 add_subdirectory(rtc)

samples/pwm_input/CMakeLists.txt

@@ -0,0 +1,3 @@
+include(${CMAKE_CURRENT_SOURCE_DIR}/../../cmake/evt-core_build.cmake)
+
+make_exe(pwm_input main.cpp)

samples/pwm_input/main.cpp

@@ -0,0 +1,39 @@
+/**
+ * Example of PWM input.
+ * This sample will measure the duty cycle, frequency, and period of a PWM signal.
+ */
+
+#include <core/io/PWMInput.hpp>
+#include <core/io/UART.hpp>
+#include <core/manager.hpp>
+#include <core/utils/time.hpp>
+
+namespace io   = core::io;
+namespace time = core::time;
+
+int main(void) {
+    // Initialize system
+    core::platform::init();
+
+    // Setup UART
+    io::UART& uart = io::getUART<io::Pin::UART_TX, io::Pin::UART_RX>(9600);
+
+    uart.printf("Starting PWM input capture\n\r");
+
+    uint32_t Period    = 0; // ICValue
+    uint32_t Frequency = 0;
+    uint8_t DutyCycle  = 0;
+
+    io::PWMInput& pwmInput = io::getPWM_INPUT<io::Pin::PB_15>();
+
+    while (1) {
+        Period    = pwmInput.getPeriod();
+        Frequency = pwmInput.getFrequency();
+        DutyCycle = pwmInput.getDutyCycle();
+        uart.printf("\n\rPeriod: %d\n\r", Period);
+        uart.printf("\n\rFrequency: %d\n\r", Frequency);
+        uart.printf("\n\rDuty: %2d%%\n\r", DutyCycle);
+        uart.printf("\n\r----------------------------------\n\r");
+        time::wait(1000);
+    }
+}

src/core/io/PWMInput.cpp

@@ -0,0 +1,12 @@
+#include <core/io/PWMInput.hpp>
+
+namespace core::io {
+
+PWMInput::PWMInput(Pin pin) { // core::io::Pin pin
+    this->pin       = pin;
+    this->dutyCycle = 0;
+    this->period    = 0;
+    this->frequency = 0;
+}
+
+} // namespace core::io