pwm.h

Go to the documentation of this file.

#ifndef DRV_PWM_H
#define DRV_PWM_H

#include <cpu/attr.h>

#include <cfg/compiler.h>
#include "cfg/cfg_pwm.h"

#define PWM_MAX_DUTY              ((pwm_duty_t)0xFFFF)
#define PWM_MAX_PERIOD                         0xFFFF
#define PWM_MAX_PERIOD_LOG2                        16

typedef uint16_t pwm_duty_t;

typedef uint32_t pwm_freq_t;

#if !CFG_PWM_ENABLE_OLD_API || defined(__doxygen__)

    typedef enum PwmPolarity
    {
        PWM_POL_HIGH_PULSE,
        PWM_POL_POSITIVE = PWM_POL_HIGH_PULSE,
        PWM_POL_LOW_PULSE,
        PWM_POL_NEGATIVE = PWM_POL_LOW_PULSE,
    } PwmPolarity;

    struct PwmHardware; //Fwd declaration

    typedef struct Pwm
    {
        unsigned ch;
        pwm_duty_t duty;
        PwmPolarity pol;
        bool enabled;
        struct PwmHardware *hw;
    } Pwm;

    void pwm_setDuty(Pwm *ctx, pwm_duty_t duty);
    void pwm_setFrequency(Pwm *ctx, pwm_freq_t freq);
    void pwm_setPolarity(Pwm *ctx, PwmPolarity pol);
    void pwm_enable(Pwm *ctx, bool state);
    void pwm_init(Pwm *ctx, unsigned channel); //defgroup pwm_api
#endif


#if CFG_PWM_ENABLE_OLD_API

    #include CPU_HEADER(pwm)
    #include "hw/pwm_map.h"

    INLINE void pwm_setPolarity(PwmDev dev, bool pol)
    {
        pwm_hw_setPolarity(dev, pol);
    }

    void pwm_setDuty(PwmDev dev, pwm_duty_t duty);
    void pwm_setFrequency(PwmDev dev, pwm_freq_t freq);
    void pwm_enable(PwmDev dev, bool state);
    void pwm_init(void); //defgroup pwm_old_api
#endif

/*
 * Test function prototypes.
 *
 * See pwm_test.c for implemntation of these functions.
 */
void pwm_testRun(void);
int pwm_testSetup(void);
/* For backward compatibility */
#define pwm_testSetUp() pwm_testSetup()
int pwm_testTearDown(void);

 //defgroup pwm_driver

#endif /* DRV_PWM_H */