pwm.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef PWM_H_
#define PWM_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
#include <stdint.h>
#include <stdbool.h>
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
enum pwm_polarity {
    PWM_POLARITY_HIGH,
    PWM_POLARITY_LOW,
};
 
struct pwm_init_param {
    uint32_t id;
    uint32_t period_ns;
    uint32_t duty_cycle_ns;
    uint32_t phase_ns;
    enum pwm_polarity polarity;
    void *extra;
};
 
struct pwm_desc {
    uint32_t id;
    uint32_t period_ns;
    uint32_t duty_cycle_ns;
    uint32_t phase_ns;
    enum pwm_polarity polarity;
    bool enabled;
    void *extra;
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
/* Initialize the PWM generator device */
int32_t pwm_init(struct pwm_desc **desc,
         const struct pwm_init_param *param);
 
/* Free the resources used by the PWM generator device */
int32_t pwm_remove(struct pwm_desc *desc);
 
/* Enable PWM generator device */
int32_t pwm_enable(struct pwm_desc *desc);
 
/* Disable PWM generator device */
int32_t pwm_disable(struct pwm_desc *desc);
 
/* Set period of PWM generator device */
int32_t pwm_set_period(struct pwm_desc *desc,
               uint32_t period_ns);
 
/* Get period of PWM generator device */
int32_t pwm_get_period(struct pwm_desc *desc,
               uint32_t *period_ns);
 
/* Set duty cycle of PWM generator device */
int32_t pwm_set_duty_cycle(struct pwm_desc *desc,
               uint32_t duty_cycle_ns);
 
/* Get period of PWM generator device */
int32_t pwm_get_duty_cycle(struct pwm_desc *desc,
               uint32_t *duty_cycle_ns);
 
/* Set the phase of PWM generator channel */
int32_t pwm_set_phase(struct pwm_desc *desc,
              uint32_t phase_ns);
 
/* Get the phase of PWM generator channel */
int32_t pwm_get_phase(struct pwm_desc *desc,
              uint32_t *phase_ns);
 
/* Set polarity of PWM generator device */
int32_t pwm_set_polarity(struct pwm_desc *desc,
             enum pwm_polarity polarity);
 
/* Set polarity of PWM generator device */
int32_t pwm_get_polarity(struct pwm_desc *desc,
             enum pwm_polarity *polarity);
 
#endif