pwm.h

Go to the documentation of this file.

#pragma once
#include "gpio.h"
#include <stdbool.h>
#include <stdint.h>

// TYPES

typedef struct hw_pwm_t hw_pwm_t;

typedef struct {
  uint64_t period_ns; 
  float duty_percent; 
  bool enabled;       
} hw_pwm_config_t;

typedef void (*hw_pwm_callback_t)(hw_pwm_t *pwm, void *userdata);

// LIFECYCLE

hw_pwm_t *hw_pwm_init(hw_gpio_t *gpio, hw_pwm_callback_t callback,
                      void *userdata, const hw_pwm_config_t *config);

hw_pwm_t *hw_pwm_init_device(const char *device, uint8_t channel,
                             const hw_pwm_config_t *config);

void hw_pwm_deinit(hw_pwm_t *pwm);

// CONFIGURATION

bool hw_pwm_set_period_ns(hw_pwm_t *pwm, uint64_t period_ns);

uint64_t hw_pwm_get_period_ns(const hw_pwm_t *pwm);

bool hw_pwm_set_duty_percent(hw_pwm_t *pwm, float duty_percent);

float hw_pwm_get_duty_percent(const hw_pwm_t *pwm);

bool hw_pwm_set_config(hw_pwm_t *pwm, const hw_pwm_config_t *config);

bool hw_pwm_get_config(const hw_pwm_t *pwm, hw_pwm_config_t *out_config);

// CONTROL

void hw_pwm_set_enabled(hw_pwm_t *pwm, bool enabled);

bool hw_pwm_get_enabled(const hw_pwm_t *pwm);

// INTERRUPTS

bool hw_pwm_irq_supported(void);