pwm.h

Go to the documentation of this file.

//   Copyright 2016-2023 Jean-Francois Poilpret
//
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.
 
 
#ifndef PWM_H
#define PWM_H
 
#include "boards/board.h"
#include "boards/board_traits.h"
#include "gpio.h"
#include "timer.h"
 
namespace board
{
    template<PWMPin PWM> constexpr DigitalPin PWM_PIN() INLINE;
    template<PWMPin PWM> constexpr DigitalPin PWM_PIN()
    {
        return board_traits::PWMPin_trait<PWM>::ACTUAL_PIN;
    }
};
 
namespace analog
{
    using timer::TimerOutputMode;
 
    template<board::PWMPin PWMPIN_, bool PULSED_ = false> class PWMOutput
    {
    public:
        static constexpr const board::PWMPin PWMPIN = PWMPIN_;
        static constexpr const bool PULSED = PULSED_;
 
    private:
        using TRAIT = board_traits::PWMPin_trait<PWMPIN>;
        using TIMER_TRAIT = board_traits::Timer_trait<TRAIT::TIMER>;
 
    public:
        PWMOutput(const PWMOutput&) = delete;
        PWMOutput& operator=(const PWMOutput&) = delete;
        
        static constexpr const board::DigitalPin PIN = TRAIT::ACTUAL_PIN;
 
        static constexpr const uint8_t COM = TRAIT::COM;
 
        using TIMER = timer::Timer<TRAIT::TIMER>;
 
        PWMOutput(TIMER& timer, TimerOutputMode output_mode = TimerOutputMode::NON_INVERTING) : timer_{timer}
        {
            // Initialize pin as output
            gpio::FastPinType<PIN>::set_mode(gpio::PinMode::OUTPUT);
            if (TIMER_TRAIT::IS_16BITS || (!PULSED))
                // Set com mode for pin
                timer_.template set_output_mode<COM>(output_mode);
        }
 
        void set_output_mode(TimerOutputMode output_mode)
        {
            if (TIMER_TRAIT::IS_16BITS || (!PULSED)) timer_.template set_output_mode<COM>(output_mode);
        }
 
        using TYPE = typename TIMER_TRAIT::TYPE;
 
        static constexpr const TYPE MAX = TIMER_TRAIT::MAX_PWM;
 
        void set_duty(TYPE duty)
        {
            timer_.template set_max<COM>(duty);
        }
 
    private:
        TIMER& timer_;
    };
}
 
#endif /* PWM_H */