no_os_pwm.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _NO_OS_PWM_H_
#define _NO_OS_PWM_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
#include <stdint.h>
#include <stdbool.h>
 
/******************************************************************************/
/********************** Macros and Constants Definitions **********************/
/******************************************************************************/
 
#define PWM_MAX_NUMBER 4
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
enum no_os_pwm_polarity {
    NO_OS_PWM_POLARITY_HIGH,
    NO_OS_PWM_POLARITY_LOW,
};
 
struct no_os_pwm_init_param {
    uint32_t id;
    uint32_t period_ns;
    uint32_t duty_cycle_ns;
    uint32_t phase_ns;
    enum no_os_pwm_polarity polarity;
    struct no_os_gpio_init_param *pwm_gpio;
    /* IRQ ID */
    uint32_t irq_id;
    void (*pwm_callback)(void *arg);
    const struct no_os_pwm_platform_ops *platform_ops;
    void *extra;
};
 
struct no_os_pwm_desc {
    void *mutex;
    uint32_t id;
    uint32_t period_ns;
    uint32_t duty_cycle_ns;
    uint32_t phase_ns;
    enum no_os_pwm_polarity polarity;
    bool enabled;
    struct no_os_gpio_desc *pwm_gpio;
    /* IRQ ID */
    uint32_t irq_id;
    void (*pwm_callback)(void* arg);
    const struct no_os_pwm_platform_ops *platform_ops;
    void *extra;
};
 
struct no_os_pwm_platform_ops {
    int32_t (*pwm_ops_init)(struct no_os_pwm_desc **,
                const struct no_os_pwm_init_param *);
    int32_t (*pwm_ops_enable)(struct no_os_pwm_desc *);
    int32_t (*pwm_ops_disable)(struct no_os_pwm_desc *);
    int32_t (*pwm_ops_set_period)(struct no_os_pwm_desc *, uint32_t);
    int32_t (*pwm_ops_get_period)(struct no_os_pwm_desc *, uint32_t *);
    int32_t (*pwm_ops_set_duty_cycle)(struct no_os_pwm_desc *, uint32_t);
    int32_t (*pwm_ops_get_duty_cycle)(struct no_os_pwm_desc *, uint32_t *);
    int32_t (*pwm_ops_set_phase)(struct no_os_pwm_desc *, uint32_t);
    int32_t (*pwm_ops_get_phase)(struct no_os_pwm_desc *, uint32_t *);
    int32_t (*pwm_ops_set_polarity)(struct no_os_pwm_desc *,
                    enum no_os_pwm_polarity);
    int32_t (*pwm_ops_get_polarity)(struct no_os_pwm_desc *,
                    enum no_os_pwm_polarity *);
    int32_t(*pwm_ops_remove)(struct no_os_pwm_desc *);
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
/* Initialize the PWM generator device */
int32_t no_os_pwm_init(struct no_os_pwm_desc **desc,
               const struct no_os_pwm_init_param *param);
 
/* Free the resources used by the PWM generator device */
int32_t no_os_pwm_remove(struct no_os_pwm_desc *desc);
 
/* Enable PWM generator device */
int32_t no_os_pwm_enable(struct no_os_pwm_desc *desc);
 
/* Disable PWM generator device */
int32_t no_os_pwm_disable(struct no_os_pwm_desc *desc);
 
/* Set period of PWM generator device */
int32_t no_os_pwm_set_period(struct no_os_pwm_desc *desc,
                 uint32_t period_ns);
 
/* Get period of PWM generator device */
int32_t no_os_pwm_get_period(struct no_os_pwm_desc *desc,
                 uint32_t *period_ns);
 
/* Set duty cycle of PWM generator device */
int32_t no_os_pwm_set_duty_cycle(struct no_os_pwm_desc *desc,
                 uint32_t duty_cycle_ns);
 
/* Get period of PWM generator device */
int32_t no_os_pwm_get_duty_cycle(struct no_os_pwm_desc *desc,
                 uint32_t *duty_cycle_ns);
 
/* Set the phase of PWM generator channel */
int32_t no_os_pwm_set_phase(struct no_os_pwm_desc *desc,
                uint32_t phase_ns);
 
/* Get the phase of PWM generator channel */
int32_t no_os_pwm_get_phase(struct no_os_pwm_desc *desc,
                uint32_t *phase_ns);
 
/* Set polarity of PWM generator device */
int32_t no_os_pwm_set_polarity(struct no_os_pwm_desc *desc,
                   enum no_os_pwm_polarity polarity);
 
/* Set polarity of PWM generator device */
int32_t no_os_pwm_get_polarity(struct no_os_pwm_desc *desc,
                   enum no_os_pwm_polarity *polarity);
 
#endif // _NO_OS_PWM_H_